middleware

Documentation

Index

• type AccessControl
  • func NewAccessControl(audience, userIDClaim string, getUser GetUser) *AccessControl
  • func (a *AccessControl) Handler(h http.Handler) http.Handler
• type AuthMiddleware
  • func NewAuthMiddleware(getAccountFromPAT GetAccountFromPATFunc, ...) *AuthMiddleware
  • func (m *AuthMiddleware) CheckJWTFromRequest(w http.ResponseWriter, r *http.Request) error
  • func (m *AuthMiddleware) CheckPATFromRequest(w http.ResponseWriter, r *http.Request) error
  • func (m *AuthMiddleware) Handler(h http.Handler) http.Handler
• type GetAccountFromPATFunc
• type GetUser
• type MarkPATUsedFunc
• type ValidateAndParseTokenFunc

Types

type AccessControl

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

AccessControl middleware to restrict to make POST/PUT/DELETE requests by admin only

func NewAccessControl

func NewAccessControl(audience, userIDClaim string, getUser GetUser) *AccessControl

NewAccessControl instance constructor

func (*AccessControl) Handler

func (a *AccessControl) Handler(h http.Handler) http.Handler

Handler method of the middleware which forbids all modify requests for non admin users It also adds

type AuthMiddleware

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

AuthMiddleware middleware to verify personal access tokens (PAT) and JWT tokens

func NewAuthMiddleware

func NewAuthMiddleware(getAccountFromPAT GetAccountFromPATFunc, validateAndParseToken ValidateAndParseTokenFunc, markPATUsed MarkPATUsedFunc, audience string) *AuthMiddleware

NewAuthMiddleware instance constructor

func (*AuthMiddleware) CheckJWTFromRequest

func (m *AuthMiddleware) CheckJWTFromRequest(w http.ResponseWriter, r *http.Request) error

CheckJWTFromRequest checks if the JWT is valid

func (*AuthMiddleware) CheckPATFromRequest

func (m *AuthMiddleware) CheckPATFromRequest(w http.ResponseWriter, r *http.Request) error

CheckPATFromRequest checks if the PAT is valid

func (*AuthMiddleware) Handler

func (m *AuthMiddleware) Handler(h http.Handler) http.Handler

Handler method of the middleware which authenticates a user either by JWT claims or by PAT

type GetAccountFromPATFunc

type GetAccountFromPATFunc func(token string) (*server.Account, *server.User, *server.PersonalAccessToken, error)

GetAccountFromPATFunc function

type GetUser

type GetUser func(claims jwtclaims.AuthorizationClaims) (*server.User, error)

GetUser function defines a function to fetch user from Account by jwtclaims.AuthorizationClaims

type MarkPATUsedFunc

type MarkPATUsedFunc func(token string) error

MarkPATUsedFunc function

type ValidateAndParseTokenFunc

type ValidateAndParseTokenFunc func(token string) (*jwt.Token, error)

ValidateAndParseTokenFunc function