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.curoverse.com/arvados.git/lib/config"
  23         "git.curoverse.com/arvados.git/lib/controller/rpc"
  24         "git.curoverse.com/arvados.git/sdk/go/arvados"
  25         "git.curoverse.com/arvados.git/sdk/go/arvadostest"
  26         "git.curoverse.com/arvados.git/sdk/go/auth"
  27         "git.curoverse.com/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         c.Assert(err, check.IsNil)
 152
 153         s.localdb = NewConn(s.cluster)
 154         s.localdb.googleLoginController.issuer = s.fakeIssuer.URL
 155         s.localdb.googleLoginController.peopleAPIBasePath = s.fakePeopleAPI.URL
 156
 157         s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI)
 158         s.localdb.railsProxy = rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider)
 159 }
 160
 161 func (s *LoginSuite) TearDownTest(c *check.C) {
 162         s.railsSpy.Close()
 163 }
 164
 165 func (s *LoginSuite) TestGoogleLogin_Start_Bogus(c *check.C) {
 166         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{})
 167         c.Check(err, check.IsNil)
 168         c.Check(resp.RedirectLocation, check.Equals, "")
 169         c.Check(resp.HTML.String(), check.Matches, `.*missing return_to parameter.*`)
 170 }
 171
 172 func (s *LoginSuite) TestGoogleLogin_Start(c *check.C) {
 173         for _, remote := range []string{"", "zzzzz"} {
 174                 resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{Remote: remote, ReturnTo: "https://app.example.com/foo?bar"})
 175                 c.Check(err, check.IsNil)
 176                 target, err := url.Parse(resp.RedirectLocation)
 177                 c.Check(err, check.IsNil)
 178                 issuerURL, _ := url.Parse(s.fakeIssuer.URL)
 179                 c.Check(target.Host, check.Equals, issuerURL.Host)
 180                 q := target.Query()
 181                 c.Check(q.Get("client_id"), check.Equals, "test%client$id")
 182                 state := s.localdb.googleLoginController.parseOAuth2State(q.Get("state"))
 183                 c.Check(state.verify([]byte(s.cluster.SystemRootToken)), check.Equals, true)
 184                 c.Check(state.Time, check.Not(check.Equals), 0)
 185                 c.Check(state.Remote, check.Equals, remote)
 186                 c.Check(state.ReturnTo, check.Equals, "https://app.example.com/foo?bar")
 187         }
 188 }
 189
 190 func (s *LoginSuite) TestGoogleLogin_InvalidCode(c *check.C) {
 191         state := s.startLogin(c)
 192         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 193                 Code:  "first-try-a-bogus-code",
 194                 State: state,
 195         })
 196         c.Check(err, check.IsNil)
 197         c.Check(resp.RedirectLocation, check.Equals, "")
 198         c.Check(resp.HTML.String(), check.Matches, `(?ms).*error in OAuth2 exchange.*cannot fetch token.*`)
 199 }
 200
 201 func (s *LoginSuite) TestGoogleLogin_InvalidState(c *check.C) {
 202         s.startLogin(c)
 203         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 204                 Code:  s.validCode,
 205                 State: "bogus-state",
 206         })
 207         c.Check(err, check.IsNil)
 208         c.Check(resp.RedirectLocation, check.Equals, "")
 209         c.Check(resp.HTML.String(), check.Matches, `(?ms).*invalid OAuth2 state.*`)
 210 }
 211
 212 func (s *LoginSuite) setupPeopleAPIError(c *check.C) {
 213         s.fakePeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 214                 w.WriteHeader(http.StatusForbidden)
 215                 fmt.Fprintln(w, `Error 403: accessNotConfigured`)
 216         }))
 217         s.localdb.googleLoginController.peopleAPIBasePath = s.fakePeopleAPI.URL
 218 }
 219
 220 func (s *LoginSuite) TestGoogleLogin_PeopleAPIDisabled(c *check.C) {
 221         s.cluster.Login.GoogleAlternateEmailAddresses = false
 222         s.authEmail = "joe.smith@primary.example.com"
 223         s.setupPeopleAPIError(c)
 224         state := s.startLogin(c)
 225         _, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 226                 Code:  s.validCode,
 227                 State: state,
 228         })
 229         c.Check(err, check.IsNil)
 230         authinfo := s.getCallbackAuthInfo(c)
 231         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 232 }
 233
 234 func (s *LoginSuite) TestGoogleLogin_PeopleAPIError(c *check.C) {
 235         s.setupPeopleAPIError(c)
 236         state := s.startLogin(c)
 237         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 238                 Code:  s.validCode,
 239                 State: state,
 240         })
 241         c.Check(err, check.IsNil)
 242         c.Check(resp.RedirectLocation, check.Equals, "")
 243 }
 244
 245 func (s *LoginSuite) TestGoogleLogin_Success(c *check.C) {
 246         state := s.startLogin(c)
 247         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{
 248                 Code:  s.validCode,
 249                 State: state,
 250         })
 251         c.Check(err, check.IsNil)
 252         c.Check(resp.HTML.String(), check.Equals, "")
 253         target, err := url.Parse(resp.RedirectLocation)
 254         c.Check(err, check.IsNil)
 255         c.Check(target.Host, check.Equals, "app.example.com")
 256         c.Check(target.Path, check.Equals, "/foo")
 257         token := target.Query().Get("api_token")
 258         c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`)
 259
 260         authinfo := s.getCallbackAuthInfo(c)
 261         c.Check(authinfo.FirstName, check.Equals, "Fake User")
 262         c.Check(authinfo.LastName, check.Equals, "Name")
 263         c.Check(authinfo.Email, check.Equals, "active-user@arvados.local")
 264         c.Check(authinfo.AlternateEmails, check.HasLen, 0)
 265
 266         // Try using the returned Arvados token.
 267         c.Logf("trying an API call with new token %q", token)
 268         ctx := auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{token}})
 269         cl, err := s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 270         c.Check(cl.ItemsAvailable, check.Not(check.Equals), 0)
 271         c.Check(cl.Items, check.Not(check.HasLen), 0)
 272         c.Check(err, check.IsNil)
 273
 274         // Might as well check that bogus tokens aren't accepted.
 275         badtoken := token + "plussomeboguschars"
 276         c.Logf("trying an API call with mangled token %q", badtoken)
 277         ctx = auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{badtoken}})
 278         cl, err = s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1})
 279         c.Check(cl.Items, check.HasLen, 0)
 280         c.Check(err, check.NotNil)
 281         c.Check(err, check.ErrorMatches, `.*401 Unauthorized: Not logged in.*`)
 282 }
 283
 284 func (s *LoginSuite) TestGoogleLogin_RealName(c *check.C) {
 285         s.authEmail = "joe.smith@primary.example.com"
 286         s.fakePeopleAPIResponse = map[string]interface{}{
 287                 "names": []map[string]interface{}{
 288                         {
 289                                 "metadata":   map[string]interface{}{"primary": false},
 290                                 "givenName":  "Joe",
 291                                 "familyName": "Smith",
 292                         },
 293                         {
 294                                 "metadata":   map[string]interface{}{"primary": true},
 295                                 "givenName":  "Joseph",
 296                                 "familyName": "Psmith",
 297                         },
 298                 },
 299         }
 300         state := s.startLogin(c)
 301         s.localdb.Login(context.Background(), arvados.LoginOptions{
 302                 Code:  s.validCode,
 303                 State: state,
 304         })
 305
 306         authinfo := s.getCallbackAuthInfo(c)
 307         c.Check(authinfo.FirstName, check.Equals, "Joseph")
 308         c.Check(authinfo.LastName, check.Equals, "Psmith")
 309 }
 310
 311 func (s *LoginSuite) TestGoogleLogin_OIDCRealName(c *check.C) {
 312         s.authName = "Joe P. Smith"
 313         s.authEmail = "joe.smith@primary.example.com"
 314         state := s.startLogin(c)
 315         s.localdb.Login(context.Background(), arvados.LoginOptions{
 316                 Code:  s.validCode,
 317                 State: state,
 318         })
 319
 320         authinfo := s.getCallbackAuthInfo(c)
 321         c.Check(authinfo.FirstName, check.Equals, "Joe P.")
 322         c.Check(authinfo.LastName, check.Equals, "Smith")
 323 }
 324
 325 // People API returns some additional email addresses.
 326 func (s *LoginSuite) TestGoogleLogin_AlternateEmailAddresses(c *check.C) {
 327         s.authEmail = "joe.smith@primary.example.com"
 328         s.fakePeopleAPIResponse = map[string]interface{}{
 329                 "emailAddresses": []map[string]interface{}{
 330                         {
 331                                 "metadata": map[string]interface{}{"verified": true},
 332                                 "value":    "joe.smith@work.example.com",
 333                         },
 334                         {
 335                                 "value": "joe.smith@unverified.example.com", // unverified, so this one will be ignored
 336                         },
 337                         {
 338                                 "metadata": map[string]interface{}{"verified": true},
 339                                 "value":    "joe.smith@home.example.com",
 340                         },
 341                 },
 342         }
 343         state := s.startLogin(c)
 344         s.localdb.Login(context.Background(), arvados.LoginOptions{
 345                 Code:  s.validCode,
 346                 State: state,
 347         })
 348
 349         authinfo := s.getCallbackAuthInfo(c)
 350         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 351         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com", "joe.smith@work.example.com"})
 352 }
 353
 354 // Primary address is not the one initially returned by oidc.
 355 func (s *LoginSuite) TestGoogleLogin_AlternateEmailAddresses_Primary(c *check.C) {
 356         s.authEmail = "joe.smith@alternate.example.com"
 357         s.fakePeopleAPIResponse = map[string]interface{}{
 358                 "emailAddresses": []map[string]interface{}{
 359                         {
 360                                 "metadata": map[string]interface{}{"verified": true, "primary": true},
 361                                 "value":    "joe.smith@primary.example.com",
 362                         },
 363                         {
 364                                 "metadata": map[string]interface{}{"verified": true},
 365                                 "value":    "joe.smith@alternate.example.com",
 366                         },
 367                 },
 368         }
 369         state := s.startLogin(c)
 370         s.localdb.Login(context.Background(), arvados.LoginOptions{
 371                 Code:  s.validCode,
 372                 State: state,
 373         })
 374         authinfo := s.getCallbackAuthInfo(c)
 375         c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com")
 376         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@alternate.example.com"})
 377 }
 378
 379 func (s *LoginSuite) TestGoogleLogin_NoPrimaryEmailAddress(c *check.C) {
 380         s.authEmail = "joe.smith@unverified.example.com"
 381         s.authEmailVerified = false
 382         s.fakePeopleAPIResponse = map[string]interface{}{
 383                 "emailAddresses": []map[string]interface{}{
 384                         {
 385                                 "metadata": map[string]interface{}{"verified": true},
 386                                 "value":    "joe.smith@work.example.com",
 387                         },
 388                         {
 389                                 "metadata": map[string]interface{}{"verified": true},
 390                                 "value":    "joe.smith@home.example.com",
 391                         },
 392                 },
 393         }
 394         state := s.startLogin(c)
 395         s.localdb.Login(context.Background(), arvados.LoginOptions{
 396                 Code:  s.validCode,
 397                 State: state,
 398         })
 399
 400         authinfo := s.getCallbackAuthInfo(c)
 401         c.Check(authinfo.Email, check.Equals, "joe.smith@work.example.com") // first verified email in People response
 402         c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com"})
 403 }
 404
 405 func (s *LoginSuite) getCallbackAuthInfo(c *check.C) (authinfo rpc.UserSessionAuthInfo) {
 406         for _, dump := range s.railsSpy.RequestDumps {
 407                 c.Logf("spied request: %q", dump)
 408                 split := bytes.Split(dump, []byte("\r\n\r\n"))
 409                 c.Assert(split, check.HasLen, 2)
 410                 hdr, body := string(split[0]), string(split[1])
 411                 if strings.Contains(hdr, "POST /auth/controller/callback") {
 412                         vs, err := url.ParseQuery(body)
 413                         c.Check(json.Unmarshal([]byte(vs.Get("auth_info")), &authinfo), check.IsNil)
 414                         c.Check(err, check.IsNil)
 415                         sort.Strings(authinfo.AlternateEmails)
 416                         return
 417                 }
 418         }
 419         c.Error("callback not found")
 420         return
 421 }
 422
 423 func (s *LoginSuite) startLogin(c *check.C) (state string) {
 424         // Initiate login, but instead of following the redirect to
 425         // the provider, just grab state from the redirect URL.
 426         resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ReturnTo: "https://app.example.com/foo?bar"})
 427         c.Check(err, check.IsNil)
 428         target, err := url.Parse(resp.RedirectLocation)
 429         c.Check(err, check.IsNil)
 430         state = target.Query().Get("state")
 431         c.Check(state, check.Not(check.Equals), "")
 432         return
 433 }
 434
 435 func (s *LoginSuite) fakeToken(c *check.C, payload []byte) string {
 436         signer, err := jose.NewSigner(jose.SigningKey{Algorithm: jose.RS256, Key: s.issuerKey}, nil)
 437         if err != nil {
 438                 c.Error(err)
 439         }
 440         object, err := signer.Sign(payload)
 441         if err != nil {
 442                 c.Error(err)
 443         }
 444         t, err := object.CompactSerialize()
 445         if err != nil {
 446                 c.Error(err)
 447         }
 448         c.Logf("fakeToken(%q) == %q", payload, t)
 449         return t
 450 }