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

Copy
1<?php
2
3/**
4 * libsodium拡張機能で利用されるXChaCha20-Poly1305-IETF暗号化方式の
5 * ノンス (nonce) の推奨バイト数を取得し、表示する関数です。
6 *
7 * ノンスは、暗号化処理においてメッセージごとにユニークである必要があり、
8 * 繰り返し利用されるとセキュリティ上の問題を引き起こす可能性があります。
9 * この定数は、そのノンスとして推奨されるバイトサイズを提供します。
10 *
11 * @return int ノンスの推奨バイト数、またはsodium拡張が利用できない場合は -1
12 */
13function getXChaCha20Poly1305IETFNpubBytes(): int
14{
15    // 'sodium' 拡張機能がPHPにロードされているかを確認します。
16    // libsodiumはPHPで利用できる強力な暗号化ライブラリです。
17    if (!extension_loaded('sodium')) {
18        echo "エラー: 'sodium' 拡張機能がロードされていません。\n";
19        return -1;
20    }
21
22    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES 定数を使用します。
23    // この定数は、XChaCha20-Poly1305-IETF暗号化に必要なノンスのバイト数を示します。
24    // PHPのlibsodium拡張では、nonce (number public bytes) のサイズをこの定数で定義しています。
25    $nonceSize = SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES;
26
27    echo "XChaCha20-Poly1305-IETF暗号化におけるノンスの推奨バイト数: " . $nonceSize . " バイト\n";
28    echo "この値は、暗号化処理で安全なノンスを生成する際に、" . $nonceSize . "バイトのランダムな値を使用することを示します。\n";
29
30    return $nonceSize;
31}
32
33// 関数を実行して結果を表示します。
34getXChaCha20Poly1305IETFNpubBytes();

このサンプルコードは、PHPのlibsodium拡張機能を利用し、XChaCha20-Poly1305-IETFという暗号化方式で使用される「ノンス」（nonce）の推奨バイト数を取得し、表示する方法を示しています。ここで登場するSODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESという定数は、この特定の暗号化方式で安全な暗号化を行うために必要なノンスの推奨されるバイト数を提供します。ノンスは、暗号化処理を行うたびに異なるユニークな値である必要があり、もし同じノンスを繰り返し使用するとセキュリティ上の問題を引き起こす可能性があるため、適切なサイズを知ることは非常に重要です。

getXChaCha20Poly1305IETFNpubBytes関数は、まずsodium拡張機能がPHPにロードされているかを確認します。これは、暗号化機能が利用可能であるかをチェックするために重要です。もし拡張機能がロードされていない場合はエラーメッセージを表示し、戻り値として-1を返します。拡張機能が利用可能な場合は、SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES定数の値を取得し、その推奨バイト数を画面に表示します。この関数は引数を取りませんが、ノンスの推奨バイト数を整数（int）で返すため、暗号化処理で安全なノンスを生成する際の目安として利用できます。

Copy
1<?php
2
3/**
4 * AES-256-GCM アルゴリズムを用いた認証付き暗号化と復号のデモンストレーションを行います。
5 * システムエンジニアを目指す初心者向けに、認証付き暗号化（AEAD）の基本的な流れと、
6 * nonce (Number Used Once) の重要性を示します。
7 *
8 * @param string $plaintext 暗号化する元の平文
9 * @param string $associatedData 認証に含める関連データ (オプション)。
10 *                               暗号化されませんが、復号時に内容が改ざんされていないか検証されます。
11 * @return bool 処理が成功し、復号されたデータが元の平文と一致すれば true、そうでなければ false。
12 */
13function demonstrateAes256GcmAead(string $plaintext, string $associatedData = ''): bool
14{
15    // PHPにSodium拡張がロードされているか確認します。
16    // 暗号化機能を利用するためには必須です。
17    if (!extension_loaded('sodium')) {
18        echo "エラー: PHPのSodium拡張がロードされていません。このスクリプトは実行できません。\n";
19        return false;
20    }
21
22    echo "--- AES-256-GCM 認証付き暗号化/復号デモンストレーション ---\n";
23    echo "元の平文: " . $plaintext . "\n";
24    echo "関連データ: " . ($associatedData ?: '[なし]') . "\n\n";
25
26    // 1. 秘密鍵の生成
27    // 暗号化と復号に使う共通の鍵を生成します。AES-256-GCMには32バイト（256ビット）の鍵が必要です。
28    $key = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES);
29    echo "鍵のバイト数: " . SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES . "バイト\n";
30
31    // 2. Nonce（ナンス）の生成
32    // Nonceは「Number Used Once」の略で、同じ鍵で複数回暗号化する際に毎回異なる値を使用する必要があります。
33    // AES-256-GCMには、SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES（12バイト）のNonceが必要です。
34    // ※リファレンス情報で指定された `SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTES` も値は12ですが、
35    //   これはXChaCha20-Poly1305-IETFアルゴリズムのNonceサイズを示す定数です。
36    //   AES-256-GCMとは異なるアルゴリズムであるため、ここではAES-256-GCM専用の定数を使用します。
37    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES);
38    echo "Nonceのバイト数 (AES-256-GCM): " . SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES . "バイト\n";
39    echo "生成されたNonce (Hex): " . bin2hex($nonce) . "\n\n";
40
41    // 3. 平文の暗号化
42    // `sodium_crypto_aead_aes256gcm_encrypt` 関数を使用してデータを暗号化します。
43    // この関数は暗号文と共に認証タグも生成し、暗号文の末尾に付加します。
44    $ciphertext = sodium_crypto_aead_aes256gcm_encrypt(
45        $plaintext,
46        $associatedData,
47        $nonce,
48        $key
49    );
50
51    if ($ciphertext === false) {
52        echo "エラー: 暗号化に失敗しました。\n";
53        return false;
54    }
55
56    echo "暗号化成功！\n";
57    echo "暗号文と認証タグ (Hex): " . bin2hex($ciphertext) . "\n\n";
58
59    // 4. 暗号文の復号
60    // `sodium_crypto_aead_aes256gcm_decrypt` 関数を使用して暗号文を復号します。
61    // この関数は復号処理と同時に、付加された認証タグの検証も行います。
62    // データが改ざんされている場合や、Nonce、鍵、関連データが不正確な場合は `false` を返します。
63    $decryptedPlaintext = sodium_crypto_aead_aes256gcm_decrypt(
64        $ciphertext,
65        $associatedData,
66        $nonce,
67        $key
68    );
69
70    if ($decryptedPlaintext === false) {
71        echo "エラー: 復号または認証タグの検証に失敗しました。\n";
72        echo "  - 鍵、Nonce、または関連データが間違っている可能性があります。\n";
73        echo "  - 暗号文が転送中に改ざんされた可能性があります。\n";
74        return false;
75    }
76
77    echo "復号成功！\n";
78    echo "復号された平文: " . $decryptedPlaintext . "\n\n";
79
80    // 5. 結果の確認
81    // 復号された平文が元の平文と一致するか検証します。
82    if ($decryptedPlaintext === $plaintext) {
83        echo "検証完了: 復号された平文は元の平文と一致します。\n";
84        return true;
85    } else {
86        echo "エラー: 復号された平文が元の平文と一致しません。\n";
87        return false;
88    }
89}
90
91// デモンストレーションの実行例
92echo "--- 実行例 1: 関連データあり ---\n";
93demonstrateAes256GcmAead("システムエンジニア入門へようこそ！", "user-id-123");
94
95echo "\n--- 実行例 2: 関連データなし ---\n";
96demonstrateAes256GcmAead("これは誰にも知られたくない秘密の情報です。");
97
98echo "\n--- 実行例 3: 誤ったNonceで復号を試みる (失敗例) ---\n";
99if (extension_loaded('sodium')) {
100    $plaintext = "テストデータ";
101    $key = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES);
102    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES);
103    $associatedData = "test";
104    $ciphertext = sodium_crypto_aead_aes256gcm_encrypt($plaintext, $associatedData, $nonce, $key);
105
106    echo "元の平文: " . $plaintext . "\n";
107    echo "暗号化成功！\n";
108
109    // 意図的に異なるNonceを生成して復号を試みます
110    $wrongNonce = random_bytes(SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES);
111    echo "誤ったNonceで復号を試みます (Hex): " . bin2hex($wrongNonce) . "\n";
112
113    $decryptedFailure = sodium_crypto_aead_aes256gcm_decrypt($ciphertext, $associatedData, $wrongNonce, $key);
114    if ($decryptedFailure === false) {
115        echo "期待通り: 復号または認証タグの検証に失敗しました。Nonceが異なるためです。\n\n";
116    } else {
117        echo "エラー: 誤ったNonceで復号されてしまいました。\n\n";
118    }
119}

SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTESは、PHPのSodium拡張が提供する定数で、XChaCha20-Poly1305-IETFという認証付き暗号化アルゴリズムにおけるNonce（ノンス）のバイト数（12バイト）を示します。Nonceは「Number Used Once」の略で、同じ鍵を使ってデータを複数回暗号化する際に、毎回異なる値を用いることでセキュリティを確保するために不可欠な一意のデータです。この定数は、XChaCha20-Poly1305-IETFアルゴリズムで安全な暗号化を行うために必要なNonceのサイズを正確に提供します。

提供されたサンプルコードは、AES-256-GCMという別の認証付き暗号化（AEAD）アルゴリズムを用いたデータの暗号化と復号のデモンストレーションです。特にsodium_crypto_aead_aes256gcm_decrypt関数は、暗号文を復号し、同時にデータの改ざんがないか認証タグを使って検証する役割を担います。この関数は、暗号文、関連データ、暗号化時に使用したNonce、そして秘密鍵の４つの引数を受け取ります。復号と認証が成功した場合は元の平文（文字列）を返し、鍵やNonceが誤っていたり、暗号文や関連データが改ざんされていたりした場合はfalseを返します。これにより、データの機密性だけでなく完全性も保証されるため、システムにおける安全なデータ通信や保存に不可欠な機能です。サンプルコードでは、正しいNonceを使用しない場合に復号が失敗する例も示されており、Nonceの重要性が明確に理解できます。