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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SODIUM_CRYPTO_SECRETBOX_KEYBYTES 定数と sodium_crypto_secretbox 関数の使用例を示します。
7 *
8 * この関数は、Liblibsodiumの共有鍵暗号機能を使って
9 * メッセージを暗号化し、復号化するプロセスをデモンストレーションします。
10 * SODIUM_CRYPTO_SECRETBOX_KEYBYTES は、安全な鍵の推奨バイト長を示します。
11 */
12function demonstrateSecretboxUsage(): void
13{
14    // 1. SODIUM_CRYPTO_SECRETBOX_KEYBYTES 定数の値を確認
15    // これは sodium_crypto_secretbox 関数で使用される秘密鍵の推奨バイト長です。
16    echo "推奨される秘密鍵のバイト長 (SODIUM_CRYPTO_SECRETBOX_KEYBYTES): "
17         . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト" . PHP_EOL . PHP_EOL;
18
19    // 2. 秘密鍵を生成
20    // sodium_crypto_secretbox_keygen() は、SODIUM_CRYPTO_SECRETBOX_KEYBYTES
21    // で指定された長さの安全な鍵を生成する便利な関数です。
22    $key = sodium_crypto_secretbox_keygen();
23    echo "生成された秘密鍵のバイト長: " . strlen($key) . " バイト" . PHP_EOL;
24
25    // 3. メッセージとノンス（Nonce）を準備
26    // ノンス（Number Used Once）は使い捨ての数値で、同じ鍵で異なるメッセージを暗号化する際に必須です。
27    // ノンスの長さも定数 (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) で定義されており、
28    // random_bytes() で安全に生成します。
29    $message = "これは秘密にしたいメッセージです。";
30    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
31
32    echo "元のメッセージ: " . $message . PHP_EOL;
33    echo "ノンスのバイト長 (SODIUM_CRYPTO_SECRETBOX_NONCEBYTES): "
34         . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイト" . PHP_EOL;
35    // ノンスはバイナリデータなので、表示のためにBase64エンコードします。
36    echo "生成されたノンス (Base64エンコード): " . base64_encode($nonce) . PHP_EOL . PHP_EOL;
37
38    // 4. メッセージを暗号化
39    // sodium_crypto_secretbox は、メッセージ、ノンス、秘密鍵を使用してデータを暗号化します。
40    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
41    // 暗号化されたメッセージもバイナリデータなので、表示のためにBase64エンコードします。
42    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($ciphertext) . PHP_EOL . PHP_EOL;
43
44    // 5. 暗号化されたメッセージを復号化
45    // sodium_crypto_secretbox_open は、暗号化されたメッセージ、使用したノンス、秘密鍵を使用してデータを復号化します。
46    // 復号に失敗した場合は false を返します（例えば、鍵やノンスが間違っている場合など）。
47    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
48
49    if ($decryptedMessage !== false) {
50        echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
51        if ($message === $decryptedMessage) {
52            echo "検証成功: 元のメッセージと復号化されたメッセージは一致します。" . PHP_EOL;
53        } else {
54            echo "検証失敗: メッセージが一致しません。何らかの問題が発生しました。" . PHP_EOL;
55        }
56    } else {
57        echo "エラー: メッセージの復号に失敗しました。鍵やノンスが正しくない可能性があります。" . PHP_EOL;
58    }
59}
60
61// デモンストレーション関数を実行
62demonstrateSecretboxUsage();

PHP 8のSODIUM_CRYPTO_SECRETBOX_KEYBYTESは、共有鍵暗号化における秘密鍵の推奨バイト長を示す定数で、整数（int）を返します。この定数は、sodium_crypto_secretbox関数などで安全な鍵長を確保するために利用されます。

sodium_crypto_secretbox関数は、指定されたメッセージを秘密鍵と使い捨ての数値であるノンスを用いて暗号化する機能を提供します。引数にはメッセージ（string）、ノンス（string）、秘密鍵（string）を指定し、暗号化されたデータ（string）を返します。

サンプルコードは、SODIUM_CRYPTO_SECRETBOX_KEYBYTESで鍵を生成し、メッセージとノンスを用いてsodium_crypto_secretbox関数で暗号化する過程を示します。その後、sodium_crypto_secretbox_open関数で復号し、元のメッセージと一致するかを検証します。復号成功時には元のメッセージ（string）が、失敗時にはfalseが返されます。これにより、定数と関数が連携して安全なデータ保護を実現する基本的な流れが理解できます。

Copy
1<?php
2
3/**
4 * PHPのSodium拡張機能を使用して、秘密鍵暗号（SecretBox）の基本的な暗号化と復号化をデモンストレーションします。
5 *
6 * この関数は、システムエンジニアを目指す初心者が、共通鍵暗号の概念と実装方法を理解するのに役立ちます。
7 * 特に、`SODIUM_CRYPTO_SECRETBOX_KEYBYTES` 定数を使用して、安全な共通鍵の長さを確保する方法を示します。
8 *
9 * @param string $message 暗号化する対象となる平文（読める形式のメッセージ）です。
10 * @return void 出力は直接コンソールに表示されます。
11 */
12function demonstrateSodiumSecretBox(string $message): void
13{
14    echo "=== 秘密鍵暗号（SecretBox）のデモンストレーション ===\n";
15    echo "元のメッセージ: " . $message . "\n\n";
16
17    // 1. 共通鍵（シークレットキー）の生成
18    // `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` は、`sodium_crypto_secretbox` 関数が要求する
19    // 鍵の正確なバイト数（長さ）を教えてくれる定数です。
20    // これにより、セキュリティ上適切な長さの鍵を確実に生成できます。
21    $keyLength = SODIUM_CRYPTO_SECRETBOX_KEYBYTES;
22    $key = random_bytes($keyLength); // 暗号学的に安全な疑似乱数バイトを生成します
23    echo "生成された共通鍵の長さ: " . strlen($key) . "バイト (期待値: " . $keyLength . "バイト)\n";
24
25    // 2. ナンス（Nonce: Number used once）の生成
26    // ナンスは「一度だけ使われる番号」という意味で、各暗号化操作ごとに異なる値を生成する必要があります。
27    // これにより、同じ平文と鍵を使っても、異なる暗号文が生成され、セキュリティが向上します。
28    // `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` は、ナンスに必要なバイト数を教えてくれる定数です。
29    $nonceLength = SODIUM_CRYPTO_SECRETBOX_NONCEBYTES;
30    $nonce = random_bytes($nonceLength);
31    echo "生成されたナンスの長さ: " . strlen($nonce) . "バイト (期待値: " . $nonceLength . "バイト)\n\n";
32
33    // 3. メッセージの暗号化
34    // `sodium_crypto_secretbox` 関数を使ってメッセージを暗号化します。
35    // 必要な引数: 平文、ナンス、共通鍵
36    $encryptedMessage = sodium_crypto_secretbox($message, $nonce, $key);
37    echo "暗号化されたメッセージ（バイナリをHex形式で表示）: " . bin2hex($encryptedMessage) . "\n";
38    echo "暗号文の長さ: " . strlen($encryptedMessage) . "バイト\n\n";
39
40    // 4. メッセージの復号化
41    // `sodium_crypto_secretbox_open` 関数を使って暗号化されたメッセージを復号します。
42    // 必要な引数: 暗号文、同じナンス、同じ共通鍵
43    // 復号に失敗した場合（例えば、暗号文や鍵、ナンスが改ざんされた場合）は `false` を返します。
44    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
45
46    if ($decryptedMessage === false) {
47        echo "!!! エラー: メッセージの復号に失敗しました。鍵、ナンス、または暗号文が正しくない可能性があります。\n";
48    } else {
49        echo "復号化されたメッセージ: " . $decryptedMessage . "\n\n";
50
51        // 復号が成功したか、元のメッセージと一致するかを確認します
52        if ($message === $decryptedMessage) {
53            echo "--- 結果: 暗号化と復号化が正常に成功し、元のメッセージと完全に一致しました。 ---\n";
54        } else {
55            echo "!!! 警告: 復号化されたメッセージが元のメッセージと一致しませんでした。何らかの問題が発生しています。\n";
56        }
57    }
58    echo "\n=== デモンストレーション終了 ===\n";
59}
60
61// サンプルコードの実行
62// システムエンジニアの初心者が実際に試せるように、具体的なメッセージを渡します。
63demonstrateSodiumSecretBox("このデータは安全に保管されるべき機密情報です。第三者には読まれないようにしましょう。");

このPHPのサンプルコードは、PHP 8で利用可能なSodium拡張機能を用いた秘密鍵暗号（SecretBox）の基本的な暗号化と復号化のプロセスを、システムエンジニアを目指す初心者の方向けに具体的に示しています。

特に、SODIUM_CRYPTO_SECRETBOX_KEYBYTESという定数の利用が重要です。この定数は、sodium_crypto_secretbox関数が要求する共通鍵（シークレットキー）の正確なバイト数（長さ）を整数値（int）で提供します。引数は必要ありません。これにより、セキュリティ上適切な長さの共通鍵を確実に生成することが可能となり、脆弱性を防ぐ上で不可欠な役割を果たします。

コードではまず、このSODIUM_CRYPTO_SECRETBOX_KEYBYTES定数を用いて適切な長さの共通鍵を生成します。次に、同様にSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数で必要な長さのナンス（一度だけ使われる乱数）を生成し、これらの要素を用いてメッセージを暗号化しています。sodium_crypto_secretbox関数は平文、ナンス、共通鍵を引数に取り、暗号文を返します。復号化の際には、sodium_crypto_secretbox_open関数に暗号文、同じナンス、同じ共通鍵を引数として渡し、成功すれば元の平文を、失敗した場合はfalseを戻り値として取得します。この一連の処理を通じて、共通鍵暗号の概念、鍵やナンスの安全な生成方法、そしてデータ保護の仕組みを実践的に学ぶことができます。