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

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_BOX_PUBLICKEYBYTES 定数と、生成された公開鍵の実際のバイト長を比較するサンプルコード。
5 *
6 * このコードは、システムエンジニアを目指す初心者向けに、
7 * libsodium 拡張機能における公開鍵のサイズを示す定数の使い方とその意味を簡潔に示します。
8 */
9function demonstrateSodiumPublicKeyBytesConstant(): void
10{
11    // libsodium 拡張がロードされているか確認します。
12    if (!extension_loaded('sodium')) {
13        echo "エラー: libsodium 拡張がロードされていません。\n";
14        return;
15    }
16
17    echo "--- SODIUM_CRYPTO_BOX_PUBLICKEYBYTES 定数のデモンストレーション ---\n";
18
19    // 1. `sodium_crypto_box` で使用する公開鍵と秘密鍵のペアを生成します。
20    $keyPair = sodium_crypto_box_keypair();
21
22    // 2. 生成された鍵ペアから公開鍵を抽出します。
23    $publicKey = sodium_crypto_box_publickey($keyPair);
24
25    // 3. SODIUM_CRYPTO_BOX_PUBLICKEYBYTES 定数の値を出力します。
26    // この定数は、`sodium_crypto_box` で使われる公開鍵のバイト長を定義しています。
27    echo "SODIUM_CRYPTO_BOX_PUBLICKEYBYTES の値: " . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . " バイト\n";
28
29    // 4. 実際に生成された公開鍵のバイト長を出力します。
30    // `strlen()` 関数は文字列のバイト長を返します。
31    $actualPublicKeyLength = strlen($publicKey);
32    echo "実際に生成された公開鍵のバイト長: " . $actualPublicKeyLength . " バイト\n";
33
34    // 5. 定数の値と、実際に生成された公開鍵のバイト長が一致するか確認します。
35    if ($actualPublicKeyLength === SODIUM_CRYPTO_BOX_PUBLICKEYBYTES) {
36        echo "結果: 定数の値と実際に生成された公開鍵のバイト長は一致します。\n";
37        echo "この定数は、libbsodium が扱う公開鍵のサイズが固定であることを示します。\n";
38    } else {
39        echo "結果: エラー: 定数の値と公開鍵のバイト長が一致しません。\n";
40    }
41
42    echo "--------------------------------------------------------\n";
43}
44
45// デモンストレーション関数を実行します。
46demonstrateSodiumPublicKeyBytesConstant();

SODIUM_CRYPTO_BOX_PUBLICKEYBYTESは、PHPのsodium拡張機能が提供する定数です。この定数は、セキュリティの高い暗号化通信を実現するsodium_crypto_box系の関数で利用される「公開鍵」の固定バイト長（サイズ）を示しています。引数はなく、常に整数型（int）の値を返します。

サンプルコードでは、この定数の役割を具体的に示しています。まず、sodium_crypto_box_keypair()関数を使って公開鍵と秘密鍵のペアを生成し、次にsodium_crypto_box_publickey()でその中から公開鍵を抽出しています。そして、SODIUM_CRYPTO_BOX_PUBLICKEYBYTES定数の値と、strlen()関数で取得した実際に生成された公開鍵のバイト長を比較しています。

この比較により、sodium拡張機能が生成する公開鍵のサイズが、常にこの定数で定義された値と一致することを確認できます。これは、libsodiumライブラリが扱う公開鍵のサイズが固定であり、予測可能であることを意味します。システムエンジニアとして暗号化処理を扱う際、鍵のサイズに関する正確な情報が必要となる場面で、この定数は重要な基準となります。

Copy
1<?php
2
3/**
4 * libsodiumの基本的な暗号化機能と、関連する定数の使用方法を初心者向けにデモンストレーションします。
5 *
6 * この関数は、システムエンジニアを目指す方々がセキュリティの基礎を理解するのに役立つよう、
7 * 対称暗号（secretbox）の概念と、公開鍵暗号（crypto_box）に関連する定数の意味を簡潔に示します。
8 *
9 * PHPの `sodium` 拡張機能が有効になっている必要があります。
10 */
11function demonstrateSodiumCryptoForBeginners(): void
12{
13    // --- SODIUM_CRYPTO_BOX_PUBLICKEYBYTES のデモンストレーション ---
14    // SODIUM_CRYPTO_BOX_PUBLICKEYBYTES は、libsodiumの「非対称暗号」（crypto_box）で
15    // 使用される公開鍵のバイト数を示す定数です。
16    // 非対称暗号は、公開鍵と秘密鍵のペアを使用し、公開鍵で暗号化し秘密鍵で復号化します。
17    // これは、メッセージの受け渡しにおいて秘密鍵を共有せずに安全に通信したい場合に利用されます。
18    echo "--- SODIUM_CRYPTO_BOX_PUBLICKEYBYTES の利用 ---" . PHP_EOL;
19    echo "libsodiumの非対称暗号における公開鍵の標準バイト数: " . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . " バイト" . PHP_EOL;
20    echo "これは、公開鍵が常にこの固定サイズであることを保証します。" . PHP_EOL;
21    echo PHP_EOL;
22
23    // --- sodium_crypto_secretbox のデモンストレーション ---
24    // sodium_crypto_secretbox は、共有の秘密鍵とノンスを使ってメッセージを暗号化・復号化する、
25    // 「対称暗号」のための主要な関数です。
26    // これは「認証付き暗号」を提供し、メッセージの機密性（秘密を守る）と
27    // 改ざん防止（メッセージが途中で変更されていないこと）の両方を保証します。
28    echo "--- sodium_crypto_secretbox (対称暗号) のデモンストレーション ---" . PHP_EOL;
29
30    // 1. 秘密鍵の生成
31    // 秘密鍵は、暗号化と復号化の両方に使用される共有の鍵です。
32    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES は secretbox の鍵に必要なバイト数を示す定数です。
33    $secretKey = sodium_crypto_secretbox_keygen(); // 安全なランダムな鍵を生成
34    echo "秘密鍵を生成しました (サイズ: " . strlen($secretKey) . " バイト)" . PHP_EOL;
35
36    // 2. ノンス（Nonce）の生成
37    // ノンス（Number once）は、各暗号化操作で一度だけ使用されるランダムな値です。
38    // これにより、同じ鍵と平文でも異なる暗号文が生成され、セキュリティが向上します。
39    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は secretbox のノンスに必要なバイト数を示す定数です。
40    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES); // 安全なランダムなノンスを生成
41    echo "ノンスを生成しました (サイズ: " . strlen($nonce) . " バイト)" . PHP_EOL;
42
43    // 3. 平文メッセージ
44    $message = "システムエンジニアを目指す初心者の皆さん、セキュリティは非常に重要です！安全なコードを書くことを心がけましょう。";
45    echo "元のメッセージ: " . $message . PHP_EOL;
46
47    // 4. メッセージの暗号化
48    // sodium_crypto_secretbox(平文, ノンス, 秘密鍵) を使用してメッセージを暗号化します。
49    // ノンスは暗号文と共に保管・送信し、復号時に必要になります。
50    $ciphertext = sodium_crypto_secretbox($message, $nonce, $secretKey);
51    // 暗号文はバイナリデータなので、表示のためにBase64エンコードします。
52    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($ciphertext) . PHP_EOL;
53    echo "暗号文のサイズ: " . strlen($ciphertext) . " バイト" . PHP_EOL;
54
55    // 5. メッセージの復号化
56    // sodium_crypto_secretbox_open(暗号文, ノンス, 秘密鍵) を使用してメッセージを復号化します。
57    // 復号に失敗した場合 (例: 暗号文が改ざんされた、鍵やノンスが間違っている)、falseを返します。
58    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $secretKey);
59
60    if ($decryptedMessage !== false) {
61        echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
62        if ($decryptedMessage === $message) {
63            echo "結果: 元のメッセージと復号化されたメッセージは一致しました。暗号化/復号化に成功です。" . PHP_EOL;
64        } else {
65            echo "結果: エラー - メッセージが一致しませんでした。" . PHP_EOL;
66        }
67    } else {
68        echo "結果: エラー - メッセージの復号化に失敗しました (メッセージが改ざんされたか、鍵/ノンスが間違っている可能性があります)。" . PHP_EOL;
69    }
70}
71
72// デモンストレーションを実行します。
73demonstrateSodiumCryptoForBeginners();
74
75?>

PHPのSODIUM_CRYPTO_BOX_PUBLICKEYBYTESは、libsodiumライブラリの非対称暗号（crypto_box）で使用される公開鍵の標準バイト数を示す定数です。この定数は固定の整数値（int）を返し、公開鍵が常に特定のサイズであることを保証します。

一方、sodium_crypto_secretbox関数は、共有の秘密鍵とノンス（使い捨ての数値）を使用してメッセージを暗号化・復号化する対称暗号の主要な機能を提供します。この関数は認証付き暗号を実現し、メッセージの機密性（内容を秘密に保つこと）と改ざん防止（メッセージが途中で不正に変更されていないこと）の両方を保証します。

暗号化の際には、平文メッセージ、各操作で一度だけ使うノンス、そして共有の秘密鍵を引数として受け取り、暗号化されたバイナリデータを返します。復号化の際には、暗号文、使用したノンス、秘密鍵を引数として受け取ります。復号に成功すれば元の平文メッセージを返しますが、暗号文が改ざんされていたり、鍵やノンスが間違っていたりした場合はfalseを返して失敗を通知します。サンプルコードでは、これらのステップを経てメッセージが安全に送受信される様子が示されています。