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

Copy
1<?php
2
3/**
4 * STREAM_CRYPTO_METHOD_TLS_SERVER 定数を使用してTLSサーバーを起動し、
5 * クライアントからの接続を受け入れて暗号化を有効にするサンプルコードです。
6 *
7 * このコードを実行するには、事前に'server.crt' (証明書ファイル) と
8 * 'server.key' (秘密鍵ファイル) をこのスクリプトと同じディレクトリに配置しておく必要があります。
9 * 自己署名証明書を生成するコマンドの例:
10 * openssl req -x509 -newkey rsa:2048 -keyout server.key -out server.crt -days 365 -nodes
11 */
12function runTlsServerExample(): void
13{
14    // 証明書ファイルと秘密鍵ファイルのパスを設定します。
15    // 実際の運用では、これらのパスは安全に管理されるべきです。
16    $certificateFile = __DIR__ . '/server.crt';
17    $privateKeyFile = __DIR__ . '/server.key';
18
19    // 証明書ファイルと秘密鍵ファイルが存在するか確認します。
20    if (!file_exists($certificateFile) || !file_exists($privateKeyFile)) {
21        echo "エラー: '{$certificateFile}' または '{$privateKeyFile}' が見つかりません。\n";
22        echo "TLSサーバーを起動するには、これらのファイルをカレントディレクトリに配置してください。\n";
23        echo "例: openssl req -x509 -newkey rsa:2048 -keyout server.key -out server.crt -days 365 -nodes\n";
24        return;
25    }
26
27    // SSL/TLSコンテキストオプションを設定します。
28    // 'local_cert' でサーバーの公開証明書、'local_pk' で秘密鍵を指定します。
29    // 'verify_peer' はクライアント証明書の検証を行うかを示します。
30    // サンプルでは簡略化のため false ですが、本番環境では通常 true に設定すべきです。
31    // 'allow_self_signed' は自己署名証明書を許可するかどうかを示します。
32    $contextOptions = [
33        'ssl' => [
34            'local_cert' => $certificateFile,
35            'local_pk' => $privateKeyFile,
36            'verify_peer' => false,
37            'allow_self_signed' => true,
38        ],
39    ];
40
41    // ストリームコンテキストを作成します。このコンテキストはサーバーソケットに適用されます。
42    $context = stream_context_create($contextOptions);
43
44    // TLSプロトコルを使用してサーバーソケットを作成し、ポート8000でリッスンを開始します。
45    // '0.0.0.0' は、すべてのネットワークインターフェースからの接続を受け入れることを意味します。
46    $serverSocket = stream_socket_server(
47        'tls://0.0.0.0:8000',
48        $errno,
49        $errstr,
50        STREAM_SERVER_BIND | STREAM_SERVER_LISTEN,
51        $context
52    );
53
54    if (!$serverSocket) {
55        echo "エラー: サーバーソケットの作成に失敗しました: ($errno) $errstr\n";
56        return;
57    }
58
59    echo "TLSサーバーが 'tls://0.0.0.0:8000' でリッスンを開始しました。\n";
60    echo "クライアントの接続を待機中...\n";
61
62    // 無限ループでクライアントからの接続を待機し、処理します。
63    while (true) {
64        // クライアントからの接続を受け入れます。
65        // タイムアウト -1 は、接続があるまで無限にブロックすることを意味します。
66        $clientSocket = stream_socket_accept($serverSocket, -1);
67
68        if (!$clientSocket) {
69            echo "警告: クライアント接続の受け入れに失敗しました。\n";
70            continue;
71        }
72
73        $peerName = stream_socket_get_name($clientSocket, true);
74        echo "クライアント '$peerName' が接続しました。\n";
75
76        // stream_socket_enable_crypto 関数を使用して、接続されたクライアントソケット上で
77        // TLSサーバーとして暗号化を有効にします。
78        // ここで STREAM_CRYPTO_METHOD_TLS_SERVER 定数を使用し、サーバーとして振る舞うことを指定します。
79        // 第二引数の 'true' は暗号化を有効にする（TLSハンドシェイクを開始する）ことを意味します。
80        $cryptoEnabled = stream_socket_enable_crypto(
81            $clientSocket,
82            true,
83            STREAM_CRYPTO_METHOD_TLS_SERVER
84        );
85
86        if ($cryptoEnabled === true) {
87            echo "クライアント '$peerName' とのTLS暗号化が成功しました。\n";
88            // TLSで暗号化されたストリームを通じてデータを送信します。
89            fwrite($clientSocket, "Hello from PHP TLS server! Your connection is encrypted.\n");
90            echo "暗号化されたメッセージをクライアント '$peerName' に送信しました。\n";
91
92            // クライアントからのデータを受信することも可能です（この例ではオプション）。
93            $data = fread($clientSocket, 1024);
94            if ($data !== false && $data !== '') {
95                echo "クライアント '$peerName' からの受信データ: " . trim($data) . "\n";
96            }
97        } elseif ($cryptoEnabled === false) {
98            echo "エラー: クライアント '$peerName' とのTLSハンドシェイクに失敗しました。\n";
99        } else {
100            // $cryptoEnabled が 0 の場合、ハンドシェイクが進行中であることを示します。
101            // (通常、非ブロッキングモードの場合に発生しますが、この例はブロッキングモードです。)
102            echo "情報: クライアント '$peerName' とのTLSハンドシェイクが進行中です。\n";
103        }
104
105        // クライアントソケットを閉じます。
106        fclose($clientSocket);
107        echo "クライアント '$peerName' との接続を閉じました。\n";
108    }
109
110    // 通常、この行には到達しませんが、プログラムが終了する際にはサーバーソケットも閉じられます。
111    // 必要に応じて、明示的に fclose($serverSocket); を呼び出すこともできます。
112}
113
114// サンプル関数を実行します。
115runTlsServerExample();

PHPの定数STREAM_CRYPTO_METHOD_TLS_SERVERは、ネットワーク通信を暗号化する際に、自身がTLS（Transport Layer Security）プロトコルのサーバー側として動作することを指定するために使用されます。この定数自体には引数や戻り値はありませんが、主にstream_socket_enable_crypto関数と組み合わせて利用されます。

このサンプルコードは、STREAM_CRYPTO_METHOD_TLS_SERVER定数を用いてTLSサーバーを構築し、クライアントからの暗号化された接続を受け入れる方法を示しています。最初に、stream_context_create関数でSSL/TLSに関するオプション（サーバー証明書や秘密鍵のパスなど）を設定したストリームコンテキストを作成します。その後、このコンテキストを使用してstream_socket_server関数でTLSプロトコルによるサーバーソケットを起動し、指定されたポートでクライアントからの接続を待ち受けます。

クライアントからの接続を受け入れた後、stream_socket_enable_crypto関数が呼び出され、この定数を第三引数に指定することで、接続されたソケット上でサーバーとしてTLSハンドシェイクを開始し、暗号化を有効にします。stream_socket_enable_crypto関数の第二引数にtrueを指定すると暗号化が有効化され、処理が成功するとtrueを、失敗するとfalseを、ハンドシェイクが進行中の場合は0を返します。暗号化が成功すれば、安全にデータを送受信できるようになります。このコードを実行するには、server.crtとserver.keyというサーバー証明書および秘密鍵ファイルが必要です。