【PHP8.x】sodium_crypto_aead_xchacha20poly1305_ietf_keygen()関数の使い方

Copy
1<?php
2
3/**
4 * PHP Sodium拡張のXChaCha20-Poly1305-IETFアルゴリズムを用いた
5 * キー生成、暗号化、復号化の基本的な流れを示すサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者向けに、暗号化の主要な要素（キー、ナンス、追加認証データ）を
8 * どのように扱うかを紹介します。
9 *
10 * PHP 8環境では、Sodium拡張はデフォルトでバンドルされていることが多いですが、
11 * 環境によってはext-libsodiumのインストールが必要な場合があります。
12 */
13function demonstrateXChaCha20Poly1305Encryption(): void
14{
15    echo "--- XChaCha20-Poly1305-IETF 暗号化デモンストレーション ---\n\n";
16
17    // 1. 暗号化キーの生成
18    // sodium_crypto_aead_xchacha20poly1305_ietf_keygen() 関数は、
19    // XChaCha20-Poly1305-IETFアルゴリズムで使用する、安全な暗号化キーを生成します。
20    // このキーは暗号化と復号化の両方に必要で、外部に漏れないように厳重に管理する必要があります。
21    $key = sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
22    echo "1. 安全な暗号化キーが生成されました。\n";
23    // echo "   キー (バイナリ): " . bin2hex($key) . "\n"; // デバッグ目的以外では出力非推奨
24
25    // 2. 暗号化する平文メッセージ
26    $message = "これは誰にも知られたくない秘密のメッセージです。";
27    echo "2. 平文メッセージ: \"{$message}\"\n";
28
29    // 3. ナンス（Nonce - Number used once）の生成
30    // ナンスは、同じキーで暗号化を行う際に、異なるナンスを使用することでセキュリティを確保します。
31    // 同じキーとナンスの組み合わせで複数のメッセージを暗号化してはいけません。
32    // SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES は、
33    // このアルゴリズムに必要なナンスの正確なバイト数を示す定数です。
34    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES);
35    echo "3. 一意のナンスが生成されました。\n";
36    // echo "   ナンス (バイナリ): " . bin2hex($nonce) . "\n"; // デバッグ目的以外では出力非推奨
37
38    // 4. 追加認証データ（AAD - Additional Authenticated Data）の定義 (オプション)
39    // AADは、暗号化はされませんが、暗号文の改ざんを検出するために認証情報として使用されます。
40    // 例えば、メッセージの受信者IDやタイムスタンプなど、特定のコンテキスト情報をここに含めることができます。
41    $additionalData = "userID:1001;transactionID:T56789";
42    echo "4. 追加認証データ: \"{$additionalData}\"\n";
43
44    // 5. メッセージの暗号化
45    // sodium_crypto_aead_xchacha20poly1305_ietf_encrypt() 関数を使用して、
46    // 平文メッセージ、追加認証データ、ナンス、キーを組み合わせて暗号文を生成します。
47    $ciphertext = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
48        $message,
49        $additionalData,
50        $nonce,
51        $key
52    );
53    echo "5. メッセージが安全に暗号化されました。\n";
54    // echo "   暗号文 (バイナリ): " . bin2hex($ciphertext) . "\n"; // 暗号文の例
55
56    // 6. 暗号化されたメッセージの復号化
57    // sodium_crypto_aead_xchacha20poly1305_ietf_decrypt() 関数を使用して、
58    // 暗号文、**同じ**追加認証データ、**同じ**ナンス、**同じ**キーを渡して平文に戻します。
59    // 復号に成功すると元の平文が返され、失敗（データ改ざんなど）した場合は false が返されます。
60    $decryptedMessage = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
61        $ciphertext,
62        $additionalData,
63        $nonce,
64        $key
65    );
66
67    echo "6. 暗号文を復号化中...\n";
68    if ($decryptedMessage !== false) {
69        echo "   復号化に成功しました。\n";
70        echo "   復号化されたメッセージ: \"{$decryptedMessage}\"\n";
71
72        if ($message === $decryptedMessage) {
73            echo "   元のメッセージと復号化されたメッセージが完全に一致します。\n";
74            echo "   デモンストレーションは成功です。\n";
75        } else {
76            echo "   エラー: 復号化されたメッセージが元のメッセージと一致しません。\n";
77        }
78    } else {
79        echo "   エラー: メッセージの復号化に失敗しました。データが改ざんされたか、\n";
80        echo "          キー、ナンス、または追加認証データが不正である可能性があります。\n";
81    }
82
83    echo "\n--- デモンストレーション終了 ---\n";
84}
85
86// 関数を実行してデモンストレーションを開始します。
87demonstrateXChaCha20Poly1305Encryption();

PHP 8のsodium_crypto_aead_xchacha20poly1305_ietf_keygen関数は、XChaCha20-Poly1305-IETF認証付き暗号化アルゴリズムで使用する、安全な暗号化キーを生成します。

この関数は引数を一切取らずに呼び出すことができ、戻り値として、暗号化と復号化の両方に必要となるバイナリ形式の文字列（キー）を生成します。生成されるキーは、データの機密性を保つための基盤となるため、非常に重要です。

システムエンジニアにとって、このキーは暗号化処理の「鍵」であり、メッセージの暗号化や復号化を行うsodium_crypto_aead_xchacha20poly1305_ietf_encryptやsodium_crypto_aead_xchacha20poly1305_ietf_decrypt関数などで利用されます。ナンス（SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTESで定義される値）や追加認証データと共に用いられ、セキュリティの中核を担います。生成されたキーは厳重に管理し、セキュアなシステム構築に不可欠です。

Copy
1<?php
2
3// このスクリプトは、PHPのSodium拡張機能を使って、
4// XChaCha20-Poly1305-IETF方式の認証付き暗号化/復号化のキー生成と利用方法を示すサンプルです。
5// システムエンジニアを目指す初心者向けに、対称鍵暗号の基本を理解できるように設計されています。
6
7// PHPのSodium拡張機能が有効か確認します。
8if (!extension_loaded('sodium')) {
9    die('Sodium extension is not loaded. Please enable it in your php.ini.');
10}
11
12/**
13 * PHPのSodium拡張機能を用いて、XChaCha20-Poly1305-IETF認証付き暗号化を実演します。
14 * 対称鍵の生成、メッセージの暗号化、復号化の一連の流れを示します。
15 */
16function demonstrateSymmetricEncryption(): void
17{
18    echo "--- Sodium XChaCha20-Poly1305-IETF 暗号化デモンストレーション ---\n\n";
19
20    // 1. 対称鍵の生成
21    // sodium_crypto_aead_xchacha20poly1305_ietf_keygen() 関数は、
22    // XChaCha20-Poly1305-IETF認証付き暗号化に使用するセッション鍵（共通鍵）を安全に生成します。
23    // この鍵は、暗号化と復号化の両方に使用されるため、通信する両者で共有される必要があります。
24    // 引数はなく、生成された鍵（バイナリ文字列）を返します。
25    $key = sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
26    echo "1. 生成された対称鍵 (Hexエンコード): " . sodium_bin2hex($key) . "\n\n";
27
28    // 2. 暗号化するオリジナルメッセージ
29    $originalMessage = "こんにちは、システムエンジニアの皆さん！これは秘密のメッセージです。";
30    echo "2. オリジナルメッセージ: " . $originalMessage . "\n\n";
31
32    // 3. ナンス（Nonce）の生成
33    // ナンス（Number used once）は、各暗号化操作で一度だけ使用される、予測不可能なランダムな値です。
34    // 同じ鍵で複数のメッセージを暗号化する際に、安全性を保つために不可欠です。
35    // 長さは SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES で定義されています。
36    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES);
37    echo "3. 生成されたナンス (Hexエンコード): " . sodium_bin2hex($nonce) . "\n\n";
38
39    // 4. メッセージの暗号化
40    // sodium_crypto_aead_xchacha20poly1305_ietf_encrypt() を使用してメッセージを暗号化します。
41    // 引数: メッセージ, 関連データ (オプション), ナンス, 鍵
42    // 関連データ (additional authenticated data, AAD) は暗号化されませんが、認証されます。
43    // 今回は関連データは使用しません（空文字列を設定）。
44    $encryptedMessage = sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(
45        $originalMessage,
46        '', // 関連データ (AAD) は空に設定
47        $nonce,
48        $key
49    );
50    echo "4. 暗号化されたメッセージ (Hexエンコード): " . sodium_bin2hex($encryptedMessage) . "\n\n";
51
52    // 5. メッセージの復号化
53    // sodium_crypto_aead_xchacha20poly1305_ietf_decrypt() を使用して暗号化されたメッセージを復号化します。
54    // 暗号化時と同じ鍵とナンス、そして関連データ（もしあれば）が必要です。
55    // 復号に失敗した場合（例: メッセージの改ざん、間違った鍵やナンスの使用）は false が返されます。
56    $decryptedMessage = sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
57        $encryptedMessage,
58        '', // 暗号化時と同じ関連データを使用
59        $nonce,
60        $key
61    );
62
63    // 6. 復号結果の検証
64    if ($decryptedMessage === false) {
65        echo "5. 復号に失敗しました。メッセージが改ざんされたか、鍵またはナンスが間違っています。\n\n";
66    } else {
67        echo "5. 復号されたメッセージ: " . $decryptedMessage . "\n\n";
68
69        // オリジナルメッセージと復号されたメッセージが一致するか確認
70        if ($originalMessage === $decryptedMessage) {
71            echo "結果: オリジナルメッセージと復号されたメッセージは一致します。暗号化と復号は成功しました！\n";
72        } else {
73            echo "結果: エラー！オリジナルメッセージと復号されたメッセージが一致しません。\n";
74        }
75    }
76
77    echo "\n--- デモンストレーション終了 ---\n";
78}
79
80// デモンストレーション関数を実行
81demonstrateSymmetricEncryption();
82

PHP 8で利用可能なsodium_crypto_aead_xchacha20poly1305_ietf_keygen関数は、PHPのSodium拡張機能が提供する、XChaCha20-Poly1305-IETF方式の認証付き暗号化に用いる「対称鍵（共通鍵）」を安全に生成するためのものです。この関数は、引数なしで呼び出すことができ、暗号学的に安全で強固な鍵を生成します。戻り値はstring型で、生成された鍵のバイナリ表現です。

この対称鍵は、メッセージを暗号化する際にも、そのメッセージを復号化する際にも必要となります。そのため、通信を行う両者が、この鍵を第三者に漏洩することなく安全に共有することが極めて重要です。提供されたサンプルコードでは、この関数を用いて対称鍵を生成し、その鍵を使ってメッセージを暗号化し、その後、正しく復号化できる一連の流れを通じて、対称鍵暗号の基本と鍵の役割を分かりやすく示しています。これにより、システムエンジニアを目指す初心者の皆さんも、データ保護における鍵管理の重要性を学ぶことができます。