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

Copy
1<?php
2
3/**
4 * PHPのSodium拡張機能が提供するXChaCha20ストリーム暗号の基本的な使用法を示します。
5 * sodium_crypto_stream_xchacha20関数は、直接データを暗号化するのではなく、
6 * 暗号化/復号化のための鍵ストリームを生成します。
7 * この鍵ストリームをプレーンテキストとXORすることで、実際の暗号化と復号化が行われます。
8 */
9function demonstrateXChaCha20StreamCipher(): void
10{
11    // 1. XChaCha20ストリーム暗号用の安全な鍵を生成します。
12    // 鍵の長さは常にSODIUM_CRYPTO_STREAM_XCHACHA20_KEYBYTES (32バイト) です。
13    $key = sodium_crypto_stream_xchacha20_keygen();
14    echo "生成された鍵 (HEX): " . bin2hex($key) . PHP_EOL;
15
16    // 2. ナンス (Nonce: Number Used Once) を生成します。
17    // ナンスは同じ鍵で複数のメッセージを暗号化する際に、各メッセージで必ず異なる値でなければなりません。
18    // 長さはSODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES (24バイト) です。
19    $nonce = random_bytes(SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES);
20    echo "生成されたナンス (HEX): " . bin2hex($nonce) . PHP_EOL;
21
22    // 3. 暗号化したいプレーンテキストデータを用意します。
23    $plaintext = "システムエンジニアを目指す初心者の皆様、PHPとSodiumで安全なデータ処理を学びましょう！";
24    // 鍵ストリームの生成に必要なプレーンテキストのバイト長を取得します。
25    $plaintextLength = mb_strlen($plaintext, '8bit');
26    echo "プレーンテキスト: " . $plaintext . PHP_EOL;
27    echo "プレーンテキスト長 (バイト): " . $plaintextLength . PHP_EOL;
28
29    // 4. 指定された長さの鍵ストリームを生成します。
30    // この関数が、リファレンス情報で示されている `sodium_crypto_stream_xchacha20` です。
31    // 鍵ストリームの長さは、暗号化したいプレーンテキストの長さと一致させる必要があります。
32    $keystream = sodium_crypto_stream_xchacha20($plaintextLength, $nonce, $key);
33    echo "生成された鍵ストリーム (先頭16バイト HEX): " . bin2hex(substr($keystream, 0, 16)) . "..." . PHP_EOL;
34
35    // 5. プレーンテキストと鍵ストリームをXORすることで暗号化を行います。
36    // ストリーム暗号では、これが暗号化の基本原理です。
37    $ciphertext = $plaintext ^ $keystream;
38    echo "暗号化されたデータ (先頭16バイト HEX): " . bin2hex(substr($ciphertext, 0, 16)) . "..." . PHP_EOL;
39
40    // 6. 暗号化されたデータと *同じ* 鍵ストリームをXORすることで復号化を行います。
41    // ストリーム暗号の特性上、暗号化と同じ鍵ストリームを再度XORすることで元のデータに戻ります。
42    $decryptedText = $ciphertext ^ $keystream;
43    echo "復号化されたテキスト: " . $decryptedText . PHP_EOL;
44
45    // 復号化が成功したかを確認します。
46    if ($plaintext === $decryptedText) {
47        echo "復号化成功: 元のプレーンテキストと一致しました。" . PHP_EOL;
48    } else {
49        echo "復号化失敗: 元のプレーンテキストと一致しませんでした。" . PHP_EOL;
50    }
51
52    // 注意:
53    // 実際のアプリケーションでは、データの機密性だけでなく、改ざん防止 (認証) も重要です。
54    // そのため、通常は `sodium_crypto_aead_xchacha20poly1305_ietf_encrypt()` のような
55    // 認証付き暗号化 (Authenticated Encryption with Associated Data, AEAD) を使用することを推奨します。
56    // この例は、`sodium_crypto_stream_xchacha20` の基本的な動作を理解するためのものです。
57}
58
59// 'sodium' 拡張機能がロードされているか確認し、デモンストレーションを実行します。
60if (extension_loaded('sodium')) {
61    demonstrateXChaCha20StreamCipher();
62} else {
63    echo "エラー: 'sodium' 拡張機能がPHPにロードされていません。php.iniで有効にしてください。" . PHP_EOL;
64}

PHPのsodium_crypto_stream_xchacha20関数は、セキュアな暗号化機能を提供する「Sodium」拡張機能の一部です。Sodiumは、現代的な暗号アルゴリズムを安全かつ簡単に利用できるよう設計されたライブラリであり、PHP 7.2以降では標準で提供されています。

この関数は、XChaCha20ストリーム暗号の「鍵ストリーム」を生成するために使用されます。引数として、生成したい鍵ストリームのバイト長を示す$length、一度だけ使用される乱数値である$nonce（ナンス）、そして暗号化に用いる$keyを受け取ります。戻り値は、指定された長さの鍵ストリーム（文字列）です。

サンプルコードでは、まずsodium_crypto_stream_xchacha20_keygen()で安全な鍵を生成し、random_bytes()でナンスを用意します。次に、暗号化したい平文のバイト長を$lengthとしてsodium_crypto_stream_xchacha20関数を呼び出し、鍵ストリームを取得します。この鍵ストリームと平文をビットごとのXOR演算で組み合わせることで、データを暗号化します。復号化は、暗号文と全く同じ鍵ストリームを再度XORするだけで可能です。

ただし、sodium_crypto_stream_xchacha20単体ではデータの改ざんを検知する機能がないため、実際のアプリケーションでは、データの機密性と完全性を同時に保証するsodium_crypto_aead_xchacha20poly1305_ietf_encrypt()のような「認証付き暗号化（AEAD）」の使用が強く推奨されます。この例は、鍵ストリームの生成と利用の基本を理解するためのものです。

Copy
1<?php
2
3// sodium_crypto_stream_xchacha20 の使い方を示すサンプルコードです。
4// この関数は、指定された鍵、ノンス、長さに基づいて疑似乱数ストリームを生成します。
5
6// --- 1. 秘密鍵を生成する ---
7// XChaCha20ストリーム暗号で使用するための暗号学的に安全な鍵を生成します。
8// この鍵は秘密に保ち、安全に保管する必要があります。
9$key = sodium_crypto_stream_xchacha20_keygen();
10
11// --- 2. ユニークなノンスを生成する ---
12// ノンス (number used once) は、同じ鍵で生成するストリームごとにユニークである必要があります。
13// ノンスは秘密にする必要はありません。XChaCha20は24バイトのノンスを要求します。
14$nonce = random_bytes(SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES);
15
16// --- 3. 必要なストリームの長さを定義する ---
17$streamLength = 64; // 例: 64バイトの疑似乱数ストリームを生成します
18
19// --- 4. 疑似乱数ストリームを生成する ---
20// sodium_crypto_stream_xchacha20 関数は、提供された長さ、ノンス、鍵に基づいて
21// 疑似乱数バイトのストリームを生成します。
22// 出力はバイト列 (string) です。
23$stream = sodium_crypto_stream_xchacha20($streamLength, $nonce, $key);
24
25echo "生成されたストリーム (最初の16バイトを16進数で表示): " . substr(bin2hex($stream), 0, 32) . "..." . PHP_EOL;
26echo "ストリームの長さ: " . strlen($stream) . " バイト" . PHP_EOL;
27
28// --- セキュリティのベストプラクティス: メモリ上の機密データをクリアする ---
29// メモリダンプなどからの情報漏洩を防ぐため、不要になった機密データはメモリから上書きしてクリアすることが推奨されます。
30sodium_memzero($key);
31sodium_memzero($nonce);
32// ストリーム自体が使用後に機密である場合、これもクリアすることが考えられます。
33// sodium_memzero($stream);
34
35?>

sodium_crypto_stream_xchacha20関数は、XChaCha20ストリーム暗号アルゴリズムに基づき、指定された長さの暗号学的に安全な疑似乱数バイト列を生成します。これは、データストリームの暗号化や一意な値の生成などに応用できます。

サンプルコードでは、この関数の基本的な使い方を示しています。まず、sodium_crypto_stream_xchacha20_keygen()関数を用いて、ストリーム生成に必要な秘密鍵を作成します。この鍵は機密情報であり、厳重に管理する必要があります。次に、random_bytes()関数と関連する定数を使って、一意のノンス（number used once）を生成します。ノンスは、同じ鍵で複数のストリームを生成する際に、必ず異なる値を用いる識別子で、秘密にする必要はありません。

その後、生成したいストリームの長さをバイト単位で指定し、これら $length（生成するストリームのバイト数）、$nonce（24バイトのユニークなノンス）、$key（32バイトの秘密鍵）の三つの引数をsodium_crypto_stream_xchacha20関数に渡します。この関数は、指定された条件に基づいて生成された疑似乱数バイト列を文字列として返します。

最後に、セキュリティのベストプラクティスとして、使用し終えた秘密鍵やノンスなどの機密データは、sodium_memzero()関数を用いてメモリから安全に消去することが推奨されています。