lib/controller/localdb/login_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/rand"
  11         "crypto/rsa"
  12         "encoding/json"
  13         "fmt"
  14         "net/http"
  15         "net/http/httptest"
  16         "net/url"
  17         "sort"
  18         "strings"
  19         "testing"
  20         "time"
  21
  22         "git.arvados.org/arvados.git/lib/config"
  23         "git.arvados.org/arvados.git/lib/controller/rpc"
  24         "git.arvados.org/arvados.git/sdk/go/arvados"
  25         "git.arvados.org/arvados.git/sdk/go/arvadostest"
  26         "git.arvados.org/arvados.git/sdk/go/auth"
  27         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  28         check "gopkg.in/check.v1"
  29         jose "gopkg.in/square/go-jose.v2"
  30 )
  31
  32 // Gocheck boilerplate
  33 func Test(t *testing.T) {
  34         check.TestingT(t)
  35 }
  36
  37 var _ = check.Suite(&LoginSuite{})
  38
  39 type LoginSuite struct {
  40         cluster               *arvados.Cluster
  41         ctx                   context.Context
  42         localdb               *Conn
  43         railsSpy              *arvadostest.Proxy
  44         fakeIssuer            *httptest.Server
  45         fakePeopleAPI         *httptest.Server
  46         fakePeopleAPIResponse map[string]interface{}
  47         issuerKey             *rsa.PrivateKey
  48
  49         // expected token request
  50         validCode string
  51         // desired response from token endpoint
  52         authEmail         string
  53         authEmailVerified bool
  54         authName          string
  55 }
  56
  57 func (s *LoginSuite) TearDownSuite(c *check.C) {
  58         // Undo any changes/additions to the user database so they
  59         // don't affect subsequent tests.
  60         arvadostest.ResetEnv()
  61         c.Check(arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil), check.IsNil)
  62 }
  63
  64 func (s *LoginSuite) SetUpTest(c *check.C) {
  65         var err error
  66         s.issuerKey, err = rsa.GenerateKey(rand.Reader, 2048)
  67         c.Assert(err, check.IsNil)
  68
  69         s.authEmail = "active-user@arvados.local"
  70         s.authEmailVerified = true
  71         s.authName = "Fake User Name"
  72         s.fakeIssuer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
  73                 req.ParseForm()
  74                 c.Logf("fakeIssuer: got req: %s %s %s", req.Method, req.URL, req.Form)
  75                 w.Header().Set("Content-Type", "application/json")
  76                 switch req.URL.Path {
  77                 case "/.well-known/openid-configuration":
  78                         json.NewEncoder(w).Encode(map[string]interface{}{
  79                                 "issuer":                 s.fakeIssuer.URL,
  80                                 "authorization_endpoint": s.fakeIssuer.URL + "/auth",
  81                                 "token_endpoint":         s.fakeIssuer.URL + "/token",
  82                                 "jwks_uri":               s.fakeIssuer.URL + "/jwks",
  83                                 "userinfo_endpoint":      s.fakeIssuer.URL + "/userinfo",
  84                         })
  85                 case "/token":
  86                         if req.Form.Get("code") != s.validCode || s.validCode == "" {
  87                                 w.WriteHeader(http.StatusUnauthorized)
  88                                 return
  89                         }
  90                         idToken, _ := json.Marshal(map[string]interface{}{
  91                                 "iss":            s.fakeIssuer.URL,
  92                                 "aud":            []string{"test%client$id"},
  93                                 "sub":            "fake-user-id",
  94                                 "exp":            time.Now().UTC().Add(time.Minute).UnixNano(),
  95                                 "iat":            time.Now().UTC().UnixNano(),
  96                                 "nonce":          "fake-nonce",
  97                                 "email":          s.authEmail,
  98                                 "email_verified": s.authEmailVerified,
  99                                 "name":           s.authName,
 100                         })
 101                         json.NewEncoder(w).Encode(struct {
 102                                 AccessToken  string `json:"access_token"`
 103                                 TokenType    string `json:"token_type"`
 104                                 RefreshToken string `json:"refresh_token"`
 105                                 ExpiresIn    int32  `json:"expires_in"`
 106                                 IDToken      string `json:"id_token"`
 107                         }{
 108                                 AccessToken:  s.fakeToken(c, []byte("fake access token")),
 109                                 TokenType:    "Bearer",
 110                                 RefreshToken: "test-refresh-token",
 111                                 ExpiresIn:    30,
 112                                 IDToken:      s.fakeToken(c, idToken),
 113                         })
 114                 case "/jwks":
 115                         json.NewEncoder(w).Encode(jose.JSONWebKeySet{
 116                                 Keys: []jose.JSONWebKey{
 117                                         {Key: s.issuerKey.Public(), Algorithm: string(jose.RS256), KeyID: ""},
 118                                 },
 119                         })
 120                 case "/auth":
 121                         w.WriteHeader(http.StatusInternalServerError)
 122                 case "/userinfo":
 123                         w.WriteHeader(http.StatusInternalServerError)
 124                 default:
 125                         w.WriteHeader(http.StatusNotFound)
 126                 }
 127         }))
 128         s.validCode = fmt.Sprintf("abcdefgh-%d", time.Now().Unix())
 129
 130         s.fakePeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 131                 req.ParseForm()
 132                 c.Logf("fakePeopleAPI: got req: %s %s %s", req.Method, req.URL, req.Form)
 133                 w.Header().Set("Content-Type", "application/json")
 134                 switch req.URL.Path {
 135                 case "/v1/people/me":
 136                         if f := req.Form.Get("personFields"); f != "emailAddresses,names" {
 137                                 w.WriteHeader(http.StatusBadRequest)
 138                                 break
 139                         }
 140                         json.NewEncoder(w).Encode(s.fakePeopleAPIResponse)
 141                 default:
 142                         w.WriteHeader(http.StatusNotFound)
 143                 }
 144         }))
 145         s.fakePeopleAPIResponse = map[string]interface{}{}
 146
 147         cfg, err := config.NewLoader(nil, ctxlog.TestLogger(c)).Load()
 148         s.cluster, err = cfg.GetCluster("")
 149         s.cluster.Login.GoogleClientID = "test%client$id"
 150         s.cluster.Login.GoogleClientSecret = "test#client/secret"
 151         s.cluster.Users.PreferDomainForUsername = "PreferDomainForUsername.example.com"
 152         c.Assert(err, check.IsNil)
 153
 154         s.localdb = NewConn(s.cluster)
 155         s.localdb.googleLoginController.issuer = s.fakeIssuer.URL
 156         s.localdb.googleLoginController.peopleAPIBasePath = s.fakePeopleAPI.URL
 157
 158         s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI)
 159         s.localdb.railsProxy = rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider)
 160 }
 161
 162 func (s *LoginSuite) TearDownTest(c *check.C) {
 163         s.railsSpy.Close()
 164 }
 165
 166 func (s *LoginSuite) TestGoogleLogin_Start_Bogus(c *check.C) {
 167         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{})
 168         c.Check(err, check.IsNil)
 169         c.Check(resp.RedirectLocation, check.Equals, "")
 170         c.Check(resp.HTML.String(), check.Matches, `.*missing return_to parameter.*`)
 171 }
 172
 173 func (s *LoginSuite) TestGoogleLogin_Start(c *check.C) {
 174         for _, remote := range []string{"", "zzzzz"} {
 175                 resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{Remote: remote, ReturnTo: "https://app.example.com/foo?bar"})
 176                 c.Check(err, check.IsNil)
 177                 target, err := url.Parse(resp.RedirectLocation)
 178                 c.Check(err, check.IsNil)
 179                 issuerURL, _ := url.Parse(s.fakeIssuer.URL)
 180                 c.Check(target.Host, check.Equals, issuerURL.Host)
 181                 q := target.Query()
 182                 c.Check(q.Get("client_id"), check.Equals, "test%client$id")
 183                 state := s.localdb.googleLoginController.parseOAuth2State(q.Get("state"))
 184                 c.Check(state.verify([]byte(s.cluster.SystemRootToken)), check.Equals, true)
 185                 c.Check(state.Time, check.Not(check.Equals), 0)
 186                 c.Check(state.Remote, check.Equals, remote)
 187                 c.Check(state.ReturnTo, check.Equals, "https://app.example.com/foo?bar")
 188         }
 189 }
 190
 191 func (s *LoginSuite) TestGoogleLogin_InvalidCode(c *check.C) {
 192         state := s.startLogin(c)
 193         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 194                 Code:  "first-try-a-bogus-code",
 195                 State: state,
 196         })
 197         c.Check(err, check.IsNil)
 198         c.Check(resp.RedirectLocation, check.Equals, "")
 199         c.Check(resp.HTML.String(), check.Matches, `(?ms).*error in OAuth2 exchange.*cannot fetch token.*`)
 200 }
 201
 202 func (s *LoginSuite) TestGoogleLogin_InvalidState(c *check.C) {
 203         s.startLogin(c)
 204         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 205                 Code:  s.validCode,
 206                 State: "bogus-state",
 207         })
 208         c.Check(err, check.IsNil)
 209         c.Check(resp.RedirectLocation, check.Equals, "")
 210         c.Check(resp.HTML.String(), check.Matches, `(?ms).*invalid OAuth2 state.*`)
 211 }
 212
 213 func (s *LoginSuite) setupPeopleAPIError(c *check.C) {
 214         s.fakePeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 215                 w.WriteHeader(http.StatusForbidden)
 216                 fmt.Fprintln(w, `Error 403: accessNotConfigured`)
 217         }))
 218         s.localdb.googleLoginController.peopleAPIBasePath = s.fakePeopleAPI.URL
 219 }
 220
 221 func (s *LoginSuite) TestGoogleLogin_PeopleAPIDisabled(c *check.C) {
 222         s.cluster.Login.GoogleAlternateEmailAddresses = false
 223         s.authEmail = "joe.smith@primary.example.com"
 224         s.setupPeopleAPIError(c)
 225         state := s.startLogin(c)
 226         _, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 227                 Code:  s.validCode,
 228                 State: state,
 229         })
 230         c.Check(err, check.IsNil)
 231         authinfo := s.getCallbackAuthInfo(c)
 232         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 233 }
 234
 235 func (s *LoginSuite) TestGoogleLogin_PeopleAPIError(c *check.C) {
 236         s.setupPeopleAPIError(c)
 237         state := s.startLogin(c)
 238         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 239                 Code:  s.validCode,
 240                 State: state,
 241         })
 242         c.Check(err, check.IsNil)
 243         c.Check(resp.RedirectLocation, check.Equals, "")
 244 }
 245
 246 func (s *LoginSuite) TestGoogleLogin_Success(c *check.C) {
 247         state := s.startLogin(c)
 248         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 249                 Code:  s.validCode,
 250                 State: state,
 251         })
 252         c.Check(err, check.IsNil)
 253         c.Check(resp.HTML.String(), check.Equals, "")
 254         target, err := url.Parse(resp.RedirectLocation)
 255         c.Check(err, check.IsNil)
 256         c.Check(target.Host, check.Equals, "app.example.com")
 257         c.Check(target.Path, check.Equals, "/foo")
 258         token := target.Query().Get("api_token")
 259         c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`)
 260
 261         authinfo := s.getCallbackAuthInfo(c)
 262         c.Check(authinfo.FirstName, check.Equals, "Fake User")
 263         c.Check(authinfo.LastName, check.Equals, "Name")
 264         c.Check(authinfo.Email, check.Equals, "active-user@arvados.local")
 265         c.Check(authinfo.AlternateEmails, check.HasLen, 0)
 266
 267         // Try using the returned Arvados token.
 268         c.Logf("trying an API call with new token %q", token)
 269         ctx := auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{token}})
 270         cl, err := s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 271         c.Check(cl.ItemsAvailable, check.Not(check.Equals), 0)
 272         c.Check(cl.Items, check.Not(check.HasLen), 0)
 273         c.Check(err, check.IsNil)
 274
 275         // Might as well check that bogus tokens aren't accepted.
 276         badtoken := token + "plussomeboguschars"
 277         c.Logf("trying an API call with mangled token %q", badtoken)
 278         ctx = auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{badtoken}})
 279         cl, err = s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 280         c.Check(cl.Items, check.HasLen, 0)
 281         c.Check(err, check.NotNil)
 282         c.Check(err, check.ErrorMatches, `.*401 Unauthorized: Not logged in.*`)
 283 }
 284
 285 func (s *LoginSuite) TestGoogleLogin_RealName(c *check.C) {
 286         s.authEmail = "joe.smith@primary.example.com"
 287         s.fakePeopleAPIResponse = map[string]interface{}{
 288                 "names": []map[string]interface{}{
 289                         {
 290                                 "metadata":   map[string]interface{}{"primary": false},
 291                                 "givenName":  "Joe",
 292                                 "familyName": "Smith",
 293                         },
 294                         {
 295                                 "metadata":   map[string]interface{}{"primary": true},
 296                                 "givenName":  "Joseph",
 297                                 "familyName": "Psmith",
 298                         },
 299                 },
 300         }
 301         state := s.startLogin(c)
 302         s.localdb.Login(context.Background(), arvados.LoginOptions{
 303                 Code:  s.validCode,
 304                 State: state,
 305         })
 306
 307         authinfo := s.getCallbackAuthInfo(c)
 308         c.Check(authinfo.FirstName, check.Equals, "Joseph")
 309         c.Check(authinfo.LastName, check.Equals, "Psmith")
 310 }
 311
 312 func (s *LoginSuite) TestGoogleLogin_OIDCRealName(c *check.C) {
 313         s.authName = "Joe P. Smith"
 314         s.authEmail = "joe.smith@primary.example.com"
 315         state := s.startLogin(c)
 316         s.localdb.Login(context.Background(), arvados.LoginOptions{
 317                 Code:  s.validCode,
 318                 State: state,
 319         })
 320
 321         authinfo := s.getCallbackAuthInfo(c)
 322         c.Check(authinfo.FirstName, check.Equals, "Joe P.")
 323         c.Check(authinfo.LastName, check.Equals, "Smith")
 324 }
 325
 326 // People API returns some additional email addresses.
 327 func (s *LoginSuite) TestGoogleLogin_AlternateEmailAddresses(c *check.C) {
 328         s.authEmail = "joe.smith@primary.example.com"
 329         s.fakePeopleAPIResponse = map[string]interface{}{
 330                 "emailAddresses": []map[string]interface{}{
 331                         {
 332                                 "metadata": map[string]interface{}{"verified": true},
 333                                 "value":    "joe.smith@work.example.com",
 334                         },
 335                         {
 336                                 "value": "joe.smith@unverified.example.com", // unverified, so this one will be ignored
 337                         },
 338                         {
 339                                 "metadata": map[string]interface{}{"verified": true},
 340                                 "value":    "joe.smith@home.example.com",
 341                         },
 342                 },
 343         }
 344         state := s.startLogin(c)
 345         s.localdb.Login(context.Background(), arvados.LoginOptions{
 346                 Code:  s.validCode,
 347                 State: state,
 348         })
 349
 350         authinfo := s.getCallbackAuthInfo(c)
 351         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 352         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com", "joe.smith@work.example.com"})
 353 }
 354
 355 // Primary address is not the one initially returned by oidc.
 356 func (s *LoginSuite) TestGoogleLogin_AlternateEmailAddresses_Primary(c *check.C) {
 357         s.authEmail = "joe.smith@alternate.example.com"
 358         s.fakePeopleAPIResponse = map[string]interface{}{
 359                 "emailAddresses": []map[string]interface{}{
 360                         {
 361                                 "metadata": map[string]interface{}{"verified": true, "primary": true},
 362                                 "value":    "joe.smith@primary.example.com",
 363                         },
 364                         {
 365                                 "metadata": map[string]interface{}{"verified": true},
 366                                 "value":    "joe.smith@alternate.example.com",
 367                         },
 368                         {
 369                                 "metadata": map[string]interface{}{"verified": true},
 370                                 "value":    "jsmith+123@preferdomainforusername.example.com",
 371                         },
 372                 },
 373         }
 374         state := s.startLogin(c)
 375         s.localdb.Login(context.Background(), arvados.LoginOptions{
 376                 Code:  s.validCode,
 377                 State: state,
 378         })
 379         authinfo := s.getCallbackAuthInfo(c)
 380         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 381         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@alternate.example.com", "jsmith+123@preferdomainforusername.example.com"})
 382         c.Check(authinfo.Username, check.Equals, "jsmith")
 383 }
 384
 385 func (s *LoginSuite) TestGoogleLogin_NoPrimaryEmailAddress(c *check.C) {
 386         s.authEmail = "joe.smith@unverified.example.com"
 387         s.authEmailVerified = false
 388         s.fakePeopleAPIResponse = map[string]interface{}{
 389                 "emailAddresses": []map[string]interface{}{
 390                         {
 391                                 "metadata": map[string]interface{}{"verified": true},
 392                                 "value":    "joe.smith@work.example.com",
 393                         },
 394                         {
 395                                 "metadata": map[string]interface{}{"verified": true},
 396                                 "value":    "joe.smith@home.example.com",
 397                         },
 398                 },
 399         }
 400         state := s.startLogin(c)
 401         s.localdb.Login(context.Background(), arvados.LoginOptions{
 402                 Code:  s.validCode,
 403                 State: state,
 404         })
 405
 406         authinfo := s.getCallbackAuthInfo(c)
 407         c.Check(authinfo.Email, check.Equals, "joe.smith@work.example.com") // first verified email in People response
 408         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com"})
 409         c.Check(authinfo.Username, check.Equals, "")
 410 }
 411
 412 func (s *LoginSuite) getCallbackAuthInfo(c *check.C) (authinfo rpc.UserSessionAuthInfo) {
 413         for _, dump := range s.railsSpy.RequestDumps {
 414                 c.Logf("spied request: %q", dump)
 415                 split := bytes.Split(dump, []byte("\r\n\r\n"))
 416                 c.Assert(split, check.HasLen, 2)
 417                 hdr, body := string(split[0]), string(split[1])
 418                 if strings.Contains(hdr, "POST /auth/controller/callback") {
 419                         vs, err := url.ParseQuery(body)
 420                         c.Check(json.Unmarshal([]byte(vs.Get("auth_info")), &authinfo), check.IsNil)
 421                         c.Check(err, check.IsNil)
 422                         sort.Strings(authinfo.AlternateEmails)
 423                         return
 424                 }
 425         }
 426         c.Error("callback not found")
 427         return
 428 }
 429
 430 func (s *LoginSuite) startLogin(c *check.C) (state string) {
 431         // Initiate login, but instead of following the redirect to
 432         // the provider, just grab state from the redirect URL.
 433         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ReturnTo: "https://app.example.com/foo?bar"})
 434         c.Check(err, check.IsNil)
 435         target, err := url.Parse(resp.RedirectLocation)
 436         c.Check(err, check.IsNil)
 437         state = target.Query().Get("state")
 438         c.Check(state, check.Not(check.Equals), "")
 439         return
 440 }
 441
 442 func (s *LoginSuite) fakeToken(c *check.C, payload []byte) string {
 443         signer, err := jose.NewSigner(jose.SigningKey{Algorithm: jose.RS256, Key: s.issuerKey}, nil)
 444         if err != nil {
 445                 c.Error(err)
 446         }
 447         object, err := signer.Sign(payload)
 448         if err != nil {
 449                 c.Error(err)
 450         }
 451         t, err := object.CompactSerialize()
 452         if err != nil {
 453                 c.Error(err)
 454         }
 455         c.Logf("fakeToken(%q) == %q", payload, t)
 456         return t
 457 }