Skip to content

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

fix(api): validate service account and workload identity emails (#19901)

p0ny3d1fda072aa0
diff --git a/backend/api/v1/account_email_validation.go b/backend/api/v1/account_email_validation.go
new file mode 100644
index 0000000000..71ce99e56c
--- /dev/null
+++ b/backend/api/v1/account_email_validation.go
@@ -0,0 +1,31 @@
+package v1
+
+import (
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common"
+)
+
+func validateServiceAccountEmail(email string) error {
+ if err := common.ValidateEmail(email); err != nil {
+ return err
+ }
+ if !common.IsServiceAccountEmail(email) {
+ return errors.Errorf("email must end with %s", common.ServiceAccountSuffix)
+ }
+ return nil
+}
+
+func validateWorkloadIdentityEmail(email string) error {
+ if err := common.ValidateEmail(email); err != nil {
+ return err
+ }
+ if !common.IsWorkloadIdentityEmail(email) {
+ return errors.Errorf("email must end with %s", common.WorkloadIdentitySuffix)
+ }
+ return nil
+}
+
+func invalidAccountEmailError(kind, email string, err error) error {
+ return errors.Wrapf(err, "invalid %s email %q", kind, email)
+}
diff --git a/backend/api/v1/account_email_validation_test.go b/backend/api/v1/account_email_validation_test.go
new file mode 100644
index 0000000000..6b7a015959
--- /dev/null
+++ b/backend/api/v1/account_email_validation_test.go
@@ -0,0 +1,77 @@
+package v1
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestValidateServiceAccountEmail(t *testing.T) {
+ tests := []struct {
+ name string
+ email string
+ valid bool
+ }{
+ {
+ name: "valid",
+ email: "[email protected]",
+ valid: true,
+ },
+ {
+ name: "invalid syntax",
+ email: "[email protected]",
+ valid: false,
+ },
+ {
+ name: "wrong suffix",
+ email: "[email protected]",
+ valid: false,
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ err := validateServiceAccountEmail(test.email)
+ if test.valid {
+ require.NoError(t, err)
+ return
+ }
+ require.Error(t, err)
+ })
+ }
+}
+
+func TestValidateWorkloadIdentityEmail(t *testing.T) {
+ tests := []struct {
+ name string
+ email string
+ valid bool
+ }{
+ {
+ name: "valid",
+ email: "[email protected]",
+ valid: true,
+ },
+ {
+ name: "invalid syntax",
+ email: "[email protected]",
+ valid: false,
+ },
+ {
+ name: "wrong suffix",
+ email: "[email protected]",
+ valid: false,
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ err := validateWorkloadIdentityEmail(test.email)
+ if test.valid {
+ require.NoError(t, err)
+ return
+ }
+ require.Error(t, err)
+ })
+ }
+}
diff --git a/backend/api/v1/auth_service.go b/backend/api/v1/auth_service.go
index c4ba40da28..578868f983 100644
--- a/backend/api/v1/auth_service.go
+++ b/backend/api/v1/auth_service.go
@@ -1274,10 +1274,9 @@ func (s *AuthService) ExchangeToken(ctx context.Context, req *connect.Request[v1
return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("email is required"))
}
- // Validate email format
- if !common.IsWorkloadIdentityEmail(request.Email) {
+ if err := validateWorkloadIdentityEmail(request.Email); err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument,
- errors.Errorf("email must end with %s", common.WorkloadIdentitySuffix))
+ invalidAccountEmailError("workload identity", request.Email, err))
}
// Find workload identity by email (cross-workspace lookup since this is unauthenticated).
diff --git a/backend/api/v1/service_account_service.go b/backend/api/v1/service_account_service.go
index 1e5e7ce731..8da21b1518 100644
--- a/backend/api/v1/service_account_service.go
+++ b/backend/api/v1/service_account_service.go
@@ -75,6 +75,9 @@ func (s *ServiceAccountService) CreateServiceAccount(ctx context.Context, reques
projectIDStr = *projectID
}
email := common.BuildServiceAccountEmail(serviceAccountID, projectIDStr)
+ if err := validateServiceAccountEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("service account", email, err))
+ }
// Check for duplicate email
existingSA, err := s.store.GetServiceAccount(ctx, common.GetWorkspaceIDFromContext(ctx), email)
@@ -122,6 +125,9 @@ func (s *ServiceAccountService) GetServiceAccount(ctx context.Context, request *
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateServiceAccountEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("service account", email, err))
+ }
sa, err := s.store.GetServiceAccount(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -214,6 +220,9 @@ func (s *ServiceAccountService) UpdateServiceAccount(ctx context.Context, reques
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateServiceAccountEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("service account", email, err))
+ }
sa, err := s.store.GetServiceAccount(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -270,6 +279,9 @@ func (s *ServiceAccountService) DeleteServiceAccount(ctx context.Context, reques
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateServiceAccountEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("service account", email, err))
+ }
sa, err := s.store.GetServiceAccount(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -296,6 +308,9 @@ func (s *ServiceAccountService) UndeleteServiceAccount(ctx context.Context, requ
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateServiceAccountEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("service account", email, err))
+ }
sa, err := s.store.GetServiceAccount(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
diff --git a/backend/api/v1/workload_identity_service.go b/backend/api/v1/workload_identity_service.go
index d31fe4baf0..ef7c042d7f 100644
--- a/backend/api/v1/workload_identity_service.go
+++ b/backend/api/v1/workload_identity_service.go
@@ -74,6 +74,9 @@ func (s *WorkloadIdentityService) CreateWorkloadIdentity(ctx context.Context, re
projectIDStr = *projectID
}
email := common.BuildWorkloadIdentityEmail(workloadIdentityID, projectIDStr)
+ if err := validateWorkloadIdentityEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("workload identity", email, err))
+ }
// Check for duplicate email
existingWI, err := s.store.GetWorkloadIdentity(ctx, common.GetWorkspaceIDFromContext(ctx), email)
@@ -111,6 +114,9 @@ func (s *WorkloadIdentityService) GetWorkloadIdentity(ctx context.Context, reque
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateWorkloadIdentityEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("workload identity", email, err))
+ }
wi, err := s.store.GetWorkloadIdentity(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -203,6 +209,9 @@ func (s *WorkloadIdentityService) UpdateWorkloadIdentity(ctx context.Context, re
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateWorkloadIdentityEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("workload identity", email, err))
+ }
wi, err := s.store.GetWorkloadIdentity(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -246,6 +255,9 @@ func (s *WorkloadIdentityService) DeleteWorkloadIdentity(ctx context.Context, re
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateWorkloadIdentityEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("workload identity", email, err))
+ }
wi, err := s.store.GetWorkloadIdentity(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
@@ -272,6 +284,9 @@ func (s *WorkloadIdentityService) UndeleteWorkloadIdentity(ctx context.Context,
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ if err := validateWorkloadIdentityEmail(email); err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, invalidAccountEmailError("workload identity", email, err))
+ }
wi, err := s.store.GetWorkloadIdentity(ctx, common.GetWorkspaceIDFromContext(ctx), email)
if err != nil {
diff --git a/backend/tests/account_email_validation_test.go b/backend/tests/account_email_validation_test.go
new file mode 100644
index 0000000000..6dc773dd2f
--- /dev/null
+++ b/backend/tests/account_email_validation_test.go
@@ -0,0 +1,96 @@
+package tests
+
+import (
+ "context"
+ "testing"
+
+ "connectrpc.com/connect"
+ "github.com/stretchr/testify/require"
+
+ v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
+)
+
+func getCurrentWorkspace(ctx context.Context, t *testing.T, ctl *controller) string {
+ t.Helper()
+
+ userResp, err := ctl.userServiceClient.GetUser(ctx, connect.NewRequest(&v1pb.GetUserRequest{
+ Name: ctl.principalName,
+ }))
+ require.NoError(t, err)
+
+ return userResp.Msg.Workspace
+}
+
+func TestServiceAccountEmailValidation(t *testing.T) {
+ t.Run("create rejects invalid generated email", func(t *testing.T) {
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ workspace := getCurrentWorkspace(ctx, t, ctl)
+ _, err = ctl.serviceAccountServiceClient.CreateServiceAccount(ctx, connect.NewRequest(&v1pb.CreateServiceAccountRequest{
+ Parent: workspace,
+ ServiceAccountId: "Bot",
+ ServiceAccount: &v1pb.ServiceAccount{
+ Title: "bot",
+ },
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+ })
+
+ t.Run("get rejects malformed resource email", func(t *testing.T) {
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ _, err = ctl.serviceAccountServiceClient.GetServiceAccount(ctx, connect.NewRequest(&v1pb.GetServiceAccountRequest{
+ Name: "serviceAccounts/[email protected]",
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+ })
+}
+
+func TestWorkloadIdentityEmailValidation(t *testing.T) {
+ t.Run("create rejects invalid generated email", func(t *testing.T) {
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ workspace := getCurrentWorkspace(ctx, t, ctl)
+ _, err = ctl.workloadIdentityServiceClient.CreateWorkloadIdentity(ctx, connect.NewRequest(&v1pb.CreateWorkloadIdentityRequest{
+ Parent: workspace,
+ WorkloadIdentityId: "Bot",
+ WorkloadIdentity: &v1pb.WorkloadIdentity{
+ Title: "bot",
+ },
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+ })
+
+ t.Run("get rejects malformed resource email", func(t *testing.T) {
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ _, err = ctl.workloadIdentityServiceClient.GetWorkloadIdentity(ctx, connect.NewRequest(&v1pb.GetWorkloadIdentityRequest{
+ Name: "workloadIdentities/[email protected]",
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+ })
+}
diff --git a/docs/superpowers/specs/2026-04-08-account-email-validation-design.md b/docs/superpowers/specs/2026-04-08-account-email-validation-design.md
new file mode 100644
index 0000000000..30e3807d31
--- /dev/null
+++ b/docs/superpowers/specs/2026-04-08-account-email-validation-design.md
@@ -0,0 +1,29 @@
+# Account Email Validation
+
+## Goal
+
+Apply the existing backend email validation rule consistently to system-generated
+service account and workload identity emails.
+
+## Scope
+
+- Reject `service_account_id` values that generate malformed emails.
+- Reject `workload_identity_id` values that generate malformed emails.
+- Reject malformed service account emails supplied through resource names.
+- Reject malformed workload identity emails supplied through resource names.
+
+## Approach
+
+- Reuse `common.ValidateEmail(...)` as the canonical syntax check.
+- Preserve service-account and workload-identity suffix checks.
+- Validate generated emails immediately after `BuildServiceAccountEmail(...)`
+ and `BuildWorkloadIdentityEmail(...)`.
+- Validate extracted resource-name emails before store lookups in the affected
+ handlers.
+
+## Testing
+
+- Add integration coverage for invalid service account creation.
+- Add integration coverage for invalid workload identity creation.
+- Add integration coverage for malformed service account resource names.
+- Add integration coverage for malformed workload identity resource names.