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

Copy
1<?php
2
3/**
4 * 確立されたソケット接続上でTLS 1.2プロトコルを使用して暗号化を有効にするサンプル関数。
5 *
6 * @param string $host 接続先のホスト名
7 * @param int $port 接続先のポート番号
8 * @return void
9 */
10function enableTls12CryptoOnSocket(string $host, int $port): void
11{
12    echo "{$host}:{$port} への接続を試行中...\n";
13
14    // 1. TCPソケット接続を確立します。
15    // 'tcp://' プレフィックスでプレーンなTCP接続を指定します。
16    // 接続に失敗した場合、$errno にエラー番号、$errstr にエラーメッセージが格納されます。
17    $socket = stream_socket_client("tcp://{$host}:{$port}", $errno, $errstr, 10);
18
19    if (!$socket) {
20        echo "エラー: {$host}:{$port} への接続に失敗しました: [{$errno}] {$errstr}\n";
21        return;
22    }
23
24    echo "{$host}:{$port} への接続に成功しました。TLS 1.2暗号化を有効にします...\n";
25
26    // 2. SSL/TLSコンテキストを作成し、TLS 1.2プロトコルを強制します。
27    // STREAM_CRYPTO_PROTO_TLSv1_2 定数を 'crypto_method' オプションで使用することで、
28    // 使用するTLSプロトコルのバージョンをTLS 1.2に限定します。
29    $sslContext = stream_context_create([
30        'ssl' => [
31            'crypto_method' => STREAM_CRYPTO_PROTO_TLSv1_2,
32            // 本番環境では、セキュリティのため以下のオプションは 'true' に設定し、
33            // 信頼できる証明書バンドル ('cafile' や 'capath') を指定することを強く推奨します。
34            // このサンプルでは、自己署名証明書などでも動作するように検証を無効にしています。
35            'verify_peer' => false,
36            'verify_peer_name' => false,
37        ]
38    ]);
39
40    // 3. 確立されたソケット上でTLS 1.2暗号化を有効化します。
41    // 第一引数: 確立されたソケットリソース。
42    // 第二引数: 暗号化を有効にするかどうか (true)。
43    // 第三引数: クライアントモードでのTLS暗号化を指定 (STREAM_CRYPTO_METHOD_TLS_CLIENT)。
44    // 第四引数: 作成したSSLコンテキストを渡し、TLS 1.2プロトコルを適用させます。
45    $cryptoEnabled = stream_socket_enable_crypto(
46        $socket,
47        true,
48        STREAM_CRYPTO_METHOD_TLS_CLIENT,
49        $sslContext
50    );
51
52    if ($cryptoEnabled === false) {
53        echo "エラー: ソケット上でTLS 1.2暗号化の有効化に失敗しました。\n";
54        fclose($socket);
55        return;
56    }
57
58    if ($cryptoEnabled === true) {
59        echo "TLS 1.2暗号化が正常に有効化されました。\n";
60        // ここで暗号化されたストリームを通じてデータの送受信が可能です。
61        // 例: HTTP/1.1のGETリクエストを送信し、レスポンスを受信する
62        // fwrite($socket, "GET / HTTP/1.1\r\nHost: {$host}\r\nConnection: Close\r\n\r\n");
63        // while (!feof($socket)) {
64        //     echo fgets($socket, 1024);
65        // }
66    } else {
67        // ノンブロッキングモードの場合、交渉中を示すことがあります。
68        // このサンプルはブロッキングモードなので、通常はここには到達しません。
69        echo "TLS 1.2暗号化の交渉が進行中です。\n";
70    }
71
72    // 接続を閉じます。
73    fclose($socket);
74    echo "接続を閉じました。\n";
75}
76
77// サンプル使用例: GoogleのHTTPSポートに接続し、TLS 1.2を強制します。
78// 実際には、対象サーバーがTLS 1.2をサポートしている必要があります。
79enableTls12CryptoOnSocket('www.google.com', 443);
80
81?>

このPHPサンプルコードは、システムエンジニアを目指す初心者の皆様が、PHPでセキュアな通信を実装する際の基本となる、TLS 1.2プロトコルを用いたソケット暗号化の手順を解説しています。

コードはまずstream_socket_client関数で、指定したホストとポートへ通常のTCPソケット接続を確立します。この関数は接続が成功するとソケットリソースを、失敗するとfalseを返し、エラー情報を変数に格納します。 次に、stream_context_create関数を使ってSSL/TLS通信の設定を行う「コンテキスト」を作成します。ここでSTREAM_CRYPTO_PROTO_TLSv1_2定数をcrypto_methodオプションに指定することで、通信にTLS 1.2プロトコルのみを強制的に使用するように設定しています。本番環境ではサーバー証明書の検証を有効にすべきですが、このサンプルでは学習のため無効にしています。 最後に、stream_socket_enable_crypto関数を呼び出し、確立済みのソケット上でTLS 1.2暗号化を有効にします。この関数は、暗号化対象のソケットリソース、有効化を示すtrue、通信モード（クライアント）、そして先ほど作成したSSLコンテキストを引数に取ります。処理が成功するとtrue、失敗するとfalse、非ブロッキングモードの場合は交渉中を示す0を返します。これにより、セキュアなデータの送受信が可能となり、最終的にfcloseで接続を閉じます。

Copy
1<?php
2
3/**
4 * TLSv1.2プロトコルを使用して、指定されたホストに安全なクライアント接続を確立し、HTTPリクエストを送受信します。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、特定のTLSプロトコルバージョン
7 * (STREAM_CRYPTO_PROTO_TLSv1_2) を用いた安全なネットワーク通信の基本を示します。
8 *
9 * @param string $host 接続先のホスト名 (例: 'www.example.com')
10 * @param int $port 接続先のポート番号 (例: 443 for HTTPS)
11 * @param string $request 送信するHTTPリクエスト文字列 (例: "GET / HTTP/1.1\r\nHost: example.com\r\nConnection: close\r\n\r\n")
12 * @return string|false サーバーからの応答、または接続・通信エラーの場合は false
13 */
14function connectAndCommunicateTlsV1_2(string $host, int $port, string $request)
15{
16    // 1. ストリームコンテキストのオプションを定義します。
17    //    'ssl' キーの下に、TLS/SSL接続に関する設定を記述します。
18    $contextOptions = [
19        'ssl' => [
20            // 'crypto_method' は、使用する暗号化メソッドとプロトコルバージョンを指定します。
21            // STREAM_CRYPTO_METHOD_TLS_CLIENT: クライアントモードでTLS暗号化を有効にします。
22            // STREAM_CRYPTO_PROTO_TLSv1_2: TLSv1.2プロトコルのみを使用するように強制します。
23            // これらの定数をビット OR (|) で組み合わせることで、特定のTLSバージョンを要求できます。
24            'crypto_method' => STREAM_CRYPTO_METHOD_TLS_CLIENT | STREAM_CRYPTO_PROTO_TLSv1_2,
25
26            // サーバー証明書を検証するかどうか。セキュリティのために 'true' を推奨します。
27            'verify_peer' => true,
28            // サーバーのホスト名が証明書と一致するかどうかを検証します。セキュリティのために 'true' を推奨します。
29            'verify_peer_name' => true,
30            // 自己署名証明書を許可するかどうか。本番環境では 'false' を推奨します。
31            'allow_self_signed' => false,
32            // CA証明書ファイルのパスを指定できます（通常はシステムのデフォルトが使用されます）。
33            // 例: 'cafile' => '/etc/ssl/certs/ca-certificates.crt',
34        ],
35    ];
36
37    // 2. 定義したオプションに基づいてストリームコンテキストを作成します。
38    $streamContext = stream_context_create($contextOptions);
39
40    // 3. stream_socket_client() を使用して、指定されたホストとポートにTLS接続を確立します。
41    //    "ssl://" プレフィックスを使用することで、PHPが自動的にSSL/TLSハンドシェイクを行います。
42    //    第2引数と第3引数でエラーコードとエラーメッセージを受け取ります。
43    //    第4引数は接続タイムアウト時間（秒）、第5引数はクライアントモード、第6引数で作成したコンテキストを渡します。
44    $socket = stream_socket_client(
45        "ssl://$host:$port",
46        $errno,
47        $errstr,
48        30, // タイムアウトを30秒に設定
49        STREAM_CLIENT_CONNECT,
50        $streamContext
51    );
52
53    // 接続に失敗した場合の処理
54    if (false === $socket) {
55        echo "エラー: 接続に失敗しました: $errstr ($errno)\n";
56        return false;
57    }
58
59    echo "情報: $host:$port に TLSv1.2 を使用して接続しました。\n";
60
61    // 4. 確立したソケットを通じてHTTPリクエストを送信します。
62    fwrite($socket, $request);
63
64    // 5. サーバーからの応答を読み込みます。
65    $response = '';
66    while (!feof($socket)) {
67        // ソケットから1024バイトずつデータを読み込み、応答に追記します。
68        $response .= fgets($socket, 1024);
69    }
70
71    // 6. 接続を閉じます。
72    fclose($socket);
73
74    return $response;
75}
76
77// --- 使用例 ---
78// 接続対象のホストとポート
79$targetHost = 'www.google.com';
80$targetPort = 443; // HTTPSの標準ポート
81
82// 送信する簡単なHTTP GETリクエスト
83$httpRequest = "GET / HTTP/1.1\r\nHost: $targetHost\r\nConnection: close\r\n\r\n";
84
85echo "情報: $targetHost:$targetPort への接続を試行しています...\n";
86$serverData = connectAndCommunicateTlsV1_2($targetHost, $targetPort, $httpRequest);
87
88if ($serverData !== false) {
89    echo "\n--- サーバー応答の冒頭500文字 --- \n";
90    echo substr($serverData, 0, 500) . "...\n";
91    echo "---------------------------------\n";
92} else {
93    echo "エラー: 接続またはデータ受信に失敗しました。\n";
94}

このサンプルコードは、PHPのSTREAM_CRYPTO_PROTO_TLSv1_2定数を使用し、特定のホストへTLSv1.2プロトコルで安全に接続し、HTTPリクエストを送受信する方法を示しています。connectAndCommunicateTlsV1_2関数は、$hostに指定された宛先（例: 'www.example.com'）と$port（例: 443）へ接続し、$requestで与えられたHTTPリクエストを送信します。

このコードの中心は、stream_context_create関数に渡すオプション設定です。特に'ssl'キー配下の'crypto_method'に、STREAM_CRYPTO_METHOD_TLS_CLIENTとSTREAM_CRYPTO_PROTO_TLSv1_2を組み合わせることで、クライアントモードでTLS暗号化を有効にし、さらに使用するプロトコルバージョンをTLSv1.2に限定しています。これにより、古い安全でないプロトコルが使用されるのを防ぎ、セキュリティを強化しています。

接続コンテキストが作成された後、stream_socket_client関数で実際のTLS接続が確立されます。成功するとソケットリソースが返され、fwriteでリクエストを送信し、fgetsでサーバーからの応答を読み取ります。最後にfcloseで接続を閉じます。関数はサーバーからの応答文字列を返すか、接続や通信に問題があった場合はfalseを返します。この一連の流れを通じて、システムエンジニアの初心者が安全なネットワーク通信の基本を理解できるように設計されています。