lib/controller/localdb/login_pam.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         "fmt"
  11         "net/http"
  12         "net/url"
  13         "strings"
  14
  15         "git.arvados.org/arvados.git/lib/controller/rpc"
  16         "git.arvados.org/arvados.git/sdk/go/arvados"
  17         "git.arvados.org/arvados.git/sdk/go/auth"
  18         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  19         "git.arvados.org/arvados.git/sdk/go/httpserver"
  20         "github.com/msteinert/pam"
  21         "github.com/sirupsen/logrus"
  22 )
  23
  24 type pamLoginController struct {
  25         Cluster    *arvados.Cluster
  26         RailsProxy *railsProxy
  27 }
  28
  29 func (ctrl *pamLoginController) Logout(ctx context.Context, opts arvados.LogoutOptions) (arvados.LogoutResponse, error) {
  30         return noopLogout(ctrl.Cluster, opts)
  31 }
  32
  33 func (ctrl *pamLoginController) Login(ctx context.Context, opts arvados.LoginOptions) (arvados.LoginResponse, error) {
  34         return arvados.LoginResponse{}, errors.New("interactive login is not available")
  35 }
  36
  37 func (ctrl *pamLoginController) UserAuthenticate(ctx context.Context, opts arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
  38         errorMessage := ""
  39         sentPassword := false
  40         tx, err := pam.StartFunc(ctrl.Cluster.Login.PAMService, opts.Username, func(style pam.Style, message string) (string, error) {
  41                 ctxlog.FromContext(ctx).Debugf("pam conversation: style=%v message=%q", style, message)
  42                 switch style {
  43                 case pam.ErrorMsg:
  44                         ctxlog.FromContext(ctx).WithField("Message", message).Info("pam.ErrorMsg")
  45                         errorMessage = message
  46                         return "", nil
  47                 case pam.TextInfo:
  48                         ctxlog.FromContext(ctx).WithField("Message", message).Info("pam.TextInfo")
  49                         return "", nil
  50                 case pam.PromptEchoOn, pam.PromptEchoOff:
  51                         sentPassword = true
  52                         return opts.Password, nil
  53                 default:
  54                         return "", fmt.Errorf("unrecognized message style %d", style)
  55                 }
  56         })
  57         if err != nil {
  58                 return arvados.APIClientAuthorization{}, err
  59         }
  60         err = tx.Authenticate(pam.DisallowNullAuthtok)
  61         if err != nil {
  62                 err = fmt.Errorf("PAM: %s", err)
  63                 if errorMessage != "" {
  64                         // Perhaps the error message in the
  65                         // conversation is helpful.
  66                         err = fmt.Errorf("%s; %q", err, errorMessage)
  67                 }
  68                 if sentPassword {
  69                         err = fmt.Errorf("%s (with username %q and password)", err, opts.Username)
  70                 } else {
  71                         // This might hint that the username was
  72                         // invalid.
  73                         err = fmt.Errorf("%s (with username %q; password was never requested by PAM service)", err, opts.Username)
  74                 }
  75                 return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(err, http.StatusUnauthorized)
  76         }
  77         if errorMessage != "" {
  78                 return arvados.APIClientAuthorization{}, httpserver.ErrorWithStatus(errors.New(errorMessage), http.StatusUnauthorized)
  79         }
  80         user, err := tx.GetItem(pam.User)
  81         if err != nil {
  82                 return arvados.APIClientAuthorization{}, err
  83         }
  84         email := user
  85         if domain := ctrl.Cluster.Login.PAMDefaultEmailDomain; domain != "" && !strings.Contains(email, "@") {
  86                 email = email + "@" + domain
  87         }
  88         ctxlog.FromContext(ctx).WithFields(logrus.Fields{"user": user, "email": email}).Debug("pam authentication succeeded")
  89         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{ctrl.Cluster.SystemRootToken}})
  90         resp, err := ctrl.RailsProxy.UserSessionCreate(ctxRoot, rpc.UserSessionCreateOptions{
  91                 // Send a fake ReturnTo value instead of the caller's
  92                 // opts.ReturnTo. We won't follow the resulting
  93                 // redirect target anyway.
  94                 ReturnTo: ",https://none.invalid",
  95                 AuthInfo: rpc.UserSessionAuthInfo{
  96                         Username: user,
  97                         Email:    email,
  98                 },
  99         })
 100         if err != nil {
 101                 return arvados.APIClientAuthorization{}, err
 102         }
 103         target, err := url.Parse(resp.RedirectLocation)
 104         if err != nil {
 105                 return arvados.APIClientAuthorization{}, err
 106         }
 107         token := target.Query().Get("api_token")
 108         return ctrl.RailsProxy.APIClientAuthorizationCurrent(auth.NewContext(ctx, auth.NewCredentials(token)), arvados.GetOptions{})
 109 }