LeeHueeng/privit-project
GitHub: LeeHueeng/privit-project
Aegis Security CLI 是一个经过授权的、被动式安全测试命令行工具,通过范围限制、数据脱敏和安全默认策略,在非破坏性前提下完成安全验证并生成多格式报告。
Stars: 1 | Forks: 0
# Aegis Security CLI
Aegis Security CLI 是一个经过授权的、非破坏性的安全验证 CLI。
它会在执行前强制进行范围限制,从安全目录中选择检查项,对敏感数据进行脱敏,并生成 JSON、Markdown、HTML 和 SARIF 报告。
它是 Privit Aegis Workspace 使用的可重用 CLI 引擎:
。
## 语言
Aegis 支持韩语、日语、中文和英语。
```
npm run aegis -- help --lang ko-KR
npm run aegis -- help --lang ja-JP
npm run aegis -- help --lang zh-CN
npm run aegis -- help --lang en-US
AEGIS_LANG=ko-KR npm run aegis -- help
```
本地化文档生成在以下目录:
- `docs/ko-KR/`
- `docs/ja-JP/`
- `docs/zh-CN/`
- `docs/en-US/`
## 快速开始
```
npm install
npm run catalog:generate
npm run aegis -- init
npm run aegis -- scope verify
npm run aegis -- plan --mode passive --target frontend
npm run aegis -- run --target frontend --mode passive --dry-run
npm run aegis -- report --format html
```
当此仓库公开后,可以直接从 GitHub 安装:
```
npm install -g github:LeeHueeng/privit-project
aegis help --lang ko-KR
```
该包已准备作为 `aegis-security-cli` 在 npm 上发布,但尚未发布到 npm。
## 安全默认设置
- 在规划或运行之前,必须提供 `aegis.scope.json`。
- 主机和路径必须与白名单匹配。
- 生产环境默认仅允许被动模式。
- 阻断破坏性、暴力破解、数据泄露、持久化和规避行为。
- 不允许 LLM 创建或执行任意 shell 命令。
- 报告和绑定到 LLM 的数据会被脱敏。
## 命令
```
aegis init
aegis scope verify
aegis catalog generate
aegis docs generate --lang all
aegis docs generate --lang ko-KR
aegis docs generate --lang ja-JP
aegis docs generate --lang zh-CN
aegis docs generate --lang en-US
aegis plan --mode passive --target frontend
aegis run --mode passive --target frontend --dry-run
aegis findings list
aegis report --format markdown
aegis report --format html
aegis report --format sarif
```
## 生成的文件
- `aegis.scope.json`:授权、目标白名单、环境、安全限制。
- `aegis.policy.json`:被阻止的行为和工具适配器策略。
- `aegis.auth.json`:仅包含测试账户元数据。
- `aegis.plan.json`:为某次运行选择的安全检查。
- `catalog/security-checks.jsonl`:2,430 条生成的安全验证检查。
- `docs/AGENT_SECURITY_CHECKS.md`:Agent 和适配器操作指南。
- `docs/HUMAN_SECURITY_GUIDE.md`:人类使用指南。
- `docs/{ko-KR,ja-JP,zh-CN,en-US}/`:本地化的 Agent 和人类指南。
- `.aegis/`:本地扫描结果、artifacts、findings 和报告。
## 文档
- 示例:[`docs/EXAMPLES.md`](./docs/EXAMPLES.md)
- 架构:[`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md)
- 检测目录:[`docs/DETECTION_CATALOG.md`](./docs/DETECTION_CATALOG.md)
- 发布流程:[`docs/RELEASE_PROCESS.md`](./docs/RELEASE_PROCESS.md)
- 路线图:[`docs/ROADMAP.md`](./docs/ROADMAP.md)
## 安全模型
本项目仅供授权测试使用。请勿将其用于您不拥有或未获得书面测试许可的系统。破坏性、暴力破解、数据泄露、持久化和规避行为默认会被阻断。
## 贡献
只要能保持默认行为安全且处于被动模式,欢迎提交 Issues 和 pull requests。请从 [`CONTRIBUTING.md`](./CONTRIBUTING.md) 开始,并在提交 pull request 之前运行 `npm test`。
标签:GNU通用公共许可证, MITM代理, Node.js, SARIF, Snort++, 国际化, 安全测试, 攻击性安全, 文档结构分析, 暗色界面, 自定义脚本, 被动扫描