cryptophil92/audit-suite

# Audit Suite [](https://github.com/cryptophil92/audit-suite/actions/workflows/shellcheck.yml) [](LICENSE)     实验性和本地化的防御性网络审计套件，主要为 Kali Linux 和授权的实验室环境设计。 ## 项目状态 项目处于实验阶段。Bash 引擎、JSON 输出、本地历史记录、报告、只读本地 API 以及一个初步的仪表板已经就绪。部分模块仍不完整或仅作为工作基础。不提供任何生产环境支持，也不保证结果的详尽性。 2026 年 7 月 28 日的专业化审计记录在 [`docs/audit/`](docs/audit/) 中。已确认的问题和建议的改进在 [GitHub issues](https://github.com/cryptophil92/audit-suite/issues) 中进行跟踪，并设有 [专门的路线图](https://github.com/cryptophil92/audit-suite/issues/58)。 ## 现有功能 - 严格的 IPv4 和 CIDR 目标验证； - 默认阻止公共网段，可通过显式指定 `--allow-public` 豁免； - 支持 `fast`、`full` 和 `stealth` 配置文件选择； - 网络发现和 Nmap 扫描； - 初步的 SMB 和 HTTP 服务检测/枚举； - 模块化编排，带每个模块的超时限制； - 支持 dry-run（空转）和不执行扫描的 JSON 预览； - JSON 清单、本地历史记录和运行结果对比； - HTML 报告和报告归档； - 只读的本地 HTTP API； - 无需外部前端依赖的本地 Web 仪表板。 ### 重要的功能限制 - SNMP、Zeek 和 Suricata 模块目前仍是骨架或占位符； - SMB 模块仅执行初步检测； - Web 界面可以准备和查看，但无法启动审计； - 不保证在 Kali/Linux 之外的平台上的可移植性； - 审计发现的某些可靠性和安全性问题仍然悬而未决。 在使用前，请查阅 [`docs/KNOWN_LIMITATIONS.md`](docs/KNOWN_LIMITATIONS.md) 和 [`docs/audit/TECHNICAL_AUDIT_2026-07-28.md`](docs/audit/TECHNICAL_AUDIT_2026-07-28.md)。 ## 架构 ``` audit.sh Lanceur et orchestration principale core/ Parsing, validation, runner, logs, historique, rapports modules/ Modules d’audit Bash bin/ Commandes JSON, rapports, diagnostic et smoke test api/server.py API HTTP locale en lecture seule api/openapi.json Spécification OpenAPI actuelle VERSION Source canonique de la version applicative web/index.html Tableau de bord local statique ui/ Aides d’interface terminal tests/ Tests Bash et test fonctionnel de l’API docs/ Documentation produit, technique, UX et sécurité ``` 主要流程如下： ``` Arguments / menus ↓ Validation des cibles et des modules ↓ Préflight des dépendances et détection de l’environnement ↓ Exécution séquentielle des modules ↓ Manifest → rapport HTML → archive → historique local ``` 详细的清单记录在 [`docs/audit/REPOSITORY_INVENTORY.md`](docs/audit/REPOSITORY_INVENTORY.md) 中。 ## 前置条件 ### 基准平台 - Kali Linux 或兼容的 Linux 发行版； - Bash 5 或兼容版本； - 用于本地 API 的 Python 3.10 或更高版本； - 具备执行所选网络功能所需的足够权限。 ### 引擎必需的依赖项 - `nmap` - `jq` - `tar` - `gzip` - GNU `timeout` 某些模块仅需要额外的工具，特别是 `whatweb`、`snmpwalk`、`zeek` 或 `suricata`。 本地检查： ``` bash bin/check_deps.sh ``` 脚本默认不安装任何内容。交互式选项 `--install` 会使用 `apt-get`，在使用前必须进行审查。 ## 安装 本项目尚未提供系统软件包或安装程序。 ``` git clone https://github.com/cryptophil92/audit-suite.git cd audit-suite chmod +x audit.sh bin/*.sh modules/*.sh ui/*.sh bash bin/check_deps.sh ``` 依赖项的系统版本未锁定。为了实现可重现的环境，请在每次审计活动中记录所使用的发行版和工具版本。 ## 快速开始 ### 无扫描验证 ``` bash bin/smoke_local.sh ``` ``` bash audit.sh \ --dry-run \ --profile fast \ --targets 192.168.1.0/24 \ --categories all \ --run-id DRY_RUN_LOCAL \ --no-zeek \ --no-suricata ``` ### 授权审计 ``` bash audit.sh \ --profile fast \ --targets 192.168.1.0/24 \ --categories 10_network_discovery.sh,20_portscan_nmap.sh \ --run-id AUDIT_LAB_001 \ --no-zeek \ --no-suricata ``` 请从 `--dry-run` 开始。请勿将此示例用于未经授权审计的目标。 ### 本地 API 和仪表板 ``` python3 api/server.py --host 127.0.0.1 --port 8765 ``` 然后打开 `http://127.0.0.1:8765/`。 请保持监听在 `127.0.0.1`。在此阶段，暴露在其他接口上既不安全也不受支持。 ## 配置 CLI 选项优先于交互式菜单： ``` --profile --targets --categories --run-id --no-udp --no-zeek --no-suricata --allow-public --dry-run --list-modules ``` 基准配置文件存储在 `etc/profiles/` 中。有关参数的详细说明，请参阅 [`docs/CLI_ARGS.md`](docs/CLI_ARGS.md)。 ## 结果和本地数据 ``` output// Résultats et manifest logs//combined.log Journal combiné history/runs.jsonl Index local history/latest.json Dernier run détaillé ``` 这些数据可能会暴露网络的拓扑结构、服务和漏洞。请勿将其公开，并在共享前检查任何归档的内容。 ## 测试 本套件包含 20 个 `tests/test_*.sh` 脚本和一个冒烟测试： ``` for test_file in tests/test_*.sh; do bash "$test_file" done bash bin/smoke_local.sh ``` CI 在 Ubuntu 下执行 ShellCheck 和大部分测试。2026 年 7 月 28 日的审计指出了 CI 覆盖率的差距，以及在 Windows Git Bash 下 API 测试的超时问题；请参阅 [`docs/audit/TEST_RESULTS_2026-07-28.md`](docs/audit/TEST_RESULTS_2026-07-28.md)。 ## 截图与演示 公开的截图尚未验证。制作计划和保密规则位于 [`docs/assets/screenshots/README.md`](docs/assets/screenshots/README.md)。初步的线框图记录在 [`docs/ux/WIREFRAMES.md`](docs/ux/WIREFRAMES.md) 中。 ## 平台 | 平台 | 状态 | |---|---| | Kali Linux | 主要目标，审计后仍需进行实际验证 | | 兼容的 Linux | 可行，但取决于系统工具和权限 | | 原生 Windows | 不受支持；使用 Git Bash 可进行部分读取/测试 | | 通过 WSL 的 Windows | 推荐的方案，但在此审计中未经验证 | | macOS | 不受支持，需要抽象化多个 Linux 依赖项 | | 本地 Web | 查看界面；引擎仍在本地运行且依赖于 OS | | Android/移动端 | 在此阶段不推荐 | 参见 [`docs/CROSS_PLATFORM_FEASIBILITY.md`](docs/CROSS_PLATFORM_FEASIBILITY.md)。 ## 路线图 推荐顺序： 1. 保护已发布的数据并修复引擎阻塞问题； 2. 提高状态、历史记录、API 和 CI 的可靠性； 3. 稳定安装过程、版本和 releases； 4. 改进仪表板、可访问性和报告； 5. 与授权用户一起验证工作流程； 6. 研究可移植性而不过早重写。 详细的路线图可在 [`docs/ROADMAP.md`](docs/ROADMAP.md) 和 [GitHub issue #58](https://github.com/cryptophil92/audit-suite/issues/58) 中查看。完整的调查结果登记表保存在 [`docs/audit/ISSUE_REGISTER.md`](docs/audit/ISSUE_REGISTER.md) 中。 ## 安全 - 使用框架：[`docs/SECURITY.md`](docs/SECURITY.md)； - 负责任的披露：[`SECURITY.md`](SECURITY.md)； - 切勿在公开的 issue 中发布任何密钥、审计结果、地址、服务指纹或利用方法。 ## 许可证 除非另有说明，Audit Suite 基于 [Apache 2.0 许可证](LICENSE) 分发。 版权所有 2026 Cryptophil ([cryptophil92](https://github.com/cryptophil92))。 适用的归属和例外情况，特别是针对改编自 Contributor Covenant 2.1 的行为准则的部分，在 [`NOTICE`](NOTICE) 中进行了说明。 ## 版本和发布 应用程序版本仅在 [`VERSION`](VERSION) 中定义。该版本会通过 `./audit.sh --version`、`bash bin/version_json.sh`、本地 API 和运行清单与源 commit 一起公开。 SemVer 策略、预检查和发布流程记录在 [`docs/RELEASING.md`](docs/RELEASING.md) 中。在旨在用于首次 release 的 P0/P1 问题 未经验证之前，不应创建任何新 tag。 ## 作者和维护 项目由 [cryptophil92](https://github.com/cryptophil92) 维护。欢迎在遵守上述法律和道德规范的前提下，通过 issues 提供贡献和反馈。

标签：Bash, CTI, Nmap, 云存储安全, 对称加密, 应用安全, 插件系统, 本地仪表盘, 网络扫描, 自动化审计, 虚拟驱动器, 逆向工具