mirror of
https://github.com/netbirdio/dex.git
synced 2026-05-22 18:43:53 -07:00
808 lines
27 KiB
Go
808 lines
27 KiB
Go
// Package oidc implements logging in through OpenID Connect providers.
|
|
package oidc
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/url"
|
|
"regexp"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/coreos/go-oidc/v3/oidc"
|
|
"golang.org/x/oauth2"
|
|
|
|
"github.com/dexidp/dex/connector"
|
|
groups_pkg "github.com/dexidp/dex/pkg/groups"
|
|
"github.com/dexidp/dex/pkg/httpclient"
|
|
)
|
|
|
|
const (
|
|
codeChallengeMethodPlain = "plain"
|
|
codeChallengeMethodS256 = "S256"
|
|
)
|
|
|
|
func contains(arr []string, item string) bool {
|
|
for _, itemFromArray := range arr {
|
|
if itemFromArray == item {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Config holds configuration options for OpenID Connect logins.
|
|
type Config struct {
|
|
Issuer string `json:"issuer"`
|
|
// Some offspec providers like Azure, Oracle IDCS have oidc discovery url
|
|
// different from issuer url which causes issuerValidation to fail
|
|
// IssuerAlias provides a way to override the Issuer url
|
|
// from the .well-known/openid-configuration issuer
|
|
IssuerAlias string `json:"issuerAlias"`
|
|
ClientID string `json:"clientID"`
|
|
ClientSecret string `json:"clientSecret"`
|
|
RedirectURI string `json:"redirectURI"`
|
|
|
|
// The section to override options discovered automatically from
|
|
// the providers' discovery URL (.well-known/openid-configuration).
|
|
ProviderDiscoveryOverrides ProviderDiscoveryOverrides `json:"providerDiscoveryOverrides"`
|
|
|
|
// Causes client_secret to be passed as POST parameters instead of basic
|
|
// auth. This is specifically "NOT RECOMMENDED" by the OAuth2 RFC, but some
|
|
// providers require it.
|
|
//
|
|
// https://tools.ietf.org/html/rfc6749#section-2.3.1
|
|
BasicAuthUnsupported *bool `json:"basicAuthUnsupported"`
|
|
|
|
Scopes []string `json:"scopes"` // defaults to "profile" and "email"
|
|
|
|
// HostedDomains was an optional list of whitelisted domains when using the OIDC connector with Google.
|
|
// Only users from a whitelisted domain were allowed to log in.
|
|
// Support for this option was removed from the OIDC connector.
|
|
// Consider switching to the Google connector which supports this option.
|
|
//
|
|
// Deprecated: will be removed in future releases.
|
|
HostedDomains []string `json:"hostedDomains"`
|
|
|
|
// Certificates for SSL validation
|
|
RootCAs []string `json:"rootCAs"`
|
|
|
|
// Override the value of email_verified to true in the returned claims
|
|
InsecureSkipEmailVerified bool `json:"insecureSkipEmailVerified"`
|
|
|
|
// InsecureEnableGroups enables groups claims. This is disabled by default until https://github.com/dexidp/dex/issues/1065 is resolved
|
|
InsecureEnableGroups bool `json:"insecureEnableGroups"`
|
|
AllowedGroups []string `json:"allowedGroups"`
|
|
|
|
// AcrValues (Authentication Context Class Reference Values) that specifies the Authentication Context Class Values
|
|
// within the Authentication Request that the Authorization Server is being requested to use for
|
|
// processing requests from this Client, with the values appearing in order of preference.
|
|
AcrValues []string `json:"acrValues"`
|
|
|
|
// Disable certificate verification
|
|
InsecureSkipVerify bool `json:"insecureSkipVerify"`
|
|
|
|
// GetUserInfo uses the userinfo endpoint to get additional claims for
|
|
// the token. This is especially useful where upstreams return "thin"
|
|
// id tokens
|
|
GetUserInfo bool `json:"getUserInfo"`
|
|
|
|
UserIDKey string `json:"userIDKey"`
|
|
|
|
UserNameKey string `json:"userNameKey"`
|
|
|
|
// PromptType will be used for the prompt parameter (when offline_access, by default prompt=consent)
|
|
PromptType *string `json:"promptType"`
|
|
|
|
// PKCEChallenge specifies which PKCE algorithm will be used
|
|
// If not setted it will be auto-detected the best-fit for the connector.
|
|
PKCEChallenge string `json:"pkceChallenge"`
|
|
|
|
// OverrideClaimMapping will be used to override the options defined in claimMappings.
|
|
// i.e. if there are 'email' and `preferred_email` claims available, by default Dex will always use the `email` claim independent of the ClaimMapping.EmailKey.
|
|
// This setting allows you to override the default behavior of Dex and enforce the mappings defined in `claimMapping`.
|
|
OverrideClaimMapping bool `json:"overrideClaimMapping"` // defaults to false
|
|
|
|
ClaimMapping struct {
|
|
// Configurable key which contains the preferred username claims
|
|
PreferredUsernameKey string `json:"preferred_username"` // defaults to "preferred_username"
|
|
|
|
// Configurable key which contains the email claims
|
|
EmailKey string `json:"email"` // defaults to "email"
|
|
|
|
// Configurable key which contains the groups claims
|
|
GroupsKey string `json:"groups"` // defaults to "groups"
|
|
} `json:"claimMapping"`
|
|
|
|
// ClaimMutations holds all claim mutations options
|
|
ClaimMutations struct {
|
|
NewGroupFromClaims []NewGroupFromClaims `json:"newGroupFromClaims"`
|
|
FilterGroupClaims FilterGroupClaims `json:"filterGroupClaims"`
|
|
ModifyGroupNames ModifyGroupNames `json:"modifyGroupNames"`
|
|
} `json:"claimModifications"`
|
|
}
|
|
|
|
type ProviderDiscoveryOverrides struct {
|
|
// TokenURL provides a way to user overwrite the Token URL
|
|
// from the .well-known/openid-configuration token_endpoint
|
|
TokenURL string `json:"tokenURL"`
|
|
// AuthURL provides a way to user overwrite the Auth URL
|
|
// from the .well-known/openid-configuration authorization_endpoint
|
|
AuthURL string `json:"authURL"`
|
|
// JWKSURL provides a way to user overwrite the JWKS URL
|
|
// from the .well-known/openid-configuration jwks_uri
|
|
JWKSURL string `json:"jwksURL"`
|
|
// EndSessionURL provides a way to override the end_session_endpoint
|
|
// from the .well-known/openid-configuration
|
|
EndSessionURL string `json:"endSessionURL"`
|
|
}
|
|
|
|
func (o *ProviderDiscoveryOverrides) Empty() bool {
|
|
return o.TokenURL == "" && o.AuthURL == "" && o.JWKSURL == "" && o.EndSessionURL == ""
|
|
}
|
|
|
|
func getProvider(ctx context.Context, issuer string, overrides ProviderDiscoveryOverrides) (*oidc.Provider, error) {
|
|
provider, err := oidc.NewProvider(ctx, issuer)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to get provider: %v", err)
|
|
}
|
|
|
|
if overrides.Empty() {
|
|
return provider, nil
|
|
}
|
|
|
|
v := &struct {
|
|
Issuer string `json:"issuer"`
|
|
AuthURL string `json:"authorization_endpoint"`
|
|
TokenURL string `json:"token_endpoint"`
|
|
DeviceAuthURL string `json:"device_authorization_endpoint"`
|
|
JWKSURL string `json:"jwks_uri"`
|
|
UserInfoURL string `json:"userinfo_endpoint"`
|
|
Algorithms []string `json:"id_token_signing_alg_values_supported"`
|
|
}{}
|
|
if err := provider.Claims(v); err != nil {
|
|
return nil, fmt.Errorf("failed to extract provider discovery claims: %v", err)
|
|
}
|
|
config := oidc.ProviderConfig{
|
|
IssuerURL: v.Issuer,
|
|
AuthURL: v.AuthURL,
|
|
TokenURL: v.TokenURL,
|
|
DeviceAuthURL: v.DeviceAuthURL,
|
|
JWKSURL: v.JWKSURL,
|
|
UserInfoURL: v.UserInfoURL,
|
|
Algorithms: v.Algorithms,
|
|
}
|
|
|
|
if overrides.TokenURL != "" {
|
|
config.TokenURL = overrides.TokenURL
|
|
}
|
|
if overrides.AuthURL != "" {
|
|
config.AuthURL = overrides.AuthURL
|
|
}
|
|
if overrides.JWKSURL != "" {
|
|
config.JWKSURL = overrides.JWKSURL
|
|
}
|
|
return config.NewProvider(context.Background()), nil
|
|
}
|
|
|
|
// NewGroupFromClaims creates a new group from a list of claims and appends it to the list of existing groups.
|
|
type NewGroupFromClaims struct {
|
|
// List of claim to join together
|
|
Claims []string `json:"claims"`
|
|
|
|
// String to separate the claims
|
|
Delimiter string `json:"delimiter"`
|
|
|
|
// Should Dex remove the Delimiter string from claim values
|
|
// This is done to keep resulting claim structure in full control of the Dex operator
|
|
ClearDelimiter bool `json:"clearDelimiter"`
|
|
|
|
// String to place before the first claim
|
|
Prefix string `json:"prefix"`
|
|
}
|
|
|
|
// FilterGroupClaims is a regex filter for to keep only the matching groups.
|
|
// This is useful when the groups list is too large to fit within an HTTP header.
|
|
type FilterGroupClaims struct {
|
|
GroupsFilter string `json:"groupsFilter"`
|
|
}
|
|
|
|
// ModifyGroupNames allows to modify the group claims by adding a prefix and/or suffix to each group.
|
|
type ModifyGroupNames struct {
|
|
Prefix string `json:"prefix"`
|
|
Suffix string `json:"suffix"`
|
|
}
|
|
|
|
// Domains that don't support basic auth. golang.org/x/oauth2 has an internal
|
|
// list, but it only matches specific URLs, not top level domains.
|
|
var brokenAuthHeaderDomains = []string{
|
|
// See: https://github.com/dexidp/dex/issues/859
|
|
"okta.com",
|
|
"oktapreview.com",
|
|
}
|
|
|
|
// connectorData stores information for sessions authenticated by this connector
|
|
type connectorData struct {
|
|
RefreshToken []byte
|
|
IDToken []byte // raw upstream id_token JWT for RP-Initiated logout
|
|
}
|
|
|
|
// Detect auth header provider issues for known providers. This lets users
|
|
// avoid having to explicitly set "basicAuthUnsupported" in their config.
|
|
//
|
|
// Setting the config field always overrides values returned by this function.
|
|
func knownBrokenAuthHeaderProvider(issuerURL string) bool {
|
|
if u, err := url.Parse(issuerURL); err == nil {
|
|
for _, host := range brokenAuthHeaderDomains {
|
|
if u.Host == host || strings.HasSuffix(u.Host, "."+host) {
|
|
return true
|
|
}
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// PKCEChallengeData is used to store info for PKCE Challenge method and verifier
|
|
// in the connectorData
|
|
type PKCEChallengeData struct {
|
|
CodeChallenge string `json:"codeChallenge"`
|
|
CodeChallengeMethod string `json:"codeChallengeMethod"`
|
|
}
|
|
|
|
// Returns an AuthCodeOption according to the provided codeChallengeMethod
|
|
func getAuthCodeOptionForCodeChallenge(codeVerifier, codeChallengeMethod string) (oauth2.AuthCodeOption, error) {
|
|
switch codeChallengeMethod {
|
|
case codeChallengeMethodPlain:
|
|
return oauth2.VerifierOption(codeVerifier), nil
|
|
case codeChallengeMethodS256:
|
|
return oauth2.S256ChallengeOption(codeVerifier), nil
|
|
default:
|
|
return nil, fmt.Errorf("unknown challenge method (%v)", codeChallengeMethod)
|
|
}
|
|
}
|
|
|
|
// Open returns a connector which can be used to login users through an upstream
|
|
// OpenID Connect provider.
|
|
func (c *Config) Open(id string, logger *slog.Logger) (conn connector.Connector, err error) {
|
|
if len(c.HostedDomains) > 0 {
|
|
return nil, fmt.Errorf("support for the Hosted domains option had been deprecated and removed, consider switching to the Google connector")
|
|
}
|
|
|
|
httpClient, err := httpclient.NewHTTPClient(c.RootCAs, c.InsecureSkipVerify)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
bgctx, cancel := context.WithCancel(context.Background())
|
|
ctx := context.WithValue(bgctx, oauth2.HTTPClient, httpClient)
|
|
if c.IssuerAlias != "" {
|
|
ctx = oidc.InsecureIssuerURLContext(ctx, c.IssuerAlias)
|
|
}
|
|
provider, err := getProvider(ctx, c.Issuer, c.ProviderDiscoveryOverrides)
|
|
if err != nil {
|
|
cancel()
|
|
return nil, err
|
|
}
|
|
if !c.ProviderDiscoveryOverrides.Empty() {
|
|
logger.Warn("overrides for connector are set, this can be a vulnerability when not properly configured", "connector_id", id)
|
|
}
|
|
|
|
endpoint := provider.Endpoint()
|
|
|
|
if c.BasicAuthUnsupported != nil {
|
|
// Setting "basicAuthUnsupported" always overrides our detection.
|
|
if *c.BasicAuthUnsupported {
|
|
endpoint.AuthStyle = oauth2.AuthStyleInParams
|
|
}
|
|
} else if knownBrokenAuthHeaderProvider(c.Issuer) {
|
|
endpoint.AuthStyle = oauth2.AuthStyleInParams
|
|
}
|
|
|
|
scopes := []string{oidc.ScopeOpenID}
|
|
if len(c.Scopes) > 0 {
|
|
scopes = append(scopes, c.Scopes...)
|
|
} else {
|
|
scopes = append(scopes, "profile", "email")
|
|
}
|
|
|
|
// PromptType should be "consent" by default, if not set
|
|
promptType := "consent"
|
|
if c.PromptType != nil {
|
|
promptType = *c.PromptType
|
|
}
|
|
|
|
var groupsFilter *regexp.Regexp
|
|
if c.ClaimMutations.FilterGroupClaims.GroupsFilter != "" {
|
|
groupsFilter, err = regexp.Compile(c.ClaimMutations.FilterGroupClaims.GroupsFilter)
|
|
if err != nil {
|
|
logger.Warn("ignoring invalid", "invalid_regex", c.ClaimMutations.FilterGroupClaims.GroupsFilter, "connector_id", id)
|
|
}
|
|
}
|
|
|
|
// Obtain metadata from the provider
|
|
var metadata struct {
|
|
CodeChallengeMethodsSupported []string `json:"code_challenge_methods_supported"`
|
|
EndSessionEndpoint string `json:"end_session_endpoint"`
|
|
}
|
|
if err := provider.Claims(&metadata); err != nil {
|
|
logger.Warn("failed to parse provider metadata")
|
|
}
|
|
// if PKCEChallenge method has not been setted in the config, auto-detect the best fit
|
|
if c.PKCEChallenge == "" {
|
|
if contains(metadata.CodeChallengeMethodsSupported, codeChallengeMethodS256) {
|
|
c.PKCEChallenge = codeChallengeMethodS256
|
|
} else if contains(metadata.CodeChallengeMethodsSupported, codeChallengeMethodPlain) {
|
|
c.PKCEChallenge = codeChallengeMethodPlain
|
|
}
|
|
} else {
|
|
// if PKCEChallenge method has been setted in the config, check if it is supported
|
|
if !contains(metadata.CodeChallengeMethodsSupported, c.PKCEChallenge) {
|
|
logger.Warn("provided PKCEChallenge method not supported by the connector")
|
|
}
|
|
}
|
|
|
|
endSessionURL := metadata.EndSessionEndpoint
|
|
if c.ProviderDiscoveryOverrides.EndSessionURL != "" {
|
|
endSessionURL = c.ProviderDiscoveryOverrides.EndSessionURL
|
|
}
|
|
if endSessionURL != "" {
|
|
endSessionParsed, err := url.Parse(endSessionURL)
|
|
if err != nil {
|
|
cancel()
|
|
return nil, fmt.Errorf("oidc: invalid end_session_endpoint: %v", err)
|
|
}
|
|
if endSessionParsed.Scheme != "https" && endSessionParsed.Scheme != "http" {
|
|
cancel()
|
|
return nil, fmt.Errorf("oidc: end_session_endpoint must use http or https scheme, got %q", endSessionParsed.Scheme)
|
|
}
|
|
}
|
|
|
|
clientID := c.ClientID
|
|
return &oidcConnector{
|
|
provider: provider,
|
|
redirectURI: c.RedirectURI,
|
|
oauth2Config: &oauth2.Config{
|
|
ClientID: clientID,
|
|
ClientSecret: c.ClientSecret,
|
|
Endpoint: endpoint,
|
|
Scopes: scopes,
|
|
RedirectURL: c.RedirectURI,
|
|
},
|
|
verifier: provider.VerifierContext(
|
|
ctx, // Pass our ctx with customized http.Client
|
|
&oidc.Config{ClientID: clientID},
|
|
),
|
|
logger: logger.With(slog.Group("connector", "type", "oidc", "id", id)),
|
|
cancel: cancel,
|
|
httpClient: httpClient,
|
|
insecureSkipEmailVerified: c.InsecureSkipEmailVerified,
|
|
insecureEnableGroups: c.InsecureEnableGroups,
|
|
allowedGroups: c.AllowedGroups,
|
|
acrValues: c.AcrValues,
|
|
getUserInfo: c.GetUserInfo,
|
|
promptType: promptType,
|
|
userIDKey: c.UserIDKey,
|
|
userNameKey: c.UserNameKey,
|
|
overrideClaimMapping: c.OverrideClaimMapping,
|
|
preferredUsernameKey: c.ClaimMapping.PreferredUsernameKey,
|
|
emailKey: c.ClaimMapping.EmailKey,
|
|
groupsKey: c.ClaimMapping.GroupsKey,
|
|
newGroupFromClaims: c.ClaimMutations.NewGroupFromClaims,
|
|
groupsFilter: groupsFilter,
|
|
groupsPrefix: c.ClaimMutations.ModifyGroupNames.Prefix,
|
|
groupsSuffix: c.ClaimMutations.ModifyGroupNames.Suffix,
|
|
pkceChallenge: c.PKCEChallenge,
|
|
endSessionURL: endSessionURL,
|
|
}, nil
|
|
}
|
|
|
|
var (
|
|
_ connector.CallbackConnector = (*oidcConnector)(nil)
|
|
_ connector.RefreshConnector = (*oidcConnector)(nil)
|
|
_ connector.TokenIdentityConnector = (*oidcConnector)(nil)
|
|
_ connector.LogoutCallbackConnector = (*oidcConnector)(nil)
|
|
)
|
|
|
|
type oidcConnector struct {
|
|
provider *oidc.Provider
|
|
redirectURI string
|
|
oauth2Config *oauth2.Config
|
|
verifier *oidc.IDTokenVerifier
|
|
cancel context.CancelFunc
|
|
logger *slog.Logger
|
|
httpClient *http.Client
|
|
insecureSkipEmailVerified bool
|
|
insecureEnableGroups bool
|
|
allowedGroups []string
|
|
acrValues []string
|
|
getUserInfo bool
|
|
promptType string
|
|
userIDKey string
|
|
userNameKey string
|
|
overrideClaimMapping bool
|
|
preferredUsernameKey string
|
|
emailKey string
|
|
groupsKey string
|
|
newGroupFromClaims []NewGroupFromClaims
|
|
groupsFilter *regexp.Regexp
|
|
groupsPrefix string
|
|
groupsSuffix string
|
|
pkceChallenge string
|
|
endSessionURL string
|
|
}
|
|
|
|
func (c *oidcConnector) Close() error {
|
|
c.cancel()
|
|
return nil
|
|
}
|
|
|
|
func (c *oidcConnector) LoginURL(s connector.Scopes, callbackURL, state string) (string, []byte, error) {
|
|
if c.redirectURI != callbackURL {
|
|
return "", nil, fmt.Errorf("expected callback URL %q did not match the URL in the config %q", callbackURL, c.redirectURI)
|
|
}
|
|
|
|
var opts []oauth2.AuthCodeOption
|
|
var connectorData []byte
|
|
|
|
if len(c.acrValues) > 0 {
|
|
acrValues := strings.Join(c.acrValues, " ")
|
|
opts = append(opts, oauth2.SetAuthURLParam("acr_values", acrValues))
|
|
}
|
|
|
|
if s.OfflineAccess {
|
|
opts = append(opts, oauth2.AccessTypeOffline, oauth2.SetAuthURLParam("prompt", c.promptType))
|
|
}
|
|
|
|
if c.pkceChallenge != "" {
|
|
codeVerifier := oauth2.GenerateVerifier()
|
|
authCodeOption, err := getAuthCodeOptionForCodeChallenge(codeVerifier, c.pkceChallenge)
|
|
if err != nil {
|
|
return "", nil, fmt.Errorf("oidc: failed to get PKCE AuthCodeOption for CodeChallenge: %v", err)
|
|
}
|
|
data := PKCEChallengeData{
|
|
CodeChallenge: codeVerifier,
|
|
CodeChallengeMethod: c.pkceChallenge,
|
|
}
|
|
connectorData, err = json.Marshal(data)
|
|
if err != nil {
|
|
return "", nil, fmt.Errorf("oidc: failed to create PKCEChallenge data: %v", err)
|
|
}
|
|
opts = append(opts, authCodeOption)
|
|
}
|
|
|
|
return c.oauth2Config.AuthCodeURL(state, opts...), connectorData, nil
|
|
}
|
|
|
|
type oauth2Error struct {
|
|
error string
|
|
errorDescription string
|
|
}
|
|
|
|
func (e *oauth2Error) Error() string {
|
|
if e.errorDescription == "" {
|
|
return e.error
|
|
}
|
|
return e.error + ": " + e.errorDescription
|
|
}
|
|
|
|
type caller uint
|
|
|
|
const (
|
|
createCaller caller = iota
|
|
refreshCaller
|
|
exchangeCaller
|
|
)
|
|
|
|
func (c *oidcConnector) HandleCallback(s connector.Scopes, connData []byte, r *http.Request) (identity connector.Identity, err error) {
|
|
q := r.URL.Query()
|
|
if errType := q.Get("error"); errType != "" {
|
|
return identity, &oauth2Error{errType, q.Get("error_description")}
|
|
}
|
|
|
|
ctx := context.WithValue(r.Context(), oauth2.HTTPClient, c.httpClient)
|
|
|
|
var opts []oauth2.AuthCodeOption
|
|
if c.pkceChallenge != "" {
|
|
var data PKCEChallengeData
|
|
if err := json.Unmarshal(connData, &data); err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to parse PKCEChallenge data: %v", err)
|
|
}
|
|
if data.CodeChallenge == "" {
|
|
return identity, fmt.Errorf("oidc: invalid PKCE CodeChallenge")
|
|
}
|
|
opts = append(opts, oauth2.VerifierOption(data.CodeChallenge))
|
|
}
|
|
|
|
token, err := c.oauth2Config.Exchange(ctx, q.Get("code"), opts...)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to get token: %v", err)
|
|
}
|
|
return c.createIdentity(ctx, identity, token, createCaller)
|
|
}
|
|
|
|
// Refresh is used to refresh a session with the refresh token provided by the IdP
|
|
func (c *oidcConnector) Refresh(ctx context.Context, s connector.Scopes, identity connector.Identity) (connector.Identity, error) {
|
|
cd := connectorData{}
|
|
err := json.Unmarshal(identity.ConnectorData, &cd)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to unmarshal connector data: %v", err)
|
|
}
|
|
|
|
ctx = context.WithValue(ctx, oauth2.HTTPClient, c.httpClient)
|
|
|
|
t := &oauth2.Token{
|
|
RefreshToken: string(cd.RefreshToken),
|
|
Expiry: time.Now().Add(-time.Hour),
|
|
}
|
|
token, err := c.oauth2Config.TokenSource(ctx, t).Token()
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to get refresh token: %v", err)
|
|
}
|
|
return c.createIdentity(ctx, identity, token, refreshCaller)
|
|
}
|
|
|
|
func (c *oidcConnector) TokenIdentity(ctx context.Context, subjectTokenType, subjectToken string) (connector.Identity, error) {
|
|
var identity connector.Identity
|
|
|
|
ctx = context.WithValue(ctx, oauth2.HTTPClient, c.httpClient)
|
|
|
|
token := &oauth2.Token{
|
|
AccessToken: subjectToken,
|
|
TokenType: subjectTokenType,
|
|
}
|
|
return c.createIdentity(ctx, identity, token, exchangeCaller)
|
|
}
|
|
|
|
func (c *oidcConnector) createIdentity(ctx context.Context, identity connector.Identity, token *oauth2.Token, caller caller) (connector.Identity, error) {
|
|
var claims map[string]interface{}
|
|
|
|
if rawIDToken, ok := token.Extra("id_token").(string); ok {
|
|
idToken, err := c.verifier.Verify(ctx, rawIDToken)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to verify ID Token: %v", err)
|
|
}
|
|
|
|
if err := idToken.Claims(&claims); err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to decode claims: %v", err)
|
|
}
|
|
} else if caller == exchangeCaller {
|
|
switch token.TokenType {
|
|
case "urn:ietf:params:oauth:token-type:id_token":
|
|
// Verify only works on ID tokens
|
|
idToken, err := c.provider.Verifier(&oidc.Config{SkipClientIDCheck: true}).Verify(ctx, token.AccessToken)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to verify token: %v", err)
|
|
}
|
|
if err := idToken.Claims(&claims); err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to decode claims: %v", err)
|
|
}
|
|
case "urn:ietf:params:oauth:token-type:access_token":
|
|
if !c.getUserInfo {
|
|
return identity, fmt.Errorf("oidc: getUserInfo is required for access token exchange")
|
|
}
|
|
default:
|
|
return identity, fmt.Errorf("unknown token type for token exchange: %s", token.TokenType)
|
|
}
|
|
} else if caller != refreshCaller {
|
|
// ID tokens aren't mandatory in the reply when using a refresh_token grant
|
|
return identity, errors.New("oidc: no id_token in token response")
|
|
}
|
|
|
|
// We immediately want to run getUserInfo if configured before we validate the claims.
|
|
// For token exchanges with access tokens, this is how we verify the token.
|
|
if c.getUserInfo {
|
|
userInfo, err := c.provider.UserInfo(ctx, oauth2.StaticTokenSource(&oauth2.Token{
|
|
AccessToken: token.AccessToken,
|
|
TokenType: "Bearer", // The UserInfo endpoint requires a bearer token as per RFC6750
|
|
}))
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: error loading userinfo: %v", err)
|
|
}
|
|
if err := userInfo.Claims(&claims); err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to decode userinfo claims: %v", err)
|
|
}
|
|
}
|
|
|
|
const subjectClaimKey = "sub"
|
|
subject, found := claims[subjectClaimKey].(string)
|
|
if !found {
|
|
return identity, fmt.Errorf("missing \"%s\" claim", subjectClaimKey)
|
|
}
|
|
|
|
userNameKey := "name"
|
|
if c.userNameKey != "" {
|
|
userNameKey = c.userNameKey
|
|
}
|
|
name, found := claims[userNameKey].(string)
|
|
if !found {
|
|
return identity, fmt.Errorf("missing \"%s\" claim", userNameKey)
|
|
}
|
|
|
|
preferredUsername, found := claims["preferred_username"].(string)
|
|
if (!found || c.overrideClaimMapping) && c.preferredUsernameKey != "" {
|
|
preferredUsername, _ = claims[c.preferredUsernameKey].(string)
|
|
}
|
|
|
|
hasEmailScope := false
|
|
for _, s := range c.oauth2Config.Scopes {
|
|
if s == "email" {
|
|
hasEmailScope = true
|
|
break
|
|
}
|
|
}
|
|
|
|
var email string
|
|
emailKey := "email"
|
|
email, found = claims[emailKey].(string)
|
|
if (!found || c.overrideClaimMapping) && c.emailKey != "" {
|
|
emailKey = c.emailKey
|
|
email, found = claims[emailKey].(string)
|
|
}
|
|
|
|
if !found && hasEmailScope {
|
|
return identity, fmt.Errorf("missing email claim, not found \"%s\" key", emailKey)
|
|
}
|
|
|
|
emailVerified, found := claims["email_verified"].(bool)
|
|
if !found {
|
|
if c.insecureSkipEmailVerified {
|
|
emailVerified = true
|
|
} else if hasEmailScope {
|
|
return identity, errors.New("missing \"email_verified\" claim")
|
|
}
|
|
}
|
|
|
|
var groups []string
|
|
if c.insecureEnableGroups {
|
|
groupsKey := "groups"
|
|
vs, found := claims[groupsKey].([]interface{})
|
|
if (!found || c.overrideClaimMapping) && c.groupsKey != "" {
|
|
groupsKey = c.groupsKey
|
|
vs, found = claims[groupsKey].([]interface{})
|
|
}
|
|
|
|
// Fallback when claims[groupsKey] is a string instead of an array of strings.
|
|
if g, b := claims[groupsKey].(string); b {
|
|
groups = []string{g}
|
|
}
|
|
|
|
if found {
|
|
for _, v := range vs {
|
|
if s, ok := v.(string); ok {
|
|
if c.groupsFilter != nil && !c.groupsFilter.MatchString(s) {
|
|
continue
|
|
}
|
|
groups = append(groups, s)
|
|
} else if groupMap, ok := v.(map[string]interface{}); ok {
|
|
if s, ok := groupMap["name"].(string); ok {
|
|
if c.groupsFilter != nil && !c.groupsFilter.MatchString(s) {
|
|
continue
|
|
}
|
|
groups = append(groups, s)
|
|
}
|
|
} else {
|
|
return identity, fmt.Errorf("malformed \"%v\" claim", groupsKey)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Validate that the user is part of allowedGroups
|
|
if len(c.allowedGroups) > 0 {
|
|
groupMatches := groups_pkg.Filter(groups, c.allowedGroups)
|
|
|
|
if len(groupMatches) == 0 {
|
|
// No group membership matches found, disallowing
|
|
return identity, fmt.Errorf("user not a member of allowed groups")
|
|
}
|
|
|
|
groups = groupMatches
|
|
}
|
|
}
|
|
|
|
// add prefix/suffix to groups
|
|
if c.groupsPrefix != "" || c.groupsSuffix != "" {
|
|
for i, group := range groups {
|
|
groups[i] = c.groupsPrefix + group + c.groupsSuffix
|
|
}
|
|
}
|
|
|
|
for _, config := range c.newGroupFromClaims {
|
|
newGroupSegments := []string{
|
|
config.Prefix,
|
|
}
|
|
for _, claimName := range config.Claims {
|
|
claimValue, ok := claims[claimName].(string)
|
|
if !ok { // Non string claim value are ignored, concatenating them doesn't really make any sense
|
|
continue
|
|
}
|
|
|
|
if config.ClearDelimiter {
|
|
// Removing the delimiter string from the concatenated claim to ensure resulting claim structure
|
|
// is in full control of Dex operator
|
|
claimValue = strings.ReplaceAll(claimValue, config.Delimiter, "")
|
|
}
|
|
|
|
newGroupSegments = append(newGroupSegments, claimValue)
|
|
}
|
|
|
|
if len(newGroupSegments) > 1 {
|
|
groups = append(groups, strings.Join(newGroupSegments, config.Delimiter))
|
|
}
|
|
}
|
|
|
|
cd := connectorData{
|
|
RefreshToken: []byte(token.RefreshToken),
|
|
}
|
|
if rawIDToken, ok := token.Extra("id_token").(string); ok {
|
|
cd.IDToken = []byte(rawIDToken)
|
|
}
|
|
|
|
connData, err := json.Marshal(&cd)
|
|
if err != nil {
|
|
return identity, fmt.Errorf("oidc: failed to encode connector data: %v", err)
|
|
}
|
|
|
|
identity = connector.Identity{
|
|
UserID: subject,
|
|
Username: name,
|
|
PreferredUsername: preferredUsername,
|
|
Email: email,
|
|
EmailVerified: emailVerified,
|
|
Groups: groups,
|
|
ConnectorData: connData,
|
|
}
|
|
|
|
if c.userIDKey != "" {
|
|
userID, found := claims[c.userIDKey].(string)
|
|
if !found {
|
|
return identity, fmt.Errorf("oidc: not found %v claim", c.userIDKey)
|
|
}
|
|
identity.UserID = userID
|
|
}
|
|
|
|
return identity, nil
|
|
}
|
|
|
|
// LogoutURL returns the upstream OIDC provider's end_session_endpoint URL.
|
|
// Per the OIDC RP-Initiated Logout spec, the post_logout_redirect_uri parameter
|
|
// tells the upstream where to redirect after logout.
|
|
func (c *oidcConnector) LogoutURL(_ context.Context, rawConnectorData []byte, postLogoutRedirectURI string) (string, error) {
|
|
if c.endSessionURL == "" {
|
|
return "", nil
|
|
}
|
|
|
|
u, err := url.Parse(c.endSessionURL)
|
|
if err != nil {
|
|
return "", fmt.Errorf("oidc: failed to parse end_session_endpoint: %v", err)
|
|
}
|
|
|
|
q := u.Query()
|
|
if postLogoutRedirectURI != "" {
|
|
q.Set("post_logout_redirect_uri", postLogoutRedirectURI)
|
|
q.Set("client_id", c.oauth2Config.ClientID)
|
|
}
|
|
// Per the RP-Initiated Logout spec, id_token_hint is independently valid
|
|
// of post_logout_redirect_uri — include it whenever we have one.
|
|
if len(rawConnectorData) > 0 {
|
|
var cd connectorData
|
|
if err := json.Unmarshal(rawConnectorData, &cd); err == nil {
|
|
if len(cd.IDToken) > 0 {
|
|
q.Set("id_token_hint", string(cd.IDToken))
|
|
}
|
|
}
|
|
}
|
|
u.RawQuery = q.Encode()
|
|
|
|
return u.String(), nil
|
|
}
|
|
|
|
// HandleLogoutCallback is a no-op for OIDC. The end_session_endpoint simply
|
|
// redirects back without a structured response to validate.
|
|
func (c *oidcConnector) HandleLogoutCallback(_ context.Context, _ *http.Request) error {
|
|
return nil
|
|
}
|