Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cmd/workspace/up/up_validate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
50 changes: 50 additions & 0 deletions pkg/config/reserved_labels.go
Original file line number Diff line number Diff line change
@@ -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
}
62 changes: 62 additions & 0 deletions pkg/config/reserved_labels_test.go
Original file line number Diff line number Diff line change
@@ -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))
}
2 changes: 1 addition & 1 deletion pkg/devcontainer/compose_metadata.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
)

const (
composeContractLabel = "devsy.compose.contract"
composeContractLabel = pkgconfig.ComposeContractLabel
composeRecreateGuidance = "rerun workspace up with the original configuration and --recreate"
)

Expand Down
4 changes: 2 additions & 2 deletions pkg/devcontainer/config_overlay_lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion pkg/devcontainer/metadata/metadata.go
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
22 changes: 22 additions & 0 deletions pkg/devcontainer/reserved_labels_test.go
Original file line number Diff line number Diff line change
@@ -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)
}
4 changes: 4 additions & 0 deletions pkg/devcontainer/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion pkg/devcontainer/wslg.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
107 changes: 107 additions & 0 deletions pkg/driver/external/reserved_labels_test.go
Original file line number Diff line number Diff line change
@@ -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)
}
20 changes: 17 additions & 3 deletions pkg/driver/external/run_image.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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
}
Expand All @@ -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) {
Expand Down
Loading
Loading