MediaWiki  master
BcryptPassword Class Reference

A Bcrypt-hashed password. More...

Inheritance diagram for BcryptPassword:
Collaboration diagram for BcryptPassword:

Public Member Functions

 crypt ( $password)
- Public Member Functions inherited from ParameterizedPassword
 needsUpdate ()
 toString ()
- Public Member Functions inherited from Password
 __construct (PasswordFactory $factory, array $config, $hash=null)
 Construct the Password object using a string hash. More...
 crypt ( $password)
 Hash a password and store the result in this object. More...
 equals ( $other)
 Compare one Password object to this object. More...
 getType ()
 Get the type name of the password. More...
 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...
 verify ( $password)
 Checks whether the given password matches the hash stored in this object. More...

Protected Member Functions

 getDefaultParams ()
 getDelimiter ()
 parseHash ( $hash)
- Protected Member Functions inherited from ParameterizedPassword
 getDefaultParams ()
 Return an ordered array of default parameters for this password hash. More...
 getDelimiter ()
 Returns the delimiter for the parameters inside the hash. More...
 parseHash ( $hash)
- Protected Member Functions inherited from Password
 assertIsSafeSize ( $hash)
 Assert that hash will fit in a tinyblob field. More...
 isSupported ()
 Whether current password type is supported on this system. More...
 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...

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

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


Definition at line 31 of file BcryptPassword.php.

Member Function Documentation

◆ crypt()

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

Definition at line 54 of file BcryptPassword.php.

References Password\$hash, and getDelimiter().

◆ getDefaultParams()

BcryptPassword::getDefaultParams ( )

Definition at line 32 of file BcryptPassword.php.

◆ getDelimiter()

BcryptPassword::getDelimiter ( )

Definition at line 38 of file BcryptPassword.php.

Referenced by crypt().

◆ parseHash()

BcryptPassword::parseHash (   $hash)

Definition at line 42 of file BcryptPassword.php.

References Password\$hash.

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