mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-07-15 14:27:20 +02:00
Initial commit
This commit is contained in:
Tanguy Duhamel
@@ -1,13 +1,28 @@
|
||||
# FuzzForge
|
||||
<p align="center">
|
||||
<img src="docs/static/img/fuzzforge_white.png" alt="FuzzForge Banner" width="20%">
|
||||
</p>
|
||||
<h1 align="center">FuzzForge 🚧</h1>
|
||||
|
||||
|
||||
<p align="center"><strong>AI-powered workflow automation and AI Agents for AppSec, Fuzzing & Offensive Security</strong></p>
|
||||
|
||||
**AI-powered workflow automation and AI Agents for AppSec, Fuzzing & Offensive Security**
|
||||
<p align="center">
|
||||
<a href="https://discord.com/invite/acqv9FVG"><img src="https://img.shields.io/discord/1420767905255133267?logo=discord&label=Discord" alt="Discord"></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/license-BSL%20%2B%20Apache-orange" alt="License: BSL + Apache"></a>
|
||||
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python 3.11+"/></a>
|
||||
<a href="https://fuzzforge.ai"><img src="https://img.shields.io/badge/Website-fuzzforge.ai-blue?logo=vercel" alt="Website"/></a>
|
||||
<img src="https://img.shields.io/badge/version-0.6.0-green" alt="Version">
|
||||
</p>
|
||||
|
||||
[](https://discord.com/invite/acqv9FVG)
|
||||
[](https://fuzzforge.ai)
|
||||
[](LICENSE)
|
||||
|
||||
<p align="center">
|
||||
<sub>
|
||||
<a href="#-overview"><b>Overview</b></a>
|
||||
• <a href="#-key-features"><b>Features</b></a>
|
||||
• <a href="#-installation"><b>Installation</b></a>
|
||||
• <a href="#-quickstart"><b>Quickstart</b></a>
|
||||
• <a href="#ai-powered-workflow-execution"><b>Demo</b></a>
|
||||
• <a href="#-contributing"><b>Contributing</b></a>
|
||||
</sub>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
@@ -22,51 +37,7 @@
|
||||
|
||||
FuzzForge is **open source**, built to empower security teams, researchers, and the community.
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quickstart
|
||||
|
||||
Run your first workflow in **3 steps**:
|
||||
|
||||
```bash
|
||||
# 1. Clone the repo
|
||||
git clone https://github.com/fuzzinglabs/fuzzforge.git
|
||||
cd fuzzforge
|
||||
|
||||
# 2. Build & run with Docker
|
||||
docker compose up
|
||||
|
||||
# 3. Access the UI
|
||||
open http://localhost:3000
|
||||
```
|
||||
|
||||
👉 More installation options in the [Documentation](https://fuzzforge.ai/docs).
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Example Workflow
|
||||
|
||||
Example: Run a workflow that audits an Android APK with AI agents:
|
||||
|
||||
```bash
|
||||
fuzzforge run workflows/android_apk_audit.yaml
|
||||
```
|
||||
|
||||
FuzzForge automatically orchestrates static analysis, AI-assisted reversing, and vulnerability triage.
|
||||
|
||||
---
|
||||
|
||||
## 🎥 Demos
|
||||
|
||||
### AI-Powered Workflow Execution
|
||||
|
||||
|
||||
*AI agents automatically analyzing code and providing security insights*
|
||||
|
||||
### Manual Workflow Setup
|
||||
|
||||
|
||||
*Setting up and running security workflows through the interface*
|
||||
> 🚧 FuzzForge is still a work in progress, you can [subscribe]() to get the latest news.
|
||||
|
||||
---
|
||||
|
||||
@@ -81,12 +52,83 @@ FuzzForge automatically orchestrates static analysis, AI-assisted reversing, and
|
||||
|
||||
---
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
### Requirements
|
||||
|
||||
**Python 3.11+**
|
||||
Python 3.11 or higher is required.
|
||||
|
||||
**uv Package Manager**
|
||||
```bash
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
**Docker**
|
||||
For containerized workflows, see the [Docker Installation Guide](https://docs.docker.com/get-docker/).
|
||||
|
||||
### CLI Installation
|
||||
|
||||
After installing the requirements, install the FuzzForge CLI:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/fuzzinglabs/fuzzforge_ai.git
|
||||
cd fuzzforge_ai
|
||||
|
||||
# Install CLI with uv (from the root directory)
|
||||
uv tool install --python python3.12 .
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quickstart
|
||||
|
||||
Run your first workflow in **3 steps**:
|
||||
|
||||
```bash
|
||||
# 1. Clone the repo
|
||||
git clone https://github.com/fuzzinglabs/fuzzforge.git
|
||||
cd fuzzforge
|
||||
|
||||
# 2. Build & run with Docker
|
||||
# Set registry host for your OS (local registry is mandatory)
|
||||
# macOS/Windows (Docker Desktop):
|
||||
export REGISTRY_HOST=host.docker.internal
|
||||
# Linux (default):
|
||||
# export REGISTRY_HOST=localhost
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
> The first launch can take 5-10 minutes due to Docker image building - a good time for a coffee break ☕
|
||||
|
||||
```bash
|
||||
# 3. Run your first workflow
|
||||
cd test_projects/vulnerable_app/ # Go into the test directory
|
||||
fuzzforge init # Init a fuzzforge project
|
||||
ff workflow security_assessment . # Start a workflow (you can also use ff command)
|
||||
```
|
||||
|
||||
### Manual Workflow Setup
|
||||
|
||||
|
||||
*Setting up and running security workflows through the interface*
|
||||
|
||||
👉 More installation options in the [Documentation](https://fuzzforge.ai/docs).
|
||||
|
||||
---
|
||||
|
||||
## AI-Powered Workflow Execution
|
||||
|
||||
|
||||
*AI agents automatically analyzing code and providing security insights*
|
||||
|
||||
## 📚 Resources
|
||||
|
||||
- 🌐 [Website](https://fuzzforge.ai)
|
||||
- 📖 [Documentation](https://fuzzforge.ai/docs)
|
||||
- 💬 [Community Discord](https://discord.com/invite/acqv9FVG)
|
||||
- 🎓 [FuzzingLabs Academy](https://academy.fuzzinglabs.com)
|
||||
- 🎓 [FuzzingLabs Academy](https://academy.fuzzinglabs.com/?coupon=GITHUB_FUZZFORGE)
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user