Helper class for passwords that use another password hash underneath it and encrypts that hash with a configured secret. More...
Public Member Functions | ||||
| crypt (string $password) | ||||
| Hash a password and store the result in this object. | ||||
| update () | ||||
| Updates the underlying hash by encrypting it with the newest secret. | ||||
| verify (string $password) | ||||
Checks whether the given password matches the hash stored 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, string $hash=null) | ||||
| Construct the Password object using a string hash. | ||||
| 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. | ||||||
| Protected Member Functions inherited from ParameterizedPassword | ||||||
| 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 | |
| string[] | $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
Helper class for passwords that use another password hash underneath it and encrypts that hash with a configured secret.
- Since
- 1.24
Definition at line 31 of file EncryptedPassword.php.
Member Function Documentation
◆ crypt()
| EncryptedPassword::crypt | ( | string | $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 43 of file EncryptedPassword.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 36 of file EncryptedPassword.php.
◆ getDelimiter()
|
protected |
Returns the delimiter for the parameters inside the hash.
- Returns
- string
Reimplemented from ParameterizedPassword.
Definition at line 32 of file EncryptedPassword.php.
◆ update()
| EncryptedPassword::update | ( | ) |
Updates the underlying hash by encrypting it with the newest secret.
- Exceptions
-
MWException If the configuration is not valid
- Returns
- bool True if the password was updated
Definition at line 82 of file EncryptedPassword.php.
◆ verify()
| EncryptedPassword::verify | ( | string | $password | ) |
Checks whether the given password matches the hash stored in this object.
- Parameters
-
string $password Password to check
- Returns
- bool
Reimplemented from Password.
Definition at line 127 of file EncryptedPassword.php.
The documentation for this class was generated from the following file:
- includes/password/EncryptedPassword.php
