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

Copy
1<?php
2
3/**
4 * この関数は、プレーンなTCP接続を確立し、STREAM_CRYPTO_METHOD_TLS_CLIENT を使用して
5 * その接続をTLS (Transport Layer Security) で暗号化する方法を示します。
6 *
7 * システムエンジニアを目指す初心者が、ネットワーク通信の暗号化の基本と、
8 * PHPでのTLSクライアント接続の確立方法を理解するのに役立ちます。
9 */
10function enableTlsClientCryptoExample(): void
11{
12    // 接続先のホスト名とTLS (HTTPS) の標準ポート
13    $host = 'www.google.com';
14    $port = 443;
15
16    // 1. まず、プレーンなTCP接続を確立します。
17    // stream_socket_client は、ネットワークソケットを作成し、接続を確立するために使用されます。
18    // "tcp://..." を指定することで、暗号化されていない通常のTCP接続を試みます。
19    // 5秒のタイムアウトを設定し、エラーコードとメッセージを $errno と $errstr に格納します。
20    $socket = stream_socket_client(
21        "tcp://{$host}:{$port}",
22        $errno,
23        $errstr,
24        5, // 接続タイムアウト (秒)
25        STREAM_CLIENT_CONNECT // 接続を確立するまで待機
26    );
27
28    if (!$socket) {
29        echo "エラー: TCP接続を確立できませんでした - ({$errno}) {$errstr}\n";
30        return;
31    }
32
33    echo "TCP接続成功: {$host}:{$port}\n";
34
35    // 2. 既存のTCP接続をTLSで暗号化（アップグレード）します。
36    // stream_socket_enable_crypto は、指定されたストリーム上でSSL/TLSを有効にします。
37    // 第2引数の `true` は暗号化を有効にすることを示します。
38    // 第3引数の `STREAM_CRYPTO_METHOD_TLS_CLIENT` は、クライアント側としてTLSプロトコルを使用して
39    // 暗号化をネゴシエートするようPHPに指示する定数です。
40    // この定数は、PHPのext/standardエクステンションに定義されており、利用可能な暗号化メソッドの一つです。
41    $enableCryptoResult = stream_socket_enable_crypto(
42        $socket,
43        true, // 暗号化を有効にする
44        STREAM_CRYPTO_METHOD_TLS_CLIENT
45    );
46
47    if ($enableCryptoResult === false) {
48        echo "エラー: TLS暗号化を有効にできませんでした。\n";
49        fclose($socket);
50        return;
51    } elseif ($enableCryptoResult === 0) {
52        // 非ブロッキングモードの場合、ネゴシエーションが進行中の可能性
53        // この例ではブロッキングモードなので、通常はすぐに `true` または `false` が返ります。
54        echo "TLS暗号化のネゴシエーションが進行中です (再試行が必要かもしれません)。\n";
55        fclose($socket);
56        return;
57    }
58
59    echo "TLS暗号化成功。安全な接続が確立されました。\n";
60
61    // 3. 暗号化された接続を通じてHTTP GETリクエストを送信し、応答を受信します。
62    $request = "GET / HTTP/1.1\r\n";
63    $request .= "Host: {$host}\r\n";
64    $request .= "Connection: Close\r\n\r\n"; // 接続を閉じることをサーバーに通知
65
66    fwrite($socket, $request);
67    echo "HTTP GETリクエストを送信しました。\n";
68
69    // サーバーからの応答を読み込みます。
70    echo "応答を受信中...\n";
71    $response = '';
72    while (!feof($socket)) {
73        $response .= fgets($socket, 1024); // 1024バイトずつ読み込み
74    }
75
76    echo "--- 応答の最初の500文字 --- \n";
77    echo htmlspecialchars(substr($response, 0, 500)) . "...\n";
78    echo "----------------------------\n";
79
80    // 4. ソケットを閉じます。
81    fclose($socket);
82    echo "ソケットを閉じました。\n";
83}
84
85// 関数を実行して、TLSクライアント接続の例を開始します。
86enableTlsClientCryptoExample();
87
88?>

このPHPサンプルコードは、セキュアなネットワーク通信の基本であるTLS（Transport Layer Security）クライアント接続を確立する方法を示しています。まず、stream_socket_client関数を使用して、指定されたホスト（例：www.google.com）の443番ポートにプレーンなTCP接続を確立します。

次に、この確立されたTCP接続を安全なTLS接続にアップグレードするため、stream_socket_enable_crypto関数を使用します。この関数の第3引数にSTREAM_CRYPTO_METHOD_TLS_CLIENT定数を指定します。この定数は、PHP 8のext/standardエクステンションに定義されており、クライアント側としてTLSプロトコルを用いて暗号化通信をネゴシエートするようPHPに指示するものです。この定数自体は引数を取りませんが、その戻り値はint型であり、PHP内部で利用可能なTLS暗号化メソッドを識別するために使われます。

stream_socket_enable_crypto関数は、暗号化が成功するとtrueを返し、失敗するとfalse、非ブロッキングモードでネゴシエーションが進行中の場合は0を返します。このサンプルでは、TLS暗号化が成功した後に、暗号化された接続上でHTTP GETリクエストを送信し、サーバーからの応答を受信します。これにより、インターネット上での安全なデータ交換がどのように行われるか、その基本的なメカニズムを理解できます。最終的にfcloseでソケットを閉じ、リソースを解放します。

Copy
1<?php
2
3/**
4 * TLSクライアントとして指定されたホストにセキュアな接続を試みます。
5 * PHPのSTREAM_CRYPTO_METHOD_TLS_CLIENT定数を使用して、TLSクライアント接続の
6 * 暗号化メソッドを設定する方法を示します。
7 *
8 * @param string $host 接続先ホスト名（例: "www.google.com"）
9 * @param int $port 接続先ポート番号（例: 443）
10 * @param int $timeout 接続タイムアウト（秒）
11 * @return void
12 */
13function connectTlsClient(string $host, int $port, int $timeout = 30): void
14{
15    $errno = 0;
16    $errstr = '';
17
18    // TLSクライアント接続のためのコンテキストオプションを設定します。
19    // STREAM_CRYPTO_METHOD_TLS_CLIENTは、クライアントとしてTLSプロトコルを使用して
20    // 暗号化接続を確立することを示します。これはビットマスクであり、
21    // 必要に応じて他のSTREAM_CRYPTO_METHOD定数（例: STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT）
22    // と組み合わせて使用することもできます。
23    $contextOptions = [
24        'ssl' => [
25            'crypto_method' => STREAM_CRYPTO_METHOD_TLS_CLIENT,
26            // サーバーの証明書検証を有効にします。本番環境では必須の設定です。
27            'verify_peer' => true,
28            'verify_peer_name' => true,
29            'allow_self_signed' => false,
30            // 信頼できるCA証明書のパスを指定します。
31            // 環境によってパスが異なるため、適切なパスに置き換える必要があります。
32            // 注: 'cafile'/'capath'を省略した場合、OpenSSLのデフォルト設定
33            // （通常はシステムの信頼できる証明書）が使用されます。
34            // ただし、環境によっては明示的な指定が推奨されます。
35            // 例: Linuxの場合 '/etc/ssl/certs/ca-certificates.crt'
36            // 例: Windowsの場合 XAMPPなどでは 'C:\xampp\php\extras\ssl\cacert.pem'
37            // 'cafile' => '/etc/ssl/certs/ca-certificates.crt',
38        ],
39    ];
40
41    // 設定したオプションでストリームコンテキストを作成します。
42    $context = stream_context_create($contextOptions);
43
44    echo "Attempting to connect to {$host}:{$port} with TLS client method...\n";
45
46    // stream_socket_client を使用して、指定されたホストとポートにソケット接続を確立します。
47    // 'ssl://' プレフィックスは、SSL/TLS接続を確立することをPHPに指示します。
48    // 第5引数にコンテキストリソースを渡すことで、上記のTLSクライアント設定が適用されます。
49    $socket = @stream_socket_client(
50        "ssl://{$host}:{$port}",
51        $errno,
52        $errstr,
53        $timeout,
54        STREAM_CLIENT_CONNECT,
55        $context
56    );
57
58    if (!$socket) {
59        echo "Failed to connect: [{$errno}] {$errstr}\n";
60        return; // 接続失敗時は処理を終了
61    }
62
63    echo "Successfully connected to {$host}:{$port} (TLS client).\n";
64
65    // 接続が確立されたら、ここでは簡単なHTTP GETリクエストを送信して応答を表示します。
66    $request = "GET / HTTP/1.1\r\nHost: {$host}\r\nConnection: Close\r\n\r\n";
67    fwrite($socket, $request);
68
69    echo "Response from server:\n";
70    while (!feof($socket)) {
71        echo fgets($socket, 1024);
72    }
73
74    // 接続を閉じます。
75    fclose($socket);
76    echo "Connection closed.\n";
77}
78
79// --- サンプル使用例 ---
80// GoogleのHTTPSポート(443)に接続を試みます。
81// このコードを実行するには、PHPがOpenSSL拡張を有効にしており、
82// システムに信頼されたCA証明書が正しく設定されている必要があります。
83connectTlsClient("www.google.com", 443);
84
85// ----------------------
86// 他の接続例（コメントアウトしてあります）
87// connectTlsClient("example.com", 443);
88// 存在しないホストへの接続試行（失敗例）
89// connectTlsClient("invalid-host.example.com", 443);

PHPのSTREAM_CRYPTO_METHOD_TLS_CLIENTは、クライアントとしてTLS (Transport Layer Security) プロトコルを用いたセキュアなネットワーク接続を確立するための整数型の定数です。この定数は引数を持たず、戻り値は整数型です。

サンプルコードは、この定数を用いてstream_socket_client関数でTLS接続を行う方法を示します。stream_context_create関数でストリームコンテキストを作成する際、sslオプションのcrypto_methodにSTREAM_CRYPTO_METHOD_TLS_CLIENTを指定します。これにより、クライアント側でTLSプロトコルが適用され、通信が暗号化されます。

connectTlsClient関数は、接続先ホスト名、ポート番号、タイムアウトを引数とし、TLS接続を試みます。処理結果は標準出力に表示され、関数は値を返しません（void）。安全な接続には、サーバー証明書検証の有効化と、CA証明書パスの設定が重要です。