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

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのSodium拡張機能を使用して、
5 * データを段階的にジェネリックハッシュ（BLAKE2b）化する方法を示します。
6 * `sodium_crypto_generichash_update`関数は、ハッシュの計算状態を更新するために使用されます。
7 *
8 * 「PHP Sodium とは」: PHPのSodium拡張は、暗号学的に安全な操作（ハッシュ、暗号化、署名など）を
9 * 提供するライブラリlibsodiumへのバインディングです。
10 * 段階的なハッシュ計算は、非常に大きなファイルを処理する際など、
11 * 全データを一度にメモリにロードできない場合に特に役立ちます。
12 *
13 * 注: このコードを実行するには、PHPにSodium拡張がインストールされ、有効になっている必要があります。
14 */
15
16// 1. ハッシュの状態を初期化します。
17// `sodium_crypto_generichash_init()` は、ハッシュ計算を開始するための初期状態（コンテキスト）を生成します。
18// 最初の引数はオプションの鍵（キー付きハッシュ用）、今回は鍵なしなので `null` を指定します。
19// 2番目の引数はハッシュの出力長（バイト単位）で、省略するとデフォルトの長さ（通常64バイト）になります。
20$hashState = sodium_crypto_generichash_init(null);
21
22$messagePart1 = "これは最初のメッセージ部分です。";
23$messagePart2 = "そして、これは二番目の部分です。";
24$messagePart3 = "最後に、これがメッセージの最終部分です。";
25
26// 2. `sodium_crypto_generichash_update()` 関数を使用して、メッセージの各部分でハッシュの状態を更新します。
27// この関数は、最初の引数 `$state` を参照渡しで受け取り、内部でその状態を更新します。
28// これにより、複数のデータチャンクを連続してハッシュ状態に追加できます。
29echo "ハッシュ状態に最初のメッセージ部分を追加中..." . PHP_EOL;
30sodium_crypto_generichash_update($hashState, $messagePart1);
31
32echo "ハッシュ状態に二番目のメッセージ部分を追加中..." . PHP_EOL;
33sodium_crypto_generichash_update($hashState, $messagePart2);
34
35echo "ハッシュ状態に最後のメッセージ部分を追加中..." . PHP_EOL;
36sodium_crypto_generichash_update($hashState, $messagePart3);
37
38// 3. `sodium_crypto_generichash_final()` 関数で、最終的なハッシュ値を取得します。
39// すべてのメッセージ部分がハッシュ状態に追加された後、この関数を呼び出して最終結果を得ます。
40$finalHash = sodium_crypto_generichash_final($hashState);
41
42echo "段階的に計算されたジェネリックハッシュ (HEX形式): " . bin2hex($finalHash) . PHP_EOL;
43
44// 比較のために、同じメッセージ全体を一度にハッシュ化した場合も示します。
45// `sodium_crypto_generichash()` は、メッセージ全体を一度にハッシュ化するシンプルな関数です。
46$fullMessage = $messagePart1 . $messagePart2 . $messagePart3;
47$singleShotHash = sodium_crypto_generichash($fullMessage);
48
49echo "一度に計算されたジェネリックハッシュ (HEX形式): " . bin2hex($singleShotHash) . PHP_EOL;
50
51// 段階的なハッシュと一度のハッシュの結果が一致することを確認します。
52if ($finalHash === $singleShotHash) {
53    echo "結果: 段階的なハッシュと一度のハッシュは一致しました。これにより、" .
54         "`sodium_crypto_generichash_update`が正しく機能していることが確認できます。" . PHP_EOL;
55} else {
56    echo "エラー: ハッシュが一致しませんでした。" . PHP_EOL;
57}

PHPのSodium拡張は、暗号学的に安全なハッシュ、暗号化、署名などの機能を提供するlibsodiumライブラリへのバインディングです。sodium_crypto_generichash_update関数は、このSodium拡張を用いてジェネリックハッシュ（BLAKE2b）を段階的に計算する際に、ハッシュの現在の状態を更新するために使用されます。

この関数は、第一引数$stateに、sodium_crypto_generichash_init関数で初期化されたハッシュの状態を「参照渡し」で受け取ります。これにより、関数が実行されるたびに$stateの内部状態が更新され、次のデータの追加に備えられます。第二引数$messageには、ハッシュ計算に追加するデータの一部（メッセージチャンク）を文字列として指定します。この関数は戻り値を持ちません。代わりに、参照渡しされた$state変数を直接変更します。

この段階的なハッシュ計算は、非常に大きなファイルやネットワークからストリーミングされるデータなど、すべてのデータを一度にメモリにロードできない場合に特に有効です。複数のsodium_crypto_generichash_update呼び出しでデータを追加した後、最終的にsodium_crypto_generichash_final関数を呼び出すことで、すべてのデータを含む最終的なハッシュ値が得られます。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのSodium拡張機能における
5 * sodium_crypto_generichash_update 関数の使用例を示します。
6 *
7 * sodium_crypto_generichash_update は、大きなデータやストリームのハッシュを
8 * 段階的に計算する際に、データをチャンクごとにハッシュ状態に追加するために使用されます。
9 * この機能を利用するには、PHPにSodium拡張機能が有効になっている必要があります。
10 */
11
12/**
13 * メッセージを複数のチャンクに分割してジェネリックハッシュを計算します。
14 *
15 * @param string $part1 ハッシュするメッセージの最初の部分
16 * @param string $part2 ハッシュするメッセージの次の部分
17 * @return string 計算された最終ハッシュ（バイナリ形式）
18 */
19function calculate_incremental_generichash(string $part1, string $part2): string
20{
21    // 1. ハッシュ計算の状態を初期化します。
22    // sodium_crypto_generichash_init() は、ハッシュの状態を保持する内部変数を返します。
23    $state = sodium_crypto_generichash_init();
24
25    // 2. 最初のメッセージチャンクをハッシュ状態に追加します。
26    // sodium_crypto_generichash_update は、参照渡しされたハッシュの状態変数 ($state) を更新します。
27    // 戻り値はありません。
28    sodium_crypto_generichash_update($state, $part1);
29
30    // 3. 次のメッセージチャンクをハッシュ状態に追加します。
31    // これにより、ハッシュは前の状態にこの新しいデータを含めて計算を続けます。
32    sodium_crypto_generichash_update($state, $part2);
33
34    // 4. ハッシュ計算を終了し、最終的なハッシュ値を取得します。
35    // sodium_crypto_generichash_final() は、最終的なハッシュ値をバイナリ文字列で返します。
36    return sodium_crypto_generichash_final($state);
37}
38
39// サンプルデータ
40$messagePart1 = "The quick brown fox ";
41$messagePart2 = "jumps over the lazy dog.";
42
43// 段階的なハッシュ計算を実行
44$incrementalHash = calculate_incremental_generichash($messagePart1, $messagePart2);
45
46// 結果を表示 (HEX形式に変換して読みやすくします)
47echo "Incremental Hash (HEX): " . sodium_bin2hex($incrementalHash) . PHP_EOL;
48
49// 参考: 全メッセージを一度にハッシュ計算した場合
50$fullMessage = $messagePart1 . $messagePart2;
51$oneShotHash = sodium_crypto_generichash($fullMessage);
52
53echo "One-shot Hash (HEX):   " . sodium_bin2hex($oneShotHash) . PHP_EOL;
54
55// 段階的計算と一度の計算の結果が一致することを確認 (セキュリティのために hash_equals を使用)
56if (hash_equals(sodium_bin2hex($incrementalHash), sodium_bin2hex($oneShotHash))) {
57    echo "結果は一致します。" . PHP_EOL;
58} else {
59    echo "エラー: 結果が一致しません。" . PHP_EOL;
60}
61

sodium_crypto_generichash_update関数は、PHP 8で提供されるSodium拡張機能の一部で、特に大きなデータやストリームのハッシュ値を、データを分割して段階的に計算したい場合に利用されます。この関数は、ハッシュ計算の現在の状態を保持する$state変数に、渡された$message（データの部分）を追加し、ハッシュの状態を更新します。$stateは参照渡しされ、関数内で直接更新されます。この関数には戻り値がありません。

ハッシュ計算は、まずsodium_crypto_generichash_init()で初期状態を作成し、その後、本関数を繰り返し呼び出してデータを順次追加し、最後にsodium_crypto_generichash_final()で最終的なハッシュ値を取得する流れで行われます。これにより、メモリに全てのデータを一度にロードすることなく、効率的にハッシュを計算できます。この機能を利用するには、PHPにSodium拡張機能がインストールされ、有効になっている必要があります。