// Copyright (C) The Arvados Authors. All rights reserved. // // SPDX-License-Identifier: AGPL-3.0 package localdb import ( "bytes" "context" "crypto/rand" "crypto/rsa" "encoding/base64" "encoding/json" "fmt" "net/http" "net/http/httptest" "net/url" "sort" "strings" "testing" "time" "git.arvados.org/arvados.git/lib/config" "git.arvados.org/arvados.git/lib/controller/rpc" "git.arvados.org/arvados.git/sdk/go/arvados" "git.arvados.org/arvados.git/sdk/go/arvadostest" "git.arvados.org/arvados.git/sdk/go/auth" "git.arvados.org/arvados.git/sdk/go/ctxlog" check "gopkg.in/check.v1" jose "gopkg.in/square/go-jose.v2" ) // Gocheck boilerplate func Test(t *testing.T) { check.TestingT(t) } var _ = check.Suite(&OIDCLoginSuite{}) type OIDCLoginSuite struct { cluster *arvados.Cluster localdb *Conn railsSpy *arvadostest.Proxy fakeIssuer *httptest.Server fakePeopleAPI *httptest.Server fakePeopleAPIResponse map[string]interface{} issuerKey *rsa.PrivateKey // expected token request validCode string validClientID string validClientSecret string // desired response from token endpoint authEmail string authEmailVerified bool authName string } func (s *OIDCLoginSuite) TearDownSuite(c *check.C) { // Undo any changes/additions to the user database so they // don't affect subsequent tests. arvadostest.ResetEnv() c.Check(arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil), check.IsNil) } func (s *OIDCLoginSuite) SetUpTest(c *check.C) { var err error s.issuerKey, err = rsa.GenerateKey(rand.Reader, 2048) c.Assert(err, check.IsNil) s.authEmail = "active-user@arvados.local" s.authEmailVerified = true s.authName = "Fake User Name" s.fakeIssuer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { req.ParseForm() c.Logf("fakeIssuer: got req: %s %s %s", req.Method, req.URL, req.Form) w.Header().Set("Content-Type", "application/json") switch req.URL.Path { case "/.well-known/openid-configuration": json.NewEncoder(w).Encode(map[string]interface{}{ "issuer": s.fakeIssuer.URL, "authorization_endpoint": s.fakeIssuer.URL + "/auth", "token_endpoint": s.fakeIssuer.URL + "/token", "jwks_uri": s.fakeIssuer.URL + "/jwks", "userinfo_endpoint": s.fakeIssuer.URL + "/userinfo", }) case "/token": var clientID, clientSecret string auth, _ := base64.StdEncoding.DecodeString(strings.TrimPrefix(req.Header.Get("Authorization"), "Basic ")) authsplit := strings.Split(string(auth), ":") if len(authsplit) == 2 { clientID, _ = url.QueryUnescape(authsplit[0]) clientSecret, _ = url.QueryUnescape(authsplit[1]) } if clientID != s.validClientID || clientSecret != s.validClientSecret { c.Logf("fakeIssuer: expected (%q, %q) got (%q, %q)", s.validClientID, s.validClientSecret, clientID, clientSecret) w.WriteHeader(http.StatusUnauthorized) return } if req.Form.Get("code") != s.validCode || s.validCode == "" { w.WriteHeader(http.StatusUnauthorized) return } idToken, _ := json.Marshal(map[string]interface{}{ "iss": s.fakeIssuer.URL, "aud": []string{clientID}, "sub": "fake-user-id", "exp": time.Now().UTC().Add(time.Minute).Unix(), "iat": time.Now().UTC().Unix(), "nonce": "fake-nonce", "email": s.authEmail, "email_verified": s.authEmailVerified, "name": s.authName, "alt_verified": true, // for custom claim tests "alt_email": "alt_email@example.com", // for custom claim tests "alt_username": "desired-username", // for custom claim tests }) json.NewEncoder(w).Encode(struct { AccessToken string `json:"access_token"` TokenType string `json:"token_type"` RefreshToken string `json:"refresh_token"` ExpiresIn int32 `json:"expires_in"` IDToken string `json:"id_token"` }{ AccessToken: s.fakeToken(c, []byte("fake access token")), TokenType: "Bearer", RefreshToken: "test-refresh-token", ExpiresIn: 30, IDToken: s.fakeToken(c, idToken), }) case "/jwks": json.NewEncoder(w).Encode(jose.JSONWebKeySet{ Keys: []jose.JSONWebKey{ {Key: s.issuerKey.Public(), Algorithm: string(jose.RS256), KeyID: ""}, }, }) case "/auth": w.WriteHeader(http.StatusInternalServerError) case "/userinfo": w.WriteHeader(http.StatusInternalServerError) default: w.WriteHeader(http.StatusNotFound) } })) s.validCode = fmt.Sprintf("abcdefgh-%d", time.Now().Unix()) s.fakePeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { req.ParseForm() c.Logf("fakePeopleAPI: got req: %s %s %s", req.Method, req.URL, req.Form) w.Header().Set("Content-Type", "application/json") switch req.URL.Path { case "/v1/people/me": if f := req.Form.Get("personFields"); f != "emailAddresses,names" { w.WriteHeader(http.StatusBadRequest) break } json.NewEncoder(w).Encode(s.fakePeopleAPIResponse) default: w.WriteHeader(http.StatusNotFound) } })) s.fakePeopleAPIResponse = map[string]interface{}{} cfg, err := config.NewLoader(nil, ctxlog.TestLogger(c)).Load() c.Assert(err, check.IsNil) s.cluster, err = cfg.GetCluster("") c.Assert(err, check.IsNil) s.cluster.Login.SSO.Enable = false s.cluster.Login.Google.Enable = true s.cluster.Login.Google.ClientID = "test%client$id" s.cluster.Login.Google.ClientSecret = "test#client/secret" s.cluster.Users.PreferDomainForUsername = "PreferDomainForUsername.example.com" s.validClientID = "test%client$id" s.validClientSecret = "test#client/secret" s.localdb = NewConn(s.cluster) c.Assert(s.localdb.loginController, check.FitsTypeOf, (*oidcLoginController)(nil)) s.localdb.loginController.(*oidcLoginController).Issuer = s.fakeIssuer.URL s.localdb.loginController.(*oidcLoginController).peopleAPIBasePath = s.fakePeopleAPI.URL s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI) *s.localdb.railsProxy = *rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider) } func (s *OIDCLoginSuite) TearDownTest(c *check.C) { s.railsSpy.Close() } func (s *OIDCLoginSuite) TestGoogleLogout(c *check.C) { resp, err := s.localdb.Logout(context.Background(), arvados.LogoutOptions{ReturnTo: "https://foo.example.com/bar"}) c.Check(err, check.IsNil) c.Check(resp.RedirectLocation, check.Equals, "https://foo.example.com/bar") } func (s *OIDCLoginSuite) TestGoogleLogin_Start_Bogus(c *check.C) { resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{}) c.Check(err, check.IsNil) c.Check(resp.RedirectLocation, check.Equals, "") c.Check(resp.HTML.String(), check.Matches, `.*missing return_to parameter.*`) } func (s *OIDCLoginSuite) TestGoogleLogin_Start(c *check.C) { for _, remote := range []string{"", "zzzzz"} { resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{Remote: remote, ReturnTo: "https://app.example.com/foo?bar"}) c.Check(err, check.IsNil) target, err := url.Parse(resp.RedirectLocation) c.Check(err, check.IsNil) issuerURL, _ := url.Parse(s.fakeIssuer.URL) c.Check(target.Host, check.Equals, issuerURL.Host) q := target.Query() c.Check(q.Get("client_id"), check.Equals, "test%client$id") state := s.localdb.loginController.(*oidcLoginController).parseOAuth2State(q.Get("state")) c.Check(state.verify([]byte(s.cluster.SystemRootToken)), check.Equals, true) c.Check(state.Time, check.Not(check.Equals), 0) c.Check(state.Remote, check.Equals, remote) c.Check(state.ReturnTo, check.Equals, "https://app.example.com/foo?bar") } } func (s *OIDCLoginSuite) TestGoogleLogin_InvalidCode(c *check.C) { state := s.startLogin(c) resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: "first-try-a-bogus-code", State: state, }) c.Check(err, check.IsNil) c.Check(resp.RedirectLocation, check.Equals, "") c.Check(resp.HTML.String(), check.Matches, `(?ms).*error in OAuth2 exchange.*cannot fetch token.*`) } func (s *OIDCLoginSuite) TestGoogleLogin_InvalidState(c *check.C) { s.startLogin(c) resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: "bogus-state", }) c.Check(err, check.IsNil) c.Check(resp.RedirectLocation, check.Equals, "") c.Check(resp.HTML.String(), check.Matches, `(?ms).*invalid OAuth2 state.*`) } func (s *OIDCLoginSuite) setupPeopleAPIError(c *check.C) { s.fakePeopleAPI = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { w.WriteHeader(http.StatusForbidden) fmt.Fprintln(w, `Error 403: accessNotConfigured`) })) s.localdb.loginController.(*oidcLoginController).peopleAPIBasePath = s.fakePeopleAPI.URL } func (s *OIDCLoginSuite) TestGoogleLogin_PeopleAPIDisabled(c *check.C) { s.localdb.loginController.(*oidcLoginController).UseGooglePeopleAPI = false s.authEmail = "joe.smith@primary.example.com" s.setupPeopleAPIError(c) state := s.startLogin(c) _, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) c.Check(err, check.IsNil) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com") } func (s *OIDCLoginSuite) TestConfig(c *check.C) { s.cluster.Login.Google.Enable = false s.cluster.Login.OpenIDConnect.Enable = true s.cluster.Login.OpenIDConnect.Issuer = "https://accounts.example.com/" s.cluster.Login.OpenIDConnect.ClientID = "oidc-client-id" s.cluster.Login.OpenIDConnect.ClientSecret = "oidc-client-secret" localdb := NewConn(s.cluster) ctrl := localdb.loginController.(*oidcLoginController) c.Check(ctrl.Issuer, check.Equals, "https://accounts.example.com/") c.Check(ctrl.ClientID, check.Equals, "oidc-client-id") c.Check(ctrl.ClientSecret, check.Equals, "oidc-client-secret") c.Check(ctrl.UseGooglePeopleAPI, check.Equals, false) for _, enableAltEmails := range []bool{false, true} { s.cluster.Login.OpenIDConnect.Enable = false s.cluster.Login.Google.Enable = true s.cluster.Login.Google.ClientID = "google-client-id" s.cluster.Login.Google.ClientSecret = "google-client-secret" s.cluster.Login.Google.AlternateEmailAddresses = enableAltEmails localdb = NewConn(s.cluster) ctrl = localdb.loginController.(*oidcLoginController) c.Check(ctrl.Issuer, check.Equals, "https://accounts.google.com") c.Check(ctrl.ClientID, check.Equals, "google-client-id") c.Check(ctrl.ClientSecret, check.Equals, "google-client-secret") c.Check(ctrl.UseGooglePeopleAPI, check.Equals, enableAltEmails) } } func (s *OIDCLoginSuite) TestGoogleLogin_PeopleAPIError(c *check.C) { s.setupPeopleAPIError(c) state := s.startLogin(c) resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) c.Check(err, check.IsNil) c.Check(resp.RedirectLocation, check.Equals, "") } func (s *OIDCLoginSuite) TestGenericOIDCLogin(c *check.C) { s.cluster.Login.Google.Enable = false s.cluster.Login.OpenIDConnect.Enable = true json.Unmarshal([]byte(fmt.Sprintf("%q", s.fakeIssuer.URL)), &s.cluster.Login.OpenIDConnect.Issuer) s.cluster.Login.OpenIDConnect.ClientID = "oidc#client#id" s.cluster.Login.OpenIDConnect.ClientSecret = "oidc#client#secret" s.validClientID = "oidc#client#id" s.validClientSecret = "oidc#client#secret" for _, trial := range []struct { expectEmail string // "" if failure expected setup func() }{ { expectEmail: "user@oidc.example.com", setup: func() { c.Log("=== succeed because email_verified is false but not required") s.authEmail = "user@oidc.example.com" s.authEmailVerified = false s.cluster.Login.OpenIDConnect.EmailClaim = "email" s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "" s.cluster.Login.OpenIDConnect.UsernameClaim = "" }, }, { expectEmail: "", setup: func() { c.Log("=== fail because email_verified is false and required") s.authEmail = "user@oidc.example.com" s.authEmailVerified = false s.cluster.Login.OpenIDConnect.EmailClaim = "email" s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "email_verified" s.cluster.Login.OpenIDConnect.UsernameClaim = "" }, }, { expectEmail: "user@oidc.example.com", setup: func() { c.Log("=== succeed because email_verified is false but config uses custom 'verified' claim") s.authEmail = "user@oidc.example.com" s.authEmailVerified = false s.cluster.Login.OpenIDConnect.EmailClaim = "email" s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "alt_verified" s.cluster.Login.OpenIDConnect.UsernameClaim = "" }, }, { expectEmail: "alt_email@example.com", setup: func() { c.Log("=== succeed with custom 'email' and 'email_verified' claims") s.authEmail = "bad@wrong.example.com" s.authEmailVerified = false s.cluster.Login.OpenIDConnect.EmailClaim = "alt_email" s.cluster.Login.OpenIDConnect.EmailVerifiedClaim = "alt_verified" s.cluster.Login.OpenIDConnect.UsernameClaim = "alt_username" }, }, } { trial.setup() if s.railsSpy != nil { s.railsSpy.Close() } s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI) s.localdb = NewConn(s.cluster) *s.localdb.railsProxy = *rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider) state := s.startLogin(c) resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) c.Assert(err, check.IsNil) if trial.expectEmail == "" { c.Check(resp.HTML.String(), check.Matches, `(?ms).*Login error.*`) c.Check(resp.RedirectLocation, check.Equals, "") continue } c.Check(resp.HTML.String(), check.Equals, "") target, err := url.Parse(resp.RedirectLocation) c.Assert(err, check.IsNil) token := target.Query().Get("api_token") c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.Email, check.Equals, trial.expectEmail) switch s.cluster.Login.OpenIDConnect.UsernameClaim { case "alt_username": c.Check(authinfo.Username, check.Equals, "desired-username") case "": c.Check(authinfo.Username, check.Equals, "") default: c.Fail() // bad test case } } } func (s *OIDCLoginSuite) TestGoogleLogin_Success(c *check.C) { state := s.startLogin(c) resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) c.Check(err, check.IsNil) c.Check(resp.HTML.String(), check.Equals, "") target, err := url.Parse(resp.RedirectLocation) c.Check(err, check.IsNil) c.Check(target.Host, check.Equals, "app.example.com") c.Check(target.Path, check.Equals, "/foo") token := target.Query().Get("api_token") c.Check(token, check.Matches, `v2/zzzzz-gj3su-.{15}/.{32,50}`) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.FirstName, check.Equals, "Fake User") c.Check(authinfo.LastName, check.Equals, "Name") c.Check(authinfo.Email, check.Equals, "active-user@arvados.local") c.Check(authinfo.AlternateEmails, check.HasLen, 0) // Try using the returned Arvados token. c.Logf("trying an API call with new token %q", token) ctx := auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{token}}) cl, err := s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1}) c.Check(cl.ItemsAvailable, check.Not(check.Equals), 0) c.Check(cl.Items, check.Not(check.HasLen), 0) c.Check(err, check.IsNil) // Might as well check that bogus tokens aren't accepted. badtoken := token + "plussomeboguschars" c.Logf("trying an API call with mangled token %q", badtoken) ctx = auth.NewContext(context.Background(), &auth.Credentials{Tokens: []string{badtoken}}) cl, err = s.localdb.CollectionList(ctx, arvados.ListOptions{Limit: -1}) c.Check(cl.Items, check.HasLen, 0) c.Check(err, check.NotNil) c.Check(err, check.ErrorMatches, `.*401 Unauthorized: Not logged in.*`) } func (s *OIDCLoginSuite) TestGoogleLogin_RealName(c *check.C) { s.authEmail = "joe.smith@primary.example.com" s.fakePeopleAPIResponse = map[string]interface{}{ "names": []map[string]interface{}{ { "metadata": map[string]interface{}{"primary": false}, "givenName": "Joe", "familyName": "Smith", }, { "metadata": map[string]interface{}{"primary": true}, "givenName": "Joseph", "familyName": "Psmith", }, }, } state := s.startLogin(c) s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.FirstName, check.Equals, "Joseph") c.Check(authinfo.LastName, check.Equals, "Psmith") } func (s *OIDCLoginSuite) TestGoogleLogin_OIDCRealName(c *check.C) { s.authName = "Joe P. Smith" s.authEmail = "joe.smith@primary.example.com" state := s.startLogin(c) s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.FirstName, check.Equals, "Joe P.") c.Check(authinfo.LastName, check.Equals, "Smith") } // People API returns some additional email addresses. func (s *OIDCLoginSuite) TestGoogleLogin_AlternateEmailAddresses(c *check.C) { s.authEmail = "joe.smith@primary.example.com" s.fakePeopleAPIResponse = map[string]interface{}{ "emailAddresses": []map[string]interface{}{ { "metadata": map[string]interface{}{"verified": true}, "value": "joe.smith@work.example.com", }, { "value": "joe.smith@unverified.example.com", // unverified, so this one will be ignored }, { "metadata": map[string]interface{}{"verified": true}, "value": "joe.smith@home.example.com", }, }, } state := s.startLogin(c) s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com") c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com", "joe.smith@work.example.com"}) } // Primary address is not the one initially returned by oidc. func (s *OIDCLoginSuite) TestGoogleLogin_AlternateEmailAddresses_Primary(c *check.C) { s.authEmail = "joe.smith@alternate.example.com" s.fakePeopleAPIResponse = map[string]interface{}{ "emailAddresses": []map[string]interface{}{ { "metadata": map[string]interface{}{"verified": true, "primary": true}, "value": "joe.smith@primary.example.com", }, { "metadata": map[string]interface{}{"verified": true}, "value": "joe.smith@alternate.example.com", }, { "metadata": map[string]interface{}{"verified": true}, "value": "jsmith+123@preferdomainforusername.example.com", }, }, } state := s.startLogin(c) s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.Email, check.Equals, "joe.smith@primary.example.com") c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@alternate.example.com", "jsmith+123@preferdomainforusername.example.com"}) c.Check(authinfo.Username, check.Equals, "jsmith") } func (s *OIDCLoginSuite) TestGoogleLogin_NoPrimaryEmailAddress(c *check.C) { s.authEmail = "joe.smith@unverified.example.com" s.authEmailVerified = false s.fakePeopleAPIResponse = map[string]interface{}{ "emailAddresses": []map[string]interface{}{ { "metadata": map[string]interface{}{"verified": true}, "value": "joe.smith@work.example.com", }, { "metadata": map[string]interface{}{"verified": true}, "value": "joe.smith@home.example.com", }, }, } state := s.startLogin(c) s.localdb.Login(context.Background(), arvados.LoginOptions{ Code: s.validCode, State: state, }) authinfo := getCallbackAuthInfo(c, s.railsSpy) c.Check(authinfo.Email, check.Equals, "joe.smith@work.example.com") // first verified email in People response c.Check(authinfo.AlternateEmails, check.DeepEquals, []string{"joe.smith@home.example.com"}) c.Check(authinfo.Username, check.Equals, "") } func (s *OIDCLoginSuite) startLogin(c *check.C) (state string) { // Initiate login, but instead of following the redirect to // the provider, just grab state from the redirect URL. resp, err := s.localdb.Login(context.Background(), arvados.LoginOptions{ReturnTo: "https://app.example.com/foo?bar"}) c.Check(err, check.IsNil) target, err := url.Parse(resp.RedirectLocation) c.Check(err, check.IsNil) state = target.Query().Get("state") c.Check(state, check.Not(check.Equals), "") return } func (s *OIDCLoginSuite) fakeToken(c *check.C, payload []byte) string { signer, err := jose.NewSigner(jose.SigningKey{Algorithm: jose.RS256, Key: s.issuerKey}, nil) if err != nil { c.Error(err) } object, err := signer.Sign(payload) if err != nil { c.Error(err) } t, err := object.CompactSerialize() if err != nil { c.Error(err) } c.Logf("fakeToken(%q) == %q", payload, t) return t } func getCallbackAuthInfo(c *check.C, railsSpy *arvadostest.Proxy) (authinfo rpc.UserSessionAuthInfo) { for _, dump := range railsSpy.RequestDumps { c.Logf("spied request: %q", dump) split := bytes.Split(dump, []byte("\r\n\r\n")) c.Assert(split, check.HasLen, 2) hdr, body := string(split[0]), string(split[1]) if strings.Contains(hdr, "POST /auth/controller/callback") { vs, err := url.ParseQuery(body) c.Check(json.Unmarshal([]byte(vs.Get("auth_info")), &authinfo), check.IsNil) c.Check(err, check.IsNil) sort.Strings(authinfo.AlternateEmails) return } } c.Error("callback not found") return }