Ring-Defaults

Knowing what middleware to add to a Ring application, and in what order, can be difficult and prone to error.

This library attempts to automate the process, by providing sensible and secure default configurations of Ring middleware for both websites and HTTP APIs.

Installation

Add the following dependency to your deps.edn file:

ring/ring-defaults {:mvn/version "0.5.0"}

Or to your Leiningen project file:

[ring/ring-defaults "0.5.0"]

Basic Usage

The wrap-defaults middleware sets up standard Ring middleware based on a supplied configuration:

(require '[ring.middleware.defaults :refer :all])

(def site
  (wrap-defaults handler site-defaults))

There are four configurations included with the middleware

• api-defaults
• site-defaults
• secure-api-defaults
• secure-site-defaults

The "api" defaults will add support for urlencoded parameters, but not much else.

The "site" defaults add support for parameters, cookies, sessions, static resources, file uploads, and a bunch of browser-specific security headers.

The "secure" defaults force SSL. Unencrypted HTTP URLs are redirected to the equivalent HTTPS URL, and various headers and flags are sent to prevent the browser sending sensitive information over insecure channels.

Proxies

If your app is sitting behind a load balancer or reverse proxy, as is often the case in cloud-based deployments, you'll want to set :proxy to true:

(assoc secure-site-defaults :proxy true)

This is particularly important when your site is secured with SSL, as the SSL redirect middleware will get caught in a redirect loop if it can't determine the correct URL scheme of the request.

Customizing

The default configurations are just maps of options, and can be customized to suit your needs. For example, if you wanted the normal site defaults, but without session support, you could use:

(wrap-defaults handler (assoc site-defaults :session false))

The following configuration keys are supported:

• :cookies - Set to true to parse cookies from the request.

• :params - A map of options that describes how to parse parameters from the request.

  • :keywordize - Set to true to turn the parameter keys into keywords.

  • :multipart - Set to true to parse urlencoded parameters in the query string and the request body, or supply a map of options to pass to the standard Ring multipart-params middleware.

  • :nested - Set to true to allow nested parameters via the standard Ring nested-params middleware

  • :urlencoded - Set to true to parse urlencoded parameters in the query string and the request body.

• :proxy - Set to true if the application is running behind a reverse proxy or load balancer.

• :responses - A map of options to augment the responses from your application.

  • :absolute-redirects - Any redirects to relative URLs will be turned into redirects to absolute URLs, to better conform to the HTTP spec.

  • :content-types - Adds the standard Ring content-type middleware.

  • :default-charset - Adds a default charset to any text content-type lacking a charset.

  • :not-modified-responses - Adds the standard Ring not-modified middleware.

• :security - Options for security related behaviors and headers.

  • :anti-forgery - Set to true to add CSRF protection via the ring-anti-forgery library.

  • :content-type-options - Prevents attacks based around media-type confusion. See: wrap-content-type-options.

  • :frame-options - Prevents your site from being placed in frames or iframes. See: wrap-frame-options.

  • :hsts - If true, enable HTTP Strict Transport Security. See: wrap-hsts.

  • :ssl-redirect - If true, redirect all HTTP requests to the equivalent HTTPS URL. A map with an :ssl-port option may be set instead, if the HTTPS server is on a non-standard port. See: wrap-ssl-redirect.

  • :xss-protection - Deprecated Enable the X-XSS-Protection header. This is no longer considered best practice and should be avoided. See: wrap-xss-protection.

• :session - A map of options for configuring session handling via the Ring session middleware.

  • :flash - If set to true, the Ring flash middleware is added.

  • :store - The Ring session store to use for storing sessions.

• :static A map of options to configure how to find static content.

  • :files - A string or a map of options to be passed to the file middleware, where the :root key is passed as the first argument, and the rest of the map is passed as options. May also be a collection of the above. Usually the :resources option below is more useful.

  • :resources - A string or a map of options to be passed to the resource middleware, where the :root key is passed as the first argument, and the rest of the map is passed as options. May also be a collection of the above.

License

Copyright © 2024 James Reeves

Distributed under the MIT License, the same as Ring.