Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
feat(iam): migrate legacy IAM binding member prefix for service account and workload identity (#19115)
rebelice813cc2539bdb
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yamlindex af1334ab5a..b8ef881c0f 100644--- a/backend/api/mcp/gen/openapi.yaml+++ b/backend/api/mcp/gen/openapi.yaml@@ -12752,6 +12752,8 @@ components:Specifies the principals who are exempt from masking.For users, the member should be: user:{email}For groups, the member should be: group:{email}+ For service accounts, the member should be: serviceAccount:{email}+ For workload identities, the member should be: workloadIdentity:{email}condition:title: conditiondescription: |-diff --git a/backend/api/v1/project_service.go b/backend/api/v1/project_service.goindex 703eb198e1..25bf92d8fd 100644--- a/backend/api/v1/project_service.go+++ b/backend/api/v1/project_service.go@@ -1204,13 +1204,13 @@ func validateMember(member string) error {return nil}- userIdentifierMap := map[string]bool{- common.UserBindingPrefix: true,- common.GroupBindingPrefix: true,- common.ServiceAccountBindingPrefix: true,- common.WorkloadIdentityBindingPrefix: true,+ validPrefixes := []string{+ common.UserBindingPrefix,+ common.GroupBindingPrefix,+ common.ServiceAccountBindingPrefix,+ common.WorkloadIdentityBindingPrefix,}- for prefix := range userIdentifierMap {+ for _, prefix := range validPrefixes {if strings.HasPrefix(member, prefix) && len(member[len(prefix):]) > 0 {return nil}diff --git a/backend/api/v1/project_service_converter.go b/backend/api/v1/project_service_converter.goindex c0bbc02ef8..5ab1a4ec36 100644--- a/backend/api/v1/project_service_converter.go+++ b/backend/api/v1/project_service_converter.go@@ -140,14 +140,14 @@ func convertToV1WebhookType(tp storepb.WebhookType) v1pb.WebhookType {}func convertToV1MemberInBinding(member string) string {- if strings.HasPrefix(member, common.UserNamePrefix) {- return common.UserBindingPrefix + strings.TrimPrefix(member, common.UserNamePrefix)- } else if strings.HasPrefix(member, common.GroupPrefix) {- return common.GroupBindingPrefix + strings.TrimPrefix(member, common.GroupPrefix)- } else if strings.HasPrefix(member, common.ServiceAccountNamePrefix) {- return common.ServiceAccountBindingPrefix + strings.TrimPrefix(member, common.ServiceAccountNamePrefix)- } else if strings.HasPrefix(member, common.WorkloadIdentityNamePrefix) {- return common.WorkloadIdentityBindingPrefix + strings.TrimPrefix(member, common.WorkloadIdentityNamePrefix)+ if email, ok := strings.CutPrefix(member, common.ServiceAccountNamePrefix); ok {+ return common.ServiceAccountBindingPrefix + email+ } else if email, ok := strings.CutPrefix(member, common.WorkloadIdentityNamePrefix); ok {+ return common.WorkloadIdentityBindingPrefix + email+ } else if email, ok := strings.CutPrefix(member, common.UserNamePrefix); ok {+ return common.UserBindingPrefix + email+ } else if email, ok := strings.CutPrefix(member, common.GroupPrefix); ok {+ return common.GroupBindingPrefix + email}// handle allUsers.return member@@ -233,18 +233,14 @@ func convertToStoreIamPolicy(iamPolicy *v1pb.IamPolicy) (*storepb.IamPolicy, err}func convertToStoreIamPolicyMember(member string) (string, error) {- if strings.HasPrefix(member, common.UserBindingPrefix) {- email := strings.TrimPrefix(member, common.UserBindingPrefix)- return common.FormatUserEmail(email), nil- } else if strings.HasPrefix(member, common.GroupBindingPrefix) {- email := strings.TrimPrefix(member, common.GroupBindingPrefix)- return common.FormatGroupEmail(email), nil- } else if strings.HasPrefix(member, common.ServiceAccountBindingPrefix) {- email := strings.TrimPrefix(member, common.ServiceAccountBindingPrefix)+ if email, ok := strings.CutPrefix(member, common.ServiceAccountBindingPrefix); ok {return common.FormatServiceAccountEmail(email), nil- } else if strings.HasPrefix(member, common.WorkloadIdentityBindingPrefix) {- email := strings.TrimPrefix(member, common.WorkloadIdentityBindingPrefix)+ } else if email, ok := strings.CutPrefix(member, common.WorkloadIdentityBindingPrefix); ok {return common.FormatWorkloadIdentityEmail(email), nil+ } else if email, ok := strings.CutPrefix(member, common.UserBindingPrefix); ok {+ return common.FormatUserEmail(email), nil+ } else if email, ok := strings.CutPrefix(member, common.GroupBindingPrefix); ok {+ return common.FormatGroupEmail(email), nil} else if member == common.AllUsers {return member, nil}diff --git a/backend/api/v1/project_service_test.go b/backend/api/v1/project_service_test.goindex ec8e152903..1ca66cc321 100644--- a/backend/api/v1/project_service_test.go+++ b/backend/api/v1/project_service_test.go@@ -39,6 +39,34 @@ func TestValidateMembers(t *testing.T) {member: "user:foo",wantErr: false,},+ {+ member: "group:[email protected]",+ wantErr: false,+ },+ {+ member: "serviceAccount:[email protected]",+ wantErr: false,+ },+ {+ member: "serviceAccount:[email protected]",+ wantErr: false,+ },+ {+ member: "workloadIdentity:[email protected]",+ wantErr: false,+ },+ {+ member: "workloadIdentity:[email protected]",+ wantErr: false,+ },+ {+ member: "serviceAccount:",+ wantErr: true,+ },+ {+ member: "workloadIdentity:",+ wantErr: true,+ },}a := require.New(t)diff --git a/backend/generated-go/v1/org_policy_service.pb.go b/backend/generated-go/v1/org_policy_service.pb.goindex d5a09b5b6a..665ee8dc4c 100644--- a/backend/generated-go/v1/org_policy_service.pb.go+++ b/backend/generated-go/v1/org_policy_service.pb.go@@ -983,6 +983,8 @@ type MaskingExemptionPolicy_Exemption struct {// Specifies the principals who are exempt from masking.// For users, the member should be: user:{email}// For groups, the member should be: group:{email}+ // For service accounts, the member should be: serviceAccount:{email}+ // For workload identities, the member should be: workloadIdentity:{email}Members []string `protobuf:"bytes,1,rep,name=members,proto3" json:"members,omitempty"`// The condition that is associated with this exception policy instance.// The syntax and semantics of CEL are documented at https://github.com/google/cel-specdiff --git a/backend/migrator/migration/3.15/0005##migrate_iam_binding_member_prefix.sql b/backend/migrator/migration/3.15/0005##migrate_iam_binding_member_prefix.sqlnew file mode 100644index 0000000000..08f57fa589--- /dev/null+++ b/backend/migrator/migration/3.15/0005##migrate_iam_binding_member_prefix.sql@@ -0,0 +1,44 @@+-- Migrate IAM binding members from legacy "users/" prefix to proper prefixes:+-- - Service accounts: "users/[email protected]" -> "serviceAccounts/[email protected]"+-- - Workload identities: "users/[email protected]" -> "workloadIdentities/[email protected]"++-- Update IAM policies in the policy table+UPDATE policy+SET payload = (+ SELECT jsonb_set(+ payload,+ '{bindings}',+ (+ SELECT jsonb_agg(+ jsonb_set(+ binding,+ '{members}',+ (+ SELECT jsonb_agg(+ CASE+ -- Service account: workspace-level (ends with @service.bytebase.com)+ WHEN member_text LIKE 'users/%@service.bytebase.com'+ THEN to_jsonb(regexp_replace(member_text, '^users/', 'serviceAccounts/'))+ -- Service account: project-level (contains .service.bytebase.com)+ WHEN member_text LIKE 'users/%@%.service.bytebase.com'+ THEN to_jsonb(regexp_replace(member_text, '^users/', 'serviceAccounts/'))+ -- Workload identity: workspace-level (ends with @workload.bytebase.com)+ WHEN member_text LIKE 'users/%@workload.bytebase.com'+ THEN to_jsonb(regexp_replace(member_text, '^users/', 'workloadIdentities/'))+ -- Workload identity: project-level (contains .workload.bytebase.com)+ WHEN member_text LIKE 'users/%@%.workload.bytebase.com'+ THEN to_jsonb(regexp_replace(member_text, '^users/', 'workloadIdentities/'))+ ELSE member+ END+ )+ FROM jsonb_array_elements(binding->'members') AS member,+ LATERAL (SELECT member #>> '{}' AS member_text) AS extracted+ )+ )+ )+ FROM jsonb_array_elements(payload->'bindings') AS binding+ )+ )+)+WHERE type = 'IAM'+ AND payload->'bindings' IS NOT NULL;diff --git a/backend/migrator/migrator_test.go b/backend/migrator/migrator_test.goindex b6b7a8761c..15e8f40daa 100644--- a/backend/migrator/migrator_test.go+++ b/backend/migrator/migrator_test.go@@ -12,8 +12,8 @@ import (func TestLatestVersion(t *testing.T) {files, err := getSortedVersionedFiles()require.NoError(t, err)- require.Equal(t, semver.MustParse("3.15.4"), *files[len(files)-1].version)- require.Equal(t, "migration/3.15/0004##add_principal_project.sql", files[len(files)-1].path)+ require.Equal(t, semver.MustParse("3.15.5"), *files[len(files)-1].version)+ require.Equal(t, "migration/3.15/0005##migrate_iam_binding_member_prefix.sql", files[len(files)-1].path)}func TestVersionUnique(t *testing.T) {diff --git a/backend/tests/user_test.go b/backend/tests/user_test.goindex cdc55f5f21..a96fa09eb1 100644--- a/backend/tests/user_test.go+++ b/backend/tests/user_test.go@@ -64,7 +64,7 @@ func TestDeleteUser(t *testing.T) {// Test: only count the end user.for _, binding := range policy.Bindings {if binding.Role == "roles/workspaceAdmin" {- binding.Members = append(binding.Members, fmt.Sprintf("user:%s", serviceAccount.Email))+ binding.Members = append(binding.Members, fmt.Sprintf("serviceAccount:%s", serviceAccount.Email))break}}diff --git a/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts b/frontend/src/types/proto-es/v1/org_policy_service_pb.d.tsindex df7b059c31..387adb8de6 100644--- a/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/org_policy_service_pb.d.ts@@ -396,6 +396,8 @@ export declare type MaskingExemptionPolicy_Exemption = Message<"bytebase.v1.Mask* Specifies the principals who are exempt from masking.* For users, the member should be: user:{email}* For groups, the member should be: group:{email}+ * For service accounts, the member should be: serviceAccount:{email}+ * For workload identities, the member should be: workloadIdentity:{email}** @generated from field: repeated string members = 1;*/diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex d72a681589..552af8935c 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -16911,6 +16911,8 @@ components:Specifies the principals who are exempt from masking.For users, the member should be: user:{email}For groups, the member should be: group:{email}+ For service accounts, the member should be: serviceAccount:{email}+ For workload identities, the member should be: workloadIdentity:{email}condition:title: conditiondescription: |-diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex 98ab30b48f..d745048af0 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -6557,7 +6557,7 @@ MaskingExemptionPolicy is the allowlist of users who can access sensitive data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} |+| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} For service accounts, the member should be: serviceAccount:{email} For workload identities, the member should be: workloadIdentity:{email} || condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec If the condition is empty, means the user can access all databases without expiration.Support variables: resource.instance_id: the instance resource id. Only support "==" operation. resource.database_name: the database name. Only support "==" operation. resource.schema_name: the schema name. Only support "==" operation. resource.table_name: the table name. Only support "==" operation. resource.column_name: the column name. Only support "==" operation. request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")` All variables should join with "&&" condition.diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex 19f318bbde..875d77672a 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -18592,7 +18592,9 @@ Format: {resource type}/{resource id} </p></td><td>repeated</td><td><p>Specifies the principals who are exempt from masking.For users, the member should be: user:{email}-For groups, the member should be: group:{email} </p></td>+For groups, the member should be: group:{email}+For service accounts, the member should be: serviceAccount:{email}+For workload identities, the member should be: workloadIdentity:{email} </p></td></tr><tr>diff --git a/proto/v1/v1/org_policy_service.proto b/proto/v1/v1/org_policy_service.protoindex 5111e92be4..a2b3724d16 100644--- a/proto/v1/v1/org_policy_service.proto+++ b/proto/v1/v1/org_policy_service.proto@@ -322,6 +322,8 @@ message MaskingExemptionPolicy {// Specifies the principals who are exempt from masking.// For users, the member should be: user:{email}// For groups, the member should be: group:{email}+ // For service accounts, the member should be: serviceAccount:{email}+ // For workload identities, the member should be: workloadIdentity:{email}repeated string members = 1;// The condition that is associated with this exception policy instance.