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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_SEALBYTES 定数と sodium_crypto_box_seal 関数の利用例を示します。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * libsodium拡張機能におけるメッセージの暗号化時のオーバーヘッドを簡潔に示します。
8 */
9function demonstrateSodiumCryptoBoxSealBytes(): void
10{
11    // SODIUM_CRYPTO_BOX_SEALBYTES は、sodium_crypto_box_seal() でメッセージを暗号化する際に
12    // 元のメッセージに追加されるオーバーヘッド（付加情報）のバイト数を定義する定数です。
13    // このオーバーヘッドには、一時的な公開鍵と認証タグが含まれます。
14    echo "SODIUM_CRYPTO_BOX_SEALBYTES の値: " . SODIUM_CRYPTO_BOX_SEALBYTES . " バイト\n\n";
15
16    // 受信者の鍵ペアを生成します。
17    // sodium_crypto_box_seal() 関数は、この受信者の公開鍵を使ってメッセージを暗号化します。
18    $recipientKeyPair = sodium_crypto_box_keypair();
19    $recipientPublicKey = sodium_crypto_box_publickey($recipientKeyPair);
20
21    // 暗号化する元のメッセージを準備します。
22    $originalMessage = "これは機密情報です。第三者には読まれないように暗号化します。";
23    echo "元のメッセージ: " . $originalMessage . "\n";
24    echo "元のメッセージのバイト長: " . strlen($originalMessage) . " バイト\n\n";
25
26    // sodium_crypto_box_seal() を使ってメッセージを暗号化します。
27    // 生成される暗号文は、元のメッセージのバイト長に SODIUM_CRYPTO_BOX_SEALBYTES 分のデータが追加された長さになります。
28    $sealedMessage = sodium_crypto_box_seal($originalMessage, $recipientPublicKey);
29
30    // 暗号化されたメッセージはバイナリデータなので、一部をBase64エンコードして表示します。
31    echo "暗号化されたメッセージ（一部をBase64エンコード）: " . substr(base64_encode($sealedMessage), 0, 50) . "...\n";
32    echo "暗号化されたメッセージのバイト長: " . strlen($sealedMessage) . " バイト\n";
33    echo "暗号文と元のメッセージのバイト長の差: " . (strlen($sealedMessage) - strlen($originalMessage)) . " バイト\n\n";
34
35    // 暗号文の長さが期待通りか確認します。
36    if (strlen($sealedMessage) === strlen($originalMessage) + SODIUM_CRYPTO_BOX_SEALBYTES) {
37        echo "【確認】暗号化されたメッセージの長さは期待通りです。\n";
38        echo "       元のメッセージのバイト長 + SODIUM_CRYPTO_BOX_SEALBYTES = " . (strlen($originalMessage) + SODIUM_CRYPTO_BOX_SEALBYTES) . " バイト\n";
39    } else {
40        echo "【警告】暗号化されたメッセージの長さが期待と異なります。\n";
41    }
42}
43
44// 関数を実行してデモンストレーションを開始します。
45demonstrateSodiumCryptoBoxSealBytes();

このPHPサンプルコードは、libsodium拡張機能を利用したメッセージ暗号化の仕組み、特にSODIUM_CRYPTO_BOX_SEALBYTES定数の役割を解説しています。SODIUM_CRYPTO_BOX_SEALBYTESは、sodium_crypto_box_seal()関数を使ってメッセージを暗号化する際に、元のメッセージに必ず追加されるオーバーヘッド（付加情報）のバイト数を定義する定数です。この追加バイトには、安全な復号に必要な一時的な公開鍵や認証タグなどが含まれます。

sodium_crypto_box_seal()関数は、暗号化したい元のメッセージと、そのメッセージを受信する側の公開鍵を引数として受け取ります。そして、第三者には内容が判読できないように暗号化されたバイナリデータを戻り値として返します。この関数によって生成される暗号文のバイト長は、常に元のメッセージのバイト長にSODIUM_CRYPTO_BOX_SEALBYTESの値が加算されたものとなります。

サンプルコードでは、まずSODIUM_CRYPTO_BOX_SEALBYTESの具体的な値を示し、次に受信者の鍵ペアを生成します。その後、準備したメッセージをsodium_crypto_box_seal()で暗号化し、元のメッセージと暗号化されたメッセージそれぞれのバイト長を比較しています。これにより、SODIUM_CRYPTO_BOX_SEALBYTESが示すバイト数が暗号文に実際に加算されることを視覚的に確認でき、暗号化がどのようにデータサイズに影響を与えるかを理解することができます。

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_SEALBYTES 定数と 'sodium_crypto_box_seal' 関数をデモンストレーションします。
5 *
6 * この関数は、非対称暗号化（公開鍵暗号）のプロセスを示します。
7 * 送信者が受信者の公開鍵を使ってメッセージを暗号化（封印）し、
8 * 受信者だけが自身の秘密鍵と公開鍵でメッセージを復号できる仕組みです。
9 *
10 * SODIUM_CRYPTO_BOX_SEALBYTES は、'sodium_crypto_box_seal' 関数が平文に
11 * 追加するオーバーヘッドのバイト数を定義します。
12 */
13function demonstrateSodiumCryptoBoxSealUsage(): void
14{
15    echo "--- SODIUM_CRYPTO_BOX_SEALBYTES 定数と非対称暗号化のデモンストレーション ---" . PHP_EOL . PHP_EOL;
16
17    // 1. 受信者の鍵ペアを生成
18    // 非対称暗号化には、公開鍵と秘密鍵のペアが必要です。
19    // 受信者はこの鍵ペアを持ち、公開鍵を送信者に渡します。
20    $recipientKeyPair = sodium_crypto_box_keypair();
21    $recipientPublicKey = sodium_crypto_box_publickey($recipientKeyPair);
22    $recipientSecretKey = sodium_crypto_box_secretkey($recipientKeyPair);
23
24    echo "受信者の鍵ペアが生成されました。" . PHP_EOL;
25    echo "  公開鍵の長さ: " . strlen($recipientPublicKey) . " バイト" . PHP_EOL;
26    echo "  秘密鍵の長さ: " . strlen($recipientSecretKey) . " バイト" . PHP_EOL . PHP_EOL;
27
28    // 2. 送信する平文メッセージ
29    $plaintext = "こんにちは、これは秘密のメッセージです！";
30    echo "送信する平文メッセージ: '" . $plaintext . "'" . PHP_EOL;
31    echo "平文の長さ: " . strlen($plaintext) . " バイト" . PHP_EOL . PHP_EOL;
32
33    // 3. SODIUM_CRYPTO_BOX_SEALBYTES 定数の値を確認
34    echo "SODIUM_CRYPTO_BOX_SEALBYTES の値: " . SODIUM_CRYPTO_BOX_SEALBYTES . " バイト" . PHP_EOL;
35    echo "この定数は、'sodium_crypto_box_seal' で暗号化されたメッセージに" . PHP_EOL;
36    echo "追加される追加データ（オーバーヘッド）のバイト数を示します。" . PHP_EOL . PHP_EOL;
37
38    // 4. メッセージを暗号化（送信側）
39    // 送信者は受信者の公開鍵を使用してメッセージを暗号化します。
40    // このメッセージは受信者だけが復号できます。
41    $sealedMessage = sodium_crypto_box_seal($plaintext, $recipientPublicKey);
42    echo "メッセージが 'sodium_crypto_box_seal' で暗号化されました。" . PHP_EOL;
43    echo "暗号文の長さ: " . strlen($sealedMessage) . " バイト" . PHP_EOL;
44
45    // 暗号文の長さは、平文の長さと SODIUM_CRYPTO_BOX_SEALBYTES の合計と一致します。
46    $expectedLength = strlen($plaintext) + SODIUM_CRYPTO_BOX_SEALBYTES;
47    echo "期待される暗号文の長さ (平文 + SEALBYTES): " . $expectedLength . " バイト" . PHP_EOL;
48
49    if (strlen($sealedMessage) === $expectedLength) {
50        echo "  暗号文の長さは期待通りです。" . PHP_EOL;
51    } else {
52        echo "  警告: 暗号文の長さが期待と異なります！" . PHP_EOL;
53    }
54    echo PHP_EOL;
55
56    // 5. メッセージを復号（受信側）
57    // 受信者は自身の秘密鍵と公開鍵を使用してメッセージを復号します。
58    try {
59        $openedMessage = sodium_crypto_box_seal_open(
60            $sealedMessage,
61            $recipientPublicKey,
62            $recipientSecretKey
63        );
64
65        echo "メッセージが 'sodium_crypto_box_seal_open' で復号されました。" . PHP_EOL;
66        echo "復号されたメッセージ: '" . $openedMessage . "'" . PHP_EOL;
67
68        if ($plaintext === $openedMessage) {
69            echo "  復号は成功し、元の平文と完全に一致します。" . PHP_EOL;
70        } else {
71            echo "  エラー: 復号されたメッセージが元の平文と一致しません！" . PHP_EOL;
72        }
73    } catch (SodiumException $e) {
74        echo "  エラー: メッセージの復号に失敗しました - " . $e->getMessage() . PHP_EOL;
75    }
76
77    echo PHP_EOL . "--- デモンストレーション終了 ---" . PHP_EOL;
78}
79
80// 関数を実行してデモンストレーションを開始します
81demonstrateSodiumCryptoBoxSealUsage();

PHP 8のSODIUM_CRYPTO_BOX_SEALBYTESは、Libsodiumライブラリが提供する暗号化拡張機能における定数です。この定数は、sodium_crypto_box_seal関数を使用して非対称暗号化（公開鍵暗号）を行う際に、元のメッセージ（平文）に自動的に追加されるデータのバイト数を示します。具体的には、送信者が受信者の公開鍵を用いてメッセージを暗号化（封印）する際に、メッセージの安全性と整合性を確保するための付加情報として、この定数分のバイト数が追加されます。この定数自体に引数はなく、戻り値もありませんが、その値は常に一定で、暗号化後のメッセージ長を予測する際に役立ちます。

サンプルコードでは、まず受信者の公開鍵と秘密鍵のペアが生成されます。次に、送信したい平文メッセージを用意し、sodium_crypto_box_seal関数を使って受信者の公開鍵で暗号化します。このとき、暗号化されたメッセージの長さは、元の平文の長さにSODIUM_CRYPTO_BOX_SEALBYTESの値が加算されたものとなります。最後に、受信者は自身の公開鍵と秘密鍵の両方を用いてsodium_crypto_box_seal_open関数で暗号化されたメッセージを復号し、元の平文を取り出します。これにより、第三者が内容を読み取れない安全なメッセージ通信が実現されます。