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

Copy
1<?php
2
3/**
4 * Demonstrates how to enable TLS encryption on a socket using stream_socket_enable_crypto
5 * with the STREAM_CRYPTO_PROTO_TLSv1_0 constant.
6 *
7 * This function attempts to connect to an HTTPS server (e.g., Google.com) on its default port (443)
8 * using a raw TCP connection first, then explicitly upgrades the connection to TLS using
9 * stream_socket_enable_crypto and the STREAM_CRYPTO_PROTO_TLSv1_0 protocol.
10 *
11 * IMPORTANT NOTE FOR BEGINNERS:
12 * TLSv1.0 is an old and insecure protocol version, largely deprecated by modern servers
13 * like Google.com for security reasons. This example uses STREAM_CRYPTO_PROTO_TLSv1_0
14 * specifically because it was requested in the reference. In real-world applications,
15 * you should use newer, more secure protocols like STREAM_CRYPTO_PROTO_TLSv1_2 or
16 * STREAM_CRYPTO_PROTO_TLSv1_3 (available in PHP 8.1+) to ensure secure communication.
17 * This example might fail to enable TLS due to the server not supporting TLSv1.0.
18 */
19function enableTlsCryptoExample(): void
20{
21    $host = 'www.google.com'; // Target server (e.g., Google.com)
22    $port = 443;               // HTTPS default port
23    $address = "tcp://{$host}:{$port}"; // Address for raw TCP connection
24
25    $socket = null;
26    $errno = 0;
27    $errstr = '';
28
29    echo "Attempting to establish a raw TCP connection to {$address}...\n";
30
31    // 1. Establish a raw TCP connection to the HTTPS port.
32    // '@' suppresses PHP warnings/errors, allowing manual error handling.
33    $socket = @stream_socket_client(
34        $address,
35        $errno,
36        $errstr,
37        30, // Timeout in seconds
38        STREAM_CLIENT_CONNECT
39    );
40
41    if (!$socket) {
42        echo "Error: Failed to establish raw TCP connection to {$host}:{$port}. ({$errno}) {$errstr}\n";
43        return;
44    }
45
46    echo "Successfully established raw TCP connection. Now attempting to enable TLS crypto...\n";
47
48    // 2. Enable TLS encryption on the connected socket using the specified protocol.
49    // We explicitly use STREAM_CRYPTO_PROTO_TLSv1_0 as requested.
50    // Modern servers typically no longer support TLSv1.0.
51    $cryptoEnabled = stream_socket_enable_crypto(
52        $socket,
53        true, // Set to true to enable encryption
54        STREAM_CRYPTO_PROTO_TLSv1_0 // Specify the TLSv1.0 protocol constant
55    );
56
57    if ($cryptoEnabled === false) {
58        echo "Error: Failed to enable TLS crypto on the socket using TLSv1.0.\n";
59        echo "This is likely because {$host} no longer supports the outdated TLSv1.0 protocol for security reasons.\n";
60        echo "In a real-world scenario, always prefer more modern protocols like TLSv1_2 or TLSv1_3.\n";
61    } elseif ($cryptoEnabled === 0) {
62        // For blocking sockets (as used here), this usually indicates an immediate failure
63        // or a pending handshake in a non-blocking context.
64        echo "Warning: TLS handshake is pending or failed immediately without a clear error.\n";
65        echo "This could also indicate a protocol mismatch or server rejection of TLSv1.0.\n";
66    } else { // $cryptoEnabled === true
67        echo "TLS crypto successfully enabled using STREAM_CRYPTO_PROTO_TLSv1_0.\n";
68
69        // If encryption was successfully enabled, you could now perform secure communication.
70        // For demonstration, we'll try to send a simple HTTP GET request.
71        $request = "GET / HTTP/1.1\r\nHost: {$host}\r\nConnection: close\r\n\r\n";
72        fwrite($socket, $request);
73        echo "Sent an HTTP GET request over the secure connection.\n";
74
75        echo "Reading response (first 512 bytes)...\n";
76        // Attempt to read the response. If TLS handshake truly failed, this might hang or return garbage.
77        $response = stream_get_contents($socket);
78        if ($response !== false && strlen($response) > 0) {
79            echo "Received response snippet:\n";
80            echo substr($response, 0, 512) . "...\n";
81        } else {
82            echo "Failed to read response or received empty response from the secure connection.\n";
83        }
84    }
85
86    // 3. Close the socket resource to release system resources.
87    fclose($socket);
88    echo "Socket closed.\n";
89}
90
91// Execute the demonstration function.
92enableTlsCryptoExample();

STREAM_CRYPTO_PROTO_TLSv1_0はPHPでネットワーク通信をTLSv1.0プロトコルで暗号化する際に使用する定数です。この定数自体に引数や戻り値はありませんが、stream_socket_enable_crypto関数などの引数として指定することで、ソケット通信の暗号化方式を制御します。

このサンプルコードは、まずstream_socket_client関数を使って、ターゲットホスト（例：www.google.com）のHTTPSポート（443番）へ生のTCP接続を確立します。次に、確立したソケットに対してstream_socket_enable_crypto関数を呼び出し、暗号化を有効にする設定（true）と、暗号化プロトコルとしてSTREAM_CRYPTO_PROTO_TLSv1_0定数を指定して、TLS暗号化の有効化を試みています。

stream_socket_enable_crypto関数は、暗号化が成功すればtrueを、失敗すればfalseを、処理が保留中の場合は0を返します。しかし、STREAM_CRYPTO_PROTO_TLSv1_0はセキュリティ上の脆弱性がある古いプロトコルであり、現代の多くのウェブサーバーではサポートが終了しています。そのため、このコードを実行してもTLS暗号化の有効化に失敗する可能性が高いことを示しています。実際のシステムでは、STREAM_CRYPTO_PROTO_TLSv1_2やSTREAM_CRYPTO_PROTO_TLSv1_3といった、より新しい安全なプロトコルを使用することが強く推奨されます。TLS有効化後には簡単なHTTP GETリクエストを送信し、最後にソケットを閉じています。

Copy
1<?php
2
3/**
4 * TLSv1.0 プロトコルを使用してHTTPSサーバーに接続するサンプル関数。
5 *
6 * この関数は、PHPのストリームコンテキストオプションと
7 * STREAM_CRYPTO_PROTO_TLSv1_0 定数を使用して、特定のTLSプロトコルバージョンを
8 * 強制的に指定する方法を示します。
9 *
10 * 注意: TLSv1.0 は現代では非推奨であり、セキュリティリスクがあるため、
11 * 本番環境での使用は避けるべきです。また、ほとんどの最新のサーバーは
12 * TLSv1.0での接続を拒否します。
13 *
14 * @param string $host 接続先ホスト名 (例: 'www.php.net')
15 * @param int $port 接続先ポート番号 (通常HTTPSは443)
16 * @return void
17 */
18function connectWithTlsV10(string $host, int $port = 443): void
19{
20    // ストリームコンテキストオプションを設定します。
21    // ここで、SSL/TLS接続の挙動を詳細に制御します。
22    $contextOptions = [
23        'ssl' => [
24            // 'verify_peer' と 'verify_peer_name' は、サーバー証明書の検証に関する設定です。
25            // 本来はセキュリティのためにtrueにすべきですが、この例ではデモンストレーションのため
26            // および、多くのサーバーがTLSv1.0を拒否するため接続エラーになりやすいことから、
27            // 一時的にfalseに設定しています。本番環境では必ずtrueに設定してください。
28            'verify_peer' => false,
29            'verify_peer_name' => false,
30            'allow_self_signed' => true, // 自己署名証明書を許可 (本番環境では非推奨)
31
32            // 'crypto_method' オプションで、暗号化方式とプロトコルバージョンを指定します。
33            // STREAM_CRYPTO_METHOD_TLS_CLIENT: クライアントとしてTLS暗号化を有効化します。
34            // STREAM_CRYPTO_PROTO_TLSv1_0: TLSv1.0 プロトコルバージョンを明示的に指定します。
35            // これらの定数はビットOR演算子 (|) で結合して使用できます。
36            'crypto_method' => STREAM_CRYPTO_METHOD_TLS_CLIENT | STREAM_CRYPTO_PROTO_TLSv1_0,
37        ],
38    ];
39
40    // 設定したオプションでストリームコンテキストを作成します。
41    $context = stream_context_create($contextOptions);
42
43    echo "Attempting to connect to {$host}:{$port} using TLSv1.0...\n";
44
45    // stream_socket_client() を使用してソケット接続を確立します。
46    // 第1引数の "tls://{$host}:{$port}" は、TLSプロトコルを使用した接続を意味します。
47    // 第4引数に作成したコンテキストを渡すことで、上記のSSL/TLS設定が適用されます。
48    $client = @stream_socket_client(
49        "tls://{$host}:{$port}", // 接続アドレス (TLSスキームを使用)
50        $errno,                  // エラー番号が格納される変数
51        $errstr,                 // エラーメッセージが格納される変数
52        30,                      // 接続タイムアウト (秒)
53        STREAM_CLIENT_CONNECT,   // クライアントソケット接続モード
54        $context                 // 作成したストリームコンテキスト
55    );
56
57    // 接続に失敗した場合
58    if (!$client) {
59        echo "Error: Could not connect to {$host}:{$port} with TLSv1.0.\n";
60        echo "Reason: [{$errno}] {$errstr}\n";
61        echo "Note: Many modern servers no longer support TLSv1.0 due to security vulnerabilities. " .
62             "Consider using a more modern TLS version (e.g., TLSv1.2 or TLSv1.3) by default.\n";
63        return;
64    }
65
66    echo "Successfully connected to {$host} using TLSv1.0.\n";
67
68    // 接続が成功したら、簡単なHTTP GETリクエストを送信します。
69    $request = "GET / HTTP/1.0\r\nHost: {$host}\r\nConnection: Close\r\n\r\n";
70    fwrite($client, $request);
71    echo "Sent HTTP GET request.\n";
72
73    // サーバーからの応答を読み込み、出力します。
74    echo "Reading response...\n";
75    while (!feof($client)) {
76        echo fgets($client, 1024);
77    }
78    echo "\nResponse complete.\n";
79
80    // 接続を閉じます。
81    fclose($client);
82    echo "Connection closed.\n";
83}
84
85// サンプル実行:
86// 多くの現代のウェブサーバーはTLSv1.0をサポートしておらず、
87// この接続は失敗する可能性が高いです。
88// これは、STREAM_CRYPTO_PROTO_TLSv1_0 の使用方法を示すためのものです。
89connectWithTlsV10('www.php.net', 443);
90
91?>

このPHPサンプルコードは、PHPのストリームコンテキスト設定において、特定のTLSプロトコルバージョンであるTLSv1.0を明示的に指定してHTTPSサーバーに接続する方法を示しています。STREAM_CRYPTO_PROTO_TLSv1_0は、この目的のために使用される定数です。

コード内のconnectWithTlsV10関数は、接続先のホスト名（$host）とポート番号（$port）を引数にとります。関数内部では、stream_context_create関数を用いてSSL/TLS接続の詳細なオプションを設定する「ストリームコンテキスト」を作成します。この際、'ssl'オプションの'crypto_method'キーにSTREAM_CRYPTO_METHOD_TLS_CLIENT定数とSTREAM_CRYPTO_PROTO_TLSv1_0定数をビットOR演算子（|）で結合して指定することで、クライアントとしてTLSv1.0での暗号化通信を試みるよう設定されます。

次に、設定されたコンテキストをstream_socket_client関数に渡すことで、指定されたホストへソケット接続を確立します。接続に成功すると、簡単なHTTP GETリクエストを送信し、サーバーからの応答を読み込んで表示します。この関数は直接の戻り値がなく（void）、処理の成否やサーバーからの応答を標準出力に示します。

ただし、TLSv1.0は現代においてセキュリティ上の脆弱性があるため非推奨であり、多くのウェブサーバーはこのプロトコルでの接続を拒否します。このサンプルコードはSTREAM_CRYPTO_PROTO_TLSv1_0の使用方法を示すためのものであり、本番環境ではより新しい安全なTLSバージョン（例: TLSv1.2、TLSv1.3）を使用することが強く推奨されます。