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

Copy
1<?php
2
3// PHP Sodium とは、PHPに組み込まれているlibsodiumライブラリへのバインディングです。
4// 高度な暗号化プリミティブを提供し、鍵交換（Key Exchange: KX）、暗号化、デジタル署名などの
5// セキュリティ機能を安全かつ容易にアプリケーションに組み込むことができます。
6// このサンプルコードでは、鍵交換プロトコルのサーバー側処理に焦点を当てています。
7
8// 1. サーバー側の鍵ペアを生成します。
9// sodium_crypto_kx_keypair() は、Diffie-Hellman鍵交換に使用する公開鍵と秘密鍵を含む鍵ペアを生成します。
10// この鍵ペアは、サーバーが自身を認証し、クライアントとの安全な通信チャネルを確立するために使用されます。
11$serverKeyPair = sodium_crypto_kx_keypair();
12$serverPublicKey = sodium_crypto_kx_publickey($serverKeyPair);
13
14echo "--- サーバー側の情報 ---\n";
15echo "サーバー公開鍵 (Base64エンコード): " . base64_encode($serverPublicKey) . "\n\n";
16
17// 2. クライアント側の鍵ペアをシミュレートし、その公開鍵を取り出します。
18// 実際のアプリケーションでは、クライアントは自身の鍵ペアを生成し、
19// その公開鍵をサーバーに送信します。ここではその状況をシミュレートします。
20$clientKeyPair = sodium_crypto_kx_keypair();
21$clientPublicKey = sodium_crypto_kx_publickey($clientKeyPair);
22
23echo "--- クライアント側の情報 (シミュレーション) ---\n";
24echo "クライアント公開鍵 (Base64エンコード): " . base64_encode($clientPublicKey) . "\n\n";
25
26// 3. サーバー側でセッション鍵を導出します。
27// sodium_crypto_kx_server_session_keys() は、サーバーの鍵ペアとクライアントの公開鍵から、
28// 双方向の安全な通信に使用するセッション鍵（送信用と受信用）を生成します。
29// これらのセッション鍵は、その後のメッセージの暗号化や復号化に利用されます。
30//
31// 引数:
32//   $server_key_pair: サーバーの鍵ペア（string型、バイナリデータ）
33//   $client_key: クライアントの公開鍵（string型、バイナリデータ）
34// 戻り値:
35//   ['rx' => 受信用セッション鍵, 'tx' => 送信用セッション鍵] の連想配列 (array型)
36try {
37    $sessionKeys = sodium_crypto_kx_server_session_keys(
38        $serverKeyPair,
39        $clientPublicKey
40    );
41
42    $serverRx = $sessionKeys['rx']; // クライアントからサーバーへのメッセージを復号化するための鍵
43    $serverTx = $sessionKeys['tx']; // サーバーからクライアントへのメッセージを暗号化するための鍵
44
45    echo "--- サーバー側で導出されたセッション鍵 ---\n";
46    echo "サーバー受信鍵 (Rx, Base64エンコード): " . base64_encode($serverRx) . "\n";
47    echo "サーバー送信鍵 (Tx, Base64エンコード): " . base64_encode($serverTx) . "\n\n";
48
49    // 補足:
50    // クライアント側では sodium_crypto_kx_client_session_keys() を使用してセッション鍵を導出します。
51    // クライアント側で導出される送信鍵は、サーバー側で導出された受信鍵と一致し、
52    // クライアント側で導出される受信鍵は、サーバー側で導出された送信鍵と一致します。
53    // これにより、クライアントとサーバー間で安全な双方向通信が可能になります。
54
55} catch (SodiumException $e) {
56    // 鍵の形式が不正な場合などにSodiumExceptionが発生する可能性があります。
57    echo "エラー: " . $e->getMessage() . "\n";
58}
59
60// 導出されたセッション鍵 ($serverRx, $serverTx) は、通常、
61// sodium_crypto_aead_aes256gcm_encrypt のような関数を使って、
62// メッセージの暗号化と認証に利用されます。
63// これらの鍵は機密情報であり、安全に管理する必要があります。
64// PHPのスクリプト終了時には、これらの鍵は自動的にメモリからクリアされます。
65
66?>

PHP Sodiumは、PHPで高度な暗号化機能を提供する拡張モジュールです。このサンプルコードは、安全な通信チャネル確立のための鍵交換プロトコルにおいて、サーバー側でセッション鍵を導出する方法を示しています。

sodium_crypto_kx_server_session_keys関数は、サーバーの鍵ペアとクライアントの公開鍵を用いて、双方向の安全な通信に必要なセッション鍵を生成します。引数には、サーバー自身の鍵ペア（string $server_key_pair）と、クライアントから受け取った公開鍵（string $client_key）を指定します。

戻り値はarray型で、['rx' => 受信用セッション鍵, 'tx' => 送信用セッション鍵]という連想配列です。rx鍵はクライアントからサーバーへのメッセージを復号化、tx鍵はサーバーからクライアントへのメッセージを暗号化するために使用されます。

サンプルでは、サーバーの鍵ペア生成とクライアント公開鍵の受け取りをシミュレートし、本関数でセッション鍵を導出しています。これらの鍵はメッセージの暗号化・復号化に利用され、機密性の高い通信を実現します。クライアント側もsodium_crypto_kx_client_session_keys関数で鍵を導出し、サーバーと相互に一致させることで安全な通信が可能になります。これらの鍵は厳重に管理が必要です。

Copy
1<?php
2
3// このスクリプトは、PHPのSodium拡張機能が有効になっている環境で動作します。
4// Sodiumは、モダンな暗号化機能を提供するライブラリです。
5
6/**
7 * Sodiumの鍵交換 (Key Exchange: KX) プロトコルを使って、
8 * サーバー側でセッション鍵を生成するシンプルな例です。
9 *
10 * sodium_crypto_kx_server_session_keys 関数は、サーバー自身の鍵ペアと
11 * クライアントから受け取った公開鍵を使って、安全な通信のための
12 * 共有セッション鍵（受信鍵と送信鍵）を導出します。
13 *
14 * @return void
15 */
16function demonstrateSodiumKxServerSessionKeys(): void
17{
18    echo "=== Sodium 鍵交換 (KX) プロトコルのサーバー側デモンストレーション ===\n\n";
19
20    // 1. サーバー自身の鍵ペアを生成します。
21    // 実際には、この鍵ペアはサーバー側で安全に生成され、永続的に保持されます。
22    // sodium_crypto_kx_keypair() は公開鍵と秘密鍵の両方を含む鍵ペアを生成します。
23    $serverKeyPair = sodium_crypto_kx_keypair();
24    echo "1. サーバーの鍵ペアを生成しました。\n";
25
26    // サーバーの公開鍵を抽出します。
27    // この公開鍵は、クライアントに安全に共有されます。（例: TLSハンドシェイクの一部として）
28    $serverPublicKey = sodium_crypto_kx_publickey($serverKeyPair);
29    echo "   サーバーの公開鍵: " . bin2hex($serverPublicKey) . "\n\n";
30
31    // --- ここからクライアント側の動作をシミュレートします ---
32    // 実際には、クライアントは自身の鍵ペアを生成し、サーバーに公開鍵を送ります。
33    $clientKeyPair = sodium_crypto_kx_keypair();
34    $clientPublicKey = sodium_crypto_kx_publickey($clientKeyPair);
35    echo "2. （クライアント側をシミュレート）クライアントの鍵ペアを生成しました。\n";
36    echo "   （クライアント側をシミュレート）クライアントの公開鍵: " . bin2hex($clientPublicKey) . "\n\n";
37    // --- クライアント側のシミュレーション終了 ---
38
39    // 3. サーバー側でセッション鍵を導出します。
40    // sodium_crypto_kx_server_session_keys 関数を使用します。
41    //
42    // 引数:
43    //   - $serverKeyPair: サーバー自身の完全な鍵ペア（公開鍵と秘密鍵を含む）
44    //   - $clientPublicKey: クライアントから受け取った公開鍵
45    //
46    // 戻り値:
47    //   - array: 共有セッション鍵を含む配列。
48    //     - 'rx' (shared receive key): クライアントから受信するメッセージを復号化する際に使用する鍵。
49    //     - 'tx' (shared transmit key): クライアントへ送信するメッセージを暗号化する際に使用する鍵。
50    $sessionKeys = sodium_crypto_kx_server_session_keys(
51        $serverKeyPair,
52        $clientPublicKey
53    );
54
55    $sharedRxKey = $sessionKeys['rx']; // サーバーがクライアントからのメッセージを受信する際の鍵
56    $sharedTxKey = $sessionKeys['tx']; // サーバーがクライアントへメッセージを送信する際の鍵
57
58    echo "3. サーバー側でセッション鍵を導出しました。\n";
59    echo "   共有受信鍵 (rx): " . bin2hex($sharedRxKey) . "\n";
60    echo "   共有送信鍵 (tx): " . bin2hex($sharedTxKey) . "\n\n";
61
62    echo "これらの鍵は、このセッションに限り、クライアントとの安全な通信（暗号化と復号化）に使用されます。\n";
63    echo "例えば、sodium_crypto_secretbox_open() や sodium_crypto_secretbox() と組み合わせて使用できます。\n";
64
65    // 補足: クライアント側で導出されるセッション鍵は、サーバーのセッション鍵と対になります。
66    // つまり、サーバーの共有受信鍵はクライアントの共有送信鍵と同じであり、
67    // サーバーの共有送信鍵はクライアントの共有受信鍵と同じになります。
68}
69
70// 関数を実行してデモンストレーションを開始します。
71demonstrateSodiumKxServerSessionKeys();
72
73?>

PHP 8のSodium拡張機能は、モダンで安全な暗号化機能を提供するライブラリです。sodium_crypto_kx_server_session_keys関数は、鍵交換（Key Exchange: KX）プロトコルを利用し、サーバー側でクライアントとの安全な通信のための共有セッション鍵を生成する際に使用されます。

この関数は、第一引数にサーバー自身の完全な鍵ペア（秘密鍵と公開鍵を含む）を、第二引数にはクライアントから受け取った公開鍵を指定します。これらの鍵情報をもとに、サーバーとクライアント間でのみ有効な、セッション固有の暗号化鍵を導出します。

戻り値は配列形式で、サーバーがクライアントからのメッセージを受信する際に使用する共有受信鍵（rx）と、クライアントへメッセージを送信する際に使用する共有送信鍵（tx）の二つの鍵が含まれます。これらの鍵は、セッション期間中に通信内容を暗号化・復号化し、秘匿性を確保するために用いられます。

サンプルコードでは、まずサーバーとクライアント（シミュレーション）の鍵ペアをそれぞれ生成しています。その後、サーバーの鍵ペアとクライアントの公開鍵をsodium_crypto_kx_server_session_keys関数に渡すことで、安全な送受信のためのセッション鍵が導出される過程を示しています。これにより生成された鍵は、そのセッション中、他のSodium暗号化関数と組み合わせてデータの機密性を保護するために利用されます。