auth

Documentation

Overview

Package auth provides application-level standardization for authentication

Index

• func HandleHTTP(h HTTPHandlerFunc, ss *session.Store) echo.HandlerFunc
• func HandleHTTPWithSession(h HTTPHandlerFuncWithSession, ss *session.Store) echo.HandlerFunc
• func HandleTS(h TSHandlerFunc, ss *session.Store) turbostreams.HandlerFunc
• func RegisterGobTypes()
• func RequireHTTPAuthz(ss *session.Store) echo.MiddlewareFunc
• func RequireTSAuthz(ss *session.Store) turbostreams.MiddlewareFunc
• func SetCSRFBehavior(s *sessions.Session, inlineToken bool)
• func SetIdentity(s *sessions.Session, username string)
• type Auth
  • func GetFromRequest(r *http.Request, s sessions.Session, ss *session.Store) (a Auth, err error)
  • func GetWithSession(r *http.Request, ss *session.Store, l godest.Logger) (a Auth, s *sessions.Session, err error)
  • func GetWithoutRequest(s sessions.Session, ss *session.Store) (a Auth, err error)
  • func (a Auth) Authorized() bool
  • func (a Auth) RequireHTTPAuthz() error
  • func (a Auth) RequireTSAuthz() error
• type CSRF
  • func (c *CSRF) SetInlining(r *http.Request, inlineToken bool)
• type CSRFBehavior
  • func GetCSRFBehavior(s sessions.Session) (behavior CSRFBehavior, err error)
• type HTTPHandlerFunc
• type HTTPHandlerFuncWithSession
• type HTTPRouter
  • func NewHTTPRouter(er godest.EchoRouter, ss *session.Store) HTTPRouter
  • func (r *HTTPRouter) CONNECT(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) DELETE(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) GET(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) HEAD(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) OPTIONS(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) PATCH(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) POST(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) PUT(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
  • func (r *HTTPRouter) TRACE(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
• type Identity
  • func GetIdentity(s sessions.Session) (identity Identity, err error)
• type TSHandlerFunc
• type TSRouter
  • func NewTSRouter(tsr turbostreams.Router, ss *session.Store) TSRouter
  • func (r *TSRouter) MSG(topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc) *turbostreams.Route
  • func (r *TSRouter) PUB(topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc) *turbostreams.Route
  • func (r *TSRouter) SUB(topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc) *turbostreams.Route

Functions

func HandleHTTP

func HandleHTTP(h HTTPHandlerFunc, ss *session.Store) echo.HandlerFunc

func HandleHTTPWithSession

func HandleHTTPWithSession(h HTTPHandlerFuncWithSession, ss *session.Store) echo.HandlerFunc

func HandleTS

func HandleTS(h TSHandlerFunc, ss *session.Store) turbostreams.HandlerFunc

func RegisterGobTypes

func RegisterGobTypes()

func RequireHTTPAuthz

func RequireHTTPAuthz(ss *session.Store) echo.MiddlewareFunc

func RequireTSAuthz

func RequireTSAuthz(ss *session.Store) turbostreams.MiddlewareFunc

func SetCSRFBehavior

func SetCSRFBehavior(s *sessions.Session, inlineToken bool)

func SetIdentity

func SetIdentity(s *sessions.Session, username string)

Types

type Auth

type Auth struct {
	Identity Identity
	CSRF     CSRF
}

func GetFromRequest

func GetFromRequest(r *http.Request, s sessions.Session, ss *session.Store) (a Auth, err error)

func GetWithSession

func GetWithSession(
	r *http.Request, ss *session.Store, l godest.Logger,
) (a Auth, s *sessions.Session, err error)

func GetWithoutRequest

func GetWithoutRequest(s sessions.Session, ss *session.Store) (a Auth, err error)

func (Auth) Authorized

func (a Auth) Authorized() bool

func (Auth) RequireHTTPAuthz

func (a Auth) RequireHTTPAuthz() error

func (Auth) RequireTSAuthz

func (a Auth) RequireTSAuthz() error

type CSRF

type CSRF struct {
	Config   session.CSRFOptions
	Behavior CSRFBehavior
	Token    string
}

func (*CSRF) SetInlining

func (c *CSRF) SetInlining(r *http.Request, inlineToken bool)

type CSRFBehavior

type CSRFBehavior struct {
	InlineToken bool
}

func GetCSRFBehavior

func GetCSRFBehavior(s sessions.Session) (behavior CSRFBehavior, err error)

type HTTPHandlerFunc

type HTTPHandlerFunc func(c echo.Context, a Auth) error

type HTTPHandlerFuncWithSession

type HTTPHandlerFuncWithSession func(c echo.Context, a Auth, sess *sessions.Session) error

type HTTPRouter

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

HTTPRouter is a routing adapter between echo.HandlerFunc and this package's HTTPHandlerFunc, by automatically extracting auth data from the session of the request.

func NewHTTPRouter

func NewHTTPRouter(er godest.EchoRouter, ss *session.Store) HTTPRouter

func (*HTTPRouter) CONNECT

func (r *HTTPRouter) CONNECT(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) DELETE

func (r *HTTPRouter) DELETE(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) GET

func (r *HTTPRouter) GET(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) HEAD

func (r *HTTPRouter) HEAD(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) OPTIONS

func (r *HTTPRouter) OPTIONS(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) PATCH

func (r *HTTPRouter) PATCH(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) POST

func (r *HTTPRouter) POST(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) PUT

func (r *HTTPRouter) PUT(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*HTTPRouter) TRACE

func (r *HTTPRouter) TRACE(path string, h HTTPHandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

type Identity

type Identity struct {
	Authenticated bool
	User          string
}

func GetIdentity

func GetIdentity(s sessions.Session) (identity Identity, err error)

type TSHandlerFunc

type TSHandlerFunc func(c *turbostreams.Context, a Auth) error

type TSRouter

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

TSRouter is a routing adapter between turbostreams.HandlerFunc and this package's TSHandlerFunc, by automatically extracting auth data from the session associated with the Action Cable connection underlying the Turbo Stream.

func NewTSRouter

func NewTSRouter(tsr turbostreams.Router, ss *session.Store) TSRouter

func (*TSRouter) MSG

func (r *TSRouter) MSG(
	topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc,
) *turbostreams.Route

func (*TSRouter) PUB

func (r *TSRouter) PUB(
	topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc,
) *turbostreams.Route

func (*TSRouter) SUB

func (r *TSRouter) SUB(
	topic string, h TSHandlerFunc, m ...turbostreams.MiddlewareFunc,
) *turbostreams.Route