Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES定数は、PHPのSodium拡張機能が提供する暗号化機能の一つであるChaCha20-Poly1305アルゴリズムにおいて、認証タグのサイズをバイト単位で表す定数です。

ChaCha20-Poly1305は、データを安全に保護するための認証付き暗号化(AEAD: Authenticated Encryption with Associated Data)アルゴリズムです。これは、単にデータを秘密にする(暗号化)だけでなく、そのデータが途中で改ざんされていないか、また正当な送信者から送られたものであるかを確認する「認証」の機能も持ち合わせています。この認証を行うために、暗号文とは別に生成される特別な情報が「認証タグ」です。

この定数は、ChaCha20-Poly1305アルゴリズムによって生成される認証タグが、常に何バイトの長さになるかという固定値を示します。例えば、暗号化されたデータを復号する際には、この認証タグのサイズを正確に把握している必要があります。この定数を使用することで、プログラマはコード内で直接数値を記述する「マジックナンバー」を避け、より安全で読みやすく、メンテナンスしやすいプログラムを作成することができます。セキュリティ関連の処理では、このような正確なサイズ管理が非常に重要であり、この定数は安全な暗号化通信を実装する上で役立ちます。

構文(syntax)

1<?php
2echo SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES;
3?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

これは、ChaCha20-Poly1305暗号化アルゴリズムを使用した場合の、認証付き暗号化データの合計バイト数を表す整数定数です。

サンプルコード

PHP Sodium: ChaCha20-Poly1305 AEAD を使用した暗号化・復号化

1<?php
2
3// このスクリプトは、PHP の Sodium 拡張機能がインストールされ、有効になっていることを前提としています。
4
5// SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES は、
6// ChaCha20-Poly1305 IETF (Internet Engineering Task Force) AEAD (Authenticated Encryption with Associated Data) 方式で使用される
7// 認証タグ (Authenticated Tag) の推奨バイト数を表す定数です。
8// 認証タグは、暗号化されたデータが改ざんされていないことを検証するために使用されます。
9echo "ChaCha20-Poly1305 IETF の認証タグのバイト数 (SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES): "
10    . SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES . " バイト\n";
11
12// sodium_crypto_aead_chacha20poly1305_ietf_npubbytes() 関数は、
13// ChaCha20-Poly1305 IETF AEAD 方式で使用される Nonce (Number Used Once) の推奨バイト数を返します。
14// Nonce は暗号化ごとに異なるランダムな値である必要があり、復号化にも同じ Nonce が必要ですが、秘密にする必要はありません。
15$nonceBytes = sodium_crypto_aead_chacha20poly1305_ietf_npubbytes();
16echo "ChaCha20-Poly1305 IETF の Nonce のバイト数 (sodium_crypto_aead_chacha20poly1305_ietf_npubbytes()): "
17    . $nonceBytes . " バイト\n";
18
19echo "\n--- ChaCha20-Poly1305 IETF を使用した暗号化と復号化の例 ---\n";
20
21// 1. 暗号化キーの生成
22// 非常に重要なステップです。このキーは秘密に保持し、安全に管理する必要があります。
23// sodium_crypto_aead_chacha20poly1305_ietf_keygen() は適切な長さのランダムなキーを生成します。
24$key = sodium_crypto_aead_chacha20poly1305_ietf_keygen();
25echo "暗号化キーを生成しました。\n";
26
27// 2. 暗号化したい元のメッセージ
28$originalMessage = "システムエンジニアの皆さん、データセキュリティはプロの基本です!";
29echo "元のメッセージ: \"" . $originalMessage . "\"\n";
30
31// 3. Nonce (Number Used Once) の生成
32// Nonce は毎回異なるランダムな値である必要があります。
33// random_bytes() 関数で推奨されるバイト数のランダムなバイト列を生成します。
34$nonce = random_bytes($nonceBytes);
35echo "Nonce を生成しました。\n";
36
37// 4. メッセージの暗号化
38// sodium_crypto_aead_chacha20poly1305_ietf_encrypt() 関数でメッセージを暗号化します。
39// この関数が返す暗号文には、元のメッセージの暗号化された部分と認証タグが含まれます。
40// 認証タグのサイズが SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES です。
41// ここでは追加の認証データ (associated data) は使用しません (第2引数に空文字列を指定)。
42$ciphertext = sodium_crypto_aead_chacha20poly1305_ietf_encrypt(
43    $originalMessage, // 暗号化するメッセージ
44    '',                // 追加の認証データ (AAD)。今回は使用しない
45    $nonce,           // ランダムに生成した Nonce
46    $key              // 生成した暗号化キー
47);
48echo "メッセージを暗号化しました。\n";
49echo "暗号化されたデータの長さ: " . strlen($ciphertext) . " バイト\n";
50// バイナリデータを安全に表示するため、Base64 でエンコードして出力します。
51echo "暗号化されたデータ (Base64): " . base64_encode($ciphertext) . "\n";
52
53// 5. 暗号化されたメッセージの復号化
54// 復号化には、暗号化時と全く同じキー、Nonce、追加の認証データが必要です。
55// いずれか一つでも異なると、復号化は失敗し SodiumException がスローされます。
56try {
57    $decryptedMessage = sodium_crypto_aead_chacha20poly1305_ietf_decrypt(
58        $ciphertext,      // 暗号化されたデータ
59        '',                // 暗号化時と同じ追加の認証データ
60        $nonce,           // 暗号化時と同じ Nonce
61        $key              // 暗号化時と同じキー
62    );
63
64    echo "メッセージを復号化しました。\n";
65    echo "復号化されたメッセージ: \"" . $decryptedMessage . "\"\n";
66
67    // 復号化されたメッセージが元のメッセージと一致するか確認します。
68    if ($decryptedMessage === $originalMessage) {
69        echo "結果: 復号化されたメッセージは元のメッセージと完全に一致しました。成功!\n";
70    } else {
71        echo "結果: エラー - 復号化されたメッセージが元のメッセージと一致しません。\n";
72    }
73} catch (SodiumException $e) {
74    // データが改ざんされた場合や、キー/Nonce/AAD が間違っている場合に例外がスローされます。
75    echo "エラー: 復号化中に問題が発生しました: " . $e->getMessage() . "\n";
76    echo "これは、暗号化データが改ざんされたか、キーや Nonce が誤っている可能性を示しています。\n";
77}
78
79?>

PHPのSodium拡張機能は、安全な暗号化機能を提供し、このコードはChaCha20-Poly1305 IETF方式での利用例です。SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTESは、データ改ざんを検証する「認証タグ」の推奨バイト数を示す定数で、整数値(int)を返します。このタグは暗号化データに付加され、データの真正性確認に利用されます。

sodium_crypto_aead_chacha20poly1305_ietf_npubbytes()関数は、暗号化ごとに異なる「Nonce(Number Used Once)」の推奨バイト数を返します。引数はなく、整数値(int)が戻り値です。Nonceは復号化に必須ですが、秘密にする必要はありません。

サンプルでは、sodium_crypto_aead_chacha20poly1305_ietf_keygen()で秘密の暗号化キーを生成し、random_bytes()とsodium_crypto_aead_chacha20poly1305_ietf_npubbytes()でNonceを生成します。その後、sodium_crypto_aead_chacha20poly1305_ietf_encrypt()関数にメッセージ、追加データ、Nonce、キーを渡し、認証タグを含む暗号化データ文字列を取得します。

復号化には、sodium_crypto_aead_chacha20poly1305_ietf_decrypt()関数を使用します。この関数は、暗号文と暗号化時と同じ追加データ、Nonce、キーを引数にとり、成功すれば復号化されたメッセージ文字列を返します。データが改ざんされたり、キーやNonceが誤っていたりするとSodiumExceptionがスローされ、復号化が失敗したことを示します。これにより、データの機密性と完全性が保証されます。

PHPのSodium拡張機能を利用するには、まず有効化されていることを確認してください。暗号化キーは生成後、絶対に秘密に安全に管理することが重要です。Nonce(ナンス)は毎回異なるランダムな値を生成し、再利用は厳禁です。復号化には、暗号化時と完全に一致するキー、Nonce、追加データが必要です。これらが一つでも異なるとSodiumExceptionが発生し復号化に失敗するため、try-catchで必ず例外を処理し、データ改ざんや誤操作に備えましょう。

sodium_crypto_box で安全な通信を確立する

1<?php
2
3/**
4 * Demonstrates public-key authenticated encryption using sodium_crypto_box.
5 * It also illustrates the value of SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES,
6 * which represents the size of authentication tags in Sodium's AEAD schemes.
7 * While sodium_crypto_box uses XSalsa20-Poly1305, its authentication tag size is
8 * coincidentally 16 bytes, matching this constant.
9 */
10function demonstrateSodiumCryptoBox(): void
11{
12    // 1. Generate key pairs for Alice (sender) and Bob (receiver).
13    // Each key pair consists of a public key and a secret key.
14    $aliceKeyPair = sodium_crypto_box_keypair();
15    $alicePublicKey = sodium_crypto_box_publickey($aliceKeyPair);
16    $aliceSecretKey = sodium_crypto_box_secretkey($aliceKeyPair);
17
18    $bobKeyPair = sodium_crypto_box_keypair();
19    $bobPublicKey = sodium_crypto_box_publickey($bobKeyPair);
20    $bobSecretKey = sodium_crypto_box_secretkey($bobKeyPair);
21
22    // 2. Define the message Alice wants to send to Bob.
23    $message = 'Hello, Bob! This is a secret message from Alice.';
24
25    // 3. Generate a secure, unique nonce (number used once).
26    // A nonce must never be reused for the same key pair when encrypting.
27    $nonce = random_bytes(SODIUM_CRYPTO_BOX_NONCEBYTES);
28
29    // 4. Alice encrypts the message for Bob.
30    // She uses her secret key and Bob's public key.
31    $ciphertext = sodium_crypto_box(
32        $message,
33        $nonce,
34        sodium_crypto_box_keypair_from_secretkey_and_publickey($aliceSecretKey, $bobPublicKey)
35    );
36
37    echo "Original Message: " . $message . PHP_EOL;
38    echo "Ciphertext (hex): " . bin2hex($ciphertext) . PHP_EOL;
39    echo "Nonce (hex): " . bin2hex($nonce) . PHP_EOL;
40    echo "---------------------------------------------------" . PHP_EOL;
41
42    // 5. Demonstrate the SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES constant.
43    // This constant defines the size of the authentication tag (MAC) in bytes.
44    // For sodium_crypto_box, this tag is prepended to the ciphertext.
45    $tagSize = SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES;
46    echo "Authentication Tag Size (SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES): " . $tagSize . " bytes" . PHP_EOL;
47
48    // The output of sodium_crypto_box is 'authentication_tag' + 'encrypted_message'.
49    echo "Total Ciphertext Length: " . strlen($ciphertext) . " bytes" . PHP_EOL;
50    echo "Expected Encrypted Message Length: " . (strlen($message) + $tagSize) . " bytes" . PHP_EOL;
51    echo "Ciphertext content breakdown:" . PHP_EOL;
52    echo "  - MAC (Authentication Tag) part (hex): " . bin2hex(substr($ciphertext, 0, $tagSize)) . PHP_EOL;
53    echo "  - Encrypted Data part (hex): " . bin2hex(substr($ciphertext, $tagSize)) . PHP_EOL;
54    echo "---------------------------------------------------" . PHP_EOL;
55
56    // 6. Bob decrypts the message from Alice.
57    // He uses his secret key and Alice's public key.
58    $decryptedMessage = sodium_crypto_box_open(
59        $ciphertext,
60        $nonce,
61        sodium_crypto_box_keypair_from_secretkey_and_publickey($bobSecretKey, $alicePublicKey)
62    );
63
64    // 7. Verify successful decryption.
65    if ($decryptedMessage !== false) {
66        echo "Decryption Successful!" . PHP_EOL;
67        echo "Decrypted Message: " . $decryptedMessage . PHP_EOL;
68        if ($decryptedMessage === $message) {
69            echo "Message matches original." . PHP_EOL;
70        }
71    } else {
72        echo "Decryption Failed! The message might have been tampered with, " .
73             "or the keys/nonce are incorrect." . PHP_EOL;
74    }
75
76    // Clean up sensitive data from memory to prevent disclosure.
77    sodium_memzero($aliceKeyPair);
78    sodium_memzero($bobKeyPair);
79    sodium_memzero($nonce);
80}
81
82// Execute the demonstration function.
83demonstrateSodiumCryptoBox();

PHPのSODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTESは、Sodium拡張機能で利用される定数です。これは、データの完全性と認証を保証するための「認証タグ」のバイトサイズを整数値で示します。この定数自体は引数を取らず、認証タグのバイト数を表す整数値を戻り値として提供します。

提供されたサンプルコードでは、sodium_crypto_box関数を用いた公開鍵認証暗号化の仕組みが説明されています。これは、アリスがボブへ秘密のメッセージを送るシナリオを模倣しており、アリスとボブがそれぞれの鍵ペアを生成し、メッセージを安全にやり取りする過程を示しています。

sodium_crypto_box関数はメッセージを暗号化する際に、暗号文の前に認証タグを付加します。この認証タグは、メッセージが途中で改ざんされていないか、また送信者が正しいかを検証するために使用される重要な部分です。サンプルコードでは、この認証タグのサイズがSODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTESの値(16バイト)と一致することを確認しています。

最終的に、ボブがメッセージを復号し、オリジナルのメッセージと一致することが検証されます。これにより、データの機密性、完全性、および認証が、この定数によって示される認証タグの役割と合わせて確認できます。

このサンプルコードでは、Nonce(ナンス)を同じ鍵ペアで決して再利用しないよう注意してください。Nonceはrandom_bytes関数で安全に生成し、都度新しいものを使用することが必須です。SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTESは認証タグのサイズを示し、sodium_crypto_boxの出力はその認証タグと暗号化されたメッセージが結合されたものです。sodium_crypto_box_open関数がfalseを返した場合、メッセージが改ざんされたか、鍵やNonceが誤っていることを示しますので、必ず戻り値を検証してください。暗号化時には送信者の秘密鍵と受信者の公開鍵、復号化時には受信者の秘密鍵と送信者の公開鍵を正しく組み合わせることが重要です。また、セキュリティ確保のため、秘密鍵などの機密データは処理後にsodium_memzeroでメモリから確実に消去するように心がけてください。

関連コンテンツ

関連IT用語

関連プログラミング言語