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

Copy
1<?php
2
3/**
4 * Libsodiumのsodium_crypto_secretboxを使用してメッセージを暗号化および復号化します。
5 *
6 * この関数は、指定されたメッセージを共有鍵とnonce（使い捨ての数値）で暗号化し、
7 * その後同じ鍵とnonceで復号化する一連の処理を示します。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * LibSodiumは、安全な暗号化処理をPHPで簡単に実装できる拡張機能です。
11 * sodium_crypto_secretbox は、共通鍵暗号方式でメッセージを暗号化し、その機密性
12 * および完全性（データが改ざんされていないこと）を保証します。
13 *
14 * 鍵のバイト数に関する定数（例: SODIUM_CRYPTO_SECRETBOX_KEYBYTES）は、
15 * 各暗号化アルゴリズムが必要とする鍵の長さを定義しています。
16 *
17 * @param string $message 暗号化する平文メッセージ。
18 * @return void
19 */
20function demonstrateSecretboxEncryption(string $message): void
21{
22    // PHPのSodium拡張がロードされているかを確認します。
23    // 暗号化機能を利用するにはこの拡張が必要です。
24    if (!extension_loaded('sodium')) {
25        echo "エラー: PHPのSodium拡張がロードされていません。PHPの設定を確認してください。\n";
26        return;
27    }
28
29    echo "--- LibSodium secretbox 暗号化/復号化のデモンストレーション ---\n\n";
30
31    // 1. 共有鍵の生成
32    // sodium_crypto_secretbox_keygen() は、secretboxアルゴリズムで必要な長さの安全な鍵を生成します。
33    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES は、このアルゴリズムの鍵の正しいバイト数を示します。
34    $key = sodium_crypto_secretbox_keygen();
35    echo "生成された鍵のバイト数: " . strlen($key) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . " バイト)\n";
36
37    // 2. nonce (Number used once) の生成
38    // nonce は、各暗号化操作でユニークである必要があります。同じ鍵とメッセージでも、異なるnonceを使うことで
39    // 同じ暗号文が生成されるのを防ぎ、セキュリティを向上させます。
40    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES は、secretboxアルゴリズムのnonceの正しいバイト数を示します。
41    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
42    echo "生成されたnonceのバイト数: " . strlen($nonce) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . " バイト)\n";
43
44    echo "\n元のメッセージ: " . $message . "\n";
45
46    // 3. メッセージの暗号化
47    // sodium_crypto_secretbox はメッセージ、nonce、鍵を引数に取り、認証付き暗号文を返します。
48    // この暗号文には、改ざんを検出するための認証タグが含まれています。
49    $ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
50    echo "暗号化されたメッセージ (Hex): " . bin2hex($ciphertext) . "\n";
51    echo "暗号化されたメッセージのバイト数: " . strlen($ciphertext) . " バイト\n";
52
53    // 4. メッセージの復号化
54    // sodium_crypto_secretbox_open は暗号文、nonce、鍵を引数に取り、復号化された平文を返します。
55    // もし暗号文が改ざんされている、または鍵/nonceが間違っている場合は、false を返します。
56    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
57
58    if ($decryptedMessage === false) {
59        echo "\nエラー: メッセージの復号化に失敗しました。暗号文が改ざんされたか、鍵/nonceが不正です。\n";
60    } else {
61        echo "\n復号化されたメッセージ: " . $decryptedMessage . "\n";
62        if ($message === $decryptedMessage) {
63            echo "結果: 暗号化と復号化が成功し、元のメッセージと一致しました！\n";
64        } else {
65            echo "結果: 警告！元のメッセージと復号化されたメッセージが一致しませんでした。\n";
66        }
67    }
68
69    echo "\n--- その他のLibSodium鍵関連定数 ---\n";
70    // 参考として、SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES の値を出力します。
71    // この定数は、`sodium_crypto_secretbox` とは異なる「シークレットストリーム」暗号化アルゴリズムで
72    // 使用される鍵のバイト数を示します。LibSodiumには、用途に応じた様々な暗号化アルゴリズムがあり、
73    // それぞれ異なる鍵の長さが定義されています。
74    echo "SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES: " . SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES . " バイト\n";
75    echo "これは、ストリーム暗号化のための鍵サイズであり、secretboxの鍵サイズとは異なります。\n";
76}
77
78// サンプルコードを実行
79$mySecretMessage = "システムエンジニアを目指す初心者の皆さん、セキュリティは非常に重要です。";
80demonstrateSecretboxEncryption($mySecretMessage);

SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTESは、PHPのLibSodium拡張機能が提供する重要な定数です。この定数は、sodium_crypto_secretstream_xchacha20poly1305という名前のストリーム暗号化アルゴリズムで使用される共通鍵の推奨されるバイト数、つまり安全な鍵の長さを数値として定義しています。PHP 8以降で利用可能であり、この定数自体には引数はなく、戻り値は整数型（int）です。暗号化においては、使用するアルゴリズムごとに適切な鍵の長さを守ることが、セキュリティを確保するために非常に重要となります。この定数を利用することで、開発者は特定のストリーム暗号化アルゴリズムに適合する正確な鍵サイズをプログラムで取得し、安全な鍵を生成する際に役立てることができます。サンプルコードでは主にsodium_crypto_secretboxという別の共通鍵暗号方式の例が示されていますが、SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTESはLibSodiumが提供する多様な暗号化機能の一つとして紹介されており、異なる用途の暗号化に適用される鍵サイズであることを理解する一助となります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * LibSodium拡張の公開鍵暗号機能である sodium_crypto_box の使い方を示します。
7 *
8 * 提示された定数 SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES は
9 * ストリーム暗号 (SecretStream) のキー長を示しますが、
10 * ここではキーワードに合わせ sodium_crypto_box (公開鍵暗号) の例を説明します。
11 * ストリーム暗号と公開鍵暗号は異なる用途で使用されることを理解してください。
12 */
13function demonstrateSodiumCryptoBox(): void
14{
15    echo "--- LibSodium 公開鍵暗号の基本 (sodium_crypto_box) ---\n\n";
16
17    // 提示された定数 SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES の値を確認します。
18    // この定数はSecretStream機能 (ストリーム暗号) のキーバイト長を示します。
19    echo "SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES (SecretStreamキー長): "
20        . SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES . " bytes\n";
21    echo "（この定数は以下の公開鍵暗号とは直接関係ありませんが、キー長の概念を理解するのに役立ちます。）\n\n";
22
23    // sodium_crypto_box で使用されるキーのバイト長も比較のために確認してみましょう。
24    echo "SODIUM_CRYPTO_BOX_SECRETKEYBYTES (公開鍵暗号の秘密鍵長): "
25        . SODIUM_CRYPTO_BOX_SECRETKEYBYTES . " bytes\n";
26    echo "SODIUM_CRYPTO_BOX_PUBLICKEYBYTES (公開鍵暗号の公開鍵長): "
27        . SODIUM_CRYPTO_BOX_PUBLICKEYBYTES . " bytes\n\n";
28
29    // 1. アリスとボブの鍵ペアを生成
30    // 鍵ペアは秘密鍵と公開鍵のセットです。
31    // 秘密鍵は誰にも知られてはならず、公開鍵は他の人と共有可能です。
32    $aliceKeypair = sodium_crypto_box_keypair();
33    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeypair);
34    $alicePublicKey = sodium_crypto_box_publickey($aliceKeypair);
35
36    $bobKeypair = sodium_crypto_box_keypair();
37    $bobSecretKey = sodium_crypto_box_secretkey($bobKeypair);
38    $bobPublicKey = sodium_crypto_box_publickey($bobKeypair);
39
40    echo "アリスの公開鍵 (Hex): " . bin2hex($alicePublicKey) . "\n";
41    echo "ボブの公開鍵 (Hex):   " . bin2hex($bobPublicKey) . "\n\n";
42
43    // 2. 暗号化するメッセージを定義
44    $message = "こんにちは、ボブ！アリスからの秘密のメッセージです。";
45    echo "元のメッセージ: " . $message . "\n\n";
46
47    // 3. ナンス (Nonce) を生成
48    // ナンスは、暗号化ごとに異なるランダムな値です。
49    // 同じ鍵で複数のメッセージを暗号化する場合、毎回異なるナンスを使用することがセキュリティ上非常に重要です。
50    // ナンスは暗号文と一緒に送信しても安全です。
51    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
52    echo "生成されたナンスの長さ: " . SODIUM_CRYPTO_BOX_NONCEBYTES . " bytes\n";
53    echo "生成されたナンス (最初の8バイトのHex): " . bin2hex(substr($nonce, 0, 8)) . "...\n\n";
54
55    // 4. アリスがボブの公開鍵と自身の秘密鍵を使ってメッセージを暗号化
56    // アリス（送信者）は自身の秘密鍵とボブ（受信者）の公開鍵を使用します。
57    $cipherText = sodium_crypto_box(
58        $message,
59        $nonce,
60        $bobPublicKey,   // 受信者（ボブ）の公開鍵
61        $aliceSecretKey  // 送信者（アリス）の秘密鍵
62    );
63    echo "暗号化されたメッセージ (最初の20バイトのHex): " . bin2hex(substr($cipherText, 0, 20)) . "...\n\n";
64
65    // 5. ボブがアリスの公開鍵と自身の秘密鍵を使ってメッセージを復号
66    // ボブ（受信者）は自身の秘密鍵とアリス（送信者）の公開鍵を使用します。
67    $decryptedMessage = sodium_crypto_box_open(
68        $cipherText,
69        $nonce,
70        $alicePublicKey, // 送信者（アリス）の公開鍵
71        $bobSecretKey    // 受信者（ボブ）の秘密鍵
72    );
73
74    if ($decryptedMessage === false) {
75        echo "復号に失敗しました。\n";
76    } else {
77        echo "復号されたメッセージ: " . $decryptedMessage . "\n";
78    }
79}
80
81// 関数を実行して、公開鍵暗号の動作を確認します。
82demonstrateSodiumCryptoBox();

PHPのLibSodium拡張に含まれる定数SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTESは、ストリーム暗号機能の一つであるSecretStreamにおけるキーのバイト長を示します。この定数は整数（int）を返しますが、今回のサンプルコードで主に解説する公開鍵暗号とは異なる用途で使用されるものです。

提示されたサンプルコードは、キーワードとして与えられたsodium_crypto_box関数を使った公開鍵暗号の基本的な使い方を紹介しています。この機能は、メッセージを安全に暗号化し、特定の相手だけが復号できるようにするために利用されます。

まず、sodium_crypto_box_keypair()関数で秘密鍵と公開鍵のペアを生成します。秘密鍵は誰にも知られてはならない重要な鍵であり、公開鍵は他の人と共有しても問題ありません。メッセージを暗号化する際は、送信者の秘密鍵と受信者の公開鍵を使用します。sodium_crypto_box()関数は、元のメッセージ、暗号化ごとに異なるランダムな値であるナンス、受信者の公開鍵、送信者の秘密鍵を引数として受け取り、暗号化されたメッセージを返します。ナンスはrandom_bytes()関数などで生成され、暗号文と一緒に送信しても安全です。

一方、暗号化されたメッセージを復号する際には、sodium_crypto_box_open()関数が用いられます。この関数は、暗号文、暗号化時に使用されたナンス、送信者の公開鍵、受信者の秘密鍵を引数として受け取ります。復号が成功すれば元のメッセージが返され、失敗した場合はfalseが返されます。これにより、メッセージの機密性を保ちながら安全な通信が実現されます。