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         "errors"
  10         "net/http"
  11         "net/url"
  12
  13         "git.arvados.org/arvados.git/lib/controller/rpc"
  14         "git.arvados.org/arvados.git/sdk/go/arvados"
  15         "git.arvados.org/arvados.git/sdk/go/auth"
  16         "git.arvados.org/arvados.git/sdk/go/httpserver"
  17 )
  18
  19 type loginController interface {
  20         Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error)
  21         Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error)
  22         UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error)
  23 }
  24
  25 func chooseLoginController(cluster *arvados.Cluster, railsProxy *railsProxy) loginController {
  26         wantGoogle := cluster.Login.Google.Enable
  27         wantOpenIDConnect := cluster.Login.OpenIDConnect.Enable
  28         wantSSO := cluster.Login.SSO.Enable
  29         wantPAM := cluster.Login.PAM.Enable
  30         wantLDAP := cluster.Login.LDAP.Enable
  31         switch {
  32         case wantGoogle && !wantOpenIDConnect && !wantSSO && !wantPAM && !wantLDAP:
  33                 return &oidcLoginController{
  34                         Cluster:            cluster,
  35                         RailsProxy:         railsProxy,
  36                         Issuer:             "https://accounts.google.com",
  37                         ClientID:           cluster.Login.Google.ClientID,
  38                         ClientSecret:       cluster.Login.Google.ClientSecret,
  39                         UseGooglePeopleAPI: cluster.Login.Google.AlternateEmailAddresses,
  40                         EmailClaim:         "email",
  41                         EmailVerifiedClaim: "email_verified",
  42                 }
  43         case !wantGoogle && wantOpenIDConnect && !wantSSO && !wantPAM && !wantLDAP:
  44                 return &oidcLoginController{
  45                         Cluster:            cluster,
  46                         RailsProxy:         railsProxy,
  47                         Issuer:             cluster.Login.OpenIDConnect.Issuer,
  48                         ClientID:           cluster.Login.OpenIDConnect.ClientID,
  49                         ClientSecret:       cluster.Login.OpenIDConnect.ClientSecret,
  50                         EmailClaim:         cluster.Login.OpenIDConnect.EmailClaim,
  51                         EmailVerifiedClaim: cluster.Login.OpenIDConnect.EmailVerifiedClaim,
  52                 }
  53         case !wantGoogle && !wantOpenIDConnect && wantSSO && !wantPAM && !wantLDAP:
  54                 return &ssoLoginController{railsProxy}
  55         case !wantGoogle && !wantOpenIDConnect && !wantSSO && wantPAM && !wantLDAP:
  56                 return &pamLoginController{Cluster: cluster, RailsProxy: railsProxy}
  57         case !wantGoogle && !wantOpenIDConnect && !wantSSO && !wantPAM && wantLDAP:
  58                 return &ldapLoginController{Cluster: cluster, RailsProxy: railsProxy}
  59         default:
  60                 return errorLoginController{
  61                         error: errors.New("configuration problem: exactly one of Login.Google, Login.OpenIDConnect, Login.SSO, Login.PAM, and Login.LDAP must be enabled"),
  62                 }
  63         }
  64 }
  65
  66 // Login and Logout are passed through to the wrapped railsProxy;
  67 // UserAuthenticate is rejected.
  68 type ssoLoginController struct{ *railsProxy }
  69
  70 func (ctrl *ssoLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
  71         return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New("username/password authentication is not available"), http.StatusBadRequest)
  72 }
  73
  74 type errorLoginController struct{ error }
  75
  76 func (ctrl errorLoginController) Login(context.Context, arvados.LoginOptions) (arvados.LoginResponse, error) {
  77         return arvados.LoginResponse{}, ctrl.error
  78 }
  79 func (ctrl errorLoginController) Logout(context.Context, arvados.LogoutOptions) (arvados.LogoutResponse, error) {
  80         return arvados.LogoutResponse{}, ctrl.error
  81 }
  82 func (ctrl errorLoginController) UserAuthenticate(context.Context, arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
  83         return arvados.APIClientAuthorization{}, ctrl.error
  84 }
  85
  86 func noopLogout(cluster *arvados.Cluster, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
  87         target := opts.ReturnTo
  88         if target == "" {
  89                 if cluster.Services.Workbench2.ExternalURL.Host != "" {
  90                         target = cluster.Services.Workbench2.ExternalURL.String()
  91                 } else {
  92                         target = cluster.Services.Workbench1.ExternalURL.String()
  93                 }
  94         }
  95         return arvados.LogoutResponse{RedirectLocation: target}, nil
  96 }
  97
  98 func createAPIClientAuthorization(ctx context.Context, conn *rpc.Conn, rootToken string, authinfo rpc.UserSessionAuthInfo) (arvados.APIClientAuthorization, error) {
  99         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{rootToken}})
 100         resp, err := conn.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
 101                 // Send a fake ReturnTo value instead of the caller's
 102                 // opts.ReturnTo. We won't follow the resulting
 103                 // redirect target anyway.
 104                 ReturnTo: ",https://none.invalid",
 105                 AuthInfo: authinfo,
 106         })
 107         if err != nil {
 108                 return arvados.APIClientAuthorization{}, err
 109         }
 110         target, err := url.Parse(resp.RedirectLocation)
 111         if err != nil {
 112                 return arvados.APIClientAuthorization{}, err
 113         }
 114         token := target.Query().Get("api_token")
 115         return conn.APIClientAuthorizationCurrent(auth.NewContext(ctx, auth.NewCredentials(token)), arvados.GetOptions{})
 116 }