Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix(api)!: ListDatabases checks bb.databases.list for a project parent (#21692)
Vincent Huang88b27ec9c31d
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yamlindex c45cc35836..45fd21640b 100644--- a/backend/api/mcp/gen/openapi.yaml+++ b/backend/api/mcp/gen/openapi.yaml@@ -1695,7 +1695,7 @@ paths:summary: ListDatabasesdescription: |-Lists databases in a project, instance, or workspace.- Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)operationId: bytebase.v1.DatabaseService.ListDatabasesparameters:- name: Connect-Protocol-Version@@ -15527,7 +15527,7 @@ components:type: stringtitle: parentdescription: |-- - projects/{project}: list databases in a project, require "bb.projects.get" permission.+ - projects/{project}: list databases in a project, require "bb.databases.list" permission.- workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.- instances/{instance}: list databases in an instance, require "bb.instances.get" permission.- projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission.diff --git a/backend/api/v1/database_service.go b/backend/api/v1/database_service.goindex 6a884b5bd5..02381c0584 100644--- a/backend/api/v1/database_service.go+++ b/backend/api/v1/database_service.go@@ -315,12 +315,12 @@ func (s *DatabaseService) ListDatabases(ctx context.Context, req *connect.Requesif project == nil || project.Deleted {return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("project %q not found", req.Msg.Parent))}- ok, err := s.iamManager.CheckPermission(ctx, permission.ProjectsGet, user, common.GetWorkspaceIDFromContext(ctx), projectID)+ ok, err := s.iamManager.CheckPermission(ctx, permission.DatabasesList, user, common.GetWorkspaceIDFromContext(ctx), projectID)if err != nil {return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err))}if !ok {- return nil, permissionDeniedError(ctx, errors.Errorf("user does not have permission %q in %q", permission.ProjectsGet, req.Msg.Parent))+ return nil, permissionDeniedError(ctx, errors.Errorf("user does not have permission %q in %q", permission.DatabasesList, req.Msg.Parent))}find.ProjectID = &projectID} else if _, err := common.GetWorkspaceID(req.Msg.Parent); err == nil {diff --git a/backend/api/v1/database_service_test.go b/backend/api/v1/database_service_test.goindex a682329a58..46651710e3 100644--- a/backend/api/v1/database_service_test.go+++ b/backend/api/v1/database_service_test.go@@ -1,6 +1,7 @@package v1import (+ "context""testing""connectrpc.com/connect"@@ -8,11 +9,74 @@ import ("github.com/stretchr/testify/require""github.com/bytebase/bytebase/backend/common"+ "github.com/bytebase/bytebase/backend/common/permission"+ "github.com/bytebase/bytebase/backend/common/testcontainer"+ "github.com/bytebase/bytebase/backend/component/iam"storepb "github.com/bytebase/bytebase/backend/generated-go/store"v1pb "github.com/bytebase/bytebase/backend/generated-go/v1""github.com/bytebase/bytebase/backend/store")+func TestListDatabasesProjectParentChecksDatabasesList(t *testing.T) {+ t.Parallel()+ ctx := context.Background()+ db, stores, _ := testcontainer.NewMetadataDB(t)+ _, err := db.ExecContext(ctx, `+ INSERT INTO workspace (resource_id) VALUES ('default');+ INSERT INTO project (resource_id, workspace, name) VALUES ('project-a', 'default', 'Project A'), ('project-b', 'default', 'Project B');+ INSERT INTO instance (resource_id, workspace) VALUES ('prod', 'default');+ INSERT INTO db (instance, name, project) VALUES ('prod', 'a1', 'project-a'), ('prod', 'a2', 'project-a');+ `)+ require.NoError(t, err)+ for role, p := range map[string]permission.Permission{"project-getter": permission.ProjectsGet, "database-lister": permission.DatabasesList} {+ _, err := stores.CreateRole(ctx, &store.RoleMessage{+ ResourceID: role, Workspace: "default", Name: role,+ Permissions: map[permission.Permission]bool{p: true},+ })+ require.NoError(t, err)+ }+ grant := func(resourceType storepb.Policy_Resource, resource, email, role string) {+ _, err := stores.PatchIamPolicy(ctx, "default", resourceType, resource, func(policy *storepb.IamPolicy) error {+ policy.Bindings = append(policy.Bindings, &storepb.Binding{Role: role, Members: []string{common.FormatUserEmail(email)}})+ return nil+ })+ require.NoError(t, err)+ }+ grant(storepb.Policy_WORKSPACE, common.FormatWorkspace("default"), "[email protected]", "roles/workspaceAdmin")+ grant(storepb.Policy_PROJECT, common.FormatProject("project-a"), "[email protected]", "roles/projectDeveloper")+ grant(storepb.Policy_PROJECT, common.FormatProject("project-a"), "[email protected]", "roles/project-getter")+ grant(storepb.Policy_PROJECT, common.FormatProject("project-a"), "[email protected]", "roles/database-lister")+ grant(storepb.Policy_PROJECT, common.FormatProject("project-b"), "[email protected]", "roles/database-lister")++ iamManager, err := iam.NewManager(stores, nil, false)+ require.NoError(t, err)+ service := &DatabaseService{store: stores, iamManager: iamManager, licenseService: newInstanceServiceTestLicenseService(t, stores)}+ list := func(email string) ([]string, error) {+ callerCtx := context.WithValue(ctx, common.WorkspaceIDContextKey, "default")+ callerCtx = context.WithValue(callerCtx, common.UserContextKey, &store.UserMessage{Email: email})+ resp, err := service.ListDatabases(callerCtx, connect.NewRequest(&v1pb.ListDatabasesRequest{Parent: "projects/project-a", PageSize: 100}))+ if err != nil {+ return nil, err+ }+ var names []string+ for _, database := range resp.Msg.Databases {+ names = append(names, database.Name)+ }+ return names, nil+ }++ names, err := list(email)+ require.NoError(t, err, email)+ require.Equal(t, []string{"instances/prod/databases/a1", "instances/prod/databases/a2"}, names, email)+ }+ for _, email := range []string{"[email protected]", "[email protected]"} {+ _, err := list(email)+ require.Equal(t, connect.CodePermissionDenied, connect.CodeOf(err), email)+ require.ErrorContains(t, err, `user does not have permission "bb.databases.list" in "projects/project-a"`, email)+ }+}+func TestShouldDiffSchemaViaSDL(t *testing.T) {t.Parallel()tests := []struct {diff --git a/backend/generated-go/v1/database_service.pb.go b/backend/generated-go/v1/database_service.pb.goindex 10a79da0ee..6b0599820b 100644--- a/backend/generated-go/v1/database_service.pb.go+++ b/backend/generated-go/v1/database_service.pb.go@@ -667,7 +667,7 @@ func (x *BatchGetDatabasesResponse) GetDatabases() []*Database {type ListDatabasesRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // - projects/{project}: list databases in a project, require "bb.projects.get" permission.+ // - projects/{project}: list databases in a project, require "bb.databases.list" permission.// - workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.// - instances/{instance}: list databases in an instance, require "bb.instances.get" permission.// - projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission.diff --git a/backend/generated-go/v1/database_service_grpc.pb.go b/backend/generated-go/v1/database_service_grpc.pb.goindex 93addae5ac..aae143866e 100644--- a/backend/generated-go/v1/database_service_grpc.pb.go+++ b/backend/generated-go/v1/database_service_grpc.pb.go@@ -49,7 +49,7 @@ type DatabaseServiceClient interface {// Permissions required: bb.databases.get (on each named database's project)BatchGetDatabases(ctx context.Context, in *BatchGetDatabasesRequest, opts ...grpc.CallOption) (*BatchGetDatabasesResponse, error)// Lists databases in a project, instance, or workspace.- // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ // Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)ListDatabases(ctx context.Context, in *ListDatabasesRequest, opts ...grpc.CallOption) (*ListDatabasesResponse, error)// Updates database properties such as labels and project assignment.// Permissions required: bb.databases.update@@ -237,7 +237,7 @@ type DatabaseServiceServer interface {// Permissions required: bb.databases.get (on each named database's project)BatchGetDatabases(context.Context, *BatchGetDatabasesRequest) (*BatchGetDatabasesResponse, error)// Lists databases in a project, instance, or workspace.- // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ // Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)// Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updatediff --git a/backend/generated-go/v1/v1connect/database_service.connect.go b/backend/generated-go/v1/v1connect/database_service.connect.goindex b5a3bc0279..6854a75162 100644--- a/backend/generated-go/v1/v1connect/database_service.connect.go+++ b/backend/generated-go/v1/v1connect/database_service.connect.go@@ -85,7 +85,7 @@ type DatabaseServiceClient interface {// Permissions required: bb.databases.get (on each named database's project)BatchGetDatabases(context.Context, *connect.Request[v1.BatchGetDatabasesRequest]) (*connect.Response[v1.BatchGetDatabasesResponse], error)// Lists databases in a project, instance, or workspace.- // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ // Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *connect.Request[v1.ListDatabasesRequest]) (*connect.Response[v1.ListDatabasesResponse], error)// Updates database properties such as labels and project assignment.// Permissions required: bb.databases.update@@ -305,7 +305,7 @@ type DatabaseServiceHandler interface {// Permissions required: bb.databases.get (on each named database's project)BatchGetDatabases(context.Context, *connect.Request[v1.BatchGetDatabasesRequest]) (*connect.Response[v1.BatchGetDatabasesResponse], error)// Lists databases in a project, instance, or workspace.- // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ // Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)ListDatabases(context.Context, *connect.Request[v1.ListDatabasesRequest]) (*connect.Response[v1.ListDatabasesResponse], error)// Updates database properties such as labels and project assignment.// Permissions required: bb.databases.updatediff --git a/frontend/src/types/proto-es/v1/database_service_pb.d.ts b/frontend/src/types/proto-es/v1/database_service_pb.d.tsindex d562b81d57..15d490c974 100644--- a/frontend/src/types/proto-es/v1/database_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/database_service_pb.d.ts@@ -84,7 +84,7 @@ export declare const BatchGetDatabasesResponseSchema: GenMessage<BatchGetDatabas*/export declare type ListDatabasesRequest = Message<"bytebase.v1.ListDatabasesRequest"> & {/**- * - projects/{project}: list databases in a project, require "bb.projects.get" permission.+ * - projects/{project}: list databases in a project, require "bb.databases.list" permission.* - workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.* - instances/{instance}: list databases in an instance, require "bb.instances.get" permission.* - projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission.@@ -3237,7 +3237,7 @@ export declare const DatabaseService: GenService<{},/*** Lists databases in a project, instance, or workspace.- * Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ * Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)** @generated from rpc bytebase.v1.DatabaseService.ListDatabases*/diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex 4cca9bae6c..1aff572b4e 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -1399,7 +1399,7 @@ paths:summary: ListDatabasesdescription: |-Lists databases in a project, instance, or workspace.- Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabases2parameters:- name: instance@@ -6182,7 +6182,7 @@ paths:summary: ListDatabasesdescription: |-Lists databases in a project, instance, or workspace.- Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabasesparameters:- name: project@@ -6607,7 +6607,7 @@ paths:summary: ListDatabasesdescription: |-Lists databases in a project, instance, or workspace.- Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabases4parameters:- name: project@@ -15784,7 +15784,7 @@ paths:summary: ListDatabasesdescription: |-Lists databases in a project, instance, or workspace.- Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)operationId: DatabaseService_ListDatabases3parameters:- name: workspace@@ -23030,7 +23030,7 @@ components:type: stringtitle: parentdescription: |-- - projects/{project}: list databases in a project, require "bb.projects.get" permission.+ - projects/{project}: list databases in a project, require "bb.databases.list" permission.- workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.- instances/{instance}: list databases in an instance, require "bb.instances.get" permission.- projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission.diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex c47483988b..f5fe53a391 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -9051,7 +9051,7 @@ IndexMetadata is the metadata for indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | - projects/{project}: list databases in a project, require "bb.projects.get" permission. - workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission. - instances/{instance}: list databases in an instance, require "bb.instances.get" permission. - projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission. |+| parent | [string](#string) | | - projects/{project}: list databases in a project, require "bb.databases.list" permission. - workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission. - instances/{instance}: list databases in an instance, require "bb.instances.get" permission. - projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission. || page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. || page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.@@ -9610,7 +9610,7 @@ DatabaseService manages databases and their schemas.| ----------- | ------------ | ------------- | ------------|| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Retrieves a database by name. Permissions required: bb.databases.get || BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Retrieves multiple databases by their names. One resource per requested name, in request order. The first name that does not resolve fails the whole call (AIP-231: no partial response). Permissions required: bb.databases.get (on each named database's project) |-| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent) |+| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent) || UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Updates database properties such as labels and project assignment. Permissions required: bb.databases.update || BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Updates multiple databases in a single batch operation. Permissions required: bb.databases.update || SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Synchronizes database schema from the instance. Permissions required: bb.databases.sync |diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex 3a9aab13f7..14bed5ecbb 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -25543,7 +25543,7 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td><td>parent</td><td><a href="#string">string</a></td><td></td>- <td><p>- projects/{project}: list databases in a project, require "bb.projects.get" permission.+ <td><p>- projects/{project}: list databases in a project, require "bb.databases.list" permission.- workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.- instances/{instance}: list databases in an instance, require "bb.instances.get" permission.- projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission. </p></td>@@ -27302,7 +27302,7 @@ Permissions required: bb.databases.get (on each named database's project)</p<td><a href="#bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</a></td><td><a href="#bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</a></td><td><p>Lists databases in a project, instance, or workspace.-Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)</p></td>+Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)</p></td></tr><tr>diff --git a/proto/v1/v1/database_service.proto b/proto/v1/v1/database_service.protoindex 557cf820ae..2db183db33 100644--- a/proto/v1/v1/database_service.proto+++ b/proto/v1/v1/database_service.proto@@ -45,7 +45,7 @@ service DatabaseService {}// Lists databases in a project, instance, or workspace.- // Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)+ // Permissions required: bb.databases.list (for project or workspace parent), or bb.instances.get (for instance parent)rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) {option (google.api.http) = {get: "/v1/{parent=projects/*}/databases"@@ -257,7 +257,7 @@ message BatchGetDatabasesResponse {}message ListDatabasesRequest {- // - projects/{project}: list databases in a project, require "bb.projects.get" permission.+ // - projects/{project}: list databases in a project, require "bb.databases.list" permission.// - workspaces/{id}: list databases in the workspace, require "bb.databases.list" permission.// - instances/{instance}: list databases in an instance, require "bb.instances.get" permission.// - projects/{project}/instances/{instance}: list databases in a project instance, require "bb.instances.get" permission.