This password hash type layers one or more parameterized password types on top of each other. More...
Inherits ParameterizedPassword.
Public Member Functions | |
| crypt (string $password) | |
| Hash a password and store the result in this object. | |
| partialCrypt (ParameterizedPassword $passObj) | |
| Finish the hashing of a partially hashed layered hash. | |
 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. | ||||||
| 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
This password hash type layers one or more parameterized password types on top of each other.
The underlying types must be parameterized. This wrapping type accumulates all the parameters and arguments from each hash and then passes the hash of the last layer as the password for the next layer.
- Since
- 1.24
Definition at line 35 of file LayeredParameterizedPassword.php.
Member Function Documentation
◆ crypt()
| LayeredParameterizedPassword::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 60 of file LayeredParameterizedPassword.php.
References $params.
◆ 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 40 of file LayeredParameterizedPassword.php.
References $params.
◆ getDelimiter()
|
protected |
Returns the delimiter for the parameters inside the hash.
- Returns
- string
Reimplemented from ParameterizedPassword.
Definition at line 36 of file LayeredParameterizedPassword.php.
◆ partialCrypt()
| LayeredParameterizedPassword::partialCrypt | ( | ParameterizedPassword | $passObj | ) |
Finish the hashing of a partially hashed layered hash.
Given a password hash that is hashed using the first layer of this object's configuration, perform the remaining layers of password hashing in order to get an updated hash with all the layers.
- Parameters
-
ParameterizedPassword $passObj Password hash of the first layer
Definition at line 101 of file LayeredParameterizedPassword.php.
References $params, Password\crypt(), and ParameterizedPassword\getDelimiter().
The documentation for this class was generated from the following file:
- includes/password/LayeredParameterizedPassword.php
