From 01e6bc3fb1951bada82a533ea9e534f758a3cab1 Mon Sep 17 00:00:00 2001 From: tduhamel42 Date: Fri, 3 Apr 2026 14:04:49 +0200 Subject: [PATCH] docs: rename FuzzForge to SecPipe in all markdown files Co-Authored-By: Claude Opus 4.6 (1M context) --- CONTRIBUTING.md | 22 ++++++++++---------- README.md | 21 +++++++++---------- ROADMAP.md | 18 ++++++++-------- USAGE.md | 42 +++++++++++++++++++------------------- fuzzforge-cli/README.md | 2 +- fuzzforge-common/README.md | 2 +- fuzzforge-mcp/README.md | 18 ++++++++-------- fuzzforge-tests/README.md | 4 ++-- 8 files changed, 64 insertions(+), 65 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd98c16..8a53bbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# Contributing to FuzzForge AI +# Contributing to SecPipe AI -Thank you for your interest in contributing to FuzzForge AI! We welcome contributions from the community and are excited to collaborate with you. +Thank you for your interest in contributing to SecPipe AI! We welcome contributions from the community and are excited to collaborate with you. -**Our Vision**: FuzzForge aims to be a **universal platform for security research** across all cybersecurity domains. Through our modular architecture, any security toolβ€”from fuzzing engines to cloud scanners, from mobile app analyzers to IoT security toolsβ€”can be integrated as a containerized module and controlled via AI agents. +**Our Vision**: SecPipe aims to be a **universal platform for security research** across all cybersecurity domains. Through our modular architecture, any security toolβ€”from fuzzing engines to cloud scanners, from mobile app analyzers to IoT security toolsβ€”can be integrated as a containerized module and controlled via AI agents. ## Ways to Contribute @@ -13,7 +13,7 @@ Thank you for your interest in contributing to FuzzForge AI! We welcome contribu - **Documentation** - Improve guides, tutorials, and module documentation - **Testing** - Help test new features and report issues - **AI Integration** - Improve MCP tools and AI agent interactions -- **Tool Integrations** - Wrap existing security tools as FuzzForge modules +- **Tool Integrations** - Wrap existing security tools as SecPipe modules ## Contribution Guidelines @@ -88,7 +88,7 @@ test(runner): add container execution tests ## Module Development -FuzzForge uses a modular architecture where security tools run as isolated containers. The `fuzzforge-modules-sdk` provides everything you need to create new modules. +SecPipe uses a modular architecture where security tools run as isolated containers. The `fuzzforge-modules-sdk` provides everything you need to create new modules. **Documentation:** - [Module SDK Documentation](fuzzforge-modules/fuzzforge-modules-sdk/README.md) - Complete SDK reference @@ -211,7 +211,7 @@ FuzzForge uses a modular architecture where security tools run as isolated conta ### Module Types -FuzzForge is designed to support modules across **all cybersecurity domains**. The modular architecture allows any security tool to be containerized and integrated. Here are the main categories: +SecPipe is designed to support modules across **all cybersecurity domains**. The modular architecture allows any security tool to be containerized and integrated. Here are the main categories: **Application Security** - Fuzzing engines (coverage-guided, grammar-based, mutation-based) @@ -341,7 +341,7 @@ uv run pytest ## Contributing to Core Features -Beyond modules, you can contribute to FuzzForge's core components. +Beyond modules, you can contribute to SecPipe's core components. **Useful Resources:** - [Project Structure](README.md) - Overview of the codebase @@ -399,7 +399,7 @@ Beyond modules, you can contribute to FuzzForge's core components. When reporting bugs, please include: - **Environment**: OS, Python version, Docker version, uv version -- **FuzzForge Version**: Output of `uv run fuzzforge --version` +- **SecPipe Version**: Output of `uv run fuzzforge --version` - **Module**: Which module or component is affected - **Steps to Reproduce**: Clear steps to recreate the issue - **Expected Behavior**: What should happen @@ -538,7 +538,7 @@ Before submitting a new module: ## License -By contributing to FuzzForge AI, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)). +By contributing to SecPipe AI, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)). For module contributions: - Modules you create remain under the project license @@ -558,6 +558,6 @@ Need help contributing? --- -**Thank you for making FuzzForge better!** +**Thank you for making SecPipe better!** -Every contribution, no matter how small, helps build a stronger security research platform. Whether you're creating a module for web security, cloud scanning, mobile analysis, or any other cybersecurity domain, your work makes FuzzForge more powerful and versatile for the entire security community! +Every contribution, no matter how small, helps build a stronger security research platform. Whether you're creating a module for web security, cloud scanning, mobile analysis, or any other cybersecurity domain, your work makes SecPipe more powerful and versatile for the entire security community! diff --git a/README.md b/README.md index a708579..7b41643 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ License: BSL 1.1 Python 3.12+ MCP Compatible - Website

@@ -26,19 +25,19 @@ --- -> 🚧 **FuzzForge AI is under active development.** Expect breaking changes and new features! +> 🚧 **SecPipe AI is under active development.** Expect breaking changes and new features! --- ## πŸš€ Overview -**FuzzForge AI** is an open-source MCP server that enables AI agents (GitHub Copilot, Claude, etc.) to orchestrate security research workflows through the **Model Context Protocol (MCP)**. +**SecPipe AI** is an open-source MCP server that enables AI agents (GitHub Copilot, Claude, etc.) to orchestrate security research workflows through the **Model Context Protocol (MCP)**. -FuzzForge connects your AI assistant to **MCP tool hubs** β€” collections of containerized security tools that the agent can discover, chain, and execute autonomously. Instead of manually running security tools, describe what you want and let your AI assistant handle it. +SecPipe connects your AI assistant to **MCP tool hubs** β€” collections of containerized security tools that the agent can discover, chain, and execute autonomously. Instead of manually running security tools, describe what you want and let your AI assistant handle it. ### The Core: Hub Architecture -FuzzForge acts as a **meta-MCP server** β€” a single MCP endpoint that gives your AI agent access to tools from multiple MCP hub servers. Each hub server is a containerized security tool (Binwalk, YARA, Radare2, Nmap, etc.) that the agent can discover at runtime. +SecPipe acts as a **meta-MCP server** β€” a single MCP endpoint that gives your AI agent access to tools from multiple MCP hub servers. Each hub server is a containerized security tool (Binwalk, YARA, Radare2, Nmap, etc.) that the agent can discover at runtime. - **πŸ” Discovery**: The agent lists available hub servers and discovers their tools - **πŸ€– AI-Native**: Hub tools provide agent context β€” usage tips, workflow guidance, and domain knowledge @@ -75,7 +74,7 @@ Agent β†’ Crash Analysis: Deduplicate and triage discovered crashes ## ⭐ Support the Project -If you find FuzzForge useful, please **star the repo** to support development! πŸš€ +If you find SecPipe useful, please **star the repo** to support development! πŸš€ GitHub Stars @@ -106,7 +105,7 @@ If you find FuzzForge useful, please **star the repo** to support development! β”‚ MCP Protocol (stdio) β–Ό β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ FuzzForge MCP Server β”‚ +β”‚ SecPipe MCP Server β”‚ β”‚ β”‚ β”‚ Projects Hub Discovery Hub Execution β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ @@ -135,7 +134,7 @@ If you find FuzzForge useful, please **star the repo** to support development! ## πŸ”§ MCP Security Hub -FuzzForge ships with built-in support for the **[MCP Security Hub](https://github.com/FuzzingLabs/mcp-security-hub)** β€” a collection of 36 production-ready, Dockerized MCP servers covering offensive security: +SecPipe ships with built-in support for the **[MCP Security Hub](https://github.com/FuzzingLabs/mcp-security-hub)** β€” a collection of 36 production-ready, Dockerized MCP servers covering offensive security: | Category | Servers | Examples | |----------|---------|----------| @@ -205,7 +204,7 @@ uv run fuzzforge mcp install claude-desktop uv run fuzzforge mcp status ``` -**Restart your editor** and your AI agent will have access to FuzzForge tools! +**Restart your editor** and your AI agent will have access to SecPipe tools! --- @@ -220,7 +219,7 @@ Once installed, just talk to your AI agent: "Run nuclei against https://example.com" ``` -The agent will use FuzzForge to discover the right hub tools, chain them into a pipeline, and return results β€” all without you touching a terminal. +The agent will use SecPipe to discover the right hub tools, chain them into a pipeline, and return results β€” all without you touching a terminal. See the [Usage Guide](USAGE.md) for detailed setup and advanced workflows. @@ -230,7 +229,7 @@ See the [Usage Guide](USAGE.md) for detailed setup and advanced workflows. ``` fuzzforge_ai/ -β”œβ”€β”€ fuzzforge-mcp/ # MCP server β€” the core of FuzzForge +β”œβ”€β”€ fuzzforge-mcp/ # MCP server β€” the core of SecPipe β”œβ”€β”€ fuzzforge-cli/ # Command-line interface & terminal UI β”œβ”€β”€ fuzzforge-common/ # Shared abstractions (containers, storage) β”œβ”€β”€ fuzzforge-runner/ # Container execution engine (Docker/Podman) diff --git a/ROADMAP.md b/ROADMAP.md index 20f3632..e00bdb3 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,6 +1,6 @@ -# FuzzForge AI Roadmap +# SecPipe AI Roadmap -This document outlines the planned features and development direction for FuzzForge AI. +This document outlines the planned features and development direction for SecPipe AI. --- @@ -10,27 +10,27 @@ This document outlines the planned features and development direction for FuzzFo **Status:** πŸ”„ Planned -Integrate [mcp-security-hub](https://github.com/FuzzingLabs/mcp-security-hub) tools into FuzzForge, giving AI agents access to 28 MCP servers and 163+ security tools through a unified interface. +Integrate [mcp-security-hub](https://github.com/FuzzingLabs/mcp-security-hub) tools into SecPipe, giving AI agents access to 28 MCP servers and 163+ security tools through a unified interface. #### How It Works -Unlike native FuzzForge modules (built with the SDK), mcp-security-hub tools are **standalone MCP servers**. The integration will bridge these tools so they can be: +Unlike native SecPipe modules (built with the SDK), mcp-security-hub tools are **standalone MCP servers**. The integration will bridge these tools so they can be: - Discovered via `list_modules` alongside native modules -- Executed through FuzzForge's orchestration layer +- Executed through SecPipe's orchestration layer - Chained with native modules in workflows | Aspect | Native Modules | MCP Hub Tools | |--------|----------------|---------------| -| **Runtime** | FuzzForge SDK container | Standalone MCP server container | +| **Runtime** | SecPipe SDK container | Standalone MCP server container | | **Protocol** | Direct execution | MCP-to-MCP bridge | | **Configuration** | Module config | Tool-specific args | -| **Output** | FuzzForge results format | Tool-native format (normalized) | +| **Output** | SecPipe results format | Tool-native format (normalized) | #### Goals - Unified discovery of all available tools (native + hub) -- Orchestrate hub tools through FuzzForge's workflow engine +- Orchestrate hub tools through SecPipe's workflow engine - Normalize outputs for consistent result handling - No modification required to mcp-security-hub tools @@ -65,7 +65,7 @@ AI Agent: **Status:** πŸ”„ Planned -A graphical interface to manage FuzzForge without the command line. +A graphical interface to manage SecPipe without the command line. #### Goals diff --git a/USAGE.md b/USAGE.md index 07ae248..e105643 100644 --- a/USAGE.md +++ b/USAGE.md @@ -1,8 +1,8 @@ -# FuzzForge AI Usage Guide +# SecPipe AI Usage Guide -This guide covers everything you need to know to get started with FuzzForge AI β€” from installation to linking your first MCP hub and running security research workflows with AI. +This guide covers everything you need to know to get started with SecPipe AI β€” from installation to linking your first MCP hub and running security research workflows with AI. -> **FuzzForge is designed to be used with AI agents** (GitHub Copilot, Claude, etc.) via MCP. +> **SecPipe is designed to be used with AI agents** (GitHub Copilot, Claude, etc.) via MCP. > A terminal UI (`fuzzforge ui`) is provided for managing agents and hubs. > The CLI is available for advanced users but the primary experience is through natural language interaction with your AI assistant. @@ -27,7 +27,7 @@ This guide covers everything you need to know to get started with FuzzForge AI - [GitHub Copilot](#github-copilot) - [Claude Code (CLI)](#claude-code-cli) - [Claude Desktop](#claude-desktop) -- [Using FuzzForge with AI](#using-fuzzforge-with-ai) +- [Using SecPipe with AI](#using-secpipe-with-ai) - [CLI Reference](#cli-reference) - [Environment Variables](#environment-variables) - [Troubleshooting](#troubleshooting) @@ -76,13 +76,13 @@ git clone git@github.com:FuzzingLabs/mcp-security-hub.git ~/.fuzzforge/hubs/mcp- # Restart your AI agent β€” done! ``` -> **Note:** FuzzForge uses Docker by default. Podman is also supported via `--engine podman`. +> **Note:** SecPipe uses Docker by default. Podman is also supported via `--engine podman`. --- ## Prerequisites -Before installing FuzzForge AI, ensure you have: +Before installing SecPipe AI, ensure you have: - **Python 3.12+** β€” [Download Python](https://www.python.org/downloads/) - **uv** package manager β€” [Install uv](https://docs.astral.sh/uv/) @@ -131,7 +131,7 @@ cd fuzzforge_ai uv sync ``` -This installs all FuzzForge components in a virtual environment. +This installs all SecPipe components in a virtual environment. ### 3. Verify Installation @@ -143,7 +143,7 @@ uv run fuzzforge --help ## Terminal UI -FuzzForge ships with a terminal user interface (TUI) built on [Textual](https://textual.textualize.io/) for managing AI agents and MCP hub servers from a single dashboard. +SecPipe ships with a terminal user interface (TUI) built on [Textual](https://textual.textualize.io/) for managing AI agents and MCP hub servers from a single dashboard. ### Launching the UI @@ -173,11 +173,11 @@ The main screen is split into two panels: Select an agent row in the AI Agents table and press `Enter`: -- **If the agent is not linked** β†’ a setup dialog opens asking for your container engine (Docker or Podman), then installs the FuzzForge MCP configuration +- **If the agent is not linked** β†’ a setup dialog opens asking for your container engine (Docker or Podman), then installs the SecPipe MCP configuration - **If the agent is already linked** β†’ a confirmation dialog offers to unlink it (removes the `fuzzforge` entry without touching other MCP servers) The setup auto-detects: -- FuzzForge installation root +- SecPipe installation root - Docker/Podman socket path - Hub configuration from `hub-config.json` @@ -188,7 +188,7 @@ Press `h` to open the hub manager. This is where you manage your MCP hub reposit | Button | Action | |--------|--------| | **FuzzingLabs Hub** | One-click clone of the official [mcp-security-hub](https://github.com/FuzzingLabs/mcp-security-hub) repository β€” clones to `~/.fuzzforge/hubs/mcp-security-hub`, scans for tools, and registers them in `hub-config.json` | -| **Link Path** | Link any local directory as a hub β€” enter a name and path, FuzzForge scans it for `category/tool-name/Dockerfile` patterns | +| **Link Path** | Link any local directory as a hub β€” enter a name and path, SecPipe scans it for `category/tool-name/Dockerfile` patterns | | **Clone URL** | Clone any git repository and link it as a hub | | **Remove** | Unlink the selected hub and remove its servers from the configuration | @@ -219,7 +219,7 @@ my-hub/ └── ... ``` -FuzzForge scans for the pattern `category/tool-name/Dockerfile` and auto-generates server configuration entries for each discovered tool. +SecPipe scans for the pattern `category/tool-name/Dockerfile` and auto-generates server configuration entries for each discovered tool. ### FuzzingLabs Security Hub @@ -290,7 +290,7 @@ uv run fuzzforge mcp install copilot ``` The command auto-detects: -- **FuzzForge root** β€” Where FuzzForge is installed +- **SecPipe root** β€” Where SecPipe is installed - **Docker socket** β€” Auto-detects `/var/run/docker.sock` **Optional overrides:** @@ -298,7 +298,7 @@ The command auto-detects: uv run fuzzforge mcp install copilot --engine podman ``` -**After installation:** Restart VS Code. FuzzForge tools appear in GitHub Copilot Chat. +**After installation:** Restart VS Code. SecPipe tools appear in GitHub Copilot Chat. ### Claude Code (CLI) @@ -306,7 +306,7 @@ uv run fuzzforge mcp install copilot --engine podman uv run fuzzforge mcp install claude-code ``` -Installs to `~/.claude.json`. FuzzForge tools are available from any directory after restarting Claude. +Installs to `~/.claude.json`. SecPipe tools are available from any directory after restarting Claude. ### Claude Desktop @@ -332,15 +332,15 @@ uv run fuzzforge mcp uninstall claude-desktop --- -## Using FuzzForge with AI +## Using SecPipe with AI -Once MCP is configured and hub images are built, interact with FuzzForge through natural language with your AI assistant. +Once MCP is configured and hub images are built, interact with SecPipe through natural language with your AI assistant. ### Example Conversations **Discover available tools:** ``` -You: "What security tools are available in FuzzForge?" +You: "What security tools are available in SecPipe?" AI: Queries hub tools β†’ "I found 15 tools across categories: nmap for port scanning, binwalk for firmware analysis, semgrep for code scanning, cargo-fuzzer for Rust fuzzing..." @@ -402,10 +402,10 @@ uv run fuzzforge project results # Get execution results ## Environment Variables -Configure FuzzForge using environment variables: +Configure SecPipe using environment variables: ```bash -# Override the FuzzForge installation root (auto-detected from cwd by default) +# Override the SecPipe installation root (auto-detected from cwd by default) export FUZZFORGE_ROOT=/path/to/fuzzforge_ai # Override the user-global data directory (default: ~/.fuzzforge) @@ -492,7 +492,7 @@ export FUZZFORGE_ENGINE=podman ### Hub Registry -FuzzForge stores linked hub information in `~/.fuzzforge/hubs.json`. If something goes wrong: +SecPipe stores linked hub information in `~/.fuzzforge/hubs.json`. If something goes wrong: ```bash # View registry diff --git a/fuzzforge-cli/README.md b/fuzzforge-cli/README.md index ed59d48..538031c 100644 --- a/fuzzforge-cli/README.md +++ b/fuzzforge-cli/README.md @@ -1,3 +1,3 @@ -# FuzzForge CLI +# SecPipe CLI ... diff --git a/fuzzforge-common/README.md b/fuzzforge-common/README.md index f1819b8..fde56f2 100644 --- a/fuzzforge-common/README.md +++ b/fuzzforge-common/README.md @@ -1,3 +1,3 @@ -# FuzzForge Common +# SecPipe Common ... diff --git a/fuzzforge-mcp/README.md b/fuzzforge-mcp/README.md index 7c98fd1..97cf078 100644 --- a/fuzzforge-mcp/README.md +++ b/fuzzforge-mcp/README.md @@ -1,10 +1,10 @@ -# FuzzForge MCP +# SecPipe MCP -Model Context Protocol (MCP) server that enables AI agents to orchestrate FuzzForge security research modules. +Model Context Protocol (MCP) server that enables AI agents to orchestrate SecPipe security research modules. ## Overview -FuzzForge MCP provides a standardized interface for AI agents (Claude Code, GitHub Copilot, Claude Desktop) to: +SecPipe MCP provides a standardized interface for AI agents (Claude Code, GitHub Copilot, Claude Desktop) to: - List and discover available security modules - Execute modules in isolated containers @@ -17,7 +17,7 @@ The server communicates with AI agents using the [Model Context Protocol](https: ### Automatic Installation (Recommended) -Use the FuzzForge CLI to automatically configure MCP for your AI agent: +Use the SecPipe CLI to automatically configure MCP for your AI agent: ```bash # For GitHub Copilot @@ -110,7 +110,7 @@ The MCP server exposes the following tools to AI agents: ### Project Management -- **`init_project`** - Initialize a new FuzzForge project +- **`init_project`** - Initialize a new SecPipe project - **`set_project_assets`** - Set initial assets (source code, contracts, etc.) for the project ### Module Management @@ -135,7 +135,7 @@ The server also provides resources for accessing: ### From AI Agent (e.g., Claude Code) -Once configured, AI agents can interact with FuzzForge naturally: +Once configured, AI agents can interact with SecPipe naturally: ```text User: List the available security modules @@ -178,14 +178,14 @@ uv run uvicorn fuzzforge_mcp.application:app --reload β”‚ stdio/JSON-RPC β–Ό β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ FuzzForge MCP Server β”‚ +β”‚ SecPipe MCP Server β”‚ β”‚ Tools: init_project, list_modules, β”‚ β”‚ execute_module, execute_workflowβ”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β–Ό β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ FuzzForge Runner β”‚ +β”‚ SecPipe Runner β”‚ β”‚ Podman/Docker Orchestration β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ @@ -212,6 +212,6 @@ uv run pytest ## See Also -- [FuzzForge Main README](../README.md) - Overall project documentation +- [SecPipe Main README](../README.md) - Overall project documentation - [Module SDK](../fuzzforge-modules/fuzzforge-modules-sdk/README.md) - Creating custom modules - [Model Context Protocol](https://modelcontextprotocol.io/) - MCP specification diff --git a/fuzzforge-tests/README.md b/fuzzforge-tests/README.md index 2b71651..07a9f73 100644 --- a/fuzzforge-tests/README.md +++ b/fuzzforge-tests/README.md @@ -1,3 +1,3 @@ -# fuzzforge-tests +# SecPipe Tests -Common test utilities and fixtures for FuzzForge packages. +Common test utilities and fixtures for SecPipe packages.