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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_SEEDBYTES 定数の利用例と、それに関連するLibSodiumの公開鍵暗号機能を示します。
5 *
6 * SODIUM_CRYPTO_BOX_SEEDBYTES は、sodium_crypto_box_seed_keypair() 関数で
7 * 公開鍵と秘密鍵のペアを生成する際に使用するシードのバイト長を定義する定数です。
8 */
9function demonstrateSodiumCryptoBoxUsage(): void
10{
11    echo "SODIUM_CRYPTO_BOX_SEEDBYTES の値: " . SODIUM_CRYPTO_BOX_SEEDBYTES . " バイト\n\n";
12
13    // 1. キーペア生成用のシードを生成します。
14    // シードの長さは SODIUM_CRYPTO_BOX_SEEDBYTES で定義されています。
15    $seed = random_bytes(SODIUM_CRYPTO_BOX_SEEDBYTES);
16    echo "生成されたシード (HEX形式): " . bin2hex($seed) . "\n\n";
17
18    // 2. シードからアリスのキーペア（公開鍵と秘密鍵）を生成します。
19    // このキーペアは、メッセージの暗号化と復号化に使用されます。
20    $aliceKeypair = sodium_crypto_box_seed_keypair($seed);
21    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
22    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
23
24    echo "アリスの公開鍵 (HEX形式): " . bin2hex($alicePublicKey) . "\n";
25    echo "アリスの秘密鍵 (HEX形式): " . bin2hex($aliceSecretKey) . "\n\n";
26
27    // 3. ボブのキーペアをランダムに生成します（シードは使いません）。
28    $bobKeypair = sodium_crypto_box_keypair();
29    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
30    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
31
32    echo "ボブの公開鍵 (HEX形式): " . bin2hex($bobPublicKey) . "\n";
33    echo "ボブの秘密鍵 (HEX形式): " . bin2hex($bobSecretKey) . "\n\n";
34
35    // 4. アリスがボブにメッセージを暗号化して送信します。
36    // アリスの秘密鍵とボブの公開鍵を使用して暗号化します。
37    $originalMessage = "こんにちは、ボブ！これはアリスからの秘密のメッセージです。";
38    echo "元のメッセージ: " . $originalMessage . "\n";
39
40    // ナンス（Nonce）は使い捨てのランダムな値で、各暗号化操作でユニークである必要があります。
41    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
42
43    $encryptedMessage = sodium_crypto_box(
44        $originalMessage,
45        $nonce,
46        sodium_crypto_box_keypair_from_secretkey_and_publickey($aliceSecretKey, $bobPublicKey)
47    );
48
49    echo "暗号化されたメッセージ (HEX形式): " . bin2hex($encryptedMessage) . "\n\n";
50
51    // 5. ボブがアリスからのメッセージを復号します。
52    // ボブの秘密鍵とアリスの公開鍵を使用して復号します。
53    $decryptedMessage = sodium_crypto_box_open(
54        $encryptedMessage,
55        $nonce,
56        sodium_crypto_box_keypair_from_secretkey_and_publickey($bobSecretKey, $alicePublicKey)
57    );
58
59    if ($decryptedMessage !== false) {
60        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
61    } else {
62        echo "メッセージの復号に失敗しました。キーやナンスが正しくない可能性があります。\n";
63    }
64}
65
66// 関数を実行します。
67demonstrateSodiumCryptoBoxUsage();

PHP 8のSODIUM_CRYPTO_BOX_SEEDBYTES定数は、暗号化ライブラリLibSodiumの公開鍵暗号機能で用いられる、鍵ペア生成のためのシードのバイト長を定義します。この定数は引数を取らず、その値は整数（int）です。主にsodium_crypto_box_seed_keypair()関数が安全な公開鍵と秘密鍵のペアを生成する際に、基となるシードデータの長さを指定するために利用されます。

サンプルコードでは、まずSODIUM_CRYPTO_BOX_SEEDBYTESの具体的な値を出力し、そのバイト長に基づいてランダムなシードを生成しています。このシードを使ってアリスの公開鍵と秘密鍵のペアを作成し、ボブの鍵ペアも別に生成します。最終的に、アリスが自身の秘密鍵とボブの公開鍵を用いてメッセージを暗号化し、それをボブが自身の秘密鍵とアリスの公開鍵で安全に復号する、公開鍵暗号の基本的なメッセージ交換プロセスを具体的に示しています。この定数は、セキュアな暗号通信において、信頼できる鍵ペアを生成するためのシードの長さを確保する、重要な役割を担っています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Sodium拡張の共有鍵暗号機能 (secretbox) を使用して、データの暗号化と復号化を実演します。
7 * また、SODIUM_CRYPTO_BOX_SEEDBYTES 定数の値も表示します。
8 *
9 * この関数は、システムエンジニアを目指す初心者向けに、
10 * 暗号化の基本的な流れとSodium拡張の利用方法を示します。
11 * SODIUM_CRYPTO_BOX_SEEDBYTES は公開鍵暗号のキーペア生成に関連する定数ですが、
12 * ここではSodium拡張の一部としてその値を出力し、
13 * キーワードである sodium_crypto_secretbox の使用例を提示します。
14 */
15function demonstrateSodiumSecretboxUsage(): void
16{
17    echo "=== Sodium Extension Demonstration ===\n\n";
18
19    // SODIUM_CRYPTO_BOX_SEEDBYTES 定数の値を出力
20    // この定数は、公開鍵暗号のキーペアを生成する際に必要なシードのバイト数を示します。
21    // sodium_crypto_secretbox とは直接関連しませんが、Sodium拡張の一部として存在します。
22    echo "SODIUM_CRYPTO_BOX_SEEDBYTES 定数の値 (型: " . gettype(SODIUM_CRYPTO_BOX_SEEDBYTES) . "): " . SODIUM_CRYPTO_BOX_SEEDBYTES . " バイト\n\n";
23
24    // -----------------------------------------------------------
25    // sodium_crypto_secretbox のデモンストレーション
26    // 共有秘密鍵 (Symmetric Key) を使用した暗号化・復号化
27    // -----------------------------------------------------------
28
29    echo "--- sodium_crypto_secretbox の使用例 ---\n";
30
31    // 1. 共有秘密鍵 (Symmetric Key) の生成
32    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES は secretbox に必要な鍵のバイト数を示します。
33    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
34    echo "長さ " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイトの秘密鍵を生成しました。\n";
35
36    // 2. 暗号化する平文メッセージ
37    $originalMessage = "これは非常に重要な秘密情報です。不正アクセスから保護する必要があります。";
38    echo "元のメッセージ: \"" . $originalMessage . "\"\n";
39
40    // 3. ナンス (Nonce) の生成
41    // ナンスは、同じ鍵で複数のメッセージを暗号化する際に必須です。
42    // 各暗号化操作でユニークなナンスを使用する必要があります。
43    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は secretbox に必要なナンスのバイト数を示します。
44    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
45    echo "長さ " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイトの一意なナンスを生成しました。\n";
46
47    // 4. メッセージの暗号化
48    // sodium_crypto_secretbox は平文、ナンス、鍵を使って暗号文を生成します。
49    $ciphertext = sodium_crypto_secretbox($originalMessage, $nonce, $key);
50    echo "暗号化されたメッセージ (Hex形式): " . bin2hex($ciphertext) . "\n";
51
52    // 5. メッセージの復号化
53    // sodium_crypto_secretbox_open は暗号文、ナンス、鍵を使って平文を復元します。
54    // 復号に失敗した場合は false を返します。
55    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
56
57    if ($decryptedMessage === false) {
58        echo "エラー: メッセージの復号に失敗しました。\n";
59        return;
60    }
61
62    echo "復号化されたメッセージ: \"" . $decryptedMessage . "\"\n";
63
64    // 6. 復号化されたメッセージが元のメッセージと一致することを確認
65    if ($originalMessage === $decryptedMessage) {
66        echo "成功: 元のメッセージと復号化されたメッセージが一致しました！\n";
67    } else {
68        echo "失敗: 元のメッセージと復号化されたメッセージが一致しませんでした！\n";
69    }
70}
71
72// 関数を実行してデモンストレーションを開始
73demonstrateSodiumSecretboxUsage();

このサンプルコードは、PHPのSodium拡張に用意されているSODIUM_CRYPTO_BOX_SEEDBYTES定数と、共有鍵暗号機能であるsodium_crypto_secretboxの使用方法を実演しています。

SODIUM_CRYPTO_BOX_SEEDBYTESは整数型の定数で、PHP 8で導入されたSodium拡張の一部です。これは公開鍵暗号のキーペアを生成する際に必要なシードのバイト数を示します。サンプルコードでは、この定数の値を出力し、Sodium拡張の定数の一例として紹介しています。

続いて、キーワードであるsodium_crypto_secretbox関数の利用例を詳細に示しています。この関数は、単一の共有秘密鍵を使用してデータを暗号化・復号化する際に用いられます。まず、random_bytes()関数とSODIUM_CRYPTO_SECRETBOX_KEYBYTES定数を使って秘密鍵を生成し、SODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数に基づいて一意のナンス（使い捨ての数値）を作成します。

暗号化では、sodium_crypto_secretbox関数に元のメッセージ、ナンス、秘密鍵を引数として渡すことで暗号文が生成され、戻り値は暗号化されたバイナリデータです。復号化では、sodium_crypto_secretbox_open関数に暗号文、同じナンス、同じ秘密鍵を引数として渡します。復号に成功すれば元のメッセージが戻り値として返され、失敗した場合はfalseを返します。この一連のプロセスを通じて、データの機密性を確保する方法を示しています。