Secure, Fast, and Extensible Sandbox runtime for AI agents.
fix(server): do not inherit system labels from snapshot images on Docker
Maohao5df55fdd887a
diff --git a/server/opensandbox_server/extensions/codec.py b/server/opensandbox_server/extensions/codec.pyindex 06b7ee193..fba0a8c8f 100644--- a/server/opensandbox_server/extensions/codec.py+++ b/server/opensandbox_server/extensions/codec.py@@ -100,7 +100,9 @@ def extract_extensions_from_mapping(Restore extension keys previously propagated to Pod annotations.For each annotation key starting with ANNOTATION_METADATA_PREFIX, the value is- copied to extensions with EXTENSIONS_ANNOTATION_PREFIX prefix.+ copied to extensions with EXTENSIONS_ANNOTATION_PREFIX prefix. Empty values are+ treated as unset: Docker labels cannot be removed, so an extension inherited+ from a snapshot image is blanked instead."""if not annotations:return None@@ -108,6 +110,6 @@ def extract_extensions_from_mapping(extensions = {EXTENSIONS_ANNOTATION_PREFIX + key[len(ANNOTATION_METADATA_PREFIX):]: valuefor key, value in annotations.items()- if key.startswith(ANNOTATION_METADATA_PREFIX)+ if key.startswith(ANNOTATION_METADATA_PREFIX) and value}return extensions or Nonediff --git a/server/opensandbox_server/services/docker/container_ops.py b/server/opensandbox_server/services/docker/container_ops.pyindex d08c3be36..cf6ef021a 100644--- a/server/opensandbox_server/services/docker/container_ops.py+++ b/server/opensandbox_server/services/docker/container_ops.py@@ -39,6 +39,7 @@ from opensandbox_server.api.schema import (PlatformSpec,)from opensandbox_server.services.constants import (+ RESERVED_LABEL_PREFIX,SANDBOX_EXPIRES_AT_LABEL,SANDBOX_ID_LABEL,SANDBOX_MANUAL_CLEANUP_LABEL,@@ -315,6 +316,29 @@ class DockerContainerOpsMixin:environment.append(f"OPENSANDBOX_ID={sandbox_id}")return labels, environment+ def _mask_inherited_system_labels(+ self,+ image_uri: str,+ labels: dict[str, str],+ sandbox_id: str,+ ) -> dict[str, str]:+ """Blank reserved labels the image would pass on to the container.++ Docker merges image labels into container labels, and a snapshot image+ keeps every label of the sandbox it was committed from (expiration,+ host ports, managed volumes, egress token, ...). Labels can be+ overridden but not removed, so set the ones this sandbox does not+ define itself to an empty value.+ """+ with self._docker_operation(f"inspect image {image_uri} labels", sandbox_id):+ image = self.docker_client.images.get(image_uri)+ image_labels = ((image.attrs or {}).get("Config") or {}).get("Labels") or {}+ masked = dict(labels)+ for key in image_labels:+ if key.startswith(RESERVED_LABEL_PREFIX) and key not in masked:+ masked[key] = ""+ return masked+def _resolve_image_auth(self, request: CreateSandboxRequest, sandbox_id: str) -> tuple[str, Optional[dict]]:@@ -439,6 +463,7 @@ class DockerContainerOpsMixin:container = Nonecontainer_id: Optional[str] = Nonetry:+ labels = self._mask_inherited_system_labels(image_uri, labels, sandbox_id)with self._docker_operation("create sandbox container", sandbox_id):container_kwargs = {"image": image_uri,diff --git a/server/opensandbox_server/services/docker/docker_service.py b/server/opensandbox_server/services/docker/docker_service.pyindex 96bb37f87..2c0b0f2fc 100644--- a/server/opensandbox_server/services/docker/docker_service.py+++ b/server/opensandbox_server/services/docker/docker_service.py@@ -537,7 +537,7 @@ class DockerSandboxService(DockerDiagnosticsMixin, DockerRuntimeMixin, DockerVolentrypoint = [entrypoint]image_tags = container.image.tagsimage_uri = image_tags[0] if image_tags else container.image.short_id- snapshot_id = labels.get(SANDBOX_SNAPSHOT_ID_LABEL)+ snapshot_id = labels.get(SANDBOX_SNAPSHOT_ID_LABEL) or Noneimage_spec = None if snapshot_id else ImageSpec(uri=image_uri)created_at = parse_timestamp(container.attrs.get("Created"))diff --git a/server/tests/test_docker_service.py b/server/tests/test_docker_service.pyindex 92a97affd..69e8f5bf4 100644--- a/server/tests/test_docker_service.py+++ b/server/tests/test_docker_service.py@@ -2856,6 +2856,154 @@ def test_create_and_start_container_windows_profile_keeps_image_entrypoint(mock_mock_install.assert_called_once()+@patch("opensandbox_server.services.docker.docker_service.docker")+def test_create_and_start_container_blanks_system_labels_inherited_from_image(mock_docker):+ mock_client = MagicMock()+ mock_client.containers.list.return_value = []+ mock_docker.from_env.return_value = mock_client+ mock_client.api.create_host_config.return_value = {}+ mock_client.api.create_container.return_value = {"Id": "cid"}+ # A snapshot image keeps every label of the sandbox it was committed from.+ mock_client.images.get.return_value.attrs = {+ "Config": {+ "Labels": {+ SANDBOX_ID_LABEL: "source-sandbox",+ SANDBOX_EXPIRES_AT_LABEL: "2026-01-01T00:00:00+00:00",+ SANDBOX_HTTP_PORT_LABEL: "48891",+ SANDBOX_MANAGED_VOLUMES_LABEL: '["source-volume"]',+ SANDBOX_EGRESS_AUTH_TOKEN_METADATA_KEY: "source-token",+ "opensandbox.io/extensions.custom": "source-value",+ "maintainer": "image-author",+ }+ }+ }+ created_container = MagicMock()+ created_container.image.attrs = {"Os": "linux", "Architecture": "amd64"}+ mock_client.containers.get.return_value = created_container++ service = DockerSandboxService(config=_app_config())+ labels = {+ SANDBOX_ID_LABEL: "restored-sandbox",+ SANDBOX_MANUAL_CLEANUP_LABEL: "true",+ }+ with patch.object(service, "_prepare_sandbox_runtime"):+ service._create_and_start_container(+ sandbox_id="restored-sandbox",+ image_uri="opensandbox-snapshots:snap-1",+ bootstrap_command=["sleep", "infinity"],+ labels=labels,+ environment=[],+ host_config_kwargs={},+ exposed_ports=None,+ platform=None,+ )++ mock_client.images.get.assert_called_once_with("opensandbox-snapshots:snap-1")+ assert mock_client.api.create_container.call_args.kwargs["labels"] == {+ SANDBOX_ID_LABEL: "restored-sandbox",+ SANDBOX_MANUAL_CLEANUP_LABEL: "true",+ SANDBOX_EXPIRES_AT_LABEL: "",+ SANDBOX_HTTP_PORT_LABEL: "",+ SANDBOX_MANAGED_VOLUMES_LABEL: "",+ SANDBOX_EGRESS_AUTH_TOKEN_METADATA_KEY: "",+ "opensandbox.io/extensions.custom": "",+ }+ assert labels == {+ SANDBOX_ID_LABEL: "restored-sandbox",+ SANDBOX_MANUAL_CLEANUP_LABEL: "true",+ }+++@patch("opensandbox_server.services.docker.docker_service.docker")+def test_create_and_start_container_maps_image_label_inspect_failure(mock_docker):+ mock_client = MagicMock()+ mock_client.containers.list.return_value = []+ mock_docker.from_env.return_value = mock_client+ mock_client.api.create_host_config.return_value = {}+ mock_client.images.get.side_effect = DockerException("daemon unavailable")++ service = DockerSandboxService(config=_app_config())+ with pytest.raises(HTTPException) as exc_info:+ service._create_and_start_container(+ sandbox_id="sandbox-1",+ image_uri="opensandbox-snapshots:snap-1",+ bootstrap_command=["sleep", "infinity"],+ labels={SANDBOX_ID_LABEL: "sandbox-1"},+ environment=[],+ host_config_kwargs={},+ exposed_ports=None,+ platform=None,+ )++ assert exc_info.value.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR+ assert exc_info.value.detail["code"] == SandboxErrorCodes.CONTAINER_START_FAILED+ mock_client.api.create_container.assert_not_called()+++def test_restore_existing_sandboxes_keeps_manual_cleanup_sandbox_with_blanked_expiration():+ service = DockerSandboxService(config=_app_config())+ container = MagicMock()+ container.attrs = {+ "Config": {+ "Labels": {+ SANDBOX_ID_LABEL: "restored-sandbox",+ SANDBOX_MANUAL_CLEANUP_LABEL: "true",+ SANDBOX_EXPIRES_AT_LABEL: "",+ }+ }+ }++ with (+ patch.object(service.docker_client.containers, "list", return_value=[container]),+ patch.object(service._metadata_store, "get_expiration", return_value=None),+ patch.object(service, "_expire_sandbox") as mock_expire,+ patch.object(service, "_schedule_expiration") as mock_schedule,+ ):+ service._restore_existing_sandboxes()++ mock_expire.assert_not_called()+ mock_schedule.assert_not_called()+++@patch("opensandbox_server.services.docker.docker_service.docker")+def test_container_to_sandbox_ignores_blanked_system_labels(mock_docker):+ mock_client = MagicMock()+ mock_client.containers.list.return_value = []+ mock_docker.from_env.return_value = mock_client++ service = DockerSandboxService(config=_app_config())+ container = MagicMock()+ container.attrs = {+ "Config": {+ "Labels": {+ SANDBOX_ID_LABEL: "sandbox-1",+ SANDBOX_MANUAL_CLEANUP_LABEL: "true",+ SANDBOX_EXPIRES_AT_LABEL: "",+ SANDBOX_SNAPSHOT_ID_LABEL: "",+ "opensandbox.io/extensions.custom": "",+ },+ "Cmd": ["python"],+ },+ "Created": "2025-01-01T00:00:00Z",+ "State": {+ "Status": "running",+ "Running": True,+ "FinishedAt": "0001-01-01T00:00:00Z",+ "ExitCode": 0,+ },+ }+ container.image = MagicMock(tags=["python:3.11"], short_id="sha-img")++ with patch.object(service._metadata_store, "get_expiration", return_value=None):+ sandbox = service._container_to_sandbox(container)++ assert sandbox.expires_at is None+ assert sandbox.snapshot_id is None+ assert sandbox.image is not None+ assert sandbox.image.uri == "python:3.11"+ assert sandbox.extensions is None++@patch("opensandbox_server.services.docker.docker_service.docker")def test_create_and_start_container_windows_profile_skips_linux_runtime_injection(mock_docker):mock_client = MagicMock()diff --git a/server/tests/test_extensions.py b/server/tests/test_extensions.pyindex 036372763..ccca80712 100644--- a/server/tests/test_extensions.py+++ b/server/tests/test_extensions.py@@ -242,6 +242,17 @@ class TestExtensionsFromAnnotations:assert extract_extensions_from_mapping(annotations) is None+ def test_skips_empty_values(self):+ annotations = {+ "opensandbox.io/extensions.blanked": "",+ "opensandbox.io/extensions.custom-key": "custom-value",+ }++ assert extract_extensions_from_mapping(annotations) == {+ "opensandbox.extensions.custom-key": "custom-value",+ }+ assert extract_extensions_from_mapping({"opensandbox.io/extensions.blanked": ""}) is None+def test_empty_annotations_return_none(self):assert extract_extensions_from_mapping({}) is Noneassert extract_extensions_from_mapping(None) is None