Skip to content
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

Jump to bottom

4668 document isCsrfTokenValid #5325

Closed
wants to merge 4 commits into from
Closed

4668 document isCsrfTokenValid #5325

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62c2f02
4668 document isCsrfTokenValid
May 28, 2015
af4ebaa
4668 show non-shortcut alternative, use variable argument for submitt…
May 28, 2015
e4d9d49
4668 link method to API docs, use 'was introduced' instead of 'was ad…
May 30, 2015
2de7c82
4668 move method reference to own line
May 31, 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
21 changes: 21 additions & 0 deletions book/controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,6 +803,27 @@ 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.
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 "[...] to use the Symfony Form component." is better


If, for example, you're doing a DELETE action, you can use ``isCsrfTokenValid()``::
Copy link
Member

Choose a reason for hiding this comment

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

We should use the method role here to link to the API docs:

If, for example, you're doing a DELETE action, you can use the
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::isCsrfTokenValid`
method to check the CSRF token::


if ($this->isCsrfTokenValid('token_id', $submittedToken)) {
// ... do something, like deleting an object
}
Copy link
Member

Choose a reason for hiding this comment

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

For consistency with other parts of the doc, there should be a comment showing the alternative not using the shortcut


.. versionadded:: 2.6
The ``isCsrfTokenValid()`` shortcut method was added in Symfony 2.6.
Copy link
Member

Choose a reason for hiding this comment

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

We always use "was introduced in".


Previously you would use::

use Symfony\Component\Security\Csrf\CsrfToken;

$this->get('security.csrf.token_manager')->isTokenValid(new CsrfToken('token_id', 'TOKEN'));

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

Expand Down