-
Notifications
You must be signed in to change notification settings - Fork 0
feat(core): add scoped impersonation tokens #129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "errors" | ||
| "net/http" | ||
|
|
||
| "github.com/gaucho-racing/sentinel/core/model" | ||
| "github.com/gaucho-racing/sentinel/core/service" | ||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| type impersonateTokenRequest struct { | ||
| UserID string `json:"user_id" binding:"required"` | ||
| ApplicationID string `json:"application_id" binding:"required"` | ||
| } | ||
|
|
||
| type impersonateTokenResponse struct { | ||
| AccessToken string `json:"access_token"` | ||
| TokenID string `json:"token_id"` | ||
| TokenType string `json:"token_type"` | ||
| ExpiresIn int `json:"expires_in"` | ||
| Scope string `json:"scope"` | ||
| } | ||
|
|
||
| func ImpersonateToken(c *gin.Context) { | ||
| c.Header("Cache-Control", "no-store") | ||
| if !RequestTokenExists(c) { | ||
| c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "authentication required"}) | ||
| return | ||
| } | ||
| if !RequestTokenHasScope(c, service.ImpersonationScope) { | ||
| c.AbortWithStatusJSON(http.StatusForbidden, gin.H{"error": "token lacks sentinel:impersonate"}) | ||
| return | ||
| } | ||
|
|
||
| var req impersonateTokenRequest | ||
| if err := c.ShouldBindJSON(&req); err != nil { | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| result, err := service.ImpersonateUser(GetRequestTokenEntityID(c), req.UserID, req.ApplicationID) | ||
| if err != nil { | ||
| switch { | ||
| case errors.Is(err, service.ErrImpersonationCallerNotServiceAccount): | ||
| c.JSON(http.StatusForbidden, gin.H{"error": err.Error()}) | ||
| case errors.Is(err, service.ErrImpersonationAccessDenied): | ||
| c.JSON(http.StatusForbidden, gin.H{"error": err.Error()}) | ||
| case errors.Is(err, service.ErrImpersonationUserNotFound): | ||
| c.JSON(http.StatusNotFound, gin.H{"error": "user not found"}) | ||
| case errors.Is(err, service.ErrImpersonationApplicationNotFound): | ||
| c.JSON(http.StatusNotFound, gin.H{"error": "application not found"}) | ||
| default: | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| recordAudit(c, model.AuditActionImpersonationTokenIssued, "user", result.UserID, model.JSONMap{ | ||
| "application_id": result.ApplicationID, | ||
| "client_id": result.ClientID, | ||
| "token_id": result.TokenID, | ||
| "scope": result.Scope, | ||
| "expires_in": result.ExpiresIn, | ||
| }) | ||
| c.JSON(http.StatusOK, impersonateTokenResponse{ | ||
| AccessToken: result.AccessToken, | ||
| TokenID: result.TokenID, | ||
| TokenType: "Bearer", | ||
| ExpiresIn: result.ExpiresIn, | ||
| Scope: result.Scope, | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| package service | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| "github.com/gaucho-racing/sentinel/core/model" | ||
| "gorm.io/gorm" | ||
| ) | ||
|
|
||
| const ImpersonationScope = "sentinel:impersonate" | ||
| const ImpersonationTokenTTLSeconds = 5 * 60 | ||
| const defaultImpersonationScope = "user:read groups:read" | ||
| const sentinelImpersonationScope = "sentinel:all" | ||
| const sentinelClientID = "sentinel" | ||
|
|
||
| var ErrImpersonationCallerNotServiceAccount = errors.New("impersonation caller must be a service account") | ||
| var ErrImpersonationUserNotFound = errors.New("impersonation user not found") | ||
| var ErrImpersonationApplicationNotFound = errors.New("impersonation application not found") | ||
| var ErrImpersonationAccessDenied = errors.New("user does not have access to the application") | ||
|
|
||
| type ImpersonationResult struct { | ||
| AccessToken string | ||
| TokenID string | ||
| UserID string | ||
| ApplicationID string | ||
| ClientID string | ||
| Scope string | ||
| ExpiresIn int | ||
| } | ||
|
|
||
| func ImpersonateUser(actorEntityID string, userID string, applicationID string) (ImpersonationResult, error) { | ||
| actor, err := GetServiceAccountByEntityID(actorEntityID) | ||
| if err != nil { | ||
| if errors.Is(err, gorm.ErrRecordNotFound) { | ||
| return ImpersonationResult{}, ErrImpersonationCallerNotServiceAccount | ||
| } | ||
| return ImpersonationResult{}, fmt.Errorf("load impersonation caller: %w", err) | ||
| } | ||
|
|
||
| user, err := GetUserByID(userID) | ||
| if err != nil { | ||
| if errors.Is(err, gorm.ErrRecordNotFound) { | ||
| return ImpersonationResult{}, ErrImpersonationUserNotFound | ||
| } | ||
| return ImpersonationResult{}, fmt.Errorf("load impersonation user: %w", err) | ||
| } | ||
|
|
||
| application, err := GetApplicationByID(applicationID) | ||
| if err != nil { | ||
| if errors.Is(err, gorm.ErrRecordNotFound) { | ||
| return ImpersonationResult{}, ErrImpersonationApplicationNotFound | ||
| } | ||
| return ImpersonationResult{}, fmt.Errorf("load impersonation application: %w", err) | ||
| } | ||
|
|
||
| groups, err := impersonationGroups(user.EntityID, application) | ||
| if err != nil { | ||
| return ImpersonationResult{}, err | ||
| } | ||
|
|
||
| scope := defaultImpersonationScope | ||
| if application.ClientID == sentinelClientID { | ||
| scope = sentinelImpersonationScope | ||
| } | ||
|
|
||
| groupNames := make([]string, 0, len(groups)) | ||
| groupIDs := make([]string, 0, len(groups)) | ||
| for _, group := range groups { | ||
| groupNames = append(groupNames, group.Name) | ||
| groupIDs = append(groupIDs, group.ID) | ||
| } | ||
|
|
||
| claims := map[string]interface{}{ | ||
| "entity_type": string(model.EntityTypeUser), | ||
| "user_id": user.ID, | ||
| "groups": groupNames, | ||
| "group_ids": groupIDs, | ||
| "act": map[string]interface{}{ | ||
| "sub": actorEntityID, | ||
| "service_account_id": actor.ID, | ||
| }, | ||
| } | ||
|
|
||
| accessToken, tokenID, err := GenerateTokenWithActor( | ||
| user.EntityID, | ||
| application.ClientID, | ||
| scope, | ||
| ImpersonationTokenTTLSeconds, | ||
| claims, | ||
| actorEntityID, | ||
| ) | ||
| if err != nil { | ||
| return ImpersonationResult{}, fmt.Errorf("mint impersonation token: %w", err) | ||
| } | ||
|
|
||
| return ImpersonationResult{ | ||
| AccessToken: accessToken, | ||
| TokenID: tokenID, | ||
| UserID: user.ID, | ||
| ApplicationID: application.ID, | ||
| ClientID: application.ClientID, | ||
| Scope: scope, | ||
| ExpiresIn: ImpersonationTokenTTLSeconds, | ||
| }, nil | ||
| } | ||
|
|
||
| func impersonationGroups(entityID string, application model.Application) ([]model.Group, error) { | ||
| userGroups, err := GetGroupsForEntity(entityID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("load user groups: %w", err) | ||
| } | ||
|
|
||
| applicationGroups, err := GetGroupsForApplication(application.ID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("load application groups: %w", err) | ||
| } | ||
| if !passesApplicationGate(userGroups, applicationGroups) { | ||
| return nil, ErrImpersonationAccessDenied | ||
| } | ||
| if application.ClientID == sentinelClientID { | ||
| return userGroups, nil | ||
| } | ||
|
|
||
| sentinelApplication, err := GetApplicationByClientID(sentinelClientID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("load sentinel application: %w", err) | ||
| } | ||
| sentinelGroups, err := GetGroupsForApplication(sentinelApplication.ID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("load sentinel groups: %w", err) | ||
| } | ||
|
|
||
| allowed := make(map[string]struct{}, len(applicationGroups)+len(sentinelGroups)) | ||
| for _, group := range applicationGroups { | ||
| allowed[group.ID] = struct{}{} | ||
| } | ||
| for _, group := range sentinelGroups { | ||
| allowed[group.ID] = struct{}{} | ||
| } | ||
|
|
||
| filtered := make([]model.Group, 0, len(userGroups)) | ||
| for _, group := range userGroups { | ||
| if _, ok := allowed[group.ID]; ok { | ||
| filtered = append(filtered, group) | ||
| } | ||
| } | ||
| return filtered, nil | ||
| } | ||
|
|
||
| func passesApplicationGate(userGroups []model.Group, applicationGroups []GroupWithRequired) bool { | ||
| userGroupIDs := make(map[string]struct{}, len(userGroups)) | ||
| for _, group := range userGroups { | ||
| userGroupIDs[group.ID] = struct{}{} | ||
| } | ||
|
|
||
| hasRequiredGroup := false | ||
| for _, group := range applicationGroups { | ||
| if !group.Required { | ||
| continue | ||
| } | ||
| hasRequiredGroup = true | ||
| if _, ok := userGroupIDs[group.ID]; ok { | ||
| return true | ||
| } | ||
| } | ||
| return !hasRequiredGroup | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GetGroupsForEntityreturns everygroup_memberrow without checkinghas_expirationorexpires_at, so a user whose required membership has expired still passespassesApplicationGate, and the expired group is embedded in the impersonation token. Load only active memberships here before enforcing the application gate and constructing authoritative group claims.Useful? React with 👍 / 👎.