chore: support multi-org group sync with runtime configuration #14578
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,79 @@ | ||
| package idpsync | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/golang-jwt/jwt/v4" | ||
| "github.com/google/uuid" | ||
| "golang.org/x/xerrors" | ||
|
|
||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbauthz" | ||
| ) | ||
|
|
||
| type GroupParams struct { | ||
| // SyncEnabled if false will skip syncing the user's groups | ||
| SyncEnabled bool | ||
| MergedClaims jwt.MapClaims | ||
| } | ||
|
|
||
| func (AGPLIDPSync) GroupSyncEnabled() bool { | ||
| // AGPL does not support syncing groups. | ||
| return false | ||
| } | ||
|
|
||
| func (s AGPLIDPSync) ParseGroupClaims(_ context.Context, _ jwt.MapClaims) (GroupParams, *HTTPError) { | ||
| return GroupParams{ | ||
| SyncEnabled: s.GroupSyncEnabled(), | ||
| }, nil | ||
| } | ||
|
|
||
| // TODO: Group allowlist behavior should probably happen at this step. | ||
| func (s AGPLIDPSync) SyncGroups(ctx context.Context, db database.Store, user database.User, params GroupParams) error { | ||
| // Nothing happens if sync is not enabled | ||
| if !params.SyncEnabled { | ||
| return nil | ||
| } | ||
|
|
||
| // nolint:gocritic // all syncing is done as a system user | ||
| ctx = dbauthz.AsSystemRestricted(ctx) | ||
|
|
||
| db.InTx(func(tx database.Store) error { | ||
| userGroups, err := db.GetGroups(ctx, database.GetGroupsParams{ | ||
| HasMemberID: user.ID, | ||
| }) | ||
| if err != nil { | ||
| return xerrors.Errorf("get user groups: %w", err) | ||
| } | ||
|
|
||
| // Figure out which organizations the user is a member of. | ||
| userOrgs := make(map[uuid.UUID][]database.GetGroupsRow) | ||
| for _, g := range userGroups { | ||
| g := g | ||
| userOrgs[g.Group.OrganizationID] = append(userOrgs[g.Group.OrganizationID], g) | ||
| } | ||
|
|
||
| // Force each organization, we sync the groups. | ||
| db.RemoveUserFromAllGroups(ctx, user.ID) | ||
|
|
||
| return nil | ||
| }, nil) | ||
|
|
||
| // | ||
| //tx.InTx(func(tx database.Store) error { | ||
| // // When setting the user's groups, it's easier to just clear their groups and re-add them. | ||
| // // This ensures that the user's groups are always in sync with the auth provider. | ||
| // err := tx.RemoveUserFromAllGroups(ctx, user.ID) | ||
| // if err != nil { | ||
| // return err | ||
| // } | ||
| // | ||
| // for _, org := range userOrgs { | ||
| // | ||
| // } | ||
| // | ||
| // return nil | ||
| //}, nil) | ||
|
|
||
| return nil | ||
| } | ||
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,28 @@ | ||
| package enidpsync | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/golang-jwt/jwt/v4" | ||
|
|
||
| "github.com/coder/coder/v2/coderd/idpsync" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
|
|
||
| func (e EnterpriseIDPSync) GroupSyncEnabled() bool { | ||
| return e.entitlements.Enabled(codersdk.FeatureTemplateRBAC) | ||
|
|
||
| } | ||
|
|
||
| // ParseGroupClaims returns the groups from the external IDP. | ||
| // TODO: Implement group allow_list behavior here since that is deployment wide. | ||
| func (e EnterpriseIDPSync) ParseGroupClaims(ctx context.Context, mergedClaims jwt.MapClaims) (idpsync.GroupParams, *idpsync.HTTPError) { | ||
| if !e.GroupSyncEnabled() { | ||
| return e.AGPLIDPSync.ParseGroupClaims(ctx, mergedClaims) | ||
| } | ||
|
|
||
| return idpsync.GroupParams{ | ||
| SyncEnabled: e.OrganizationSyncEnabled(), | ||
| MergedClaims: mergedClaims, | ||
| }, nil | ||
| } |
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.
Enterprise license code just handles the
ParseGroupClaims. So AGPL will always be disabled.I put the actual
SyncGroupscode in AGPL so that I can unit test and maintain the sync code all in 1 package. It is a convenience, while still making sure AGPL code cannot leverage this feature.