【PHP8.x】hash_update_stream()関数の使い方

Copy
1<?php
2
3/**
4 * hash_update_stream関数の使用例を示すスクリプト。
5 * 
6 * hash_update_streamは、ファイルやネットワーク接続などのストリームリソースから
7 * データを読み込み、既存のハッシュコンテキストを更新するために使用されます。
8 */
9
10// 1. SHA256アルゴリズムで新しいハッシュコンテキストを初期化します。
11$hashContext = hash_init('sha256');
12
13// 2. ハッシュ対象のデータを作成します。
14$dataToHash = "この文字列は、hash_update_stream関数を使ってハッシュ化されます。";
15
16// 3. データを一時的なメモリストリームに書き込みます。
17// 'r+' モードは、読み書きを可能にし、ファイルが存在しない場合は作成します。
18$stream = fopen('php://temp', 'r+');
19if ($stream === false) {
20    die("ストリームの作成に失敗しました。\n");
21}
22
23// 4. 作成したストリームにデータを書き込みます。
24fwrite($stream, $dataToHash);
25
26// 5. ストリームポインタを先頭に戻します。
27// hash_update_streamがストリームの最初からデータを読み取れるようにするためです。
28rewind($stream);
29
30// 6. ストリームからデータを読み込み、ハッシュコンテキストを更新します。
31// $lengthを省略（または-1）すると、ストリームの終端まで読み込まれます。
32// 戻り値は、処理されたバイト数です。
33$bytesProcessed = hash_update_stream($hashContext, $stream);
34
35// 7. ハッシュ計算を完了し、最終的なハッシュ値を取得します。
36$finalHash = hash_final($hashContext);
37
38// 8. 結果を出力します。
39echo "元のデータ: " . $dataToHash . PHP_EOL;
40echo "ストリームから処理されたバイト数: " . $bytesProcessed . PHP_EOL;
41echo "SHA256ハッシュ: " . $finalHash . PHP_EOL;
42
43// 9. 使用したストリームリソースを閉じます。
44fclose($stream);
45
46?>

PHPのhash_update_stream関数は、指定されたストリームリソースからデータを読み込み、進行中のハッシュ計算コンテキストを更新するために使用されます。ファイルやネットワーク接続など、大量のデータを一度にメモリに読み込むことなく、段階的にハッシュ値を計算する際に特に役立ちます。

この関数は、hash_init関数で初期化されたHashContextオブジェクトを最初の引数$contextとして受け取ります。次に、ハッシュの対象となるデータが格納された$streamリソース（例: fopenで開かれたファイルやメモリストリーム）を指定します。オプションの引数$lengthには、ストリームから読み込むバイト数を指定でき、省略（または-1）するとストリームの終端まで読み込みます。関数は実際に処理したバイト数を整数値として返します。

サンプルコードでは、まずsha256アルゴリズムでハッシュコンテキストを初期化し、対象データを一時的なメモリストリーム（php://temp）に書き込みます。hash_update_streamを呼び出す前にrewindでストリームポインタを先頭に戻すことで、ストリームの最初からデータが読み込まれ、ハッシュコンテキストが更新されます。最終的にhash_final関数でハッシュ計算を完了し、結果として得られたハッシュ値を出力します。この一連の処理により、効率的にストリームデータをハッシュ化できます。

Copy
1<?php
2
3/**
4 * calculateRawPostBodyHash
5 *
6 * この関数は、HTTP POSTリクエストの生データ（ボディ）からSHA256ハッシュを計算します。
7 * `http_raw_post_data`キーワードに関連して、現代のPHPでは`php://input`ストリームを
8 * 使用して生データにアクセスするのが推奨される方法です。
9 * `hash_update_stream`は、特に大きなデータの場合に、メモリにすべてを読み込むことなく
10 * ストリームから直接データを処理する効率的な方法を示しています。
11 *
12 * @return string POSTボディのSHA256ハッシュを返します。POSTリクエストでない場合やエラーの場合は空文字列を返します。
13 */
14function calculateRawPostBodyHash(): string
15{
16    // HTTPリクエストメソッドがPOSTであることを確認します。
17    // POST以外のリクエストでは、通常、生データは送信されません。
18    if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
19        error_log("This function expects a POST request.");
20        return '';
21    }
22
23    // SHA256ハッシュアルゴリズムでハッシュコンテキストを初期化します。
24    // これにより、ハッシュ計算の準備が整います。
25    $context = hash_init('sha256');
26
27    // 'php://input'ストリームを開きます。
28    // これは、HTTP POSTリクエストの生データを読み取り専用で提供する特別なストリームです。
29    // PHP 8では、非推奨となった`$HTTP_RAW_POST_DATA`や`http_raw_post_data` ini設定の
30    // 代わりにこのストリームを使用することが推奨されます。
31    $inputStream = fopen('php://input', 'r');
32
33    if ($inputStream === false) {
34        // ストリームを開けなかった場合の処理
35        error_log("Failed to open php://input stream.");
36        return '';
37    }
38
39    // `hash_update_stream`を使用して、開かれたストリームからハッシュコンテキストにデータを供給します。
40    // これにより、ストリームの内容が効率的に読み取られ、ハッシュ計算が更新されます。
41    // 第3引数`$length`を省略すると、ストリームの終端まで読み込みます。
42    $bytesRead = hash_update_stream($context, $inputStream);
43
44    // ストリームの利用が完了したら閉じます。
45    fclose($inputStream);
46
47    // ハッシュ計算を完了し、結果のハッシュ文字列を取得します。
48    // `true`を渡すことで、結果が小文字の16進数形式で返されます。
49    return hash_final($context, true);
50}
51
52// --- コード実行例 ---
53// このコードをテストするには、POSTリクエストを送信する必要があります。
54// 例: `curl -X POST -H "Content-Type: text/plain" --data "Hello, World!" http://localhost/your_script.php`
55// 上記のコマンドで "Hello, World!" のSHA256ハッシュが出力されます。
56
57$hashResult = calculateRawPostBodyHash();
58
59if (!empty($hashResult)) {
60    echo "SHA256 Hash of raw POST body: " . $hashResult . PHP_EOL;
61} else {
62    // POSTリクエストではない場合、またはエラーが発生した場合
63    echo "No raw POST body hash calculated. Please send a POST request." . PHP_EOL;
64}

このサンプルコードは、HTTP POSTリクエストのボディ部分からSHA256ハッシュ値を計算する方法を示しています。

主要な関数であるhash_update_streamは、PHP 8で提供される拡張機能の一つで、ハッシュ計算の途中にストリームからデータを効率的に供給するために使用されます。引数としてhash_initで初期化されたハッシュコンテキストと、データを読み込むストリームリソースを受け取ります。オプションの第3引数$lengthを指定すると、ストリームから読み込むバイト数を制限できますが、省略した場合はストリームの終端まで読み込みます。この関数は実際にストリームから読み込まれ、ハッシュに追加されたバイト数を整数値（int）で返します。

コードでは、まず$_SERVER['REQUEST_METHOD']でPOSTリクエストであることを確認し、hash_init('sha256')でSHA256アルゴリズムのハッシュコンテキストを初期化します。次に、HTTP POSTリクエストの生のボディデータを提供する特別なストリームであるphp://inputをfopenで開きます。これは、非推奨となったhttp_raw_post_dataに代わる現代的な取得方法です。開いたストリームをhash_update_streamに渡し、ボディデータからハッシュコンテキストを更新します。最後にfcloseでストリームを閉じ、hash_finalで最終的なハッシュ値（文字列）を取得して返します。この方法により、特に大きなPOSTデータであっても、メモリにすべてを読み込むことなく効率的にハッシュ計算が可能です。