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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Libsodiumの公開鍵暗号 (sodium_crypto_box) の使用例と、関連定数の表示
7 *
8 * この関数は、PHPのLibSodium拡張を使用した公開鍵暗号の基本的な仕組みを
9 * システムエンジニアを目指す初心者向けに示します。
10 *
11 * SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX は、LibSodiumのジェネリックハッシュ関数の
12 * 鍵の最大バイト数を示す定数であり、直接的には sodium_crypto_box とは
13 * 関連しませんが、同じLibSodium拡張で提供される定数として参照します。
14 */
15function demonstrateSodiumCryptoBoxAndConstants(): void
16{
17    // PHPにSodium拡張がロードされているかを確認
18    if (!extension_loaded('sodium')) {
19        echo "エラー: PHP Sodium 拡張がロードされていません。\n";
20        echo "php.ini ファイルで 'extension=sodium' を有効にしてください。\n";
21        return;
22    }
23
24    echo "--- Libsodium 定数の確認 ---\n";
25    // SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX の値を表示します。
26    // この定数は、ジェネリックハッシュ（暗号学的ハッシュ関数）の鍵の最大長を示します。
27    // キーワードの sodium_crypto_box (公開鍵暗号) とは異なる機能の定数ですが、
28    // 同じ Libsodium 拡張の一部として利用できます。
29    echo "SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX: " . SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX . " バイト\n\n";
30
31    echo "--- Libsodium 公開鍵暗号 (sodium_crypto_box) のデモンストレーション ---\n";
32
33    // 1. アリス (メッセージ送信者) とボブ (メッセージ受信者) の鍵ペアを生成します。
34    // 各鍵ペアには公開鍵 (他人に見せる鍵) と秘密鍵 (自分だけが持つ鍵) が含まれます。
35    $aliceKeypair = sodium_crypto_box_keypair();
36    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair); // アリスの公開鍵
37    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair); // アリスの秘密鍵
38
39    $bobKeypair = sodium_crypto_box_keypair();
40    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);     // ボブの公開鍵
41    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);     // ボブの秘密鍵
42
43    echo "鍵ペアの生成が完了しました。\n";
44    echo "  アリスの公開鍵 (先頭16文字): " . bin2hex(substr($alicePublicKey, 0, 16)) . "...\n";
45    echo "  ボブの公開鍵 (先頭16文字):   " . bin2hex(substr($bobPublicKey, 0, 16)) . "...\n\n";
46
47    // 2. 暗号化したい元のメッセージ
48    $message = "こんにちはボブ、これはアリスからの秘密のメッセージです！";
49    echo "元のメッセージ: \"" . $message . "\"\n";
50
51    // 3. ナンス (Nonce: Number used once) を生成します。
52    // ナンスは、同じ鍵で複数回暗号化を行う際に、毎回異なる値を使うことでセキュリティを確保するための、
53    // 一度だけ使用されるランダムな数値です。
54    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
55    echo "ナンスの生成が完了しました (サイズ: " . SODIUM_CRYPTO_BOX_NONCEBYTES . " バイト)。\n\n";
56
57    // 4. アリスがボブ宛のメッセージを暗号化します。
58    // アリスは、ボブの公開鍵 (メッセージの受信者) と、自分の秘密鍵 (メッセージの送信者) を使って暗号化します。
59    $encryptedMessage = sodium_crypto_box(
60        $message,          // 暗号化するメッセージ
61        $nonce,            // 一度だけ使うランダムなナンス
62        $bobPublicKey,     // 受信者 (ボブ) の公開鍵
63        $aliceSecretKey    // 送信者 (アリス) の秘密鍵
64    );
65
66    echo "メッセージの暗号化が完了しました。\n";
67    echo "暗号化されたメッセージ (先頭16文字の16進数表記): " . bin2hex(substr($encryptedMessage, 0, 16)) . "...\n\n";
68
69    // 5. ボブがアリスからのメッセージを復号化します。
70    // ボブは、アリスの公開鍵 (メッセージの送信者) と、自分の秘密鍵 (メッセージの受信者) を使って復号化します。
71    // 暗号化に使用されたナンスも、復号化時に同じものが必要です。
72    $decryptedMessage = sodium_crypto_box_open(
73        $encryptedMessage, // 暗号化されたメッセージ
74        $nonce,            // 暗号化時に使用されたナンス
75        $alicePublicKey,   // 送信者 (アリス) の公開鍵
76        $bobSecretKey      // 受信者 (ボブ) の秘密鍵
77    );
78
79    // 復号化に失敗した場合、false が返されます。
80    if ($decryptedMessage === false) {
81        echo "エラー: メッセージの復号化に失敗しました。鍵やナンスが正しくない可能性があります。\n";
82    } else {
83        echo "メッセージの復号化が完了しました。\n";
84        echo "復号化されたメッセージ: \"" . $decryptedMessage . "\"\n\n";
85
86        // 元のメッセージと復号化されたメッセージが一致するかを確認
87        if ($message === $decryptedMessage) {
88            echo "結果: 元のメッセージと復号化されたメッセージは一致します。公開鍵暗号の成功です！\n";
89        } else {
90            echo "結果: エラー！元のメッセージと復号化されたメッセージが一致しませんでした。\n";
91        }
92    }
93}
94
95// 関数を実行してデモンストレーションを開始
96demonstrateSodiumCryptoBoxAndConstants();

PHPのLibSodium拡張は、セキュアな暗号処理を提供する強力なツールです。このサンプルコードでは、LibSodium拡張に定義されている定数SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAXと、公開鍵暗号を行う関数sodium_crypto_boxの使用方法を解説します。

SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAXは、LibSodiumが提供するジェネリックハッシュ関数で利用される鍵の最大バイト数を示す定数です。これはsodium_crypto_boxとは異なる機能に関連しますが、同じLibSodium拡張の一部として利用可能な定数の一つです。

sodium_crypto_boxは、公開鍵暗号の仕組みを使って安全なメッセージのやり取りを実現する関数です。この関数を使うことで、メッセージの送信者と受信者だけが内容を読み取れるようにできます。 まず、sodium_crypto_box_keypair()関数を用いて、送信者（アリス）と受信者（ボブ）それぞれが公開鍵と秘密鍵のペアを生成します。 メッセージを暗号化する際は、sodium_crypto_box()関数を使用します。引数として、暗号化したいメッセージ、一度だけ使うランダムな数値である「ナンス」、メッセージを受け取る相手の公開鍵、そしてメッセージを送る自分の秘密鍵を渡します。戻り値として、暗号化されたメッセージが返されます。 暗号化されたメッセージを復号化するには、sodium_crypto_box_open()関数を使います。引数には、暗号化されたメッセージ、暗号化時に使われたナンス、メッセージを送った相手の公開鍵、そしてメッセージを受け取る自分の秘密鍵を渡します。正しく復号化できた場合、元のメッセージが戻り値として返されますが、鍵やナンスが一致しないなど復号化に失敗した場合はfalseが返されます。これらの機能は、安全な通信やデータ保護において非常に重要です。

Copy
1<?php
2
3/**
4 * PHPのsodium拡張機能を使ってメッセージを安全に暗号化し、復号化します。
5 *
6 * SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX は、generichash関数用のキーの最大長を示す定数です。
7 * ここでは、PHPのsodium拡張で利用できる定数の一例としてその値を示しますが、
8 * sodium_crypto_secretbox関数のキーサイズとは直接関係ありません。
9 * sodium_crypto_secretboxのキーサイズはSODIUM_CRYPTO_SECRETBOX_KEYBYTESで定義されます。
10 *
11 * @param string $plainMessage 暗号化する平文メッセージ
12 * @return string 復号化されたメッセージ
13 * @throws Exception PHP 'sodium' 拡張機能がロードされていない場合、または復号に失敗した場合
14 */
15function encryptAndDecryptWithSecretbox(string $plainMessage): string
16{
17    // SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX はgenerichashの最大キー長です。
18    // ここでその値を出力し、sodium拡張の定数の一例として示します。
19    echo "【参考情報】SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX の値: " . SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX . " バイト\n";
20    // sodium_crypto_secretbox で必要なキー長は SODIUM_CRYPTO_SECRETBOX_KEYBYTES です。
21    echo "【重要】sodium_crypto_secretbox のキー長: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト\n\n";
22
23    // sodium拡張がロードされているか確認
24    if (!extension_loaded('sodium')) {
25        throw new Exception("PHP 'sodium' 拡張機能がロードされていません。");
26    }
27
28    // 1. sodium_crypto_secretboxで使用する秘密鍵を生成します。
29    // このキーはSODIUM_CRYPTO_SECRETBOX_KEYBYTESの長さでなければなりません。
30    $key = sodium_crypto_secretbox_keygen();
31
32    // 2. ナンス（使い捨ての番号）を生成します。
33    // ナンスは暗号化ごとに異なる必要があり、SODIUM_CRYPTO_SECRETBOX_NONCEBYTESの長さです。
34    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
35
36    // 3. メッセージを暗号化します。
37    // sodium_crypto_secretbox は、メッセージ、ナンス、鍵を引数に取ります。
38    $ciphertext = sodium_crypto_secretbox($plainMessage, $nonce, $key);
39
40    // 4. 暗号化されたデータとナンスを結合し、保存または送信可能な形式にします。
41    // 復号時にはナンスも必要なので、通常は暗号文の前にナンスを付加します。
42    $encryptedDataWithNonce = $nonce . $ciphertext;
43
44    // 5. 復号のために、結合されたデータからナンスと暗号文を分離します。
45    $retrievedNonce = mb_substr($encryptedDataWithNonce, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit');
46    $retrievedCiphertext = mb_substr($encryptedDataWithNonce, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit');
47
48    // 6. メッセージを復号します。
49    // sodium_crypto_secretbox_open は、暗号文、ナンス、鍵を引数に取ります。
50    $decryptedMessage = sodium_crypto_secretbox_open($retrievedCiphertext, $retrievedNonce, $key);
51
52    // 復号に失敗した場合はfalseが返されます。
53    if ($decryptedMessage === false) {
54        throw new Exception('メッセージの復号に失敗しました。提供されたデータが不正である可能性があります。');
55    }
56
57    return $decryptedMessage;
58}
59
60// --- サンプルコードの実行 ---
61$originalMessage = "これは誰にも知られたくない秘密のメッセージです。";
62echo "元のメッセージ: " . $originalMessage . "\n\n";
63
64try {
65    $decrypted = encryptAndDecryptWithSecretbox($originalMessage);
66    echo "復号されたメッセージ: " . $decrypted . "\n";
67
68    // 元のメッセージと復号されたメッセージが一致するか確認
69    if ($originalMessage === $decrypted) {
70        echo "\n検証結果: 元のメッセージと復号されたメッセージは一致しました。\n";
71    } else {
72        echo "\n検証結果: 元のメッセージと復号されたメッセージが一致しませんでした。\n";
73    }
74} catch (Exception $e) {
75    echo "エラーが発生しました: " . $e->getMessage() . "\n";
76}

このサンプルコードは、PHPのsodium拡張機能を用いて、メッセージを安全に暗号化し、その後復号する一連の処理を示しています。

SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAXは、sodium拡張が提供する定数の一つで、ハッシュ関数であるgenerichashで使用するキーの最大バイト長を表します。コード中ではこの定数の値を出力していますが、これはsodium拡張機能で利用できる定数の一例として紹介されており、今回のメッセージ暗号化に使用するsodium_crypto_secretbox関数のキー長とは直接関係がありません。sodium_crypto_secretbox関数のキー長は、別の定数SODIUM_CRYPTO_SECRETBOX_KEYBYTESで定義されます。

encryptAndDecryptWithSecretbox関数は、与えられた文字列$plainMessageを暗号化し、復号する機能を持ちます。この関数では、まずsodium_crypto_secretbox_keygen()でメッセージの暗号化と復号に使う秘密鍵を生成し、random_bytes()でナンス（一度だけ使用するランダムな値）を作成します。ナンスは暗号化ごとに異なるものを使い、鍵と共に暗号化と復号の両方で必要となる重要な情報です。

メッセージの暗号化にはsodium_crypto_secretbox関数を使用し、引数として元のメッセージ、ナンス、秘密鍵を渡します。この関数は暗号化されたメッセージを文字列として返します。復号の際は、sodium_crypto_secretbox_open関数に暗号化されたメッセージ、使用したナンス、秘密鍵を引数として渡します。復号に成功した場合、この関数は元のメッセージを文字列として返しますが、失敗した場合はfalseを返しますので、その結果を適切に処理することが重要です。これにより、メッセージが正しく暗号化され、安全に復元できることを確認しています。