Generate a keyed hash value using the HMAC method and the contents of a given file

Descrição

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

Parâmetros

algo: Name of selected hashing algorithm (e.g. "sha256"). For a list of supported algorithms see hash_hmac_algos().
Note:
Non-cryptographic hash functions are not allowed.
filename: URL describing location of file to be hashed; Supports fopen wrappers.
key: Shared secret key used for generating the HMAC variant of the message digest.
binary: When set to true, outputs raw binary data. false outputs lowercase hexits.

Valor Retornado

Returns a string containing the calculated message digest as lowercase hexits unless binary is set to true in which case the raw binary representation of the message digest is returned. Returns false if the file filename cannot be read.

Erros/Exceções

Throws a ValueError exception if algo is unknown or is a non-cryptographic hash function.

Registro de Alterações

Versão	Descrição
8.0.0	Now throws a ValueError exception if `algo` is unknown or is a non-cryptographic hash function; previously, `false` was returned instead.
7.2.0	Usage of non-cryptographic hash functions (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) was disabled.

Exemplos

Example #1 hash_hmac_file() example

<?php
/* Create a file to calculate hash of */
file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

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

O exemplo acima produzirá:

9c5c42422b03f0ee32949920649445e417b2c634050833c5165704b825c2a53b

Veja Também

hash_hmac() - Generate a keyed hash value using the HMAC method
hash_hmac_algos() - Return a list of registered hashing algorithms suitable for hash_hmac
hash_init() - Initialize an incremental hashing context
hash_equals() - Timing attack safe string comparison