sodium_crypto_generichash

Function • Params and return types changed in PHP 8.0

Get a hash of the message.

PHP 5
PHP 7.0-7.1
PHP 7.2
Added
PHP 7.3-7.4
PHP 8.0
Improved
PHP 8.1
PHP 8.2
PHP 8.3
PHP 8.4
PHP 8.5

sodium_crypto_generichash Function synopsis

sodium_crypto_generichash(
    string $message,
    string $key = "",
    int $length = SODIUM_CRYPTO_GENERICHASH_BYTES
  ): string

Parameters

$message

Typestring

The message being hashed.

$key

OptionalTypestringDefault value""

(Optional) cryptographic key. This serves the same function as a HMAC key, but it's utilized as a reserved section of the internal BLAKE2 state.

$length

OptionalTypeintDefault valueSODIUM_CRYPTO_GENERICHASH_BYTES

Output size.

Return value

Typestring

The cryptographic hash as raw bytes. If a hex-encoded output is desired, the result can be passed to sodium_bin2hex.

Changes to the sodium_crypto_generichash Function

PHP 8.0

  • Return type added: string
  • Parameter name of parameter #1 changed: $string to $message
  • Parameter type added for parameter #1 ($message): string
  • Parameter type added for parameter #2 ($key): string
  • Parameter default value added for position #2 ($key): ""
  • Parameter type added for parameter #3 ($length): int
  • Parameter default value added for position #3 ($length): SODIUM_CRYPTO_GENERICHASH_BYTES
  sodium_crypto_generichash(
-     $string,
+     string $message,
-     $key,
+     string $key = "",
-     $length
+     int $length = SODIUM_CRYPTO_GENERICHASH_BYTES
-   )
+   ): string

PHP 7.2

  • Function added

sodium_crypto_generichash Function Availability

PHP VersionAvailability
PHP 8.5Future Release Yes
PHP 8.4Upcoming Release Yes
PHP 8.3Supported (Latest) Yes
PHP 8.2Supported Yes
PHP 8.1Security-Fixes Only Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported No
PHP 7.0Unsupported No
PHP 5.6Unsupported No
PHP 5.5Unsupported No
PHP 5.4Unsupported No
PHP 5.3Unsupported No