middleware

README

Middleware Package

The official documentation of the Middleware package will be here.

Documentation

Index

• Constants
• func NewContextGetter() *contextGetter
• func NewMiddleware(config ConfigMiddleware, jwtAccess jwt.Jwt, dataAccess secretdata.SecretData) *middleware
• type ConfigMiddleware
• type ContextGetter
• type Middleware
• type MockDescription
  • func (s *MockDescription) GetJwtData(_ context.Context) ([]byte, error)
  • func (s *MockDescription) GetJwtID(_ context.Context) (string, error)
  • func (s *MockDescription) GetRemoteAddr(_ context.Context) (string, string, error)
  • func (s *MockDescription) GetRequestID(_ context.Context) (string, string, error)

Constants

const (
	ContextKeyRemoteAddr = "remoteAddr"
	ContextKeyRequestID  = "requestID"
	ContextKeyJwtID      = "jwtID"
	ContextKeyJwtData    = "jwtData"
)

Functions

func NewContextGetter

func NewContextGetter() *contextGetter

func NewMiddleware

func NewMiddleware(
	config ConfigMiddleware,
	jwtAccess jwt.Jwt,
	dataAccess secretdata.SecretData) *middleware

Types

type ConfigMiddleware

type ConfigMiddleware struct {
	RequestIDRequired bool
	RequestIDCheck    bool
}

type ContextGetter

type ContextGetter interface {
	GetRemoteAddr(ctx context.Context) (string, string, error)
	GetRequestID(ctx context.Context) (string, string, error)
	GetJwtID(ctx context.Context) (string, error)
	GetJwtData(ctx context.Context) ([]byte, error)
}

type Middleware

type Middleware interface {
	RequestID(logger *zap.Logger) func(http.Handler) http.Handler
	RemoteAddr(logger *zap.Logger) func(http.Handler) http.Handler
	Logging(logger *zap.Logger) func(http.Handler) http.Handler
	Authorization(logger *zap.Logger) func(http.Handler) http.Handler
}

type MockDescription

type MockDescription struct {
	Props    struct{}
	Expected struct {
		Error error
	}
}

var MockData MockDescription

func (*MockDescription) GetJwtData

func (s *MockDescription) GetJwtData(_ context.Context) ([]byte, error)

func (*MockDescription) GetJwtID

func (s *MockDescription) GetJwtID(_ context.Context) (string, error)

func (*MockDescription) GetRemoteAddr

func (s *MockDescription) GetRemoteAddr(_ context.Context) (string, string, error)

func (*MockDescription) GetRequestID

func (s *MockDescription) GetRequestID(_ context.Context) (string, string, error)