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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_KDF_KEYBYTES 定数と sodium_crypto_box 関数を組み合わせて使用するサンプルコードです。
5 *
6 * このコードは、システムエンジニアを目指す初心者向けに、公開鍵暗号の基本的な仕組みと、
7 * 鍵導出関数 (KDF) を用いた鍵の派生方法を示します。
8 * sodium_crypto_box で生成される共有シークレットをKDFのマスターキーとして利用する例を含みます。
9 */
10function demonstrateCryptoOperations(): void
11{
12    echo "--- SODIUM_CRYPTO_KDF_KEYBYTES 定数の値 ---" . PHP_EOL;
13    // SODIUM_CRYPTO_KDF_KEYBYTES は、鍵導出関数 (KDF) で派生できる鍵の最大長を示します。
14    echo "SODIUM_CRYPTO_KDF_KEYBYTES: " . SODIUM_CRYPTO_KDF_KEYBYTES . " bytes" . PHP_EOL . PHP_EOL;
15
16    echo "--- sodium_crypto_box (公開鍵暗号) のデモンストレーション ---" . PHP_EOL;
17
18    // 1. アリスとボブの鍵ペアを生成します。
19    // sodium_crypto_box_keypair() は公開鍵と秘密鍵を含む鍵ペアを生成します。
20    $aliceKeypair = sodium_crypto_box_keypair();
21    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair); // アリスの公開鍵
22    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair); // アリスの秘密鍵
23
24    $bobKeypair = sodium_crypto_box_keypair();
25    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);     // ボブの公開鍵
26    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);     // ボブの秘密鍵
27
28    echo "アリスの公開鍵の長さ: " . strlen($alicePublicKey) . " bytes" . PHP_EOL;
29    echo "ボブの公開鍵の長さ: " . strlen($bobPublicKey) . " bytes" . PHP_EOL . PHP_EOL;
30
31    // 2. Diffie-Hellman 鍵交換により、アリスとボブ間で共有シークレットを導出します。
32    // sodium_crypto_box_beforenm() は、相手の公開鍵と自分の秘密鍵から共有シークレットを計算します。
33    $aliceSharedSecret = sodium_crypto_box_beforenm($bobPublicKey, $aliceSecretKey);
34    $bobSharedSecret = sodium_crypto_box_beforenm($alicePublicKey, $bobSecretKey);
35
36    if ($aliceSharedSecret === $bobSharedSecret) {
37        echo "アリスとボブ間で共有シークレットが正常に確立されました。" . PHP_EOL;
38        echo "共有シークレットの長さ: " . strlen($aliceSharedSecret) . " bytes" . PHP_EOL . PHP_EOL;
39    } else {
40        echo "エラー: 共有シークレットの確立に失敗しました。" . PHP_EOL;
41        return;
42    }
43
44    echo "--- KDF (鍵導出関数) による派生鍵の生成と利用 ---" . PHP_EOL;
45
46    // 3. 共有シークレットをマスターキーとして、KDFで新しい鍵を派生させます。
47    // SODIUM_CRYPTO_KDF_KEYBYTES の値を使用して、派生鍵の長さを指定します。
48    // KDFコンテキストは、鍵の用途を区別するための識別子で、一意であるべきです。
49    $kdfContext = random_bytes(SODIUM_CRYPTO_KDF_CONTEXTBYTES);
50
51    $derivedKey = sodium_crypto_kdf_derive_from_key(
52        SODIUM_CRYPTO_KDF_KEYBYTES, // 派生する鍵の長さ
53        1,                         // 鍵のインデックス (同じマスターキーから複数の鍵を導出する場合に利用)
54        $kdfContext,               // KDFコンテキスト
55        $aliceSharedSecret         // マスターキーとして共有シークレットを使用
56    );
57
58    echo "KDFで生成された派生鍵の長さ: " . strlen($derivedKey) . " bytes" . PHP_EOL . PHP_EOL;
59
60    // 4. 派生鍵の利用例として、別の対称鍵暗号 (sodium_crypto_secretbox) でメッセージを暗号化・復号化します。
61    $messageForDerivedKey = "これはKDFで派生した鍵で暗号化されたメッセージです。";
62    // sodium_crypto_secretbox 用の使い捨ての数値 (Nonce) を生成します。
63    $derivedKeyNonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
64
65    $encryptedByDerivedKey = sodium_crypto_secretbox(
66        $messageForDerivedKey,
67        $derivedKeyNonce,
68        $derivedKey
69    );
70    echo "派生鍵で暗号化されたデータ (一部): " . substr(bin2hex($encryptedByDerivedKey), 0, 30) . "..." . PHP_EOL;
71
72    $decryptedByDerivedKey = sodium_crypto_secretbox_open(
73        $encryptedByDerivedKey,
74        $derivedKeyNonce,
75        $derivedKey
76    );
77
78    if ($decryptedByDerivedKey === $messageForDerivedKey) {
79        echo "派生鍵で復号化されたデータ: " . $decryptedByDerivedKey . PHP_EOL . PHP_EOL;
80    } else {
81        echo "エラー: 派生鍵での復号化に失敗しました。" . PHP_EOL . PHP_EOL;
82    }
83
84    echo "--- sodium_crypto_box を使ったメッセージのやり取り ---" . PHP_EOL;
85
86    // 5. sodium_crypto_box を使って、アリスからボブへメッセージを暗号化して送ります。
87    $message = "こんにちは、アリスからボブへの秘密のメッセージです。";
88
89    // sodium_crypto_box 用の使い捨ての数値 (Nonce) を生成します。
90    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
91    // アリスはボブの公開鍵と自分の秘密鍵を使ってメッセージを暗号化します。
92    $cipherText = sodium_crypto_box(
93        $message,
94        $nonce,
95        $bobPublicKey,
96        $aliceSecretKey
97    );
98    echo "アリスが暗号化したデータ (一部): " . substr(bin2hex($cipherText), 0, 30) . "..." . PHP_EOL;
99
100    // 6. ボブがアリスからのメッセージを復号化します。
101    // ボブはアリスの公開鍵と自分の秘密鍵を使ってメッセージを復号化します。
102    $decryptedMessage = sodium_crypto_box_open(
103        $cipherText,
104        $nonce,
105        $alicePublicKey,
106        $bobSecretKey
107    );
108
109    if ($decryptedMessage === $message) {
110        echo "ボブが復号化したデータ: " . $decryptedMessage . PHP_EOL . PHP_EOL;
111    } else {
112        echo "エラー: sodium_crypto_box での復号化に失敗しました。" . PHP_EOL . PHP_EOL;
113    }
114
115    // セキュリティのベストプラクティス: 処理が終わったら機密情報をメモリから消去します。
116    sodium_memzero($aliceKeypair);
117    sodium_memzero($aliceSecretKey);
118    sodium_memzero($bobKeypair);
119    sodium_memzero($bobSecretKey);
120    sodium_memzero($aliceSharedSecret);
121    sodium_memzero($bobSharedSecret);
122    sodium_memzero($derivedKey);
123}
124
125// サンプルコードの実行
126demonstrateCryptoOperations();

このPHPサンプルコードは、公開鍵暗号と鍵導出関数（KDF）の基本的な利用方法を解説しています。SODIUM_CRYPTO_KDF_KEYBYTESは、KDFで派生できる鍵の最大長を整数値で示す定数であり、引数は持ちません。この定数を利用して、安全な鍵の長さを適切に指定します。

まず、sodium_crypto_box_keypair()で通信相手ごとに公開鍵と秘密鍵のペアを生成します。その後、sodium_crypto_box_beforenm()は、相手の公開鍵と自身の秘密鍵を基に、共通の秘密情報（共有シークレット）を安全に導出します。この共有シークレットは、sodium_crypto_kdf_derive_from_key()という鍵導出関数にマスターキーとして渡され、SODIUM_CRYPTO_KDF_KEYBYTESで指定された長さの新しい鍵（派生鍵）が生成されます。この派生鍵は、さらに別の対称鍵暗号などに利用可能です。また、sodium_crypto_box()関数は、直接メッセージを暗号化・復号化する機能も提供し、生成した鍵ペアを使って安全なメッセージのやり取りを実現します。処理後は、セキュリティ上の理由からsodium_memzero()で機密情報をメモリから消去しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * libsodiumのsodium_crypto_secretbox関数を使用して、メッセージを安全に暗号化および復号化します。
7 *
8 * この関数は、共有秘密鍵による認証付き暗号を提供し、メッセージの機密性と完全性を保証します。
9 * PHP 8では、sodium拡張機能が標準で利用可能です。
10 *
11 * @param string $message 暗号化する平文メッセージ
12 */
13function handleSecretBoxEncryption(string $message): void
14{
15    // 秘密鍵を生成します。
16    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES は、sodium_crypto_secretbox に必要な鍵のバイト長を定義する定数です。
17    $key = sodium_crypto_secretbox_keygen();
18
19    // ノンス（Number used once）を生成します。
20    // 各暗号化操作で異なるノンスを使用することがセキュリティ上極めて重要です。
21    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、sodium_crypto_secretbox に必要なノンスのバイト長を定義する定数です。
22    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
23
24    echo "元のメッセージ: " . $message . PHP_EOL;
25
26    // メッセージを暗号化します。
27    $encryptedMessage = sodium_crypto_secretbox($message, $nonce, $key);
28    echo "暗号化されたメッセージ (base64エンコード): " . base64_encode($encryptedMessage) . PHP_EOL;
29
30    // 暗号化されたメッセージを復号化します。
31    // 復号化には同じ鍵とノンスが必要です。
32    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
33
34    if ($decryptedMessage !== false) {
35        echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
36        if ($decryptedMessage === $message) {
37            echo "✅ 暗号化と復号化が成功し、元のメッセージと一致しました。" . PHP_EOL;
38        } else {
39            echo "❌ エラー: 復号化されたメッセージが元のメッセージと一致しません。" . PHP_EOL;
40        }
41    } else {
42        echo "❌ エラー: メッセージの復号化に失敗しました。認証タグが不正である可能性があります。" . PHP_EOL;
43    }
44}
45
46// サンプルコードを実行
47handleSecretBoxEncryption("こんにちは、システムエンジニアを目指す皆さん！セキュリティは大切です。");

このサンプルコードは、PHP 8で利用できるlibsodium拡張機能を使って、メッセージを安全に暗号化および復号化する方法を示しています。認証付き暗号であるsodium_crypto_secretbox関数を利用することで、メッセージの機密性（内容が漏れないこと）と完全性（改ざんされていないこと）を同時に保証します。

まず、メッセージの暗号化には、sodium_crypto_secretbox_keygen()関数で秘密鍵を生成します。この鍵の適切なバイト長は、SODIUM_CRYPTO_SECRETBOX_KEYBYTES定数によって定義されています。次に、各暗号化操作ごとに異なる「ノンス（Number used once）」を生成します。これはrandom_bytes()関数とSODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数で指定されるバイト長を用いて作成され、セキュリティ上極めて重要です。

sodium_crypto_secretbox関数は、元のメッセージ、生成したノンス、秘密鍵を引数として受け取り、暗号化されたメッセージを返します。この暗号化されたメッセージは、元の内容だけでなく、メッセージが改ざんされていないことを確認するための情報も含まれています。

復号化にはsodium_crypto_secretbox_open関数を使用します。この関数には、暗号化されたメッセージ、暗号化時に使用したノンス、そして秘密鍵を引数として渡します。復号に成功すると元のメッセージが戻り値として返され、もしメッセージが改ざんされていたり、鍵やノンスが異なったりした場合はfalseが返されます。

なお、提供されたリファレンス情報にあるSODIUM_CRYPTO_KDF_KEYBYTESは、鍵導出関数（KDF）で使われる鍵のバイト長を定義する定数であり、本サンプルコードでは直接使用されていませんが、libsodiumにおける別の暗号化処理で重要な役割を果たす定数の一つです。