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
Manual
Code Examples

stream_socket_enable_crypto(
     resource$stream,
     bool$enable,
     [int|null$crypto_method = null],
     [resource|null$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_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_SSLv2_SERVER

STREAM_CRYPTO_METHOD_SSLv3_SERVER

STREAM_CRYPTO_METHOD_SSLv23_SERVER

STREAM_CRYPTO_METHOD_ANY_SERVER

STREAM_CRYPTO_METHOD_TLS_SERVER

STREAM_CRYPTO_METHOD_TLSv1_0_SERVER

STREAM_CRYPTO_METHOD_TLSv1_1_SERVER

STREAM_CRYPTO_METHOD_TLSv1_2_SERVER

If omitted, the crypto_method context 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.

Example of stream_socket_enable_crypto

Show all examples for stream_socket_enable_crypto

PHP Version: