0xTaoZ/sigma-rule-helper
GitHub: 0xTaoZ/sigma-rule-helper
一个用于审查 Sigma 检测规则 YAML 文件的轻量 CLI 工具,能报告缺失的核心字段并输出简明审查摘要。
Stars: 0 | Forks: 0
# sigma-rule-helper
一个小巧的命令行辅助工具,用于在实验或学习仓库中审查 Sigma 检测规则。
其首要目标实用且明确:加载一个或多个 Sigma YAML 文件,报告缺失的核心字段,并打印一份在规则审查期间易于阅读的简明摘要。
它并不能替代官方的 Sigma 工具。这是一个适合初学者的项目,旨在学习检测规则的结构以及如何构建简单的验证工具。
## 计划工作流
```
sigma-rule-helper check rules/
sigma-rule-helper summary rules/
sigma-rule-helper summary --format json rules/
```
尝试示例规则集:
```
sigma-rule-helper check samples/
```
## 检查内容
- 必需的顶级字段,例如 `title`、`id`、`status`、`logsource`、`detection` 和 `level`
- 基本的检测结构
- 存在时的 MITRE ATT&CK 标签
- 用于快速规则审查的易读输出
## 开发
```
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -e .
PYTHONPATH=src python -m unittest discover -s tests
```
## 项目状态
早期的学习项目。CLI 和检查逻辑特意保持精简,以便对每一项行为进行测试和理解。
## 当前检查
该仓库包含一个小型的 unittest 测试套件,以及一个在 push 和 pull request 事件时运行该测试套件的 GitHub Actions 工作流。
有关此工具所基于的简要审查清单,请参阅 `docs/rule-review-notes.md`。
标签:Python, Sigma规则, URL发现, 代码规范, 安全检测, 文档结构分析, 无后门, 目标导入, 逆向工具, 配置审查