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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES 定数とその関連機能のデモンストレーションを行います。
5 *
6 * この関数は、XChaCha20-Poly1305 (IETF) を用いた認証付き暗号化の基本的な流れを示します。
7 * 主に認証タグのサイズ (ABYTES) とナンスのサイズ (NPUBBYTES) の使用方法に焦点を当てています。
8 *
9 * @return void
10 */
11function demonstrateAeadXChaCha20Poly1305IETF(): void
12{
13    // libsodium拡張が利用可能か確認
14    if (!extension_loaded('sodium')) {
15        echo "エラー: 'sodium' 拡張機能が読み込まれていません。php.ini で有効にしてください。\n";
16        return;
17    }
18
19    echo "--- XChaCha20-Poly1305 IETF AEAD 暗号化デモンストレーション ---\n\n";
20
21    // 暗号化に必要な定数の値を確認
22    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES: 暗号化に使用する鍵のバイト数
23    echo "鍵のサイズ (KEYBYTES): " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES . " バイト\n";
24
25    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES: ナンス (nonce) のバイト数
26    // ナンスは、各暗号化操作でユニークである必要があるランダムな値です。
27    // 提供されたキーワード 'sodium_crypto_aead_chacha20poly1305_ietf_npubbytes' に関連する値として、
28    // XChaCha20-Poly1305 IETF版のナンスサイズを示します。
29    echo "ナンスのサイズ (NPUBBYTES): " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES . " バイト\n";
30
31    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES: 認証タグのバイト数
32    // この定数は、メッセージの完全性と認証を保証する「認証タグ」のサイズを示します。
33    // 暗号文に付加され、改ざん検出に使用されます。
34    echo "認証タグのサイズ (ABYTES): " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES . " バイト\n\n";
35
36    // 1. 鍵の生成
37    // セキュアなランダムな鍵を生成します。この鍵は暗号化と復号化の両方に使用されます。
38    $key = sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
39    echo "鍵を生成しました。\n";
40
41    // 2. ナンスの生成
42    // ナンスは、常に新しいランダムな値である必要があります。
43    // 同じ鍵とナンスのペアを複数回使用するとセキュリティが損なわれます。
44    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES);
45    echo "ナンスを生成しました (バイナリデータなので表示は省略)。\n";
46
47    // 3. 平文と関連データ
48    // 平文: 暗号化したい元のメッセージ
49    $message = "これは外部に漏れてはならない重要な秘密情報です。";
50    // 関連データ: 暗号化されませんが、認証の一部となるデータ（例：ファイル名、ユーザーIDなど）
51    $associatedData = "追加認証データ (AAD): このデータは認証されますが暗号化されません。";
52
53    echo "元のメッセージ: " . $message . "\n";
54    echo "関連データ: " . $associatedData . "\n\n";
55
56    // 4. メッセージの暗号化
57    // `sodium_crypto_aead_xchacha20poly1305_ietf_encrypt` 関数は、
58    // 平文、関連データ、ナンス、鍵を使用してメッセージを暗号化します。
59    // 戻り値は、暗号文と認証タグが結合されたものです。
60    $ciphertext = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
61        $message,
62        $associatedData,
63        $nonce,
64        $key
65    );
66
67    echo "メッセージを暗号化しました。\n";
68    echo "暗号文 (Base64エンコード): " . base64_encode($ciphertext) . "\n\n";
69
70    // 5. メッセージの復号化
71    // `sodium_crypto_aead_xchacha20poly1305_ietf_decrypt` 関数は、
72    // 暗号文、関連データ、ナンス、鍵を使用してメッセージを復号化します。
73    // 復号化の際に認証も行われ、暗号文や関連データが改ざんされていた場合は `false` を返します。
74    $decryptedMessage = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
75        $ciphertext,
76        $associatedData,
77        $nonce,
78        $key
79    );
80
81    if ($decryptedMessage === false) {
82        echo "エラー: メッセージの復号化または認証に失敗しました。データが改ざんされた可能性があります。\n";
83    } else {
84        echo "メッセージを復号化しました。\n";
85        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
86        if ($message === $decryptedMessage) {
87            echo "結果: 暗号化・復号化が成功し、元のメッセージと一致します。\n";
88        } else {
89            echo "結果: エラー - 復号されたメッセージが元のメッセージと一致しません。\n";
90        }
91    }
92
93    echo "\n--- デモンストレーション終了 ---\n";
94}
95
96// 関数を実行してデモンストレーションを開始します。
97demonstrateAeadXChaCha20Poly1305IETF();

このPHPサンプルコードは、sodium拡張機能を用いて、認証付き暗号化アルゴリズム「XChaCha20-Poly1305 (IETF版)」の基本的な使い方を実演します。特に、このアルゴリズムに必要な定数、中でもSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTESの役割を理解することを目的としています。

SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES定数は、暗号化したメッセージに付加される「認証タグ」のサイズ（バイト数）を示し、整数値として定義されています。この認証タグは、データが途中で改ざんされていないかを検証するために使用され、メッセージの完全性と真正性を保証します。この定数に引数はありません。

また、キーワードとして挙げられている機能に関連するSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES定数は、各暗号化操作でユニークである必要がある「ナンス（Nonce）」のサイズを示します。ナンスは、同じ鍵で安全に複数回暗号化を行うために不可欠なランダムな値です。

コードでは、まず鍵とナンスを生成し、秘密にしたい「平文」と、暗号化されないが認証の対象となる「関連データ」を準備します。次に、sodium_crypto_aead_xchacha20poly1305_ietf_encrypt関数でこれらを暗号化し、その結果得られる暗号文には認証タグが含まれます。最後に、sodium_crypto_aead_xchacha20poly1305_ietf_decrypt関数で復号を試みます。この復号の際には認証タグも検証され、もしデータが改ざんされていた場合は復号に失敗し、安全ではないデータが誤って使用されることを防ぎます。これにより、機密性と完全性の両方が保証されたデータのやり取りが可能になります。

Copy
1<?php
2
3// Sodiumライブラリが利用可能か確認します。
4// システムエンジニアを目指す上で、必要なPHP拡張機能がインストールされているかの確認は重要です。
5if (!extension_loaded('sodium')) {
6    die('PHP Sodium extension not loaded.' . PHP_EOL);
7}
8
9/**
10 * AEAD (Authenticated Encryption with Associated Data) を使用した
11 * データの暗号化と復号のデモンストレーション関数です。
12 *
13 * `SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES` 定数を使って
14 * 異なる暗号化アルゴリズムの認証タグサイズも示しつつ、
15 * `sodium_crypto_aead_aes256gcm_decrypt` 関数を用いた復号の流れを説明します。
16 */
17function demonstrateAeadEncryptionDecryption(): void
18{
19    echo "--- AEAD 暗号化・復号デモンストレーション ---" . PHP_EOL . PHP_EOL;
20
21    // 1. 各暗号化方式の認証タグサイズを表示（参考情報として）
22    // 「認証タグ」は、データの改ざんを検知するために付加される短いデータです。
23    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES は、
24    // XChaCha20-Poly1305-IETF 方式の認証タグのバイトサイズを示します。
25    echo "XChaCha20-Poly1305-IETF 認証タグサイズ: " . SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES . " バイト" . PHP_EOL;
26    // 今回使用する AES256-GCM 方式の認証タグサイズも表示します。
27    echo "AES256-GCM 認証タグサイズ: " . SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES . " バイト" . PHP_EOL;
28    echo PHP_EOL;
29
30    // 2. AES256-GCM 暗号化に必要な要素を準備
31    // 秘密鍵は、暗号化と復号の両方に使用される非常に重要な情報です。
32    $key = sodium_crypto_aead_aes256gcm_keygen(); // 32バイトのランダムな秘密鍵を生成
33
34    // ノンス（nonce, ナンスとも呼ばれる）は、一度しか使用しないランダムな値です。
35    // 同じ鍵で暗号化するたびに異なるノンスを使用することがセキュリティ上必須です。
36    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES); // AES256-GCMに必要な12バイトのノンスを生成
37
38    $plaintext = 'これは外部に漏らしてはならない秘密の情報です。';
39    // 追加認証データ (AAD) は、暗号化されませんが、認証の対象となるデータです。
40    // メッセージIDやバージョン情報など、データが改ざんされていないことを確認したい情報に使われます。
41    // 復号時には、暗号化時と全く同じAADが必要です。
42    $additionalData = 'order-id-456789-user-123';
43
44    echo "--- 暗号化 ---" . PHP_EOL;
45    echo "平文: " . $plaintext . PHP_EOL;
46    echo "追加認証データ (AAD): " . $additionalData . PHP_EOL;
47    echo "ノンス (Base64エンコード): " . base64_encode($nonce) . PHP_EOL;
48    echo PHP_EOL;
49
50    // 3. データの暗号化
51    // `sodium_crypto_aead_aes256gcm_encrypt` 関数を使用してデータを暗号化します。
52    // この関数は、平文、AAD、ノンス、鍵を受け取り、暗号文と認証タグを結合したバイト列を返します。
53    $ciphertextWithTag = sodium_crypto_aead_aes256gcm_encrypt(
54        $plaintext,
55        $additionalData,
56        $nonce,
57        $key
58    );
59
60    echo "暗号文と認証タグ (Base64エンコード): " . base64_encode($ciphertextWithTag) . PHP_EOL;
61    echo PHP_EOL;
62
63    // 4. データの復号
64    echo "--- 復号 ---" . PHP_EOL;
65    // `sodium_crypto_aead_aes256gcm_decrypt` 関数を使用してデータを復号します。
66    // この関数は、暗号文、追加認証データ、ノンス、鍵を使い、
67    // データの認証（改ざんされていないことの確認）を行います。
68    // 認証が成功すれば平文を返し、認証が失敗したりデータが改ざんされている場合は `false` を返します。
69    $decryptedPlaintext = sodium_crypto_aead_aes256gcm_decrypt(
70        $ciphertextWithTag,
71        $additionalData, // 暗号化時と全く同じAADを使用
72        $nonce,          // 暗号化時と全く同じノンスを使用
73        $key             // 暗号化時と全く同じ鍵を使用
74    );
75
76    if ($decryptedPlaintext !== false) {
77        echo "復号された平文: " . $decryptedPlaintext . PHP_EOL;
78        if ($decryptedPlaintext === $plaintext) {
79            echo "✔ 復号されたデータは元の平文と一致します。認証も成功しました。" . PHP_EOL;
80        } else {
81            echo "✘ 復号されたデータが元の平文と一致しません！これは予期せぬエラーです。" . PHP_EOL;
82        }
83    } else {
84        echo "✘ 復号に失敗しました。認証エラーが発生したか、データが改ざんされています。" . PHP_EOL;
85    }
86
87    echo PHP_EOL;
88
89    // 5. 意図的な改ざんによる復号失敗の例
90    echo "--- 改ざんされたデータの復号試行 ---" . PHP_EOL;
91    // 暗号文をわずかに改ざんしてみます（例として最初の1バイトを反転）。
92    $tamperedCiphertext = $ciphertextWithTag;
93    $tamperedCiphertext[0] = chr(ord($tamperedCiphertext[0]) ^ 0xFF);
94
95    $failedDecryption = sodium_crypto_aead_aes256gcm_decrypt(
96        $tamperedCiphertext,
97        $additionalData,
98        $nonce,
99        $key
100    );
101
102    if ($failedDecryption === false) {
103        echo "✔ 改ざんされた暗号文は正しく復号に失敗しました（セキュリティ機能が働きました）。" . PHP_EOL;
104    } else {
105        echo "✘ 改ざんされたデータが復号されてしまいました（これはセキュリティ上の問題です）。" . PHP_EOL;
106    }
107
108    echo PHP_EOL;
109
110    // 6. 異なる追加認証データ (AAD) による復号失敗の例
111    echo "--- 異なるAADでの復号試行 ---" . PHP_EOL;
112    $tamperedAdditionalData = 'wrong-order-id'; // 暗号化時とは異なるAAD
113
114    $failedDecryptionWithTamperedAad = sodium_crypto_aead_aes256gcm_decrypt(
115        $ciphertextWithTag,
116        $tamperedAdditionalData, // 異なるAADを使用すると認証に失敗します
117        $nonce,
118        $key
119    );
120
121    if ($failedDecryptionWithTamperedAad === false) {
122        echo "✔ 異なるAADでの復号は正しく失敗しました（セキュリティ機能が働きました）。" . PHP_EOL;
123    } else {
124        echo "✘ 異なるAADで復号されてしまいました（これはセキュリティ上の問題です）。" . PHP_EOL;
125    }
126}
127
128// デモンストレーション関数を実行します。
129demonstrateAeadEncryptionDecryption();

このサンプルコードは、PHPのSodium拡張機能を用いたAEAD（認証付き暗号化）によるデータの暗号化と復号のプロセスを、システムエンジニアを目指す初心者向けに示します。

SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTESは、XChaCha20-Poly1305-IETFという暗号化方式で使用される認証タグのバイトサイズを示す整数値の定数です。認証タグは、データが改ざんされていないかを検証するための重要な情報で、コード内では他の方式のタグサイズと比較して表示されています。

データの暗号化には秘密鍵、一度きりのノンス、平文、そして認証対象となる追加認証データ（AAD）が用いられます。これらの情報を使ってsodium_crypto_aead_aes256gcm_encrypt関数で暗号化されたデータは、認証タグと結合されます。

復号にはsodium_crypto_aead_aes256gcm_decrypt関数を使用します。この関数は、暗号化されたデータ（暗号文と認証タグ）、AAD、ノンス、そして秘密鍵を引数として受け取ります。重要な点として、これらの引数が暗号化時と完全に一致しないと認証が失敗します。sodium_crypto_aead_aes256gcm_decryptは、データの改ざんがないことを認証タグで検証します。検証に成功すれば元の平文が文字列として戻り値で返されますが、データやAADが改ざんされていたり、ノンスや鍵が異なっていたりすると、認証失敗と判断されfalseが戻り値として返されます。

サンプルコードでは、意図的に暗号文やAADを改ざんして復号を試み、その際にfalseが返されることで、データの整合性が損なわれた場合に適切に検知されるセキュリティ機能が働く様子を示しています。これにより、セキュアなシステム開発におけるAEADの重要性が理解できます。