fix case sensitivity

coder · f0ssel · Jul 16, 2024 · Jul 9, 2024 · Jul 9, 2024 · Jul 11, 2024
commit 28ded4534b96b135e4fb1cc009aa08da59153e83
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -2859,7 +2859,7 @@ func (q *querier) InsertWorkspaceResourceMetadata(ctx context.Context, arg datab
 	return q.db.InsertWorkspaceResourceMetadata(ctx, arg)
 }
 
-func (q *querier) ListProvisionerKeysByOrganization(ctx context.Context, organizationID uuid.UUID) ([]database.ListProvisionerKeysByOrganizationRow, error) {
+func (q *querier) ListProvisionerKeysByOrganization(ctx context.Context, organizationID uuid.UUID) ([]database.ProvisionerKey, error) {
 	return fetchWithPostFilter(q.auth, policy.ActionRead, q.db.ListProvisionerKeysByOrganization)(ctx, organizationID)
 }
 

diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
@@ -1835,7 +1835,7 @@ func (s *MethodTestSuite) TestProvisionerKeys() {
 	s.Run("ListProvisionerKeysByOrganization", s.Subtest(func(db database.Store, check *expects) {
 		org := dbgen.Organization(s.T(), db, database.Organization{})
 		pk := dbgen.ProvisionerKey(s.T(), db, database.ProvisionerKey{OrganizationID: org.ID})
-		pks := []database.ListProvisionerKeysByOrganizationRow{
+		pks := []database.ProvisionerKey{
 			{
 				ID:             pk.ID,
 				CreatedAt:      pk.CreatedAt,

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -124,6 +124,14 @@ func (inTxMutex) RLock()   {}
 func (inTxMutex) Unlock()  {}
 func (inTxMutex) RUnlock() {}
 
+// newUniqueContraintError copies the base unique constraint error and sets the constraint to the provided value.
+func newUniqueContraintError(uc database.UniqueConstraint) *pq.Error {
+	newErr := *errUniqueConstraint
+	newErr.Constraint = string(uc)
+
+	return &newErr
+}
+
 // FakeQuerier replicates database functionality to enable quick testing.  It's an exported type so that our test code
 // can do type checks.
 type FakeQuerier struct {
@@ -3228,7 +3236,7 @@ func (q *FakeQuerier) GetProvisionerKeyByName(_ context.Context, arg database.Ge
 	defer q.mutex.RUnlock()
 
 	for _, key := range q.provisionerKeys {
-		if key.Name == arg.Name && key.OrganizationID == arg.OrganizationID {
+		if strings.ToLower(key.Name) == strings.ToLower(arg.Name) && key.OrganizationID == arg.OrganizationID {
 			return key, nil
 		}
 	}
@@ -6544,7 +6552,7 @@ func (q *FakeQuerier) InsertProvisionerKey(_ context.Context, arg database.Inser
 	defer q.mutex.Unlock()
 
 	newErr := *errUniqueConstraint
-	newErr.Constraint = string(database.UniqueProvisionerKeysOrganizationIDNameKey)
+	newErr.Constraint = string(database.UniqueProvisionerKeysOrganizationIDNameIndex)
 	for _, key := range q.provisionerKeys {
 		if key.ID == arg.ID || (key.OrganizationID == arg.OrganizationID && key.Name == arg.Name) {
 			return database.ProvisionerKey{}, &newErr
@@ -6556,7 +6564,7 @@ func (q *FakeQuerier) InsertProvisionerKey(_ context.Context, arg database.Inser
 		ID:             arg.ID,
 		CreatedAt:      arg.CreatedAt,
 		OrganizationID: arg.OrganizationID,
-		Name:           arg.Name,
+		Name:           strings.ToLower(arg.Name),
 		HashedSecret:   arg.HashedSecret,
 	}
 	q.provisionerKeys = append(q.provisionerKeys, provisionerKey)
@@ -7241,18 +7249,19 @@ func (q *FakeQuerier) InsertWorkspaceResourceMetadata(_ context.Context, arg dat
 	return metadata, nil
 }
 
-func (q *FakeQuerier) ListProvisionerKeysByOrganization(_ context.Context, organizationID uuid.UUID) ([]database.ListProvisionerKeysByOrganizationRow, error) {
+func (q *FakeQuerier) ListProvisionerKeysByOrganization(_ context.Context, organizationID uuid.UUID) ([]database.ProvisionerKey, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	keys := make([]database.ListProvisionerKeysByOrganizationRow, 0)
+	keys := make([]database.ProvisionerKey, 0)
 	for _, key := range q.provisionerKeys {
 		if key.OrganizationID == organizationID {
-			keys = append(keys, database.ListProvisionerKeysByOrganizationRow{
+			keys = append(keys, database.ProvisionerKey{
 				ID:             key.ID,
 				CreatedAt:      key.CreatedAt,
 				OrganizationID: key.OrganizationID,
 				Name:           key.Name,
+				HashedSecret:   key.HashedSecret,
 			})
 		}
 	}

diff --git a/coderd/database/dbmetrics/dbmetrics.go b/coderd/database/dbmetrics/dbmetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000226_provisioner_keys.up.sql b/coderd/database/migrations/000226_provisioner_keys.up.sql
@@ -3,7 +3,7 @@ CREATE TABLE provisioner_keys (
     created_at timestamptz NOT NULL,
     organization_id uuid NOT NULL REFERENCES organizations (id) ON DELETE CASCADE,
     name varchar(64) NOT NULL,
-    hashed_secret bytea NOT NULL,
+    hashed_secret bytea NOT NULL
 );
 
-CREATE INDEX provisioner_keys_organization_id_name_idx ON provisioner_keys (organization_id, name);
+CREATE UNIQUE INDEX provisioner_keys_organization_id_name_idx ON provisioner_keys (organization_id, name);
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/provisionerkeys.sql b/coderd/database/queries/provisionerkeys.sql
@@ -8,7 +8,7 @@ INSERT INTO
 		hashed_secret
 	)
 VALUES
-	($1, $2, $3, lower($4), $5) RETURNING *;
+	($1, $2, $3, lower(@name), $4) RETURNING *;
 
 -- name: GetProvisionerKeyByID :one
 SELECT
@@ -26,14 +26,11 @@ FROM
 WHERE
     organization_id = $1
 AND 
-    name = $2;
+    name = lower(@name);
 
 -- name: ListProvisionerKeysByOrganization :many
 SELECT
-    id,
-    created_at,
-    organization_id,
-    name
+    *
 FROM
     provisioner_keys
 WHERE

diff --git a/coderd/database/unique_constraint.go b/coderd/database/unique_constraint.go
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -271,6 +271,7 @@ type ProvisionerKey struct {
 	CreatedAt      time.Time `json:"created_at" format:"date-time"`
 	OrganizationID uuid.UUID `json:"organization" format:"uuid"`
 	Name           string    `json:"name"`
+	// HashedSecret - never include the access token in the API response
 }
 
 type CreateProvisionerKeyRequest struct {

diff --git a/enterprise/coderd/provisionerkeys.go b/enterprise/coderd/provisionerkeys.go
@@ -63,7 +63,7 @@ func (api *API) postProvisionerKey(rw http.ResponseWriter, r *http.Request) {
 	}
 
 	_, err = api.Database.InsertProvisionerKey(ctx, params)
-	if database.IsUniqueViolation(err, database.UniqueProvisionerKeysOrganizationIDNameKey) {
+	if database.IsUniqueViolation(err, database.UniqueProvisionerKeysOrganizationIDNameIndex) {
 		httpapi.Write(ctx, rw, http.StatusConflict, codersdk.Response{
 			Message: fmt.Sprintf("Provisioner key with name '%s' already exists in organization", req.Name),
 		})
@@ -135,14 +135,15 @@ func (api *API) deleteProvisionerKey(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
-func convertProvisionerKeys(dbKeys []database.ListProvisionerKeysByOrganizationRow) []codersdk.ProvisionerKey {
+func convertProvisionerKeys(dbKeys []database.ProvisionerKey) []codersdk.ProvisionerKey {
 	keys := make([]codersdk.ProvisionerKey, 0, len(dbKeys))
 	for _, dbKey := range dbKeys {
 		keys = append(keys, codersdk.ProvisionerKey{
 			ID:             dbKey.ID,
 			CreatedAt:      dbKey.CreatedAt,
 			OrganizationID: dbKey.OrganizationID,
 			Name:           dbKey.Name,
+			// HashedSecret - never include the access token in the API response
 		})
 	}
 	return keys

diff --git a/enterprise/coderd/provisionerkeys_test.go b/enterprise/coderd/provisionerkeys_test.go
@@ -71,7 +71,7 @@ func TestProvisionerKeys(t *testing.T) {
 
 	// org admin can create a provisioner key
 	_, err = orgAdmin.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
-		Name: "key",
+		Name: "Key", // case insensitive
 	})
 	require.NoError(t, err, "org admin create provisioner key")
 
@@ -99,7 +99,7 @@ func TestProvisionerKeys(t *testing.T) {
 	require.Len(t, keys, 1, "org admin list provisioner keys")
 
 	// org admin can delete a provisioner key
-	err = orgAdmin.DeleteProvisionerKey(ctx, owner.OrganizationID, "key")
+	err = orgAdmin.DeleteProvisionerKey(ctx, owner.OrganizationID, "key") // using lowercase here works
 	require.NoError(t, err, "org admin delete provisioner key")
 
 	// org admin cannot delete a provisioner key that doesn't exist