Factory class for creating and checking Password objects. More...
Public Member Functions | |
| getDefaultType () | |
| Get the default password type. | |
| getTypes () | |
| Get the list of types of passwords. | |
| init (Config $config) | |
| Initialize the internal static variables using the global variables. | |
| needsUpdate (Password $password) | |
| Determine whether a password object needs updating. | |
| newFromCiphertext ( $hash) | |
| Create a new Hash object from an existing string hash. | |
| newFromPlaintext ( $password, Password $existing=null) | |
| Create a new Hash object from a plaintext password. | |
| newFromType ( $type) | |
| Make a new default password of the given type. | |
| register ( $type, array $config) | |
| Register a new type of password hash. | |
| setDefaultType ( $type) | |
| Set the default password type. | |
Static Public Member Functions | |
| static | generateRandomPasswordString ( $minLength=10) |
| Generate a random string suitable for a password. | |
| static | newInvalidPassword () |
| Create an InvalidPassword. | |
Private Attributes | |
| string | $default = '' |
| The default PasswordHash type. | |
| array | $types |
| Mapping of password types to classes. | |
Detailed Description
Factory class for creating and checking Password objects.
- Since
- 1.24
Definition at line 28 of file PasswordFactory.php.
Member Function Documentation
◆ generateRandomPasswordString()
|
static |
Generate a random string suitable for a password.
- Parameters
-
int $minLength Minimum length of password to generate
- Returns
- string
Definition at line 198 of file PasswordFactory.php.
References MWCryptRand\generateHex().
◆ getDefaultType()
| PasswordFactory::getDefaultType | ( | ) |
◆ getTypes()
| PasswordFactory::getTypes | ( | ) |
◆ init()
| PasswordFactory::init | ( | Config | $config | ) |
Initialize the internal static variables using the global variables.
- Parameters
-
Config $config Configuration object to load data from
Definition at line 85 of file PasswordFactory.php.
References $options, $type, Config\get(), and setDefaultType().
Referenced by PasswordFactoryTest\testInit().
◆ needsUpdate()
| PasswordFactory::needsUpdate | ( | Password | $password | ) |
Determine whether a password object needs updating.
Check whether the given password is of the default type. If it is, pass off further needsUpdate checks to Password::needsUpdate.
- Parameters
-
Password $password
- Returns
- bool True if needs update, false otherwise
Definition at line 184 of file PasswordFactory.php.
References Password\getType(), and Password\needsUpdate().
◆ newFromCiphertext()
| PasswordFactory::newFromCiphertext | ( | $hash | ) |
Create a new Hash object from an existing string hash.
Parse the type of a hash and create a new hash object based on the parsed type. Pass the raw hash to the constructor of the new object. Use InvalidPassword type if a null hash is given.
- Parameters
-
string | null $hash Existing hash or null for an invalid password
- Returns
- Password
- Exceptions
-
PasswordError If hash is invalid or type is not recognized
Definition at line 113 of file PasswordFactory.php.
References $type.
◆ newFromPlaintext()
| PasswordFactory::newFromPlaintext | ( | $password, | |
| Password | $existing = null ) |
Create a new Hash object from a plaintext password.
If no existing object is given, make a new default object. If one is given, clone that object. Then pass the plaintext to Password::crypt().
- Parameters
-
string | null $password Plaintext password, or null for an invalid password Password | null $existing Optional existing hash to get options from
- Returns
- Password
Definition at line 157 of file PasswordFactory.php.
◆ newFromType()
| PasswordFactory::newFromType | ( | $type | ) |
Make a new default password of the given type.
- Parameters
-
string $type Existing type
- Returns
- Password
- Exceptions
-
PasswordError If hash is invalid or type is not recognized
Definition at line 137 of file PasswordFactory.php.
References $type.
◆ newInvalidPassword()
|
static |
Create an InvalidPassword.
- Returns
- InvalidPassword
Definition at line 214 of file PasswordFactory.php.
Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate().
◆ register()
| PasswordFactory::register | ( | $type, | |
| array | $config ) |
Register a new type of password hash.
- Parameters
-
string $type Unique type name for the hash array $config Array of configuration options
Definition at line 53 of file PasswordFactory.php.
References $type.
Referenced by PasswordFactoryTest\testNeedsUpdate(), PasswordFactoryTest\testNewFromCiphertext(), PasswordFactoryTest\testNewFromCiphertextErrors(), PasswordFactoryTest\testNewFromPlaintext(), PasswordFactoryTest\testNewFromType(), PasswordFactoryTest\testNewFromTypeError(), PasswordFactoryTest\testRegister(), and PasswordFactoryTest\testSetDefaultType().
◆ setDefaultType()
| PasswordFactory::setDefaultType | ( | $type | ) |
Set the default password type.
- Exceptions
-
InvalidArgumentException If the type is not registered
- Parameters
-
string $type Password hash type
Definition at line 64 of file PasswordFactory.php.
References $type.
Referenced by init(), and PasswordFactoryTest\testSetDefaultTypeError().
Member Data Documentation
◆ $default
|
private |
The default PasswordHash type.
- See also
- PasswordFactory::setDefaultType
Definition at line 35 of file PasswordFactory.php.
◆ $types
|
private |
Mapping of password types to classes.
- See also
- PasswordFactory::register
- Setup.php
Definition at line 43 of file PasswordFactory.php.
The documentation for this class was generated from the following file:
- includes/password/PasswordFactory.php
