MediaWiki  REL1_24
BcryptPassword Class Reference

A Bcrypt-hashed password. More...

Inheritance diagram for BcryptPassword:
Collaboration diagram for BcryptPassword:

List of all members.

Public Member Functions

 crypt ($password)

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.
 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.

Detailed Description

A Bcrypt-hashed password.

This is a computationally complex password hash for use in modern applications. The number of rounds can be configured by $wgPasswordConfig['bcrypt']['cost'].

Since:
1.24

Definition at line 31 of file BcryptPassword.php.


Member Function Documentation

BcryptPassword::crypt ( password)
Parameters:
string$passwordPassword to encrypt
Exceptions:
PasswordErrorIf bcrypt has an unknown error
MWExceptionIf bcrypt is not supported by PHP

Reimplemented from Password.

Definition at line 54 of file BcryptPassword.php.

References Password\$hash, MWCryptRand\generate(), and getDelimiter().

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 32 of file BcryptPassword.php.

References array().

Returns the delimiter for the parameters inside the hash.

Returns:
string

Reimplemented from ParameterizedPassword.

Definition at line 38 of file BcryptPassword.php.

Referenced by crypt().

BcryptPassword::parseHash ( hash) [protected]

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$hashThe hash, with the :<TYPE>: prefix stripped
Exceptions:
PasswordErrorIf there is an error in parsing the hash

Reimplemented from ParameterizedPassword.

Definition at line 42 of file BcryptPassword.php.

References Password\$hash.


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