A Bcrypt-hashed password. More...
Public Member Functions | |
| crypt (string $password) | |
 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, string $hash=null) | |
| Construct the Password object using a string hash. | |
| getType () | |
| Get the type name of the password. | |
| verify (string $password) | |
| Checks whether the given password matches the hash stored 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. | ||||||
| parseHash (?string $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 (string $hash) | ||||||
| Assert that hash will fit in a tinyblob field. | ||||||
| isSupported () | ||||||
| Whether current password type is supported on this system. | ||||||
Additional Inherited Members | |
| 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 null | $hash |
| String representation of the hash without the type. | |
Detailed Description
A Bcrypt-hashed password.
This is a computationally complex password hash for use in modern applications. The number of rounds can be configured by $wgPasswordConfig['bcrypt']['cost'].
- Since
- 1.24
Definition at line 33 of file BcryptPassword.php.
Member Function Documentation
◆ crypt()
| BcryptPassword::crypt | ( | string | $password | ) |
- Parameters
-
string $password Password to encrypt
- Exceptions
-
PasswordError If bcrypt has an unknown error MWException If bcrypt is not supported by PHP
Reimplemented from Password.
Definition at line 56 of file BcryptPassword.php.
◆ 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 34 of file BcryptPassword.php.
◆ getDelimiter()
|
protected |
Returns the delimiter for the parameters inside the hash.
- Returns
- string
Reimplemented from ParameterizedPassword.
Definition at line 40 of file BcryptPassword.php.
◆ parseHash()
|
protected |
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.
- Parameters
-
string | null $hash The hash, with the :<TYPE>: prefix stripped
- Exceptions
-
PasswordError If there is an error in parsing the hash
Reimplemented from ParameterizedPassword.
Definition at line 44 of file BcryptPassword.php.
The documentation for this class was generated from the following file:
- includes/password/BcryptPassword.php
