simple

Documentation

Index

• type AuthSimple
  • func New(cs *sessions.CookieStore) *AuthSimple
  • func (a AuthSimple) AuthenticatorID() string
  • func (a *AuthSimple) Configure(yamlSource []byte) error
  • func (a AuthSimple) DetectUser(res http.ResponseWriter, r *http.Request) (string, []string, error)
  • func (a AuthSimple) Login(res http.ResponseWriter, r *http.Request) (string, []plugins.MFAConfig, error)
  • func (a AuthSimple) LoginFields() (fields []plugins.LoginField)
  • func (a AuthSimple) Logout(res http.ResponseWriter, r *http.Request) (err error)
  • func (a AuthSimple) SupportsMFA() bool

Types

type AuthSimple

type AuthSimple struct {
	EnableBasicAuth bool                           `yaml:"enable_basic_auth"`
	Users           map[string]string              `yaml:"users"`
	Groups          map[string][]string            `yaml:"groups"`
	MFA             map[string][]plugins.MFAConfig `yaml:"mfa"`
	// contains filtered or unexported fields
}

func New

func New(cs *sessions.CookieStore) *AuthSimple

func (AuthSimple) AuthenticatorID

func (a AuthSimple) AuthenticatorID() string

AuthenticatorID needs to return an unique string to identify this special authenticator

func (*AuthSimple) Configure

func (a *AuthSimple) Configure(yamlSource []byte) error

Configure loads the configuration for the Authenticator from the global config.yaml file which is passed as a byte-slice. If no configuration for the Authenticator is supplied the function needs to return the plugins.ErrProviderUnconfigured

func (AuthSimple) DetectUser

func (a AuthSimple) DetectUser(res http.ResponseWriter, r *http.Request) (string, []string, error)

DetectUser is used to detect a user without a login form from a cookie, header or other methods If no user was detected the plugins.ErrNoValidUserFound needs to be returned

func (AuthSimple) Login

func (a AuthSimple) Login(res http.ResponseWriter, r *http.Request) (string, []plugins.MFAConfig, error)

Login is called when the user submits the login form and needs to authenticate the user or throw an error. If the user has successfully logged in the persistent cookie should be written in order to use DetectUser for the next login. If the user did not login correctly the plugins.ErrNoValidUserFound needs to be returned

func (AuthSimple) LoginFields

func (a AuthSimple) LoginFields() (fields []plugins.LoginField)

LoginFields needs to return the fields required for this login method. If no login using this method is possible the function needs to return nil.

func (AuthSimple) Logout

func (a AuthSimple) Logout(res http.ResponseWriter, r *http.Request) (err error)

Logout is called when the user visits the logout endpoint and needs to destroy any persistent stored cookies

func (AuthSimple) SupportsMFA

func (a AuthSimple) SupportsMFA() bool

SupportsMFA returns the MFA detection capabilities of the login provider. If the provider can provide mfaConfig objects from its configuration return true. If this is true the login interface will display an additional field for this provider for the user to fill in their MFA token.