Skip to content

Implement TeamWhiteList functionality for OIDC providers #591

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Implement TeamWhiteList functionality for OIDC providers #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/cfg/oauth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ type oauthConfig struct {
PreferredDomain string `mapstructure:"preferredDomain"`
AzureToken string `mapstructure:"azure_token" envconfig:"azure_token"`
CodeChallengeMethod string `mapstructure:"code_challenge_method" envconfig:"code_challenge_method"`
TeamWhiteListClaim string `mapstructure:"team_whitelist_claim" envconfig:"team_whitelist_claim"`
// DiscordUseIDs defaults to false, maintaining the more common username checking behavior
// If set to true, match the Discord user's ID instead of their username
DiscordUseIDs bool `mapstructure:"discord_use_ids" envconfig:"discord_use_ids"`
Expand Down
31 changes: 31 additions & 0 deletions pkg/providers/openid/openid.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,25 @@ func (Provider) Configure() {
log = cfg.Logging.Logger
}

func GenerateTeamsOfUser(customClaims *structs.CustomClaims, claimName string) map[string]bool {
teamOutput := make(map[string]bool)
if val, ok := customClaims.Claims[claimName]; ok {

customClaimsSlice := val.([]interface{})

for _, teamValue := range customClaimsSlice {
team, isMyType := teamValue.(string)
if isMyType {
teamOutput[team] = true
}
}

return teamOutput
}
log.Debugf("Claim %s missing from UserInfo response. Make sure you include the correct scope", claimName)
return teamOutput
}

// GetUserInfo provider specific call to get userinfomation
func (Provider) GetUserInfo(r *http.Request, user *structs.User, customClaims *structs.CustomClaims, ptokens *structs.PTokens, opts ...oauth2.AuthCodeOption) (rerr error) {
client, _, err := common.PrepareTokensAndClient(r, ptokens, true, opts...)
Expand All @@ -59,5 +78,17 @@ func (Provider) GetUserInfo(r *http.Request, user *structs.User, customClaims *s
return err
}
user.PrepareUserData()

if len(cfg.Cfg.TeamWhiteList) != 0 && len(cfg.GenOAuth.TeamWhiteListClaim) != 0 {
allTeamsOfUser := GenerateTeamsOfUser(customClaims, cfg.GenOAuth.TeamWhiteListClaim)

for _, whiteListedTeam := range cfg.Cfg.TeamWhiteList {
if allTeamsOfUser[whiteListedTeam] {
user.TeamMemberships = append(user.TeamMemberships, whiteListedTeam)
}
}
}
log.Debug("getUserInfoFromOAuth")
log.Debug(user)
return nil
}