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

Copy
1<?php
2
3/**
4 * LibSodium拡張のcrypto_box関数を使用して、メッセージを安全に暗号化・復号するサンプルです。
5 * SODIUM_CRYPTO_STREAM_KEYBYTES定数も紹介します。
6 * システムエンジニアを目指す初心者向けに、公開鍵暗号の基本的な流れを示します。
7 */
8function demonstrateSodiumCryptoBoxCommunication(): void
9{
10    // SODIUM_CRYPTO_STREAM_KEYBYTESはストリーム暗号のキーサイズを示す定数です。
11    // crypto_box関数とは直接関連しませんが、LibSodiumエクステンションの一部です。
12    $streamKeySize = SODIUM_CRYPTO_STREAM_KEYBYTES;
13    echo "LibSodium定数 SODIUM_CRYPTO_STREAM_KEYBYTES (ストリーム暗号キーサイズ): " . $streamKeySize . " バイト\n\n";
14
15    // --- 1. 送信者 (Alice) のキーペア生成 ---
16    // 公開鍵と秘密鍵のペアを生成します。
17    $aliceKeypair = sodium_crypto_box_keypair();
18    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
19    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
20    echo "アリスのキーペアを生成しました。\n";
21
22    // --- 2. 受信者 (Bob) のキーペア生成 ---
23    // 同様に、ボブもキーペアを生成します。
24    $bobKeypair = sodium_crypto_box_keypair();
25    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
26    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
27    echo "ボブのキーペアを生成しました。\n\n";
28
29    // --- 3. メッセージの暗号化 (アリスからボブへ) ---
30    $originalMessage = "こんにちは、ボブ！これはアリスからの秘密のメッセージです。";
31    echo "元のメッセージ: \"" . $originalMessage . "\"\n";
32
33    // メッセージを暗号化するために、一度きりのランダムな値 (ナンス) を生成します。
34    // ナンスの長さはSODIUM_CRYPTO_BOX_NONCEBYTES定数で定義されています。
35    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
36
37    // アリスは、ボブの公開鍵と自分の秘密鍵を使ってメッセージを暗号化します。
38    $encryptedMessage = sodium_crypto_box(
39        $originalMessage,
40        $nonce,
41        $bobPublicKey,    // 受信者 (ボブ) の公開鍵
42        $aliceSecretKey   // 送信者 (アリス) の秘密鍵
43    );
44    echo "メッセージを暗号化しました。\n";
45
46    // --- 4. メッセージの復号 (ボブがアリスから) ---
47    try {
48        // ボブは、アリスの公開鍵と自分の秘密鍵を使ってメッセージを復号します。
49        $decryptedMessage = sodium_crypto_box_open(
50            $encryptedMessage,
51            $nonce,
52            $alicePublicKey,   // 送信者 (アリス) の公開鍵
53            $bobSecretKey      // 受信者 (ボブ) の秘密鍵
54        );
55
56        if ($decryptedMessage === false) {
57            echo "エラー: メッセージの復号に失敗しました。鍵が一致しないか、メッセージが改ざんされた可能性があります。\n";
58        } else {
59            echo "復号されたメッセージ: \"" . $decryptedMessage . "\"\n";
60        }
61    } catch (Exception $e) {
62        echo "エラーが発生しました: " . $e->getMessage() . "\n";
63    }
64}
65
66// 暗号化通信のデモンストレーション関数を実行
67demonstrateSodiumCryptoBoxCommunication();

このPHPサンプルコードは、LibSodium拡張機能を利用した安全なメッセージ通信の基本的な仕組みを、初心者の方にも分かりやすく示すものです。まず、SODIUM_CRYPTO_STREAM_KEYBYTES定数について説明します。これはLibSodiumライブラリが提供するストリーム暗号化で用いられるキーの推奨バイトサイズを示す定数で、引数はなく、整数値を返します。サンプルではその値を出力し、LibSodium拡張の定数の一例として紹介しています。

このコードの主要部分は、sodium_crypto_box関数を使った公開鍵暗号のデモンストレーションです。最初に、メッセージの送信者（アリス）と受信者（ボブ）がそれぞれ独自の公開鍵と秘密鍵のペアを生成します。sodium_crypto_box_keypair()関数は新しい鍵ペアを作成し、sodium_crypto_box_publickey()とsodium_crypto_box_secretkey()関数でそれぞれの公開鍵と秘密鍵を抽出します。

アリスがボブに秘密のメッセージを送る際、アリスはボブの公開鍵と自身の秘密鍵、そしてメッセージごとに生成される一意のランダム値「ナンス」を引数としてsodium_crypto_box()関数を使います。この関数は暗号化されたメッセージデータを返します。

ボブがこの暗号化されたメッセージを受け取ると、ボブはアリスの公開鍵と自身の秘密鍵、そして同じナンスを引数としてsodium_crypto_box_open()関数を使用し、メッセージを復号します。復号に成功した場合、元のメッセージが文字列として返され、失敗した場合はfalseが返るため、安全な通信が保証されます。これにより、システムエンジニアを目指す初心者が公開鍵暗号の概念と実装の基本を理解できるよう設計されています。

Copy
1<?php
2
3/**
4 * libsodium拡張機能を使用してメッセージを秘密裏に暗号化し、復号化します。
5 * キーワードである sodium_crypto_secretbox 関数を中心に、認証付き暗号化の基本を示します。
6 *
7 * @param string $message 暗号化する平文メッセージ。
8 * @return void
9 */
10function encryptAndDecryptSecretbox(string $message): void
11{
12    // 秘密鍵を生成します。鍵の長さは SODIUM_CRYPTO_SECRETBOX_KEYBYTES で定義されます。
13    $key = sodium_crypto_secretbox_keygen();
14
15    // ノンス（Number used once）を生成します。
16    // ノンスは毎回異なる値を使用する必要があり、暗号化のセキュリティを高めます。
17    // ノンスの長さは SODIUM_CRYPTO_SECRETBOX_NONCEBYTES で定義されます。
18    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
19
20    echo "--- 暗号化と復号化のデモンストレーション ---" . PHP_EOL;
21    echo "元の平文: " . $message . PHP_EOL;
22
23    // メッセージを暗号化します。
24    // sodium_crypto_secretbox は認証付き暗号化を提供し、改ざんを検出できます。
25    $cipher = sodium_crypto_secretbox($message, $nonce, $key);
26    echo "暗号文 (Hex): " . bin2hex($cipher) . PHP_EOL;
27
28    // 暗号文を復号化します。
29    // 復号に失敗した場合は false を返します。
30    $plainText = sodium_crypto_secretbox_open($cipher, $nonce, $key);
31
32    if ($plainText === false) {
33        echo "復号化に失敗しました。鍵またはノンスが間違っているか、メッセージが改ざんされた可能性があります。" . PHP_EOL;
34    } else {
35        echo "復号された平文: " . $plainText . PHP_EOL;
36    }
37
38    echo "--- libsodium 定数の情報 ---" . PHP_EOL;
39    // リファレンス情報で指定された定数：ストリーム暗号のキー長。
40    // sodium_crypto_secretbox とは直接関係ありませんが、libsodium拡張機能の一部です。
41    echo "SODIUM_CRYPTO_STREAM_KEYBYTES の値: " . SODIUM_CRYPTO_STREAM_KEYBYTES . PHP_EOL;
42    
43    // 参考: sodium_crypto_secretbox に必要な関連定数も表示します。
44    echo "SODIUM_CRYPTO_SECRETBOX_KEYBYTES の値: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . PHP_EOL;
45    echo "SODIUM_CRYPTO_SECRETBOX_NONCEBYTES の値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . PHP_EOL;
46}
47
48// サンプルとして関数を実行します。
49$originalMessage = "これはシステムエンジニア初心者のための秘密のメッセージです。";
50encryptAndDecryptSecretbox($originalMessage);
51

このPHPコードは、libsodium拡張機能を使ってメッセージを安全に暗号化し、復号化する基本的な方法をシステムエンジニアの初心者向けに示しています。中心となるのは、認証付き暗号化を提供するsodium_crypto_secretbox関数です。

encryptAndDecryptSecretbox関数は、暗号化したい元のメッセージを$message引数として文字列で受け取ります。この関数は処理結果を直接表示するため、特別な戻り値はありません。

関数内ではまず、sodium_crypto_secretbox_keygen()を用いて暗号化に使う秘密鍵を生成します。次に、random_bytes()とSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数を利用して、暗号化ごとに異なる「ノンス」（一度だけ使う乱数）を生成します。これらは安全な暗号化に不可欠な要素です。

sodium_crypto_secretbox関数は、平文メッセージ、生成されたノンス、秘密鍵を引数として受け取り、暗号文を生成します。この関数はメッセージの機密性を保つだけでなく、改ざんを検出する認証機能も備えています。生成された暗号文は、sodium_crypto_secretbox_open関数により復号化されます。復号が成功すると元の平文が返され、失敗した場合はfalseが返されるため、メッセージの改ざんや鍵の不一致を検知できます。

最後に、リファレンス情報で指定されたSODIUM_CRYPTO_STREAM_KEYBYTES定数の値が表示されます。この定数はストリーム暗号と呼ばれる別の暗号化方式で利用される鍵の長さを表しており、今回の認証付き暗号化であるsodium_crypto_secretboxとは直接関係ありませんが、libsodium拡張機能の一部です。コードではsodium_crypto_secretboxに関連する鍵長とノンス長の定数も合わせて確認できます。