bobjflong / yesod-csp

add CSP headers to Yesod apps
MIT License
8 stars 4 forks source link

PACKAGE MOVED TO https://github.com/pSub/yesod-csp

yesod-csp

The aim of this library is to make it easy to add correct Content Security Policy headers to your responses. This reduces the risk of loading bad assets or scripts.

Using the data types

The following code:

getHomeR :: Handler Html
getHomeR = do
  cspPolicy [ScriptSrc (Self :| []), StyleSrc (Https :| [Self])]
  defaultLayout [whamlet|hello|]

will ensure that a Content-Security-Policy: script-src 'self'; style-src https: 'self' header is set. In this example we only want to load scripts from our own domain, and we only want styles that come from our domain or over https.

This is a work in progress, not battle-hardened! Use with caution and confirm you're getting the results you need.

Examples

This module contains a host of runnable example Yesod handlers which set various CSP headers.

Template Haskell support

I'm working on Template Haskell support so you don't need to write the ADTs yourself explicitly. You can get the same compile-time checking with the familar CSP DSL:

getHomeR :: Handler Html
getHomeR = do
  cspPolicy [csp|img-src 'self' https:; script-src https://foo.com|]
  ...

You can add in your dynamic urls in scope:

getHomeR :: Handler Html
getHomeR = do
  let url = fromJust (escapeAndParseURI ...)
  cspPolicy [csp|img-src 'self' $url|]
  ...