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

Copy
1<?php
2
3/**
4 * libsodiumのcrypto_box機能と、各種鍵のバイト数定数を示すサンプル。
5 *
6 * この関数は、システムエンジニアを目指す初心者が、libsodiumライブラリの
7 * 鍵交換および暗号化機能 (crypto_box) の基本的な使い方と、
8 * 異なる暗号操作で使用される鍵のバイト数に関する定数を理解するのに役立ちます。
9 */
10function demonstrateSodiumCryptoBoxAndKeySizes(): void
11{
12    echo "--- libsodium crypto_box のデモンストレーション ---\n";
13
14    // AliceとBobの鍵ペアを生成します。
15    // crypto_box_keypair() は秘密鍵と公開鍵を結合した形で返します。
16    $aliceKeypair = sodium_crypto_box_keypair();
17    $bobKeypair = sodium_crypto_box_keypair();
18
19    // 鍵ペアから秘密鍵と公開鍵を分離します。
20    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
21    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
22    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
23    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
24
25    echo "Aliceの秘密鍵の長さ: " . strlen($aliceSecretKey) . " バイト\n";
26    echo "Aliceの公開鍵の長さ: " . strlen($alicePublicKey) . " バイト\n";
27    echo "Bobの秘密鍵の長さ: " . strlen($bobSecretKey) . " バイト\n";
28    echo "Bobの公開鍵の長さ: " . strlen($bobPublicKey) . " バイト\n";
29
30    // 暗号化するメッセージとナンス（Nonce: 一度だけ使用されるランダムな値）を準備します。
31    // ナンスの長さは SODIUM_CRYPTO_BOX_NONCEBYTES 定数で定義されています。
32    $message = "こんにちは、安全な世界へようこそ！";
33    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
34
35    // AliceがBobに向けてメッセージを暗号化します。
36    // Aliceの秘密鍵とBobの公開鍵を使用します。
37    $ciphertext = sodium_crypto_box(
38        $message,
39        $nonce,
40        $bobPublicKey,
41        $aliceSecretKey
42    );
43
44    echo "元のメッセージ: " . $message . "\n";
45    echo "暗号化されたメッセージの長さ: " . strlen($ciphertext) . " バイト\n";
46
47    // BobがAliceからのメッセージを復号します。
48    // Bobの秘密鍵とAliceの公開鍵を使用します。
49    $decryptedMessage = sodium_crypto_box_open(
50        $ciphertext,
51        $nonce,
52        $alicePublicKey,
53        $bobSecretKey
54    );
55
56    if ($decryptedMessage === false) {
57        echo "復号に失敗しました！\n";
58    } else {
59        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
60    }
61
62    echo "\n--- libsodium 鍵バイト数定数の情報 ---\n";
63
64    // SODIUM_CRYPTO_SIGN_SECRETKEYBYTES の値を出力します。
65    // これは、libsodiumの署名（signing）機能で使用される秘密鍵のバイト数です。
66    echo "SODIUM_CRYPTO_SIGN_SECRETKEYBYTES (署名秘密鍵): " . SODIUM_CRYPTO_SIGN_SECRETKEYBYTES . " バイト\n";
67
68    // crypto_box 機能で使用される秘密鍵のバイト数を定数で確認します。
69    echo "SODIUM_CRYPTO_BOX_SECRETKEYBYTES (暗号ボックス秘密鍵): " . SODIUM_CRYPTO_BOX_SECRETKEYBYTES . " バイト\n";
70
71    echo "これらの値は、libsodiumライブラリが提供する異なる暗号操作において、\n";
72    echo "それぞれに最適な鍵の長さを定義していることを示しています。\n";
73}
74
75// サンプル関数を実行します。
76demonstrateSodiumCryptoBoxAndKeySizes();

このPHPサンプルコードは、libsodium 拡張機能が提供する暗号化・復号の仕組みである crypto_box の基本的な使い方と、セキュリティ関連の様々な鍵のバイト数を示す定数について解説しています。

crypto_box 機能では、まず sodium_crypto_box_keypair() を使って公開鍵と秘密鍵のペアを生成します。例えば、AliceがBobにメッセージを送る場合、Aliceは自身の秘密鍵とBobの公開鍵でメッセージを暗号化します。Bobは、自身の秘密鍵とAliceの公開鍵を使ってメッセージを復号することで、安全な通信を実現します。

サンプルコードの終盤に表示される SODIUM_CRYPTO_SIGN_SECRETKEYBYTES は、libsodium のデジタル署名機能で使われる秘密鍵のバイト数を示す定数です。デジタル署名とは、メッセージが確かに送信者から送られ、途中で改ざんされていないことを証明する技術です。この定数自体に引数はなく、その値は常に署名用秘密鍵の推奨バイト数を示す整数値 int です。

また、SODIUM_CRYPTO_BOX_SECRETKEYBYTES は、上記 crypto_box 機能で使用される秘密鍵のバイト数を示しています。これらの定数は、異なる暗号操作において、安全性を保証するために必要な鍵の長さを開発者が迷わず利用できるよう提供されています。

Copy
1<?php
2
3/**
4 * Libsodium拡張機能の定数と、sodium_crypto_secretbox関数を用いた
5 * メッセージの暗号化と復号の基本的な例を示します。
6 *
7 * このコードは、システムエンジニアを目指す初心者向けに、PHPで安全な暗号処理を行う
8 * Libsodiumライブラリの基本的な使い方を理解してもらうことを目的としています。
9 */
10function demonstrateSodiumSecretbox(): void
11{
12    // 1. Libsodium拡張機能がロードされているか確認します。
13    // PHP 7.2 以降では標準で利用可能ですが、念のため確認することが推奨されます。
14    if (!extension_loaded('sodium')) {
15        echo "エラー: Libsodium拡張機能がロードされていません。\n";
16        return;
17    }
18
19    // 2. リファレンス情報で指定された定数 SODIUM_CRYPTO_SIGN_SECRETKEYBYTES の値を出力します。
20    // この定数は、Libsodiumの「署名(Signing)」機能で使用される秘密鍵のバイト数を示します。
21    // 今回の例の「secretbox (対称暗号化)」機能とは異なる用途の定数ですが、
22    // Libsodium拡張が提供する多様な定数の一例として確認できます。
23    echo "--- Libsodium 定数の確認 ---\n";
24    echo "SODIUM_CRYPTO_SIGN_SECRETKEYBYTES (署名用秘密鍵の長さ): " . SODIUM_CRYPTO_SIGN_SECRETKEYBYTES . " バイト\n\n";
25
26    // 3. sodium_crypto_secretbox で使用する鍵とノンスの長さを定数で取得します。
27    // これらの定数は、各暗号化機能に必要なデータの正確なサイズを提供します。
28    $keyLength = SODIUM_CRYPTO_SECRETBOX_KEYBYTES;
29    $nonceLength = SODIUM_CRYPTO_SECRETBOX_NONCEBYTES;
30
31    echo "--- sodium_crypto_secretbox の準備 ---\n";
32    echo "secretbox の鍵の長さ: " . $keyLength . " バイト\n";
33    echo "secretbox のノンスの長さ: " . $nonceLength . " バイト\n\n";
34
35    // 4. 秘密鍵とノンス（Nonce: Number Once）を安全に生成します。
36    // 鍵は暗号化と復号に両方に使用される秘密の情報です。
37    // ノンスは各暗号化操作で一度だけ使用される一意の値で、安全性を保つためにランダムに生成する必要があります。
38    $key = random_bytes($keyLength);
39    $nonce = random_bytes($nonceLength);
40
41    // 5. 暗号化する元のメッセージ（平文）を定義します。
42    $originalMessage = "これは誰にも知られたくない秘密のメッセージです。";
43    echo "元のメッセージ: " . $originalMessage . "\n\n";
44
45    // 6. メッセージを sodium_crypto_secretbox で暗号化します。
46    // この関数は、メッセージ、ノンス、鍵を引数に取り、暗号化されたデータ（暗号文）を返します。
47    // 失敗した場合は false を返しますが、通常は成功します。
48    $encryptedMessage = sodium_crypto_secretbox($originalMessage, $nonce, $key);
49
50    echo "--- 暗号化 ---\n";
51    echo "暗号化されたメッセージ (Base64エンコード): " . base64_encode($encryptedMessage) . "\n\n";
52
53    // 7. 暗号化されたメッセージを sodium_crypto_secretbox_open で復号します。
54    // 復号には、暗号化時と同じノンスと鍵が必要です。
55    // 復号に成功すると元の平文が返され、失敗した場合は false が返されます（例: 鍵やノンスが間違っている場合）。
56    $decryptedMessage = sodium_crypto_secretbox_open($encryptedMessage, $nonce, $key);
57
58    echo "--- 復号 ---\n";
59    if ($decryptedMessage !== false) {
60        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
61        if ($originalMessage === $decryptedMessage) {
62            echo "復号は成功し、元のメッセージと一致しました。\n";
63        } else {
64            echo "復号は成功しましたが、元のメッセージと一致しませんでした (予期せぬエラー)。\n";
65        }
66    } else {
67        echo "エラー: メッセージの復号に失敗しました。鍵またはノンスが正しくない可能性があります。\n";
68    }
69}
70
71// サンプル関数を実行します。
72demonstrateSodiumSecretbox();

このサンプルコードは、PHP 8 の Libsodium 拡張機能を用いて、メッセージを安全に暗号化および復号する基本的な方法を示しています。

まず、Libsodium 拡張機能が利用可能かを確認します。次に、リファレンス情報で指定された定数 SODIUM_CRYPTO_SIGN_SECRETKEYBYTES の値を出力します。この定数は、Libsodiumの「署名」機能で使用される秘密鍵の長さを整数 (int) で示し、引数は取りません。今回のメインである sodium_crypto_secretbox とは異なる用途ですが、Libsodiumが提供する定数の一例として確認できます。

メッセージの暗号化と復号には、sodium_crypto_secretbox 関数が使用されます。この関数は「秘密鍵」と「ノンス（一度だけ使う番号）」という二つの重要なデータに依存します。これらはそれぞれ SODIUM_CRYPTO_SECRETBOX_KEYBYTES と SODIUM_CRYPTO_SECRETBOX_NONCEBYTES という定数で指定された長さで、random_bytes 関数を用いて安全に生成されます。

sodium_crypto_secretbox は、元のメッセージ、生成されたノンス、および秘密鍵を引数として受け取り、暗号化されたデータ（暗号文）を返します。この暗号文は、base64_encode で人間が読める形式に変換されています。

暗号化されたメッセージを元の状態に戻す（復号する）には、sodium_crypto_secretbox_open 関数を使用します。この関数は、暗号文、暗号化時と同じノンス、そして同じ秘密鍵を引数に取ります。復号に成功すると元のメッセージが文字列として返され、鍵やノンスが間違っているなどの理由で失敗した場合は false が返されます。この一連の流れを通じて、PHPでセキュアなデータ保護を行うための基礎的な仕組みを理解することができます。