Skip to content

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

fix(audit): mark the IAM verdicts handlers make for themselves (#21483)

Vincent Huangd88c2b6a3a5a
diff --git a/backend/api/v1/auth_service.go b/backend/api/v1/auth_service.go
index 610355b560..04794237e9 100644
--- a/backend/api/v1/auth_service.go
+++ b/backend/api/v1/auth_service.go
@@ -949,7 +949,7 @@ func (s *AuthService) SwitchWorkspace(ctx context.Context, req *connect.Request[
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to find workspace"))
}
if ws == nil {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("not a member of workspace %q", workspaceID))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("not a member of workspace %q", workspaceID))
}
// Validate the target workspace's sign-in policies.
diff --git a/backend/api/v1/database_service.go b/backend/api/v1/database_service.go
index 2b06885183..cf70d50448 100644
--- a/backend/api/v1/database_service.go
+++ b/backend/api/v1/database_service.go
@@ -201,7 +201,9 @@ func (s *DatabaseService) BatchGetDatabases(ctx context.Context, req *connect.Re
}
if !ok {
// Same code and message as a missing database: a different one would
- // tell the caller a database exists in a project they cannot see.
+ // tell the caller a database exists in a project they cannot see. The
+ // mark records the refusal the caller is not told about.
+ common.SetPermissionDenied(ctx)
return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("database %q not found", name))
}
database, err := s.convertToDatabase(ctx, databaseMessage)
@@ -299,7 +301,7 @@ func (s *DatabaseService) ListDatabases(ctx context.Context, req *connect.Reques
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q in %q", permission.InstancesGet, req.Msg.Parent))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q in %q", permission.InstancesGet, req.Msg.Parent))
}
find.InstanceID = &instanceID
} else if projectID, err := common.GetProjectID(req.Msg.Parent); err == nil {
@@ -318,7 +320,7 @@ func (s *DatabaseService) ListDatabases(ctx context.Context, req *connect.Reques
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q in %q", permission.ProjectsGet, req.Msg.Parent))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q in %q", permission.ProjectsGet, req.Msg.Parent))
}
find.ProjectID = &projectID
} else if _, err := common.GetWorkspaceID(req.Msg.Parent); err == nil {
@@ -327,7 +329,7 @@ func (s *DatabaseService) ListDatabases(ctx context.Context, req *connect.Reques
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.DatabasesList))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.DatabasesList))
}
} else if instanceID, err := common.GetInstanceID(req.Msg.Parent); err == nil {
if _, err := s.getInstanceForDatabaseResource(ctx, nil, instanceID); err != nil {
@@ -338,7 +340,7 @@ func (s *DatabaseService) ListDatabases(ctx context.Context, req *connect.Reques
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.InstancesGet))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.InstancesGet))
}
find.InstanceID = &instanceID
} else {
diff --git a/backend/api/v1/group_service.go b/backend/api/v1/group_service.go
index a1219d970b..ccf9e15327 100644
--- a/backend/api/v1/group_service.go
+++ b/backend/api/v1/group_service.go
@@ -184,7 +184,7 @@ func (s *GroupService) UpdateGroup(ctx context.Context, req *connect.Request[v1p
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.GroupsCreate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.GroupsCreate))
}
return s.CreateGroup(ctx, connect.NewRequest(&v1pb.CreateGroupRequest{
Group: req.Msg.Group,
@@ -286,7 +286,7 @@ func (s *GroupService) checkPermission(ctx context.Context, group *store.GroupMe
return connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
if !ok {
- return connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission))
+ return common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission))
}
return nil
}
@@ -373,7 +373,7 @@ func (s *GroupService) checkGroupPermission(ctx context.Context, req connect.Any
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- err := connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.GroupsGet))
+ err := common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.GroupsGet))
if detail, detailErr := connect.NewErrorDetail(&v1pb.PermissionDeniedDetail{
Method: req.Spec().Procedure,
RequiredPermissions: []string{string(permission.GroupsGet)},
diff --git a/backend/api/v1/issue_review.go b/backend/api/v1/issue_review.go
index 2d8c0a14a6..9efb4fcafd 100644
--- a/backend/api/v1/issue_review.go
+++ b/backend/api/v1/issue_review.go
@@ -50,7 +50,7 @@ func (s *IssueService) reviewIssue(ctx context.Context, name, comment string, ac
Comment: comment,
})
if err != nil {
- return nil, mapReviewError(err, action)
+ return nil, mapReviewError(ctx, err, action)
}
createRollout := false
@@ -113,7 +113,7 @@ func (s *IssueService) reviewIssue(ctx context.Context, name, comment string, ac
return connect.NewResponse(converted), nil
}
-func mapReviewError(err error, action review.Action) error {
+func mapReviewError(ctx context.Context, err error, action review.Action) error {
var workflowErr *review.Error
if !errors.As(err, &workflowErr) {
return connect.NewError(connect.CodeInternal, err)
@@ -126,6 +126,13 @@ func mapReviewError(err error, action review.Action) error {
case review.ErrorFailedPrecondition:
return connect.NewError(connect.CodeFailedPrecondition, workflowErr)
case review.ErrorPermissionDenied:
+ // ApproveIssue and RejectIssue carry no permission option, so the
+ // approver-role check is the method's only permission check. The other
+ // two refusals with this code are a project self-approval setting and
+ // an issue-ownership rule, which the design leaves unmarked.
+ if workflowErr.Reason == review.ReasonApproverRoleRequired {
+ return common.PermissionDeniedError(ctx, workflowErr)
+ }
return connect.NewError(connect.CodePermissionDenied, workflowErr)
case review.ErrorConflict:
message := "cannot request issue because approval finding is stale"
diff --git a/backend/api/v1/issue_review_test.go b/backend/api/v1/issue_review_test.go
new file mode 100644
index 0000000000..b827e83751
--- /dev/null
+++ b/backend/api/v1/issue_review_test.go
@@ -0,0 +1,53 @@
+package v1
+
+import (
+ "context"
+ "testing"
+
+ "connectrpc.com/connect"
+ "github.com/pkg/errors"
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/common"
+ "github.com/bytebase/bytebase/backend/component/review"
+)
+
+func TestMapReviewErrorMarksOnlyTheApproverRoleVerdict(t *testing.T) {
+ t.Parallel()
+
+ for _, test := range []struct {
+ name string
+ err error
+ wantCode connect.Code
+ wantMark bool
+ }{
+ {
+ name: "approver role",
+ err: &review.Error{Code: review.ErrorPermissionDenied, Reason: review.ReasonApproverRoleRequired, Err: errors.New("cannot approve")},
+ wantCode: connect.CodePermissionDenied,
+ wantMark: true,
+ },
+ {
+ name: "self-approval or ownership",
+ err: &review.Error{Code: review.ErrorPermissionDenied, Err: errors.New("self-approval is not allowed")},
+ wantCode: connect.CodePermissionDenied,
+ },
+ {
+ name: "issue state",
+ err: &review.Error{Code: review.ErrorInvalidAction, Err: errors.New("the issue has been approved")},
+ wantCode: connect.CodeInvalidArgument,
+ },
+ } {
+ t.Run(test.name, func(t *testing.T) {
+ t.Parallel()
+ marked := false
+ ctx := common.WithSetPermissionDenied(context.Background(), func() { marked = true })
+
+ err := mapReviewError(ctx, test.err, review.ActionApprove)
+
+ require.Equal(t, test.wantCode, connect.CodeOf(err))
+ require.Equal(t, test.wantMark, marked,
+ "the audit interceptor streams a refusal, and stamps it WARNING, only when the request is marked")
+ })
+ }
+}
diff --git a/backend/api/v1/issue_service.go b/backend/api/v1/issue_service.go
index 8d0b7b69e7..490179e814 100644
--- a/backend/api/v1/issue_service.go
+++ b/backend/api/v1/issue_service.go
@@ -394,7 +394,7 @@ func (s *IssueService) SearchIssues(ctx context.Context, req *connect.Request[v1
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to check permission %q", permission.IssuesGet))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q in %q", permission.IssuesGet, req.Msg.Parent))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q in %q", permission.IssuesGet, req.Msg.Parent))
}
projectIDs = append(projectIDs, projectID)
}
@@ -914,7 +914,7 @@ func (s *IssueService) UpdateIssue(ctx context.Context, req *connect.Request[v1p
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.IssuesCreate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.IssuesCreate))
}
// Extract project ID from the issue name (format: projects/{project}/issues/{issue})
@@ -1392,7 +1392,7 @@ func (s *IssueService) UpdateIssueComment(ctx context.Context, req *connect.Requ
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.IssueCommentsCreate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.IssueCommentsCreate))
}
// Creation applies the complete resource regardless of the update mask.
return s.CreateIssueComment(ctx, connect.NewRequest(&v1pb.CreateIssueCommentRequest{
diff --git a/backend/api/v1/issue_service_test.go b/backend/api/v1/issue_service_test.go
index 9de8f9c7a0..8a8dedc00a 100644
--- a/backend/api/v1/issue_service_test.go
+++ b/backend/api/v1/issue_service_test.go
@@ -123,7 +123,12 @@ func TestLinkedIssueForCreate(t *testing.T) {
}
}
-func TestApproveIssueFailsClosedWhenIAMLookupFails(t *testing.T) {
+// TestApproveIssueRefusesWhenIAMLookupFails pins the fail-closed property
+// itself: no approval is recorded when the server cannot read the IAM policy.
+// The refusal is Internal rather than PermissionDenied, because an unreadable
+// policy is an outage, not a verdict about the caller — and since BYT-10124 a
+// permission verdict also files a WARNING denial in the audit log.
+func TestApproveIssueRefusesWhenIAMLookupFails(t *testing.T) {
t.Parallel()
ctx := issueServiceTestContext()
stores := setupIssueServiceTestStore(ctx, t)
@@ -145,7 +150,14 @@ func TestApproveIssueFailsClosedWhenIAMLookupFails(t *testing.T) {
_, err = service.ApproveIssue(reviewerCtx, connect.NewRequest(&v1pb.ApproveIssueRequest{
Name: common.FormatIssue(issue.ProjectID, issue.UID),
}))
- require.Equal(t, connect.CodePermissionDenied, connect.CodeOf(err))
+ require.Equal(t, connect.CodeInternal, connect.CodeOf(err))
+
+ after, err := stores.GetIssue(ctx, &store.FindIssueMessage{
+ ProjectIDs: []string{issue.ProjectID},
+ UID: &issue.UID,
+ })
+ require.NoError(t, err)
+ require.Empty(t, after.Payload.GetApproval().GetApprovers(), "no approval may be recorded")
}
func TestCreateRolloutAndPendingTasksAllowsUnapprovedIssueWhenApprovalNotRequired(t *testing.T) {
diff --git a/backend/api/v1/org_policy_service.go b/backend/api/v1/org_policy_service.go
index d8c1427360..ccc935e179 100644
--- a/backend/api/v1/org_policy_service.go
+++ b/backend/api/v1/org_policy_service.go
@@ -475,7 +475,7 @@ func (s *OrgPolicyService) checkPolicyPermission(ctx context.Context, req connec
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- err := connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", perm))
+ err := common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", perm))
if detail, detailErr := connect.NewErrorDetail(&v1pb.PermissionDeniedDetail{
Method: req.Spec().Procedure,
RequiredPermissions: []string{string(perm)},
diff --git a/backend/api/v1/plan_service.go b/backend/api/v1/plan_service.go
index f9221704f8..1dac991dbf 100644
--- a/backend/api/v1/plan_service.go
+++ b/backend/api/v1/plan_service.go
@@ -264,7 +264,7 @@ func (s *PlanService) UpdatePlan(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.PlansCreate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.PlansCreate))
}
return s.CreatePlan(ctx, connect.NewRequest(&v1pb.CreatePlanRequest{
Parent: common.FormatProject(projectID),
@@ -293,7 +293,7 @@ func (s *PlanService) UpdatePlan(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to check permission"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("permission denied to update plan"))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("permission denied to update plan"))
}
var title *string
diff --git a/backend/api/v1/rollout_service.go b/backend/api/v1/rollout_service.go
index d5467ee146..21c9f295df 100644
--- a/backend/api/v1/rollout_service.go
+++ b/backend/api/v1/rollout_service.go
@@ -285,7 +285,7 @@ func (s *RolloutService) CreateRollout(ctx context.Context, req *connect.Request
}
if !hasPermission {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.New("permission denied to create rollout"))
+ return nil, common.PermissionDeniedError(ctx, errors.New("permission denied to create rollout"))
}
if err := rejectMCPOriginatedIssuelessRollout(ctx, project, issue, "create a rollout"); err != nil {
@@ -864,7 +864,7 @@ func (s *RolloutService) BatchRunTasks(ctx context.Context, req *connect.Request
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to check if the user can run tasks"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.New("Not allowed to run tasks"))
+ return nil, common.PermissionDeniedError(ctx, errors.New("Not allowed to run tasks"))
}
if err := rejectMCPOriginatedIssuelessRollout(ctx, project, issueN, "run tasks"); err != nil {
@@ -1026,7 +1026,7 @@ func (s *RolloutService) BatchSkipTasks(ctx context.Context, req *connect.Reques
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to check if the user can skip tasks"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("not allowed to skip tasks in environment %q", environment))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("not allowed to skip tasks in environment %q", environment))
}
}
@@ -1140,7 +1140,7 @@ func (s *RolloutService) BatchCancelTaskRuns(ctx context.Context, req *connect.R
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to check if the user can run tasks"))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.New("Not allowed to cancel tasks"))
+ return nil, common.PermissionDeniedError(ctx, errors.New("Not allowed to cancel tasks"))
}
// Confine the lookup to the plan and environment just authorized: the stage in
diff --git a/backend/api/v1/saved_query_service.go b/backend/api/v1/saved_query_service.go
index 7011ec780c..2bda0a0426 100644
--- a/backend/api/v1/saved_query_service.go
+++ b/backend/api/v1/saved_query_service.go
@@ -637,7 +637,7 @@ func (s *SavedQueryService) checkProjectWide(ctx context.Context, user *store.Us
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err))
}
if !ok {
- return connect.NewError(connect.CodePermissionDenied, errors.Errorf("permission denied: %s", p))
+ return common.PermissionDeniedError(ctx, errors.Errorf("permission denied: %s", p))
}
return nil
}
@@ -1001,6 +1001,11 @@ func (s *SavedQueryService) hasSavedQueryPermission(ctx context.Context, user *s
if err != nil {
return false, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err))
}
+ if !ok {
+ // Callers answer NotFound to hide the saved query's existence, so the
+ // mark is the only record that a permission check refused the caller.
+ common.SetPermissionDenied(ctx)
+ }
return ok, nil
}
diff --git a/backend/api/v1/setting_service.go b/backend/api/v1/setting_service.go
index 9b907cefc3..4ff829a620 100644
--- a/backend/api/v1/setting_service.go
+++ b/backend/api/v1/setting_service.go
@@ -1108,7 +1108,7 @@ func (s *SettingService) checkSettingPermission(ctx context.Context, req connect
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- err := connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", perm))
+ err := common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", perm))
if detail, detailErr := connect.NewErrorDetail(&v1pb.PermissionDeniedDetail{
Method: req.Spec().Procedure,
RequiredPermissions: []string{string(perm)},
diff --git a/backend/api/v1/sql_service.go b/backend/api/v1/sql_service.go
index 0dea556d7e..5d0ca99a4d 100644
--- a/backend/api/v1/sql_service.go
+++ b/backend/api/v1/sql_service.go
@@ -1433,6 +1433,11 @@ func (s *SQLService) accessCheckWithGrantedTargets(
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access control for database: %q, error %v", databaseFullName, err))
}
if !ok {
+ // queryError does not implement Unwrap, and Query reports a refusal
+ // inside its response rather than as an RPC error, so connect.CodeOf
+ // cannot see this verdict. The mark is the only way it reaches the
+ // audit interceptor.
+ common.SetPermissionDenied(ctx)
return &queryError{
err: connect.NewError(
connect.CodePermissionDenied,
@@ -1526,6 +1531,7 @@ func (s *SQLService) accessCheckWithGrantedTargets(
return err
}
if len(deniedResources) > 0 {
+ common.SetPermissionDenied(ctx)
return &queryError{
err: connect.NewError(
connect.CodePermissionDenied,
@@ -1593,6 +1599,7 @@ func (s *SQLService) accessCheckWithGrantedTargets(
}
}
if len(deniedResources) > 0 {
+ common.SetPermissionDenied(ctx)
return &queryError{
err: connect.NewError(
connect.CodePermissionDenied,
diff --git a/backend/api/v1/user_service.go b/backend/api/v1/user_service.go
index 4bfe1d524e..07b8d943a0 100644
--- a/backend/api/v1/user_service.go
+++ b/backend/api/v1/user_service.go
@@ -179,7 +179,7 @@ func (s *UserService) ListUsers(ctx context.Context, request *connect.Request[v1
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check user permission"))
}
if !hasPermission {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.ProjectsGet))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.ProjectsGet))
}
} else if s.profile.SaaS {
find.Workspace = common.GetWorkspaceIDFromContext(ctx)
@@ -342,7 +342,7 @@ func (s *UserService) UpdateUser(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersCreate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersCreate))
}
return s.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
User: request.Msg.User,
@@ -365,7 +365,7 @@ func (s *UserService) UpdateUser(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersUpdate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersUpdate))
}
}
@@ -451,7 +451,7 @@ func (s *UserService) DeleteUser(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersDelete))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersDelete))
}
email, err := common.GetUserEmail(request.Msg.Name)
@@ -539,7 +539,7 @@ func (s *UserService) UndeleteUser(ctx context.Context, request *connect.Request
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersUndelete))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersUndelete))
}
email, err := common.GetUserEmail(request.Msg.Name)
@@ -591,7 +591,7 @@ func (s *UserService) UpdateEmail(ctx context.Context, request *connect.Request[
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersUpdateEmail))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersUpdateEmail))
}
// Get user by email from the name field
@@ -916,7 +916,7 @@ func (s *UserService) DisableMFA(ctx context.Context, request *connect.Request[v
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
}
if !hasPermission {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.UsersUpdate))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("user does not have permission %q", permission.UsersUpdate))
}
}
diff --git a/backend/api/v1/workspace_service.go b/backend/api/v1/workspace_service.go
index b4db475841..8c3c9a5dee 100644
--- a/backend/api/v1/workspace_service.go
+++ b/backend/api/v1/workspace_service.go
@@ -208,7 +208,7 @@ func (s *WorkspaceService) RotateDirectorySyncToken(ctx context.Context, req *co
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Wrapf(err, "invalid workspace name %q", req.Msg.GetName()))
}
if requested != workspaceID {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("workspace mismatch"))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("workspace mismatch"))
}
// The update path this replaces gated on the same feature. Without it an
@@ -276,7 +276,7 @@ func (s *WorkspaceService) DeleteWorkspace(ctx context.Context, req *connect.Req
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
if contextWorkspaceID := common.GetWorkspaceIDFromContext(ctx); workspaceID != contextWorkspaceID {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot delete workspace %q from workspace %q", workspaceID, contextWorkspaceID))
+ return nil, common.PermissionDeniedError(ctx, errors.Errorf("cannot delete workspace %q from workspace %q", workspaceID, contextWorkspaceID))
}
// Cancel active Stripe subscription if any.
diff --git a/backend/common/context.go b/backend/common/context.go
index 6963d1985a..3a356ef62c 100644
--- a/backend/common/context.go
+++ b/backend/common/context.go
@@ -4,6 +4,8 @@ package common
import (
"context"
+ "connectrpc.com/connect"
+
"google.golang.org/protobuf/types/known/anypb"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
@@ -72,6 +74,16 @@ func SetPermissionDenied(ctx context.Context) {
}
}
+// PermissionDeniedError is the refusal a handler answers with when its own
+// permission check turns the caller away. It marks the request, so the audit
+// interceptor streams the refusal and stamps it WARNING. A license gate, a
+// workflow state or an ownership rule answers connect.NewError directly: none
+// of them is a verdict about a permission the caller holds.
+func PermissionDeniedError(ctx context.Context, err error) *connect.Error {
+ SetPermissionDenied(ctx)
+ return connect.NewError(connect.CodePermissionDenied, err)
+}
+
// WithSetHandlerReached registers a callback the ACL interceptor uses to report
// that it admitted the request to its handler.
func WithSetHandlerReached(ctx context.Context, setHandlerReached func()) context.Context {
diff --git a/backend/common/context_test.go b/backend/common/context_test.go
new file mode 100644
index 0000000000..027973bae3
--- /dev/null
+++ b/backend/common/context_test.go
@@ -0,0 +1,27 @@
+package common
+
+import (
+ "context"
+ "testing"
+
+ "connectrpc.com/connect"
+ "github.com/pkg/errors"
+ "github.com/stretchr/testify/require"
+)
+
+func TestPermissionDeniedErrorMarksTheRequest(t *testing.T) {
+ t.Parallel()
+
+ marked := false
+ ctx := WithSetPermissionDenied(context.Background(), func() { marked = true })
+ err := PermissionDeniedError(ctx, errors.New("user does not have permission"))
+
+ require.Equal(t, connect.CodePermissionDenied, connect.CodeOf(err))
+ require.ErrorContains(t, err, "user does not have permission")
+ require.True(t, marked, "the refusal must reach the audit interceptor")
+
+ // A handler built outside the interceptor chain, and every test that calls
+ // one, reaches this with no setter registered.
+ require.Equal(t, connect.CodePermissionDenied,
+ connect.CodeOf(PermissionDeniedError(context.Background(), errors.New("no setter"))))
+}
diff --git a/backend/component/review/workflow.go b/backend/component/review/workflow.go
index ae26121002..7d4caec0d7 100644
--- a/backend/component/review/workflow.go
+++ b/backend/component/review/workflow.go
@@ -4,7 +4,6 @@ package review
import (
"context"
"database/sql"
- "log/slog"
"time"
"github.com/pkg/errors"
@@ -12,7 +11,6 @@ import (
"google.golang.org/protobuf/proto"
"github.com/bytebase/bytebase/backend/common"
- "github.com/bytebase/bytebase/backend/common/log"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/store"
"github.com/bytebase/bytebase/backend/utils"
@@ -38,6 +36,10 @@ const (
ReasonDraftIssue
ReasonApprovalRequired
ReasonStaleInput
+ // ReasonApproverRoleRequired separates the one ErrorPermissionDenied that
+ // is an IAM verdict about the caller from the project and ownership rules
+ // that answer the same code: only the verdict is marked for the audit log.
+ ReasonApproverRoleRequired
)
// Error is a typed review transition error.
@@ -340,8 +342,13 @@ func (w *Workflow) applyReviewAction(ctx context.Context, project *store.Project
if role == "" {
return nil, workflowError(ErrorInvalidAction, "the issue has been approved")
}
- if !w.canReview(ctx, project, input.Actor, role) {
- return nil, workflowError(ErrorPermissionDenied, "cannot %s because the user does not have the required permission", verb)
+ hasRole, err := w.canReview(ctx, project, input.Actor, role)
+ if err != nil {
+ return nil, workflowWrap(ErrorInternal, err, "failed to check the approver role")
+ }
+ if !hasRole {
+ return nil, workflowReasonError(ErrorPermissionDenied, ReasonApproverRoleRequired,
+ "cannot %s because the user does not have the required permission", verb)
}
if !project.Setting.GetAllowSelfApproval() && issue.CreatorEmail == input.Actor.Email {
return nil, workflowError(ErrorPermissionDenied, "cannot %s because self-approval is not allowed for this project", verb)
@@ -401,19 +408,21 @@ func effectiveLastPlanEditor(plan *store.PlanMessage) string {
return plan.Creator
}
-func (w *Workflow) canReview(ctx context.Context, project *store.ProjectMessage, user *store.UserMessage, role string) bool {
+// canReview reports whether the user holds the role the approval step requires.
+// A policy it cannot read is an error, not a refusal: answering false would tell
+// the caller they lack a role, and file a permission denial in the audit log,
+// for an outage. The rollout sibling, canUserRunEnvironmentTasks, does the same.
+func (w *Workflow) canReview(ctx context.Context, project *store.ProjectMessage, user *store.UserMessage, role string) (bool, error) {
projectPolicy, err := w.store.GetProjectIamPolicy(ctx, project.Workspace, project.ResourceID)
if err != nil {
- slog.Warn("failed to get project IAM policy", slog.String("project", project.ResourceID), log.BBError(err))
- return false
+ return false, errors.Wrapf(err, "failed to get project %s IAM policy", project.ResourceID)
}
workspacePolicy, err := w.store.GetWorkspaceIamPolicy(ctx, project.Workspace)
if err != nil {
- slog.Warn("failed to get workspace IAM policy", slog.String("workspace", project.Workspace), log.BBError(err))
- return false
+ return false, errors.Wrapf(err, "failed to get workspace %s IAM policy", project.Workspace)
}
roles := utils.GetUserFormattedRolesMap(ctx, w.store, project.Workspace, user, projectPolicy.Policy, workspacePolicy.Policy)
- return roles[role]
+ return roles[role], nil
}
func lockIssue(ctx context.Context, tx *sql.Tx, projectID string, issueUID int64) (*store.IssueMessage, error) {
@@ -549,8 +558,8 @@ func workflowError(code ErrorCode, format string, args ...any) error {
return &Error{Code: code, Err: errors.Errorf(format, args...)}
}
-func workflowReasonError(code ErrorCode, reason ErrorReason, message string) error {
- return &Error{Code: code, Reason: reason, Err: errors.New(message)}
+func workflowReasonError(code ErrorCode, reason ErrorReason, format string, args ...any) error {
+ return &Error{Code: code, Reason: reason, Err: errors.Errorf(format, args...)}
}
func workflowWrap(_ ErrorCode, err error, message string) error {
diff --git a/backend/component/review/workflow_test.go b/backend/component/review/workflow_test.go
index db8b85ed7d..cac9a20fea 100644
--- a/backend/component/review/workflow_test.go
+++ b/backend/component/review/workflow_test.go
@@ -2,6 +2,7 @@ package review
import (
"context"
+ "database/sql"
"errors"
"sync"
"testing"
@@ -1282,6 +1283,12 @@ func TestPlanMutationMakesPendingApprovalFindingStale(t *testing.T) {
func setupWorkflowStore(ctx context.Context, t *testing.T) *store.Store {
t.Helper()
+ _, stores := setupWorkflowStoreWithDB(ctx, t)
+ return stores
+}
+
+func setupWorkflowStoreWithDB(ctx context.Context, t *testing.T) (*sql.DB, *store.Store) {
+ t.Helper()
db, stores, _ := testcontainer.NewMetadataDB(t)
@@ -1296,7 +1303,7 @@ func setupWorkflowStore(ctx context.Context, t *testing.T) *store.Store {
`)
require.NoError(t, err)
- return stores
+ return db, stores
}
func createPendingDatabaseChangeApproval(ctx context.Context, t *testing.T, stores *store.Store, roles []string) (*store.PlanMessage, *store.IssueMessage) {
@@ -1326,3 +1333,82 @@ func createPendingDatabaseChangeApproval(ctx context.Context, t *testing.T, stor
require.NoError(t, err)
return plan, issue
}
+
+func TestApproverRoleRefusalCarriesItsReason(t *testing.T) {
+ for _, test := range []struct {
+ name string
+ actor string
+ actorRoles []string
+ wantReason ErrorReason
+ }{
+ {
+ name: "no approver role",
+ actor: "[email protected]",
+ wantReason: ReasonApproverRoleRequired,
+ },
+ {
+ name: "self-approval",
+ actor: "[email protected]",
+ actorRoles: []string{"roles/projectOwner"},
+ wantReason: ReasonUnspecified,
+ },
+ } {
+ t.Run(test.name, func(t *testing.T) {
+ ctx := context.Background()
+ stores := setupWorkflowStore(ctx, t)
+ if len(test.actorRoles) > 0 {
+ _, err := stores.PatchWorkspaceIamPolicy(ctx, &store.PatchIamPolicyMessage{
+ Workspace: "default",
+ Member: common.FormatUserEmail(test.actor),
+ Roles: test.actorRoles,
+ })
+ require.NoError(t, err)
+ }
+ _, issue := createPendingDatabaseChangeApproval(ctx, t, stores, []string{"roles/projectOwner"})
+
+ _, err := NewWorkflow(stores).ReviewIssue(ctx, IssueInput{
+ Workspace: "default",
+ ProjectID: "project-a",
+ IssueUID: issue.UID,
+ Actor: &store.UserMessage{Email: test.actor},
+ Action: ActionApprove,
+ })
+
+ var workflowErr *Error
+ require.ErrorAs(t, err, &workflowErr)
+ require.Equal(t, ErrorPermissionDenied, workflowErr.Code)
+ require.Equal(t, test.wantReason, workflowErr.Reason,
+ "only the IAM verdict is marked for the audit log; the self-approval setting is not")
+ })
+ }
+}
+
+func TestApproverRoleLookupFailureIsNotARefusal(t *testing.T) {
+ ctx := context.Background()
+ db, stores := setupWorkflowStoreWithDB(ctx, t)
+ _, issue := createPendingDatabaseChangeApproval(ctx, t, stores, []string{"roles/projectOwner"})
+
+ // A policy the store cannot parse is the cheapest stand-in for any read
+ // that fails: an outage, a permission error on the metadata database, a
+ // payload written by an older release.
+ _, err := db.ExecContext(ctx, `
+ INSERT INTO policy (workspace, resource_type, resource, type, payload)
+ VALUES ('default', 'PROJECT', 'projects/project-a', 'IAM', '{"bindings": "not a list"}');
+ `)
+ require.NoError(t, err)
+
+ _, err = NewWorkflow(stores).ReviewIssue(ctx, IssueInput{
+ Workspace: "default",
+ ProjectID: "project-a",
+ IssueUID: issue.UID,
+ Actor: &store.UserMessage{Email: "[email protected]"},
+ Action: ActionApprove,
+ })
+
+ var workflowErr *Error
+ require.ErrorAs(t, err, &workflowErr)
+ require.Equal(t, ErrorInternal, workflowErr.Code,
+ "a policy the store cannot read is an outage, not a verdict about the caller")
+ require.Equal(t, ReasonUnspecified, workflowErr.Reason,
+ "an outage must not be marked as a permission denial in the audit log")
+}