MediaWiki  master
LayeredParameterizedPassword Class Reference

This password hash type layers one or more parameterized password types on top of each other. More...

Inheritance diagram for LayeredParameterizedPassword:
Collaboration diagram for LayeredParameterizedPassword:

Public Member Functions

 crypt (string $password)
 Hash a password and store the result in this object. More...
 
 partialCrypt (ParameterizedPassword $passObj)
 Finish the hashing of a partially hashed layered hash. More...
 
- Public Member Functions inherited from ParameterizedPassword
 needsUpdate ()
 Determine if the hash needs to be updated. More...
 
 toString ()
 Convert this hash to a string that can be stored in the database. More...
 
- Public Member Functions inherited from Password
 __construct (PasswordFactory $factory, array $config, string $hash=null)
 Construct the Password object using a string hash. More...
 
 getType ()
 Get the type name of the password. More...
 
 verify (string $password)
 Checks whether the given password matches the hash stored in this object. More...
 

Protected Member Functions

 getDefaultParams ()
 Return an ordered array of default parameters for this password hash. More...
 
 getDelimiter ()
 Returns the delimiter for the parameters inside the hash. More...
 
- 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.
Parameters
string | null$hashThe hash, with the :<TYPE>: prefix stripped
Exceptions
PasswordErrorIf there is an error in parsing the hash
More...
 
- Protected Member Functions inherited from Password
 assertIsSafeSize (string $hash)
 Assert that hash will fit in a tinyblob field. More...
 
 isSupported ()
 Whether current password type is supported on this system. More...
 

Additional Inherited Members

- Protected Attributes inherited from ParameterizedPassword
array $args = []
 Extra arguments that were found in the hash. More...
 
array $params = []
 Named parameters that have default values for this password type. More...
 
- Protected Attributes inherited from Password
array $config
 Array of configuration variables injected from the constructor. More...
 
PasswordFactory $factory
 Factory that created the object. More...
 
string null $hash
 String representation of the hash without the type. More...
 

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$passwordPassword to hash
Exceptions
PasswordErrorIf an internal error occurs in hashing

Reimplemented from Password.

Definition at line 58 of file LayeredParameterizedPassword.php.

References ParameterizedPassword\$args, Password\$hash, ParameterizedPassword\$params, and $type.

◆ getDefaultParams()

LayeredParameterizedPassword::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 ParameterizedPassword\$params, and $type.

◆ getDelimiter()

LayeredParameterizedPassword::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$passObjPassword hash of the first layer
Exceptions
MWExceptionIf the first parameter is not of the correct type

Definition at line 101 of file LayeredParameterizedPassword.php.

References ParameterizedPassword\$args, Password\$hash, ParameterizedPassword\$params, $type, Password\crypt(), and ParameterizedPassword\getDelimiter().


The documentation for this class was generated from the following file: