diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,8 @@ +## 1.4.23.1 + +* Don't allow sending multiple cookies with the same name to the client, in accordance with [RFC 6265](https://tools.ietf.org/html/rfc6265). This fixes an issue where multiple CSRF tokens were sent to the client. [#1258](https://github.com/yesodweb/yesod/pull/1258) +* Default CSRF tokens to the root path "/", fixing an issue where multiple tokens were stored in cookies, and using the wrong one led to CSRF errors [#1248](https://github.com/yesodweb/yesod/pull/1248) + ## 1.4.23 * urlParamRenderOverride method for Yesod class [#1257](https://github.com/yesodweb/yesod/pull/1257) diff --git a/Yesod/Core/Class/Yesod.hs b/Yesod/Core/Class/Yesod.hs --- a/Yesod/Core/Class/Yesod.hs +++ b/Yesod/Core/Class/Yesod.hs @@ -419,9 +419,9 @@ -- all responses so that browsers will rewrite all http links to https -- until the timeout expires. For security, the max-age of the STS header -- should always equal or exceed the client sessions timeout. This defends --- against hijacking attacks on the sessions of users who attempt to access --- the site using an http url. This middleware makes a site functionally --- inaccessible over vanilla http in all standard browsers. +-- against SSL-stripping man-in-the-middle attacks. It is only effective if +-- a secure connection has already been made; Strict-Transport-Security +-- headers are ignored over HTTP. -- -- Since 1.4.7 sslOnlyMiddleware :: Yesod site @@ -491,13 +491,17 @@ -- | Calls 'csrfSetCookieMiddleware' with the 'defaultCsrfCookieName'. -- +-- The cookie's path is set to @/@, making it valid for your whole website. +-- -- Since 1.4.14 defaultCsrfSetCookieMiddleware :: Yesod site => HandlerT site IO res -> HandlerT site IO res -defaultCsrfSetCookieMiddleware handler = csrfSetCookieMiddleware handler (def { setCookieName = defaultCsrfCookieName }) +defaultCsrfSetCookieMiddleware handler = setCsrfCookie >> handler -- | Takes a 'SetCookie' and overrides its value with a CSRF token, then sets the cookie. See 'setCsrfCookieWithCookie'. -- -- For details, see the "AJAX CSRF protection" section of "Yesod.Core.Handler". +-- +-- Make sure to set the 'setCookiePath' to the root path of your application, otherwise you'll generate a new CSRF token for every path of your app. If your app is run from from e.g. www.example.com\/app1, use @app1@. The vast majority of sites will just use @/@. -- -- Since 1.4.14 csrfSetCookieMiddleware :: Yesod site => HandlerT site IO res -> SetCookie -> HandlerT site IO res diff --git a/Yesod/Core/Handler.hs b/Yesod/Core/Handler.hs --- a/Yesod/Core/Handler.hs +++ b/Yesod/Core/Handler.hs @@ -615,10 +615,14 @@ -- | Bypass remaining handler code and output the given JSON with the given -- status code. --- +-- -- Since 1.4.18 sendStatusJSON :: (MonadHandler m, ToJSON c) => H.Status -> c -> m a +#if MIN_VERSION_aeson(0, 11, 0) +sendStatusJSON s v = sendResponseStatus s (toEncoding v) +#else sendStatusJSON s v = sendResponseStatus s (toJSON v) +#endif -- | Send a 201 "Created" response with the given route as the Location -- response header. @@ -724,7 +728,11 @@ -- | Set the cookie on the client. setCookie :: MonadHandler m => SetCookie -> m () -setCookie = addHeaderInternal . AddCookie +setCookie sc = do + addHeaderInternal (DeleteCookie name path) + addHeaderInternal (AddCookie sc) + where name = setCookieName sc + path = maybe "/" id (setCookiePath sc) -- | Helper function for setCookieExpires value getExpires :: MonadIO m @@ -1354,7 +1362,7 @@ -- -- The form-based approach has the advantage of working for users with Javascript disabled, while adding the token to the headers with Javascript allows things like submitting JSON or binary data in AJAX requests. Yesod supports checking for a CSRF token in either the POST parameters of the form ('checkCsrfParamNamed'), the headers ('checkCsrfHeaderNamed'), or both options ('checkCsrfHeaderOrParam'). -- --- The easiest way to check both sources is to add the 'defaultCsrfMiddleware' to your Yesod Middleware. +-- The easiest way to check both sources is to add the 'Yesod.Core.defaultCsrfMiddleware' to your Yesod Middleware. -- | The default cookie name for the CSRF token ("XSRF-TOKEN"). -- @@ -1364,11 +1372,15 @@ -- | Sets a cookie with a CSRF token, using 'defaultCsrfCookieName' for the cookie name. -- +-- The cookie's path is set to @/@, making it valid for your whole website. +-- -- Since 1.4.14 setCsrfCookie :: MonadHandler m => m () -setCsrfCookie = setCsrfCookieWithCookie def { setCookieName = defaultCsrfCookieName } +setCsrfCookie = setCsrfCookieWithCookie def { setCookieName = defaultCsrfCookieName, setCookiePath = Just "/" } -- | Takes a 'SetCookie' and overrides its value with a CSRF token, then sets the cookie. +-- +-- Make sure to set the 'setCookiePath' to the root path of your application, otherwise you'll generate a new CSRF token for every path of your app. If your app is run from from e.g. www.example.com\/app1, use @app1@. The vast majority of sites will just use @/@. -- -- Since 1.4.14 setCsrfCookieWithCookie :: MonadHandler m => SetCookie -> m () diff --git a/Yesod/Core/Types.hs b/Yesod/Core/Types.hs --- a/Yesod/Core/Types.hs +++ b/Yesod/Core/Types.hs @@ -323,7 +323,7 @@ ----- header stuff -- | Headers to be added to a 'Result'. data Header = - AddCookie SetCookie + AddCookie SetCookie | DeleteCookie ByteString ByteString | Header ByteString ByteString deriving (Eq, Show) diff --git a/test/YesodCoreTest/Csrf.hs b/test/YesodCoreTest/Csrf.hs --- a/test/YesodCoreTest/Csrf.hs +++ b/test/YesodCoreTest/Csrf.hs @@ -45,6 +45,12 @@ assertStatus 200 res assertClientCookieExists "Should have an XSRF-TOKEN cookie" defaultCsrfCookieName + it "uses / as the path of the cookie" $ runner $ do -- https://github.com/yesodweb/yesod/issues/1247 + res <- request defaultRequest + assertStatus 200 res + cookiePath <- fmap setCookiePath requireCsrfCookie + liftIO $ cookiePath `shouldBe` Just "/" + it "200s write requests with the correct CSRF header, but no param" $ runner $ do getRes <- request defaultRequest assertStatus 200 getRes diff --git a/yesod-core.cabal b/yesod-core.cabal --- a/yesod-core.cabal +++ b/yesod-core.cabal @@ -1,5 +1,5 @@ name: yesod-core -version: 1.4.23 +version: 1.4.23.1 license: MIT license-file: LICENSE author: Michael Snoyman