README

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-opportunistic-tls

Usage

Because this package is extracted from this PR the API is identical as to proposed there. Making it a two line change in any packages using this package once the PR has been merged. We, the ReactPHP core team, decided on going with testing it out in a package before merging in the PR. Main reasons ensuring we tackle most unexpected issues as this is a tricky subject. This package is set up as a drop in replacement for the Connector and SocketServer. Put WyriHaximus\ in front of its namespace to use it.

Client

use WyriHaximus\React\Socket;

use function React\Promise\Stream\first;

$connector = new Socket\Connector();
$connector->connect('opportunistic+tls://example.com:5432/')->then(function (Socket\OpportunisticTlsConnectionInterface $startTlsConnection) {
    $connection->write('let\'s encrypt?');

    return first($connection)->then(function ($data) use ($connection) {
        if ($data === 'yes') {
            return $connection->enableEncryption();
        }

        return $stream;
    });
})->then(function (Socket\ConnectionInterface $connection) {
    $connection->write('Hello!');
});

Server

use WyriHaximus\React\Socket;

$socket = new Socket\SocketServer('opportunistic+tls://127.0.0.1:8000', array(
    'tls' => array(
        'local_cert' => 'server.pem',
        'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_2_SERVER
    )
));
$server->on('connection', static function (Socket\OpportunisticTlsConnectionInterface $connection) use ($server) {
    return $connection->enableEncryption();
});

License

The MIT License (MIT)

Copyright (c) 2025 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.