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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHPのLibsodium拡張機能を使って、対称鍵暗号化（SecretBox）の基本的なデモンストレーションを行います。
7 *
8 * この関数は、システムエンジニアを目指す初心者向けに、メッセージの暗号化と復号化のプロセスを
9 * 分かりやすく示します。Libsodiumは、PHPで安全な暗号化を簡単に実装するためのライブラリです。
10 *
11 * @return void
12 */
13function demonstrateSecretBoxEncryption(): void
14{
15    echo "--- Libsodium SecretBox 暗号化デモンストレーション ---\n\n";
16
17    // 1. 鍵の生成
18    // SecretBoxによる暗号化では、対称鍵を使用します。
19    // sodium_crypto_secretbox_keygen() は、安全でランダムな鍵を生成します。
20    // この鍵は、暗号化と復号の両方に使用されます。
21    $key = sodium_crypto_secretbox_keygen();
22    echo "生成された鍵の長さ: " . strlen($key) . " バイト\n";
23    // 鍵は秘密にすべき情報であり、通常は表示しませんが、デモンストレーションのために一部表示します。
24    echo "鍵 (抜粋): " . bin2hex(substr($key, 0, 8)) . "...\n\n";
25
26    // 2. 暗号化するメッセージ
27    $originalMessage = "こんにちは、世界！これはLibsodium SecretBoxで暗号化する秘密のメッセージです。";
28    echo "元のメッセージ: " . $originalMessage . "\n";
29    echo "元のメッセージの長さ: " . strlen($originalMessage) . " バイト\n\n";
30
31    // 3. ノンス（Nonce）の生成
32    // ノンスは "number used once" の略で、同じ鍵で複数のメッセージを暗号化する際に、
33    // 各メッセージに対して異なるノンスを使用することが極めて重要です。
34    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、SecretBoxが必要とするノンスの正確な長さを定義します。
35    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
36    echo "生成されたノンスの長さ: " . strlen($nonce) . " バイト\n";
37    echo "ノンス (抜粋): " . bin2hex(substr($nonce, 0, 8)) . "...\n\n";
38
39    // 4. メッセージの暗号化
40    // sodium_crypto_secretbox() 関数を使って、メッセージを暗号化します。
41    // 引数として、元のメッセージ、ノンス、鍵を渡します。
42    // この関数は、認証タグを含む安全な暗号文を生成します。
43    $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $key);
44    echo "暗号化されたメッセージ (バイナリ形式の一部): " . bin2hex(substr($encryptedMessage, 0, 20)) . "...\n";
45    echo "暗号化されたメッセージの長さ: " . strlen($encryptedMessage) . " バイト\n\n";
46
47    // 5. メッセージの復号化
48    // sodium_crypto_secretbox_open() 関数を使って、暗号文を復号します。
49    // 暗号化時と同じ暗号文、ノンス、鍵が必要です。
50    // 復号に成功した場合、元のメッセージが返されます。
51    // 復号に失敗した場合（例えば、暗号文が改ざんされた場合など）、falseが返され、セキュリティエラーを示します。
52    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
53
54    if ($decryptedMessage === false) {
55        echo "エラー: メッセージの復号に失敗しました。暗号文が改ざんされたか、鍵やノンスが間違っている可能性があります。\n";
56    } else {
57        echo "復号されたメッセージ: " . $decryptedMessage . "\n\n";
58    }
59
60    // 復号が成功し、元のメッセージと一致するかを確認
61    if ($decryptedMessage === $originalMessage) {
62        echo "結果: 暗号化と復号が成功し、元のメッセージと完全に一致しました。\n";
63    } else {
64        echo "結果: エラーが発生しました。復号されたメッセージが元のメッセージと一致しませんでした。\n";
65    }
66
67    echo "\n--- リファレンス情報に関する補足 ---\n";
68    // 提供されたリファレンス情報にある定数について補足します。
69    // SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY は、
70    // 上記の sodium_crypto_secretbox とは異なる、Libsodiumのストリーム暗号化API (secretstream) で使用される定数です。
71    // ストリーム内で鍵を更新する指示をタグとして付与する際に利用されます。
72    // 例えば、sodium_crypto_secretstream_push() 関数に渡すタグとして使われ、
73    // 暗号化ストリームの途中で内部鍵を安全に更新するためのメカニズムです。
74    echo "定数 SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY は、\n";
75    echo "Libsodiumのストリーム暗号化API (secretstream) で、鍵の安全な更新を指示するためのタグです。\n";
76    echo "その値は: " . SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY . " (数値)\n";
77}
78
79// スクリプトが直接実行された場合にデモンストレーション関数を呼び出します。
80demonstrateSecretBoxEncryption();
81

このPHPサンプルコードは、Libsodium拡張機能を用いて、メッセージを安全に暗号化および復号化する「SecretBox（対称鍵暗号化）」の基本的なプロセスをシステムエンジニアを目指す初心者向けに示しています。まず、sodium_crypto_secretbox_keygen()関数で暗号化と復号に共通で使用する秘密鍵を生成します。この関数は引数を取らず、安全な鍵文字列を返します。次に、random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES)により、メッセージごとに異なる「ノンス（一度だけ使う乱数）」を生成します。ノンスは暗号化の安全性を確保するために不可欠です。

メッセージの暗号化はsodium_crypto_secretbox()関数で行います。この関数は元のメッセージ、生成したノンス、秘密鍵を引数に取り、認証タグを含む暗号化されたメッセージ文字列を返します。復号化にはsodium_crypto_secretbox_open()関数を使用し、暗号化されたメッセージ、ノンス、秘密鍵を引数として渡します。復号に成功すると元のメッセージ文字列が返され、失敗した場合はfalseが返されることで改ざんなどを検知できます。

なお、リファレンス情報に記載されている定数SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEYは、このサンプルコードで示されているSecretBoxとは異なる、Libsodiumのストリーム暗号化APIで利用される特別なタグです。これは、暗号化ストリームの途中で内部鍵を安全に更新する際に、その指示を付与するために使われる定数で、特定の数値を示します。

Copy
1<?php
2
3/**
4 * Libsodiumのcrypto_box関数を使用してメッセージを安全に暗号化および復号化する手順を示す。
5 * この関数は、公開鍵暗号と認証付き暗号化を組み合わせたものです。
6 *
7 * @param string $message 暗号化する平文メッセージ。
8 * @return bool 処理が成功し、復号されたメッセージが元のメッセージと一致した場合はtrue、それ以外はfalse。
9 */
10function demonstrateSodiumCryptoBox(string $message): bool
11{
12    // Libsodium拡張が利用可能か確認します。
13    // PHPの'sodium'拡張は、多くの暗号化機能を提供します。
14    if (!extension_loaded('sodium')) {
15        echo "エラー: 'sodium' 拡張がロードされていません。" . PHP_EOL;
16        return false;
17    }
18
19    echo "--- Libsodium crypto_box デモンストレーション ---" . PHP_EOL;
20
21    // 1. 送信者 (Alice) の鍵ペアを生成します。
22    // crypto_box_keypair() は公開鍵と秘密鍵の両方を含む鍵ペアを生成します。
23    $aliceKeyPair = sodium_crypto_box_keypair();
24    $alicePublicKey = sodium_crypto_box_publickey($aliceKeyPair); // 公開鍵
25    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeyPair); // 秘密鍵
26
27    echo "Aliceの公開鍵が生成されました。" . PHP_EOL;
28
29    // 2. 受信者 (Bob) の鍵ペアを生成します。
30    $bobKeyPair = sodium_crypto_box_keypair();
31    $bobPublicKey = sodium_crypto_box_publickey($bobKeyPair); // 公開鍵
32    $bobSecretKey = sodium_crypto_box_secretkey($bobKeyPair); // 秘密鍵
33
34    echo "Bobの公開鍵が生成されました。" . PHP_EOL;
35
36    echo "元のメッセージ: '" . $message . "'" . PHP_EOL;
37
38    // 3. AliceがBobのためにメッセージを暗号化します。
39    // 暗号化には、送信者(Alice)の秘密鍵と受信者(Bob)の公開鍵、およびNonce (使い捨ての番号) が必要です。
40    // Nonceは毎回ユニークでなければならず、予測不可能である必要があります。
41    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
42
43    $ciphertext = sodium_crypto_box(
44        $message,
45        $nonce,
46        $bobPublicKey,    // 受信者Bobの公開鍵
47        $aliceSecretKey   // 送信者Aliceの秘密鍵
48    );
49
50    if ($ciphertext === false) {
51        echo "エラー: 暗号化に失敗しました。" . PHP_EOL;
52        return false;
53    }
54
55    echo "メッセージが暗号化されました。" . PHP_EOL;
56    // echo "暗号文 (Hex): " . bin2hex($ciphertext) . PHP_EOL; // デバッグ用
57
58    // 4. BobがAliceからのメッセージを復号化します。
59    // 復号化には、受信者(Bob)の秘密鍵と送信者(Alice)の公開鍵、および暗号化時に使用されたNonceが必要です。
60    $decryptedMessage = sodium_crypto_box_open(
61        $ciphertext,
62        $nonce,
63        $alicePublicKey,  // 送信者Aliceの公開鍵
64        $bobSecretKey     // 受信者Bobの秘密鍵
65    );
66
67    if ($decryptedMessage === false) {
68        echo "エラー: 復号化に失敗しました。メッセージが改ざんされたか、鍵またはNonceが間違っています。" . PHP_EOL;
69        return false;
70    }
71
72    echo "メッセージが復号化されました。" . PHP_EOL;
73    echo "復号されたメッセージ: '" . $decryptedMessage . "'" . PHP_EOL;
74
75    // 5. 元のメッセージと復号されたメッセージを比較して検証します。
76    if ($message === $decryptedMessage) {
77        echo "検証成功: 元のメッセージと復号されたメッセージは一致します。" . PHP_EOL;
78        return true;
79    } else {
80        echo "検証失敗: メッセージが一致しません。" . PHP_EOL;
81        return false;
82    }
83}
84
85// サンプルコードを実行します。
86demonstrateSodiumCryptoBox("プログラミングは楽しい！安全な通信を学ぼう。");
87

このサンプルコードは、PHPのsodium拡張を利用し、安全なメッセージの暗号化と復号化を行う基本的な手順を、システムエンジニアを目指す初心者にも分かりやすく解説しています。中核となるのはsodium_crypto_box関数で、これは公開鍵暗号と認証付き暗号化を組み合わせることで、通信されるメッセージの機密性（内容が漏れないこと）と完全性（改ざんされていないこと）の両方を保証します。

まず、sodium_crypto_box_keypair()関数を使用して、メッセージを送信する側（Alice）と受信する側（Bob）それぞれで、公開鍵と秘密鍵のペアを生成します。メッセージを暗号化する際は、送信者の秘密鍵、受信者の公開鍵、そして毎回異なるユニークな使い捨て番号であるNonce（ナンス）を使用します。これらの情報と元のメッセージをsodium_crypto_box関数に渡すと、安全な暗号文が生成されます。sodium_crypto_box(string $message, string $nonce, string $receiverPublicKey, string $senderSecretKey)は、暗号化されたメッセージのバイナリ文字列を返します。暗号化に失敗した場合はfalseを返します。

次に、この暗号文を復号化する際には、受信者の秘密鍵、送信者の公開鍵、そして暗号化時に使用された同じNonceが必要になります。これらの情報と暗号文をsodium_crypto_box_open関数に渡すことで、元の平文メッセージが取り出されます。sodium_crypto_box_open(string $ciphertext, string $nonce, string $senderPublicKey, string $receiverSecretKey)は、復号された平文メッセージのバイナリ文字列を返します。もしメッセージが改ざんされているか、鍵またはNonceが間違っている場合はfalseを返します。

最終的に、復号されたメッセージが元のメッセージと完全に一致することを確認することで、安全な通信が成功したことを検証しています。この一連のプロセスを通じて、インターネット上での安全な情報交換の仕組みを学ぶことができます。