Factory class for creating and checking Password objects. More...

Collaboration diagram for PasswordFactory:

Public Member Functions
	__construct (array $config=[], $default='')
	Construct a new password factory. More...

	getDefaultType ()
	Get the default password type. More...

	getTypes ()
	Get the list of types of passwords. More...

	init (Config $config)

	needsUpdate (Password $password)
	Determine whether a password object needs updating. More...

	newFromCiphertext ( $hash)
	Create a new Hash object from an existing string hash. More...

	newFromPlaintext ( $password, Password $existing=null)
	Create a new Hash object from a plaintext password. More...

	newFromType ( $type)
	Make a new default password of the given type. More...

	register ( $type, array $config)
	Register a new type of password hash. More...

	setDefaultType ( $type)
	Set the default password type. More...

Static Public Member Functions
static	generateRandomPasswordString ( $minLength=10)
	Generate a random string suitable for a password. More...

static	newInvalidPassword ()
	Create an InvalidPassword. More...

Private Attributes
string	$default = ''
	The default PasswordHash type. More...

array	$types
	Mapping of password types to classes. More...

Detailed Description

Factory class for creating and checking Password objects.

Since: 1.24

Definition at line 28 of file PasswordFactory.php.

Constructor & Destructor Documentation

◆ __construct()

PasswordFactory::__construct	(	array	$config = `[]`,
			$default = `''`
	)

Construct a new password factory.

Most of the time you'll want to use MediaWikiServices::getPasswordFactory instead.

Parameters

array	$config	Mapping of password type => config
string	$default	Default password type

See also: PasswordFactory::register; PasswordFactory::setDefaultType

Definition at line 56 of file PasswordFactory.php.

References $options, $type, as, and setDefaultType().

Member Function Documentation

◆ generateRandomPasswordString()

static PasswordFactory::generateRandomPasswordString ( $minLength = 10 )

static

Generate a random string suitable for a password.

Parameters

int $minLength Minimum length of password to generate

Returns: string

Definition at line 224 of file PasswordFactory.php.

References MWCryptRand\generateHex().

Referenced by ResetUserEmail\execute(), BotPassword\generatePassword(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), User\randomPassword(), and PasswordFactoryTest\testGenerateRandomPasswordString().

◆ getDefaultType()

PasswordFactory::getDefaultType ( )

Get the default password type.

Returns: string

Definition at line 100 of file PasswordFactory.php.

References $default.

◆ getTypes()

PasswordFactory::getTypes ( )

Get the list of types of passwords.

Returns: array

Definition at line 124 of file PasswordFactory.php.

References $types.

◆ init()

PasswordFactory::init ( Config $config )

Deprecated:: since 1.32 Initialize settings using the constructor

Initialize the internal static variables using the global variables

Parameters

Config $config Configuration object to load data from

Definition at line 111 of file PasswordFactory.php.

References $options, $type, as, 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 210 of file PasswordFactory.php.

References $default, 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 139 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 183 of file PasswordFactory.php.

References $default.

◆ 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 163 of file PasswordFactory.php.

References $type.

◆ newInvalidPassword()

static PasswordFactory::newInvalidPassword ( )

static

Create an InvalidPassword.

Returns: InvalidPassword

Definition at line 240 of file PasswordFactory.php.

Referenced by User\addToDatabase(), User\createNew(), BotPassword\getPassword(), BotPassword\invalidateAllPasswordsForCentralId(), DeleteLocalPasswords\processUsers(), BotPassword\save(), PasswordFactoryTest\testNewInvalidPassword(), 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. Will be prefixed to the password hashes to identify what hashing method was used.
array	$config	Array of configuration options. 'class' is required (the Password subclass name), everything else is passed to the constructor of that class.

Definition at line 74 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.

This type will be used for creating new passwords when the type is not specified. Passwords of a different type will be considered outdated and in need of update.

Parameters

string $type Password hash type

Exceptions

InvalidArgumentException If the type is not registered

Definition at line 88 of file PasswordFactory.php.

References $type.

Referenced by __construct(), init(), and PasswordFactoryTest\testSetDefaultTypeError().

Member Data Documentation

◆ $default

string PasswordFactory::$default = ''

private

The default PasswordHash type.

See also: PasswordFactory::setDefaultType

Definition at line 35 of file PasswordFactory.php.

Referenced by getDefaultType(), needsUpdate(), and newFromPlaintext().

◆ $types

array PasswordFactory::$types

private

Initial value:

= [
        '' => [ 'type' => '', 'class' => InvalidPassword::class ],
    ]

Mapping of password types to classes.

See also: PasswordFactory::register; Setup.php

Definition at line 44 of file PasswordFactory.php.

Referenced by getTypes().

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

includes/password/PasswordFactory.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateRandomPasswordString()

◆ getDefaultType()

◆ getTypes()

◆ init()

◆ needsUpdate()

◆ newFromCiphertext()

◆ newFromPlaintext()

◆ newFromType()

◆ newInvalidPassword()

◆ register()

◆ setDefaultType()

Member Data Documentation

◆ $default

◆ $types