π OpenHands: AI-Driven Development
security: Invalidate SESSION_API_KEY on pause and require RUNNING status (#14001)
chuckbutkusf318792a17ea
diff --git a/openhands/app_server/sandbox/remote_sandbox_service.py b/openhands/app_server/sandbox/remote_sandbox_service.pyindex 45f93f3e54..5148717f42 100644--- a/openhands/app_server/sandbox/remote_sandbox_service.py+++ b/openhands/app_server/sandbox/remote_sandbox_service.py@@ -522,12 +522,18 @@ class RemoteSandboxService(SandboxService):raise SandboxError(f'Failed to start sandbox: {e}')async def resume_sandbox(self, sandbox_id: str) -> bool:- """Resume a paused sandbox."""+ """Resume a paused sandbox.++ Security: When a sandbox is resumed, the runtime-api generates a new+ session_api_key and returns it. This invalidates any previously leaked+ keys and ensures that only the new key can be used to access secrets.+ """# Enforce sandbox limits by cleaning up old sandboxesawait self.pause_old_sandboxes(self.max_num_sandboxes - 1)try:- if not await self._get_stored_sandbox(sandbox_id):+ stored_sandbox = await self._get_stored_sandbox(sandbox_id)+ if not stored_sandbox:return Falseruntime_data = await self._get_runtime(sandbox_id)response = await self._send_runtime_api_request(@@ -538,16 +544,39 @@ class RemoteSandboxService(SandboxService):if response.status_code == 404:return Falseresponse.raise_for_status()++ # Security: Update stored session_api_key with the new key returned+ # by the runtime-api. The old key was invalidated on resume.+ response_data = response.json()+ new_session_api_key = response_data.get('session_api_key')+ if new_session_api_key:+ stored_sandbox.session_api_key_hash = _hash_session_api_key(+ new_session_api_key+ )+ _logger.info(+ f'Updated session_api_key_hash for sandbox {sandbox_id} after resume'+ )+return Trueexcept httpx.HTTPError as e:_logger.error(f'Error resuming sandbox {sandbox_id}: {e}')return Falseasync def pause_sandbox(self, sandbox_id: str) -> bool:- """Pause a running sandbox."""+ """Pause a running sandbox.++ Security: Clears the session_api_key_hash to invalidate any existing+ session keys, preventing leaked keys from being used while paused.+ """try:- if not await self._get_stored_sandbox(sandbox_id):+ stored_sandbox = await self._get_stored_sandbox(sandbox_id)+ if not stored_sandbox:return False++ # Security: Invalidate the session API key hash to prevent+ # leaked keys from being used while the sandbox is paused.+ stored_sandbox.session_api_key_hash = None+runtime_data = await self._get_runtime(sandbox_id)response = await self._send_runtime_api_request('POST',@@ -564,11 +593,17 @@ class RemoteSandboxService(SandboxService):return Falseasync def delete_sandbox(self, sandbox_id: str) -> bool:- """Delete a sandbox by stopping its runtime."""+ """Delete a sandbox by stopping its runtime.++ Security: Deleting the stored_sandbox record also removes the+ session_api_key_hash, invalidating any leaked session keys.+ """try:stored_sandbox = await self._get_stored_sandbox(sandbox_id)if not stored_sandbox:return False+ # Deleting the record also removes the session_api_key_hash,+ # which invalidates any leaked session keys.await self.db_session.delete(stored_sandbox)runtime_data = await self._get_runtime(sandbox_id)response = await self._send_runtime_api_request(diff --git a/tests/unit/app_server/test_remote_sandbox_service.py b/tests/unit/app_server/test_remote_sandbox_service.pyindex a7547092ef..9bbdaac444 100644--- a/tests/unit/app_server/test_remote_sandbox_service.py+++ b/tests/unit/app_server/test_remote_sandbox_service.py@@ -526,6 +526,7 @@ class TestSandboxLifecycle:mock_response = MagicMock()mock_response.status_code = 200+ mock_response.json.return_value = {'session_api_key': 'new-session-key-123'}remote_sandbox_service.httpx_client.request.return_value = mock_response# Execute