17417: Merge branch 'main' into 17417-add-arm64
[arvados.git] / lib / controller / localdb / login_oidc.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package localdb
6
7 import (
8         "bytes"
9         "context"
10         "crypto/hmac"
11         "crypto/sha256"
12         "database/sql"
13         "encoding/base64"
14         "errors"
15         "fmt"
16         "io"
17         "net/http"
18         "net/url"
19         "strings"
20         "sync"
21         "text/template"
22         "time"
23
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"
35         "golang.org/x/oauth2"
36         "google.golang.org/api/option"
37         "google.golang.org/api/people/v1"
38         "gopkg.in/square/go-jose.v2/jwt"
39 )
40
41 var (
42         tokenCacheSize        = 1000
43         tokenCacheNegativeTTL = time.Minute * 5
44         tokenCacheTTL         = time.Minute * 10
45         tokenCacheRaceWindow  = time.Minute
46 )
47
48 type oidcLoginController struct {
49         Cluster                *arvados.Cluster
50         Parent                 *Conn
51         Issuer                 string // OIDC issuer URL, e.g., "https://accounts.google.com"
52         ClientID               string
53         ClientSecret           string
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
61
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
66
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()
71 }
72
73 // Initialize ctrl.provider and ctrl.oauth2conf.
74 func (ctrl *oidcLoginController) setup() error {
75         ctrl.mu.Lock()
76         defer ctrl.mu.Unlock()
77         if ctrl.provider != nil {
78                 // already set up
79                 return nil
80         }
81         redirURL, err := (*url.URL)(&ctrl.Cluster.Services.Controller.ExternalURL).Parse("/" + arvados.EndpointLogin.Path)
82         if err != nil {
83                 return fmt.Errorf("error making redirect URL: %s", err)
84         }
85         provider, err := oidc.NewProvider(context.Background(), ctrl.Issuer)
86         if err != nil {
87                 return err
88         }
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(),
95         }
96         ctrl.verifier = provider.Verifier(&oidc.Config{
97                 ClientID: ctrl.ClientID,
98         })
99         ctrl.provider = provider
100         return nil
101 }
102
103 func (ctrl *oidcLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
104         return logout(ctx, ctrl.Cluster, opts)
105 }
106
107 func (ctrl *oidcLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
108         err := ctrl.setup()
109         if err != nil {
110                 return loginError(fmt.Errorf("error setting up OpenID Connect provider: %s", err))
111         }
112         if opts.State == "" {
113                 // Initiate OIDC sign-in.
114                 if opts.ReturnTo == "" {
115                         return loginError(errors.New("missing return_to parameter"))
116                 }
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))
121                 }
122                 return arvados.LoginResponse{
123                         RedirectLocation: ctrl.oauth2conf.AuthCodeURL(state.String(), authparams...),
124                 }, nil
125         }
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"))
130         }
131         oauth2Token, err := ctrl.oauth2conf.Exchange(ctx, opts.Code)
132         if err != nil {
133                 return loginError(fmt.Errorf("error in OAuth2 exchange: %s", err))
134         }
135         ctxlog.FromContext(ctx).WithField("oauth2Token", oauth2Token).Debug("oauth2 exchange succeeded")
136         rawIDToken, ok := oauth2Token.Extra("id_token").(string)
137         if !ok {
138                 return loginError(errors.New("error in OAuth2 exchange: no ID token in OAuth2 token"))
139         }
140         ctxlog.FromContext(ctx).WithField("rawIDToken", rawIDToken).Debug("oauth2Token provided ID token")
141         idToken, err := ctrl.verifier.Verify(ctx, rawIDToken)
142         if err != nil {
143                 return loginError(fmt.Errorf("error verifying ID token: %s", err))
144         }
145         authinfo, err := ctrl.getAuthInfo(ctx, oauth2Token, idToken)
146         if err != nil {
147                 return loginError(err)
148         }
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,
152                 AuthInfo: *authinfo,
153         })
154 }
155
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)
158 }
159
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
164 }
165
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")
173
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
185                 } else {
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]
192                         }
193                 }
194                 ret.Email, _ = claims[ctrl.EmailClaim].(string)
195         }
196
197         if ctrl.UsernameClaim != "" {
198                 ret.Username, _ = claims[ctrl.UsernameClaim].(string)
199         }
200
201         if !ctrl.UseGooglePeopleAPI {
202                 if ret.Email == "" {
203                         return nil, fmt.Errorf("cannot log in with unverified email address %q", claims[ctrl.EmailClaim])
204                 }
205                 return &ret, nil
206         }
207
208         svc, err := people.NewService(ctx, option.WithTokenSource(ctrl.oauth2conf.TokenSource(ctx, token)), option.WithScopes(people.UserEmailsReadScope))
209         if err != nil {
210                 return nil, fmt.Errorf("error setting up People API: %s", err)
211         }
212         if p := ctrl.peopleAPIBasePath; p != "" {
213                 // Override normal API endpoint (for testing)
214                 svc.BasePath = p
215         }
216         person, err := people.NewPeopleService(svc).Get("people/me").PersonFields("emailAddresses,names").Do()
217         if err != nil {
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")
223                 }
224                 return nil, fmt.Errorf("error getting profile info from People API: %s", err)
225         }
226
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
234                         break
235                 }
236         }
237
238         altEmails := map[string]bool{}
239         if ret.Email != "" {
240                 altEmails[ret.Email] = true
241         }
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")
245                         continue
246                 }
247                 altEmails[ea.Value] = true
248                 if ea.Metadata.Primary || ret.Email == "" {
249                         ret.Email = ea.Value
250                 }
251         }
252         if len(altEmails) == 0 {
253                 return nil, errors.New("cannot log in without a verified email address")
254         }
255         for ae := range altEmails {
256                 if ae == ret.Email {
257                         continue
258                 }
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]
264                         }
265                 }
266         }
267         return &ret, nil
268 }
269
270 func loginError(sendError error) (resp arvados.LoginResponse, err error) {
271         tmpl, err := template.New("error").Parse(`<h2>Login error:</h2><p>{{.}}</p>`)
272         if err != nil {
273                 return
274         }
275         err = tmpl.Execute(&resp.HTML, sendError.Error())
276         return
277 }
278
279 func (ctrl *oidcLoginController) newOAuth2State(key []byte, remote, returnTo string) oauth2State {
280         s := oauth2State{
281                 Time:     time.Now().Unix(),
282                 Remote:   remote,
283                 ReturnTo: returnTo,
284         }
285         s.HMAC = s.computeHMAC(key)
286         return s
287 }
288
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
294 }
295
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")
301         if len(f) != 4 {
302                 return
303         }
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)
308         return
309 }
310
311 func (s oauth2State) verify(key []byte) bool {
312         if delta := time.Now().Unix() - s.Time; delta < 0 || delta > 300 {
313                 return false
314         }
315         return hmac.Equal(s.computeHMAC(key), s.HMAC)
316 }
317
318 func (s oauth2State) String() string {
319         var buf bytes.Buffer
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)
322         enc.Close()
323         return buf.String()
324 }
325
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)
329         return mac.Sum(nil)
330 }
331
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)
338         if err != nil {
339                 panic(err)
340         }
341         return &oidcTokenAuthorizer{
342                 ctrl:  ctrl,
343                 getdb: getdb,
344                 cache: cache,
345         }
346 }
347
348 type oidcTokenAuthorizer struct {
349         ctrl  *oidcLoginController
350         getdb func(context.Context) (*sqlx.DB, error)
351         cache *lru.TwoQueueCache
352 }
353
354 func (ta *oidcTokenAuthorizer) Middleware(w http.ResponseWriter, r *http.Request, next http.Handler) {
355         if ta.ctrl == nil {
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])
359                 if err != nil {
360                         http.Error(w, err.Error(), http.StatusInternalServerError)
361                         return
362                 }
363         }
364         next.ServeHTTP(w, r)
365 }
366
367 func (ta *oidcTokenAuthorizer) WrapCalls(origFunc api.RoutableFunc) api.RoutableFunc {
368         if ta.ctrl == nil {
369                 // Not using a compatible (OIDC) login controller.
370                 return origFunc
371         }
372         return func(ctx context.Context, opts interface{}) (_ interface{}, err error) {
373                 creds, ok := auth.FromContext(ctx)
374                 if !ok {
375                         return origFunc(ctx, opts)
376                 }
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
380                 // them.
381                 for _, tok := range creds.Tokens {
382                         err = ta.registerToken(ctx, tok)
383                         if err != nil {
384                                 return nil, err
385                         }
386                 }
387                 return origFunc(ctx, opts)
388         }
389 }
390
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/") {
396                 return nil
397         }
398         if cached, hit := ta.cache.Get(tok); !hit {
399                 // Fall through to database and OIDC provider checks
400                 // below
401         } else if exp, ok := cached.(time.Time); ok {
402                 // cached negative result (value is expiry time)
403                 if time.Now().Before(exp) {
404                         return nil
405                 }
406                 ta.cache.Remove(tok)
407         } else {
408                 // cached positive result
409                 aca := cached.(arvados.APIClientAuthorization)
410                 var expiring bool
411                 if !aca.ExpiresAt.IsZero() {
412                         t := aca.ExpiresAt
413                         expiring = t.Before(time.Now().Add(time.Minute))
414                 }
415                 if !expiring {
416                         return nil
417                 }
418         }
419
420         db, err := ta.getdb(ctx)
421         if err != nil {
422                 return err
423         }
424         tx, err := db.Beginx()
425         if err != nil {
426                 return err
427         }
428         defer tx.Rollback()
429         ctx = ctrlctx.NewWithTransaction(ctx, tx)
430
431         // We use hmac-sha256(accesstoken,systemroottoken) as the
432         // secret part of our own token, and avoid storing the auth
433         // provider's real secret in our database.
434         mac := hmac.New(sha256.New, []byte(ta.ctrl.Cluster.SystemRootToken))
435         io.WriteString(mac, tok)
436         hmac := fmt.Sprintf("%x", mac.Sum(nil))
437
438         var expiring bool
439         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)
440         if err != nil && err != sql.ErrNoRows {
441                 return fmt.Errorf("database error while checking token: %w", err)
442         } else if err == nil && !expiring {
443                 // Token is already in the database as an Arvados
444                 // token, and isn't about to expire, so we can pass it
445                 // through to RailsAPI etc. regardless of whether it's
446                 // an OIDC access token.
447                 return nil
448         }
449         updating := err == nil
450
451         // Check whether the token is a valid OIDC access token. If
452         // so, swap it out for an Arvados token (creating/updating an
453         // api_client_authorizations row if needed) which downstream
454         // server components will accept.
455         err = ta.ctrl.setup()
456         if err != nil {
457                 return fmt.Errorf("error setting up OpenID Connect provider: %s", err)
458         }
459         if ok, err := ta.checkAccessTokenScope(ctx, tok); err != nil || !ok {
460                 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
461                 return err
462         }
463         oauth2Token := &oauth2.Token{
464                 AccessToken: tok,
465         }
466         userinfo, err := ta.ctrl.provider.UserInfo(ctx, oauth2.StaticTokenSource(oauth2Token))
467         if err != nil {
468                 ta.cache.Add(tok, time.Now().Add(tokenCacheNegativeTTL))
469                 return nil
470         }
471         ctxlog.FromContext(ctx).WithField("userinfo", userinfo).Debug("(*oidcTokenAuthorizer)registerToken: got userinfo")
472         authinfo, err := ta.ctrl.getAuthInfo(ctx, oauth2Token, userinfo)
473         if err != nil {
474                 return err
475         }
476
477         // Expiry time for our token is one minute longer than our
478         // cache TTL, so we don't pass it through to RailsAPI just as
479         // it's expiring.
480         exp := time.Now().UTC().Add(tokenCacheTTL + tokenCacheRaceWindow)
481
482         var aca arvados.APIClientAuthorization
483         if updating {
484                 _, err = tx.ExecContext(ctx, `update api_client_authorizations set expires_at=$1 where api_token=$2`, exp, hmac)
485                 if err != nil {
486                         return fmt.Errorf("error updating token expiry time: %w", err)
487                 }
488                 ctxlog.FromContext(ctx).WithField("HMAC", hmac).Debug("(*oidcTokenAuthorizer)registerToken: updated api_client_authorizations row")
489         } else {
490                 aca, err = ta.ctrl.Parent.CreateAPIClientAuthorization(ctx, ta.ctrl.Cluster.SystemRootToken, *authinfo)
491                 if err != nil {
492                         return err
493                 }
494                 _, err = tx.ExecContext(ctx, `update api_client_authorizations set api_token=$1, expires_at=$2 where uuid=$3`, hmac, exp, aca.UUID)
495                 if err != nil {
496                         return fmt.Errorf("error adding OIDC access token to database: %w", err)
497                 }
498                 aca.APIToken = hmac
499                 ctxlog.FromContext(ctx).WithFields(logrus.Fields{"UUID": aca.UUID, "HMAC": hmac}).Debug("(*oidcTokenAuthorizer)registerToken: inserted api_client_authorizations row")
500         }
501         err = tx.Commit()
502         if err != nil {
503                 return err
504         }
505         aca.ExpiresAt = exp
506         ta.cache.Add(tok, aca)
507         return nil
508 }
509
510 // Check that the provided access token is a JWT with the required
511 // scope. If it is a valid JWT but missing the required scope, we
512 // return a 403 error, otherwise true (acceptable as an API token) or
513 // false (pass through unmodified).
514 //
515 // Return false if configured not to accept access tokens at all.
516 //
517 // Note we don't check signature or expiry here. We are relying on the
518 // caller to verify those separately (e.g., by calling the UserInfo
519 // endpoint).
520 func (ta *oidcTokenAuthorizer) checkAccessTokenScope(ctx context.Context, tok string) (bool, error) {
521         if !ta.ctrl.AcceptAccessToken {
522                 return false, nil
523         } else if ta.ctrl.AcceptAccessTokenScope == "" {
524                 return true, nil
525         }
526         var claims struct {
527                 Scope string `json:"scope"`
528         }
529         if t, err := jwt.ParseSigned(tok); err != nil {
530                 ctxlog.FromContext(ctx).WithError(err).Debug("error parsing jwt")
531                 return false, nil
532         } else if err = t.UnsafeClaimsWithoutVerification(&claims); err != nil {
533                 ctxlog.FromContext(ctx).WithError(err).Debug("error extracting jwt claims")
534                 return false, nil
535         }
536         for _, s := range strings.Split(claims.Scope, " ") {
537                 if s == ta.ctrl.AcceptAccessTokenScope {
538                         return true, nil
539                 }
540         }
541         ctxlog.FromContext(ctx).WithFields(logrus.Fields{"have": claims.Scope, "need": ta.ctrl.AcceptAccessTokenScope}).Infof("unacceptable access token scope")
542         return false, httpserver.ErrorWithStatus(errors.New("unacceptable access token scope"), http.StatusUnauthorized)
543 }