STREAM_SOCKET_ENABLE_CRYPTO(3) 1 STREAM_SOCKET_ENABLE_CRYPTO(3)
stream_socket_enable_crypto - Turns encryption on/off on an already connected socket
SYNOPSIS
mixed stream_socket_enable_crypto (resource $stream, bool $enable, [int $crypto_type], [resource $session_stream])
DESCRIPTION
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 param-
eter.
PARAMETERS
o $stream
- The stream resource.
o $enable
- Enable/disable cryptography on the stream.
o $crypto_type
- Setup encryption on the stream. Valid methods are
o STREAM_CRYPTO_METHOD_SSLv2_CLIENT
o STREAM_CRYPTO_METHOD_SSLv3_CLIENT
o STREAM_CRYPTO_METHOD_SSLv23_CLIENT
o STREAM_CRYPTO_METHOD_TLS_CLIENT
o STREAM_CRYPTO_METHOD_SSLv2_SERVER
o STREAM_CRYPTO_METHOD_SSLv3_SERVER
o STREAM_CRYPTO_METHOD_SSLv23_SERVER
o STREAM_CRYPTO_METHOD_TLS_SERVER
If omitted, the $crypto_type context option on the stream's SSL context will be used instead.
o $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 |
| | |
+--------+------------------------------------+
| 5.6.0 | |
| | |
| | The $crypto_type is now optional. |
| | |
+--------+------------------------------------+
EXAMPLES
Example #1
stream_socket_enable_crypto(3) 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
");
fwrite($fp, "PASS secret
");
/* 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:
SEE ALSO
"OpenSSL Functions", "List of Supported Socket Transports".
PHP Documentation Group STREAM_SOCKET_ENABLE_CRYPTO(3)