A PBKDF2-hashed password. More...
Public Member Functions | |
| crypt ( $password) | |
| Hash a password and store the result in this object. | |
 Public Member Functions inherited from ParameterizedPassword | |
| needsUpdate () | |
| Determine if the hash needs to be updated. | |
| toString () | |
| Convert this hash to a string that can be stored in the database. | |
| Public Member Functions inherited from Password | |
| __construct (PasswordFactory $factory, array $config, $hash=null) | |
| Construct the Password object using a string hash. | |
| equals ( $other) | |
| Compare one Password object to this object. | |
| getType () | |
| Get the type name of the password. | |
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. | |
| shouldUseHashExtension () | |
| Protected Member Functions inherited from ParameterizedPassword | |
| parseHash ( $hash) | |
| Perform any parsing necessary on the hash to see if the hash is valid and/or to perform logic for seeing if the hash needs updating. | |
| Protected Member Functions inherited from Password | |
| assertIsSafeSize ( $hash) | |
| Assert that hash will fit in a tinyblob field. | |
Additional Inherited Members | |
| Public Attributes inherited from Password | |
| const | MAX_HASH_SIZE = 255 |
| Hash must fit in user_password, which is a tinyblob. | |
| Protected Attributes inherited from ParameterizedPassword | |
| array | $args = [] |
| Extra arguments that were found in the hash. | |
| array | $params = [] |
| Named parameters that have default values for this password type. | |
| Protected Attributes inherited from Password | |
| array | $config |
| Array of configuration variables injected from the constructor. | |
| PasswordFactory | $factory |
| Factory that created the object. | |
| string | $hash |
| String representation of the hash without the type. | |
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
◆ crypt()
| 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 49 of file Pbkdf2Password.php.
References Password\$hash, MWCryptRand\generate(), and shouldUseHashExtension().
◆ 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.
◆ getDelimiter()
|
protected |
Returns the delimiter for the parameters inside the hash.
- Returns
- string
Reimplemented from ParameterizedPassword.
Definition at line 40 of file Pbkdf2Password.php.
◆ shouldUseHashExtension()
|
protected |
Definition at line 44 of file Pbkdf2Password.php.
Referenced by crypt().
The documentation for this class was generated from the following file:
- includes/password/Pbkdf2Password.php
