mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-02-13 13:13:15 +00:00
187b171360
Updated all documentation to reflect actual v0.7.0 workflow implementation: Workflow name changes: - Removed all references to non-existent workflows (static_analysis_scan, secret_detection_scan, infrastructure_scan, penetration_testing_scan) - Updated examples to use actual workflows (security_assessment, gitleaks_detection, trufflehog_detection, llm_secret_detection) - Deleted docs/docs/reference/workflows/static-analysis.md (described non-existent workflow) Content corrections: - Fixed workflow tool descriptions (removed incorrect Semgrep/Bandit references, documented actual SecurityAnalyzer and FileScanner modules) - Updated all workflow lists to show production-ready vs development status - Fixed all example configurations to match actual workflow parameters Module creation guide fixes: - Fixed 4 path references: backend/src/toolbox → backend/toolbox - Updated import statements in example code Files updated: - docs/index.md - workflow list, CLI example, broken tutorial links - docs/docs/tutorial/getting-started.md - workflow list, example output, tool descriptions - docs/docs/how-to/create-module.md - module paths and imports - docs/docs/how-to/mcp-integration.md - workflow examples and list - docs/docs/ai/prompts.md - workflow example - docs/docs/reference/cli-ai.md - 3 workflow references
117 lines
5.3 KiB
Markdown
117 lines
5.3 KiB
Markdown
# FuzzForge Documentation
|
|
|
|
Welcome to FuzzForge, a comprehensive security analysis platform built on Temporal that automates security testing workflows. FuzzForge provides production-ready workflows that run static analysis, secret detection, infrastructure scanning, penetration testing, and custom fuzzing campaigns with Docker-based isolation and SARIF-compliant reporting.
|
|
|
|
## 🚀 Quick Navigation
|
|
|
|
### 📚 **Tutorials** - *Learn by doing*
|
|
Perfect for newcomers who want to learn FuzzForge step by step.
|
|
|
|
- [**Getting Started**](tutorials/getting-started.md) - Complete setup from installation to first workflow
|
|
|
|
### 🛠️ **How-To Guides** - *Problem-focused solutions*
|
|
Step-by-step guides for specific tasks and common problems.
|
|
|
|
- [**Docker Setup**](how-to/docker-setup.md) - Docker requirements and worker profiles
|
|
- [**Create Workflow**](how-to/create-workflow.md) - Build custom security workflows
|
|
- [**Create Module**](how-to/create-module.md) - Develop security analysis modules
|
|
- [**API Integration**](how-to/api-integration.md) - REST API usage and integration
|
|
- [**MCP Integration**](how-to/mcp-integration.md) - AI assistant integration setup
|
|
- [**Troubleshooting**](how-to/troubleshooting.md) - Common issues and solutions
|
|
|
|
### 💡 **Concepts** - *Understanding-oriented*
|
|
Background information and conceptual explanations.
|
|
|
|
- [**Architecture**](concepts/architecture.md) - System design and component interactions
|
|
- [**Workflows**](concepts/workflows.md) - How workflows function and interact
|
|
- [**Security Analysis**](concepts/security-analysis.md) - Security analysis methodology
|
|
- [**Docker Containers**](concepts/docker-containers.md) - Containerization approach
|
|
- [**SARIF Format**](concepts/sarif-format.md) - Industry-standard security results format
|
|
|
|
### 📖 **Reference** - *Information-oriented*
|
|
Technical reference materials and specifications.
|
|
|
|
#### Workflows
|
|
- [**All Workflows**](reference/workflows/index.md) - Complete workflow reference
|
|
- [**Static Analysis**](reference/workflows/static-analysis.md) - Code vulnerability detection
|
|
- [**Secret Detection**](reference/workflows/secret-detection.md) - Credential discovery
|
|
- [**Infrastructure Scan**](reference/workflows/infrastructure-scan.md) - Infrastructure security
|
|
- [**Penetration Testing**](reference/workflows/penetration-testing.md) - Security testing
|
|
- [**Language Fuzzing**](reference/workflows/language-fuzzing.md) - Input validation testing
|
|
- [**Security Assessment**](reference/workflows/security-assessment.md) - Comprehensive analysis
|
|
|
|
#### APIs and Interfaces
|
|
- [**REST API**](reference/api/index.md) - Complete API documentation
|
|
- [**CLI Reference**](reference/cli/index.md) - Command-line interface
|
|
- [**Configuration**](reference/configuration.md) - System configuration options
|
|
|
|
#### Additional Resources
|
|
- [**AI Orchestration (Advanced)**](../ai/docs/index.md) - Multi-agent orchestration, A2A services, ingestion, and LLM configuration
|
|
- [**Docker Configuration**](reference/docker-configuration.md) - Complete Docker setup requirements
|
|
- [**Contributing**](reference/contributing.md) - Development and contribution guidelines
|
|
- [**FAQ**](reference/faq.md) - Frequently asked questions
|
|
- [**Changelog**](reference/changelog.md) - Version history and updates
|
|
|
|
---
|
|
|
|
## 🎯 FuzzForge at a Glance
|
|
|
|
**Production-Ready Workflows:**
|
|
- Security Assessment - Regex-based analysis for secrets, SQL injection, dangerous functions
|
|
- Gitleaks Detection - Pattern-based secret scanning
|
|
- TruffleHog Detection - Pattern-based secret scanning
|
|
- LLM Secret Detection - AI-powered secret detection (requires API key)
|
|
|
|
**Development Workflows:**
|
|
- Atheris Fuzzing - Python fuzzing (early development)
|
|
- Cargo Fuzzing - Rust fuzzing (early development)
|
|
- OSS-Fuzz Campaign - OSS-Fuzz integration (heavy development)
|
|
|
|
**Multiple Interfaces:**
|
|
- 💻 **CLI**: `fuzzforge workflow run security_assessment /path/to/code`
|
|
- 🐍 **Python SDK**: Programmatic workflow integration
|
|
- 🌐 **REST API**: HTTP-based workflow management
|
|
- 🤖 **MCP**: AI assistant integration (Claude, ChatGPT)
|
|
|
|
**Key Features:**
|
|
- Container-based workflow execution with Docker isolation
|
|
- SARIF-compliant security results format
|
|
- Real-time workflow monitoring and progress tracking
|
|
- Persistent result storage with shared volumes
|
|
- Custom Docker image building for specialized tools
|
|
|
|
---
|
|
|
|
## 🚨 Important Setup Requirement
|
|
|
|
**Environment Configuration Required**
|
|
|
|
Before starting FuzzForge, you **must** create the environment configuration file:
|
|
|
|
```bash
|
|
cp volumes/env/.env.example volumes/env/.env
|
|
```
|
|
|
|
Docker Compose will fail without this file. You can leave it with default values if you're only using basic workflows (no AI features).
|
|
|
|
See [Getting Started Guide](tutorials/getting-started.md) for detailed setup instructions.
|
|
|
|
---
|
|
|
|
## 📋 Documentation Framework
|
|
|
|
This documentation follows the [Diátaxis framework](https://diataxis.fr/):
|
|
|
|
- **Tutorials**: Learning-oriented, hands-on lessons
|
|
- **How-to guides**: Problem-oriented, step-by-step instructions
|
|
- **Concepts**: Understanding-oriented, theoretical knowledge
|
|
- **Reference**: Information-oriented, technical specifications
|
|
|
|
---
|
|
|
|
**New to FuzzForge?** Start with the [Getting Started Tutorial](tutorials/getting-started.md)
|
|
|
|
**Need help?** Check the [FAQ](reference/faq.md) or [Troubleshooting Guide](how-to/troubleshooting.md)
|
|
|
|
**Want to contribute?** See the [Contributing Guide](reference/contributing.md)
|