middleware

Documentation

Index

• Variables
• func Authentication() dojo.MiddlewareFunc
• func AuthenticationWithConfig(config AuthenticationConfig) dojo.MiddlewareFunc
• func CSRF() dojo.MiddlewareFunc
• func CSRFWithConfig(config CSRFConfig) dojo.MiddlewareFunc
• func DefaultErrorReporter(ctx dojo.Context, err error) error
• func DefaultSkipper(ctx dojo.Context) bool
• func Guest() dojo.MiddlewareFunc
• func GuestWithConfig(config GuestConfig) dojo.MiddlewareFunc
• func HttpError() dojo.MiddlewareFunc
• func HttpErrorWithConfig(config HttpErrorConfig) dojo.MiddlewareFunc
• type AuthenticationConfig
• type BeforeFunc
• type CSRFConfig
• type ErrorReporter
• type ErrorResponder
• type GuestConfig
• type HttpErrorConfig
• type Skipper

Variables

var (
	DefaultAuthenticationConfig = AuthenticationConfig{
		Skipper:      DefaultSkipper,
		RedirectPath: "/login",
	}
)

var (
	DefaultCSRFConfig = CSRFConfig{
		Skipper:      DefaultSkipper,
		TokenLength:  32,
		TokenLookup:  "header:" + dojo.HeaderXCSRFToken,
		ContextKey:   "csrf",
		CookieName:   "_csrf",
		CookieMaxAge: 86400,
	}
)

var (
	DefaultGuestConfig = GuestConfig{
		Skipper:      DefaultSkipper,
		RedirectPath: "/",
	}
)

var (
	HttpErrorDefaultConfig = HttpErrorConfig{
		Reporter: DefaultErrorReporter,
	}
)

Functions

func Authentication

func Authentication() dojo.MiddlewareFunc

func AuthenticationWithConfig

func AuthenticationWithConfig(config AuthenticationConfig) dojo.MiddlewareFunc

func CSRF

func CSRF() dojo.MiddlewareFunc

func CSRFWithConfig

func CSRFWithConfig(config CSRFConfig) dojo.MiddlewareFunc

func DefaultErrorReporter

func DefaultErrorReporter(ctx dojo.Context, err error) error

func DefaultSkipper

func DefaultSkipper(ctx dojo.Context) bool

func Guest

func Guest() dojo.MiddlewareFunc

func GuestWithConfig

func GuestWithConfig(config GuestConfig) dojo.MiddlewareFunc

func HttpError

func HttpError() dojo.MiddlewareFunc

func HttpErrorWithConfig

func HttpErrorWithConfig(config HttpErrorConfig) dojo.MiddlewareFunc

Types

type AuthenticationConfig

type AuthenticationConfig struct {
	Skipper      Skipper
	BeforeFunc   BeforeFunc
	RedirectPath string
}

type BeforeFunc

type BeforeFunc func(ctx dojo.Context)

type CSRFConfig

type CSRFConfig struct {
	Skipper Skipper

	TokenLength uint8 `yaml:"token_length"`

	TokenLookup string `yaml:"token_lookup"`

	ContextKey string `yaml:"context_key"`

	CookieName string `yaml:"cookie_name"`

	CookieMaxAge int `yaml:"cookie_max_age"`
}

type ErrorReporter

type ErrorReporter func(ctx dojo.Context, err error) error

type ErrorResponder

type ErrorResponder interface {
	RespondError(ctx dojo.Context, application *dojo.Application) bool
}

type GuestConfig

type GuestConfig struct {
	Skipper      Skipper
	BeforeFunc   BeforeFunc
	RedirectPath string
}

type HttpErrorConfig

type HttpErrorConfig struct {
	Reporter ErrorReporter
}

type Skipper

type Skipper func(ctx dojo.Context) bool