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

Copy
1<?php
2
3/**
4 * SOCKS5プロキシ認証を使用して指定されたURLにHTTPリクエストを送信します。
5 *
6 * この関数は、プログラミング言語リファレンス情報に基づき、
7 * SOCKS5プロキシ認証に関連するオプションの設定例を示します。
8 *
9 * 注意: リファレンス情報にある「CURLOPT_SOCKS5_AUTH」という定数は、
10 * PHPの標準cURL拡張には直接存在しません。
11 * もしこの定数が存在し、SOCKS5プロキシの認証方式を指定する用途だった場合、
12 * どのように利用されるかを想定してコメントアウトされた形で示しています。
13 *
14 * 実際のPHP環境でSOCKS5プロキシ認証を行う際は、CURLOPT_PROXYTYPE、
15 * CURLOPT_PROXYUSERNAME、CURLOPT_PROXYPASSWORD、そしてCURLOPT_PROXYAUTHを
16 * 組み合わせて使用するのが一般的です。
17 *
18 * @param string $url リクエストを送信するターゲットURL。
19 * @param string $proxyAddress SOCKS5プロキシサーバーのアドレス（例: "127.0.0.1"）。
20 * @param int $proxyPort SOCKS5プロキシサーバーのポート番号（例: 1080）。
21 * @param string $username プロキシ認証に使用するユーザー名。
22 * @param string $password プロキシ認証に使用するパスワード。
23 * @return string|false リクエストが成功した場合はレスポンス本文、失敗した場合は false。
24 */
25function fetchDataViaSocks5ProxyWithAuth(
26    string $url,
27    string $proxyAddress,
28    int $proxyPort,
29    string $username,
30    string $password
31): string|false {
32    // cURLセッションを初期化します。
33    $ch = curl_init();
34
35    if ($ch === false) {
36        error_log("cURLセッションの初期化に失敗しました。");
37        return false;
38    }
39
40    // 基本的なcURLオプションを設定します。
41    // ターゲットURLを設定
42    curl_setopt($ch, CURLOPT_URL, $url);
43    // 応答を文字列として受け取るように設定
44    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
45
46    // SOCKS5プロキシの接続情報を設定します。
47    // プロキシのアドレスとポートを設定
48    curl_setopt($ch, CURLOPT_PROXY, $proxyAddress . ':' . $proxyPort);
49    // プロキシのタイプをSOCKS5に設定
50    curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
51
52    // SOCKS5プロキシ認証のためのユーザー名とパスワードを設定します。
53    curl_setopt($ch, CURLOPT_PROXYUSERNAME, $username);
54    curl_setopt($ch, CURLOPT_PROXYPASSWORD, $password);
55
56    // PHP/libcurlの標準には「CURLOPT_SOCKS5_AUTH」という定数は存在しません。
57    // もし参照情報にあるこの定数が存在し、認証方式を指定する用途だった場合、
58    // 以下のように`curl_setopt`のオプションとして利用されることが想定されます。
59    // しかし、PHP環境で実行すると未定義定数エラーが発生するため、この行はコメントアウトしています。
60    // curl_setopt($ch, CURLOPT_SOCKS5_AUTH, SOME_AUTH_METHOD_CONSTANT);
61
62    // 代わりに、PHPでSOCKS5プロキシのユーザー名・パスワード認証を行う際は、
63    // `CURLOPT_PROXYAUTH`オプションで認証方式（例: `CURLAUTH_BASIC`）を指定するのが一般的です。
64    // 実際のプロキシサーバーがサポートする認証方式に合わせて設定してください。
65    curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC);
66
67    // SSL/TLS証明書の検証を無効にする設定（開発環境向け。本番環境では適切に設定を検討してください）
68    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
69    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
70
71    // リクエストを実行し、応答を取得します。
72    $response = curl_exec($ch);
73
74    // cURL実行中にエラーが発生したかチェックします。
75    if (curl_errno($ch)) {
76        error_log('cURL エラー (' . curl_errno($ch) . '): ' . curl_error($ch));
77        $response = false;
78    }
79
80    // cURLセッションを閉じ、リソースを解放します。
81    curl_close($ch);
82
83    return $response;
84}

このサンプルコードは、PHPのcURL拡張を利用して、SOCKS5プロキシ経由で認証付きのHTTPリクエストを送信する方法を解説しています。関数fetchDataViaSocks5ProxyWithAuthは、引数として受け取ったターゲット$urlに対し、指定された$proxyAddressと$proxyPortのSOCKS5プロキシを経由し、$usernameと$passwordによる認証を行ってリクエストを送信します。

プログラミング言語リファレンス情報に記載されているCURLOPT_SOCKS5_AUTHという定数は、現在のPHPのcURL拡張には直接存在しません。そのため、サンプルコードではこの定数を使用せず、SOCKS5プロキシでの認証を実現するために、複数のcURLオプションを組み合わせて設定しています。具体的には、curl_setopt関数を使い、CURLOPT_PROXYTYPEでプロキシの種類をCURLPROXY_SOCKS5に指定します。さらに、CURLOPT_PROXYUSERNAMEとCURLOPT_PROXYPASSWORDでプロキシ認証のためのユーザー名とパスワードを設定し、CURLOPT_PROXYAUTHオプションでプロキシがサポートする認証方式（例えばCURLAUTH_BASIC）を明示的に指定しています。

この関数はcURLセッションを初期化し、基本的なリクエスト設定に加えて、プロキシ接続情報と認証情報を適切に設定します。リクエストの実行後、エラーが発生した場合はそれを記録し、cURLセッションを閉じます。リクエストが成功した場合、ウェブサーバーからの応答本文が文字列として返され、失敗した場合はfalseが戻り値となります。このコードは、セキュアなプロキシ経由での通信設定の基礎を学ぶのに役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、SSLホスト名検証を行います。
5 * システムエンジニアを目指す初心者向けに、基本的なcURLの使い方と
6 * SSL/TLS検証に関するオプション設定を理解できるよう作成されています。
7 *
8 * @param string $url リクエストを送信するターゲットURL。
9 * @return string|null リクエストが成功した場合はレスポンス本文、失敗した場合はnullを返します。
10 */
11function performSecureCurlRequest(string $url): ?string
12{
13    // cURLセッションを初期化します。
14    // curl_init() は新しいcURLセッションを初期化し、cURLハンドルを返します。
15    $ch = curl_init();
16
17    // cURLの初期化に失敗した場合のエラーハンドリング
18    if ($ch === false) {
19        error_log("cURLセッションの初期化に失敗しました。");
20        return null;
21    }
22
23    // cURLオプションを設定します。
24    // curl_setopt() は指定されたcURL転送のオプションを設定します。
25
26    // CURLOPT_URL: リクエストの送信先URLを設定します。
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // CURLOPT_RETURNTRANSFER: 実行結果を文字列で取得するかどうかを設定します。
30    // trueに設定すると、curl_exec() は成功時に結果を文字列で返し、失敗時にfalseを返します。
31    // falseに設定すると、curl_exec() は直接結果を出力します。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33
34    // --- SSL/TLS検証に関するオプション設定 ---
35
36    // CURLOPT_SSL_VERIFYPEER: ピアの証明書の検証を行うかどうかを設定します。
37    // trueに設定すると、接続先のSSL証明書が正当なものか（信頼できる認証局によって発行されているか）を検証します。
38    // これはセキュリティ上の理由から常にtrueに設定することを強く推奨します。
39    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
40
41    // CURLOPT_SSL_VERIFYHOST: ピアの証明書のCN（Common Name）またはSAN（Subject Alternative Name）が
42    // リクエスト先のホスト名と一致するかどうかを検証します。
43    // 2: 検証を行います (推奨されるセキュアな設定)。
44    // 0: 検証を行いません (非推奨、セキュリティリスクがあるため本番環境では使用しないでください)。
45    // 注: cURL 7.28.1以降では 1 は 2 と同じ動作をするようになりましたが、2 の使用が明確です。
46    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
47
48    // CURLOPT_TIMEOUT: cURL操作のタイムアウト秒数を設定します。
49    // ここでは10秒に設定しています。
50    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
51
52    // cURLセッションを実行し、結果を取得します。
53    // curl_exec() は成功した場合は転送されたデータ、失敗した場合はfalseを返します。
54    $response = curl_exec($ch);
55
56    // cURLの実行中にエラーが発生したか確認します。
57    if (curl_errno($ch)) {
58        // curl_errno() は直近のcURL操作で発生したエラー番号を返します。
59        // curl_error() は直近のcURL操作で発生したエラーメッセージを返します。
60        error_log("cURLエラーが発生しました: " . curl_error($ch));
61        $response = null; // エラー時はnullを返す
62    }
63
64    // cURLセッションを閉じます。
65    // curl_close() はcURLセッションを終了し、リソースを開放します。
66    curl_close($ch);
67
68    return $response;
69}
70
71// 以下は、上記の関数を単体で動作させるためのサンプル呼び出しコードです。
72// 実際のWebサイトのURLに置き換えて試してください。
73$targetUrl = "https://www.example.com";
74echo "Fetching URL: " . $targetUrl . PHP_EOL;
75
76$content = performSecureCurlRequest($targetUrl);
77
78if ($content !== null) {
79    echo "Successfully fetched content (first 200 chars):" . PHP_EOL;
80    echo substr($content, 0, 200) . "..." . PHP_EOL;
81} else {
82    echo "Failed to fetch content from " . $targetUrl . PHP_EOL;
83    echo "Please check the URL or network connection, and review error logs for details." . PHP_EOL;
84}

このPHPサンプルコードは、cURL拡張機能を用いて安全にHTTPリクエストを送信する方法を、システムエンジニアを目指す初心者向けに解説しています。特にSSL/TLS通信における証明書検証の設定に焦点を当てています。

まず、curl_init()でcURLセッションを開始し、curl_setopt()関数で様々なオプションを設定します。CURLOPT_URLで接続先のURLを指定し、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果を文字列として取得できます。また、CURLOPT_TIMEOUTで処理の最大秒数を設定しています。

セキュリティ上非常に重要なのは、SSL/TLS証明書の検証に関する設定です。CURLOPT_SSL_VERIFYPEERをtrueにすることで、接続先のサーバー証明書が信頼できる認証局によって発行されたものであるかを検証します。さらに、CURLOPT_SSL_VERIFYHOSTを2に設定することで、証明書に記載されたホスト名がアクセス先のホスト名と一致するかを厳密に確認し、中間者攻撃などのリスクを防ぎます。これらの設定は安全な通信のために強く推奨されます。

リクエストの実行後、curl_errno()やcurl_error()を用いてエラーが発生していないかを確認し、curl_close()でセッションを終了してリソースを解放します。performSecureCurlRequest関数は、引数としてリクエスト対象のURL（文字列）を受け取り、成功した場合はサーバーからのレスポンス本文（文字列）を、失敗した場合はnullを返します。

なお、本サンプルコードでは使用していませんが、PHPのcURL拡張機能には、プロキシ経由での通信時にSOCKS5プロキシの認証方式を指定するためのCURLOPT_SOCKS5_AUTHといった定数も存在します。