【PHP8.x】STREAM_CRYPTO_PROTO_TLSv1_1定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたホストとポートに接続し、TLSv1.1プロトコルを使用して暗号化を有効にするサンプル関数です。
5 * stream_socket_enable_crypto 関数と STREAM_CRYPTO_PROTO_TLSv1_1 定数の使用方法を示します。
6 *
7 * @param string $host 接続先のホスト名 (例: 'www.php.net')
8 * @param int $port 接続先のポート番号 (例: 443)
9 * @return void
10 */
11function enableTls11ClientCrypto(string $host, int $port): void
12{
13    // タイムアウト設定 (秒)
14    $timeout = 10;
15
16    echo "{$host}:{$port} への接続を試みています...\n";
17
18    // 非暗号化ソケット接続を確立します。
19    // stream_socket_client は、ネットワークソケットまたはUnixドメインソケット接続を確立します。
20    $socket = stream_socket_client(
21        "tcp://{$host}:{$port}",
22        $errno,  // 接続エラーコードが格納されます
23        $errstr, // 接続エラーメッセージが格納されます
24        $timeout,
25        STREAM_CLIENT_CONNECT // クライアントソケット接続を確立します
26    );
27
28    if (!$socket) {
29        echo "エラー: 接続できませんでした ({$errno}) {$errstr}\n";
30        return;
31    }
32
33    echo "接続成功。TLSv1.1 暗号化を有効にしています...\n";
34
35    // STREAM_CRYPTO_PROTO_TLSv1_1 を使用して、特定のTLSプロトコルバージョンを指定します。
36    // stream_socket_enable_crypto の crypto_method 引数には、
37    // STREAM_CRYPTO_METHOD_* 定数と組み合わせて使用するのが一般的です。
38    // ここでは、クライアントとしてTLSv1.1の使用を試みます。
39    $cryptoMethod = STREAM_CRYPTO_METHOD_TLS_CLIENT | STREAM_CRYPTO_PROTO_TLSv1_1;
40
41    // ソケットに対してSSL/TLS暗号化を有効にします。
42    // 第2引数が true の場合、暗号化を有効にしようとします。
43    // 戻り値:
44    //   true: 暗号化が成功した
45    //   false: 暗号化に失敗した
46    //   0: 暗号化ハンドシェイクが進行中 (非ブロッキングモードの場合)
47    $enableCryptoResult = stream_socket_enable_crypto(
48        $socket,
49        true, // 暗号化を有効にする
50        $cryptoMethod
51    );
52
53    if ($enableCryptoResult === true) {
54        echo "TLSv1.1 暗号化が正常に有効になりました。\n";
55
56        // 暗号化された接続を通じてHTTP GETリクエストを送信します。
57        $request = "GET / HTTP/1.1\r\nHost: {$host}\r\nConnection: Close\r\n\r\n";
58        fwrite($socket, $request);
59        echo "HTTP GET リクエストを送信しました。\n";
60
61        echo "受信した応答:\n";
62        // 応答を読み込み、表示します。
63        while (!feof($socket)) {
64            echo fgets($socket, 1024);
65        }
66
67    } elseif ($enableCryptoResult === 0) {
68        echo "TLSv1.1 暗号化ハンドシェイクが進行中です。\n";
69        // このブロッキングモードの例では、通常この状態は一時的です。
70    } else {
71        echo "エラー: TLSv1.1 暗号化を有効にできませんでした。\n";
72        // サーバーがTLSv1.1をサポートしていない場合、または証明書の問題などにより失敗する可能性があります。
73    }
74
75    // ソケット接続を閉じます。
76    fclose($socket);
77    echo "ソケットが閉じられました。\n";
78}
79
80// サンプルとして、PHPの公式サイト（HTTPS対応）に接続を試みます。
81// 注意: 多くのモダンなサーバーはTLSv1.1を非推奨としているため、
82// 接続に失敗したり、より新しいプロトコルにネゴシエートされる可能性があります。
83// このコードは STREAM_CRYPTO_PROTO_TLSv1_1 定数の使い方を示すためのものです。
84enableTls11ClientCrypto('www.php.net', 443);

このPHPのサンプルコードは、ネットワークソケットを介した通信で、特定のTLSプロトコルバージョン「TLSv1.1」を指定して暗号化を有効にする方法を示しています。

STREAM_CRYPTO_PROTO_TLSv1_1は、TLSv1.1プロトコルを表す整数値を返す定数です。この定数を使用することで、暗号化通信を行う際に使用するプロトコルバージョンを明示的に指定できます。現代ではセキュリティ上の理由からTLSv1.1の使用は非推奨ですが、特定のレガシーシステムとの互換性が必要な場合に指定可能です。

コードではまずstream_socket_client関数を使って非暗号化のソケット接続を確立します。その後、このソケットに対してstream_socket_enable_crypto関数を呼び出して暗号化を有効化しています。

stream_socket_enable_crypto関数は、指定されたソケット接続のSSL/TLS暗号化を有効にします。第1引数にはソケットリソース、第2引数には暗号化を有効にする場合はtrue、無効にする場合はfalseを指定します。第3引数crypto_methodには、暗号化のプロトコルバージョンや通信方向（クライアント/サーバー）を指定するための定数を組み合わせます。サンプルではSTREAM_CRYPTO_METHOD_TLS_CLIENTとSTREAM_CRYPTO_PROTO_TLSv1_1を組み合わせて、クライアントとしてTLSv1.1での暗号化を試みています。

この関数の戻り値は、暗号化の成否を示します。暗号化が成功した場合はtrue、失敗した場合はfalseを返し、非ブロッキングモードで暗号化ハンドシェイクが進行中の場合は0を返します。サンプルでは、暗号化成功後にHTTPリクエストを送信し、サーバーからの応答を受信・表示しています。多くのモダンなサーバーはTLSv1.1を非推奨としているため、この例は定数の使い方を示すためのものとしてご理解ください。

Copy
1<?php
2
3/**
4 * STREAM_CRYPTO_PROTO_TLSv1_1定数を使用して、
5 * TLSv1.1プロトコルを指定したセキュアなクライアント接続を試みるサンプル関数。
6 *
7 * この関数は、PHPのストリームコンテキストオプション `ssl.crypto_method` を介して、
8 * 特定のTLSプロトコルバージョンを指定する方法を示します。
9 *
10 * @param string $targetHost 接続先のホスト名またはIPアドレス (例: 'www.example.com')
11 * @param int $targetPort 接続先のポート番号 (例: 443)
12 * @return void
13 */
14function connectWithTls1_1(string $targetHost, int $targetPort): void
15{
16    echo "--- TLSv1.1 クライアント接続試行 ---" . PHP_EOL;
17
18    // ストリームコンテキストオプションを定義します。
19    // ここでSSL/TLSに関する設定を行います。
20    $contextOptions = [
21        'ssl' => [
22            // 使用するTLS/SSL暗号化メソッドを指定します。
23            // STREAM_CRYPTO_PROTO_TLSv1_1 はTLS 1.1プロトコルを指定する定数です (int型)。
24            // 注意: TLS 1.1は現在では多くのモダンなサーバーで非推奨または無効化されています。
25            // そのため、この指定では接続が成功しない可能性が高いです。
26            'crypto_method' => STREAM_CRYPTO_PROTO_TLSv1_1,
27
28            // デモ目的でサーバー証明書の検証を無効化しています。
29            // 本番環境ではセキュリティリスクとなるため、通常は 'true' に設定し、
30            // 適切なCA証明書を設定してサーバーの身元を検証する必要があります。
31            'verify_peer' => false,
32            'verify_peer_name' => false,
33        ],
34    ];
35
36    // 定義したオプションでストリームコンテキストを作成します。
37    $context = stream_context_create($contextOptions);
38
39    if (!$context) {
40        echo "エラー: ストリームコンテキストの作成に失敗しました。" . PHP_EOL;
41        return;
42    }
43
44    $remoteSocketAddress = "tls://{$targetHost}:{$targetPort}";
45    echo "接続先: {$remoteSocketAddress}" . PHP_EOL;
46
47    $errno = null; // エラーコードを格納する変数
48    $errstr = null; // エラーメッセージを格納する変数
49
50    // stream_socket_client を使用してセキュアなソケット接続を確立します。
51    // 第5引数に作成したコンテキストを渡すことで、定義したSSL/TLS設定が適用されます。
52    // `@` 演算子を使用してPHPの警告を抑制し、`$errno` と `$errstr` でエラー情報を取得します。
53    $socket = @stream_socket_client(
54        $remoteSocketAddress,
55        $errno,
56        $errstr,
57        30, // 接続タイムアウト (秒)
58        STREAM_CLIENT_CONNECT,
59        $context
60    );
61
62    if (!$socket) {
63        echo "接続失敗: [エラーコード: {$errno}] {$errstr}" . PHP_EOL;
64        echo "ヒント: 多くのモダンなサーバーはTLSv1.1をサポートしていません。" . PHP_EOL;
65        echo "このコードは STREAM_CRYPTO_PROTO_TLSv1_1 定数の具体的な使用方法を示すものです。" . PHP_EOL;
66        return;
67    }
68
69    echo "接続成功！ (証明書検証はデモ目的で無効化されています。)" . PHP_EOL;
70    // ここに実際の通信処理（例: データの送受信）を記述できます。
71    // 例: fwrite($socket, "GET / HTTP/1.0\r\nHost: {$targetHost}\r\n\r\n");
72    //     while (!feof($socket)) {
73    //         echo fgets($socket, 1024);
74    //     }
75
76    // 接続を閉じます。
77    fclose($socket);
78    echo "接続が閉じられました。" . PHP_EOL;
79}
80
81// サンプル使用例:
82// この例では、www.php.net へのTLSv1.1接続を試みます。
83// 多くのウェブサイトはTLSv1.1のサポートを終了しているため、接続は失敗する可能性が高いです。
84// これは STREAM_CRYPTO_PROTO_TLSv1_1 定数の使い方を示すためのコードであり、
85// 実際の接続成功を保証するものではありません。
86connectWithTls1_1('www.php.net', 443);

このPHPサンプルコードは、STREAM_CRYPTO_PROTO_TLSv1_1定数を利用して、特定のTLSプロトコルバージョンを指定したセキュアなクライアント接続を試みる方法を示しています。この定数はPHP 8で利用可能な整数値であり、ストリームコンテキストオプションのssl.crypto_methodに設定することで、通信にTLS 1.1プロトコルを使用するよう指示します。

connectWithTls1_1関数は、接続先のホスト名（$targetHost）とポート番号（$targetPort）を引数として受け取り、指定されたサーバーへのセキュアな接続を確立しようとします。関数内部では、stream_context_createを使ってSSL/TLSに関する設定を含むコンテキストを作成し、そのコンテキストをstream_socket_client関数に渡すことで、定義したプロトコル（TLS 1.1）でのソケット接続を試みます。STREAM_CRYPTO_PROTO_TLSv1_1定数自体は引数を取らず、その値は整数型（int）として返され、TLSプロトコルバージョンの識別子として使用されます。

ただし、現代の多くのサーバーはセキュリティ上の理由からTLS 1.1のサポートを終了しているため、このコードで接続を試みてもほとんどの場合で失敗する可能性が高いことに留意してください。このサンプルは、STREAM_CRYPTO_PROTO_TLSv1_1定数の具体的な利用方法を示すものであり、実際の接続成功を保証するものではありません。また、デモ目的でサーバー証明書の検証（verify_peer）を無効にしていますが、本番環境ではセキュリティリスクとなるため、この設定は避けるべきです。