php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
31,035 Commits 7 Branches 0 Tags
master
Commit Graph

128 Commits

Author SHA1 Message Date
Josh
e325776622 Update Hash extension installation notes (#4867) 2025-09-08 15:29:17 +02:00
Derick Rethans
a19139232a Enable (and fix) hash functions for WASM 2025-07-30 15:48:09 +01:00
Tim Düsterhus
6ba84e3a5b Revert "Reverse hash_equals parameters (#4733)" 
see https://github.com/php/doc-en/pull/4733#issuecomment-2989328180

This reverts commit c769746c03.
 2025-06-20 01:06:48 +02:00
Devin Gammill
c769746c03 Reverse hash_equals parameters (#4733) 
As stated in the document, the user provided string is supposed to be the second parameter. Whereas before this pull request, the user provided string is the first parameter.
 2025-06-19 22:53:46 +02:00
Cédric Anne
05b26e8d7a Add missing false return type in hash_file documentation (#4671) 2025-05-14 14:37:11 +08:00
Niels Dossche
fe4ff34103 PHP 8.4: Document hash_init() invalid options deprecation 2024-11-24 01:23:25 +00:00
Niels Dossche
4c852f20e9 PHP 8.4: Document return type change of hash_update() 2024-11-24 01:23:25 +00:00
Mikhail Alferov
0904e1f4db hash/book.xml: add missing comma (#3638) 2024-08-04 23:14:08 +02:00
Yoshinari Takaoka
4a5170086f Moved early algorithm description to warning block (#3635) 2024-08-02 21:19:46 +09:00
Jim Winstead
a9c0102c4e Add more description for hash extension (#3630) 
* Add more description for hash extension

Based on this comment by @cmb69:
https://github.com/php/doc-en/issues/3616#issuecomment-2254714040

With additional feedback from @TimWolla
 2024-07-31 09:09:47 -07:00
Tim Düsterhus
539a9823a8 hash: Clean up the listed algorithms for the hash_*() algorithm parameter (#3614) 
* hash: Clean up the listed algorithms for the `hash_*()` algorithm parameter

* hash: Fix algorithm reference for functions requiring a CS hash function

* hash: Quote the algorithm name in the `<literal>`
 2024-07-30 20:41:27 +02:00
haszi
765b2d6eec Remove empty configuration pages (#3538) 
Co-authored-by: haszi <haszika80@gmail.com>
 2024-07-09 22:24:55 +01:00
Mikhail Alferov
0cd7bb8f32 hash-file.xml: add the literal tag to the algorithms (#3537) 2024-07-09 20:11:01 +01:00
Mikhail Alferov
a027e69cf7 hash-file.xml: add the function tag (#3530) 
* hash-file.xml: add the `function` tag

* Update hash-update-file.xml
 2024-07-09 16:18:37 +01:00
Tim Düsterhus
71e12e2df7 Clean up “See Also” for hash*() (#3482) 
* Clean up “See Also” for `hash*()`

Specifically remove the `md5*()` and `sha1*()` references, but also shorten the
lists in general: All hash functions are somewhat related, that does not mean
that each should reference each other.

see https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_md5_sha1_md5_file_and_sha1_file
see php/doc-en#2822

* Clean out “See Also” of `md5*()` and `sha1*()`
 2024-07-07 14:47:57 +01:00
haszi
57d1b0df36 Remove empty installation pages (#3462) 
Co-authored-by: haszi <haszika80@gmail.com>
 2024-06-21 02:38:44 +01:00
Gina Peter Banyard
4d17b7b494 [skip-revcheck] Convert class markup to be compatible with DocBook 5.2 
Closes GH-3415
 2024-06-14 17:04:53 +01:00
Máté Kocsis
5bc68add3d Document SensitiveParameter attributes - part 1 (#3402) 2024-05-21 12:08:46 +01:00
Máté Kocsis
db22a7cfcb Sync some methodsynopses with stubs (#3356) 
Co-authored-by: Gina Peter Banyard <girgias@php.net>
 2024-04-28 21:42:56 +01:00
Tim Düsterhus
7b68fb1712 hash_pbkdf2: Add actually related function references 2023-11-04 14:13:38 +00:00
Tim Düsterhus
1aeea8f0d2 hash_pbkdf2: Clean out referenced functions 
`hash_pbkdf2` is intended as a key derivation function, the only functions that
are somewhat related are `crypt()` and `password_hash()`, with `crypt()` usage
being discouraged.
 2023-11-04 14:13:38 +00:00
Tim Düsterhus
60307126df hash_pbkdf2: Do not reference openssl_pbkdf2 
The functions do the same thing, but ext/hash is always available and the list
of referenced functions is long enough.
 2023-11-04 14:13:38 +00:00
Tim Düsterhus
a22e0f26f6 hash_pbkdf2: Increase rounds to 600000 
This matches the current OWASP suggestion.
 2023-11-04 14:13:38 +00:00
Tim Düsterhus
50960545e7 hash_hmac_file: Sync example with hash_hmac (#2838) 
This was missed in 20dcfbb0dd.
 2023-10-05 00:17:20 +01:00
Tim Düsterhus
584a9fb976 hash_copy: Unify with hash_* (#2839) 
see 20dcfbb0dd
 2023-10-05 00:17:05 +01:00
Tim Düsterhus
33b00cc279 hash_hmac: Reference hash_equals() in the “see also” section (#2823) 2023-10-03 13:52:04 +01:00
Tim Düsterhus
20dcfbb0dd hash_*: Rewrite examples (#2822) 
- Consistently use `sha256` in the examples, as sha256 is the right choice if
  all things are equal.
- Improve the `hash_init()` example by showcasing that incremental hashing is
  equivalent to hashing the contents in full.
 2023-10-03 13:51:40 +01:00
Tim Düsterhus
472a8ae5cc hash_equals: Rewrite the page (#2821) 
* hash_equals: Improve example

Stop showcasing `crypt()`, as passwords are better verified using
`password_verify()`. The example also used a terrible BCrypt salt.

Instead, showcase an example using `hash_hmac()` which likely is the best use
case for `hash_equals()`.

* hash_equals: Rewrite the explanation
 2023-10-03 13:50:02 +01:00
Máté Kocsis
5e9500ddad [skip-revcheck] Syncronize predefined constants with stubs - part 1 (#2739) 
Preparation commit for syncing constants with stub.

This reformats the page, which is mainly just whitespace changes.
 2023-09-04 23:37:50 +01:00
Máté Kocsis
14767af0f0 Use new class synopsis markup (#2611) 
Follow-up on https://github.com/php/phd/pull/77
 2023-08-30 12:28:30 +01:00
Máté Kocsis
d5f26dc94f Update ext/hash role attributes (#2060) 2022-12-11 23:20:18 +01:00
Tim Düsterhus
2ab45105b4 Stop referring to openssl_random_pseudo_bytes() outside of ext/openssl (#1967) 
* random: Remove openssl_random_pseudo_bytes() from caution.cryptographically-insecure

The `random_bytes()` and `random_int()` alternatives are available since since
PHP 7.0, are available by default and directly map to the OS' CSPRNG and thus
are likely more secure.

Thus this commit stops mentioning `openssl_random_pseudo_bytes()` as a possible
option any more to keep things simple for the reader.

* random: Remove `openssl_random_pseudo_bytes()` from “See Also” sections for ext/random

The reasoning as with the previous commit applies.

* hash: Replace `openssl_random_pseudo_bytes()` by `random_bytes()`

* session: Replace `openssl_random_pseudo_bytes()` by `random_bytes()`
 2022-11-10 14:08:01 +01:00
Tim Starling
91e303f2d2 Updates for hash functions that now throw errors 
Update the manual for the changes to the hash functions by Mark Randall
in August 2019 and subsequent tweaks by Máté Kocsis in March 2020.

Closes GH-1932.
 2022-11-03 11:34:34 +01:00
Juliette
03bb26ae70 PHP 8.1 | Update hash_algos() documentation 
> **MurmurHash3**
>
> Added support for MurmurHash3 with streaming support. The following variants are implemented:
> * murmur3a, 32-bit hash
> * murmur3c, 128-bit hash for x86
> * murmur3f, 128-bit hash for x64
>
> **xxHash**
>
> Added support for xxHash. The following variants are implemented:
> * xxh32, 32-bit hash
> * xxh64, 64-bit hash
> * xxh3, 64-bit hash
> * xxh128, 128-bit hash

Refs:
* https://www.php.net/manual/en/migration81.new-features.php#migration81.new-features.hash.murmurhash3
* https://github.com/php/php-src/pull/6059
* 72e91e9fc8
* https://www.php.net/manual/en/migration81.new-features.php#migration81.new-features.hash.xxhash
* https://github.com/php/php-src/pull/6524
* 23590f7c53

Co-authored-by: jrfnl <jrfnl@users.noreply.github.com>

Closes GH-1451.
 2022-03-11 14:20:23 +01:00
Christoph M. Becker
1adf24615e Update name of 3rd param of hash_hmac_file() 
See <https://github.com/php/php-src/issues/7826>.
 2021-12-26 13:07:57 +01:00
Yoshinari Takaoka
4b4c8b4740 fixed function name in changelog 2021-12-18 10:23:36 +09:00
Máté Kocsis
ac6b36357e Update ext/hash documentation 
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-1215.
 2021-12-17 15:15:19 +01:00
Fabien Villepinte
537e1dfad9 Add missing final modifier 
Closes GH-1152.
 2021-11-29 13:47:04 +01:00
Christoph M. Becker
8ad9c12d9b Fix #81473: hash_pbkdf2 truncate in hex 
We extend the example to show the behavior of raw binary results.
 2021-09-27 14:33:58 +02:00
Máté Kocsis
7f99d5e488 Remove some unnecessary methodsynopsis role attributes (#913) 2021-09-14 14:37:29 +02:00
Yoshinari Takaoka
abb0c22310 Deleted old PHP 5.3 -> 5.4 tiger hash compatibility example. (#926) 2021-09-08 00:41:10 +01:00
George Peter Banyard
68c2c87150 Fix extension doc membership 2021-06-13 23:23:33 +01:00
George Peter Banyard
4283ca8aa3 Fix section order issues in Hash extension 
Part of #658
 2021-06-06 18:03:03 +01:00
Yoshinari Takaoka
2a3060d1bb Added PHP 8 into versions.xml for hash based on stubs. 
Closes GH-377.
 2021-01-24 12:22:38 +01:00
Christoph Michael Becker
e41806c30b Revert revision(s) 351724 from phpdoc/en/trunk: 
Document false and null return types

Cf. <https://news-web.php.net/php.doc.cvs/17645>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
 2020-11-28 18:05:44 +00:00
Jakub Vrana
c80da7c04a Document false and null return types 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351724 c90b9560-bf6c-de11-be94-00142212c4b1
 2020-11-28 12:54:59 +00:00
Christoph Michael Becker
dabaf662b1 Generate hash methodsynopses based on stubs 
Patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351417 c90b9560-bf6c-de11-be94-00142212c4b1
 2020-11-17 22:46:27 +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
Andrey Gromov
01a7e4684e Fixes from volunteers 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350953 c90b9560-bf6c-de11-be94-00142212c4b1
 2020-10-20 08:54:50 +00:00
Christoph Michael Becker
3e15d2894f Remove more changelog entries, mostly from PHP 5.4 era 
Patch contributed by Sobak <msobaczewski@gmail.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350656 c90b9560-bf6c-de11-be94-00142212c4b1
 2020-09-26 14:15:17 +00:00