Skip to content

document old way of checking validity of CSRF token #5818

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

Closed
wants to merge 5 commits into from
Closed

document old way of checking validity of CSRF token #5818

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6cfb36
document old way of checking validity of CSRF token
Oct 20, 2015
eda7332
fix code example
Oct 22, 2015
73209d0
use generateCsrfToken()
Oct 22, 2015
7b57421
link to interface
Dec 1, 2015
fb1c73d
more realistic example
Dec 15, 2015
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
16 changes: 16 additions & 0 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,6 +794,22 @@ Just like when creating a controller for a route, the order of the arguments of
order of the arguments, Symfony will still pass the correct value to each
variable.

Checking the Validity of a CSRF Token
-------------------------------------

Sometimes you want to use CSRF protection in an action where you don't want to use a
Symfony form.

If, for example, you're doing a DELETE action, you can use the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DELETE in backticks?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the docs for mentions of HTTP methods. In a sentence they are never in backticks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

:method:`Symfony\\Component\\Form\\Extension\\Csrf\\CsrfProvider\\DefaultCsrfProvider::isCsrfTokenValid`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should link to the method in the interface instead (it doesn't matter which implementation is registered as the service).

method to check the CSRF token::

$csrf = $this->container->get('form.csrf_provider');
$intention = 'authenticate';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to show this without showing a template? When you generate the CSRF token in the template, you would need to also include authenticate then, right?

$token = $csrf->generateCsrfToken($intention);

$csrf->isCsrfTokenValid($intention, $token);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about an if statement to be more realistic:

if (!$csrf->isCsrfTokenValid($intention, $token)) {
    // CSRF token invalid! Do something, like redirect with an error
}


Final Thoughts
--------------

Expand Down