middleware

Documentation

Overview

Package middleware provides a standard set of middleware for pomerium.

Index

• func CorsBypass(target http.Handler) func(next http.Handler) http.Handler
• func Healthcheck(endpoint, msg string) func(http.Handler) http.Handler
• func SetHeaders(headers map[string]string) func(next http.Handler) http.Handler
• func StripCookie(cookieName string) func(next http.Handler) http.Handler
• func TimeoutHandlerFunc(timeout time.Duration, timeoutError string) func(next http.Handler) http.Handler
• func ValidateRequestURL(r *http.Request, key string) error
• func ValidateSignature(sharedSecret string) func(next http.Handler) http.Handler

Functions

func CorsBypass

func CorsBypass(target http.Handler) func(next http.Handler) http.Handler

CorsBypass is middleware that takes a target handler as a paramater, if the request is determined to be a CORS preflight request, that handler is called instead of the normal handler chain.

func Healthcheck

func Healthcheck(endpoint, msg string) func(http.Handler) http.Handler

Healthcheck endpoint middleware useful to setting up a path like `/ping` that load balancers or uptime testing external services can make a request before hitting any routes. It's also convenient to place this above ACL middlewares as well.

https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html

func SetHeaders

func SetHeaders(headers map[string]string) func(next http.Handler) http.Handler

SetHeaders sets a map of response headers.

func StripCookie

func StripCookie(cookieName string) func(next http.Handler) http.Handler

StripCookie strips the cookie from the downstram request.

func TimeoutHandlerFunc

func TimeoutHandlerFunc(timeout time.Duration, timeoutError string) func(next http.Handler) http.Handler

TimeoutHandlerFunc wraps http.TimeoutHandler

func ValidateRequestURL

func ValidateRequestURL(r *http.Request, key string) error

ValidateRequestURL validates the current absolute request URL was signed by a given shared key.

func ValidateSignature

func ValidateSignature(sharedSecret string) func(next http.Handler) http.Handler

ValidateSignature ensures the request is valid and has been signed with the correspdoning client secret key