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

Copy
1<?php
2
3// このスクリプトはPHPのSodium拡張機能が有効になっていることを前提としています。
4// Sodiumは、暗号化処理を安全かつ簡単に扱うためのライブラリです。
5
6/**
7 * 指定されたメッセージと秘密鍵を使って短いハッシュを生成します。
8 * このハッシュは、ハッシュテーブルのキー生成や軽量なメッセージ整合性チェックなどに適しています。
9 *
10 * @param string $message ハッシュ化するメッセージ（任意のバイナリ文字列）
11 * @param string $key ハッシュ生成に使用する秘密鍵。SODIUM_CRYPTO_SHORTHASH_KEYBYTESの長さが必要です。
12 * @return string 生成されたハッシュ値 (バイナリ文字列)
13 * @throws InvalidArgumentException キーの長さが不正な場合
14 */
15function generateShortHash(string $message, string $key): string
16{
17    // キーの長さを検証します。SODIUM_CRYPTO_SHORTHASH_KEYBYTESは、この関数に推奨されるキーのバイト長です。
18    if (mb_strlen($key, '8bit') !== SODIUM_CRYPTO_SHORTHASH_KEYBYTES) {
19        throw new InvalidArgumentException(
20            'キーの長さが ' . SODIUM_CRYPTO_SHORTHASH_KEYBYTES . ' バイトではありません。'
21        );
22    }
23
24    // sodium_crypto_shorthash関数を呼び出し、メッセージとキーからハッシュを生成します。
25    // この関数は非常に高速ですが、強力なセキュリティが必要な暗号ハッシュには向きません。
26    return sodium_crypto_shorthash($message, $key);
27}
28
29// -----------------------------------------------------------------------------
30// サンプルコードの実行例
31// -----------------------------------------------------------------------------
32
33// ハッシュ化するメッセージを定義
34$inputMessage = "これはハッシュ化されるサンプルメッセージです。";
35
36// ハッシュ生成に使用する秘密キーを安全に生成します。
37// sodium_randombytes_buf関数を使うことで、暗号学的に強力なランダムなバイト列を生成できます。
38$secretKey = sodium_randombytes_buf(SODIUM_CRYPTO_SHORTHASH_KEYBYTES);
39
40try {
41    // generateShortHash関数を使って短いハッシュを生成
42    $shortHash = generateShortHash($inputMessage, $secretKey);
43
44    // 生成されたハッシュはバイナリデータなので、表示するために16進数に変換します。
45    echo "オリジナルメッセージ: " . $inputMessage . PHP_EOL;
46    echo "生成された短いハッシュ (16進数): " . bin2hex($shortHash) . PHP_EOL;
47
48    // 同じメッセージとキーからは常に同じハッシュが得られることを確認
49    $anotherHash = generateShortHash($inputMessage, $secretKey);
50    echo "再度生成されたハッシュ (16進数): " . bin2hex($anotherHash) . PHP_EOL;
51    if ($shortHash === $anotherHash) {
52        echo "=> ハッシュは一致しました。入力が同じであれば出力も常に同じです。" . PHP_EOL;
53    }
54
55    // 別のメッセージでハッシュを生成し、異なる結果になることを確認
56    $differentMessage = "別の内容のメッセージです。";
57    $differentHash = generateShortHash($differentMessage, $secretKey);
58    echo "別のメッセージのハッシュ (16進数): " . bin2hex($differentHash) . PHP_EOL;
59    if ($shortHash !== $differentHash) {
60        echo "=> メッセージが異なるとハッシュも異なります。" . PHP_EOL;
61    }
62
63} catch (InvalidArgumentException $e) {
64    echo "エラー: " . $e->getMessage() . PHP_EOL;
65} catch (SodiumException $e) {
66    // Sodium関連の処理で発生する可能性のあるエラーを捕捉
67    echo "Sodium関連エラー: " . $e->getMessage() . PHP_EOL;
68} catch (Exception $e) {
69    // その他の予期せぬエラーを捕捉
70    echo "予期せぬエラー: " . $e->getMessage() . PHP_EOL;
71}

PHPのsodium_crypto_shorthash関数は、PHP 8で標準搭載されたLiblibsodiumライブラリをPHPで利用するための「Sodium拡張機能」の一部です。Sodiumは、暗号化処理を安全かつ簡単に扱うための機能群を提供しています。

この関数は、与えられたメッセージと秘密鍵から、非常に高速に「短いハッシュ値」を生成します。生成されるハッシュは固定長で、主にハッシュテーブルのキー生成や、軽量なメッセージの整合性チェックなど、パフォーマンスが重要で、かつ「秘密鍵を知っている者だけが同じハッシュを生成できる」という特性を活かしたい場合に適しています。ただし、一般的なパスワードハッシュのような、高いセキュリティレベルが求められる暗号学的ハッシュ関数とは異なる目的で使用されます。

引数$messageにはハッシュ化したい元のデータ（任意のバイナリ文字列）を渡します。引数$keyには、ハッシュ生成に使う秘密鍵（文字列）を渡しますが、このキーはSODIUM_CRYPTO_SHORTHASH_KEYBYTESで定義される特定のバイト長である必要があります。sodium_randombytes_bufのような関数を使って、安全に生成することが推奨されます。戻り値は、生成されたハッシュ値を示すバイナリ文字列です。

サンプルコードでは、sodium_randombytes_bufを使って安全な秘密鍵を生成し、その鍵と入力メッセージを使ってsodium_crypto_shorthash関数を呼び出しています。生成されたハッシュはバイナリデータであるため、表示する際にはbin2hex関数で16進数に変換しています。同じメッセージとキーからは常に同じハッシュが生成され、メッセージが異なればハッシュも異なることが確認できます。キーの長さが不正な場合はInvalidArgumentException、Sodium関連の処理でエラーが発生した場合はSodiumExceptionがスローされる可能性があります。

Copy
1<?php
2
3// このコードは、PHPのSodium拡張機能が有効になっている環境で動作します。
4// php.iniで 'extension=sodium' を有効にするか、'php-cli' の場合は 'sudo apt install php-sodium' などでインストールしてください。
5
6/**
7 * sodium_crypto_shorthash を使用して、短いメッセージから鍵付きハッシュを生成する例。
8 *
9 * この関数は、ハッシュテーブルや非暗号的なメッセージ認証など、
10 * 高度な暗号的セキュリティを必要としないが、高速な鍵付きハッシュが必要な場合に適しています。
11 */
12function generateShorthashExample(): void
13{
14    // ハッシュ化するメッセージを定義します。
15    $message = 'システムエンジニアの学習は楽しい！';
16
17    // sodium_crypto_shorthash_KEYBYTES は、鍵の長さを示す定数です。
18    // この定数と同じ長さのランダムな鍵を生成する必要があります。
19    // random_bytes() を使用して、安全なランダムバイト列を生成します。
20    $key = random_bytes(SODIUM_CRYPTO_SHORTHASH_KEYBYTES);
21
22    echo "元のメッセージ: " . $message . PHP_EOL;
23    echo "使用する鍵 (hex): " . bin2hex($key) . PHP_EOL;
24    echo "鍵の長さ: " . strlen($key) . " バイト (期待値: " . SODIUM_CRYPTO_SHORTHASH_KEYBYTES . " バイト)" . PHP_EOL;
25
26    try {
27        // メッセージと鍵を使用して、短いハッシュを生成します。
28        $hash = sodium_crypto_shorthash($message, $key);
29
30        // 生成されたハッシュはバイナリデータなので、可読性のため16進数に変換して表示します。
31        echo "生成されたハッシュ (hex): " . bin2hex($hash) . PHP_EOL;
32        echo "ハッシュの長さ: " . strlen($hash) . " バイト (期待値: " . SODIUM_CRYPTO_SHORTHASH_BYTES . " バイト)" . PHP_EOL;
33
34    } catch (Exception $e) {
35        // Sodium拡張機能がロードされていない場合や、引数に問題がある場合に例外をキャッチします。
36        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
37    }
38}
39
40// Sodium拡張機能がロードされているかを確認します。
41if (!extension_loaded('sodium')) {
42    echo "エラー: Sodium拡張機能がロードされていません。" . PHP_EOL;
43    echo "php.iniファイルを確認し、'extension=sodium' を有効にするか、" . PHP_EOL;
44    echo "PHP環境にSodiumをインストールしてください (例: 'sudo apt install php-sodium')." . PHP_EOL;
45} else {
46    // 例示関数を実行します。
47    generateShorthashExample();
48}
49

sodium_crypto_shorthash関数は、PHPのSodium拡張機能を通じて、短いメッセージから高速な鍵付きハッシュを生成する際に利用します。この関数は、ハッシュテーブルのキー生成や非暗号的なメッセージ認証など、高度な暗号的セキュリティを必要としないものの、高速な鍵付きハッシュが求められる場面に適しています。この機能を使用するには、PHP環境でSodium拡張機能が有効になっている必要があります。

サンプルコードでは、まずハッシュ化したいメッセージと、SODIUM_CRYPTO_SHORTHASH_KEYBYTES定数で定められた長さの秘密鍵を準備します。鍵はrandom_bytes関数を用いて安全に生成することが重要です。その後、sodium_crypto_shorthash関数にメッセージと鍵を渡すことで、結果として鍵付きハッシュがバイナリ形式の文字列として返されます。このバイナリデータは、そのままでは読みにくいため、bin2hex関数を使用して16進数文字列に変換し、表示しています。生成されるハッシュの長さはSODIUM_CRYPTO_SHORTHASH_BYTES定数で決まっています。コードの冒頭では、Sodium拡張機能がロードされているかを確認し、ロードされていない場合には、その旨を伝えるエラーメッセージが表示されるように配慮されています。