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

Copy
1<?php
2
3/**
4 * libsodium を使用してメッセージの暗号化と復号の基本的なプロセスをデモンストレーションします。
5 * これは公開鍵暗号 (非対称暗号) の一例です。
6 * また、libsodium の鍵導出関数に関連する定数も表示します。
7 *
8 * @return void
9 */
10function demonstrateSodiumCryptoBoxCommunication(): void
11{
12    echo "--- libsodium 暗号化/復号デモンストレーション ---" . PHP_EOL;
13
14    // 1. 送信者 (アリス) と受信者 (ボブ) の鍵ペアを生成します。
15    // 各鍵ペアは公開鍵と秘密鍵の両方を含みます。
16    $aliceKeyPair = sodium_crypto_box_keypair();
17    $bobKeyPair = sodium_crypto_box_keypair();
18
19    // 2. 各鍵ペアから、通信に必要な公開鍵と秘密鍵を抽出します。
20    $alicePublicKey = sodium_crypto_box_publickey($aliceKeyPair);
21    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeyPair);
22
23    $bobPublicKey = sodium_crypto_box_publickey($bobKeyPair);
24    $bobSecretKey = sodium_crypto_box_secretkey($bobKeyPair);
25
26    // SODIUM_CRYPTO_KDF_BYTES_MIN 定数の表示
27    // この定数は、鍵導出関数 (KDF) が生成できる最小の鍵バイト数を定義します。
28    // sodium_crypto_box は直接この定数を使って鍵の長さを指定しませんが、
29    // libsodium 拡張における鍵管理の重要な側面のひとつです。
30    echo "SODIUM_CRYPTO_KDF_BYTES_MIN (鍵導出の最小バイト数): " . SODIUM_CRYPTO_KDF_BYTES_MIN . " bytes" . PHP_EOL;
31    echo PHP_EOL;
32
33    // 3. 暗号化する元のメッセージを準備します。
34    $originalMessage = "こんにちは、ボブ！これはアリスからの秘密のメッセージだよ。";
35    echo "元のメッセージ: " . $originalMessage . PHP_EOL;
36
37    // 4. 暗号化に必要なノンス（nonce: Number Once）を生成します。
38    // ノンスは各暗号化操作でユニークである必要があり、再利用してはいけません。
39    // 安全なノンスは random_bytes で生成します。
40    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
41
42    // 5. アリスがボブ宛にメッセージを暗号化します。
43    // アリスの秘密鍵とボブの公開鍵を使用して、共通の秘密を確立し、メッセージを暗号化します。
44    $encryptedMessage = sodium_crypto_box(
45        $originalMessage,
46        $nonce,
47        $bobPublicKey, // 受信者（ボブ）の公開鍵
48        $aliceSecretKey // 送信者（アリス）の秘密鍵
49    );
50    echo "暗号化されたメッセージ (バイナリ): " . bin2hex($encryptedMessage) . PHP_EOL;
51
52    // 6. ボブがアリスからの暗号化されたメッセージを復号します。
53    // ボブの秘密鍵とアリスの公開鍵を使用して、メッセージを復号します。
54    $decryptedMessage = sodium_crypto_box_open(
55        $encryptedMessage,
56        $nonce,
57        $alicePublicKey, // 送信者（アリス）の公開鍵
58        $bobSecretKey    // 受信者（ボブ）の秘密鍵
59    );
60
61    if ($decryptedMessage === false) {
62        echo "エラー: メッセージの復号に失敗しました。鍵またはノンスが正しくない可能性があります。" . PHP_EOL;
63    } else {
64        echo "復号されたメッセージ: " . $decryptedMessage . PHP_EOL;
65        if ($decryptedMessage === $originalMessage) {
66            echo "成功: 復号されたメッセージは元のメッセージと一致しました。" . PHP_EOL;
67        } else {
68            echo "警告: 復号されたメッセージが元のメッセージと一致しませんでした！" . PHP_EOL;
69        }
70    }
71}
72
73// デモンストレーション関数を実行します。
74demonstrateSodiumCryptoBoxCommunication();

このPHPサンプルコードは、libsodium拡張機能を用いて、公開鍵暗号（非対称暗号）によるメッセージの安全な送受信方法を初心者向けに示しています。まず、メッセージをやり取りする送信者と受信者それぞれが、公開鍵と秘密鍵からなる鍵ペアを生成します。

暗号化の準備として、元のメッセージと、毎回異なるランダムな値であるノンスを用意します。メッセージを暗号化する際には、送信者の秘密鍵と受信者の公開鍵を使い、sodium_crypto_box関数を呼び出します。この関数は、メッセージ、ノンス、そしてこれら2つの鍵情報を受け取り、暗号化されたメッセージをバイナリ形式で返します。

次に、受信者がメッセージを復号します。復号には、受信者の秘密鍵と送信者の公開鍵を使用し、sodium_crypto_box_open関数を使います。この関数も、暗号化されたメッセージ、ノンス、および2つの鍵情報を受け取り、成功すれば元のメッセージを返しますが、失敗した場合はブール値のfalseを返します。

サンプルコード中で表示されているSODIUM_CRYPTO_KDF_BYTES_MIN定数は、libsodiumライブラリが提供する鍵導出関数（KDF）が生成できる鍵の最小バイト数を定義しています。この定数はsodium_crypto_box関数の直接的な引数ではありませんが、libsodiumにおける安全な鍵管理の基盤となる情報の一つです。このデモンストレーションを通して、公開鍵暗号の基本的な流れを理解することができます。

Copy
1<?php
2
3/**
4 * Libsodium拡張機能を使ったAEAD (Authenticated Encryption with Associated Data)
5 * 暗号化のデモンストレーションと、関連するセキュリティ定数の表示。
6 *
7 * この関数は、システムエンジニアを目指す初心者向けに、Libsodium拡張機能を用いて
8 * メッセージを安全に暗号化および復号する基本的な方法を示します。
9 * キーワードである `sodium_crypto_aead_aes256gcm_npubbytes` の利用と、
10 * `SODIUM_CRYPTO_KDF_BYTES_MIN` 定数の表示を組み合わせています。
11 */
12function demonstrateSodiumEncryptionAndConstants(): void
13{
14    // 1. Libsodium拡張がシステムにインストールされ、有効になっているかを確認します。
15    // セキュリティ機能を利用する上で必須のチェックです。
16    if (!extension_loaded('sodium')) {
17        echo "エラー: PHP Libsodium拡張が有効になっていません。" . PHP_EOL;
18        echo "続行するには、PHPの設定でLibsodiumを有効にしてください。" . PHP_EOL;
19        return;
20    }
21
22    echo "--- Libsodium AEAD 暗号化のデモンストレーション ---" . PHP_EOL;
23
24    // 2. AES-256-GCM 暗号化に使用する秘密鍵を生成します。
25    // 鍵はランダムに生成され、安全に保管・管理される必要があります。
26    // SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES はAES-256-GCMに必要な鍵のバイト数を示します。
27    $key = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES);
28    echo "生成されたAEAD秘密鍵のバイト数: " . strlen($key) . " バイト" . PHP_EOL;
29
30    // 3. 暗号化する元のメッセージを準備します。
31    $originalMessage = "これは誰にも知られたくない秘密のメッセージです。";
32    echo "元のメッセージ: '" . $originalMessage . "'" . PHP_EOL;
33
34    // 4. Nonce (Number Used Once) を生成します。
35    // Nonceは、同じ鍵で複数のメッセージを暗号化する際に、各暗号化で異なる値を使用することで
36    // セキュリティを強化するためのランダムな値です。
37    // `sodium_crypto_aead_aes256gcm_npubbytes()` は、AES-256-GCMに必要なNonceの推奨バイト数を返します。
38    $nonceBytes = sodium_crypto_aead_aes256gcm_npubbytes();
39    $nonce = random_bytes($nonceBytes);
40    echo "Nonceの推奨バイト数 (sodium_crypto_aead_aes256gcm_npubbytes()): " . $nonceBytes . " バイト" . PHP_EOL;
41    echo "生成されたNonceのバイト数: " . strlen($nonce) . " バイト" . PHP_EOL;
42
43    // 5. 追加認証データ (AAD: Additional Authenticated Data) を準備します (オプション)。
44    // AADは暗号化されませんが、メッセージと共に認証されるため、改ざんを防止できます。
45    // 例えば、メッセージがどのユーザーのものであるかを示す情報を格納できます。
46    $additionalData = "ユーザーID: 42";
47    echo "追加認証データ (AAD): '" . $additionalData . "'" . PHP_EOL;
48
49    // 6. メッセージを暗号化します。
50    // `sodium_crypto_aead_aes256gcm_encrypt` 関数を使用します。
51    $encryptedMessage = sodium_crypto_aead_aes256gcm_encrypt(
52        $originalMessage,
53        $additionalData,
54        $nonce,
55        $key
56    );
57    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($encryptedMessage) . PHP_EOL;
58
59    // 7. 暗号化されたメッセージを復号します。
60    // 復号には、暗号化時と同じ秘密鍵、Nonce、およびAADが必要です。
61    // これらのいずれかが異なると、SodiumExceptionがスローされ、復号に失敗します。
62    try {
63        $decryptedMessage = sodium_crypto_aead_aes256gcm_decrypt(
64            $encryptedMessage,
65            $additionalData,
66            $nonce,
67            $key
68        );
69        echo "復号されたメッセージ: '" . $decryptedMessage . "'" . PHP_EOL;
70
71        if ($originalMessage === $decryptedMessage) {
72            echo "結果: 暗号化と復号が正常に完了し、メッセージは一致しました。" . PHP_EOL;
73        } else {
74            echo "結果: エラー - 復号されたメッセージが元のメッセージと一致しません。" . PHP_EOL;
75        }
76    } catch (SodiumException $e) {
77        echo "復号エラー: " . $e->getMessage() . PHP_EOL;
78        echo "エラー原因として、鍵、Nonce、または追加認証データが一致しない可能性があります。" . PHP_EOL;
79    }
80
81    echo PHP_EOL . "--- その他のLibsodiumセキュリティ定数 ---" . PHP_EOL;
82
83    // 8. SODIUM_CRYPTO_KDF_BYTES_MIN 定数を表示します。
84    // この定数は、鍵導出関数 (KDF: Key Derivation Function) が出力できる
85    // 鍵の最小バイト数を示します。
86    // 上記のAES暗号化処理とは直接関係ありませんが、Libsodiumの重要なセキュリティ定数の一つです。
87    echo "鍵導出関数 (KDF) の最小バイト数 (SODIUM_CRYPTO_KDF_BYTES_MIN): " . SODIUM_CRYPTO_KDF_BYTES_MIN . " バイト" . PHP_EOL;
88
89    // 参考として、AES-256-GCM認証タグのバイト数も表示
90    echo "AEAD認証タグのバイト数 (SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES): " . SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES . " バイト" . PHP_EOL;
91}
92
93// 関数を実行してデモンストレーションを開始します。
94demonstrateSodiumEncryptionAndConstants();

このサンプルコードは、PHPのLibsodium拡張機能を利用して、メッセージを安全に暗号化し復号するプロセスをシステムエンジニアを目指す初心者向けに示します。まず、Libsodiumが有効かを確認した後、random_bytes関数とSODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES定数を用いてAEAD暗号化に必要な秘密鍵を生成します。次に、sodium_crypto_aead_aes256gcm_npubbytes関数を使用してNonce（Number Used Once）の推奨バイト数を取得し、セキュリティを確保するためのNonceを生成します。その後、元のメッセージと追加認証データを指定して暗号化を行い、同じ鍵とNonce、追加データを用いて復号する一連の流れを実演しています。

コードの後半では、本リファレンス情報の対象であるSODIUM_CRYPTO_KDF_BYTES_MIN定数の値を出力しています。この定数は、Libsodiumの鍵導出関数（KDF: Key Derivation Function）が生成できる鍵の最小バイト数を示すものであり、セキュリティ要件に基づいた鍵の長さを判断する際に役立ちます。SODIUM_CRYPTO_KDF_BYTES_MINは定数であるため、引数や戻り値は持ちません。Libsodiumの各種定数を確認することで、安全な暗号化システムの設計に不可欠な情報を得ることができます。