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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_SECRETBOX_NONCEBYTES 定数を使用して、
5 * Sodiumライブラリの対称暗号化（Secretbox）の基本的な利用方法を示すサンプルコード。
6 *
7 * Secretboxは、メッセージ、秘密鍵、そしてユニークなnonce（ナンス）を用いてデータを暗号化・復号化します。
8 * SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、このnonceの推奨バイト長を定義しています。
9 */
10function demonstrateSodiumSecretbox(): void
11{
12    echo "--- Sodium Secretbox 暗号化・復号化のデモンストレーション ---\n\n";
13
14    // 1. SODIUM_CRYPTO_SECRETBOX_NONCEBYTES 定数の値を取得
15    // この定数は、secretbox関数で使用するnonceの推奨バイト長を示します。
16    $nonceBytes = SODIUM_CRYPTO_SECRETBOX_NONCEBYTES;
17    echo "SODIUM_CRYPTO_SECRETBOX_NONCEBYTES: " . $nonceBytes . " バイト\n";
18
19    // 2. 秘密鍵の生成
20    // この鍵は、暗号化と復号化の両方に必要です。安全に保管する必要があります。
21    $key = sodium_crypto_secretbox_keygen();
22    echo "秘密鍵が生成されました。\n";
23
24    // 3. 暗号化する元のメッセージ
25    $originalMessage = "システムエンジニアを目指す皆さん、こんにちは！これは秘密のメッセージです。";
26    echo "元のメッセージ: \"" . $originalMessage . "\"\n";
27
28    // 4. nonce（ナンス）の生成
29    // nonceは各暗号化操作でユニークである必要があります。
30    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES で指定されたバイト長で乱数から生成します。
31    $nonce = random_bytes($nonceBytes);
32    echo "Nonceが生成されました (長さ: " . strlen($nonce) . " バイト)。\n";
33
34    // 5. メッセージの暗号化
35    // sodium_crypto_secretbox() は、メッセージ、nonce、鍵を使用してデータを暗号化します。
36    $cipherText = sodium_crypto_secretbox($originalMessage, $nonce, $key);
37    echo "メッセージが暗号化されました。暗号文の長さ: " . strlen($cipherText) . " バイト。\n";
38
39    echo "\n--- 復号化のフェーズ ---\n\n";
40
41    // 6. 暗号化されたメッセージの復号化
42    // 復号化には、元のnonce、暗号化されたデータ、そして同じ鍵が必要です。
43    $decryptedMessage = sodium_crypto_secretbox_open($cipherText, $nonce, $key);
44
45    if ($decryptedMessage === false) {
46        echo "復号化に失敗しました！ nonce、鍵、または暗号文が不正である可能性があります。\n";
47    } else {
48        echo "復号化されたメッセージ: \"" . $decryptedMessage . "\"\n";
49
50        // 7. 元のメッセージと復号化されたメッセージが一致するか確認
51        if ($originalMessage === $decryptedMessage) {
52            echo "復号化に成功しました！元のメッセージと復号化されたメッセージは一致します。\n";
53        } else {
54            echo "エラー: 復号化されたメッセージが元のメッセージと一致しません。\n";
55        }
56    }
57    echo "\n------------------------------------------------------\n";
58}
59
60// 関数を実行してデモンストレーションを開始します。
61demonstrateSodiumSecretbox();
62
63?>

このサンプルコードは、PHPのSodium拡張機能が提供するSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数の利用方法と、それを用いた対称暗号化（Secretbox）の基本的な流れを示しています。SODIUM_CRYPTO_SECRETBOX_NONCEBYTESは、sodium_crypto_secretbox関数でデータを暗号化する際に必要となる「nonce（ナンス）」と呼ばれる使い捨ての数値の推奨バイト長を整数値（int）として定義する定数です。この定数自体は引数をとりません。

コードではまず、この定数からnonceの推奨バイト長を取得します。次に、sodium_crypto_secretbox_keygen()関数で暗号化と復号化に使う秘密鍵を生成し、元のメッセージを準備します。そして、SODIUM_CRYPTO_SECRETBOX_NONCEBYTESで指定されたバイト長を使ってrandom_bytes()関数でユニークなnonceを生成します。

生成されたメッセージ、nonce、鍵を用いてsodium_crypto_secretbox()関数でメッセージを暗号化します。暗号化されたデータは、同じnonceと鍵を使ってsodium_crypto_secretbox_open()関数で復号化され、元のメッセージに戻せることを確認しています。この一連のプロセスは、共通の秘密鍵とユニークなnonceを用いることで、データの安全なやり取りを実現するための基本的な手順を示しています。

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_SECRETBOX_NONCEBYTES 定数を用いた共有鍵暗号化のデモンストレーション。
5 *
6 * この関数は、LibSodium の `secretbox` 機能を使い、メッセージの暗号化と復号化の一連の処理を示します。
7 * ノンスのバイト長として `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` 定数を使用します。
8 *
9 * @param string $message 暗号化する平文メッセージ
10 * @return void
11 */
12function demonstrateSecretboxEncryption(string $message): void
13{
14    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES の値を取得し、表示します。
15    // この定数は、共有鍵暗号化（secretbox）で使用されるノンスの推奨バイト長を示します。
16    echo "SODIUM_CRYPTO_SECRETBOX_NONCEBYTES の値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイト\n\n";
17
18    // 共有鍵を生成します。この鍵は暗号化と復号化の両方に使用されます。
19    // 鍵は秘密に保たれる必要があります。
20    $key = sodium_crypto_secretbox_keygen();
21    echo "共有鍵を生成しました。\n";
22
23    // ノンス（Nonce - Number Used Once）を生成します。
24    // ノンスは暗号化ごとに異なる値を生成し、公開されても安全なランダムな値です。
25    // `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` で指定されたバイト長を使用します。
26    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
27    echo "ノンスを生成しました (長さ: " . strlen($nonce) . " バイト)。\n\n";
28
29    // メッセージを暗号化します。
30    // `sodium_crypto_secretbox` 関数は、メッセージ、ノンス、共有鍵を引数にとります。
31    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
32    echo "オリジナルメッセージ: " . $message . "\n";
33    echo "暗号化されたメッセージ (Hex): " . bin2hex($ciphertext) . "\n\n";
34
35    // 暗号化されたメッセージを復号化します。
36    // `sodium_crypto_secretbox_open` 関数は、暗号文、ノンス、共有鍵を引数にとります。
37    // 復号化に失敗した場合（例: 改ざんされた場合）、`false` を返します。
38    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
39
40    if ($decryptedMessage === false) {
41        echo "エラー: メッセージの復号化に失敗しました。暗号文が改ざんされた可能性があります。\n";
42    } else {
43        echo "復号化されたメッセージ: " . $decryptedMessage . "\n\n";
44
45        // 元のメッセージと復号化されたメッセージが一致するか確認します。
46        if ($message === $decryptedMessage) {
47            echo "結果: 暗号化と復号化は成功し、メッセージは一致しました。\n";
48        } else {
49            echo "結果: 致命的なエラー、復号化されたメッセージが元のメッセージと一致しませんでした。\n";
50        }
51    }
52
53    // セキュリティを強化するため、秘密鍵やノンスなどの機密データは使用後にメモリからクリアすることが推奨されます。
54    sodium_memzero($key);
55    sodium_memzero($nonce);
56}
57
58// 関数の実行例
59demonstrateSecretboxEncryption("このメッセージは共有鍵で安全に暗号化されます。");
60

このPHPサンプルコードは、PHPのLibSodium拡張機能を用いた共有鍵暗号化の一連の処理を、システムエンジニアを目指す初心者にも分かりやすくデモンストレーションしています。中心となるのは、暗号化処理で重要な「ノンス」の推奨バイト長を示すSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数です。この定数は引数を取らず、共有鍵暗号化で利用するノンスの標準的な長さを整数値として提供します。

コードではまず、メッセージの暗号化と復号化に使う秘密の「共有鍵」を生成します。次に、SODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数の値に基づいて、毎回異なるランダムな「ノンス」を生成します。ノンスは公開されても問題ありませんが、同じ鍵で複数の暗号化を行う際にセキュリティを確保するために必須です。

生成した共有鍵とノンスを使って、sodium_crypto_secretbox関数で元のメッセージを暗号化し、暗号文を得ます。その後、同じ共有鍵とノンスを用いてsodium_crypto_secretbox_open関数で暗号文を復号化します。この関数は、復号に成功すれば元のメッセージを返し、メッセージが改ざんされていた場合はセキュリティ上の理由からfalseを返します。これにより、メッセージの機密性と完全性が保たれていることを確認できます。最後に、使用済みの鍵やノンスといった機密情報をメモリから安全に消去する処理も含まれており、セキュリティ対策の重要性も示されています。