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

Copy
1<?php
2
3/**
4 * AES256-GCM暗号化と復号化の例
5 *
6 * sodium_crypto_aead_aes256gcm_keygen を使用して新しい秘密鍵を生成し、
7 * その鍵を使ってデータの暗号化と復号化を行います。
8 * システムエンジニアを目指す初心者にも理解しやすいように、基本的な流れを示します。
9 */
10function runEncryptionDecryptionExample(): void
11{
12    // PHP Sodium拡張機能がロードされているか確認します。
13    // この機能は通常、PHPのインストール時に追加されます。
14    if (!extension_loaded('sodium')) {
15        echo "エラー: PHP Sodium拡張機能がロードされていません。\n";
16        echo "ext-sodiumをインストールして有効にしてください。\n";
17        return;
18    }
19
20    echo "--- AES256-GCM暗号化・復号化の例 ---\n";
21
22    // 1. AES256-GCM用の新しい秘密鍵を生成します。
23    // この鍵は、暗号化と復号化の両方に必要で、外部に漏らしてはいけません。
24    // 戻り値はバイナリ文字列なので、直接表示すると文字化けすることがあります。
25    $key = sodium_crypto_aead_aes256gcm_keygen();
26    echo "1. 新しい秘密鍵が生成されました (生データのため表示しません)。\n";
27
28    // 2. 暗号化したい平文データを用意します。
29    $plainText = "これはAES256-GCMで暗号化される秘密のメッセージです。システムエンジニアの皆さん、こんにちは！";
30    echo "2. 元の平文: " . $plainText . "\n";
31
32    // 3. ノンシー (Nonce: Number used once) を生成します。
33    // ノンシーは、同じ鍵で暗号化するたびに異なる値を使用する必要があります。
34    // これはメッセージごとにユニークである必要があり、予測不可能なランダムな値でなければなりません。
35    // ノンシーの長さは sodium_crypto_aead_aes256gcm_npubbytes() で取得します。
36    $nonce = random_bytes(sodium_crypto_aead_aes256gcm_npubbytes());
37    echo "3. ノンシーが生成されました (生データのため表示しません)。\n";
38
39    // 4. 追加認証データ (Additional Data: AD) を用意します。
40    // このデータは暗号化されませんが、復号時に認証に使用されます。
41    // メッセージの内容が改ざんされていなくても、追加認証データが改ざんされた場合は
42    // 復号に失敗します。ここでは簡単な文字列を例とします。
43    $additionalData = "ユーザーID: 12345, ドキュメントタイプ: 機密";
44    echo "4. 追加認証データ: " . $additionalData . "\n";
45
46    // 5. 平文データを暗号化します。
47    // sodium_crypto_aead_aes256gcm_encrypt(平文, 追加認証データ, ノンシー, 鍵)
48    $cipherText = sodium_crypto_aead_aes256gcm_encrypt(
49        $plainText,
50        $additionalData,
51        $nonce,
52        $key
53    );
54    // 暗号文はバイナリデータなので、画面に表示するためにBase64エンコードします。
55    echo "5. 生成された暗号文 (Base64エンコード): " . base64_encode($cipherText) . "\n";
56
57    // 6. 暗号文を復号化します。
58    // 復号化には、暗号化に使用した鍵、ノンシー、追加認証データが全て必要です。
59    // いずれか一つでも欠けていたり、間違っていたりすると復号化は失敗し、falseを返します。
60    $decryptedText = sodium_crypto_aead_aes256gcm_decrypt(
61        $cipherText,
62        $additionalData,
63        $nonce,
64        $key
65    );
66
67    // 7. 復号化が成功したかを確認し、結果を表示します。
68    if ($decryptedText === false) {
69        echo "6. 復号化に失敗しました。鍵、ノンシー、または追加認証データが正しくありません。\n";
70    } else {
71        echo "6. 復号された平文: " . $decryptedText . "\n";
72
73        // 復号されたデータが元の平文と一致するか確認します。
74        if ($decryptedText === $plainText) {
75            echo "結果: 復号されたデータは元の平文と完全に一致しました。成功！\n";
76        } else {
77            echo "エラー: 復号されたデータが元の平文と一致しませんでした。\n";
78        }
79    }
80}
81
82// 例を実行します
83runEncryptionDecryptionExample();

PHP 8のsodium_crypto_aead_aes256gcm_keygen関数は、セキュアなAES256-GCM暗号化方式で使用する秘密鍵を生成するために利用されます。この関数は引数を持ちません。実行すると、暗号化と復号化の両方に利用される、ランダムで強力なバイナリ文字列の鍵を返します。この生成された鍵は機密情報であり、データの安全性を保つために外部に漏洩しないよう厳重に管理する必要があります。

提供されたサンプルコードでは、まずこの関数を使って新しい秘密鍵を作成しています。次に、生成された鍵と、メッセージごとに異なる「ノンシー」（Nonce: Number used once）という一意の値、さらに「追加認証データ」（Additional Data）と呼ばれる認証用の情報を用いて、元の平文データをsodium_crypto_aead_aes256gcm_encrypt関数で安全に暗号化しています。

暗号化されたデータ（暗号文）を復号化する際には、暗号化時に使用した全く同じ秘密鍵、ノンシー、追加認証データの三つ全てが必要です。sodium_crypto_aead_aes256gcm_decrypt関数はこれらの情報を受け取り、全てが正しければ元の平文を返しますが、一つでも誤りがあれば復号は失敗し、falseを返します。この一連の流れにより、データの機密性と完全性が確保されます。この機能を利用するには、PHPのSodium拡張機能が有効になっている必要があります。

Copy
1<?php
2
3/**
4 * PHP 8 の sodium_crypto_aead_aes256gcm_keygen を使用して鍵を生成し、
5 * その鍵でデータを暗号化・復号化するデモンストレーションを行います。
6 *
7 * この関数は、システムエンジニアを目指す初心者向けに、
8 * 認証付き暗号化の一連の流れを簡潔に示します。
9 * Sodium 拡張機能が有効になっている環境で実行してください。
10 */
11function demonstrateAes256GcmEncryption(): void
12{
13    // 1. AES256-GCM 用の秘密鍵を生成します。
14    // この鍵は極めて重要であり、安全に保管し、決して漏洩させてはいけません。
15    // sodium_crypto_aead_aes256gcm_keygen() は引数なしで32バイトのランダムな鍵を返します。
16    $key = sodium_crypto_aead_aes256gcm_keygen();
17    echo "--- 鍵生成 ---\n";
18    echo "生成された秘密鍵 (Base64エンコード): " . base64_encode($key) . "\n\n";
19
20    // 2. 暗号化する元のデータ（プレーンテキスト）を準備します。
21    $plainText = "これはシステムエンジニアを目指す初心者向けの機密メッセージです。";
22    echo "--- 暗号化 --- \n";
23    echo "元のテキスト: " . $plainText . "\n\n";
24
25    // 3. 暗号化ごとにユニークなノンス（nonce）を生成します。
26    // ノンスは "number used once" の略で、再利用してはいけません。
27    // ノンス自体は秘密にする必要はありませんが、認証された形で送信する必要があります。
28    // sodium_crypto_aead_aes256gcm_npubbytes() はこのアルゴリズムに必要なノンスのバイト数を返します。
29    $nonce = random_bytes(sodium_crypto_aead_aes256gcm_npubbytes());
30    echo "生成されたノンス (Base64エンコード): " . base64_encode($nonce) . "\n\n";
31
32    // 4. 追加認証データ (Authenticated Additional Data, AAD) を準備します。
33    // このデータは暗号化されませんが、改ざん防止の認証に含まれます。
34    // 今回は例として空文字列を使用しますが、必要に応じてメタデータなどを渡せます。
35    $additionalData = '';
36
37    // 5. データを暗号化します。
38    // sodium_crypto_aead_aes256gcm_encrypt() は、メッセージ、AAD、ノンス、鍵を引数に取り、
39    // 暗号文と認証タグを結合した文字列を返します。
40    $cipherText = sodium_crypto_aead_aes256gcm_encrypt(
41        $plainText,
42        $additionalData,
43        $nonce,
44        $key
45    );
46    echo "暗号化されたデータ (Base64エンコード): " . base64_encode($cipherText) . "\n\n";
47
48    // 6. 暗号化されたデータを復号化します。
49    // 復号化には、暗号化時と同じ鍵、ノンス、追加認証データが必要です。
50    // これらのいずれかが異なると、復号に失敗するか、改ざんエラーが発生します。
51    echo "--- 復号化 ---\n";
52    try {
53        $decryptedText = sodium_crypto_aead_aes256gcm_decrypt(
54            $cipherText,
55            $additionalData,
56            $nonce,
57            $key
58        );
59
60        echo "復号されたテキスト: " . $decryptedText . "\n\n";
61
62        // 7. 復号されたデータが元のデータと一致するか確認します。
63        if ($decryptedText === $plainText) {
64            echo "結果: 復号化が成功し、元のテキストと完全に一致しました。\n";
65        } else {
66            echo "結果: 復号化されたテキストが元のテキストと一致しませんでした。データの改ざん、または鍵/ノンスの誤りの可能性があります。\n";
67        }
68    } catch (ValueError $e) {
69        // 復号に失敗した場合（例: 鍵が間違っている、ノンスが異なる、データが改ざんされているなど）
70        echo "エラー: 復号化に失敗しました。データが改ざんされたか、鍵またはノンスが誤っている可能性があります。\n";
71        echo "詳細: " . $e->getMessage() . "\n";
72    }
73}
74
75// 関数を実行してデモンストレーションを開始します。
76demonstrateAes256GcmEncryption();
77
78?>

PHP 8のSodium拡張機能で提供されるsodium_crypto_aead_aes256gcm_keygen関数は、認証付き暗号化アルゴリズムであるAES256-GCMに用いる秘密鍵を安全に生成します。この関数は引数を取らず、セキュリティ上重要な32バイトのランダムな文字列（string型）を秘密鍵として返します。生成された鍵は、データの暗号化と復号化の両方に必要となるため、厳重な管理が求められます。

サンプルコードでは、まずこの関数で秘密鍵を生成し、続いて暗号化の対象となる平文、認証情報となる追加データ、そして毎回異なる値であるノンスを準備します。これらの情報と生成した秘密鍵をsodium_crypto_aead_aes256gcm_encrypt関数に渡すことで、データは暗号化されます。暗号化されたデータは、同じ秘密鍵、ノンス、追加データを用いてsodium_crypto_aead_aes256gcm_decrypt関数で元の平文に復号化されます。この一連の流れは、データの機密性と改ざん防止を両立させる認証付き暗号化の基本的な仕組みを示しており、安全なシステムを構築する上で不可欠な技術です。