A base class that implements some of the boilerplate for a PreAuthenticationProvider. More...

Inheritance diagram for MediaWiki\Auth\AbstractPreAuthenticationProvider:

[legend]

Collaboration diagram for MediaWiki\Auth\AbstractPreAuthenticationProvider:

[legend]

Public Member Functions
	getAuthenticationRequests ( $action, array $options)
	Return the applicable list of AuthenticationRequests.

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

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

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

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

	testForAccountLink ( $user)
	Determine whether an account may linked to another authentication method.

	testForAuthentication (array $reqs)
	Determine whether an authentication may begin.

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

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

	setConfig (Config $config)
	Set configuration.

	setLogger (LoggerInterface $logger)

	setManager (AuthManager $manager)
	Set AuthManager.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider
Config	$config

LoggerInterface	$logger

AuthManager	$manager

Detailed Description

A base class that implements some of the boilerplate for a PreAuthenticationProvider.

Since: 1.27

Definition at line 29 of file AbstractPreAuthenticationProvider.php.

Member Function Documentation

◆ getAuthenticationRequests()

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

Return the applicable list of AuthenticationRequests.

Possible values for $action depend on whether the implementing class is also a PreAuthenticationProvider, PrimaryAuthenticationProvider, or SecondaryAuthenticationProvider.

ACTION_LOGIN: Valid for passing to beginAuthentication. Called on all providers.
ACTION_CREATE: Valid for passing to beginAccountCreation. Called on all providers.
ACTION_LINK: Valid for passing to beginAccountLink. Called on linking primary providers only.
ACTION_CHANGE: Valid for passing to AuthManager::changeAuthenticationData to change credentials. Called on primary and secondary providers.
ACTION_REMOVE: Valid for passing to AuthManager::changeAuthenticationData to remove credentials. Must work without additional user input (i.e. without calling loadFromSubmission). Called on primary and secondary providers.

See also: AuthManager::getAuthenticationRequests()

Parameters

string	$action
array	$options	Options are: username: User name related to the action, or null/unset if anon. ACTION_LOGIN: The currently logged-in user, if any. ACTION_CREATE: The account creator, if non-anonymous. ACTION_LINK: The local user being linked to. ACTION_CHANGE: The user having data changed. ACTION_REMOVE: The user having data removed. If you leave the username property of the returned requests empty, this will automatically be copied there (except for ACTION_CREATE where it wouldn't really make sense).

Returns: AuthenticationRequest[]

Implements MediaWiki\Auth\AuthenticationProvider.

Definition at line 33 of file AbstractPreAuthenticationProvider.php.

◆ postAccountCreation()

MediaWiki\Auth\AbstractPreAuthenticationProvider::postAccountCreation	(		$user,
			$creator,
		AuthenticationResponse	$response
	)

Post-creation callback.

This will be called at the end of an account creation attempt. 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)

Implements MediaWiki\Auth\PreAuthenticationProvider.

Definition at line 52 of file AbstractPreAuthenticationProvider.php.

◆ postAccountLink()

MediaWiki\Auth\AbstractPreAuthenticationProvider::postAccountLink	(		$user,
		AuthenticationResponse	$response
	)

Post-link callback.

This will be called at the end of an account linking attempt.

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)

Implements MediaWiki\Auth\PreAuthenticationProvider.

Definition at line 59 of file AbstractPreAuthenticationProvider.php.

◆ postAuthentication()

MediaWiki\Auth\AbstractPreAuthenticationProvider::postAuthentication	(		$user,
		AuthenticationResponse	$response
	)

Post-login callback.

This will be called at the end of a login attempt. It will not be called for unfinished login attempts that fail by the session timing out.

Note: Under certain circumstances, this can be called even when testForAuthentication was not; see AuthenticationRequest::$loginRequest.

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)

Implements MediaWiki\Auth\PreAuthenticationProvider.

Reimplemented in MediaWiki\Auth\ThrottlePreAuthenticationProvider.

Definition at line 41 of file AbstractPreAuthenticationProvider.php.

◆ testForAccountCreation()

MediaWiki\Auth\AbstractPreAuthenticationProvider::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

Implements MediaWiki\Auth\PreAuthenticationProvider.

Reimplemented in MediaWiki\Auth\LegacyHookPreAuthenticationProvider, and MediaWiki\Auth\ThrottlePreAuthenticationProvider.

Definition at line 44 of file AbstractPreAuthenticationProvider.php.

◆ testForAccountLink()

MediaWiki\Auth\AbstractPreAuthenticationProvider::testForAccountLink ( $user )

Determine whether an account may linked to another authentication method.

Parameters

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

Returns: StatusValue

Implements MediaWiki\Auth\PreAuthenticationProvider.

Definition at line 55 of file AbstractPreAuthenticationProvider.php.

◆ testForAuthentication()

MediaWiki\Auth\AbstractPreAuthenticationProvider::testForAuthentication ( array $reqs )

Determine whether an authentication may begin.

Called from AuthManager::beginAuthentication()

Parameters

AuthenticationRequest[] $reqs

Returns: StatusValue

Implements MediaWiki\Auth\PreAuthenticationProvider.

Reimplemented in MediaWiki\Auth\LegacyHookPreAuthenticationProvider, and MediaWiki\Auth\ThrottlePreAuthenticationProvider.

Definition at line 37 of file AbstractPreAuthenticationProvider.php.

◆ testUserForCreation()

MediaWiki\Auth\AbstractPreAuthenticationProvider::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 User:READ_* constants, default User::READ_NORMAL creating: (bool) If false (or missing), this call is only testing if a user could be created. If set, this (non-autocreation) is for actually creating an account and will 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.

Returns: StatusValue

Implements MediaWiki\Auth\PreAuthenticationProvider.

Reimplemented in MediaWiki\Auth\LegacyHookPreAuthenticationProvider.

Definition at line 48 of file AbstractPreAuthenticationProvider.php.

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

includes/auth/AbstractPreAuthenticationProvider.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAuthenticationRequests()

◆ postAccountCreation()

◆ postAccountLink()

◆ postAuthentication()

◆ testForAccountCreation()

◆ testForAccountLink()

◆ testForAuthentication()

◆ testUserForCreation()