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

Copy
1<?php
2
3/**
4 * sodium_memcmp の使用例を示す関数。
5 *
6 * この関数は、PHP の Sodium 拡張機能に含まれる sodium_memcmp 関数を使って、
7 * 2つの文字列をセキュアに比較する方法を示します。
8 *
9 * `php sodium とは`：
10 * Sodium は、PHP で利用できる最新の暗号化ライブラリです。
11 * 高速かつ安全な暗号化機能を提供し、特にセキュリティが要求されるアプリケーションでの利用に適しています。
12 * `sodium_memcmp` は、この Sodium 拡張機能の一部であり、
13 * タイミング攻撃（比較にかかる時間のわずかな差から情報を推測しようとする攻撃）を防ぐために設計されています。
14 * したがって、パスワードや秘密鍵など、機密性の高い情報を比較する際に推奨されます。
15 *
16 * @param string $secret1 比較する最初の秘密文字列。
17 * @param string $secret2 比較する2番目の秘密文字列。
18 * @return void
19 */
20function demonstrateSodiumMemcmp(string $secret1, string $secret2): void
21{
22    echo "比較対象の文字列:\n";
23    echo "  文字列1: '" . $secret1 . "'\n";
24    echo "  文字列2: '" . $secret2 . "'\n\n";
25
26    // sodium_memcmp を使用して文字列を比較します。
27    // 戻り値が 0 の場合、文字列は等しいと判断されます。
28    // 0 以外の場合、文字列は異なります。
29    // この比較は、比較にかかる時間が常に一定であるため、タイミング攻撃に対して安全です。
30    $result = sodium_memcmp($secret1, $secret2);
31
32    echo "sodium_memcmp の結果: ";
33    if ($result === 0) {
34        echo "文字列は等しいです。\n";
35        echo "（これは、暗号学的に安全な方法で比較されました。）\n";
36    } else {
37        echo "文字列は異なります。\n";
38        echo "（これは、暗号学的に安全な方法で比較されました。）\n";
39    }
40
41    echo "\n--- 通常の比較 (===) との違いについて ---\n";
42    echo "通常の比較演算子 (===) も文字列が等しいか判定しますが、\n";
43    echo "文字列の途中で不一致が見つかった場合、比較を中断して結果を返すことがあります。\n";
44    echo "この比較時間の差が、タイミング攻撃に利用される可能性があります。\n";
45    echo "sodium_memcmp は、このような脆弱性を防ぐために、文字列全体を常に同じ時間で比較します。\n";
46    echo "（例: '" . $secret1 . "' === '" . $secret2 . "' の結果: " . ($secret1 === $secret2 ? "true" : "false") . "）\n";
47}
48
49// --- サンプルコードの実行 ---
50
51// 例1: 等しい文字列を比較するケース
52echo "--- 例1: 等しい秘密文字列の比較 ---\n";
53demonstrateSodiumMemcmp("my_secure_password_hash_123", "my_secure_password_hash_123");
54echo "\n";
55
56// 例2: 異なる文字列を比較するケース
57echo "--- 例2: 異なる秘密文字列の比較 ---\n";
58demonstrateSodiumMemcmp("my_secure_password_hash_123", "my_secure_password_hash_456");
59echo "\n";
60
61// 例3: 異なる長さの文字列を比較するケース
62echo "--- 例3: 異なる長さの秘密文字列の比較 ---\n";
63demonstrateSodiumMemcmp("short_key", "short_key_longer_than_first_one");
64echo "\n";
65
66?>

PHPのSodium拡張機能は、バージョン8で利用可能な高セキュリティな暗号化ライブラリです。これは、高速かつ暗号学的に安全な機能を提供し、特にセキュリティが求められるアプリケーションでのデータ保護に貢献します。

sodium_memcmp関数は、このSodium拡張機能の一部であり、2つの文字列をセキュアに比較するために利用されます。この関数の最大の特徴は、比較にかかる時間が文字列の内容に関わらず常に一定である点です。一般的な文字列比較では、不一致が見つかった時点で比較を中断することがあり、この時間の差が「タイミング攻撃」に利用される可能性があります。sodium_memcmpは、このような攻撃を防ぐために設計されており、パスワードや秘密鍵のハッシュ値など、機密性の高い情報を比較する際に推奨されます。

この関数は引数として、比較したい2つの文字列（$string1と$string2）を受け取ります。戻り値は整数値であり、2つの文字列が完全に一致する場合は0を返します。文字列が異なる場合は、0以外の値を返します。サンプルコードでは、等しい文字列、異なる文字列、異なる長さの文字列をそれぞれ比較し、sodium_memcmpがその安全な比較結果をどのように返すかを確認できます。これにより、開発者は機密情報の比較において、より強固なセキュリティ対策を講じることが可能です。

Copy
1<?php
2
3/**
4 * sodium_memcmp の使用例を示す関数。
5 *
6 * この関数は、暗号学的に安全な方法で2つの文字列を比較します。
7 * 通常の文字列比較（例: ===, strcmp）とは異なり、
8 * タイミング攻撃を防ぐために、常に一定の時間で比較を実行します。
9 * これは、パスワードや秘密鍵などのセキュリティが重要な情報を比較する際に不可欠です。
10 *
11 * このコードを実行する前に、PHPのsodium拡張が有効になっていることを確認してください。
12 * (例: php.iniで 'extension=sodium' を有効にする、またはパッケージマネージャーでインストールする)
13 */
14function demonstrateSodiumMemcmp(): void
15{
16    // 比較する文字列の例
17    $secretStringA = 'very_secret_password_123';
18    $secretStringB = 'very_secret_password_123'; // secretStringA と同じ
19    $secretStringC = 'wrong_secret_password_456'; // secretStringA と異なる
20    $secretStringD = 'very_secret_password_XYZ'; // secretStringA と長さは同じだが内容が異なる
21
22    echo "--- 比較例1: 同じ文字列 ---\n";
23    echo "文字列1: '{$secretStringA}'\n";
24    echo "文字列2: '{$secretStringB}'\n";
25    $result1 = sodium_memcmp($secretStringA, $secretStringB);
26
27    // 戻り値が 0 の場合、文字列は一致します。
28    if ($result1 === 0) {
29        echo "結果: 文字列は一致します。\n";
30    } else {
31        echo "結果: 文字列は一致しません。(戻り値: {$result1})\n";
32    }
33    echo "\n";
34
35    echo "--- 比較例2: 異なる文字列 (内容も長さも異なる) ---\n";
36    echo "文字列1: '{$secretStringA}'\n";
37    echo "文字列2: '{$secretStringC}'\n";
38    $result2 = sodium_memcmp($secretStringA, $secretStringC);
39
40    if ($result2 === 0) {
41        echo "結果: 文字列は一致します。\n";
42    } else {
43        echo "結果: 文字列は一致しません。(戻り値: {$result2})\n";
44    }
45    echo "\n";
46
47    echo "--- 比較例3: 異なる文字列 (長さは同じだが内容が異なる) ---\n";
48    echo "文字列1: '{$secretStringA}'\n";
49    echo "文字列2: '{$secretStringD}'\n";
50    $result3 = sodium_memcmp($secretStringA, $secretStringD);
51
52    if ($result3 === 0) {
53        echo "結果: 文字列は一致します。\n";
54    } else {
55        echo "結果: 文字列は一致しません。(戻り値: {$result3})\n";
56    }
57    echo "\n";
58}
59
60// 関数の実行
61demonstrateSodiumMemcmp();

PHPのsodium_memcmp関数は、暗号学的に安全な方法で2つの文字列を比較するために使用されます。この関数は、パスワードや秘密鍵など、セキュリティが重要な情報を比較する際に発生する可能性のあるタイミング攻撃を防ぐために設計されています。通常の文字列比較（===やstrcmpなど）とは異なり、比較にかかる時間が常に一定であるため、攻撃者が比較時間から情報を推測することを防ぎます。

引数には比較したい2つの文字列（$string1, $string2）を指定します。戻り値は整数型（int）で、2つの文字列が完全に一致した場合は0を返します。一致しない場合は0以外の値を返します。

この機能を利用するには、PHPのsodium拡張がサーバーにインストールされ、php.iniで有効になっている必要があります。

上記のサンプルコードでは、demonstrateSodiumMemcmp関数がsodium_memcmpの基本的な使い方を示しています。まず、同じ内容の文字列同士を比較し、0が返されることで一致することを確認しています。次に、内容も長さも異なる文字列や、長さは同じだが内容が異なる文字列を比較し、いずれも0以外が返されることで不一致となることを示しています。このように、sodium_memcmpは常にセキュリティを考慮した比較結果を提供します。