blairmichaelg/secbrain
GitHub: blairmichaelg/secbrain
一款基于多代理 AI 架构的 Web3 安全审计与漏洞赏金自动化平台,集成 DeFi 防护模板与受保护执行环境。
Stars: 1 | Forks: 0
# SecBrain
[](https://github.com/blairmichaelg/secbrain/actions/workflows/security-scan.yml)
[](https://github.com/blairmichaelg/secbrain/actions/workflows/solidity-security.yml)
[](https://github.com/blairmichaelg/secbrain/actions/workflows/code-quality.yml)
[](https://github.com/blairmichaelg/secbrain/actions/workflows/python-testing.yml)
[](https://github.com/blairmichaelg/secbrain/actions/workflows/foundry-fuzzing.yml)
[](LICENSE)
[](https://www.python.org/downloads/)
## 概述
SecBrain 是一个 CLI 优先的 Python 项目,利用协调一致的 AI 代理团队自动化执行漏洞赏金工作流。它结合了:
- **多代理架构**:针对每个阶段(侦察、假设、利用、分类、报告)的专业代理
- **研究优先方法**:增强的 Perplexity 集成,具有基于 TTL 的缓存、速率限制,以及用于严重性评估、攻击向量和市场条件分析的专业研究方法
- **顾问监督**:Gemini 模型审查关键决策
- **受保护的执行**:ACL、速率限制、熔断开关和人工批准检查点
### 🛡️ 新特性:DeFi 安全模板
**可用于生产环境的 Solidity 模板,可防御最新的 2023-2024 漏洞利用模式:**
- 📘 **[快速入门指南](docs/DEFI_SECURITY_QUICKSTART.md)** - 10 分钟内获得保护
- 📕 **[完整保护指南](docs/DEFI_EXPLOIT_PROTECTION_GUIDE.md)** - 深入了解所有保护模式
- ✅ **[安全检查表](docs/DEFI_SECURITY_CHECKLIST.md)** - 部署前验证
- 🔧 **[模板](docs/testing-examples/)** - 即拿即用的 Solidity 合约
**保护措施包括:**
- ✅ 只读重入攻击(Curve Finance 攻击向量)
- ✅ 通过闪电贷进行的预言机操纵(TWAP + Chainlink)
- ✅ MEV 抵抗(三明治攻击、抢跑交易)
- ✅ 闪电贷检测与预防
- ✅ 全面的访问控制
- ✅ 滑点保护
## 关键特性
- 🔍 **自动化侦察**,集成 subfinder、amass、httpx
- 🧠 **漏洞假设生成**,利用 AI 推理
- 🔬 **研究支撑的测试**,具有增强的 Perplexity 集成:
- 带有漏洞利用示例的真实世界严重性上下文
- 从近期漏洞利用中发现的攻击向量
- 用于漏洞利用验证的市场状况分析
- 基于 TTL 的智能缓存(1h-168h)
- 严格的速率限制(10 次/分钟)
- ✅ **顾问审查**,在关键检查点进行
- 🛡️ **安全控制**:范围强制执行、速率限制、熔断开关
- 📊 **结构化日志**,采用 JSONL 格式
- 📝 **报告生成**,包含 CWE/CVE 参考
- 📈 **洞察仪表板**,提供可操作的安全发现
## 快速开始
### 🚀 新特性:综合安全分析工作流
使用 12+ 种安全工具和 AI 驱动的洞察分析任何公共存储库:
```
# 通过 GitHub Actions 运行全面的安全分析
gh workflow run comprehensive-security-analysis.yml \
-f target_repo=https://github.com/owner/repo \
-f target_type=mixed \
-f analysis_depth=standard \
-f enable_ai_analysis=true \
-f enable_fuzzing=true
# 或通过 GitHub UI:Actions → "🔒 Comprehensive Security Analysis" → Run workflow
```
**功能:**
- 🔍 静态分析(Slither、Semgrep、Bandit、Solhint)
- 🎲 模糊测试(Foundry、Echidna)
- 🔮 符号执行(Mythril)
- 🤖 AI 驱动的分析(SecBrain 代理)
- 📊 自动化报告生成并附带 GitHub issues
完整文档请参阅 [综合安全分析指南](docs/guides/COMPREHENSIVE_SECURITY_ANALYSIS_QUICKREF.md)。
### 快速赏金挖掘工作流
想立即开始在 Immunefi 上挖掘漏洞?试试这个:
```
# 1. 安装 SecBrain
pip install -e ".[dev]"
# 2. 发现高价值目标
secbrain immunefi list --min-bounty 1000000 --limit 5
# 3. 研究新出现的漏洞
secbrain research --timeframe 90 --output findings.json
# 4. 获取特定程序的情报
secbrain immunefi intelligence --program thresholdnetwork
# 5. 查看您的指标(提交后)
secbrain metrics summary
```
详细工作流请参阅 [Immunefi 集成指南](docs/IMMUNEFI_INTEGRATION_GUIDE.md)。
### 验证一切正常
在做任何其他事情之前,请验证一切工作正常:
```
# 有关完整的验证步骤,请参阅 VERIFICATION.md
# 快速测试:
cd secbrain
python3 -m pip install -e ".[dev]"
cd ..
secbrain run \
--scope secbrain/examples/dummy_target/scope.yaml \
--program secbrain/examples/dummy_target/program.json \
--workspace /tmp/test \
--dry-run
```
完整的验证步骤请参阅 [VERIFICATION.md](docs/guides/VERIFICATION.md)。
### 安装
```
# 克隆仓库
git clone https://github.com/blairmichaelg/secbrain.git
cd secbrain
# 使用 uv 安装(推荐)
uv sync
# 或使用 pip
pip install -e ".[dev]"
```
### 设置 API 密钥
**所有配置均使用免费层模型!** 详情请参阅 [FREE_TIER_MODELS.md](docs/guides/FREE_TIER_MODELS.md)。
```
# 研究集成所需(Perplexity PRO 免费 - 无限制)
export PERPLEXITY_API_KEY=pplx-xxxx
# 顾问模型所需(Google PRO 免费)
export GOOGLE_API_KEY=AIza-xxxx
# 工作者模型所需(Together AI 免费层级)
export TOGETHER_API_KEY=your-together-key # Recommended: Together AI (FREE tier)
# 或使用替代的免费提供商(参见 FREE_TIER_MODELS.md):
# export GROQ_API_KEY=your-groq-key # 替代方案:Groq(免费层级)
# export OPENROUTER_API_KEY=your-openrouter-key # 替代方案:OpenRouter(免费模型)
```
**注意:** 所有默认模型均配置为使用免费层。无需付费 API 调用!
### 运行空运行测试
```
secbrain run \
--scope examples/dummy_target/scope.yaml \
--program examples/dummy_target/program.json \
--workspace ./targets/test \
--dry-run
```
### 测试增强的研究功能
```
# 运行研究集成测试脚本
python test_research.py
```
这将验证:
- 基于 TTL 的缓存行为
- 速率限制执行(10 次/分钟)
- 专业研究方法(严重性、攻击向量、市场状况)
- 与现有方法的向后兼容性
### 从结果生成洞察
```
# 生成洞察报告
secbrain insights --workspace ./targets/protocol1
# 生成 HTML 报告并在浏览器中打开
secbrain insights --workspace ./targets/protocol1 --format html --open
```
## 文档
### 核心文档
- 📖 [架构](secbrain/docs/architecture-updated.md) - 系统设计和组件
- 🔄 [工作流](secbrain/docs/workflows.md) - 运行模式和阶段
- 🛠️ [操作指南](secbrain/docs/ops.md) - 设置和使用
- 🔒 [威胁模型](secbrain/docs/threat_model.md) - 安全注意事项
- 📊 [洞察指南](secbrain/docs/INSIGHTS-GUIDE.md) - 将数据转化为可操作的洞察
- 🧪 [不变量测试](docs/INVARIANT_TESTING.md) - 智能合约的 Foundry 不变量测试
- 🔧 [故障排除指南](docs/TROUBLESHOOTING.md) - 常见问题和解决方案
### 工作流优化与分析 🚀
- 📈 [**赏金工作流分析**](docs/guides/BOUNTY_WORKFLOW_ANALYSIS.md) - **完整的工作流分析、工具清单和优化路线图**
- ⚡ [**工作流优化指南**](docs/guides/WORKFLOW_OPTIMIZATION_GUIDE.md) - **优化功能、工具使用和最佳实践**
- 📋 [运行分析指导](docs/guides/RUN_ANALYSIS_GUIDANCE.md) - 调试零发现运行
- 🔧 [优化指南](docs/guides/OPTIMIZATION-GUIDE.md) - 性能和效率最佳实践
### 贡献与质量
- 🤝 [贡献指南](CONTRIBUTING.md) - 如何贡献
- 🧪 [测试策略](docs/TESTING-STRATEGIES.md) - 高级测试方法
- 🔐 [安全模式](docs/SOLIDITY_SECURITY_PATTERNS.md) - 智能合约安全
- 🎯 [Git 快速入门](docs/GIT_QUICK_START.md) - Git 工作流基础
- 🤖 [自动化代理](secbrain/docs/automated-agents.md) - CI/CD 自动化套件
### 快速参考
- ⚡ [自动化快速参考](docs/guides/AUTOMATION-QUICK-REF.md) - 日常工作流和工具
- 📋 [测试快速参考](docs/TESTING-QUICK-REF.md) - 快速测试命令
- 📚 [文档索引](docs/README.md) - 所有贡献者指南
- 🎯 [Immunefi 集成指南](docs/IMMUNEFI_INTEGRATION_GUIDE.md) - 漏洞赏金平台集成
- 💰 [免费层模型](docs/guides/FREE_TIER_MODELS.md) - 使用免费 API 层
- 📦 [依赖管理](docs/guides/DEPENDENCY-MANAGEMENT.md) - 管理项目依赖
- ✅ [验证指南](docs/guides/VERIFICATION.md) - 如何验证安装和设置
## CLI 命令
### 核心命令
| 命令 | 描述 |
|---------|-------------|
| `secbrain run` | 执行赏金工作流 |
| `secbrain insights` | 从工作区生成可操作的洞察报告 |
| `secbrain validate` | 验证配置文件 |
| `secbrain version` | 显示版本 |
### 漏洞赏金命令(新)
| 命令 | 描述 |
|---------|-------------|
| `secbrain immunefi` | 访问 Immunefi 平台情报(list、show、trends、intelligence) |
| `secbrain research` | 利用前沿模式进行高级漏洞研究 |
| `secbrain metrics` | 跟踪和分析漏洞赏金成功指标 |
详细的 CLI 选项请参阅 [操作指南](secbrain/docs/ops.md)。
## 新特性:增强的漏洞赏金能力
SecBrain 现在包含提高您漏洞赏金发现能力的高级功能:
### 🎯 Immunefi 平台集成
- **高价值目标发现** - 自动识别赏金 ≥$500K 的项目
- **项目情报** - 获取关于范围、奖励和关注领域的综合数据
- **趋势漏洞** - 追踪近期成功提交中出现的新模式
- **优先级评分** - 基于赏金、活跃度和成功率对项目进行 0-100 排名
```
# 寻找高价值目标
secbrain immunefi list --min-bounty 1000000
# 获取程序情报
secbrain immunefi intelligence --program wormhole
```
### 🔬 高级研究代理
- **新兴模式发现** - 6+ 种前沿漏洞类型(2024-2025)
- **协议特定分析** - 深入研究目标协议
- **新颖假设生成** - AI 驱动的漏洞发现
- **真实世界利用数据** - 从超过 $2B 的历史黑客攻击中学习
**追踪的关键模式:**
- 基于意图的协议漏洞利用(平均 $450K)
- 跨链桥漏洞(平均 $2.3M)
- 只读重入攻击(平均 $180K)
- ERC-4337 账户抽象问题(平均 $320K)
- ZK 证明验证缺陷
- 集中流动性 MEV(平均 $125K)
```
# 研究新出现的漏洞
secbrain research --timeframe 90 --output findings.json
# 分析特定协议
secbrain research --protocol "Threshold Network" --contracts "TBTC,Bridge"
```
### 📊 成功指标跟踪
- **提交跟踪** - 记录所有赏金提交和结果
- **模式有效性** - 了解哪些漏洞类型具有最高的成功率
- **持续学习** - 获取提高接受率的洞察
- **决策支持** - 基于历史数据提供是否提交的建议
```
# 查看您的成功指标
secbrain metrics summary
# 查看最有效的模式
secbrain metrics patterns
# 获取改进见解
secbrain metrics insights
```
完整文档请参阅 [Immunefi 集成指南](docs/IMMUNEFI_INTEGRATION_GUIDE.md)。
## 项目结构
```
secbrain/
├── secbrain/ # Main Python package
│ ├── agents/ # Agent implementations
│ ├── cli/ # CLI interface
│ ├── core/ # Context, logging, types
│ ├── insights/ # Insights aggregation and reporting
│ ├── models/ # Model abstractions
│ ├── tools/ # Tool wrappers
│ ├── workflows/ # Orchestration logic
│ └── docs/ # Core project documentation
├── docs/ # Contributor-focused guides
├── config/ # Configuration files
├── examples/ # Example targets
├── scripts/ # Utility scripts
├── targets/ # Target analysis workspaces
└── tests/ # Test suite
```
## 开发
### 代码质量
```
# 运行 linter
cd secbrain
python -m ruff check .
# 自动修复问题
python -m ruff check . --fix
```
### 安全扫描
SecBrain 包含用于检测安全漏洞的自定义 Semgrep 规则:
```
# 运行所有自定义安全规则
semgrep --config=.semgrep/rules/ secbrain/
# 运行特定规则类别
semgrep --config=.semgrep/rules/subprocess-injection.yml secbrain/
semgrep --config=.semgrep/rules/sql-injection.yml secbrain/
semgrep --config=.semgrep/rules/command-injection.yml secbrain/
semgrep --config=.semgrep/rules/general-security.yml secbrain/
# 运行 Solidity 安全规则
semgrep --config=.semgrep/rules/solidity-security.yml targets/
# 运行并自动修复(如可用)
semgrep --config=.semgrep/rules/ --autofix secbrain/
```
自定义规则检测:
- 🔒 **子进程注入** - 通过子进程调用的 Shell 注入
- 🔒 **SQL 注入** - 不安全的 SQL 查询构建
- 🔒 **命令注入** - OS 命令注入漏洞
- 🔒 **Solidity 漏洞** - 重入、未检查调用、访问控制问题
- 🔒 **常规安全** - 硬编码密钥、弱加密、路径遍历
详细的规则文档请参阅 [`.semgrep/README.md`](.semgrep/README.md)。
### 运行测试
SecBrain 采用全面的多层测试策略:
```
cd secbrain
# 标准单元测试
python -m pytest tests/ -v
# 基于属性的测试(使用 Hypothesis)
python -m pytest tests/test_property_based.py -v --hypothesis-show-statistics
# 运行并收集覆盖率
python -m pytest tests/ --cov=secbrain --cov-report=term-missing
# 变异测试(验证测试质量)
mutmut run --paths-to-mutate=secbrain/utils/
```
针对智能合约测试:
```
# 快速模糊测试(32 次运行)
FOUNDRY_PROFILE=quick forge test
# 标准模糊测试(256 次运行)
forge test
# CI 模糊测试(10,000 次运行)
FOUNDRY_PROFILE=ci forge test
# 仅不变量测试
forge test --match-contract Invariant -vvv
# 使用 CI 配置文件的不变量测试(全面)
FOUNDRY_PROFILE=ci forge test --match-contract Invariant -vvv
# Echidna 模糊测试(如已安装)
echidna . --contract EchidnaTestExample --config echidna.yaml
```
**不变量测试覆盖范围:**
- SingleAssetStaking:余额一致性、会计核算、暂停状态
- WOETH:ERC4626 属性、转换一致性、储备资产
- LidoARM:流动性管理、份额核算
详情请参阅 [不变量测试指南](docs/INVARIANT-TESTING-GUIDE.md)。
**高级测试功能:**
- 🧪 **基于属性的测试**:Hypothesis 生成数千个随机输入
- 🔬 **模糊测试**:Foundry/Echidna 用于全面的智能合约测试
- 🧬 **变异测试**:Mutmut 验证测试套件质量
- 📊 **不变量测试**:基于处理程序的状态机测试
更多详情请参阅 [测试策略](docs/TESTING-STRATEGIES.md)。
## 安全控制
1. **范围强制执行**:所有操作均根据 scope.yaml 进行验证
2. **速率限制**:可配置的单工具限制和全局上限
3. **熔断开关**:外部文件或 API 信号以立即停止
4. **人工批准**:高风险操作需要批准
5. **空运行模式**:完整模拟,无网络调用
## 贡献
我们欢迎贡献!无论您是修复错误、添加功能还是改进文档,我们都感谢您的帮助。
### 针对初学者
- 📖 **从这里开始**:[Git 快速入门指南](docs/GIT_QUICK_START.md)
- 📚 **完整指南**:[贡献指南](CONTRIBUTING.md)
### 快速贡献流程
```
# 1. Fork 并克隆仓库
git clone https://github.com/blairmichaelg/secbrain.git
cd secbrain
# 2. 创建功能分支
git checkout -b feature/my-improvement
# 3. 进行更改并提交
git add .
git commit -m "Add: brief description of changes"
# 4. 推送并创建 PR
git push -u origin feature/my-improvement
```
### 当前 CI 状态
我们的 GitHub Actions CI 自动运行:
- ✅ **Linting**(ruff)- 代码风格检查
- ⚠️ **类型检查**(mypy)- 目前为非阻塞状态,我们正在修复遗留类型错误
- ✅ **单元测试** - pytest 及覆盖率要求
- ✅ **集成测试** - 空运行验证
更多详情请参阅 [CI 状态](docs/CI_STATUS.md)。
## 许可证
MIT
## 📄 许可证
本项目采用 MIT 许可证授权 - 详情请参阅 [LICENSE](LICENSE) 文件。
## 🙏 致谢
- 基于尖端的 AI 模型和安全研究构建
- 由开源工具驱动:Foundry、Slither、Semgrep 等
- 灵感来源于安全研究和漏洞赏金社区
**需要帮助? 请查看 [文档](docs/README.md) 或 [提出 issue](https://github.com/blairmichaelg/secbrain/issues)!
**最后更新:** 2026 年 1 月 8 日
标签:C2, CISA项目, DeFi, DLL 劫持, Foundry, FTP漏洞扫描, PyRIT, Python, SecBrain, Solidity, Web3安全, 人工智能, 代码安全, 加密货币安全, 区块链安全, 域名收集, 多智能体系统, 大语言模型, 安全编排, 密码管理, 攻击防御, 无后门, 智能合约审计, 漏洞枚举, 用户模式Hook绕过, 自动化渗透测试, 逆向工具