Commit graph

61 commits

Author SHA1 Message Date
Michal Špaček
6be77ad626
Argon2's memory_cost is in kilobytes, not bytes
https://www.php.net/password-hash says "kibibytes", spec https://www.password-hashing.net/argon2-specs.pdf says "kilobytes", went with "kibibytes" to match the other docs page.

Closes GH-1596.
2022-05-25 19:39:34 +02:00
Steve Thomas
f93ab9943c
password_verify is capable of verifying crypt hashes
Closes GH-1424.
2022-02-22 17:15:50 +01:00
Christoph M. Becker
98ba3bd97a
Fix #1328: bcrypt max password length is about bytes, not characters 2022-01-14 13:45:21 +01:00
Kim Hallberg
39148ec514
Fix password_needs_rehash method signature (#930) 2021-09-17 20:50:45 +01:00
Christoph M. Becker
79c06cc0e7
Fix #81299: password_hash() documentation is missing PHP 8 changes 2021-07-26 13:21:14 +02:00
Remi Collet
a997a6c145
Add information about "threads" with libsodium
Closes GH-762.
2021-07-07 10:25:58 +02:00
Sergey Panteleev
a0ae28d3bc
Removed references to PHP 5, PHP 7.0 (#545) 2021-04-24 20:01:17 +03:00
Yoshinari Takaoka
443dc41e7d Added PHP 8 into versions.xml for password based on stubs.
Closes GH-396.
2021-01-24 17:18:16 +01:00
Christoph Michael Becker
b95d28e6ec Fix return types
Functions which return false on failure should state that in their
signature as well.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:52:35 +00:00
Christoph Michael Becker
86e6094e86 Use canonical type names
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00
Christoph Michael Becker
5e803ed87f Fix section order
It's supposed to be return values, changelog, examples.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349972 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-24 11:49:30 +00:00
Christoph Michael Becker
c9596f7576 Fix #79565: Documentation missing for password_algos()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349903 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-17 12:05:19 +00:00
Christoph Michael Becker
b21947c4f7 Fix typo
Patch provided by anonymous user.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347683 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-30 09:33:30 +00:00
Christoph Michael Becker
0b7542c9e3 Document Argon2id password hashing support
Cf. <https://wiki.php.net/rfc/argon2_password_hash_enhancements>.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346125 c90b9560-bf6c-de11-be94-00142212c4b1
2018-11-29 10:44:24 +00:00
Nikita Popov
6e2c23cc40 Mention PASSWORD_ARGON2I not always available
And remove the example for manually specifying a salt. We should not show examples with deprecated functionality.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345776 c90b9560-bf6c-de11-be94-00142212c4b1
2018-10-05 10:10:36 +00:00
Nikita Popov
99d1ecc2f4 Don't use mcrypt_create_iv in password_hash docs
Also reference sodium_crypto_pwhash_str (patch by Marcus Bointon). Merged into this commit because I don't understand edit.php.net

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345734 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-29 20:12:28 +00:00
Nikita Popov
be96542e25 Reference sodium_crypto_pwhash_str_verify from password_verify
Patch by Marcus Bointon

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345733 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-29 20:09:28 +00:00
Christoph Michael Becker
6acea9d1d1 Add preliminary documentation of PASSWORD_ARGON2ID
Based on patch provided by an anonymous user.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345731 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-29 17:32:30 +00:00
Christoph Michael Becker
ab387e780b Fix #76716: PASSWORD_ARGON2I not always being available not documented
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345440 c90b9560-bf6c-de11-be94-00142212c4b1
2018-08-07 21:36:07 +00:00
Christoph Michael Becker
7f59e06a51 Fix typo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344891 c90b9560-bf6c-de11-be94-00142212c4b1
2018-04-30 18:21:57 +00:00
Christoph Michael Becker
db38901efe Fix #76290: Wrong info in argon2i memory_cost
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344889 c90b9560-bf6c-de11-be94-00142212c4b1
2018-04-30 17:12:26 +00:00
Jakub Vrana
be295015d0 Use int instead of integer in parameters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343891 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:56:34 +00:00
Jakub Vrana
331fbfeac5 Use bool instead of boolean in return types
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343889 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:50:10 +00:00
Kalle Sommer Nielsen
0ed97654e1 Documented ArgDocumented Argon2 password hashing support in 7.2.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343511 c90b9560-bf6c-de11-be94-00142212c4b1
2017-11-29 19:44:12 +00:00
Christoph Michael Becker
3327d57392 Fix typo
Patch provided by johney.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343346 c90b9560-bf6c-de11-be94-00142212c4b1
2017-10-30 18:17:18 +00:00
Peter Cowburn
119fb4697c remove confusing newlines in password_hash() examples (doc bug #75276)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343154 c90b9560-bf6c-de11-be94-00142212c4b1
2017-09-28 15:27:54 +00:00
Pieter Hordijk
08c60bdf54 Added note about the salt option being deprecated in 7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342418 c90b9560-bf6c-de11-be94-00142212c4b1
2017-04-25 14:26:01 +00:00
Christoph Michael Becker
7e65787ddc Fixed that the option parameter description was nested below the algorithms parameter.
-- 
Provided by anonymous 63625 (php@dennis.birkholz.biz)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340333 c90b9560-bf6c-de11-be94-00142212c4b1
2016-10-06 10:27:37 +00:00
Adam Harvey
41d8e7ffe4 Update version information to include PHP 7.
This was mostly done programmatically, and is likely wrong for a small number
of functions. We may have to wait for bug reports, unless someone wants to
review this by hand. Basic efforts were made to avoid adding "PHP 7" to
functions that were removed in PHP 5.x (x > 0) and PHP 7, but there are
undoubtedly still issues.

In case we're still using Docbook for PHP 8, I've uploaded the script that I
wrote to do this to GitHub at
https://github.com/LawnGnome/php-doc-version-migrator.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338406 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-04 21:40:07 +00:00
Adam Harvey
a4706cc591 Note that salt is deprecated all over the password_hash() page.
Also change the version examples, since some of them have already happened. Now
we can forget about this until 2021!


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338252 c90b9560-bf6c-de11-be94-00142212c4b1
2015-12-14 19:27:01 +00:00
Maciej Sobaczewski
056c39d4f5 Make the caution more clear (closes bug #70615)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337962 c90b9560-bf6c-de11-be94-00142212c4b1
2015-10-07 06:49:28 +00:00
Thomas Punt
834d7db5b8 Document deperecation of password_hash() salt option
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337585 c90b9560-bf6c-de11-be94-00142212c4b1
2015-08-22 12:30:06 +00:00
Pieter Hordijk
f0e80e2c3f Added message about the function being safe against timing attacks.
https://bugs.php.net/bug.php?id=69230

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337052 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-25 11:29:56 +00:00
Maciej Sobaczewski
5650ac40be Improve title of password_needs_rehash() example
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336033 c90b9560-bf6c-de11-be94-00142212c4b1
2015-03-04 04:32:07 +00:00
Maciej Sobaczewski
b3b5e95c7e Drop unnecessary entity
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336029 c90b9560-bf6c-de11-be94-00142212c4b1
2015-03-03 12:53:03 +00:00
Anthony Ferrara
28ebb20500 Add example for password_needs_rehash to documentation.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336027 c90b9560-bf6c-de11-be94-00142212c4b1
2015-03-02 22:50:57 +00:00
Anthony Ferrara
2bf617982f Update password_hash documentation to recommend <= 100 ms hash times, including adjusting the cost-finding script.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334834 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-10 15:41:21 +00:00
Simion Onea
14af302c9c Making the XML definition consistent across the entire project.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-05 07:44:07 +00:00
Chris Wright
b978dba78b Grammar fix in password_hash() docs
-- 
Provided by anonymous 48275

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334703 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-01 16:23:05 +00:00
Anthony Ferrara
925468837b Revert 334297 and 334297, as:
1) there was no discussion prior to edits (even in #66564)
2) It is incorrect, misleading and not the overall sentiment that needs to be communicated

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334309 c90b9560-bf6c-de11-be94-00142212c4b1
2014-07-17 22:14:11 +00:00
Maciej Sobaczewski
39bbfc9fd1 Typofixes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334300 c90b9560-bf6c-de11-be94-00142212c4b1
2014-07-17 05:28:16 +00:00
Yasuo Ohgaki
7182ebded6 Add important CRYPT_BLOWFISH limitation to password_hash()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334297 c90b9560-bf6c-de11-be94-00142212c4b1
2014-07-17 02:17:56 +00:00
Ferenc Kovacs
3fb1e0bf88 removing the misleading sentence (reported by Solar Designer, also pointed out by Michal Špaček previously in a comment for #66564)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333973 c90b9560-bf6c-de11-be94-00142212c4b1
2014-06-27 15:00:47 +00:00
Hannes Magnusson
dfaeb887cf Remove generated file
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333398 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-22 04:30:28 +00:00
Peter Cowburn
a1b67e45e7 Fix password_needs_rehash() argument types (patch by Andrey Andreev)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333093 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-24 20:23:27 +00:00
Sherif Ramadan
824b84746c Add cautionary statement about truncation for crypt and password_hash using BCRYPT. Fixes Bug #66564.
This includes a cautionary statement that the CRYPT_BLOWFISH algorithm in crypt/password_hash functions
will truncate the input string at a maxmimum length of 72 characters. Typically not a problem for the
average use case since this is only likely used for passwords and assuming each hash has a unique salt.
However, it's still a good idea to document this behavior so that users are aware of the side effect.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332747 c90b9560-bf6c-de11-be94-00142212c4b1
2014-01-28 13:10:21 +00:00
Nikita Popov
e2128e7727 password_hash outputs are not exact, use outputs.similar
Also commit a contributed patch noting that the returned hash already contains algo/salt/etc.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332666 c90b9560-bf6c-de11-be94-00142212c4b1
2014-01-18 22:24:08 +00:00
Yasuo Ohgaki
acadfdd1b4 Add description for crypt() compatibility.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332024 c90b9560-bf6c-de11-be94-00142212c4b1
2013-10-31 00:50:41 +00:00
Adam Harvey
254b04328c Fix typo.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331550 c90b9560-bf6c-de11-be94-00142212c4b1
2013-09-27 19:07:08 +00:00
Anthony Ferrara
dc38086ee9 Clean up typo in cost finder example.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330613 c90b9560-bf6c-de11-be94-00142212c4b1
2013-06-21 16:53:38 +00:00