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