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

Copy
1<?php
2
3/**
4 * LibSodium拡張の sodium_crypto_box を用いたメッセージの暗号化と復号化の例を示します。
5 * SODIUM_CRYPTO_KX_SEEDBYTES は鍵交換（Key Exchange）のためのシードのバイト数を定義する定数ですが、
6 * このサンプルでは、LibSodiumが提供する多くの定数の一つとしてその値を確認しつつ、
7 * キーワードである sodium_crypto_box の利用方法を中心に解説します。
8 *
9 * sodium_crypto_box は公開鍵暗号による認証付き暗号化（Authenticated Encryption）を
10 * 実現する関数で、メッセージの機密性、完全性、認証性を提供します。
11 */
12function demonstrateSodiumBoxEncryption(): void
13{
14    // SODIUM_CRYPTO_KX_SEEDBYTES 定数の値を出力します。
15    // この定数は鍵交換アルゴリズムで使用されるシードの推奨バイト数を示します。
16    echo "SODIUM_CRYPTO_KX_SEEDBYTES (鍵交換シードのバイト数): " . SODIUM_CRYPTO_KX_SEEDBYTES . " bytes\n\n";
17
18    // ----------------------------------------------------------------------
19    // sodium_crypto_box の基本的な使い方
20    // ----------------------------------------------------------------------
21
22    // 1. 鍵ペアの生成
23    // アリスとボブ、それぞれが公開鍵と秘密鍵のペアを生成します。
24    // 公開鍵は他者に公開し、秘密鍵は厳重に保管します。
25    $aliceKeypair = sodium_crypto_box_keypair();
26    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
27    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
28
29    $bobKeypair = sodium_crypto_box_keypair();
30    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
31    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
32
33    echo "アリスの公開鍵 (一部): " . substr(bin2hex($alicePublicKey), 0, 16) . "...\n";
34    echo "ボブの公開鍵 (一部): " . substr(bin2hex($bobPublicKey), 0, 16) . "...\n\n";
35
36    // 2. 暗号化するメッセージの準備
37    $message = "Hello, this is a secret message from Alice to Bob!";
38    echo "元のメッセージ: " . $message . "\n";
39
40    // 3. ナンス（Nonce）の生成
41    // ナンスは暗号化ごとに異なるランダムな値でなければなりません。
42    // 同じ鍵ペアで異なるメッセージを暗号化する場合でも、常に新しいナンスを使用します。
43    // sodium_crypto_box_noncebytes は推奨されるナンスのバイト数です。
44    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
45    echo "ナンス (一部): " . substr(bin2hex($nonce), 0, 16) . "...\n\n";
46
47    // 4. アリスがボブ宛にメッセージを暗号化
48    // アリスの秘密鍵とボブの公開鍵を使用してメッセージを暗号化します。
49    // これにより、メッセージはボブのみが復号でき、アリスからのものであることが保証されます。
50    $encryptedMessage = sodium_crypto_box(
51        $message,
52        $nonce,
53        $bobPublicKey,    // 受信者の公開鍵
54        $aliceSecretKey   // 送信者の秘密鍵
55    );
56    echo "暗号化されたメッセージ (Hexの一部): " . substr(bin2hex($encryptedMessage), 0, 32) . "...\n\n";
57
58    // 5. ボブがアリスからのメッセージを復号化
59    // ボブの秘密鍵とアリスの公開鍵を使用して暗号化されたメッセージを復号化します。
60    // 復号に成功した場合、メッセージは正しく、送信者も認証されたことになります。
61    $decryptedMessage = sodium_crypto_box_open(
62        $encryptedMessage,
63        $nonce,
64        $alicePublicKey,  // 送信者の公開鍵
65        $bobSecretKey     // 受信者の秘密鍵
66    );
67
68    if ($decryptedMessage !== false) {
69        echo "復号化されたメッセージ: " . $decryptedMessage . "\n";
70        echo "復号化成功！メッセージは改ざんされておらず、アリスからのものです。\n";
71    } else {
72        echo "復号化失敗！メッセージが改ざんされたか、鍵またはナンスが間違っています。\n";
73    }
74
75    echo "\n";
76}
77
78// 関数を実行して、暗号化と復号化のデモンストレーションを開始します。
79demonstrateSodiumBoxEncryption();

このサンプルコードは、PHPのLibSodium拡張を用いてメッセージを安全に暗号化し復号化する方法を示しています。まず、SODIUM_CRYPTO_KX_SEEDBYTESという定数が出力されていますが、これは鍵交換アルゴリズムにおけるシードの推奨バイト数を示す整数値（int）であり、LibSodiumが提供する多数の定数の一つです。

コードの主な目的は、sodium_crypto_box関数を使った公開鍵暗号による認証付き暗号化のデモンストレーションです。この関数は、メッセージの機密性、完全性、そして送信者の認証を保証します。具体的には、アリスとボブがそれぞれ公開鍵と秘密鍵のペアを生成するところから始まります。公開鍵は他者に公開し、秘密鍵は厳重に保管されます。

メッセージを暗号化する際には、sodium_crypto_box関数を使用し、暗号化したいメッセージ、ナンス（使い捨てのランダムな値）、受信者の公開鍵、送信者の秘密鍵を引数として渡します。ナンスは毎回異なる値を生成する必要があり、random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES)で推奨されるバイト数のナンスを生成します。

次に、暗号化されたメッセージを復号化するには、sodium_crypto_box_open関数を使用します。ここには、暗号化されたメッセージ、同じナンス、送信者の公開鍵、受信者の秘密鍵を引数として渡します。復号化に成功すると、元のメッセージが文字列として返されます。もしメッセージが改ざんされていたり、鍵やナンスが間違っていたりすると、復号に失敗しfalseが返されるため、メッセージの信頼性を確認できます。

Copy
1<?php
2
3// Sodium拡張が利用可能かチェック
4if (!extension_loaded('sodium')) {
5    die("Sodium extension is not loaded. Please enable it in php.ini.\n");
6}
7
8/**
9 * Libsodiumの`sodium_crypto_secretbox`関数を使用してメッセージを暗号化・復号化します。
10 *
11 * この関数は対称鍵暗号化の基本的な例を示します。
12 * `SODIUM_CRYPTO_KX_SEEDBYTES` は鍵交換のシード長を示す定数ですが、
13 * `sodium_crypto_secretbox`で必要な鍵長(`SODIUM_CRYPTO_SECRETBOX_KEYBYTES`)と偶然同じバイト数です。
14 * そのため、鍵の生成例の箇所でその値も表示し、鍵長に関する情報を提供します。
15 *
16 * @param string $message 暗号化する平文メッセージ
17 * @return void
18 */
19function encryptAndDecryptSecretboxMessage(string $message): void
20{
21    echo "--- Libsodium (PHP 8 Sodium Extension) `sodium_crypto_secretbox` 例 ---\n";
22    echo "元のメッセージ: '" . $message . "'\n\n";
23
24    // 1. 共有秘密鍵の生成
25    // `sodium_crypto_secretbox` には `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` (通常32バイト) の鍵が必要です。
26    // `SODIUM_CRYPTO_KX_SEEDBYTES` は鍵交換のシード長ですが、偶然にも `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` と同じ値です。
27    // ここでは `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` の値を使って鍵を生成します。
28    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
29    echo "生成された共有秘密鍵 (Hex): " . bin2hex($key) . " (長さ: " . strlen($key) . " バイト)\n";
30    echo "  - `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` (secretboxの鍵長): " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト\n";
31    echo "  - `SODIUM_CRYPTO_KX_SEEDBYTES` (鍵交換シード長): " . SODIUM_CRYPTO_KX_SEEDBYTES . " バイト\n\n";
32
33    // 2. ナンス（Nonce）の生成
34    // ナンスは「Number used once」の略で、同じ鍵で複数のメッセージを暗号化する際に必須です。
35    // 各暗号化操作でユニークな値である必要があります。
36    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
37    echo "生成されたナンス (Hex): " . bin2hex($nonce) . " (長さ: " . strlen($nonce) . " バイト)\n";
38    echo "  - `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` (secretboxのナンス長): " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイト\n\n";
39
40    // 3. メッセージの暗号化
41    // `sodium_crypto_secretbox` は認証付き暗号を提供します。
42    // 戻り値は、認証タグと暗号化されたデータが連結されたものです。
43    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
44    echo "暗号化されたデータ (Hex): " . bin2hex($ciphertext) . " (長さ: " . strlen($ciphertext) . " バイト)\n\n";
45
46    // 4. メッセージの復号化
47    // 復号化に失敗した場合（例：データが改ざんされた、または鍵/ナンスが間違っている場合）、`false`を返します。
48    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
49
50    if ($decryptedMessage === false) {
51        echo "復号化に失敗しました！データが改ざんされたか、鍵またはナンスが間違っている可能性があります。\n";
52    } else {
53        echo "復号化されたメッセージ: '" . $decryptedMessage . "'\n";
54    }
55}
56
57// サンプル関数の実行
58encryptAndDecryptSecretboxMessage("システムエンジニアを目指す皆さん、PHPの暗号化の基本を学びましょう！");
59

PHPのSodium拡張は、安全な暗号化処理を簡単に実装するための機能を提供します。このサンプルコードは、共通鍵暗号方式であるsodium_crypto_secretbox関数を用いて、メッセージを暗号化・復号化する基本的な手順を示しています。

まず、暗号化に必須となる共有秘密鍵と、各暗号化操作で一度だけ使用されるナンス（Number used once）を生成します。鍵はSODIUM_CRYPTO_SECRETBOX_KEYBYTES定数で指定された長さ（通常32バイト）で生成されます。ここでSODIUM_CRYPTO_KX_SEEDBYTES定数も表示していますが、これは本来鍵交換プロトコルのシード長を示す定数であり、本例では偶然SODIUM_CRYPTO_SECRETBOX_KEYBYTESと同じ値であることを補足しています。

メッセージの暗号化にはsodium_crypto_secretbox関数を使います。この関数は、暗号化したい平文メッセージ（string）、生成したナンス（string）、そして共有秘密鍵（string）を引数として受け取ります。認証付き暗号化を提供するため、メッセージを暗号化するだけでなく、データの改ざんを検出するための認証タグも同時に生成し、これらを結合した形式で暗号文（string）として返します。

復号化にはsodium_crypto_secretbox_open関数を使用します。この関数は、暗号文（string）、暗号化時に使用したナンス（string）、共有秘密鍵（string）を引数に取ります。復号処理中にデータが改ざんされたことを検出した場合や、鍵またはナンスが間違っている場合にはfalseを返し、安全に復号できなかったことを伝えます。正常に復号できた場合は、元の平文（string）を戻り値として返します。