mid

Documentation

Index

• func Denylist(options *DenylistOptions) web.Middleware
• func Errors(logger *logrus.Logger) web.Middleware
• func IPAllowlist(options *IPAllowListOptions) web.Middleware
• func Logger(logger *logrus.Logger) web.Middleware
• func MIMETypeIdentifier(logger *logrus.Logger) web.Middleware
• func Panics(logger *logrus.Logger) web.Middleware
• func Proxy(options *ProxyOptions) web.Middleware
• func ShadowAPIMonitor(logger *logrus.Logger, cfg *config.ShadowAPI) web.Middleware
• type DenylistOptions
• type IPAllowListOptions
• type ProxyOptions

Functions

func Denylist

func Denylist(options *DenylistOptions) web.Middleware

Denylist forbidden requests with tokens in the blacklist

func Errors

func Errors(logger *logrus.Logger) web.Middleware

Errors handles errors coming out of the call chain. It detects normal application errors which are used to respond to the client in a uniform way. Unexpected errors (status >= 500) are logged.

func IPAllowlist

func IPAllowlist(options *IPAllowListOptions) web.Middleware

This function checks if an IP is allowed else gives error.

func Logger

func Logger(logger *logrus.Logger) web.Middleware

Logger writes some information about the request to the logs in the format: TraceID : (200) GET /foo -> IP ADDR (latency)

func MIMETypeIdentifier

func MIMETypeIdentifier(logger *logrus.Logger) web.Middleware

MIMETypeIdentifier identifies the MIME type of the content in case of CT header is missing

func Panics

func Panics(logger *logrus.Logger) web.Middleware

Panics recovers from panics and converts the panic to an error so it is reported in Metrics and handled in Errors.

func Proxy

func Proxy(options *ProxyOptions) web.Middleware

Proxy changes request scheme before request

func ShadowAPIMonitor

func ShadowAPIMonitor(logger *logrus.Logger, cfg *config.ShadowAPI) web.Middleware

ShadowAPIMonitor check each request for the params, methods or paths that are not specified in the OpenAPI specification and log each violation

Types

type DenylistOptions

type DenylistOptions struct {
	Mode                  string
	Config                *config.Denylist
	CustomBlockStatusCode int
	DeniedTokens          *denylist.DeniedTokens
	Logger                *logrus.Logger
}

type IPAllowListOptions

type IPAllowListOptions struct {
	Mode                  string
	Config                *config.AllowIP
	CustomBlockStatusCode int
	AllowedIPs            *allowiplist.AllowedIPsType
	Logger                *logrus.Logger
}

type ProxyOptions

type ProxyOptions struct {
	Mode                 string
	RequestValidation    string
	DeleteAcceptEncoding bool
	ServerURL            *url.URL
}