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                         AcceptAccessTokenScope: cluster.Login.OpenIDConnect.AcceptAccessTokenScope,
  67                 }
  68         case wantSSO:
  69                 return &ssoLoginController{Parent: parent}
  70         case wantPAM:
  71                 return &pamLoginController{Cluster: cluster, Parent: parent}
  72         case wantLDAP:
  73                 return &ldapLoginController{Cluster: cluster, Parent: parent}
  74         case wantTest:
  75                 return &testLoginController{Cluster: cluster, Parent: parent}
  76         case wantLoginCluster:
  77                 return &federatedLoginController{Cluster: cluster}
  78         default:
  79                 return errorLoginController{
  80                         error: errors.New("BUG: missing case in login controller setup switch"),
  81                 }
  82         }
  83 }
  84
  85 func countTrue(vals ...bool) int {
  86         n := 0
  87         for _, val := range vals {
  88                 if val {
  89                         n++
  90                 }
  91         }
  92         return n
  93 }
  94
  95 // Login and Logout are passed through to the parent's railsProxy;
  96 // UserAuthenticate is rejected.
  97 type ssoLoginController struct{ Parent *Conn }
  98
  99 func (ctrl *ssoLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
 100         return ctrl.Parent.railsProxy.Login(ctx, opts)
 101 }
 102 func (ctrl *ssoLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 103         return ctrl.Parent.railsProxy.Logout(ctx, opts)
 104 }
 105 func (ctrl *ssoLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 106         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
 107 }
 108
 109 type errorLoginController struct{ error }
 110
 111 func (ctrl errorLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
 112         return arvados.LoginResponse{}, ctrl.error
 113 }
 114 func (ctrl errorLoginController) Logout(context.Context, arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 115         return arvados.LogoutResponse{}, ctrl.error
 116 }
 117 func (ctrl errorLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 118         return arvados.APIClientAuthorization{}, ctrl.error
 119 }
 120
 121 type federatedLoginController struct {
 122         Cluster *arvados.Cluster
 123 }
 124
 125 func (ctrl federatedLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
 126         return arvados.LoginResponse{}, httpserver.ErrorWithStatus(errors.New("Should have been redirected to login cluster"), http.StatusBadRequest)
 127 }
 128 func (ctrl federatedLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 129         return logout(ctx, ctrl.Cluster, opts)
 130 }
 131 func (ctrl federatedLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
 132         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
 133 }
 134
 135 func (conn *Conn) CreateAPIClientAuthorization(ctx context.Context, rootToken string, authinfo rpc.UserSessionAuthInfo) (resp arvados.APIClientAuthorization, err error) {
 136         if rootToken == "" {
 137                 return arvados.APIClientAuthorization{}, errors.New("configuration error: empty SystemRootToken")
 138         }
 139         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{rootToken}})
 140         newsession, err := conn.railsProxy.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
 141                 // Send a fake ReturnTo value instead of the caller's
 142                 // opts.ReturnTo. We won't follow the resulting
 143                 // redirect target anyway.
 144                 ReturnTo: ",https://controller.api.client.invalid",
 145                 AuthInfo: authinfo,
 146         })
 147         if err != nil {
 148                 return
 149         }
 150         target, err := url.Parse(newsession.RedirectLocation)
 151         if err != nil {
 152                 return
 153         }
 154         token := target.Query().Get("api_token")
 155         tx, err := ctrlctx.CurrentTx(ctx)
 156         if err != nil {
 157                 return
 158         }
 159         tokensecret := token
 160         if strings.Contains(token, "/") {
 161                 tokenparts := strings.Split(token, "/")
 162                 if len(tokenparts) >= 3 {
 163                         tokensecret = tokenparts[2]
 164                 }
 165         }
 166         var exp sql.NullString
 167         var scopes []byte
 168         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)
 169         if err != nil {
 170                 return
 171         }
 172         resp.ExpiresAt = exp.String
 173         if len(scopes) > 0 {
 174                 err = json.Unmarshal(scopes, &resp.Scopes)
 175                 if err != nil {
 176                         return resp, fmt.Errorf("unmarshal scopes: %s", err)
 177                 }
 178         }
 179         return
 180 }