A PBKDF2-hashed password. More...
Public Member Functions | |
| crypt ($password) | |
| Hash a password and store the result in this object. | |
Protected Member Functions | |
| getDefaultParams () | |
| Return an ordered array of default parameters for this password hash. | |
| getDelimiter () | |
| Returns the delimiter for the parameters inside the hash. | |
Detailed Description
A PBKDF2-hashed password.
This is a computationally complex password hash for use in modern applications. The number of rounds can be configured by $wgPasswordConfig['pbkdf2']['cost'].
- Since:
- 1.24
Definition at line 31 of file Pbkdf2Password.php.
Member Function Documentation
| Pbkdf2Password::crypt | ( | $ | password | ) |
Hash a password and store the result in this object.
The result of the password hash should be put into the internal state of the hash object.
- Parameters:
-
string $password Password to hash
- Exceptions:
-
PasswordError If an internal error occurs in hashing
Reimplemented from Password.
Definition at line 44 of file Pbkdf2Password.php.
References Password\$hash, and MWCryptRand\generate().
| Pbkdf2Password::getDefaultParams | ( | ) | [protected] |
Return an ordered array of default parameters for this password hash.
The keys should be the parameter names and the values should be the default values. Additionally, the order of the array should be the order in which they appear in the hash.
When parsing a password hash, the constructor will split the hash based on the delimiter, and consume as many parts as it can, matching each to a parameter in this list. Once all the parameters have been filled, all remaining parts will be considered extra arguments, except, of course, for the very last part, which is the hash itself.
- Returns:
- array
Reimplemented from ParameterizedPassword.
Definition at line 32 of file Pbkdf2Password.php.
References array().
| Pbkdf2Password::getDelimiter | ( | ) | [protected] |
Returns the delimiter for the parameters inside the hash.
- Returns:
- string
Reimplemented from ParameterizedPassword.
Definition at line 40 of file Pbkdf2Password.php.
The documentation for this class was generated from the following file:
- includes/password/Pbkdf2Password.php
