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

Copy
1<?php
2
3/**
4 * プロキシ経由でSSLクライアント証明書の秘密鍵を使用するcURLリクエストの例を示します。
5 *
6 * CURLOPT_PROXY_SSLKEY は、プロキシサーバーへの接続（トンネリング）に使用する
7 * クライアントSSL証明書の秘密鍵のパスを設定します。
8 * これは、プロキシサーバー自体がクライアント認証を要求するHTTPSプロキシである場合に必要となります。
9 * ターゲットURLへの接続ではなく、プロキシサーバーへの接続時に使用されます。
10 *
11 * このサンプルコードは、設定方法を示すことを目的としています。
12 * 実際に動作させるには、有効なプロキシホスト、ポート、および指定されたパスに存在する
13 * 有効なクライアントSSL秘密鍵ファイルが必要です。
14 */
15function demonstrateCurloptProxySslKey(): void
16{
17    // cURLセッションを初期化
18    $ch = curl_init();
19
20    // --- プロキシ設定のためのプレースホルダー ---
21    // ご自身の環境に合わせて以下の値を変更してください。
22    // 実際に動作させるには、適切なプロキシサーバーとSSL秘密鍵ファイルが必要です。
23    $proxyHost = 'your_proxy_host.example.com'; // 例: '192.168.1.1' や 'proxy.example.com'
24    $proxyPort = 8080;                         // 例: 8080, 3128, 443 など
25
26    // プロキシ接続に使用するクライアントSSL秘密鍵のパス
27    // 例: '/etc/ssl/private/proxy_client_key.pem'
28    // このパスに秘密鍵ファイルが存在しない場合、cURLエラーが発生します。
29    $proxySslKeyPath = '/path/to/your/proxy_client_ssl_key.pem';
30
31    // --- cURLオプションの設定 ---
32    // アクセス対象のURL
33    curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/');
34    // 実行結果を文字列として返すように設定
35    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
36
37    // プロキシホストとポートを設定
38    curl_setopt($ch, CURLOPT_PROXY, $proxyHost);
39    curl_setopt($ch, CURLOPT_PROXYPORT, $proxyPort);
40
41    // プロキシサーバーへの接続にクライアントSSL秘密鍵を使用する場合、そのパスを設定します。
42    // CURLOPT_PROXY_SSLKEY の値は、秘密鍵ファイルの絶対パスです。
43    curl_setopt($ch, CURLOPT_PROXY_SSLKEY, $proxySslKeyPath);
44
45    // プロキシ経由でHTTPSターゲットに接続する場合、HTTPプロキシトンネルを使用することが一般的です。
46    // これを設定しないと、プロキシサーバーが単なるHTTPプロキシとして振る舞う可能性があります。
47    curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, true);
48
49    // （オプション）秘密鍵のタイプを指定する場合 (デフォルトはPEM)
50    // curl_setopt($ch, CURLOPT_PROXY_SSLKEYTYPE, 'PEM');
51    // （オプション）秘密鍵がパスフレーズで保護されている場合
52    // curl_setopt($ch, CURLOPT_PROXY_SSLKEYPASSWD, 'your_key_password');
53
54    // --- リクエストの実行と結果の処理 ---
55    $response = curl_exec($ch);
56
57    if (curl_errno($ch)) {
58        // エラーが発生した場合
59        echo "cURLエラーが発生しました: " . curl_error($ch) . PHP_EOL;
60        echo "エラーコード: " . curl_errno($ch) . PHP_EOL;
61    } else {
62        // 成功した場合
63        echo "cURLリクエストが成功しました（プロキシ経由）！" . PHP_EOL;
64        echo "HTTPステータスコード: " . curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL;
65        // レスポンスボディは非常に長くなる可能性があるため、最初の500文字のみ表示
66        echo "レスポンスの最初の500文字: " . substr((string)$response, 0, 500) . "..." . PHP_EOL;
67    }
68
69    // cURLセッションを閉じる
70    curl_close($ch);
71}
72
73// 関数を実行してデモンストレーションを開始
74demonstrateCurloptProxySslKey();

PHPのCURLOPT_PROXY_SSLKEY定数は、cURL拡張機能において、プロキシサーバーへの接続時に使用するクライアントSSL証明書の秘密鍵のパスを指定するために利用されます。このオプションは、ターゲットのWebサイトへ接続するのではなく、プロキシサーバー自体がクライアント認証を要求するHTTPSプロキシである場合に、プロキシサーバーとの間にセキュアなトンネルを確立するために必要となります。

サンプルコードでは、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLでアクセス対象のURLを設定します。次に、CURLOPT_PROXYとCURLOPT_PROXYPORTでプロキシサーバーのホスト名とポート番号を設定します。そして、CURLOPT_PROXY_SSLKEYにプロキシ接続用のクライアントSSL秘密鍵ファイルの絶対パス（文字列）を設定しています。プロキシ経由でHTTPSターゲットにアクセスする場合に一般的に必要なCURLOPT_HTTPPROXYTUNNELも有効にしています。これらの設定後、curl_exec()でリクエストを実行し、その結果を処理する流れを示しています。

この定数自体は引数を取らず、戻り値もありませんが、curl_setopt()関数のオプションとして使用することで、cURLリクエストの挙動を設定します。実際にこのコードを動作させるには、適切なプロキシサーバー情報と、指定されたパスに有効な秘密鍵ファイルが存在する必要があります。

Copy
1<?php
2
3/**
4 * プロキシ経由でHTTPS URLにアクセスし、プロキシへの接続にクライアント証明書を使用し、
5 * ターゲットサーバーへのSSL/TLSバージョンを指定するサンプル関数。
6 *
7 * システムエンジニアを目指す初心者向けに、CURLOPT_PROXY_SSLKEYとCURLOPT_SSLVERSIONの使用例を示します。
8 * このコードはPHP 8の推奨コーディングスタイルに従っています。
9 *
10 * @param string $targetUrl アクセスするターゲットURL (例: 'https://example.com/api')
11 * @param string $proxyHost プロキシサーバーのホスト名またはIPアドレス (例: 'your-proxy.com')
12 * @param int $proxyPort プロキシサーバーのポート番号 (例: 8080)
13 * @param string $proxyClientCertPath プロキシへのクライアント認証に使用する証明書ファイルのパス (例: '/path/to/proxy_client.crt')
14 * @param string $proxyClientKeyPath プロキシへのクライアント認証に使用する秘密鍵ファイルのパス (例: '/path/to/proxy_client.key')
15 * @return string|false 成功した場合はレスポンスボディ、失敗した場合は false
16 */
17function fetchUrlWithProxyClientCertAndSslVersion(
18    string $targetUrl,
19    string $proxyHost,
20    int $proxyPort,
21    string $proxyClientCertPath,
22    string $proxyClientKeyPath
23): string|false {
24    $ch = curl_init();
25
26    if ($ch === false) {
27        // cURLセッションの初期化に失敗した場合
28        return false;
29    }
30
31    // ターゲットURLを設定
32    curl_setopt($ch, CURLOPT_URL, $targetUrl);
33
34    // プロキシサーバーを設定
35    curl_setopt($ch, CURLOPT_PROXY, $proxyHost);
36    curl_setopt($ch, CURLOPT_PROXYPORT, $proxyPort);
37    // プロキシタイプをHTTPに設定（SOCKSプロキシの場合はCURLPROXY_SOCKS5など）
38    curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
39
40    // CURLOPT_PROXY_SSLKEY: プロキシへの接続にクライアント認証が必要な場合の秘密鍵ファイルパス
41    // このオプションは、プロキシ自体がSSL/TLSを使用し、クライアント証明書による認証を要求する場合に利用します。
42    // 注意: 実際の秘密鍵ファイル（例: '/path/to/proxy_client.key'）が存在し、
43    // PHPプロセスが読み取り可能な権限が設定されている必要があります。
44    // ファイルが存在しない、またはアクセス権がない場合、cURLエラーが発生します。
45    curl_setopt($ch, CURLOPT_PROXY_SSLKEY, $proxyClientKeyPath);
46
47    // CURLOPT_PROXY_SSLCERT: プロキシへの接続にクライアント認証が必要な場合の証明書ファイルパス
48    // CURLOPT_PROXY_SSLKEYとセットで使用します。
49    // 注意: 実際の証明書ファイル（例: '/path/to/proxy_client.crt'）が存在し、
50    // PHPプロセスが読み取り可能な権限が設定されている必要があります。
51    // ファイルが存在しない、またはアクセス権がない場合、cURLエラーが発生します。
52    curl_setopt($ch, CURLOPT_PROXY_SSLCERT, $proxyClientCertPath);
53
54    // CURLOPT_SSLVERSION: ターゲットサーバーへのSSL/TLS接続のバージョンを指定
55    // ここではTLSv1.2を使用するように指定していますが、環境や要件に応じて変更してください。
56    // 指定可能な値: CURL_SSLVERSION_DEFAULT, CURL_SSLVERSION_TLSv1_0, CURL_SSLVERSION_TLSv1_1,
57    // CURL_SSLVERSION_TLSv1_2, CURL_SSLVERSION_TLSv1_3 などがあります。
58    curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
59
60    // SSL/TLS証明書の検証を有効にする（本番環境では必須）
61    // 自己署名証明書や期限切れ証明書を使用する場合は無効にする必要がありますが、セキュリティリスクがあります。
62    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
63    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); // ホスト名検証を有効にする
64
65    // プロキシに対するSSL/TLS証明書の検証
66    // プロキシもHTTPSを使用する場合に、プロキシの証明書を検証します。
67    curl_setopt($ch, CURLOPT_PROXY_SSL_VERIFYPEER, true);
68    curl_setopt($ch, CURLOPT_PROXY_SSL_VERIFYHOST, 2);
69
70    // レスポンスを文字列として取得する設定
71    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
72
73    // リクエストを実行
74    $response = curl_exec($ch);
75
76    // エラーハンドリング
77    if (curl_errno($ch)) {
78        // エラーが発生した場合、エラーメッセージをログに記録するか、呼び出し元で処理できるよう詳細を返す
79        $errorMsg = curl_error($ch);
80        // error_log("cURLリクエスト中にエラーが発生しました: " . $errorMsg);
81        curl_close($ch);
82        return false;
83    }
84
85    // cURLセッションを終了
86    curl_close($ch);
87
88    return $response;
89}

このPHPサンプルコードは、プロキシサーバー経由でHTTPS URLにアクセスする際に、プロキシへの接続にクライアント証明書を使用し、さらにターゲットサーバーへのSSL/TLS接続バージョンを指定する方法を学ぶためのものです。

特に重要なのは、CURLOPT_PROXY_SSLKEYとCURLOPT_PROXY_SSLCERTの利用です。CURLOPT_PROXY_SSLKEYは、プロキシ自体がSSL/TLS通信を行い、クライアント証明書による認証を要求する場合に、秘密鍵ファイルのパスを指定します。CURLOPT_PROXY_SSLCERTは、その秘密鍵に対応するクライアント証明書ファイルのパスを指定し、両者はセットで利用されます。これらの証明書と秘密鍵ファイルは、PHPプロセスが読み取り可能な権限で存在している必要があります。

また、CURLOPT_SSLVERSIONは、ターゲットサーバーとのSSL/TLS接続に使用するバージョン（例えばTLSv1.2）を指定するオプションです。これにより、特定のセキュリティ要件を満たす安全な接続が可能になります。本コードでは、ターゲットサーバーおよびプロキシの両方でSSL/TLS証明書の検証を有効にし、通信の信頼性を高めています。

この関数は、アクセスしたいURL（$targetUrl）、プロキシの情報（$proxyHost, $proxyPort）、プロキシ認証用の証明書と秘密鍵のパス（$proxyClientCertPath, $proxyClientKeyPath）を引数として受け取ります。成功時にはターゲットサーバーからのレスポンスボディを文字列として返し、失敗した場合はfalseを返します。