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

Copy
1<?php
2
3/**
4 * Libsodiumの対称鍵ストリーム暗号化機能を使用して、データの暗号化と復号化を実演します。
5 * sodium_crypto_secretstream_xchacha20poly1305_init_push 関数が
6 * ストリームの暗号化開始点としてどのように機能するかを示します。
7 */
8function demonstrateSecretStreamEncryption(): void
9{
10    // 1. 共通秘密鍵を生成します。この鍵は暗号化と復号化の両方に必要です。
11    //    鍵は厳重に管理されるべきであり、絶対に漏洩してはなりません。
12    $key = sodium_crypto_secretstream_xchacha20poly1305_keygen();
13    echo "秘密鍵が生成されました。\n\n";
14
15    // 2. プッシュ操作（データの暗号化）を初期化します。
16    //    sodium_crypto_secretstream_xchacha20poly1305_init_push は、
17    //    ストリームのヘッダと、後続のプッシュ操作で使用する状態オブジェクトを配列で返します。
18    //    このヘッダは復号化を開始するために必要となります。
19    $initResult = sodium_crypto_secretstream_xchacha20poly1305_init_push($key);
20    $header = $initResult['header'];
21    $pushState = $initResult['state']; // この状態変数は参照渡しで更新されます
22    
23    echo "ストリーム暗号化の準備ができました。\n";
24    echo "ヘッダ (Hex): " . bin2hex($header) . "\n\n";
25
26    // 暗号化する元のデータ（メッセージ）
27    $originalMessage = "これはシステムエンジニア初心者のための秘密のメッセージです。";
28    // オプションで、暗号文と一緒に認証される追加データ（AD）を提供できます。
29    // ADは暗号化されませんが、データの改ざん検出に使用されます。
30    $additionalData = "このメッセージの付加情報";
31
32    echo "元のメッセージ: " . $originalMessage . "\n";
33    echo "追加データ: " . $additionalData . "\n\n";
34
35    // 3. メッセージを暗号化します。
36    //    sodium_crypto_secretstream_xchacha20poly1305_push は、
37    //    現在のストリーム状態、メッセージ、追加データ、およびメッセージのタグを受け取り、
38    //    暗号文を返します。$pushStateは暗号化の進行に伴い内部で更新されます。
39    $ciphertext = sodium_crypto_secretstream_xchacha20poly1305_push(
40        $pushState,
41        $originalMessage,
42        $additionalData,
43        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE // メッセージブロックの標準タグ
44    );
45    echo "暗号化されたメッセージ (Hex): " . bin2hex($ciphertext) . "\n\n";
46
47    // --- ここから復号化のプロセス ---
48
49    // 4. プル操作（データの復号化）を初期化します。
50    //    sodium_crypto_secretstream_xchacha20poly1305_init_pull は、
51    //    暗号化時に使用されたヘッダと共通秘密鍵を使用して、復号化の状態オブジェクトを生成します。
52    $pullState = sodium_crypto_secretstream_xchacha20poly1305_init_pull($header, $key);
53    echo "ストリーム復号化の準備ができました。\n\n";
54
55    // 5. 暗号化されたメッセージを復号化します。
56    //    sodium_crypto_secretstream_xchacha20poly1305_pull は、
57    //    現在のストリーム状態、暗号文、および追加データを受け取り、
58    //    復号化されたメッセージとタグを配列で返します。
59    //    $pullStateも復号化の進行に伴い内部で更新されます。
60    //    データが改ざんされているか、鍵が間違っている場合はfalseを返します。
61    $decryptResult = sodium_crypto_secretstream_xchacha20poly1305_pull(
62        $pullState,
63        $ciphertext,
64        $additionalData
65    );
66
67    if ($decryptResult === false) {
68        echo "エラー: メッセージの復号化に失敗しました。データが改ざんされたか、鍵が間違っています。\n";
69        return;
70    }
71
72    $decryptedMessage = $decryptResult['message'];
73    $tag = $decryptResult['tag'];
74
75    echo "復号化されたメッセージ: " . $decryptedMessage . "\n";
76    echo "復号化されたメッセージのタグ: " . $tag . "\n\n"; // タグはメッセージのタイプを示します
77
78    // 6. 復号化されたメッセージが元のメッセージと完全に一致するか確認します。
79    if ($decryptedMessage === $originalMessage) {
80        echo "成功: メッセージは正しく暗号化され、復号化されました。\n";
81    } else {
82        echo "失敗: 復号化されたメッセージが元のメッセージと一致しません。\n";
83    }
84}
85
86// 関数を実行して、ストリーム暗号化と復号化のデモンストレーションを開始します。
87demonstrateSecretStreamEncryption();

PHPのsodium_crypto_secretstream_xchacha20poly1305_init_push関数は、セキュリティ拡張機能であるLibsodiumライブラリの一部で、データを安全にやり取りするための「ストリーム暗号化」を開始する際に利用されます。この関数は、引数として暗号化と復号化の両方で使う共通の秘密鍵（$key）を受け取ります。この秘密鍵は非常に重要であり、絶対に他人に漏洩しないよう厳重に管理する必要があります。

関数が実行されると、戻り値としてarray型の情報が返されます。この配列には二つの主要な要素が含まれています。一つは「ヘッダ」で、これは復号化を開始するために必要となる情報です。もう一つは、データの暗号化を進めていくための「状態オブジェクト」です。サンプルコードでは、まず秘密鍵を生成し、次にこの関数を使って暗号化の準備を行っています。得られたヘッダと状態オブジェクトは、その後の実際のメッセージ暗号化（sodium_crypto_secretstream_xchacha20poly1305_push）や、復号化（sodium_crypto_secretstream_xchacha20poly1305_init_pullとsodium_crypto_secretstream_xchacha20poly1305_pull）のプロセスで不可欠な要素として活用されます。これにより、大きなデータでも効率的かつ安全に暗号化・復号化ができる仕組みが提供されます。

Copy
1<?php
2
3/**
4 * ストリーム暗号化の初期化とメッセージのプッシュ、および復号の例。
5 *
6 * このスクリプトはPHP 8以上とSodium拡張モジュールが必要です。
7 *
8 * sodium_crypto_secretstream_xchacha20poly1305_init_push は、
9 * 連続したデータを安全に暗号化・復号するためのストリーム暗号化を開始します。
10 * これは、単一メッセージを暗号化する sodium_crypto_secretbox とは異なり、
11 * より大きなデータやストリーム処理に適しています。
12 */
13function demonstrateSecretStreamEncryption(): void
14{
15    // 1. ストリーム暗号化に使用する秘密鍵を生成します。
16    // この鍵は送信者と受信者の間で安全に共有される必要があります。
17    $key = sodium_crypto_secretstream_xchacha20poly1305_keygen();
18    echo "生成された秘密鍵 (Base64エンコード): " . base64_encode($key) . PHP_EOL . PHP_EOL;
19
20    // 2. プッシュモードのストリーム暗号化を初期化します。
21    // sodium_crypto_secretstream_xchacha20poly1305_init_push は、
22    // 初期状態 ('state') と、受信者に最初に送信する必要があるヘッダー ('header') を含む配列を返します。
23    // このヘッダーは、復号側がストリームを初期化するために不可欠です。
24    $initResult = sodium_crypto_secretstream_xchacha20poly1305_init_push($key);
25    $pushState = $initResult['state'];
26    $header = $initResult['header'];
27
28    echo "=== 暗号化側 (送信者) ===\n";
29    echo "ストリームヘッダー (Base64エンコード): " . base64_encode($header) . PHP_EOL;
30
31    // 暗号化するメッセージの例
32    $message1 = "これは最初の秘密のメッセージブロックです。";
33    $message2 = "そして、これは続く2番目のメッセージブロックです。";
34    $message3 = "これがストリームの最後のメッセージブロックです。";
35
36    // 3. メッセージをストリームにプッシュ（暗号化）します。
37    // SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE は通常のメッセージタグです。
38    // ストリームの最後のメッセージには SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL を使用し、
39    // ストリームの終了を示します。
40    $cipherText1 = sodium_crypto_secretstream_xchacha20poly1305_push(
41        $pushState,
42        $message1,
43        '', // 関連データ (AD): 必要に応じて認証するデータを含めることができますが、今回は空にしています。
44        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
45    );
46    echo "暗号文1 (Base64エンコード): " . base64_encode($cipherText1) . PHP_EOL;
47
48    $cipherText2 = sodium_crypto_secretstream_xchacha20poly1305_push(
49        $pushState,
50        $message2,
51        '',
52        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE
53    );
54    echo "暗号文2 (Base64エンコード): " . base64_encode($cipherText2) . PHP_EOL;
55
56    $cipherText3 = sodium_crypto_secretstream_xchacha20poly1305_push(
57        $pushState,
58        $message3,
59        '',
60        SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL // 最後のメッセージを示すタグ
61    );
62    echo "暗号文3 (Base64エンコード): " . base64_encode($cipherText3) . PHP_EOL . PHP_EOL;
63
64    // 4. 受信側でのストリーム復号をシミュレートします。
65    echo "=== 復号側 (受信者) ===\n";
66
67    // 受信側は、送信者から受け取ったヘッダーと共有された鍵を使ってストリームの復号を初期化します。
68    $pullState = sodium_crypto_secretstream_xchacha20poly1305_init_pull($header, $key);
69
70    // 各暗号文をプル（復号）します。
71    $decrypted1 = sodium_crypto_secretstream_xchacha20poly1305_pull($pullState, $cipherText1);
72    if ($decrypted1 !== false) {
73        echo "復号されたメッセージ1: " . $decrypted1['message'] . PHP_EOL;
74        // $decrypted1['tag'] には元のメッセージのタグ情報が含まれます
75    } else {
76        echo "メッセージ1の復号に失敗しました。" . PHP_EOL;
77    }
78
79    $decrypted2 = sodium_crypto_secretstream_xchacha20poly1305_pull($pullState, $cipherText2);
80    if ($decrypted2 !== false) {
81        echo "復号されたメッセージ2: " . $decrypted2['message'] . PHP_EOL;
82    } else {
83        echo "メッセージ2の復号に失敗しました。" . PHP_EOL;
84    }
85
86    $decrypted3 = sodium_crypto_secretstream_xchacha20poly1305_pull($pullState, $cipherText3);
87    if ($decrypted3 !== false) {
88        echo "復号されたメッセージ3: " . $decrypted3['message'] . PHP_EOL;
89        // 最後のメッセージなので、タグは SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL であるはずです
90        echo "最終メッセージのタグ: " . ($decrypted3['tag'] === SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL ? "TAG_FINAL" : "UNKNOWN_TAG") . PHP_EOL;
91    } else {
92        echo "メッセージ3の復号に失敗しました。" . PHP_EOL;
93    }
94}
95
96// サンプル関数の実行
97demonstrateSecretStreamEncryption();
98
99?>

sodium_crypto_secretstream_xchacha20poly1305_init_push関数は、PHP 8で利用可能なSodium拡張モジュールの一部で、連続したデータを安全に暗号化・復号するための「ストリーム暗号化」を開始する際に使用されます。これは、単一のメッセージを暗号化するsodium_crypto_secretboxとは異なり、大量のデータや、分割されたメッセージを順次処理する際に特に有効です。

この関数は、暗号化と復号の両方で使用される共通の秘密鍵を、文字列型の$key引数として受け取ります。この鍵は、送信者と受信者の間で事前に安全に共有されている必要があります。

関数が正常に実行されると、ストリームの初期状態と、復号側がストリームを初期化するために不可欠なヘッダーを含む配列が戻り値として返されます。具体的には、この配列には「state」（現在の暗号化状態を保持する情報）と「header」（受信側に最初に送るべき情報）の2つの要素が含まれます。特に「header」は、復号側でsodium_crypto_secretstream_xchacha20poly1305_init_pull関数を使って復号を開始する際に必須となるため、暗号文を送信する前に必ず受信側に渡す必要があります。

サンプルコードでは、まず秘密鍵を生成し、この関数でストリーム暗号化を初期化します。その後、返された情報を使って複数のメッセージブロックを安全に暗号化し（プッシュ）、復号側がヘッダーと秘密鍵を用いてそれらの暗号文を元のメッセージに戻す（プル）一連の流れを示しており、連続データの秘匿性を確保する上で重要な役割を果たします。