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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_NONCEBYTES 定数を含む sodium_crypto_box の使用例を示します。
5 *
6 * この関数は、lib/sodium 拡張機能を使用して、公開鍵/秘密鍵のペアに基づいた
7 * メッセージの認証付き暗号化と復号化の手順を実演します。
8 * SODIUM_CRYPTO_BOX_NONCEBYTES 定数は、安全な暗号化に必要なノンスの推奨バイト数を定義します。
9 */
10function demonstrateSodiumCryptoBoxUsage(): void
11{
12    echo "--- libsodium crypto_box の使用例 ---\n\n";
13
14    // SODIUM_CRYPTO_BOX_NONCEBYTES の値を出力します。
15    // これは sodium_crypto_box 関数で使用されるノンスの推奨バイト数を示す定数です。
16    echo "SODIUM_CRYPTO_BOX_NONCEBYTES の値: " . SODIUM_CRYPTO_BOX_NONCEBYTES . " バイト\n\n";
17
18    // 1. 鍵ペアの生成
19    // 送信者 (Alice) と受信者 (Bob) がそれぞれ独自の公開鍵/秘密鍵ペアを生成します。
20    $aliceKeypair = sodium_crypto_box_keypair();
21    $bobKeypair = sodium_crypto_box_keypair();
22
23    // 鍵ペアから秘密鍵と公開鍵を抽出します。
24    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
25    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
26
27    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
28    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
29
30    echo "鍵ペア生成完了。\n";
31    echo "Alice の公開鍵の長さ: " . strlen($alicePublicKey) . " バイト\n";
32    echo "Bob の公開鍵の長さ: " . strlen($bobPublicKey) . " バイト\n\n";
33
34    // 2. 暗号化するメッセージ
35    $message = "これは秘匿すべきメッセージです。第三者には読まれないようにします。";
36    echo "元のメッセージ: '" . $message . "'\n\n";
37
38    // 3. ノンスの生成
39    // ノンス (Number Used Once) は、各暗号化操作で一度だけ使用されるランダムな値です。
40    // 予測可能なノンスを再利用するとセキュリティ上の脆弱性につながるため、
41    // 常に暗号学的に強力な新しいランダムなノンスを生成する必要があります。
42    // SODIUM_CRYPTO_BOX_NONCEBYTES で定義されたバイト数のノンスを生成します。
43    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
44    echo "生成されたノンスの長さ: " . strlen($nonce) . " バイト (期待値: " . SODIUM_CRYPTO_BOX_NONCEBYTES . ")\n\n";
45
46    // 4. 暗号化に必要な「共有鍵」文字列の準備 (PHP 8.0 以前の形式)
47    // sodium_crypto_box の第三引数には、自身の秘密鍵と相手の公開鍵を連結した文字列を渡します。
48    // Alice が Bob にメッセージを送る場合: Alice の秘密鍵 + Bob の公開鍵
49    $aliceToBobSharedKeyString = $aliceSecretKey . $bobPublicKey;
50
51    // 5. メッセージの暗号化 (Alice が Bob へ送る)
52    // Alice の秘密鍵と Bob の公開鍵に基づいて生成された共有鍵文字列とノンスを使ってメッセージを暗号化します。
53    $encryptedMessage = sodium_crypto_box($message, $nonce, $aliceToBobSharedKeyString);
54    echo "暗号化されたメッセージ (バイナリ、一部): " . substr(bin2hex($encryptedMessage), 0, 30) . "...\n";
55    echo "暗号化されたメッセージの長さ: " . strlen($encryptedMessage) . " バイト\n\n";
56
57    // 6. 復号化に必要な「共有鍵」文字列の準備 (PHP 8.0 以前の形式)
58    // Bob が Alice から受け取ったメッセージを復号化する場合: Bob の秘密鍵 + Alice の公開鍵
59    $bobToAliceSharedKeyString = $bobSecretKey . $alicePublicKey;
60
61    // 7. メッセージの復号化 (Bob が Alice から受け取る)
62    // Bob の秘密鍵と Alice の公開鍵に基づいて生成された共有鍵文字列と、
63    // 暗号化時に使用されたノンスを使ってメッセージを復号化します。
64    // 復号に成功すると元のメッセージが、失敗すると false が返されます。
65    $decryptedMessage = sodium_crypto_box_open($encryptedMessage, $nonce, $bobToAliceSharedKeyString);
66
67    if ($decryptedMessage !== false) {
68        echo "復号化されたメッセージ: '" . $decryptedMessage . "'\n\n";
69        if ($decryptedMessage === $message) {
70            echo "元のメッセージと復号化されたメッセージは一致します。暗号化/復号化に成功しました。\n";
71        } else {
72            echo "元のメッセージと復号化されたメッセージは一致しません！エラーが発生しました。\n";
73        }
74    } else {
75        echo "メッセージの復号化に失敗しました。\n";
76        echo "これは、鍵ペアやノンスが間違っている場合に発生する可能性があります。\n";
77    }
78}
79
80// 関数を実行して、上記サンプルコードの動作を確認します。
81demonstrateSodiumCryptoBoxUsage();

PHPのSODIUM_CRYPTO_BOX_NONCEBYTES定数は、暗号化ライブラリlibsodiumが提供する重要な情報です。この定数は、公開鍵暗号方式でメッセージを安全に暗号化する際に必要となる「ノンス」（Number Used Once）の推奨バイト数を示す整数値を提供します。ノンスは、同じ鍵で複数のメッセージを暗号化する場合でも、各メッセージごとに異なる値を使い、セキュリティを確保するために不可欠な使い捨てのランダムなデータです。SODIUM_CRYPTO_BOX_NONCEBYTESは引数を取らず、そのまま参照することで、ノンスとして必要なバイト数を取得できます。

サンプルコードでは、まず送信者と受信者の鍵ペアを生成し、次に暗号化するメッセージを準備します。その後、SODIUM_CRYPTO_BOX_NONCEBYTESの値をrandom_bytes関数に渡し、推奨される適切な長さのノンスを生成しています。このノンスと、送信者の秘密鍵および受信者の公開鍵から得られる共有鍵情報を用いて、sodium_crypto_box関数によりメッセージを暗号化します。暗号化されたメッセージは、受信者が自身の秘密鍵と送信者の公開鍵、そして暗号化時に使われたノンスを使い、sodium_crypto_box_open関数で復号化されます。この定数を使用することで、開発者はlibsodiumが推奨するセキュリティ要件を満たしたノンスの長さを容易に取得し、暗号化処理の堅牢性を高めることができます。

Copy
1<?php
2
3/**
4 * libsodium拡張が利用可能かチェックします。
5 * 暗号化処理を行うには、PHPにlibsodium拡張がインストールされ、有効になっている必要があります。
6 *
7 * @return bool libsodium拡張が有効な場合true、そうでない場合false。
8 */
9function checkSodiumExtension(): bool
10{
11    if (!extension_loaded('sodium')) {
12        echo 'エラー: libsodium拡張がロードされていません。PHPの設定を確認してください。' . PHP_EOL;
13        return false;
14    }
15    return true;
16}
17
18/**
19 * 共通鍵暗号 (Secret-key cryptography) の sodium_crypto_secretbox 関数を使用して、
20 * メッセージの暗号化と復号化の基本的な例を示します。
21 *
22 * この関数は、共有された秘密鍵とノンス（一度だけ使用されるランダムな値）を用いてデータを安全に扱います。
23 * ノンスは毎回異なる値を生成する必要があります。
24 */
25function demonstrateSodiumCryptoSecretbox(): void
26{
27    // --- リファレンス情報に関する補足 ---
28    // SODIUM_CRYPTO_BOX_NONCEBYTES は、公開鍵暗号 (例: sodium_crypto_box_seal) で使用される
29    // ノンス（Nonce）のバイト数を示す定数です。その値は ' . SODIUM_CRYPTO_BOX_NONCEBYTES . ' です。
30    // このサンプルで利用する sodium_crypto_secretbox (共通鍵暗号) とは異なる暗号化方式で使われます。
31    // sodium_crypto_secretbox で使用されるノンスのバイト数は SODIUM_CRYPTO_SECRETBOX_NONCEBYTES で定義されます。
32    // --- 補足終わり ---
33
34    if (!checkSodiumExtension()) {
35        return;
36    }
37
38    // 1. 秘密鍵の生成
39    // sodium_crypto_secretbox_keygen() は安全な秘密鍵を生成します。
40    // 実際のアプリケーションでは、この鍵は安全に生成、保存、共有される必要があります。
41    $key = sodium_crypto_secretbox_keygen();
42    echo '秘密鍵の生成が完了しました。長さ: ' . strlen($key) . ' バイト' . PHP_EOL;
43
44    // 2. 暗号化するメッセージ
45    $originalMessage = 'システムエンジニアを目指す皆さん、PHPでのセキュリティ実装は基本の「き」です！';
46    echo '元のメッセージ: ' . $originalMessage . PHP_EOL;
47
48    // 3. ノンス (Nonce) の生成
49    // ノンスは暗号化ごとにユニークなランダム値である必要があります。
50    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、sodium_crypto_secretbox 関数に必要なノンスの正確なバイト数を指定します。
51    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
52    echo 'ノンスの生成が完了しました。長さ: ' . strlen($nonce) . ' バイト' . PHP_EOL;
53
54    // 4. メッセージの暗号化
55    // sodium_crypto_secretbox() はメッセージ、ノンス、鍵を引数に取り、暗号化されたデータ（ciphertext）を返します。
56    $ciphertext = sodium_crypto_secretbox($originalMessage, $nonce, $key);
57    echo '暗号化されたメッセージ (Base64エンコード): ' . base64_encode($ciphertext) . PHP_EOL;
58
59    // 5. メッセージの復号化
60    // sodium_crypto_secretbox_open() は暗号文、ノンス、鍵を引数に取り、元のメッセージを復元します。
61    // 復号に失敗した場合は false を返します。
62    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
63
64    if ($decryptedMessage === false) {
65        echo 'エラー: メッセージの復号化に失敗しました。鍵またはノンスが一致しない可能性があります。' . PHP_EOL;
66    } else {
67        echo '復号化されたメッセージ: ' . $decryptedMessage . PHP_EOL;
68
69        // 6. 復号化されたメッセージの検証
70        if ($decryptedMessage === $originalMessage) {
71            echo '検証成功: 復号化されたメッセージは元のメッセージと一致します。' . PHP_EOL;
72        } else {
73            echo '検証失敗: 復号化されたメッセージが元のメッセージと異なります。' . PHP_EOL;
74        }
75    }
76}
77
78// サンプルコードの実行
79demonstrateSodiumCryptoSecretbox();

SODIUM_CRYPTO_BOX_NONCEBYTESは、PHPのlibsodium拡張で提供される定数で、公開鍵暗号方式の一つであるsodium_crypto_box関数などで使用されるノンスの推奨バイト数を示す整数値です。ノンスは暗号化の安全性を高めるために一度だけ使用されるランダムな値であり、この定数の戻り値はint型でそのバイト数を表します。

このサンプルコードは、libsodium拡張を利用した共通鍵暗号の基本的なメッセージ暗号化と復号化のプロセスを解説しています。具体的な処理にはsodium_crypto_secretbox関数群を使用します。

まず、sodium_crypto_secretbox_keygen()関数で安全な秘密鍵を生成します。次に、暗号化ごとに異なるノンスをrandom_bytes()とSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数を用いて生成します。ここで使われるSODIUM_CRYPTO_SECRETBOX_NONCEBYTESは、共通鍵暗号のsodium_crypto_secretboxに適したノンスのバイト数を示す定数であり、リファレンス情報に挙げられたSODIUM_CRYPTO_BOX_NONCEBYTESとは異なる点にご注意ください。これは、暗号化方式によって適切なノンスの長さが異なるためです。

メッセージの暗号化はsodium_crypto_secretbox()関数が行い、元のメッセージ、ノンス、秘密鍵を引数として暗号化されたデータを返します。復号化はsodium_crypto_secretbox_open()関数を使い、暗号文、同じノンス、秘密鍵を引数に渡すことで元のメッセージを復元します。復号に失敗した場合はfalseが戻り値となります。このコードは、セキュリティ実装の基礎として共通鍵暗号の動作を理解するのに役立ちます。