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

Copy
1<?php
2
3/**
4 * libsodium拡張機能を使用したパスワードのハッシュ化と検証のサンプル。
5 *
6 * このコードは、初心者システムエンジニアがパスワードの安全な取り扱いを理解するために、
7 * sodium_crypto_pwhash_scryptsalsa208sha256_str と
8 * sodium_crypto_pwhash_scryptsalsa208sha256_str_verify を使った基本的な流れを示します。
9 *
10 * sodium_crypto_pwhash_scryptsalsa208sha256_str_verify 関数は、提供されたパスワードが
11 * ハッシュ化されたパスワードと一致するかどうかを検証します。
12 * ハッシュ文字列には、ソルトやアルゴリズムパラメータが既に含まれているため、
13 * 検証時に別途ソルトを提供する必要はありません。
14 */
15function demonstrateSodiumPasswordVerification(): void
16{
17    $userPassword = 'MySecretPassword123!';
18    $wrongPassword = 'WrongPassword456';
19
20    echo "--- パスワードハッシュ化と検証のデモンストレーション ---\n\n";
21
22    // 1. パスワードをハッシュ化する (登録時を想定)
23    // sodium_crypto_pwhash_scryptsalsa208sha256_str は、パスワードを安全にハッシュ化し、
24    // 生成されたハッシュ文字列にはソルトとアルゴリズムのコストパラメータが含まれます。
25    // SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE と SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE は
26    // セキュリティとパフォーマンスのバランスを取るための計算コストを設定します。
27    $hashedPassword = sodium_crypto_pwhash_scryptsalsa208sha256_str(
28        $userPassword,
29        SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE,
30        SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE
31    );
32
33    echo "元のパスワード:  '" . $userPassword . "'\n";
34    echo "生成されたハッシュ: '" . $hashedPassword . "'\n\n";
35
36    // 2. 正しいパスワードで検証する (ログイン時を想定)
37    // sodium_crypto_pwhash_scryptsalsa208sha256_str_verify は、
38    // ハッシュ化されたパスワードと提供されたパスワードを比較し、真偽値を返します。
39    $isPasswordCorrect = sodium_crypto_pwhash_scryptsalsa208sha256_str_verify(
40        $hashedPassword,
41        $userPassword
42    );
43
44    if ($isPasswordCorrect) {
45        echo "正しいパスワード ('" . $userPassword . "') での検証: 成功！ (期待通り)\n";
46    } else {
47        echo "正しいパスワードでの検証: 失敗！ (エラー、これは起こるべきではありません)\n";
48    }
49
50    // 3. 間違ったパスワードで検証する (ログイン時を想定)
51    $isPasswordIncorrect = sodium_crypto_pwhash_scryptsalsa208sha256_str_verify(
52        $hashedPassword,
53        $wrongPassword
54    );
55
56    if (!$isPasswordIncorrect) {
57        echo "間違ったパスワード ('" . $wrongPassword . "') での検証: 失敗！ (期待通り)\n";
58    } else {
59        echo "間違ったパスワードでの検証: 成功！ (セキュリティ上の問題、これは起こるべきではありません)\n";
60    }
61
62    echo "\n--- デモンストレーション終了 ---\n";
63}
64
65// libsodium拡張機能が有効であることを確認
66if (!extension_loaded('sodium')) {
67    die('エラー: libsodium拡張機能がロードされていません。PHP設定で有効にしてください。');
68}
69
70// 関数を実行してデモンストレーションを開始
71demonstrateSodiumPasswordVerification();
72
73?>

このサンプルコードは、PHPのlibsodium拡張機能を利用したパスワードの安全なハッシュ化と検証のプロセスを、システムエンジニアを目指す初心者向けに示しています。特に、sodium_crypto_pwhash_scryptsalsa208sha256_str_verify関数の役割と使い方を具体的にデモンストレーションしています。

まず、ユーザーが登録した際のパスワード（例: 'MySecretPassword123!'）を、sodium_crypto_pwhash_scryptsalsa208sha256_str関数を使って安全なハッシュ文字列に変換します。このハッシュ文字列には、パスワードを保護するためのソルトや、セキュリティ強度を調整する計算コスト（アルゴリズムパラメータ）が自動的に含まれています。

次に、ユーザーがログイン時に入力したパスワードが、以前に保存したハッシュと一致するかどうかを確認するために、sodium_crypto_pwhash_scryptsalsa208sha256_str_verify関数を使用します。この関数は、第1引数にデータベースなどに保存されている「ハッシュ化されたパスワード（$hash）」を、第2引数にユーザーが入力した「検証したい生のパスワード（$password）」を受け取ります。関数は、提供された生のパスワードがハッシュ化されたパスワードと一致すれば論理値trueを、一致しなければfalseを戻り値として返します。ハッシュ文字列にソルト情報が含まれているため、検証時に別途ソルトを指定する必要はありません。

このコードを実行することで、正しいパスワードで検証が成功し、間違ったパスワードでは失敗するという、パスワード検証の基本的なセキュリティメカニズムを実際に確認できます。

Copy
1<?php
2
3/**
4 * このスクリプトは、libナトリウムの scrypt ベースのパスワードハッシュ検証関数
5 * `sodium_crypto_pwhash_scryptsalsa208sha256_str_verify` の使用方法を示します。
6 *
7 * この関数は、`sodium_crypto_pwhash_scryptsalsa208sha256_str` で生成されたハッシュと、
8 * 提供されたプレーンテキストパスワードが一致するかどうかを確認するために使用されます。
9 * ソルトやコストパラメータはハッシュ文字列自体に含まれているため、別途管理する必要はありません。
10 */
11
12// 1. テスト用のプレーンテキストパスワードを定義します。
13$password = 'MySecretPassword123!';
14
15// 2. パスワードのハッシュを生成します。
16//    `sodium_crypto_pwhash_scryptsalsa208sha256_str` は、ランダムなソルトと運用制限を
17//    含んだ、検証可能な文字列形式のハッシュを生成します。
18//    運用制限 (opslimit, memlimit) は、ハッシュ生成の計算コストを定義します。
19//    これらはセキュリティとパフォーマンスのバランスを取るために重要です。
20try {
21    $hash = sodium_crypto_pwhash_scryptsalsa208sha256_str(
22        $password,
23        SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE, // 中程度の演算制限
24        SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE  // 中程度のメモリ制限
25    );
26
27    echo "--- パスワードハッシュの生成と検証 ---" . PHP_EOL;
28    echo "元のパスワード: " . $password . PHP_EOL;
29    echo "生成されたハッシュ: " . $hash . PHP_EOL . PHP_EOL;
30
31    // 3. 正しいパスワードを使用してハッシュを検証します。
32    //    `sodium_crypto_pwhash_scryptsalsa208sha256_str_verify` は、ハッシュ文字列から
33    //    必要な情報（ソルト、コストパラメータなど）を自動的に抽出し、検証を行います。
34    $isCorrect = sodium_crypto_pwhash_scryptsalsa208sha256_str_verify($hash, $password);
35
36    echo "正しいパスワード ('" . $password . "') で検証中..." . PHP_EOL;
37    if ($isCorrect) {
38        echo "結果: 検証成功。パスワードは一致します。" . PHP_EOL . PHP_EOL;
39    } else {
40        echo "結果: 検証失敗。パスワードは一致しません (予期せぬエラー)。" . PHP_EOL . PHP_EOL;
41    }
42
43    // 4. 間違ったパスワードを使用してハッシュを検証します。
44    $wrongPassword = 'WrongPassword456!';
45    $isIncorrect = sodium_crypto_pwhash_scryptsalsa208sha256_str_verify($hash, $wrongPassword);
46
47    echo "間違ったパスワード ('" . $wrongPassword . "') で検証中..." . PHP_EOL;
48    if ($isIncorrect) {
49        echo "結果: 検証成功 (予期せぬエラー)。間違ったパスワードが一致しました。" . PHP_EOL;
50    } else {
51        echo "結果: 検証失敗。間違ったパスワードは一致しません (期待通り)。" . PHP_EOL;
52    }
53
54} catch (SodiumException $e) {
55    // libsodium 関連のエラーを捕捉します。
56    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
57} catch (Exception $e) {
58    // その他の一般的なエラーを捕捉します。
59    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
60}
61
62?>

sodium_crypto_pwhash_scryptsalsa208sha256_str_verify 関数は、PHP 8で利用可能なlibsodiumライブラリを通じて、セキュアなパスワードの検証を行うための機能です。この関数は、あらかじめ sodium_crypto_pwhash_scryptsalsa208sha256_str 関数によって生成されデータベースなどに保存されているパスワードハッシュと、ユーザーが入力したプレーンテキストのパスワードが一致するかどうかを安全に確認するために使用されます。

第一引数 $hash には、sodium_crypto_pwhash_scryptsalsa208sha256_str で生成されたハッシュ文字列を渡します。このハッシュ文字列には、パスワードの安全性を高めるためのランダムな「salt（ソルト）」や、ハッシュ生成に要した計算コスト（運用制限やメモリ制限）といった情報がすべて含まれています。第二引数 $password には、検証したいプレーンテキストのパスワードを渡してください。

この関数は、受け取ったハッシュ文字列から自動的にソルトやコストパラメータを抽出し、提供されたパスワードを使用してハッシュを再計算します。そして、その結果と元のハッシュが一致するかを比較します。両者が一致すれば true（真）を、一致しなければ false（偽）を戻り値として返します。これにより、セキュリティを確保しつつ、ユーザーの認証を行うことが可能です。