https://github.com/cla7aye15i4nd/patchagent
[USENIX Security 25] PatchAgent is a LLM-based practical program repair agent that mimics human expertise.
https://github.com/cla7aye15i4nd/patchagent
llm patch program-repair
Last synced: 5 months ago
JSON representation
[USENIX Security 25] PatchAgent is a LLM-based practical program repair agent that mimics human expertise.
- Host: GitHub
- URL: https://github.com/cla7aye15i4nd/patchagent
- Owner: cla7aye15I4nd
- License: apache-2.0
- Created: 2025-02-27T17:38:00.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-08T17:55:08.000Z (5 months ago)
- Last Synced: 2025-08-08T19:39:30.720Z (5 months ago)
- Topics: llm, patch, program-repair
- Language: Python
- Homepage: https://www.dataisland.org/patchagent
- Size: 11.4 MB
- Stars: 83
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PatchAgent
[](https://github.com/cla7aye15I4nd/PatchAgent/actions/workflows/ci.yaml)
[](https://opensource.org/licenses/Apache-2.0)
> [!NOTE]
> The original research repository is located at [osf.io/8k2ac](https://osf.io/8k2ac).
> This repository is a production-focused fork dedicated to real-world bug fixing.
## 📋 Overview
PatchAgent is an LLM-based program repair agent that mimics human expertise to automatically generate patches for real-world bugs. It integrates:
- **Language Server Protocol**: For accurate code navigation and analysis
- **Patch Verification**: For ensuring correct and safe fixes
- **Interaction Optimization**: To achieve human-like reasoning during vulnerability repair
## 🚀 Getting Started
### Prerequisites
- Python 3.12+
- Docker (for OSS-Fuzz integration)
- Git
### Installation
```bash
# Pull the image
docker pull ghcr.io/cla7aye15i4nd/patchagent:latest
# Run the container
docker run -it --privileged ghcr.io/cla7aye15i4nd/patchagent:latest
```
### Environment Configuration
Create a `.env` file based on the template:
```bash
cp .env.template .env
# Edit .env with your API keys and configuration
```
## 💻 Usage Example
PatchAgent can be used to repair real-world bugs. Here's a simple example:
```python
from patchagent.agent.generator import agent_generator
from patchagent.builder import OSSFuzzBuilder, OSSFuzzPoC
from patchagent.parser.sanitizer import Sanitizer
from patchagent.task import PatchTask
# Initialize the repair task
patchtask = PatchTask(
[OSSFuzzPoC("poc.bin", "libpng_read_fuzzer")], # Proof of Concept file with target
OSSFuzzBuilder(
"libpng", # Project name
"/path/to/libpng", # Source code path
"/path/to/oss-fuzz", # OSS-Fuzz path
[Sanitizer.AddressSanitizer], # Sanitizer to use
),
)
# Initialize and run the repair process
patchtask.initialize()
patch = patchtask.repair(agent_generator())
print(f"Generated patch: {patch}")
```
## 🛠️ Development Setup
For development, we recommend using the VS Code devcontainer:
1. Install the [VS Code Remote Development Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
2. Open the repository in VS Code
3. When prompted, click "Reopen in Container"
This will set up a fully configured development environment with all the necessary tools.
## 🔧 Supported Languages and Sanitizers
### Languages
- C/C++
- Java
### Sanitizers
- [AddressSanitizer (ASan)](https://github.com/google/sanitizers/wiki/AddressSanitizer)
- [MemorySanitizer (MSan)](https://github.com/google/sanitizers/wiki/MemorySanitizer)
- [UndefinedBehaviorSanitizer (UBSan)](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html)
- [ThreadSanitizer (TSan)](https://clang.llvm.org/docs/ThreadSanitizer.html)
- [Jazzer (Java fuzzing)](https://github.com/CodeIntelligenceTesting/jazzer)
## 🏆 Fixed Vulnerabilities
Below is a sample of the vulnerabilities fixed by PatchAgent. More will be disclosed as responsible disclosure periods end.
| Repository | Stars | Vulnerabilities |
| - | - | - |
| [assimp](https://github.com/assimp/assimp) | 11.4k | [#5763](https://github.com/assimp/assimp/pull/5763), [#5764](https://github.com/assimp/assimp/pull/5764), [#5765](https://github.com/assimp/assimp/pull/5765) |
| [libssh2](https://github.com/libssh2/libssh2) | 1.4k | [#1508](https://github.com/libssh2/libssh2/pull/1508) |
| [hdf5](https://github.com/HDFGroup/hdf5) | 0.6k | [#5201](https://github.com/HDFGroup/hdf5/pull/5201), [#5210](https://github.com/HDFGroup/hdf5/pull/5210) |
| [libredwg](https://github.com/LibreDWG/libredwg) | 1.0k | [#1061](https://github.com/LibreDWG/libredwg/pull/1061) |
| [Pcap++](https://github.com/seladb/PcapPlusPlus) | 2.8k | [#1678](https://github.com/seladb/PcapPlusPlus/pull/1678), [#1680](https://github.com/seladb/PcapPlusPlus/pull/1680), [#1699](https://github.com/seladb/PcapPlusPlus/pull/1699) |
## 📄 License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
## 📞 Contact
For questions, bugs, or feature requests:
- Create [GitHub issues](https://github.com/cla7aye15I4nd/PatchAgent/issues)
- For direct communication related to PatchAgent, contact [Zheng Yu](https://www.dataisland.org)
## 📚 Citation
To cite PatchAgent in scientific publications, please use:
```bibtex
@inproceedings{PatchAgent,
title = {PatchAgent: A Practical Program Repair Agent Mimicking Human Expertise},
author = {Yu, Zheng and Guo, Ziyi and Wu, Yuhang and Yu, Jiahao and
Xu, Meng and Mu, Dongliang and Chen, Yan and Xing, Xinyu},
booktitle = {34rd USENIX Security Symposium (USENIX Security 25)},
year = {2025}
}
```