cognis-digital/sigmacheck

``` pip install cognis-sigmacheck sigmacheck scan . # → prioritized findings in seconds ``` ## 目录 - [为什么选择 sigmacheck？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关项目](#related) · [贡献指南](#contributing) ## 用法 — 分步指南 `sigmacheck` 用于验证 Sigma 检测规则，运行其内置的自测试，并可将规则与 JSON 事件进行匹配。当验证失败、测试失败或检测结果达到 `--fail-on` 的阈值时，退出码为 `1`。 1. **安装** pip install sigmacheck 2. **验证并自测规则文件、目录或通配符**（`-` 读取 stdin）： sigmacheck check rules/ rules/win/*.yml 3. **结合内置规则库进行尝试**并列出自带的内容： sigmacheck demo sigmacheck list 4. **读取 JSON 输出**，并使用 `--fail-on {informational,low,medium,high,critical}` 调整失败阈值： sigmacheck --format json check rules/ | jq '.total_findings' 5. **将单个规则与事件进行匹配**以进行临时分类，并通过 `check` 来控制 CI： sigmacheck match rule.yml events.jsonl sigmacheck check rules/ --fail-on high # exit 1 fails the build ## 为什么选择 sigmacheck？ 有效的检测 `sigmacheck` 具有单一用途、可脚本化且支持自托管：将其指向目标，即可获得符合您现有工作流程格式的优先排序结果（表格 · JSON · SARIF），将其用于 CI 检测门槛，并允许 agent 通过 MCP 驱动它。 ## 功能 - ✅ 解析 Yaml - ✅ 评估检测 - ✅ Lint 规则 - ✅ 运行单元测试 - ✅ 可在 Linux/macOS/Windows · Docker · devcontainer 上运行 - ✅ 提供 Python、JavaScript、Go 和 Rust 移植版本 (`ports/`) ## 快速开始 ``` pip install cognis-sigmacheck sigmacheck --version sigmacheck scan . # scan current project sigmacheck scan . --format json # machine-readable sigmacheck scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ sigmacheck scan . [HIGH ] SIG-001 example finding (./src/app.py) [MEDIUM ] SIG-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[target / manifest] --> P[sigmacheck
checks + rules] P --> OUT[findings (JSON / SARIF)] ``` ## 从任何 AI 技术栈中使用 `sigmacheck` 与每种流行的 AI 使用方式均可互操作： - **MCP 服务器** — `sigmacheck mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **兼容 OpenAI / JSON** — 将 `sigmacheck scan . --format json` 通过管道传递给任何 agent 或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** — 只需一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** — 为非 AI pipeline 提供 exit 代码 + SARIF ## 对比 | | **Cognis sigmacheck** | sigma-cli | |---|:---:|:---:| | 支持自托管，无需账号 | ✅ | 视情况而定 | | 单一命令，零配置 | ✅ | ⚠️ | | 为 CI 提供 JSON + SARIF | ✅ | 视情况而定 | | MCP 原生支持 (AI agent) | ✅ | ❌ | | 多语言移植 (JS/Go/Rust) | ✅ | ❌ | | 开源许可证 | ✅ COCL | 视情况而定 | *秉承 **sigma-cli** 的精神，以 Cognis 的方式重新构建。遗漏了致谢内容？提交一个 PR。* ## 集成 可整合至您的技术栈：用于代码扫描的 **SARIF**，用于一切的 **JSON**，用于 AI agent 的 **MCP 服务器** (`sigmacheck mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 — 各种方式，各个平台 ``` pip install "git+https://github.com/cognis-digital/sigmacheck.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/sigmacheck.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/sigmacheck.git" # uv pip install cognis-sigmacheck # PyPI (when published) docker run --rm ghcr.io/cognis-digital/sigmacheck:latest --help # Docker brew install cognis-digital/tap/sigmacheck # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/sigmacheck/main/install.sh | sh ``` | Linux | macOS | Windows | Docker | Cloud | |---|---|---|---|---| | `scripts/setup-linux.sh` | `scripts/setup-macos.sh` | `scripts/setup-windows.ps1` | `docker run ghcr.io/cognis-digital/sigmacheck` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 - [`portfan`](https://github.com/cognis-digital/portfan) — 汇总 nmap XML 并将其差异对比为优先的、可进行攻击的检测结果 - [`subhunt`](https://github.com/cognis-digital/subhunt) — 汇聚并去重来自多个来源的子域名枚举 - [`dirsight`](https://github.com/cognis-digital/dirsight) — 分析 Web 内容发现输出（ffuf/gobuster）并生成排序的 endpoint - [`jwtinspect`](https://github.com/cognis-digital/jwtinspect) — 解码 JWT 并针对 alg=none、弱密钥和缺失的 claim 进行 lint - [`corsaudit`](https://github.com/cognis-digital/corsaudit) — 通过 header 或配置检测宽松/错误配置的 CORS - [`headerscan`](https://github.com/cognis-digital/headerscan) — 根据响应转储对 HTTP 安全 header (CSP/HSTS/XFO) 进行 A-F 评级 **探索套件 →** [🗂️ 全部 170+ 工具](https://github.com/cognis-digital/cognis-neural-suite) · [⭐ awesome-cognis](https://github.com/cognis-digital/awesome-cognis) · [🔗 cognis-sources](https://github.com/cognis-digital/cognis-sources) · [🤖 uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet) · [🧠 engram](https://github.com/cognis-digital/engram) ## 互操作性 `{}` 与包含 300+ 工具的 Cognis 套件协同工作 — 使用 JSON 输入/输出和共享的 兼容 OpenAI 的 `/v1` 主干。请参阅 **[INTEROP.md](INTEROP.md)** 获取 套件映射表、组合模式以及参考技术栈。 ## 许可证 在 **Cognis Open Collaboration License (COCL) v1.0** 下提供源码 — 个人、内部评估、研究和教育用途免费；**商业/生产环境使用需要获得许可证** (licensing@cognis.digital)。参见 [LICENSE](LICENSE)。

标签：DevSecOps, SIEM检测规则, Sigma规则, 上游代理, 代码静态检查, 目标导入, 请求拦截, 逆向工具