Code Review AI Bot
Go to file
rockmelodies b1b0531e47 增加readme.md docker加速源配置方法 2025-12-24 19:05:14 +08:00
.github fix(agent): 修复任务取消和LLM流式处理的多项问题 2025-12-16 22:47:04 +08:00
backend 在 GoTestTool 类的 _build_wrapper_code 方法中,第 770 行有语法错误。 2025-12-24 17:39:24 +08:00
docker/sandbox feat: Update deployment configurations, dependency management, and documentation, including a new sandbox build service. 2025-12-15 15:18:55 +08:00
docs 更新 LLM_PROVIDERS.md 2025-12-22 21:39:58 +08:00
frontend chore: 更新DeepAudit导航图片 2025-12-23 09:58:55 +08:00
rules Initial commit: Add XCodeReviewer project files 2025-09-20 00:09:00 +08:00
scripts fix(agent): 修复工具执行结果处理中的 None 值问题 2025-12-15 10:24:58 +08:00
supabase/migrations feat(projects): add ZIP file upload support and source type tracking 2025-11-28 17:38:12 +08:00
.dockerignore feat(docker): Enhance Docker configuration for multi-provider LLM support 2025-10-24 16:41:29 +08:00
.gitignore chore: 忽略后端向量数据库数据目录 2025-12-16 15:13:40 +08:00
CHANGELOG.md chore: release v3.0.1 2025-12-16 22:55:19 +08:00
CONTRIBUTING.md docs: 更新 Python 和 Node.js 版本要求 2025-12-21 06:40:33 +08:00
DISCLAIMER.md chore: rebrand XCodeReviewer to DeepAudit across all files 2025-12-08 21:35:09 +08:00
LICENSE Add LICENSE file 2025-12-18 02:22:41 +08:00
README.md 增加readme.md docker加速源配置方法 2025-12-24 19:05:14 +08:00
README_EN.md 增加readme.md docker加速源配置方法 2025-12-24 19:05:14 +08:00
SECURITY.md chore: rebrand XCodeReviewer to DeepAudit across all files 2025-12-08 21:35:09 +08:00
docker-compose.prod.cn.yml chore: bump version to v3.0.2 2025-12-19 00:01:10 +08:00
docker-compose.prod.yml chore: bump version to v3.0.2 2025-12-19 00:01:10 +08:00
docker-compose.yml chore: bump version to v3.0.2 2025-12-19 00:01:10 +08:00
sgconfig.yml Initial commit: Add XCodeReviewer project files 2025-09-20 00:09:00 +08:00
tools.txt feat: Introduce Kunlun agent tool, add Docker and sandbox environment checks, and update agent services and frontend dialogs. 2025-12-15 02:00:34 +08:00

README_EN.md

DeepAudit - Your AI Security Audit Team, Making Vulnerability Discovery Accessible

简体中文 | English

DeepAudit Logo

Version License: AGPL-3.0 React TypeScript FastAPI Python Ask DeepWiki

Stars Forks

lintsinghua%2FDeepAudit | Trendshift

DeepAudit Demo

Screenshots

Agent Audit Entry

Agent Audit Entry

Quick access to Multi-Agent deep audit from homepage

Audit Flow Logs

Audit Flow Logs
Real-time view of Agent thinking and execution process
Smart Dashboard

Dashboard
Grasp project security posture at a glance
Instant Analysis

Instant Analysis
Paste code / upload files, get results in seconds
Project Management

Project Management
GitHub/GitLab import, multi-project collaboration

Professional Reports

Audit Report

One-click export to PDF / Markdown / JSON (Quick mode shown, not Agent mode report)

View Full Agent Audit Report Example


Overview

DeepAudit is a next-generation code security audit platform based on Multi-Agent collaborative architecture. It's not just a static scanning tool, but simulates the thinking patterns of security experts through autonomous collaboration of multiple agents (Orchestrator, Recon, Analysis, Verification), achieving deep code understanding, vulnerability discovery, and automated sandbox PoC verification.

We are committed to solving three major pain points of traditional SAST tools:

  • High false positive rate — Lack of semantic understanding, massive false positives consume manpower
  • Business logic blind spots — Cannot understand cross-file calls and complex logic
  • Lack of verification methods — Don't know if vulnerabilities are actually exploitable

Users only need to import a project, and DeepAudit automatically starts working: identify tech stack → analyze potential risks → generate scripts → sandbox verification → generate report, ultimately outputting a professional audit report.

Core Philosophy: Let AI attack like a hacker, defend like an expert.

Why Choose DeepAudit?

Traditional Audit Pain Points DeepAudit Solutions
Low manual audit efficiency
Can't keep up with CI/CD iteration speed, slowing release process
Multi-Agent Autonomous Audit
AI automatically orchestrates audit strategies, 24/7 automated execution
Too many false positives
Lack of semantic understanding, spending lots of time cleaning noise daily
RAG Knowledge Enhancement
Combining code semantics with context, significantly reducing false positives
Data privacy concerns
Worried about core source code leaking to cloud AI, can't meet compliance requirements
Ollama Local Deployment Support
Data stays on-premises, supports Llama3/DeepSeek and other local models
Can't confirm authenticity
Outsourced projects have many vulnerabilities, don't know which are truly exploitable
Sandbox PoC Verification
Automatically generate and execute attack scripts, confirm real vulnerability impact

System Architecture

Architecture Diagram

DeepAudit adopts microservices architecture, driven by the Multi-Agent engine at its core.

DeepAudit Architecture

Audit Workflow

Step Phase Responsible Agent Main Actions
1 Strategy Planning Orchestrator Receive audit task, analyze project type, formulate audit plan, dispatch tasks to sub-agents
2 Information Gathering Recon Agent Scan project structure, identify frameworks/libraries/APIs, extract attack surface (Entry Points)
3 Vulnerability Discovery Analysis Agent Combine RAG knowledge base with AST analysis, deep code review, discover potential vulnerabilities
4 PoC Verification Verification Agent (Critical) Write PoC scripts, execute in Docker sandbox. Self-correct and retry if failed
5 Report Generation Orchestrator Aggregate all findings, filter out verified false positives, generate final report

Project Structure

DeepAudit/
├── backend/                        # Python FastAPI Backend
│   ├── app/
│   │   ├── agents/                 # Multi-Agent Core Logic
│   │   │   ├── orchestrator.py     # Commander: Task Orchestration
│   │   │   ├── recon.py            # Scout: Asset Identification
│   │   │   ├── analysis.py         # Analyst: Vulnerability Discovery
│   │   │   └── verification.py     # Verifier: Sandbox PoC
│   │   ├── core/                   # Core Config & Sandbox Interface
│   │   ├── models/                 # Database Models
│   │   └── services/               # RAG, LLM Service Wrappers
│   └── tests/                      # Unit Tests
├── frontend/                       # React + TypeScript Frontend
│   ├── src/
│   │   ├── components/             # UI Component Library
│   │   ├── pages/                  # Page Routes
│   │   └── stores/                 # Zustand State Management
├── docker/                         # Docker Deployment Config
│   ├── sandbox/                    # Security Sandbox Image Build
│   └── postgres/                   # Database Initialization
└── docs/                           # Detailed Documentation

Quick Start

Using pre-built Docker images, no need to clone code, start with one command:

curl -fsSL https://raw.githubusercontent.com/lintsinghua/DeepAudit/v3.0.0/docker-compose.prod.yml | docker compose -f - up -d
💡 Configure Docker Registry Mirrors (Optional, for faster image pulling) (Click to expand)

If pulling images is still slow, you can configure Docker registry mirrors. Edit the Docker configuration file and add the following mirror sources:

Linux / macOS: Edit /etc/docker/daemon.json

Windows: Right-click Docker Desktop icon → Settings → Docker Engine

{
  "registry-mirrors": [
    "https://docker.1ms.run",
    "https://dockerproxy.com",
    "https://hub.rat.dev"
  ]
}

Restart Docker service after saving:

# Linux
sudo systemctl restart docker

# macOS / Windows
# Restart Docker Desktop application

Success! Visit http://localhost:3000 to start exploring.


Option 2: Clone and Deploy

Suitable for users who need custom configuration or secondary development:

# 1. Clone project
git clone https://github.com/lintsinghua/DeepAudit.git && cd DeepAudit

# 2. Configure environment variables
cp backend/env.example backend/.env
# Edit backend/.env and fill in your LLM API Key

# 3. One-click start
docker compose up -d

First startup will automatically build the sandbox image, which may take a few minutes.


Development Guide

For developers doing secondary development and debugging.

Requirements

  • Python 3.11+
  • Node.js 20+
  • PostgreSQL 15+
  • Docker (for sandbox)

1. Backend Setup

cd backend
# Use uv for environment management (recommended)
uv sync
source .venv/bin/activate

# Start API service
uvicorn app.main:app --reload

2. Frontend Setup

cd frontend
pnpm install
pnpm dev

3. Sandbox Environment

Development mode requires pulling the sandbox image locally:

docker pull ghcr.io/lintsinghua/deepaudit-sandbox:latest

Multi-Agent Intelligent Audit

Supported Vulnerability Types

Vulnerability Type Description
sql_injection SQL Injection
xss Cross-Site Scripting
command_injection Command Injection
path_traversal Path Traversal
ssrf Server-Side Request Forgery
xxe XML External Entity Injection
Vulnerability Type Description
insecure_deserialization Insecure Deserialization
hardcoded_secret Hardcoded Secrets
weak_crypto Weak Cryptography
authentication_bypass Authentication Bypass
authorization_bypass Authorization Bypass
idor Insecure Direct Object Reference

For detailed documentation, see Agent Audit Guide


Supported LLM Platforms

International Platforms

OpenAI GPT-4o / GPT-4
Claude 3.5 Sonnet / Opus
Google Gemini Pro
DeepSeek V3

Chinese Platforms

Qwen (Tongyi Qianwen)
Zhipu GLM-4
Moonshot Kimi
Wenxin · MiniMax · Doubao

Local Deployment

Ollama
Llama3 · Qwen2.5 · CodeLlama
DeepSeek-Coder · Codestral
Code stays on-premises

Supports API proxies to solve network access issues | Detailed configuration → LLM Platform Support


Feature Matrix

Feature Description Mode
Agent Deep Audit Multi-Agent collaboration, autonomous audit strategy orchestration Agent
RAG Knowledge Enhancement Code semantic understanding, CWE/CVE knowledge base retrieval Agent
Sandbox PoC Verification Docker isolated execution, verify vulnerability validity Agent
Project Management GitHub/GitLab import, ZIP upload, 10+ language support General
Instant Analysis Code snippet analysis in seconds, paste and use General
Five-Dimensional Detection Bug · Security · Performance · Style · Maintainability General
What-Why-How Precise location + cause explanation + fix suggestions General
Audit Rules Built-in OWASP Top 10, supports custom rule sets General
Prompt Templates Visual management, bilingual support General
Report Export One-click export to PDF / Markdown / JSON General
Runtime Configuration Configure LLM in browser, no service restart needed General

Roadmap

We are continuously evolving, with more language support and stronger Agent capabilities coming.

  • Basic static analysis, Semgrep integration
  • RAG knowledge base introduction, Docker security sandbox support
  • Multi-Agent Collaborative Architecture (Current)
  • Support for more realistic simulated service environments for more authentic vulnerability verification
  • Optimize sandbox from function_call to stable MCP service
  • Auto-Fix: Agent directly submits PRs to fix vulnerabilities
  • Incremental PR Audit: Continuously track PR changes, intelligently analyze vulnerabilities, integrate with CI/CD
  • Optimized RAG: Support custom knowledge bases

Contributing & Community

Contributing Guide

We warmly welcome your contributions! Whether it's submitting Issues, PRs, or improving documentation. Please check CONTRIBUTING.md for details.

Contact

Feel free to reach out for technical discussions, feature suggestions, or collaboration opportunities!

Contact
Email lintsinghua@qq.com
GitHub @lintsinghua

💬 Community Group

Welcome to join our QQ group for discussion, sharing, learning, and chatting~

QQ Group

License

This project is open-sourced under the AGPL-3.0 License.

Star History

Star History Chart
Made with ❤️ by lintsinghua

Acknowledgements

Thanks to the following open-source projects for their support:

FastAPI · LangChain · LangGraph · ChromaDB · LiteLLM · Tree-sitter · Kunlun-M · Strix · React · Vite · Radix UI · TailwindCSS · shadcn/ui


Important Security Notice

  1. Any unauthorized vulnerability testing, penetration testing, or security assessment is prohibited
  2. This project is only for cybersecurity academic research, teaching, and learning purposes
  3. It is strictly prohibited to use this project for any illegal purposes or unauthorized security testing

Vulnerability Reporting Responsibility

  1. When discovering any security vulnerabilities, please report them through legitimate channels promptly
  2. It is strictly prohibited to use discovered vulnerabilities for illegal activities
  3. Comply with national cybersecurity laws and regulations, maintain cyberspace security

Usage Restrictions

  • Only for educational and research purposes in authorized environments
  • Prohibited for security testing on unauthorized systems
  • Users are fully responsible for their own actions

Disclaimer

The author is not responsible for any direct or indirect losses caused by the use of this project. Users bear full legal responsibility for their own actions.


Detailed Security Policy

For detailed information about installation policy, disclaimer, code privacy, API usage security, and vulnerability reporting, please refer to DISCLAIMER.md and SECURITY.md files.

Quick Reference

  • Code Privacy Warning: Your code will be sent to the selected LLM provider's servers
  • Sensitive Code Handling: Use local models for sensitive code
  • Compliance Requirements: Comply with data protection and privacy laws
  • Vulnerability Reporting: Report security issues through legitimate channels