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

Copy
1<?php
2
3/**
4 * CURLHSTS_ENABLE 定数を使用して cURL リクエストを送信するサンプル関数。
5 *
6 * この定数は、HTTP Strict Transport Security (HSTS) を有効にするために
7 * CURLOPT_HSTS_ENABLE オプションと共に使用されます。
8 * HSTSが有効な場合、cURLはHSTSポリシーを尊重し、可能であればHTTPSを使用します。
9 *
10 * @param string $url リクエストを送信するターゲットURL。
11 * @return string|false リクエストのレスポンス本文、または失敗した場合はfalse。
12 */
13function sendCurlRequestWithHsts(string $url): string|false
14{
15    // cURLハンドルの初期化
16    // CURLHandle オブジェクトを作成します。
17    $ch = curl_init();
18
19    if ($ch === false) {
20        echo "エラー: cURLハンドルの初期化に失敗しました。\n";
21        return false;
22    }
23
24    // cURLオプションの設定
25    // リクエストのURLを設定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // レスポンスを文字列として返すように設定します。
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
29    // HTTP Strict Transport Security (HSTS) を有効にします。
30    // CURLHSTS_ENABLE 定数は、HSTSを有効にするために使用する値です。
31    // これは PHP 8 で利用可能な CURLOPT_HSTS_ENABLE オプションに渡されます。
32    curl_setopt($ch, CURLOPT_HSTS_ENABLE, CURLHSTS_ENABLE);
33    // SSL証明書の検証を行うように設定します（本番環境では必須）。
34    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
35    // ホスト名の検証を行うように設定します（本番環境では必須）。
36    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
37
38    // cURLリクエストの実行
39    $response = curl_exec($ch);
40
41    if ($response === false) {
42        // リクエスト失敗時のエラー情報を表示します。
43        echo "エラー: cURLリクエストの実行に失敗しました: " . curl_error($ch) . "\n";
44    }
45
46    // cURLハンドルのクローズ
47    // リソースを解放します。
48    curl_close($ch);
49
50    return $response;
51}
52
53// サンプルとして使用するURL
54$targetUrl = 'https://www.google.com';
55
56echo "URL: " . $targetUrl . " への cURL リクエストを HSTS 有効で送信します。\n\n";
57
58// 関数を呼び出し、結果を表示
59$result = sendCurlRequestWithHsts($targetUrl);
60
61if ($result !== false) {
62    echo "リクエスト成功。受信したレスポンスの最初の200文字:\n";
63    echo substr($result, 0, 200) . "...\n";
64} else {
65    echo "リクエストは失敗しました。\n";
66}
67
68?>

このサンプルコードは、PHP 8で導入されたCURLHSTS_ENABLE定数を用いて、HTTP Strict Transport Security (HSTS) を有効にしたcURLリクエストを送信する方法を示しています。HSTSとは、ウェブサイトがクライアントに対し、常にHTTPS（暗号化された安全な接続）を使用するよう強制するセキュリティメカニズムです。

CURLHSTS_ENABLE定数は、cURLのCURLOPT_HSTS_ENABLEオプションに設定することで、このHSTSの機能を有効にするための値として機能します。これにより、クライアントは指定されたウェブサイトへの接続時にHTTPSを強制的に使用し、中間者攻撃などのリスクを低減できます。

sendCurlRequestWithHsts関数は、引数として指定された$urlに対しcURLリクエストを送信します。まずcurl_init()でcURLハンドルを初期化し、リクエストを準備します。次に、curl_setopt()を使って各種設定を行います。具体的には、ターゲットURLの設定、レスポンスを文字列として取得する設定、そしてCURLOPT_HSTS_ENABLEオプションにCURLHSTS_ENABLEを渡してHSTS機能を有効にしています。さらに、通信の安全性を確保するため、SSL証明書とホスト名の検証も行っています。

設定後、curl_exec()で実際にリクエストを実行し、ウェブサイトからの応答を取得します。リクエストが成功すればレスポンス本文の文字列を、失敗した場合はfalseを戻り値として返します。最後に、curl_close()でリソースを解放します。この一連の処理により、安全で信頼性の高いHTTP通信が実現されます。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、HSTSを有効にします。
5 *
6 * @param string $url リクエスト先のURL
7 * @return string|null 取得したコンテンツ、またはエラー時にnull
8 */
9function fetchDataWithHsts(string $url): ?string
10{
11    // cURLセッションを初期化
12    $ch = curl_init($url);
13    if (!$ch) {
14        error_log("cURLの初期化に失敗しました: " . $url);
15        return null;
16    }
17
18    // HTTP Strict Transport Security (HSTS) を有効化します。
19    // PHPのCURL拡張において、提供されたリファレンス情報にあるCURLHSTS_ENABLE定数は
20    // 直接オプションとして利用されません。代わりにCURLOPT_HSTS_ENABLEオプションを
21    // `true`に設定することでHSTSを有効にできます。(libcurl 7.74.0以降で利用可能)
22    if (defined('CURLOPT_HSTS_ENABLE')) {
23        curl_setopt($ch, CURLOPT_HSTS_ENABLE, true);
24    } else {
25        // 環境によってはCURLOPT_HSTS_ENABLEが未定義の場合があるため、その際の処理
26        error_log("CURLOPT_HSTS_ENABLEは現在のPHP環境で定義されていません。HSTSは適用されません。");
27    }
28
29    // その他の基本的なcURLオプションを設定
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 戻り値を文字列として取得する
31    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // HTTPリダイレクトを自動的に追跡する
32    curl_setopt($ch, CURLOPT_TIMEOUT, 30);          // 接続および実行のタイムアウトを30秒に設定
33    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); // SSL証明書の検証を有効にする (推奨)
34    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);    // ホスト名の検証を有効にする (推奨)
35
36    // cURLリクエストを実行
37    $response = curl_exec($ch);
38
39    // エラーハンドリング
40    if (curl_errno($ch)) {
41        error_log("cURLエラー発生 for " . $url . ": " . curl_error($ch));
42        curl_close($ch);
43        return null;
44    }
45
46    // HTTPステータスコードを取得
47    $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
48    error_log("HTTPステータスコード for " . $url . ": " . $http_status);
49
50    // cURLセッションを閉じる
51    curl_close($ch);
52
53    return $response;
54}
55
56// --- サンプル使用例 ---
57// HSTSを有効にしたリクエストの実行方法を示します。
58// 実際のHSTSポリシーの効果は、cURLが使用するlibcurlのバージョンや
59// キャッシュ設定に依存する場合があります。
60$targetUrl = 'https://www.google.com'; // HSTS対応のサイトを指定することを推奨します
61
62echo "URL: " . $targetUrl . " からコンテンツをHSTS有効化設定で取得中 (cURLがサポートしている場合)..." . PHP_EOL;
63$content = fetchDataWithHsts($targetUrl);
64
65if ($content !== null) {
66    echo "コンテンツを正常に取得しました (最初の200文字):" . PHP_EOL;
67    echo substr($content, 0, 200) . "..." . PHP_EOL;
68} else {
69    echo "コンテンツの取得に失敗しました。" . PHP_EOL;
70}
71
72?>

このPHPコードは、指定されたURLからWebコンテンツを取得する際に、セキュリティ機能であるHSTS（HTTP Strict Transport Security）を有効にする方法を示しています。HSTSとは、Webブラウザに対して、そのサイトへは常にHTTPSで接続するよう強制することで、中間者攻撃などを防ぎ、セキュリティを強化する仕組みです。

リファレンスで示されたCURLHSTS_ENABLE定数は、HSTS機能の存在や利用可能性を概念的に示すものですが、直接cURLオプションとして設定する定数ではありません。このサンプルコードでは、実際にHSTSを有効にするために、CURLOPT_HSTS_ENABLEというオプションをtrueに設定しています。このオプションはlibcurl 7.74.0以降のバージョンで利用可能となります。

fetchDataWithHsts関数は、リクエスト先のURLを文字列型引数$urlとして受け取り、成功した場合は取得したWebコンテンツを文字列として返します。何らかのエラーが発生した場合はnullを返します。関数内部では、curl_init()でcURLセッションを初期化し、curl_setopt()で様々なオプションを設定します。例えば、CURLOPT_RETURNTRANSFERで取得結果を文字列として返すように、CURLOPT_FOLLOWLOCATIONでリダイレクトを自動追跡するように設定しています。特に、Web通信の安全性を確保するため、CURLOPT_SSL_VERIFYPEERとCURLOPT_SSL_VERIFYHOSTをtrueに設定することは推奨されるプラクティスです。これらの設定後、curl_exec()でリクエストを実行し、エラーが発生した場合は適切に処理した上で、curl_close()でセッションを閉じます。このコードを通じて、PHPでcURLとHSTSを安全に利用する基礎を学ぶことができます。