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

Copy
1<?php
2
3// Libsodium拡張が利用可能かチェックします。
4// システムエンジニアを目指す上で、このような環境チェックは重要です。
5// 'sodium' 拡張が有効になっていない場合、このコードは動作しません。
6if (!extension_loaded('sodium')) {
7    die("エラー: 'sodium' 拡張がロードされていません。php.ini で有効にしてください。\n");
8}
9
10/**
11 * LibsodiumのXChaCha20-Poly1305-IETFアルゴリズムを使用した暗号化と復号のサンプル。
12 * SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES 定数の利用方法を示します。
13 *
14 * ノンス (Nonce) は「一度だけ使用される数値」を意味し、
15 * 各暗号化操作で異なる一意の値である必要があります。
16 * この定数は、そのノンスに必要なバイト数を示します。
17 */
18
19// SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES 定数の値を取得します。
20// これはXChaCha20-Poly1305-IETFアルゴリズムでNonce（ノンス）として必要なバイト数を示します。
21$npubBytes = SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES;
22
23echo "XChaCha20-Poly1305-IETFアルゴリズムのNonceに必要なバイト数: " . $npubBytes . " バイト" . PHP_EOL . PHP_EOL;
24
25// 1. 暗号化に使用するキーを生成します。
26// キーの長さは SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES で定義されています。
27$keyBytes = SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES;
28$key = random_bytes($keyBytes); // 安全なキーを生成
29echo "キーを生成しました (長さ: " . $keyBytes . " バイト)." . PHP_EOL;
30
31// 2. 暗号化したい元のメッセージ（平文）です。
32$plaintext = "PHPとLibSodiumで安全な通信を学びましょう。";
33echo "元のメッセージ（平文）: " . $plaintext . PHP_EOL;
34
35// 3. ノンス（Nonce）を生成します。
36// ノンスは暗号化ごとに異なる、予測不可能な一意な値である必要があります。
37// このノンスの長さは SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES で指定されます。
38$nonce = random_bytes($npubBytes); // 安全なノンスを生成
39echo "Nonceを生成しました (長さ: " . $npubBytes . " バイト, 16進数): " . bin2hex($nonce) . PHP_EOL;
40
41// 4. 追加認証データ（Associated Data）を定義します（オプション）。
42// このデータは暗号化されませんが、改ざん防止のためにメッセージと共に認証されます。
43// 例えば、ユーザーIDやファイル名など、メッセージに関連する情報を含めることができます。
44$associatedData = "user_id:123, document_id:456";
45echo "追加認証データ: " . $associatedData . PHP_EOL;
46
47// 5. メッセージを暗号化します。
48// sodium_crypto_aead_xchacha20poly1305_ietf_encrypt() 関数を使用します。
49$ciphertext = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
50    $plaintext,      // 暗号化する平文
51    $associatedData, // 追加認証データ (オプション)
52    $nonce,          // ノンス
53    $key             // 暗号化キー
54);
55echo "暗号化されたメッセージ (バイナリ形式): " . bin2hex($ciphertext) . PHP_EOL . PHP_EOL;
56
57echo "--- 復号処理 ---" . PHP_EOL;
58
59// 6. 暗号化されたメッセージを復号します。
60// 復号には、暗号化時と全く同じキー、ノンス、追加認証データが必要です。
61try {
62    $decryptedPlaintext = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
63        $ciphertext,      // 復号する暗号文
64        $associatedData, // 暗号化時と同じ追加認証データ
65        $nonce,          // 暗号化時と同じノンス
66        $key             // 暗号化時と同じキー
67    );
68
69    echo "復号されたメッセージ: " . $decryptedPlaintext . PHP_EOL;
70
71    // 復号されたメッセージが元のメッセージと同じであることを確認します。
72    if ($plaintext === $decryptedPlaintext) {
73        echo "✅ 復号されたメッセージは元の平文と一致します。" . PHP_EOL;
74    } else {
75        echo "❌ エラー: 復号されたメッセージが元の平文と一致しません。" . PHP_EOL;
76    }
77
78} catch (SodiumException $e) {
79    // キー、ノンス、認証データのいずれかが間違っているか、
80    // 暗号文が改ざんされた場合に SodiumException が発生します。
81    echo "❌ 復号エラー: " . $e->getMessage() . PHP_EOL;
82    echo "これは通常、提供された情報が暗号化時と異なるか、" . PHP_EOL;
83    echo "暗号文が改ざんされたことを示します。" . PHP_EOL;
84}
85
86?>

PHP 8のSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESは、PHPのLibsodium拡張が提供する定数の一つです。この定数は、安全なデータ暗号化に用いられるXChaCha20-Poly1305-IETFアルゴリズムにおいて、ノンス（Nonce）として必要なバイト数（長さ）を示します。ノンスとは「一度だけ使用される数値」を意味し、各暗号化操作で必ず異なる、予測不可能な一意の値である必要があります。これにより、同じキーと平文であっても異なる暗号文が生成され、リプレイ攻撃などのセキュリティリスクを防ぐ重要な役割を担っています。

この定数は引数を持たず、暗号化アルゴリズムが要求するノンスのバイト数を整数型（int）で返します。サンプルコードでは、まずこの定数からノンスに必要なバイト数を取得し、その長さで安全な乱数としてノンスを生成しています。生成されたノンスは、sodium_crypto_aead_xchacha20poly1305_ietf_encrypt関数による暗号化時と、sodium_crypto_aead_xchacha20poly1305_ietf_decrypt関数による復号時に、キーと追加認証データと共に必須の引数として渡されます。この定数が示すバイト数で正確な長さのノンスを準備することは、XChaCha20-Poly1305-IETFアルゴリズムを用いたセキュアな暗号化・復号処理の実現に不可欠です。この定数を利用するには、Libsodium拡張がPHPにロードされている必要があります。

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES 定数の使用例
5 *
6 * この定数は、XChaCha20-Poly1305 (IETF variant) 暗号化方式で
7 * 使用されるNonce (Number Used Once) の推奨バイト数を示します。
8 * Nonceは、同じ鍵で複数のメッセージを暗号化する際に、各メッセージで異なる値を使用することで
9 * セキュリティを強化するために非常に重要です。
10 * システムエンジニアを目指す初心者の方にも、暗号化の基本的な流れとNonceの重要性を理解してもらうことを目的とします。
11 */
12function demonstrateXChaCha20Encryption(): void
13{
14    // 1. SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES の値を確認
15    // この定数は、XChaCha20-Poly1305-IETF アルゴリズムが要求するNonceの正確なバイト数を示します。
16    echo "定数 SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES の値: " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES . " バイト\n";
17    echo "これは、XChaCha20-Poly1305-IETF で使用するNonceの必須サイズです。\n\n";
18
19    // 2. 暗号化に使用する秘密鍵を生成
20    // この鍵は非常に重要であり、安全に保管され、暗号化と復号化の両方に使用されます。
21    // 鍵の長さも libsodium が自動で適切なものを生成します。
22    $key = sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
23    echo "秘密鍵を生成しました。\n";
24
25    // 3. 暗号化したい平文のデータ
26    $plaintext = "システムセキュリティは非常に重要です。このメッセージは保護されます。";
27    echo "元の平文: " . $plaintext . "\n";
28
29    // 4. Nonce (Number Used Once) を生成
30    // Nonceは、暗号化ごとにユニークな値である必要があります。同じ鍵で異なるデータを暗号化する際、
31    // 毎回新しいNonceを使用することで、暗号化の安全性が保たれます。
32    // そのサイズは SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES で厳密に定義されています。
33    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES);
34    echo "Nonceを生成しました (サイズ: " . strlen($nonce) . " バイト)。\n";
35
36    // 5. 関連データ (Authenticated Data) を設定 (オプション)
37    // 関連データは暗号化されませんが、改ざん防止の対象となります。
38    // 例えば、メッセージの送信者IDやタイムスタンプなど、メッセージの内容とは別に
39    // 認証したいデータに使われます。復号時にも同じADが必要です。
40    $ad = "user_id_123_message_timestamp_2023-10-27";
41    echo "関連データ (AD): " . $ad . "\n\n";
42
43    // 6. データを暗号化
44    // sodium_crypto_aead_xchacha20poly1305_ietf_encrypt 関数を使用します。
45    // 平文、関連データ、Nonce、鍵を引数として渡します。
46    $ciphertext = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
47        $plaintext,
48        $ad,
49        $nonce,
50        $key
51    );
52    // 暗号化されたデータはバイナリなので、表示のためにBase64エンコードします。
53    echo "暗号化されたデータ (Base64エンコード): " . base64_encode($ciphertext) . "\n\n";
54
55    // 7. データを復号化
56    // 復号化には、暗号化時と同じ鍵、Nonce、関連データが全て正確に必要です。
57    // いずれか一つでも異なると復号に失敗するか、改ざんが検出され false が返されます。
58    $decryptedPlaintext = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
59        $ciphertext,
60        $ad,
61        $nonce,
62        $key
63    );
64
65    if ($decryptedPlaintext === false) {
66        // 復号に失敗した場合、データが改ざんされたか、鍵/Nonce/ADのいずれかが間違っている可能性があります。
67        echo "エラー: 復号に失敗しました。データが改ざんされたか、鍵/Nonce/ADが正しくありません。\n";
68    } else {
69        echo "復号された平文: " . $decryptedPlaintext . "\n";
70
71        // 復号されたデータが元の平文と一致するかを確認します。
72        if ($decryptedPlaintext === $plaintext) {
73            echo "結果: 復号化に成功し、元の平文と一致しました。\n";
74        } else {
75            echo "結果: 復号化は成功しましたが、元の平文と一致しません。(予期せぬエラー)\n";
76        }
77    }
78}
79
80// 上記の暗号化・復号化のデモンストレーション関数を実行します。
81demonstrateXChaCha20Encryption();

PHP 8で提供されるSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESは、PHPのlibsodium拡張が提供する重要な定数です。この定数は、XChaCha20-Poly1305 (IETF variant) という暗号化方式で使用されるNonce（Number Used Once）の、必須となるバイト数を示しています。Nonceは、同じ秘密鍵を用いて複数のデータを暗号化する際に、各データで必ず異なる値を使用することで、暗号化の安全性を強化するために不可欠な要素です。この定数は引数を持ちません。その値は整数型（int）で、特定の暗号化アルゴリズムが要求するNonceのサイズを提供します。

サンプルコードでは、この定数の値を確認した後、random_bytes()関数にSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESを引数として渡すことで、XChaCha20-Poly1305-IETFアルゴリズムに適した正確なサイズのNonceを生成しています。生成されたNonceは、平文データ、秘密鍵、およびオプションの関連データ（Authenticated Data）と共にsodium_crypto_aead_xchacha20poly1305_ietf_encrypt関数に渡され、データが暗号化されます。データの復号化には、暗号化時と全く同じ秘密鍵、Nonce、関連データが正確に必要となります。この定数を利用することで、システムエンジニアを目指す初心者の方も、セキュリティ要件を満たす適切なNonceサイズを確実に取得し、安全な暗号化処理を正確に実装できる基盤となります。