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

Copy
1<?php
2
3// PHP Sodium拡張機能が有効になっているかを確認します。
4// システムエンジニアを目指す上で、必要な拡張機能が利用可能か確認することは重要です。
5if (!extension_loaded('sodium')) {
6    die('PHP Sodium拡張機能が有効になっていません。このスクリプトを実行するには有効化してください。');
7}
8
9/**
10 * Sodium拡張機能を使用してパスワードをハッシュ化および検証する方法を示します。
11 *
12 * SODIUM_CRYPTO_PWHASH_ALG_DEFAULT定数は、パスワードハッシュ化に使用される
13 * デフォルトのアルゴリズム（現在、Argon2id13）を指定します。
14 * Sodiumは、パスワードの安全な保存など、セキュリティ関連の操作に強力な暗号プリミティブを提供します。
15 * この関数は、システムエンジニアが学ぶべき基本的なセキュリティ実践を示します。
16 */
17function demonstratePasswordHashingWithSodium(): void
18{
19    echo "--- PHP Sodium パスワードハッシュ化デモンストレーション ---\n\n";
20
21    // SODIUM_CRYPTO_PWHASH_ALG_DEFAULTは、パスワードハッシュ化のデフォルトアルゴリズムを
22    // 示す整数定数です。
23    echo "SODIUM_CRYPTO_PWHASH_ALG_DEFAULTの値: " . SODIUM_CRYPTO_PWHASH_ALG_DEFAULT . "\n\n";
24
25    $password = 'mySecretPa$$word123';
26    echo "元のパスワード: " . $password . "\n";
27
28    // パスワードハッシュ化のためのパラメータを定義します。
29    // これらのパラメータは、セキュリティとパフォーマンスのバランスに基づいて選択されます。
30    // SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE: 実行する操作の制限（CPUコスト）。
31    // SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE: 使用するメモリの制限。
32    // SODIUM_CRYPTO_PWHASH_ALG_DEFAULT: 使用するパスワードハッシュ化アルゴリズム。
33    $opslimit = SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE;
34    $memlimit = SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE;
35    $alg = SODIUM_CRYPTO_PWHASH_ALG_DEFAULT; // ここで定数を使用します
36
37    echo "使用するアルゴリズムID: " . $alg . " (SODIUM_CRYPTO_PWHASH_ALG_DEFAULT)\n";
38    echo "使用する操作制限: " . $opslimit . " (SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE)\n";
39    echo "使用するメモリ制限: " . $memlimit . "バイト (SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE)\n\n";
40
41    // 暗号学的に安全なランダムなソルトを生成します。
42    // SODIUM_CRYPTO_PWHASH_SALTBYTESは、ソルトに必要な長さを指定します。
43    $salt = random_bytes(SODIUM_CRYPTO_PWHASH_SALTBYTES);
44
45    // sodium_crypto_pwhash関数を使用してパスワードをハッシュ化します。
46    // 最初の引数（64）は、生成されるハッシュ（導出キー）の望ましい長さです。
47    $hashedPassword = sodium_crypto_pwhash(
48        64, // 導出キー（ハッシュ化されたパスワード）の出力長
49        $password,
50        $salt,
51        $opslimit,
52        $memlimit,
53        $alg // SODIUM_CRYPTO_PWHASH_ALG_DEFAULT定数をアルゴリズムとして渡します
54    );
55
56    echo "生成されたソルト (hex): " . bin2hex($salt) . "\n";
57    echo "ハッシュ化されたパスワード (hex): " . bin2hex($hashedPassword) . "\n\n";
58
59    // --- パスワードの検証 ---
60    echo "--- パスワードの検証 ---\n";
61
62    // ユーザーが入力したパスワードを検証するには、元のハッシュ化に使用した
63    // *全く同じ*ソルトとパラメータ（opslimit, memlimit, alg）を使用して再度ハッシュ化します。
64    // その後、新たに生成されたハッシュを、格納されているハッシュと
65    // タイミング攻撃に強い比較関数（hash_equals）で比較します。
66
67    $providedPassword = 'mySecretPa$$word123'; // ユーザーが入力したと仮定
68    $incorrectPassword = 'wrongPassword';     // 誤ったパスワードを入力したと仮定
69
70    // 検証試行1: 正しいパスワードの場合
71    $verifiedHash = sodium_crypto_pwhash(
72        64,
73        $providedPassword,
74        $salt,
75        $opslimit,
76        $memlimit,
77        $alg
78    );
79
80    if (hash_equals($hashedPassword, $verifiedHash)) {
81        echo "検証成功: 提供されたパスワードは保存されたハッシュと一致します。\n";
82    } else {
83        echo "検証失敗: 提供されたパスワードは保存されたハッシュと一致しません。\n";
84    }
85
86    // 検証試行2: 間違ったパスワードの場合
87    $verifiedHashIncorrect = sodium_crypto_pwhash(
88        64,
89        $incorrectPassword,
90        $salt,
91        $opslimit,
92        $memlimit,
93        $alg
94    );
95
96    if (hash_equals($hashedPassword, $verifiedHashIncorrect)) {
97        echo "検証成功 (予期せぬ結果): 間違ったパスワードが一致しました！\n";
98    } else {
99        echo "検証失敗 (予期された結果): 間違ったパスワードは保存されたハッシュと一致しません。\n";
100    }
101}
102
103// デモンストレーション関数を実行します。
104demonstratePasswordHashingWithSodium();

PHPのSodium拡張機能は、ウェブアプリケーションのセキュリティを強化するための強力な暗号機能を提供します。特にパスワードの安全な取り扱いはシステムエンジニアにとって非常に重要です。

SODIUM_CRYPTO_PWHASH_ALG_DEFAULTは、Sodium拡張が提供する定数の一つで、パスワードをハッシュ化する際に使用されるデフォルトのアルゴリズム（現在ではArgon2id13）を示す整数値を返します。この定数には引数がありません。

サンプルコードでは、この定数を使ってパスワードを安全にハッシュ化し、その後に検証する一連の流れを示しています。sodium_crypto_pwhash関数は、元のパスワード、ランダムに生成されたソルト、操作コストやメモリコストといったセキュリティパラメータ、そしてハッシュアルゴリズムとしてSODIUM_CRYPTO_PWHASH_ALG_DEFAULTを指定して呼び出されます。これにより、元のパスワードから一方向のハッシュ値が生成され、データベースなどに安全に保存できるようになります。

パスワードを検証する際には、ユーザーが入力したパスワードを、保存時と全く同じソルトとパラメータ、そしてSODIUM_CRYPTO_PWHASH_ALG_DEFAULTで再度ハッシュ化します。生成されたハッシュ値は、hash_equals関数を用いて、保存されているハッシュ値と比較することで、入力されたパスワードが正しいか安全に判断できます。このように、SODIUM_CRYPTO_PWHASH_ALG_DEFAULTは、パスワード管理におけるセキュリティ実践の基盤となる重要な定数です。

Copy
1<?php
2
3/**
4 * PHP Sodium拡張の定数とAEAD暗号化の基本デモンストレーション。
5 *
6 * システムエンジニアを目指す初心者向けに、
7 * Sodium拡張の重要な定数の使い方と、AEAD (Authenticated Encryption with Associated Data)
8 * を使ったデータの暗号化・復号化の基本的な流れを示します。
9 *
10 * PHP 8の推奨コーディングスタイルに従っています。
11 */
12function demonstrateSodiumConstantsAndAEAD(): void
13{
14    // ---------- プログラミング言語リファレンス情報で指定された定数 ----------
15    // SODIUM_CRYPTO_PWHASH_ALG_DEFAULT
16    // これはパスワードハッシュ関数 (pwhash) のデフォルトアルゴリズムを表す定数です。
17    // その値は整数型 (int) で、具体的なアルゴリズムIDを示します。
18    // 直接的なAEAD暗号化には使用しませんが、Sodium拡張の別の重要な機能で使われます。
19    echo "SODIUM_CRYPTO_PWHASH_ALG_DEFAULT の値: " . SODIUM_CRYPTO_PWHASH_ALG_DEFAULT . PHP_EOL;
20    echo PHP_EOL; // 空行で区切り
21
22    // ---------- キーワードに最も関連性の高い定数とAEAD暗号化のデモンストレーション ----------
23    // sodium_crypto_aead_aes256gcm_npubbytes
24    // これは、AES256-GCM暗号化で使用するノンス (Nonce: Number used once) の推奨バイト長を示す定数です。
25    // ノンスは暗号化のたびに異なる値を使用し、セキュリティを確保するために重要です。
26    $nonceLength = sodium_crypto_aead_aes256gcm_npubbytes;
27    echo "sodium_crypto_aead_aes256gcm_npubbytes (ノンス長): " . $nonceLength . " バイト" . PHP_EOL;
28
29    // AEAD (Authenticated Encryption with Associated Data) の基本操作
30    // AEADは、データの機密性 (暗号化) と完全性 (改ざん検出) の両方を保証します。
31
32    // 1. 秘密鍵の生成
33    // AES256-GCMに使用する256ビット (32バイト) の鍵を生成します。
34    // この鍵は秘密に保たれなければなりません。
35    $key = sodium_crypto_aead_aes256gcm_keygen();
36    echo "秘密鍵を生成しました (生データは表示しません)。" . PHP_EOL;
37
38    // 2. 暗号化するメッセージと追加認証データ (AAD) の準備
39    $message = "システムエンジニアの学習は楽しいです！";
40    // associatedData (追加認証データ) は、暗号化はされないが、改ざん防止の対象となるデータです。
41    // 例えば、メッセージの受信者IDやタイムスタンプなどが考えられます。
42    $associatedData = "user_id_12345";
43
44    echo "元のメッセージ: " . $message . PHP_EOL;
45    echo "追加認証データ: " . $associatedData . PHP_EOL;
46
47    // 3. ノンスの生成
48    // ノンスは毎回異なるランダムな値でなければなりません。
49    // 長さは sodium_crypto_aead_aes256gcm_npubbytes で定義された値を使用します。
50    $nonce = random_bytes($nonceLength);
51    // ノンス自体は秘密である必要はありませんが、重複してはいけません。
52    // 暗号文と一緒に保存し、復号化時に同じものを使用します。
53    echo "ノンスを生成しました (生データは表示しません)。" . PHP_EOL;
54
55    // 4. データの暗号化
56    // sodium_crypto_aead_aes256gcm_encrypt 関数を使用してメッセージを暗号化します。
57    $ciphertext = sodium_crypto_aead_aes256gcm_encrypt(
58        $message,        // 暗号化するメッセージ
59        $associatedData, // 追加認証データ (省略可能)
60        $nonce,          // ノンス
61        $key             // 秘密鍵
62    );
63
64    // 暗号文はバイナリデータなので、表示のためにBase64エンコードします。
65    echo "暗号文 (Base64エンコード): " . base64_encode($ciphertext) . PHP_EOL;
66
67    // 5. データの復号化
68    // sodium_crypto_aead_aes256gcm_decrypt 関数を使用して暗号文を復号化します。
69    // 復号化には、暗号化時と同じ秘密鍵、ノンス、追加認証データが必要です。
70    $decryptedMessage = sodium_crypto_aead_aes256gcm_decrypt(
71        $ciphertext,     // 暗号文
72        $associatedData, // 暗号化時と同じ追加認証データ
73        $nonce,          // 暗号化時と同じノンス
74        $key             // 暗号化時と同じ秘密鍵
75    );
76
77    // 復号化が失敗した場合 (例: データ改ざん、鍵やノンスの不一致)、falseが返されます。
78    if ($decryptedMessage === false) {
79        echo "エラー: 復号化に失敗しました。データが改ざんされたか、鍵/ノンス/AADが一致しません。" . PHP_EOL;
80    } else {
81        echo "復号化されたメッセージ: " . $decryptedMessage . PHP_EOL;
82    }
83
84    // 意図的に追加認証データを改ざんして復号化を失敗させる例
85    echo PHP_EOL;
86    echo "--- 意図的にAADを改ざんして復号化を失敗させる例 ---" . PHP_EOL;
87    $tamperedAssociatedData = "wrong_user_id";
88    $failedDecryption = sodium_crypto_aead_aes256gcm_decrypt(
89        $ciphertext,
90        $tamperedAssociatedData, // ここを改ざん
91        $nonce,
92        $key
93    );
94
95    if ($failedDecryption === false) {
96        echo "復号化に失敗しました (AADの不一致を検出)。セキュリティ機能が正常に動作しています。" . PHP_EOL;
97    } else {
98        echo "エラー: 復号化が成功してしまいました (これは予期せぬ動作です)。" . PHP_EOL;
99    }
100}
101
102// 関数の実行
103demonstrateSodiumConstantsAndAEAD();
104
105?>

このPHPコードは、Sodium拡張を利用した基本的な暗号化のデモンストレーションです。 まず、SODIUM_CRYPTO_PWHASH_ALG_DEFAULTという定数の値を出力しています。これはパスワードハッシュ機能のデフォルトアルゴリズムを示す整数型の定数で、直接的なデータ暗号化とは異なり、主にパスワードの安全な保存に用いられます。

次に、sodium_crypto_aead_aes256gcm_npubbytesという定数を使用して、AEAD (Authenticated Encryption with Associated Data) 暗号化の主要な機能を示します。この定数は、AES256-GCM方式でデータを暗号化する際に必要な「ノンス」（Number used once、使い捨ての数）の推奨バイト長を整数型で返します。ノンスは暗号化ごとに異なる値を用いることでセキュリティを強化します。

コードでは、まず秘密鍵を生成し、暗号化するメッセージと「追加認証データ」(AAD)を準備します。AADはメッセージと一緒に認証されますが、暗号化はされないデータです。その後、random_bytes関数と先の定数で生成したノンスを用いて、sodium_crypto_aead_aes256gcm_encrypt関数でメッセージを暗号化します。この関数はメッセージ、AAD、ノンス、鍵を引数として受け取り、暗号文を返します。

復号化にはsodium_crypto_aead_aes256gcm_decrypt関数を使用し、暗号文、AAD、ノンス、鍵を引数として渡します。この関数は、引数が全て一致し、データが改ざんされていない場合に元のメッセージを返します。もしデータが改ざんされたり、引数が一致しない場合はfalseを返すため、データの完全性を検証できる点がAEADの大きな特徴です。コードの最後の例では、意図的にAADを改ざんして復号が失敗することを示し、セキュリティ機能の動作を確認しています。