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

Copy
1<?php
2
3/**
4 * Libsodiumの公開鍵暗号 (Box) と、特定の定数の値を示すサンプルコードです。
5 * システムエンジニアを目指す初心者向けに、鍵ペアの生成、メッセージの暗号化、復号化の基本フローを解説します。
6 *
7 * SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES は、ストリーム暗号XChaCha20のnonce（使い捨ての数値）のバイト長を示す定数です。
8 * sodium_crypto_box は公開鍵暗号化に使用され、SODIUM_CRYPTO_BOX_NONCEBYTES の長さのnonceを必要とします。
9 * 本サンプルでは、これら異なる定数の値も合わせて表示します。
10 */
11function demonstrateCryptoBox(): void
12{
13    // アリスとボブの鍵ペアを生成
14    // 各鍵ペアは秘密鍵と公開鍵を含みます。
15    $aliceKeypair = sodium_crypto_box_keypair();
16    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair); // アリスの公開鍵
17    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair); // アリスの秘密鍵
18
19    $bobKeypair = sodium_crypto_box_keypair();
20    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);     // ボブの公開鍵
21    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);     // ボブの秘密鍵
22
23    $message = "Hello, Bob! This is a secret message from Alice.";
24
25    // 暗号化に使用するNonce (使い捨ての数値) を生成
26    // sodium_crypto_box関数にはSODIUM_CRYPTO_BOX_NONCEBYTESの長さのnonceが必要です。
27    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
28
29    echo "--- 公開鍵暗号のデモンストレーション ---" . PHP_EOL;
30    echo "元のメッセージ: " . $message . PHP_EOL;
31    echo "必要なNonceのバイト長 (crypto_box): " . SODIUM_CRYPTO_BOX_NONCEBYTES . PHP_EOL;
32    echo "生成されたNonce (Base64): " . base64_encode($nonce) . PHP_EOL;
33
34    // AliceがBobへメッセージを暗号化
35    // 送信者(Alice)の秘密鍵と受信者(Bob)の公開鍵を使用します。
36    $ciphertext = sodium_crypto_box($message, $nonce, $bobPublicKey, $aliceSecretKey);
37
38    echo "暗号化されたメッセージ (Base64): " . base64_encode($ciphertext) . PHP_EOL;
39
40    // BobがAliceからのメッセージを復号化
41    // 受信者(Bob)の秘密鍵と送信者(Alice)の公開鍵を使用します。
42    $decryptedMessage = sodium_crypto_box_open($ciphertext, $nonce, $alicePublicKey, $bobSecretKey);
43
44    if ($decryptedMessage === false) {
45        echo "メッセージの復号化に失敗しました！" . PHP_EOL;
46    } else {
47        echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
48    }
49
50    echo PHP_EOL . "--- その他の定数情報 ---" . PHP_EOL;
51    // リファレンス情報で指定された定数の値を表示
52    // この定数はストリーム暗号XChaCha20で用いられるnonceのバイト長であり、
53    // 上記のsodium_crypto_box関数では直接使用されません。
54    echo "SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES (ストリーム暗号XChaCha20のnonceバイト長): " . SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES . PHP_EOL;
55}
56
57// 関数を実行してデモンストレーションを開始
58demonstrateCryptoBox();

PHPのSODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTESは、PHP 8で提供されるsodium拡張機能の定数です。この定数は、ストリーム暗号XChaCha20アルゴリズムで使用される「nonce（ナンス）」と呼ばれる使い捨ての数値のバイト長を示します。引数はなく、その値は整数（int）として返されます。

提供されたサンプルコードでは、主に公開鍵暗号化のsodium_crypto_box関数の利用方法をデモンストレーションしています。この関数は、メッセージを安全に暗号化および復号化するために、送信者の秘密鍵と受信者の公開鍵、そして一意のnonceを使用します。sodium_crypto_box関数が要求するnonceのバイト長は、別の定数SODIUM_CRYPTO_BOX_NONCEBYTESで定義されています。

サンプルコードでは、まずアリスとボブの鍵ペアを生成し、アリスからボブへのメッセージを暗号化します。暗号化されたメッセージは、ボブが自身の秘密鍵とアリスの公開鍵、そして同じnonceを使って復号化されます。これにより、メッセージが正しく送受信できることを確認できます。

SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES自体は、このsodium_crypto_box関数の直接的な処理には関与しませんが、PHPのsodium拡張が提供する様々な暗号化定数の一つとして、その値が参照用に表示されています。これにより、異なる暗号アルゴリズムが異なるnonceの長さを必要とすることへの理解を深めることができます。

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES 定数と sodium_crypto_secretbox 関数を使用して
5 * メッセージを暗号化および復号化するサンプル関数。
6 *
7 * システムエンジニアを目指す初心者向けに、共有鍵暗号の基本的な流れを示します。
8 * SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES は、Nonce（番号を一度だけ使う）の
9 * 必要なバイト数を示す定数です。Nonceは暗号化ごとにユニークである必要があります。
10 *
11 * @param string $message 暗号化する平文のメッセージ
12 * @return void
13 */
14function encryptAndDecryptMessage(string $message): void
15{
16    echo "元のメッセージ: " . $message . PHP_EOL;
17
18    // 1. 共有鍵の生成
19    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES は、secretbox_open 関数に必要な鍵のバイト数を示す定数
20    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
21    echo "鍵のサイズ: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト" . PHP_EOL;
22
23    // 2. Nonce (Number Used Once) の生成
24    // SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES は、Nonceに必要なバイト数を示す定数
25    // 各暗号化操作でユニークなNonceを使用することが非常に重要です。
26    $nonce = random_bytes(SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES);
27    echo "Nonceのサイズ: " . SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES . " バイト" . PHP_EOL;
28
29    // 3. メッセージの暗号化
30    // sodium_crypto_secretbox(メッセージ, Nonce, 鍵) を使用してメッセージを暗号化
31    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
32    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($ciphertext) . PHP_EOL;
33
34    // 4. 暗号化されたメッセージの復号化
35    // sodium_crypto_secretbox_open(暗号文, Nonce, 鍵) を使用してメッセージを復号化
36    // Nonceと鍵が暗号化時と同じである必要があります。
37    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
38
39    if ($decryptedMessage === false) {
40        echo "エラー: メッセージの復号化に失敗しました。" . PHP_EOL;
41        return;
42    }
43
44    echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
45
46    // 復号化されたメッセージが元のメッセージと一致するか確認
47    if ($decryptedMessage === $message) {
48        echo "結果: 暗号化と復号化が成功しました！" . PHP_EOL;
49    } else {
50        echo "結果: 暗号化と復号化に失敗、メッセージが一致しません。" . PHP_EOL;
51    }
52}
53
54// 関数の実行例
55encryptAndDecryptMessage("これは秘密のメッセージです。誰にも読まれないように暗号化します！");
56

このPHPサンプルコードは、SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES定数とsodium_crypto_secretbox関数を用いて、メッセージを安全に暗号化し復号化する共有鍵暗号の基本的な仕組みをシステムエンジニアを目指す初心者向けに示しています。

SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTESは、暗号化処理において「Nonce（ナンス）」と呼ばれる、一度だけ使用されるランダムな数値に必要なバイト数（整数値）を示す定数です。Nonceは各暗号化ごとにユニークである必要があり、これを使い回すとセキュリティが著しく低下します。

サンプルコード内のencryptAndDecryptMessage関数は、指定された$message（文字列）を引数として受け取り、戻り値はありません。関数内で、まずSODIUM_CRYPTO_SECRETBOX_KEYBYTES定数に定義されたサイズの鍵と、SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES定数に定義されたサイズのNonceをそれぞれランダムに生成します。

次に、sodium_crypto_secretbox関数が$message、生成した$nonce、$keyを引数に受け取り、メッセージを暗号化します。この関数は暗号化されたメッセージ（文字列）を返します。復号化はsodium_crypto_secretbox_open関数で行われ、暗号化時と同じ$ciphertext、$nonce、$keyを引数として渡すことで、元のメッセージを取り出します。復号化に成功すると元のメッセージ（文字列）が返され、失敗した場合はfalseが返ります。これにより、安全なデータ通信の基本を学習できます。