lib/controller/localdb/login.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         "context"
   9         "database/sql"
  10         "encoding/json"
  11         "errors"
  12         "fmt"
  13         "net/http"
  14         "net/url"
  15         "strings"
  16
  17         "git.arvados.org/arvados.git/lib/controller/rpc"
  18         "git.arvados.org/arvados.git/lib/ctrlctx"
  19         "git.arvados.org/arvados.git/sdk/go/arvados"
  20         "git.arvados.org/arvados.git/sdk/go/auth"
  21         "git.arvados.org/arvados.git/sdk/go/httpserver"
  22 )
  23
  24 type loginController interface {
  25         Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error)
  26         Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error)
  27         UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error)
  28 }
  29
  30 func chooseLoginController(cluster *arvados.Cluster, parent *Conn) loginController {
  31         wantGoogle := cluster.Login.Google.Enable
  32         wantOpenIDConnect := cluster.Login.OpenIDConnect.Enable
  33         wantSSO := cluster.Login.SSO.Enable
  34         wantPAM := cluster.Login.PAM.Enable
  35         wantLDAP := cluster.Login.LDAP.Enable
  36         wantTest := cluster.Login.Test.Enable
  37         wantLoginCluster := cluster.Login.LoginCluster != "" && cluster.Login.LoginCluster != cluster.ClusterID
  38         switch {
  39         case 1 != countTrue(wantGoogle, wantOpenIDConnect, wantSSO, wantPAM, wantLDAP, wantTest, wantLoginCluster):
  40                 return errorLoginController{
  41                         error: errors.New("configuration problem: exactly one of Login.Google, Login.OpenIDConnect, Login.SSO, Login.PAM, Login.LDAP, Login.Test, or Login.LoginCluster must be set"),
  42                 }
  43         case wantGoogle:
  44                 return &oidcLoginController{
  45                         Cluster:            cluster,
  46                         Parent:             parent,
  47                         Issuer:             "https://accounts.google.com",
  48                         ClientID:           cluster.Login.Google.ClientID,
  49                         ClientSecret:       cluster.Login.Google.ClientSecret,
  50                         AuthParams:         cluster.Login.Google.AuthenticationRequestParameters,
  51                         UseGooglePeopleAPI: cluster.Login.Google.AlternateEmailAddresses,
  52                         EmailClaim:         "email",
  53                         EmailVerifiedClaim: "email_verified",
  54                 }
  55         case wantOpenIDConnect:
  56                 return &oidcLoginController{
  57                         Cluster:                cluster,
  58                         Parent:                 parent,
  59                         Issuer:                 cluster.Login.OpenIDConnect.Issuer,
  60                         ClientID:               cluster.Login.OpenIDConnect.ClientID,
  61                         ClientSecret:           cluster.Login.OpenIDConnect.ClientSecret,
  62                         AuthParams:             cluster.Login.OpenIDConnect.AuthenticationRequestParameters,
  63                         EmailClaim:             cluster.Login.OpenIDConnect.EmailClaim,
  64                         EmailVerifiedClaim:     cluster.Login.OpenIDConnect.EmailVerifiedClaim,
  65                         UsernameClaim:          cluster.Login.OpenIDConnect.UsernameClaim,
  66                         AcceptAccessToken:      cluster.Login.OpenIDConnect.AcceptAccessToken,
  67                         AcceptAccessTokenScope: cluster.Login.OpenIDConnect.AcceptAccessTokenScope,
  68                 }
  69         case wantSSO:
  70                 return &ssoLoginController{Parent: parent}
  71         case wantPAM:
  72                 return &pamLoginController{Cluster: cluster, Parent: parent}
  73         case wantLDAP:
  74                 return &ldapLoginController{Cluster: cluster, Parent: parent}
  75         case wantTest:
  76                 return &testLoginController{Cluster: cluster, Parent: parent}
  77         case wantLoginCluster:
  78                 return &federatedLoginController{Cluster: cluster}
  79         default:
  80                 return errorLoginController{
  81                         error: errors.New("BUG: missing case in login controller setup switch"),
  82                 }
  83         }
  84 }
  85
  86 func countTrue(vals ...bool) int {
  87         n := 0
  88         for _, val := range vals {
  89                 if val {
  90                         n++
  91                 }
  92         }
  93         return n
  94 }
  95
  96 // Login and Logout are passed through to the parent's railsProxy;
  97 // UserAuthenticate is rejected.
  98 type ssoLoginController struct{ Parent *Conn }
  99
 100 func (ctrl *ssoLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
 101         return ctrl.Parent.railsProxy.Login(ctx, opts)
 102 }
 103 func (ctrl *ssoLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 104         return ctrl.Parent.railsProxy.Logout(ctx, opts)
 105 }
 106 func (ctrl *ssoLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 107         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
 108 }
 109
 110 type errorLoginController struct{ error }
 111
 112 func (ctrl errorLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
 113         return arvados.LoginResponse{}, ctrl.error
 114 }
 115 func (ctrl errorLoginController) Logout(context.Context, arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 116         return arvados.LogoutResponse{}, ctrl.error
 117 }
 118 func (ctrl errorLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 119         return arvados.APIClientAuthorization{}, ctrl.error
 120 }
 121
 122 type federatedLoginController struct {
 123         Cluster *arvados.Cluster
 124 }
 125
 126 func (ctrl federatedLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
 127         return arvados.LoginResponse{}, httpserver.ErrorWithStatus(errors.New("Should have been redirected to login cluster"), http.StatusBadRequest)
 128 }
 129 func (ctrl federatedLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 130         return logout(ctx, ctrl.Cluster, opts)
 131 }
 132 func (ctrl federatedLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 133         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
 134 }
 135
 136 func (conn *Conn) CreateAPIClientAuthorization(ctx context.Context, rootToken string, authinfo rpc.UserSessionAuthInfo) (resp arvados.APIClientAuthorization, err error) {
 137         if rootToken == "" {
 138                 return arvados.APIClientAuthorization{}, errors.New("configuration error: empty SystemRootToken")
 139         }
 140         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{rootToken}})
 141         newsession, err := conn.railsProxy.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
 142                 // Send a fake ReturnTo value instead of the caller's
 143                 // opts.ReturnTo. We won't follow the resulting
 144                 // redirect target anyway.
 145                 ReturnTo: ",https://controller.api.client.invalid",
 146                 AuthInfo: authinfo,
 147         })
 148         if err != nil {
 149                 return
 150         }
 151         target, err := url.Parse(newsession.RedirectLocation)
 152         if err != nil {
 153                 return
 154         }
 155         token := target.Query().Get("api_token")
 156         tx, err := ctrlctx.CurrentTx(ctx)
 157         if err != nil {
 158                 return
 159         }
 160         tokensecret := token
 161         if strings.Contains(token, "/") {
 162                 tokenparts := strings.Split(token, "/")
 163                 if len(tokenparts) >= 3 {
 164                         tokensecret = tokenparts[2]
 165                 }
 166         }
 167         var exp sql.NullString
 168         var scopes []byte
 169         err = tx.QueryRowxContext(ctx, "select uuid, api_token, expires_at, scopes from api_client_authorizations where api_token=$1", tokensecret).Scan(&resp.UUID, &resp.APIToken, &exp, &scopes)
 170         if err != nil {
 171                 return
 172         }
 173         resp.ExpiresAt = exp.String
 174         if len(scopes) > 0 {
 175                 err = json.Unmarshal(scopes, &resp.Scopes)
 176                 if err != nil {
 177                         return resp, fmt.Errorf("unmarshal scopes: %s", err)
 178                 }
 179         }
 180         return
 181 }