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

Copy
1<?php
2
3/**
4 * Libsodiumの公開鍵暗号 (Authenticated Encryption using Public Keys) を用いた
5 * メッセージの暗号化と復号のデモンストレーションを行います。
6 *
7 * この関数は、キーワードとして指定された `sodium_crypto_box` の基本的な使い方を中心に解説します。
8 * リファレンス情報に指定された定数 `SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL` は、
9 * Libsodiumのストリーム暗号機能で使用されるもので、`sodium_crypto_box` とは直接関連はありませんが、
10 * リファレンス情報の一部としてコード内にその存在を示しています。
11 */
12function demonstrateCryptoBoxEncryption(): void
13{
14    // リファレンス情報に指定された定数。
15    // この定数は、LibSodiumの秘密ストリーム暗号において、
16    // ストリームの最終チャンクをマークするために使用されます。
17    // `sodium_crypto_box` の文脈では直接使用されません。
18    // 必要であれば、以下の行のコメントを外して定数の値を確認できます。
19    // var_dump(SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL);
20
21    echo "--- Libsodium 公開鍵暗号 (sodium_crypto_box) のデモンストレーション ---\n\n";
22
23    // 1. AliceとBobのキーペア（公開鍵と秘密鍵の組）をそれぞれ生成します。
24    // 各キーペアは、そのユーザー専用の公開鍵と秘密鍵を含みます。
25    $aliceKeypair = sodium_crypto_box_keypair();
26    $bobKeypair = sodium_crypto_box_keypair();
27
28    // 各キーペアから公開鍵と秘密鍵を分離して取得します。
29    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
30    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
31    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
32    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
33
34    echo "キーペア生成完了。\n";
35
36    // 2. AliceがBobに送る秘密のメッセージを準備します。
37    $message = 'Hello Bob, this is a secret message from Alice. Please keep it safe!';
38    echo "元のメッセージ: \"{$message}\"\n";
39
40    // 3. ナンス (Nonce: Number used once) を生成します。
41    // ナンスは、暗号化ごとに異なるユニークな値である必要があります。
42    // 同じ鍵で複数のメッセージを暗号化する場合でも、各暗号文が
43    // 異なるものとなるように保証する役割があります。
44    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
45    echo "ナンス生成完了 (サイズ: " . strlen($nonce) . " バイト)。\n";
46
47    // 4. AliceがBobの公開鍵と自身の秘密鍵を使ってメッセージを暗号化します。
48    // `sodium_crypto_box` 関数は、メッセージを暗号化し、かつそのメッセージが
49    // Aliceによって送信されたことを Bob が検証できるように署名も行います。
50    $cipherText = sodium_crypto_box($message, $nonce, $bobPublicKey, $aliceSecretKey);
51
52    if ($cipherText === false) {
53        echo "エラー: メッセージの暗号化に失敗しました。\n";
54        return;
55    }
56    echo "メッセージを暗号化しました。暗号文サイズ: " . strlen($cipherText) . " バイト。\n";
57
58    // 5. BobがAliceの公開鍵と自身の秘密鍵を使ってメッセージを復号します。
59    // `sodium_crypto_box_open` 関数は、メッセージの復号を試み、
60    // かつメッセージがAliceから来ており、改ざんされていないことを検証します。
61    // 復号には、暗号文、同じナンス、送信者（Alice）の公開鍵、
62    // そして受信者（Bob）の秘密鍵が必要です。
63    $decryptedMessage = sodium_crypto_box_open($cipherText, $nonce, $alicePublicKey, $bobSecretKey);
64
65    if ($decryptedMessage === false) {
66        echo "エラー: 復号に失敗しました。メッセージが改ざんされたか、キーまたはナンスが間違っています。\n";
67    } else {
68        echo "メッセージを復号しました。復号されたメッセージ: \"{$decryptedMessage}\"\n";
69
70        if ($decryptedMessage === $message) {
71            echo "結果: 元のメッセージと復号されたメッセージは一致します。安全な通信が確立されました。\n";
72        } else {
73            echo "結果: 元のメッセージと復号されたメッセージが一致しませんでした。何らかの問題が発生した可能性があります。\n";
74        }
75    }
76    echo "\n------------------------------------------------------------------\n";
77}
78
79// 関数を実行してデモンストレーションを開始します。
80demonstrateCryptoBoxEncryption();

PHP 8のLibSodium拡張機能は、安全な暗号化通信を実現するための強力な機能を提供します。このサンプルコードは、公開鍵暗号を用いたメッセージの暗号化と復号を行うsodium_crypto_box関数の基本的な使い方を示しています。

まず、通信を行う双方（例：AliceとBob）がそれぞれ公開鍵と秘密鍵のペアを生成します。sodium_crypto_box_keypair()でキーペアを生成し、sodium_crypto_box_publickey()とsodium_crypto_box_secretkey()を用いることで、それぞれの公開鍵と秘密鍵を取り出すことができます。

メッセージを暗号化する際には、sodium_crypto_box(メッセージ, ナンス, 受信者の公開鍵, 送信者の秘密鍵)を使用します。ここでナンス（Number used once）は、暗号化ごとに異なるユニークな値であり、random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES)で生成されます。この関数は、メッセージを暗号化するだけでなく、送信者が誰であるかを証明する署名も同時に行い、暗号文を返します。暗号化に失敗した場合はfalseが戻り値となります。

次に、暗号文を復号するにはsodium_crypto_box_open(暗号文, ナンス, 送信者の公開鍵, 受信者の秘密鍵)を使用します。この関数は、メッセージの復号を試み、かつメッセージが改ざんされていないか、指定された送信者から送られたものかを検証します。復号に成功すると元のメッセージを返し、失敗した場合はfalseを返します。

リファレンス情報に記載されたSODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL定数は、LibSodiumの秘密ストリーム暗号機能でストリームの最終チャンクを示すために用いられるものであり、sodium_crypto_boxとは直接関連しません。

Copy
1<?php
2
3/**
4 * 秘密メッセージを認証付きで暗号化・復号化するデモンストレーション。
5 * sodium_crypto_secretbox 関数を使用します。
6 *
7 * リファレンス情報で指定された定数 SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL は、
8 * sodium_crypto_secretbox とは異なるストリーム暗号化機能の定数ですが、
9 * どちらもPHPのSodium拡張モジュールに属します。
10 * このサンプルコードは、キーワードとして与えられた sodium_crypto_secretbox の使用方法に焦点を当てています。
11 */
12function demonstrateSecretboxEncryption(): void
13{
14    // PHPにSodium拡張がインストールされ、有効になっているかを確認します。
15    // この拡張は、暗号化機能を提供します。
16    if (!extension_loaded('sodium')) {
17        echo 'エラー: Sodium拡張がインストールされていないか、有効になっていません。' . PHP_EOL;
18        return;
19    }
20
21    echo "--- sodium_crypto_secretbox によるメッセージの暗号化と復号化 ---" . PHP_EOL;
22
23    // 1. 暗号化に使用する秘密鍵を生成します。
24    // この鍵は32バイト長で、安全に生成され、送信側と受信側で共有される必要があります。
25    // 実際のアプリケーションでは、この鍵の管理は非常に重要です。
26    $key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
27    echo '生成された秘密鍵 (Base64エンコード): ' . base64_encode($key) . PHP_EOL;
28
29    // 2. 暗号化する元のメッセージを定義します。
30    $originalMessage = 'これは外部に漏らしたくない秘密のメッセージです。';
31    echo '元のメッセージ: ' . $originalMessage . PHP_EOL;
32
33    // 3. ノンス（Nonce - Number used once）を生成します。
34    // ノンスは各暗号化操作で一意である必要がありますが、秘密にする必要はありません。
35    // 暗号文と一緒に安全でないチャネルで送信できます。
36    // 再利用されるとセキュリティ上の問題が発生します。
37    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
38    echo '生成されたノンス (Base64エンコード): ' . base64_encode($nonce) . PHP_EOL;
39
40    // 4. メッセージを暗号化します。
41    // sodium_crypto_secretbox は、メッセージ、ノンス、キーを受け取り、認証付きの暗号文を返します。
42    $ciphertext = sodium_crypto_secretbox($originalMessage, $nonce, $key);
43    echo '暗号化されたメッセージ (Base64エンコード): ' . base64_encode($ciphertext) . PHP_EOL;
44
45    echo PHP_EOL . "--- 復号化の処理 ---" . PHP_EOL;
46
47    // 5. 暗号文を復号化します。
48    // 復号化には、暗号文、元のノンス、元のキーが必要です。
49    // キーまたはノンスが間違っている場合、あるいは暗号文が改ざんされている場合、
50    // sodium_crypto_secretbox_open は false を返します。
51    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
52
53    if ($decryptedMessage === false) {
54        echo 'エラー: メッセージの復号化に失敗しました。' . PHP_EOL;
55        echo 'キー、ノンス、または暗号文が不正である可能性があります。' . PHP_EOL;
56    } else {
57        echo '復号化されたメッセージ: ' . $decryptedMessage . PHP_EOL;
58
59        // 復号化されたメッセージが元のメッセージと一致するか確認します。
60        if ($decryptedMessage === $originalMessage) {
61            echo '結果: 復号化は成功し、元のメッセージと完全に一致しました。' . PHP_EOL;
62        } else {
63            echo '結果: 復号化されたメッセージが元のメッセージと異なります。エラーが発生しました。' . PHP_EOL;
64        }
65    }
66}
67
68// 定義した暗号化・復号化のデモンストレーション関数を実行します。
69demonstrateSecretboxEncryption();

このPHPサンプルコードは、Sodium拡張モジュールを利用して、秘密のメッセージを認証付きで暗号化し、復号化する方法をデモンストレーションしています。システムエンジニアにとって、データの安全な取り扱いは非常に重要です。

まず、sodium_crypto_secretbox関数は、指定された秘密鍵とノンス（一意の使い捨て番号）を使ってメッセージを暗号化します。引数として、暗号化したい文字列メッセージ、各暗号化操作で異なるノンス、そして送信者と受信者が共有する秘密鍵（32バイト）を受け取ります。これにより、改ざん検出機能を備えた暗号文（文字列）が戻り値として生成されます。

次に、暗号化されたメッセージを元の状態に戻すには、sodium_crypto_secretbox_open関数を使用します。この関数は、暗号文、暗号化に使用された同じノンス、そして同じ秘密鍵を引数として受け取ります。復号化に成功した場合、元のメッセージ（文字列）が戻り値として返されます。もし鍵やノンスが間違っている場合、または暗号文が改ざんされていた場合は、メッセージの認証に失敗し、falseが返されるため、不正なデータではないかを確認できます。

リファレンス情報にあるSODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINALは別のストリーム暗号化機能の定数ですが、どちらも強力な暗号化を提供するPHPのSodium拡張に属します。本サンプルでは、個別のメッセージ暗号化に適したsodium_crypto_secretboxの基本的な利用法を紹介しています。