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 AcceptAccessTokenScope string // If non-empty, accept any access token containing this scope as an API token
59 AuthParams map[string]string // Additional parameters to pass with authentication request
61 // override Google People API base URL for testing purposes
62 // (normally empty, set by google pkg to
63 // https://people.googleapis.com/)
64 peopleAPIBasePath string
66 provider *oidc.Provider // initialized by setup()
67 oauth2conf *oauth2.Config // initialized by setup()
68 verifier *oidc.IDTokenVerifier // initialized by setup()
69 mu sync.Mutex // protects setup()
72 // Initialize ctrl.provider and ctrl.oauth2conf.
73 func (ctrl *oidcLoginController) setup() error {
75 defer ctrl.mu.Unlock()
76 if ctrl.provider != nil {
80 redirURL, err := (*url.URL)(&ctrl.Cluster.Services.Controller.ExternalURL).Parse("/" + arvados.EndpointLogin.Path)
82 return fmt.Errorf("error making redirect URL: %s", err)
84 provider, err := oidc.NewProvider(context.Background(), ctrl.Issuer)
88 ctrl.oauth2conf = &oauth2.Config{
89 ClientID: ctrl.ClientID,
90 ClientSecret: ctrl.ClientSecret,
91 Endpoint: provider.Endpoint(),
92 Scopes: []string{oidc.ScopeOpenID, "profile", "email"},
93 RedirectURL: redirURL.String(),
95 ctrl.verifier = provider.Verifier(&oidc.Config{
96 ClientID: ctrl.ClientID,
98 ctrl.provider = provider
102 func (ctrl *oidcLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
103 return logout(ctx, ctrl.Cluster, opts)
106 func (ctrl *oidcLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
109 return loginError(fmt.Errorf("error setting up OpenID Connect provider: %s", err))
111 if opts.State == "" {
112 // Initiate OIDC sign-in.
113 if opts.ReturnTo == "" {
114 return loginError(errors.New("missing return_to parameter"))
116 state := ctrl.newOAuth2State([]byte(ctrl.Cluster.SystemRootToken), opts.Remote, opts.ReturnTo)
117 var authparams []oauth2.AuthCodeOption
118 for k, v := range ctrl.AuthParams {
119 authparams = append(authparams, oauth2.SetAuthURLParam(k, v))
121 return arvados.LoginResponse{
122 RedirectLocation: ctrl.oauth2conf.AuthCodeURL(state.String(), authparams...),
125 // Callback after OIDC sign-in.
126 state := ctrl.parseOAuth2State(opts.State)
127 if !state.verify([]byte(ctrl.Cluster.SystemRootToken)) {
128 return loginError(errors.New("invalid OAuth2 state"))
130 oauth2Token, err := ctrl.oauth2conf.Exchange(ctx, opts.Code)
132 return loginError(fmt.Errorf("error in OAuth2 exchange: %s", err))
134 ctxlog.FromContext(ctx).WithField("oauth2Token", oauth2Token).Debug("oauth2 exchange succeeded")
135 rawIDToken, ok := oauth2Token.Extra("id_token").(string)
137 return loginError(errors.New("error in OAuth2 exchange: no ID token in OAuth2 token"))
139 ctxlog.FromContext(ctx).WithField("rawIDToken", rawIDToken).Debug("oauth2Token provided ID token")
140 idToken, err := ctrl.verifier.Verify(ctx, rawIDToken)
142 return loginError(fmt.Errorf("error verifying ID token: %s", err))
144 authinfo, err := ctrl.getAuthInfo(ctx, oauth2Token, idToken)
146 return loginError(err)
148 ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{ctrl.Cluster.SystemRootToken}})
149 return ctrl.Parent.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
150 ReturnTo: state.Remote + "," + state.ReturnTo,
155 func (ctrl *oidcLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
156 return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
159 // claimser can decode arbitrary claims into a map. Implemented by
160 // *oauth2.IDToken and *oauth2.UserInfo.
161 type claimser interface {
162 Claims(interface{}) error
165 // Use a person's token to get all of their email addresses, with the
166 // primary address at index 0. The provided defaultAddr is always
167 // included in the returned slice, and is used as the primary if the
168 // Google API does not indicate one.
169 func (ctrl *oidcLoginController) getAuthInfo(ctx context.Context, token *oauth2.Token, claimser claimser) (*rpc.UserSessionAuthInfo, error) {
170 var ret rpc.UserSessionAuthInfo
171 defer ctxlog.FromContext(ctx).WithField("ret", &ret).Debug("getAuthInfo returned")
173 var claims map[string]interface{}
174 if err := claimser.Claims(&claims); err != nil {
175 return nil, fmt.Errorf("error extracting claims from token: %s", err)
176 } else if verified, _ := claims[ctrl.EmailVerifiedClaim].(bool); verified || ctrl.EmailVerifiedClaim == "" {
177 // Fall back to this info if the People API call
178 // (below) doesn't return a primary && verified email.
179 name, _ := claims["name"].(string)
180 if names := strings.Fields(strings.TrimSpace(name)); len(names) > 1 {
181 ret.FirstName = strings.Join(names[0:len(names)-1], " ")
182 ret.LastName = names[len(names)-1]
183 } else if len(names) > 0 {
184 ret.FirstName = names[0]
186 ret.Email, _ = claims[ctrl.EmailClaim].(string)
189 if ctrl.UsernameClaim != "" {
190 ret.Username, _ = claims[ctrl.UsernameClaim].(string)
193 if !ctrl.UseGooglePeopleAPI {
195 return nil, fmt.Errorf("cannot log in with unverified email address %q", claims[ctrl.EmailClaim])
200 svc, err := people.NewService(ctx, option.WithTokenSource(ctrl.oauth2conf.TokenSource(ctx, token)), option.WithScopes(people.UserEmailsReadScope))
202 return nil, fmt.Errorf("error setting up People API: %s", err)
204 if p := ctrl.peopleAPIBasePath; p != "" {
205 // Override normal API endpoint (for testing)
208 person, err := people.NewPeopleService(svc).Get("people/me").PersonFields("emailAddresses,names").Do()
210 if strings.Contains(err.Error(), "Error 403") && strings.Contains(err.Error(), "accessNotConfigured") {
211 // Log the original API error, but display
212 // only the "fix config" advice to the user.
213 ctxlog.FromContext(ctx).WithError(err).WithField("email", ret.Email).Error("People API is not enabled")
214 return nil, errors.New("configuration error: Login.GoogleAlternateEmailAddresses is true, but Google People API is not enabled")
216 return nil, fmt.Errorf("error getting profile info from People API: %s", err)
219 // The given/family names returned by the People API and
220 // flagged as "primary" (if any) take precedence over the
221 // split-by-whitespace result from above.
222 for _, name := range person.Names {
223 if name.Metadata != nil && name.Metadata.Primary {
224 ret.FirstName = name.GivenName
225 ret.LastName = name.FamilyName
230 altEmails := map[string]bool{}
232 altEmails[ret.Email] = true
234 for _, ea := range person.EmailAddresses {
235 if ea.Metadata == nil || !ea.Metadata.Verified {
236 ctxlog.FromContext(ctx).WithField("address", ea.Value).Info("skipping unverified email address")
239 altEmails[ea.Value] = true
240 if ea.Metadata.Primary || ret.Email == "" {
244 if len(altEmails) == 0 {
245 return nil, errors.New("cannot log in without a verified email address")
247 for ae := range altEmails {
251 ret.AlternateEmails = append(ret.AlternateEmails, ae)
252 if ret.Username == "" {
253 i := strings.Index(ae, "@")
254 if i > 0 && strings.ToLower(ae[i+1:]) == strings.ToLower(ctrl.Cluster.Users.PreferDomainForUsername) {
255 ret.Username = strings.SplitN(ae[:i], "+", 2)[0]
262 func loginError(sendError error) (resp arvados.LoginResponse, err error) {
263 tmpl, err := template.New("error").Parse(`<h2>Login error:</h2><p>{{.}}</p>`)
267 err = tmpl.Execute(&resp.HTML, sendError.Error())
271 func (ctrl *oidcLoginController) newOAuth2State(key []byte, remote, returnTo string) oauth2State {
273 Time: time.Now().Unix(),
277 s.HMAC = s.computeHMAC(key)
281 type oauth2State struct {
282 HMAC []byte // hash of other fields; see computeHMAC()
283 Time int64 // creation time (unix timestamp)
284 Remote string // remote cluster if requesting a salted token, otherwise blank
285 ReturnTo string // redirect target
288 func (ctrl *oidcLoginController) parseOAuth2State(encoded string) (s oauth2State) {
289 // Errors are not checked. If decoding/parsing fails, the
290 // token will be rejected by verify().
291 decoded, _ := base64.RawURLEncoding.DecodeString(encoded)
292 f := strings.Split(string(decoded), "\n")
296 fmt.Sscanf(f[0], "%x", &s.HMAC)
297 fmt.Sscanf(f[1], "%x", &s.Time)
298 fmt.Sscanf(f[2], "%s", &s.Remote)
299 fmt.Sscanf(f[3], "%s", &s.ReturnTo)
303 func (s oauth2State) verify(key []byte) bool {
304 if delta := time.Now().Unix() - s.Time; delta < 0 || delta > 300 {
307 return hmac.Equal(s.computeHMAC(key), s.HMAC)
310 func (s oauth2State) String() string {
312 enc := base64.NewEncoder(base64.RawURLEncoding, &buf)
313 fmt.Fprintf(enc, "%x\n%x\n%s\n%s", s.HMAC, s.Time, s.Remote, s.ReturnTo)
318 func (s oauth2State) computeHMAC(key []byte) []byte {
319 mac := hmac.New(sha256.New, key)
320 fmt.Fprintf(mac, "%x %s %s", s.Time, s.Remote, s.ReturnTo)
324 func OIDCAccessTokenAuthorizer(cluster *arvados.Cluster, getdb func(context.Context) (*sqlx.DB, error)) *oidcTokenAuthorizer {
325 // We want ctrl to be nil if the chosen controller is not a
326 // *oidcLoginController, so we can ignore the 2nd return value
327 // of this type cast.
328 ctrl, _ := NewConn(cluster).loginController.(*oidcLoginController)
329 cache, err := lru.New2Q(tokenCacheSize)
333 return &oidcTokenAuthorizer{
340 type oidcTokenAuthorizer struct {
341 ctrl *oidcLoginController
342 getdb func(context.Context) (*sqlx.DB, error)
343 cache *lru.TwoQueueCache
346 func (ta *oidcTokenAuthorizer) Middleware(w http.ResponseWriter, r *http.Request, next http.Handler) {
348 // Not using a compatible (OIDC) login controller.
349 } else if authhdr := strings.Split(r.Header.Get("Authorization"), " "); len(authhdr) > 1 && (authhdr[0] == "OAuth2" || authhdr[0] == "Bearer") {
350 err := ta.registerToken(r.Context(), authhdr[1])
352 http.Error(w, err.Error(), http.StatusInternalServerError)
359 func (ta *oidcTokenAuthorizer) WrapCalls(origFunc api.RoutableFunc) api.RoutableFunc {
361 // Not using a compatible (OIDC) login controller.
364 return func(ctx context.Context, opts interface{}) (_ interface{}, err error) {
365 creds, ok := auth.FromContext(ctx)
367 return origFunc(ctx, opts)
369 // Check each token in the incoming request. If any
370 // are valid OAuth2 access tokens, insert/update them
371 // in the database so RailsAPI's auth code accepts
373 for _, tok := range creds.Tokens {
374 err = ta.registerToken(ctx, tok)
379 return origFunc(ctx, opts)
383 // registerToken checks whether tok is a valid OIDC Access Token and,
384 // if so, ensures that an api_client_authorizations row exists so that
385 // RailsAPI will accept it as an Arvados token.
386 func (ta *oidcTokenAuthorizer) registerToken(ctx context.Context, tok string) error {
387 if tok == ta.ctrl.Cluster.SystemRootToken || strings.HasPrefix(tok, "v2/") {
390 if cached, hit := ta.cache.Get(tok); !hit {
391 // Fall through to database and OIDC provider checks
393 } else if exp, ok := cached.(time.Time); ok {
394 // cached negative result (value is expiry time)
395 if time.Now().Before(exp) {
400 // cached positive result
401 aca := cached.(arvados.APIClientAuthorization)
403 if aca.ExpiresAt != "" {
404 t, err := time.Parse(time.RFC3339Nano, aca.ExpiresAt)
406 return fmt.Errorf("error parsing expires_at value: %w", err)
408 expiring = t.Before(time.Now().Add(time.Minute))
415 db, err := ta.getdb(ctx)
419 tx, err := db.Beginx()
424 ctx = ctrlctx.NewWithTransaction(ctx, tx)
426 // We use hmac-sha256(accesstoken,systemroottoken) as the
427 // secret part of our own token, and avoid storing the auth
428 // provider's real secret in our database.
429 mac := hmac.New(sha256.New, []byte(ta.ctrl.Cluster.SystemRootToken))
430 io.WriteString(mac, tok)
431 hmac := fmt.Sprintf("%x", mac.Sum(nil))
434 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)
435 if err != nil && err != sql.ErrNoRows {
436 return fmt.Errorf("database error while checking token: %w", err)
437 } else if err == nil && !expiring {
438 // Token is already in the database as an Arvados
439 // token, and isn't about to expire, so we can pass it
440 // through to RailsAPI etc. regardless of whether it's
441 // an OIDC access token.
444 updating := err == nil
446 // Check whether the token is a valid OIDC access token. If
447 // so, swap it out for an Arvados token (creating/updating an
448 // api_client_authorizations row if needed) which downstream
449 // server components will accept.
450 err = ta.ctrl.setup()
452 return fmt.Errorf("error setting up OpenID Connect provider: %s", err)
454 if ok, err := ta.checkAccessTokenScope(ctx, tok); err != nil || !ok {
455 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
458 oauth2Token := &oauth2.Token{
461 userinfo, err := ta.ctrl.provider.UserInfo(ctx, oauth2.StaticTokenSource(oauth2Token))
463 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
466 ctxlog.FromContext(ctx).WithField("userinfo", userinfo).Debug("(*oidcTokenAuthorizer)registerToken: got userinfo")
467 authinfo, err := ta.ctrl.getAuthInfo(ctx, oauth2Token, userinfo)
472 // Expiry time for our token is one minute longer than our
473 // cache TTL, so we don't pass it through to RailsAPI just as
475 exp := time.Now().UTC().Add(tokenCacheTTL + tokenCacheRaceWindow)
477 var aca arvados.APIClientAuthorization
479 _, err = tx.ExecContext(ctx, `update api_client_authorizations set expires_at=$1 where api_token=$2`, exp, hmac)
481 return fmt.Errorf("error updating token expiry time: %w", err)
483 ctxlog.FromContext(ctx).WithField("HMAC", hmac).Debug("(*oidcTokenAuthorizer)registerToken: updated api_client_authorizations row")
485 aca, err = ta.ctrl.Parent.CreateAPIClientAuthorization(ctx, ta.ctrl.Cluster.SystemRootToken, *authinfo)
489 _, err = tx.ExecContext(ctx, `update api_client_authorizations set api_token=$1, expires_at=$2 where uuid=$3`, hmac, exp, aca.UUID)
491 return fmt.Errorf("error adding OIDC access token to database: %w", err)
494 ctxlog.FromContext(ctx).WithFields(logrus.Fields{"UUID": aca.UUID, "HMAC": hmac}).Debug("(*oidcTokenAuthorizer)registerToken: inserted api_client_authorizations row")
500 aca.ExpiresAt = exp.Format(time.RFC3339Nano)
501 ta.cache.Add(tok, aca)
505 // Check that the provided access token is a JWT with the required
506 // scope. If it is a valid JWT but missing the required scope, we
507 // return a 403 error, otherwise true (acceptable as an API token) or
508 // false (pass through unmodified).
510 // Note we don't check signature or expiry here. We are relying on the
511 // caller to verify those separately (e.g., by calling the UserInfo
513 func (ta *oidcTokenAuthorizer) checkAccessTokenScope(ctx context.Context, tok string) (bool, error) {
514 switch ta.ctrl.AcceptAccessTokenScope {
521 Scope string `json:"scope"`
523 if t, err := jwt.ParseSigned(tok); err != nil {
524 ctxlog.FromContext(ctx).WithError(err).Debug("error parsing jwt")
526 } else if err = t.UnsafeClaimsWithoutVerification(&claims); err != nil {
527 ctxlog.FromContext(ctx).WithError(err).Debug("error extracting jwt claims")
530 for _, s := range strings.Split(claims.Scope, " ") {
531 if s == ta.ctrl.AcceptAccessTokenScope {
535 ctxlog.FromContext(ctx).WithFields(logrus.Fields{"have": claims.Scope, "need": ta.ctrl.AcceptAccessTokenScope}).Infof("unacceptable access token scope")
536 return false, httpserver.ErrorWithStatus(errors.New("unacceptable access token scope"), http.StatusUnauthorized)