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

Copy
1<?php
2
3/**
4 * CURLHSTS_READONLYFILE 定数を使ってHSTSポリシーファイルを読み取り専用モードで指定するCURLリクエストの例。
5 *
6 * この関数は、CURLHSTS_READONLYFILE 定数の使用方法を示します。
7 * この定数は、HTTP Strict Transport Security (HSTS) ポリシーファイルを扱う際に、
8 * そのファイルを読み取り専用として扱うことをCURLに指示するために使用されます。
9 * また、HTTPステータスコードの取得も行い、キーワード「httpstatus」に対応します。
10 *
11 * 注意: この機能 (CURLHSTS_READONLYFILE および CURLOPT_HSTS_DEFAULT_FILE) は PHP 8.2.0 以降で利用可能です。
12 *
13 * @param string $url リクエストを送信するターゲットURL。
14 * @return string|null サーバーからのレスポンス文字列、またはエラーの場合はnull。
15 */
16function sendCurlRequestWithReadonlyHSTSFile(string $url): ?string
17{
18    // HSTSポリシーファイルを一時的に作成します。
19    // 実際には、事前に用意された有効なHSTSポリシーファイルを使用します。
20    $hstsFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'dummy_hsts_policy.txt';
21    file_put_contents($hstsFilePath, '# This is a dummy HSTS policy file.' . PHP_EOL);
22    echo "HSTSポリシーファイルを作成しました: " . $hstsFilePath . PHP_EOL;
23
24    $ch = curl_init();
25
26    if ($ch === false) {
27        echo "エラー: CURL初期化に失敗しました。" . PHP_EOL;
28        // 作成したダミーファイルを削除
29        if (file_exists($hstsFilePath)) {
30            unlink($hstsFilePath);
31        }
32        return null;
33    }
34
35    // 基本的なCURLオプションを設定
36    curl_setopt($ch, CURLOPT_URL, $url);
37    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得する
38    curl_setopt($ch, CURLOPT_HEADER, false);       // レスポンスヘッダを含めない
39    curl_setopt($ch, CURLOPT_TIMEOUT, 10);         // タイムアウトを10秒に設定
40
41    // HSTSポリシーファイルを読み取り専用として指定
42    // CURLOPT_HSTS_DEFAULT_FILE オプションは、HSTSポリシーファイルを指定するために使用されます。
43    // 第2引数として CURLHSTS_READONLYFILE を渡すことで、CURLはこのファイルへの書き込みを行いません。
44    // この機能は PHP 8.2.0 以降で有効です。
45    curl_setopt($ch, CURLOPT_HSTS_DEFAULT_FILE, [$hstsFilePath, CURLHSTS_READONLYFILE]);
46    echo "CURLHSTS_READONLYFILE を使用してHSTSポリシーファイルを読み取り専用として設定しました。" . PHP_EOL;
47
48    // CURLリクエストを実行
49    $response = curl_exec($ch);
50
51    // エラーチェック
52    if (curl_errno($ch)) {
53        echo 'CURLエラー: ' . curl_error($ch) . PHP_EOL;
54        $response = null;
55    } else {
56        // HTTPステータスコードを取得し表示 (キーワード「httpstatus」に対応)
57        $httpStatusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
58        echo "HTTPステータスコード: " . $httpStatusCode . PHP_EOL;
59    }
60
61    // CURLセッションを閉じる
62    curl_close($ch);
63
64    // 作成したダミーHSTSポリシーファイルを削除します。
65    if (file_exists($hstsFilePath)) {
66        unlink($hstsFilePath);
67        echo "HSTSポリシーファイルを削除しました: " . $hstsFilePath . PHP_EOL;
68    }
69
70    return $response;
71}
72
73// サンプルとして使用するURL (HTTPSサイトが適切です)
74// このコードはHSTSオプションの設定方法を示すためのものであり、
75// 特定のHSTS動作を詳細に検証するものではありません。
76$targetUrl = 'https://www.google.com';
77
78echo "URL: {$targetUrl} へのCURLリクエストを開始します。" . PHP_EOL;
79$result = sendCurlRequestWithReadonlyHSTSFile($targetUrl);
80
81if ($result !== null) {
82    echo PHP_EOL . "--- レスポンスの一部 ---" . PHP_EOL;
83    // レスポンスが長い場合があるため、最初の500文字だけ表示
84    echo substr($result, 0, 500) . (strlen($result) > 500 ? '...' : '') . PHP_EOL;
85    echo "------------------------" . PHP_EOL;
86} else {
87    echo "CURLリクエストが失敗したか、レスポンスがありませんでした。" . PHP_EOL;
88}

このPHPサンプルコードは、CURLHSTS_READONLYFILE定数を利用して、CURLリクエストにおいてHTTP Strict Transport Security (HSTS) ポリシーファイルを読み取り専用モードで扱う方法を実演しています。HSTSは、ウェブサイトがブラウザに対してHTTPS接続のみを使用するよう強制するためのセキュリティ機能です。

CURLHSTS_READONLYFILE定数は、curl_setopt関数でCURLOPT_HSTS_DEFAULT_FILEオプションを指定する際に、HSTSポリシーファイルパスと共に渡すことで、CURLがそのファイルへの書き込みを行わず、既存のポリシーを読み込む専用として動作させることを指示します。この機能はPHP 8.2.0以降でサポートされています。

サンプルコードのsendCurlRequestWithReadonlyHSTSFile関数は、一時的なHSTSポリシーファイルを作成し、これを読み取り専用として設定した上で、指定された$url（ターゲットURL）に対してCURLリクエストを実行します。リクエスト後には、キーワード「httpstatus」に関連し、取得したHTTPステータスコードも表示しています。

この関数は$urlという文字列型の引数を取り、成功時にはサーバーからのレスポンス文字列を返します。CURLリクエスト中にエラーが発生した場合はnullが返されます。

Copy
1<?php
2
3/**
4 * CURLHSTS_READONLYFILE 定数と curl_file_create 関数を使用したcURLリクエストのサンプル
5 *
6 * この関数は、以下の2つの独立したcURLリクエストの例を示します。
7 * 1. CURLHSTS_READONLYFILE 定数を使用して、HSTSキャッシュファイルを読み取り専用として扱う設定。
8 * 2. curl_file_create 関数を使用して、ファイルをアップロードするPOSTリクエストの準備。
9 *
10 * システムエンジニアを目指す初心者がそれぞれの概念を理解しやすいように、
11 * 各セクションを明確に分け、必要最低限のコメントを加えています。
12 */
13function demonstrateCurlFeatures(): void
14{
15    // --- 1. CURLHSTS_READONLYFILE 定数の使用例 ---
16    // CURLHSTS_READONLYFILE は、CURLがHSTS (HTTP Strict Transport Security) キャッシュファイルを
17    // 読み取り専用で扱うべきであることを示す定数です。
18    // 主に CURLOPT_HSTS_CTRL オプションと共に使用され、HSTSキャッシュファイルの保護に役立ちます。
19    echo "--- HSTS Read-Only Cache Configuration Example ---\n";
20
21    // HSTSが有効なHTTPSサイトをターゲットに設定
22    $urlHsts = 'https://www.example.com/';
23    $chHsts = curl_init($urlHsts);
24
25    if ($chHsts === false) {
26        echo "エラー: cURL初期化に失敗しました (HSTS例)。\n";
27        return;
28    }
29
30    // HSTSキャッシュファイルとして使用する一時ファイルを作成します。
31    // 実際には永続的なパスを指定することが多いです。
32    $hstsCacheFile = tempnam(sys_get_temp_dir(), 'hsts_cache_');
33    if ($hstsCacheFile === false) {
34        echo "エラー: 一時HSTSキャッシュファイルの作成に失敗しました。\n";
35        curl_close($chHsts);
36        return;
37    }
38
39    // CURLOPT_HSTS_CACHEFILE: HSTSキャッシュファイルのパスを指定します。
40    curl_setopt($chHsts, CURLOPT_HSTS_CACHEFILE, $hstsCacheFile);
41
42    // CURLOPT_HSTS_CTRL: HSTSの動作制御オプションを設定します。
43    // CURLHSTS_READONLYFILE を設定することで、このキャッシュファイルを読み取り専用として扱います。
44    // これにより、cURLはこのファイルにHSTSポリシーを書き込むことを試みなくなります。
45    curl_setopt($chHsts, CURLOPT_HSTS_CTRL, CURLHSTS_READONLYFILE);
46
47    // レスポンスボディを文字列として取得するための設定
48    curl_setopt($chHsts, CURLOPT_RETURNTRANSFER, true);
49    // タイムアウト設定 (秒)
50    curl_setopt($chHsts, CURLOPT_TIMEOUT, 10);
51
52    echo "CURLHSTS_READONLYFILE を設定してHSTSキャッシュファイル操作を試行中...\n";
53    $responseHsts = curl_exec($chHsts);
54
55    if (curl_errno($chHsts)) {
56        echo 'cURL HSTSエラー (' . curl_errno($chHsts) . '): ' . curl_error($chHsts) . "\n";
57    } else {
58        echo "HSTSキャッシュファイルは読み取り専用モードとして設定されました。\n";
59        // 実際のHSTSキャッシュファイルの内容は通常表示しませんが、成功を示すメッセージを出力
60        echo "HTTPステータスコード: " . curl_getinfo($chHsts, CURLINFO_HTTP_CODE) . "\n";
61    }
62
63    curl_close($chHsts);
64    unlink($hstsCacheFile); // 作成した一時ファイルを削除
65    echo "\n";
66
67
68    // --- 2. curl_file_create 関数の使用例 ---
69    // curl_file_create は、multipart/form-data リクエストでファイルをアップロードする際に、
70    // ファイルを表すCURLFileオブジェクトを作成するために使用されます。
71    echo "--- File Upload Example (using curl_file_create) ---\n";
72
73    // ファイルアップロードのテスト用エンドポイント
74    $urlUpload = 'https://httpbin.org/post';
75    $chUpload = curl_init($urlUpload);
76
77    if ($chUpload === false) {
78        echo "エラー: cURL初期化に失敗しました (ファイルアップロード例)。\n";
79        return;
80    }
81
82    // アップロードする一時ファイルを作成します
83    $uploadFilePath = tempnam(sys_get_temp_dir(), 'upload_test_');
84    if ($uploadFilePath === false) {
85         echo "エラー: 一時アップロードファイルの作成に失敗しました。\n";
86         curl_close($chUpload);
87         return;
88    }
89    $fileContent = "これはテスト用のファイルの内容です。\nPHP cURLでアップロードされます。";
90    file_put_contents($uploadFilePath, $fileContent);
91    echo "アップロードする一時ファイルを作成しました: " . basename($uploadFilePath) . "\n";
92
93    // curl_file_create を使用してアップロード用のファイルオブジェクトを作成
94    // 第1引数: アップロードするファイルのパス
95    // 第2引数: ファイルのMIMEタイプ (省略可能。指定しない場合はcURLが推測を試みます)
96    // 第3引数: サーバーに送信されるファイル名 (省略可能。指定しない場合は元のファイル名が使われます)
97    $cFile = curl_file_create($uploadFilePath, 'text/plain', 'my_uploaded_file.txt');
98
99    // POSTリクエストとして設定
100    curl_setopt($chUpload, CURLOPT_POST, true);
101
102    // CURLOPT_POSTFIELDS: POSTリクエストで送信するデータを設定します。
103    // 'file_field' はフォームのフィールド名、 $cFile はそのフィールドに結びつけられるファイルデータです。
104    // 他のフォームデータも追加できます。
105    curl_setopt($chUpload, CURLOPT_POSTFIELDS, [
106        'file_field' => $cFile,
107        'description' => 'PHP cURLによるテストアップロード',
108    ]);
109
110    // レスポンスボディを文字列として取得するための設定
111    curl_setopt($chUpload, CURLOPT_RETURNTRANSFER, true);
112    // タイムアウト設定 (秒)
113    curl_setopt($chUpload, CURLOPT_TIMEOUT, 30);
114
115    echo "ファイルをアップロードするためのcURLリクエストを送信中...\n";
116    $responseUpload = curl_exec($chUpload);
117
118    if (curl_errno($chUpload)) {
119        echo 'cURL アップロードエラー (' . curl_errno($chUpload) . '): ' . curl_error($chUpload) . "\n";
120    } else {
121        echo "ファイルアップロードリクエストが正常に送信されました。\n";
122        echo "サーバーからの応答 (一部):\n";
123        // 応答が長い場合があるので、一部のみ表示
124        echo substr($responseUpload, 0, 500) . (strlen($responseUpload) > 500 ? '...' : '') . "\n";
125    }
126
127    curl_close($chUpload);
128    unlink($uploadFilePath); // 作成した一時ファイルを削除
129}
130
131// 関数を実行
132demonstrateCurlFeatures();
133

PHPのcURL拡張機能は、Webサーバーとのデータ送受信を行うための強力なツールです。このサンプルコードは、その中でも特に「CURLHSTS_READONLYFILE定数」と「curl_file_create関数」の二つの重要な機能について解説しています。

まず、CURLHSTS_READONLYFILE定数についてです。これは、cURLがHSTS（HTTP Strict Transport Security）キャッシュファイルを読み取り専用として扱うべきであることを示す整数値（int）の定数です。引数はなく、CURLOPT_HSTS_CTRLオプションと組み合わせて使用することで、cURLがHSTSポリシーをこのキャッシュファイルに書き込むことを防ぎ、HSTSキャッシュの整合性や保護に貢献します。

次に、curl_file_create関数についてです。この関数は、HTTP POSTリクエストでファイルをアップロードする際に非常に役立ちます。ファイルのパス、MIMEタイプ、サーバーに送信されるファイル名を引数として受け取り、cURLがアップロード用のCURLFileオブジェクトを作成します。作成されたオブジェクトをCURLOPT_POSTFIELDSオプションに設定することで、multipart/form-data形式でファイルデータと追加のフォームデータをWebサーバーへ送信することが可能になります。これにより、PHPアプリケーションから手軽にファイルをアップロードする処理を実装できます。

これら二つの機能は、Webリクエストのセキュリティ管理やファイル操作において重要な役割を果たします。