REST API Fuzz Testing (RAFT) 项目使用教程

余达殉Lambert

于 2024-09-09 08:52:53 发布

阅读量748

点赞数 13

本文链接：https://blog.csdn.net/gitblog_00475/article/details/142043178

版权

REST API Fuzz Testing (RAFT) 项目使用教程

rest-api-fuzz-testingREST API Fuzz Testing (RAFT): Source code for self-hosted service developed for Azure, including the API, orchestration engine, and default set of security tools (including MSR's RESTler), that enables developers to embed security tooling into their CI/CD workflows项目地址:https://gitcode.com/gh_mirrors/re/rest-api-fuzz-testing

1. 项目的目录结构及介绍

REST API Fuzz Testing (RAFT) 项目的目录结构如下：

rest-api-fuzz-testing/
├── api/
├── orchestration_engine/
├── security_tools/
├── config/
├── docs/
├── tests/
├── README.md
├── LICENSE
├── CONTRIBUTING.md
└── requirements.txt

目录介绍

api/: 包含与API相关的代码和资源。
orchestration_engine/: 包含API编排引擎的代码。
security_tools/: 包含默认的安全工具集，包括MSR的RESTler。
config/: 包含项目的配置文件。
docs/: 包含项目的文档文件。
tests/: 包含项目的测试代码。
README.md: 项目的介绍和基本使用说明。
LICENSE: 项目的许可证文件。
CONTRIBUTING.md: 贡献指南。
requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

项目的启动文件通常位于 orchestration_engine/ 目录下。具体启动文件可能包括：

main.py: 主启动文件，负责初始化并启动API编排引擎。
run.sh: 启动脚本，用于在Linux环境下启动项目。

启动步骤

安装项目依赖：
```
pip install -r requirements.txt
```
运行启动文件：
```
python orchestration_engine/main.py
```
或者使用启动脚本：
```
./run.sh
```

3. 项目的配置文件介绍

项目的配置文件通常位于 config/ 目录下。常见的配置文件包括：

config.yaml: 主配置文件，包含项目的各种配置选项，如API端点、安全工具配置等。
logging.conf: 日志配置文件，定义日志的输出格式和级别。

配置文件示例

config.yaml:

api:
  endpoint: "https://api.example.com"
  timeout: 10

security_tools:
  restler:
    enabled: true
    options:
      - "--mode=fuzz"
      - "--max-requests=1000"

logging.conf:

[loggers]
keys=root

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

通过这些配置文件，可以灵活地调整项目的运行参数和日志输出。