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

Copy
1<?php
2
3/**
4 * LibsodiumライブラリのChacha20-Poly1305 IETF暗号方式で使用される
5 * 鍵とNonceのバイト長定数について示します。
6 *
7 * システムエンジニアを目指す初心者向けに、これらの定数が何を示し、
8 * どのように使われるのかを簡潔に説明します。
9 */
10function demonstrateSodiumChacha20Poly1305IetfConstants(): void
11{
12    // SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES は、
13    // Chacha20-Poly1305 IETF暗号方式で利用する秘密鍵のバイト数を示します。
14    // この値は、安全な鍵を生成する際に必要となる長さです。
15    echo "Chacha20-Poly1305 IETF Key Bytes: "
16        . SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES
17        . " bytes\n";
18
19    // SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES は、
20    // Chacha20-Poly1305 IETF暗号方式で利用するNonce (数値 nonce、または npub) のバイト数を示します。
21    // Nonceは、同じ鍵で複数のメッセージを暗号化する際に、暗号の安全性を保つために各メッセージで異なる値を使用する「使い捨ての数値」です。
22    echo "Chacha20-Poly1305 IETF Nonce (Npub) Bytes: "
23        . SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES
24        . " bytes\n";
25
26    echo "\n";
27
28    // これらの定数を使用して、実際に必要な長さのランダムなバイト列（鍵とNonce）を生成する例
29    // random_bytes() 関数は、暗号学的に安全なランダムなバイト列を生成します。
30
31    // 適切な長さの秘密鍵を生成
32    $key = random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES);
33    echo "Generated Key Length: " . strlen($key) . " bytes\n";
34    // 実際のアプリケーションでは、鍵は安全に保管・管理されるべきであり、
35    // 直接表示することは避けるべきです。ここではデモンストレーションのために長さのみ表示します。
36
37    // 適切な長さのNonceを生成
38    // Nonceはメッセージごとに一意である必要があります。
39    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES);
40    echo "Generated Nonce Length: " . strlen($nonce) . " bytes\n";
41    // Nonceも通常は直接表示せず、暗号化処理に利用されます。
42
43    echo "\n";
44    echo "これらの定数は、LibSodium拡張機能を使って暗号化や復号化を行う際に、\n";
45    echo "鍵やNonceなどの重要なパラメータが適切なサイズであることを保証するために使われます。\n";
46}
47
48// 関数を実行して、定数の値と利用例を表示
49demonstrateSodiumChacha20Poly1305IetfConstants();

PHP 8のSODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES定数は、PHPのLibSodium拡張機能が提供するChacha20-Poly1305 IETF暗号方式で使用される秘密鍵の推奨バイト数を示すものです。この定数は引数を取らず、鍵の安全な長さを整数値として返します。システムエンジニアを目指す初心者にとって、暗号化のセキュリティを確保するために重要な情報です。

関連するsodium_crypto_aead_chacha20poly1305_ietf_npubbytes定数は、同じ暗号方式で利用するNonce（ナンス）のバイト数を示します。Nonceとは、同じ鍵で複数回暗号化する際に、セキュリティを保つための「使い捨ての数値」です。

これらの定数は、random_bytes()関数などで、鍵やNonceを生成する際に適切なバイト数を指定するために使われます。例えば、random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES)のように使用することで、推奨される長さの秘密鍵を確実に生成し、システムのセキュリティ維持に貢献します。

Copy
1<?php
2
3/**
4 * Demonstrates authenticated encryption and decryption using the ChaCha20-Poly1305 (IETF variant) algorithm.
5 * This function utilizes SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES to ensure
6 * the correct key length for symmetric authenticated encryption.
7 * While `sodium_crypto_box` offers non-symmetric (key-pair based) authenticated encryption,
8 * this example focuses on the symmetric variant using the specified constant.
9 *
10 * @param string $message          The plaintext message to be encrypted.
11 * @param string $associatedData   Optional additional authenticated data that is not encrypted
12 *                                 but verified during decryption.
13 * @return array{ciphertext: string, nonce: string}|false An array containing the ciphertext and nonce on success,
14 *                                                       or false if encryption/decryption fails.
15 */
16function encryptAndDecryptSymmetricMessage(string $message, string $associatedData = ''): array|false
17{
18    // Generate a cryptographically secure random key.
19    // SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES defines the required key length for this algorithm.
20    $key = random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES);
21
22    // Generate a unique nonce (number used once) for each encryption operation.
23    // SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES defines the required nonce length.
24    $nonce = random_bytes(SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES);
25
26    // Encrypt the message.
27    // The associated data is authenticated along with the message but remains unencrypted.
28    $ciphertext = sodium_crypto_aead_chacha20poly1305_ietf_encrypt(
29        $message,
30        $associatedData,
31        $nonce,
32        $key
33    );
34
35    if ($ciphertext === false) {
36        echo "Encryption failed!" . PHP_EOL;
37        return false;
38    }
39
40    echo "Original Message: " . $message . PHP_EOL;
41    echo "Ciphertext (hex): " . bin2hex($ciphertext) . PHP_EOL;
42    echo "Nonce (hex): " . bin2hex($nonce) . PHP_EOL;
43    echo "Key (hex): " . bin2hex($key) . PHP_EOL;
44
45    // Decrypt the ciphertext.
46    // The same key, nonce, and associated data are required for successful decryption.
47    $decryptedMessage = sodium_crypto_aead_chacha20poly1305_ietf_decrypt(
48        $ciphertext,
49        $associatedData,
50        $nonce,
51        $key
52    );
53
54    if ($decryptedMessage === false) {
55        echo "Decryption failed (e.g., due to data tampering or incorrect inputs)!" . PHP_EOL;
56        return false;
57    }
58
59    echo "Decrypted Message: " . $decryptedMessage . PHP_EOL;
60
61    return ['ciphertext' => $ciphertext, 'nonce' => $nonce];
62}
63
64// Example usage when executed from the command line
65if (php_sapi_name() === 'cli') {
66    if (!extension_loaded('sodium')) {
67        echo "Error: The 'sodium' extension is not loaded. Please enable it in your PHP configuration." . PHP_EOL;
68        exit(1);
69    }
70
71    $messageToEncrypt = "Secure communication is vital for system engineers.";
72    $additionalAuthData = "TransactionID: ABC-123";
73
74    encryptAndDecryptSymmetricMessage($messageToEncrypt, $additionalAuthData);
75}

このPHPのサンプルコードは、SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES定数を使用して、対称鍵暗号化の一種であるChaCha20-Poly1305 (IETF variant)アルゴリズムでメッセージを安全に暗号化および復号化する方法を示しています。この定数は、指定されたアルゴリズムで利用する共通鍵の正確なバイト長（整数値）を定義しており、この値を用いることで適切な長さの鍵を生成できます。

コード内では、まずSODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTESで指定された長さの暗号的に安全なランダムな鍵をrandom_bytes関数で生成しています。同様に、暗号化ごとに一意の使い捨ての数値（nonce）も適切な長さで生成されます。これらの鍵とnonce、そして暗号化したいメッセージ（$message）、オプションの追加認証データ（$associatedData）を用いてsodium_crypto_aead_chacha20poly1305_ietf_encrypt関数でメッセージを暗号化します。暗号化されたデータは$ciphertextとして得られ、復号化時には同じ鍵、nonce、追加認証データを用いてsodium_crypto_aead_chacha20poly1305_ietf_decrypt関数で元のメッセージに戻します。

encryptAndDecryptSymmetricMessage関数は、引数として暗号化したいメッセージ（$message）と、暗号化はされないが復号時にデータの改ざんを検証するための追加データ（$associatedData）を受け取ります。成功時には暗号文とnonceを含む配列を返し、暗号化または復号化に失敗した場合はfalseを返します。なお、sodium_crypto_boxは公開鍵と秘密鍵を使用する非対称暗号化を提供しますが、このサンプルは共通の鍵を使用する対称暗号化に焦点を当てています。