auth

Documentation

Index

• type Config
• type HandlerWrapper
  • func NewHandlerWrapper(handler common.HTTPHandler, tm tokenManager) *HandlerWrapper
  • func (h *HandlerWrapper) Handler() common.HTTPRequestHandler
• type TokenDef
• type TokenManager
  • func NewTokenManager(cfg Config) (*TokenManager, error)
  • func (m *TokenManager) IsAuthRequired(endpoint, method string) (bool, error)
  • func (m *TokenManager) RequiredAuthTokens(endpoint, method string) ([]string, error)
• type TokenVerifier
  • func NewTokenVerifier(tm tokenManager, endpoint, method string) *TokenVerifier
  • func (h *TokenVerifier) Verify(req *http.Request) bool

Types

type Config

type Config struct {
	AuthTokensDef []*TokenDef
	AuthTokens    map[string]string
}

Config contains the authorization token configuration.

type HandlerWrapper

type HandlerWrapper struct {
	common.HTTPHandler
	// contains filtered or unexported fields
}

HandlerWrapper wraps an existing HTTP handler and performs bearer token authorization. If authorized then the wrapped handler is invoked.

func NewHandlerWrapper

func NewHandlerWrapper(handler common.HTTPHandler, tm tokenManager) *HandlerWrapper

NewHandlerWrapper returns a handler that first performs bearer token authorization and, if authorized, invokes the wrapped handler.

func (*HandlerWrapper) Handler

func (h *HandlerWrapper) Handler() common.HTTPRequestHandler

Handler returns the 'wrapper' handler.

type TokenDef

type TokenDef struct {
	EndpointExpression string
	ReadTokens         []string
	WriteTokens        []string
}

TokenDef contains authorization bearer token definitions.

type TokenManager

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

TokenManager manages the authorization tokens for both the client and server.

func NewTokenManager

func NewTokenManager(cfg Config) (*TokenManager, error)

NewTokenManager returns a token mapper that performs bearer token authorization.

func (*TokenManager) IsAuthRequired

func (m *TokenManager) IsAuthRequired(endpoint, method string) (bool, error)

IsAuthRequired return true if authorization is required for the given endpoint/method.

func (*TokenManager) RequiredAuthTokens

func (m *TokenManager) RequiredAuthTokens(endpoint, method string) ([]string, error)

RequiredAuthTokens returns the authorization tokens required for the given endpoint and method.

type TokenVerifier

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

TokenVerifier authorizes requests with bearer tokens.

func NewTokenVerifier

func NewTokenVerifier(tm tokenManager, endpoint, method string) *TokenVerifier

NewTokenVerifier returns a verifier that performs bearer token authorization.

func (*TokenVerifier) Verify

func (h *TokenVerifier) Verify(req *http.Request) bool

Verify verifies that the request has the required bearer token. If not, false is returned.