MediaWiki  REL1_31
EncryptedPassword Class Reference

Helper class for passwords that use another password hash underneath it and encrypts that hash with a configured secret. More...

Inheritance diagram for EncryptedPassword:
Collaboration diagram for EncryptedPassword:

Public Member Functions

 crypt ( $password)
 Hash a password and store the result in this object. More...
 
 update ()
 Updates the underlying hash by encrypting it with the newest secret. 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, $hash=null)
 Construct the Password object using a string hash. More...
 
 equals ( $other)
 Compare one Password object to this object. More...
 
 getType ()
 Get the type name of the password. 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 ( $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. More...
 
- Protected Member Functions inherited from Password
 assertIsSafeSize ( $hash)
 Assert that hash will fit in a tinyblob field. More...
 

Additional Inherited Members

- Public Attributes inherited from Password
const MAX_HASH_SIZE = 255
 Hash must fit in user_password, which is a tinyblob. More...
 
- 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 $hash
 String representation of the hash without the type. More...
 

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 29 of file EncryptedPassword.php.

Member Function Documentation

◆ crypt()

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

Reimplemented from Password.

Definition at line 41 of file EncryptedPassword.php.

References MWCryptRand\generate().

◆ getDefaultParams()

EncryptedPassword::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 EncryptedPassword.php.

Referenced by update().

◆ getDelimiter()

EncryptedPassword::getDelimiter ( )
protected

Returns the delimiter for the parameters inside the hash.

Returns
string

Reimplemented from ParameterizedPassword.

Definition at line 30 of file EncryptedPassword.php.

◆ update()

EncryptedPassword::update ( )

Updates the underlying hash by encrypting it with the newest secret.

Exceptions
MWExceptionIf the configuration is not valid
Returns
bool True if the password was updated

Definition at line 80 of file EncryptedPassword.php.

References MWCryptRand\generate(), and getDefaultParams().


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