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

Copy
1<?php
2
3/**
4 * sodium_crypto_kdf_keygen で生成したキーを、
5 * sodium_crypto_box の鍵ペア生成シードとして利用する応用例。
6 * KDFキーの主な用途は、他の暗号キーの導出です。
7 */
8function demonstrateKdfKeyAsBoxSeed(): void
9{
10    // KDF (Key Derivation Function) マスターキーを生成します。
11    // これは安全な32バイトのランダムなキーです。
12    $kdfMasterKey = sodium_crypto_kdf_keygen();
13    echo "KDF Master Key (Hex): " . bin2hex($kdfMasterKey) . "\n";
14
15    // KDFマスターキーをシードとして、
16    // sodium_crypto_box 用の鍵ペアを生成します。
17    // KDFキーは32バイトであり、seed_keypairのシードとして形式的に適合します。
18    $keyPair = sodium_crypto_box_seed_keypair($kdfMasterKey);
19    $publicKey = sodium_crypto_box_publickey($keyPair);
20    $secretKey = sodium_crypto_box_secretkey($keyPair);
21
22    echo "Public Key (Hex): " . bin2hex($publicKey) . "\n";
23    echo "Secret Key (Hex): " . bin2hex($secretKey) . "\n";
24
25    // 暗号化対象のメッセージ
26    $message = "Hello, secure communication!";
27    // ワンタイムナンスは毎回異なるランダムな値を使用します
28    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES); 
29
30    // 送信者の秘密鍵と受信者の公開鍵でメッセージを暗号化
31    // この例では、同じ鍵ペアを使用していますが、通常は異なるユーザー間で鍵を交換します。
32    $cipherText = sodium_crypto_box($message, $nonce, $publicKey, $secretKey);
33    echo "Original Message: " . $message . "\n";
34    echo "Ciphertext (Hex): " . bin2hex($cipherText) . "\n";
35
36    // メッセージの復号化
37    // 受信者の秘密鍵と送信者の公開鍵でメッセージを復号
38    $decryptedMessage = sodium_crypto_box_open($cipherText, $nonce, $publicKey, $secretKey);
39
40    if ($decryptedMessage !== false) {
41        echo "Decrypted Message: " . $decryptedMessage . "\n";
42    } else {
43        echo "Decryption failed.\n";
44    }
45
46    // セキュリティのため、秘密キーやマスターキーは使用後にクリアします
47    sodium_memzero($kdfMasterKey);
48    sodium_memzero($secretKey);
49    sodium_memzero($keyPair);
50}
51
52// 関数の実行
53demonstrateKdfKeyAsBoxSeed();
54
55?>

PHP 8のsodium_crypto_kdf_keygen関数は、引数なしで呼び出すことにより、暗号学的に安全な32バイトのランダムな文字列を返します。この戻り値は、KDF（Key Derivation Function）マスターキーと呼ばれ、他の暗号キーを安全に導出するための基盤となるキーとして利用されます。

サンプルコードでは、このsodium_crypto_kdf_keygenで生成したKDFマスターキーを、sodium_crypto_box関数群で利用する鍵ペアの生成シードとして活用する応用例を示しています。まず、sodium_crypto_kdf_keygenによって安全なKDFマスターキーが生成され、そのキーがsodium_crypto_box_seed_keypairの引数として渡されます。これにより、マスターキーから公開鍵と秘密鍵のペアが派生的に生成されます。 その後、生成された鍵ペアとランダムなナンス（一度だけ使用する値）を用いて、sodium_crypto_boxでメッセージを暗号化し、sodium_crypto_box_openで復号化する一連の流れが示されています。これは、KDFマスターキーが最終的にセキュアな通信の基盤となる鍵を導出する能力を持つことを具体的に表しています。処理の最後には、セキュリティ強化のため、使用した秘密情報がメモリから確実に消去されるsodium_memzeroが呼び出されています。この関数は、セキュアなシステムにおいて、複数の暗号鍵を一元的に管理し、安全に派生させる上で非常に重要な役割を果たします。

Copy
1<?php
2
3/**
4 * libsodium拡張機能を使用して、秘密鍵の生成、メッセージの暗号化、および復号化を行うサンプルコードです。
5 * sodium_crypto_kdf_keygen 関数で生成されたキーを、sodium_crypto_secretbox の秘密鍵として使用します。
6 *
7 * この関数は、システムエンジニアを目指す初心者が対称鍵暗号の基本的な流れを理解できるように、
8 * 鍵生成、暗号化、復号化の一連のプロセスを簡潔に示します。
9 */
10function encryptAndDecryptSecretBox(): void
11{
12    // 1. 秘密鍵の生成
13    // sodium_crypto_kdf_keygen() は、キー導出関数 (KDF) のマスターキーを生成します。
14    // このキーは、sodium_crypto_secretbox が要求するキー長 (SODIUM_CRYPTO_SECRETBOX_KEYBYTES) と互換性があり、
15    // 対称鍵暗号の秘密鍵として直接利用できます。
16    $secretKey = sodium_crypto_kdf_keygen();
17    echo "--- 秘密鍵の生成 ---\n";
18    echo "秘密鍵のバイト数: " . strlen($secretKey) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . ")\n";
19    echo "秘密鍵 (Base64エンコード): " . base64_encode($secretKey) . "\n\n";
20
21    // 暗号化したい元のメッセージ
22    $originalMessage = "これは極秘のメッセージです。誰にも読まれてはいけません。";
23    echo "--- メッセージの暗号化 ---\n";
24    echo "元のメッセージ: " . $originalMessage . "\n";
25
26    // 2. ノンセ (Nonce) の生成
27    // ノンセは、一度しか使わないランダムな値で、同じ鍵で複数のメッセージを暗号化する際に必須です。
28    // 各暗号化操作で異なるノンセを使用することで、セキュリティが向上します。
29    // sodium_crypto_secretbox_noncegen() は、適切な長さのノンセを生成します。
30    $nonce = sodium_crypto_secretbox_noncegen();
31    echo "ノンセのバイト数: " . strlen($nonce) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . ")\n";
32    echo "ノンセ (Base64エンコード): " . base64_encode($nonce) . "\n";
33
34    // 3. メッセージの暗号化
35    // sodium_crypto_secretbox() を使用して、メッセージを暗号化します。
36    // 引数: (string $message, string $nonce, string $key)
37    // 戻り値: 暗号化されたメッセージ (string)
38    $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $secretKey);
39    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($encryptedMessage) . "\n\n";
40
41    // 暗号化されたメッセージとノンセは通常、組み合わせて保存または送信されます。
42    // 例として、ノンセと暗号化メッセージを結合し、Base64エンコードして1つの文字列として扱います。
43    $combinedData = base64_encode($nonce . $encryptedMessage);
44    echo "--- 暗号化されたデータの結合 (保存/送信形式) ---\n";
45    echo "結合データ (Base64エンコード): " . $combinedData . "\n\n";
46
47    // 4. メッセージの復号化
48    echo "--- メッセージの復号化 ---\n";
49
50    // 結合されたデータからノンセと暗号化メッセージを分離します。
51    $decodedCombinedData = base64_decode($combinedData);
52    $receivedNonce = substr($decodedCombinedData, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
53    $receivedEncryptedMessage = substr($decodedCombinedData, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
54
55    echo "受信したノンセ (Base64エンコード): " . base64_encode($receivedNonce) . "\n";
56    echo "受信した暗号化メッセージ (Base64エンコード): " . base64_encode($receivedEncryptedMessage) . "\n";
57
58    // sodium_crypto_secretbox_open() を使用して、メッセージを復号化します。
59    // 復号に失敗した場合 (例: キーが異なる、データが改ざんされている)、false を返します。
60    // 引数: (string $encrypted_message, string $nonce, string $key)
61    // 戻り値: 復号されたメッセージ (string) または false
62    $decryptedMessage = sodium_crypto_secretbox_open($receivedEncryptedMessage, $receivedNonce, $secretKey);
63
64    if ($decryptedMessage === false) {
65        echo "エラー: メッセージの復号に失敗しました。キーが異なるか、データが改ざんされた可能性があります。\n";
66    } else {
67        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
68        // 元のメッセージと復号されたメッセージが一致するか確認
69        if ($originalMessage === $decryptedMessage) {
70            echo "検証: 復号されたメッセージは元のメッセージと一致します。\n";
71        } else {
72            echo "検証: 復号されたメッセージは元のメッセージと一致しません！\n";
73        }
74    }
75}
76
77// 関数の実行
78// このコードを実行するには、PHPにlibsodium拡張がインストールされている必要があります。
79if (extension_loaded('sodium')) {
80    encryptAndDecryptSecretBox();
81} else {
82    echo "エラー: libsodium 拡張機能がロードされていません。PHPの設定を確認してください。\n";
83}
84

このサンプルコードは、PHPのlibsodium拡張機能を用いて、対称鍵暗号の基本的な流れをシステムエンジニアを目指す初心者にも分かりやすく解説しています。まず、sodium_crypto_kdf_keygen関数を使用し、引数なしで秘密鍵を生成します。この関数は、sodium_crypto_secretboxで利用可能な長さの安全なバイト列（文字列）を戻り値として返します。

生成された秘密鍵は、メッセージを暗号化・復号化する際に使われます。メッセージの暗号化では、sodium_crypto_secretbox_noncegen関数で一度限りのランダムな値であるノンセを生成し、元のメッセージと秘密鍵、ノンセをsodium_crypto_secretbox関数に渡します。この関数は、暗号化されたメッセージを文字列として返します。

復号化の際には、暗号化されたメッセージ、使用したノンセ、そして同じ秘密鍵をsodium_crypto_secretbox_open関数に渡します。この関数は、正しく復号できた場合に元のメッセージ（文字列）を返し、鍵が異なるなどの理由で失敗した場合はfalseを返します。この一連のプロセスを通じて、鍵の生成からメッセージの暗号化、そして復号化まで、対称鍵暗号の基本原則を実践的に理解することができます。