Cyber Chef MCP

CyberChef MCP服务器

该项目提供了 模型上下文协议（MCP） 服务器接口 网络大厨，由 一般通信司令部.

通过运行此服务器，您可以使AI助手（如Claude、Cursor AI等）能够以可执行工具的形式，原生地利用CyberChef的463个数据操作操作库，包括加密、编码、压缩和取证分析。

最新版本： v1.9.0| 发布说明 | 安全策略 | 安全修复报告

CyberChef MCP Banner

  ](https://github.com/doublegate/CyberChef-MCP/releases) ](https://nodejs.org/)  

项目上下文

网络大厨 是一个简单直观的网络应用程序，用于在网络浏览器中执行各种“网络”操作。它最初是由 一般通信司令部.

该分叉将核心CyberChef Node.js API封装到MCP服务器中，弥合了自然语言人工智能意图和确定性数据处理之间的差距。

分叉关系

该项目与上游GCHQ/CyberChef存储库保持选择性同步关系：

• 核心业务：从上游同步(src/core/operations/*.mjs)通过自动化工作流程
• Web UI组件：已删除（88个文件，约19260行）-MCP服务器不需要
• MCP特定代码：自定义实施(src/node/mcp-server.mjs、测试、工作流）
• 同步模型：选择性文件复制，而不是git合并，以保留MCP特定的修改

看 上游同步指南 有关同步过程的详细信息。

CyberChef MCP Blueprint

特性

MCP工具

服务器将CyberChef操作作为MCP工具公开：

• cyberchef_bake：“Omni工具”。对输入执行完整的CyberChef配方（一系列操作）。非常适合复杂的多步骤转换（例如，“解码Base64，然后是Gunzip，然后是美化JSON”）。
• 原子操作：463个用于特定任务的单独工具，由CyberChef配置动态生成。

- cyberchef_to_base64 / cyberchef_from_base64 - cyberchef_aes_decrypt - cyberchef_sha2 - cyberchef_yara_rules - …还有数百人。

• cyberchef_search：一个帮助人工智能发现可用操作及其描述的实用工具。
• 食谱管理 （v1.6.0）：10个用于保存、组织和重用多操作工作流的工具

- cyberchef_recipe_create / cyberchef_recipe_get / cyberchef_recipe_list - cyberchef_recipe_update / cyberchef_recipe_delete / cyberchef_recipe_execute - cyberchef_recipe_export / cyberchef_recipe_import - cyberchef_recipe_validate / cyberchef_recipe_test

• 高级功能 （v1.7.0）：5个用于企业级功能的新工具

- cyberchef_batch -以并行或顺序模式执行多个操作 - cyberchef_telemetry_export -隐私优先使用分析（选择加入） - cyberchef_cache_stats / cyberchef_cache_clear -缓存检查和管理 - cyberchef_quota_info -资源配额和使用情况跟踪

• 迁移工具 （v1.8.0）：全面的v2.0.0准备和迁移协助

- cyberchef_migration_preview -分析配方是否与v2.0.0兼容，有两种模式： - analyze 模式：通过详细的诊断检查破坏性更改的配方 - transform 模式：自动将食谱转换为v2.0.0格式 - cyberchef_deprecation_stats -跟踪不推荐使用的API使用统计信息 - 显示当前会话中触发的弃用警告 - 报告会话持续时间、抑制状态和v2兼容模式 - 列出所有8个弃用代码（DEP001-DEP008）及其详细信息

• 工作线程池 （v1.9.0）：将CPU密集型操作卸载到工作线程

- cyberchef_worker_stats -监控工作池利用率、活动/已完成任务和池配置 - 启用 CYBERCHEF_ENABLE_WORKERS=true 环境变量 - 可配置的池大小、空闲超时和工作路由的最小输入大小

技术亮点

• 容器化：作为一个轻量级的、自包含的Docker容器运行，基于Chaingguard无发行版的Node.js 22（压缩约90MB，攻击面比传统映像小70%）。
• 双注册表发布：发布到Docker Hub和GitHub容器注册表（GHCR）的映像，以实现最大的可访问性和Docker Scout健康评分优化。
• 供应链认证：附加到Docker Hub映像的SBOM和来源证明，以提高安全透明度和合规性（SLSA Build Level 3）。
• 双重运输 （v1.9.0）：Stdio（默认）或通过流式传输HTTP CYBERCHEF_TRANSPORT=http 适用于浏览器和远程客户端。
• MCP流媒体正在进行中 （v1.9.0）：操作发送 notifications/progress 通过MCP SDK进度令牌机制，在长时间运行的任务期间进行实时状态更新。
• 工作线程池 （v1.9.0）：基于Piscina的工作线程卸载CPU密集型操作（AES、Blowfish、bcrypt、scrypt、PBKDF2等），以防止事件循环阻塞。可配置的池大小和路由阈值。
• 模式验证：所有输入都根据CyberChef内部类型系统导出的模式进行验证，使用 zod.
• 现代Node.js：与Node.js v22+完全兼容，并带有自动兼容性补丁。
• 食谱管理 （v1.6.0）：保存和重用具有完整CRUD操作的多操作工作流，以多种格式（JSON/YAML/URL/Cybechef）导入/导出，具有嵌套支持的配方组合，以及5个类别中25个以上生产就绪配方的精选库。看 配方管理指南 了解详情。
• 高级功能 （v1.7.0）：企业级功能，具有批处理（并行/顺序执行多达100个操作）、隐私优先的遥测收集（默认禁用，不捕获输入/输出数据）、用于资源保护的滑动窗口速率限制、使用检查工具的增强缓存和资源配额跟踪（并发操作、数据大小）。所有功能都可以通过具有安全默认值的环境变量进行配置。看 发布说明 了解详情。
• 增强可观察性 （v1.5.0）：使用Pino进行结构化JSON日志记录以进行生产监控，使用可操作的恢复建议进行全面的错误处理，使用指数回退的自动重试逻辑，与UUID跟踪的请求相关性，用于级联故障预防的断路器模式，以及用于大型操作渐进结果的流式基础设施。看 发布说明 了解详情。
• 性能优化 （v1.4.0）：用于操作结果的LRU缓存（默认100MB），用于大输入的自动流式传输（10MB+阈值），可配置的资源限制（最大输入100MB，30秒超时），内存监控和全面的基准测试套件。看 性能调整指南 用于配置选项。
• 上游同步自动化 （v1.3.0）：每周（UTC周日中午）自动监控上游CyberChef发布，一键同步工作流程，包含689个测试的全面验证测试套件，以及紧急回滚机制。
• 生产就绪：具有CodeQL v4、自动化测试和双注册表容器发布（Docker Hub+GHCR）的全面CI/CD，并具有完整的供应链认证。

快速开始

先决条件

• 码头工人 安装并运行。

安装选项

选项1：从Docker Hub拉取（在线，推荐）

# Docker Hub provides health scores and supply chain attestations
docker pull doublegate/cyberchef-mcp:latest
docker tag doublegate/cyberchef-mcp:latest cyberchef-mcp
docker run -i --rm cyberchef-mcp

选项1b：从GitHub容器注册表中提取（替代）

docker pull ghcr.io/doublegate/cyberchef-mcp_v1:latest
docker tag ghcr.io/doublegate/cyberchef-mcp_v1:latest cyberchef-mcp
docker run -i --rm cyberchef-mcp

选项2：下载预构建映像（离线安装）

对于没有直接GHCR访问权限的环境，请从以下网址下载预构建的Docker镜像tarball 最新版本:

1. 下载tarball （压缩约90MB）：

   # Download from GitHub Releases
   wget https://github.com/doublegate/CyberChef-MCP/releases/download/v1.9.0/cyberchef-mcp-v1.9.0-docker-image.tar.gz

1. 将镜像加载到Docker中：

   docker load  **特性** > **主控程序**.
1. 添加新服务器：
   - **姓名：** `CyberChef`
   - **类型：** `command`
   - **命令：** `docker`
   - **Args：** `run -i --rm cyberchef-mcp`

### 克劳德代码（CLI）

添加到配置文件（通常 `~/.config/claude/config.json`):

{ "mcpServers": { "cyberchef": { "command": "docker", "args": ["run", "-i", "--rm", "cyberchef-mcp"] } } }

### 克劳德桌面

添加到您的Claude Desktop配置文件中：

- **macOS：** `~/Library/Application Support/Claude/claude_desktop_config.json`
- **窗户：** `%APPDATA%/Claude/claude_desktop_config.json`

{ "mcpServers": { "cyberchef": { "command": "docker", "args": ["run", "-i", "--rm", "cyberchef-mcp"] } } }

添加配置后，重新启动Claude Desktop。CyberChef工具将出现在可用工具面板中。

## 性能和配置

1.4.0版本引入了全面的性能优化和可配置的资源限制。所有功能都可以通过环境变量进行调整，以满足您的部署需求。

### 性能特点

**LRU缓存操作结果**

- 自动缓存操作结果以消除冗余计算
- 可配置缓存大小（默认100MB）和项目计数（默认1000）
- 基于操作+输入+参数（SHA256哈希）的缓存密钥

**大输入的自动流媒体**

- 超过10MB的输入会自动使用分块处理
- 支持编码、压缩和散列操作
- 100MB+文件的内存高效处理
- 非流操作的透明回退

**资源限制**

- 最大输入大小验证（默认100MB）
- 操作超时强制（默认30秒）
- 防止内存不足崩溃和操作失控

**内存监控**

- 定期将内存使用情况记录到stderr
- 堆和RSS跟踪用于故障排除

### 配置选项

所有功能都可以通过环境变量进行配置：

Logging (v1.5.0+)

LOG_LEVEL=info # Logging level: debug, info, warn, error, fatal

Retry Logic (v1.5.0+)

CYBERCHEF_MAX_RETRIES=3 # Maximum retry attempts for transient failures CYBERCHEF_INITIAL_BACKOFF=1000 # Initial backoff delay in milliseconds CYBERCHEF_MAX_BACKOFF=10000 # Maximum backoff delay in milliseconds CYBERCHEF_BACKOFF_MULTIPLIER=2 # Backoff multiplier for exponential backoff

Streaming (v1.5.0+)

CYBERCHEF_STREAM_CHUNK_SIZE=1048576 # Chunk size for streaming (1MB) CYBERCHEF_STREAM_PROGRESS_INTERVAL=10485760 # Progress reporting interval (10MB)

Recipe Management (v1.6.0+)

CYBERCHEF_RECIPE_STORAGE=./recipes.json # Storage file path CYBERCHEF_RECIPE_MAX_COUNT=10000 # Maximum number of recipes CYBERCHEF_RECIPE_MAX_OPERATIONS=100 # Max operations per recipe CYBERCHEF_RECIPE_MAX_DEPTH=5 # Max nesting depth

Batch Processing (v1.7.0+)

CYBERCHEF_BATCH_MAX_SIZE=100 # Maximum operations per batch CYBERCHEF_BATCH_ENABLED=true # Enable/disable batch processing

Telemetry & Analytics (v1.7.0+)

CYBERCHEF_TELEMETRY_ENABLED=false # Privacy-first: disabled by default

Rate Limiting (v1.7.0+)

CYBERCHEF_RATE_LIMIT_ENABLED=false # Disabled by default CYBERCHEF_RATE_LIMIT_REQUESTS=100 # Max requests per window CYBERCHEF_RATE_LIMIT_WINDOW=60000 # Time window in milliseconds

Cache Management (v1.7.0+)

CYBERCHEF_CACHE_ENABLED=true # Enable/disable caching

Resource Quotas (v1.7.0+)

CYBERCHEF_MAX_CONCURRENT_OPS=10 # Maximum concurrent operations

Deprecation & Migration (v1.8.0+)

V2_COMPATIBILITY_MODE=false # Enable v2.0.0 behavior preview (elevates warnings to errors) CYBERCHEF_SUPPRESS_DEPRECATIONS=false # Suppress deprecation warnings

Transport (v1.9.0+)

CYBERCHEF_TRANSPORT=stdio # Transport type: stdio or http CYBERCHEF_HTTP_PORT=3000 # HTTP transport port CYBERCHEF_HTTP_HOST=127.0.0.1 # HTTP transport bind address

Worker Thread Pool (v1.9.0+)

CYBERCHEF_WORKER_MIN_THREADS=1 # Minimum worker threads CYBERCHEF_WORKER_MAX_THREADS=4 # Maximum worker threads CYBERCHEF_WORKER_IDLE_TIMEOUT=30000 # Worker idle timeout in milliseconds CYBERCHEF_WORKER_MIN_INPUT_SIZE=1024 # Minimum input size for worker routing (bytes)

Performance (v1.4.0+)

CYBERCHEF_MAX_INPUT_SIZE=104857600 # Maximum input size (100MB) CYBERCHEF_OPERATION_TIMEOUT=30000 # Operation timeout in milliseconds (30s) CYBERCHEF_STREAMING_THRESHOLD=10485760 # Streaming threshold (10MB) CYBERCHEF_ENABLE_STREAMING=true # Enable streaming for large operations CYBERCHEF_ENABLE_WORKERS=false # Enable worker thread pool (disabled by default) CYBERCHEF_CACHE_MAX_SIZE=104857600 # Cache maximum size (100MB) CYBERCHEF_CACHE_MAX_ITEMS=1000 # Cache maximum items

### 示例配置

**高吞吐量服务器（大文件）**

docker run -i --rm --memory=4g \ -e CYBERCHEF_MAX_INPUT_SIZE=524288000 \ -e CYBERCHEF_STREAMING_THRESHOLD=52428800 \ -e CYBERCHEF_CACHE_MAX_SIZE=524288000 \ -e CYBERCHEF_OPERATION_TIMEOUT=120000 \ ghcr.io/doublegate/cyberchef-mcp_v1:latest

**低内存环境**

docker run -i --rm --memory=512m \ -e CYBERCHEF_MAX_INPUT_SIZE=10485760 \ -e CYBERCHEF_STREAMING_THRESHOLD=5242880 \ -e CYBERCHEF_CACHE_MAX_SIZE=10485760 \ -e CYBERCHEF_CACHE_MAX_ITEMS=100 \ ghcr.io/doublegate/cyberchef-mcp_v1:latest

**带自定义限制的Claude桌面**

{ "mcpServers": { "cyberchef": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "CYBERCHEF_MAX_INPUT_SIZE=209715200", "-e", "CYBERCHEF_CACHE_MAX_SIZE=209715200", "ghcr.io/doublegate/cyberchef-mcp_v1:latest" ] } } }

**故障排除的调试日志记录（v1.5.0+）**

docker run -i --rm \ -e LOG_LEVEL=debug \ -e CYBERCHEF_MAX_RETRIES=5 \ ghcr.io/doublegate/cyberchef-mcp_v1:latest

**用于CPU密集型操作的工作线程池（v1.9.0+）**

docker run -i --rm \ -e CYBERCHEF_ENABLE_WORKERS=true \ -e CYBERCHEF_WORKER_MAX_THREADS=8 \ -e CYBERCHEF_WORKER_IDLE_TIMEOUT=60000 \ ghcr.io/doublegate/cyberchef-mcp_v1:latest

**浏览器/远程客户端的HTTP传输（v1.9.0+）**

docker run --rm -p 3000:3000 \ -e CYBERCHEF_TRANSPORT=http \ -e CYBERCHEF_HTTP_PORT=3000 \ -e CYBERCHEF_HTTP_HOST=0.0.0.0 \ ghcr.io/doublegate/cyberchef-mcp_v1:latest

有关详细的性能调优指导，请参阅 [性能调整指南](docs/architecture/performance-tuning.md).

### 性能基准

运行基准测试套件来衡量硬件的性能：

Install dependencies

npm install

Generate required configuration

npx grunt configTests

Run benchmarks

npm run benchmark

基准测试套件测试了20多种不同输入大小（1KB、10KB、100KB）的操作，类别包括：

- 编码操作（Base64，十六进制）
- 哈希运算（MD5、SHA256、SHA512）
- 压缩操作（Gzip）
- 加密操作（AES）
- 文本操作（正则表达式）
- 分析操作（熵、频率分布）

## 安全

该项目通过持续改进实现了全面的安全强化：

### 最新增强功能（v1.6.0）

- **配方管理系统**：保存、组织和重用多操作工作流
  - **CRUD操作**：使用版本控制创建、读取、更新、删除食谱
  - **导入/导出**：JSON、YAML、URL和CyberChef格式支持
  - **配方组成**：在复杂工作流程的食谱中嵌套食谱
  - **配方库**：5个类别（密码学、编码、数据提取、取证、网络）的25个以上精选示例
  - **验证工具**：执行前验证和复杂性估计
  - **测试工具**：部署前使用样本输入测试配方
  - **10个新的MCP工具**：完整的配方生命周期管理
  - 看 [配方管理指南](docs/guides/recipe_management.md) 获取完整的使用文档

### 增强可观察性（v1.5.0）

- **增强的错误处理**：用于生产调试的全面错误报告
  - **8错误代码**：标准化错误分类（INVALID_INPUT、MISSING_ARGUMENT、OPERATION_FAILED、超时、OUT_OF_MEMORY、不支持操作、缓存错误、流错误）
  - **丰富的上下文**：详细的调试信息（输入大小、操作名称、请求ID、时间戳）
  - **恢复建议**：就共同问题提出可采取行动的建议
  - **可重试分类**：瞬时故障和永久故障之间的自动区分
- **使用Pino进行结构化日志记录**：生产就绪可观察性
  - **JSON日志**：用于监控工具（Datadog、Splunk、ELK）的机器可读日志
  - **请求关联**：跨操作的基于UUID的请求跟踪
  - **性能指标**：持续时间、吞吐量、缓存命中率、内存使用率
  - **可配置级别**：通过LOGLEVEL环境变量调试、信息、警告、错误、致命
- **自动重试逻辑**：瞬态故障的弹性
  - **指数退避**: 1s → 2s → 4用抖动来防止羊群打雷
  - **可配置检索**：默认3次尝试，可通过CYBERCHEF_MAX_RETRIES进行自定义
  - **智能检测**：自动重试超时、内存问题、网络错误
  - **断路器**：在连续5次故障后打开，以防止级联问题
- **MCP流媒体基础设施**：大型行动的逐步成果
  - **块状加工**：100MB+输入的内存高效处理
  - **进度报告**：长时间运行的操作每10MB更新一次
  - **14支持的操作**：编码（Base64，十六进制）、散列（MD5，SHA家族）、文本操作
  - **可配置阈值**：流块大小和进度间隔

### 安全强化（v1.4.6）

- **Chaingguard Distrioles基础图片**：企业级集装箱安全
  - **零CVE基线**：关键补丁的7天SLA每日安全更新
  - **攻击面缩小70%**：与传统的Alpine/DDebian映像相比，操作系统占用空间最小
  - **非根执行**：在无发行版环境中以UID 65532（非root用户）运行
  - **SLSA构建级别3来源**：可验证的供应链完整性
  - **多阶段构建**: `-dev` 用于编译的变体，用于生产的无发行版运行时
- **只读文件系统支持**：生产就绪的不可变部署
  - 支持 `docker run --read-only` 使用/tmpfs挂载/tmp
  - 符合PCI-DSS、SOC 2、FedRAMP要求
  - 例子： `docker run -i --rm --read-only --tmpfs /tmp:rw,noexec,nosuid,size=100m cyberchef-mcp`
- **安全扫描失败阈值**：自动漏洞预防
  - Trivy扫描仪配置有 `exit-code: '1'` 在CI/CD中
  - 构建在关键或高漏洞上自动失败
  - 防止易受攻击的图像进入生产环境
- **双SBOM战略**：全面的供应链透明度
  - **第1部分**：用于自动注册表扫描的Docker buildx认证（Docker Scout）
  - **第2部分**：Trivy CycloneDX SBOM用于离线合规审计
  - 两个SBOM都作为发布资产附上以供验证

### 代码安全（v1.4.1+）

- **修复了12个代码扫描漏洞中的11个**：完成全面的安全强化
  - **关键的**：修复GOST库中不安全的加密随机性-已替换 `Math.random()` 随着 `crypto.randomBytes()`
  - **高**：在6次操作中消除了7个ReDoS（正则表达式拒绝服务）漏洞
  - **新模块**：SafeRegex.mjs为所有用户控制的正则表达式模式提供集中验证
    - 图案长度限制（10000个字符）
    - ReDoS模式检测（嵌套量词、重叠替换）
    - 基于超时的验证（100ms），用于检测灾难性回溯
    - XRegExp和标准RegExp支持
- **全部1933项测试通过**：通过全面的测试套件验证安全修复
- 看 [安全修复报告](docs/security/SECURITY_FIX_REPORT.md) 有关完整详细信息

### 供应链安全（v1.4.5+）

- **具有认证的双注册发布**：增强安全透明度和合规性
  - **Docker 中心**：使用Docker Scout健康评分监控的主要分发
  - **GitHub容器注册表（GHCR）**：GitHub生态系统集成的二级分发
  - 两个注册表都接收具有完全证明支持的相同映像
- **Docker Scout认证**：建立完整性和软件透明度
  - **产地证明** （模式=最大值）：完成SLSA构建级别3合规性的构建过程元数据（构建器、材料、配方）
  - **SBOM证明**：SPDX-JSON格式的自动软件物料清单生成
  - 在Docker Hub上获得最佳的Docker Scout健康评分（A级或B级）
  - 在健康评分计算中，15分（满分100分）是权重最高的政策类别之一
- **双SBOM战略**：全面的软件透明度
  - **Docker认证SBOM**：附在图像清单上，用于基于注册表的验证和 `docker sbom` 命令
  - **琐碎的SBOM文物**：用于离线审计和合规性报告的独立CycloneDX文件
  - 两个SBOM都包含完整的依赖关系树和版本信息
- **Trivy集成**：使用快速失败阈值对每个构建进行容器和依赖关系扫描
- **GitHub安全选项卡**：所有结果都自动上传为SARIF
- **验证**：使用 `docker scout quickview` 和 `docker sbom` 本地检查认证的命令

### 集装箱安全（v1.4.5+）

- **女主席无发行版**：零CVE基线，攻击面最小
- **非根执行**：容器以UID 65532运行（无发行版中的非root用户）
- **只读文件系统**：支持 `--read-only` 不可变部署的标志
- **最小攻击面**：没有shell，没有包管理器，只有运行时依赖关系
- **健康检查**：内置容器健康监测

### 加密强化（v1.2.5）

- **Argon2 OWASP合规性**：默认参数遵循OWASP 2024-2025建议
  - 类型：Argon2d（混合侧通道+GPU电阻）
  - 内存：19 MiB（最低OWASP）
  - 迭代次数：2次（OWASP建议用于19MiB）
- **安全随机数生成**：所有加密操作都使用 `crypto.randomBytes()` 或 `crypto.getRandomValues()`
- **CVE-2025-64756已修复**：更新了npm以解决glob命令注入漏洞

### 自动安全扫描

- **CodeQL分析**：持续扫描代码以查找安全漏洞
- **每周扫描**：计划扫描捕获新发现的漏洞

### 安全部署

Recommended: Run with maximum security options (Chainguard distroless)

docker run -i --rm \ --read-only \ --tmpfs /tmp:rw,noexec,nosuid,size=100m \ --cap-drop=ALL \ --security-opt=no-new-privileges \ cyberchef-mcp

Note: Chainguard distroless already runs as non-root (UID 65532)

--read-only requires tmpfs mount for /tmp directory

有关详细信息，请参阅：

- [安全策略](SECURITY.md) -漏洞报告和安全策略
- [安全审计](docs/security/audit.md) -综合安全评估
- [安全修复报告](docs/security/SECURITY_FIX_REPORT.md) -最新漏洞修复
- [安全修复摘要](docs/security/SECURITY_FIXES_SUMMARY.md) -快速参考指南

## 项目路线图

CyberChef MCP服务器有一个全面的开发路线图，涵盖 **19次发布** 穿过 **6个阶段** 直到2027年8月。

|阶段|发布|时间线|焦点|状态|
|-------|----------|----------|-------|--------|
| **第一阶段：基础** |v1.2.0-v1.4.6 | 2025年第4季度-2026年第1季度|安全强化、上游同步、性能| **完成** |
| **第二阶段：增强** |v1.5.0-v1.7.3 | 2026年第2季度|流媒体、配方管理、批处理| **完成** |
| **第三阶段：成熟** |v1.8.0-v2.0.0 | 2026年第3季度| API稳定，外部工具集成，v2.0.0| **v1.9.0发布** |
| **第四阶段：扩建** |v2.1.0-v2.3.0 |2026年第四季度|多模式、高级传输、插件|计划中|
| **第五阶段：企业** |v2.4.0-v2.6.0 | 2027年第一季度| OAuth 2.1、RBAC、Kubernetes、可观察性|计划中|
| **第六阶段：进化** |v2.7.0-v3.0.0 | 2027年第二季度第三季度|边缘部署，AI原生功能，v3.0.0 |计划中|

**v2.0.0规划：** 全面的外部项目集成规划现已完成，有30份规划文件，涵盖8个安全工具项目（Ciphey、crypti、xortool、RsaCtfTool、John the Ripper、pwntools、katana、cyberchef recipes）的80-120个新MCP工具。看 [外部项目集成](docs/planning/ext-proj-int/) 了解详情。

看 [**完整路线图**](docs/planning/ROADMAP.md) 了解详细的发布计划和时间表。

## 文档

详细文档组织在 [`docs/`](docs/) 目录：

### 用户指南

- [**用户指南**](docs/guides/user_guide.md)：详细的安装和客户端配置
- [**命令参考**](docs/guides/commands.md)：所有可用MCP工具和操作列表
- [**配方管理指南**](docs/guides/recipe_management.md)：保存、组织和重用工作流的完整指南
- [**上游同步指南**](docs/guides/upstream-sync-guide.md)：选择性上游同步工作流程指南
- ：Docker Hub发布和认证快速入门指南
- ：供应链认证和健康评分综合指南

### 开发指南

- [**Codecov集成指南**](docs/guides/codecov-integration.md)：覆盖率分析、捆绑包分析和测试分析

### 技术文档

- [**建筑**](docs/architecture/architecture.md)：MCP服务器的技术设计
- [**技术实现**](docs/architecture/technical_implementation.md)：实施细节
- [**性能调整指南**](docs/architecture/performance-tuning.md)：优化性能的配置指南

### 项目管理

- [**产品路线图**](docs/planning/ROADMAP.md)：全面v1.1.0→ 带时间线的v3.0.0路线图
- [**任务**](docs/planning/tasks.md)：按版本组织的500多个实施任务
- [**开发阶段**](docs/planning/phases/overview.md)：每个开发阶段的Sprint细分
- [**发布计划**](docs/planning/future-releases/)：个人发布规范（v1.2.0-v3.0.0）
- [**项目概要**](docs/internal/project_summary.md)：内部项目概述

### 战略规划

- [**上游同步策略**](docs/planning/strategies/UPSTREAM-SYNC-STRATEGY.md)：自动CyberChef更新监控
- [**安全强化计划**](docs/planning/strategies/SECURITY-HARDENING-PLAN.md)：Docker DHI，非root，SBOM生成
- [**多模式策略**](docs/planning/strategies/MULTI-MODAL-STRATEGY.md)：通过MCP进行图像/二进制/音频处理
- [**插件架构**](docs/planning/strategies/PLUGIN-ARCHITECTURE-DESIGN.md)：自定义操作和沙盒执行
- [**企业功能**](docs/planning/strategies/ENTERPRISE-FEATURES-PLAN.md)：OAuth 2.1、RBAC、审计日志

### v2.0.0集成规划

- [**外部项目集成**](docs/planning/ext-proj-int/)：全面规划v2.0.0+集成
  - [概述](docs/planning/ext-proj-int/overview.md)：集成战略和架构（4个阶段，12个冲刺，80-120个新工具）
  - [阶段计划](docs/planning/ext-proj-int/phases/)：基础，JavaScript原生，算法端口，高级
  - [Sprint计划](docs/planning/ext-proj-int/sprints/)：12个详细的冲刺分解和任务列表
  - [工具集成计划](docs/planning/ext-proj-int/tools/)：按工具集成策略（Ciphey、crypti、xortool、RsaCtfTool、John、pwntools、katana、recipes）
  - [技术指南](docs/planning/ext-proj-int/technical/)：工具注册、算法移植、测试、依赖关系

### 参考文档

- [**安全工具参考**](docs/reference/)11个安全工具和相关项目的技术文件
  - [阿瑞斯](docs/reference/ares.md), [ciphey](docs/reference/ciphey.md)：自动解码工具和算法
  - [神秘](docs/reference/cryptii.md)：模块化编码/解码系统
  - [网络厨师食谱](docs/reference/cyberchef-recipes.md), [网络厨师服务器](docs/reference/cyberchef-server.md)：相关CyberChef项目
  - [开膛手约翰](docs/reference/john-the-ripper.md)：密码破解和哈希识别
  - [武士刀](docs/reference/katana.md), [pwntools](docs/reference/pwntools.md)：CTF和二进制开发工具
  - [rsactft工具](docs/reference/rsactftool.md), [xortool](docs/reference/xortool.md)：密码分析实用程序

### 安全与发布

- [**安全策略**](SECURITY.md)：安全政策和漏洞报告
- [**安全审计**](docs/security/audit.md)：综合安全评估
- [**安全修复报告**](docs/security/SECURITY_FIX_REPORT.md)：11个漏洞修复（ReDoS和加密弱点）的详细报告
- [**安全修复摘要**](docs/security/SECURITY_FIXES_SUMMARY.md)：快速参考最近的安全改进
- [**v2.0.0重大更改**](docs/v2.0.0-breaking-changes.md)：v2.0.0的全面迁移指南，包括弃用代码、示例和常见问题
- [**发行说明v1.9.0**](docs/releases/v1.9.0.md)：MCP流、工作线程池、HTTP传输、上游v10.20.0、安全更新、689测试
- [**发行说明v1.8.0**](docs/releases/v1.8.0.md)：中断更改准备-弃用警告、迁移预览工具、v2.0.0兼容模式
- [**发行说明v1.7.3**](docs/releases/v1.7.3.md)：参考文档和v2.0.0集成规划-42个新文档文件，全面的安全工具参考
- [**发行说明v1.7.2**](docs/releases/v1.7.2.md)：CI改进、测试扩展、文档更新-增强的工作流程、150个新测试、纠正的指标
- [**发行说明v1.7.1**](docs/releases/v1.7.1.md)：存储库清理和工作流增强-删除了88个未使用的文件，增强了上游同步
- [**发行说明v1.7.0**](docs/releases/v1.7.0.md)：高级功能-批处理、遥测、速率限制、缓存增强、资源配额
- [**发行说明v1.6.2**](docs/releases/v1.6.2.md)：技术债务修复-ESLint错误已解决，ENABLE_WORKERS默认值已纠正
- [**发行说明v1.6.1**](docs/releases/v1.6.1.md)：全面的测试覆盖率（311次测试，78.93%的覆盖率）和Codecov集成
- [**发行说明v1.6.0**](docs/releases/v1.6.0.md)：具有CRUD操作、导入/导出和策划库的配方管理系统
- [**发行说明v1.5.0**](docs/releases/v1.5.0.md)：增强的错误处理、结构化日志记录、自动重试、流式基础设施
- [**发行说明v1.4.6**](docs/releases/v1.4.6.md)：Sprint 1安全强化-Chaingguard无发行版迁移、零CVE基线、只读文件系统支持
- [**发行说明v1.4.5**](docs/releases/v1.4.5.md)：供应链认证和文件重组
- [**发行说明v1.4.4**](docs/releases/v1.4.4.md)：Docker Hub构建修复和12个安全漏洞修复
- [**发行说明v1.4.3**](docs/releases/v1.4.3.md)：依赖解析和Node.js 22兼容性
- [**发行说明v1.4.2**](docs/releases/v1.4.2.md)：CI/CD改进和零警告工作流程
- [**发行说明v1.4.1**](docs/releases/v1.4.1.md)：安全补丁-修复了11个代码扫描漏洞
- [**发行说明v1.4.0**](docs/releases/v1.4.0.md)：通过缓存、流媒体和资源限制进行性能优化
- [**发行说明v1.3.0**](docs/releases/v1.3.0.md)：上游同步自动化和全面测试
- [**发行说明v1.2.6**](docs/releases/v1.2.6.md)：nginx：用于web应用程序的alpine slim优化
- [**发行说明v1.2.5**](docs/releases/v1.2.5.md)：带有OWASP Argon2加固功能的安全补丁
- [**发行说明v1.2.0**](docs/releases/v1.2.0.md)：安全强化版本
- [**发行说明v1.1.0**](docs/releases/v1.1.0.md)：安全修复和Node.js 22兼容性
- [**发行说明v1.0.0**](docs/releases/v1.0.0.md)：MCP服务器初始版本

## 发展

### 本地设置

如果你想在没有Docker的情况下修改服务器代码：

1. **安装依赖关系：**

npm install

1. **生成配置：** （需要建立内部操作列表）

npx grunt configTests

1. **运行服务器：**

npm run mcp

### CI/CD

该项目使用GitHub Actions来确保稳定性和安全性：

**核心开发工作流程：**

- **MCP服务器CI** ([`core-ci.yml`](.github/workflows/core-ci.yml))：在Node.js v22上测试底层CyberChef逻辑和配置生成
- **Docker构建** ()：构建、验证和安全扫描 `cyberchef-mcp` Docker镜像
- **拉取请求检查** ([`pull_requests.yml`](.github/workflows/pull_requests.yml))：拉取请求的自动测试和验证
- **性能基准** ([`performance-benchmarks.yml`](.github/workflows/performance-benchmarks.yml))：代码更改的自动性能回归测试（v1.4.0+）

**代码质量和覆盖率：**

- **Codecov集成**：具有三个不同组成部分的全面代码质量分析
  - **覆盖率分析**：使用V8提供程序自动跟踪覆盖范围，并对拉取请求进行状态检查
    - 项目覆盖率阈值：70%（行、函数、语句）
    - 补丁覆盖率阈值：新代码为75%
    - 多种覆盖格式：lcov、JSON、HTML、Cobertura
    - 组件级跟踪：MCP服务器、核心运营、节点API
  - **捆绑分析**：通过@codecov/Webpack插件跟踪和可视化Webpack捆绑包大小
    - 在拉取请求中自动检测包大小变化
    - 历史捆绑包大小趋势和优化见解
    - 地方发展的试运行模式
  - **测试分析**：JUnitXML测试结果报告和分析
    - 随时间推移的测试性能跟踪
    - 缺陷检测
    - 测试执行时间监控
  - 配置： `codecov.yml`、覆盖标志、阈值、公关评论
  - 看 [Codecov集成指南](docs/guides/codecov-integration.md) 获取完整的设置和使用文档

**安全和发布工作流：**

- **安全扫描** ([`security-scan.yml`](.github/workflows/security-scan.yml))：Trivy漏洞扫描、SBOM生成、每周计划扫描
- **CodeQL分析** ([`codeql.yml`](.github/workflows/codeql.yml))：代码漏洞的自动安全扫描（CodeQL v4）
- **发布** ([`mcp-release.yml`](.github/workflows/mcp-release.yml))：将Docker镜像发布到GHCR，并在版本标签上添加SBOM附件(`v*`)，自动创建GitHub版本

**上游同步自动化（v1.3.0+）：**

- **上游监测器** ([`upstream-monitor.yml`](.github/workflows/upstream-monitor.yml))：每周（UTC周日中午）监控GCHQ/CyberChef的新版本，创建GitHub问题以供审查
- **上游同步** ([`upstream-sync.yml`](.github/workflows/upstream-sync.yml))：选择性文件同步工作流-仅限副本 `src/core/operations/*.mjs` 文件，防止恢复已删除的web UI组件，创建PR以供审查
- **回滚** ([`rollback.yml`](.github/workflows/rollback.yml))：具有状态比较和参考项目指导的紧急回滚机制

所有工作流都使用最新的CodeQL Action v4进行安全扫描和SARIF上传。

### 测试

Run all tests (requires Node.js 22+)

npm test

Run MCP validation test suite (689 tests with Vitest)

npm run test:mcp

Run MCP tests with coverage report

npm run test:coverage

Run performance benchmarks (v1.4.0+)

npm run benchmark

Test Node.js consumer compatibility

npm run testnodeconsumer

Test UI (requires production build first)

npm run build npm run testui

Lint code

npm run lint

**测试覆盖范围：**
MCP服务器在19个测试套件中保持全面的测试覆盖率：

- **总共689次测试** 覆盖所有MCP服务器组件（从v1.8.0中的563个增加）
- **覆盖阈值**：75%的行/语句，90%的函数，70%的分支
- **当前覆盖范围**：75.64%的行，75.7%的语句，91.5%的函数，71.98%的分支
- 测试套件：配置变化、覆盖率改进、弃用、错误、处理程序调度、记录器、mcp服务器、迁移预览、真实服务器处理程序、配方管理器、配方存储、配方验证器、重试、服务器集成、流式传输、v1.7.0、验证、工作池
- 注：随着新功能的添加，覆盖范围会发生变化；由于大量的集成代码，mcp-server.mjs目前的覆盖率较低

## 贡献

欢迎为MCP适配器捐款！我们感谢：

- **错误报告**：打开一个包含详细复制步骤的问题
- **功能请求**：检查 [路线图](docs/planning/roadmap.md) 首先，然后打开一个问题
- **拉取请求**：参见 [任务](docs/planning/tasks.md) 对于需要工作的区域
- **文档**：欢迎对指南和示例进行改进

### 开发流程

1. 克隆该仓库
1. 创建要素分支(`git checkout -b feature/amazing-feature`)
1. 进行更改并彻底测试
1. 使用常规提交消息进行提交(`feat:`, `fix:`, `docs:`等等）
1. 推叉并提交拉叉请求

对于对CyberChef核心业务的贡献，请记入原始账户 [GCHQ存储库](https://github.com/gchq/CyberChef).

## 存储库信息

- **原创CyberChef**: [GCHQ/网络厨师](https://github.com/gchq/CyberChef)
- **MCP叉**: [双门/CyberChef MCP](https://github.com/doublegate/CyberChef-MCP)
- **集装箱登记处**:
  - **Docker 中心** 主要的，重要的 [双门/电脑厨师mcp](https://hub.docker.com/r/doublegate/cyberchef-mcp) -使用Docker Scout健康评分和认证
  - **GHCR** （中学）： [ghcr.io/双开门/cyberchef-mcp_v1](https://github.com/doublegate/CyberChef-MCP/pkgs/container/cyberchef-mcp_v1)
- **问题追踪**: 

## 支持

如果你觉得这个项目有用，可以考虑支持它的开发：

[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-FFDD00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/doublegate)
[![Thanks.dev](https://img.shields.io/badge/Thanks.dev-Support-blue)](https://thanks.dev/doublegate)

## 许可

CyberChef发布于 [Apache 2.0许可证](https://www.apache.org/licenses/LICENSE-2.0) 并且被覆盖 [皇家版权](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/).

此MCP服务器适配器保持相同的Apache 2.0许可证。