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

Inheritance diagram for EncryptedPassword:

[legend]

Collaboration diagram for EncryptedPassword:

[legend]

List of all members.

Public Member Functions
	crypt ($password)
	Hash a password and store the result in this object.
	update ()
	Updates the underlying hash by encrypting it with the newest secret.
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.

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

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 $password Password to hash

Exceptions:

PasswordError If an internal error occurs in hashing

Reimplemented from Password.

Definition at line 41 of file EncryptedPassword.php.

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

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.