mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-02-13 19:12:44 +00:00
* 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.
370 lines
13 KiB
Python
370 lines
13 KiB
Python
"""
|
|
FuzzForge Common Storage Activities
|
|
|
|
Activities for interacting with MinIO storage:
|
|
- get_target_activity: Download target from MinIO to local cache
|
|
- cleanup_cache_activity: Remove target from local cache
|
|
- upload_results_activity: Upload workflow results to MinIO
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
import shutil
|
|
from pathlib import Path
|
|
|
|
import boto3
|
|
from botocore.exceptions import ClientError
|
|
from temporalio import activity
|
|
|
|
# Configure logging
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Initialize S3 client (MinIO)
|
|
s3_client = boto3.client(
|
|
's3',
|
|
endpoint_url=os.getenv('S3_ENDPOINT', 'http://minio:9000'),
|
|
aws_access_key_id=os.getenv('S3_ACCESS_KEY', 'fuzzforge'),
|
|
aws_secret_access_key=os.getenv('S3_SECRET_KEY', 'fuzzforge123'),
|
|
region_name=os.getenv('S3_REGION', 'us-east-1'),
|
|
use_ssl=os.getenv('S3_USE_SSL', 'false').lower() == 'true'
|
|
)
|
|
|
|
# Configuration
|
|
S3_BUCKET = os.getenv('S3_BUCKET', 'targets')
|
|
CACHE_DIR = Path(os.getenv('CACHE_DIR', '/cache'))
|
|
CACHE_MAX_SIZE_GB = int(os.getenv('CACHE_MAX_SIZE', '10').rstrip('GB'))
|
|
|
|
|
|
@activity.defn(name="get_target")
|
|
async def get_target_activity(
|
|
target_id: str,
|
|
run_id: str = None,
|
|
workspace_isolation: str = "isolated"
|
|
) -> str:
|
|
"""
|
|
Download target from MinIO to local cache.
|
|
|
|
Args:
|
|
target_id: UUID of the uploaded target
|
|
run_id: Workflow run ID for isolation (required for isolated mode)
|
|
workspace_isolation: Isolation mode - "isolated" (default), "shared", or "copy-on-write"
|
|
|
|
Returns:
|
|
Local path to the cached target workspace
|
|
|
|
Raises:
|
|
FileNotFoundError: If target doesn't exist in MinIO
|
|
ValueError: If run_id not provided for isolated mode
|
|
Exception: For other download errors
|
|
"""
|
|
logger.info(
|
|
f"Activity: get_target (target_id={target_id}, run_id={run_id}, "
|
|
f"isolation={workspace_isolation})"
|
|
)
|
|
|
|
# Validate isolation mode
|
|
valid_modes = ["isolated", "shared", "copy-on-write"]
|
|
if workspace_isolation not in valid_modes:
|
|
raise ValueError(
|
|
f"Invalid workspace_isolation mode: {workspace_isolation}. "
|
|
f"Must be one of: {valid_modes}"
|
|
)
|
|
|
|
# Require run_id for isolated and copy-on-write modes
|
|
if workspace_isolation in ["isolated", "copy-on-write"] and not run_id:
|
|
raise ValueError(
|
|
f"run_id is required for workspace_isolation='{workspace_isolation}'"
|
|
)
|
|
|
|
# Define cache paths based on isolation mode
|
|
if workspace_isolation == "isolated":
|
|
# Each run gets its own isolated workspace
|
|
cache_path = CACHE_DIR / target_id / run_id
|
|
cached_file = cache_path / "target"
|
|
elif workspace_isolation == "shared":
|
|
# All runs share the same workspace (legacy behavior)
|
|
cache_path = CACHE_DIR / target_id
|
|
cached_file = cache_path / "target"
|
|
else: # copy-on-write
|
|
# Shared download, run-specific copy
|
|
shared_cache_path = CACHE_DIR / target_id / "shared"
|
|
cache_path = CACHE_DIR / target_id / run_id
|
|
cached_file = shared_cache_path / "target"
|
|
|
|
# Handle copy-on-write mode
|
|
if workspace_isolation == "copy-on-write":
|
|
# Check if shared cache exists
|
|
if cached_file.exists():
|
|
logger.info(f"Copy-on-write: Shared cache HIT for {target_id}")
|
|
|
|
# Copy shared workspace to run-specific path
|
|
shared_workspace = shared_cache_path / "workspace"
|
|
run_workspace = cache_path / "workspace"
|
|
|
|
if shared_workspace.exists():
|
|
logger.info(f"Copying workspace to isolated run path: {run_workspace}")
|
|
cache_path.mkdir(parents=True, exist_ok=True)
|
|
shutil.copytree(shared_workspace, run_workspace)
|
|
return str(run_workspace)
|
|
else:
|
|
# Shared file exists but not extracted (non-tarball)
|
|
run_file = cache_path / "target"
|
|
cache_path.mkdir(parents=True, exist_ok=True)
|
|
shutil.copy2(cached_file, run_file)
|
|
return str(run_file)
|
|
# If shared cache doesn't exist, fall through to download
|
|
|
|
# Check if target is already cached (isolated or shared mode)
|
|
elif cached_file.exists():
|
|
# Update access time for LRU
|
|
cached_file.touch()
|
|
logger.info(f"Cache HIT: {target_id} (mode: {workspace_isolation})")
|
|
|
|
# Check if workspace directory exists (extracted tarball)
|
|
workspace_dir = cache_path / "workspace"
|
|
if workspace_dir.exists() and workspace_dir.is_dir():
|
|
logger.info(f"Returning cached workspace: {workspace_dir}")
|
|
return str(workspace_dir)
|
|
else:
|
|
# Return cached file (not a tarball)
|
|
return str(cached_file)
|
|
|
|
# Cache miss - download from MinIO
|
|
logger.info(
|
|
f"Cache MISS: {target_id} (mode: {workspace_isolation}), "
|
|
f"downloading from MinIO..."
|
|
)
|
|
|
|
try:
|
|
# Create cache directory
|
|
cache_path.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Download from S3/MinIO
|
|
s3_key = f'{target_id}/target'
|
|
logger.info(f"Downloading s3://{S3_BUCKET}/{s3_key} -> {cached_file}")
|
|
|
|
s3_client.download_file(
|
|
Bucket=S3_BUCKET,
|
|
Key=s3_key,
|
|
Filename=str(cached_file)
|
|
)
|
|
|
|
# Verify file was downloaded
|
|
if not cached_file.exists():
|
|
raise FileNotFoundError(f"Downloaded file not found: {cached_file}")
|
|
|
|
file_size = cached_file.stat().st_size
|
|
logger.info(
|
|
f"✓ Downloaded target {target_id} "
|
|
f"({file_size / 1024 / 1024:.2f} MB)"
|
|
)
|
|
|
|
# Extract tarball if it's an archive
|
|
import tarfile
|
|
workspace_dir = cache_path / "workspace"
|
|
|
|
if tarfile.is_tarfile(str(cached_file)):
|
|
logger.info(f"Extracting tarball to {workspace_dir}...")
|
|
workspace_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
with tarfile.open(str(cached_file), 'r:*') as tar:
|
|
tar.extractall(path=workspace_dir)
|
|
|
|
logger.info(f"✓ Extracted tarball to {workspace_dir}")
|
|
|
|
# For copy-on-write mode, copy to run-specific path
|
|
if workspace_isolation == "copy-on-write":
|
|
run_cache_path = CACHE_DIR / target_id / run_id
|
|
run_workspace = run_cache_path / "workspace"
|
|
logger.info(f"Copy-on-write: Copying to {run_workspace}")
|
|
run_cache_path.mkdir(parents=True, exist_ok=True)
|
|
shutil.copytree(workspace_dir, run_workspace)
|
|
return str(run_workspace)
|
|
|
|
return str(workspace_dir)
|
|
else:
|
|
# Not a tarball
|
|
if workspace_isolation == "copy-on-write":
|
|
# Copy file to run-specific path
|
|
run_cache_path = CACHE_DIR / target_id / run_id
|
|
run_file = run_cache_path / "target"
|
|
logger.info(f"Copy-on-write: Copying file to {run_file}")
|
|
run_cache_path.mkdir(parents=True, exist_ok=True)
|
|
shutil.copy2(cached_file, run_file)
|
|
return str(run_file)
|
|
|
|
return str(cached_file)
|
|
|
|
except ClientError as e:
|
|
error_code = e.response['Error']['Code']
|
|
if error_code == '404' or error_code == 'NoSuchKey':
|
|
logger.error(f"Target not found in MinIO: {target_id}")
|
|
raise FileNotFoundError(f"Target {target_id} not found in storage")
|
|
else:
|
|
logger.error(f"S3/MinIO error downloading target: {e}", exc_info=True)
|
|
raise
|
|
|
|
except Exception as e:
|
|
logger.error(f"Failed to download target {target_id}: {e}", exc_info=True)
|
|
# Cleanup partial download
|
|
if cache_path.exists():
|
|
shutil.rmtree(cache_path, ignore_errors=True)
|
|
raise
|
|
|
|
|
|
@activity.defn(name="cleanup_cache")
|
|
async def cleanup_cache_activity(
|
|
target_path: str,
|
|
workspace_isolation: str = "isolated"
|
|
) -> None:
|
|
"""
|
|
Remove target from local cache after workflow completes.
|
|
|
|
Args:
|
|
target_path: Path to the cached target workspace (from get_target_activity)
|
|
workspace_isolation: Isolation mode used - determines cleanup scope
|
|
|
|
Notes:
|
|
- "isolated" mode: Removes the entire run-specific directory
|
|
- "copy-on-write" mode: Removes run-specific directory, keeps shared cache
|
|
- "shared" mode: Does NOT remove cache (shared across runs)
|
|
"""
|
|
logger.info(
|
|
f"Activity: cleanup_cache (path={target_path}, "
|
|
f"isolation={workspace_isolation})"
|
|
)
|
|
|
|
try:
|
|
target = Path(target_path)
|
|
|
|
# For shared mode, don't clean up (cache is shared across runs)
|
|
if workspace_isolation == "shared":
|
|
logger.info(
|
|
f"Skipping cleanup for shared workspace (mode={workspace_isolation})"
|
|
)
|
|
return
|
|
|
|
# For isolated and copy-on-write modes, clean up run-specific directory
|
|
# Navigate up to the run-specific directory: /cache/{target_id}/{run_id}/
|
|
if target.name == "workspace":
|
|
# Path is .../workspace, go up one level to run directory
|
|
run_dir = target.parent
|
|
else:
|
|
# Path is a file, go up one level to run directory
|
|
run_dir = target.parent
|
|
|
|
# Validate it's in cache and looks like a run-specific path
|
|
if run_dir.exists() and run_dir.is_relative_to(CACHE_DIR):
|
|
# Check if parent is target_id directory (validate structure)
|
|
target_id_dir = run_dir.parent
|
|
if target_id_dir.is_relative_to(CACHE_DIR):
|
|
shutil.rmtree(run_dir)
|
|
logger.info(
|
|
f"✓ Cleaned up run-specific directory: {run_dir} "
|
|
f"(mode={workspace_isolation})"
|
|
)
|
|
else:
|
|
logger.warning(
|
|
f"Unexpected cache structure, skipping cleanup: {run_dir}"
|
|
)
|
|
else:
|
|
logger.warning(
|
|
f"Cache path not in CACHE_DIR or doesn't exist: {run_dir}"
|
|
)
|
|
|
|
except Exception as e:
|
|
# Don't fail workflow if cleanup fails
|
|
logger.error(
|
|
f"Failed to cleanup cache {target_path}: {e}",
|
|
exc_info=True
|
|
)
|
|
|
|
|
|
@activity.defn(name="upload_results")
|
|
async def upload_results_activity(
|
|
workflow_id: str,
|
|
results: dict,
|
|
results_format: str = "json"
|
|
) -> str:
|
|
"""
|
|
Upload workflow results to MinIO.
|
|
|
|
Args:
|
|
workflow_id: Workflow execution ID
|
|
results: Results dictionary to upload
|
|
results_format: Format for results (json, sarif, etc.)
|
|
|
|
Returns:
|
|
S3 URL to the uploaded results
|
|
"""
|
|
logger.info(
|
|
f"Activity: upload_results "
|
|
f"(workflow_id={workflow_id}, format={results_format})"
|
|
)
|
|
|
|
try:
|
|
import json
|
|
|
|
# Prepare results content
|
|
if results_format == "json":
|
|
content = json.dumps(results, indent=2).encode('utf-8')
|
|
content_type = 'application/json'
|
|
file_ext = 'json'
|
|
elif results_format == "sarif":
|
|
content = json.dumps(results, indent=2).encode('utf-8')
|
|
content_type = 'application/sarif+json'
|
|
file_ext = 'sarif'
|
|
else:
|
|
# Default to JSON
|
|
content = json.dumps(results, indent=2).encode('utf-8')
|
|
content_type = 'application/json'
|
|
file_ext = 'json'
|
|
|
|
# Upload to MinIO
|
|
s3_key = f'{workflow_id}/results.{file_ext}'
|
|
logger.info(f"Uploading results to s3://results/{s3_key}")
|
|
|
|
s3_client.put_object(
|
|
Bucket='results',
|
|
Key=s3_key,
|
|
Body=content,
|
|
ContentType=content_type,
|
|
Metadata={
|
|
'workflow_id': workflow_id,
|
|
'format': results_format
|
|
}
|
|
)
|
|
|
|
# Construct S3 URL
|
|
s3_endpoint = os.getenv('S3_ENDPOINT', 'http://minio:9000')
|
|
s3_url = f"{s3_endpoint}/results/{s3_key}"
|
|
|
|
logger.info(f"✓ Uploaded results: {s3_url}")
|
|
return s3_url
|
|
|
|
except Exception as e:
|
|
logger.error(
|
|
f"Failed to upload results for workflow {workflow_id}: {e}",
|
|
exc_info=True
|
|
)
|
|
raise
|
|
|
|
|
|
def _check_cache_size():
|
|
"""Check total cache size and log warning if exceeding limit"""
|
|
try:
|
|
total_size = 0
|
|
for item in CACHE_DIR.rglob('*'):
|
|
if item.is_file():
|
|
total_size += item.stat().st_size
|
|
|
|
total_size_gb = total_size / (1024 ** 3)
|
|
if total_size_gb > CACHE_MAX_SIZE_GB:
|
|
logger.warning(
|
|
f"Cache size ({total_size_gb:.2f} GB) exceeds "
|
|
f"limit ({CACHE_MAX_SIZE_GB} GB). Consider cleanup."
|
|
)
|
|
|
|
except Exception as e:
|
|
logger.error(f"Failed to check cache size: {e}")
|