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

Added note about the hash_equals polyfill #6044

Closed
wants to merge 2 commits into from
Closed

Added note about the hash_equals polyfill #6044

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
397dbcc
Added note about the polyfill
wouterj Dec 18, 2015
3c971dd
Add versionadded about the polyfill
wouterj Dec 20, 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
13 changes: 13 additions & 0 deletions cookbook/security/custom_authentication_provider.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,18 @@ the ``PasswordDigest`` header value matches with the user's password.
provider for the given token. In the case of multiple providers, the
authentication manager will then move to the next provider in the list.

.. note::

While the :phpfunction:`hash_equals` function was introduced in PHP 5.6,
you are safe to use it with any PHP version in your Symfony application. In
PHP versions prior to 5.6, `Symfony Polyfill`_ (which is included in
Symfony) will define the function for you.

.. versionadded:: 2.8
Copy link
Contributor

Choose a reason for hiding this comment

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

blank line after the version add? like in the note, or not needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Versionadded is a very strange directive, as it can be used inside sentences. For this reason, empty lines after the directive start are not allowed (well they are, but the following text will be parsed as normal text instead of inside the vesrionadded directive).

Symfony Polyfill is included by default since Symfony 2.8. Prior to Symfony 2.8,
you have to execute ``composer require symfony/polyfill-php56`` to be able to
use ``hash_equals`` on older PHP versions.

The Factory
-----------

Expand Down Expand Up @@ -666,3 +678,4 @@ in the factory and consumed or passed to the other classes in the container.
.. _`WSSE`: http://www.xml.com/pub/a/2003/12/17/dive.html
.. _`nonce`: https://en.wikipedia.org/wiki/Cryptographic_nonce
.. _`timing attacks`: https://en.wikipedia.org/wiki/Timing_attack
.. _`Symfony Polyfill`: https://github.com/symfony/polyfill