summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-05-09 10:23:08 +0200
committerAndrey Andreev <narf@devilix.net>2014-05-09 10:23:08 +0200
commita5621b8965ebcec213d3a5b07500cfcc3a730ada (patch)
tree476bc1a085cae07974ced3c7c512118a6c65f275 /user_guide_src
parent08ae84f82c9e83d5a7630d0adb621d5d638d6089 (diff)
Add hash_equals() to ext/hash compat layer
Introduced in PHP 5.6 Beta 1 (unfortunately, still undocumented). RFC: https://wiki.php.net/rfc/timing_attack (Yes, I am aware that the RFC talks about hash_compare(), the function was later renamed in the implementation.)
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/changelog.rst2
-rw-r--r--user_guide_src/source/general/compatibility_functions.rst15
2 files changed, 14 insertions, 3 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index edf0a497b..db8f7d277 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -525,7 +525,7 @@ Release Date: Not Released
- Added `compatibility layers <general/compatibility_functions>` for:
- `Multibyte String <http://php.net/mbstring>`_ (limited support).
- - `Hash <http://php.net/hash>`_ (just ``hash_pbkdf2()``).
+ - `Hash <http://php.net/hash>`_ (``hash_equals()``, ``hash_pbkdf2()``).
- `Password Hashing <http://php.net/password>`_.
- `Array Functions <http://php.net/book.array>`_ (``array_column()``, ``array_replace()``, ``array_replace_recursive()``).
diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst
index 398403eda..e685073a1 100644
--- a/user_guide_src/source/general/compatibility_functions.rst
+++ b/user_guide_src/source/general/compatibility_functions.rst
@@ -97,8 +97,9 @@ Function reference
Hash (Message Digest)
*********************
-This compatibility layer contains only a single function at
-this time - ``hash_pbkdf2()``, which otherwise requires PHP 5.5.
+This compatibility layer contains backports for the ``hash_equals()``
+and ``hash_pbkdf2()`` functions, which otherwise require PHP 5.6 and/or
+PHP 5.5 respectively.
Dependancies
============
@@ -108,6 +109,16 @@ Dependancies
Function reference
==================
+.. function:: hash_equals($known_string, $user_string)
+
+ :param string $known_string: Known string
+ :param string $user_string: User-supplied string
+ :returns: TRUE if the strings match, FALSE otherwise
+ :rtype: string
+
+ For more information, please refer to the `PHP manual for
+ hash_equals() <http://php.net/hash_equals>`_.
+
.. function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
:param string $algo: Hashing algorithm