Merge pull request #1250 from MaxGabriel/documentCsrfMiddlewareUsage

Document recommended usage of the CSRF middleware
This commit is contained in:
Michael Snoyman 2016-07-14 18:05:45 +03:00 committed by GitHub
commit 9ce2770813

View File

@ -454,6 +454,18 @@ csrfSetCookieMiddleware handler cookie = setCsrfCookieWithCookie cookie >> handl
--
-- For details, see the "AJAX CSRF protection" section of "Yesod.Core.Handler".
--
-- You can add this chain this middleware together with other middleware like so:
--
-- @
-- 'yesodMiddleware' = 'defaultYesodMiddleware' . 'defaultCsrfMiddleware'
-- @
--
-- or:
--
-- @
-- 'yesodMiddleware' app = 'defaultYesodMiddleware' $ 'defaultCsrfMiddleware' $ app
-- @
--
-- Since 1.4.14
defaultCsrfMiddleware :: Yesod site => HandlerT site IO res -> HandlerT site IO res
defaultCsrfMiddleware = defaultCsrfSetCookieMiddleware . defaultCsrfCheckMiddleware