π OpenHands: AI-Driven Development
fix: scope MCP and ACP env vars to the acting org member (#14528)
Hiep Ledf25dcfd0f60
diff --git a/enterprise/storage/saas_settings_store.py b/enterprise/storage/saas_settings_store.pyindex f72b528bf2..09ef76c5b3 100644--- a/enterprise/storage/saas_settings_store.py+++ b/enterprise/storage/saas_settings_store.py@@ -25,11 +25,41 @@ from storage.user_store import UserStorefrom openhands.app_server.settings.settings_models import Settingsfrom openhands.app_server.settings.settings_store import SettingsStorefrom openhands.app_server.utils.jsonpatch_compat import (+ WHOLESALE_REPLACEMENT_KEYS,deep_merge,deep_merge_with_wholesale_keys,)from openhands.app_server.utils.llm import is_openhands_model+# Agent-settings keys that are private to each org member and must never+# be written to org-level defaults or broadcast across the org. Today this+# covers ``mcp_config`` (per-user MCP server set) and ``acp_env`` (per-user+# ACP environment variables) β both are dict-of-items collections that+# represent one member's personal configuration, not org-wide defaults.+MEMBER_PRIVATE_AGENT_KEYS: frozenset[str] = WHOLESALE_REPLACEMENT_KEYS+++def _split_member_private_keys(+ agent_settings_diff: dict[str, Any],+) -> tuple[dict[str, Any], dict[str, Any]]:+ """Split an agent_settings dump into (shared, private) halves.++ The shared half is safe to write to ``org.agent_settings`` and to+ broadcast through ``update_all_members_settings_async``. The private+ half must be applied only to the acting member's row.+ """+ private = {+ key: agent_settings_diff[key]+ for key in MEMBER_PRIVATE_AGENT_KEYS+ if key in agent_settings_diff+ }+ shared = {+ key: value+ for key, value in agent_settings_diff.items()+ if key not in MEMBER_PRIVATE_AGENT_KEYS+ }+ return shared, private+@dataclassclass SaasSettingsStore(SettingsStore):@@ -139,8 +169,16 @@ class SaasSettingsStore(SettingsStore):if (normalized := c.name.lstrip('_')) in Settings.model_fields},}+ # Drop member-private keys from the org dump before merging so+ # legacy values written by older code paths (when mcp_config /+ # acp_env were broadcast at the org level) can no longer leak+ # one member's private config to another. Each member's own+ # ``agent_settings_diff`` still supplies their personal values.+ org_agent_settings_dump = org_agent_settings.model_dump(mode='json')+ for private_key in MEMBER_PRIVATE_AGENT_KEYS:+ org_agent_settings_dump.pop(private_key, None)merged_agent_settings = deep_merge(- org_agent_settings.model_dump(mode='json'),+ org_agent_settings_dump,member_agent_settings_diff,)effective_llm_api_key = self._get_effective_llm_api_key(org, org_member)@@ -244,10 +282,28 @@ class SaasSettingsStore(SettingsStore):effective_agent_settings_diff = self._get_persisted_agent_settings(item)+ # Keep mcp_config / acp_env scoped to the acting member only.+ # ``shared_agent_settings_diff`` is the slice safe for org-wide+ # state; ``private_agent_settings_diff`` is applied below to the+ # acting member's row only so other members don't inherit one+ # user's MCP servers (or ACP env vars).+ shared_agent_settings_diff, private_agent_settings_diff = (+ _split_member_private_keys(effective_agent_settings_diff)+ )++ # Strip any pre-existing private keys from the org dump before+ # merging, so legacy values written by older code paths are+ # cleaned up on the next save and stop leaking to other members.+ org_agent_settings_dump = OrgStore.get_agent_settings_from_org(+ org+ ).model_dump(mode='json')+ for private_key in MEMBER_PRIVATE_AGENT_KEYS:+ org_agent_settings_dump.pop(private_key, None)+# Single assignment so SQLAlchemy tracks the changeorg.agent_settings = deep_merge_with_wholesale_keys(- OrgStore.get_agent_settings_from_org(org).model_dump(mode='json'),- effective_agent_settings_diff,+ org_agent_settings_dump,+ shared_agent_settings_diff,)effective_conversation_diff = item.conversation_settings.model_dump(@@ -291,7 +347,7 @@ class SaasSettingsStore(SettingsStore):session,org_id,OrgMemberSettingsUpdate(- agent_settings_diff=effective_agent_settings_diff,+ agent_settings_diff=shared_agent_settings_diff,conversation_settings_diff=effective_conversation_diff,llm_api_key=(current_member_llm_api_key_raw # type: ignore[arg-type]@@ -301,6 +357,15 @@ class SaasSettingsStore(SettingsStore):),)+ # Member-private keys (mcp_config, acp_env) live only on the+ # acting member's row. Use the wholesale-replacement semantics+ # so deletes stick (APP-1862).+ if private_agent_settings_diff:+ org_member.agent_settings_diff = deep_merge_with_wholesale_keys(+ dict(org_member.agent_settings_diff),+ private_agent_settings_diff,+ )+if uses_managed_llm_key and current_member_llm_api_key is not None:# Managed/proxy key β store on this member but mark as org-managedorg_member.llm_api_key = current_member_llm_api_key # type: ignore[assignment]diff --git a/enterprise/tests/unit/test_saas_settings_store.py b/enterprise/tests/unit/test_saas_settings_store.pyindex d1eeb621c5..da4377bd0e 100644--- a/enterprise/tests/unit/test_saas_settings_store.py+++ b/enterprise/tests/unit/test_saas_settings_store.py@@ -575,22 +575,26 @@ async def test_store_keeps_openhands_managed_keys_member_specific(@pytest.mark.asyncio-async def test_store_saves_mcp_config_in_agent_settings(+async def test_store_keeps_mcp_config_private_to_acting_member(session_maker, async_session_maker, org_with_multiple_members_fixture):- """mcp_config now flows through agent_settings / agent_settings_diff,- so it is persisted on both the org and all members."""+ """A member's MCP servers must stay scoped to that member's row.++ After Member 1 saves an mcp_config, no other org member sees those+ servers on load, and ``org.agent_settings`` carries no mcp_config so+ new joiners don't inherit them via the org defaults.+ """from sqlalchemy import selectfrom storage.org import Orgfrom storage.org_member import OrgMember+ # Arrangefixture = org_with_multiple_members_fixtureorg_id = fixture['org_id']admin_user_id = str(fixture['admin_user_id'])member1_user_id = str(fixture['member1_user_id'])member2_user_id = str(fixture['member2_user_id'])- store = SaasSettingsStore(admin_user_id)user_mcp_config = {'mcpServers': {'user1': {'url': 'https://user1-mcp-server.com', 'transport': 'sse'}@@ -610,14 +614,15 @@ async def test_store_saves_mcp_config_in_agent_settings(})+ # Act β Member 1 (admin) saves the mcp_config+ store = SaasSettingsStore(admin_user_id)with patch('storage.saas_settings_store.a_session_maker', async_session_maker):await store.store(new_settings)+ # Assert β only the acting member's row carries mcp_config; org and+ # other members do not.with session_maker() as session:org = session.execute(select(Org).where(Org.id == org_id)).scalars().first()- assert org is not None- assert org.agent_settings.get('mcp_config') == user_mcp_config-members = {str(m.user_id): mfor m in session.execute(@@ -626,18 +631,13 @@ async def test_store_saves_mcp_config_in_agent_settings(.scalars().all()}- assert (- members[admin_user_id].agent_settings_diff.get('mcp_config')- == user_mcp_config- )- assert (- members[member1_user_id].agent_settings_diff.get('mcp_config')- == user_mcp_config- )- assert (- members[member2_user_id].agent_settings_diff.get('mcp_config')- == user_mcp_config- )++ assert 'mcp_config' not in org.agent_settings+ assert (+ members[admin_user_id].agent_settings_diff.get('mcp_config') == user_mcp_config+ )+ assert 'mcp_config' not in members[member1_user_id].agent_settings_diff+ assert 'mcp_config' not in members[member2_user_id].agent_settings_diff@pytest.mark.asyncio@@ -764,6 +764,60 @@ async def test_store_and_load_mcp_config_via_agent_settings()+async def test_load_drops_legacy_org_level_mcp_config(+ session_maker, async_session_maker, org_with_multiple_members_fixture+):+ """Legacy org-level mcp_config (from before the fix) must not leak+ to members on load. Members without their own mcp_config see ``None``+ even if the org row still carries a stale value in the database.+ """+ from sqlalchemy import select+ from storage.org import Org+ from storage.user import User++ # Arrange β simulate pre-fix data: org carries an mcp_config that+ # was broadcast at the org level. member1 has no mcp_config of their+ # own.+ fixture = org_with_multiple_members_fixture+ org_id = fixture['org_id']+ member1_user_id = str(fixture['member1_user_id'])++ legacy_org_mcp_config = {+ 'mcpServers': {+ 'leaked': {'url': 'https://leaked-server.com', 'transport': 'sse'}+ },+ }+ with session_maker() as session:+ org = session.execute(select(Org).where(Org.id == org_id)).scalars().first()+ org.agent_settings = {+ 'agent_kind': 'openhands',+ 'mcp_config': legacy_org_mcp_config,+ }+ # Populate the nullable bool defaults that the Settings model+ # requires non-None when load() rebuilds the Settings object.+ user = (+ session.execute(select(User).where(User.id == fixture['member1_user_id']))+ .scalars()+ .first()+ )+ user.enable_sound_notifications = False+ session.commit()++ # Act+ store = SaasSettingsStore(member1_user_id)+ with (+ patch('storage.saas_settings_store.a_session_maker', async_session_maker),+ patch('storage.user_store.a_session_maker', async_session_maker),+ patch('storage.org_store.a_session_maker', async_session_maker),+ ):+ loaded = await store.load()++ # Assert β legacy org mcp_config is not inherited by member1+ assert loaded is not None+ assert loaded.agent_settings.mcp_config is None++@pytest.mark.asyncioasync def test_store_and_load_llm_profiles_round_trip(async_session_maker, org_with_multiple_members_fixture@@ -946,24 +1000,22 @@ async def test_llm_profiles_are_encrypted_at_rest(async def test_store_replaces_mcp_config_on_delete(session_maker, async_session_maker, org_with_multiple_members_fixture):- """When a server is deleted, mcp_config should be replaced wholesale,- not merged (which would resurrect deleted servers).+ """Deleting a server from a member's mcp_config sticks on the acting+ member's row and never touches other members' rows.- This tests the fix for APP-1862: MCP server settings cannot be updated- or deleted because deep_merge was resurrecting deleted servers.+ Combines the APP-1862 wholesale-replacement contract (deletes are not+ resurrected by deep_merge) with the per-member privacy contract."""from sqlalchemy import select- from storage.org import Orgfrom storage.org_member import OrgMember+ # Arrange β Member 1 (admin) starts with 3 MCP serversfixture = org_with_multiple_members_fixtureorg_id = fixture['org_id']admin_user_id = str(fixture['admin_user_id'])member1_user_id = str(fixture['member1_user_id'])store = SaasSettingsStore(admin_user_id)-- # Step 1: Save 3 MCP serversinitial_mcp_config = {'mcpServers': {'server1': {'url': 'https://server1.com', 'transport': 'sse'},@@ -984,22 +1036,14 @@ async def test_store_replaces_mcp_config_on_delete(},})-with patch('storage.saas_settings_store.a_session_maker', async_session_maker):await store.store(initial_settings)- # Verify 3 servers are saved- with session_maker() as session:- org = session.execute(select(Org).where(Org.id == org_id)).scalars().first()- assert org is not None- assert len(org.agent_settings.get('mcp_config', {}).get('mcpServers', {})) == 3-- # Step 2: Delete one server (save with only 2 servers)+ # Act β re-save with server3 removedupdated_mcp_config = {'mcpServers': {'server1': {'url': 'https://server1.com', 'transport': 'sse'},'server2': {'url': 'https://server2.com', 'transport': 'sse'},- # server3 is deleted},}updated_settings = DataSettings()@@ -1015,25 +1059,12 @@ async def test_store_replaces_mcp_config_on_delete(},})-with patch('storage.saas_settings_store.a_session_maker', async_session_maker):await store.store(updated_settings)- # Step 3: Verify only 2 servers remain (server3 was not resurrected)+ # Assert β server3 is gone from the acting member; other members were+ # never touched by either save.with session_maker() as session:- org = session.execute(select(Org).where(Org.id == org_id)).scalars().first()- assert org is not None- mcp_servers = org.agent_settings.get('mcp_config', {}).get('mcpServers', {})- assert (- len(mcp_servers) == 2- ), f'Expected 2 servers, got {len(mcp_servers)}: {mcp_servers}'- assert 'server1' in mcp_servers- assert 'server2' in mcp_servers- assert (- 'server3' not in mcp_servers- ), 'Deleted server was resurrected by deep_merge'-- # Also verify member diffs have 2 serversmembers = {str(m.user_id): mfor m in session.execute(@@ -1042,10 +1073,11 @@ async def test_store_replaces_mcp_config_on_delete(.scalars().all()}- admin_mcp = members[admin_user_id].agent_settings_diff.get('mcp_config', {})- assert len(admin_mcp.get('mcpServers', {})) == 2- assert 'server3' not in admin_mcp.get('mcpServers', {})- member1_mcp = members[member1_user_id].agent_settings_diff.get('mcp_config', {})- assert len(member1_mcp.get('mcpServers', {})) == 2- assert 'server3' not in member1_mcp.get('mcpServers', {})+ admin_servers = (+ members[admin_user_id]+ .agent_settings_diff.get('mcp_config', {})+ .get('mcpServers', {})+ )+ assert set(admin_servers.keys()) == {'server1', 'server2'}+ assert 'mcp_config' not in members[member1_user_id].agent_settings_diff