middleware

Documentation

Overview

Package middleware provides several standard middleware implementations.

Index

• Constants
• func AutomaticOptions(c *web.C, h http.Handler) http.Handler
• func EnvInit(c *web.C, h http.Handler) http.Handler
• func GetReqID(c web.C) string
• func Logger(c *web.C, h http.Handler) http.Handler
• func NoCache(h http.Handler) http.Handler
• func RealIP(c *web.C, h http.Handler) http.Handler
• func Recoverer(c *web.C, h http.Handler) http.Handler
• func RequestID(c *web.C, h http.Handler) http.Handler
• func SubRouter(c *web.C, h http.Handler) http.Handler

Constants

const OriginalRemoteAddrKey = "originalRemoteAddr"

Key the original value of RemoteAddr is stored under.

const RequestIDKey = "reqID"

Key to use when setting the request ID.

Functions

func AutomaticOptions

func AutomaticOptions(c *web.C, h http.Handler) http.Handler

AutomaticOptions automatically return an appropriate "Allow" header when the request method is OPTIONS and the request would have otherwise been 404'd.

func EnvInit

func EnvInit(c *web.C, h http.Handler) http.Handler

EnvInit is a middleware that allocates an environment map if one does not already exist. This is necessary because Goji does not guarantee that Env is present when running middleware (it avoids forcing the map allocation). Note that other middleware should check Env for nil in order to maximize compatibility (when EnvInit is not used, or when another middleware layer blanks out Env), but for situations in which the user controls the middleware stack and knows EnvInit is present, this middleware can eliminate a lot of boilerplate.

func GetReqID

func GetReqID(c web.C) string

GetReqID returns a request ID from the given context if one is present. Returns the empty string if a request ID cannot be found.

func Logger

func Logger(c *web.C, h http.Handler) http.Handler

Logger is a middleware that logs the start and end of each request, along with some useful data about what was requested, what the response status was, and how long it took to return. When standard output is a TTY, Logger will print in color, otherwise it will print in black and white.

Logger prints a request ID if one is provided.

Logger has been designed explicitly to be Good Enough for use in small applications and for people just getting started with Goji. It is expected that applications will eventually outgrow this middleware and replace it with a custom request logger, such as one that produces machine-parseable output, outputs logs to a different service (e.g., syslog), or formats lines like those printed elsewhere in the application.

func NoCache

func NoCache(h http.Handler) http.Handler

NoCache is a simple piece of middleware that sets a number of HTTP headers to prevent a router (or subrouter) from being cached by an upstream proxy and/or client.

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 RealIP

func RealIP(c *web.C, h http.Handler) http.Handler

RealIP is a middleware that sets a http.Request's RemoteAddr to the results of parsing either the X-Forwarded-For header or the X-Real-IP header (in that order). It places the original value of RemoteAddr in a context environment variable.

This middleware should be inserted fairly early in the middleware stack to ensure that subsequent layers (e.g., request loggers) which examine the RemoteAddr will see the intended value.

You should only use this middleware if you can trust the headers passed to you (in particular, the two headers this middleware uses), for example because you have placed a reverse proxy like HAProxy or nginx in front of Goji. If your reverse proxies are configured to pass along arbitrary header values from the client, or if you use this middleware without a reverse proxy, malicious clients will be able to make you very sad (or, depending on how you're using RemoteAddr, vulnerable to an attack of some sort).

func Recoverer

func Recoverer(c *web.C, h http.Handler) http.Handler

Recoverer is a middleware that recovers from panics, logs the panic (and a backtrace), and returns a HTTP 500 (Internal Server Error) status if possible.

Recoverer prints a request ID if one is provided.

func RequestID

func RequestID(c *web.C, h http.Handler) http.Handler

RequestID is a middleware that injects a request ID into the context of each request. A request ID is a string of the form "host.example.com/random-0001", where "random" is a base62 random string that uniquely identifies this go process, and where the last number is an atomically incremented request counter.

func SubRouter

func SubRouter(c *web.C, h http.Handler) http.Handler

SubRouter is a helper middleware that makes writing sub-routers easier.

If you register a sub-router under a key like "/admin/*", Goji's router will automatically set c.URLParams["*"] to the unmatched path suffix. This middleware will help you set the request URL's Path to this unmatched suffix, allowing you to write sub-routers with no knowledge of what routes the parent router matches.