ODamDam/sec-report-kit
GitHub: ODamDam/sec-report-kit
将安全分析结果从YAML转换为标准化Markdown/HTML/DOCX报告的CLI工具。
Stars: 0 | Forks: 0
# sec-report-kit
`sec-report-kit` 是一款轻量级 CLI 工具,用于从结构化 YAML 输入文件生成安全分析报告。
`sec-report-kit`은 CVE 분석, 악성코드 트리아지, 모의해킹 Finding을 YAML로 구조화하고, 이를 Markdown/HTML 보고서로 자동 생성하는 보안 분석 보고서 자동화 도구입니다.
该项目专为 CVE 分析、恶意软件分类和渗透测试报告工作流程设计。
它将结构化分析数据转换为 Markdown 和 HTML 报告。
## 概述
安全分析报告通常需要重复的章节,例如执行摘要、目标信息、严重程度、技术分析、攻击流程、检测点、IOC、MITRE ATT&CK 映射、缓解措施和参考文献。
该项目将结构化分析数据与报告呈现分离。分析师使用 YAML 编写发现结果,工具即可生成一致的 Markdown 和 HTML 报告。
## 支持的报告类型
| 报告类型 | 描述 |
|---|---|
| CVE 分析 | 基于 CVE 研究的漏洞分析报告 |
| 恶意软件分类 | 包含 IOC、行为和 ATT&CK 映射的恶意软件分类报告 |
| 渗透测试发现 | 针对 Web 或系统漏洞的渗透测试发现报告 |
## 功能特性
- 基于 YAML 的报告输入
- Markdown 报告生成
- HTML 报告生成
- 可重用的报告模板
- CVE 分析报告示例
- 恶意软件分类报告示例
- 渗透测试发现报告示例
- IOC 章节支持
- MITRE ATT&CK 映射章节支持
- 检测和缓解章节
- YARA 规则参考章节
- Sigma 规则参考章节
- 安全重点的输入验证
- 架构加载和报告渲染的单元测试
- DOCX 报告生成
## 项目结构
```
sec-report-kit/
├─ docs/
│ └─ schema.md
├─ examples/
│ ├─ cve/
│ ├─ malware/
│ ├─ pentest/
│ └─ outputs/
├─ outputs/
├─ sec_report_kit/
├─ templates/
├─ README.md
├─ requirements.txt
├─ pyproject.toml
└─ LICENSE
```
## 安装说明
```
cd sec-report-kit
```
```
python -m venv .venv
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\.venv\Scripts\Activate.ps1
```
```
python -m pip install --upgrade pip
```
```
python -m pip install -r requirements.txt
```
## 使用方法
从 YAML 输入文件生成报告:
```
python -m sec_report_kit.cli examples/cve/cve-2023-38831.yaml
```
将报告生成到 examples/outputs:
```
python -m sec_report_kit.cli examples/cve/cve-2023-38831.yaml -o examples/outputs
python -m sec_report_kit.cli examples/malware/agent-tesla-triage.yaml -o examples/outputs
python -m sec_report_kit.cli examples/pentest/sample-web-finding.yaml -o examples/outputs
```
仅生成 HTML:
```
python -m sec_report_kit.cli examples/cve/cve-2023-38831.yaml -f html
```
仅生成 Markdown:
```
python -m sec_report_kit.cli examples/cve/cve-2023-38831.yaml -f md
```
仅生成 DOCX:
```
powershell
python -m sec_report_kit.cli examples/cve/cve-2023-38831.yaml -f docx
```
## YAML 架构
请参阅 docs/schema.md。
## 路线图
- [x] 基于 YAML 的报告输入
- [x] Markdown 报告生成
- [x] HTML 报告生成
- [x] CVE 分析报告示例
- [x] 恶意软件分类报告示例
- [x] 渗透测试发现报告示例
- [x] 示例生成的报告
- [x] GitHub Pages 演示
- [x] YARA 规则章节
- [x] Sigma 规则章节
- [x] DOCX 导出
- [x] 输入验证测试
- [x] 单元测试
- [x] 免责声明
该项目仅用于教育和防御安全目的。
本仓库不包含任何恶意软件二进制文件、实际利用代码、真实受害者数据、凭据或敏感的基础设施信息。
## 许可证
本项目基于 MIT 许可证授权。
标签:Cloudflare, CVE分析, DAST, DNS信息、DNS暴力破解, DOCX, HTML, IOC, Linux安全, Markdown, MITRE ATT&CK, Pentest报告, Sigma规则, YAML, YARA规则, 多模态安全, 威胁情报, 安全库, 安全报告, 开发者工具, 恶意软件 triage, 恶意软件分析, 报告生成工具, 报告自动化, 文档结构分析, 漏洞报告, 目标导入, 结构化数据, 逆向工具, 防御加固