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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_KEYPAIRBYTES 定数とそれに連なる Sodium 拡張関数の使用例を示します。
5 *
6 * この関数は、公開鍵暗号化のためのキーペアの生成プロセスと、その構成要素のサイズを
7 * システムエンジニアを目指す初心者にも分かりやすく実演します。
8 *
9 * @return void
10 */
11function demonstrateSodiumKeyPairGeneration(): void
12{
13    // SODIUM_CRYPTO_BOX_KEYPAIRBYTES 定数は、sodium_crypto_box_keypair() 関数が生成する
14    // 公開鍵と秘密鍵を含むキーペア全体のバイトサイズを示します。
15    echo "SODIUM_CRYPTO_BOX_KEYPAIRBYTES (キーペア全体のサイズ): " . SODIUM_CRYPTO_BOX_KEYPAIRBYTES . " bytes\n";
16
17    // sodium_crypto_box_keypair() を使用して、公開鍵と秘密鍵のペアを生成します。
18    // このキーペアは、セキュアな通信（メッセージの暗号化や署名）の基盤となります。
19    $keyPair = sodium_crypto_box_keypair();
20    echo "--- キーペアを生成しました ---\n";
21
22    // 生成されたキーペアの実際のバイトサイズを確認します。
23    // このサイズは SODIUM_CRYPTO_BOX_KEYPAIRBYTES と一致するはずです。
24    $actualKeyPairSize = strlen($keyPair);
25    echo "生成されたキーペアの実際のサイズ: " . $actualKeyPairSize . " bytes\n";
26
27    if ($actualKeyPairSize === SODIUM_CRYPTO_BOX_KEYPAIRBYTES) {
28        echo "=> 定数と実際のキーペアサイズは一致します。\n";
29    } else {
30        echo "=> 警告: 定数と実際のキーペアサイズが一致しません！\n";
31    }
32
33    // 生成されたキーペアから公開鍵と秘密鍵をそれぞれ抽出します。
34    // 公開鍵は安全に共有できますが、秘密鍵は厳重に保護する必要があります。
35    $publicKey = sodium_crypto_box_publickey_from_keypair($keyPair);
36    $secretKey = sodium_crypto_box_secretkey_from_keypair($keyPair);
37
38    // 公開鍵と秘密鍵のバイトサイズも確認します。
39    // これらはそれぞれ SODIUM_CRYPTO_BOX_PUBLICKEYBYTES と SODIUM_CRYPTO_BOX_SECRETKEYBYTES に一致します。
40    echo "--- キーペアから鍵を抽出しました ---\n";
41    echo "公開鍵のサイズ: " . strlen($publicKey) . " bytes (SODIUM_CRYPTO_BOX_PUBLICKEYBYTES: " . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . ")\n";
42    echo "秘密鍵のサイズ: " . strlen($secretKey) . " bytes (SODIUM_CRYPTO_BOX_SECRETKEYBYTES: " . SODIUM_CRYPTO_BOX_SECRETKEYBYTES . ")\n";
43
44    // 鍵の内容を直接表示するとバイナリデータになるため、Base64エンコードして表示します。
45    // 実際のアプリケーションでは、鍵は通常このように直接出力されません。
46    echo "公開鍵 (Base64エンコード): " . base64_encode($publicKey) . "\n";
47    echo "秘密鍵 (Base64エンコード): " . base64_encode($secretKey) . "\n";
48}
49
50// 関数を実行し、鍵生成のデモンストレーションを開始します。
51demonstrateSodiumKeyPairGeneration();

SODIUM_CRYPTO_BOX_KEYPAIRBYTESは、PHPのSodium拡張機能で提供される定数です。この定数は、安全なデータ交換や通信に用いられる「公開鍵暗号化」のためのキーペア全体が占めるバイトサイズを、整数値（int）として示します。キーペアとは、誰もが知ることのできる「公開鍵」と、持ち主だけが厳重に保管する「秘密鍵」がセットになったもので、これらを使ってメッセージの暗号化やデジタル署名を行います。

この定数自体は引数を取りません。その戻り値である整数値は、sodium_crypto_box_keypair()関数を使って生成される、公開鍵と秘密鍵を合わせたデータの長さが何バイトになるかをあらかじめ教えてくれるものです。サンプルコードでは、この定数で示される期待されるサイズと、実際に生成されたキーペアのサイズが一致するかを確認しています。これにより、生成されるキーペアのメモリ要件を把握し、Sodium拡張が正しく機能していることを検証できます。SODIUM_CRYPTO_BOX_KEYPAIRBYTESは、公開鍵暗号化を扱う際に、鍵のデータ構造とサイズを理解するための重要な情報を提供します。

Copy
1<?php
2
3/**
4 * libsodium の共通鍵暗号 (SecretBox) を使用してメッセージを安全に暗号化および復号化するサンプルです。
5 *
6 * このコードはキーワードである `sodium_crypto_secretbox` に焦点を当てています。
7 * リファレンス情報で指定された `SODIUM_CRYPTO_BOX_KEYPAIRBYTES` は公開鍵暗号 (Box)
8 * のキーペア長を示す定数であり、共通鍵暗号とは直接関係しませんが、
9 * 参考情報としてその値と `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` の値を比較表示します。
10 *
11 * PHP 8 以降では `sodium` 拡張機能が標準で有効になっています。
12 */
13function runSecretBoxExample(): void
14{
15    echo "--- libsodium SecretBox (共通鍵暗号) サンプル ---\n";
16
17    // 1. 共通鍵の生成
18    // `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` は SecretBox で使用される鍵のバイト数を示します。
19    // `sodium_crypto_secretbox_keygen()` で、この長さの安全な共通鍵が生成されます。
20    $key = sodium_crypto_secretbox_keygen();
21    echo "生成された共通鍵の長さ: " . strlen($key) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . ")\n";
22
23    // 2. 暗号化する平文メッセージ
24    $message = "システムエンジニアを目指す初心者の皆さん、頑張ってください！";
25    echo "元のメッセージ: " . $message . "\n";
26
27    // 3. ノンス (Nonce: Number used once) の生成
28    // ノンスは各暗号化操作でユニークである必要がある、使い捨てのランダム値です。
29    // `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` はノンスのバイト数を示します。
30    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
31    echo "生成されたノンスの長さ: " . strlen($nonce) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . ")\n";
32
33    // 4. メッセージの暗号化
34    // `sodium_crypto_secretbox()` 関数でメッセージ、ノンス、鍵を使って暗号化します。
35    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
36    echo "暗号化されたメッセージ (バイナリを16進数で表示): " . bin2hex($ciphertext) . "\n";
37    echo "暗号文の長さ: " . strlen($ciphertext) . " バイト\n";
38
39    // 5. 暗号化されたメッセージの復号化
40    // `sodium_crypto_secretbox_open()` 関数で暗号文、元のノンス、鍵を使って復号化します。
41    // ノンスまたは鍵が間違っている場合、復号に失敗し `false` を返します。
42    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
43
44    if ($decryptedMessage === false) {
45        echo "復号化に失敗しました。ノンスまたは鍵が間違っている可能性があります。\n";
46    } else {
47        echo "復号化されたメッセージ: " . $decryptedMessage . "\n";
48    }
49
50    // --- libsodium 定数比較 (参考情報) ---
51    // `SODIUM_CRYPTO_BOX_KEYPAIRBYTES` は、公開鍵暗号 (Box) で使用されるキーペアのバイト数です。
52    // 今回使用した共通鍵暗号 (SecretBox) とは直接的な関連はありませんが、
53    // libsodium の提供する異なる暗号方式での鍵のバイト数を示す定数として、参考までに表示します。
54    echo "\n--- libsodium 定数比較 ---\n";
55    echo "SODIUM_CRYPTO_BOX_KEYPAIRBYTES (公開鍵暗号のキーペア長): " . SODIUM_CRYPTO_BOX_KEYPAIRBYTES . " バイト\n";
56    echo "SODIUM_CRYPTO_SECRETBOX_KEYBYTES (共通鍵暗号の鍵長): " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト\n";
57}
58
59// サンプル関数の実行
60runSecretBoxExample();

このPHPサンプルコードは、libsodium拡張機能の共通鍵暗号（SecretBox）を利用し、メッセージを安全に暗号化・復号化する手順を具体的に示しています。PHP 8以降ではlibsodiumが標準で利用可能です。まず、sodium_crypto_secretbox_keygen()関数で共通鍵を生成し、random_bytes()関数とSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数を用いて各暗号化で一意な使い捨ての数値であるノンスを生成します。

sodium_crypto_secretbox()関数は、平文メッセージ、ノンス、共通鍵を引数に受け取り、暗号文をバイナリデータとして返します。この暗号文は、sodium_crypto_secretbox_open()関数に同じ暗号文、ノンス、共通鍵を引数として渡すことで復号化が試みられます。復号に成功すれば元のメッセージが、失敗すればfalseが戻り値として返されます。

リファレンス情報にあるSODIUM_CRYPTO_BOX_KEYPAIRBYTESは、公開鍵暗号（Box）におけるキーペアのバイト数を示す定数であり、整数値（int）を返します。このサンプルコードでは、共通鍵暗号とは異なる暗号方式の鍵長を示す参考情報として、その値がSODIUM_CRYPTO_SECRETBOX_KEYBYTESと比較して表示されています。