【PHP8.x】sodium_crypto_pwhash_str()関数の使い方

Copy
1<?php
2
3/**
4 * PHP sodium 拡張機能を使用してパスワードを安全にハッシュ化し、検証するサンプルです。
5 *
6 * sodium_crypto_pwhash_str は、入力されたパスワードから安全なハッシュ文字列を生成します。
7 * このハッシュは、元のパスワードの代わりにデータベースなどに保存され、
8 * 後でユーザー認証時にパスワードの正当性を検証するために使用されます。
9 *
10 * @param string $passwordToProcess ハッシュ化および検証に使用するパスワード文字列
11 * @return void
12 */
13function demonstrateSodiumPasswordHashing(string $passwordToProcess): void
14{
15    // PHP sodium 拡張機能がインストールされ、有効になっていることを前提とします。
16    // 本番環境では、extension_loaded('sodium') などで存在を確認することを推奨します。
17
18    echo "元のパスワード: " . $passwordToProcess . "\n\n";
19
20    // パスワードをハッシュ化します。
21    // SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE と SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE は、
22    // セキュリティとパフォーマンスのバランスが取れた推奨パラメータです。
23    // これらは、パスワードのハッシュ計算にかかる時間とメモリ使用量を制御し、
24    // ブルートフォース攻撃に対する耐性を高めます。
25    $hashedPassword = sodium_crypto_pwhash_str(
26        $passwordToProcess,
27        SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE, // 演算の複雑さ（CPU時間）の上限
28        SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE  // メモリ使用量の上限
29    );
30
31    echo "生成されたハッシュ: " . $hashedPassword . "\n\n";
32
33    // 生成されたハッシュと元のパスワードを使用して、パスワードの検証を行います。
34    // sodium_crypto_pwhash_str_verify は、元のパスワードを知ることなく、
35    // ユーザーが入力したパスワードが保存されたハッシュと一致するかを安全にチェックします。
36    if (sodium_crypto_pwhash_str_verify($hashedPassword, $passwordToProcess)) {
37        echo "パスワードの検証に成功しました。（元のパスワードと一致）\n";
38    } else {
39        echo "パスワードの検証に失敗しました。（これは通常発生しません！）\n";
40    }
41
42    // 意図的に異なるパスワードで検証を試みます。
43    $incorrectPassword = "a_different_password";
44    echo "\n異なるパスワード ('" . $incorrectPassword . "') で検証を試みます...\n";
45    if (sodium_crypto_pwhash_str_verify($hashedPassword, $incorrectPassword)) {
46        echo "異なるパスワードでも検証に成功しました。（セキュリティ上の重大な問題！）\n";
47    } else {
48        echo "異なるパスワードでの検証に失敗しました。（期待通りの動作）\n";
49    }
50}
51
52// サンプル関数の実行
53$userDefinedPassword = "MyStrongPassword_SE_123!";
54demonstrateSodiumPasswordHashing($userDefinedPassword);

PHPのSodium拡張機能は、現代のWebアプリケーションにおいてセキュリティを強化するための暗号化機能を提供しています。その中でも、sodium_crypto_pwhash_str関数は、ユーザーのパスワードを安全に処理するために非常に重要な役割を果たします。

この関数は、引数として指定された$password（元のパスワード）を受け取り、それを推測されにくい「ハッシュ文字列」に変換します。この変換プロセスは、引数$opslimit（演算の複雑さの上限）と$memlimit（メモリ使用量の上限）によって調整されます。これらのパラメータを設定することで、パスワードのハッシュ計算にかかる時間とメモリ使用量を制御し、悪意のあるブルートフォース攻撃からパスワードを守る強度を高めることができます。

関数は、安全に処理されたパスワードのハッシュを表すstring型の値を戻り値として返します。システムでは、元のパスワードを直接保存する代わりに、このハッシュ文字列をデータベースなどに保存します。ユーザーがログインする際には、入力されたパスワードを再度ハッシュ化し、sodium_crypto_pwhash_str_verify関数を使って保存されたハッシュと一致するかどうかを安全に検証します。これにより、万が一データベースが漏洩しても、実際のパスワードが流出するリスクを大幅に低減し、システム全体のセキュリティを向上させることが可能です。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのsodium拡張機能を使用してパスワードを安全にハッシュ化し、検証する方法を示します。
5 * sodium拡張機能（php-sodium.so）がPHPにロードされている必要があります。
6 */
7
8// サンプルパスワードを定義します。
9$password = 'MySuperSecurePassword123!';
10
11// sodium_crypto_pwhash_str 関数で使用するパラメータを定義します。
12// これらは、インタラクティブな用途に適した推奨されるセキュリティレベルを提供します。
13$opslimit = SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE;
14$memlimit = SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE;
15
16echo "元のパスワード: " . $password . "\n\n";
17
18// sodium_crypto_pwhash_str 関数を使ってパスワードをハッシュ化します。
19// この関数は、ランダムなソルトと指定された制限に基づいて、安全なパスワードハッシュを生成します。
20try {
21    if (!function_exists('sodium_crypto_pwhash_str')) {
22        throw new Exception('sodium_crypto_pwhash_str 関数が見つかりません。php-sodium 拡張機能が有効になっているか確認してください。');
23    }
24
25    $hashedPassword = sodium_crypto_pwhash_str($password, $opslimit, $memlimit);
26    echo "生成されたハッシュ: " . $hashedPassword . "\n\n";
27
28    // 生成されたハッシュを検証します。
29    // sodium_crypto_pwhash_str_verify 関数は、元のパスワードがハッシュと一致するかどうかを確認します。
30    // これは、ログイン時にユーザーが入力したパスワードと保存されたハッシュを比較する際に使用されます。
31    if (sodium_crypto_pwhash_str_verify($hashedPassword, $password)) {
32        echo "パスワードの検証に成功しました。\n";
33    } else {
34        echo "パスワードの検証に失敗しました。\n";
35    }
36
37    // 誤ったパスワードで検証を試みる例
38    $wrongPassword = 'WrongPassword';
39    echo "\n誤ったパスワード ('" . $wrongPassword . "') で検証を試みます。\n";
40    if (sodium_crypto_pwhash_str_verify($hashedPassword, $wrongPassword)) {
41        echo "誤ったパスワードの検証に成功しました。(これは起こるべきではありません!)\n";
42    } else {
43        echo "誤ったパスワードの検証に失敗しました。(期待される結果)\n";
44    }
45
46} catch (Exception $e) {
47    echo "エラー: " . $e->getMessage() . "\n";
48    echo "php-sodium 拡張機能がインストールされ、有効になっていることを確認してください。\n";
49}
50
51?>

PHPのsodium_crypto_pwhash_str関数は、ユーザーのパスワードを安全にハッシュ化するために使用される重要な機能です。この関数を利用することで、データベースに平文のパスワードを保存するリスクを避け、システム全体のセキュリティを大幅に向上させることができます。この機能を使うには、事前にPHPにphp-sodium.so拡張機能がロードされている必要があります。

引数には、ハッシュ化したい元のパスワードを文字列で渡す$password、計算処理にかかるCPU時間を制限する$opslimit、そして使用するメモリ量を制限する$memlimitを指定します。これらの制限値は、セキュリティとシステムパフォーマンスのバランスを取る上で非常に重要であり、サンプルコードではインタラクティブな用途に適した推奨値を使用しています。関数は処理後、元のパスワードとは異なる、安全にソルト処理されたパスワードハッシュの文字列を戻り値として返します。

サンプルコードでは、定義した元のパスワードをsodium_crypto_pwhash_strでハッシュ化し、生成されたハッシュを出力しています。その後、sodium_crypto_pwhash_str_verify関数を用いて、元のパスワードがこのハッシュと一致するかを検証する流れが示されています。これは、ユーザーがログインする際に、入力されたパスワードと保存されているハッシュを比較する一般的な方法です。万一、sodium拡張機能が有効でない場合は、エラーメッセージが表示されるようにエラーハンドリングも含まれています。