Skip to content

Enhance CSRF documentation with OWASP best practices and guidelines #21638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Spomky wants to merge 1 commit into
base: 7.4
Choose a base branch
from
+12 −0
Open

Enhance CSRF documentation with OWASP best practices and guidelines #21638

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions security/csrf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ CSRF, or `Cross-site request forgery`_, is a type of attack where a malicious ac
tricks a user into performing actions on a web application without their knowledge
or consent.

.. note::

According to `OWASP best practices`_, CSRF protection is only required for
**state-changing operations**. Do not use GET requests for state-changing
operations, as recommended by the HTTP specification. CSRF tokens must not be
transmitted in GET request parameters, as they can leak through browser history,
log files, network utilities, and Referer headers.

If you need to disable CSRF protection for specific forms (for example, forms
that only perform read operations), see :ref:`form-csrf-customization`.

The attack is based on the trust that a web application has in a user's browser
(e.g. on session cookies). Here's a real example of a CSRF attack: a malicious
actor could create the following website:
Expand Down Expand Up @@ -529,6 +540,7 @@ validation has been proven effective, it remains enforced for that session.
fall back to ``Origin`` / ``Referer`` checks when JavaScript is unavailable.

.. _`Cross-site request forgery`: https://en.wikipedia.org/wiki/Cross-site_request_forgery
.. _`OWASP best practices`: https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html
.. _`BREACH`: https://en.wikipedia.org/wiki/BREACH
.. _`CRIME`: https://en.wikipedia.org/wiki/CRIME
.. _`some JavaScript`: https://github.com/symfony/recipes/blob/main/symfony/stimulus-bundle/2.20/assets/controllers/csrf_protection_controller.js