mhash_keygen_s2k

FunctionDeprecated in PHP 8.1

Generates a key.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Deprecated
PHP 8.2
PHP 8.3
PHP 8.4
PHP 8.5

mhash_keygen_s2k Function synopsis

#[\Deprecated]
mhash_keygen_s2k(
    int $algo,
    string $password,
    string $salt,
    int $length
  ): string|false

Parameters

$algo

Typeint

The hash ID used to create the key. One of the MHASH_* constants.

$password

Typestring

An user supplied password.

$salt

Typestring

Must be different and random enough for every key you generate in order to create different keys. Because $salt must be known when you check the keys, it is a good idea to append the key to it. Salt has a fixed length of 8 bytes and will be padded with zeros if you supply less bytes.

$length

Typeint

The key length, in bytes.

Return value

Typestring|false

Returns the generated key as a string, or false on error.

Changes to the mhash_keygen_s2k Function

PHP 8.1

  • Function deprecated

PHP 8.0

  • Return type added: string|false
  • Parameter name of parameter #1 changed: $hash to $algo
  • Parameter type added for parameter #1 ($algo): int
  • Parameter name of parameter #2 changed: $input_password to $password
  • Parameter type added for parameter #2 ($password): string
  • Parameter type added for parameter #3 ($salt): string
  • Parameter name of parameter #4 changed: $bytes to $length
  • Parameter type added for parameter #4 ($length): int
  mhash_keygen_s2k(
-     $hash,
+     int $algo,
-     $input_password,
+     string $password,
-     $salt,
+     string $salt,
-     $bytes
+     int $length
-   )
+   ): string|false

mhash_keygen_s2k Function Availability

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