PandaX
AI Agent 代码审计门禁 — 让每一次代码改动都留下合规、可追溯的证据链。
中文
是什么?
PandaX 是一个 7 层防御体系,强制 AI Agent(或任何开发者)写代码前必须经过审计:
任何受保护文件的修改都必须通过 pandax write 命令,留下 reason / problem / approach 三段式审计记录。
适用场景:
- 🤖 AI Agent 开发:防止 Agent 绕过审查直接改代码
- 🏢 企业合规:满足 SOC2 / ISO 27001 等代码变更审计要求
- 👥 团队协作:所有 PR 必须有审计记录才能合入
核心特性
- 17 种文本格式 + 24 种二进制格式保护(
.py/.md/.json/.yml/.env/.png/.pdf/ ...) - 7 层防御体系(详见 防御体系)
- MCP Server 原生支持 — Claude / Cursor / Trae 等 AI IDE 直连
- 13 种审计日志导出格式(Excel / Word / PDF / SQLite / ...)
- 纯 Python — Windows / macOS / Linux 通吃,无 C 扩展
- 右键菜单集成 — 一行命令在 3 大平台安装原生右键菜单(HKCU / Quick Action / Nautilus + Dolphin)
- i18n 国际化 —
zh-CN/en双语 CLI 自动检测 +--lang强制 + 持久化偏好
快速开始
安装
方式 A:从 PyPI 安装(最简单)
pip install pandax-guard
# 一键装上右键菜单(Windows / macOS / Linux 自动检测)
pandax install-context
方式 B:从源码一键安装(推荐开发者使用,含最新 i18n + CI lint)
git clone https://github.com/hellob1889/PandaX.git
cd pandax
# Windows
powershell -ExecutionPolicy Bypass -File scripts/install.ps1
# macOS / Linux
./scripts/install.sh
安装脚本自动做:
- 检测 Python ≥ 3.10
- 探测 git(不在 PATH 时尝试常见安装路径)
- 卸载 site-packages 里可能存在的老 pandax 版本(避免版本冲突)
pip install -e .本地源码 editable 安装- 验证 pandax 可用(
python -m pandax --version) - 调用
doctor.py --fix --persist-path自动修复剩余问题(依赖、setuptools、指纹、PATH 持久化到 HKCU)
环境诊断(任何时候都能跑)
python scripts/doctor.py # 人类可读
python scripts/doctor.py --json # CI 用(返回 pass/fail)
python scripts/doctor.py --quiet # 只显示 WARN / FAIL
python scripts/doctor.py --fix # 自动修复 13 类问题(仅当前会话生效)
python scripts/doctor.py --fix --persist-path # 持久化 PATH 到 HKCU(重启 shell 生效)
python scripts/doctor.py --fix-only # 只跑修复 + 重测,跳过详细诊断
检测 9 个项目 + 自动修复 13 类问题(pip / git / pandax 装在 site-packages / pandax.exe PATH / 指纹污染 / setuptools / 5 个运行时依赖)。
--fix --persist-path 会做什么:
- 卸载 site-packages 老版本 → 重装本地源码
- 删除污染的
~/.pandax_fp.txt - 自动
pip install缺失的运行时依赖 - Windows:用
setx PATH "%PATH%;<Scripts>"持久化到HKCU\Environment\Path(新开的 PowerShell 自动看到) - macOS / Linux:追加
export PATH="..."到~/.bashrc/~/.zshrc
初始化项目
cd /path/to/your-project
pandax init --root .
# 自动:
# - 创建 .pandax/ 目录
# - 生成 config.json(17 文本 + 24 二进制扩展名)
# - 创建 binary_snapshots.json(SHA256 字典)
# - 初始化 .gitignore 排除
写代码(合规路径)
# 修改 Python 文件
pandax write \
--file src/main.py \
--reason "修复 user_id 类型注解" \
--problem "原代码用 int,实际可能是 None" \
--approach "改为 Optional[int]" \
--old 'def get_user(user_id: int):' \
--new 'def get_user(user_id: Optional[int]):'
# 替换二进制文件(图片/文档/PDF 等)
pandax write \
--file assets/logo.png \
--reason "更新品牌 logo" \
--problem "旧 logo 与新品牌色不匹配" \
--approach "用新版 logo 替换" \
--from-file /tmp/new_logo.png
查看审计日志
# 命令行查看
pandax log --last 10
# 导出为 Excel
pandax log --format xlsx --output audit_report.xlsx
# 导出为 PDF(含中文支持)
pandax log --format pdf --output audit_report.pdf
# 全部 13 种格式:text / csv / tsv / json / yaml / md / html / xlsx / docx / pdf / sqlite / rst / asciidoc
项目状态仪表盘
pandax status --root .
显示:项目路径、配置摘要、L1 锁定状态、二进制快照、最近审计、版本指纹等。
防御体系(7 层)
| 层 | 组件 | 作用 | 被绕过后的兜底 |
|---|---|---|---|
| L1 | file chmod | 文件级只读锁(attrib +r / chmod -w) | L2 watchdog |
| L2 | watchdog | 实时文件监控 + git checkout 回滚 | L3 hook |
| L3 | pre-commit hook | 严格校验每个 staged 文件的 APPROVED 记录 | L4 / L5 |
| L4 | 启动读 README | CLI 启动时加载项目元数据 | L5 |
| L5 | 自指纹 | CLI 自身 SHA256 检测篡改 | L6 |
| L6 | 二进制 SHA256 snapshot | 检测 .png/.pdf 等二进制篡改 | L7 |
| L7 | GitHub Actions CI | PR 合入前审计验证(最终兜底) | 人工 review |
MCP Server(AI Agent 直连)
// claude_desktop_config.json 或 Cursor MCP 配置
{
"mcpServers": {
"pandax": {
"command": "pandax-mcp",
"env": {}
}
}
}
暴露 11 个工具:pandax_init / pandax_lock / pandax_unlock / pandax_write / pandax_log / pandax_status / pandax_install_hook / pandax_watch / pandax_install_git / pandax_fingerprint_update / pandax_ci
真实场景测试
完整实战验证报告:实战验证报告.md
包含:
- 7 层防御每层实战证据
- L3 hook 严重 bug 的发现 + 修复
- 隐藏文件锁定 bug 的发现 + 修复
- 13 种导出格式实测
- MCP 协议完整工作流
详细示例集
- EXAMPLES.md — 10 个真实工作流 + 终端输出
- examples/ — 5 个可运行的 Python demo 脚本
- docs/ — 中英双语文档站(mkdocs)
- docs/index.html — 交互式 HTML 文档首页(带终端动画)
命令清单
| 命令 | 用途 |
|---|---|
pandax init |
初始化项目 |
pandax lock / unlock |
锁定 / 解锁所有受保护文件 |
pandax write |
核心:审计写入(支持文本/二进制) |
pandax log |
查询审计历史(13 种导出格式) |
pandax status |
项目状态仪表盘 |
pandax install-hook |
安装 L3 pre-commit hook |
pandax watch |
启动 L2 watchdog 守护进程 |
pandax serve |
🆕 Web 实时仪表盘(浏览器打开 localhost:8765,watchdog + SSE <100ms 推送) |
pandax install-git |
自动安装 git |
pandax ci |
L7 CI 验证(git diff vs audit log) |
pandax-mcp |
启动 MCP server(stdio JSON-RPC) |
开发与测试
git clone https://github.com/hellob1889/PandaX
cd pandax
pip install -e .[dev]
pytest tests/ -v
当前测试数:340 passed(覆盖 i18n / write / status / lock / ci / watchdog / export / init / e2e / serve / desktop-icon / gitignore)
路线图
| 版本 | 状态 | 关键能力 |
|---|---|---|
| v0.1.0 | ✅ | Phase 1-3 MVP(5 层防御) |
| v0.2.0 | ✅ | 多格式导出(7 种) |
| v0.3.0 | ✅ | 17 种文本保护 |
| v0.4.0 | ✅ | 24 种二进制 SHA256 |
| v0.5.0 | ✅ | MCP Server |
| v0.6.0 | ✅ | GitHub Actions CI |
| v0.6.1 | ✅ | L3 hook 强化(实战验证) |
| v0.6.2 | ✅ | 隐藏文件锁定 bug 修复 |
| v0.7.0 | ✅ | Phase 9 OS 右键菜单 + Phase 10 i18n(zh-CN/en)+ doctor.py 环境自检 + auto-fix 13 类 + PATH 持久化 |
| v0.7.2 | ✅ | CI 工程化修复:publish.yml Tests job 在干净 ubuntu-latest 容器 25s exit 1(setuptools pin 缺失)→ pin setuptools==80.10.2 + --no-build-isolation,新增 pytest log artifact 上传。340 测试通过 |
| v0.7.1 | ✅ | 28 个 bug 全修 + 4 大新功能:P0 安全(#8/#12×2/#22/#23)+ P1(#2/#5/#15/#29)+ P2(#21/#6/#20/#9-#10)+ P3(#13/#4/#26/#39)+ UX(#14/#17/#48/#25/#28)+ 工程化(#版本漂移 / #README 分组标签 / #CRLF 根因)+ 🆕 文件夹熊猫锁图标(desktop.ini + ICO)+ 🆕 Web 实时仪表盘(watchdog + SSE <100ms)+ 🆕 Git 兼容(init 自动写 .gitignore)+ 🆕 右键菜单真实可用验证,298 测试通过 |
完整历史:CHANGELOG.md
许可
MIT License — 详见 LICENSE
English
What is it?
PandaX is a 7-layer defense system that forces every code change through an audit gate.
Any modification to a protected file (17 text + 24 binary formats) must go through pandax write,
which records reason / problem / approach as immutable audit evidence.
Use cases
- 🤖 AI Agent development: prevent agents from bypassing review
- 🏢 Enterprise compliance: meet SOC2 / ISO 27001 code change audit requirements
- 👥 Team collaboration: every PR must have audit records before merging
Install
Option A: from PyPI (easiest)
pip install pandax-guard
Option B: from source (recommended for developers, includes latest i18n + CI lint)
git clone https://github.com/hellob1889/PandaX.git
cd pandax
# Windows
powershell -ExecutionPolicy Bypass -File scripts/install.ps1
# macOS / Linux
./scripts/install.sh
The install script automatically:
- Checks Python >= 3.10
- Locates git (scans common install paths if not in PATH)
- Removes stale pandax from site-packages (prevents version conflicts)
pip install -e .local source editable install- Verifies pandax works (
python -m pandax --version) - Runs
doctor.py --fix --persist-path(auto-fix remaining issues: deps / setuptools / fingerprint / persist PATH to HKCU)
Environment diagnostics (run anytime)
python scripts/doctor.py # human-readable
python scripts/doctor.py --json # CI mode (returns pass/fail)
python scripts/doctor.py --quiet # only WARN / FAIL
python scripts/doctor.py --fix # auto-fix 13 issue classes (session only)
python scripts/doctor.py --fix --persist-path # persist PATH to HKCU (new shell)
python scripts/doctor.py --fix-only # just fix + re-check, skip detailed diagnosis
Checks 9 items + auto-fixes 13 issue classes (pip / git / pandax-in-site-packages / pandax.exe PATH / fingerprint pollution / setuptools / 5 runtime dependencies).
What --fix --persist-path does:
- Uninstall stale site-packages version, reinstall local source
- Remove polluted
~/.pandax_fp.txt - Auto
pip installfor missing runtime deps - Windows: use
setx PATH "%PATH%;<Scripts>"to persist toHKCU\Environment\Path(new PowerShell shells see it automatically) - macOS / Linux: append
export PATH="..."to~/.bashrc/~/.zshrc
Quick start
cd /path/to/your-project
pandax init --root .
pandax write \
--file src/main.py \
--reason "Fix user_id type annotation" \
--problem "Original used int, could be None" \
--approach "Change to Optional[int]" \
--old 'def get_user(user_id: int):' \
--new 'def get_user(user_id: Optional[int]):'
7 Defense Layers
| Layer | Component | Purpose |
|---|---|---|
| L1 | file chmod | File-level read-only lock |
| L2 | watchdog | Real-time file monitoring + git checkout rollback |
| L3 | pre-commit hook | Strict per-file APPROVED validation |
| L4 | startup README | CLI loads project metadata on startup |
| L5 | self-fingerprint | CLI's own SHA256 detects tampering |
| L6 | binary SHA256 snapshot | Detect .png/.pdf binary tampering |
| L7 | GitHub Actions CI | Pre-merge audit verification (final backstop) |
MCP Server
{
"mcpServers": {
"pandax": {
"command": "pandax-mcp",
"env": {}
}
}
}
Exposes 11 tools for AI agents (Claude / Cursor / Trae).
License
MIT — see LICENSE
Links
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pandax_guard-0.7.2.tar.gz.
File metadata
- Download URL: pandax_guard-0.7.2.tar.gz
- Upload date:
- Size: 237.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb2d011e517da1b558fc34cf5de8f3d4b626ff39142dfa8d00ad077e0d30998c
|
|
| MD5 |
830a6a131f1e1b11d9f9dce904379ea4
|
|
| BLAKE2b-256 |
2b855e2b0826422c94e10e1e068c86603892c1e0f162618d41f639c8dc6bbfa2
|
Provenance
The following attestation bundles were made for pandax_guard-0.7.2.tar.gz:
Publisher:
publish.yml on hellob1889/PandaX
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pandax_guard-0.7.2.tar.gz -
Subject digest:
cb2d011e517da1b558fc34cf5de8f3d4b626ff39142dfa8d00ad077e0d30998c - Sigstore transparency entry: 2776825939
- Sigstore integration time:
-
Permalink:
hellob1889/PandaX@304cd6c0d1d33f632fe3c313d14d1a16e0eeea85 -
Branch / Tag:
refs/tags/v0.7.2 - Owner: https://github.com/hellob1889
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@304cd6c0d1d33f632fe3c313d14d1a16e0eeea85 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pandax_guard-0.7.2-py3-none-any.whl.
File metadata
- Download URL: pandax_guard-0.7.2-py3-none-any.whl
- Upload date:
- Size: 158.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
acf6c588d72e1fb67f1f21edd8901ae0cc51be0765fa4a85dfafb46c0cc72570
|
|
| MD5 |
073e8d1e32a596e7bcbb27aa6f7af173
|
|
| BLAKE2b-256 |
fc68a867f7439afd2cc7a7e489716d511ec827f15ee78945ae5790bd3f3fff00
|
Provenance
The following attestation bundles were made for pandax_guard-0.7.2-py3-none-any.whl:
Publisher:
publish.yml on hellob1889/PandaX
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pandax_guard-0.7.2-py3-none-any.whl -
Subject digest:
acf6c588d72e1fb67f1f21edd8901ae0cc51be0765fa4a85dfafb46c0cc72570 - Sigstore transparency entry: 2776826005
- Sigstore integration time:
-
Permalink:
hellob1889/PandaX@304cd6c0d1d33f632fe3c313d14d1a16e0eeea85 -
Branch / Tag:
refs/tags/v0.7.2 - Owner: https://github.com/hellob1889
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@304cd6c0d1d33f632fe3c313d14d1a16e0eeea85 -
Trigger Event:
push
-
Statement type: