Skip to content

Commit b51bf01

Browse files
committed
fix(coderd): do not carry prebuild secrets forward to the claimant
1 parent ab8fd63 commit b51bf01

2 files changed

Lines changed: 74 additions & 0 deletions

File tree

‎coderd/wsbuilder/wsbuilder.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,11 @@ func (b *Builder) persistSecrets(store database.Store, workspaceBuildID uuid.UUI
665665
// First build; nothing to copy forward.
666666
case err != nil:
667667
return BuildError{http.StatusInternalServerError, "get last build", err}
668+
case b.prebuiltWorkspaceBuildStage == sdkproto.PrebuiltWorkspaceBuildStage_CLAIM:
669+
// The previous build belongs to the prebuild's system owner. Its
670+
// secrets must not transfer to the claimant; only secrets the
671+
// claimant sends apply. The prebuild's rows are cleared when this
672+
// build completes.
668673
default:
669674
// getLastBuild was cached before the new build row was inserted, so
670675
// it is the build being superseded.

‎enterprise/coderd/workspaces_test.go‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,75 @@ func TestCreateUserWorkspace(t *testing.T) {
596596
require.NoError(t, json.Unmarshal(job.Input, &metadata))
597597
require.Equal(t, metadata.PrebuiltWorkspaceBuildStage, proto.PrebuiltWorkspaceBuildStage_CLAIM)
598598
})
599+
600+
// A prebuild's secrets belong to the prebuilds system user and must not
601+
// carry forward to the claimant. Secrets the claimant sends still apply.
602+
t.Run("ClaimPrebuildSecrets", func(t *testing.T) {
603+
t.Parallel()
604+
605+
client, db, user := coderdenttest.NewWithDatabase(t, &coderdenttest.Options{
606+
Options: &coderdtest.Options{
607+
DeploymentValues: coderdtest.DeploymentValues(t),
608+
},
609+
LicenseOptions: &coderdenttest.LicenseOptions{
610+
Features: license.Features{
611+
codersdk.FeatureWorkspacePrebuilds: 1,
612+
},
613+
},
614+
})
615+
616+
presetID := uuid.New()
617+
tv := dbfake.TemplateVersion(t, db).Seed(database.TemplateVersion{
618+
OrganizationID: user.OrganizationID,
619+
CreatedBy: user.UserID,
620+
}).Preset(database.TemplateVersionPreset{
621+
ID: presetID,
622+
}).Do()
623+
624+
r := dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{
625+
OwnerID: database.PrebuildsSystemUserID,
626+
TemplateID: tv.Template.ID,
627+
}).Seed(database.WorkspaceBuild{
628+
TemplateVersionID: tv.TemplateVersion.ID,
629+
TemplateVersionPresetID: uuid.NullUUID{
630+
UUID: presetID,
631+
Valid: true,
632+
},
633+
}).WithAgent().Do()
634+
dbgen.WorkspaceSecret(t, db, database.WorkspaceSecret{
635+
WorkspaceID: r.Workspace.ID,
636+
WorkspaceBuildID: r.Build.ID,
637+
Name: "prebuild-token",
638+
EnvName: "PREBUILD_TOKEN",
639+
})
640+
641+
ctx := dbauthz.AsSystemRestricted(testutil.Context(t, testutil.WaitLong))
642+
agent, err := db.GetAuthenticatedWorkspaceAgentAndBuildByAuthToken(ctx, uuid.MustParse(r.AgentToken))
643+
require.NoError(t, err)
644+
err = db.UpdateWorkspaceAgentLifecycleStateByID(ctx, database.UpdateWorkspaceAgentLifecycleStateByIDParams{
645+
ID: agent.WorkspaceAgent.ID,
646+
LifecycleState: database.WorkspaceAgentLifecycleStateReady,
647+
})
648+
require.NoError(t, err)
649+
650+
claimed, err := client.CreateUserWorkspace(ctx, user.UserID.String(), codersdk.CreateWorkspaceRequest{
651+
TemplateVersionID: tv.TemplateVersion.ID,
652+
TemplateVersionPresetID: presetID,
653+
Name: "claimed-workspace",
654+
Secrets: []codersdk.WorkspaceSecretInput{
655+
{Name: "my-token", Value: ptr.Ref("mine"), EnvName: "MY_TOKEN"},
656+
},
657+
})
658+
require.NoError(t, err)
659+
require.Equal(t, r.Workspace.ID, claimed.ID, "the prebuild was claimed")
660+
661+
//nolint:gocritic // Only the workspace secret manager reads values.
662+
secrets, err := db.ListActiveWorkspaceSecrets(dbauthz.AsWorkspaceSecretManager(ctx), claimed.LatestBuild.ID)
663+
require.NoError(t, err)
664+
require.Len(t, secrets, 1, "only the claimant's secret is on the claim build")
665+
require.Equal(t, "my-token", secrets[0].Name)
666+
require.Equal(t, database.WorkspaceSecretSourceRequest, secrets[0].Source)
667+
})
599668
}
600669

601670
func TestWorkspaceAutobuild(t *testing.T) {

0 commit comments

Comments
 (0)