-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
4668 document isCsrfTokenValid #5572
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.
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
Changes from 5 commits
0878c51
91b3f99
b7d133f
42c78fd
1d0aa8e
e719d56
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -440,7 +440,7 @@ If you want to redirect the user to another page, use the ``redirectToRoute()`` | |
} | ||
|
||
.. versionadded:: 2.6 | ||
The ``redirectToRoute()`` method was added in Symfony 2.6. Previously (and still now), you | ||
The ``redirectToRoute()`` method was introduced in Symfony 2.6. Previously (and still now), you | ||
could use ``redirect()`` and ``generateUrl()`` together for this (see the example above). | ||
|
||
Or, if you want to redirect externally, just use ``redirect()`` and pass it the URL:: | ||
|
@@ -803,6 +803,29 @@ 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 the | ||
Symfony Form component. | ||
|
||
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 | ||
} | ||
|
||
.. versionadded:: 2.6 | ||
The ``isCsrfTokenValid()`` shortcut method was introduced in Symfony 2.6. | ||
|
||
It is equivalent to executing the following code:: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you should indent this (and put this directly after the previous sentence). This way, everything will be included in the versionadded box. Again, this can be done after the merge (please note that you can just add commits to the current branch, no need to create a new PR) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tried that and it broke the code example when previewing the html build. |
||
|
||
use Symfony\Component\Security\Csrf\CsrfToken; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't this code listing be indented? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, will do after the merge |
||
|
||
$this->get('security.csrf.token_manager')->isTokenValid(new CsrfToken('token_id', 'TOKEN')); | ||
|
||
Final Thoughts | ||
-------------- | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excuse me for nitpicking but
Checking the Validity ...
sounds a bit too formal to me. Should we change this title byValidating a CSRF Token
?