cognis-digital/uefiscan

``` pip install cognis-uefiscan uefiscan scan . # → prioritized findings in seconds ``` ## 使用说明 —— 分步指南 1. **安装** (Python 3.9+)： pip install uefiscan 2. **扫描固件转储** 并输出红色/绿色的 Secure Boot 判定结果： uefiscan scan firmware.bin 3. **调整输出。** 切换为 JSON 格式以适配工具，或禁用 ANSI 颜色以捕获日志： uefiscan scan firmware.bin --format json uefiscan scan firmware.bin --no-color 4. 使用 `jq` **通过编程方式读取判定结果**： uefiscan scan firmware.bin --format json | jq .verdict 5. **在 CI 中进行拦截。** 当审计失败时退出码为非零，因此构建会在遇到不安全的镜像时中断： uefiscan scan firmware.bin || echo "Secure Boot audit FAILED" ## 目录 - [为什么选择 uefiscan？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关项目](#related) · [贡献指南](#contributing) ## 为什么选择 uefiscan？ 出于对供应链固件植入的担忧（在 LogoFAIL/BlackLotus 事件之后）—— 这是一个友好的 CLI 封装工具，它提供红色/绿色的直观判定结果，而不是像 CHIPSEC 那样输出一大堆令人眼花缭乱的信息。 `uefiscan` 是单一用途、可脚本化且支持自托管的：将其指向目标，以您的工作流已使用的格式（表格 · JSON · SARIF）获取经过优先级排序的结果，在 CI 中对其进行拦截，并让代理通过 MCP 驱动它。 ## 功能 - ✅ 查找 Firmware Volumes - ✅ 查找 Efi Variables - ✅ 查找 Pe Modules - ✅ 审计 Bytes - ✅ 审计 Image - ✅ 运行于 Linux/macOS/Windows · Docker · devcontainer - ✅ 提供 Python、JavaScript、Go 和 Rust 的移植版本 (`ports/`) ## 快速开始 ``` pip install cognis-uefiscan uefiscan --version uefiscan scan . # scan current project uefiscan scan . --format json # machine-readable uefiscan scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ uefiscan scan . [HIGH ] UEF-001 example finding (./src/app.py) [MEDIUM ] UEF-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[target / manifest] --> P[uefiscan
checks + rules] P --> OUT[findings (JSON / SARIF)] ``` ## 从任何 AI 技术栈中使用 `uefiscan` 能够与所有主流的 AI 使用方式实现互操作： - **MCP server** — `uefiscan mcp` (Claude Desktop、Cursor、Cognis.Studio、[uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **OpenAI 兼容 / JSON** — 将 `uefiscan scan . --format json` 通过管道传递给任何代理或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** — 一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** — 退出码 + SARIF 适用于非 AI 流水线 ## 对比 | | **Cognis uefiscan** | CHIPSEC + UEFITool | |---|:---:|:---:| | 支持自托管，无需账号 | ✅ | 视情况而定 | | 单一命令，零配置 | ✅ | ⚠️ | | 针对_ci_的_json_+_sarif | ✅ | 视情况而定 | | MCP 原生支持（AI 代理） | ✅ | ❌ | | 多语言端口（JS/Go/Rust） | ✅ | ❌ | | 开放许可 | ✅ COCL | 视情况而定 | *秉承 **CHIPSEC + UEFITool** 的精神，以 Cognis 的方式重新构建。遗漏了致谢？欢迎提交 PR。* ## 集成 可通过管道接入您的技术栈：用于代码扫描的 **SARIF**，适用于任何场景的 **JSON**，用于 AI 代理的 **MCP server** (`uefiscan mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 —— 任意方式，全平台支持 ``` pip install "git+https://github.com/cognis-digital/uefiscan.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/uefiscan.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/uefiscan.git" # uv pip install cognis-uefiscan # PyPI (when published) docker run --rm ghcr.io/cognis-digital/uefiscan:latest --help # Docker brew install cognis-digital/tap/uefiscan # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/uefiscan/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/uefiscan` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 - [`fwxray`](https://github.com/cognis-digital/fwxray) — 对比两个固件镜像并准确呈现其中的变化：新增的二进制文件、更改的配置标志、添加的证书以及发生偏移的熵区域。 - [`canzap`](https://github.com/cognis-digital/canzap) — 使用微型 YAML DSL 从 .pcap 文件或 SocketCAN 接口重放、模糊测试并断言 CAN 总线流量。 - [`sbomb`](https://github.com/cognis-digital/sbomb) — 直接从解包的固件根文件系统生成 CycloneDX SBOM，并标记出包含已知 CVE 和 EOL 内核的组件。 - [`mqttspy`](https://github.com/cognis-digital/mqttspy) — 被动映射 MQTT 代理：枚举主题、检测未经身份验证的写入、发现 payload 中的 PII/机密信息，并生成风险报告。 - [`modpot`](https://github.com/cognis-digital/modpot) — 搭建高交互 Modbus/DNP3 ICS 蜜罐，将攻击者的寄存器读取/写入操作记录为结构化 JSON。 - [`keyhunt`](https://github.com/cognis-digital/keyhunt) — 扫描固件 Blob 和文件系统转储，查找硬编码的私钥、API token、默认凭据以及较弱的 RSA/ECC 素材。 **探索全套工具 →** [🗂️ 全部 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)。

标签：Python, UEFI, Web报告查看器, 可视化界面, 固件安全, 数据可视化, 无后门, 日志审计, 漏洞审计, 请求拦截, 逆向工具