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

Copy
1<?php
2
3/**
4 * PHPのSTREAM_CRYPTO_METHOD_ANY_SERVER定数と
5 * stream_socket_enable_crypto関数を使用して、
6 * 暗号化されたTCPソケットサーバーを構築するサンプルコード。
7 *
8 * このスクリプトを実行する前に、自己署名証明書ファイル (server.pem) が必要です。
9 * スクリプトと同じディレクトリに `server.pem` という名前で保存してください。
10 *
11 * 【server.pem の作成方法】
12 * 以下のコマンドをターミナルで実行してください（パスフレーズなしの証明書を生成します）。
13 * openssl req -new -x509 -days 365 -nodes -out server.pem -keyout server.pem -subj "/CN=localhost"
14 */
15
16// サーバーのホストアドレスとポート番号を定義
17$host = '127.0.0.1';
18$port = 12345;
19// 自己署名証明書ファイルへのパス (このスクリプトと同じディレクトリにあると仮定)
20$pemFile = __DIR__ . '/server.pem';
21
22// サーバー証明書ファイルが存在するか確認し、存在しない場合は作成方法を案内して終了
23if (!file_exists($pemFile)) {
24    die("エラー: サーバー証明書ファイルが見つかりません。\n" .
25        "スクリプトと同じディレクトリに 'server.pem' を配置してください。\n" .
26        "以下のコマンドを実行して自己署名証明書を作成できます。\n" .
27        "例: openssl req -new -x509 -days 365 -nodes -out server.pem -keyout server.pem -subj \"/CN=localhost\"\n");
28}
29
30// SSL/TLS接続のためのコンテキストオプションを設定
31// これにより、stream_socket_enable_crypto関数が証明書情報などを利用できます。
32$contextOptions = [
33    'ssl' => [
34        'local_cert'        => $pemFile,         // サーバー証明書ファイルへのパス
35        'allow_self_signed' => true,             // 自己署名証明書を許可 (開発およびテスト用途)
36        'verify_peer'       => false,            // クライアントからの証明書検証を無効化 (開発およびテスト用途)
37        // 'passphrase' => 'your_password',     // 証明書にパスフレーズがある場合、ここで指定
38    ],
39];
40
41// ストリームコンテキストを作成
42$context = stream_context_create($contextOptions);
43
44// TCPソケットサーバーを作成し、指定されたホストとポートでリッスンを開始
45// 'tcp://' スキームを使用し、接続自体は暗号化されていません。
46// 暗号化は後で stream_socket_enable_crypto で有効にします。
47$serverSocket = stream_socket_server(
48    "tcp://{$host}:{$port}",
49    $errno,   // エラー番号を格納する変数
50    $errstr,  // エラーメッセージを格納する変数
51    STREAM_SERVER_LISTEN, // ソケットをリッスンモードで作成
52    $context              // 作成したSSLコンテキストを渡す
53);
54
55// サーバーソケットの作成に失敗した場合の処理
56if (!$serverSocket) {
57    die("サーバーソケットの作成に失敗しました: ({$errno}) {$errstr}\n");
58}
59
60echo "サーバーが {$host}:{$port} でリッスン中です。\n";
61echo "クライアントからの接続を待機しています...\n";
62
63// クライアントからの接続を待機 (無期限待機)
64// 接続が確立されると、$clientSocket にクライアントとのソケットストリームが格納されます。
65$clientSocket = stream_socket_accept($serverSocket, -1, $peerName); // -1 は無期限待機
66
67// クライアント接続の受け入れに失敗した場合の処理
68if (!$clientSocket) {
69    echo "クライアント接続の受け入れに失敗しました。\n";
70    fclose($serverSocket); // サーバーソケットを閉じる
71    exit(1);
72}
73
74echo "クライアントが接続しました: {$peerName}\n";
75
76// 接続されたソケットでSSL/TLS暗号化を有効にする
77echo "SSL/TLS暗号化を有効にしています...\n";
78$enabled = stream_socket_enable_crypto(
79    $clientSocket,                      // 暗号化を有効にする対象のソケット
80    true,                               // 暗号化を有効にする (boolean enable)
81    STREAM_CRYPTO_METHOD_ANY_SERVER     // サーバー側で利用可能な任意の安全な暗号化プロトコルを選択
82);
83
84// SSL/TLS暗号化の有効化に失敗した場合の処理
85if (!$enabled) {
86    echo "SSL/TLS暗号化の有効化に失敗しました。\n";
87    // 詳細なエラー情報は stream_get_meta_data($clientSocket)['crypto'] などで確認できます。
88    fclose($clientSocket);
89    fclose($serverSocket);
90    exit(1);
91}
92
93echo "SSL/TLS暗号化が正常に有効になりました。\n";
94
95// 暗号化された接続を通じてクライアントからデータを読み取る
96// fread() はバイナリセーフな読み取り関数です。
97$data = fread($clientSocket, 1024); // 最大1024バイト読み取る
98if ($data === false) {
99    echo "データの読み取りに失敗しました。\n";
100} else {
101    echo "クライアントからの受信データ: \"" . trim($data) . "\"\n";
102}
103
104// 暗号化された接続を通じてクライアントに応答データを書き込む
105// fwrite() はバイナリセーフな書き込み関数です。
106$response = "こんにちは、PHPの暗号化されたサーバーです！";
107if (fwrite($clientSocket, $response) === false) {
108    echo "データの書き込みに失敗しました。\n";
109} else {
110    echo "クライアントに応答を送信しました: \"" . $response . "\"\n";
111}
112
113// クライアントとの接続を閉じる
114fclose($clientSocket);
115echo "クライアントとの接続を閉じました。\n";
116// サーバーソケットを閉じる
117fclose($serverSocket);
118echo "サーバーソケットを閉じました。\n";
119
120?>

このPHPサンプルコードは、PHP 8でSSL/TLS暗号化されたTCPソケットサーバーを構築する方法を示しています。サーバーは指定されたポートで接続を待ち受け、クライアントからの接続を受け付けた後に暗号化を適用し、安全な通信を行います。

まず、サーバー証明書ファイル（server.pem）を用意し、SSL/TLS接続に必要な設定を定義したストリームコンテキストを作成します。次に、stream_socket_server関数でTCPソケットサーバーを起動し、クライアントからの接続を受け入れます。

接続が確立された後、重要なのはstream_socket_enable_crypto関数です。この関数は、すでに確立された通常のTCP接続に対し、SSL/TLS暗号化を有効にする役割があります。第一引数で暗号化したいソケットストリームを指定し、第二引数にtrueを渡すことで暗号化を有効にします。そして、第三引数にSTREAM_CRYPTO_METHOD_ANY_SERVER定数を指定します。この定数は、サーバーとして利用可能な任意の安全な暗号化プロトコルを柔軟に選択することを意味します。stream_socket_enable_crypto関数の戻り値は、暗号化が正常に有効化された場合はtrue、失敗した場合はfalse、処理がブロックされた場合は0を返します。

暗号化が成功すると、以降のデータ送受信は安全なSSL/TLSチャネルを通じて行われます。これにより、送受信されるデータは盗聴や改ざんから保護されます。サンプルコードでは、暗号化された接続でクライアントからのデータを受信し、応答を送信した後、接続を閉じます。

Copy
1<?php
2
3/**
4 * セキュアなサーバーへ接続し、HTTP GET リクエストを送信するクライアントの例。
5 * STREAM_CRYPTO_METHOD_ANY_SERVER 定数を使用して、接続先のサーバーがサポートする
6 * 任意の暗号化メソッド（SSL/TLSバージョン）を受け入れるように設定します。
7 */
8function connectToSecureServer(): void
9{
10    // 接続先ホストとポート
11    // セキュアな接続のため 'ssl://' プレフィックスを使用
12    $host = 'ssl://www.example.com';
13    $port = 443; // HTTPSの標準ポート
14    $timeout = 10; // 接続タイムアウト秒数
15
16    // エラー情報を格納する変数
17    $errno = 0;
18    $errstr = '';
19
20    // ストリームコンテキストオプションを作成
21    // SSL/TLS接続の設定を行います。
22    $contextOptions = [
23        'ssl' => [
24            // STREAM_CRYPTO_METHOD_ANY_SERVER: サーバーがサポートする任意の
25            // 暗号化メソッド（TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3など）を受け入れます。
26            // これにより、幅広いサーバーと互換性のある接続を試みることができます。
27            'crypto_method' => STREAM_CRYPTO_METHOD_ANY_SERVER,
28
29            // 以下は開発・学習目的で検証を無効にしていますが、
30            // 本番環境ではセキュリティのため常に有効（true）にすることを強く推奨します。
31            'allow_self_signed' => true, // 自己署名証明書を許可
32            'verify_peer' => false,      // ピア（サーバー）の証明書を検証しない
33            'verify_peer_name' => false, // ピア（サーバー）のホスト名を検証しない
34        ],
35    ];
36
37    // ストリームコンテキストを作成
38    $context = stream_context_create($contextOptions);
39
40    // stream_socket_client() を使用してセキュアなソケット接続を確立します。
41    // 第5引数 (STREAM_CLIENT_CONNECT) は、クライアントソケット接続モードを指定します。
42    // 第6引数 ($context) には、作成したSSL/TLSコンテキストを渡します。
43    $socket = stream_socket_client(
44        "{$host}:{$port}",
45        $errno,
46        $errstr,
47        $timeout,
48        STREAM_CLIENT_CONNECT,
49        $context
50    );
51
52    // 接続に失敗した場合のエラーハンドリング
53    if (!$socket) {
54        echo "エラー: セキュアなサーバーに接続できませんでした ({$errno}): {$errstr}\n";
55        return;
56    }
57
58    echo "セキュアなサーバー '{$host}' に接続しました。\n";
59
60    // HTTP GET リクエストを構築
61    // ホスト名には 'ssl://' を含まないオリジナルのホスト名を使用します。
62    $request = "GET / HTTP/1.1\r\n";
63    $request .= "Host: " . str_replace('ssl://', '', $host) . "\r\n";
64    $request .= "Connection: Close\r\n\r\n"; // 接続を閉じることを要求
65
66    // リクエストをソケットに書き込む
67    fwrite($socket, $request);
68    echo "HTTP GET リクエストを送信しました。\n\n";
69
70    // サーバーからの応答を読み込み、表示する
71    echo "--- サーバーからの応答開始 ---\n";
72    while (!feof($socket)) {
73        echo fgets($socket, 1024); // 1024バイトずつ読み込む
74    }
75    echo "--- サーバーからの応答終了 ---\n";
76
77    // ソケット接続を閉じる
78    fclose($socket);
79    echo "\n接続を閉じました。\n";
80}
81
82// 関数を実行して、セキュアなサーバーへの接続とリクエストの送受信を試みる
83connectToSecureServer();

STREAM_CRYPTO_METHOD_ANY_SERVERは、PHPで安全なネットワーク通信（SSL/TLS接続）を行う際に、クライアントが接続先のサーバーと交渉する暗号化メソッド（SSL/TLSのバージョンや方式）を指定するための定数です。この定数自体は引数を持たず、整数値（int）を返します。

提供されたサンプルコードは、PHPのstream_socket_client関数を用いてHTTPSのようなセキュアなサーバーへ接続し、HTTP GETリクエストを送信するクライアントの例です。特に、stream_context_create関数でSSL/TLS接続の設定を行う際に、'crypto_method' => STREAM_CRYPTO_METHOD_ANY_SERVERと指定している点が重要です。

この設定により、クライアントは接続先のサーバーがサポートする任意の暗号化メソッド（例えば、TLSv1.0からTLSv1.3までなど）を受け入れるようになります。これにより、幅広いサーバー環境との互換性が向上し、セキュアな接続を確立しやすくなります。システムエンジニアを目指す上では、安全な通信プロトコルを適切に扱う知識が不可欠です。

なお、サンプルコードでは学習目的でサーバー証明書の検証（verify_peerなど）を無効にしていますが、実際のシステム開発においては、セキュリティ保護のためこれらの検証を常に有効（true）に設定し、通信相手の正当性を確認することが強く推奨されます。