1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
24 "git.arvados.org/arvados.git/lib/controller/api"
25 "git.arvados.org/arvados.git/lib/controller/rpc"
26 "git.arvados.org/arvados.git/lib/ctrlctx"
27 "git.arvados.org/arvados.git/sdk/go/arvados"
28 "git.arvados.org/arvados.git/sdk/go/auth"
29 "git.arvados.org/arvados.git/sdk/go/ctxlog"
30 "git.arvados.org/arvados.git/sdk/go/httpserver"
31 "github.com/coreos/go-oidc"
32 lru "github.com/hashicorp/golang-lru"
33 "github.com/jmoiron/sqlx"
34 "github.com/sirupsen/logrus"
36 "google.golang.org/api/option"
37 "google.golang.org/api/people/v1"
38 "gopkg.in/square/go-jose.v2/jwt"
43 tokenCacheNegativeTTL = time.Minute * 5
44 tokenCacheTTL = time.Minute * 10
45 tokenCacheRaceWindow = time.Minute
48 type oidcLoginController struct {
49 Cluster *arvados.Cluster
51 Issuer string // OIDC issuer URL, e.g., "https://accounts.google.com"
54 UseGooglePeopleAPI bool // Use Google People API to look up alternate email addresses
55 EmailClaim string // OpenID claim to use as email address; typically "email"
56 EmailVerifiedClaim string // If non-empty, ensure claim value is true before accepting EmailClaim; typically "email_verified"
57 UsernameClaim string // If non-empty, use as preferred username
58 AcceptAccessToken bool // Accept access tokens as API tokens
59 AcceptAccessTokenScope string // If non-empty, don't accept access tokens as API tokens unless they contain this scope
60 AuthParams map[string]string // Additional parameters to pass with authentication request
62 // override Google People API base URL for testing purposes
63 // (normally empty, set by google pkg to
64 // https://people.googleapis.com/)
65 peopleAPIBasePath string
67 provider *oidc.Provider // initialized by setup()
68 oauth2conf *oauth2.Config // initialized by setup()
69 verifier *oidc.IDTokenVerifier // initialized by setup()
70 mu sync.Mutex // protects setup()
73 // Initialize ctrl.provider and ctrl.oauth2conf.
74 func (ctrl *oidcLoginController) setup() error {
76 defer ctrl.mu.Unlock()
77 if ctrl.provider != nil {
81 redirURL, err := (*url.URL)(&ctrl.Cluster.Services.Controller.ExternalURL).Parse("/" + arvados.EndpointLogin.Path)
83 return fmt.Errorf("error making redirect URL: %s", err)
85 provider, err := oidc.NewProvider(context.Background(), ctrl.Issuer)
89 ctrl.oauth2conf = &oauth2.Config{
90 ClientID: ctrl.ClientID,
91 ClientSecret: ctrl.ClientSecret,
92 Endpoint: provider.Endpoint(),
93 Scopes: []string{oidc.ScopeOpenID, "profile", "email"},
94 RedirectURL: redirURL.String(),
96 ctrl.verifier = provider.Verifier(&oidc.Config{
97 ClientID: ctrl.ClientID,
99 ctrl.provider = provider
103 func (ctrl *oidcLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
104 return logout(ctx, ctrl.Cluster, opts)
107 func (ctrl *oidcLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
110 return loginError(fmt.Errorf("error setting up OpenID Connect provider: %s", err))
112 if opts.State == "" {
113 // Initiate OIDC sign-in.
114 if opts.ReturnTo == "" {
115 return loginError(errors.New("missing return_to parameter"))
117 state := ctrl.newOAuth2State([]byte(ctrl.Cluster.SystemRootToken), opts.Remote, opts.ReturnTo)
118 var authparams []oauth2.AuthCodeOption
119 for k, v := range ctrl.AuthParams {
120 authparams = append(authparams, oauth2.SetAuthURLParam(k, v))
122 return arvados.LoginResponse{
123 RedirectLocation: ctrl.oauth2conf.AuthCodeURL(state.String(), authparams...),
126 // Callback after OIDC sign-in.
127 state := ctrl.parseOAuth2State(opts.State)
128 if !state.verify([]byte(ctrl.Cluster.SystemRootToken)) {
129 return loginError(errors.New("invalid OAuth2 state"))
131 oauth2Token, err := ctrl.oauth2conf.Exchange(ctx, opts.Code)
133 return loginError(fmt.Errorf("error in OAuth2 exchange: %s", err))
135 ctxlog.FromContext(ctx).WithField("oauth2Token", oauth2Token).Debug("oauth2 exchange succeeded")
136 rawIDToken, ok := oauth2Token.Extra("id_token").(string)
138 return loginError(errors.New("error in OAuth2 exchange: no ID token in OAuth2 token"))
140 ctxlog.FromContext(ctx).WithField("rawIDToken", rawIDToken).Debug("oauth2Token provided ID token")
141 idToken, err := ctrl.verifier.Verify(ctx, rawIDToken)
143 return loginError(fmt.Errorf("error verifying ID token: %s", err))
145 authinfo, err := ctrl.getAuthInfo(ctx, oauth2Token, idToken)
147 return loginError(err)
149 ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{ctrl.Cluster.SystemRootToken}})
150 return ctrl.Parent.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
151 ReturnTo: state.Remote + "," + state.ReturnTo,
156 func (ctrl *oidcLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
157 return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
160 // claimser can decode arbitrary claims into a map. Implemented by
161 // *oauth2.IDToken and *oauth2.UserInfo.
162 type claimser interface {
163 Claims(interface{}) error
166 // Use a person's token to get all of their email addresses, with the
167 // primary address at index 0. The provided defaultAddr is always
168 // included in the returned slice, and is used as the primary if the
169 // Google API does not indicate one.
170 func (ctrl *oidcLoginController) getAuthInfo(ctx context.Context, token *oauth2.Token, claimser claimser) (*rpc.UserSessionAuthInfo, error) {
171 var ret rpc.UserSessionAuthInfo
172 defer ctxlog.FromContext(ctx).WithField("ret", &ret).Debug("getAuthInfo returned")
174 var claims map[string]interface{}
175 if err := claimser.Claims(&claims); err != nil {
176 return nil, fmt.Errorf("error extracting claims from token: %s", err)
177 } else if verified, _ := claims[ctrl.EmailVerifiedClaim].(bool); verified || ctrl.EmailVerifiedClaim == "" {
178 // Fall back to this info if the People API call
179 // (below) doesn't return a primary && verified email.
180 givenName, _ := claims["given_name"].(string)
181 familyName, _ := claims["family_name"].(string)
182 if givenName != "" && familyName != "" {
183 ret.FirstName = givenName
184 ret.LastName = familyName
186 name, _ := claims["name"].(string)
187 if names := strings.Fields(strings.TrimSpace(name)); len(names) > 1 {
188 ret.FirstName = strings.Join(names[0:len(names)-1], " ")
189 ret.LastName = names[len(names)-1]
190 } else if len(names) > 0 {
191 ret.FirstName = names[0]
194 ret.Email, _ = claims[ctrl.EmailClaim].(string)
197 if ctrl.UsernameClaim != "" {
198 ret.Username, _ = claims[ctrl.UsernameClaim].(string)
201 if !ctrl.UseGooglePeopleAPI {
203 return nil, fmt.Errorf("cannot log in with unverified email address %q", claims[ctrl.EmailClaim])
208 svc, err := people.NewService(ctx, option.WithTokenSource(ctrl.oauth2conf.TokenSource(ctx, token)), option.WithScopes(people.UserEmailsReadScope))
210 return nil, fmt.Errorf("error setting up People API: %s", err)
212 if p := ctrl.peopleAPIBasePath; p != "" {
213 // Override normal API endpoint (for testing)
216 person, err := people.NewPeopleService(svc).Get("people/me").PersonFields("emailAddresses,names").Do()
218 if strings.Contains(err.Error(), "Error 403") && strings.Contains(err.Error(), "accessNotConfigured") {
219 // Log the original API error, but display
220 // only the "fix config" advice to the user.
221 ctxlog.FromContext(ctx).WithError(err).WithField("email", ret.Email).Error("People API is not enabled")
222 return nil, errors.New("configuration error: Login.GoogleAlternateEmailAddresses is true, but Google People API is not enabled")
224 return nil, fmt.Errorf("error getting profile info from People API: %s", err)
227 // The given/family names returned by the People API and
228 // flagged as "primary" (if any) take precedence over the
229 // split-by-whitespace result from above.
230 for _, name := range person.Names {
231 if name.Metadata != nil && name.Metadata.Primary {
232 ret.FirstName = name.GivenName
233 ret.LastName = name.FamilyName
238 altEmails := map[string]bool{}
240 altEmails[ret.Email] = true
242 for _, ea := range person.EmailAddresses {
243 if ea.Metadata == nil || !ea.Metadata.Verified {
244 ctxlog.FromContext(ctx).WithField("address", ea.Value).Info("skipping unverified email address")
247 altEmails[ea.Value] = true
248 if ea.Metadata.Primary || ret.Email == "" {
252 if len(altEmails) == 0 {
253 return nil, errors.New("cannot log in without a verified email address")
255 for ae := range altEmails {
259 ret.AlternateEmails = append(ret.AlternateEmails, ae)
260 if ret.Username == "" {
261 i := strings.Index(ae, "@")
262 if i > 0 && strings.ToLower(ae[i+1:]) == strings.ToLower(ctrl.Cluster.Users.PreferDomainForUsername) {
263 ret.Username = strings.SplitN(ae[:i], "+", 2)[0]
270 func loginError(sendError error) (resp arvados.LoginResponse, err error) {
271 tmpl, err := template.New("error").Parse(`<h2>Login error:</h2><p>{{.}}</p>`)
275 err = tmpl.Execute(&resp.HTML, sendError.Error())
279 func (ctrl *oidcLoginController) newOAuth2State(key []byte, remote, returnTo string) oauth2State {
281 Time: time.Now().Unix(),
285 s.HMAC = s.computeHMAC(key)
289 type oauth2State struct {
290 HMAC []byte // hash of other fields; see computeHMAC()
291 Time int64 // creation time (unix timestamp)
292 Remote string // remote cluster if requesting a salted token, otherwise blank
293 ReturnTo string // redirect target
296 func (ctrl *oidcLoginController) parseOAuth2State(encoded string) (s oauth2State) {
297 // Errors are not checked. If decoding/parsing fails, the
298 // token will be rejected by verify().
299 decoded, _ := base64.RawURLEncoding.DecodeString(encoded)
300 f := strings.Split(string(decoded), "\n")
304 fmt.Sscanf(f[0], "%x", &s.HMAC)
305 fmt.Sscanf(f[1], "%x", &s.Time)
306 fmt.Sscanf(f[2], "%s", &s.Remote)
307 fmt.Sscanf(f[3], "%s", &s.ReturnTo)
311 func (s oauth2State) verify(key []byte) bool {
312 if delta := time.Now().Unix() - s.Time; delta < 0 || delta > 300 {
315 return hmac.Equal(s.computeHMAC(key), s.HMAC)
318 func (s oauth2State) String() string {
320 enc := base64.NewEncoder(base64.RawURLEncoding, &buf)
321 fmt.Fprintf(enc, "%x\n%x\n%s\n%s", s.HMAC, s.Time, s.Remote, s.ReturnTo)
326 func (s oauth2State) computeHMAC(key []byte) []byte {
327 mac := hmac.New(sha256.New, key)
328 fmt.Fprintf(mac, "%x %s %s", s.Time, s.Remote, s.ReturnTo)
332 func OIDCAccessTokenAuthorizer(cluster *arvados.Cluster, getdb func(context.Context) (*sqlx.DB, error)) *oidcTokenAuthorizer {
333 // We want ctrl to be nil if the chosen controller is not a
334 // *oidcLoginController, so we can ignore the 2nd return value
335 // of this type cast.
336 ctrl, _ := NewConn(cluster).loginController.(*oidcLoginController)
337 cache, err := lru.New2Q(tokenCacheSize)
341 return &oidcTokenAuthorizer{
348 type oidcTokenAuthorizer struct {
349 ctrl *oidcLoginController
350 getdb func(context.Context) (*sqlx.DB, error)
351 cache *lru.TwoQueueCache
354 func (ta *oidcTokenAuthorizer) Middleware(w http.ResponseWriter, r *http.Request, next http.Handler) {
356 // Not using a compatible (OIDC) login controller.
357 } else if authhdr := strings.Split(r.Header.Get("Authorization"), " "); len(authhdr) > 1 && (authhdr[0] == "OAuth2" || authhdr[0] == "Bearer") {
358 err := ta.registerToken(r.Context(), authhdr[1])
360 http.Error(w, err.Error(), http.StatusInternalServerError)
367 func (ta *oidcTokenAuthorizer) WrapCalls(origFunc api.RoutableFunc) api.RoutableFunc {
369 // Not using a compatible (OIDC) login controller.
372 return func(ctx context.Context, opts interface{}) (_ interface{}, err error) {
373 creds, ok := auth.FromContext(ctx)
375 return origFunc(ctx, opts)
377 // Check each token in the incoming request. If any
378 // are valid OAuth2 access tokens, insert/update them
379 // in the database so RailsAPI's auth code accepts
381 for _, tok := range creds.Tokens {
382 err = ta.registerToken(ctx, tok)
387 return origFunc(ctx, opts)
391 // registerToken checks whether tok is a valid OIDC Access Token and,
392 // if so, ensures that an api_client_authorizations row exists so that
393 // RailsAPI will accept it as an Arvados token.
394 func (ta *oidcTokenAuthorizer) registerToken(ctx context.Context, tok string) error {
395 if tok == ta.ctrl.Cluster.SystemRootToken || strings.HasPrefix(tok, "v2/") {
398 if cached, hit := ta.cache.Get(tok); !hit {
399 // Fall through to database and OIDC provider checks
401 } else if exp, ok := cached.(time.Time); ok {
402 // cached negative result (value is expiry time)
403 if time.Now().Before(exp) {
408 // cached positive result
409 aca := cached.(arvados.APIClientAuthorization)
411 if aca.ExpiresAt != "" {
412 t, err := time.Parse(time.RFC3339Nano, aca.ExpiresAt)
414 return fmt.Errorf("error parsing expires_at value: %w", err)
416 expiring = t.Before(time.Now().Add(time.Minute))
423 db, err := ta.getdb(ctx)
427 tx, err := db.Beginx()
432 ctx = ctrlctx.NewWithTransaction(ctx, tx)
434 // We use hmac-sha256(accesstoken,systemroottoken) as the
435 // secret part of our own token, and avoid storing the auth
436 // provider's real secret in our database.
437 mac := hmac.New(sha256.New, []byte(ta.ctrl.Cluster.SystemRootToken))
438 io.WriteString(mac, tok)
439 hmac := fmt.Sprintf("%x", mac.Sum(nil))
442 err = tx.QueryRowContext(ctx, `select (expires_at is not null and expires_at - interval '1 minute' <= current_timestamp at time zone 'UTC') from api_client_authorizations where api_token=$1`, hmac).Scan(&expiring)
443 if err != nil && err != sql.ErrNoRows {
444 return fmt.Errorf("database error while checking token: %w", err)
445 } else if err == nil && !expiring {
446 // Token is already in the database as an Arvados
447 // token, and isn't about to expire, so we can pass it
448 // through to RailsAPI etc. regardless of whether it's
449 // an OIDC access token.
452 updating := err == nil
454 // Check whether the token is a valid OIDC access token. If
455 // so, swap it out for an Arvados token (creating/updating an
456 // api_client_authorizations row if needed) which downstream
457 // server components will accept.
458 err = ta.ctrl.setup()
460 return fmt.Errorf("error setting up OpenID Connect provider: %s", err)
462 if ok, err := ta.checkAccessTokenScope(ctx, tok); err != nil || !ok {
463 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
466 oauth2Token := &oauth2.Token{
469 userinfo, err := ta.ctrl.provider.UserInfo(ctx, oauth2.StaticTokenSource(oauth2Token))
471 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
474 ctxlog.FromContext(ctx).WithField("userinfo", userinfo).Debug("(*oidcTokenAuthorizer)registerToken: got userinfo")
475 authinfo, err := ta.ctrl.getAuthInfo(ctx, oauth2Token, userinfo)
480 // Expiry time for our token is one minute longer than our
481 // cache TTL, so we don't pass it through to RailsAPI just as
483 exp := time.Now().UTC().Add(tokenCacheTTL + tokenCacheRaceWindow)
485 var aca arvados.APIClientAuthorization
487 _, err = tx.ExecContext(ctx, `update api_client_authorizations set expires_at=$1 where api_token=$2`, exp, hmac)
489 return fmt.Errorf("error updating token expiry time: %w", err)
491 ctxlog.FromContext(ctx).WithField("HMAC", hmac).Debug("(*oidcTokenAuthorizer)registerToken: updated api_client_authorizations row")
493 aca, err = ta.ctrl.Parent.CreateAPIClientAuthorization(ctx, ta.ctrl.Cluster.SystemRootToken, *authinfo)
497 _, err = tx.ExecContext(ctx, `update api_client_authorizations set api_token=$1, expires_at=$2 where uuid=$3`, hmac, exp, aca.UUID)
499 return fmt.Errorf("error adding OIDC access token to database: %w", err)
502 ctxlog.FromContext(ctx).WithFields(logrus.Fields{"UUID": aca.UUID, "HMAC": hmac}).Debug("(*oidcTokenAuthorizer)registerToken: inserted api_client_authorizations row")
508 aca.ExpiresAt = exp.Format(time.RFC3339Nano)
509 ta.cache.Add(tok, aca)
513 // Check that the provided access token is a JWT with the required
514 // scope. If it is a valid JWT but missing the required scope, we
515 // return a 403 error, otherwise true (acceptable as an API token) or
516 // false (pass through unmodified).
518 // Return false if configured not to accept access tokens at all.
520 // Note we don't check signature or expiry here. We are relying on the
521 // caller to verify those separately (e.g., by calling the UserInfo
523 func (ta *oidcTokenAuthorizer) checkAccessTokenScope(ctx context.Context, tok string) (bool, error) {
524 if !ta.ctrl.AcceptAccessToken {
526 } else if ta.ctrl.AcceptAccessTokenScope == "" {
530 Scope string `json:"scope"`
532 if t, err := jwt.ParseSigned(tok); err != nil {
533 ctxlog.FromContext(ctx).WithError(err).Debug("error parsing jwt")
535 } else if err = t.UnsafeClaimsWithoutVerification(&claims); err != nil {
536 ctxlog.FromContext(ctx).WithError(err).Debug("error extracting jwt claims")
539 for _, s := range strings.Split(claims.Scope, " ") {
540 if s == ta.ctrl.AcceptAccessTokenScope {
544 ctxlog.FromContext(ctx).WithFields(logrus.Fields{"have": claims.Scope, "need": ta.ctrl.AcceptAccessTokenScope}).Infof("unacceptable access token scope")
545 return false, httpserver.ErrorWithStatus(errors.New("unacceptable access token scope"), http.StatusUnauthorized)