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

Copy
1<?php
2
3/**
4 * Libsodiumのsecretbox関数を使用して、メッセージの暗号化と復号を行うサンプルコードです。
5 *
6 * システムエンジニアを目指す初心者の方へ：
7 * このコードは、重要な情報を安全に扱うための基本的な暗号化の手法を示しています。
8 * `sodium_crypto_secretbox` は「認証付き暗号」を提供し、メッセージの秘密性（第三者から読めないこと）と
9 * 完全性（メッセージが途中で改ざんされていないこと）の両方を保証します。
10 * 鍵（$key）とナンス（$nonce）はそれぞれ秘密に管理し、ナンスは同じ鍵で暗号化するたびに
11 * 必ず異なるものを使用する必要があります。
12 *
13 * @return void
14 */
15function demonstrateSecretboxEncryption(): void
16{
17    // 1. 暗号化したい元のメッセージを定義
18    $originalMessage = 'これはLibSodiumを使って安全に暗号化されるべき秘密のメッセージです。';
19    echo "元のメッセージ: " . $originalMessage . PHP_EOL;
20
21    // 2. 秘密鍵を生成
22    // `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` は、secretbox関数が要求する鍵の正しいバイト数を指定します。
23    // この鍵は誰にも知られてはいけない非常に重要な情報です。
24    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
25    echo "秘密鍵を生成しました (長さ: " . strlen($key) . " バイト)" . PHP_EOL;
26
27    // 3. ナンス（Nonce: Number used once）を生成
28    // `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` は、secretbox関数が要求するナンスの正しいバイト数を指定します。
29    // 同じ鍵で複数のメッセージを暗号化する場合、それぞれのメッセージに対して必ず異なるナンスを使用してください。
30    // ナンスは秘密にする必要はありませんが、重複してはなりません。
31    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
32    echo "ナンスを生成しました (長さ: " . strlen($nonce) . " バイト)" . PHP_EOL;
33
34    // 4. メッセージを暗号化
35    // `sodium_crypto_secretbox` 関数は、元のメッセージ、ナンス、秘密鍵を使用して暗号化します。
36    // 返されるデータは、暗号化されたメッセージと認証タグを結合したものです。
37    $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $key);
38    echo "暗号化されたメッセージ (バイナリ、hexエンコード): " . bin2hex($encryptedMessage) . PHP_EOL;
39    echo "暗号化されたメッセージの長さ: " . strlen($encryptedMessage) . " バイト" . PHP_EOL;
40
41    // 5. 暗号化されたメッセージを復号
42    // `sodium_crypto_secretbox_open` 関数は、暗号化されたメッセージ、使用したナンス、秘密鍵を使用して復号します。
43    // この関数は、メッセージの完全性も検証します。もしメッセージが改ざんされていたり、
44    // 鍵やナンスが間違っていたりすると、復号に失敗し `false` を返します。
45    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
46
47    if ($decryptedMessage === false) {
48        echo "復号に失敗しました。メッセージが改ざんされたか、鍵またはナンスが間違っている可能性があります。" . PHP_EOL;
49    } else {
50        echo "復号されたメッセージ: " . $decryptedMessage . PHP_EOL;
51    }
52
53    // --- 補足情報 ---
54    // ここで、このサンプルコードで使用された定数、およびリファレンス情報にあった定数の値を出力します。
55    echo PHP_EOL;
56    echo "LibSodium関連の定数情報:" . PHP_EOL;
57    echo " - SODIUM_CRYPTO_SECRETBOX_KEYBYTES (secretboxの鍵の長さ): " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト" . PHP_EOL;
58    echo " - SODIUM_CRYPTO_SECRETBOX_NONCEBYTES (secretboxのナンスの長さ): " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイト" . PHP_EOL;
59
60    // リファレンス情報で指定された定数ですが、今回のキーワード `sodium_crypto_secretbox` とは
61    // 直接的な関連がない（鍵交換(KX)に使用される）ため、参考情報として出力しています。
62    echo " - SODIUM_CRYPTO_KX_SECRETKEYBYTES (鍵交換の秘密鍵の長さ): " . SODIUM_CRYPTO_KX_SECRETKEYBYTES . " バイト" . PHP_EOL;
63}
64
65// 関数を実行して、暗号化と復号のデモンストレーションを開始します。
66demonstrateSecretboxEncryption();

このPHPコードは、LibSodium拡張機能を使用し、メッセージの暗号化と復号を行う方法をシステムエンジニアを目指す初心者向けに示しています。sodium_crypto_secretbox関数は、メッセージの秘密性（内容が第三者に読まれないこと）と完全性（途中で改ざんされていないこと）を保証する「認証付き暗号」を提供します。

暗号化には、外部に漏らしてはならない秘密の「鍵」（$key）と、同じ鍵で暗号化するたびに異なる値を使用する「ナンス」（$nonce）が必要です。鍵の長さはSODIUM_CRYPTO_SECRETBOX_KEYBYTES定数、ナンスの長さはSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数でそれぞれ定義されています。sodium_crypto_secretboxは、元のメッセージ、ナンス、鍵を引数に取り、認証タグを含む暗号化済みメッセージをバイナリ文字列で戻り値として返します。

復号にはsodium_crypto_secretbox_open関数を使用します。これは暗号化メッセージ、使用したナンス、鍵を引数に受け取り、成功すれば元のメッセージを返します。メッセージ改ざんや鍵・ナンスの誤りがあった場合はfalseを戻り値として返し、検証失敗を通知します。リファレンス情報にあったSODIUM_CRYPTO_KX_SECRETKEYBYTES定数は、鍵交換用の秘密鍵の長さを表し、sodium_crypto_secretbox関数とは直接関連しません。この定数に引数はなく、戻り値もありません。

Copy
1<?php
2
3/**
4 * Libsodiumの公開鍵暗号機能 (sodium_crypto_box) の使用例と、関連する定数を示す関数。
5 *
6 * この関数は、アリスとボブの間で安全なメッセージ交換を行うシナリオを通して、
7 * sodium_crypto_box の基本的な使い方を説明します。
8 * また、鍵やnonceの長さを定義するいくつかの定数の値も表示し、
9 * 特に指定された SODIUM_CRYPTO_KX_SECRETKEYBYTES 定数も含みます。
10 *
11 * システムエンジニアを目指す初心者向けに、各ステップをコメントで簡潔に解説します。
12 */
13function demonstrateSodiumCryptoBox(): void
14{
15    // Libsodium拡張が利用可能かチェック
16    if (!extension_loaded('sodium')) {
17        die('エラー: libsodium 拡張機能が読み込まれていません。');
18    }
19
20    echo "--- Libsodium sodium_crypto_box 使用例 ---\n";
21
22    // 1. アリスの鍵ペアを生成
23    // sodium_crypto_box_keypair() は秘密鍵と公開鍵を結合した形式で返します。
24    // その後、sodium_crypto_box_secretkey() と sodium_crypto_box_publickey() で分離できます。
25    $aliceKeypair = sodium_crypto_box_keypair();
26    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
27    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
28    echo "1. アリスの秘密鍵と公開鍵のペアを生成しました。\n";
29
30    // 2. ボブの鍵ペアを生成
31    $bobKeypair = sodium_crypto_box_keypair();
32    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
33    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
34    echo "2. ボブの秘密鍵と公開鍵のペアを生成しました。\n";
35
36    // 3. 送信するメッセージを準備
37    $message = "こんにちは、ボブ！これはアリスからの秘密のメッセージだよ。";
38    echo "\n3. 送信メッセージ: \"" . $message . "\"\n";
39
40    // 4. nonce (Number Used Once) を生成
41    // nonce は「使い捨ての数」を意味し、暗号化ごとに異なるユニークな値である必要があります。
42    // SODIUM_CRYPTO_BOX_NONCEBYTES は nonce の推奨バイト長を定義しています。
43    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
44    echo "4. 暗号化に使用するユニークな nonce を生成しました。\n";
45
46    // 5. アリスがボブの公開鍵を使ってメッセージを暗号化
47    // 暗号化には、アリス自身の秘密鍵とボブの公開鍵を使用します。
48    $ciphertext = sodium_crypto_box($message, $nonce, $bobPublicKey, $aliceSecretKey);
49    echo "5. メッセージを暗号化しました。\n";
50
51    // 6. ボブがアリスの公開鍵を使ってメッセージを復号化
52    // 復号化には、ボブ自身の秘密鍵とアリスの公開鍵を使用します。
53    $decryptedMessage = sodium_crypto_box_open($ciphertext, $nonce, $alicePublicKey, $bobSecretKey);
54
55    if ($decryptedMessage !== false) {
56        echo "6. メッセージの復号化に成功しました。\n";
57        echo "   復号化されたメッセージ: \"" . $decryptedMessage . "\"\n";
58        if ($decryptedMessage === $message) {
59            echo "   (元のメッセージと完全に一致します。)\n";
60        } else {
61            echo "   (警告: 復号化されたメッセージが元のメッセージと異なります。)\n";
62        }
63    } else {
64        echo "6. メッセージの復号化に失敗しました。鍵またはnonceが間違っている可能性があります。\n";
65    }
66
67    echo "\n--- Libsodium 関連定数の値 (バイト長) ---\n";
68    // libsodiumのさまざまな機能で使用される鍵やnonceの推奨バイト長を示す定数です。
69    // これらの定数を使うことで、安全かつ正しい長さのデータを扱えます。
70    echo "SODIUM_CRYPTO_BOX_SECRETKEYBYTES (sodium_crypto_box秘密鍵の長さ): " . SODIUM_CRYPTO_BOX_SECRETKEYBYTES . " バイト\n";
71    echo "SODIUM_CRYPTO_BOX_PUBLICKEYBYTES (sodium_crypto_box公開鍵の長さ): " . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . " バイト\n";
72    echo "SODIUM_CRYPTO_BOX_NONCEBYTES (sodium_crypto_box nonceの長さ): " . SODIUM_CRYPTO_BOX_NONCEBYTES . " バイト\n";
73    // リファレンス情報に指定された定数もここで表示します。
74    // SODIUM_CRYPTO_KX_SECRETKEYBYTES は、Key Exchange (鍵交換) 機能で使用される秘密鍵の長さを表します。
75    echo "SODIUM_CRYPTO_KX_SECRETKEYBYTES (Key Exchange秘密鍵の長さ): " . SODIUM_CRYPTO_KX_SECRETKEYBYTES . " バイト\n";
76}
77
78// 関数を実行して、サンプルコードの動作を確認します。
79demonstrateSodiumCryptoBox();

このサンプルコードは、PHPのlibsodium拡張を使ったsodium_crypto_box関数による公開鍵暗号化の基本的な流れを示すものです。まず、アリスとボブがそれぞれ秘密鍵と公開鍵のペアを生成します。その後、アリスはボブの公開鍵と自身の秘密鍵を用いてメッセージを暗号化します。暗号化の際には、各処理でユニークな値であるnonce（ナンス）を生成して利用します。これにより、同じメッセージが何度も暗号化される場合でも、異なる暗号文が生成され、安全性が高まります。暗号化されたメッセージは、ボブがアリスの公開鍵と自身の秘密鍵、そして同じnonceを用いて正しく復号化できることを確認できます。

SODIUM_CRYPTO_KX_SECRETKEYBYTESは、libsodiumの鍵交換（Key Exchange）機能で使われる秘密鍵のバイト長を示す定数です。この定数に引数はなく、特定のバイト長を示す数値を直接提供します。開発者がセキュリティを確保するために適切な鍵長を把握する上で役立ちます。このサンプルを通じて、PHPで安全なメッセージ交換を行うための基本的な暗号化処理と、それに関連する定数の役割を学ぶことができます。