自动化 on DefectDojo Documentation

DefectDojo API v2

Mon, 01 Jan 0001 00:00:00 +0000

DefectDojo 的 API 使用 Django Rest Framework 构建。每个端点的文档在每个 DefectDojo 安装实例中都可以通过 /api/v2/oa3/swagger-ui 获取，也可以通过页眉中用户下拉菜单里的 API v2 Docs 链接访问。

该文档使用 drf-spectacular 在 /api/v2/oa3/swagger-ui/ 生成，并且是可交互的。在 API v2 文档顶部有一个链接，可用于生成 OpenAPI v3 规范。

语言与代码行数

Mon, 01 Jan 0001 00:00:00 +0000

DefectDojo 可以显示某个产品的编程语言构成和代码行数明细，这些数据通过 API 导入 cloc（Count Lines of Code）工具生成的报告来填充。

Generating the cloc Report

对您的代码库运行 cloc，并使用 --json 标志以生成格式正确的 JSON 文件：

cloc --json /path/to/your/project > cloc-report.json

Importing via the API

通过 API 将该 JSON 报告上传到 DefectDojo。导入时，该产品现有的所有语言数据都会被新文件的内容替换。

速率限制

Mon, 01 Jan 0001 00:00:00 +0000

DefectDojo 内置了登录页面速率限制功能，以防范暴力破解攻击，该功能由 Django Ratelimit 提供支持。

Configuration

速率限制通过以下设置进行配置（有关如何应用这些设置，请参阅配置）：

DD_RATE_LIMITER_ENABLED=(bool, True),
DD_RATE_LIMITER_RATE=(str, '5/m'),
DD_RATE_LIMITER_BLOCK=(bool, True),
DD_RATE_LIMITER_ACCOUNT_LOCKOUT=(bool, True),

Rate Limit (`DD_RATE_LIMITER_RATE`)

设置限制请求频率的方式。支持的单位有：

秒：1s
分钟：5m
小时：100h
天：2400d

有关更多配置选项，请参阅 Django Ratelimit rates 文档。

通知 Webhook

Mon, 01 Jan 0001 00:00:00 +0000

这是一项实验性的开源功能 — 其行为可能会在未来版本中发生变化。

Webhook 是在特定事件发生时，从您的 DefectDojo 实例发送到用户自定义服务器的出站 HTTP 请求。

Setup

Webhook 端点由管理员配置。创建 webhook 时，DefectDojo 会发送一个 ping 事件，以验证该端点是否可访问，并返回预期的状态码。

Endpoint State Transitions

DefectDojo 会监控投递成功情况，并根据 HTTP 响应或网络故障暂时或永久禁用某个端点。管理员也可以手动重新启用该端点。

自动化 on DefectDojo Documentation

DefectDojo API v2

语言与代码行数

Generating the cloc Report

Importing via the API

速率限制

Configuration

Rate Limit (DD_RATE_LIMITER_RATE)

通知 Webhook

Setup

Endpoint State Transitions

Rate Limit (`DD_RATE_LIMITER_RATE`)