cognis-digital/secretsweep

``` pip install cognis-secretsweep secretsweep scan . # → prioritized findings in seconds ``` ## 使用说明 — 分步指南 `secretsweep` 是一个零安装的 secret 扫描器，内置 50+ 种服务商规则、Shannon 熵检测，并支持 allowlist/baseline。控制台脚本：`secretsweep`。 1. **安装**: pipx install secretsweep # 或者：pip install secretsweep 2. **扫描文件、目录或 stdin** 以查找 secret： secretsweep scan ./src --format json | jq '.summary' cat config.yml | secretsweep scan 退出码 `2` = 发现 secret，`0` = 干净，`1` = 错误。 3. **记录 baseline**（即当前接受的扫描结果），防止现有的 secret 阻断构建流程： secretsweep baseline . --output .secretsweep.baseline 4. **在 CI 中针对 baseline 进行验证** — 仅在达到或超过严重性阈值时遇到*新增* secret 才失败： secretsweep verify . --baseline .secretsweep.baseline --severity high 5. **调整扫描设置**（使用 allowlist 和熵检测器），或列出内置的规则包： secretsweep scan . --exclude '*/tests/*' --allow-regex 'AKIA_EXAMPLE_.*' --entropy-threshold 4.5 secretsweep rules --format json ## 目录 - [为什么选择 secretsweep？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关工具](#related) · [贡献](#contributing) ## 为什么选择 secretsweep？ 跨服务商的仓库 secret 扫描器 + 自动轮换工具 — 无需搭建重量级的基础设施。 `secretsweep` 是单一用途、可脚本化且可自托管的：将其指向目标，即可获取符合您现有工作流格式的优先级排序结果（table · JSON · SARIF），通过它来管控 CI，并让 agent 通过 MCP 驱动它。 ## 功能 - ✅ Shannon 熵 - ✅ 脱敏 - ✅ 文本扫描 - ✅ 路径扫描 - ✅ 轮换计划 - ✅ 可在 Linux/macOS/Windows · Docker · devcontainer 上运行 - ✅ 支持 Python, JavaScript, Go, 和 Rust 的移植版本 (`ports/`) ## 快速开始 ``` pip install cognis-secretsweep secretsweep --version secretsweep scan . # scan current project secretsweep scan . --format json # machine-readable secretsweep scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ secretsweep scan . [HIGH ] SEC-001 example finding (./src/app.py) [MEDIUM ] SEC-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[target / manifest] --> P[secretsweep
checks + rules] P --> OUT[findings (JSON / SARIF)] ``` ## 从任何 AI 技术栈中使用 `secretsweep` 可以与所有主流的 AI 使用方式实现互操作： - **MCP server** — `secretsweep mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **OpenAI 兼容 / JSON** — 将 `secretsweep scan . --format json` 的输出通过管道传递给任何 agent 或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** — 只需一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** — 为非 AI pipeline 提供 exit code + SARIF ## 对比 | | **Cognis secretsweep** | trufflesecurity | |---|:---:|:---:| | 可自托管，无需账号 | ✅ | 视情况而定 | | 单条命令，零配置 | ✅ | ⚠️ | | 用于 CI 的 JSON + SARIF | ✅ | 视情况而定 | | MCP 原生支持 (AI agents) | ✅ | ❌ | | 多语言移植版 (JS/Go/Rust) | ✅ | ❌ | | 开源许可证 | ✅ COCL | 视情况而定 | *秉承 **trufflesecurity/trufflehog** 的精神，以 Cognis 的方式重新构建。遗漏了致谢？欢迎提交 PR。* ## 集成 可接入您的技术栈：用于代码扫描的 **SARIF**，用于一切的 **JSON**，用于 AI agent 的 **MCP server** (`secretsweep mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 — 全平台的各种方式 ``` pip install "git+https://github.com/cognis-digital/secretsweep.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/secretsweep.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/secretsweep.git" # uv pip install cognis-secretsweep # PyPI (when published) docker run --rm ghcr.io/cognis-digital/secretsweep:latest --help # Docker brew install cognis-digital/tap/secretsweep # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/secretsweep/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/secretsweep` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 - [`depgraph`](https://github.com/cognis-digital/depgraph) — 依赖风险可视化工具 — Scorecard + OSV + typosquat + 维护者信号 - [`pipewatch-pro`](https://github.com/cognis-digital/pipewatch-pro) — CI/CD 供应链审计工具 — GH Actions / GitLab CI / OWASP CI/CD Top 10 - [`ossaudit`](https://github.com/cognis-digital/ossaudit) — OSS 许可证合规审计工具 — AGPL 污染 + NOTICE 生成 **探索套件 →** [🗂️ 全部 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, StruQ, 上游代理, 代码安全, 可视化界面, 安全助手, 安全合规, 数据可视化, 日志审计, 漏洞枚举, 网络代理, 请求拦截, 逆向工具