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

Copy
1<?php
2
3/**
4 * Libsodium を使ってパスワードをハッシュ化し、検証するサンプルコード。
5 *
6 * このスクリプトは、システムエンジニアを目指す初心者向けに、
7 * PHPのSodium拡張機能におけるパスワードハッシュの基本を実演します。
8 * SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE 定数の使用例を含みます。
9 *
10 * Libsodiumは、モダンで使いやすい暗号化機能を提供するPHP拡張です。
11 * パスワードのハッシュ化は、セキュリティ上、生のパスワードをデータベースに
12 * 保存する代わりに、不可逆な文字列（ハッシュ）に変換して保存する重要な手法です。
13 */
14
15// Sodium拡張が有効になっているかを確認します。
16// これにより、Sodiumが利用できない環境でのエラーを防ぎます。
17if (!extension_loaded('sodium')) {
18    echo "エラー: Sodium拡張がインストールされていないか、有効になっていません。\n";
19    echo "php.ini で 'extension=sodium.so' (Linux) または 'extension=sodium.dll' (Windows) を有効にしてください。\n";
20    exit(1);
21}
22
23// 必要な定数が定義されているかを確認します。
24// SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE はPHP 8.0以降のSodium拡張で利用可能です。
25if (!defined('SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE') || !defined('SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE')) {
26    echo "エラー: 必要なSodium定数が見つかりません。\n";
27    echo "PHPのバージョンが8以上であり、Sodium拡張が正しくインストールされていることを確認してください。\n";
28    exit(1);
29}
30
31// ハッシュ化するプレーンテキストのパスワードを定義します。
32$plainTextPassword = 'MySecureUserPassword123!';
33
34echo "元のパスワード: " . $plainTextPassword . "\n";
35
36// パスワードをハッシュ化します。
37// sodium_crypto_pwhash_str は、パスワードハッシュを安全に生成する推奨関数です。
38//
39// SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE: 操作制限 (CPU時間)。高いほど処理が遅くなり、攻撃に対する耐性が向上します。
40// SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE: メモリ制限。高いほど多くのメモリを使用し、攻撃に対する耐性が向上します。
41// 'SENSITIVE' という設定は、特に機密性の高いパスワードに適した、より高いセキュリティレベルを提供します。
42$hashedPassword = sodium_crypto_pwhash_str(
43    $plainTextPassword,
44    SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE,  // CPU時間に関するセキュリティレベル
45    SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE   // メモリ使用に関するセキュリティレベル
46);
47
48if ($hashedPassword === false) {
49    echo "エラー: パスワードのハッシュ化に失敗しました。\n";
50    exit(1);
51}
52
53echo "ハッシュ化されたパスワード: " . $hashedPassword . "\n\n";
54
55// ハッシュ化されたパスワードの検証を行います。
56// これは、ユーザーがログインを試みた際に、入力されたパスワードと
57// データベースに保存されたハッシュを比較するプロセスをシミュレートします。
58
59// 1. 正しいパスワードで検証を試みます。
60$isVerifiedCorrect = sodium_crypto_pwhash_str_verify($hashedPassword, $plainTextPassword);
61
62echo "正しいパスワード ('" . $plainTextPassword . "') で検証: ";
63if ($isVerifiedCorrect) {
64    echo "成功しました。パスワードは一致します。\n";
65} else {
66    echo "失敗しました。パスワードは一致しません。(これは予期せぬ結果です！)\n";
67}
68
69// 2. 間違ったパスワードで検証を試みます。
70$wrongPassword = 'IncorrectPassword456!';
71$isVerifiedWrong = sodium_crypto_pwhash_str_verify($hashedPassword, $wrongPassword);
72
73echo "間違ったパスワード ('" . $wrongPassword . "') で検証: ";
74if ($isVerifiedWrong) {
75    echo "成功しました。パスワードは一致します。(これは予期せぬ結果です！)\n";
76} else {
77    echo "失敗しました。パスワードは一致しません。\n";
78}
79
80?>

このPHPサンプルコードは、Libsodium拡張機能を用いてパスワードを安全にハッシュ化し、その検証を行う方法をシステムエンジニアを目指す初心者向けに紹介しています。Libsodiumは、PHPでモダンな暗号化機能を利用するための拡張機能で、パスワードハッシュ化は、ユーザーの生パスワードをデータベースに直接保存せず、不可逆な文字列（ハッシュ）に変換して保存する重要なセキュリティ対策です。

コードではまず、Sodium拡張が有効か、必要な定数が定義されているかを確認しています。その後、sodium_crypto_pwhash_str関数を使用してプレーンテキストのパスワードをハッシュ化します。ここで登場するSODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE定数は、パスワードハッシュ処理において利用されるメモリの上限を示す整数値です。この定数には引数がなく、常に整数値を返します。「SENSITIVE」という名称が示す通り、機密性の高いパスワード保護に適した、より高いセキュリティレベルを提供するために推奨されるメモリ制限値を表します。この値をsodium_crypto_pwhash_str関数に渡すことで、ハッシュ生成時に割り当てるメモリ量を指定し、ブルートフォース攻撃に対する耐性を向上させることができます。

sodium_crypto_pwhash_str関数は、指定されたパスワードとセキュリティレベルに基づいてハッシュ文字列を生成し、成功すればハッシュを、失敗すればfalseを返します。次に、sodium_crypto_pwhash_str_verify関数を使って、保存されたハッシュと入力されたパスワードが一致するかを検証します。この関数は、一致すればtrue、一致しなければfalseを返します。これにより、ユーザーのログイン時にパスワードの正当性を安全に確認できる仕組みが実現されます。

Copy
1<?php
2
3/**
4 * SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE を使用したパスワードハッシュのデモ関数。
5 *
6 * 指定されたパスワードを `SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE` 定数で
7 * メモリ制限を設定してハッシュ化し、その検証を行います。
8 * この定数は、高いセキュリティ要件を持つパスワードハッシュ生成時に、
9 * より多くのメモリを使用することを指定し、ブルートフォース攻撃に対する耐性を高めます。
10 *
11 * @param string $password デモに使用するパスワード文字列。
12 * @return void
13 */
14function demonstrateSensitivePasswordHashing(string $password): void
15{
16    echo "元のパスワード: " . $password . PHP_EOL;
17
18    try {
19        // パスワードのハッシュ化を実行
20        // SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE: CPU時間制限（処理の計算回数）
21        // SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE: メモリ使用量制限（バイト数）
22        // SENSITIVE 設定は、攻撃に対するより高い耐性を提供するためにメモリを多めに割り当てます。
23        $hashedPassword = sodium_crypto_pwhash_str(
24            $password,
25            SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE,
26            SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE
27        );
28
29        // ハッシュ化に失敗した場合のチェック
30        if ($hashedPassword === false) {
31            throw new RuntimeException('パスワードのハッシュ化に失敗しました。');
32        }
33
34        echo "ハッシュ化されたパスワード: " . $hashedPassword . PHP_EOL;
35
36        // ハッシュ化されたパスワードと元のパスワードを検証
37        if (sodium_crypto_pwhash_str_verify($hashedPassword, $password)) {
38            echo "検証結果: 成功 - パスワードが一致しました。" . PHP_EOL;
39        } else {
40            echo "検証結果: 失敗 - パスワードが一致しませんでした。" . PHP_EOL;
41        }
42
43        // 間違ったパスワードで検証を試みる
44        $wrongPassword = 'WrongPassword123!';
45        echo "間違ったパスワードでの検証 ('" . $wrongPassword . "'):" . PHP_EOL;
46        if (sodium_crypto_pwhash_str_verify($hashedPassword, $wrongPassword)) {
47            echo "検証結果: 成功 - 間違ったパスワードで一致しました (これは問題です)。" . PHP_EOL;
48        } else {
49            echo "検証結果: 失敗 - 間違ったパスワードでは一致しませんでした (期待通り)。" . PHP_EOL;
50        }
51
52    } catch (RuntimeException $e) {
53        echo "エラー: " . $e->getMessage() . PHP_EOL;
54    }
55}
56
57// デモの実行
58$userPassword = 'MySecretPasswordForDemo123!';
59demonstrateSensitivePasswordHashing($userPassword);

SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVEは、PHPのSodium拡張機能が提供するパスワードハッシュ処理において、メモリ使用量の制限を設定するための定数です。特にこの定数は、高いセキュリティを要求される場面でより多くのメモリを使用することを指定し、パスワードの推測攻撃やブルートフォース攻撃に対する耐性を高めます。この定数自体は引数を持たず、メモリ制限のレベルを示す整数値（int）を返します。

サンプルコードでは、demonstrateSensitivePasswordHashing関数が、与えられたパスワードをこの定数を用いて安全にハッシュ化し、その検証を行う一連の流れを示しています。具体的には、sodium_crypto_pwhash_str関数がパスワードをハッシュ化する際に、メモリ制限としてSODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVEが使われています。これにより、セキュリティレベルが高く、より多くの計算コストがかかるハッシュが生成されます。CPU時間制限にはSODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATEも併用されています。ハッシュ化されたパスワードは、その後にsodium_crypto_pwhash_str_verify関数によって、元のパスワードや、意図的に間違えたパスワードと比較され、正しく検証できるかどうかが確認されます。このコードは、パスワードの安全な保存と検証における、このメモリ制限定数の実用的な利用方法を学ぶのに役立ちます。