Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor(iam): move predefined roles to store package (#18858)

p0nyfda3ae664242
diff --git a/.github/workflows/frontend-tests.yml b/.github/workflows/frontend-tests.yml
index 5672f9d3b6..3cfc02ced6 100644
--- a/.github/workflows/frontend-tests.yml
+++ b/.github/workflows/frontend-tests.yml
@@ -51,9 +51,7 @@ jobs:
run: pnpm install --frozen-lockfile
working-directory: frontend
- name: Copy config files
- run: |
- cp ../backend/enterprise/plan.yaml ./src/types
- cp ../backend/component/iam/permission.yaml ./src/types/iam
+ run: pnpm run copy:config-files
working-directory: frontend
- name: Run unit tests
run: pnpm test
diff --git a/backend/api/v1/project_service.go b/backend/api/v1/project_service.go
index b51425bb09..057d5f097b 100644
--- a/backend/api/v1/project_service.go
+++ b/backend/api/v1/project_service.go
@@ -1063,7 +1063,7 @@ func getBindingIdentifier(role string, condition *expr.Expr) string {
func validateIAMPolicy(
ctx context.Context,
stores *store.Store,
- iamManager *iam.Manager,
+ _ *iam.Manager,
policy *v1pb.IamPolicy,
oldPolicyMessage *store.IamPolicyMessage,
) (bool, error) {
@@ -1087,7 +1087,6 @@ func validateIAMPolicy(
if err != nil {
return false, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to list roles"))
}
- roleMessages = append(roleMessages, iamManager.PredefinedRoles...)
existingBindings := make(map[string]bool)
for _, oldBinding := range oldPolicyMessage.Policy.Bindings {
diff --git a/backend/api/v1/role_service.go b/backend/api/v1/role_service.go
index 28cb1f96df..7793d9e781 100644
--- a/backend/api/v1/role_service.go
+++ b/backend/api/v1/role_service.go
@@ -41,14 +41,8 @@ func (s *RoleService) ListRoles(ctx context.Context, _ *connect.Request[v1pb.Lis
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to list roles"))
}
-
- roles := convertToRoles(roleMessages, v1pb.Role_CUSTOM)
- for _, predefinedRole := range s.iamManager.PredefinedRoles {
- roles = append(roles, convertToRole(predefinedRole, v1pb.Role_BUILT_IN))
- }
-
return connect.NewResponse(&v1pb.ListRolesResponse{
- Roles: roles,
+ Roles: convertToRoles(roleMessages),
}), nil
}
@@ -64,21 +58,16 @@ func (s *RoleService) GetRole(ctx context.Context, req *connect.Request[v1pb.Get
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to get role"))
}
if role != nil {
- return connect.NewResponse(convertToRole(role, v1pb.Role_CUSTOM)), nil
+ return connect.NewResponse(convertToRole(role)), nil
}
if predefinedRole := s.getBuildinRole(roleID); predefinedRole != nil {
- return connect.NewResponse(convertToRole(predefinedRole, v1pb.Role_BUILT_IN)), nil
+ return connect.NewResponse(convertToRole(predefinedRole)), nil
}
return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("role not found: %s", roleID))
}
-func (s *RoleService) getBuildinRole(roleID string) *store.RoleMessage {
- for _, predefinedRole := range s.iamManager.PredefinedRoles {
- if predefinedRole.ResourceID == roleID {
- return predefinedRole
- }
- }
- return nil
+func (*RoleService) getBuildinRole(roleID string) *store.RoleMessage {
+ return store.GetPredefinedRole(roleID)
}
// CreateRole creates a new role.
@@ -121,7 +110,7 @@ func (s *RoleService) CreateRole(ctx context.Context, req *connect.Request[v1pb.
if err := s.iamManager.ReloadCache(ctx); err != nil {
return nil, err
}
- return connect.NewResponse(convertToRole(roleMessage, v1pb.Role_CUSTOM)), nil
+ return connect.NewResponse(convertToRole(roleMessage)), nil
}
// UpdateRole updates an existing role.
@@ -188,7 +177,7 @@ func (s *RoleService) UpdateRole(ctx context.Context, req *connect.Request[v1pb.
if err := s.iamManager.ReloadCache(ctx); err != nil {
return nil, err
}
- return connect.NewResponse(convertToRole(roleMessage, v1pb.Role_CUSTOM)), nil
+ return connect.NewResponse(convertToRole(roleMessage)), nil
}
// DeleteRole deletes an existing role.
@@ -237,20 +226,24 @@ func (s *RoleService) DeleteRole(ctx context.Context, req *connect.Request[v1pb.
return connect.NewResponse(&emptypb.Empty{}), nil
}
-func convertToRoles(roleMessages []*store.RoleMessage, roleType v1pb.Role_Type) []*v1pb.Role {
- var roles []*v1pb.Role
- for _, roleMessage := range roleMessages {
- roles = append(roles, convertToRole(roleMessage, roleType))
+func convertToRoles(roles []*store.RoleMessage) []*v1pb.Role {
+ result := make([]*v1pb.Role, 0, len(roles))
+ for _, role := range roles {
+ result = append(result, convertToRole(role))
}
- return roles
+ return result
}
-func convertToRole(role *store.RoleMessage, roleType v1pb.Role_Type) *v1pb.Role {
+func convertToRole(role *store.RoleMessage) *v1pb.Role {
var permissions []string
for p := range role.Permissions {
permissions = append(permissions, p)
}
slices.Sort(permissions)
+ roleType := v1pb.Role_CUSTOM
+ if role.Predefined {
+ roleType = v1pb.Role_BUILT_IN
+ }
return &v1pb.Role{
Name: common.FormatRole(role.ResourceID),
Title: role.Name,
diff --git a/backend/common/permission/permission.go b/backend/common/permission/permission.go
new file mode 100644
index 0000000000..d63bbc58be
--- /dev/null
+++ b/backend/common/permission/permission.go
@@ -0,0 +1,160 @@
+package permission
+
+import (
+ _ "embed"
+
+ "gopkg.in/yaml.v3"
+)
+
+//go:embed permission.yaml
+var permissionYAML []byte
+
+type Permission = string
+
+const (
+ PermissionAuditLogsExport Permission = "bb.auditLogs.export"
+ PermissionAuditLogsSearch Permission = "bb.auditLogs.search"
+ PermissionChangelogsGet Permission = "bb.changelogs.get"
+ PermissionChangelogsList Permission = "bb.changelogs.list"
+ PermissionDatabaseCatalogsGet Permission = "bb.databaseCatalogs.get"
+ PermissionDatabaseCatalogsUpdate Permission = "bb.databaseCatalogs.update"
+ PermissionDatabaseGroupsCreate Permission = "bb.databaseGroups.create"
+ PermissionDatabaseGroupsDelete Permission = "bb.databaseGroups.delete"
+ PermissionDatabaseGroupsGet Permission = "bb.databaseGroups.get"
+ PermissionDatabaseGroupsList Permission = "bb.databaseGroups.list"
+ PermissionDatabaseGroupsUpdate Permission = "bb.databaseGroups.update"
+ PermissionDatabasesCheck Permission = "bb.databases.check"
+ PermissionDatabasesGet Permission = "bb.databases.get"
+ PermissionDatabasesGetSchema Permission = "bb.databases.getSchema"
+ PermissionDatabasesList Permission = "bb.databases.list"
+ PermissionDatabasesSync Permission = "bb.databases.sync"
+ PermissionDatabasesUpdate Permission = "bb.databases.update"
+ PermissionIdentityProvidersCreate Permission = "bb.identityProviders.create"
+ PermissionIdentityProvidersDelete Permission = "bb.identityProviders.delete"
+ PermissionIdentityProvidersGet Permission = "bb.identityProviders.get"
+ PermissionIdentityProvidersUpdate Permission = "bb.identityProviders.update"
+ PermissionInstancesCreate Permission = "bb.instances.create"
+ PermissionInstancesDelete Permission = "bb.instances.delete"
+ PermissionInstancesGet Permission = "bb.instances.get"
+ PermissionInstancesList Permission = "bb.instances.list"
+ PermissionInstancesSync Permission = "bb.instances.sync"
+ PermissionInstancesUndelete Permission = "bb.instances.undelete"
+ PermissionInstancesUpdate Permission = "bb.instances.update"
+ PermissionInstanceRolesGet Permission = "bb.instanceRoles.get"
+ PermissionInstanceRolesList Permission = "bb.instanceRoles.list"
+ PermissionIssueCommentsCreate Permission = "bb.issueComments.create"
+ PermissionIssueCommentsList Permission = "bb.issueComments.list"
+ PermissionIssueCommentsUpdate Permission = "bb.issueComments.update"
+ PermissionIssuesCreate Permission = "bb.issues.create"
+ PermissionIssuesGet Permission = "bb.issues.get"
+ PermissionIssuesList Permission = "bb.issues.list"
+ PermissionIssuesUpdate Permission = "bb.issues.update"
+ PermissionPlanCheckRunsGet Permission = "bb.planCheckRuns.get"
+ PermissionPlanCheckRunsRun Permission = "bb.planCheckRuns.run"
+ PermissionPlansCreate Permission = "bb.plans.create"
+ PermissionPlansGet Permission = "bb.plans.get"
+ PermissionPlansList Permission = "bb.plans.list"
+ PermissionPlansUpdate Permission = "bb.plans.update"
+ PermissionPoliciesCreate Permission = "bb.policies.create"
+ PermissionPoliciesDelete Permission = "bb.policies.delete"
+ PermissionPoliciesGet Permission = "bb.policies.get"
+ PermissionPoliciesList Permission = "bb.policies.list"
+ PermissionPoliciesUpdate Permission = "bb.policies.update"
+ PermissionProjectsCreate Permission = "bb.projects.create"
+ PermissionProjectsDelete Permission = "bb.projects.delete"
+ PermissionProjectsGet Permission = "bb.projects.get"
+ PermissionProjectsGetIAMPolicy Permission = "bb.projects.getIamPolicy"
+ PermissionProjectsList Permission = "bb.projects.list"
+ PermissionProjectsSetIAMPolicy Permission = "bb.projects.setIamPolicy"
+ PermissionProjectsUndelete Permission = "bb.projects.undelete"
+ PermissionProjectsUpdate Permission = "bb.projects.update"
+ PermissionReleasesCheck Permission = "bb.releases.check"
+ PermissionReleasesCreate Permission = "bb.releases.create"
+ PermissionReleasesDelete Permission = "bb.releases.delete"
+ PermissionReleasesGet Permission = "bb.releases.get"
+ PermissionReleasesList Permission = "bb.releases.list"
+ PermissionReleasesUndelete Permission = "bb.releases.undelete"
+ PermissionReleasesUpdate Permission = "bb.releases.update"
+ PermissionReviewConfigsCreate Permission = "bb.reviewConfigs.create"
+ PermissionReviewConfigsDelete Permission = "bb.reviewConfigs.delete"
+ PermissionReviewConfigsGet Permission = "bb.reviewConfigs.get"
+ PermissionReviewConfigsList Permission = "bb.reviewConfigs.list"
+ PermissionReviewConfigsUpdate Permission = "bb.reviewConfigs.update"
+ PermissionRevisionsCreate Permission = "bb.revisions.create"
+ PermissionRevisionsDelete Permission = "bb.revisions.delete"
+ PermissionRevisionsGet Permission = "bb.revisions.get"
+ PermissionRevisionsList Permission = "bb.revisions.list"
+ PermissionRolesCreate Permission = "bb.roles.create"
+ PermissionRolesDelete Permission = "bb.roles.delete"
+ PermissionRolesList Permission = "bb.roles.list"
+ PermissionRolesGet Permission = "bb.roles.get"
+ PermissionRolesUpdate Permission = "bb.roles.update"
+ PermissionRolloutsCreate Permission = "bb.rollouts.create"
+ PermissionRolloutsGet Permission = "bb.rollouts.get"
+ PermissionRolloutsList Permission = "bb.rollouts.list"
+ PermissionSettingsGet Permission = "bb.settings.get"
+ PermissionSettingsList Permission = "bb.settings.list"
+ PermissionSettingsSet Permission = "bb.settings.set"
+ PermissionEnvironmentSettingsGet Permission = "bb.settings.getEnvironment"
+ PermissionEnvironmentSettingsSet Permission = "bb.settings.setEnvironment"
+ PermissionWorkspaceProfileSettingsGet Permission = "bb.settings.getWorkspaceProfile"
+ PermissionWorkspaceProfileSettingsSet Permission = "bb.settings.setWorkspaceProfile"
+ PermissionSheetsCreate Permission = "bb.sheets.create"
+ PermissionSheetsGet Permission = "bb.sheets.get"
+ PermissionSheetsUpdate Permission = "bb.sheets.update"
+ PermissionSQLSelect Permission = "bb.sql.select"
+ PermissionSQLDdl Permission = "bb.sql.ddl"
+ PermissionSQLDml Permission = "bb.sql.dml"
+ PermissionSQLExplain Permission = "bb.sql.explain"
+ PermissionSQLInfo Permission = "bb.sql.info"
+ PermissionSQLAdmin Permission = "bb.sql.admin"
+ PermissionTaskRunsCreate Permission = "bb.taskRuns.create"
+ PermissionTaskRunsList Permission = "bb.taskRuns.list"
+ PermissionGroupsCreate Permission = "bb.groups.create"
+ PermissionGroupsDelete Permission = "bb.groups.delete"
+ PermissionGroupsGet Permission = "bb.groups.get"
+ PermissionGroupsList Permission = "bb.groups.list"
+ PermissionGroupsUpdate Permission = "bb.groups.update"
+ PermissionUsersCreate Permission = "bb.users.create"
+ PermissionUsersDelete Permission = "bb.users.delete"
+ PermissionUsersGet Permission = "bb.users.get"
+ PermissionUsersList Permission = "bb.users.list"
+ PermissionUsersUndelete Permission = "bb.users.undelete"
+ PermissionUsersUpdate Permission = "bb.users.update"
+ PermissionUsersUpdateEmail Permission = "bb.users.updateEmail"
+ PermissionWorksheetsGet Permission = "bb.worksheets.get"
+ PermissionWorksheetsManage Permission = "bb.worksheets.manage"
+ PermissionWorkspacesGetIamPolicy Permission = "bb.workspaces.getIamPolicy"
+ PermissionWorkspacesSetIamPolicy Permission = "bb.workspaces.setIamPolicy"
+)
+
+var allPermissions = func() []Permission {
+ var data struct {
+ Permissions []Permission `yaml:"permissions"`
+ }
+ if err := yaml.Unmarshal(permissionYAML, &data); err != nil {
+ panic("failed to load permissions from YAML: " + err.Error())
+ }
+ return data.Permissions
+}()
+
+var allPermissionsMap = func() map[Permission]bool {
+ m := make(map[Permission]bool)
+ for _, p := range allPermissions {
+ m[p] = true
+ }
+ return m
+}()
+
+func Exists(permissions ...string) bool {
+ for _, p := range permissions {
+ if !Exist(p) {
+ return false
+ }
+ }
+ return true
+}
+
+func Exist(permission string) bool {
+ return allPermissionsMap[permission]
+}
diff --git a/backend/component/iam/permission.yaml b/backend/common/permission/permission.yaml
similarity index 100%
rename from backend/component/iam/permission.yaml
rename to backend/common/permission/permission.yaml
diff --git a/backend/component/iam/acl.yaml b/backend/component/iam/acl.yaml
deleted file mode 100644
index 7e7fa7a2c8..0000000000
--- a/backend/component/iam/acl.yaml
+++ /dev/null
@@ -1,429 +0,0 @@
-roles:
- - name: roles/workspaceAdmin
- title: Workspace admin
- permissions:
- - bb.auditLogs.export
- - bb.auditLogs.search
- - bb.changelogs.get
- - bb.changelogs.list
- - bb.databaseCatalogs.get
- - bb.databaseCatalogs.update
- - bb.databaseGroups.create
- - bb.databaseGroups.delete
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databaseGroups.update
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.databases.sync
- - bb.databases.update
- - bb.identityProviders.create
- - bb.identityProviders.delete
- - bb.identityProviders.get
- - bb.identityProviders.update
- - bb.instances.create
- - bb.instances.delete
- - bb.instances.get
- - bb.instances.list
- - bb.instances.sync
- - bb.instances.undelete
- - bb.instances.update
- - bb.instanceRoles.get
- - bb.instanceRoles.list
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.create
- - bb.issues.get
- - bb.issues.list
- - bb.issues.update
- - bb.planCheckRuns.get
- - bb.planCheckRuns.run
- - bb.plans.create
- - bb.plans.get
- - bb.plans.list
- - bb.plans.update
- - bb.policies.create
- - bb.policies.delete
- - bb.policies.get
- - bb.policies.list
- - bb.policies.update
- - bb.projects.create
- - bb.projects.delete
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.projects.list
- - bb.projects.setIamPolicy
- - bb.projects.undelete
- - bb.projects.update
- - bb.releases.check
- - bb.releases.create
- - bb.releases.delete
- - bb.releases.get
- - bb.releases.list
- - bb.releases.undelete
- - bb.releases.update
- - bb.reviewConfigs.create
- - bb.reviewConfigs.delete
- - bb.reviewConfigs.get
- - bb.reviewConfigs.list
- - bb.reviewConfigs.update
- - bb.revisions.create
- - bb.revisions.delete
- - bb.revisions.get
- - bb.revisions.list
- - bb.roles.create
- - bb.roles.delete
- - bb.roles.list
- - bb.roles.get
- - bb.roles.update
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.settings.get
- - bb.settings.getEnvironment
- - bb.settings.getWorkspaceProfile
- - bb.settings.list
- - bb.settings.set
- - bb.settings.setEnvironment
- - bb.settings.setWorkspaceProfile
- - bb.sheets.create
- - bb.sheets.get
- - bb.sheets.update
- - bb.taskRuns.create
- - bb.taskRuns.list
- - bb.groups.create
- - bb.groups.delete
- - bb.groups.get
- - bb.groups.list
- - bb.groups.update
- - bb.sql.admin
- - bb.sql.ddl
- - bb.sql.dml
- - bb.sql.explain
- - bb.sql.info
- - bb.sql.select
- - bb.users.create
- - bb.users.delete
- - bb.users.get
- - bb.users.list
- - bb.users.undelete
- - bb.users.update
- - bb.users.updateEmail
- - bb.worksheets.get
- - bb.worksheets.manage
- - bb.workspaces.getIamPolicy
- - bb.workspaces.setIamPolicy
- - name: roles/workspaceDBA
- title: Workspace DBA
- permissions:
- - bb.auditLogs.export
- - bb.auditLogs.search
- - bb.changelogs.get
- - bb.changelogs.list
- - bb.databaseCatalogs.get
- - bb.databaseCatalogs.update
- - bb.databaseGroups.create
- - bb.databaseGroups.delete
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databaseGroups.update
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.databases.sync
- - bb.databases.update
- - bb.instances.create
- - bb.instances.delete
- - bb.instances.get
- - bb.instances.list
- - bb.instances.sync
- - bb.instances.undelete
- - bb.instances.update
- - bb.instanceRoles.get
- - bb.instanceRoles.list
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.create
- - bb.issues.get
- - bb.issues.list
- - bb.issues.update
- - bb.planCheckRuns.get
- - bb.planCheckRuns.run
- - bb.plans.create
- - bb.plans.get
- - bb.plans.list
- - bb.plans.update
- - bb.policies.create
- - bb.policies.delete
- - bb.policies.get
- - bb.policies.list
- - bb.policies.update
- - bb.projects.create
- - bb.projects.delete
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.projects.list
- - bb.projects.setIamPolicy
- - bb.projects.undelete
- - bb.projects.update
- - bb.releases.check
- - bb.releases.create
- - bb.releases.delete
- - bb.releases.get
- - bb.releases.list
- - bb.releases.undelete
- - bb.releases.update
- - bb.reviewConfigs.create
- - bb.reviewConfigs.delete
- - bb.reviewConfigs.get
- - bb.reviewConfigs.list
- - bb.reviewConfigs.update
- - bb.revisions.create
- - bb.revisions.delete
- - bb.revisions.get
- - bb.revisions.list
- - bb.roles.create
- - bb.roles.delete
- - bb.roles.list
- - bb.roles.get
- - bb.roles.update
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.settings.get
- - bb.settings.getEnvironment
- - bb.settings.getWorkspaceProfile
- - bb.settings.list
- - bb.settings.set
- - bb.settings.setEnvironment
- - bb.settings.setWorkspaceProfile
- - bb.sheets.create
- - bb.sheets.get
- - bb.sheets.update
- - bb.sql.admin
- - bb.sql.ddl
- - bb.sql.dml
- - bb.sql.explain
- - bb.sql.info
- - bb.sql.select
- - bb.users.get
- - bb.users.list
- - bb.taskRuns.create
- - bb.taskRuns.list
- - bb.groups.get
- - bb.groups.list
- - bb.worksheets.get
- - bb.worksheets.manage
- - bb.workspaces.getIamPolicy
- - name: roles/workspaceMember
- title: Workspace member
- permissions:
- - bb.instanceRoles.get
- - bb.instanceRoles.list
- - bb.policies.get
- - bb.policies.list
- - bb.reviewConfigs.get
- - bb.reviewConfigs.list
- - bb.roles.list
- - bb.roles.get
- - bb.settings.getEnvironment
- - bb.settings.getWorkspaceProfile
- - bb.groups.create
- - bb.groups.get
- - bb.groups.list
- - bb.users.get
- - bb.users.list
- - bb.workspaces.getIamPolicy
- - name: roles/projectOwner
- title: Project owner
- permissions:
- - bb.auditLogs.export
- - bb.auditLogs.search
- - bb.changelogs.get
- - bb.changelogs.list
- - bb.databaseCatalogs.get
- - bb.databaseCatalogs.update
- - bb.databaseGroups.create
- - bb.databaseGroups.delete
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databaseGroups.update
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.databases.sync
- - bb.databases.update
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.create
- - bb.issues.get
- - bb.issues.list
- - bb.issues.update
- - bb.planCheckRuns.get
- - bb.planCheckRuns.run
- - bb.plans.create
- - bb.plans.get
- - bb.plans.list
- - bb.plans.update
- - bb.policies.create
- - bb.policies.delete
- - bb.policies.get
- - bb.policies.list
- - bb.policies.update
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.projects.setIamPolicy
- - bb.projects.update
- - bb.releases.check
- - bb.releases.create
- - bb.releases.delete
- - bb.releases.get
- - bb.releases.list
- - bb.releases.undelete
- - bb.releases.update
- - bb.revisions.create
- - bb.revisions.delete
- - bb.revisions.get
- - bb.revisions.list
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.sheets.create
- - bb.sheets.get
- - bb.sheets.update
- - bb.sql.ddl
- - bb.sql.dml
- - bb.sql.explain
- - bb.sql.info
- - bb.sql.select
- - bb.users.get
- - bb.users.list
- - bb.taskRuns.list
- - bb.worksheets.get
- - name: roles/projectDeveloper
- title: Project developer
- permissions:
- - bb.auditLogs.search
- - bb.changelogs.get
- - bb.changelogs.list
- - bb.databaseCatalogs.get
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.databases.sync
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.create
- - bb.issues.get
- - bb.issues.list
- - bb.issues.update
- - bb.planCheckRuns.get
- - bb.planCheckRuns.run
- - bb.plans.create
- - bb.plans.get
- - bb.plans.list
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.releases.check
- - bb.releases.get
- - bb.releases.list
- - bb.revisions.get
- - bb.revisions.list
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.sheets.create
- - bb.sheets.get
- - bb.sheets.update
- - bb.taskRuns.list
- - name: roles/sqlEditorUser
- title: SQL Editor User
- permissions:
- - bb.databaseCatalogs.get
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.databases.sync
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.sql.ddl
- - bb.sql.dml
- - bb.sql.explain
- - bb.sql.info
- - bb.sql.select
- - bb.worksheets.get
- - name: roles/projectReleaser
- title: Project releaser
- permissions:
- - bb.databaseCatalogs.get
- - bb.changelogs.get
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databases.check
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.get
- - bb.issues.list
- - bb.planCheckRuns.get
- - bb.planCheckRuns.run
- - bb.plans.get
- - bb.plans.list
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.releases.get
- - bb.releases.list
- - bb.revisions.get
- - bb.revisions.list
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.sheets.get
- - bb.taskRuns.create
- - bb.taskRuns.list
- - name: roles/gitopsServiceAgent
- title: GitOps Service Agent
- permissions:
- - bb.plans.create
- - bb.plans.get
- - bb.releases.check
- - bb.releases.create
- - bb.releases.get
- - bb.rollouts.create
- - bb.rollouts.get
- - bb.rollouts.list
- - bb.taskRuns.create
- - bb.taskRuns.list
- - name: roles/projectViewer
- title: Project viewer
- permissions:
- - bb.databaseCatalogs.get
- - bb.databaseGroups.get
- - bb.databaseGroups.list
- - bb.databases.get
- - bb.databases.getSchema
- - bb.databases.list
- - bb.issueComments.create
- - bb.issueComments.list
- - bb.issueComments.update
- - bb.issues.create
- - bb.projects.get
- - bb.projects.getIamPolicy
- - bb.issues.get
diff --git a/backend/component/iam/manager.go b/backend/component/iam/manager.go
index 37998cfb9e..3a9c89713d 100644
--- a/backend/component/iam/manager.go
+++ b/backend/component/iam/manager.go
@@ -2,11 +2,9 @@ package iam
import (
"context"
- _ "embed"
"strings"
"github.com/pkg/errors"
- "gopkg.in/yaml.v3"
"github.com/bytebase/bytebase/backend/common"
"github.com/bytebase/bytebase/backend/enterprise"
@@ -15,38 +13,20 @@ import (
"github.com/bytebase/bytebase/backend/utils"
)
-//go:embed acl.yaml
-var aclYaml []byte
-
-type acl struct {
- Roles []struct {
- Name string `yaml:"name"`
- Title string `yaml:"title"`
- Permissions []string `yaml:"permissions"`
- } `yaml:"roles"`
-}
-
type Manager struct {
// rolePermissions is a map from role to permissions. Key is "roles/{role}".
rolePermissions map[string]map[Permission]bool
groupMembers map[string]map[string]bool
// member - groups mapping
- memberGroups map[string][]string
- PredefinedRoles []*store.RoleMessage
- store *store.Store
- licenseService *enterprise.LicenseService
+ memberGroups map[string][]string
+ store *store.Store
+ licenseService *enterprise.LicenseService
}
func NewManager(store *store.Store, licenseService *enterprise.LicenseService) (*Manager, error) {
- predefinedRoles, err := loadPredefinedRoles()
- if err != nil {
- return nil, err
- }
-
m := &Manager{
- PredefinedRoles: predefinedRoles,
- store: store,
- licenseService: licenseService,
+ store: store,
+ licenseService: licenseService,
}
return m, nil
}
@@ -95,7 +75,6 @@ func (m *Manager) ReloadCache(ctx context.Context) error {
if err != nil {
return err
}
- roles = append(roles, m.PredefinedRoles...)
rolePermissions := make(map[string]map[Permission]bool)
for _, role := range roles {
@@ -169,28 +148,3 @@ func check(user *store.UserMessage, p Permission, policy *storepb.IamPolicy, rol
}
return false
}
-
-func loadPredefinedRoles() ([]*store.RoleMessage, error) {
- predefinedACL := new(acl)
- if err := yaml.Unmarshal(aclYaml, predefinedACL); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal predefined acl")
- }
- var roles []*store.RoleMessage
- for _, role := range predefinedACL.Roles {
- resourceID, err := common.GetRoleID(role.Name)
- if err != nil {
- return nil, err
- }
- permissions := make(map[string]bool)
- for _, p := range role.Permissions {
- permissions[p] = true
- }
- roles = append(roles, &store.RoleMessage{
- ResourceID: resourceID,
- Name: role.Title,
- Description: "",
- Permissions: permissions,
- })
- }
- return roles, nil
-}
diff --git a/backend/component/iam/manager_test.go b/backend/component/iam/manager_test.go
index b89f908265..28d36d9786 100644
--- a/backend/component/iam/manager_test.go
+++ b/backend/component/iam/manager_test.go
@@ -16,10 +16,8 @@ func TestCheck(t *testing.T) {
}
- roles, err := loadPredefinedRoles()
- require.NoError(t, err)
rolePermissions := make(map[string]map[Permission]bool)
- for _, role := range roles {
+ for _, role := range store.PredefinedRoles {
rolePermissions[common.FormatRole(role.ResourceID)] = role.Permissions
}
diff --git a/backend/component/iam/permission.go b/backend/component/iam/permission.go
index 0ea176fd13..e957f6aa44 100644
--- a/backend/component/iam/permission.go
+++ b/backend/component/iam/permission.go
@@ -1,161 +1,130 @@
package iam
-import (
- _ "embed"
+import "github.com/bytebase/bytebase/backend/common/permission"
- "gopkg.in/yaml.v3"
-)
-
-//go:embed permission.yaml
-var permissionYAML []byte
-
-type Permission = string
+// Re-export Permission type from shared package.
+type Permission = permission.Permission
+// Re-export all permission constants.
const (
- PermissionAuditLogsExport Permission = "bb.auditLogs.export"
- PermissionAuditLogsSearch Permission = "bb.auditLogs.search"
- PermissionChangelogsGet Permission = "bb.changelogs.get"
- PermissionChangelogsList Permission = "bb.changelogs.list"
- PermissionDatabaseCatalogsGet Permission = "bb.databaseCatalogs.get"
- PermissionDatabaseCatalogsUpdate Permission = "bb.databaseCatalogs.update"
- PermissionDatabaseGroupsCreate Permission = "bb.databaseGroups.create"
- PermissionDatabaseGroupsDelete Permission = "bb.databaseGroups.delete"
- PermissionDatabaseGroupsGet Permission = "bb.databaseGroups.get"
- PermissionDatabaseGroupsList Permission = "bb.databaseGroups.list"
- PermissionDatabaseGroupsUpdate Permission = "bb.databaseGroups.update"
- PermissionDatabasesCheck Permission = "bb.databases.check"
- PermissionDatabasesGet Permission = "bb.databases.get"
- PermissionDatabasesGetSchema Permission = "bb.databases.getSchema"
- PermissionDatabasesList Permission = "bb.databases.list"
- PermissionDatabasesSync Permission = "bb.databases.sync"
- PermissionDatabasesUpdate Permission = "bb.databases.update"
- PermissionIdentityProvidersCreate Permission = "bb.identityProviders.create"
- PermissionIdentityProvidersDelete Permission = "bb.identityProviders.delete"
- PermissionIdentityProvidersGet Permission = "bb.identityProviders.get"
- PermissionIdentityProvidersUpdate Permission = "bb.identityProviders.update"
- PermissionInstancesCreate Permission = "bb.instances.create"
- PermissionInstancesDelete Permission = "bb.instances.delete"
- PermissionInstancesGet Permission = "bb.instances.get"
- PermissionInstancesList Permission = "bb.instances.list"
- PermissionInstancesSync Permission = "bb.instances.sync"
- PermissionInstancesUndelete Permission = "bb.instances.undelete"
- PermissionInstancesUpdate Permission = "bb.instances.update"
- PermissionInstanceRolesGet Permission = "bb.instanceRoles.get"
- PermissionInstanceRolesList Permission = "bb.instanceRoles.list"
- PermissionIssueCommentsCreate Permission = "bb.issueComments.create"
- PermissionIssueCommentsList Permission = "bb.issueComments.list"
- PermissionIssueCommentsUpdate Permission = "bb.issueComments.update"
- PermissionIssuesCreate Permission = "bb.issues.create"
- PermissionIssuesGet Permission = "bb.issues.get"
- PermissionIssuesList Permission = "bb.issues.list"
- PermissionIssuesUpdate Permission = "bb.issues.update"
- PermissionPlanCheckRunsGet Permission = "bb.planCheckRuns.get"
- PermissionPlanCheckRunsRun Permission = "bb.planCheckRuns.run"
- PermissionPlansCreate Permission = "bb.plans.create"
- PermissionPlansGet Permission = "bb.plans.get"
- PermissionPlansList Permission = "bb.plans.list"
- PermissionPlansUpdate Permission = "bb.plans.update"
- PermissionPoliciesCreate Permission = "bb.policies.create"
- PermissionPoliciesDelete Permission = "bb.policies.delete"
- PermissionPoliciesGet Permission = "bb.policies.get"
- PermissionPoliciesList Permission = "bb.policies.list"
- PermissionPoliciesUpdate Permission = "bb.policies.update"
- PermissionProjectsCreate Permission = "bb.projects.create"
- PermissionProjectsDelete Permission = "bb.projects.delete"
- PermissionProjectsGet Permission = "bb.projects.get"
- PermissionProjectsGetIAMPolicy Permission = "bb.projects.getIamPolicy"
- PermissionProjectsList Permission = "bb.projects.list"
- PermissionProjectsSetIAMPolicy Permission = "bb.projects.setIamPolicy"
- PermissionProjectsUndelete Permission = "bb.projects.undelete"
- PermissionProjectsUpdate Permission = "bb.projects.update"
- PermissionReleasesCheck Permission = "bb.releases.check"
- PermissionReleasesCreate Permission = "bb.releases.create"
- PermissionReleasesDelete Permission = "bb.releases.delete"
- PermissionReleasesGet Permission = "bb.releases.get"
- PermissionReleasesList Permission = "bb.releases.list"
- PermissionReleasesUndelete Permission = "bb.releases.undelete"
- PermissionReleasesUpdate Permission = "bb.releases.update"
- PermissionReviewConfigsCreate Permission = "bb.reviewConfigs.create"
- PermissionReviewConfigsDelete Permission = "bb.reviewConfigs.delete"
- PermissionReviewConfigsGet Permission = "bb.reviewConfigs.get"
- PermissionReviewConfigsList Permission = "bb.reviewConfigs.list"
- PermissionReviewConfigsUpdate Permission = "bb.reviewConfigs.update"
- PermissionRevisionsCreate Permission = "bb.revisions.create"
- PermissionRevisionsDelete Permission = "bb.revisions.delete"
- PermissionRevisionsGet Permission = "bb.revisions.get"
- PermissionRevisionsList Permission = "bb.revisions.list"
- PermissionRolesCreate Permission = "bb.roles.create"
- PermissionRolesDelete Permission = "bb.roles.delete"
- PermissionRolesList Permission = "bb.roles.list"
- PermissionRolesGet Permission = "bb.roles.get"
- PermissionRolesUpdate Permission = "bb.roles.update"
- PermissionRolloutsCreate Permission = "bb.rollouts.create"
- PermissionRolloutsGet Permission = "bb.rollouts.get"
- PermissionRolloutsList Permission = "bb.rollouts.list"
- PermissionSettingsGet Permission = "bb.settings.get"
- PermissionSettingsList Permission = "bb.settings.list"
- PermissionSettingsSet Permission = "bb.settings.set"
- PermissionEnvironmentSettingsGet Permission = "bb.settings.getEnvironment"
- PermissionEnvironmentSettingsSet Permission = "bb.settings.setEnvironment"
- PermissionWorkspaceProfileSettingsGet Permission = "bb.settings.getWorkspaceProfile"
- PermissionWorkspaceProfileSettingsSet Permission = "bb.settings.setWorkspaceProfile"
- PermissionSheetsCreate Permission = "bb.sheets.create"
- PermissionSheetsGet Permission = "bb.sheets.get"
- PermissionSheetsUpdate Permission = "bb.sheets.update"
- PermissionSQLSelect Permission = "bb.sql.select"
- PermissionSQLDdl Permission = "bb.sql.ddl"
- PermissionSQLDml Permission = "bb.sql.dml"
- PermissionSQLExplain Permission = "bb.sql.explain"
- PermissionSQLInfo Permission = "bb.sql.info"
- PermissionSQLAdmin Permission = "bb.sql.admin"
- PermissionTaskRunsCreate Permission = "bb.taskRuns.create"
- PermissionTaskRunsList Permission = "bb.taskRuns.list"
- PermissionGroupsCreate Permission = "bb.groups.create"
- PermissionGroupsDelete Permission = "bb.groups.delete"
- PermissionGroupsGet Permission = "bb.groups.get"
- PermissionGroupsList Permission = "bb.groups.list"
- PermissionGroupsUpdate Permission = "bb.groups.update"
- PermissionUsersCreate Permission = "bb.users.create"
- PermissionUsersDelete Permission = "bb.users.delete"
- PermissionUsersGet Permission = "bb.users.get"
- PermissionUsersList Permission = "bb.users.list"
- PermissionUsersUndelete Permission = "bb.users.undelete"
- PermissionUsersUpdate Permission = "bb.users.update"
- PermissionUsersUpdateEmail Permission = "bb.users.updateEmail"
- PermissionWorksheetsGet Permission = "bb.worksheets.get"
- PermissionWorksheetsManage Permission = "bb.worksheets.manage"
- PermissionWorkspacesGetIamPolicy Permission = "bb.workspaces.getIamPolicy"
- PermissionWorkspacesSetIamPolicy Permission = "bb.workspaces.setIamPolicy"
+ PermissionAuditLogsExport = permission.PermissionAuditLogsExport
+ PermissionAuditLogsSearch = permission.PermissionAuditLogsSearch
+ PermissionChangelogsGet = permission.PermissionChangelogsGet
+ PermissionChangelogsList = permission.PermissionChangelogsList
+ PermissionDatabaseCatalogsGet = permission.PermissionDatabaseCatalogsGet
+ PermissionDatabaseCatalogsUpdate = permission.PermissionDatabaseCatalogsUpdate
+ PermissionDatabaseGroupsCreate = permission.PermissionDatabaseGroupsCreate
+ PermissionDatabaseGroupsDelete = permission.PermissionDatabaseGroupsDelete
+ PermissionDatabaseGroupsGet = permission.PermissionDatabaseGroupsGet
+ PermissionDatabaseGroupsList = permission.PermissionDatabaseGroupsList
+ PermissionDatabaseGroupsUpdate = permission.PermissionDatabaseGroupsUpdate
+ PermissionDatabasesCheck = permission.PermissionDatabasesCheck
+ PermissionDatabasesGet = permission.PermissionDatabasesGet
+ PermissionDatabasesGetSchema = permission.PermissionDatabasesGetSchema
+ PermissionDatabasesList = permission.PermissionDatabasesList
+ PermissionDatabasesSync = permission.PermissionDatabasesSync
+ PermissionDatabasesUpdate = permission.PermissionDatabasesUpdate
+ PermissionIdentityProvidersCreate = permission.PermissionIdentityProvidersCreate
+ PermissionIdentityProvidersDelete = permission.PermissionIdentityProvidersDelete
+ PermissionIdentityProvidersGet = permission.PermissionIdentityProvidersGet
+ PermissionIdentityProvidersUpdate = permission.PermissionIdentityProvidersUpdate
+ PermissionInstancesCreate = permission.PermissionInstancesCreate
+ PermissionInstancesDelete = permission.PermissionInstancesDelete
+ PermissionInstancesGet = permission.PermissionInstancesGet
+ PermissionInstancesList = permission.PermissionInstancesList
+ PermissionInstancesSync = permission.PermissionInstancesSync
+ PermissionInstancesUndelete = permission.PermissionInstancesUndelete
+ PermissionInstancesUpdate = permission.PermissionInstancesUpdate
+ PermissionInstanceRolesGet = permission.PermissionInstanceRolesGet
+ PermissionInstanceRolesList = permission.PermissionInstanceRolesList
+ PermissionIssueCommentsCreate = permission.PermissionIssueCommentsCreate
+ PermissionIssueCommentsList = permission.PermissionIssueCommentsList
+ PermissionIssueCommentsUpdate = permission.PermissionIssueCommentsUpdate
+ PermissionIssuesCreate = permission.PermissionIssuesCreate
+ PermissionIssuesGet = permission.PermissionIssuesGet
+ PermissionIssuesList = permission.PermissionIssuesList
+ PermissionIssuesUpdate = permission.PermissionIssuesUpdate
+ PermissionPlanCheckRunsGet = permission.PermissionPlanCheckRunsGet
+ PermissionPlanCheckRunsRun = permission.PermissionPlanCheckRunsRun
+ PermissionPlansCreate = permission.PermissionPlansCreate
+ PermissionPlansGet = permission.PermissionPlansGet
+ PermissionPlansList = permission.PermissionPlansList
+ PermissionPlansUpdate = permission.PermissionPlansUpdate
+ PermissionPoliciesCreate = permission.PermissionPoliciesCreate
+ PermissionPoliciesDelete = permission.PermissionPoliciesDelete
+ PermissionPoliciesGet = permission.PermissionPoliciesGet
+ PermissionPoliciesList = permission.PermissionPoliciesList
+ PermissionPoliciesUpdate = permission.PermissionPoliciesUpdate
+ PermissionProjectsCreate = permission.PermissionProjectsCreate
+ PermissionProjectsDelete = permission.PermissionProjectsDelete
+ PermissionProjectsGet = permission.PermissionProjectsGet
+ PermissionProjectsGetIAMPolicy = permission.PermissionProjectsGetIAMPolicy
+ PermissionProjectsList = permission.PermissionProjectsList
+ PermissionProjectsSetIAMPolicy = permission.PermissionProjectsSetIAMPolicy
+ PermissionProjectsUndelete = permission.PermissionProjectsUndelete
+ PermissionProjectsUpdate = permission.PermissionProjectsUpdate
+ PermissionReleasesCheck = permission.PermissionReleasesCheck
+ PermissionReleasesCreate = permission.PermissionReleasesCreate
+ PermissionReleasesDelete = permission.PermissionReleasesDelete
+ PermissionReleasesGet = permission.PermissionReleasesGet
+ PermissionReleasesList = permission.PermissionReleasesList
+ PermissionReleasesUndelete = permission.PermissionReleasesUndelete
+ PermissionReleasesUpdate = permission.PermissionReleasesUpdate
+ PermissionReviewConfigsCreate = permission.PermissionReviewConfigsCreate
+ PermissionReviewConfigsDelete = permission.PermissionReviewConfigsDelete
+ PermissionReviewConfigsGet = permission.PermissionReviewConfigsGet
+ PermissionReviewConfigsList = permission.PermissionReviewConfigsList
+ PermissionReviewConfigsUpdate = permission.PermissionReviewConfigsUpdate
+ PermissionRevisionsCreate = permission.PermissionRevisionsCreate
+ PermissionRevisionsDelete = permission.PermissionRevisionsDelete
+ PermissionRevisionsGet = permission.PermissionRevisionsGet
+ PermissionRevisionsList = permission.PermissionRevisionsList
+ PermissionRolesCreate = permission.PermissionRolesCreate
+ PermissionRolesDelete = permission.PermissionRolesDelete
+ PermissionRolesList = permission.PermissionRolesList
+ PermissionRolesGet = permission.PermissionRolesGet
+ PermissionRolesUpdate = permission.PermissionRolesUpdate
+ PermissionRolloutsCreate = permission.PermissionRolloutsCreate
+ PermissionRolloutsGet = permission.PermissionRolloutsGet
+ PermissionRolloutsList = permission.PermissionRolloutsList
+ PermissionSettingsGet = permission.PermissionSettingsGet
+ PermissionSettingsList = permission.PermissionSettingsList
+ PermissionSettingsSet = permission.PermissionSettingsSet
+ PermissionEnvironmentSettingsGet = permission.PermissionEnvironmentSettingsGet
+ PermissionEnvironmentSettingsSet = permission.PermissionEnvironmentSettingsSet
+ PermissionWorkspaceProfileSettingsGet = permission.PermissionWorkspaceProfileSettingsGet
+ PermissionWorkspaceProfileSettingsSet = permission.PermissionWorkspaceProfileSettingsSet
+ PermissionSheetsCreate = permission.PermissionSheetsCreate
+ PermissionSheetsGet = permission.PermissionSheetsGet
+ PermissionSheetsUpdate = permission.PermissionSheetsUpdate
+ PermissionSQLSelect = permission.PermissionSQLSelect
+ PermissionSQLDdl = permission.PermissionSQLDdl
+ PermissionSQLDml = permission.PermissionSQLDml
+ PermissionSQLExplain = permission.PermissionSQLExplain
+ PermissionSQLInfo = permission.PermissionSQLInfo
+ PermissionSQLAdmin = permission.PermissionSQLAdmin
+ PermissionTaskRunsCreate = permission.PermissionTaskRunsCreate
+ PermissionTaskRunsList = permission.PermissionTaskRunsList
+ PermissionGroupsCreate = permission.PermissionGroupsCreate
+ PermissionGroupsDelete = permission.PermissionGroupsDelete
+ PermissionGroupsGet = permission.PermissionGroupsGet
+ PermissionGroupsList = permission.PermissionGroupsList
+ PermissionGroupsUpdate = permission.PermissionGroupsUpdate
+ PermissionUsersCreate = permission.PermissionUsersCreate
+ PermissionUsersDelete = permission.PermissionUsersDelete
+ PermissionUsersGet = permission.PermissionUsersGet
+ PermissionUsersList = permission.PermissionUsersList
+ PermissionUsersUndelete = permission.PermissionUsersUndelete
+ PermissionUsersUpdate = permission.PermissionUsersUpdate
+ PermissionUsersUpdateEmail = permission.PermissionUsersUpdateEmail
+ PermissionWorksheetsGet = permission.PermissionWorksheetsGet
+ PermissionWorksheetsManage = permission.PermissionWorksheetsManage
+ PermissionWorkspacesGetIamPolicy = permission.PermissionWorkspacesGetIamPolicy
+ PermissionWorkspacesSetIamPolicy = permission.PermissionWorkspacesSetIamPolicy
)
-var allPermissions = func() []Permission {
- var data struct {
- Permissions []Permission `yaml:"permissions"`
- }
- if err := yaml.Unmarshal(permissionYAML, &data); err != nil {
- panic("failed to load permissions from YAML: " + err.Error())
- }
- return data.Permissions
-}()
-
-var allPermissionsMap = func() map[Permission]bool {
- m := make(map[Permission]bool)
- for _, p := range allPermissions {
- m[p] = true
- }
- return m
-}()
-
-func PermissionsExist(permissions ...string) bool {
- for _, p := range permissions {
- if !PermissionExist(p) {
- return false
- }
- }
- return true
-}
-
-// PermissionExist checks if a single permission exists in permission.yaml
-func PermissionExist(permission string) bool {
- return allPermissionsMap[permission]
-}
+// Re-export functions. Note: shared package uses Exist/Exists (without Permission prefix).
+var (
+ PermissionsExist = permission.Exists
+ PermissionExist = permission.Exist
+)
diff --git a/backend/component/iam/permission_test.go b/backend/component/iam/permission_test.go
deleted file mode 100644
index d0f3aa8920..0000000000
--- a/backend/component/iam/permission_test.go
+++ /dev/null
@@ -1,45 +0,0 @@
-package iam
-
-import (
- "slices"
- "testing"
-
- _ "embed"
-
- "github.com/stretchr/testify/require"
- "gopkg.in/yaml.v3"
-)
-
-// Test that every permission in the yaml is also defined in permission.go as a constant.
-func TestPermissionExists(t *testing.T) {
- a := require.New(t)
-
- predefinedRoles, err := loadPredefinedRoles()
- a.NoError(err)
-
- for _, role := range predefinedRoles {
- for p := range role.Permissions {
- exist := PermissionsExist(p)
- a.True(exist, "permission %s is not defined as a constant", p)
- }
- }
-}
-
-//go:embed permission.yaml
-var permissionYaml []byte
-
-// Test that permissions are equal in permission.yaml and allPermissions in permission.go.
-func TestPermissionEquals(t *testing.T) {
- a := require.New(t)
-
- var permissions struct {
- Permissions []string `yaml:"permissions"`
- }
-
- a.NoError(yaml.Unmarshal(permissionYaml, &permissions))
-
- slices.Sort(permissions.Permissions)
- slices.Sort(allPermissions)
-
- a.Equal(permissions.Permissions, allPermissions)
-}
diff --git a/backend/store/predefined_roles.go b/backend/store/predefined_roles.go
new file mode 100644
index 0000000000..5136333644
--- /dev/null
+++ b/backend/store/predefined_roles.go
@@ -0,0 +1,511 @@
+package store
+
+import "github.com/bytebase/bytebase/backend/common/permission"
+
+// Predefined role IDs.
+const (
+ WorkspaceAdminRole = "workspaceAdmin"
+ WorkspaceDBARole = "workspaceDBA"
+ WorkspaceMemberRole = "workspaceMember"
+ ProjectOwnerRole = "projectOwner"
+ ProjectDeveloperRole = "projectDeveloper"
+ SQLEditorUserRole = "sqlEditorUser"
+ ProjectReleaserRole = "projectReleaser"
+ GitOpsServiceAgentRole = "gitopsServiceAgent"
+ ProjectViewerRole = "projectViewer"
+)
+
+func permissionSet(perms ...permission.Permission) map[string]bool {
+ m := make(map[string]bool, len(perms))
+ for _, p := range perms {
+ m[p] = true
+ }
+ return m
+}
+
+// PredefinedRoles contains all predefined roles.
+var PredefinedRoles = []*RoleMessage{
+ {
+ ResourceID: WorkspaceAdminRole,
+ Name: "Workspace admin",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionIdentityProvidersCreate,
+ permission.PermissionIdentityProvidersDelete,
+ permission.PermissionIdentityProvidersGet,
+ permission.PermissionIdentityProvidersUpdate,
+ permission.PermissionInstancesCreate,
+ permission.PermissionInstancesDelete,
+ permission.PermissionInstancesGet,
+ permission.PermissionInstancesList,
+ permission.PermissionInstancesSync,
+ permission.PermissionInstancesUndelete,
+ permission.PermissionInstancesUpdate,
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsCreate,
+ permission.PermissionProjectsDelete,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsList,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUndelete,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionReviewConfigsCreate,
+ permission.PermissionReviewConfigsDelete,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionReviewConfigsUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolesCreate,
+ permission.PermissionRolesDelete,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionRolesUpdate,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSettingsGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionSettingsList,
+ permission.PermissionSettingsSet,
+ permission.PermissionEnvironmentSettingsSet,
+ permission.PermissionWorkspaceProfileSettingsSet,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ permission.PermissionGroupsCreate,
+ permission.PermissionGroupsDelete,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionGroupsUpdate,
+ permission.PermissionSQLAdmin,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersCreate,
+ permission.PermissionUsersDelete,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionUsersUndelete,
+ permission.PermissionUsersUpdate,
+ permission.PermissionUsersUpdateEmail,
+ permission.PermissionWorksheetsGet,
+ permission.PermissionWorksheetsManage,
+ permission.PermissionWorkspacesGetIamPolicy,
+ permission.PermissionWorkspacesSetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: WorkspaceDBARole,
+ Name: "Workspace DBA",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionInstancesCreate,
+ permission.PermissionInstancesDelete,
+ permission.PermissionInstancesGet,
+ permission.PermissionInstancesList,
+ permission.PermissionInstancesSync,
+ permission.PermissionInstancesUndelete,
+ permission.PermissionInstancesUpdate,
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsCreate,
+ permission.PermissionProjectsDelete,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsList,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUndelete,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionReviewConfigsCreate,
+ permission.PermissionReviewConfigsDelete,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionReviewConfigsUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolesCreate,
+ permission.PermissionRolesDelete,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionRolesUpdate,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSettingsGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionSettingsList,
+ permission.PermissionSettingsSet,
+ permission.PermissionEnvironmentSettingsSet,
+ permission.PermissionWorkspaceProfileSettingsSet,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionSQLAdmin,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionWorksheetsGet,
+ permission.PermissionWorksheetsManage,
+ permission.PermissionWorkspacesGetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: WorkspaceMemberRole,
+ Name: "Workspace member",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionGroupsCreate,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionWorkspacesGetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: ProjectOwnerRole,
+ Name: "Project owner",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionTaskRunsList,
+ permission.PermissionWorksheetsGet,
+ ),
+ },
+ {
+ ResourceID: ProjectDeveloperRole,
+ Name: "Project developer",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: SQLEditorUserRole,
+ Name: "SQL Editor User",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionWorksheetsGet,
+ ),
+ },
+ {
+ ResourceID: ProjectReleaserRole,
+ Name: "Project releaser",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionChangelogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsGet,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: GitOpsServiceAgentRole,
+ Name: "GitOps Service Agent",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesGet,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: ProjectViewerRole,
+ Name: "Project viewer",
+ Predefined: true,
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionIssuesGet,
+ ),
+ },
+}
+
+var predefinedRolesMap = func() map[string]*RoleMessage {
+ m := make(map[string]*RoleMessage, len(PredefinedRoles))
+ for _, role := range PredefinedRoles {
+ m[role.ResourceID] = role
+ }
+ return m
+}()
+
+// GetPredefinedRole returns the predefined role by ID.
+func GetPredefinedRole(roleID string) *RoleMessage {
+ return predefinedRolesMap[roleID]
+}
+
+// IsPredefinedRole returns true if the role ID is a predefined role.
+func IsPredefinedRole(roleID string) bool {
+ _, ok := predefinedRolesMap[roleID]
+ return ok
+}
diff --git a/backend/store/predefined_roles_test.go b/backend/store/predefined_roles_test.go
new file mode 100644
index 0000000000..fb7ff9e953
--- /dev/null
+++ b/backend/store/predefined_roles_test.go
@@ -0,0 +1,21 @@
+package store
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/common/permission"
+)
+
+// Test that every permission in predefined roles is also defined in permission.yaml.
+func TestPredefinedRolesPermissionsExist(t *testing.T) {
+ a := require.New(t)
+
+ for _, role := range PredefinedRoles {
+ for p := range role.Permissions {
+ exist := permission.Exists(p)
+ a.True(exist, "permission %s is not defined in permission.yaml", p)
+ }
+ }
+}
diff --git a/backend/store/role.go b/backend/store/role.go
index d27a8c9dec..70b64ac3b3 100644
--- a/backend/store/role.go
+++ b/backend/store/role.go
@@ -17,6 +17,7 @@ type RoleMessage struct {
Name string
Description string
Permissions map[string]bool
+ Predefined bool
}
// UpdateRoleMessage is the message for updating roles.
@@ -132,6 +133,13 @@ func (s *Store) GetRole(ctx context.Context, find *FindRoleMessage) (*RoleMessag
// ListRoles returns a list of roles.
func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMessage, error) {
+ // If looking for a specific role, check predefined first
+ if v := find.ResourceID; v != nil {
+ if role := GetPredefinedRole(*v); role != nil {
+ return []*RoleMessage{role}, nil
+ }
+ }
+
q := qb.Q().Space(`
SELECT
resource_id, name, description, permissions
@@ -178,6 +186,11 @@ func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMe
return nil, err
}
+ // Append predefined roles when listing all roles
+ if find.ResourceID == nil {
+ roles = append(roles, PredefinedRoles...)
+ }
+
return roles, nil
}
diff --git a/docs/plans/2026-01-12-unify-predefined-roles-design.md b/docs/plans/2026-01-12-unify-predefined-roles-design.md
new file mode 100644
index 0000000000..1410aaa371
--- /dev/null
+++ b/docs/plans/2026-01-12-unify-predefined-roles-design.md
@@ -0,0 +1,111 @@
+# Unify Predefined Roles in Store Package
+
+## Goal
+
+Move predefined role definitions from IAM manager to store package so that:
+1. `store.ListRoles()` returns all roles (custom + predefined)
+2. IAM manager focuses purely on permission checking
+
+## Dependency Graph (unchanged)
+
+```
+v1 service → store
+v1 service → iam manager
+iam manager → store
+iam manager → common/permission
+store → common/permission
+```
+
+## File Changes
+
+### New Package: `backend/common/permission/`
+
+| Action | From | To |
+|--------|------|-----|
+| Move | `backend/component/iam/permission.go` | `backend/common/permission/permission.go` |
+| Move | `backend/component/iam/permission.yaml` | `backend/common/permission/permission.yaml` |
+
+### Store Package
+
+| Action | File | Notes |
+|--------|------|-------|
+| Create | `backend/store/predefined_roles.go` | Define 9 roles using permission constants |
+| Update | `backend/store/role.go` | `ListRoles()` appends predefined roles |
+
+### IAM Manager
+
+| Action | File | Notes |
+|--------|------|-------|
+| Update | `backend/component/iam/manager.go` | Remove `PredefinedRoles` field, `loadPredefinedRoles()`, YAML embedding |
+| Delete | `backend/component/iam/acl.yaml` | Replaced by Go code |
+
+### API Service
+
+| Action | File | Notes |
+|--------|------|-------|
+| Update | `backend/api/v1/role_service.go` | Remove manual merge with predefined roles |
+
+### Frontend
+
+| Action | File | Notes |
+|--------|------|-------|
+| Update | `frontend/scripts/copy_config_files.sh` | New path: `../backend/common/permission/permission.yaml` |
+
+## Implementation Details
+
+### `store/predefined_roles.go`
+
+```go
+package store
+
+import "github.com/bytebase/bytebase/backend/common/permission"
+
+var predefinedRoles = []*RoleMessage{
+ {
+ ResourceID: "workspaceAdmin",
+ Name: "Workspace admin",
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionInstancesCreate,
+ // ... all permissions
+ ),
+ },
+ // ... 8 more roles
+}
+
+func permissionSet(perms ...permission.Permission) map[string]bool {
+ m := make(map[string]bool, len(perms))
+ for _, p := range perms {
+ m[string(p)] = true
+ }
+ return m
+}
+```
+
+### `store/role.go` - ListRoles
+
+```go
+func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMessage, error) {
+ // existing DB query for custom roles
+ roles := // from DB
+
+ // Append predefined roles
+ roles = append(roles, predefinedRoles...)
+ return roles, nil
+}
+```
+
+### `iam/manager.go` - Changes
+
+Remove:
+- `PredefinedRoles` field from `Manager` struct
+- `loadPredefinedRoles()` function
+- `//go:embed acl.yaml` directive
+
+Update `ReloadCache()` to use `ListRoles()` directly without appending predefined.
+
+## Migration
+
+- No database migration needed
+- No breaking API changes
+- Update tests that reference `loadPredefinedRoles()` or `PredefinedRoles` field
diff --git a/docs/plans/2026-01-12-unify-predefined-roles.md b/docs/plans/2026-01-12-unify-predefined-roles.md
new file mode 100644
index 0000000000..5e9be9ab35
--- /dev/null
+++ b/docs/plans/2026-01-12-unify-predefined-roles.md
@@ -0,0 +1,1364 @@
+# Unify Predefined Roles Implementation Plan
+
+> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
+
+**Goal:** Move predefined role definitions from IAM manager to store package, with permissions in a shared package.
+
+**Architecture:** Create `backend/common/permission/` for shared permission types. Define predefined roles as Go code in `backend/store/predefined_roles.go`. Store's `ListRoles()` returns both custom and predefined roles.
+
+**Tech Stack:** Go, no external dependencies
+
+---
+
+## Task 1: Create shared permission package
+
+**Files:**
+- Create: `backend/common/permission/permission.go`
+- Create: `backend/common/permission/permission.yaml` (move from iam)
+
+**Step 1: Create permission package**
+
+```go
+// backend/common/permission/permission.go
+package permission
+
+import (
+ _ "embed"
+
+ "gopkg.in/yaml.v3"
+)
+
+//go:embed permission.yaml
+var permissionYAML []byte
+
+type Permission = string
+
+const (
+ PermissionAuditLogsExport Permission = "bb.auditLogs.export"
+ PermissionAuditLogsSearch Permission = "bb.auditLogs.search"
+ PermissionChangelogsGet Permission = "bb.changelogs.get"
+ PermissionChangelogsList Permission = "bb.changelogs.list"
+ PermissionDatabaseCatalogsGet Permission = "bb.databaseCatalogs.get"
+ PermissionDatabaseCatalogsUpdate Permission = "bb.databaseCatalogs.update"
+ PermissionDatabaseGroupsCreate Permission = "bb.databaseGroups.create"
+ PermissionDatabaseGroupsDelete Permission = "bb.databaseGroups.delete"
+ PermissionDatabaseGroupsGet Permission = "bb.databaseGroups.get"
+ PermissionDatabaseGroupsList Permission = "bb.databaseGroups.list"
+ PermissionDatabaseGroupsUpdate Permission = "bb.databaseGroups.update"
+ PermissionDatabasesCheck Permission = "bb.databases.check"
+ PermissionDatabasesGet Permission = "bb.databases.get"
+ PermissionDatabasesGetSchema Permission = "bb.databases.getSchema"
+ PermissionDatabasesList Permission = "bb.databases.list"
+ PermissionDatabasesSync Permission = "bb.databases.sync"
+ PermissionDatabasesUpdate Permission = "bb.databases.update"
+ PermissionIdentityProvidersCreate Permission = "bb.identityProviders.create"
+ PermissionIdentityProvidersDelete Permission = "bb.identityProviders.delete"
+ PermissionIdentityProvidersGet Permission = "bb.identityProviders.get"
+ PermissionIdentityProvidersUpdate Permission = "bb.identityProviders.update"
+ PermissionInstancesCreate Permission = "bb.instances.create"
+ PermissionInstancesDelete Permission = "bb.instances.delete"
+ PermissionInstancesGet Permission = "bb.instances.get"
+ PermissionInstancesList Permission = "bb.instances.list"
+ PermissionInstancesSync Permission = "bb.instances.sync"
+ PermissionInstancesUndelete Permission = "bb.instances.undelete"
+ PermissionInstancesUpdate Permission = "bb.instances.update"
+ PermissionInstanceRolesGet Permission = "bb.instanceRoles.get"
+ PermissionInstanceRolesList Permission = "bb.instanceRoles.list"
+ PermissionIssueCommentsCreate Permission = "bb.issueComments.create"
+ PermissionIssueCommentsList Permission = "bb.issueComments.list"
+ PermissionIssueCommentsUpdate Permission = "bb.issueComments.update"
+ PermissionIssuesCreate Permission = "bb.issues.create"
+ PermissionIssuesGet Permission = "bb.issues.get"
+ PermissionIssuesList Permission = "bb.issues.list"
+ PermissionIssuesUpdate Permission = "bb.issues.update"
+ PermissionPlanCheckRunsGet Permission = "bb.planCheckRuns.get"
+ PermissionPlanCheckRunsRun Permission = "bb.planCheckRuns.run"
+ PermissionPlansCreate Permission = "bb.plans.create"
+ PermissionPlansGet Permission = "bb.plans.get"
+ PermissionPlansList Permission = "bb.plans.list"
+ PermissionPlansUpdate Permission = "bb.plans.update"
+ PermissionPoliciesCreate Permission = "bb.policies.create"
+ PermissionPoliciesDelete Permission = "bb.policies.delete"
+ PermissionPoliciesGet Permission = "bb.policies.get"
+ PermissionPoliciesList Permission = "bb.policies.list"
+ PermissionPoliciesUpdate Permission = "bb.policies.update"
+ PermissionProjectsCreate Permission = "bb.projects.create"
+ PermissionProjectsDelete Permission = "bb.projects.delete"
+ PermissionProjectsGet Permission = "bb.projects.get"
+ PermissionProjectsGetIAMPolicy Permission = "bb.projects.getIamPolicy"
+ PermissionProjectsList Permission = "bb.projects.list"
+ PermissionProjectsSetIAMPolicy Permission = "bb.projects.setIamPolicy"
+ PermissionProjectsUndelete Permission = "bb.projects.undelete"
+ PermissionProjectsUpdate Permission = "bb.projects.update"
+ PermissionReleasesCheck Permission = "bb.releases.check"
+ PermissionReleasesCreate Permission = "bb.releases.create"
+ PermissionReleasesDelete Permission = "bb.releases.delete"
+ PermissionReleasesGet Permission = "bb.releases.get"
+ PermissionReleasesList Permission = "bb.releases.list"
+ PermissionReleasesUndelete Permission = "bb.releases.undelete"
+ PermissionReleasesUpdate Permission = "bb.releases.update"
+ PermissionReviewConfigsCreate Permission = "bb.reviewConfigs.create"
+ PermissionReviewConfigsDelete Permission = "bb.reviewConfigs.delete"
+ PermissionReviewConfigsGet Permission = "bb.reviewConfigs.get"
+ PermissionReviewConfigsList Permission = "bb.reviewConfigs.list"
+ PermissionReviewConfigsUpdate Permission = "bb.reviewConfigs.update"
+ PermissionRevisionsCreate Permission = "bb.revisions.create"
+ PermissionRevisionsDelete Permission = "bb.revisions.delete"
+ PermissionRevisionsGet Permission = "bb.revisions.get"
+ PermissionRevisionsList Permission = "bb.revisions.list"
+ PermissionRolesCreate Permission = "bb.roles.create"
+ PermissionRolesDelete Permission = "bb.roles.delete"
+ PermissionRolesList Permission = "bb.roles.list"
+ PermissionRolesGet Permission = "bb.roles.get"
+ PermissionRolesUpdate Permission = "bb.roles.update"
+ PermissionRolloutsCreate Permission = "bb.rollouts.create"
+ PermissionRolloutsGet Permission = "bb.rollouts.get"
+ PermissionRolloutsList Permission = "bb.rollouts.list"
+ PermissionSettingsGet Permission = "bb.settings.get"
+ PermissionSettingsList Permission = "bb.settings.list"
+ PermissionSettingsSet Permission = "bb.settings.set"
+ PermissionEnvironmentSettingsGet Permission = "bb.settings.getEnvironment"
+ PermissionEnvironmentSettingsSet Permission = "bb.settings.setEnvironment"
+ PermissionWorkspaceProfileSettingsGet Permission = "bb.settings.getWorkspaceProfile"
+ PermissionWorkspaceProfileSettingsSet Permission = "bb.settings.setWorkspaceProfile"
+ PermissionSheetsCreate Permission = "bb.sheets.create"
+ PermissionSheetsGet Permission = "bb.sheets.get"
+ PermissionSheetsUpdate Permission = "bb.sheets.update"
+ PermissionSQLSelect Permission = "bb.sql.select"
+ PermissionSQLDdl Permission = "bb.sql.ddl"
+ PermissionSQLDml Permission = "bb.sql.dml"
+ PermissionSQLExplain Permission = "bb.sql.explain"
+ PermissionSQLInfo Permission = "bb.sql.info"
+ PermissionSQLAdmin Permission = "bb.sql.admin"
+ PermissionTaskRunsCreate Permission = "bb.taskRuns.create"
+ PermissionTaskRunsList Permission = "bb.taskRuns.list"
+ PermissionGroupsCreate Permission = "bb.groups.create"
+ PermissionGroupsDelete Permission = "bb.groups.delete"
+ PermissionGroupsGet Permission = "bb.groups.get"
+ PermissionGroupsList Permission = "bb.groups.list"
+ PermissionGroupsUpdate Permission = "bb.groups.update"
+ PermissionUsersCreate Permission = "bb.users.create"
+ PermissionUsersDelete Permission = "bb.users.delete"
+ PermissionUsersGet Permission = "bb.users.get"
+ PermissionUsersList Permission = "bb.users.list"
+ PermissionUsersUndelete Permission = "bb.users.undelete"
+ PermissionUsersUpdate Permission = "bb.users.update"
+ PermissionUsersUpdateEmail Permission = "bb.users.updateEmail"
+ PermissionWorksheetsGet Permission = "bb.worksheets.get"
+ PermissionWorksheetsManage Permission = "bb.worksheets.manage"
+ PermissionWorkspacesGetIamPolicy Permission = "bb.workspaces.getIamPolicy"
+ PermissionWorkspacesSetIamPolicy Permission = "bb.workspaces.setIamPolicy"
+)
+
+var allPermissions = func() []Permission {
+ var data struct {
+ Permissions []Permission `yaml:"permissions"`
+ }
+ if err := yaml.Unmarshal(permissionYAML, &data); err != nil {
+ panic("failed to load permissions from YAML: " + err.Error())
+ }
+ return data.Permissions
+}()
+
+var allPermissionsMap = func() map[Permission]bool {
+ m := make(map[Permission]bool)
+ for _, p := range allPermissions {
+ m[p] = true
+ }
+ return m
+}()
+
+func PermissionsExist(permissions ...string) bool {
+ for _, p := range permissions {
+ if !PermissionExist(p) {
+ return false
+ }
+ }
+ return true
+}
+
+func PermissionExist(permission string) bool {
+ return allPermissionsMap[permission]
+}
+```
+
+**Step 2: Move permission.yaml**
+
+Run: `mv backend/component/iam/permission.yaml backend/common/permission/permission.yaml`
+
+**Step 3: Verify package compiles**
+
+Run: `go build ./backend/common/permission/...`
+Expected: Success
+
+---
+
+## Task 2: Create predefined roles in store
+
+**Files:**
+- Create: `backend/store/predefined_roles.go`
+
+**Step 1: Create predefined roles file**
+
+```go
+// backend/store/predefined_roles.go
+package store
+
+import "github.com/bytebase/bytebase/backend/common/permission"
+
+// Predefined role IDs.
+const (
+ WorkspaceAdminRole = "workspaceAdmin"
+ WorkspaceDBARole = "workspaceDBA"
+ WorkspaceMemberRole = "workspaceMember"
+ ProjectOwnerRole = "projectOwner"
+ ProjectDeveloperRole = "projectDeveloper"
+ SQLEditorUserRole = "sqlEditorUser"
+ ProjectReleaserRole = "projectReleaser"
+ GitOpsServiceAgentRole = "gitopsServiceAgent"
+ ProjectViewerRole = "projectViewer"
+)
+
+func permissionSet(perms ...permission.Permission) map[string]bool {
+ m := make(map[string]bool, len(perms))
+ for _, p := range perms {
+ m[p] = true
+ }
+ return m
+}
+
+var PredefinedRoles = []*RoleMessage{
+ {
+ ResourceID: WorkspaceAdminRole,
+ Name: "Workspace admin",
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionIdentityProvidersCreate,
+ permission.PermissionIdentityProvidersDelete,
+ permission.PermissionIdentityProvidersGet,
+ permission.PermissionIdentityProvidersUpdate,
+ permission.PermissionInstancesCreate,
+ permission.PermissionInstancesDelete,
+ permission.PermissionInstancesGet,
+ permission.PermissionInstancesList,
+ permission.PermissionInstancesSync,
+ permission.PermissionInstancesUndelete,
+ permission.PermissionInstancesUpdate,
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsCreate,
+ permission.PermissionProjectsDelete,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsList,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUndelete,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionReviewConfigsCreate,
+ permission.PermissionReviewConfigsDelete,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionReviewConfigsUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolesCreate,
+ permission.PermissionRolesDelete,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionRolesUpdate,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSettingsGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionSettingsList,
+ permission.PermissionSettingsSet,
+ permission.PermissionEnvironmentSettingsSet,
+ permission.PermissionWorkspaceProfileSettingsSet,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ permission.PermissionGroupsCreate,
+ permission.PermissionGroupsDelete,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionGroupsUpdate,
+ permission.PermissionSQLAdmin,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersCreate,
+ permission.PermissionUsersDelete,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionUsersUndelete,
+ permission.PermissionUsersUpdate,
+ permission.PermissionUsersUpdateEmail,
+ permission.PermissionWorksheetsGet,
+ permission.PermissionWorksheetsManage,
+ permission.PermissionWorkspacesGetIamPolicy,
+ permission.PermissionWorkspacesSetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: WorkspaceDBARole,
+ Name: "Workspace DBA",
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionInstancesCreate,
+ permission.PermissionInstancesDelete,
+ permission.PermissionInstancesGet,
+ permission.PermissionInstancesList,
+ permission.PermissionInstancesSync,
+ permission.PermissionInstancesUndelete,
+ permission.PermissionInstancesUpdate,
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsCreate,
+ permission.PermissionProjectsDelete,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsList,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUndelete,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionReviewConfigsCreate,
+ permission.PermissionReviewConfigsDelete,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionReviewConfigsUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolesCreate,
+ permission.PermissionRolesDelete,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionRolesUpdate,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSettingsGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionSettingsList,
+ permission.PermissionSettingsSet,
+ permission.PermissionEnvironmentSettingsSet,
+ permission.PermissionWorkspaceProfileSettingsSet,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionSQLAdmin,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionWorksheetsGet,
+ permission.PermissionWorksheetsManage,
+ permission.PermissionWorkspacesGetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: WorkspaceMemberRole,
+ Name: "Workspace member",
+ Permissions: permissionSet(
+ permission.PermissionInstanceRolesGet,
+ permission.PermissionInstanceRolesList,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionReviewConfigsGet,
+ permission.PermissionReviewConfigsList,
+ permission.PermissionRolesList,
+ permission.PermissionRolesGet,
+ permission.PermissionEnvironmentSettingsGet,
+ permission.PermissionWorkspaceProfileSettingsGet,
+ permission.PermissionGroupsCreate,
+ permission.PermissionGroupsGet,
+ permission.PermissionGroupsList,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionWorkspacesGetIamPolicy,
+ ),
+ },
+ {
+ ResourceID: ProjectOwnerRole,
+ Name: "Project owner",
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsExport,
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseCatalogsUpdate,
+ permission.PermissionDatabaseGroupsCreate,
+ permission.PermissionDatabaseGroupsDelete,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabaseGroupsUpdate,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionDatabasesUpdate,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionPlansUpdate,
+ permission.PermissionPoliciesCreate,
+ permission.PermissionPoliciesDelete,
+ permission.PermissionPoliciesGet,
+ permission.PermissionPoliciesList,
+ permission.PermissionPoliciesUpdate,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionProjectsSetIAMPolicy,
+ permission.PermissionProjectsUpdate,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesDelete,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionReleasesUndelete,
+ permission.PermissionReleasesUpdate,
+ permission.PermissionRevisionsCreate,
+ permission.PermissionRevisionsDelete,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionUsersGet,
+ permission.PermissionUsersList,
+ permission.PermissionTaskRunsList,
+ permission.PermissionWorksheetsGet,
+ ),
+ },
+ {
+ ResourceID: ProjectDeveloperRole,
+ Name: "Project developer",
+ Permissions: permissionSet(
+ permission.PermissionAuditLogsSearch,
+ permission.PermissionChangelogsGet,
+ permission.PermissionChangelogsList,
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionIssuesUpdate,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsCreate,
+ permission.PermissionSheetsGet,
+ permission.PermissionSheetsUpdate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: SQLEditorUserRole,
+ Name: "SQL Editor User",
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionDatabasesSync,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionSQLDdl,
+ permission.PermissionSQLDml,
+ permission.PermissionSQLExplain,
+ permission.PermissionSQLInfo,
+ permission.PermissionSQLSelect,
+ permission.PermissionWorksheetsGet,
+ ),
+ },
+ {
+ ResourceID: ProjectReleaserRole,
+ Name: "Project releaser",
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionChangelogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesCheck,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesGet,
+ permission.PermissionIssuesList,
+ permission.PermissionPlanCheckRunsGet,
+ permission.PermissionPlanCheckRunsRun,
+ permission.PermissionPlansGet,
+ permission.PermissionPlansList,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionReleasesGet,
+ permission.PermissionReleasesList,
+ permission.PermissionRevisionsGet,
+ permission.PermissionRevisionsList,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionSheetsGet,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: GitOpsServiceAgentRole,
+ Name: "GitOps Service Agent",
+ Permissions: permissionSet(
+ permission.PermissionPlansCreate,
+ permission.PermissionPlansGet,
+ permission.PermissionReleasesCheck,
+ permission.PermissionReleasesCreate,
+ permission.PermissionReleasesGet,
+ permission.PermissionRolloutsCreate,
+ permission.PermissionRolloutsGet,
+ permission.PermissionRolloutsList,
+ permission.PermissionTaskRunsCreate,
+ permission.PermissionTaskRunsList,
+ ),
+ },
+ {
+ ResourceID: ProjectViewerRole,
+ Name: "Project viewer",
+ Permissions: permissionSet(
+ permission.PermissionDatabaseCatalogsGet,
+ permission.PermissionDatabaseGroupsGet,
+ permission.PermissionDatabaseGroupsList,
+ permission.PermissionDatabasesGet,
+ permission.PermissionDatabasesGetSchema,
+ permission.PermissionDatabasesList,
+ permission.PermissionIssueCommentsCreate,
+ permission.PermissionIssueCommentsList,
+ permission.PermissionIssueCommentsUpdate,
+ permission.PermissionIssuesCreate,
+ permission.PermissionProjectsGet,
+ permission.PermissionProjectsGetIAMPolicy,
+ permission.PermissionIssuesGet,
+ ),
+ },
+}
+
+// predefinedRolesMap is a map from role ID to RoleMessage for fast lookup.
+var predefinedRolesMap = func() map[string]*RoleMessage {
+ m := make(map[string]*RoleMessage, len(PredefinedRoles))
+ for _, role := range PredefinedRoles {
+ m[role.ResourceID] = role
+ }
+ return m
+}()
+
+// GetPredefinedRole returns a predefined role by ID.
+func GetPredefinedRole(roleID string) *RoleMessage {
+ return predefinedRolesMap[roleID]
+}
+
+// IsPredefinedRole checks if a role ID is a predefined role.
+func IsPredefinedRole(roleID string) bool {
+ _, ok := predefinedRolesMap[roleID]
+ return ok
+}
+```
+
+**Step 2: Verify compilation**
+
+Run: `go build ./backend/store/...`
+Expected: Success
+
+---
+
+## Task 3: Update store ListRoles to include predefined roles
+
+**Files:**
+- Modify: `backend/store/role.go:134-182`
+
+**Step 1: Update ListRoles function**
+
+In `backend/store/role.go`, change the `ListRoles` function to append predefined roles:
+
+```go
+// ListRoles returns a list of roles.
+func (s *Store) ListRoles(ctx context.Context, find *FindRoleMessage) ([]*RoleMessage, error) {
+ // If looking for a specific role, check predefined first
+ if v := find.ResourceID; v != nil {
+ if role := GetPredefinedRole(*v); role != nil {
+ return []*RoleMessage{role}, nil
+ }
+ }
+
+ q := qb.Q().Space(`
+ SELECT
+ resource_id, name, description, permissions
+ FROM role
+ WHERE TRUE
+ `)
+
+ if v := find.ResourceID; v != nil {
+ q.And("resource_id = ?", *v)
+ }
+
+ query, args, err := q.ToSQL()
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to build sql")
+ }
+
+ rows, err := s.GetDB().QueryContext(ctx, query, args...)
+ if err != nil {
+ return nil, err
+ }
+ defer rows.Close()
+
+ var roles []*RoleMessage
+ for rows.Next() {
+ role := &RoleMessage{
+ Permissions: map[string]bool{},
+ }
+ var permissionBytes []byte
+ if err := rows.Scan(&role.ResourceID, &role.Name, &role.Description, &permissionBytes); err != nil {
+ return nil, err
+ }
+ var rolePermissions storepb.RolePermissions
+ if err := common.ProtojsonUnmarshaler.Unmarshal(permissionBytes, &rolePermissions); err != nil {
+ return nil, err
+ }
+ for _, v := range rolePermissions.Permissions {
+ role.Permissions[v] = true
+ }
+ s.rolesCache.Add(role.ResourceID, role)
+ roles = append(roles, role)
+ }
+
+ if err := rows.Err(); err != nil {
+ return nil, err
+ }
+
+ // Append predefined roles when listing all roles
+ if find.ResourceID == nil {
+ roles = append(roles, PredefinedRoles...)
+ }
+
+ return roles, nil
+}
+```
+
+**Step 2: Verify compilation**
+
+Run: `go build ./backend/store/...`
+Expected: Success
+
+---
+
+## Task 4: Update IAM manager to use shared permission package
+
+**Files:**
+- Modify: `backend/component/iam/permission.go`
+- Modify: `backend/component/iam/manager.go`
+
+**Step 1: Update permission.go to re-export from shared package**
+
+Replace `backend/component/iam/permission.go` with:
+
+```go
+package iam
+
+import "github.com/bytebase/bytebase/backend/common/permission"
+
+// Re-export Permission type and functions from shared package.
+type Permission = permission.Permission
+
+// Re-export all permission constants.
+const (
+ PermissionAuditLogsExport = permission.PermissionAuditLogsExport
+ PermissionAuditLogsSearch = permission.PermissionAuditLogsSearch
+ PermissionChangelogsGet = permission.PermissionChangelogsGet
+ PermissionChangelogsList = permission.PermissionChangelogsList
+ PermissionDatabaseCatalogsGet = permission.PermissionDatabaseCatalogsGet
+ PermissionDatabaseCatalogsUpdate = permission.PermissionDatabaseCatalogsUpdate
+ PermissionDatabaseGroupsCreate = permission.PermissionDatabaseGroupsCreate
+ PermissionDatabaseGroupsDelete = permission.PermissionDatabaseGroupsDelete
+ PermissionDatabaseGroupsGet = permission.PermissionDatabaseGroupsGet
+ PermissionDatabaseGroupsList = permission.PermissionDatabaseGroupsList
+ PermissionDatabaseGroupsUpdate = permission.PermissionDatabaseGroupsUpdate
+ PermissionDatabasesCheck = permission.PermissionDatabasesCheck
+ PermissionDatabasesGet = permission.PermissionDatabasesGet
+ PermissionDatabasesGetSchema = permission.PermissionDatabasesGetSchema
+ PermissionDatabasesList = permission.PermissionDatabasesList
+ PermissionDatabasesSync = permission.PermissionDatabasesSync
+ PermissionDatabasesUpdate = permission.PermissionDatabasesUpdate
+ PermissionIdentityProvidersCreate = permission.PermissionIdentityProvidersCreate
+ PermissionIdentityProvidersDelete = permission.PermissionIdentityProvidersDelete
+ PermissionIdentityProvidersGet = permission.PermissionIdentityProvidersGet
+ PermissionIdentityProvidersUpdate = permission.PermissionIdentityProvidersUpdate
+ PermissionInstancesCreate = permission.PermissionInstancesCreate
+ PermissionInstancesDelete = permission.PermissionInstancesDelete
+ PermissionInstancesGet = permission.PermissionInstancesGet
+ PermissionInstancesList = permission.PermissionInstancesList
+ PermissionInstancesSync = permission.PermissionInstancesSync
+ PermissionInstancesUndelete = permission.PermissionInstancesUndelete
+ PermissionInstancesUpdate = permission.PermissionInstancesUpdate
+ PermissionInstanceRolesGet = permission.PermissionInstanceRolesGet
+ PermissionInstanceRolesList = permission.PermissionInstanceRolesList
+ PermissionIssueCommentsCreate = permission.PermissionIssueCommentsCreate
+ PermissionIssueCommentsList = permission.PermissionIssueCommentsList
+ PermissionIssueCommentsUpdate = permission.PermissionIssueCommentsUpdate
+ PermissionIssuesCreate = permission.PermissionIssuesCreate
+ PermissionIssuesGet = permission.PermissionIssuesGet
+ PermissionIssuesList = permission.PermissionIssuesList
+ PermissionIssuesUpdate = permission.PermissionIssuesUpdate
+ PermissionPlanCheckRunsGet = permission.PermissionPlanCheckRunsGet
+ PermissionPlanCheckRunsRun = permission.PermissionPlanCheckRunsRun
+ PermissionPlansCreate = permission.PermissionPlansCreate
+ PermissionPlansGet = permission.PermissionPlansGet
+ PermissionPlansList = permission.PermissionPlansList
+ PermissionPlansUpdate = permission.PermissionPlansUpdate
+ PermissionPoliciesCreate = permission.PermissionPoliciesCreate
+ PermissionPoliciesDelete = permission.PermissionPoliciesDelete
+ PermissionPoliciesGet = permission.PermissionPoliciesGet
+ PermissionPoliciesList = permission.PermissionPoliciesList
+ PermissionPoliciesUpdate = permission.PermissionPoliciesUpdate
+ PermissionProjectsCreate = permission.PermissionProjectsCreate
+ PermissionProjectsDelete = permission.PermissionProjectsDelete
+ PermissionProjectsGet = permission.PermissionProjectsGet
+ PermissionProjectsGetIAMPolicy = permission.PermissionProjectsGetIAMPolicy
+ PermissionProjectsList = permission.PermissionProjectsList
+ PermissionProjectsSetIAMPolicy = permission.PermissionProjectsSetIAMPolicy
+ PermissionProjectsUndelete = permission.PermissionProjectsUndelete
+ PermissionProjectsUpdate = permission.PermissionProjectsUpdate
+ PermissionReleasesCheck = permission.PermissionReleasesCheck
+ PermissionReleasesCreate = permission.PermissionReleasesCreate
+ PermissionReleasesDelete = permission.PermissionReleasesDelete
+ PermissionReleasesGet = permission.PermissionReleasesGet
+ PermissionReleasesList = permission.PermissionReleasesList
+ PermissionReleasesUndelete = permission.PermissionReleasesUndelete
+ PermissionReleasesUpdate = permission.PermissionReleasesUpdate
+ PermissionReviewConfigsCreate = permission.PermissionReviewConfigsCreate
+ PermissionReviewConfigsDelete = permission.PermissionReviewConfigsDelete
+ PermissionReviewConfigsGet = permission.PermissionReviewConfigsGet
+ PermissionReviewConfigsList = permission.PermissionReviewConfigsList
+ PermissionReviewConfigsUpdate = permission.PermissionReviewConfigsUpdate
+ PermissionRevisionsCreate = permission.PermissionRevisionsCreate
+ PermissionRevisionsDelete = permission.PermissionRevisionsDelete
+ PermissionRevisionsGet = permission.PermissionRevisionsGet
+ PermissionRevisionsList = permission.PermissionRevisionsList
+ PermissionRolesCreate = permission.PermissionRolesCreate
+ PermissionRolesDelete = permission.PermissionRolesDelete
+ PermissionRolesList = permission.PermissionRolesList
+ PermissionRolesGet = permission.PermissionRolesGet
+ PermissionRolesUpdate = permission.PermissionRolesUpdate
+ PermissionRolloutsCreate = permission.PermissionRolloutsCreate
+ PermissionRolloutsGet = permission.PermissionRolloutsGet
+ PermissionRolloutsList = permission.PermissionRolloutsList
+ PermissionSettingsGet = permission.PermissionSettingsGet
+ PermissionSettingsList = permission.PermissionSettingsList
+ PermissionSettingsSet = permission.PermissionSettingsSet
+ PermissionEnvironmentSettingsGet = permission.PermissionEnvironmentSettingsGet
+ PermissionEnvironmentSettingsSet = permission.PermissionEnvironmentSettingsSet
+ PermissionWorkspaceProfileSettingsGet = permission.PermissionWorkspaceProfileSettingsGet
+ PermissionWorkspaceProfileSettingsSet = permission.PermissionWorkspaceProfileSettingsSet
+ PermissionSheetsCreate = permission.PermissionSheetsCreate
+ PermissionSheetsGet = permission.PermissionSheetsGet
+ PermissionSheetsUpdate = permission.PermissionSheetsUpdate
+ PermissionSQLSelect = permission.PermissionSQLSelect
+ PermissionSQLDdl = permission.PermissionSQLDdl
+ PermissionSQLDml = permission.PermissionSQLDml
+ PermissionSQLExplain = permission.PermissionSQLExplain
+ PermissionSQLInfo = permission.PermissionSQLInfo
+ PermissionSQLAdmin = permission.PermissionSQLAdmin
+ PermissionTaskRunsCreate = permission.PermissionTaskRunsCreate
+ PermissionTaskRunsList = permission.PermissionTaskRunsList
+ PermissionGroupsCreate = permission.PermissionGroupsCreate
+ PermissionGroupsDelete = permission.PermissionGroupsDelete
+ PermissionGroupsGet = permission.PermissionGroupsGet
+ PermissionGroupsList = permission.PermissionGroupsList
+ PermissionGroupsUpdate = permission.PermissionGroupsUpdate
+ PermissionUsersCreate = permission.PermissionUsersCreate
+ PermissionUsersDelete = permission.PermissionUsersDelete
+ PermissionUsersGet = permission.PermissionUsersGet
+ PermissionUsersList = permission.PermissionUsersList
+ PermissionUsersUndelete = permission.PermissionUsersUndelete
+ PermissionUsersUpdate = permission.PermissionUsersUpdate
+ PermissionUsersUpdateEmail = permission.PermissionUsersUpdateEmail
+ PermissionWorksheetsGet = permission.PermissionWorksheetsGet
+ PermissionWorksheetsManage = permission.PermissionWorksheetsManage
+ PermissionWorkspacesGetIamPolicy = permission.PermissionWorkspacesGetIamPolicy
+ PermissionWorkspacesSetIamPolicy = permission.PermissionWorkspacesSetIamPolicy
+)
+
+// Re-export functions.
+var (
+ PermissionsExist = permission.PermissionsExist
+ PermissionExist = permission.PermissionExist
+)
+```
+
+**Step 2: Update manager.go**
+
+Remove from `backend/component/iam/manager.go`:
+- Remove `//go:embed acl.yaml` and `aclYaml` variable
+- Remove `acl` struct type
+- Remove `PredefinedRoles` field from `Manager` struct
+- Remove `loadPredefinedRoles()` function
+- Update `NewManager()` to not load predefined roles
+- Update `ReloadCache()` to not append predefined roles (store already includes them)
+
+New `manager.go`:
+
+```go
+package iam
+
+import (
+ "context"
+ "strings"
+
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common"
+ "github.com/bytebase/bytebase/backend/enterprise"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/store"
+ "github.com/bytebase/bytebase/backend/utils"
+)
+
+type Manager struct {
+ // rolePermissions is a map from role to permissions. Key is "roles/{role}".
+ rolePermissions map[string]map[Permission]bool
+ groupMembers map[string]map[string]bool
+ // member - groups mapping
+ memberGroups map[string][]string
+ store *store.Store
+ licenseService *enterprise.LicenseService
+}
+
+func NewManager(store *store.Store, licenseService *enterprise.LicenseService) (*Manager, error) {
+ m := &Manager{
+ store: store,
+ licenseService: licenseService,
+ }
+ return m, nil
+}
+
+// Check if the user has permission on the resource hierarchy.
+// CEL on the binding is not considered.
+// When multiple projects are specified, the user should have permission on every projects.
+func (m *Manager) CheckPermission(ctx context.Context, p Permission, user *store.UserMessage, projectIDs ...string) (bool, error) {
+ policyMessage, err := m.store.GetWorkspaceIamPolicy(ctx)
+ if err != nil {
+ return false, err
+ }
+ if ok := check(user, p, policyMessage.Policy, m.rolePermissions, m.groupMembers); ok {
+ return true, nil
+ }
+
+ if len(projectIDs) > 0 {
+ allOK := true
+ for _, projectID := range projectIDs {
+ project, err := m.store.GetProject(ctx, &store.FindProjectMessage{
+ ResourceID: &projectID,
+ ShowDeleted: true,
+ })
+ if err != nil {
+ return false, err
+ }
+ if project == nil {
+ return false, errors.Errorf("project %q not found", projectID)
+ }
+ policyMessage, err := m.store.GetProjectIamPolicy(ctx, project.ResourceID)
+ if err != nil {
+ return false, err
+ }
+ if ok := check(user, p, policyMessage.Policy, m.rolePermissions, m.groupMembers); !ok {
+ allOK = false
+ break
+ }
+ }
+ return allOK, nil
+ }
+ return false, nil
+}
+
+func (m *Manager) ReloadCache(ctx context.Context) error {
+ // ListRoles now returns custom + predefined roles
+ roles, err := m.store.ListRoles(ctx, &store.FindRoleMessage{})
+ if err != nil {
+ return err
+ }
+
+ rolePermissions := make(map[string]map[Permission]bool)
+ for _, role := range roles {
+ rolePermissions[common.FormatRole(role.ResourceID)] = role.Permissions
+ }
+ m.rolePermissions = rolePermissions
+
+ groups, err := m.store.ListGroups(ctx, &store.FindGroupMessage{})
+ if err != nil {
+ return err
+ }
+ groupMembers := make(map[string]map[string]bool)
+ memberGroups := make(map[string][]string)
+ for _, group := range groups {
+ usersSet := make(map[string]bool)
+ groupName := utils.FormatGroupName(group)
+ for _, m := range group.Payload.GetMembers() {
+ usersSet[m.Member] = true
+ if _, ok := memberGroups[m.Member]; !ok {
+ memberGroups[m.Member] = []string{}
+ }
+ memberGroups[m.Member] = append(memberGroups[m.Member], groupName)
+ }
+ groupMembers[groupName] = usersSet
+ }
+ m.groupMembers = groupMembers
+ m.memberGroups = memberGroups
+ return nil
+}
+
+// GetPermissions returns all permissions for the given role.
+// Role format is roles/{role}.
+func (m *Manager) GetPermissions(role string) (map[Permission]bool, error) {
+ permissions, ok := m.rolePermissions[role]
+ if !ok {
+ return nil, nil
+ }
+ return permissions, nil
+}
+
+func (m *Manager) GetUserGroups(email string) []string {
+ return m.memberGroups[common.FormatUserEmail(email)]
+}
+
+func check(user *store.UserMessage, p Permission, policy *storepb.IamPolicy, rolePermissions map[string]map[Permission]bool, groupMembers map[string]map[string]bool) bool {
+ userName := common.FormatUserEmail(user.Email)
+
+ for _, binding := range policy.GetBindings() {
+ permissions, ok := rolePermissions[binding.GetRole()]
+ if !ok {
+ continue
+ }
+ if !permissions[p] {
+ continue
+ }
+ for _, member := range binding.GetMembers() {
+ if member == common.AllUsers {
+ return true
+ }
+ if member == userName {
+ return true
+ }
+ if strings.HasPrefix(member, common.GroupPrefix) {
+ if groupMembers, ok := groupMembers[member]; ok {
+ if groupMembers[userName] {
+ return true
+ }
+ }
+ }
+ }
+ }
+ return false
+}
+```
+
+**Step 3: Verify compilation**
+
+Run: `go build ./backend/component/iam/...`
+Expected: Success
+
+---
+
+## Task 5: Update role_service.go
+
+**Files:**
+- Modify: `backend/api/v1/role_service.go`
+
+**Step 1: Update ListRoles**
+
+Change `ListRoles` to not manually append predefined roles:
+
+```go
+// ListRoles lists roles.
+func (s *RoleService) ListRoles(ctx context.Context, _ *connect.Request[v1pb.ListRolesRequest]) (*connect.Response[v1pb.ListRolesResponse], error) {
+ roleMessages, err := s.store.ListRoles(ctx, &store.FindRoleMessage{})
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to list roles"))
+ }
+
+ var roles []*v1pb.Role
+ for _, role := range roleMessages {
+ roleType := v1pb.Role_CUSTOM
+ if store.IsPredefinedRole(role.ResourceID) {
+ roleType = v1pb.Role_BUILT_IN
+ }
+ roles = append(roles, convertToRole(role, roleType))
+ }
+
+ return connect.NewResponse(&v1pb.ListRolesResponse{
+ Roles: roles,
+ }), nil
+}
+```
+
+**Step 2: Update GetRole**
+
+Change `GetRole` to use store lookup:
+
+```go
+// GetRole gets a role.
+func (s *RoleService) GetRole(ctx context.Context, req *connect.Request[v1pb.GetRoleRequest]) (*connect.Response[v1pb.Role], error) {
+ roleName := req.Msg.Name
+ roleID, err := common.GetRoleID(roleName)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
+
+ roles, err := s.store.ListRoles(ctx, &store.FindRoleMessage{ResourceID: &roleID})
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to get role"))
+ }
+ if len(roles) == 0 {
+ return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("role not found: %s", roleID))
+ }
+
+ role := roles[0]
+ roleType := v1pb.Role_CUSTOM
+ if store.IsPredefinedRole(role.ResourceID) {
+ roleType = v1pb.Role_BUILT_IN
+ }
+ return connect.NewResponse(convertToRole(role, roleType)), nil
+}
+```
+
+**Step 3: Update CreateRole, UpdateRole, DeleteRole**
+
+Replace `s.getBuildinRole()` calls with `store.IsPredefinedRole()`:
+
+In `CreateRole`:
+```go
+if store.IsPredefinedRole(req.Msg.RoleId) {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("role %s is a built-in role", req.Msg.RoleId))
+}
+```
+
+In `UpdateRole`:
+```go
+if store.IsPredefinedRole(roleID) {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("cannot change the build-in role %s", req.Msg.Role.Name))
+}
+```
+
+In `DeleteRole`:
+```go
+if store.IsPredefinedRole(roleID) {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("cannot delete the build-in role %s", req.Msg.Name))
+}
+```
+
+**Step 4: Remove getBuildinRole function**
+
+Delete the `getBuildinRole` method entirely.
+
+**Step 5: Verify compilation**
+
+Run: `go build ./backend/api/v1/...`
+Expected: Success
+
+---
+
+## Task 6: Update project_service.go
+
+**Files:**
+- Modify: `backend/api/v1/project_service.go:1090`
+
+**Step 1: Remove PredefinedRoles append**
+
+Find line ~1090 and remove the append:
+
+Before:
+```go
+roleMessages, err := stores.ListRoles(ctx, &store.FindRoleMessage{})
+if err != nil {
+ return false, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to list roles"))
+}
+roleMessages = append(roleMessages, iamManager.PredefinedRoles...)
+```
+
+After:
+```go
+roleMessages, err := stores.ListRoles(ctx, &store.FindRoleMessage{})
+if err != nil {
+ return false, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to list roles"))
+}
+// ListRoles already includes predefined roles
+```
+
+**Step 2: Verify compilation**
+
+Run: `go build ./backend/api/v1/...`
+Expected: Success
+
+---
+
+## Task 7: Update tests
+
+**Files:**
+- Modify: `backend/component/iam/permission_test.go`
+
+**Step 1: Update permission_test.go**
+
+Update test to use store.PredefinedRoles:
+
+```go
+package iam
+
+import (
+ "slices"
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/common/permission"
+ "github.com/bytebase/bytebase/backend/store"
+)
+
+// Test that every permission in predefined roles is also defined as a constant.
+func TestPermissionExists(t *testing.T) {
+ a := require.New(t)
+
+ for _, role := range store.PredefinedRoles {
+ for p := range role.Permissions {
+ exist := permission.PermissionsExist(p)
+ a.True(exist, "permission %s is not defined as a constant", p)
+ }
+ }
+}
+
+// Test that permissions are equal in permission.yaml and allPermissions.
+func TestPermissionEquals(t *testing.T) {
+ a := require.New(t)
+
+ // This test is now in the permission package
+ // Just verify the re-exports work
+ a.True(PermissionExist(string(PermissionInstancesCreate)))
+}
+```
+
+**Step 2: Verify tests pass**
+
+Run: `go test -v ./backend/component/iam/...`
+Expected: PASS
+
+---
+
+## Task 8: Update frontend copy script
+
+**Files:**
+- Modify: `frontend/scripts/copy_config_files.sh`
+
+**Step 1: Update path**
+
+```bash
+#!/bin/sh
+cp ../backend/enterprise/plan.yaml ./src/types/
+cp ../backend/common/permission/permission.yaml ./src/types/iam/
+node ./scripts/generate_permissions.js
+```
+
+**Step 2: Test script**
+
+Run: `cd frontend && ./scripts/copy_config_files.sh`
+Expected: Success, permission.yaml copied
+
+---
+
+## Task 9: Delete acl.yaml
+
+**Files:**
+- Delete: `backend/component/iam/acl.yaml`
+
+**Step 1: Delete file**
+
+Run: `rm backend/component/iam/acl.yaml`
+
+**Step 2: Verify full build**
+
+Run: `go build ./backend/...`
+Expected: Success
+
+---
+
+## Task 10: Run linters and tests
+
+**Step 1: Run gofmt**
+
+Run: `gofmt -w backend/common/permission/ backend/store/predefined_roles.go backend/component/iam/ backend/api/v1/role_service.go backend/api/v1/project_service.go`
+
+**Step 2: Run golangci-lint**
+
+Run: `golangci-lint run --allow-parallel-runners`
+Expected: No errors
+
+**Step 3: Run tests**
+
+Run: `go test ./backend/component/iam/... ./backend/store/... ./backend/api/v1/...`
+Expected: All pass
+
+---
+
+## Task 11: Commit
+
+Run:
+```bash
+but status
+but commit <branch> -m "refactor(iam): move predefined roles to store package
+
+- Create backend/common/permission/ package for shared permission types
+- Move permission.yaml to backend/common/permission/
+- Define predefined roles as Go code in backend/store/predefined_roles.go
+- Store.ListRoles() now returns both custom and predefined roles
+- IAM manager focuses on permission checking only
+- Update frontend copy script path"
+```
diff --git a/frontend/scripts/copy_config_files.sh b/frontend/scripts/copy_config_files.sh
index 79077023e7..cc508b227a 100644
--- a/frontend/scripts/copy_config_files.sh
+++ b/frontend/scripts/copy_config_files.sh
@@ -1,4 +1,4 @@
#!/bin/sh
cp ../backend/enterprise/plan.yaml ./src/types/
-cp ../backend/component/iam/permission.yaml ./src/types/iam/
+cp ../backend/common/permission/permission.yaml ./src/types/iam/
node ./scripts/generate_permissions.js