PHP 8.4.0 RC2 available for testing

hash_hmac_file

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL hash >= 1.1)

hash_hmac_fileHMAC 方式を使用して、指定されたファイルの内容からハッシュ値を生成する

説明

hash_hmac_file(
    string $algo,
    string $filename,
    #[\SensitiveParameter] string $key,
    bool $binary = false
): string|false

パラメータ

algo

選択したアルゴリズムの名前 (例: "sha256")。 サポートするアルゴリズムの一覧は hash_hmac_algos() を参照ください。

注意:

暗号に適さないハッシュ関数は許可されません。

filename

ハッシュ対象となるファイルの位置を示す URL。 fopen ラッパーをサポートしています。

key

HMAC 方式でのメッセージダイジェストを生成するために使用する 共有の秘密鍵。

binary

true を設定すると、生のバイナリデータを出力します。 false の場合は小文字の 16 進数値となります。

戻り値

binary が true に設定されていない場合は、 メッセージダイジェストの計算結果を小文字の 16 進数値形式の文字列で 返します。もし true に設定されていた場合は、メッセージダイジェストが そのままのバイナリ形式で返されます。 filename が読めない場合は、false が返されます。

エラー / 例外

algo が不明な場合や、 暗号に適さないハッシュ関数の場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.0.0 algo が不明な場合や、 暗号に適さないハッシュ関数の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、false を返していました。
7.2.0 暗号に適さないハッシュ関数 (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) は使えなくなりました。

例1 hash_hmac_file() の例

<?php
/* ハッシュ値を計算するファイルを作成します */
file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

echo
hash_hmac_file('sha256', 'example.txt', 'secret');
?>

上の例の出力は以下となります。

9c5c42422b03f0ee32949920649445e417b2c634050833c5165704b825c2a53b

参考

  • hash_hmac() - HMAC 方式を使用してハッシュ値を生成する
  • hash_hmac_algos() - hash_hmac に合うハッシュアルゴリズムの一覧を返す
  • hash_init() - 段階的なハッシュコンテキストを初期化する
  • hash_equals() - タイミング攻撃に対しても安全な文字列比較

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top