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

Copy
1<?php
2
3/**
4 * LibsodiumのXChacha20-Poly1305 IETFモードを使用した暗号化と復号化の例。
5 * このコードは、XChacha20-Poly1305 IETFモードで必要な鍵のバイト数を示す定数
6 * `SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES` と、
7 * nonce（ナンス、Number used once）のバイト数を示す定数
8 * `SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES` の使用法をデモンストレーションします。
9 *
10 * システムエンジニアを目指す初心者向けに、これらの定数が暗号化処理における
11 * 重要なパラメータのサイズをどのように決定するのかを具体的に示します。
12 */
13function demonstrateSodiumAeadXChacha20Poly1305IetfUsage(): void
14{
15    // 暗号化する平文メッセージ
16    $message = 'Hello, system engineer beginner! This is a confidential message.';
17
18    // 1. 鍵のバイト数を表示
19    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES は、
20    // XChacha20-Poly1305 IETFモードで必要とされる鍵のバイト数を定義します。
21    // この定数により、適切なサイズの鍵を生成できます。
22    echo '鍵の必要バイト数 (' . 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES' . '): ' . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES . ' bytes' . PHP_EOL;
23
24    // 2. Nonce (npub) のバイト数を表示
25    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES は、
26    // 同モードで必要とされるnonceのバイト数を定義します。
27    // Nonceは各暗号化操作でユニークである必要があり、予測不可能な値であることが重要です。
28    echo 'Nonceの必要バイト数 (' . 'SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES' . '): ' . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES . ' bytes' . PHP_EOL;
29
30    // 3. 安全な暗号化鍵を生成
31    // random_bytes() を使用して、指定されたバイト数のランダムな鍵を生成します。
32    $key = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES);
33    echo '生成された鍵の長さ: ' . strlen($key) . ' bytes' . PHP_EOL;
34
35    // 4. 安全なNonceを生成
36    // 各暗号化操作ごとに異なるnonceを生成することが非常に重要です。
37    // 同じ鍵で複数のメッセージを暗号化する場合、異なるnonceを使用しないとセキュリティ上の問題が発生します。
38    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES);
39    echo '生成されたNonceの長さ: ' . strlen($nonce) . ' bytes' . PHP_EOL;
40
41    // 5. 追加認証データ (Optional)
42    // このデータは暗号化されませんが、改ざん防止のために認証されます。
43    // 例: メッセージの送信者IDやタイムスタンプなど。
44    $additionalData = 'UserID: 12345, Timestamp: ' . time();
45
46    echo '---------------------------------------------------' . PHP_EOL;
47    echo '元のメッセージ: "' . $message . '"' . PHP_EOL;
48    echo '追加認証データ: "' . $additionalData . '"' . PHP_EOL;
49
50    // 6. メッセージを暗号化
51    // sodium_crypto_aead_xchacha20poly1305_ietf_encrypt 関数を使用します。
52    // 引数: 平文、追加認証データ、nonce、鍵
53    $ciphertext = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
54        $message,
55        $additionalData,
56        $nonce,
57        $key
58    );
59
60    echo '暗号化されたデータ (Base64エンコード): ' . base64_encode($ciphertext) . PHP_EOL;
61
62    // 7. メッセージを復号化
63    // sodium_crypto_aead_xchacha20poly1305_ietf_decrypt 関数を使用します。
64    // 引数: 暗号文、追加認証データ、nonce、鍵
65    // 復号化が成功すると元の平文を返し、失敗すると false を返します。
66    // 失敗の原因: 鍵やnonceが間違っている、または暗号文と追加認証データが改ざんされている。
67    $decryptedMessage = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
68        $ciphertext,
69        $additionalData,
70        $nonce,
71        $key
72    );
73
74    echo '---------------------------------------------------' . PHP_EOL;
75    if ($decryptedMessage === false) {
76        echo 'エラー: 復号化に失敗しました。データが改ざんされたか、鍵/Nonceが不正です。' . PHP_EOL;
77    } else {
78        echo '復号化されたメッセージ: "' . $decryptedMessage . '"' . PHP_EOL;
79        echo '元のメッセージと復号化されたメッセージは一致しますか？ ' . ($message === $decryptedMessage ? 'はい' : 'いいえ') . PHP_EOL;
80    }
81}
82
83// 暗号化と復号化のデモンストレーション関数を実行します。
84demonstrateSodiumAeadXChacha20Poly1305IetfUsage();
85
86?>

PHPのSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTESは、強力な暗号化ライブラリLibsodiumが提供するXChacha20-Poly1305 IETFモードという特定の暗号化方式において、データの暗号化と復号化に必要となる「鍵」の正確なバイト数を定義する定数です。この定数自体は引数を取らず、戻り値として鍵のバイト数を表す整数値を返します。システムエンジニアにとって、暗号化鍵の適切な長さはセキュリティ強度を保証するために非常に重要です。

サンプルコードでは、この定数を利用して、安全な暗号化鍵を生成するために必要なバイト数を簡単に取得し、それに基づいてrandom_bytes()関数で鍵を生成する手順を示しています。また、関連する定数SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESは、「nonce（ナンス）」と呼ばれる、各暗号化操作で一度だけ使用するユニークな乱数のバイト数を定義します。これらの定数によって定められた適切なサイズの鍵とnonceを準備することで、sodium_crypto_aead_xchacha20poly1305_ietf_encrypt関数でデータを安全に暗号化し、対応するsodium_crypto_aead_xchacha20poly1305_ietf_decrypt関数で正確に復号化することが可能となります。これらの定数の利用は、セキュアなデータ処理を実装する上での基礎となります。

Copy
1<?php
2
3/**
4 * Libsodiumの公開鍵暗号 (Box) を使用して、安全なメッセージ送受信をデモンストレーションします。
5 * また、SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES 定数についても解説します。
6 *
7 * この関数は、システムエンジニアを目指す初心者が、公開鍵暗号の基本と
8 * Libsodiumライブラリの定数の関連性を理解するのに役立ちます。
9 */
10function demonstrateSodiumCryptoBoxCommunication(): void
11{
12    // PHPのSodium拡張機能が利用可能か確認します。
13    if (!extension_loaded('sodium')) {
14        echo "エラー: PHP Sodium 拡張機能が有効になっていません。\n";
15        return;
16    }
17
18    echo "--- Libsodium 公開鍵暗号 (sodium_crypto_box) のデモンストレーション ---\n\n";
19
20    // --- 1. 送信者 (Alice) と受信者 (Bob) の鍵ペアを生成 ---
21    // 公開鍵暗号では、各ユーザーが「秘密鍵」と「公開鍵」のペアを持ちます。
22    // 秘密鍵は絶対に公開せず、公開鍵は安全に共有できます。
23    $aliceKeypair = sodium_crypto_box_keypair();
24    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
25    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
26
27    $bobKeypair = sodium_crypto_box_keypair();
28    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
29    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
30
31    echo "Aliceの公開鍵: " . bin2hex($alicePublicKey) . "\n";
32    echo "Bobの公開鍵:   " . bin2hex($bobPublicKey) . "\n\n";
33
34    // --- 2. ノンス (Nonce) の生成 ---
35    // ノンス (Number used once) は、各暗号化操作で一度だけ使用されるユニークな値です。
36    // ノンスは秘密にする必要はなく、メッセージと一緒に送ることができます。
37    // 同じ鍵ペアで異なるメッセージを暗号化する際は、必ず異なるノンスを使用してください。
38    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
39    echo "生成されたノンス: " . bin2hex($nonce) . "\n\n";
40
41    // --- 3. AliceがBobへメッセージを送信 (暗号化) ---
42    $originalMessage = "こんにちは、Bob！Aliceからの秘密のメッセージです。";
43    echo "AliceがBobへ送るメッセージ: \"" . $originalMessage . "\"\n";
44
45    // Aliceの秘密鍵とBobの公開鍵を使ってメッセージを暗号化します。
46    // sodium_crypto_box は、内部で XChaCha20-Poly1305 (または類似の認証付き暗号) を使用して
47    // メッセージの機密性（誰にも読まれないこと）と完全性（改ざんされていないこと）を保証します。
48    $encryptedMessage = sodium_crypto_box(
49        $originalMessage,
50        $nonce,
51        $bobPublicKey,
52        $aliceSecretKey
53    );
54
55    echo "暗号化されたメッセージ (バイナリをHEX変換): " . bin2hex($encryptedMessage) . "\n\n";
56
57    // --- 4. BobがAliceからのメッセージを受信 (復号) ---
58    // Bobの秘密鍵とAliceの公開鍵を使って暗号化されたメッセージを復号します。
59    $decryptedMessage = sodium_crypto_box_open(
60        $encryptedMessage,
61        $nonce,
62        $alicePublicKey,
63        $bobSecretKey
64    );
65
66    if ($decryptedMessage !== false) {
67        echo "Bobが復号したメッセージ: \"" . $decryptedMessage . "\"\n";
68        echo "✅ メッセージの送受信が成功しました！\n\n";
69    } else {
70        echo "❌ メッセージの復号に失敗しました。鍵やノンスが正しくない可能性があります。\n\n";
71    }
72
73    // --- 5. SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES 定数の情報 ---
74    // この定数は、XChaCha20-Poly1305 (IETF variant) という「認証付き対称鍵暗号」方式で
75    // 使用される鍵のバイト長を示します。
76    //
77    // sodium_crypto_box は、公開鍵暗号ですが、その内部の実装には、このような対称鍵暗号が
78    // 組み込まれており、セッション鍵の生成とメッセージの暗号化に利用されます。
79    // つまり、この定数は crypto_box が基盤としている堅牢な暗号化アルゴリズムの一部です。
80    //
81    // 例えば、`sodium_crypto_aead_xchacha20poly1305_ietf_keygen()` といった
82    // 対称鍵暗号の鍵を生成する際に、この定数値が使用されます。
83    echo "--- SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES 定数の詳細 ---\n";
84    echo "定数名: SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES\n";
85    echo "値 (バイト長): " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES . " バイト\n";
86    echo "(これは " . (SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES * 8) . " ビットに相当します)\n";
87    echo "この値は、直接 sodium_crypto_box の鍵長ではありませんが、\n";
88    echo "Libsodiumライブラリが提供する堅牢な暗号化の基盤となる\n";
89    echo "対称鍵暗号アルゴリズム（XChaCha20-Poly1305）の鍵サイズを示しています。\n";
90}
91
92// サンプル関数を実行します。
93demonstrateSodiumCryptoBoxCommunication();

PHP 8で導入されたLibSodium拡張機能が提供するSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTESは、XChaCha20-Poly1305という認証付き対称鍵暗号方式で使用される鍵のバイト長を示す定数です。この定数には引数はなく、整数値（int）として鍵のサイズが返されます。

サンプルコードでは、sodium_crypto_box関数を使った公開鍵暗号による安全なメッセージ送受信をデモンストレーションしています。sodium_crypto_boxはアリスとボブの秘密鍵と公開鍵のペアを用いてメッセージを暗号化・復号しますが、その内部ではセッション鍵を生成し、XChaCha20-Poly1305のような認証付き対称鍵暗号アルゴリズムを利用して実際のメッセージの暗号化が行われます。

SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTESは、この基盤となる対称鍵暗号アルゴリズムで必要とされる鍵のバイト長（例：32バイト、すなわち256ビット）を示しており、例えばsodium_crypto_aead_xchacha20poly1305_ietf_keygen()のような対称鍵暗号の鍵を生成する関数で参照されます。直接sodium_crypto_boxの鍵長を定義するものではありませんが、Libsodiumライブラリが提供する強固なセキュリティの根幹をなす重要な定数の一つです。システムエンジニアを目指す方にとって、暗号化アルゴリズムの内部構造と、それに伴う鍵の設計を理解する上で役立つ情報となります。