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

Copy
1<?php
2
3/**
4 * Libsodiumの公開鍵暗号 (Box) を使用してメッセージを安全に送受信するデモンストレーションを行います。
5 *
6 * SODIUM_CRYPTO_KX_SESSIONKEYBYTES は鍵交換のセッションキーのバイト数を示す定数です。
7 * この定数自体は sodium_crypto_box 関数の直接の引数ではありませんが、
8 * Libsodium 拡張機能が提供するセキュリティ関連の重要な定数の一つとして参照されます。
9 */
10function demonstrateSodiumCryptoBoxCommunication(): void
11{
12    echo "--- Libsodium crypto_box デモンストレーション ---\n\n";
13
14    // 1. Alice と Bob の鍵ペアを生成します。
15    // crypto_box は Diffie-Hellman 鍵交換をベースとしたハイブリッド暗号化を提供します。
16    $aliceKeypair = sodium_crypto_box_keypair();
17    $bobKeypair = sodium_crypto_box_keypair();
18
19    // 鍵ペアから秘密鍵と公開鍵を抽出します。
20    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
21    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
22    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
23    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
24
25    echo "・Alice と Bob の鍵ペアが生成されました。\n";
26    echo "  (公開鍵長: " . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . " バイト, 秘密鍵長: " . SODIUM_CRYPTO_BOX_SECRETKEYBYTES . " バイト)\n\n";
27
28    // 2. ノンス（Nonce: 使い捨ての数）を生成します。
29    // ノンスは暗号化ごとにユニークである必要があり、予測不可能性が求められます。
30    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
31    echo "・ノンスが生成されました (長さ: " . SODIUM_CRYPTO_BOX_NONCEBYTES . " バイト)。\n\n";
32
33    // 3. 暗号化するメッセージを定義します。
34    $message = "こんにちは、Bob！これはAliceからの秘密のメッセージです。PHP初心者です。";
35    echo "・元のメッセージ: \"{$message}\"\n\n";
36
37    // 4. AliceがBobの公開鍵と自身の秘密鍵を使ってメッセージを暗号化します。
38    // sodium_crypto_box(メッセージ, ノンス, 共有鍵)
39    // ここでいう共有鍵は、Aliceの秘密鍵とBobの公開鍵から内部的に生成されます。
40    $encryptedMessage = sodium_crypto_box(
41        $message,
42        $nonce,
43        sodium_crypto_box_keypair_from_secretkey_and_publickey($aliceSecretKey, $bobPublicKey)
44    );
45    echo "・メッセージが暗号化されました (長さ: " . strlen($encryptedMessage) . " バイト)。\n\n";
46
47    // 5. Bobが自身の秘密鍵とAliceの公開鍵を使ってメッセージを復号化します。
48    // sodium_crypto_box_open(暗号化されたメッセージ, ノンス, 共有鍵)
49    // ここでいう共有鍵は、Bobの秘密鍵とAliceの公開鍵から内部的に生成されます。
50    $decryptedMessage = sodium_crypto_box_open(
51        $encryptedMessage,
52        $nonce,
53        sodium_crypto_box_keypair_from_secretkey_and_publickey($bobSecretKey, $alicePublicKey)
54    );
55
56    if ($decryptedMessage === false) {
57        echo "・メッセージの復号化に失敗しました！\n";
58    } else {
59        echo "・復号化されたメッセージ: \"{$decryptedMessage}\"\n\n";
60    }
61
62    // SODIUM_CRYPTO_KX_SESSIONKEYBYTES 定数の値を表示します。
63    // これは Libsodium が提供する鍵交換プロトコル (Key Exchange) で生成される
64    // セッションキーのバイト数を示します。
65    // sodium_crypto_box は Diffie-Hellman を内部で行いますが、これはより低レベルな
66    // 鍵交換API (sodium_crypto_kx_*) で使用されるセッションキーの長さを表します。
67    echo "--- Libsodium 定数の情報 ---\n";
68    echo "SODIUM_CRYPTO_KX_SESSIONKEYBYTES (鍵交換セッションキーのバイト数): " . SODIUM_CRYPTO_KX_SESSIONKEYBYTES . " バイト\n";
69    echo "（Libsodium 拡張が提供するセキュリティ関連の定数の一例です）\n";
70}
71
72// デモンストレーションを実行します。
73demonstrateSodiumCryptoBoxCommunication();

このPHPサンプルコードは、Libsodium拡張機能が提供するsodium_crypto_box関数を用いて、安全なメッセージの送受信を実演します。sodium_crypto_boxは、公開鍵暗号方式の一つであるDiffie-Hellman鍵交換を基盤とし、メッセージの暗号化と復号化を行います。

コードではまず、AliceとBobの鍵ペア（公開鍵と秘密鍵）をそれぞれ生成します。次に、暗号化ごとにユニークである必要があるノンス（使い捨ての数値）を用意します。Aliceは自身の秘密鍵とBobの公開鍵を利用してメッセージを暗号化し、その暗号化されたメッセージとノンスをBobに送信します。Bobは受け取った暗号化メッセージとノンスを、自身の秘密鍵とAliceの公開鍵を使って復号化し、元のメッセージを取り出します。sodium_crypto_box関数はメッセージとノンス、そして鍵ペアから生成される共有鍵を受け取り、暗号化または復号化を実行します。

本サンプルコードの最後に示されている定数SODIUM_CRYPTO_KX_SESSIONKEYBYTESは、Libsodiumの鍵交換 (Key Exchange: KX) プロトコルで生成されるセッションキーのバイト数を示します。この定数自体はsodium_crypto_box関数の直接の引数ではありませんが、Libsodiumが提供するセキュリティ関連の重要な定数の一つです。引数はありませんが、その値がセキュリティ上の重要な情報を示します。

Copy
1<?php
2
3/**
4 * libsodiumのSODIUM_CRYPTO_KX_SESSIONKEYBYTES定数と
5 * sodium_crypto_secretbox関数の基本的な使用方法を示すサンプルコードです。
6 *
7 * SODIUM_CRYPTO_KX_SESSIONKEYBYTESはキー交換で使われるセッションキーのバイト長を示し、
8 * sodium_crypto_secretboxは共有シークレットキーを使った認証付き暗号化に使用されます。
9 * 両者は異なるコンテキストのキーですが、共通して「キーの長さ」という概念を持ちます。
10 */
11function demonstrateSodiumCryptographicOperations(): void
12{
13    // libsodium拡張が有効か確認します。
14    if (!extension_loaded('sodium')) {
15        echo "エラー: 'sodium' 拡張機能がロードされていません。PHPの設定を確認してください。\n";
16        return;
17    }
18
19    // SODIUM_CRYPTO_KX_SESSIONKEYBYTES定数の値を出力します。
20    // これはキー交換プロトコルで生成されるセッションキーの推奨されるバイト長です。
21    echo "SODIUM_CRYPTO_KX_SESSIONKEYBYTES (キー交換セッションキー長): "
22         . SODIUM_CRYPTO_KX_SESSIONKEYBYTES . " バイト\n";
23
24    // sodium_crypto_secretboxで利用するキーのバイト長を出力します。
25    // この定数とSODIUM_CRYPTO_KX_SESSIONKEYBYTESは異なる値であることに注意してください。
26    echo "SODIUM_CRYPTO_SECRETBOX_KEYBYTES (SecretBoxキー長): "
27         . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト\n\n";
28
29    echo "--- sodium_crypto_secretbox の使用例 ---\n";
30
31    // 1. 共有シークレットキーの生成
32    // sodium_crypto_secretboxには、SODIUM_CRYPTO_SECRETBOX_KEYBYTESで定義された長さのキーが必要です。
33    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
34    echo "生成された共有シークレットキー (HEX): " . bin2hex($key) . "\n";
35    echo "キーの長さ: " . strlen($key) . " バイト\n";
36
37    // 2. 暗号化するオリジナルのメッセージ
38    $originalMessage = "システムエンジニアを目指す皆様、頑張りましょう！";
39    echo "元のメッセージ: " . $originalMessage . "\n";
40
41    // 3. ナンス (Nonce: Number Used Once) の生成
42    // ナンスは、同じキーで暗号化するたびに異なる値である必要があります。
43    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTESで定義された長さで生成します。
44    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
45    echo "生成されたナンス (HEX): " . bin2hex($nonce) . "\n";
46    echo "ナンスの長さ: " . strlen($nonce) . " バイト\n";
47
48    // 4. メッセージの暗号化
49    // sodium_crypto_secretboxは、メッセージ、ナンス、キーを使って暗号文（と認証タグ）を生成します。
50    $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $key);
51    echo "暗号化されたメッセージ (HEX): " . bin2hex($encryptedMessage) . "\n";
52    echo "暗号化メッセージの長さ: " . strlen($encryptedMessage) . " バイト\n";
53
54    // 5. 暗号文の復号化
55    // sodium_crypto_secretbox_openは、暗号文、ナンス、キーを使って元のメッセージを復号します。
56    // キーやナンスが間違っている、またはメッセージが改ざんされている場合は false を返します。
57    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
58
59    if ($decryptedMessage === false) {
60        echo "復号化に失敗しました。キー、ナンス、または暗号文が間違っている可能性があります。\n";
61    } else {
62        echo "復号化されたメッセージ: " . $decryptedMessage . "\n";
63    }
64}
65
66// サンプルコードを実行します。
67demonstrateSodiumCryptographicOperations();
68

SODIUM_CRYPTO_KX_SESSIONKEYBYTESは、PHPのsodium拡張機能で提供される定数です。これは、安全な通信を行うためのキー交換プロトコルにおいて、セッションキーとして推奨されるバイト長を示します。定数であるため、特定の引数を取ったり、値を返したりすることはありません。

一方、sodium_crypto_secretbox関数は、共有シークレットキーを用いてメッセージを認証付きで暗号化する際に使用されます。この関数は、暗号化したいメッセージ、一度だけ使うランダムな値であるナンス、そして事前に共有されたシークレットキーの三つの引数を取ります。具体的には、第一引数に$messageとして暗号化対象の文字列、第二引数に$nonceとして各暗号化操作でユニークであるべき乱数、第三引数に$keyとして共有済みの秘密鍵を指定します。

処理に成功すると、暗号化されたデータと認証タグを含む文字列が戻り値として返されます。もし、何らかの理由で暗号化処理が失敗した場合は、falseが返されます。この暗号化されたデータは、対応するsodium_crypto_secretbox_open関数を使用し、同じナンスとキーを渡すことで元のメッセージに復号できます。SODIUM_CRYPTO_KX_SESSIONKEYBYTESとsodium_crypto_secretboxで利用されるキーの長さは異なる文脈で使われるため、混同しないよう注意が必要です。