Skip to content

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

refactor: simplify token audience by removing release mode suffix (#18682)

p0nyc3f3d1d40053
diff --git a/backend/api/auth/auth.go b/backend/api/auth/auth.go
index 0bfba44276..9873a6e2a2 100644
--- a/backend/api/auth/auth.go
+++ b/backend/api/auth/auth.go
@@ -4,10 +4,8 @@ package auth
import (
"context"
"errors"
- "fmt"
"net/http"
"slices"
- "strconv"
"strings"
"time"
@@ -33,10 +31,10 @@ const (
// Signing key section. For now, this is only used for signing, not for verifying since we only
// have 1 version. But it will be used to maintain backward compatibility if we change the signing mechanism.
keyID = "v1"
- // AccessTokenAudienceFmt is the format of the acccess token audience.
- AccessTokenAudienceFmt = "bb.user.access.%s"
- // MFATempTokenAudienceFmt is the format of the MFA temp token audience.
- MFATempTokenAudienceFmt = "bb.user.mfa-temp.%s"
+ // AccessTokenAudience is the audience for user access tokens.
+ AccessTokenAudience = "bb.user.access"
+ // MFATempTokenAudience is the audience for MFA temporary tokens.
+ MFATempTokenAudience = "bb.user.mfa-temp"
// OAuth2AccessTokenAudience is the audience for OAuth2 access tokens.
OAuth2AccessTokenAudience = "bb.oauth2.access"
apiTokenDuration = 1 * time.Hour
@@ -164,38 +162,22 @@ func (in *APIAuthInterceptor) authenticate(ctx context.Context, accessTokenStr s
return nil, nil, errs.New("failed to parse claim")
}
- // Accept both user access tokens (bb.user.access.{mode}) and OAuth2 access tokens (bb.oauth2.access)
- validUserAudience := fmt.Sprintf(AccessTokenAudienceFmt, in.profile.Mode)
- if !audienceContains(claims.Audience, validUserAudience) && !audienceContains(claims.Audience, OAuth2AccessTokenAudience) {
+ // Accept both user access tokens (bb.user.access) and OAuth2 access tokens (bb.oauth2.access)
+ if !audienceContains(claims.Audience, AccessTokenAudience) && !audienceContains(claims.Audience, OAuth2AccessTokenAudience) {
return nil, nil, errs.Errorf(
- "invalid access token, audience mismatch, got %q, expected %q or %q. you may send request to the wrong environment",
+ "invalid access token, audience mismatch, got %q, expected %q or %q",
claims.Audience,
- validUserAudience,
+ AccessTokenAudience,
OAuth2AccessTokenAudience,
)
}
- // Try to parse subject as integer ID (old tokens), otherwise treat as email (new tokens and OAuth2)
- var user *store.UserMessage
- var err error
- if principalID, parseErr := strconv.Atoi(claims.Subject); parseErr == nil {
- // Old token with numeric ID as subject
- user, err = in.store.GetUserByID(ctx, principalID)
- if err != nil {
- return nil, nil, errs.Errorf("failed to find user ID %q in the access token", principalID)
- }
- if user == nil {
- return nil, nil, errs.Errorf("user ID %q not exists in the access token", principalID)
- }
- } else {
- // New token with email as subject (includes OAuth2 tokens)
- user, err = in.store.GetUserByEmail(ctx, claims.Subject)
- if err != nil {
- return nil, nil, errs.Errorf("failed to find user email %q in the access token", claims.Subject)
- }
- if user == nil {
- return nil, nil, errs.Errorf("user email %q not exists in the access token", claims.Subject)
- }
+ user, err := in.store.GetUserByEmail(ctx, claims.Subject)
+ if err != nil {
+ return nil, nil, errs.Errorf("failed to find user %q in the access token", claims.Subject)
+ }
+ if user == nil {
+ return nil, nil, errs.Errorf("user %q not exists in the access token", claims.Subject)
}
if user.MemberDeleted {
return nil, nil, errs.Errorf("user ID %q has been deactivated by administrators", user.ID)
@@ -226,7 +208,7 @@ func (in *APIAuthInterceptor) getUserConnect(ctx context.Context, accessTokenStr
}
// GetUserEmailFromMFATempToken returns the user email from the MFA temp token.
-func GetUserEmailFromMFATempToken(token string, mode common.ReleaseMode, secret string) (string, error) {
+func GetUserEmailFromMFATempToken(token string, secret string) (string, error) {
claims := &claimsMessage{}
_, err := jwt.ParseWithClaims(token, claims, func(t *jwt.Token) (any, error) {
if t.Method.Alg() != jwt.SigningMethodHS256.Name {
@@ -242,7 +224,7 @@ func GetUserEmailFromMFATempToken(token string, mode common.ReleaseMode, secret
if err != nil {
return "", connect.NewError(connect.CodeUnauthenticated, errs.New("failed to parse claim"))
}
- if !audienceContains(claims.Audience, fmt.Sprintf(MFATempTokenAudienceFmt, mode)) {
+ if !audienceContains(claims.Audience, MFATempTokenAudience) {
return "", connect.NewError(connect.CodeUnauthenticated, errs.New("invalid MFA temp token, audience mismatch"))
}
return claims.Subject, nil
diff --git a/backend/api/auth/tokens.go b/backend/api/auth/tokens.go
index bfde4d90eb..ecb6f489eb 100644
--- a/backend/api/auth/tokens.go
+++ b/backend/api/auth/tokens.go
@@ -4,12 +4,9 @@ import (
"crypto/rand"
"crypto/sha256"
"encoding/base64"
- "fmt"
"time"
"github.com/golang-jwt/jwt/v5"
-
- "github.com/bytebase/bytebase/backend/common"
)
// GenerateOpaqueToken creates a cryptographically random opaque token.
@@ -41,21 +38,21 @@ type oauth2ClaimsMessage struct {
}
// GenerateAPIToken generates an API token.
-func GenerateAPIToken(userEmail string, mode common.ReleaseMode, secret string) (string, error) {
+func GenerateAPIToken(userEmail string, secret string) (string, error) {
expirationTime := time.Now().Add(apiTokenDuration)
- return generateToken(userEmail, fmt.Sprintf(AccessTokenAudienceFmt, mode), expirationTime, []byte(secret))
+ return generateToken(userEmail, AccessTokenAudience, expirationTime, []byte(secret))
}
// GenerateAccessToken generates an access token for web.
-func GenerateAccessToken(userEmail string, mode common.ReleaseMode, secret string, tokenDuration time.Duration) (string, error) {
+func GenerateAccessToken(userEmail string, secret string, tokenDuration time.Duration) (string, error) {
expirationTime := time.Now().Add(tokenDuration)
- return generateToken(userEmail, fmt.Sprintf(AccessTokenAudienceFmt, mode), expirationTime, []byte(secret))
+ return generateToken(userEmail, AccessTokenAudience, expirationTime, []byte(secret))
}
// GenerateMFATempToken generates a temporary token for MFA.
-func GenerateMFATempToken(userEmail string, mode common.ReleaseMode, secret string, tokenDuration time.Duration) (string, error) {
+func GenerateMFATempToken(userEmail string, secret string, tokenDuration time.Duration) (string, error) {
expirationTime := time.Now().Add(tokenDuration)
- return generateToken(userEmail, fmt.Sprintf(MFATempTokenAudienceFmt, mode), expirationTime, []byte(secret))
+ return generateToken(userEmail, MFATempTokenAudience, expirationTime, []byte(secret))
}
// generateToken creates a JWT token for web authentication.
diff --git a/backend/api/oauth2/authorize.go b/backend/api/oauth2/authorize.go
index 94e592044e..1d1cf8031c 100644
--- a/backend/api/oauth2/authorize.go
+++ b/backend/api/oauth2/authorize.go
@@ -6,7 +6,6 @@ import (
"net/http"
"net/url"
"slices"
- "strconv"
"time"
"github.com/golang-jwt/jwt/v5"
@@ -129,30 +128,16 @@ func (s *Service) handleAuthorizePost(c echo.Context) error {
}
// Validate audience
- if !audienceContains(claims.Audience, fmt.Sprintf(auth.AccessTokenAudienceFmt, s.profile.Mode)) {
+ if !audienceContains(claims.Audience, auth.AccessTokenAudience) {
return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "invalid token audience")
}
- // Try to parse subject as integer ID (old tokens), otherwise treat as email (new tokens)
- var user *store.UserMessage
- if principalID, parseErr := strconv.Atoi(claims.Subject); parseErr == nil {
- // Old token with numeric ID as subject
- user, err = s.store.GetUserByID(ctx, principalID)
- if err != nil {
- return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "failed to find user")
- }
- if user == nil {
- return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "user not found")
- }
- } else {
- // New token with email as subject
- user, err = s.store.GetUserByEmail(ctx, claims.Subject)
- if err != nil {
- return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "failed to find user")
- }
- if user == nil {
- return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "user not found")
- }
+ user, err := s.store.GetUserByEmail(ctx, claims.Subject)
+ if err != nil {
+ return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "failed to find user")
+ }
+ if user == nil {
+ return oauth2ErrorRedirect(c, redirectURI, state, "access_denied", "user not found")
}
// Generate authorization code
diff --git a/backend/api/v1/audit.go b/backend/api/v1/audit.go
index bc19ce05b3..92fa85c984 100644
--- a/backend/api/v1/audit.go
+++ b/backend/api/v1/audit.go
@@ -191,7 +191,7 @@ func createAuditLogConnect(ctx context.Context, request, response any, method st
resource = u.Email
} else if loginRequest, ok := request.(*v1pb.LoginRequest); ok && loginRequest.MfaTempToken != nil {
// Extract user email from MFA temp token.
- if userEmail, err := auth.GetUserEmailFromMFATempToken(*loginRequest.MfaTempToken, profile.Mode, secret); err == nil {
+ if userEmail, err := auth.GetUserEmailFromMFATempToken(*loginRequest.MfaTempToken, secret); err == nil {
resource = userEmail
}
}
diff --git a/backend/api/v1/auth_service.go b/backend/api/v1/auth_service.go
index e562e7344a..1687830cb0 100644
--- a/backend/api/v1/auth_service.go
+++ b/backend/api/v1/auth_service.go
@@ -239,7 +239,7 @@ func (s *AuthService) Refresh(ctx context.Context, req *connect.Request[v1pb.Ref
// 7. Issue new tokens
accessTokenDuration := auth.GetAccessTokenDuration(ctx, s.store, s.licenseService)
- accessToken, err := auth.GenerateAccessToken(user.Email, s.profile.Mode, s.secret, accessTokenDuration)
+ accessToken, err := auth.GenerateAccessToken(user.Email, s.secret, accessTokenDuration)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to generate access token"))
}
@@ -666,7 +666,7 @@ func (s *AuthService) authenticateLogin(ctx context.Context, request *v1pb.Login
// completeMFALogin validates MFA temp token and verifies OTP or recovery code.
func (s *AuthService) completeMFALogin(ctx context.Context, request *v1pb.LoginRequest) (*store.UserMessage, error) {
- userEmail, err := auth.GetUserEmailFromMFATempToken(*request.MfaTempToken, s.profile.Mode, s.secret)
+ userEmail, err := auth.GetUserEmailFromMFATempToken(*request.MfaTempToken, s.secret)
if err != nil {
return nil, err
}
@@ -748,7 +748,7 @@ func (s *AuthService) checkMFARequired(user *store.UserMessage, mfaSecondLogin b
return nil, nil
}
- mfaTempToken, err := auth.GenerateMFATempToken(user.Email, s.profile.Mode, s.secret, mfaTempTokenDuration)
+ mfaTempToken, err := auth.GenerateMFATempToken(user.Email, s.secret, mfaTempTokenDuration)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to generate MFA temp token"))
}
@@ -764,9 +764,9 @@ func (s *AuthService) generateLoginToken(ctx context.Context, user *store.UserMe
switch user.Type {
case storepb.PrincipalType_END_USER:
- return auth.GenerateAccessToken(user.Email, s.profile.Mode, s.secret, tokenDuration)
+ return auth.GenerateAccessToken(user.Email, s.secret, tokenDuration)
case storepb.PrincipalType_SERVICE_ACCOUNT:
- return auth.GenerateAPIToken(user.Email, s.profile.Mode, s.secret)
+ return auth.GenerateAPIToken(user.Email, s.secret)
default:
return "", connect.NewError(connect.CodeUnauthenticated, errors.Errorf("user type %s cannot login", user.Type))
}
@@ -873,7 +873,7 @@ func (s *AuthService) ExchangeToken(ctx context.Context, req *connect.Request[v1
}
// Generate Bytebase API token (1 hour duration, same as service account)
- token, err := auth.GenerateAPIToken(user.Email, s.profile.Mode, s.secret)
+ token, err := auth.GenerateAPIToken(user.Email, s.secret)
if err != nil {
return nil, connect.NewError(connect.CodeInternal,
errors.Wrap(err, "failed to generate access token"))