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