# BugFlow

**Repository Path**: secpwn/bugflow

## Basic Information

- **Project Name**: BugFlow
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-30
- **Last Updated**: 2026-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BugFlow

AI 驱动的 C/C++ 代码安全审计工具

## 简介

BugFlow 是一款面向安全审计人员的 C/C++ 代码漏洞检测平台。通过结合传统静态分析工具（Clang/Clang-Tidy）与 AI 大模型（VulBERTa-MLP），实现高精度、可扩展的自动化代码安全审计。

## 核心特性

- **多引擎检测** - Clang 静态分析 + Clang-Tidy 规则 + AI 模型三重检测
- **大规模支持** - 智能代码分块，支持千万行级别代码库
- **知识增强** - RAG 系统持续学习历史审计经验
- **告警继承** - 支持精确/哈希/模糊三种匹配策略
- **离线部署** - Docker Compose 一键部署，支持内网隔离环境

## 技术架构

| 组件 | 技术选型 |
|------|---------|
| 前端 | Vue3 + Vite + Ant Design Vue + ECharts + Pinia |
| 后端 | FastAPI + SQLAlchemy + Celery |
| 数据库 | SQLite + Qdrant (向量) |
| AI 模型 | VulBERTa-MLP (可切换) |
| 扫描引擎 | Clang + Clang-Tidy |
| 部署 | Docker Compose |

## 快速开始

### 环境要求

- Ubuntu 24.04 LTS (amd64)
- Docker 24.0+
- Docker Compose 2.0+
- 内存: 16GB+
- 存储: 100GB+ SSD

### 在线环境部署

```bash
# 克隆项目
git clone https://gitee.com/your-org/bugflow.git
cd bugflow

# 启动服务
cd docker
docker compose up -d

# 访问
# Web UI: http://localhost:8080
# API Docs: http://localhost:8000/docs
```

### 离线环境部署

**步骤 1: 在有网环境准备离线包**
```bash
cd bugflow
chmod +x scripts/setup-offline.sh
./scripts/setup-offline.sh
```

**步骤 2: 复制到离线服务器并部署**
```bash
# 复制整个 bugflow 文件夹到目标服务器
chmod +x scripts/deploy-offline.sh
./scripts/deploy-offline.sh
```

## 使用指南

### 1. 创建项目

在「项目管理」页面创建新项目，配置代码路径：
- 本地路径：直接填写服务器上的代码路径
- 远程路径：填写 `用户名@IP:端口/路径` 格式

### 2. 启动扫描

选择项目后配置扫描参数：
- Clang 静态分析器
- Clang-Tidy 检查规则
- AI 模型及置信度阈值

### 3. 查看报告

扫描完成后查看漏洞报告：
- 按严重程度/状态筛选
- 确认/标记误报/修复
- 导出 Excel/CSV/JSON

### 4. 继承确认结果

新扫描可继承历史确认结果：
- 精确匹配：文件+行号+类型
- 哈希匹配：代码片段 hash
- 模糊匹配：代码相似度

### 5. 知识库管理

导入先验知识提高检测精度：
- 历史 Bug 报告
- CVE 漏洞数据
- 安全代码模式

## 项目结构

```
bugflow/
├── backend/          # FastAPI 后端
│   ├── app/
│   │   ├── api/      # API 路由
│   │   ├── core/     # 核心模块
│   │   ├── db/       # 数据库模型
│   │   └── schemas/  # Pydantic 模式
│   └── requirements.txt
├── frontend/         # Vue3 前端
│   ├── src/
│   └── package.json
├── docker/           # Docker 配置
│   ├── docker-compose.yml
│   └── Dockerfile.*
├── docs/             # 文档
│   └── bmad/         # BMad 规范文档
└── scripts/          # 部署脚本
```

## 文档

### BMad 规范文档
- [产品简报](docs/bmad/product-brief.md) - 项目愿景与核心价值
- [产品需求文档](docs/bmad/PRD.md) - 功能需求与非功能需求

### 详细文档
- [产品文档](docs/bmad/product.md) - 详细产品说明与用户指南
- [设计文档](docs/bmad/design.md) - 系统架构与技术方案
- [开发文档](docs/bmad/development.md) - 开发环境与代码规范
- [测试文档](docs/bmad/testing.md) - 测试策略与用例清单

## 许可证

MIT License