// Copyright (c) 2015-2021 MinIO, Inc. // // This file is part of MinIO Object Storage stack // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package openid import ( "crypto" "crypto/sha1" "crypto/sha256" "encoding/base64" "encoding/json" "errors" "fmt" "io" "net" "net/http" "strconv" "strings" "sync" "time" jwtgo "github.com/golang-jwt/jwt/v4" "github.com/minio/madmin-go" "github.com/minio/minio/internal/arn" "github.com/minio/minio/internal/auth" "github.com/minio/minio/internal/config" "github.com/minio/minio/internal/config/identity/openid/provider" "github.com/minio/pkg/env" iampolicy "github.com/minio/pkg/iam/policy" xnet "github.com/minio/pkg/net" ) // Config - OpenID Config // RSA authentication target arguments type Config struct { *sync.RWMutex Enabled bool `json:"enabled"` JWKS struct { URL *xnet.URL `json:"url"` } `json:"jwks"` URL *xnet.URL `json:"url,omitempty"` ClaimPrefix string `json:"claimPrefix,omitempty"` ClaimName string `json:"claimName,omitempty"` ClaimUserinfo bool `json:"claimUserInfo,omitempty"` RedirectURI string `json:"redirectURI,omitempty"` RedirectURIDynamic bool `json:"redirectURIDynamic"` DiscoveryDoc DiscoveryDoc ClientID string ClientSecret string RolePolicy string roleArn arn.ARN provider provider.Provider publicKeys map[string]crypto.PublicKey transport *http.Transport closeRespFn func(io.ReadCloser) } // UserInfo returns claims for authenticated user from userInfo endpoint. // // Some OIDC implementations such as GitLab do not support // claims as part of the normal oauth2 flow, instead rely // on service providers making calls to IDP to fetch additional // claims available from the UserInfo endpoint func (r *Config) UserInfo(accessToken string) (map[string]interface{}, error) { if r.JWKS.URL == nil || r.JWKS.URL.String() == "" { return nil, errors.New("openid not configured") } transport := http.DefaultTransport if r.transport != nil { transport = r.transport } client := &http.Client{ Transport: transport, } req, err := http.NewRequest(http.MethodPost, r.DiscoveryDoc.UserInfoEndpoint, nil) if err != nil { return nil, err } if accessToken != "" { req.Header.Set("Authorization", "Bearer "+accessToken) } resp, err := client.Do(req) if err != nil { return nil, err } defer r.closeRespFn(resp.Body) if resp.StatusCode != http.StatusOK { // uncomment this for debugging when needed. // reqBytes, _ := httputil.DumpRequest(req, false) // fmt.Println(string(reqBytes)) // respBytes, _ := httputil.DumpResponse(resp, true) // fmt.Println(string(respBytes)) return nil, errors.New(resp.Status) } dec := json.NewDecoder(resp.Body) claims := map[string]interface{}{} if err = dec.Decode(&claims); err != nil { // uncomment this for debugging when needed. // reqBytes, _ := httputil.DumpRequest(req, false) // fmt.Println(string(reqBytes)) // respBytes, _ := httputil.DumpResponse(resp, true) // fmt.Println(string(respBytes)) return nil, err } return claims, nil } // LookupUser lookup userid for the provider func (r Config) LookupUser(userid string) (provider.User, error) { if r.provider != nil { user, err := r.provider.LookupUser(userid) if err != nil && err != provider.ErrAccessTokenExpired { return user, err } if err == provider.ErrAccessTokenExpired { if err = r.provider.LoginWithClientID(r.ClientID, r.ClientSecret); err != nil { return user, err } user, err = r.provider.LookupUser(userid) } return user, err } // Without any specific logic for a provider, all accounts // are always enabled. return provider.User{ID: userid, Enabled: true}, nil } const ( keyCloakVendor = "keycloak" ) // InitializeProvider initializes if any additional vendor specific // information was provided, initialization will return an error // initial login fails. func (r *Config) InitializeProvider(kvs config.KVS) error { vendor := env.Get(EnvIdentityOpenIDVendor, kvs.Get(Vendor)) if vendor == "" { return nil } switch vendor { case keyCloakVendor: adminURL := env.Get(EnvIdentityOpenIDKeyCloakAdminURL, kvs.Get(KeyCloakAdminURL)) realm := env.Get(EnvIdentityOpenIDKeyCloakRealm, kvs.Get(KeyCloakRealm)) return r.InitializeKeycloakProvider(adminURL, realm) default: return fmt.Errorf("Unsupport vendor %s", keyCloakVendor) } } // ProviderEnabled returns true if any vendor specific provider is enabled. func (r Config) ProviderEnabled() bool { return r.Enabled && r.provider != nil } // GetRoleInfo - returns role ARN and policy if present, otherwise returns false // boolean. func (r Config) GetRoleInfo() (arn.ARN, string, bool) { return r.roleArn, r.RolePolicy, r.RolePolicy != "" } // InitializeKeycloakProvider - initializes keycloak provider func (r *Config) InitializeKeycloakProvider(adminURL, realm string) error { var err error r.provider, err = provider.KeyCloak( provider.WithAdminURL(adminURL), provider.WithOpenIDConfig(provider.DiscoveryDoc(r.DiscoveryDoc)), provider.WithTransport(r.transport), provider.WithRealm(realm), ) return err } // PopulatePublicKey - populates a new publickey from the JWKS URL. func (r *Config) PopulatePublicKey() error { if r.JWKS.URL == nil || r.JWKS.URL.String() == "" { return nil } transport := http.DefaultTransport if r.transport != nil { transport = r.transport } client := &http.Client{ Transport: transport, } r.Lock() defer r.Unlock() resp, err := client.Get(r.JWKS.URL.String()) if err != nil { return err } defer r.closeRespFn(resp.Body) if resp.StatusCode != http.StatusOK { return errors.New(resp.Status) } var jwk JWKS if err = json.NewDecoder(resp.Body).Decode(&jwk); err != nil { return err } for _, key := range jwk.Keys { r.publicKeys[key.Kid], err = key.DecodePublicKey() if err != nil { return err } } return nil } // UnmarshalJSON - decodes JSON data. func (r *Config) UnmarshalJSON(data []byte) error { // subtype to avoid recursive call to UnmarshalJSON() type subConfig Config var sr subConfig if err := json.Unmarshal(data, &sr); err != nil { return err } ar := Config(sr) if ar.JWKS.URL == nil || ar.JWKS.URL.String() == "" { *r = ar return nil } *r = ar return nil } // GetDefaultExpiration - returns the expiration seconds expected. func GetDefaultExpiration(dsecs string) (time.Duration, error) { defaultExpiryDuration := time.Duration(60) * time.Minute // Defaults to 1hr. if dsecs != "" { expirySecs, err := strconv.ParseInt(dsecs, 10, 64) if err != nil { return 0, auth.ErrInvalidDuration } // The duration, in seconds, of the role session. // The value can range from 900 seconds (15 minutes) // up to 365 days. if expirySecs < 900 || expirySecs > 31536000 { return 0, auth.ErrInvalidDuration } defaultExpiryDuration = time.Duration(expirySecs) * time.Second } return defaultExpiryDuration, nil } func updateClaimsExpiry(dsecs string, claims map[string]interface{}) error { expStr := claims["exp"] if expStr == "" { return ErrTokenExpired } // No custom duration requested, the claims can be used as is. if dsecs == "" { return nil } expAt, err := auth.ExpToInt64(expStr) if err != nil { return err } defaultExpiryDuration, err := GetDefaultExpiration(dsecs) if err != nil { return err } // Verify if JWT expiry is lesser than default expiry duration, // if that is the case then set the default expiration to be // from the JWT expiry claim. if time.Unix(expAt, 0).UTC().Sub(time.Now().UTC()) < defaultExpiryDuration { defaultExpiryDuration = time.Unix(expAt, 0).UTC().Sub(time.Now().UTC()) } // else honor the specified expiry duration. claims["exp"] = time.Now().UTC().Add(defaultExpiryDuration).Unix() // update with new expiry. return nil } // Validate - validates the id_token. func (r *Config) Validate(token, accessToken, dsecs string) (map[string]interface{}, error) { jp := new(jwtgo.Parser) jp.ValidMethods = []string{ "RS256", "RS384", "RS512", "ES256", "ES384", "ES512", "RS3256", "RS3384", "RS3512", "ES3256", "ES3384", "ES3512", } keyFuncCallback := func(jwtToken *jwtgo.Token) (interface{}, error) { kid, ok := jwtToken.Header["kid"].(string) if !ok { return nil, fmt.Errorf("Invalid kid value %v", jwtToken.Header["kid"]) } r.RLock() defer r.RUnlock() return r.publicKeys[kid], nil } var claims jwtgo.MapClaims jwtToken, err := jp.ParseWithClaims(token, &claims, keyFuncCallback) if err != nil { // Re-populate the public key in-case the JWKS // pubkeys are refreshed if err = r.PopulatePublicKey(); err != nil { return nil, err } jwtToken, err = jwtgo.ParseWithClaims(token, &claims, keyFuncCallback) if err != nil { return nil, err } } if !jwtToken.Valid { return nil, ErrTokenExpired } if err = updateClaimsExpiry(dsecs, claims); err != nil { return nil, err } // If claim user info is enabled, get claims from userInfo // and overwrite them with the claims from JWT. if r.ClaimUserinfo { if accessToken == "" { return nil, errors.New("access_token is mandatory if user_info claim is enabled") } uclaims, err := r.UserInfo(accessToken) if err != nil { return nil, err } for k, v := range uclaims { if _, ok := claims[k]; !ok { // only add to claims not update it. claims[k] = v } } } return claims, nil } // ID returns the provider name and authentication type. func (Config) ID() ID { return "jwt" } // GetSettings - fetches OIDC settings for site-replication related validation. // NOTE that region must be populated by caller as this package does not know. func (r *Config) GetSettings() madmin.OpenIDSettings { res := madmin.OpenIDSettings{} if !r.Enabled { return res } hashedSecret := "" { h := sha256.New() h.Write([]byte(r.ClientSecret)) bs := h.Sum(nil) hashedSecret = base64.RawURLEncoding.EncodeToString(bs) } if r.RolePolicy != "" { res.Roles = make(map[string]madmin.OpenIDProviderSettings) res.Roles[r.roleArn.String()] = madmin.OpenIDProviderSettings{ ClaimUserinfoEnabled: r.ClaimUserinfo, RolePolicy: r.RolePolicy, ClientID: r.ClientID, HashedClientSecret: hashedSecret, } } else { res.ClaimProvider = madmin.OpenIDProviderSettings{ ClaimName: r.ClaimName, ClaimUserinfoEnabled: r.ClaimUserinfo, ClientID: r.ClientID, HashedClientSecret: hashedSecret, } } return res } // OpenID keys and envs. const ( JwksURL = "jwks_url" ConfigURL = "config_url" ClaimName = "claim_name" ClaimUserinfo = "claim_userinfo" ClaimPrefix = "claim_prefix" ClientID = "client_id" ClientSecret = "client_secret" RolePolicy = "role_policy" Vendor = "vendor" Scopes = "scopes" RedirectURI = "redirect_uri" RedirectURIDynamic = "redirect_uri_dynamic" // Vendor specific ENV only enabled if the Vendor matches == "vendor" KeyCloakRealm = "keycloak_realm" KeyCloakAdminURL = "keycloak_admin_url" EnvIdentityOpenIDVendor = "MINIO_IDENTITY_OPENID_VENDOR" EnvIdentityOpenIDClientID = "MINIO_IDENTITY_OPENID_CLIENT_ID" EnvIdentityOpenIDClientSecret = "MINIO_IDENTITY_OPENID_CLIENT_SECRET" EnvIdentityOpenIDURL = "MINIO_IDENTITY_OPENID_CONFIG_URL" EnvIdentityOpenIDClaimName = "MINIO_IDENTITY_OPENID_CLAIM_NAME" EnvIdentityOpenIDClaimUserInfo = "MINIO_IDENTITY_OPENID_CLAIM_USERINFO" EnvIdentityOpenIDClaimPrefix = "MINIO_IDENTITY_OPENID_CLAIM_PREFIX" EnvIdentityOpenIDRolePolicy = "MINIO_IDENTITY_OPENID_ROLE_POLICY" EnvIdentityOpenIDRedirectURI = "MINIO_IDENTITY_OPENID_REDIRECT_URI" EnvIdentityOpenIDRedirectURIDynamic = "MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC" EnvIdentityOpenIDScopes = "MINIO_IDENTITY_OPENID_SCOPES" // Vendor specific ENVs only enabled if the Vendor matches == "vendor" EnvIdentityOpenIDKeyCloakRealm = "MINIO_IDENTITY_OPENID_KEYCLOAK_REALM" EnvIdentityOpenIDKeyCloakAdminURL = "MINIO_IDENTITY_OPENID_KEYCLOAK_ADMIN_URL" ) // DiscoveryDoc - parses the output from openid-configuration // for example https://accounts.google.com/.well-known/openid-configuration type DiscoveryDoc struct { Issuer string `json:"issuer,omitempty"` AuthEndpoint string `json:"authorization_endpoint,omitempty"` TokenEndpoint string `json:"token_endpoint,omitempty"` UserInfoEndpoint string `json:"userinfo_endpoint,omitempty"` RevocationEndpoint string `json:"revocation_endpoint,omitempty"` JwksURI string `json:"jwks_uri,omitempty"` ResponseTypesSupported []string `json:"response_types_supported,omitempty"` SubjectTypesSupported []string `json:"subject_types_supported,omitempty"` IDTokenSigningAlgValuesSupported []string `json:"id_token_signing_alg_values_supported,omitempty"` ScopesSupported []string `json:"scopes_supported,omitempty"` TokenEndpointAuthMethods []string `json:"token_endpoint_auth_methods_supported,omitempty"` ClaimsSupported []string `json:"claims_supported,omitempty"` CodeChallengeMethodsSupported []string `json:"code_challenge_methods_supported,omitempty"` } func parseDiscoveryDoc(u *xnet.URL, transport *http.Transport, closeRespFn func(io.ReadCloser)) (DiscoveryDoc, error) { d := DiscoveryDoc{} req, err := http.NewRequest(http.MethodGet, u.String(), nil) if err != nil { return d, err } clnt := http.Client{ Transport: transport, } resp, err := clnt.Do(req) if err != nil { clnt.CloseIdleConnections() return d, err } defer closeRespFn(resp.Body) if resp.StatusCode != http.StatusOK { return d, err } dec := json.NewDecoder(resp.Body) if err = dec.Decode(&d); err != nil { return d, err } return d, nil } // DefaultKVS - default config for OpenID config var ( DefaultKVS = config.KVS{ config.KV{ Key: ConfigURL, Value: "", }, config.KV{ Key: ClientID, Value: "", }, config.KV{ Key: ClientSecret, Value: "", }, config.KV{ Key: ClaimName, Value: iampolicy.PolicyName, }, config.KV{ Key: ClaimUserinfo, Value: "", }, config.KV{ Key: RolePolicy, Value: "", }, config.KV{ Key: ClaimPrefix, Value: "", }, config.KV{ Key: RedirectURI, Value: "", }, config.KV{ Key: RedirectURIDynamic, Value: "off", }, config.KV{ Key: Scopes, Value: "", }, } ) // Enabled returns if configURL is enabled. func Enabled(kvs config.KVS) bool { return kvs.Get(ConfigURL) != "" } // LookupConfig lookup jwks from config, override with any ENVs. func LookupConfig(kvs config.KVS, transport *http.Transport, closeRespFn func(io.ReadCloser), serverRegion string) (c Config, err error) { // remove this since we have removed this already. kvs.Delete(JwksURL) if err = config.CheckValidKeys(config.IdentityOpenIDSubSys, kvs, DefaultKVS); err != nil { return c, err } c = Config{ RWMutex: &sync.RWMutex{}, ClaimName: env.Get(EnvIdentityOpenIDClaimName, kvs.Get(ClaimName)), ClaimUserinfo: env.Get(EnvIdentityOpenIDClaimUserInfo, kvs.Get(ClaimUserinfo)) == config.EnableOn, ClaimPrefix: env.Get(EnvIdentityOpenIDClaimPrefix, kvs.Get(ClaimPrefix)), RedirectURI: env.Get(EnvIdentityOpenIDRedirectURI, kvs.Get(RedirectURI)), RedirectURIDynamic: env.Get(EnvIdentityOpenIDRedirectURIDynamic, kvs.Get(RedirectURIDynamic)) == config.EnableOn, publicKeys: make(map[string]crypto.PublicKey), ClientID: env.Get(EnvIdentityOpenIDClientID, kvs.Get(ClientID)), ClientSecret: env.Get(EnvIdentityOpenIDClientSecret, kvs.Get(ClientSecret)), RolePolicy: env.Get(EnvIdentityOpenIDRolePolicy, kvs.Get(RolePolicy)), transport: transport, closeRespFn: closeRespFn, } configURL := env.Get(EnvIdentityOpenIDURL, kvs.Get(ConfigURL)) var configURLDomain string if configURL != "" { c.URL, err = xnet.ParseHTTPURL(configURL) if err != nil { return c, err } configURLDomain, _, _ = net.SplitHostPort(c.URL.Host) c.DiscoveryDoc, err = parseDiscoveryDoc(c.URL, transport, closeRespFn) if err != nil { return c, err } } if c.ClaimUserinfo && configURL == "" { return c, errors.New("please specify config_url to enable fetching claims from UserInfo endpoint") } if scopeList := env.Get(EnvIdentityOpenIDScopes, kvs.Get(Scopes)); scopeList != "" { var scopes []string for _, scope := range strings.Split(scopeList, ",") { scope = strings.TrimSpace(scope) if scope == "" { return c, config.Errorf("empty scope value is not allowed '%s', please refer to our documentation", scopeList) } scopes = append(scopes, scope) } // Replace the discovery document scopes by client customized scopes. c.DiscoveryDoc.ScopesSupported = scopes } // Check if claim name is the non-default value and role policy is set. if c.ClaimName != iampolicy.PolicyName && c.RolePolicy != "" { // In the unlikely event that the user specifies // `iampolicy.PolicyName` as the claim name explicitly and sets // a role policy, this check is thwarted, but we will be using // the role policy anyway. return c, config.Errorf("Role Policy and Claim Name cannot both be set.") } if c.RolePolicy != "" { // RolePolicy is valided by IAM System during its // initialization. // Generate role ARN as combination of provider domain and // prefix of client ID. domain := configURLDomain if domain == "" { // Attempt to parse the JWKs URI. domain, _, _ = net.SplitHostPort(c.JWKS.URL.Host) if domain == "" { return c, config.Errorf("unable to generate a domain from the OpenID config.") } } if c.ClientID == "" { return c, config.Errorf("client ID must not be empty") } // We set the resource ID of the role arn as a hash of client // ID, so we can get a short roleARN that stays the same on // restart. var resourceID string { h := sha1.New() h.Write([]byte(c.ClientID)) bs := h.Sum(nil) resourceID = base64.RawURLEncoding.EncodeToString(bs) } c.roleArn, err = arn.NewIAMRoleARN(resourceID, serverRegion) if err != nil { return c, config.Errorf("unable to generate ARN from the OpenID config: %v", err) } } jwksURL := c.DiscoveryDoc.JwksURI if jwksURL == "" { return c, nil } c.JWKS.URL, err = xnet.ParseHTTPURL(jwksURL) if err != nil { return c, err } if err = c.PopulatePublicKey(); err != nil { return c, err } if err = c.InitializeProvider(kvs); err != nil { return c, err } c.Enabled = true return c, nil }