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

Copy
1<?php
2
3/**
4 * Sodium拡張を使った公開鍵暗号のサンプルコード。
5 * AliceとBob間でメッセージを安全にやり取りする方法を示します。
6 *
7 * 注記: SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES は
8 * ストリーム暗号化のヘッダーサイズを示す定数であり、今回の公開鍵暗号 (sodium_crypto_box) とは直接関連しませんが、
9 * 同じSodium拡張に属する定数としてその値を出力しています。
10 */
11function demonstrateSodiumCryptoBox(): void
12{
13    echo "=== Sodium Extension: 公開鍵暗号 (sodium_crypto_box) ===\n";
14
15    // PHP環境でSodium拡張が有効になっているか確認します。
16    // 有効でない場合、関連する関数は使用できません。
17    if (!extension_loaded('sodium')) {
18        echo "エラー: Sodium拡張が有効になっていません。php.iniでsodium拡張を有効にしてください。\n";
19        return;
20    }
21
22    // リファレンス情報にある定数 SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES の値を出力します。
23    // これはストリーム暗号化に関連する定数であり、本サンプルコードの公開鍵暗号とは直接関係ありませんが、
24    // Sodium拡張が提供する定数の一つです。
25    echo "SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES の値: " . SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES . " バイト\n\n";
26
27    // 1. 鍵ペアの生成
28    echo "--- 鍵ペア生成 ---\n";
29    // Alice用の鍵ペア (公開鍵と秘密鍵のセット) を生成します。
30    $aliceKeypair = sodium_crypto_box_keypair();
31    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair); // Aliceの公開鍵
32    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair); // Aliceの秘密鍵
33    echo "Aliceの鍵ペアを生成しました。\n";
34
35    // Bob用の鍵ペアを生成します。
36    $bobKeypair = sodium_crypto_box_keypair();
37    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair); // Bobの公開鍵
38    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair); // Bobの秘密鍵
39    echo "Bobの鍵ペアを生成しました。\n\n";
40
41    // 2. メッセージの準備
42    $originalMessage = "こんにちはBob、Aliceからの秘密のメッセージだよ！";
43    echo "元のメッセージ: " . $originalMessage . "\n\n";
44
45    // 3. メッセージの暗号化 (AliceがBobへメッセージを送る場合)
46    echo "--- 暗号化 (Alice -> Bob) ---\n";
47    // ノンス (nonce: Number once) は、各暗号化操作で一度だけ使用されるランダムな値です。
48    // これにより、同じメッセージを同じ鍵で複数回暗号化しても、毎回異なる暗号文が生成され、セキュリティが向上します。
49    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
50
51    // Aliceは、Bobの公開鍵と自身の秘密鍵を使用してメッセージを暗号化します。
52    // sodium_crypto_box_keypair_from_secretkey_and_publickey は、
53    // 暗号化/復号化に必要な「共有秘密鍵」を安全に導出するためのキーペアを構築します。
54    $encryptedMessage = sodium_crypto_box(
55        $originalMessage,
56        $nonce,
57        sodium_crypto_box_keypair_from_secretkey_and_publickey(
58            $aliceSecretKey, // Aliceの秘密鍵
59            $bobPublicKey    // Bobの公開鍵
60        )
61    );
62    echo "メッセージを暗号化しました。\n";
63    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($encryptedMessage) . "\n";
64    echo "使用したノンス (Base64エンコード): " . base64_encode($nonce) . "\n\n";
65
66    // 4. メッセージの復号化 (BobがAliceからのメッセージを受け取る場合)
67    echo "--- 復号化 (Bob <- Alice) ---\n";
68    // Bobは、自身の秘密鍵とAliceの公開鍵、そして暗号化時に使用されたノンスを使ってメッセージを復号化します。
69    $decryptedMessage = sodium_crypto_box_open(
70        $encryptedMessage,
71        $nonce,
72        sodium_crypto_box_keypair_from_secretkey_and_publickey(
73            $bobSecretKey,    // Bobの秘密鍵
74            $alicePublicKey   // Aliceの公開鍵
75        )
76    );
77
78    // 復号化が成功したか確認します。
79    // 認証エラーやデータ改ざんがあった場合、falseが返されます。
80    if ($decryptedMessage === false) {
81        echo "エラー: メッセージの復号化に失敗しました。認証エラーまたはデータが改ざんされている可能性があります。\n";
82    } else {
83        echo "メッセージを復号化しました。\n";
84        echo "復号化されたメッセージ: " . $decryptedMessage . "\n\n";
85
86        // 5. 検証
87        // 元のメッセージと復号化されたメッセージが一致するか確認します。
88        if ($originalMessage === $decryptedMessage) {
89            echo "検証: 元のメッセージと復号化されたメッセージが一致します。公開鍵暗号のデモンストレーションは成功です！\n";
90        } else {
91            echo "検証: エラー！元のメッセージと復号化されたメッセージが一致しません。\n";
92        }
93    }
94}
95
96// サンプルコードを実行します。
97demonstrateSodiumCryptoBox();

このサンプルコードは、PHPのSodium拡張を使用して、安全なメッセージのやり取りを行う公開鍵暗号（sodium_crypto_box）の基本的な使い方を示しています。まず、参照情報にある定数SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTESの値を出力します。この定数はストリーム暗号化のヘッダーサイズを示す整数（int）で、戻り値はバイト数を表します。今回の公開鍵暗号とは直接関連しませんが、Sodium拡張の一部として提供されています。コードでは、通信を行う二者（AliceとBob）がそれぞれ公開鍵と秘密鍵のペアを生成します。メッセージを暗号化する際には、送り手（Alice）の秘密鍵と受け手（Bob）の公開鍵、そして各暗号化ごとに異なるランダムな値であるノンス（nonce）を使います。sodium_crypto_box関数はこれらを用いてメッセージを暗号化し、暗号文を返します。メッセージを復号化する際には、受け手（Bob）の秘密鍵と送り手（Alice）の公開鍵、そして暗号化時に使われた同じノンスを使って、sodium_crypto_box_open関数により元のメッセージを取り出します。復号化に成功すると元のメッセージが取得され、失敗した場合はfalseが返されることで、データが改ざんされていないかを確認できます。

Copy
1<?php
2
3/**
4 * libsodium拡張のsodium_crypto_secretbox関数を使用して、
5 * メッセージを認証付きで暗号化・復号化するデモンストレーションを行います。
6 *
7 * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES 定数は、
8 * ストリーム暗号に関連するもので、sodium_crypto_secretboxとは直接的な関連はありませんが、
9 * 同じlibsodium拡張で提供される定数の一つとして紹介します。
10 */
11function demonstrateSecretBoxEncryption(): void
12{
13    echo "--- libsodium: sodium_crypto_secretbox を使った認証付き暗号化デモンストレーション ---\n\n";
14
15    // 1. 秘密鍵を生成します。
16    // sodium_crypto_secretbox_keygen() は、256ビット (32バイト) の安全な鍵を生成します。
17    $key = sodium_crypto_secretbox_keygen();
18    echo "生成された秘密鍵 (Base64エンコード): " . base64_encode($key) . "\n\n";
19
20    // 2. 暗号化する平文メッセージ
21    $message = "これは秘密のメッセージです。安全に送信・保存するために暗号化します。";
22    echo "元のメッセージ: " . $message . "\n\n";
23
24    // 3. ナンス (Nonce: Number used once) を生成します。
25    // 同じ鍵で同じナンスを二度使ってはいけません。必ずユニークなナンスを生成してください。
26    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、必要なナンスのバイト数を示します。
27    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
28    echo "生成されたナンス (Base64エンコード): " . base64_encode($nonce) . "\n\n";
29
30    // 4. メッセージを暗号化します。
31    // sodium_crypto_secretbox は、メッセージに認証タグを付けて暗号化し、その結果を返します。
32    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
33    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($ciphertext) . "\n\n";
34
35    // 5. 暗号化されたメッセージを復号化します。
36    // sodium_crypto_secretbox_open は、暗号文、ナンス、鍵を使い、メッセージを復号化します。
37    // メッセージが改ざんされていたり、鍵やナンスが間違っていたりする場合、false を返します。
38    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
39
40    if ($decryptedMessage === false) {
41        echo "エラー: メッセージの復号化に失敗しました。メッセージが改ざんされたか、鍵またはナンスが間違っています。\n\n";
42    } else {
43        echo "復号化されたメッセージ: " . $decryptedMessage . "\n\n";
44        if ($decryptedMessage === $message) {
45            echo "検証成功: 復号化されたメッセージは元のメッセージと完全に一致します。\n\n";
46        } else {
47            echo "検証失敗: 復号化されたメッセージが元のメッセージと一致しませんでした。\n\n";
48        }
49    }
50
51    // SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES 定数の紹介
52    echo "--- libsodium 拡張の別の定数の紹介 ---\n";
53    echo "SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES の値: " . SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES . " バイト\n";
54    echo "この定数は、ストリーム暗号化 (sodium_crypto_secretstream_*) で使用されるヘッダーのサイズを示します。\n";
55    echo "(上記の sodium_crypto_secretbox とは異なる用途ですが、同じlibsodium拡張の一部です。)\n";
56
57    // セキュリティベストプラクティスとして、鍵とナンスをメモリからクリアします。
58    sodium_memzero($key);
59    sodium_memzero($nonce);
60}
61
62// デモンストレーション関数を実行します
63demonstrateSecretBoxEncryption();

このPHPサンプルコードは、メッセージの認証付き暗号化と復号化を行う、libsodium拡張の基本的な使い方をシステムエンジニア志望の初心者向けに説明しています。

まず、sodium_crypto_secretbox_keygen()関数で、暗号化と復号化に使う「秘密鍵」を生成します。次に、暗号化ごとに異なる「ナンス」（Number used once、使い捨ての数値）をrandom_bytes()関数とSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数を使って準備します。 メッセージを暗号化するには、sodium_crypto_secretbox($message, $nonce, $key)関数を使います。この関数は、平文のメッセージ、ナンス、秘密鍵を受け取り、認証タグ付きの暗号化されたデータ（文字列）を返します。これにより、メッセージの内容が外部に漏れるのを防ぎ、かつ途中で改ざんされていないことを確認できます。 復号化はsodium_crypto_secretbox_open($ciphertext, $nonce, $key)関数で行います。暗号文、ナンス、秘密鍵を渡すと、元のメッセージが復元されます。もし暗号文が改ざんされていたり、鍵やナンスが誤っていたりした場合は、安全にfalseを返して復号化の失敗を示します。

また、サンプルコードの最後には、SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTESという定数も紹介しています。この定数はlibsodium拡張で提供され、ストリーム暗号化（大量のデータを連続的に暗号化する方式）で使われるヘッダーのバイトサイズを整数値で示します。引数はなく、常にこのint型の固定値を提供します。この定数自体は上記のsodium_crypto_secretboxとは直接関係ありませんが、libsodiumが提供する幅広い暗号機能の一部として理解しておくと良いでしょう。