middleware

README

echo-middleware

This project provides a collection of echo middleware used in API / Web projects.

License

This code was authored by Mark Wolfe and licensed under the Apache 2.0 license.

Documentation

Index

• Constants
• func NoCache() echo.MiddlewareFunc
• func NoCacheWithConfig(config NoCacheConfig) echo.MiddlewareFunc
• func OriginVerifierWithConfig(config OriginVerifierConfig) echo.MiddlewareFunc
• func ZeroLogRequestLog() echo.MiddlewareFunc
• func ZeroLogRequestLogWithConfig(config ZeroLogRequestLogConfig) echo.MiddlewareFunc
• func ZeroLogWithConfig(cfg ZeroLogConfig) echo.MiddlewareFunc
• type NoCacheConfig
• type OriginVerifierConfig
• type ZeroLogConfig
• type ZeroLogRequestLogConfig

Constants

const OriginVerifyHeaderName = "X-Origin-Verify"

Functions

func NoCache

func NoCache() echo.MiddlewareFunc

NoCache returns a middleware which sets the no cache headers with default configuration.

func NoCacheWithConfig

func NoCacheWithConfig(config NoCacheConfig) echo.MiddlewareFunc

NoCacheWithConfig returns a middleware which sets a number of http headers to ensure the resource is not cached.

As per http://wiki.nginx.org/HttpProxyModule - NoCache sets:

Expires: Thu, 01 Jan 1970 00:00:00 UTC
Cache-Control: no-cache, private, max-age=0
X-Accel-Expires: 0
Pragma: no-cache (for HTTP/1.0 proxies/clients)

func OriginVerifierWithConfig

func OriginVerifierWithConfig(config OriginVerifierConfig) echo.MiddlewareFunc

OriginVerifierWithConfig returns a middleware which verifies requests include a `X-Origin-Verify` header containing the token configured, requests which fail will be rejected with a 400 bad request status code.

This solution is based on a pattern presented in https://aws.amazon.com/blogs/networking-and-content-delivery/restricting-access-http-api-gateway-lambda-authorizer/ and uses the same header name.

func ZeroLogRequestLog

func ZeroLogRequestLog() echo.MiddlewareFunc

ZeroLogRequestLog returns a request logger middleware with default config.

func ZeroLogRequestLogWithConfig

func ZeroLogRequestLogWithConfig(config ZeroLogRequestLogConfig) echo.MiddlewareFunc

ZeroLogRequestLogWithConfig returns a request logger middleware with config.

func ZeroLogWithConfig

func ZeroLogWithConfig(cfg ZeroLogConfig) echo.MiddlewareFunc

ZeroLogWithConfig setup and return an echo middleware with zerolog logger available from the context.Context.

Types

type NoCacheConfig

type NoCacheConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper
}

NoCacheConfig used to configure the no cache middleware.

type OriginVerifierConfig

type OriginVerifierConfig struct {
	// Token used to validate requests coming include the required header
	Token string

	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper
}

OriginVerifierConfig used to configure the origin authentication middleware.

type ZeroLogConfig

type ZeroLogConfig struct {
	Caller bool
	Level  zerolog.Level
	Output io.Writer
	Logger zerolog.Logger
	Fields map[string]interface{}
}

ZeroLogConfig used to configure the zerolog echo middleware.

type ZeroLogRequestLogConfig

type ZeroLogRequestLogConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper
}

ZeroLogRequestLogConfig defines the config for the request logger middleware.