Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

CURLOPT_PRE_PROXY定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

CURLOPT_PRE_PROXY定数は、PHPのcURL拡張機能において、ネットワーク通信の特定の動作を設定するために使用される定数です。この定数は、特にプロキシサーバーを介したデータ転送を行う際に、その接続経路をより詳細に制御するために利用されます。

PHPのcURL拡張機能は、Webサービスとの連携や外部APIへのアクセスなど、HTTP、HTTPS、FTPといった様々なプロトコルを用いたデータ送受信を可能にする強力なライブラリです。通常、cURLリクエストをプロキシサーバー経由で実行する場合、CURLOPT_PROXY オプションを使用してプロキシサーバーのアドレスとポートを指定します。

CURLOPT_PRE_PROXY 定数は、この一般的なプロキシ設定とは異なる、より手前の段階でのプロキシ設定を指定する際に活用されます。具体的には、メインとなるHTTP/HTTPSプロキシに接続する前に、さらに別のプロキシ(例えば、SOCKSプロキシなど)を介して通信を確立したい場合に、この定数にその前段プロキシのホスト名とポート情報を設定します。これにより、多重のプロキシ構成や、特定のセキュリティ要件を持つ複雑なネットワーク環境下でのルーティングに柔軟に対応できるようになります。

この定数は、curl_setopt() 関数と組み合わせて使用され、指定された前段プロキシのURL文字列をcURLハンドルに設定することで、通信経路を細かく制御できます。システム開発において、ネットワークセキュリティの強化や、特定のネットワークポリシーへの準拠が求められる場面で、CURLOPT_PRE_PROXY はPHPアプリケーションのネットワーク通信の柔軟性と堅牢性を高める上で重要な定数の一つとして機能します。

構文(syntax)

1<?php
2$ch = curl_init();
3curl_setopt($ch, CURLOPT_PRE_PROXY, "http://proxy.example.com:8080");
4curl_setopt($ch, CURLOPT_URL, "https://www.example.com");
5curl_exec($ch);
6curl_close($ch);
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

CURLOPT_PRE_PROXYは、プロキシ接続前に実行するコマンドを指定するための定数です。この定数は、整数型(int)の値を返します。

サンプルコード

PHP cURL: CURLOPT_PRE_PROXY でプロキシチェーンを構築する

1<?php
2
3/**
4 * CURLOPT_PRE_PROXY オプションを使用して、複数のプロキシ経由でWebコンテンツを取得する例。
5 *
6 * この関数は、リクエストを送信する際に、通常のプロキシ (CURLOPT_PROXY) の前段に
7 * さらにもう一つのプロキシ (CURLOPT_PRE_PROXY) を設定する方法を示します。
8 * これは、プロキシチェーンを構築する際に利用されます。
9 *
10 * 注: このコードを実際に動作させるには、指定したプロキシアドレスで動作している
11 *     有効なプロキシサーバーが必要です。例示のアドレスはダミーです。
12 *     CURLOPT_PRE_PROXY は PHP 8.2 以降 (libcurl 7.85.0 以降) で利用可能です。
13 *
14 * @param string $url 取得するターゲットURL。
15 * @param string $mainProxy メインのプロキシサーバーのアドレス (例: "http://proxy.example.com:8080")。
16 * @param string $preProxy メインプロキシの前段に位置するプロキシサーバーのアドレス (例: "http://preproxy.example.com:3128")。
17 * @return string|false 取得したWebページのコンテンツ、またはエラー発生時に false。
18 */
19function fetchContentViaPreProxy(string $url, string $mainProxy, string $preProxy)
20{
21    // cURL セッションを初期化
22    $ch = curl_init();
23
24    if ($ch === false) {
25        echo "エラー: cURL セッションの初期化に失敗しました。\n";
26        return false;
27    }
28
29    // ターゲットURLを設定
30    curl_setopt($ch, CURLOPT_URL, $url);
31    // レスポンスを文字列として取得する設定
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33    // HTTPSリクエストの場合、証明書の検証をスキップする (開発環境向け、本番環境では非推奨)
34    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
35    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
36
37    // メインのプロキシサーバーを設定 (CURLOPT_PROXY)
38    // リクエストはこのプロキシを通過して最終的なターゲットURLに到達します。
39    curl_setopt($ch, CURLOPT_PROXY, $mainProxy);
40
41    // メインプロキシの前段プロキシを設定 (CURLOPT_PRE_PROXY)
42    // リクエストはまずこの pre-proxy を通過し、次に main-proxy を通過してターゲットURLに到達します。
43    curl_setopt($ch, CURLOPT_PRE_PROXY, $preProxy);
44
45    // cURL リクエストを実行
46    $response = curl_exec($ch);
47
48    // エラーチェック
49    if (curl_errno($ch)) {
50        echo 'cURL エラー (' . curl_errno($ch) . '): ' . curl_error($ch) . "\n";
51        $response = false;
52    } else {
53        echo "cURL リクエストが正常に完了しました。\n";
54    }
55
56    // cURL セッションを閉じる
57    curl_close($ch);
58
59    return $response;
60}
61
62// --- 使用例 ---
63// 以下のプロキシアドレスは例示であり、実際には動作しません。
64// 適切なプロキシサーバーのアドレスとポートに置き換えてください。
65$targetUrl = "http://example.com"; // ターゲットとなるWebサイト
66$mainProxyAddress = "http://127.0.0.1:8080"; // メインのプロキシサーバー
67$preProxyAddress = "http://127.0.0.1:3128";  // その前段のプロキシサーバー
68
69echo "--- CURLOPT_PRE_PROXY を用いたプロキシチェーンのリクエスト ---" . PHP_EOL;
70echo "ターゲットURL: " . $targetUrl . PHP_EOL;
71echo "メインプロキシ: " . $mainProxyAddress . PHP_EOL;
72echo "前段プロキシ (Pre-Proxy): " . $preProxyAddress . PHP_EOL;
73echo PHP_EOL;
74
75$content = fetchContentViaPreProxy($targetUrl, $mainProxyAddress, $preProxyAddress);
76
77if ($content !== false) {
78    // 取得したコンテンツの最初の200文字のみ表示
79    echo "Webページの取得に成功しました。コンテンツの冒頭:" . PHP_EOL;
80    echo mb_substr($content, 0, 200) . "..." . PHP_EOL;
81} else {
82    echo "Webページの取得に失敗しました。プロキシ設定やサーバーの稼働状況を確認してください。" . PHP_EOL;
83}
84
85?>

このサンプルコードは、PHPのcURL拡張機能でWebコンテンツを取得する際に、複数のプロキシサーバーを経由して通信する「プロキシチェーン」を構築する方法を示しています。具体的には、CURLOPT_PRE_PROXYという定数を使用して、通常のプロキシ(CURLOPT_PROXYで設定)のさらに前段に別のプロキシサーバーを設定する例です。

fetchContentViaPreProxy関数は、指定されたターゲットURLを、まず$preProxyで指定された前段プロキシ、次に$mainProxyで指定されたメインプロキシを経由して取得します。 この関数は次の3つの引数を取ります。$urlはアクセスしたいWebサイトのURL、$mainProxyは最終的な接続に使用されるプロキシのアドレス、そして$preProxyはそのメインプロキシの前に接続されるプロキシのアドレスです。 関数が成功した場合、取得したWebページのコンテンツが文字列として返されますが、エラーが発生した場合はfalseが返されます。

内部では、curl_init()でcURLセッションを初期化し、curl_setopt()関数を用いて各種オプションを設定しています。特に、CURLOPT_URLでターゲットURLを、CURLOPT_PROXYでメインプロキシを、そして本説明の対象であるCURLOPT_PRE_PROXYで前段プロキシを指定しています。リクエストはcurl_exec()で実行され、エラーがなければコンテンツが取得されます。最後にcurl_close()でセッションが閉じられます。

CURLOPT_PRE_PROXYはPHP 8.2以降(libcurl 7.85.0以降)で利用可能であり、複数のプロキシを連携させて通信経路を制御したい場合に活用されます。コードを実際に動作させるためには、例示されたダミーのアドレスではなく、実際に稼働している有効なプロキシサーバーのアドレスに置き換える必要があります。

このサンプルコードを利用する際は、PHP 8.2以降およびlibcurl 7.85.0以降の環境が必要である点にご注意ください。示されているプロキシアドレスは例示のため、実際に機能するプロキシサーバー(メインと前段の両方)を別途用意する必要があります。CURLOPT_PRE_PROXYCURLOPT_PROXYよりも先にリクエストが通過する「前段」プロキシを設定するもので、プロキシチェーンの順序を正しく理解することが重要です。また、SSL証明書の検証をスキップする設定は開発環境向けであり、本番環境ではセキュリティリスクを伴うため避けてください。万一エラーが発生した場合は、curl_errno()curl_error()で詳細なエラーメッセージを確認し、トラブルシューティングに役立てましょう。

PHP cURLでSSLバージョンを指定する

1<?php
2
3/**
4 * cURL を使用して HTTPS リクエストを実行し、特定の SSL/TLS バージョンを指定するサンプル関数。
5 * システムエンジニアを目指す初心者向けに、cURL オプションの設定方法を示します。
6 *
7 * @param string $url リクエスト先のURL (例: 'https://example.com/api').
8 * @param int $sslVersion 使用する SSL/TLS のバージョンを示す定数 (例: CURL_SSLVERSION_TLSv1_2).
9 *                        利用可能な定数は、CURL_SSLVERSION_DEFAULT, CURL_SSLVERSION_TLSv1_0,
10 *                        CURL_SSLVERSION_TLSv1_1, CURL_SSLVERSION_TLSv1_2, CURL_SSLVERSION_TLSv1_3 などです。
11 *                        古いバージョン (SSLv2, SSLv3) はセキュリティ上の理由から非推奨です。
12 * @return string|false リクエストが成功した場合は応答ボディの文字列、失敗した場合は false を返します。
13 */
14function fetchUrlWithSpecificSslVersion(string $url, int $sslVersion)
15{
16    // 1. cURL セッションを初期化します。
17    //    これは、ウェブサーバーと通信するためのハンドル(識別子)を作成する操作です。
18    $ch = curl_init();
19
20    // 初期化に失敗した場合はエラーメッセージを表示し、処理を終了します。
21    if ($ch === false) {
22        echo "エラー: cURL セッションの初期化に失敗しました。\n";
23        return false;
24    }
25
26    // 2. curl_setopt() を使用して、cURL オプションを設定します。
27    //    これにより、どのようにリクエストを行うかを cURL に指示します。
28
29    // リクエスト先のURLを設定します。
30    curl_setopt($ch, CURLOPT_URL, $url);
31
32    // curl_exec() が応答を文字列として返すように設定します。
33    // これを設定しない場合、応答は直接出力されます。
34    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
35
36    // SSL/TLS 証明書のピア検証を行うかどうかを設定します。
37    // 本番環境ではセキュリティのため 'true' (検証を行う) に設定し、
38    // 必要に応じて CURLOPT_CAINFO オプションで信頼できるCA証明書を指定することを強く推奨します。
39    // このサンプルコードでは動作確認のため一時的に 'false' (検証を行わない) に設定しています。
40    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
41
42    // SSL/TLS 証明書のホスト名検証を行うかどうかを設定します。
43    // 本番環境ではセキュリティのため '2' (検証を行う) に設定することを強く推奨します。
44    // このサンプルコードでは動作確認のため一時的に 'false' (検証を行わない) に設定しています。
45    // 'false' の値は非推奨であり、将来的にはサポートされない可能性があります。
46    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
47
48    // ここがキーワードに該当する重要なオプションです。
49    // CURLOPT_SSLVERSION を使用して、cURL が HTTPS 接続時に使用する SSL/TLS バージョンを指定します。
50    // 指定された $sslVersion 定数の値に基づいてバージョンが選択されます。
51    // セキュリティ上の理由から、可能な限り最新かつ安全なバージョン(例: TLSv1.2, TLSv1.3)を使用してください。
52    curl_setopt($ch, CURLOPT_SSLVERSION, $sslVersion);
53
54    // 3. 設定したオプションで HTTP リクエストを実行します。
55    //    結果は CURLOPT_RETURNTRANSFER が true なので文字列として $response に格納されます。
56    $response = curl_exec($ch);
57
58    // 4. エラーが発生したかどうかを確認します。
59    if (curl_errno($ch)) {
60        // エラーが発生した場合、エラーメッセージを表示します。
61        echo 'cURL エラーが発生しました: ' . curl_error($ch) . "\n";
62        $response = false; // 応答を false に設定して失敗を通知します。
63    }
64
65    // 5. cURL セッションを閉じます。
66    //    これにより、使用されたリソースが解放されます。
67    curl_close($ch);
68
69    // 応答または失敗を示す false を返します。
70    return $response;
71}
72
73// -----------------------------------------------------------------------------
74// サンプルコードの実行例
75// -----------------------------------------------------------------------------
76
77// リクエストを送信するターゲットURLを指定します。
78// 例として、GitHub API の簡単なエンドポイントを使用します。
79$targetUrl = 'https://api.github.com/zen';
80
81// 使用する SSL/TLS バージョンを指定します。
82// ここでは TLSv1.2 を明示的に指定しています。
83// サーバーが TLSv1.2 をサポートしていない場合、通信は失敗します。
84$specificSslVersion = CURL_SSLVERSION_TLSv1_2;
85
86echo "--- cURL による HTTPS リクエストサンプル ---\n";
87echo "ターゲットURL: " . $targetUrl . "\n";
88echo "指定SSL/TLSバージョン: TLSv1.2 (内部定数値: " . $specificSslVersion . ")\n";
89echo "----------------------------------------\n";
90
91// 関数を呼び出してリクエストを実行します。
92$result = fetchUrlWithSpecificSslVersion($targetUrl, $specificSslVersion);
93
94// 結果を表示します。
95if ($result !== false) {
96    echo "リクエストが成功しました!\n";
97    echo "サーバーからの応答:\n";
98    echo $result . "\n";
99} else {
100    echo "リクエストが失敗しました。\n";
101}
102
103// 注意: 環境によっては、CURLOPT_SSL_VERIFYPEER と CURLOPT_SSL_VERIFYHOST を false に設定すると
104// セキュリティ警告が表示されたり、動作しない場合があります。
105// その際は、適切なCA証明書を設定するか、信頼できる環境で実行してください。

このPHPコードは、cURLライブラリを使用してHTTPSリクエストを実行し、通信に使用するSSL/TLSのバージョンを明示的に指定する方法を、システムエンジニアを目指す初心者向けに示しています。fetchUrlWithSpecificSslVersion関数は、リクエスト先のURLである$urlと、使用するSSL/TLSバージョンを示す定数である$sslVersionを引数として受け取ります。リクエストが成功した場合はサーバーからの応答ボディを文字列として返し、失敗した場合はfalseを返します。

関数内では、最初にcurl_init()でcURLセッションを初期化し、ウェブサーバーと通信するためのハンドルを作成します。その後、curl_setopt()関数を用いて様々なオプションを設定します。最も重要なオプションの一つがCURLOPT_SSLVERSIONで、これによりcURLがHTTPS接続時にどのSSL/TLSバージョンを使用するかを指定できます。例えばCURL_SSLVERSION_TLSv1_2のような定数を渡すことで、特定のバージョンを選べます。セキュリティ上の理由から、可能な限り新しい安全なバージョンを使用することが推奨されます。また、CURLOPT_SSL_VERIFYPEERCURLOPT_SSL_VERIFYHOSTといったセキュリティ関連のオプションも設定されており、本番環境での適切な設定の重要性を示唆しています。設定が完了したら、curl_exec()で実際のリクエストを実行し、最終的にcurl_close()で利用したリソースを解放します。このコードは、特定のセキュリティ要件を持つAPI連携などで役立ちます。

サンプルコードにおいて、CURLOPT_SSL_VERIFYPEERCURLOPT_SSL_VERIFYHOSTfalseに設定している点は、セキュリティ上のリスクが非常に高いため、本番環境では絶対に行わないでください。開発やテスト目的以外では必ずtrueに設定し、適切なCA証明書を構成して、通信相手が信頼できるか検証することが必須です。CURLOPT_SSLVERSIONで指定するSSL/TLSバージョンは、ターゲットサーバーがそのバージョンをサポートしているか確認が必要です。セキュリティのため、古いSSLv2やSSLv3の使用は避け、常に最新で安全なTLSバージョンを選択してください。また、curl_errno()curl_error()によるエラーハンドリング、そしてcurl_close()によるリソース解放は、安定したプログラムを構築する上で非常に重要な処理ですので、常に実施することが推奨されます。

関連コンテンツ

関連IT用語

関連プログラミング言語