tokenauth

Documentation

Index

• func WithHeader(header string) option
• func WithPrefix(prefix string) option
• func WithTokenSource(ts TokenSource) option
• type Module
  • func (m *Module) Authenticate(rw http.ResponseWriter, req *http.Request) (bool, *string, error)
  • func (m *Module) Configure(opts ...option)
  • func (m *Module) Init(c *service.Config)
  • func (m *Module) Logout(rw http.ResponseWriter, req *http.Request)
• type TokenSource

Functions

func WithHeader

func WithHeader(header string) option

WithHeader sets the http header to use. Defaults to 'Authorization'. Optional.

func WithPrefix

func WithPrefix(prefix string) option

WithPrefix sets the prefix to check for in the header. Defaults to 'Token'. Optional.

func WithTokenSource

func WithTokenSource(ts TokenSource) option

WithTokenSource sets the backing token source. Required.

Types

type Module

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

func (*Module) Authenticate

func (m *Module) Authenticate(rw http.ResponseWriter, req *http.Request) (bool, *string, error)

func (*Module) Configure

func (m *Module) Configure(opts ...option)

func (*Module) Init

func (m *Module) Init(c *service.Config)

func (*Module) Logout

func (m *Module) Logout(rw http.ResponseWriter, req *http.Request)

type TokenSource

type TokenSource interface {
	Get(token string) *string
}