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

Inheritance diagram for MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider:

[legend]

Collaboration diagram for MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider:

[legend]

Public Member Functions
	__construct (array $params=[])

	getAuthenticationRequests ( $action, array $options)
	@inheritDoc More...

Public Member Functions inherited from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider
	autoCreatedAccount ( $user, $source)
	Post-auto-creation callback. More...

	beginPrimaryAccountLink ( $user, array $reqs)
	Start linking an account to an existing user. More...

	continuePrimaryAccountCreation ( $user, $creator, array $reqs)
	Continue an account creation flow. More...

	continuePrimaryAccountLink ( $user, array $reqs)
	Continue linking an account to an existing user. More...

	continuePrimaryAuthentication (array $reqs)
	Continue an authentication flow. More...

	finishAccountCreation ( $user, $creator, AuthenticationResponse $response)
	Post-creation callback. More...

	postAccountCreation ( $user, $creator, AuthenticationResponse $response)
	Post-creation callback. More...

	postAccountLink ( $user, AuthenticationResponse $response)
	Post-link callback. More...

	postAuthentication ( $user, AuthenticationResponse $response)
	Post-login callback. More...

	providerAllowsPropertyChange ( $property)
	Determine whether a property can change. More...

	providerNormalizeUsername ( $username)
	@inheritDoc More...

	providerRevokeAccessForUser ( $username)
	@inheritDoc More...

	testForAccountCreation ( $user, $creator, array $reqs)
	Determine whether an account creation may begin. More...

	testUserCanAuthenticate ( $username)
	Test whether the named user can authenticate with this provider. More...

	testUserForCreation ( $user, $autocreate, array $options=[])
	Determine whether an account may be created. More...

Public Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider
	getUniqueId ()
	@inheritDoc More...

	setConfig (Config $config)
	Set configuration. More...

	setLogger (LoggerInterface $logger)

	setManager (AuthManager $manager)
	Set AuthManager. More...

Public Member Functions inherited from MediaWiki\Auth\PrimaryAuthenticationProvider
	accountCreationType ()
	Fetch the account-creation type. More...

	beginPrimaryAccountCreation ( $user, $creator, array $reqs)
	Start an account creation flow. More...

	beginPrimaryAuthentication (array $reqs)
	Start an authentication flow. More...

	providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)
	Validate a change of authentication data (e.g. More...

	providerChangeAuthenticationData (AuthenticationRequest $req)
	Change or remove authentication data (e.g. More...

	testUserExists ( $username, $flags=User::READ_NORMAL)
	Test whether the named user exists. More...

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

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

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

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

	getPasswordFactory ()
	Get the PasswordFactory. More...

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

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

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

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

LoggerInterface	$logger

AuthManager	$manager

Private Attributes
	$passwordFactory = null

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

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

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

Detailed Description

Basic framework for a primary authentication provider that uses passwords.

Since: 1.27

Definition at line 33 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array

$params

Settings

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

Definition at line 46 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 105 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $username.

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

◆ failResponse()

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

protected

Return the appropriate response for failure.

Parameters

PasswordAuthenticationRequest $req

Returns: AuthenticationResponse

Definition at line 85 of file AbstractPasswordPrimaryAuthenticationProvider.php.

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

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

◆ getAuthenticationRequests()

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

@inheritDoc

Of the requests returned by this method, exactly one should have AuthenticationRequest::$required set to REQUIRED.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Reimplemented in MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider, and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider.

Definition at line 162 of file AbstractPasswordPrimaryAuthenticationProvider.php.

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

◆ getNewPasswordExpiry()

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

protected

Get expiration date for a new password, if any.

Parameters

string $username

Returns: string|null

Definition at line 152 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $username, User\newFromName(), Hooks\run(), 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 69 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $e, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\$passwordFactory, class, and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordFactory().

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

◆ getPasswordFactory()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPasswordFactory ( )

protected

Get the PasswordFactory.

Returns: PasswordFactory

Definition at line 54 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\$passwordFactory.

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

◆ getPasswordResetData()

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

protected

Get password reset data, if any.

Parameters

string	$username
mixed	$data

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

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

Definition at line 142 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag().

◆ 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()
mixed \| null	$data	Passed through to $this->getPasswordResetData()

Definition at line 120 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $username, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordResetData(), and object.

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\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 37 of file AbstractPasswordPrimaryAuthenticationProvider.php.

◆ $passwordFactory

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::$passwordFactory = null

private

Definition at line 39 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Referenced by MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPassword(), and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordFactory().

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

includes/auth/AbstractPasswordPrimaryAuthenticationProvider.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkPasswordValidity()

◆ failResponse()

◆ getAuthenticationRequests()

◆ getNewPasswordExpiry()

◆ getPassword()

◆ getPasswordFactory()

◆ getPasswordResetData()

◆ setPasswordResetFlag()

Member Data Documentation

◆ $authoritative

◆ $passwordFactory