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

Copy
1<?php
2
3/**
4 * ChaCha20-Poly1305 (AEAD) アルゴリズムを使用してデータを暗号化・復号化するサンプル関数です。
5 *
6 * システムエンジニアを目指す初心者の方へ:
7 * この関数は、データを安全に保護するための基本的な流れを示しています。
8 * キー生成、nonce (使い捨ての番号) 生成、データの暗号化、そして復号化の手順を学びましょう。
9 * このコードを実行するには、PHPにSodium拡張がインストールされ、有効になっている必要があります。
10 *
11 * @param string $plainText 暗号化する平文データ
12 * @return void
13 */
14function demonstrateChaCha20Poly1305Encryption(string $plainText): void
15{
16    echo "=== ChaCha20-Poly1305 暗号化・復号化デモンストレーション ===\n";
17    echo "元の平文: " . $plainText . "\n\n";
18
19    // 1. 暗号化キーの生成
20    // sodium_crypto_aead_chacha20poly1305_keygen() は、このアルゴリズムで使用する安全なキーを生成します。
21    // キーは暗号化と復号化の両方に必要です。決して外部に漏らしてはいけません。
22    $key = sodium_crypto_aead_chacha20poly1305_keygen();
23    echo "生成されたキーの長さ: " . strlen($key) . " バイト\n";
24    // 実際にはキーを直接表示することは推奨されません。デモのために長さを表示しています。
25
26    // 2. Nonce (ナンス) の生成
27    // Nonceは "Number used once" (一度だけ使われる数値) の略です。
28    // 各暗号化操作で異なるユニークなNonceを使用する必要があります。
29    // sodium_crypto_aead_chacha20poly1305_ietf_npubbytes は、このアルゴリズムで必要なNonceのバイト長を返します。
30    $nonceBytes = sodium_crypto_aead_chacha20poly1305_ietf_npubbytes;
31    $nonce = random_bytes($nonceBytes); // 暗号学的に安全なランダムなNonceを生成
32    echo "必要なNonceの長さ: " . $nonceBytes . " バイト\n";
33    echo "生成されたNonceの長さ: " . strlen($nonce) . " バイト\n\n";
34
35    // 3. データの暗号化
36    // sodium_crypto_aead_chacha20poly1305_encrypt() を使用してデータを暗号化します。
37    // 引数: 平文, 追加認証データ (オプション), Nonce, キー
38    // 追加認証データ (AD) は、暗号化はされませんが、復号時に改ざんされていないことを検証するために使用できます。
39    $additionalData = 'example-metadata'; // 例: データの種類など
40    $cipherText = sodium_crypto_aead_chacha20poly1305_encrypt(
41        $plainText,
42        $additionalData,
43        $nonce,
44        $key
45    );
46
47    echo "暗号化されたデータの長さ: " . strlen($cipherText) . " バイト\n";
48    // 暗号化されたデータ (バイナリ) をBase64エンコードして表示 (表示のため)
49    echo "暗号文 (Base64): " . base64_encode($cipherText) . "\n\n";
50
51    // 4. データの復号化
52    // sodium_crypto_aead_chacha20poly1305_decrypt() を使用して暗号文を復号化します。
53    // 復号化には、暗号化時と同じキー、Nonce、および追加認証データが必要です。
54    // これらのいずれか一つでも異なると、復号化は失敗します (改ざん検知)。
55    try {
56        $decryptedText = sodium_crypto_aead_chacha20poly1305_decrypt(
57            $cipherText,
58            $additionalData,
59            $nonce,
60            $key
61        );
62        echo "復号化された平文: " . $decryptedText . "\n\n";
63
64        // 復号化されたデータが元の平文と一致するか確認
65        if ($plainText === $decryptedText) {
66            echo "結果: 復号化成功！元の平文と一致しました。\n";
67        } else {
68            echo "結果: エラー！復号化されたデータが元の平文と一致しません。\n";
69        }
70    } catch (Throwable $e) {
71        echo "復号化エラー: " . $e->getMessage() . "\n";
72        echo "データが改ざんされたか、キー/Nonce/追加データが間違っている可能性があります。\n";
73    }
74}
75
76// サンプルコードを実行
77$messageToEncrypt = "こんにちは、世界！これはPHPのSodium拡張を使った秘密のメッセージです。";
78demonstrateChaCha20Poly1305Encryption($messageToEncrypt);

このPHPのサンプルコードは、Sodium拡張を利用したChaCha20-Poly1305アルゴリズムによるデータの安全な暗号化と復号化のプロセスを示しています。システムエンジニアを目指す初心者の方にとって、セキュリティの基礎を学ぶ上で重要な知識となります。

主要なsodium_crypto_aead_chacha20poly1305_keygen関数は、この暗号化アルゴリズムで使用する、安全で予測不可能な暗号化キーを生成します。この関数は引数を取らず、強力なランダムバイト列を文字列として返します。生成されたキーは、データの暗号化と復号化の両方に不可欠であり、厳重な秘密管理が求められます。

キーの生成後、sodium_crypto_aead_chacha20poly1305_ietf_npubbytes定数で示される必要な長さでNonce（ナンス：一度だけ使用する番号）を生成します。これらのキーとNonceを用いて平文データを暗号化し、後で同じキー、Nonce、および追加認証データ（もしあれば）を使って復号化します。これにより、データの機密性と完全性が保護され、改ざんされていないかも確認できます。このサンプルコードの実行には、PHPにSodium拡張がインストールされ、有効になっている必要があります。

Copy
1<?php
2
3/**
4 * LibsodiumのChaCha20-Poly1305 AEAD暗号化/復号化のサンプルコード。
5 *
6 * sodium_crypto_aead_chacha20poly1305_keygen 関数を使用して、
7 * メッセージを安全に暗号化および復号化する方法を示します。
8 * キーワードの 'sodium_crypto_box' は異なる種類の暗号化ですが、
9 * このサンプルでは鍵生成と暗号化の基本的な流れを示します。
10 */
11function runChacha20Poly1305Example(): void
12{
13    // 1. 対称鍵の生成
14    // sodium_crypto_aead_chacha20poly1305_keygen() は引数なしで、
15    // ChaCha20-Poly1305 暗号化用の256ビット (32バイト) の対称鍵を生成します。
16    $key = sodium_crypto_aead_chacha20poly1305_keygen();
17    echo "--- 鍵生成と暗号化/復号化の例 ---\n\n";
18    echo "生成された鍵の長さ: " . strlen($key) . " バイト\n";
19    // 鍵自体は機密情報なので、通常は表示しません。
20    // echo "鍵 (Base64エンコード): " . base64_encode($key) . "\n\n";
21
22    // 2. 暗号化するオリジナルメッセージ
23    $originalMessage = "システムエンジニアの皆さん、Libsodiumへようこそ！これは秘密のメッセージです。";
24    echo "オリジナルメッセージ: " . $originalMessage . "\n\n";
25
26    // 3. ナンス (Nonce) の生成
27    // Nonce (Number used once) は、各暗号化操作で一度だけ使用される一意のランダム値です。
28    // 同じ鍵で複数のメッセージを暗号化する場合でも、常に異なるNonceを使用する必要があります。
29    // Nonceは暗号文と一緒に保存し、復号化時に必要になります。
30    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES);
31    echo "生成されたNonceの長さ: " . strlen($nonce) . " バイト\n";
32    // echo "Nonce (Base64エンコード): " . base64_encode($nonce) . "\n\n";
33
34    // 4. メッセージの暗号化
35    // sodium_crypto_aead_chacha20poly1305_encrypt() は、メッセージ、Nonce、追加認証データ (オプション)、鍵
36    // を受け取り、暗号文を返します。
37    // 追加認証データ (AD) は、暗号化はされないが認証されるデータで、メッセージの完全性を保証するのに役立ちます。
38    // ここではADは使用しません。
39    $encryptedMessage = sodium_crypto_aead_chacha20poly1305_encrypt(
40        $originalMessage,
41        '', // 追加認証データ (AD)。今回は使用しないので空文字列
42        $nonce,
43        $key
44    );
45    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($encryptedMessage) . "\n";
46    echo "暗号化されたメッセージの長さ: " . strlen($encryptedMessage) . " バイト\n\n";
47
48    // 5. メッセージの復号化
49    // sodium_crypto_aead_chacha20poly1305_decrypt() は、暗号文、Nonce、追加認証データ (オプション)、鍵
50    // を受け取り、復号化されたメッセージを返します。
51    // 復号化に失敗した場合 (例: 鍵が間違っている、暗号文が改ざんされている)、false を返します。
52    $decryptedMessage = sodium_crypto_aead_chacha20poly1305_decrypt(
53        $encryptedMessage,
54        '', // 暗号化時と同じ追加認証データを使用
55        $nonce,
56        $key
57    );
58
59    if ($decryptedMessage === false) {
60        echo "エラー: メッセージの復号化に失敗しました。\n";
61    } else {
62        echo "復号化されたメッセージ: " . $decryptedMessage . "\n\n";
63
64        // 6. 結果の確認
65        if ($originalMessage === $decryptedMessage) {
66            echo "結果: オリジナルメッセージと復号化されたメッセージは一致します。暗号化/復号化成功！\n";
67        } else {
68            echo "結果: エラー！オリジナルメッセージと復号化されたメッセージが一致しません。\n";
69        }
70    }
71}
72
73// サンプルコードを実行
74runChacha20Poly1305Example();
75
76?>

PHPのsodium_crypto_aead_chacha20poly1305_keygen関数は、ChaCha20-Poly1305という認証付き暗号アルゴリズムで使用する「対称鍵」を安全に生成するために利用されます。この関数は引数を一切必要とせず、呼び出すだけで256ビット（32バイト）のランダムな鍵をバイナリ文字列として返します。生成されたこの鍵は、メッセージの暗号化と復号化の両方に使用されるため、非常に機密性の高い情報として厳重に管理する必要があります。

サンプルコードでは、まずこのsodium_crypto_aead_chacha20poly1305_keygen関数を用いて、暗号化と復号化に使う対称鍵を生成しています。次に、暗号化したい元のメッセージと、各暗号化操作で一度だけ使用する一意のランダム値である「ナンス」（Nonce）を準備します。ナンスは、同じ鍵で複数のメッセージを暗号化する際に、それぞれの暗号文のセキュリティを確保するために不可欠な要素です。

そして、生成した鍵とナンス、オリジナルメッセージをsodium_crypto_aead_chacha20poly1305_encrypt関数に渡すことで、メッセージが安全に暗号化されます。暗号化されたデータは、正しい鍵とナンスがなければ復号できません。最後に、同じ鍵とナンスを使用してsodium_crypto_aead_chacha20poly1305_decrypt関数でメッセージを復号化し、元のメッセージと一致するかを確認することで、データの機密性と完全性が正しく保持されていることを示しています。このように、sodium_crypto_aead_chacha20poly1305_keygenは、セキュアなデータ通信の基盤となる鍵を生成する重要な役割を担っています。