MediaWiki\Password\Pbkdf2PasswordUsingHashExtension Class Reference

A PBKDF2-hashed password, using PHP's hash extension. More...

Inherits MediaWiki\Password\AbstractPbkdf2Password.

Collaboration diagram for MediaWiki\Password\Pbkdf2PasswordUsingHashExtension:

Protected Member Functions
	getDigestAlgo (string $algo)
	Get the implementation specific name for a hash algorithm.
	pbkdf2 (string $digestAlgo, string $password, string $salt, int $rounds, int $length)
	Call the PBKDF2 implementation, which hashes the password.
Protected Member Functions inherited from MediaWiki\Password\AbstractPbkdf2Password
	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 MediaWiki\Password\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 $hash The hash, with the :<TYPE>: prefix stripped Exceptions PasswordError If there is an error in parsing the hash
Protected Member Functions inherited from MediaWiki\Password\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
Public Member Functions inherited from MediaWiki\Password\AbstractPbkdf2Password
	crypt (string $password)
	Hash a password and store the result in this object.
Public Member Functions inherited from MediaWiki\Password\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 MediaWiki\Password\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 Attributes inherited from MediaWiki\Password\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 MediaWiki\Password\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

A PBKDF2-hashed password, using PHP's hash extension.

This class exists for compatibility purposes only! Unless an installation's existing password hashes were generated using an algorithm not supported by OpenSSL, Pbkdf2PasswordUsingOpenSSL should be used.

Since

1.40 (since 1.29 under the old name)

Definition at line 36 of file Pbkdf2PasswordUsingHashExtension.php.

Member Function Documentation

getDigestAlgo()

MediaWiki\Password\Pbkdf2PasswordUsingHashExtension::getDigestAlgo ( string $algo )

protected

Get the implementation specific name for a hash algorithm.

Parameters

string

$algo

Algorithm specified in the password hash string

Returns

string|null $algo Implementation specific name, or null if unsupported

Reimplemented from MediaWiki\Password\AbstractPbkdf2Password.

Definition at line 37 of file Pbkdf2PasswordUsingHashExtension.php.

pbkdf2()

MediaWiki\Password\Pbkdf2PasswordUsingHashExtension::pbkdf2 ( string $digestAlgo, string $password, string $salt, int $rounds, int $length )

protected

Call the PBKDF2 implementation, which hashes the password.

Parameters

string	$digestAlgo	Implementation specific hash algorithm name
string	$password	Password to hash
string	$salt	Salt as a binary string
int	$rounds	Number of iterations
int	$length	Length of the hash value in bytes

Returns

string Hash value as a binary string

Exceptions

PasswordError

If an internal error occurs in hashing

Reimplemented from MediaWiki\Password\AbstractPbkdf2Password.

Definition at line 41 of file Pbkdf2PasswordUsingHashExtension.php.

---

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

• includes/password/Pbkdf2PasswordUsingHashExtension.php