解析器文档模板 (Open Source)
本模板用于记录新解析器或现有解析器的文档。欢迎补充任何有助于其他安全从业者的额外信息。
- 复制此 .md 文件,并将其添加到 GitHub 仓库中的
/docs/content/supported_tools/file。 - 更新标题,使其与您新建或现有解析器的名称一致。
- 填写下方列出的所有部分。请删除各部分中出现的说明文字或示例内容。
文件类型
请注明您的解析器接受的所有文件类型(例如 CSV、JSON、XML)。 请说明如何从相关安全工具创建或导出可接受的文件格式。
[文件格式] 中的字段总数
数据字段总数: 安全工具导出文件中包含的字段总数。 已解析的数据字段数: 已解析到 DefectDojo 发现项中的字段总数。 未解析的数据字段数: 未解析到 DefectDojo 发现项中的字段总数。
请按照以下格式,简要描述每个字段及其如何映射到 DefectDojo 的数据模型。 请按出现顺序列出安全工具导出文件中的所有字段,并注明未被解析的字段。
按出现顺序排列的字段:
- 字段 1 - 该字段映射方式的描述(例如,映射到发现项标题、端点主机等)
- 字段 2 - 该字段是否映射及映射方式的描述。
- 字段 3 - 该字段是否映射及映射方式的描述。
- 字段 4 - 该字段是否映射及映射方式的描述。 (对文件中的每个字段依此类推。)
字段映射详情
对于每个创建的发现项,请说明解析器如何解析特定数据的详细信息。例如:
- 端点的创建方式(例如,组合 IP、域名、端口和协议字段)。
- 出现次数(occurrences)的处理方式(例如,默认
nb_occurences设为 1,遇到重复项时递增)。 - 去重的处理方式(例如,使用严重程度 + 标题 + 描述的哈希值)。
- 说明未匹配到映射时的默认严重程度。
示例扫描数据或单元测试
请添加指向 GitHub 仓库中单元测试或示例扫描数据文件夹的链接。例如:
工具链接
请提供指向该扫描器或工具本身的链接(例如 GitHub 仓库、供应商网站或文档)。例如: