stream_socket_enable_crypto()
stream_socket_enable_crypto() — Turns encryption on/off on an already connected socket.
Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.1.0, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
Signature
stream_socket_enable_crypto(resource $stream, bool $enable, ?int $crypto_method = null, ?resource $session_stream = null): int|bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $stream | resource | The stream resource. |
| $enable | bool | Enable/disable cryptography on the stream. |
| $crypto_method | ?int | Setup encryption on the stream. Valid methods are STREAM_CRYPTO_METHOD_SSLv2_CLIENT STREAM_CRYPTO_METHOD_SSLv3_CLIENT STREAM_CRYPTO_METHOD_SSLv23_CLIENT STREAM_CRYPTO_METHOD_ANY_CLIENT STREAM_CRYPTO_METHOD_TLS_CLIENT STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT (as of PHP 7.4.0) STREAM_CRYPTO_METHOD_SSLv2_SERVER ... |
| $session_stream | ?resource | Seed the stream with settings from session_stream. |
Return value
Returns true on success, false if negotiation has failed or 0 if there isn't enough data and you should try again (only for non-blocking sockets).
Example
A runnable snippet:
$fp = stream_socket_client("tcp://myproto.example.com:31337", $errno, $errstr, 30); if (!$fp) { die("Unable to connect: $errstr ($errno)"); } /* Turn on encryption for login phase */ stream_socket_enable_crypto($fp, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT); fwrite($fp, "USER god\r\n"); fwrite($fp, "PASS secret\r\n"); /* Turn off encryption for the rest */ stream_socket_enable_crypto($fp, false); while ($motd = fgets($fp)) { echo $motd; } fclose($fp);
Changelog
| Version | Change |
|---|---|
| 8.0.0 | Now throws a ValueError if crypto_method is needed but not given. Previously, an E_WARNING was raised and false was returned. |
| 8.0.0 | session_stream is now nullable. |
All PHP 8.5 built-in functions
Reference card built from the PHP manual page stream_socket_enable_crypto() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.