middleware

Documentation

Index

• func APIKeyAuthMiddleware(validator func(apiKey string) bool, apiKeys ...string) func(handler http.Handler) http.Handler
• func BasicAuthMiddleware(basicAuthProvider BasicAuthProvider) func(handler http.Handler) http.Handler
• func CORS() func(inner http.Handler) http.Handler
• func Logging(logger logger) func(inner http.Handler) http.Handler
• func Metrics(metrics metrics) func(inner http.Handler) http.Handler
• func OAuth(key PublicKeyProvider) func(inner http.Handler) http.Handler
• func Tracer(inner http.Handler) http.Handler
• type BasicAuthProvider
• type JSONWebKey
• type JWKNotFound
  • func (i JWKNotFound) Error() string
• type JWKS
• type JWKSProvider
• type JWTClaim
• type OauthConfigs
• type PublicKeyProvider
  • func NewOAuth(config OauthConfigs) PublicKeyProvider
• type PublicKeys
  • func (p *PublicKeys) Get(kid string) *rsa.PublicKey
• type RequestLog
• type StatusResponseWriter
  • func (w *StatusResponseWriter) WriteHeader(status int)

Functions

func APIKeyAuthMiddleware

func APIKeyAuthMiddleware(validator func(apiKey string) bool, apiKeys ...string) func(handler http.Handler) http.Handler

func BasicAuthMiddleware

func BasicAuthMiddleware(basicAuthProvider BasicAuthProvider) func(handler http.Handler) http.Handler

func CORS

func CORS() func(inner http.Handler) http.Handler

func Logging

func Logging(logger logger) func(inner http.Handler) http.Handler

Logging is a middleware which logs response status and time in microseconds along with other data.

func Metrics

func Metrics(metrics metrics) func(inner http.Handler) http.Handler

func OAuth

func OAuth(key PublicKeyProvider) func(inner http.Handler) http.Handler

func Tracer

func Tracer(inner http.Handler) http.Handler

Types

type BasicAuthProvider

type BasicAuthProvider struct {
	Users        map[string]string
	ValidateFunc func(username, password string) bool
}

type JSONWebKey

type JSONWebKey struct {
	ID   string `json:"kid"`
	Type string `json:"kty"`

	Modulus         string `json:"n"`
	PublicExponent  string `json:"e"`
	PrivateExponent string `json:"d"`
}

type JWKNotFound

type JWKNotFound struct {
}

func (JWKNotFound) Error

func (i JWKNotFound) Error() string

type JWKS

type JWKS struct {
	Keys []JSONWebKey `json:"keys"`
}

JWKS represents a JSON Web Key Set.

type JWKSProvider

type JWKSProvider interface {
	GetWithHeaders(ctx context.Context, path string, queryParams map[string]interface{},
		headers map[string]string) (*http.Response, error)
}

type JWTClaim

type JWTClaim string

type OauthConfigs

type OauthConfigs struct {
	Provider        JWKSProvider
	RefreshInterval time.Duration
}

type PublicKeyProvider

type PublicKeyProvider interface {
	Get(kid string) *rsa.PublicKey
}

func NewOAuth

func NewOAuth(config OauthConfigs) PublicKeyProvider

type PublicKeys

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

func (*PublicKeys) Get

func (p *PublicKeys) Get(kid string) *rsa.PublicKey

type RequestLog

type RequestLog struct {
	TraceID      string `json:"trace_id,omitempty"`
	SpanID       string `json:"span_id,omitempty"`
	StartTime    string `json:"start_time,omitempty"`
	ResponseTime int64  `json:"response_time,omitempty"`
	Method       string `json:"method,omitempty"`
	UserAgent    string `json:"user_agent,omitempty"`
	IP           string `json:"ip,omitempty"`
	URI          string `json:"uri,omitempty"`
	Response     int    `json:"response,omitempty"`
}

type StatusResponseWriter

type StatusResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

StatusResponseWriter Defines own Response Writer to be used for logging of status - as http.ResponseWriter does not let us read status.

func (*StatusResponseWriter) WriteHeader

func (w *StatusResponseWriter) WriteHeader(status int)