middleware

Documentation

Index

• Constants
• Variables
• func Cors(opts ...cors.Option) func(http.Handler) http.Handler
• func ExtractAccountUUID(opts ...account.Option) func(http.Handler) http.Handler
• func Logger(logger log.Logger) func(http.Handler) http.Handler
• func NoCache(next http.Handler) http.Handler
• func Secure(next http.Handler) http.Handler
• func Static(root string, fs http.FileSystem, ttl int) func(http.Handler) http.Handler
• func Token(token string) func(http.Handler) http.Handler
• func TraceContext(next http.Handler) http.Handler
• func Version(name, version string) func(http.Handler) http.Handler

Constants

const AccountID string = "Account-Id"

AccountID serves as key for the account uuid in the context

const RoleIDs string = "Role-Ids"

RoleIDs serves as key for the roles in the context

Variables

var (
	// ErrInvalidToken is returned when the request token is invalid.
	ErrInvalidToken = errors.New("invalid or missing token")
)

Functions

func Cors

func Cors(opts ...cors.Option) func(http.Handler) http.Handler

Cors writes required cors headers to all requests.

func ExtractAccountUUID

func ExtractAccountUUID(opts ...account.Option) func(http.Handler) http.Handler

ExtractAccountUUID provides a middleware to extract the account uuid from the x-access-token header value and write it to the context. If there is no x-access-token the middleware is omitted.

func Logger

func Logger(logger log.Logger) func(http.Handler) http.Handler

Logger is a middleware to log http requests. It uses debug level logging and should be used by all services save the proxy (which uses info level logging).

func NoCache

func NoCache(next http.Handler) http.Handler

NoCache writes required cache headers to all requests.

func Secure

func Secure(next http.Handler) http.Handler

Secure writes required access headers to all requests.

func Static

func Static(root string, fs http.FileSystem, ttl int) func(http.Handler) http.Handler

Static is a middleware that serves static assets.

func Token

func Token(token string) func(http.Handler) http.Handler

Token provides a middleware to check access secured by a static token.

func TraceContext

func TraceContext(next http.Handler) http.Handler

TraceContext unpacks the request context looking for an existing trace id.

func Version

func Version(name, version string) func(http.Handler) http.Handler

Version writes the current version to the headers.