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

Copy
1<?php
2
3/**
4 * クライアントとしてリモートサーバーへのSSL/TLS暗号化接続を確立するサンプル関数です。
5 * STREAM_CRYPTO_METHOD_ANY_CLIENT 定数を使用して、利用可能な任意の暗号化メソッドを許可します。
6 */
7function connectAndEnableCryptoClient(): void
8{
9    // 接続先ホストとポート
10    // www.example.com はテスト目的で利用可能な安全なドメインです。
11    $remoteAddress = 'tcp://www.example.com';
12    $port = 443; // HTTPSの標準ポート
13    $timeout = 30; // 接続タイムアウト (秒)
14
15    echo "{$remoteAddress}:{$port} への接続を試行中...\n";
16
17    // stream_socket_client() を使用して、まず生のTCPソケット接続を開きます。
18    // エラー番号とエラー文字列は参照渡しで受け取ります。
19    $socket = stream_socket_client(
20        "{$remoteAddress}:{$port}",
21        $errno,
22        $errstr,
23        $timeout
24    );
25
26    if (!$socket) {
27        // 接続失敗
28        echo "エラー: 接続失敗 - [{$errno}] {$errstr}\n";
29        return;
30    }
31
32    echo "接続成功。\n";
33    echo "ソケット上でSSL/TLS暗号化を有効化中...\n";
34
35    // stream_socket_enable_crypto() を使用して、ソケットストリーム上でSSL/TLS暗号化を有効にします。
36    // 第2引数: true はクライアントモードで暗号化を有効にすることを示します。
37    // 第3引数: STREAM_CRYPTO_METHOD_ANY_CLIENT は、クライアント側で利用可能な任意の暗号化メソッドを許可します。
38    $enabled = stream_socket_enable_crypto(
39        $socket,
40        true, // クライアントモード
41        STREAM_CRYPTO_METHOD_ANY_CLIENT
42    );
43
44    if ($enabled === true) {
45        // 暗号化の有効化が成功
46        echo "SSL/TLS暗号化がソケット上で正常に有効化されました。\n";
47        echo "これで、暗号化された通信チャネルを通じてデータを送受信できます。\n";
48
49        // 例: 簡単なHTTP GETリクエストを送信し、応答を読み込む
50        // (この例では実際のデータ送受信は省略します)
51        // $request = "GET / HTTP/1.1\r\nHost: www.example.com\r\nConnection: close\r\n\r\n";
52        // fwrite($socket, $request);
53        // while (!feof($socket)) {
54        //     echo fgets($socket, 1024);
55        // }
56
57    } elseif ($enabled === false) {
58        // 暗号化の有効化が失敗
59        echo "エラー: ソケット上でSSL/TLS暗号化を有効化できませんでした。\n";
60    } else {
61        // ネゴシエーションが進行中 (非ブロッキングモードでのみ発生する可能性が高い)
62        echo "SSL/TLS暗号化のネゴシエーションが進行中です。\n";
63    }
64
65    // 開いたソケットストリームを閉じます。
66    fclose($socket);
67    echo "ソケットを閉じました。\n";
68}
69
70// 関数を実行して、SSL/TLS接続を試行します。
71connectAndEnableCryptoClient();
72
73?>

このサンプルコードは、PHPを使用してリモートサーバーとの間でSSL/TLS暗号化接続を確立する基本的な方法を示しています。まず、stream_socket_client関数を使って、接続先ホストとポート番号を指定し、生のTCPソケット接続を確立します。この関数は、接続が成功すればソケットリソースを返し、失敗した場合はエラー番号とエラーメッセージを引数に設定します。

次に、接続が確立されたソケットに対し、stream_socket_enable_crypto関数を用いてSSL/TLS暗号化を有効にします。この関数の第2引数にtrueを設定することで、クライアントとして暗号化接続を確立するモードを指定します。そして第3引数にはSTREAM_CRYPTO_METHOD_ANY_CLIENT定数を指定します。この定数は、クライアント側で利用可能な任意のSSL/TLS暗号化メソッド（プロトコルや暗号スイート）を許可することを意味し、幅広い互換性を持って接続を試みる際に利用されます。stream_socket_enable_crypto関数は、暗号化の有効化が成功すればtrue、失敗すればfalse、非ブロッキングモードでネゴシエーションが進行中の場合は0を返します。暗号化が正常に有効化された後は、そのソケットを通じて安全にデータを送受信できるようになります。最後に、fclose関数で開いたソケットリソースを閉じて接続を終了します。

Copy
1<?php
2
3/**
4 * 指定されたホストとポートにTCP接続を確立し、
5 * STREAM_CRYPTO_METHOD_ANY_CLIENT を使用してSSL/TLS暗号化を有効にします。
6 * その後、簡単なHTTP GETリクエストを送信し、サーバーからの応答を表示します。
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * この関数は、ウェブサイトへの安全な接続（HTTPSなど）をPHPコードから確立する方法を示しています。
10 * STREAM_CRYPTO_METHOD_ANY_CLIENT は、クライアントとして接続する際に、
11 * 利用可能な任意の暗号化プロトコル（TLSv1.2, TLSv1.3など）をサーバーとネゴシエートするようPHPに指示する定数です。
12 * これにより、幅広いサーバーと互換性のあるセキュアな接続を試みることができます。
13 *
14 * @param string $host 接続するホスト名 (例: 'www.example.com')
15 * @param int $port 接続するポート番号 (HTTPSの標準ポートは443)
16 * @return void
17 */
18function connectWithSslClient(string $host, int $port): void
19{
20    // 接続先のアドレスを作成します。最初はプレーンなTCP接続を試みます。
21    $address = "tcp://{$host}:{$port}";
22    $errno = null; // 接続失敗時のエラーコードを格納する変数
23    $errstr = null; // 接続失敗時のエラーメッセージを格納する変数
24    $timeout = 30;   // 接続試行のタイムアウト時間（秒）
25
26    echo "{$host}:{$port} へのTCP接続を試行中...\n";
27    // stream_socket_client を使用して、指定されたアドレスへのTCPソケット接続を確立します。
28    // この段階では、まだ暗号化はされていません。
29    $socket = stream_socket_client($address, $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT);
30
31    if (!$socket) {
32        // 接続に失敗した場合、エラーメッセージを表示して関数を終了します。
33        echo "接続に失敗しました: {$errstr} ({$errno})\n";
34        return;
35    }
36    echo "{$host} へのTCP接続に成功しました。\n";
37
38    echo "STREAM_CRYPTO_METHOD_ANY_CLIENT を使用してSSL/TLS暗号化を有効にしています...\n";
39    // stream_socket_enable_crypto を使用して、確立したTCP接続をSSL/TLSで暗号化します。
40    // 第2引数 `true` は、暗号化を有効にすることを意味します。
41    // 第3引数 `STREAM_CRYPTO_METHOD_ANY_CLIENT` は、PHPがクライアントとして動作し、
42    // サーバーがサポートする任意の安全な暗号化メソッドを選択してハンドシェイクを行うよう指示します。
43    // これにより、様々なSSL/TLS設定のサーバーとの接続が柔軟に行えます。
44    $success = stream_socket_enable_crypto($socket, true, STREAM_CRYPTO_METHOD_ANY_CLIENT);
45
46    if (!$success) {
47        // SSL/TLS暗号化の有効化に失敗した場合、エラーメッセージを表示し、ソケットを閉じて終了します。
48        echo "SSL/TLS暗号化の有効化に失敗しました。接続は安全ではない可能性があります。\n";
49        fclose($socket);
50        return;
51    }
52    echo "SSL/TLS暗号化が正常に有効になりました。\n";
53
54    // 暗号化されたソケット接続を使用して、HTTP GETリクエストをサーバーに送信します。
55    $request = "GET / HTTP/1.1\r\n"; // HTTP/1.1 プロトコルでルートパスへのGETリクエスト
56    $request .= "Host: {$host}\r\n"; // 接続先のホスト名を指定
57    $request .= "Connection: close\r\n\r\n"; // リクエスト後に接続を閉じるよう指示
58
59    echo "HTTP GETリクエストを送信しています:\n";
60    fwrite($socket, $request); // ソケットにリクエスト文字列を書き込みます。
61
62    // サーバーからの応答を読み込みます。
63    echo "サーバーからの応答を読み込み中...\n";
64    $response = '';
65    // feof($socket) は、ソケット接続の終端に達したかどうかをチェックします。
66    // 終端に達するまで、fgets() でソケットからデータを4KBずつ読み込みます。
67    while (!feof($socket)) {
68        $response .= fgets($socket, 4096);
69    }
70
71    echo "受信した応答:\n";
72    // 初心者にも見やすいように、応答が長い場合は先頭500文字のみ表示し、省略記号を追加します。
73    echo substr($response, 0, 500) . (strlen($response) > 500 ? "\n[残りの応答は省略されました...]" : "") . "\n";
74
75    // 確立したソケット接続を閉じます。
76    fclose($socket);
77    echo "接続を閉じました。\n";
78}
79
80// この関数を呼び出して、実際のウェブサイト（www.example.com）のHTTPSポート(443)に接続してみます。
81// www.example.com は、テスト目的でよく利用されるドメインです。
82connectWithSslClient('www.example.com', 443);
83

このサンプルコードは、PHPで指定されたホストとポートに対し、安全なSSL/TLS暗号化接続を確立し、簡単なHTTP GETリクエストを送信して応答を受け取る方法を示しています。特にウェブサイトへのHTTPS接続をプログラムから行う際の基本を学ぶのに役立ちます。

STREAM_CRYPTO_METHOD_ANY_CLIENT は、PHPがクライアントとしてサーバーに接続する際、利用可能な任意のSSL/TLS暗号化プロトコル（TLSv1.2、TLSv1.3など）をサーバーと自動的にネゴシエートするよう指示する定数です。これにより、幅広いサーバーとの互換性を持たせた安全な通信を試みることができます。

コードではまず、stream_socket_client 関数を使用して指定されたホストとポートにTCP接続を確立します。その後、確立された接続に対して stream_socket_enable_crypto 関数を呼び出し、第二引数に true、第三引数に STREAM_CRYPTO_METHOD_ANY_CLIENT を指定することで、SSL/TLS暗号化を有効にします。暗号化が成功すると、暗号化されたチャネルを通じてHTTP GETリクエストを送信し、サーバーからの応答を読み込み、最後に接続を閉じます。

connectWithSslClient 関数は、接続先のホスト名 $host とポート番号 $port を引数として受け取ります。戻り値は void で、値を返さずに処理を完了します。この一連の処理により、システムエンジニアを目指す初心者の方も、PHPで安全なネットワーク通信を行う基本を理解できるでしょう。