Skip to content

Secure, Fast, and Extensible Sandbox runtime for AI agents.

fix(server): do not report image labels as sandbox metadata on Docker

Maohao7b91c00eb692
diff --git a/server/opensandbox_server/services/constants.py b/server/opensandbox_server/services/constants.py
index f0cfc3ed4..ffa29f3b2 100644
--- a/server/opensandbox_server/services/constants.py
+++ b/server/opensandbox_server/services/constants.py
@@ -25,6 +25,9 @@ SANDBOX_MANUAL_CLEANUP_LABEL = "opensandbox.io/manual-cleanup"
SANDBOX_PLATFORM_OS_LABEL = "opensandbox.io/platform-os"
SANDBOX_PLATFORM_ARCH_LABEL = "opensandbox.io/platform-arch"
SANDBOX_SNAPSHOT_ID_LABEL = "opensandbox.io/snapshot-id"
+# JSON list of the user metadata keys set at create (Docker): the container
+# also carries labels inherited from its image, which are not metadata.
+SANDBOX_METADATA_KEYS_LABEL = "opensandbox.io/metadata-keys"
# Host-mapped ports recorded on containers (bridge mode).
SANDBOX_EMBEDDING_PROXY_PORT_LABEL = (
"opensandbox.io/embedding-proxy-port" # maps container 44772 -> host port
diff --git a/server/opensandbox_server/services/docker/container_ops.py b/server/opensandbox_server/services/docker/container_ops.py
index d08c3be36..b41a38048 100644
--- a/server/opensandbox_server/services/docker/container_ops.py
+++ b/server/opensandbox_server/services/docker/container_ops.py
@@ -21,6 +21,7 @@ Mixed into DockerSandboxService.
from __future__ import annotations
+import json
import logging
from datetime import datetime
from typing import Any, Dict, Optional
@@ -41,6 +42,7 @@ from opensandbox_server.api.schema import (
from opensandbox_server.services.constants import (
SANDBOX_EXPIRES_AT_LABEL,
SANDBOX_ID_LABEL,
+ SANDBOX_METADATA_KEYS_LABEL,
SANDBOX_MANUAL_CLEANUP_LABEL,
SANDBOX_PLATFORM_ARCH_LABEL,
SANDBOX_PLATFORM_OS_LABEL,
@@ -288,6 +290,7 @@ class DockerContainerOpsMixin:
) -> tuple[dict[str, str], list[str]]:
metadata = request.metadata or {}
labels = {key: str(value) for key, value in metadata.items()}
+ labels[SANDBOX_METADATA_KEYS_LABEL] = json.dumps(sorted(metadata))
labels[SANDBOX_ID_LABEL] = sandbox_id
if expires_at is None:
labels[SANDBOX_MANUAL_CLEANUP_LABEL] = "true"
diff --git a/server/opensandbox_server/services/docker/metadata.py b/server/opensandbox_server/services/docker/metadata.py
index 03a6112ab..cfb42219c 100644
--- a/server/opensandbox_server/services/docker/metadata.py
+++ b/server/opensandbox_server/services/docker/metadata.py
@@ -31,6 +31,8 @@ from datetime import datetime
from pathlib import Path
from uuid import uuid4
+from opensandbox_server.services.constants import SANDBOX_METADATA_KEYS_LABEL
+
logger = logging.getLogger(__name__)
_NON_USER_LABEL_PREFIXES = (
@@ -48,6 +50,18 @@ def _is_user_label(key: str) -> bool:
def _extract_user_labels(labels: dict) -> dict:
+ """User metadata stored in container labels.
+
+ Image labels are merged into container labels, so only the keys recorded
+ at create are metadata. Containers created before that label existed fall
+ back to every label without a system prefix.
+ """
+ try:
+ keys = json.loads(labels[SANDBOX_METADATA_KEYS_LABEL])
+ except (KeyError, TypeError, ValueError):
+ keys = None
+ if isinstance(keys, list):
+ return {k: labels[k] for k in keys if isinstance(k, str) and k in labels}
return {k: v for k, v in labels.items() if _is_user_label(k)}
diff --git a/server/tests/test_docker_metadata_store.py b/server/tests/test_docker_metadata_store.py
index b98b9f4e1..9f1ecf739 100644
--- a/server/tests/test_docker_metadata_store.py
+++ b/server/tests/test_docker_metadata_store.py
@@ -60,6 +60,22 @@ class TestExtractUserLabels:
def test_empty_returns_empty(self):
assert _extract_user_labels({}) == {}
+ def test_keeps_only_recorded_metadata_keys(self):
+ labels = {
+ "team": "infra",
+ "maintainer": "from the image",
+ "opensandbox.io/metadata-keys": '["team"]',
+ }
+ assert _extract_user_labels(labels) == {"team": "infra"}
+
+ def test_recorded_empty_metadata(self):
+ labels = {"maintainer": "from the image", "opensandbox.io/metadata-keys": "[]"}
+ assert _extract_user_labels(labels) == {}
+
+ def test_malformed_metadata_keys_fall_back_to_user_labels(self):
+ labels = {"team": "infra", "opensandbox.io/metadata-keys": "not json"}
+ assert _extract_user_labels(labels) == {"team": "infra"}
+
class TestDockerMetadataStore:
diff --git a/server/tests/test_docker_service.py b/server/tests/test_docker_service.py
index 92a97affd..70eea2218 100644
--- a/server/tests/test_docker_service.py
+++ b/server/tests/test_docker_service.py
@@ -2468,6 +2468,25 @@ def test_build_labels_marks_manual_cleanup_without_expiration():
assert "opensandbox.io/expires-at" not in labels
+def test_metadata_excludes_labels_inherited_from_the_image(tmp_path):
+ """Docker merges image labels (e.g. nginx's ``maintainer``) into the
+ container's labels; only the keys the request set are metadata."""
+ service = DockerSandboxService(config=_app_config())
+ request = CreateSandboxRequest(
+ image=ImageSpec(uri="nginx:latest"),
+ resourceLimits=ResourceLimits(root={}),
+ env={},
+ metadata={"team": "infra"},
+ entrypoint=["nginx"],
+ )
+
+ labels, _ = service._build_labels_and_env("sandbox-meta", request, None)
+ container_labels = {"maintainer": "NGINX Docker Maintainers", **labels}
+
+ store = DockerMetadataStore(root=tmp_path / "metadata")
+ assert store.get("sandbox-meta", container_labels) == {"team": "infra"}
+
+
def test_build_env_omits_execd_run_as_init_by_default():
service = DockerSandboxService(config=_app_config())
request = CreateSandboxRequest(