【PHP8.x】SODIUM_CRYPTO_STREAM_NONCEBYTES定数の使い方

Copy
1<?php
2
3/**
4 * Libsodiumのストリーム暗号を用いてデータを暗号化・復号化するサンプル関数です。
5 * SODIUM_CRYPTO_STREAM_NONCEBYTES 定数を使用して、ノンスの推奨バイト数を指定します。
6 *
7 * @param string $message 暗号化する平文データ
8 * @param string $key    秘密鍵 (SODIUM_CRYPTO_STREAM_KEYBYTES の長さが必要)
9 * @return array|false   暗号化されたデータとノンス、またはエラー時に false を返します。
10 */
11function encryptAndDecryptWithStream(string $message, string $key)
12{
13    // Libsodium拡張が利用可能かを確認します。
14    // PHPで暗号化機能を利用するには、この拡張機能がインストールされ有効になっている必要があります。
15    if (!extension_loaded('sodium')) {
16        echo "Error: Libsodium extension is not loaded. Please enable it.\n";
17        return false;
18    }
19
20    // SODIUM_CRYPTO_STREAM_NONCEBYTES は、ストリーム暗号 (例: sodium_crypto_stream_xor)
21    // で使用するノンス（Number Once）のバイト数（長さ）を示します。
22    // ノンスは、同じ鍵で複数のメッセージを暗号化する際に、必ず各メッセージで異なる値を使用する必要がある、
23    // セキュリティ上重要なランダムな値です。
24    //
25    // キーワードである sodium_crypto_secretbox もノンスを使用しますが、
26    // secretbox で使用するノンスの推奨サイズは SODIUM_CRYPTO_SECRETBOX_NONCEBYTES となり、
27    // SODIUM_CRYPTO_STREAM_NONCEBYTES とは異なる点に注意してください。
28    $nonce = random_bytes(SODIUM_CRYPTO_STREAM_NONCEBYTES);
29
30    // sodium_crypto_stream_xor() を使用してメッセージを暗号化します。
31    // これは、メッセージとノンスからキーストリームを生成し、
32    // そのキーストリームとメッセージをXOR演算することで暗号文を生成します。
33    $cipherText = sodium_crypto_stream_xor($message, $nonce, $key);
34
35    echo "--- Original Data ---\n";
36    echo "Message: " . $message . "\n";
37    echo "Key (hex): " . bin2hex($key) . "\n";
38    echo "Nonce (hex): " . bin2hex($nonce) . " (Length: " . SODIUM_CRYPTO_STREAM_NONCEBYTES . " bytes)\n\n";
39
40    echo "--- Encrypted Data ---\n";
41    echo "Ciphertext (hex): " . bin2hex($cipherText) . "\n\n";
42
43    // 復号化は、暗号化と同じ鍵、同じノンス、そして暗号文に対して再度
44    // sodium_crypto_stream_xor() を適用することで行います。
45    // ストリーム暗号の性質上、同じ関数で暗号化と復号化が可能です。
46    $decryptedMessage = sodium_crypto_stream_xor($cipherText, $nonce, $key);
47
48    echo "--- Decrypted Data ---\n";
49    echo "Decrypted Message: " . $decryptedMessage . "\n";
50
51    if ($message === $decryptedMessage) {
52        echo "\nSuccess: Encryption and decryption completed successfully!\n";
53        return ['cipherText' => $cipherText, 'nonce' => $nonce];
54    } else {
55        echo "\nError: Decrypted message does not match the original message.\n";
56        return false;
57    }
58}
59
60// 実行例
61$plainMessage = "This is a secret message for system engineers.";
62
63// ストリーム暗号用の秘密鍵を生成します。
64// SODIUM_CRYPTO_STREAM_KEYBYTES は、ストリーム暗号で使用する鍵の推奨バイト数を示します。
65$encryptionKey = random_bytes(SODIUM_CRYPTO_STREAM_KEYBYTES);
66
67// 作成した関数を実行します。
68encryptAndDecryptWithStream($plainMessage, $encryptionKey);

このPHPサンプルコードは、LibSodiumライブラリのストリーム暗号機能を用いてデータを安全に暗号化し、そして復号化する方法を示しています。特に、暗号化処理において不可欠な「ノンス」と呼ばれる一回限りの値の推奨サイズを定義するSODIUM_CRYPTO_STREAM_NONCEBYTES定数の利用方法を中心に説明します。

SODIUM_CRYPTO_STREAM_NONCEBYTESは、ストリーム暗号（sodium_crypto_stream_xor関数など）で使用するノンスの推奨バイト数を示す定数です。ノンスは、同じ鍵で複数のデータを暗号化する際に、必ず各データで異なる値を使用しなければならないセキュリティ上極めて重要なランダムな値です。もし同じノンスと鍵で異なるデータを暗号化すると、セキュリティが著しく低下します。なお、キーワードにあるsodium_crypto_secretboxもノンスを使用しますが、その推奨サイズはSODIUM_CRYPTO_SECRETBOX_NONCEBYTESとなり、本定数とは異なる点にご注意ください。

サンプルコード内のencryptAndDecryptWithStream関数は、引数として暗号化したい文字列データ$messageと秘密鍵$keyを受け取ります。まずLibSodium拡張が有効かを確認し、次にSODIUM_CRYPTO_STREAM_NONCEBYTES定数で指定されたバイト数で安全なノンスを生成します。その後、このノンス、秘密鍵、そして元のメッセージを用いてsodium_crypto_stream_xor関数でメッセージを暗号化します。この関数は、暗号化されたデータとノンスをarray形式で返し、エラー発生時にはfalseを返します。復号化は、暗号化時と同じ鍵とノンス、そして暗号文を再度sodium_crypto_stream_xor関数に渡すことで行われます。実行例では、SODIUM_CRYPTO_STREAM_KEYBYTESで指定される推奨サイズの秘密鍵を生成し、実際の暗号化・復号化の流れを確認しています。

Copy
1<?php
2
3/**
4 * libsodiumの公開鍵暗号 (Box) を使用してメッセージを暗号化・復号化する。
5 *
6 * SODIUM_CRYPTO_STREAM_NONCEBYTES はストリーム暗号用のnonceバイト数を示す定数です。
7 * `sodium_crypto_box` 関数では、これとは異なる `SODIUM_CRYPTO_BOX_NONCEBYTES` を使用します。
8 */
9function handleCryptoBoxExample(): void
10{
11    // リファレンス情報にある SODIUM_CRYPTO_STREAM_NONCEBYTES の値 (参考情報として表示)
12    echo 'SODIUM_CRYPTO_STREAM_NONCEBYTES: ' . SODIUM_CRYPTO_STREAM_NONCEBYTES . " bytes\n\n";
13
14    // 1. 送信者 (Alice) と受信者 (Bob) の鍵ペアを生成
15    // 各自の秘密鍵と公開鍵が含まれる鍵ペア
16    $aliceKeyPair = sodium_crypto_box_keypair();
17    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeyPair);
18    $alicePublicKey = sodium_crypto_box_publickey($aliceKeyPair);
19
20    $bobKeyPair = sodium_crypto_box_keypair();
21    $bobSecretKey = sodium_crypto_box_secretkey($bobKeyPair);
22    $bobPublicKey = sodium_crypto_box_publickey($bobKeyPair);
23
24    echo "鍵ペア生成完了。\n";
25
26    // 2. 暗号化する元のメッセージ
27    $message = 'Hello, PHP security world! This is a secret message.';
28    echo "元のメッセージ: " . $message . "\n";
29
30    // 3. nonce（ナンバー・ユーズド・ワンス）を生成
31    // `sodium_crypto_box` 関数には SODIUM_CRYPTO_BOX_NONCEBYTES サイズのnonceが必要です。
32    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
33    echo "生成されたnonceの長さ: " . strlen($nonce) . " bytes (SODIUM_CRYPTO_BOX_NONCEBYTES)\n";
34
35    // 4. 送信者 (Alice) が受信者 (Bob) 宛にメッセージを暗号化
36    // Aliceの秘密鍵とBobの公開鍵から共有鍵を導出して暗号化します。
37    $cipherText = sodium_crypto_box(
38        $message,
39        $nonce,
40        sodium_crypto_box_keypair_from_secretkey_and_publickey($aliceSecretKey, $bobPublicKey)
41    );
42
43    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($cipherText) . "\n";
44
45    // 5. 受信者 (Bob) が送信者 (Alice) からのメッセージを復号化
46    // Bobの秘密鍵とAliceの公開鍵から共有鍵を導出して復号化します。
47    $decryptedMessage = sodium_crypto_box_open(
48        $cipherText,
49        $nonce,
50        sodium_crypto_box_keypair_from_secretkey_and_publickey($bobSecretKey, $alicePublicKey)
51    );
52
53    if ($decryptedMessage !== false) {
54        echo "復号化されたメッセージ: " . $decryptedMessage . "\n";
55        if ($decryptedMessage === $message) {
56            echo "✔ メッセージは正常に暗号化・復号化されました。\n";
57        } else {
58            echo "✖ エラー: 復号化されたメッセージが元のメッセージと異なります。\n";
59        }
60    } else {
61        echo "✖ エラー: メッセージの復号化に失敗しました。認証タグが不正である可能性があります。\n";
62    }
63}
64
65// PHP sodium 拡張機能がロードされているか確認し、関数を実行
66if (extension_loaded('sodium')) {
67    handleCryptoBoxExample();
68} else {
69    echo "エラー: PHP sodium 拡張機能がロードされていません。インストールして有効にしてください。\n";
70}

PHP 8のSODIUM_CRYPTO_STREAM_NONCEBYTESは、libsodium拡張機能が提供するストリーム暗号において、nonce（ナンバー・ユーズド・ワンス）に必要なバイト数を示す定数です。この定数は特定の整数値を持ち、引数や戻り値はありません。

このサンプルコードは、SODIUM_CRYPTO_STREAM_NONCEBYTESが直接使用されるわけではありませんが、libsodiumの公開鍵暗号（Box）機能、具体的にはsodium_crypto_box関数を使ったメッセージの暗号化と復号化の例を初心者向けに示しています。SODIUM_CRYPTO_STREAM_NONCEBYTESはストリーム暗号向けのnonceサイズを表しますが、sodium_crypto_box関数では異なるSODIUM_CRYPTO_BOX_NONCEBYTESという定数で指定されるnonceサイズが使用されます。

コードではまず、送信者と受信者の鍵ペアをそれぞれ生成します。次に、暗号化する元のメッセージを用意し、sodium_crypto_box関数が要求するSODIUM_CRYPTO_BOX_NONCEBYTESで定義されるサイズのnonceを生成します。このnonceと、送信者の秘密鍵、受信者の公開鍵から導出した共有鍵を用いてメッセージを暗号化します。暗号化されたメッセージは、受信者の秘密鍵と送信者の公開鍵から導出した共有鍵、そして同じnonceを使ってsodium_crypto_box_open関数で復号化されます。最後に、復号化されたメッセージが元のメッセージと一致するかを検証し、暗号化・復号化処理の成功を確認しています。SODIUM_CRYPTO_STREAM_NONCEBYTESは、開発者がストリーム暗号機能を利用する際に適切なnonceサイズを理解するための情報として活用されます。