Skip to content

feat: add user_secrets table #19162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Aug 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
104bf21
feat: add user_secrets table
evgeniy-scherbina Aug 4, 2025
b677273
feat: add SQL queries
evgeniy-scherbina Aug 4, 2025
a826dd3
feat: add DBAuthz wrappers and UserSecret resource type
evgeniy-scherbina Aug 5, 2025
540f2e2
feat: add DBAuthz tests
evgeniy-scherbina Aug 5, 2025
363173c
test: fix role-permissions test
evgeniy-scherbina Aug 5, 2025
e152648
test: fix migration test
evgeniy-scherbina Aug 5, 2025
49ac807
fix: change user-secret permissions
evgeniy-scherbina Aug 5, 2025
85b4f4c
fix: add unit-tests for sql queries
evgeniy-scherbina Aug 6, 2025
3f04a15
test: improve unit-tests for sql queries
evgeniy-scherbina Aug 6, 2025
d7605f6
refactor: use table-test approach for secrets-authz test
evgeniy-scherbina Aug 6, 2025
b55be78
refactor: minor refactor in tests
evgeniy-scherbina Aug 6, 2025
3090d52
fix: formatting
evgeniy-scherbina Aug 6, 2025
789a5eb
fix: formatting
evgeniy-scherbina Aug 6, 2025
12b6c2e
ci: run make gen and make fmt
evgeniy-scherbina Aug 6, 2025
317708b
refactor: CR's fixes
evgeniy-scherbina Aug 7, 2025
72faf7a
Update coderd/database/dbauthz/dbauthz.go
evgeniy-scherbina Aug 7, 2025
a715310
Update coderd/database/dbauthz/dbauthz.go
evgeniy-scherbina Aug 7, 2025
8ea3cda
refactor: CR's fixes
evgeniy-scherbina Aug 7, 2025
b21f07c
refactor: CR's fixes
evgeniy-scherbina Aug 7, 2025
0f47bae
refactor: CR's fixes
evgeniy-scherbina Aug 7, 2025
1d6f2fa
refactor: CR's fixes
evgeniy-scherbina Aug 7, 2025
b24599c
Merge remote-tracking branch 'origin/main' into yevhenii/secrets-db-s…
evgeniy-scherbina Aug 7, 2025
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
2 changes: 2 additions & 0 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 64 additions & 0 deletions coderd/database/dbauthz/dbauthz.go
Original file line number Diff line number Diff line change
Expand Up @@ -1387,6 +1387,14 @@ func (q *querier) CountUnreadInboxNotificationsByUserID(ctx context.Context, use
return q.db.CountUnreadInboxNotificationsByUserID(ctx, userID)
}

func (q *querier) CreateUserSecret(ctx context.Context, arg database.CreateUserSecretParams) (database.UserSecret, error) {
obj := rbac.ResourceUserSecret.WithOwner(arg.UserID.String())
if err := q.authorizeContext(ctx, policy.ActionCreate, obj); err != nil {
return database.UserSecret{}, err
}
return q.db.CreateUserSecret(ctx, arg)
}

// TODO: Handle org scoped lookups
func (q *querier) CustomRoles(ctx context.Context, arg database.CustomRolesParams) ([]database.CustomRole, error) {
roleObject := rbac.ResourceAssignRole
Expand Down Expand Up @@ -1657,6 +1665,19 @@ func (q *querier) DeleteTailnetTunnel(ctx context.Context, arg database.DeleteTa
return q.db.DeleteTailnetTunnel(ctx, arg)
}

func (q *querier) DeleteUserSecret(ctx context.Context, id uuid.UUID) error {
// First get the secret to check ownership
secret, err := q.GetUserSecret(ctx, id)
if err != nil {
return err
}

if err := q.authorizeContext(ctx, policy.ActionDelete, secret); err != nil {
return err
}
return q.db.DeleteUserSecret(ctx, id)
}

func (q *querier) DeleteWebpushSubscriptionByUserIDAndEndpoint(ctx context.Context, arg database.DeleteWebpushSubscriptionByUserIDAndEndpointParams) error {
if err := q.authorizeContext(ctx, policy.ActionDelete, rbac.ResourceWebpushSubscription.WithOwner(arg.UserID.String())); err != nil {
return err
Expand Down Expand Up @@ -3075,6 +3096,28 @@ func (q *querier) GetUserNotificationPreferences(ctx context.Context, userID uui
return q.db.GetUserNotificationPreferences(ctx, userID)
}

func (q *querier) GetUserSecret(ctx context.Context, id uuid.UUID) (database.UserSecret, error) {
// First get the secret to check ownership
secret, err := q.db.GetUserSecret(ctx, id)
if err != nil {
return database.UserSecret{}, err
}

if err := q.authorizeContext(ctx, policy.ActionRead, secret); err != nil {
return database.UserSecret{}, err
}
return secret, nil
}

func (q *querier) GetUserSecretByUserIDAndName(ctx context.Context, arg database.GetUserSecretByUserIDAndNameParams) (database.UserSecret, error) {
obj := rbac.ResourceUserSecret.WithOwner(arg.UserID.String())
if err := q.authorizeContext(ctx, policy.ActionRead, obj); err != nil {
return database.UserSecret{}, err
}

return q.db.GetUserSecretByUserIDAndName(ctx, arg)
}

func (q *querier) GetUserStatusCounts(ctx context.Context, arg database.GetUserStatusCountsParams) ([]database.GetUserStatusCountsRow, error) {
if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceUser); err != nil {
return nil, err
Expand Down Expand Up @@ -4153,6 +4196,14 @@ func (q *querier) ListProvisionerKeysByOrganizationExcludeReserved(ctx context.C
return fetchWithPostFilter(q.auth, policy.ActionRead, q.db.ListProvisionerKeysByOrganizationExcludeReserved)(ctx, organizationID)
}

func (q *querier) ListUserSecrets(ctx context.Context, userID uuid.UUID) ([]database.UserSecret, error) {
obj := rbac.ResourceUserSecret.WithOwner(userID.String())
if err := q.authorizeContext(ctx, policy.ActionRead, obj); err != nil {
return nil, err
}
return q.db.ListUserSecrets(ctx, userID)
}

func (q *querier) ListWorkspaceAgentPortShares(ctx context.Context, workspaceID uuid.UUID) ([]database.WorkspaceAgentPortShare, error) {
workspace, err := q.db.GetWorkspaceByID(ctx, workspaceID)
if err != nil {
Expand Down Expand Up @@ -4866,6 +4917,19 @@ func (q *querier) UpdateUserRoles(ctx context.Context, arg database.UpdateUserRo
return q.db.UpdateUserRoles(ctx, arg)
}

func (q *querier) UpdateUserSecret(ctx context.Context, arg database.UpdateUserSecretParams) (database.UserSecret, error) {
// First get the secret to check ownership
secret, err := q.db.GetUserSecret(ctx, arg.ID)
if err != nil {
return database.UserSecret{}, err
}

if err := q.authorizeContext(ctx, policy.ActionUpdate, secret); err != nil {
return database.UserSecret{}, err
}
return q.db.UpdateUserSecret(ctx, arg)
}

func (q *querier) UpdateUserStatus(ctx context.Context, arg database.UpdateUserStatusParams) (database.User, error) {
fetch := func(ctx context.Context, arg database.UpdateUserStatusParams) (database.User, error) {
return q.db.GetUserByID(ctx, arg.ID)
Expand Down
61 changes: 61 additions & 0 deletions coderd/database/dbauthz/dbauthz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5883,3 +5883,64 @@ func (s *MethodTestSuite) TestAuthorizePrebuiltWorkspace() {
}).Asserts(w, policy.ActionUpdate, w.AsPrebuild(), policy.ActionUpdate)
}))
}

func (s *MethodTestSuite) TestUserSecrets() {
s.Run("GetUserSecretByUserIDAndName", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
userSecret := dbgen.UserSecret(s.T(), db, database.UserSecret{
UserID: user.ID,
})
arg := database.GetUserSecretByUserIDAndNameParams{
UserID: user.ID,
Name: userSecret.Name,
}
check.Args(arg).
Asserts(rbac.ResourceUserSecret.WithOwner(arg.UserID.String()), policy.ActionRead).
Returns(userSecret)
}))
s.Run("GetUserSecret", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
userSecret := dbgen.UserSecret(s.T(), db, database.UserSecret{
UserID: user.ID,
})
check.Args(userSecret.ID).
Asserts(userSecret, policy.ActionRead).
Returns(userSecret)
}))
s.Run("ListUserSecrets", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
userSecret := dbgen.UserSecret(s.T(), db, database.UserSecret{
UserID: user.ID,
})
check.Args(user.ID).
Asserts(rbac.ResourceUserSecret.WithOwner(user.ID.String()), policy.ActionRead).
Returns([]database.UserSecret{userSecret})
}))
s.Run("CreateUserSecret", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
arg := database.CreateUserSecretParams{
UserID: user.ID,
}
check.Args(arg).
Asserts(rbac.ResourceUserSecret.WithOwner(arg.UserID.String()), policy.ActionCreate)
}))
s.Run("UpdateUserSecret", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
userSecret := dbgen.UserSecret(s.T(), db, database.UserSecret{
UserID: user.ID,
})
arg := database.UpdateUserSecretParams{
ID: userSecret.ID,
}
check.Args(arg).
Asserts(userSecret, policy.ActionUpdate)
}))
s.Run("DeleteUserSecret", s.Subtest(func(db database.Store, check *expects) {
user := dbgen.User(s.T(), db, database.User{})
userSecret := dbgen.UserSecret(s.T(), db, database.UserSecret{
UserID: user.ID,
})
check.Args(userSecret.ID).
Asserts(userSecret, policy.ActionRead, userSecret, policy.ActionDelete)
}))
}
14 changes: 14 additions & 0 deletions coderd/database/dbgen/dbgen.go
Original file line number Diff line number Diff line change
Expand Up @@ -1422,6 +1422,20 @@ func PresetParameter(t testing.TB, db database.Store, seed database.InsertPreset
return parameters
}

func UserSecret(t testing.TB, db database.Store, seed database.UserSecret) database.UserSecret {
userSecret, err := db.CreateUserSecret(genCtx, database.CreateUserSecretParams{
ID: takeFirst(seed.ID, uuid.New()),
UserID: takeFirst(seed.UserID, uuid.New()),
Name: takeFirst(seed.Name, "secret-name"),
Description: takeFirst(seed.Description, "secret description"),
Value: takeFirst(seed.Value, "secret value"),
EnvName: takeFirst(seed.EnvName, "SECRET_ENV_NAME"),
FilePath: takeFirst(seed.FilePath, "~/secret/file/path"),
})
require.NoError(t, err, "failed to insert user secret")
return userSecret
}

func ClaimPrebuild(t testing.TB, db database.Store, newUserID uuid.UUID, newName string, presetID uuid.UUID) database.ClaimPrebuiltWorkspaceRow {
claimedWorkspace, err := db.ClaimPrebuiltWorkspace(genCtx, database.ClaimPrebuiltWorkspaceParams{
NewUserID: newUserID,
Expand Down
42 changes: 42 additions & 0 deletions coderd/database/dbmetrics/querymetrics.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy