mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-22 07:56:48 +00:00
7ec8d3a6e7
* fix(security): mask sensitive values in MCP config API responses GET /api/mcp/config previously returned plaintext secrets including env dict values (API keys), headers (auth tokens), and OAuth client_secret/refresh_token. Any authenticated user could read all MCP service credentials. This commit masks sensitive fields in GET/PUT responses while preserving the key structure so the frontend round-trip (GET masked → toggle enabled → PUT) correctly preserves existing secrets. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(security): address Copilot review on MCP config masking - Load raw JSON (un-resolved $VAR placeholders) as merge source instead of resolved config, preventing plaintext secrets from replacing $VAR placeholders on disk (Comment 2) - Preserve all top-level keys (e.g. mcpInterceptors) in PUT, not just mcpServers/skills (Comment 1) - Reject masked value '***' for new keys that don't exist in existing config, returning 400 with actionable error (Comment 3) - Allow empty string '' to explicitly clear OAuth secrets, while None means 'preserve existing' for safe round-trip (Comment 4) - Add 3 new tests for rejection, clearing, and edge cases (18 total) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
290 lines
12 KiB
Python
290 lines
12 KiB
Python
import json
|
|
import logging
|
|
from pathlib import Path
|
|
from typing import Literal
|
|
|
|
from fastapi import APIRouter, HTTPException
|
|
from pydantic import BaseModel, Field
|
|
|
|
from deerflow.config.extensions_config import ExtensionsConfig, get_extensions_config, reload_extensions_config
|
|
|
|
logger = logging.getLogger(__name__)
|
|
router = APIRouter(prefix="/api", tags=["mcp"])
|
|
|
|
|
|
class McpOAuthConfigResponse(BaseModel):
|
|
"""OAuth configuration for an MCP server."""
|
|
|
|
enabled: bool = Field(default=True, description="Whether OAuth token injection is enabled")
|
|
token_url: str = Field(default="", description="OAuth token endpoint URL")
|
|
grant_type: Literal["client_credentials", "refresh_token"] = Field(default="client_credentials", description="OAuth grant type")
|
|
client_id: str | None = Field(default=None, description="OAuth client ID")
|
|
client_secret: str | None = Field(default=None, description="OAuth client secret")
|
|
refresh_token: str | None = Field(default=None, description="OAuth refresh token")
|
|
scope: str | None = Field(default=None, description="OAuth scope")
|
|
audience: str | None = Field(default=None, description="OAuth audience")
|
|
token_field: str = Field(default="access_token", description="Token response field containing access token")
|
|
token_type_field: str = Field(default="token_type", description="Token response field containing token type")
|
|
expires_in_field: str = Field(default="expires_in", description="Token response field containing expires-in seconds")
|
|
default_token_type: str = Field(default="Bearer", description="Default token type when response omits token_type")
|
|
refresh_skew_seconds: int = Field(default=60, description="Refresh this many seconds before expiry")
|
|
extra_token_params: dict[str, str] = Field(default_factory=dict, description="Additional form params sent to token endpoint")
|
|
|
|
|
|
class McpServerConfigResponse(BaseModel):
|
|
"""Response model for MCP server configuration."""
|
|
|
|
enabled: bool = Field(default=True, description="Whether this MCP server is enabled")
|
|
type: str = Field(default="stdio", description="Transport type: 'stdio', 'sse', or 'http'")
|
|
command: str | None = Field(default=None, description="Command to execute to start the MCP server (for stdio type)")
|
|
args: list[str] = Field(default_factory=list, description="Arguments to pass to the command (for stdio type)")
|
|
env: dict[str, str] = Field(default_factory=dict, description="Environment variables for the MCP server")
|
|
url: str | None = Field(default=None, description="URL of the MCP server (for sse or http type)")
|
|
headers: dict[str, str] = Field(default_factory=dict, description="HTTP headers to send (for sse or http type)")
|
|
oauth: McpOAuthConfigResponse | None = Field(default=None, description="OAuth configuration for MCP HTTP/SSE servers")
|
|
description: str = Field(default="", description="Human-readable description of what this MCP server provides")
|
|
|
|
|
|
class McpConfigResponse(BaseModel):
|
|
"""Response model for MCP configuration."""
|
|
|
|
mcp_servers: dict[str, McpServerConfigResponse] = Field(
|
|
default_factory=dict,
|
|
description="Map of MCP server name to configuration",
|
|
)
|
|
|
|
|
|
class McpConfigUpdateRequest(BaseModel):
|
|
"""Request model for updating MCP configuration."""
|
|
|
|
mcp_servers: dict[str, McpServerConfigResponse] = Field(
|
|
...,
|
|
description="Map of MCP server name to configuration",
|
|
)
|
|
|
|
|
|
_MASKED_VALUE = "***"
|
|
|
|
|
|
def _mask_server_config(server: McpServerConfigResponse) -> McpServerConfigResponse:
|
|
"""Return a copy of server config with sensitive fields masked.
|
|
|
|
Masks env values, header values, and removes OAuth secrets so they
|
|
are not exposed through the GET API endpoint.
|
|
"""
|
|
masked_env = {k: _MASKED_VALUE for k in server.env}
|
|
masked_headers = {k: _MASKED_VALUE for k in server.headers}
|
|
masked_oauth = None
|
|
if server.oauth is not None:
|
|
masked_oauth = server.oauth.model_copy(
|
|
update={
|
|
"client_secret": None,
|
|
"refresh_token": None,
|
|
}
|
|
)
|
|
return server.model_copy(
|
|
update={
|
|
"env": masked_env,
|
|
"headers": masked_headers,
|
|
"oauth": masked_oauth,
|
|
}
|
|
)
|
|
|
|
|
|
def _merge_preserving_secrets(
|
|
incoming: McpServerConfigResponse,
|
|
existing: McpServerConfigResponse,
|
|
) -> McpServerConfigResponse:
|
|
"""Merge incoming config with existing, preserving secrets masked by GET.
|
|
|
|
When the frontend toggles ``enabled`` it round-trips the full config:
|
|
GET (masked) → modify enabled → PUT (masked values sent back).
|
|
This function ensures masked values (``***``) are replaced with the
|
|
real secrets from the current on-disk config.
|
|
|
|
``***`` is only accepted for keys that already exist in *existing*.
|
|
New keys must provide a real value.
|
|
|
|
For OAuth secrets, ``None`` means "preserve the existing stored value"
|
|
so masked GET responses can be safely round-tripped. To explicitly clear
|
|
a stored secret, clients may send an empty string, which is converted
|
|
to ``None`` before persisting.
|
|
"""
|
|
merged_env = {}
|
|
for k, v in incoming.env.items():
|
|
if v == _MASKED_VALUE:
|
|
if k in existing.env:
|
|
merged_env[k] = existing.env[k]
|
|
else:
|
|
raise HTTPException(
|
|
status_code=400,
|
|
detail=f"Cannot set env key '{k}' to masked value '***'; provide a real value.",
|
|
)
|
|
else:
|
|
merged_env[k] = v
|
|
|
|
merged_headers = {}
|
|
for k, v in incoming.headers.items():
|
|
if v == _MASKED_VALUE:
|
|
if k in existing.headers:
|
|
merged_headers[k] = existing.headers[k]
|
|
else:
|
|
raise HTTPException(
|
|
status_code=400,
|
|
detail=f"Cannot set header '{k}' to masked value '***'; provide a real value.",
|
|
)
|
|
else:
|
|
merged_headers[k] = v
|
|
|
|
merged_oauth = incoming.oauth
|
|
if incoming.oauth is not None and existing.oauth is not None:
|
|
# None = preserve (masked round-trip), "" = explicitly clear, else = new value
|
|
merged_client_secret = existing.oauth.client_secret if incoming.oauth.client_secret is None else (None if incoming.oauth.client_secret == "" else incoming.oauth.client_secret)
|
|
merged_refresh_token = existing.oauth.refresh_token if incoming.oauth.refresh_token is None else (None if incoming.oauth.refresh_token == "" else incoming.oauth.refresh_token)
|
|
merged_oauth = incoming.oauth.model_copy(
|
|
update={
|
|
"client_secret": merged_client_secret,
|
|
"refresh_token": merged_refresh_token,
|
|
}
|
|
)
|
|
return incoming.model_copy(
|
|
update={
|
|
"env": merged_env,
|
|
"headers": merged_headers,
|
|
"oauth": merged_oauth,
|
|
}
|
|
)
|
|
|
|
|
|
@router.get(
|
|
"/mcp/config",
|
|
response_model=McpConfigResponse,
|
|
summary="Get MCP Configuration",
|
|
description="Retrieve the current Model Context Protocol (MCP) server configurations.",
|
|
)
|
|
async def get_mcp_configuration() -> McpConfigResponse:
|
|
"""Get the current MCP configuration.
|
|
|
|
Returns:
|
|
The current MCP configuration with all servers.
|
|
|
|
Example:
|
|
```json
|
|
{
|
|
"mcp_servers": {
|
|
"github": {
|
|
"enabled": true,
|
|
"command": "npx",
|
|
"args": ["-y", "@modelcontextprotocol/server-github"],
|
|
"env": {"GITHUB_TOKEN": "***"},
|
|
"description": "GitHub MCP server for repository operations"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
"""
|
|
config = get_extensions_config()
|
|
|
|
servers = {name: _mask_server_config(McpServerConfigResponse(**server.model_dump())) for name, server in config.mcp_servers.items()}
|
|
return McpConfigResponse(mcp_servers=servers)
|
|
|
|
|
|
@router.put(
|
|
"/mcp/config",
|
|
response_model=McpConfigResponse,
|
|
summary="Update MCP Configuration",
|
|
description="Update Model Context Protocol (MCP) server configurations and save to file.",
|
|
)
|
|
async def update_mcp_configuration(request: McpConfigUpdateRequest) -> McpConfigResponse:
|
|
"""Update the MCP configuration.
|
|
|
|
This will:
|
|
1. Save the new configuration to the mcp_config.json file
|
|
2. Reload the configuration cache
|
|
3. Reset MCP tools cache to trigger reinitialization
|
|
|
|
Args:
|
|
request: The new MCP configuration to save.
|
|
|
|
Returns:
|
|
The updated MCP configuration.
|
|
|
|
Raises:
|
|
HTTPException: 500 if the configuration file cannot be written.
|
|
|
|
Example Request:
|
|
```json
|
|
{
|
|
"mcp_servers": {
|
|
"github": {
|
|
"enabled": true,
|
|
"command": "npx",
|
|
"args": ["-y", "@modelcontextprotocol/server-github"],
|
|
"env": {"GITHUB_TOKEN": "$GITHUB_TOKEN"},
|
|
"description": "GitHub MCP server for repository operations"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
"""
|
|
try:
|
|
# Get the current config path (or determine where to save it)
|
|
config_path = ExtensionsConfig.resolve_config_path()
|
|
|
|
# If no config file exists, create one in the parent directory (project root)
|
|
if config_path is None:
|
|
config_path = Path.cwd().parent / "extensions_config.json"
|
|
logger.info(f"No existing extensions config found. Creating new config at: {config_path}")
|
|
|
|
# Load current config to preserve skills
|
|
current_config = get_extensions_config()
|
|
|
|
# Load raw (un-resolved) JSON from disk to use as the merge source.
|
|
# This preserves $VAR placeholders in env values and top-level keys
|
|
# like mcpInterceptors that would otherwise be lost.
|
|
raw_servers: dict[str, dict] = {}
|
|
raw_other_keys: dict = {}
|
|
if config_path is not None and config_path.exists():
|
|
with open(config_path, encoding="utf-8") as f:
|
|
raw_data = json.load(f)
|
|
raw_servers = raw_data.get("mcpServers", {})
|
|
# Preserve any top-level keys beyond mcpServers/skills
|
|
for key, value in raw_data.items():
|
|
if key not in ("mcpServers", "skills"):
|
|
raw_other_keys[key] = value
|
|
|
|
# Merge incoming server configs with raw on-disk secrets
|
|
merged_servers: dict[str, McpServerConfigResponse] = {}
|
|
for name, incoming in request.mcp_servers.items():
|
|
raw_server = raw_servers.get(name)
|
|
if raw_server is not None:
|
|
merged_servers[name] = _merge_preserving_secrets(
|
|
incoming,
|
|
McpServerConfigResponse(**raw_server),
|
|
)
|
|
else:
|
|
merged_servers[name] = incoming
|
|
|
|
# Build config data preserving all top-level keys from the original file
|
|
config_data = dict(raw_other_keys)
|
|
config_data["mcpServers"] = {name: server.model_dump() for name, server in merged_servers.items()}
|
|
config_data["skills"] = {name: {"enabled": skill.enabled} for name, skill in current_config.skills.items()}
|
|
|
|
# Write the configuration to file
|
|
with open(config_path, "w", encoding="utf-8") as f:
|
|
json.dump(config_data, f, indent=2)
|
|
|
|
logger.info(f"MCP configuration updated and saved to: {config_path}")
|
|
|
|
# NOTE: No need to reload/reset cache here - LangGraph Server (separate process)
|
|
# will detect config file changes via mtime and reinitialize MCP tools automatically
|
|
|
|
# Reload the configuration and update the global cache
|
|
reloaded_config = reload_extensions_config()
|
|
servers = {name: _mask_server_config(McpServerConfigResponse(**server.model_dump())) for name, server in reloaded_config.mcp_servers.items()}
|
|
return McpConfigResponse(mcp_servers=servers)
|
|
|
|
except Exception as e:
|
|
logger.error(f"Failed to update MCP configuration: {e}", exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to update MCP configuration: {str(e)}")
|