Skip to content

Commit 04e8a78

Browse files
committed
docs: polish README and add competition result
1 parent b38d90d commit 04e8a78

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@
33
<div align="center">
44

55
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
6+
[![CI](https://github.com/Fruit-Guardians/PureAutoCodeql/actions/workflows/ci.yml/badge.svg)](https://github.com/Fruit-Guardians/PureAutoCodeql/actions/workflows/ci.yml)
67
[![Python](https://img.shields.io/badge/python-3.13%2B-3776AB.svg)](https://www.python.org/)
78
[![CodeQL](https://img.shields.io/badge/CodeQL-enabled-2EA44F.svg)](https://codeql.github.com/)
89
[![FastAPI](https://img.shields.io/badge/API-FastAPI-009688.svg)](pure_auto_codeql/api/README.md)
910
[![uv](https://img.shields.io/badge/package-uv-DE5FE9.svg)](https://github.com/astral-sh/uv)
1011
[![Languages](https://img.shields.io/badge/lang-Java%20%7C%20Python%20%7C%20C%2FC%2B%2B-informational.svg)](#它做什么)
12+
[![Qiangwang Cup 2025](https://img.shields.io/badge/Qiangwang_Cup_2025-6th_Place-D4AF37.svg)](README.md)
1113

12-
**多智能体驱动的 CVE 自动分析与 CodeQL 查询生成流水线**
14+
**面向 CVE 复盘与源码审计的多智能体 CodeQL 自动化系统**
1315

14-
把「读漏洞情报 → 找 Source/Sink → 写并修好 CodeQL → 跑查询 → 筛路径」串成一条可复用流程。
15-
面向安全研究、漏洞复现与源码审计。
16+
从漏洞情报和补丁出发,自动定位 Source/Sink、生成并修复 CodeQL 查询,
17+
执行路径分析,最后留下可复核的 SARIF、QL、精选路径和运行清单。
18+
19+
🏆 *6th Place — 2025 Qiangwang Cup Industry-Specific Competition*
1620

1721
<br/>
1822

@@ -30,20 +34,23 @@
3034

3135
## 它做什么
3236

33-
CVE 复盘或审计时,常见流程是:读 advisory 和补丁、在代码里找入口与危险点、手写 CodeQL、修语法、跑查询,再从大量路径里挑出真正相关的几条。
37+
CVE 复盘或审计通常要反复处理几件事:阅读 advisory 和补丁、在源码中寻找入口与
38+
危险点、手写并调试 CodeQL,再从大量结果中筛出真正相关的路径。
3439

35-
**PureAutoCodeQL 把这条链路自动化**,给你结构化报告和可复用的查询产物。
40+
PureAutoCodeQL 将这些工作放进同一条可配置流水线,输出结构化结果和可继续维护的
41+
查询产物。
3642

37-
| 你的目标 | 系统产出 |
43+
| 分析任务 | 系统产出 |
3844
| --- | --- |
3945
| 弄清这个 CVE 在说什么 | 汇总本地 JSON / patch / 补充材料,可选拉取 NVD、GHSA |
4046
| 定位危险调用与用户可控输入 | Sink / Source Agent + 源码检索 + 语言 LSP |
4147
| 得到可执行的 CodeQL | 语言模板与内部知识库生成 Path Query,LSP 校验并迭代修复 |
4248
| 查询为空或数据流断掉 | 断流点分析,补 `isAdditionalFlowStep` 后重跑 |
4349
| 路径太多、噪声大 | 硬过滤 + 特征打分 + LLM 只读解释,收敛高质量路径 |
44-
| 接入平台或前端 | CLI 一键跑通;FastAPI + SSE 任务流 |
50+
| 接入平台或前端 | API/Worker 分离,PostgreSQL 保存状态,Redis Streams 分发任务与事件 |
51+
| 复查一次完整运行 | `manifest.json` 记录配置、步骤、版本、耗时、警告和产物哈希 |
4552

46-
**适合:** 安全研究、漏洞复现、定制 CodeQL 规则沉淀、需要结构化报告的审计场景
53+
适用于安全研究、漏洞复现、CodeQL 规则沉淀,以及需要保留结构化证据的源码审计
4754

4855
---
4956

@@ -224,6 +231,7 @@ output/
224231
└── CVE-XXXX-XXXX/
225232
└── YYYYMMDD-HHMMSS/
226233
├── summary.md # 完整分析报告
234+
├── manifest.json # 配置、版本、步骤状态与产物哈希
227235
├── sarif/
228236
│ └── codeql-run.sarif # CodeQL 原始结果
229237
├── codeql/
@@ -263,7 +271,7 @@ uv run pure-auto-codeql serve --host 127.0.0.1 --port 8000
263271

264272
```bash
265273
export API_AUTH_TOKEN="change-me"
266-
curl -H "Authorization: Bearer change-me" http://127.0.0.1:8000/api/projects
274+
curl -H "Authorization: Bearer change-me" http://127.0.0.1:8000/api/v1/projects
267275
```
268276

269277
更多: [API README](pure_auto_codeql/api/README.md) · [SSE 参考](pure_auto_codeql/api/SSE_REFERENCE.md) · [部署](docs/deployment.md)

0 commit comments

Comments
 (0)