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

Copy
1<?php
2
3// このコードは sodium_crypto_stream_xor 関数を使用して、データの暗号化と復号化を行います。
4// これはストリーム暗号の一種であり、メッセージと擬似乱数ストリームをXORすることでデータを保護します。
5
6// 必要な定数が定義されているか確認します (PHP Sodium 拡張が必要)。
7if (!extension_loaded('sodium')) {
8    die('PHP Sodium extension is not loaded. Please enable it.');
9}
10
11// 1. 暗号化に必要なキーを生成します。
12// キーは秘密に保ち、安全に管理する必要があります。
13// SODIUM_CRYPTO_STREAM_KEYBYTES は、このストリーム暗号に必要なキーのバイト数を示します。
14$key = random_bytes(SODIUM_CRYPTO_STREAM_KEYBYTES);
15
16// 2. ノンス (Nonce) を生成します。
17// ノンスはメッセージごとにユニークである必要がありますが、秘密にする必要はありません。
18// 暗号文と一緒に送信できます。
19// SODIUM_CRYPTO_STREAM_NONCEBYTES は、このストリーム暗号に必要なノンスのバイト数を示します。
20$nonce = random_bytes(SODIUM_CRYPTO_STREAM_NONCEBYTES);
21
22// 3. 暗号化する元のメッセージを定義します。
23$originalMessage = "Hello, this is a confidential message that needs protection!";
24echo "Original Message: " . $originalMessage . PHP_EOL;
25
26// 4. sodium_crypto_stream_xor を使用してメッセージを暗号化します。
27// この関数は、入力メッセージと、ノンスおよびキーから生成されるキーストリームをXORします。
28// 結果として暗号文が生成されます。
29$encryptedMessage = sodium_crypto_stream_xor($originalMessage, $nonce, $key);
30
31echo "Encrypted Message (Base64 encoded for display): " . base64_encode($encryptedMessage) . PHP_EOL;
32
33// 5. sodium_crypto_stream_xor を使用して暗号化されたメッセージを復号化します。
34// 暗号化時と同じノンスとキーを使用することで、元のメッセージを正確に復元できます。
35// これは XOR の数学的性質 (A XOR B) XOR B = A を利用しています。
36$decryptedMessage = sodium_crypto_stream_xor($encryptedMessage, $nonce, $key);
37
38echo "Decrypted Message: " . $decryptedMessage . PHP_EOL;
39
40// 6. 暗号化と復号化が正しく行われたか検証します。
41if ($originalMessage === $decryptedMessage) {
42    echo "Verification successful: Original and decrypted messages match." . PHP_EOL;
43} else {
44    echo "Verification failed: Messages do not match." . PHP_EOL;
45}
46

PHP 8で提供されるsodium_crypto_stream_xor関数は、データの暗号化と復号化を行うためのストリーム暗号機能を提供します。この関数は、メッセージ、ノンス、キーという3つの引数を受け取り、文字列を返します。

第一引数の$messageには、暗号化または復号化の対象となる文字列データを指定します。第二引数の$nonceは「ナンバーワンス」の略で、メッセージごとにユニークである必要がありますが、秘密にする必要はありません。暗号文とともに公開して問題ありません。第三引数の$keyは、データを保護するための秘密の鍵であり、厳重に管理する必要があります。

sodium_crypto_stream_xorは、入力されたメッセージと、ノンスおよびキーから生成されるキーストリームをXOR（排他的論理和）演算によって結合し、暗号文を生成します。復号化を行う際も、暗号化時と全く同じノンスとキーを使って暗号文を再度この関数に渡すことで、XORの数学的特性により元のメッセージを正確に復元できます。

戻り値は、暗号化された、または復号化された結果の文字列です。この関数を利用するには、PHPにSodium拡張がロードされている必要があります。セキュリティを確保するため、キーは安全に生成し、ノンスは必ずメッセージごとに異なる値を使用することが重要です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHP Sodium Stream XOR Encryption/Decryption Example.
7 *
8 * この関数は、PHPのSodium拡張機能を利用して、ストリーム暗号による
9 * データの暗号化と復号化を行うサンプルコードを提供します。
10 *
11 * PHPのSodium拡張は、安全で使いやすい現代的な暗号ライブラリ
12 * (libsodiumのPHPバインディング) を提供します。
13 * PHP 7.2以降で標準でバンドルされており、システムエンジニアが
14 * 自身のアプリケーションに堅牢な暗号機能を実装するのを支援します。
15 *
16 * sodium_crypto_stream_xor 関数は、指定されたメッセージを
17 * 鍵 (key) とノンス (nonce) を使ってXOR暗号化または復号化します。
18 * 同じ鍵とノンスを使用することで、暗号化と復号化の両方に利用できます。
19 * ノンスは、同じ鍵で複数のメッセージを処理する際に、各メッセージで
20 * 必ず異なる値を使い、再利用しないことが極めて重要です。
21 */
22function demonstrateSodiumStreamXor(): void
23{
24    echo "PHP Sodium Stream XOR 暗号化/復号化のデモンストレーション\n\n";
25
26    // 1. セキュアなランダム鍵を生成します。
27    // SODIUM_CRYPTO_STREAM_KEYBYTES は、ストリーム暗号に必要な鍵の長さを定義します。
28    $key = sodium_crypto_stream_keygen();
29    echo "生成された鍵 (HEX): " . bin2hex($key) . "\n";
30
31    // 2. セキュアなランダムノンス (Number Used Once) を生成します。
32    // ノンスは、同じ鍵で暗号化するすべてのメッセージに対して一意である必要があります。
33    // SODIUM_CRYPTO_STREAM_NONCEBYTES は、必要なノンスの長さを定義します。
34    $nonce = random_bytes(SODIUM_CRYPTO_STREAM_NONCEBYTES);
35    echo "生成されたノンス (HEX): " . bin2hex($nonce) . "\n\n";
36
37    // 3. 暗号化する平文メッセージを定義します。
38    $plaintext = "これは sodium_crypto_stream_xor を使って暗号化される秘密のメッセージです。";
39    echo "元の平文: " . $plaintext . "\n";
40    echo "平文の長さ: " . strlen($plaintext) . " バイト\n\n";
41
42    // 4. メッセージを暗号化します。
43    // sodium_crypto_stream_xor は、鍵とノンスからキーストリームを生成し、
44    // それを平文とXOR演算することで暗号文を生成します。
45    $ciphertext = sodium_crypto_stream_xor($plaintext, $nonce, $key);
46    echo "暗号文 (HEX): " . bin2hex($ciphertext) . "\n";
47    echo "暗号文の長さ: " . strlen($ciphertext) . " バイト\n\n";
48
49    // 5. 暗号文を復号化します。
50    // 復号化するには、暗号化時とまったく同じ鍵とノンスを使用します。
51    // 暗号文を、同じ鍵とノンスから生成されたキーストリームでXOR演算すると、
52    // 元の平文に戻ります。
53    $decryptedText = sodium_crypto_stream_xor($ciphertext, $nonce, $key);
54    echo "復号化されたテキスト: " . $decryptedText . "\n\n";
55
56    // 6. 復号化が正しく行われたかを確認します。
57    if ($plaintext === $decryptedText) {
58        echo "復号化に成功しました: 元の平文と復号化されたテキストが一致します。\n";
59    } else {
60        echo "復号化に失敗しました: 平文が一致しません！\n";
61    }
62
63    // 7. 機密性の高いデータ (鍵やノンスなど) は、使用後にメモリから安全に消去することが推奨されます。
64    // これにより、攻撃者がメモリダンプなどから機密情報を取得するリスクを低減できます。
65    sodium_memzero($key);
66    sodium_memzero($nonce);
67}
68
69// Sodium拡張機能がロードされていることを確認します。
70// ロードされていない場合は、エラーメッセージを表示します。
71if (!extension_loaded('sodium')) {
72    echo "エラー: 'sodium' 拡張機能がロードされていません。php.ini で有効にしてください。\n";
73} else {
74    // 拡張機能がロードされていれば、デモンストレーションを実行します。
75    demonstrateSodiumStreamXor();
76}

PHPのsodium_crypto_stream_xor関数は、安全な暗号化ライブラリであるPHP Sodium拡張機能の一部です。PHP 7.2以降で標準で提供されており、システムエンジニアが堅牢な暗号化機能をアプリケーションに組み込む際に役立ちます。この関数は、ストリーム暗号の仕組みを利用して、データの暗号化と復号化を行います。

この関数は3つの引数を取ります。1つ目の$messageには、暗号化したい元のデータ（平文）または復号化したい暗号化されたデータ（暗号文）を指定します。2つ目の$nonceは「ナンバー・ユーズド・ワンス」の略で、同じ鍵を使用して複数のメッセージを処理する際に、各メッセージで必ず異なる一意の値を生成して使用することが極めて重要です。このノンスの再利用はセキュリティ上の重大な脆弱性となります。3つ目の$keyは、暗号化と復号化の両方に使う秘密の鍵です。関数は処理結果として、暗号化または復号化されたデータを文字列として返します。

サンプルコードでは、まずセキュアな鍵とノンスを生成し、平文メッセージをsodium_crypto_stream_xor関数で暗号化しています。その後、全く同じ鍵とノンスを再度この関数に渡すことで、暗号文が元の平文に復号化される様子が示されています。これにより、同じ関数と鍵・ノンスの組み合わせで暗号化と復号化の両方が可能であることがわかります。機密性の高い鍵やノンスは、使用後にメモリから安全に消去することが推奨されます。