cognis-digital/auditrail

``` pip install cognis-auditrail auditrail scan . # → prioritized findings in seconds ``` ## 使用说明 —— 分步指南 1. **安装** CLI（控制台脚本 `auditrail`）： pip install cognis-auditrail 2. 基于事件的 JSON 数组 / JSONL **构建哈希链**（每个事件需要包含 `ts`/`actor`/`action`）；省略路径或使用 `-` 表示从标准输入读取： auditrail chain events.jsonl 3. **验证完整性** —— `verify` 会重新计算哈希链，如果发现被篡改则以退出码 2 退出： auditrail verify events.jsonl 4. 以 JSON 格式**读取结果 / 输出证明**，用于存储或审计： auditrail verify events.jsonl --format json auditrail attest events.jsonl --format json > attestation.json 5. **在 CI 中实现自动化** —— 发生任何篡改中断（退出码 2）时使任务失败： - run: pip install cognis-auditrail - run: cat events.jsonl | auditrail verify - --format json ## 目录 - [为什么选择 auditrail？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关工具](#related) · [贡献指南](#contributing) ## 为什么选择 auditrail？ 合规证据完整性 `auditrail` 专注单一功能、可脚本化且支持自托管：将其指向目标，以你的工作流已使用的格式（表格 · JSON · SARIF）获取优先级排序的结果，以此来控制 CI 流水线，并允许代理通过 MCP 进行驱动。 ## 功能 - ✅ 构建哈希链 - ✅ 验证哈希链 - ✅ 输出证明 - ✅ 加载事件 - ✅ 从路径加载事件 - ✅ 运行于 Linux/macOS/Windows · Docker · devcontainer - ✅ 提供 Python、JavaScript、Go 和 Rust 移植版（`ports/`） ## 快速开始 ``` pip install cognis-auditrail auditrail --version auditrail scan . # scan current project auditrail scan . --format json # machine-readable auditrail scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ auditrail scan . [HIGH ] AUD-001 example finding (./src/app.py) [MEDIUM ] AUD-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[target / manifest] --> P[auditrail
checks + rules] P --> OUT[findings (JSON / SARIF)] ``` ## 从任何 AI 技术栈中使用 `auditrail` 与所有主流的 AI 使用方式兼容互操作： - **MCP 服务器** —— `auditrail mcp`（Claude Desktop、Cursor、Cognis.Studio、[uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)） - **兼容 OpenAI / JSON** —— 将 `auditrail scan . --format json` 的输出通过管道传递给任何代理或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** —— 用一行代码将 CLI/JSON 封装为工具 - **CI / 脚本** —— 为非 AI 流水线提供退出码 + SARIF ## 对比 | | **Cognis auditrail** | 审计日志 | |---|:---:|:---:| | 支持自托管，无需账号 | ✅ | 视情况而定 | | 单条命令，零配置 | ✅ | ⚠️ | | 用于 CI 的 JSON + SARIF | ✅ | 视情况而定 | | 原生支持 MCP（AI 代理） | ✅ | ❌ | | 多语言移植版（JS/Go/Rust） | ✅ | ❌ | | 开源许可证 | ✅ COCL | 视情况而定 | *秉承**审计日志**的精神打造，并以 Cognis 的方式重新塑造。遗漏了谁的贡献？欢迎提交 PR。* ## 集成 无缝接入你的技术栈：用于代码扫描的 **SARIF**，用于一切的 **JSON**，用于 AI 代理的 **MCP 服务器**（`auditrail mcp`），以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 —— 涵盖所有方式与平台 ``` pip install "git+https://github.com/cognis-digital/auditrail.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/auditrail.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/auditrail.git" # uv pip install cognis-auditrail # PyPI (when published) docker run --rm ghcr.io/cognis-digital/auditrail:latest --help # Docker brew install cognis-digital/tap/auditrail # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/auditrail/main/install.sh | sh ``` | Linux | macOS | Windows | Docker | 云平台 | |---|---|---|---|---| | `scripts/setup-linux.sh` | `scripts/setup-macos.sh` | `scripts/setup-windows.ps1` | `docker run ghcr.io/cognis-digital/auditrail` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 - [`soc2box`](https://github.com/cognis-digital/soc2box) —— SOC 2 证据收集器和控制项追踪器，支持自托管 - [`gdprkit`](https://github.com/cognis-digital/gdprkit) —— GDPR/CCPA DSAR、RoPA 和 cookie 同意工具包 - [`policyforge`](https://github.com/cognis-digital/policyforge) —— 通过简短的问卷自动生成安全策略 - [`vendorvet`](https://github.com/cognis-digital/vendorvet) —— 包含 SBOM 交叉比对的第三方/供应商风险评估问卷 - [`frameworkmap`](https://github.com/cognis-digital/frameworkmap) —— 跨越 NIST、ISO 27001、SOC 2、CMMC、PCI 的控制项映射 - [`dpiaforge`](https://github.com/cognis-digital/dpiaforge) —— DPIA 和欧盟 AI 法案影响评估生成器 ## 互操作性 `auditrail` 可与包含 300 多个工具的 Cognis 套件无缝组合 —— 统一的 JSON 输入/输出以及共享的 兼容 OpenAI 的 `/v1` 核心主干。有关套件映射、组合模式和参考技术栈，请参阅 **[INTEROP.md](INTEROP.md)**。 ## 许可证 在 **Cognis Open Collaboration License (COCL) v1.0** 下提供源码可见授权 —— 个人使用、内部评估、研究和教育用途免费；**商业/生产环境使用需要获取许可证**（licensing@cognis.digital）。详见 [LICENSE](LICENSE)。

标签：LNA, Python, 可视化界面, 合规GRC, 哈希链, 完整性校验, 数据可视化, 无后门, 日志审计, 请求拦截, 逆向工具, 防篡改