Clarity on constant STREAM_CRYPTO_METHOD_TLS_CLIENT
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
What's Wrong:
Doc: https://www.php.net/manual/en/migration56.openssl.php
Source: https://github.com/php/doc-en/blame/master/appendices/migration56/openssl.xml#L238
// Requiring TLS 1.0 or better when using file_get_contents(): is an incorrect comment in the context of migration to 5.6. While it is true on versions 5.6.0-5.6.6, it is not true on 5.6.7-7.1.x. Instead, in these versions it means specifically TLS 1.0 for "backward compatibility" with PHP 5.5 which did not have TLS 1.1+ support.
Reference Code:
v7.2 - https://github.com/php/php-src/commit/bec91e1117fd3527897cde2f8a26eab9a20fa3dc#diff-44e92201d04db88602978efe498e1131018a557ed319870f873a799d6bece883
v5.6.7 - https://github.com/php/php-src/commit/95b5fb115c6b4915c4e4dc54d35d3a8be09b0ba9#diff-44e92201d04db88602978efe498e1131018a557ed319870f873a799d6bece883
v5.6.0 - https://github.com/php/php-src/commit/3a9829af2062527fb4e5cb11eb4ac3e045d0b370#diff-44e92201d04db88602978efe498e1131018a557ed319870f873a799d6bece883
What's Undocumented and unclear:
Doc: https://www.php.net/manual/en/function.stream-socket-enable-crypto.php#119122
Source: https://github.com/php/doc-en/blob/master/reference/stream/functions/stream-socket-enable-crypto.xml#L61
- There is a flag introduced in 5.67 that actually means what it's named consistently since inception. STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT
- Unclear what STREAM_CRYPTO_METHOD_TLS_CLIENT actually means without digging into the source code. Would be nice to mention it under revisions at the minimum.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with appendices/migration56/openssl.xml and reference/stream/functions/stream-socket-enable-crypto.xml at the lines linked in the issue. Compare the referenced PHP 5.6.0, 5.6.7, and 7.2 source revisions, then update the comments and revision notes to explain STREAM_CRYPTO_METHOD_TLS_CLIENT and STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT accurately across those versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100