Basic framework for a primary authentication provider that uses passwords. More...

Inherits MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.

Inherited by MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider, and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider.

Collaboration diagram for MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider:

[legend]

Public Member Functions

__construct (array $params=[])

getAuthenticationRequests ( $action, array $options)

Public Member Functions inherited from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider

autoCreatedAccount ( $user, $source)

Post-auto-creation callback.

Parameters

User	$user	User being created (has been added to the database now). This may become a "UserValue" in the future, or User may be refactored into such.
string	$source	The source of the auto-creation passed to AuthManager::autoCreateUser().

beginPrimaryAccountLink ( $user, array $reqs)

Start linking an account to an existing user.

Parameters

User	$user	User being linked. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationRequest[]	$reqs

Returns

AuthenticationResponse Expected responses:

PASS: The user is linked.
FAIL: The user is not linked. Fail the linking process.
ABSTAIN: These $reqs are not handled. Some other primary provider may handle it.
UI: The $reqs are accepted, no other primary provider will run. Additional AuthenticationRequests are needed to complete the process.
REDIRECT: The $reqs are accepted, no other primary provider will run. Redirection to a third party is needed to complete the process.

continuePrimaryAccountCreation ( $user, $creator, array $reqs)

Continue an account creation flow.

Parameters

User	$user	User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
User	$creator	User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationRequest[]	$reqs

Returns

AuthenticationResponse Expected responses:

PASS: The user may be created. Secondary providers will now run.
FAIL: The user may not be created. Fail the creation process.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

continuePrimaryAccountLink ( $user, array $reqs)

Continue linking an account to an existing user.

Parameters

User	$user	User being linked. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationRequest[]	$reqs

Returns

AuthenticationResponse Expected responses:

PASS: The user is linked.
FAIL: The user is not linked. Fail the linking process.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

continuePrimaryAuthentication (array $reqs)

finishAccountCreation ( $user, $creator, AuthenticationResponse $response)

Post-creation callback.Called after the user is added to the database, before secondary authentication providers are run. Only called if this provider was the one that issued a PASS.

Parameters

User	$user	User being created (has been added to the database now). This may become a "UserValue" in the future, or User may be refactored into such.
User	$creator	User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationResponse	$response	PASS response returned earlier

Returns: string|null 'newusers' log subtype to use for logging the account creation. If null, either 'create' or 'create2' will be used depending on $creator.

postAccountCreation ( $user, $creator, AuthenticationResponse $response)

Post-creation callback.This will be called at the end of any account creation attempt, regardless of whether this provider was the one that handled it. It will not be called if the account creation process results in a session timeout (possibly after a successful user creation, while a secondary provider is waiting for a response).

Parameters

User	$user	User that was attempted to be created. This may become a "UserValue" in the future, or User may be refactored into such.
User	$creator	User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationResponse	$response	Authentication response that will be returned (PASS or FAIL)

postAccountLink ( $user, AuthenticationResponse $response)

Post-link callback.This will be called at the end of any account linking attempt, regardless of whether this provider was the one that handled it.

Parameters

User	$user	User that was attempted to be linked. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationResponse	$response	Authentication response that will be returned (PASS or FAIL)

postAuthentication ( $user, AuthenticationResponse $response)

Post-login callback.This will be called at the end of any login attempt, regardless of whether this provider was the one that handled it. It will not be called for unfinished login attempts that fail by the session timing out.

Parameters

User \| null	$user	User that was attempted to be logged in, if known. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationResponse	$response	Authentication response that will be returned (PASS or FAIL)

providerAllowsPropertyChange ( $property)

Determine whether a property can change.

See also: AuthManager::allowsPropertyChange()

Parameters

string $property

Returns: bool

providerNormalizeUsername ( $username)

Normalize the username for authentication.Any two inputs that would result in the same user being authenticated should return the same string here, while inputs that would result in different users should return different strings.If possible, the best thing to do here is to return the canonicalized name of the local user account that would be used. If not, return something that would be invalid as a local username (e.g. wrap an email address in "<>", or append "#servicename" to the username passed to a third-party service).If the provider doesn't use a username at all in its AuthenticationRequests, return null. If the name is syntactically invalid, it's probably best to return null.

Parameters

string $username

Returns: string|null

providerRevokeAccessForUser ( $username)

Revoke the user's credentials.This may cause the user to no longer exist for the provider, or the user may continue to exist in a "disabled" state.The intention is that the named account will never again be usable for normal login (i.e. there is no way to undo the revocation of access).

Parameters

string $username

testForAccountCreation ( $user, $creator, array $reqs)

Determine whether an account creation may begin.Called from AuthManager::beginAccountCreation()

Note: No need to test if the account exists, AuthManager checks that

Parameters

User	$user	User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
User	$creator	User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationRequest[]	$reqs

Returns: StatusValue

testUserCanAuthenticate ( $username)

Test whether the named user can authenticate with this provider.Should return true if the provider has any data for this user which can be used to authenticate it, even if the user is temporarily prevented from authentication somehow.

Parameters

string $username MediaWiki username

Returns: bool

testUserForCreation ( $user, $autocreate, array $options=[])

Determine whether an account may be created.

Parameters

User	$user	User being created (not added to the database yet). This may become a "UserValue" in the future, or User may be refactored into such.
bool \| string	$autocreate	False if this is not an auto-creation, or the source of the auto-creation passed to AuthManager::autoCreateUser().
array	$options	flags: (int) Bitfield of IDBAccessObject::READ_* constants, default IDBAccessObject::READ_NORMAL creating: (bool) If false (or missing), this call is only testing if a user could be created. If set, this is for actually creating an account. If set and $autocreate is false, it's guaranteed to be followed by a call to testForAccountCreation(). In this case, the provider might return StatusValue::newGood() here and let the later call to testForAccountCreation() do a more thorough test. canAlwaysAutocreate: (bool) If true the session provider is exempt from autocreate user permissions checks.

Returns: StatusValue

Public Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider

getUniqueId ()

Return a unique identifier for this instance.This must be the same across requests. If multiple instances return the same ID, exceptions will be thrown from AuthManager.

Returns: string

init (LoggerInterface $logger, AuthManager $manager, HookContainer $hookContainer, Config $config, UserNameUtils $userNameUtils)

Initialise with dependencies of an AuthenticationProvider.

Public Member Functions inherited from MediaWiki\Auth\PrimaryAuthenticationProvider

accountCreationType ()

Fetch the account-creation type.

beginPrimaryAccountCreation ( $user, $creator, array $reqs)

Start an account creation flow.

beginPrimaryAuthentication (array $reqs)

Start an authentication flow.

providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)

Validate a change of authentication data (e.g.

providerChangeAuthenticationData (AuthenticationRequest $req)

Change or remove authentication data (e.g.

testUserExists ( $username, $flags=IDBAccessObject::READ_NORMAL)

Test whether the named user exists.

Protected Member Functions
	checkPasswordValidity ( $username, $password)
	Check that the password is valid.

	failResponse (PasswordAuthenticationRequest $req)
	Return the appropriate response for failure.

	getFatalPasswordErrorResponse (string $username, Status $status)
	Adds user-friendly description to a fatal password validity check error.

	getNewPasswordExpiry ( $username)
	Get expiration date for a new password, if any.

	getPassword ( $hash)
	Get a Password object from the hash.

	getPasswordFactory ()

	getPasswordResetData ( $username, $data)
	Get password reset data, if any.

	setPasswordResetFlag ( $username, Status $status, $data=null)
	Check if the password should be reset.

Protected Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider
	getHookContainer ()

	getHookRunner ()

	postInitSetup ()
	A provider can override this to do any necessary setup after init() is called.

Protected Attributes
bool	$authoritative
	Whether this provider should ABSTAIN (false) or FAIL (true) on password failure.

Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider
Config	$config

LoggerInterface	$logger

AuthManager	$manager

UserNameUtils	$userNameUtils

Additional Inherited Members
Public Attributes inherited from MediaWiki\Auth\PrimaryAuthenticationProvider
const	TYPE_CREATE = 'create'
	Provider can create accounts.

const	TYPE_LINK = 'link'
	Provider can link to existing accounts elsewhere.

const	TYPE_NONE = 'none'
	Provider cannot create or link to accounts.

Detailed Description

Basic framework for a primary authentication provider that uses passwords.

Stability: stable: to extend

Since: 1.27

Definition at line 40 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::__construct ( array $params = [] )

Stability: stable: to call

Parameters

array

$params

Settings

authoritative: Whether this provider should ABSTAIN (false) or FAIL (true) on password failure

Definition at line 55 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $params.

Member Function Documentation

◆ checkPasswordValidity()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::checkPasswordValidity	(		$username,
			$password )

protected

Check that the password is valid.

This should be called before validating the password. If the result is not ok, login should fail immediately.

Parameters

string	$username
string	$password

Returns: Status

Definition at line 113 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\testForAccountCreation(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testForAccountCreation().

◆ failResponse()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::failResponse ( PasswordAuthenticationRequest $req )

protected

Return the appropriate response for failure.

Parameters

PasswordAuthenticationRequest $req

Returns: AuthenticationResponse

Definition at line 93 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newFail(), and wfMessage().

Referenced by MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication().

◆ getAuthenticationRequests()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getAuthenticationRequests	(		$action,
		array	$options )

Stability: stable: to override

Parameters

string	$action
array	$options

Returns: AuthenticationRequest[]

Implements MediaWiki\Auth\AuthenticationProvider.

Reimplemented in MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider.

Definition at line 204 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\AuthManager\ACTION_CHANGE, MediaWiki\Auth\AuthManager\ACTION_CREATE, MediaWiki\Auth\AuthManager\ACTION_LOGIN, and MediaWiki\Auth\AuthManager\ACTION_REMOVE.

◆ getFatalPasswordErrorResponse()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getFatalPasswordErrorResponse	(	string	$username,
		Status	$status )

protected

Adds user-friendly description to a fatal password validity check error.

These errors prevent login even when the password is correct, so just displaying the description of the error would be somewhat confusing.

Parameters

string	$username
Status	$status	The status returned by checkPasswordValidity(); must be a fatal.

Returns: AuthenticationResponse A FAIL response with an improved description.

Definition at line 125 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication().

◆ getNewPasswordExpiry()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getNewPasswordExpiry ( $username )

protected

Get expiration date for a new password, if any.

Stability: stable: to override

Parameters

string $username

Returns: string|null

Definition at line 186 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\MainConfigNames\PasswordExpirationDays, and wfTimestamp().

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData().

◆ getPassword()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPassword ( $hash )

protected

Get a Password object from the hash.

Parameters

string $hash

Returns: Password

Definition at line 77 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordFactory(), and MediaWiki\Password\PasswordFactory\newFromCiphertext().

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\testUserCanAuthenticate().

◆ getPasswordFactory()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPasswordFactory ( )

protected

Returns: PasswordFactory

Definition at line 62 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\MainConfigNames\PasswordConfig, and MediaWiki\MainConfigNames\PasswordDefault.

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPassword(), MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData().

◆ getPasswordResetData()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPasswordResetData	(		$username,
			$data )

protected

Get password reset data, if any.

Stability: stable: to override

Parameters

string	$username
\\stdClass \| null	$data

Returns: \stdClass|null { 'hard' => bool, 'msg' => Message }

Reimplemented in MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider, and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider.

Definition at line 175 of file AbstractPasswordPrimaryAuthenticationProvider.php.

◆ setPasswordResetFlag()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::setPasswordResetFlag	(		$username,
		Status	$status,
			$data = null )

protected

Check if the password should be reset.

This should be called after a successful login. It sets 'reset-pass' authentication data if necessary, see ResetPassSecondaryAuthenticationProvider.

Parameters

string	$username
Status	$status	From $this->checkPasswordValidity()
\\stdClass \| null	$data	Passed through to $this->getPasswordResetData()

Definition at line 147 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Status\Status\getMessage(), StatusValue\getValue(), MediaWiki\MainConfigNames\InvalidPasswordReset, and StatusValue\isGood().

Referenced by MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication().

Member Data Documentation

◆ $authoritative

bool MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::$authoritative

protected

Whether this provider should ABSTAIN (false) or FAIL (true) on password failure.

Definition at line 44 of file AbstractPasswordPrimaryAuthenticationProvider.php.

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

includes/auth/AbstractPasswordPrimaryAuthenticationProvider.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkPasswordValidity()

◆ failResponse()

◆ getAuthenticationRequests()

◆ getFatalPasswordErrorResponse()

◆ getNewPasswordExpiry()

◆ getPassword()

◆ getPasswordFactory()

◆ getPasswordResetData()

◆ setPasswordResetFlag()

Member Data Documentation

◆ $authoritative