diff --git a/cmd/workspace/up/up_validate.go b/cmd/workspace/up/up_validate.go index 441ac9c51..4f84455be 100644 --- a/cmd/workspace/up/up_validate.go +++ b/cmd/workspace/up/up_validate.go @@ -38,6 +38,9 @@ func (cmd *UpCmd) validate() error { if err := validatePodmanFlags(cmd); err != nil { return err } + if err := config.ValidateUserLabels(cmd.IDLabels); err != nil { + return err + } if err := config2.ValidateIDLabels(cmd.IDLabels); err != nil { return err } diff --git a/pkg/config/reserved_labels.go b/pkg/config/reserved_labels.go new file mode 100644 index 000000000..b266b4775 --- /dev/null +++ b/pkg/config/reserved_labels.go @@ -0,0 +1,50 @@ +package config + +import ( + "fmt" + "strings" +) + +const ( + OverlayStructureLabel = "devsy.overlay.structure" + ComposeContractLabel = "devsy.compose.contract" + ComposeInvocationLabel = "devsy.compose.invocation" + WSLgSnapshotLabel = "devsy.wslg.snapshot" + CreationConfigLabel = "devsy.sh/metadata-creation-config" + MicrosandboxUserLabel = "devsy.sh/user" + MicrosandboxMountLabel = "devsy.sh/microsandbox-workspace-mount" + MicrosandboxWorkspaceUserLabel = "devsy.sh/microsandbox-workspace-user" +) + +var reservedLabels = map[string]struct{}{ + DockerUserLabel: {}, + DockerRecoveryLabel: {}, + OverlayStructureLabel: {}, + ComposeContractLabel: {}, + ComposeInvocationLabel: {}, + WSLgSnapshotLabel: {}, + CreationConfigLabel: {}, + MicrosandboxUserLabel: {}, + MicrosandboxMountLabel: {}, + MicrosandboxWorkspaceUserLabel: {}, + DockerManagedLabel: {}, + DockerWorkspaceIDLabel: {}, + DockerResourceLabel: {}, + DockerVolumeRoleLabel: {}, + DockerSeededLabel: {}, + K8sCreatedLabel: {}, + K8sWorkspaceUIDLabel: {}, + K8sManagedLabel: {}, + K8sResourceLabel: {}, + K8sVolumeRoleLabel: {}, +} + +func ValidateUserLabels(labels []string) error { + for _, label := range labels { + key, _, _ := strings.Cut(label, "=") + if _, reserved := reservedLabels[key]; reserved { + return fmt.Errorf("label %q is reserved by Devsy; remove the user-supplied label", key) + } + } + return nil +} diff --git a/pkg/config/reserved_labels_test.go b/pkg/config/reserved_labels_test.go new file mode 100644 index 000000000..83888c6e1 --- /dev/null +++ b/pkg/config/reserved_labels_test.go @@ -0,0 +1,62 @@ +package config + +import ( + "testing" + + "github.com/stretchr/testify/suite" +) + +type ReservedLabelsSuite struct{ suite.Suite } + +func TestReservedLabelsSuite(t *testing.T) { suite.Run(t, new(ReservedLabelsSuite)) } + +func (s *ReservedLabelsSuite) TestRejectsEveryReservedKeyWithoutDisclosingValues() { + keys := []string{ + "devsy.user", + "sh.devsy.recovery", + "devsy.overlay.structure", + "devsy.compose.contract", + "devsy.compose.invocation", + "devsy.wslg.snapshot", + "devsy.sh/metadata-creation-config", + "devsy.sh/user", + "devsy.sh/microsandbox-workspace-mount", + "devsy.sh/microsandbox-workspace-user", + "sh.devsy.managed", + "sh.devsy.workspace-id", + "sh.devsy.resource", + "sh.devsy.volume-role", + "sh.devsy.seeded", + "devsy.sh/created", + "devsy.sh/workspace-uid", + "devsy.sh/managed", + "devsy.sh/resource", + "devsy.sh/volume-role", + } + s.Len(reservedLabels, len(keys)) + for _, key := range keys { + s.Run(key, func() { + for _, value := range []string{"", "root", "fixture-private-value=with=equals"} { + err := ValidateUserLabels([]string{key + "=" + value}) + s.Require().ErrorContains(err, key) + s.Contains(err.Error(), "reserved by Devsy") + if value != "" { + s.NotContains(err.Error(), value) + } + } + }) + } +} + +func (s *ReservedLabelsSuite) TestPreservesOrdinaryLabelsAndSupportedMetadata() { + labels := []string{ + "custom=value=with=equals", + "dev.containers.id=custom-id", + "devcontainer.metadata=[]", + "devsy.user.extra=ordinary", + } + original := append([]string(nil), labels...) + s.NoError(ValidateUserLabels(labels)) + s.Equal(original, labels) + s.NoError(ValidateUserLabels(nil)) +} diff --git a/pkg/devcontainer/compose_metadata.go b/pkg/devcontainer/compose_metadata.go index 22278d7a1..8e5b1fd8b 100644 --- a/pkg/devcontainer/compose_metadata.go +++ b/pkg/devcontainer/compose_metadata.go @@ -13,7 +13,7 @@ import ( ) const ( - composeContractLabel = "devsy.compose.contract" + composeContractLabel = pkgconfig.ComposeContractLabel composeRecreateGuidance = "rerun workspace up with the original configuration and --recreate" ) diff --git a/pkg/devcontainer/config_overlay_lifecycle.go b/pkg/devcontainer/config_overlay_lifecycle.go index 35868209f..ee0b7c6ae 100644 --- a/pkg/devcontainer/config_overlay_lifecycle.go +++ b/pkg/devcontainer/config_overlay_lifecycle.go @@ -20,8 +20,8 @@ import ( ) const ( - overlayStructureLabel = "devsy.overlay.structure" - composeInvocationLabel = "devsy.compose.invocation" + overlayStructureLabel = pkgconfig.OverlayStructureLabel + composeInvocationLabel = pkgconfig.ComposeInvocationLabel ) func structuralSignature(c *config.DevContainerConfig) string { diff --git a/pkg/devcontainer/metadata/metadata.go b/pkg/devcontainer/metadata/metadata.go index 3f373a72d..156388336 100644 --- a/pkg/devcontainer/metadata/metadata.go +++ b/pkg/devcontainer/metadata/metadata.go @@ -12,7 +12,7 @@ import ( const ImageMetadataLabel = pkgconfig.DevcontainerMetadataLabel // CreationConfigLabel identifies a metadata chain ending with the creation-time workspace config. -const CreationConfigLabel = "devsy.sh/metadata-creation-config" +const CreationConfigLabel = pkgconfig.CreationConfigLabel const metadataLabelSizeWarningThreshold = 100 * 1024 diff --git a/pkg/devcontainer/reserved_labels_test.go b/pkg/devcontainer/reserved_labels_test.go new file mode 100644 index 000000000..97273d0ba --- /dev/null +++ b/pkg/devcontainer/reserved_labels_test.go @@ -0,0 +1,22 @@ +package devcontainer + +import ( + "testing" + "time" + + "github.com/devsy-org/devsy/pkg/provider" + "github.com/stretchr/testify/suite" +) + +type ReservedIdentitySuite struct{ suite.Suite } + +func TestReservedIdentitySuite(t *testing.T) { suite.Run(t, new(ReservedIdentitySuite)) } + +func (s *ReservedIdentitySuite) TestPersistedLabelsRejectedBeforeDriverAccess() { + r := &runner{workspaceConfig: &provider.AgentWorkspaceInfo{}} + r.workspaceConfig.CLIOptions.IDLabels = []string{"devsy.user=fixture-private-value"} + result, err := r.Up(s.T().Context(), UpOptions{}, time.Second, nil) + s.ErrorContains(err, "devsy.user") + s.NotContains(err.Error(), "fixture-private-value") + s.Nil(result) +} diff --git a/pkg/devcontainer/run.go b/pkg/devcontainer/run.go index c4a7026d0..afa994263 100644 --- a/pkg/devcontainer/run.go +++ b/pkg/devcontainer/run.go @@ -9,6 +9,7 @@ import ( "github.com/devsy-org/devsy/pkg/agent/tunnel" "github.com/devsy-org/devsy/pkg/clierr" + pkgconfig "github.com/devsy-org/devsy/pkg/config" "github.com/devsy-org/devsy/pkg/devcontainer/config" "github.com/devsy-org/devsy/pkg/driver" "github.com/devsy-org/devsy/pkg/driver/drivercreate" @@ -158,6 +159,9 @@ func (r *runner) Up( timeout time.Duration, reporter status.Reporter, ) (*config.Result, error) { + if err := pkgconfig.ValidateUserLabels(r.workspaceConfig.CLIOptions.IDLabels); err != nil { + return nil, err + } if r.workspaceConfig.CLIOptions.LifecycleTerminal != nil && options.LifecycleTerminalClient == nil { return nil, fmt.Errorf("lifecycle terminal request requires a lifecycle terminal client") diff --git a/pkg/devcontainer/wslg.go b/pkg/devcontainer/wslg.go index e480e7b38..0f4b5b4fc 100644 --- a/pkg/devcontainer/wslg.go +++ b/pkg/devcontainer/wslg.go @@ -18,7 +18,7 @@ import ( "github.com/devsy-org/devsy/pkg/wslg" ) -const wslgSnapshotLabel = "devsy.wslg.snapshot" +const wslgSnapshotLabel = pkgconfig.WSLgSnapshotLabel // The local context is the authority. Neither agent workspace JSON nor a // downloaded provider can opt in, and cleanup never calls this method. diff --git a/pkg/driver/external/reserved_labels_test.go b/pkg/driver/external/reserved_labels_test.go new file mode 100644 index 000000000..89ddcda8e --- /dev/null +++ b/pkg/driver/external/reserved_labels_test.go @@ -0,0 +1,107 @@ +package external + +import ( + "context" + "encoding/json" + "time" + + pkgconfig "github.com/devsy-org/devsy/pkg/config" + "github.com/devsy-org/devsy/pkg/devcontainer/config" + "github.com/devsy-org/devsy/pkg/driver" +) + +func (s *HostSuite) TestReservedIdentityLabelsNeverReachRuntimeProcess() { + host := s.host("normal") + params := &driver.RunImageDevContainerParams{ + WorkspaceID: fixtureWorkspace, + Options: &driver.RunOptions{Image: fixtureImage}, + } + for _, key := range []string{ + "devsy.user", "sh.devsy.recovery", "devsy.overlay.structure", "devsy.sh/metadata-creation-config", + "devsy.compose.contract", "devsy.compose.invocation", "devsy.wslg.snapshot", + "devsy.sh/user", "devsy.sh/microsandbox-workspace-mount", "devsy.sh/microsandbox-workspace-user", + "sh.devsy.managed", "sh.devsy.workspace-id", "sh.devsy.resource", "sh.devsy.volume-role", "sh.devsy.seeded", + "devsy.sh/created", "devsy.sh/workspace-uid", "devsy.sh/managed", "devsy.sh/resource", "devsy.sh/volume-role", + } { + s.Run(key, func() { + host.idLabels = []string{key + "=fixture-private-value"} + s.ErrorContains(host.ValidateRunImageDevContainer(params), key) + s.ErrorContains(host.RunImageDevContainer(s.T().Context(), params), key) + found, err := host.FindDevContainer(s.T().Context(), fixtureWorkspace) + s.Require().NoError(err) + s.Nil(found) + }) + } +} + +func (s *HostSuite) TestGeneratedAndOrdinaryLabelsThroughRuntimeProcess() { + host := s.host("normal") + host.idLabels = []string{"custom.label=ordinary=value", "dev.containers.id=custom-id"} + generated := []string{ + pkgconfig.DockerUserLabel + "=root", + pkgconfig.DockerRecoveryLabel + "=true", + pkgconfig.OverlayStructureLabel + "=v1:fingerprint", + pkgconfig.CreationConfigLabel + "=true", + pkgconfig.DevcontainerMetadataLabel + `=[{"remoteEnv":{"TOKEN":"private"}}]`, + } + params := &driver.RunImageDevContainerParams{ + WorkspaceID: fixtureWorkspace, + Options: &driver.RunOptions{Image: fixtureImage, Labels: generated}, + } + ctx, cancel := context.WithTimeout(s.T().Context(), 30*time.Second) + defer cancel() + s.Require().NoError(host.ValidateRunImageDevContainer(params)) + s.Require().NoError(host.RunImageDevContainer(ctx, params)) + found, err := host.FindDevContainer(ctx, fixtureWorkspace) + s.Require().NoError(err) + s.Require().NotNil(found) + want := config.ListToObject(append(append([]string(nil), generated...), host.idLabels...)) + want["fake.remote-user"] = fixtureProcessUser + s.Equal(want, found.Config.Labels) + s.Equal(generated, params.Options.Labels) +} + +func (s *HostSuite) TestDevcontainerLabelInputsCannotBecomeRequestLabels() { + host := s.host("normal") + for _, raw := range []string{ + `{"image":"fixture","containerLabels":{"devsy.user":"private"}}`, + `{"image":"fixture","labels":{"devsy.user":"private"}}`, + } { + parsed := &config.DevContainerConfig{} + s.Require().NoError(json.Unmarshal([]byte(raw), parsed)) + params := &driver.RunImageDevContainerParams{ + WorkspaceID: fixtureWorkspace, + ParsedConfig: parsed, + Options: &driver.RunOptions{ + Image: parsed.Image, + Labels: []string{"devsy.user=root"}, + }, + } + s.Require().NoError(host.RunImageDevContainer(s.T().Context(), params)) + found, err := host.FindDevContainer(s.T().Context(), fixtureWorkspace) + s.Require().NoError(err) + s.Require().NotNil(found) + s.Equal(fixtureProcessUser, found.Config.Labels["devsy.user"]) + s.Equal( + map[string]string{ + "devsy.user": fixtureProcessUser, + "dev.containers.id": fixtureWorkspace, + "fake.remote-user": fixtureProcessUser, + }, + found.Config.Labels, + ) + s.Require().NoError(host.DeleteDevContainer(s.T().Context(), fixtureWorkspace)) + } + parsed := &config.DevContainerConfig{} + s.Require(). + NoError(json.Unmarshal([]byte(`{"image":"fixture","runArgs":["--label","devsy.user=private"]}`), parsed)) + params := &driver.RunImageDevContainerParams{ + WorkspaceID: fixtureWorkspace, + ParsedConfig: parsed, + Options: &driver.RunOptions{Image: parsed.Image}, + } + s.ErrorContains(host.RunImageDevContainer(s.T().Context(), params), "cannot express runArgs") + found, err := host.FindDevContainer(s.T().Context(), fixtureWorkspace) + s.Require().NoError(err) + s.Nil(found) +} diff --git a/pkg/driver/external/run_image.go b/pkg/driver/external/run_image.go index 9d2539a31..2c406a4fb 100644 --- a/pkg/driver/external/run_image.go +++ b/pkg/driver/external/run_image.go @@ -11,12 +11,13 @@ import ( "strings" "github.com/devsy-org/devsy-runtime-sdk/runtimev1" + pkgconfig "github.com/devsy-org/devsy/pkg/config" "github.com/devsy-org/devsy/pkg/devcontainer/config" "github.com/devsy-org/devsy/pkg/driver" ) func (h *Host) ValidateRunImageDevContainer(params *driver.RunImageDevContainerParams) error { - request, err := runImageRequest(params) + request, err := h.runImageRequest(params) if err != nil { return err } @@ -27,11 +28,10 @@ func (h *Host) RunImageDevContainer( ctx context.Context, params *driver.RunImageDevContainerParams, ) error { - request, err := runImageRequest(params) + request, err := h.runImageRequest(params) if err != nil { return err } - request.Labels = append(request.Labels, config.GetIDLabels(params.WorkspaceID, h.idLabels)...) if err := h.validateRunImage(request); err != nil { return err } @@ -41,6 +41,20 @@ func (h *Host) RunImageDevContainer( return h.RunImage(ctx, request) } +func (h *Host) runImageRequest( + params *driver.RunImageDevContainerParams, +) (*runtimev1.RunImageRequest, error) { + if err := pkgconfig.ValidateUserLabels(h.idLabels); err != nil { + return nil, err + } + request, err := runImageRequest(params) + if err != nil { + return nil, err + } + request.Labels = append(request.Labels, config.GetIDLabels(params.WorkspaceID, h.idLabels)...) + return request, nil +} + func runImageRequest( params *driver.RunImageDevContainerParams, ) (*runtimev1.RunImageRequest, error) { diff --git a/pkg/driver/kubernetes/reserved_labels_test.go b/pkg/driver/kubernetes/reserved_labels_test.go new file mode 100644 index 000000000..3cd90b013 --- /dev/null +++ b/pkg/driver/kubernetes/reserved_labels_test.go @@ -0,0 +1,51 @@ +package kubernetes + +import ( + "testing" + + pkgconfig "github.com/devsy-org/devsy/pkg/config" + "github.com/devsy-org/devsy/pkg/driver" + "github.com/devsy-org/devsy/pkg/provider" + "github.com/stretchr/testify/suite" + corev1 "k8s.io/api/core/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +type ReservedLabelsSuite struct{ suite.Suite } + +func TestReservedLabelsSuite(t *testing.T) { suite.Run(t, new(ReservedLabelsSuite)) } + +func (s *ReservedLabelsSuite) TestTemplateAndProviderLabelsRejectedBeforeProvisioning() { + for _, key := range []string{pkgconfig.K8sCreatedLabel, pkgconfig.K8sWorkspaceUIDLabel, pkgconfig.DockerUserLabel} { + s.Run(key, func() { + _, err := getLabels( + &corev1.Pod{ + ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{key: "private"}}, + }, + "", + ) + s.ErrorContains(err, key) + _, err = getLabels(&corev1.Pod{}, key+"=private") + s.ErrorContains(err, key) + k := &KubernetesDriver{options: &provider.ProviderKubernetesDriverConfig{}} + k.options.Labels = key + "=private" + s.ErrorContains(k.preflightTemplate(&driver.RunOptions{}), key) + }) + } +} + +func (s *ReservedLabelsSuite) TestOrdinaryAndGeneratedLabelsPreserved() { + labels, err := getLabels( + &corev1.Pod{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"custom": "template"}}}, + "other=provider", + ) + s.Require().NoError(err) + s.Equal( + map[string]string{ + "custom": "template", + "other": "provider", + pkgconfig.K8sCreatedLabel: "true", + }, + labels, + ) +} diff --git a/pkg/driver/kubernetes/run.go b/pkg/driver/kubernetes/run.go index 068fefcea..406c6a577 100644 --- a/pkg/driver/kubernetes/run.go +++ b/pkg/driver/kubernetes/run.go @@ -79,6 +79,9 @@ func (k *KubernetesDriver) preflightTemplate(options *driver.RunOptions) error { if err != nil { return err } + if _, err := getLabels(pod, k.options.Labels); err != nil { + return err + } timeout, err := lifecycleTimeout(options) if err != nil { return fmt.Errorf("read lifecycle policy: %w", err) @@ -720,6 +723,9 @@ func getLabels(pod *corev1.Pod, rawLabels string) (map[string]string, error) { } maps.Copy(labels, extraLabels) } + if err := pkgconfig.ValidateUserLabels(config.ObjectToList(labels)); err != nil { + return nil, err + } // make sure we don't overwrite the devsy labels maps.Copy(labels, ExtraDevsyLabels) diff --git a/pkg/driver/microsandbox/microsandbox.go b/pkg/driver/microsandbox/microsandbox.go index 0087579ac..32524130d 100644 --- a/pkg/driver/microsandbox/microsandbox.go +++ b/pkg/driver/microsandbox/microsandbox.go @@ -24,7 +24,7 @@ import ( v1 "github.com/google/go-containerregistry/pkg/v1" ) -const userLabel = "devsy.sh/user" +const userLabel = pkgconfig.MicrosandboxUserLabel const createdAtLayout = "2006-01-02T15:04:05Z07:00" @@ -515,8 +515,8 @@ func (d *microsandboxDriver) RequiresMountStreaming() bool { return false } func (d *microsandboxDriver) RecreateMode() driver.RecreateMode { return driver.RecreateOnRun } const ( - workspaceMountContractLabel = "devsy.sh/microsandbox-workspace-mount" - workspaceRemoteUserLabel = "devsy.sh/microsandbox-workspace-user" + workspaceMountContractLabel = pkgconfig.MicrosandboxMountLabel + workspaceRemoteUserLabel = pkgconfig.MicrosandboxWorkspaceUserLabel ) func (d *microsandboxDriver) RequiresRecreate( diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx index 608e2bc5b..01303c9cd 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx @@ -137,3 +137,34 @@ With the SSH provider, the variable in `${localEnv:NAME}` must reach the remote ```sh devsy workspace up --provider ssh --ide=none ``` + +## Reserved labels + +Devsy owns the following labels in the explicit label maps it sends to drivers and external providers: + +- `devsy.user` +- `sh.devsy.recovery` +- `devsy.overlay.structure` +- `devsy.sh/metadata-creation-config` +- `devsy.compose.contract` +- `devsy.compose.invocation` +- `devsy.wslg.snapshot` +- `devsy.sh/user` +- `devsy.sh/microsandbox-workspace-mount` +- `devsy.sh/microsandbox-workspace-user` +- `sh.devsy.managed` +- `sh.devsy.workspace-id` +- `sh.devsy.resource` +- `sh.devsy.volume-role` +- `sh.devsy.seeded` +- `devsy.sh/created` +- `devsy.sh/workspace-uid` +- `devsy.sh/managed` +- `devsy.sh/resource` +- `devsy.sh/volume-role` + +Do not supply these keys through `--id-label`, Kubernetes provider labels, or Kubernetes pod template labels. Devsy rejects them with an error naming the key. This also applies to saved workspace options. Remove the assignment before starting an older workspace again. Devsy still writes its own values for these keys. + +Custom identification labels, including `dev.containers.id`, remain configurable. The `devcontainer.metadata` image label remains a supported configuration source and can contain private values. Reserving a label does not make every value stored under it public. + +The top-level `containerLabels` and `labels` fields in devcontainer.json are ignored. External providers reject `runArgs` rather than translate them into request labels. Native Docker, Podman, nerdctl, Apple and Compose arguments and inherited image labels are outside this explicit map reservation. Avoid using reserved keys there. Native argument validation is a separate follow-up.