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

Copy
1<?php
2
3/**
4 * PHPのLibSodium拡張にある定数 SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN を
5 * 使用したサンプルコードです。
6 *
7 * この定数は、ジェネリックハッシュ関数 (sodium_crypto_generichash) で使用するキーの
8 * 最小バイト数を示します。
9 * LibSodium拡張は、暗号化関連の様々な関数を提供しており、
10 * キーワードにある sodium_crypto_box などの公開鍵暗号化/復号化機能も含まれます。
11 *
12 * システムエンジニアを目指す初心者の方にも分かりやすいように、
13 * 定数の値の確認と、それを使ったハッシュ生成の基本的な流れを示します。
14 */
15function demonstrateSodiumGenerichashMinKeyUsage(): void
16{
17    // sodium拡張が有効か確認します。
18    // PHPで暗号化機能を使う前に、拡張が正しくインストールされているかを確認することが重要です。
19    if (!extension_loaded('sodium')) {
20        echo "エラー: 'sodium' 拡張がロードされていません。\n";
21        echo "php.iniで 'extension=sodium' が有効になっているか確認してください。\n";
22        return;
23    }
24
25    echo "--- LibSodium ジェネリックハッシュキー最小バイト数デモンストレーション ---\n\n";
26
27    // SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN 定数の値を取得し表示します。
28    // この定数は、ジェネリックハッシュ関数で使用するキーの最小バイト数を定義しています。
29    $minKeyBytes = SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN;
30    echo "SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN (最小キーバイト数): " . $minKeyBytes . " バイト\n\n";
31
32    // ジェネリックハッシュ用のキーを生成します。
33    // sodium_crypto_generichash_keygen() は、ジェネリックハッシュに適した長さ (通常32バイト) の
34    // ランダムなキーを生成します。この長さは SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN (16バイト) 以上です。
35    $key = sodium_crypto_generichash_keygen();
36
37    // 生成されたキーの長さを確認します。
38    echo "生成されたハッシュキーの長さ: " . strlen($key) . " バイト\n";
39    echo "キー (16進数): " . bin2hex($key) . "\n\n";
40
41    // ハッシュ化する元のデータ（メッセージ）を定義します。
42    $message = "これはLibSodiumのジェネリックハッシュでハッシュ化するメッセージです。";
43    echo "元のメッセージ: '" . $message . "'\n\n";
44
45    // 定義されたキーとメッセージを使用してジェネリックハッシュを計算します。
46    // sodium_crypto_generichash() は、入力データとキーから固定長のハッシュ値を生成します。
47    $hash = sodium_crypto_generichash($message, $key);
48
49    // 生成されたハッシュを表示します。
50    // ハッシュ値はバイナリデータなので、可読性のため16進数にエンコードして表示します。
51    echo "生成されたジェネリックハッシュ (16進数): " . bin2hex($hash) . "\n\n";
52
53    // 補足:
54    // LibSodium拡張には、ハッシュ関数以外にも強力な暗号機能が多数含まれています。
55    // 例えば、キーワードに挙げられた `sodium_crypto_box` は、
56    // 公開鍵と秘密鍵のペアを使って安全にメッセージを暗号化・復号化するための関数群です。
57    // 具体的には `sodium_crypto_box_keypair()` で鍵ペアを生成し、
58    // `sodium_crypto_box()` で暗号化、`sodium_crypto_box_open()` で復号化を行います。
59}
60
61// 関数の実行
62demonstrateSodiumGenerichashMinKeyUsage();
63
64?>

PHPのLibSodium拡張は、安全な暗号機能を提供する重要なツールです。このサンプルコードは、LibSodium拡張が持つ定数の一つである SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN の使い方と、それに関連するジェネリックハッシュ処理の基本的な流れをシステムエンジニアを目指す初心者の方にも分かりやすく説明しています。

SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN は、ジェネリックハッシュ関数 sodium_crypto_generichash で使用する暗号キーの最小バイト数を示す整数値（int）です。この定数の値は16バイトであり、ジェネリックハッシュを行う際に必要なキーの安全な下限を定義しています。

コードではまず、sodium 拡張がPHPにロードされているかを確認しています。これは、暗号機能を利用する上で必須の事前チェックです。次に、SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN の値を取得・表示し、その後に sodium_crypto_generichash_keygen() 関数を使って、ジェネリックハッシュに適した長さのキーを生成しています。この関数は引数を取らず、安全なランダムなバイナリ文字列を戻り値として返します。そして、生成されたキーと任意のメッセージを用いて sodium_crypto_generichash() 関数でハッシュ値を計算し、その結果を16進数で表示しています。

LibSodium拡張には、この他にも強力な暗号機能が多数含まれており、キーワードにある sodium_crypto_box は、公開鍵と秘密鍵のペアを用いたメッセージの暗号化と復号化を行うための関数群です。これらの機能は、データの安全性やプライバシー保護に不可欠であり、セキュアなシステム開発において非常に重要な役割を果たします。

Copy
1<?php
2
3/**
4 * libsodium 拡張の sodium_crypto_secretbox 関数を使用して、
5 * 認証付き暗号化と復号化を行うサンプルです。
6 *
7 * この関数は、メッセージの機密性（暗号化）と完全性（改ざん防止）の両方を保護します。
8 * システムエンジニアを目指す初心者向けに、鍵の生成、メッセージの暗号化、
9 * そして復号化の基本的な流れを示します。
10 * 暗号文が改ざんされた場合に復号化が失敗することも確認します。
11 *
12 * @param string $originalMessage 暗号化する元の平文メッセージ。
13 * @return void
14 */
15function demonstrateAuthenticatedEncryption(string $originalMessage): void
16{
17    echo "--- libsodium を用いた認証付き暗号化のデモンストレーション ---\n\n";
18
19    // 1. 秘密鍵の生成
20    // sodium_crypto_secretbox_keygen() は、secretbox に必要な長さの安全な鍵を生成します。
21    // SODIUM_CRYPTO_SECRETBOX_KEYBYTES 定数で鍵の推奨バイト長を確認できます。
22    $key = sodium_crypto_secretbox_keygen();
23    echo "生成された秘密鍵の長さ: " . strlen($key) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_KEYBYTES . ")\n";
24    // 実際には鍵を直接表示すべきではありませんが、デモンストレーションのため出力します。
25    echo "秘密鍵 (Base64エンコード): " . base64_encode($key) . "\n\n";
26
27    // 2. ナンス（Nonce: Number used once）の生成
28    // 各暗号化操作でユニークなナンスを使用することが極めて重要です。
29    // SODIUM_CRYPTO_SECRETBOX_NONCEBYTES 定数でナンスの推奨バイト長を確認できます。
30    $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
31    echo "生成されたナンスの長さ: " . strlen($nonce) . " バイト (期待値: " . SODIUM_CRYPTO_SECRETBOX_NONCEBYTES . ")\n";
32    echo "ナンス (Base64エンコード): " . base64_encode($nonce) . "\n\n";
33
34    echo "元のメッセージ: \"" . $originalMessage . "\"\n\n";
35
36    // 3. メッセージの暗号化
37    // sodium_crypto_secretbox() は、メッセージを秘密鍵とナンスで暗号化し、
38    // 認証タグ（改ざん検知用データ）を付加した暗号文を返します。
39    $ciphertext = sodium_crypto_secretbox($originalMessage, $nonce, $key);
40    echo "暗号化されたメッセージの長さ: " . strlen($ciphertext) . " バイト\n";
41    // 暗号文はバイナリデータなので、表示のためにBase64エンコードします。
42    echo "暗号文 (Base64エンコード): " . base64_encode($ciphertext) . "\n\n";
43
44    // 4. 暗号文の復号化 (成功例)
45    echo "--- 復号化の試み (成功例) ---\n";
46    // sodium_crypto_secretbox_open() は、暗号文、ナンス、鍵を使ってメッセージを復号化します。
47    // 復号化と同時に認証タグを検証し、改ざんされていなければ平文を返します。
48    // 改ざんされていたり、鍵やナンスが間違っている場合は false を返します。
49    $decryptedMessage = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
50
51    if ($decryptedMessage === false) {
52        echo "エラー: 復号化に失敗しました。\n";
53    } else {
54        echo "復号化されたメッセージ: \"" . $decryptedMessage . "\"\n";
55        echo "メッセージは正常に復号化されました。これは元のメッセージと一致します。\n\n";
56    }
57
58    // 5. 暗号文を改ざんし、復号化が失敗することを確認する (認証失敗例)
59    echo "--- 復号化の試み (認証失敗例: 暗号文の改ざん) ---\n";
60    // 暗号文の一部を意図的に変更して、改ざんされた状態を作ります。
61    $tamperedCiphertext = $ciphertext;
62    // 例えば、暗号文の最後のバイトを反転させます
63    $tamperedCiphertext[strlen($tamperedCiphertext) - 1] = chr(ord($tamperedCiphertext[strlen($tamperedCiphertext) - 1]) ^ 0xFF);
64    echo "改ざんされた暗号文の長さ: " . strlen($tamperedCiphertext) . " バイト\n";
65    echo "改ざんされた暗号文 (Base64エンコード): " . base64_encode($tamperedCiphertext) . "\n\n";
66
67    $tamperedDecryptedMessage = sodium_crypto_secretbox_open($tamperedCiphertext, $nonce, $key);
68
69    if ($tamperedDecryptedMessage === false) {
70        echo "成功: 改ざんされた暗号文の復号化は失敗しました。\n";
71        echo "これは、libsodium の認証付き暗号化がメッセージの改ざんを検知し、\n";
72        echo "安全でないデータが復号化されるのを防いでいることを示しています。\n";
73    } else {
74        echo "エラー: 改ざんされた暗号文が復号化されてしまいました。これは予期しない動作です。\n";
75    }
76    echo "\n----------------------------------------------------\n";
77}
78
79// PHP sodium 拡張が利用可能かを確認します。
80if (extension_loaded('sodium')) {
81    // サンプル関数の実行
82    demonstrateAuthenticatedEncryption("こんにちは、システムエンジニアの皆さん！これは極秘メッセージです。");
83} else {
84    echo "エラー: PHP sodium 拡張がロードされていません。\n";
85    echo "このサンプルコードを実行するには、libsodium 拡張を有効にする必要があります。\n";
86}

このサンプルコードは、PHPのlibsodium拡張機能を利用し、sodium_crypto_secretbox関数を用いてメッセージの認証付き暗号化と復号化を行う基本的な方法を示しています。この機能は、秘密鍵と一度しか使わない「ナンス」と呼ばれる値を使い、メッセージの機密性（暗号化）と完全性（改ざん防止）の両方を保護します。

サンプルでは、まず秘密鍵とナンスを生成し、sodium_crypto_secretboxで指定された平文メッセージを暗号化します。次に、sodium_crypto_secretbox_openでこの暗号文を復号化して元のメッセージを取り出します。この復号化関数は、暗号文が改ざんされていないかを自動的に検証し、もし改ざんが検知された場合は復号化を拒否してデータの不正利用を防ぎます。

このdemonstrateAuthenticatedEncryption関数は、暗号化する元の平文メッセージを$originalMessage（文字列）として受け取り、暗号化および復号化の過程と結果を画面に表示するのみで、特定の戻り値はありません（void）。このコードは、安全なデータ通信や保存に不可欠な認証付き暗号化の基本的な流れと、その強固なセキュリティ特性をシステムエンジニアを目指す初心者の方々に示すものです。