This directory contains comprehensive planning documentation for integrating reference security tools into CyberChef-MCP as native MCP tools. The integration focuses on extracting algorithms and functionality directly from source code - no Docker containers or binary execution.
| Metric | Value |
|---|---|
| Planning Version | 1.1.0 |
| Planning Status | Complete |
| Target CyberChef-MCP Version | 2.0.0+ |
| Total Phases | 4 |
| Total Sprints | 12 |
| Estimated Duration | 24 weeks |
| New MCP Tools Target | 80-120 tools |
| Project | Language | Primary Integration Focus | Complexity |
|---|---|---|---|
| Ciphey/Ares | Rust | AuSearch auto-decode, plaintext detection | High |
| cryptii | JavaScript | Modular encoding, historical ciphers | Low |
| xortool | Python | XOR cipher analysis | Medium |
| RsaCtfTool | Python | RSA cryptanalysis (60+ attacks) | High |
| John the Ripper | C | Hash identification, analysis | Very High |
| pwntools | Python | Encoding utilities, binary helpers | Medium |
| katana | Python | CTF automation patterns | Medium |
| cyberchef-recipes | JSON | Recipe patterns, presets | Low |
docs/planning/ext-proj-int/
├── README.md # This file - navigation guide
├── overview.md # Integration strategy and architecture
├── phases/
│ ├── phase-1-foundation.md # Core infrastructure (3 sprints)
│ ├── phase-2-js-native.md # JavaScript integrations (3 sprints)
│ ├── phase-3-algorithm-port.md # Python/Rust algorithm ports (5 sprints)
│ └── phase-4-advanced.md # Complex integrations (4 sprints)
├── sprints/ # 12 detailed sprint plans
│ ├── sprint-1.1-tool-registry.md # ToolRegistry and BaseTool infrastructure
│ ├── sprint-1.2-testing-framework.md # Testing framework extensions
│ ├── sprint-2.1-cryptii-integration.md # cryptii encoding integration
│ ├── sprint-2.2-recipes-presets.md # Recipe pattern presets
│ ├── sprint-2.3-pwntools-binary.md # pwntools binary utilities
│ ├── sprint-3.1-ciphey-autodecode.md # Ciphey A* auto-decode algorithm
│ ├── sprint-3.2-xortool-analysis.md # XOR analysis algorithms
│ ├── sprint-3.3-rsactftool-factorization.md # RSA factorization attacks
│ ├── sprint-3.4-katana-patterns.md # katana CTF automation patterns
│ ├── sprint-4.1-john-hash-id.md # John hash identification
│ ├── sprint-4.2-composite-workflows.md # Multi-tool workflows
│ └── sprint-4.3-documentation-release.md # Documentation and release
├── tools/
│ ├── ciphey-integration.md # Detailed Ciphey/Ares integration plan
│ ├── cryptii-integration.md # Detailed cryptii integration plan
│ ├── xortool-integration.md # Detailed xortool integration plan
│ ├── rsactftool-integration.md # Detailed RsaCtfTool integration plan
│ ├── john-integration.md # Detailed John integration plan
│ ├── pwntools-integration.md # Detailed pwntools integration plan
│ ├── katana-integration.md # Detailed katana integration plan
│ └── recipes-integration.md # Detailed recipes integration plan
└── technical/
├── tool-registration.md # How to add new MCP tools
├── algorithm-porting.md # Python/Rust to JavaScript guide
├── testing-strategy.md # Test coverage requirements
└── dependencies.md # New npm packages needed
- Phase 1: Foundation - Core infrastructure (2 sprints, 4 weeks)
- Phase 2: JavaScript Native - JS integrations (3 sprints, 6 weeks)
- Phase 3: Algorithm Ports - Python/Rust ports (4 sprints, 8 weeks)
- Phase 4: Advanced - Complex integrations (3 sprints, 6 weeks)
- Sprint 1.1: Tool Registry - ToolRegistry, BaseTool, category indexing
- Sprint 1.2: Testing Framework - MockTransport, fixtures, CI workflow
- Sprint 2.1: cryptii Integration - Morse, Braille, Enigma ciphers
- Sprint 2.2: Recipe Presets - Malware analysis, forensics recipes
- Sprint 2.3: pwntools Binary - Pack/unpack, cyclic patterns, hexdump
- Sprint 3.1: Ciphey Auto-Decode - A* search, encoding detection
- Sprint 3.2: xortool Analysis - Key length, key guessing, brute force
- Sprint 3.3: RsaCtfTool Factorization - Fermat, Wiener, Pollard's rho
- Sprint 3.4: katana Patterns - Encoding chains, file detection, CTF analyzer
- Sprint 4.1: John Hash ID - 100+ hash patterns, identification
- Sprint 4.2: Composite Workflows - Multi-tool pipelines, CTF/malware workflows
- Sprint 4.3: Documentation & Release - Docs, benchmarks, v2.0.0 release
- Tool Registration - Step-by-step guide for adding MCP tools
- Algorithm Porting - Converting Python/Rust to JavaScript
- Testing Strategy - Test requirements and patterns
- Dependencies - Required npm packages
- Ciphey Integration - Auto-decode, AuSearch algorithm
- cryptii Integration - Modular encoding system
- xortool Integration - XOR analysis
- RsaCtfTool Integration - RSA attacks
- John Integration - Hash identification
- pwntools Integration - Encoding utilities
- katana Integration - CTF patterns
- Recipes Integration - Recipe presets
- Native JavaScript - All integrations must be pure JavaScript/TypeScript
- No External Binaries - No Docker, no subprocess execution, no system calls
- Source Code Extraction - Pull algorithms directly from reference project source
- MCP Tool Pattern - Follow existing
cyberchef_*tool conventions - Comprehensive Testing - Minimum 80% coverage for new tools
- Documentation First - Document before implementing
cyberchef_<category>_<operation>
Examples:
cyberchef_auto_decode- Auto-detect and decode (from Ciphey)cyberchef_xor_analyze- XOR key analysis (from xortool)cyberchef_rsa_factor- RSA factorization (from RsaCtfTool)cyberchef_hash_identify- Hash type identification (from John)cyberchef_encoding_detect- Encoding detection (from cryptii)
- All planning documents complete with actionable detail
- Clear sprint breakdown with time estimates
- Technical guides for implementation
- No Docker/binary execution dependencies
- Integration preserves MCP tool patterns
- Comprehensive test strategy defined
- New tools integrate seamlessly with existing 300+ operations
- Read Overview for integration strategy
- Review Phase Plans in order (1-4)
- Consult Technical Guides before implementation
- Follow Per-Tool Plans for specific integrations
- Execute Sprint Plans sequentially within phases
Document Version: 1.0.0 Last Updated: 2025-12-17 Maintained By: CyberChef-MCP Team