cognis-digital/pwnreview

``` pip install cognis-pwnreview pwnreview scan . # → prioritized findings in seconds ``` ## 使用说明 — 分步指南 1. **安装** (Python 3.9+)： pip install pwnreview # 或者：pipx install pwnreview 2. 在渲染之前**验证测试项目文件**（使用 `-` 代表标准输入）： pwnreview validate engagement.yaml 3. **生成报告。** 渲染为 HTML 或 Markdown 并将其写入文件： pwnreview generate engagement.yaml --render markdown -o report.md 4. 获取已验证/汇总测试项目的**机器可读输出**： pwnreview generate engagement.yaml --format json > engagement.json 5. **查看结果。** `validate` 会报告 schema/完整性问题并在失败时以非零状态退出；`generate` 会汇总测试发现，并（通过 `--render`）输出可共享的 HTML/Markdown 文档。 6. **将其接入 CI。** 在每次更改时进行验证，然后发布渲染后的报告： pwnreview validate engagement.yaml && pwnreview generate engagement.yaml --render html -o site/report.html ## 目录 - [为什么选择 pwnreview？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比分析](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关工具](#related) · [贡献](#contributing) ## 为什么选择 pwnreview？ 渗透测试报告生成器 — 将 YAML 测试发现转化为 CREST 级别的 PDF — 无需搭建重型基础设施。 `pwnreview` 具有单一用途、可脚本化且支持自托管：将其指向目标，即可通过您工作流中已有的格式（表格 · JSON · SARIF）获取按优先级排序的结果，以此为依据控制 CI 流程，并让 agent 通过 MCP 驱动它。 ## 功能 - ✅ 解析 YAML - ✅ 加载测试项目 - ✅ 严重程度统计 - ✅ 构建报告 - ✅ 渲染 Markdown - ✅ 渲染 HTML - ✅ 支持 Linux/macOS/Windows · Docker · devcontainer 运行 - ✅ 支持 Python、JavaScript、Go 和 Rust 语言移植版本 (`ports/`) ## 快速开始 ``` pip install cognis-pwnreview pwnreview --version pwnreview scan . # scan current project pwnreview scan . --format json # machine-readable pwnreview scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ pwnreview scan . [HIGH ] PWN-001 example finding (./src/app.py) [MEDIUM ] PWN-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[capture / scan] --> P[pwnreview
parse + map] P --> OUT[report] ``` ## 从任何 AI 技术栈中使用 `pwnreview` 可与所有流行的 AI 使用方式互操作： - **MCP server** — `pwnreview mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **兼容 OpenAI / JSON** — 将 `pwnreview scan . --format json` 管道传输至任何 agent 或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** — 一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** — 为非 AI pipeline 提供 exit code + SARIF ## 对比分析 | | **Cognis pwnreview** | Marmeus | |---|:---:|:---:| | 支持自托管，无需账户 | ✅ | 视情况而定 | | 单一命令，零配置 | ✅ | ⚠️ | | 用于 CI 的 JSON + SARIF | ✅ | 视情况而定 | | MCP 原生支持 (AI agent) | ✅ | ❌ | | 多语言移植版本 (JS/Go/Rust) | ✅ | ❌ | | 开源许可证 | ✅ COCL | 视情况而定 | *秉承 **Marmeus/pentesting-report-generator** 的精神，以 Cognis 的方式重新构建。遗漏了致谢？欢迎提交 PR。* ## 集成 可接入您的技术栈：用于代码扫描的 **SARIF**，适用于任何场景的 **JSON**，用于 AI agent 的 **MCP server** (`pwnreview mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 — 全方式、全平台支持 ``` pip install "git+https://github.com/cognis-digital/pwnreview.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/pwnreview.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/pwnreview.git" # uv pip install cognis-pwnreview # PyPI (when published) docker run --rm ghcr.io/cognis-digital/pwnreview:latest --help # Docker brew install cognis-digital/tap/pwnreview # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/pwnreview/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/pwnreview` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关 Cognis 工具 - [`c2detect`](https://github.com/cognis-digital/c2detect) — C2 server 指纹识别工具 — Cobalt Strike, Sliver, Mythic, Havoc, Brute Ratel - [`payloadlab`](https://github.com/cognis-digital/payloadlab) — 静态恶意 payload 分析工具 — PE/ELF/LNK/macro/OneNote - [`redpath`](https://github.com/cognis-digital/redpath) — Active Directory 攻击路径映射工具 — 最小成本路径 + 修复优先级 - [`crackq`](https://github.com/cognis-digital/crackq) — 自托管密码破解队列 — 带审计日志的多用户 hashcat **探索全系列工具 →** [🗂️ 全部 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)。

标签：PDF, Python, YAML, 安全库, 报告生成器, 数据展示, 无后门, 红队, 请求拦截, 逆向工具