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

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPのSodium拡張機能における
5 * ストリーム暗号化（SecretStream）機能と、
6 * その途中で内部鍵を再生成（rekey）する
7 * `sodium_crypto_secretstream_xchacha20poly1305_rekey`関数の使用方法を示します。
8 *
9 * `sodium_crypto_secretbox`が単一のメッセージを認証付きで暗号化するのに適しているのに対し、
10 * SecretStreamは大量のデータや連続するメッセージを効率的かつ安全に処理するために設計されています。
11 * `rekey`機能は、長期間にわたるストリーム暗号化において、定期的に内部の暗号化状態を更新することで、
12 * 鍵の漏洩リスクを低減し、より高いセキュリティを維持するために重要です。
13 *
14 * この例では、メッセージを暗号化する途中で`rekey`を行い、
15 * その後もストリームが正常に機能し、すべてのメッセージが正しく復号されることを確認します。
16 */
17function demonstrateSecretStreamRekeying(): void
18{
19    // 1. ストリーム暗号化に使用する秘密鍵を生成します。
20    // この鍵は送信者と受信者の両方で共有される必要があります。
21    $key = sodium_crypto_secretstream_xchacha20poly1305_keygen();
22    echo "ストリーム用秘密鍵 (Hex): " . bin2hex($key) . PHP_EOL;
23    echo "----------------------------------------------------" . PHP_EOL;
24
25    $messages = [
26        "最初の秘密メッセージ（リキー前）。",
27        "2番目の秘密メッセージ（リキー後）。",
28        "3番目の秘密メッセージ（ストリーム継続）。"
29    ];
30    $encryptedStream = []; // 暗号化されたメッセージを格納する配列
31
32    // --- 暗号化フェーズ ---
33
34    echo "--- 暗号化処理 ---" . PHP_EOL;
35
36    // プッシュ（暗号化）状態を初期化します。
37    // これにより、ストリームのヘッダと初期暗号化状態が取得されます。
38    // ヘッダは復号時に必要となります。
39    list($streamStatePush, $header) = sodium_crypto_secretstream_xchacha20poly1305_init_push($key);
40    $encryptedStream[] = $header; // ヘッダはストリームの最初の部分として格納します。
41
42    echo "ストリームヘッダ (Hex): " . bin2hex($header) . PHP_EOL;
43
44    // 最初のメッセージを暗号化します。
45    $encryptedMessage1 = sodium_crypto_secretstream_xchacha20poly1305_push(
46        $streamStatePush,
47        $messages[0],
48        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE // 通常のメッセージを示すタグ
49    );
50    $encryptedStream[] = $encryptedMessage1;
51    echo "暗号化済みメッセージ 1 (リキー前) (Hex): " . bin2hex($encryptedMessage1) . PHP_EOL;
52
53    // ストリームの内部状態を再生成（rekey）します。
54    // `$streamStatePush`変数は参照渡しされるため、この関数内で直接変更されます。
55    sodium_crypto_secretstream_xchacha20poly1305_rekey($streamStatePush);
56    echo "ストリームがリキーされました。内部状態が更新されました。" . PHP_EOL;
57
58    // リキー後に2番目のメッセージを暗号化します。
59    $encryptedMessage2 = sodium_crypto_secretstream_xchacha20poly1305_push(
60        $streamStatePush,
61        $messages[1],
62        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
63    );
64    $encryptedStream[] = $encryptedMessage2;
65    echo "暗号化済みメッセージ 2 (リキー後) (Hex): " . bin2hex($encryptedMessage2) . PHP_EOL;
66
67    // 最後のメッセージを暗号化します。
68    // `_TAG_FINAL`タグは、ストリームの終端を示します。
69    $encryptedMessage3 = sodium_crypto_secretstream_xchacha20poly1305_push(
70        $streamStatePush,
71        $messages[2],
72        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL
73    );
74    $encryptedStream[] = $encryptedMessage3;
75    echo "暗号化済みメッセージ 3 (最終) (Hex): " . bin2hex($encryptedMessage3) . PHP_EOL;
76    echo "----------------------------------------------------" . PHP_EOL;
77
78    // --- 復号化フェーズ ---
79
80    echo "--- 復号化処理 ---" . PHP_EOL;
81
82    // プル（復号化）状態を初期化します。
83    // 暗号化時に取得したヘッダと秘密鍵を使用します。
84    $streamStatePull = sodium_crypto_secretstream_xchacha20poly1305_init_pull($encryptedStream[0], $key);
85
86    // 最初のメッセージを復号化します。
87    list($decryptedMessage1, $tag1) = sodium_crypto_secretstream_xchacha20poly1305_pull(
88        $streamStatePull,
89        $encryptedStream[1]
90    );
91    echo "復号済みメッセージ 1: \"" . $decryptedMessage1 . "\" (タグ: " . $tag1 . ")" . PHP_EOL;
92    if ($decryptedMessage1 !== $messages[0]) {
93        echo "エラー: 復号済みメッセージ 1 が元のメッセージと一致しません。" . PHP_EOL;
94    }
95
96    // 2番目のメッセージを復号化します。
97    // 復号状態は自動的に更新され、リキーされた状態と一致します。
98    list($decryptedMessage2, $tag2) = sodium_crypto_secretstream_xchacha20poly1305_pull(
99        $streamStatePull,
100        $encryptedStream[2]
101    );
102    echo "復号済みメッセージ 2: \"" . $decryptedMessage2 . "\" (タグ: " . $tag2 . ")" . PHP_EOL;
103    if ($decryptedMessage2 !== $messages[1]) {
104        echo "エラー: 復号済みメッセージ 2 が元のメッセージと一致しません。" . PHP_EOL;
105    }
106
107    // 3番目の（最終）メッセージを復号化します。
108    list($decryptedMessage3, $tag3) = sodium_crypto_secretstream_xchacha20poly1305_pull(
109        $streamStatePull,
110        $encryptedStream[3]
111    );
112    echo "復号済みメッセージ 3: \"" . $decryptedMessage3 . "\" (タグ: " . $tag3 . ")" . PHP_EOL;
113    if ($decryptedMessage3 !== $messages[2]) {
114        echo "エラー: 復号済みメッセージ 3 が元のメッセージと一致しません。" . PHP_EOL;
115    }
116
117    echo "----------------------------------------------------" . PHP_EOL;
118    echo "すべてのメッセージがリキー後も正常に処理されました。" . PHP_EOL;
119}
120
121// Sodium拡張機能がロードされているか確認します。
122// プログラムを実行する前に、php.iniでsodium拡張を有効にする必要があります。
123if (!extension_loaded('sodium')) {
124    die('Sodium拡張機能がロードされていません。php.iniで有効にしてください。');
125}
126
127// デモンストレーションを実行します。
128demonstrateSecretStreamRekeying();

PHPのsodium_crypto_secretstream_xchacha20poly1305_rekey関数は、大量のデータや連続するメッセージを安全に暗号化・復号化するための「ストリーム暗号化」機能において、内部の暗号化鍵を途中で再生成する役割を担います。これは、単一のメッセージを暗号化するsodium_crypto_secretboxとは異なり、長期間にわたる通信のセキュリティを維持するために非常に重要です。鍵の再生成を定期的に行うことで、もし一部の鍵情報が漏洩したとしても、その影響範囲を限定し、全体のセキュリティリスクを低減できます。

この関数は、引数として&$stateを受け取ります。この$stateは、現在のストリームの暗号化状態を保持する文字列型の変数で、参照渡し（&）であるため、関数内で直接内容が更新されます。具体的には、この関数が実行されると、$stateの内部で管理されている暗号化鍵が新しいものに更新され、以降のストリーム処理はこの新しい鍵を用いて行われるようになります。戻り値はvoidであり、関数の実行結果は引数$stateの更新を通じて反映されます。

サンプルコードでは、メッセージを暗号化する途中でこのrekey関数を呼び出し、ストリームの内部状態を更新しています。これにより、rekeyの前後で暗号化されたメッセージが、受信側で問題なく復号できることを示しており、ストリーム暗号化におけるセキュリティ強化の手法を具体的に理解できます。

Copy
1<?php
2
3/**
4 * PHPのlibsodium拡張を使って、安全なストリーム暗号化と鍵再生成の例を示します。
5 * `sodium_crypto_secretstream_xchacha20poly1305_rekey`は、
6 * 長時間にわたるデータの暗号化ストリームにおいて、内部の鍵を途中で更新するための関数です。
7 * これにより、定期的に鍵を更新することでセキュリティを強化できます。
8 * `sodium_crypto_box`とは異なる暗号方式（共通鍵ストリーム暗号）ですが、
9 * どちらもlibsodiumライブラリが提供する堅牢な暗号化機能の一部です。
10 *
11 * このサンプルでは、まず共通鍵（マスターキー）を使ってストリームを初期化し、データを暗号化します。
12 * 次に`rekey`関数を使って内部鍵を再生成し、その後もデータを暗号化します。
13 * 最後に、これらの暗号化されたデータをマスターキーとストリームヘッダーを使って復号化します。
14 * 復号化側は、送信側で`rekey`が呼び出されても自動的に処理されるため、特別な操作は不要です。
15 */
16function demonstrateSecretStreamRekeying(): void
17{
18    // 1. ストリームのマスターキーを生成します。
19    // この鍵は、送信者と受信者の両方で安全に共有されている必要があります。
20    // 通常、この共通鍵は`sodium_crypto_box`のような非対称暗号方式を使って安全に交換されます。
21    $masterKey = random_bytes(SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES);
22    echo "マスターキー (HEX): " . bin2hex($masterKey) . "\n\n";
23
24    // --- 送信者側の処理 (暗号化) ---
25    echo "--- 送信者側 (暗号化) ---\n";
26
27    // ストリームの初期化（プッシュモード、つまり暗号化側）を行います。
28    // `$header` はストリームの開始を示す情報で、復号化時に必要になります。
29    // `$state` はlibsodiumがストリームの内部状態（現在の鍵など）を保持するための参照変数です。
30    [$state, $header] = sodium_crypto_secretstream_xchacha20poly1305_init_push($masterKey);
31    echo "ストリームヘッダー (HEX): " . bin2hex($header) . "\n\n";
32
33    $message1 = "これは最初のメッセージです。重要な情報を含んでいます。";
34    // 最初のメッセージを暗号化します。
35    // `SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE` は通常のメッセージタグです。
36    $encryptedMessage1 = sodium_crypto_secretstream_xchacha20poly1305_push(
37        $state,
38        $message1,
39        '', // 関連データ (AD) はオプションです。認証はされますが暗号化はされません。
40        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
41    );
42    echo "元のメッセージ1: " . $message1 . "\n";
43    echo "暗号化されたメッセージ1 (HEX): " . bin2hex($encryptedMessage1) . "\n\n";
44
45    // 鍵を再生成します。
46    // `sodium_crypto_secretstream_xchacha20poly1305_rekey`を呼び出すと、
47    // `$state`変数内の内部鍵が新しいものに更新されます。
48    // これにより、後続のメッセージは新しい鍵で暗号化され、セキュリティが強化されます。
49    echo "鍵を再生成しています (sodium_crypto_secretstream_xchacha20poly1305_rekey)...\n\n";
50    sodium_crypto_secretstream_xchacha20poly1305_rekey($state);
51
52    $message2 = "これは鍵が再生成された後に送信される2番目のメッセージです。";
53    // 2番目のメッセージを再生成された鍵で暗号化します。
54    // `rekey`関数が内部状態を更新するため、`push`関数は自動的に新しい鍵を使用します。
55    // メッセージのタグは引き続き通常のメッセージタグを使用します。
56    $encryptedMessage2 = sodium_crypto_secretstream_xchacha20poly1305_push(
57        $state,
58        $message2,
59        '', // 関連データ (AD) はオプション
60        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
61    );
62    echo "元のメッセージ2: " . $message2 . "\n";
63    echo "暗号化されたメッセージ2 (HEX): " . bin2hex($encryptedMessage2) . "\n\n";
64
65    // --- 受信者側の処理 (復号化) ---
66    echo "--- 受信者側 (復号化) ---\n";
67
68    // ストリームの初期化（プルモード、つまり復号化側）を行います。
69    // 送信者から受け取ったヘッダーとマスターキーを使用します。
70    // これにより、受信側も送信側と同じストリームの内部状態を追跡できるようになります。
71    $statePull = sodium_crypto_secretstream_xchacha20poly1305_init_pull($header, $masterKey);
72
73    // 最初のメッセージを復号化します。
74    // `pull`関数は、内部状態に基づいてメッセージを復号化し、正しい鍵で自動的に処理します。
75    [$decryptedMessage1, $tag1] = sodium_crypto_secretstream_xchacha20poly1305_pull($statePull, $encryptedMessage1);
76    echo "復号化されたメッセージ1: " . $decryptedMessage1 . "\n";
77    echo "メッセージ1のタグ: " . $tag1 . " (通常メッセージ)\n\n";
78
79    // 再生成された鍵で暗号化された2番目のメッセージを復号化します。
80    // 受信側は、送信側で`rekey`が呼び出されたことを明示的に知る必要はありません。
81    // `pull`関数は`statePull`の内部状態を更新し続けるため、
82    // 送信側で`rekey`が呼び出されても、受信側は通常通り`pull`を続けるだけで自動的に新しい鍵で復号化されます。
83    [$decryptedMessage2, $tag2] = sodium_crypto_secretstream_xchacha20poly1305_pull($statePull, $encryptedMessage2);
84    echo "復号化されたメッセージ2: " . $decryptedMessage2 . "\n";
85    echo "メッセージ2のタグ: " . $tag2 . " (通常メッセージ)\n\n";
86
87    // 復号化されたメッセージが元のメッセージと一致することを確認
88    if ($decryptedMessage1 === $message1 && $decryptedMessage2 === $message2) {
89        echo "すべてのメッセージが正しく暗号化され、復号化されました。\n";
90    } else {
91        echo "エラー: メッセージの復号化に失敗しました。\n";
92    }
93}
94
95// PHP CLI で直接実行する場合のガード
96if (php_sapi_name() === 'cli') {
97    // libsodium拡張が利用可能か確認します。
98    if (!extension_loaded('sodium')) {
99        echo "エラー: libsodium拡張がロードされていません。\n";
100        echo "PHPのインストールにlibsodium拡張を追加してください。\n";
101        exit(1);
102    }
103    demonstrateSecretStreamRekeying();
104}

sodium_crypto_secretstream_xchacha20poly1305_rekey関数は、PHPのlibsodium拡張に含まれる共通鍵ストリーム暗号機能の一部です。この関数は、長期間にわたってデータを安全に暗号化するストリーム通信において、途中で内部の暗号鍵を新しいものに更新し、セキュリティを強化することを目的としています。引数の&$stateは、ストリームの現在の内部状態（利用中の暗号鍵など）を保持する参照変数で、この関数が呼び出されると、その内部状態が更新され、以降の暗号化処理は新しい鍵で行われるようになります。戻り値はvoidであり、特定の値を直接返しません。

sodium_crypto_boxのような非対称暗号が鍵交換や認証付き暗号化に用いられるのに対し、この関数は、事前に共有された共通鍵（マスターキー）を用いてデータをストリーム形式で暗号化する際に使われます。サンプルコードでは、最初にマスターキーでストリームを初期化し、メッセージを暗号化します。その後、rekey関数を呼び出して内部鍵を更新し、さらに別のメッセージを暗号化しています。受信側では、送信側から受け取ったストリームヘッダーとマスターキーを使って復号化ストリームを初期化するだけで、送信側で鍵が再生成されたことを意識することなく、暗号化されたデータを順番に復号化できます。受信側は内部で鍵の更新を自動的に処理するため、特別な操作は不要です。