login

Documentation

Index

• Constants
• Variables
• func NewLoginFormRenderer(customLoginTemplateFile string) (*loginTemplateRenderer, error)
• func ValidateLoginTemplate(templateContent []byte) []error
• type Confirm
  • func NewConfirm(csrf csrf.CSRF, auth RequestAuthenticator, render ConfirmFormRenderer) *Confirm
  • func (c *Confirm) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type ConfirmForm
• type ConfirmFormRenderer
• type ConfirmFormValues
• type Login
  • func NewLogin(csrf csrf.CSRF, auth PasswordAuthenticator, render LoginFormRenderer) *Login
  • func (l *Login) Install(mux Mux, paths ...string)
  • func (l *Login) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type LoginForm
• type LoginFormFields
• type LoginFormRenderer
• type Mux
• type PasswordAuthenticator
• type RequestAuthenticator

Constants

const LoginTemplateExample = `` /* 1528-byte string literal not displayed */

LoginTemplateExample is a basic template for customizing the login page.

Variables

var DefaultConfirmFormRenderer = confirmTemplateRenderer{}

Functions

func NewLoginFormRenderer

func NewLoginFormRenderer(customLoginTemplateFile string) (*loginTemplateRenderer, error)

NewLoginFormRenderer creates a login form renderer that takes in an optional custom template to allow branding of the login page. Uses the default if customLoginTemplateFile is not set.

func ValidateLoginTemplate

func ValidateLoginTemplate(templateContent []byte) []error

Types

type Confirm

type Confirm struct {
	// contains filtered or unexported fields
}

func NewConfirm

func NewConfirm(csrf csrf.CSRF, auth RequestAuthenticator, render ConfirmFormRenderer) *Confirm

func (*Confirm) ServeHTTP

func (c *Confirm) ServeHTTP(w http.ResponseWriter, req *http.Request)

type ConfirmForm

type ConfirmForm struct {
	Action string
	Error  string
	User   user.Info
	Values ConfirmFormValues
}

type ConfirmFormRenderer

type ConfirmFormRenderer interface {
	Render(form ConfirmForm, w http.ResponseWriter, req *http.Request)
}

type ConfirmFormValues

type ConfirmFormValues struct {
	Then string
	CSRF string
}

type Login

type Login struct {
	// contains filtered or unexported fields
}

func NewLogin

func NewLogin(csrf csrf.CSRF, auth PasswordAuthenticator, render LoginFormRenderer) *Login

func (*Login) Install

func (l *Login) Install(mux Mux, paths ...string)

Install registers the login handler into a mux. It is expected that the provided prefix will serve all operations. Path MUST NOT end in a slash.

func (*Login) ServeHTTP

func (l *Login) ServeHTTP(w http.ResponseWriter, req *http.Request)

type LoginForm

type LoginForm struct {
	Action string
	Error  string
	Names  LoginFormFields
	Values LoginFormFields
}

type LoginFormFields

type LoginFormFields struct {
	Then     string
	CSRF     string
	Username string
	Password string
}

type LoginFormRenderer

type LoginFormRenderer interface {
	Render(form LoginForm, w http.ResponseWriter, req *http.Request)
}

type Mux

type Mux interface {
	Handle(pattern string, handler http.Handler)
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
}

Mux is an object that can register http handlers.

type PasswordAuthenticator

type PasswordAuthenticator interface {
	authenticator.Password
	handlers.AuthenticationSuccessHandler
}

type RequestAuthenticator

type RequestAuthenticator interface {
	authenticator.Request
	handlers.AuthenticationSuccessHandler
}