mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-05-17 04:13:27 +02:00
ec812461d6
* feat: Complete migration from Prefect to Temporal BREAKING CHANGE: Replaces Prefect workflow orchestration with Temporal ## Major Changes - Replace Prefect with Temporal for workflow orchestration - Implement vertical worker architecture (rust, android) - Replace Docker registry with MinIO for unified storage - Refactor activities to be co-located with workflows - Update all API endpoints for Temporal compatibility ## Infrastructure - New: docker-compose.temporal.yaml (Temporal + MinIO + workers) - New: workers/ directory with rust and android vertical workers - New: backend/src/temporal/ (manager, discovery) - New: backend/src/storage/ (S3-cached storage with MinIO) - New: backend/toolbox/common/ (shared storage activities) - Deleted: docker-compose.yaml (old Prefect setup) - Deleted: backend/src/core/prefect_manager.py - Deleted: backend/src/services/prefect_stats_monitor.py - Deleted: Docker registry and insecure-registries requirement ## Workflows - Migrated: security_assessment workflow to Temporal - New: rust_test workflow (example/test workflow) - Deleted: secret_detection_scan (Prefect-based, to be reimplemented) - Activities now co-located with workflows for independent testing ## API Changes - Updated: backend/src/api/workflows.py (Temporal submission) - Updated: backend/src/api/runs.py (Temporal status/results) - Updated: backend/src/main.py (727 lines, TemporalManager integration) - Updated: All 16 MCP tools to use TemporalManager ## Testing - ✅ All services healthy (Temporal, PostgreSQL, MinIO, workers, backend) - ✅ All API endpoints functional - ✅ End-to-end workflow test passed (72 findings from vulnerable_app) - ✅ MinIO storage integration working (target upload/download, results) - ✅ Worker activity discovery working (6 activities registered) - ✅ Tarball extraction working - ✅ SARIF report generation working ## Documentation - ARCHITECTURE.md: Complete Temporal architecture documentation - QUICKSTART_TEMPORAL.md: Getting started guide - MIGRATION_DECISION.md: Why we chose Temporal over Prefect - IMPLEMENTATION_STATUS.md: Migration progress tracking - workers/README.md: Worker development guide ## Dependencies - Added: temporalio>=1.6.0 - Added: boto3>=1.34.0 (MinIO S3 client) - Removed: prefect>=3.4.18 * feat: Add Python fuzzing vertical with Atheris integration This commit implements a complete Python fuzzing workflow using Atheris: ## Python Worker (workers/python/) - Dockerfile with Python 3.11, Atheris, and build tools - Generic worker.py for dynamic workflow discovery - requirements.txt with temporalio, boto3, atheris dependencies - Added to docker-compose.temporal.yaml with dedicated cache volume ## AtherisFuzzer Module (backend/toolbox/modules/fuzzer/) - Reusable module extending BaseModule - Auto-discovers fuzz targets (fuzz_*.py, *_fuzz.py, fuzz_target.py) - Recursive search to find targets in nested directories - Dynamically loads TestOneInput() function - Configurable max_iterations and timeout - Real-time stats callback support for live monitoring - Returns findings as ModuleFinding objects ## Atheris Fuzzing Workflow (backend/toolbox/workflows/atheris_fuzzing/) - Temporal workflow for orchestrating fuzzing - Downloads user code from MinIO - Executes AtherisFuzzer module - Uploads results to MinIO - Cleans up cache after execution - metadata.yaml with vertical: python for routing ## Test Project (test_projects/python_fuzz_waterfall/) - Demonstrates stateful waterfall vulnerability - main.py with check_secret() that leaks progress - fuzz_target.py with Atheris TestOneInput() harness - Complete README with usage instructions ## Backend Fixes - Fixed parameter merging in REST API endpoints (workflows.py) - Changed workflow parameter passing from positional args to kwargs (manager.py) - Default parameters now properly merged with user parameters ## Testing ✅ Worker discovered AtherisFuzzingWorkflow ✅ Workflow executed end-to-end successfully ✅ Fuzz target auto-discovered in nested directories ✅ Atheris ran 100,000 iterations ✅ Results uploaded and cache cleaned * chore: Complete Temporal migration with updated CLI/SDK/docs This commit includes all remaining Temporal migration changes: ## CLI Updates (cli/) - Updated workflow execution commands for Temporal - Enhanced error handling and exceptions - Updated dependencies in uv.lock ## SDK Updates (sdk/) - Client methods updated for Temporal workflows - Updated models for new workflow execution - Updated dependencies in uv.lock ## Documentation Updates (docs/) - Architecture documentation for Temporal - Workflow concept documentation - Resource management documentation (new) - Debugging guide (new) - Updated tutorials and how-to guides - Troubleshooting updates ## README Updates - Main README with Temporal instructions - Backend README - CLI README - SDK README ## Other - Updated IMPLEMENTATION_STATUS.md - Removed old vulnerable_app.tar.gz These changes complete the Temporal migration and ensure the CLI/SDK work correctly with the new backend. * fix: Use positional args instead of kwargs for Temporal workflows The Temporal Python SDK's start_workflow() method doesn't accept a 'kwargs' parameter. Workflows must receive parameters as positional arguments via the 'args' parameter. Changed from: args=workflow_args # Positional arguments This fixes the error: TypeError: Client.start_workflow() got an unexpected keyword argument 'kwargs' Workflows now correctly receive parameters in order: - security_assessment: [target_id, scanner_config, analyzer_config, reporter_config] - atheris_fuzzing: [target_id, target_file, max_iterations, timeout_seconds] - rust_test: [target_id, test_message] * fix: Filter metadata-only parameters from workflow arguments SecurityAssessmentWorkflow was receiving 7 arguments instead of 2-5. The issue was that target_path and volume_mode from default_parameters were being passed to the workflow, when they should only be used by the system for configuration. Now filters out metadata-only parameters (target_path, volume_mode) before passing arguments to workflow execution. * refactor: Remove Prefect leftovers and volume mounting legacy Complete cleanup of Prefect migration artifacts: Backend: - Delete registry.py and workflow_discovery.py (Prefect-specific files) - Remove Docker validation from setup.py (no longer needed) - Remove ResourceLimits and VolumeMount models - Remove target_path and volume_mode from WorkflowSubmission - Remove supported_volume_modes from API and discovery - Clean up metadata.yaml files (remove volume/path fields) - Simplify parameter filtering in manager.py SDK: - Remove volume_mode parameter from client methods - Remove ResourceLimits and VolumeMount models - Remove Prefect error patterns from docker_logs.py - Clean up WorkflowSubmission and WorkflowMetadata models CLI: - Remove Volume Modes display from workflow info All removed features are Prefect-specific or Docker volume mounting artifacts. Temporal workflows use MinIO storage exclusively. * feat: Add comprehensive test suite and benchmark infrastructure - Add 68 unit tests for fuzzer, scanner, and analyzer modules - Implement pytest-based test infrastructure with fixtures - Add 6 performance benchmarks with category-specific thresholds - Configure GitHub Actions for automated testing and benchmarking - Add test and benchmark documentation Test coverage: - AtherisFuzzer: 8 tests - CargoFuzzer: 14 tests - FileScanner: 22 tests - SecurityAnalyzer: 24 tests All tests passing (68/68) All benchmarks passing (6/6) * fix: Resolve all ruff linting violations across codebase Fixed 27 ruff violations in 12 files: - Removed unused imports (Depends, Dict, Any, Optional, etc.) - Fixed undefined workflow_info variable in workflows.py - Removed dead code with undefined variables in atheris_fuzzer.py - Changed f-string to regular string where no placeholders used All files now pass ruff checks for CI/CD compliance. * fix: Configure CI for unit tests only - Renamed docker-compose.temporal.yaml → docker-compose.yml for CI compatibility - Commented out integration-tests job (no integration tests yet) - Updated test-summary to only depend on lint and unit-tests CI will now run successfully with 68 unit tests. Integration tests can be added later. * feat: Add CI/CD integration with ephemeral deployment model Implements comprehensive CI/CD support for FuzzForge with on-demand worker management: **Worker Management (v0.7.0)** - Add WorkerManager for automatic worker lifecycle control - Auto-start workers from stopped state when workflows execute - Auto-stop workers after workflow completion - Health checks and startup timeout handling (90s default) **CI/CD Features** - `--fail-on` flag: Fail builds based on SARIF severity levels (error/warning/note/info) - `--export-sarif` flag: Export findings in SARIF 2.1.0 format - `--auto-start`/`--auto-stop` flags: Control worker lifecycle - Exit code propagation: Returns 1 on blocking findings, 0 on success **Exit Code Fix** - Add `except typer.Exit: raise` handlers at 3 critical locations - Move worker cleanup to finally block for guaranteed execution - Exit codes now propagate correctly even when build fails **CI Scripts & Examples** - ci-start.sh: Start FuzzForge services with health checks - ci-stop.sh: Clean shutdown with volume preservation option - GitHub Actions workflow example (security-scan.yml) - GitLab CI pipeline example (.gitlab-ci.example.yml) - docker-compose.ci.yml: CI-optimized compose file with profiles **OSS-Fuzz Integration** - New ossfuzz_campaign workflow for running OSS-Fuzz projects - OSS-Fuzz worker with Docker-in-Docker support - Configurable campaign duration and project selection **Documentation** - Comprehensive CI/CD integration guide (docs/how-to/cicd-integration.md) - Updated architecture docs with worker lifecycle details - Updated workspace isolation documentation - CLI README with worker management examples **SDK Enhancements** - Add get_workflow_worker_info() endpoint - Worker vertical metadata in workflow responses **Testing** - All workflows tested: security_assessment, atheris_fuzzing, secret_detection, cargo_fuzzing - All monitoring commands tested: stats, crashes, status, finding - Full CI pipeline simulation verified - Exit codes verified for success/failure scenarios Ephemeral CI/CD model: ~3-4GB RAM, ~60-90s startup, runs entirely in CI containers. * fix: Resolve ruff linting violations in CI/CD code - Remove unused variables (run_id, defaults, result) - Remove unused imports - Fix f-string without placeholders All CI/CD integration files now pass ruff checks.
283 lines
9.1 KiB
Python
283 lines
9.1 KiB
Python
"""Project initialization commands."""
|
|
# Copyright (c) 2025 FuzzingLabs
|
|
#
|
|
# Licensed under the Business Source License 1.1 (BSL). See the LICENSE file
|
|
# at the root of this repository for details.
|
|
#
|
|
# After the Change Date (four years from publication), this version of the
|
|
# Licensed Work will be made available under the Apache License, Version 2.0.
|
|
# See the LICENSE-APACHE file or http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Additional attribution and requirements are provided in the NOTICE file.
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
import os
|
|
from textwrap import dedent
|
|
from typing import Optional
|
|
|
|
import typer
|
|
from rich.console import Console
|
|
from rich.prompt import Confirm, Prompt
|
|
|
|
from ..config import ensure_project_config
|
|
from ..database import ensure_project_db
|
|
|
|
console = Console()
|
|
app = typer.Typer()
|
|
|
|
|
|
@app.command()
|
|
def project(
|
|
name: Optional[str] = typer.Option(
|
|
None, "--name", "-n",
|
|
help="Project name (defaults to current directory name)"
|
|
),
|
|
api_url: Optional[str] = typer.Option(
|
|
None, "--api-url", "-u",
|
|
help="FuzzForge API URL (defaults to http://localhost:8000)"
|
|
),
|
|
force: bool = typer.Option(
|
|
False, "--force", "-f",
|
|
help="Force initialization even if project already exists"
|
|
)
|
|
):
|
|
"""
|
|
📁 Initialize a new FuzzForge project in the current directory.
|
|
|
|
This creates a .fuzzforge directory with:
|
|
• SQLite database for storing runs, findings, and crashes
|
|
• Configuration file with project settings
|
|
• Default ignore patterns and preferences
|
|
"""
|
|
current_dir = Path.cwd()
|
|
fuzzforge_dir = current_dir / ".fuzzforge"
|
|
|
|
# Check if project already exists
|
|
if fuzzforge_dir.exists() and not force:
|
|
if fuzzforge_dir.is_dir() and any(fuzzforge_dir.iterdir()):
|
|
console.print("❌ FuzzForge project already exists in this directory", style="red")
|
|
console.print("Use --force to reinitialize", style="dim")
|
|
raise typer.Exit(1)
|
|
|
|
# Get project name
|
|
if not name:
|
|
name = Prompt.ask(
|
|
"Project name",
|
|
default=current_dir.name,
|
|
console=console
|
|
)
|
|
|
|
# Get API URL
|
|
if not api_url:
|
|
api_url = Prompt.ask(
|
|
"FuzzForge API URL",
|
|
default="http://localhost:8000",
|
|
console=console
|
|
)
|
|
|
|
# Confirm initialization
|
|
console.print(f"\n📁 Initializing FuzzForge project: [bold cyan]{name}[/bold cyan]")
|
|
console.print(f"📍 Location: [dim]{current_dir}[/dim]")
|
|
console.print(f"🔗 API URL: [dim]{api_url}[/dim]")
|
|
|
|
if not Confirm.ask("\nProceed with initialization?", default=True, console=console):
|
|
console.print("❌ Initialization cancelled", style="yellow")
|
|
raise typer.Exit(0)
|
|
|
|
try:
|
|
# Create .fuzzforge directory
|
|
console.print("\n🔨 Creating project structure...")
|
|
fuzzforge_dir.mkdir(exist_ok=True)
|
|
|
|
# Initialize configuration
|
|
console.print("⚙️ Setting up configuration...")
|
|
ensure_project_config(
|
|
project_dir=current_dir,
|
|
project_name=name,
|
|
api_url=api_url,
|
|
)
|
|
|
|
# Initialize database
|
|
console.print("🗄️ Initializing database...")
|
|
ensure_project_db(current_dir)
|
|
|
|
_ensure_env_file(fuzzforge_dir, force)
|
|
_ensure_agents_registry(fuzzforge_dir, force)
|
|
|
|
# Create .gitignore if needed
|
|
gitignore_path = current_dir / ".gitignore"
|
|
gitignore_entries = [
|
|
"# FuzzForge CLI",
|
|
".fuzzforge/findings.db-*", # SQLite temp files
|
|
".fuzzforge/cache/",
|
|
".fuzzforge/temp/",
|
|
]
|
|
|
|
if gitignore_path.exists():
|
|
with open(gitignore_path, 'r') as f:
|
|
existing_content = f.read()
|
|
|
|
if "# FuzzForge CLI" not in existing_content:
|
|
with open(gitignore_path, 'a') as f:
|
|
f.write(f"\n{chr(10).join(gitignore_entries)}\n")
|
|
console.print("📝 Updated .gitignore with FuzzForge entries")
|
|
else:
|
|
with open(gitignore_path, 'w') as f:
|
|
f.write(f"{chr(10).join(gitignore_entries)}\n")
|
|
console.print("📝 Created .gitignore")
|
|
|
|
# Create README if it doesn't exist
|
|
readme_path = current_dir / "README.md"
|
|
if not readme_path.exists():
|
|
readme_content = f"""# {name}
|
|
|
|
FuzzForge security testing project.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# List available workflows
|
|
fuzzforge workflows
|
|
|
|
# Submit a workflow for analysis
|
|
fuzzforge workflow <workflow-name> /path/to/target
|
|
|
|
# Monitor run progress
|
|
fuzzforge monitor live <run-id>
|
|
|
|
# View findings
|
|
fuzzforge finding <run-id>
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
- `.fuzzforge/` - Project data and configuration
|
|
- `.fuzzforge/config.yaml` - Project configuration
|
|
- `.fuzzforge/findings.db` - Local database for runs and findings
|
|
"""
|
|
|
|
with open(readme_path, 'w') as f:
|
|
f.write(readme_content)
|
|
console.print("📚 Created README.md")
|
|
|
|
console.print("\n✅ FuzzForge project initialized successfully!", style="green")
|
|
console.print("\n🎯 Next steps:")
|
|
console.print(" • ff workflows - See available workflows")
|
|
console.print(" • ff status - Check API connectivity")
|
|
console.print(" • ff workflow <workflow> <path> - Start your first analysis")
|
|
console.print(" • edit .fuzzforge/.env with API keys & provider settings")
|
|
|
|
except Exception as e:
|
|
console.print(f"\n❌ Initialization failed: {e}", style="red")
|
|
raise typer.Exit(1)
|
|
|
|
|
|
@app.callback()
|
|
def init_callback():
|
|
"""
|
|
📁 Initialize FuzzForge projects and components
|
|
"""
|
|
|
|
|
|
def _ensure_env_file(fuzzforge_dir: Path, force: bool) -> None:
|
|
"""Create or update the .fuzzforge/.env file with AI defaults."""
|
|
|
|
env_path = fuzzforge_dir / ".env"
|
|
if env_path.exists() and not force:
|
|
console.print("🧪 Using existing .fuzzforge/.env (use --force to regenerate)")
|
|
return
|
|
|
|
console.print("🧠 Configuring AI environment...")
|
|
console.print(" • Default LLM provider: openai")
|
|
console.print(" • Default LLM model: gpt-5-mini")
|
|
console.print(" • To customise provider/model later, edit .fuzzforge/.env")
|
|
|
|
llm_provider = "openai"
|
|
llm_model = "gpt-5-mini"
|
|
|
|
api_key = Prompt.ask(
|
|
"OpenAI API key (leave blank to fill manually)",
|
|
default="",
|
|
show_default=False,
|
|
console=console,
|
|
)
|
|
|
|
enable_cognee = False
|
|
cognee_url = ""
|
|
|
|
session_db_path = fuzzforge_dir / "fuzzforge_sessions.db"
|
|
session_db_rel = session_db_path.relative_to(fuzzforge_dir.parent)
|
|
|
|
env_lines = [
|
|
"# FuzzForge AI configuration",
|
|
"# Populate the API key(s) that match your LLM provider",
|
|
"",
|
|
f"LLM_PROVIDER={llm_provider}",
|
|
f"LLM_MODEL={llm_model}",
|
|
f"LITELLM_MODEL={llm_model}",
|
|
f"OPENAI_API_KEY={api_key}",
|
|
f"FUZZFORGE_MCP_URL={os.getenv('FUZZFORGE_MCP_URL', 'http://localhost:8010/mcp')}",
|
|
"",
|
|
"# Cognee configuration mirrors the primary LLM by default",
|
|
f"LLM_COGNEE_PROVIDER={llm_provider}",
|
|
f"LLM_COGNEE_MODEL={llm_model}",
|
|
f"LLM_COGNEE_API_KEY={api_key}",
|
|
"LLM_COGNEE_ENDPOINT=",
|
|
"COGNEE_MCP_URL=",
|
|
"",
|
|
"# Session persistence options: inmemory | sqlite",
|
|
"SESSION_PERSISTENCE=sqlite",
|
|
f"SESSION_DB_PATH={session_db_rel}",
|
|
"",
|
|
"# Optional integrations",
|
|
"AGENTOPS_API_KEY=",
|
|
"FUZZFORGE_DEBUG=0",
|
|
"",
|
|
]
|
|
|
|
env_path.write_text("\n".join(env_lines), encoding="utf-8")
|
|
console.print(f"📝 Created {env_path.relative_to(fuzzforge_dir.parent)}")
|
|
|
|
template_path = fuzzforge_dir / ".env.template"
|
|
if not template_path.exists() or force:
|
|
template_lines = []
|
|
for line in env_lines:
|
|
if line.startswith("OPENAI_API_KEY="):
|
|
template_lines.append("OPENAI_API_KEY=")
|
|
elif line.startswith("LLM_COGNEE_API_KEY="):
|
|
template_lines.append("LLM_COGNEE_API_KEY=")
|
|
else:
|
|
template_lines.append(line)
|
|
template_path.write_text("\n".join(template_lines), encoding="utf-8")
|
|
console.print(f"📝 Created {template_path.relative_to(fuzzforge_dir.parent)}")
|
|
|
|
# SQLite session DB will be created automatically when first used by the AI agent
|
|
|
|
|
|
def _ensure_agents_registry(fuzzforge_dir: Path, force: bool) -> None:
|
|
"""Create a starter agents.yaml registry if needed."""
|
|
|
|
agents_path = fuzzforge_dir / "agents.yaml"
|
|
if agents_path.exists() and not force:
|
|
return
|
|
|
|
template = dedent(
|
|
"""\
|
|
# FuzzForge Registered Agents
|
|
# Populate this list to auto-register remote agents when the AI CLI starts
|
|
registered_agents: []
|
|
|
|
# Example:
|
|
# registered_agents:
|
|
# - name: Calculator
|
|
# url: http://localhost:10201
|
|
# description: Sample math agent
|
|
""".strip()
|
|
)
|
|
|
|
agents_path.write_text(template + "\n", encoding="utf-8")
|
|
console.print(f"📝 Created {agents_path.relative_to(fuzzforge_dir.parent)}")
|