Pbkdf2PasswordUsingOpenSSL Class Reference
A PBKDF2-hashed password, using OpenSSL. More...
Inheritance diagram for Pbkdf2PasswordUsingOpenSSL:
Collaboration diagram for Pbkdf2PasswordUsingOpenSSL:
Protected Member Functions | ||||||
| getDigestAlgo (string $algo) | ||||||
| Get the implementation specific name for a hash algorithm. More... | ||||||
| static | isSupported () | |||||
| Whether current password type is supported on this system. More... | ||||||
| pbkdf2 (string $digestAlgo, string $password, string $salt, int $rounds, int $length) | ||||||
| Call the PBKDF2 implementation, which hashes the password. More... | ||||||
 Protected Member Functions inherited from AbstractPbkdf2Password | ||||||
| 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 (?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.
| ||||||
| Protected Member Functions inherited from Password | ||||||
| assertIsSafeSize (string $hash) | ||||||
| Assert that hash will fit in a tinyblob field. More... | ||||||
Additional Inherited Members | |
| Public Member Functions inherited from AbstractPbkdf2Password | |
| crypt (string $password) | |
| Hash a password and store the result in this object. 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, string $hash=null) | |
| Construct the Password object using a string hash. More... | |
| getType () | |
| Get the type name of the password. More... | |
| verify (string $password) | |
| Checks whether the given password matches the hash stored in this object. More... | |
| Static Public Member Functions inherited from AbstractPbkdf2Password | |
| static | newInstance (PasswordFactory $factory, array $config, string $hash=null) |
| Create a new AbstractPbkdf2Password object. More... | |
| Static Protected Member Functions inherited from AbstractPbkdf2Password | |
| static | canUseOpenSSL () |
| Check if OpenSSL can be used for computing PBKDF2 password hashes. More... | |
| Protected Attributes inherited from ParameterizedPassword | |
| string[] | $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 null | $hash |
| String representation of the hash without the type. More... | |
Detailed Description
A PBKDF2-hashed password, using OpenSSL.
- Since
- 1.40
Definition at line 30 of file Pbkdf2PasswordUsingOpenSSL.php.
Member Function Documentation
◆ getDigestAlgo()
|
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 AbstractPbkdf2Password.
Definition at line 61 of file Pbkdf2PasswordUsingOpenSSL.php.
◆ isSupported()
|
protected |
Whether current password type is supported on this system.
- Returns
- bool
Reimplemented from Password.
Definition at line 57 of file Pbkdf2PasswordUsingOpenSSL.php.
◆ pbkdf2()
|
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 AbstractPbkdf2Password.
Definition at line 68 of file Pbkdf2PasswordUsingOpenSSL.php.
The documentation for this class was generated from the following file:
- includes/password/Pbkdf2PasswordUsingOpenSSL.php
