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