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

Copy
1<?php
2
3/**
4 * libsodiumのsodium_crypto_boxを使ってメッセージを暗号化・復号する例。
5 * 非対称暗号（公開鍵暗号）による認証付き暗号化を示します。
6 *
7 * この関数は、システムエンジニアを目指す初心者が、libsodiumの基本的な公開鍵暗号の
8 * 仕組みと利用方法を理解するのに役立ちます。
9 */
10function demonstrateCryptoBoxEncryption(): void
11{
12    // PHP 8以降では、sodium拡張がデフォルトで有効になっています。
13    // 無効な場合は、'ext-sodium' を composer.json の require 節に追加するか、
14    // php.ini で extension=sodium を有効にする必要があります。
15
16    // リファレンス情報として提供された定数: SODIUM_CRYPTO_GENERICHASH_KEYBYTES
17    // この定数はジェネリックハッシュ関数の鍵長を示しますが、
18    // ここで扱う sodium_crypto_box の操作には直接関係しません。
19    // libsodiumの他の機能で使用されます。
20    $generichashKeyBytesLength = SODIUM_CRYPTO_GENERICHASH_KEYBYTES;
21    echo "libsodiumの定数 SODIUM_CRYPTO_GENERICHASH_KEYBYTES: " . $generichashKeyBytesLength . " bytes\n\n";
22
23    // 鍵ペアの生成 (AliceとBob)
24    // sodium_crypto_box_secretkey() はランダムな秘密鍵を生成します。
25    // sodium_crypto_box_publickey() は秘密鍵から対応する公開鍵を導出します。
26    $aliceSecretKey = sodium_crypto_box_secretkey();
27    $alicePublicKey = sodium_crypto_box_publickey($aliceSecretKey);
28
29    $bobSecretKey = sodium_crypto_box_secretkey();
30    $bobPublicKey = sodium_crypto_box_publickey($bobSecretKey);
31
32    echo "Aliceの公開鍵: " . bin2hex($alicePublicKey) . "\n";
33    echo "Bobの公開鍵:   " . bin2hex($bobPublicKey) . "\n\n";
34
35    // 暗号化するメッセージ
36    $originalMessage = "こんにちは、AliceからBobへ安全なメッセージです！";
37    echo "元メッセージ: " . $originalMessage . "\n";
38
39    // ノンス (Nonce) の生成
40    // ノンスは一度だけ使用されるランダムな値で、各暗号化操作でユニークである必要があります。
41    // SODIUM_CRYPTO_BOX_NONCEBYTES は、ノンスに必要なバイト数を示します。
42    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
43    echo "生成されたノンス: " . bin2hex($nonce) . " (長さ: " . SODIUM_CRYPTO_BOX_NONCEBYTES . " bytes)\n\n";
44
45    // AliceがBob宛にメッセージを暗号化
46    // Aliceの秘密鍵とBobの公開鍵を使用して、共通鍵を導出し暗号化します。
47    $encryptedMessage = sodium_crypto_box(
48        $originalMessage,
49        $nonce,
50        $bobPublicKey,    // 受信者の公開鍵
51        $aliceSecretKey   // 送信者の秘密鍵
52    );
53    echo "暗号化されたメッセージ: " . bin2hex($encryptedMessage) . "\n\n";
54
55    // BobがAliceからのメッセージを復号
56    // Bobの秘密鍵とAliceの公開鍵を使用して、共通鍵を導出し復号します。
57    // 復号に失敗した場合は false を返します（例: メッセージが改ざんされた場合）。
58    $decryptedMessage = sodium_crypto_box_open(
59        $encryptedMessage,
60        $nonce,
61        $alicePublicKey,  // 送信者の公開鍵
62        $bobSecretKey     // 受信者の秘密鍵
63    );
64
65    if ($decryptedMessage === false) {
66        echo "メッセージの復号に失敗しました。メッセージが改ざんされた可能性があります。\n";
67    } else {
68        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
69        if ($decryptedMessage === $originalMessage) {
70            echo "復号されたメッセージは元のメッセージと一致します。\n";
71        }
72    }
73}
74
75// 関数を実行してデモンストレーションを開始
76demonstrateCryptoBoxEncryption();

このPHPのサンプルコードは、libsodium拡張を利用した非対称暗号（公開鍵暗号）によるメッセージの安全な送受信方法を示しています。まず、参照情報にあるSODIUM_CRYPTO_GENERICHASH_KEYBYTES定数は、ジェネリックハッシュ関数の鍵長（バイト数）を表す整数値ですが、このコードで扱うsodium_crypto_boxの操作には直接関連しません。

コードでは、sodium_crypto_box_secretkey()とsodium_crypto_box_publickey()を使って、AliceとBobの鍵ペア（秘密鍵と公開鍵）をそれぞれ生成します。次に、暗号化処理に必須となる、各操作でユニークな使い捨てのランダムな値であるノンスをrandom_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES)で生成します。

メッセージの暗号化はsodium_crypto_box()関数で行います。この関数は、暗号化したい文字列、ノンス、メッセージの受信者の公開鍵、そしてメッセージの送信者の秘密鍵を引数として受け取ります。これにより、メッセージは認証付きで暗号化され、暗号化されたデータが文字列として返されます。

復号にはsodium_crypto_box_open()関数を使用します。これは、暗号化されたメッセージ、ノンス、メッセージの送信者の公開鍵、そしてメッセージの受信者の秘密鍵を引数とします。復号が成功すると元のメッセージ（文字列）が返され、メッセージの改ざんが検出されたり鍵が間違っていたりした場合にはfalseが返されます。これにより、メッセージの機密性だけでなく、改ざん検知（認証）も保証される仕組みを理解できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SODIUM_CRYPTO_GENERICHASH_KEYBYTES 定数と sodium_crypto_secretbox 関数を組み合わせて、
7 * 秘密鍵を用いたメッセージの暗号化と復号化の例を示します。
8 *
9 * SODIUM_CRYPTO_GENERICHASH_KEYBYTES は汎用ハッシュ関数の鍵の推奨サイズを示しますが、
10 * この値（32バイト）は sodium_crypto_secretbox の秘密鍵のサイズ
11 * (SODIUM_CRYPTO_SECRETBOX_KEYBYTES) とも一致するため、鍵生成に利用できます。
12 *
13 * @return void
14 */
15function demonstrateSecretBoxEncryption(): void
16{
17    // SODIUM_CRYPTO_GENERICHASH_KEYBYTES 定数から、鍵の長さを取得します。
18    // この値は32バイトです。
19    $keyLength = SODIUM_CRYPTO_GENERICHASH_KEYBYTES;
20
21    // libsodiumの秘密鍵暗号化に使用する秘密鍵を生成します。
22    // ここでは、SODIUM_CRYPTO_GENERICHASH_KEYBYTES で示されるバイト数の
23    // ランダムな鍵を生成し、secretboxの鍵として利用します。
24    $key = random_bytes($keyLength);
25
26    // 暗号化したいオリジナルのメッセージ
27    $message = 'システムエンジニアの皆さん、PHPでのセキュリティも学びましょう！';
28    echo "オリジナルメッセージ: " . $message . PHP_EOL;
29
30    // 暗号化に使用するNonce（ナンバー・ワンス、使い捨ての数値）を生成します。
31    // Nonceは各暗号化操作でユニークである必要があり、
32    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES がその推奨サイズです（24バイト）。
33    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
34
35    // sodium_crypto_secretbox を使用してメッセージを暗号化します。
36    // この関数は、メッセージ、Nonce、秘密鍵を引数に取り、
37    // 認証タグが付加された暗号文を返します。
38    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
39    echo "暗号文 (Base64エンコード): " . base64_encode($ciphertext) . PHP_EOL;
40
41    // sodium_crypto_secretbox_open を使用して暗号文を復号します。
42    // 暗号文、Nonce、秘密鍵がすべて正しくないと復号に失敗し、falseを返します。
43    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
44
45    if ($decryptedMessage !== false) {
46        echo "復号されたメッセージ: " . $decryptedMessage . PHP_EOL;
47        if ($message === $decryptedMessage) {
48            echo "✓ 暗号化と復号化が成功しました。" . PHP_EOL;
49        } else {
50            echo "✗ エラー: 復号されたメッセージがオリジナルと一致しません。" . PHP_EOL;
51        }
52    } else {
53        echo "✗ エラー: メッセージの復号に失敗しました。鍵またはNonceが間違っている可能性があります。" . PHP_EOL;
54    }
55
56    // セキュリティのベストプラクティスとして、機密データ（鍵やNonce）は使用後にクリアすることが推奨されます。
57    sodium_memzero($key);
58    sodium_memzero($nonce);
59}
60
61// 関数を実行して、暗号化と復号化の処理を確認します。
62demonstrateSecretBoxEncryption();

このサンプルコードは、PHPのLibsodiumライブラリを使用して、秘密鍵によるメッセージの暗号化と復号化の基本的な手順を示しています。まず、SODIUM_CRYPTO_GENERICHASH_KEYBYTES定数を用いて秘密鍵の長さを取得します。この定数は本来、汎用ハッシュ関数の鍵推奨サイズを示しますが、sodium_crypto_secretbox関数で必要とされる秘密鍵のサイズ（32バイト）とも一致するため、安全な鍵を生成する際の長さに利用しています。

random_bytes関数でこの長さのランダムなバイト列を生成し、秘密鍵として使用します。次に、暗号化ごとに異なる必要のある使い捨ての数値（Nonce）を、SODIUM_CRYPTO_SECRETBOX_NONCEBYTES定数で推奨される長さ（24バイト）で生成します。

メッセージの暗号化にはsodium_crypto_secretbox関数を使います。この関数は、暗号化したいメッセージ、Nonce、秘密鍵の3つを引数にとり、認証タグが付加された暗号文をstring型で返します。

復号化にはsodium_crypto_secretbox_open関数を使用します。これは暗号文、暗号化時に使ったNonce、秘密鍵を引数にとり、復号が成功し、かつ認証タグが有効であれば元のメッセージをstring型で返します。しかし、鍵やNonceが間違っている場合、または暗号文が改ざんされている場合はfalseを返すため、戻り値の確認が非常に重要です。

最後に、セキュリティのベストプラクティスとして、秘密鍵やNonceなどの機密データは使用後にsodium_memzero関数でメモリから安全にクリアすることが推奨されます。