PasswordFactory Class Reference

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

Public Member Functions
	__construct (array $config=[], string $default='')
	Most of the time you'll want to use MediaWikiServices::getInstance()->getPasswordFactory instead.
	getDefaultType ()
	Get the default password type.
	getTypes ()
	Get the list of types of passwords.
	init (Config $config)
	needsUpdate (Password $password)
	Determine whether a password object needs updating.
	newFromCiphertext (?string $hash)
	Create a new Password object from an existing string hash.
	newFromPlaintext (?string $password, Password $existing=null)
	Create a new Password object from a plaintext password.
	newFromType (string $type)
	Create a new Password object of the given type.
	register (string $type, array $config)
	Register a new type of password hash.
	setDefaultType (string $type)
	Set the default password type.

Static Public Member Functions
static	generateRandomPasswordString (int $minLength=10)
	Generate a random string suitable for a password.
static	newInvalidPassword ()
	Create an InvalidPassword.

Detailed Description

Factory class for creating and checking Password objects.

Since

1.24

Definition at line 34 of file PasswordFactory.php.

Constructor & Destructor Documentation

__construct()

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

Most of the time you'll want to use MediaWikiServices::getInstance()->getPasswordFactory instead.

Parameters

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

See also

PasswordFactory::register

PasswordFactory::setDefaultType

Definition at line 64 of file PasswordFactory.php.

References setDefaultType().

Member Function Documentation

generateRandomPasswordString()

static PasswordFactory::generateRandomPasswordString ( int $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 243 of file PasswordFactory.php.

getDefaultType()

PasswordFactory::getDefaultType

(

)

Get the default password type.

Returns

string

Definition at line 108 of file PasswordFactory.php.

getTypes()

PasswordFactory::getTypes

(

)

Get the list of types of passwords.

Returns

array[]

Definition at line 134 of file PasswordFactory.php.

init()

PasswordFactory::init

(

Config

$config

)

Deprecated

since 1.32 Initialize settings using the constructor Emitting deprecation warnings since 1.41.

Initialize the internal static variables using the global variables

Parameters

Config

$config

Configuration object to load data from

Definition at line 120 of file PasswordFactory.php.

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

newFromCiphertext()

PasswordFactory::newFromCiphertext

(

?string

$hash

)

Create a new Password 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 149 of file PasswordFactory.php.

newFromPlaintext()

PasswordFactory::newFromPlaintext	(	?string	$password,
		Password	$existing = null )

Create a new Password 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 203 of file PasswordFactory.php.

newFromType()

PasswordFactory::newFromType

(

string

$type

)

Create a new Password object of the given type.

Parameters

string

$type

Existing type

Returns

Password

Exceptions

PasswordError

If type is not recognized

Definition at line 167 of file PasswordFactory.php.

newInvalidPassword()

static PasswordFactory::newInvalidPassword ( )

static

Create an InvalidPassword.

Returns

InvalidPassword

Definition at line 259 of file PasswordFactory.php.

register()

PasswordFactory::register	(	string	$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 82 of file PasswordFactory.php.

setDefaultType()

PasswordFactory::setDefaultType

(

string

$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 96 of file PasswordFactory.php.

Referenced by __construct().

---

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

• includes/password/PasswordFactory.php