mirror of
https://github.com/FuzzingLabs/fuzzforge_ai.git
synced 2026-06-12 18:57:51 +02:00
60ca088ecf
* 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.
230 lines
7.7 KiB
Python
230 lines
7.7 KiB
Python
"""Custom A2A wiring so we can access task store and queue manager."""
|
|
# 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
|
|
|
|
import logging
|
|
from typing import Optional, Union
|
|
|
|
from starlette.applications import Starlette
|
|
from starlette.responses import Response, FileResponse
|
|
|
|
from google.adk.a2a.executor.a2a_agent_executor import A2aAgentExecutor
|
|
from google.adk.a2a.utils.agent_card_builder import AgentCardBuilder
|
|
from google.adk.a2a.experimental import a2a_experimental
|
|
from google.adk.agents.base_agent import BaseAgent
|
|
from google.adk.artifacts.in_memory_artifact_service import InMemoryArtifactService
|
|
from google.adk.auth.credential_service.in_memory_credential_service import InMemoryCredentialService
|
|
from google.adk.cli.utils.logs import setup_adk_logger
|
|
from google.adk.memory.in_memory_memory_service import InMemoryMemoryService
|
|
from google.adk.runners import Runner
|
|
from google.adk.sessions.in_memory_session_service import InMemorySessionService
|
|
|
|
from a2a.server.apps import A2AStarletteApplication
|
|
from a2a.server.request_handlers.default_request_handler import DefaultRequestHandler
|
|
from a2a.server.tasks.inmemory_task_store import InMemoryTaskStore
|
|
from a2a.server.events.in_memory_queue_manager import InMemoryQueueManager
|
|
from a2a.types import AgentCard
|
|
|
|
from .agent_executor import FuzzForgeExecutor
|
|
|
|
|
|
import json
|
|
|
|
|
|
async def serve_artifact(request):
|
|
"""Serve artifact files via HTTP for A2A agents"""
|
|
artifact_id = request.path_params["artifact_id"]
|
|
|
|
# Try to get the executor instance to access artifact cache
|
|
# We'll store a reference to it during app creation
|
|
executor = getattr(serve_artifact, '_executor', None)
|
|
if not executor:
|
|
return Response("Artifact service not available", status_code=503)
|
|
|
|
try:
|
|
# Look in the artifact cache directory
|
|
artifact_cache_dir = executor._artifact_cache_dir
|
|
artifact_dir = artifact_cache_dir / artifact_id
|
|
|
|
if not artifact_dir.exists():
|
|
return Response("Artifact not found", status_code=404)
|
|
|
|
# Find the artifact file (should be only one file in the directory)
|
|
artifact_files = list(artifact_dir.glob("*"))
|
|
if not artifact_files:
|
|
return Response("Artifact file not found", status_code=404)
|
|
|
|
artifact_file = artifact_files[0] # Take the first (and should be only) file
|
|
|
|
# Determine mime type from file extension or default to octet-stream
|
|
import mimetypes
|
|
mime_type, _ = mimetypes.guess_type(str(artifact_file))
|
|
if not mime_type:
|
|
mime_type = 'application/octet-stream'
|
|
|
|
return FileResponse(
|
|
path=str(artifact_file),
|
|
media_type=mime_type,
|
|
filename=artifact_file.name
|
|
)
|
|
|
|
except Exception as e:
|
|
return Response(f"Error serving artifact: {str(e)}", status_code=500)
|
|
|
|
|
|
async def knowledge_query(request):
|
|
"""Expose knowledge graph search over HTTP for external agents."""
|
|
executor = getattr(knowledge_query, '_executor', None)
|
|
if not executor:
|
|
return Response("Knowledge service not available", status_code=503)
|
|
|
|
try:
|
|
payload = await request.json()
|
|
except Exception:
|
|
return Response("Invalid JSON body", status_code=400)
|
|
|
|
query = payload.get("query")
|
|
if not query:
|
|
return Response("'query' is required", status_code=400)
|
|
|
|
search_type = payload.get("search_type", "INSIGHTS")
|
|
dataset = payload.get("dataset")
|
|
|
|
result = await executor.query_project_knowledge_api(
|
|
query=query,
|
|
search_type=search_type,
|
|
dataset=dataset,
|
|
)
|
|
|
|
status = 200 if not isinstance(result, dict) or "error" not in result else 400
|
|
return Response(
|
|
json.dumps(result, default=str),
|
|
status_code=status,
|
|
media_type="application/json",
|
|
)
|
|
|
|
|
|
async def create_file_artifact(request):
|
|
"""Create an artifact from a project file via HTTP."""
|
|
executor = getattr(create_file_artifact, '_executor', None)
|
|
if not executor:
|
|
return Response("File service not available", status_code=503)
|
|
|
|
try:
|
|
payload = await request.json()
|
|
except Exception:
|
|
return Response("Invalid JSON body", status_code=400)
|
|
|
|
path = payload.get("path")
|
|
if not path:
|
|
return Response("'path' is required", status_code=400)
|
|
|
|
result = await executor.create_project_file_artifact_api(path)
|
|
status = 200 if not isinstance(result, dict) or "error" not in result else 400
|
|
return Response(
|
|
json.dumps(result, default=str),
|
|
status_code=status,
|
|
media_type="application/json",
|
|
)
|
|
|
|
|
|
def _load_agent_card(agent_card: Optional[Union[AgentCard, str]]) -> Optional[AgentCard]:
|
|
if agent_card is None:
|
|
return None
|
|
if isinstance(agent_card, AgentCard):
|
|
return agent_card
|
|
|
|
import json
|
|
from pathlib import Path
|
|
|
|
path = Path(agent_card)
|
|
with path.open('r', encoding='utf-8') as handle:
|
|
data = json.load(handle)
|
|
return AgentCard(**data)
|
|
|
|
|
|
@a2a_experimental
|
|
def create_a2a_app(
|
|
agent: BaseAgent,
|
|
*,
|
|
host: str = "localhost",
|
|
port: int = 8000,
|
|
protocol: str = "http",
|
|
agent_card: Optional[Union[AgentCard, str]] = None,
|
|
executor=None, # Accept executor reference
|
|
) -> Starlette:
|
|
"""Variant of google.adk.a2a.utils.to_a2a that exposes task-store handles."""
|
|
|
|
setup_adk_logger(logging.INFO)
|
|
|
|
async def create_runner() -> Runner:
|
|
return Runner(
|
|
agent=agent,
|
|
app_name=agent.name or "fuzzforge",
|
|
artifact_service=InMemoryArtifactService(),
|
|
session_service=InMemorySessionService(),
|
|
memory_service=InMemoryMemoryService(),
|
|
credential_service=InMemoryCredentialService(),
|
|
)
|
|
|
|
task_store = InMemoryTaskStore()
|
|
queue_manager = InMemoryQueueManager()
|
|
|
|
agent_executor = A2aAgentExecutor(runner=create_runner)
|
|
request_handler = DefaultRequestHandler(
|
|
agent_executor=agent_executor,
|
|
task_store=task_store,
|
|
queue_manager=queue_manager,
|
|
)
|
|
|
|
rpc_url = f"{protocol}://{host}:{port}/"
|
|
provided_card = _load_agent_card(agent_card)
|
|
|
|
card_builder = AgentCardBuilder(agent=agent, rpc_url=rpc_url)
|
|
|
|
app = Starlette()
|
|
|
|
async def setup() -> None:
|
|
if provided_card is not None:
|
|
final_card = provided_card
|
|
else:
|
|
final_card = await card_builder.build()
|
|
|
|
a2a_app = A2AStarletteApplication(
|
|
agent_card=final_card,
|
|
http_handler=request_handler,
|
|
)
|
|
a2a_app.add_routes_to_app(app)
|
|
|
|
# Add artifact serving route
|
|
app.router.add_route("/artifacts/{artifact_id}", serve_artifact, methods=["GET"])
|
|
app.router.add_route("/graph/query", knowledge_query, methods=["POST"])
|
|
app.router.add_route("/project/files", create_file_artifact, methods=["POST"])
|
|
|
|
app.add_event_handler("startup", setup)
|
|
|
|
# Expose handles so the executor can emit task updates later
|
|
FuzzForgeExecutor.task_store = task_store
|
|
FuzzForgeExecutor.queue_manager = queue_manager
|
|
|
|
# Store reference to executor for artifact serving
|
|
serve_artifact._executor = executor
|
|
knowledge_query._executor = executor
|
|
create_file_artifact._executor = executor
|
|
|
|
return app
|
|
|
|
|
|
__all__ = ["create_a2a_app"]
|