stream_socket_enable_crypto
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
stream_socket_enable_crypto — Turns encryption on/off on an already connected socket
Description
resource
$stream,bool
$enable,?int
$crypto_method = null,?resource
$session_stream = null): int|bool
Enable or disable encryption on the stream.
Once the crypto settings are established, cryptography can be turned
on and off dynamically by passing true or false in the
enable parameter.
Parameters
-
stream -
The stream resource.
-
enable -
Enable/disable cryptography on the stream.
-
crypto_method -
Setup encryption on the stream. Valid methods are
STREAM_CRYPTO_METHOD_SSLv2_CLIENTSTREAM_CRYPTO_METHOD_SSLv3_CLIENTSTREAM_CRYPTO_METHOD_SSLv23_CLIENTSTREAM_CRYPTO_METHOD_ANY_CLIENTSTREAM_CRYPTO_METHOD_TLS_CLIENTSTREAM_CRYPTO_METHOD_TLSv1_0_CLIENTSTREAM_CRYPTO_METHOD_TLSv1_1_CLIENTSTREAM_CRYPTO_METHOD_TLSv1_2_CLIENTSTREAM_CRYPTO_METHOD_SSLv2_SERVERSTREAM_CRYPTO_METHOD_SSLv3_SERVERSTREAM_CRYPTO_METHOD_SSLv23_SERVERSTREAM_CRYPTO_METHOD_ANY_SERVERSTREAM_CRYPTO_METHOD_TLS_SERVERSTREAM_CRYPTO_METHOD_TLSv1_0_SERVERSTREAM_CRYPTO_METHOD_TLSv1_1_SERVERSTREAM_CRYPTO_METHOD_TLSv1_2_SERVER
If omitted, the
crypto_methodcontext option on the stream's SSL context will be used instead. -
session_stream -
Seed the stream with settings from
session_stream.
Return Values
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).
Changelog
| Version | Description |
|---|---|
| 8.0.0 |
session_stream is now nullable.
|
Examples
Example #1 stream_socket_enable_crypto() example
<?php
$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);
?>
The above example will output something similar to:
