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, railsProxy *railsProxy) 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         switch {
  37         case wantGoogle && !wantOpenIDConnect && !wantSSO && !wantPAM && !wantLDAP:
  38                 return &oidcLoginController{
  39                         Cluster:            cluster,
  40                         RailsProxy:         railsProxy,
  41                         Issuer:             "https://accounts.google.com",
  42                         ClientID:           cluster.Login.Google.ClientID,
  43                         ClientSecret:       cluster.Login.Google.ClientSecret,
  44                         UseGooglePeopleAPI: cluster.Login.Google.AlternateEmailAddresses,
  45                         EmailClaim:         "email",
  46                         EmailVerifiedClaim: "email_verified",
  47                 }
  48         case !wantGoogle && wantOpenIDConnect && !wantSSO && !wantPAM && !wantLDAP:
  49                 return &oidcLoginController{
  50                         Cluster:            cluster,
  51                         RailsProxy:         railsProxy,
  52                         Issuer:             cluster.Login.OpenIDConnect.Issuer,
  53                         ClientID:           cluster.Login.OpenIDConnect.ClientID,
  54                         ClientSecret:       cluster.Login.OpenIDConnect.ClientSecret,
  55                         EmailClaim:         cluster.Login.OpenIDConnect.EmailClaim,
  56                         EmailVerifiedClaim: cluster.Login.OpenIDConnect.EmailVerifiedClaim,
  57                         UsernameClaim:      cluster.Login.OpenIDConnect.UsernameClaim,
  58                 }
  59         case !wantGoogle && !wantOpenIDConnect && wantSSO && !wantPAM && !wantLDAP:
  60                 return &ssoLoginController{railsProxy}
  61         case !wantGoogle && !wantOpenIDConnect && !wantSSO && wantPAM && !wantLDAP:
  62                 return &pamLoginController{Cluster: cluster, RailsProxy: railsProxy}
  63         case !wantGoogle && !wantOpenIDConnect && !wantSSO && !wantPAM && wantLDAP:
  64                 return &ldapLoginController{Cluster: cluster, RailsProxy: railsProxy}
  65         default:
  66                 return errorLoginController{
  67                         error: errors.New("configuration problem: exactly one of Login.Google, Login.OpenIDConnect, Login.SSO, Login.PAM, and Login.LDAP must be enabled"),
  68                 }
  69         }
  70 }
  71
  72 // Login and Logout are passed through to the wrapped railsProxy;
  73 // UserAuthenticate is rejected.
  74 type ssoLoginController struct{ *railsProxy }
  75
  76 func (ctrl *ssoLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
  77         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
  78 }
  79
  80 type errorLoginController struct{ error }
  81
  82 func (ctrl errorLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
  83         return arvados.LoginResponse{}, ctrl.error
  84 }
  85 func (ctrl errorLoginController) Logout(context.Context, arvados.LogoutOptions) (arvados.LogoutResponse, error) {
  86         return arvados.LogoutResponse{}, ctrl.error
  87 }
  88 func (ctrl errorLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
  89         return arvados.APIClientAuthorization{}, ctrl.error
  90 }
  91
  92 func noopLogout(cluster *arvados.Cluster, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
  93         target := opts.ReturnTo
  94         if target == "" {
  95                 if cluster.Services.Workbench2.ExternalURL.Host != "" {
  96                         target = cluster.Services.Workbench2.ExternalURL.String()
  97                 } else {
  98                         target = cluster.Services.Workbench1.ExternalURL.String()
  99                 }
 100         }
 101         return arvados.LogoutResponse{RedirectLocation: target}, nil
 102 }
 103
 104 func createAPIClientAuthorization(ctx context.Context, conn *rpc.Conn, rootToken string, authinfo rpc.UserSessionAuthInfo) (resp arvados.APIClientAuthorization, err error) {
 105         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{rootToken}})
 106         newsession, err := conn.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
 107                 // Send a fake ReturnTo value instead of the caller's
 108                 // opts.ReturnTo. We won't follow the resulting
 109                 // redirect target anyway.
 110                 ReturnTo: ",https://none.invalid",
 111                 AuthInfo: authinfo,
 112         })
 113         if err != nil {
 114                 return
 115         }
 116         target, err := url.Parse(newsession.RedirectLocation)
 117         if err != nil {
 118                 return
 119         }
 120         token := target.Query().Get("api_token")
 121         tx, err := ctrlctx.CurrentTx(ctx)
 122         if err != nil {
 123                 return
 124         }
 125         tokensecret := token
 126         if strings.Contains(token, "/") {
 127                 tokenparts := strings.Split(token, "/")
 128                 if len(tokenparts) >= 3 {
 129                         tokensecret = tokenparts[2]
 130                 }
 131         }
 132         var exp sql.NullString
 133         var scopes []byte
 134         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)
 135         if err != nil {
 136                 return
 137         }
 138         resp.ExpiresAt = exp.String
 139         if len(scopes) > 0 {
 140                 err = json.Unmarshal(scopes, &resp.Scopes)
 141                 if err != nil {
 142                         return resp, fmt.Errorf("unmarshal scopes: %s", err)
 143                 }
 144         }
 145         return
 146 }