lib/controller/localdb/login_oidc_test.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         "encoding/json"
  13         "fmt"
  14         "io"
  15         "net/http"
  16         "net/http/httptest"
  17         "net/url"
  18         "sort"
  19         "strings"
  20         "sync"
  21         "testing"
  22         "time"
  23
  24         "git.arvados.org/arvados.git/lib/config"
  25         "git.arvados.org/arvados.git/lib/controller/rpc"
  26         "git.arvados.org/arvados.git/sdk/go/arvados"
  27         "git.arvados.org/arvados.git/sdk/go/arvadostest"
  28         "git.arvados.org/arvados.git/sdk/go/auth"
  29         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  30         "github.com/jmoiron/sqlx"
  31         check "gopkg.in/check.v1"
  32 )
  33
  34 // Gocheck boilerplate
  35 func Test(t *testing.T) {
  36         check.TestingT(t)
  37 }
  38
  39 var _ = check.Suite(&OIDCLoginSuite{})
  40
  41 type OIDCLoginSuite struct {
  42         cluster      *arvados.Cluster
  43         localdb      *Conn
  44         railsSpy     *arvadostest.Proxy
  45         trustedURL   *arvados.URL
  46         fakeProvider *arvadostest.OIDCProvider
  47 }
  48
  49 func (s *OIDCLoginSuite) TearDownSuite(c *check.C) {
  50         // Undo any changes/additions to the user database so they
  51         // don't affect subsequent tests.
  52         arvadostest.ResetEnv()
  53         c.Check(arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil), check.IsNil)
  54 }
  55
  56 func (s *OIDCLoginSuite) SetUpTest(c *check.C) {
  57         s.trustedURL = &arvados.URL{Scheme: "https", Host: "app.example.com", Path: "/"}
  58
  59         s.fakeProvider = arvadostest.NewOIDCProvider(c)
  60         s.fakeProvider.AuthEmail = "active-user@arvados.local"
  61         s.fakeProvider.AuthEmailVerified = true
  62         s.fakeProvider.AuthName = "Fake User Name"
  63         s.fakeProvider.AuthGivenName = "Fake"
  64         s.fakeProvider.AuthFamilyName = "User Name"
  65         s.fakeProvider.ValidCode = fmt.Sprintf("abcdefgh-%d", time.Now().Unix())
  66         s.fakeProvider.PeopleAPIResponse = map[string]interface{}{}
  67
  68         cfg, err := config.NewLoader(nil, ctxlog.TestLogger(c)).Load()
  69         c.Assert(err, check.IsNil)
  70         s.cluster, err = cfg.GetCluster("")
  71         c.Assert(err, check.IsNil)
  72         s.cluster.Login.Test.Enable = false
  73         s.cluster.Login.Google.Enable = true
  74         s.cluster.Login.Google.ClientID = "test%client$id"
  75         s.cluster.Login.Google.ClientSecret = "test#client/secret"
  76         s.cluster.Login.TrustedClients = map[arvados.URL]struct{}{*s.trustedURL: {}}
  77         s.cluster.Users.PreferDomainForUsername = "PreferDomainForUsername.example.com"
  78         s.fakeProvider.ValidClientID = "test%client$id"
  79         s.fakeProvider.ValidClientSecret = "test#client/secret"
  80
  81         s.localdb = NewConn(s.cluster)
  82         c.Assert(s.localdb.loginController, check.FitsTypeOf, (*oidcLoginController)(nil))
  83         s.localdb.loginController.(*oidcLoginController).Issuer = s.fakeProvider.Issuer.URL
  84         s.localdb.loginController.(*oidcLoginController).peopleAPIBasePath = s.fakeProvider.PeopleAPI.URL
  85
  86         s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI)
  87         *s.localdb.railsProxy = *rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider)
  88 }
  89
  90 func (s *OIDCLoginSuite) TearDownTest(c *check.C) {
  91         s.railsSpy.Close()
  92 }
  93
  94 func (s *OIDCLoginSuite) TestGoogleLogout(c *check.C) {
  95         s.cluster.Login.TrustedClients[arvados.URL{Scheme: "https", Host: "foo.example", Path: "/"}] = struct{}{}
  96         s.cluster.Login.TrustPrivateNetworks = false
  97
  98         resp, err := s.localdb.Logout(context.Background(), arvados.LogoutOptions{ReturnTo: "https://foo.example.com/bar"})
  99         c.Check(err, check.NotNil)
 100         c.Check(resp.RedirectLocation, check.Equals, "")
 101
 102         resp, err = s.localdb.Logout(context.Background(), arvados.LogoutOptions{ReturnTo: "https://127.0.0.1/bar"})
 103         c.Check(err, check.NotNil)
 104         c.Check(resp.RedirectLocation, check.Equals, "")
 105
 106         resp, err = s.localdb.Logout(context.Background(), arvados.LogoutOptions{ReturnTo: "https://foo.example/bar"})
 107         c.Check(err, check.IsNil)
 108         c.Check(resp.RedirectLocation, check.Equals, "https://foo.example/bar")
 109
 110         s.cluster.Login.TrustPrivateNetworks = true
 111
 112         resp, err = s.localdb.Logout(context.Background(), arvados.LogoutOptions{ReturnTo: "https://192.168.1.1/bar"})
 113         c.Check(err, check.IsNil)
 114         c.Check(resp.RedirectLocation, check.Equals, "https://192.168.1.1/bar")
 115 }
 116
 117 func (s *OIDCLoginSuite) TestGoogleLogin_Start_Bogus(c *check.C) {
 118         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{})
 119         c.Check(err, check.IsNil)
 120         c.Check(resp.RedirectLocation, check.Equals, "")
 121         c.Check(resp.HTML.String(), check.Matches, `.*missing return_to parameter.*`)
 122 }
 123
 124 func (s *OIDCLoginSuite) TestGoogleLogin_Start(c *check.C) {
 125         for _, remote := range []string{"", "zzzzz"} {
 126                 resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{Remote: remote, ReturnTo: "https://app.example.com/foo?bar"})
 127                 c.Check(err, check.IsNil)
 128                 target, err := url.Parse(resp.RedirectLocation)
 129                 c.Check(err, check.IsNil)
 130                 issuerURL, _ := url.Parse(s.fakeProvider.Issuer.URL)
 131                 c.Check(target.Host, check.Equals, issuerURL.Host)
 132                 q := target.Query()
 133                 c.Check(q.Get("client_id"), check.Equals, "test%client$id")
 134                 state := s.localdb.loginController.(*oidcLoginController).parseOAuth2State(q.Get("state"))
 135                 c.Check(state.verify([]byte(s.cluster.SystemRootToken)), check.Equals, true)
 136                 c.Check(state.Time, check.Not(check.Equals), 0)
 137                 c.Check(state.Remote, check.Equals, remote)
 138                 c.Check(state.ReturnTo, check.Equals, "https://app.example.com/foo?bar")
 139         }
 140 }
 141
 142 func (s *OIDCLoginSuite) TestGoogleLogin_UnknownClient(c *check.C) {
 143         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ReturnTo: "https://bad-app.example.com/foo?bar"})
 144         c.Check(err, check.IsNil)
 145         c.Check(resp.RedirectLocation, check.Equals, "")
 146         c.Check(resp.HTML.String(), check.Matches, `(?ms).*requesting site is not listed in TrustedClients.*`)
 147 }
 148
 149 func (s *OIDCLoginSuite) TestGoogleLogin_InvalidCode(c *check.C) {
 150         state := s.startLogin(c)
 151         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 152                 Code:  "first-try-a-bogus-code",
 153                 State: state,
 154         })
 155         c.Check(err, check.IsNil)
 156         c.Check(resp.RedirectLocation, check.Equals, "")
 157         c.Check(resp.HTML.String(), check.Matches, `(?ms).*error in OAuth2 exchange.*cannot fetch token.*`)
 158 }
 159
 160 func (s *OIDCLoginSuite) TestGoogleLogin_InvalidState(c *check.C) {
 161         s.startLogin(c)
 162         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 163                 Code:  s.fakeProvider.ValidCode,
 164                 State: "bogus-state",
 165         })
 166         c.Check(err, check.IsNil)
 167         c.Check(resp.RedirectLocation, check.Equals, "")
 168         c.Check(resp.HTML.String(), check.Matches, `(?ms).*invalid OAuth2 state.*`)
 169 }
 170
 171 func (s *OIDCLoginSuite) setupPeopleAPIError(c *check.C) {
 172         s.fakeProvider.PeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 173                 w.WriteHeader(http.StatusForbidden)
 174                 fmt.Fprintln(w, `Error 403: accessNotConfigured`)
 175         }))
 176         s.localdb.loginController.(*oidcLoginController).peopleAPIBasePath = s.fakeProvider.PeopleAPI.URL
 177 }
 178
 179 func (s *OIDCLoginSuite) TestGoogleLogin_PeopleAPIDisabled(c *check.C) {
 180         s.localdb.loginController.(*oidcLoginController).UseGooglePeopleAPI = false
 181         s.fakeProvider.AuthEmail = "joe.smith@primary.example.com"
 182         s.setupPeopleAPIError(c)
 183         state := s.startLogin(c)
 184         _, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 185                 Code:  s.fakeProvider.ValidCode,
 186                 State: state,
 187         })
 188         c.Check(err, check.IsNil)
 189         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 190         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 191 }
 192
 193 func (s *OIDCLoginSuite) TestConfig(c *check.C) {
 194         s.cluster.Login.Google.Enable = false
 195         s.cluster.Login.OpenIDConnect.Enable = true
 196         s.cluster.Login.OpenIDConnect.Issuer = "https://accounts.example.com/"
 197         s.cluster.Login.OpenIDConnect.ClientID = "oidc-client-id"
 198         s.cluster.Login.OpenIDConnect.ClientSecret = "oidc-client-secret"
 199         s.cluster.Login.OpenIDConnect.AuthenticationRequestParameters = map[string]string{"testkey": "testvalue"}
 200         localdb := NewConn(s.cluster)
 201         ctrl := localdb.loginController.(*oidcLoginController)
 202         c.Check(ctrl.Issuer, check.Equals, "https://accounts.example.com/")
 203         c.Check(ctrl.ClientID, check.Equals, "oidc-client-id")
 204         c.Check(ctrl.ClientSecret, check.Equals, "oidc-client-secret")
 205         c.Check(ctrl.UseGooglePeopleAPI, check.Equals, false)
 206         c.Check(ctrl.AuthParams["testkey"], check.Equals, "testvalue")
 207
 208         for _, enableAltEmails := range []bool{false, true} {
 209                 s.cluster.Login.OpenIDConnect.Enable = false
 210                 s.cluster.Login.Google.Enable = true
 211                 s.cluster.Login.Google.ClientID = "google-client-id"
 212                 s.cluster.Login.Google.ClientSecret = "google-client-secret"
 213                 s.cluster.Login.Google.AlternateEmailAddresses = enableAltEmails
 214                 s.cluster.Login.Google.AuthenticationRequestParameters = map[string]string{"testkey": "testvalue"}
 215                 localdb = NewConn(s.cluster)
 216                 ctrl = localdb.loginController.(*oidcLoginController)
 217                 c.Check(ctrl.Issuer, check.Equals, "https://accounts.google.com")
 218                 c.Check(ctrl.ClientID, check.Equals, "google-client-id")
 219                 c.Check(ctrl.ClientSecret, check.Equals, "google-client-secret")
 220                 c.Check(ctrl.UseGooglePeopleAPI, check.Equals, enableAltEmails)
 221                 c.Check(ctrl.AuthParams["testkey"], check.Equals, "testvalue")
 222         }
 223 }
 224
 225 func (s *OIDCLoginSuite) TestGoogleLogin_PeopleAPIError(c *check.C) {
 226         s.setupPeopleAPIError(c)
 227         state := s.startLogin(c)
 228         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 229                 Code:  s.fakeProvider.ValidCode,
 230                 State: state,
 231         })
 232         c.Check(err, check.IsNil)
 233         c.Check(resp.RedirectLocation, check.Equals, "")
 234 }
 235
 236 func (s *OIDCLoginSuite) TestOIDCAuthorizer(c *check.C) {
 237         s.cluster.Login.Google.Enable = false
 238         s.cluster.Login.OpenIDConnect.Enable = true
 239         json.Unmarshal([]byte(fmt.Sprintf("%q", s.fakeProvider.Issuer.URL)), &s.cluster.Login.OpenIDConnect.Issuer)
 240         s.cluster.Login.OpenIDConnect.ClientID = "oidc#client#id"
 241         s.cluster.Login.OpenIDConnect.ClientSecret = "oidc#client#secret"
 242         s.cluster.Login.OpenIDConnect.AcceptAccessToken = true
 243         s.cluster.Login.OpenIDConnect.AcceptAccessTokenScope = ""
 244         s.fakeProvider.ValidClientID = "oidc#client#id"
 245         s.fakeProvider.ValidClientSecret = "oidc#client#secret"
 246         db := arvadostest.DB(c, s.cluster)
 247
 248         tokenCacheTTL = time.Millisecond
 249         tokenCacheRaceWindow = time.Millisecond
 250         tokenCacheNegativeTTL = time.Millisecond
 251
 252         oidcAuthorizer := OIDCAccessTokenAuthorizer(s.cluster, func(context.Context) (*sqlx.DB, error) { return db, nil })
 253         accessToken := s.fakeProvider.ValidAccessToken()
 254
 255         mac := hmac.New(sha256.New, []byte(s.cluster.SystemRootToken))
 256         io.WriteString(mac, accessToken)
 257         apiToken := fmt.Sprintf("%x", mac.Sum(nil))
 258
 259         cleanup := func() {
 260                 _, err := db.Exec(`delete from api_client_authorizations where api_token=$1`, apiToken)
 261                 c.Check(err, check.IsNil)
 262         }
 263         cleanup()
 264         defer cleanup()
 265
 266         ctx := auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{accessToken}})
 267         var exp1 time.Time
 268
 269         concurrent := 4
 270         s.fakeProvider.HoldUserInfo = make(chan *http.Request)
 271         s.fakeProvider.ReleaseUserInfo = make(chan struct{})
 272         go func() {
 273                 for i := 0; ; i++ {
 274                         if i == concurrent {
 275                                 close(s.fakeProvider.ReleaseUserInfo)
 276                         }
 277                         <-s.fakeProvider.HoldUserInfo
 278                 }
 279         }()
 280         var wg sync.WaitGroup
 281         for i := 0; i < concurrent; i++ {
 282                 i := i
 283                 wg.Add(1)
 284                 go func() {
 285                         defer wg.Done()
 286                         _, err := oidcAuthorizer.WrapCalls(func(ctx context.Context, opts interface{}) (interface{}, error) {
 287                                 c.Logf("concurrent req %d/%d", i, concurrent)
 288                                 var exp time.Time
 289
 290                                 creds, ok := auth.FromContext(ctx)
 291                                 c.Assert(ok, check.Equals, true)
 292                                 c.Assert(creds.Tokens, check.HasLen, 1)
 293                                 c.Check(creds.Tokens[0], check.Equals, accessToken)
 294
 295                                 err := db.QueryRowContext(ctx, `select expires_at at time zone 'UTC' from api_client_authorizations where api_token=$1`, apiToken).Scan(&exp)
 296                                 c.Check(err, check.IsNil)
 297                                 c.Check(exp.Sub(time.Now()) > -time.Second, check.Equals, true)
 298                                 c.Check(exp.Sub(time.Now()) < time.Second, check.Equals, true)
 299                                 if i == 0 {
 300                                         exp1 = exp
 301                                 }
 302                                 return nil, nil
 303                         })(ctx, nil)
 304                         c.Check(err, check.IsNil)
 305                 }()
 306         }
 307         wg.Wait()
 308         if c.Failed() {
 309                 c.Fatal("giving up")
 310         }
 311
 312         // If the token is used again after the in-memory cache
 313         // expires, oidcAuthorizer must re-check the token and update
 314         // the expires_at value in the database.
 315         time.Sleep(3 * time.Millisecond)
 316         oidcAuthorizer.WrapCalls(func(ctx context.Context, opts interface{}) (interface{}, error) {
 317                 var exp time.Time
 318                 err := db.QueryRowContext(ctx, `select expires_at at time zone 'UTC' from api_client_authorizations where api_token=$1`, apiToken).Scan(&exp)
 319                 c.Check(err, check.IsNil)
 320                 c.Check(exp.Sub(exp1) > 0, check.Equals, true, check.Commentf("expect %v > 0", exp.Sub(exp1)))
 321                 c.Check(exp.Sub(exp1) < time.Second, check.Equals, true, check.Commentf("expect %v < 1s", exp.Sub(exp1)))
 322                 return nil, nil
 323         })(ctx, nil)
 324
 325         s.fakeProvider.AccessTokenPayload = map[string]interface{}{"scope": "openid profile foobar"}
 326         accessToken = s.fakeProvider.ValidAccessToken()
 327         ctx = auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{accessToken}})
 328
 329         mac = hmac.New(sha256.New, []byte(s.cluster.SystemRootToken))
 330         io.WriteString(mac, accessToken)
 331         apiToken = fmt.Sprintf("%x", mac.Sum(nil))
 332
 333         for _, trial := range []struct {
 334                 configEnable bool
 335                 configScope  string
 336                 acceptable   bool
 337                 shouldRun    bool
 338         }{
 339                 {true, "foobar", true, true},
 340                 {true, "foo", false, false},
 341                 {true, "", true, true},
 342                 {false, "", false, true},
 343                 {false, "foobar", false, true},
 344         } {
 345                 c.Logf("trial = %+v", trial)
 346                 cleanup()
 347                 s.cluster.Login.OpenIDConnect.AcceptAccessToken = trial.configEnable
 348                 s.cluster.Login.OpenIDConnect.AcceptAccessTokenScope = trial.configScope
 349                 oidcAuthorizer = OIDCAccessTokenAuthorizer(s.cluster, func(context.Context) (*sqlx.DB, error) { return db, nil })
 350                 checked := false
 351                 oidcAuthorizer.WrapCalls(func(ctx context.Context, opts interface{}) (interface{}, error) {
 352                         var n int
 353                         err := db.QueryRowContext(ctx, `select count(*) from api_client_authorizations where api_token=$1`, apiToken).Scan(&n)
 354                         c.Check(err, check.IsNil)
 355                         if trial.acceptable {
 356                                 c.Check(n, check.Equals, 1)
 357                         } else {
 358                                 c.Check(n, check.Equals, 0)
 359                         }
 360                         checked = true
 361                         return nil, nil
 362                 })(ctx, nil)
 363                 c.Check(checked, check.Equals, trial.shouldRun)
 364         }
 365 }
 366
 367 func (s *OIDCLoginSuite) TestGenericOIDCLogin(c *check.C) {
 368         s.cluster.Login.Google.Enable = false
 369         s.cluster.Login.OpenIDConnect.Enable = true
 370         json.Unmarshal([]byte(fmt.Sprintf("%q", s.fakeProvider.Issuer.URL)), &s.cluster.Login.OpenIDConnect.Issuer)
 371         s.cluster.Login.OpenIDConnect.ClientID = "oidc#client#id"
 372         s.cluster.Login.OpenIDConnect.ClientSecret = "oidc#client#secret"
 373         s.cluster.Login.OpenIDConnect.AuthenticationRequestParameters = map[string]string{"testkey": "testvalue"}
 374         s.fakeProvider.ValidClientID = "oidc#client#id"
 375         s.fakeProvider.ValidClientSecret = "oidc#client#secret"
 376         for _, trial := range []struct {
 377                 expectEmail string // "" if failure expected
 378                 setup       func()
 379         }{
 380                 {
 381                         expectEmail: "user@oidc.example.com",
 382                         setup: func() {
 383                                 c.Log("=== succeed because email_verified is false but not required")
 384                                 s.fakeProvider.AuthEmail = "user@oidc.example.com"
 385                                 s.fakeProvider.AuthEmailVerified = false
 386                                 s.cluster.Login.OpenIDConnect.EmailClaim = "email"
 387                                 s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = ""
 388                                 s.cluster.Login.OpenIDConnect.UsernameClaim = ""
 389                         },
 390                 },
 391                 {
 392                         expectEmail: "",
 393                         setup: func() {
 394                                 c.Log("=== fail because email_verified is false and required")
 395                                 s.fakeProvider.AuthEmail = "user@oidc.example.com"
 396                                 s.fakeProvider.AuthEmailVerified = false
 397                                 s.cluster.Login.OpenIDConnect.EmailClaim = "email"
 398                                 s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "email_verified"
 399                                 s.cluster.Login.OpenIDConnect.UsernameClaim = ""
 400                         },
 401                 },
 402                 {
 403                         expectEmail: "user@oidc.example.com",
 404                         setup: func() {
 405                                 c.Log("=== succeed because email_verified is false but config uses custom 'verified' claim")
 406                                 s.fakeProvider.AuthEmail = "user@oidc.example.com"
 407                                 s.fakeProvider.AuthEmailVerified = false
 408                                 s.cluster.Login.OpenIDConnect.EmailClaim = "email"
 409                                 s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "alt_verified"
 410                                 s.cluster.Login.OpenIDConnect.UsernameClaim = ""
 411                         },
 412                 },
 413                 {
 414                         expectEmail: "alt_email@example.com",
 415                         setup: func() {
 416                                 c.Log("=== succeed with custom 'email' and 'email_verified' claims")
 417                                 s.fakeProvider.AuthEmail = "bad@wrong.example.com"
 418                                 s.fakeProvider.AuthEmailVerified = false
 419                                 s.cluster.Login.OpenIDConnect.EmailClaim = "alt_email"
 420                                 s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "alt_verified"
 421                                 s.cluster.Login.OpenIDConnect.UsernameClaim = "alt_username"
 422                         },
 423                 },
 424         } {
 425                 trial.setup()
 426                 if s.railsSpy != nil {
 427                         s.railsSpy.Close()
 428                 }
 429                 s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI)
 430                 s.localdb = NewConn(s.cluster)
 431                 *s.localdb.railsProxy = *rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider)
 432
 433                 state := s.startLogin(c, func(form url.Values) {
 434                         c.Check(form.Get("testkey"), check.Equals, "testvalue")
 435                 })
 436                 resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 437                         Code:  s.fakeProvider.ValidCode,
 438                         State: state,
 439                 })
 440                 c.Assert(err, check.IsNil)
 441                 if trial.expectEmail == "" {
 442                         c.Check(resp.HTML.String(), check.Matches, `(?ms).*Login error.*`)
 443                         c.Check(resp.RedirectLocation, check.Equals, "")
 444                         continue
 445                 }
 446                 c.Check(resp.HTML.String(), check.Equals, "")
 447                 target, err := url.Parse(resp.RedirectLocation)
 448                 c.Assert(err, check.IsNil)
 449                 token := target.Query().Get("api_token")
 450                 c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`)
 451                 authinfo := getCallbackAuthInfo(c, s.railsSpy)
 452                 c.Check(authinfo.Email, check.Equals, trial.expectEmail)
 453
 454                 switch s.cluster.Login.OpenIDConnect.UsernameClaim {
 455                 case "alt_username":
 456                         c.Check(authinfo.Username, check.Equals, "desired-username")
 457                 case "":
 458                         c.Check(authinfo.Username, check.Equals, "")
 459                 default:
 460                         c.Fail() // bad test case
 461                 }
 462         }
 463 }
 464
 465 func (s *OIDCLoginSuite) TestGoogleLogin_Success(c *check.C) {
 466         s.cluster.Login.Google.AuthenticationRequestParameters["prompt"] = "consent"
 467         s.cluster.Login.Google.AuthenticationRequestParameters["foo"] = "bar"
 468         state := s.startLogin(c, func(form url.Values) {
 469                 c.Check(form.Get("foo"), check.Equals, "bar")
 470                 c.Check(form.Get("prompt"), check.Equals, "consent")
 471         })
 472         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 473                 Code:  s.fakeProvider.ValidCode,
 474                 State: state,
 475         })
 476         c.Check(err, check.IsNil)
 477         c.Check(resp.HTML.String(), check.Equals, "")
 478         target, err := url.Parse(resp.RedirectLocation)
 479         c.Check(err, check.IsNil)
 480         c.Check(target.Host, check.Equals, "app.example.com")
 481         c.Check(target.Path, check.Equals, "/foo")
 482         token := target.Query().Get("api_token")
 483         c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`)
 484
 485         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 486         c.Check(authinfo.FirstName, check.Equals, "Fake")
 487         c.Check(authinfo.LastName, check.Equals, "User Name")
 488         c.Check(authinfo.Email, check.Equals, "active-user@arvados.local")
 489         c.Check(authinfo.AlternateEmails, check.HasLen, 0)
 490
 491         // Try using the returned Arvados token.
 492         c.Logf("trying an API call with new token %q", token)
 493         ctx := auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{token}})
 494         cl, err := s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 495         c.Check(cl.ItemsAvailable, check.Not(check.Equals), 0)
 496         c.Check(cl.Items, check.Not(check.HasLen), 0)
 497         c.Check(err, check.IsNil)
 498
 499         // Might as well check that bogus tokens aren't accepted.
 500         badtoken := token + "plussomeboguschars"
 501         c.Logf("trying an API call with mangled token %q", badtoken)
 502         ctx = auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{badtoken}})
 503         cl, err = s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 504         c.Check(cl.Items, check.HasLen, 0)
 505         c.Check(err, check.NotNil)
 506         c.Check(err, check.ErrorMatches, `.*401 Unauthorized: Not logged in.*`)
 507 }
 508
 509 func (s *OIDCLoginSuite) TestGoogleLogin_RealName(c *check.C) {
 510         s.fakeProvider.AuthEmail = "joe.smith@primary.example.com"
 511         s.fakeProvider.AuthEmailVerified = true
 512         s.fakeProvider.PeopleAPIResponse = map[string]interface{}{
 513                 "names": []map[string]interface{}{
 514                         {
 515                                 "metadata":   map[string]interface{}{"primary": false},
 516                                 "givenName":  "Joe",
 517                                 "familyName": "Smith",
 518                         },
 519                         {
 520                                 "metadata":   map[string]interface{}{"primary": true},
 521                                 "givenName":  "Joseph",
 522                                 "familyName": "Psmith",
 523                         },
 524                 },
 525         }
 526         state := s.startLogin(c)
 527         s.localdb.Login(context.Background(), arvados.LoginOptions{
 528                 Code:  s.fakeProvider.ValidCode,
 529                 State: state,
 530         })
 531
 532         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 533         c.Check(authinfo.FirstName, check.Equals, "Joseph")
 534         c.Check(authinfo.LastName, check.Equals, "Psmith")
 535 }
 536
 537 func (s *OIDCLoginSuite) TestGoogleLogin_OIDCNameWithoutGivenAndFamilyNames(c *check.C) {
 538         s.fakeProvider.AuthName = "Joe P. Smith"
 539         s.fakeProvider.AuthGivenName = ""
 540         s.fakeProvider.AuthFamilyName = ""
 541         s.fakeProvider.AuthEmail = "joe.smith@primary.example.com"
 542         state := s.startLogin(c)
 543         s.localdb.Login(context.Background(), arvados.LoginOptions{
 544                 Code:  s.fakeProvider.ValidCode,
 545                 State: state,
 546         })
 547
 548         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 549         c.Check(authinfo.FirstName, check.Equals, "Joe P.")
 550         c.Check(authinfo.LastName, check.Equals, "Smith")
 551 }
 552
 553 // People API returns some additional email addresses.
 554 func (s *OIDCLoginSuite) TestGoogleLogin_AlternateEmailAddresses(c *check.C) {
 555         s.fakeProvider.AuthEmail = "joe.smith@primary.example.com"
 556         s.fakeProvider.PeopleAPIResponse = map[string]interface{}{
 557                 "emailAddresses": []map[string]interface{}{
 558                         {
 559                                 "metadata": map[string]interface{}{"verified": true},
 560                                 "value":    "joe.smith@work.example.com",
 561                         },
 562                         {
 563                                 "value": "joe.smith@unverified.example.com", // unverified, so this one will be ignored
 564                         },
 565                         {
 566                                 "metadata": map[string]interface{}{"verified": true},
 567                                 "value":    "joe.smith@home.example.com",
 568                         },
 569                 },
 570         }
 571         state := s.startLogin(c)
 572         s.localdb.Login(context.Background(), arvados.LoginOptions{
 573                 Code:  s.fakeProvider.ValidCode,
 574                 State: state,
 575         })
 576
 577         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 578         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 579         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com", "joe.smith@work.example.com"})
 580 }
 581
 582 // Primary address is not the one initially returned by oidc.
 583 func (s *OIDCLoginSuite) TestGoogleLogin_AlternateEmailAddresses_Primary(c *check.C) {
 584         s.fakeProvider.AuthEmail = "joe.smith@alternate.example.com"
 585         s.fakeProvider.PeopleAPIResponse = map[string]interface{}{
 586                 "emailAddresses": []map[string]interface{}{
 587                         {
 588                                 "metadata": map[string]interface{}{"verified": true, "primary": true},
 589                                 "value":    "joe.smith@primary.example.com",
 590                         },
 591                         {
 592                                 "metadata": map[string]interface{}{"verified": true},
 593                                 "value":    "joe.smith@alternate.example.com",
 594                         },
 595                         {
 596                                 "metadata": map[string]interface{}{"verified": true},
 597                                 "value":    "jsmith+123@preferdomainforusername.example.com",
 598                         },
 599                 },
 600         }
 601         state := s.startLogin(c)
 602         s.localdb.Login(context.Background(), arvados.LoginOptions{
 603                 Code:  s.fakeProvider.ValidCode,
 604                 State: state,
 605         })
 606         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 607         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 608         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@alternate.example.com", "jsmith+123@preferdomainforusername.example.com"})
 609         c.Check(authinfo.Username, check.Equals, "jsmith")
 610 }
 611
 612 func (s *OIDCLoginSuite) TestGoogleLogin_NoPrimaryEmailAddress(c *check.C) {
 613         s.fakeProvider.AuthEmail = "joe.smith@unverified.example.com"
 614         s.fakeProvider.AuthEmailVerified = false
 615         s.fakeProvider.PeopleAPIResponse = map[string]interface{}{
 616                 "emailAddresses": []map[string]interface{}{
 617                         {
 618                                 "metadata": map[string]interface{}{"verified": true},
 619                                 "value":    "joe.smith@work.example.com",
 620                         },
 621                         {
 622                                 "metadata": map[string]interface{}{"verified": true},
 623                                 "value":    "joe.smith@home.example.com",
 624                         },
 625                 },
 626         }
 627         state := s.startLogin(c)
 628         s.localdb.Login(context.Background(), arvados.LoginOptions{
 629                 Code:  s.fakeProvider.ValidCode,
 630                 State: state,
 631         })
 632
 633         authinfo := getCallbackAuthInfo(c, s.railsSpy)
 634         c.Check(authinfo.Email, check.Equals, "joe.smith@work.example.com") // first verified email in People response
 635         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com"})
 636         c.Check(authinfo.Username, check.Equals, "")
 637 }
 638
 639 func (s *OIDCLoginSuite) startLogin(c *check.C, checks ...func(url.Values)) (state string) {
 640         // Initiate login, but instead of following the redirect to
 641         // the provider, just grab state from the redirect URL.
 642         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ReturnTo: "https://app.example.com/foo?bar"})
 643         c.Check(err, check.IsNil)
 644         c.Check(resp.HTML.String(), check.Not(check.Matches), `(?ms).*error:.*`)
 645         target, err := url.Parse(resp.RedirectLocation)
 646         c.Check(err, check.IsNil)
 647         state = target.Query().Get("state")
 648         if !c.Check(state, check.Not(check.Equals), "") {
 649                 c.Logf("Redirect target: %q", target)
 650                 c.Logf("HTML: %q", resp.HTML)
 651         }
 652         for _, fn := range checks {
 653                 fn(target.Query())
 654         }
 655         s.cluster.Login.OpenIDConnect.AuthenticationRequestParameters = map[string]string{"testkey": "testvalue"}
 656         return
 657 }
 658
 659 func (s *OIDCLoginSuite) TestValidateLoginRedirectTarget(c *check.C) {
 660         for _, trial := range []struct {
 661                 permit       bool
 662                 trustPrivate bool
 663                 url          string
 664         }{
 665                 // wb1, wb2 => accept
 666                 {true, false, s.cluster.Services.Workbench1.ExternalURL.String()},
 667                 {true, false, s.cluster.Services.Workbench2.ExternalURL.String()},
 668                 // explicitly listed host => accept
 669                 {true, false, "https://app.example.com/"},
 670                 {true, false, "https://app.example.com:443/foo?bar=baz"},
 671                 // non-listed hostname => deny (regardless of TrustPrivateNetworks)
 672                 {false, false, "https://bad.example/"},
 673                 {false, true, "https://bad.example/"},
 674                 // non-listed non-private IP addr => deny (regardless of TrustPrivateNetworks)
 675                 {false, true, "https://1.2.3.4/"},
 676                 {false, true, "https://1.2.3.4/"},
 677                 {false, true, "https://[ab::cd]:1234/"},
 678                 // localhost or non-listed private IP addr => accept only if TrustPrivateNetworks is set
 679                 {false, false, "https://localhost/"},
 680                 {true, true, "https://localhost/"},
 681                 {false, false, "https://[10.9.8.7]:80/foo"},
 682                 {true, true, "https://[10.9.8.7]:80/foo"},
 683                 {false, false, "https://[::1]:80/foo"},
 684                 {true, true, "https://[::1]:80/foo"},
 685                 {true, true, "http://192.168.1.1/"},
 686                 {true, true, "http://172.17.2.0/"},
 687                 // bad url => deny
 688                 {false, true, "https://10.1.1.1:blorp/foo"},        // non-numeric port
 689                 {false, true, "https://app.example.com:blorp/foo"}, // non-numeric port
 690                 {false, true, "https://]:443"},
 691                 {false, true, "https://"},
 692                 {false, true, "https:"},
 693                 {false, true, ""},
 694                 // explicitly listed host but different port, protocol, or user/pass => deny
 695                 {false, true, "http://app.example.com/"},
 696                 {false, true, "http://app.example.com:443/"},
 697                 {false, true, "https://app.example.com:80/"},
 698                 {false, true, "https://app.example.com:4433/"},
 699                 {false, true, "https://u:p@app.example.com:443/foo?bar=baz"},
 700         } {
 701                 c.Logf("trial %+v", trial)
 702                 s.cluster.Login.TrustPrivateNetworks = trial.trustPrivate
 703                 err := validateLoginRedirectTarget(s.cluster, trial.url)
 704                 c.Check(err == nil, check.Equals, trial.permit)
 705         }
 706
 707 }
 708
 709 func getCallbackAuthInfo(c *check.C, railsSpy *arvadostest.Proxy) (authinfo rpc.UserSessionAuthInfo) {
 710         for _, dump := range railsSpy.RequestDumps {
 711                 c.Logf("spied request: %q", dump)
 712                 split := bytes.Split(dump, []byte("\r\n\r\n"))
 713                 c.Assert(split, check.HasLen, 2)
 714                 hdr, body := string(split[0]), string(split[1])
 715                 if strings.Contains(hdr, "POST /auth/controller/callback") {
 716                         vs, err := url.ParseQuery(body)
 717                         c.Check(json.Unmarshal([]byte(vs.Get("auth_info")), &authinfo), check.IsNil)
 718                         c.Check(err, check.IsNil)
 719                         sort.Strings(authinfo.AlternateEmails)
 720                         return
 721                 }
 722         }
 723         c.Error("callback not found")
 724         return
 725 }