Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
feat: enhance StdioTransport to prevent environment variable leakage (#5506)
Lorenze Jay2e36f06732eb
diff --git a/lib/crewai/src/crewai/mcp/transports/stdio.py b/lib/crewai/src/crewai/mcp/transports/stdio.pyindex d609daf1d..8701ca668 100644--- a/lib/crewai/src/crewai/mcp/transports/stdio.py+++ b/lib/crewai/src/crewai/mcp/transports/stdio.py@@ -1,7 +1,7 @@"""Stdio transport for MCP servers running as local processes."""import asyncio-import os+from collections.abc import Callableimport subprocessfrom typing import Any@@ -10,6 +10,16 @@ from typing_extensions import Selffrom crewai.mcp.transports.base import BaseTransport, TransportType+_env_filter_hook: Callable[[dict[str, str]], dict[str, str]] | None = None+"""Optional hook to post-process the environment passed to stdio MCP servers.++Extensions (e.g., enterprise policy) can set this to enforce org-wide rules such+as stripping credentials from `env` before the subprocess is spawned. The hook+receives the merged env (SDK defaults + user-supplied `env=`) and returns the+filtered env. Set to None to disable.+"""++class StdioTransport(BaseTransport):"""Stdio transport for connecting to local MCP servers.@@ -71,15 +81,18 @@ class StdioTransport(BaseTransport):try:from mcp import StdioServerParameters- from mcp.client.stdio import stdio_client+ from mcp.client.stdio import get_default_environment, stdio_client- process_env = os.environ.copy()+ process_env = get_default_environment()process_env.update(self.env)+ if _env_filter_hook is not None:+ process_env = _env_filter_hook(process_env)+server_params = StdioServerParameters(command=self.command,args=self.args,- env=process_env if process_env else None,+ env=process_env,)self._transport_context = stdio_client(server_params)diff --git a/lib/crewai/tests/mcp/test_stdio_transport.py b/lib/crewai/tests/mcp/test_stdio_transport.pynew file mode 100644index 000000000..3be32dcbc--- /dev/null+++ b/lib/crewai/tests/mcp/test_stdio_transport.py@@ -0,0 +1,124 @@+"""Tests for stdio transport."""++from unittest.mock import AsyncMock, MagicMock, patch++import pytest++import crewai.mcp.transports.stdio as stdio_transport_module+from crewai.mcp.transports.stdio import StdioTransport+++async def test_ambient_env_does_not_leak_to_server(monkeypatch):+ """Ambient env vars outside the MCP SDK's default allowlist must not reach the server.++ Regression guard: previously StdioTransport did os.environ.copy(), which leaked+ every ambient var (COMPANY_SECRET, AWS_*, etc.) into every spawned MCP server.+ """+ monkeypatch.setenv("COMPANY_SECRET", "leaked")+ monkeypatch.setenv("AWS_SECRET_ACCESS_KEY", "leaked")++ transport = StdioTransport(+ command="python",+ args=["server.py"],+ env={"OPENAI_API_KEY": "sk-test"},+ )++ captured: dict[str, dict[str, str] | None] = {}++ fake_ctx = MagicMock()+ fake_ctx.__aenter__ = AsyncMock(return_value=(MagicMock(), MagicMock()))+ fake_ctx.__aexit__ = AsyncMock(return_value=None)++ def fake_stdio_client(server_params):+ captured["env"] = server_params.env+ return fake_ctx++ with (+ patch("mcp.client.stdio.stdio_client", side_effect=fake_stdio_client),+ patch(+ "mcp.client.stdio.get_default_environment",+ return_value={"PATH": "/usr/bin", "HOME": "/home/user"},+ ),+ ):+ await transport.connect()++ env = captured["env"]+ assert env is not None+ assert "COMPANY_SECRET" not in env+ assert "AWS_SECRET_ACCESS_KEY" not in env+ assert env.get("OPENAI_API_KEY") == "sk-test"+ assert env.get("PATH") == "/usr/bin"+++async def test_user_env_overrides_default_environment():+ """User-supplied env values must override keys returned by get_default_environment()."""+ transport = StdioTransport(+ command="python",+ args=["server.py"],+ env={"PATH": "/custom/bin"},+ )++ captured: dict[str, dict[str, str] | None] = {}++ fake_ctx = MagicMock()+ fake_ctx.__aenter__ = AsyncMock(return_value=(MagicMock(), MagicMock()))+ fake_ctx.__aexit__ = AsyncMock(return_value=None)++ def fake_stdio_client(server_params):+ captured["env"] = server_params.env+ return fake_ctx++ with (+ patch("mcp.client.stdio.stdio_client", side_effect=fake_stdio_client),+ patch(+ "mcp.client.stdio.get_default_environment",+ return_value={"PATH": "/usr/bin"},+ ),+ ):+ await transport.connect()++ assert captured["env"]["PATH"] == "/custom/bin"+++async def test_env_filter_hook_runs_after_merge():+ """An extension-supplied env_filter_hook must be applied to the final env."""+ transport = StdioTransport(+ command="python",+ args=["server.py"],+ env={"OPENAI_API_KEY": "sk-test", "AWS_SECRET_ACCESS_KEY": "should-strip"},+ )++ captured: dict[str, dict[str, str] | None] = {}++ fake_ctx = MagicMock()+ fake_ctx.__aenter__ = AsyncMock(return_value=(MagicMock(), MagicMock()))+ fake_ctx.__aexit__ = AsyncMock(return_value=None)++ def fake_stdio_client(server_params):+ captured["env"] = server_params.env+ return fake_ctx++ def drop_aws(env):+ return {k: v for k, v in env.items() if not k.startswith("AWS_")}++ original_hook = stdio_transport_module._env_filter_hook+ stdio_transport_module._env_filter_hook = drop_aws+ try:+ with (+ patch("mcp.client.stdio.stdio_client", side_effect=fake_stdio_client),+ patch(+ "mcp.client.stdio.get_default_environment",+ return_value={"PATH": "/usr/bin"},+ ),+ ):+ await transport.connect()+ finally:+ stdio_transport_module._env_filter_hook = original_hook++ env = captured["env"]+ assert "AWS_SECRET_ACCESS_KEY" not in env+ assert env.get("OPENAI_API_KEY") == "sk-test"+ assert env.get("PATH") == "/usr/bin"