Links third-party authentication to the user's account. More...

Inherits MediaWiki\Auth\AbstractSecondaryAuthenticationProvider.

Collaboration diagram for MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider:

[legend]

Public Member Functions

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

Start an account creation flow.

beginSecondaryAuthentication ( $user, array $reqs)

Start an authentication flow.

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

Continue an authentication flow.

Parameters

User	$user	User being created (has been added to the database). 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 creation is ok. Additional secondary providers may run.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Stability: stable: to override

continueSecondaryAuthentication ( $user, array $reqs)

Continue an authentication flow.

Parameters

User	$user	User being authenticated. 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 authenticated. Additional secondary providers may run.
FAIL: The user is not authenticated. Fail the authentication process.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Stability: stable: to override

getAuthenticationRequests ( $action, array $options)

Return the applicable list of AuthenticationRequests.

Public Member Functions inherited from MediaWiki\Auth\AbstractSecondaryAuthenticationProvider

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().

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)

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.

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)

providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)

Validate a change of authentication data (e.g.passwords)Return StatusValue::newGood( 'ignored' ) if you don't support this AuthenticationRequest type.

Parameters

AuthenticationRequest	$req
bool	$checkData	If false, $req hasn't been loaded from the submission so checks on user-submitted fields should be skipped. $req->username is considered user-submitted for this purpose, even if it cannot be changed via $req->loadFromSubmission.

Returns: StatusValue

providerAllowsPropertyChange ( $property)

Determine whether a property can change.

See also: AuthManager::allowsPropertyChange()

Parameters

string $property

Returns: bool

providerChangeAuthenticationData (AuthenticationRequest $req)

Change or remove authentication data (e.g.passwords)If $req was returned for AuthManager::ACTION_CHANGE, the corresponding credentials should result in a successful login in the future.If $req was returned for AuthManager::ACTION_REMOVE, the corresponding credentials should no longer result in a successful login.It can be assumed that providerAllowsAuthenticationDataChange with $checkData === true was called before this, and passed. This method should never fail (other than throwing an exception).

Parameters

AuthenticationRequest $req

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

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

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.

setConfig (Config $config)

setHookContainer (HookContainer $hookContainer)

setLogger (LoggerInterface $logger)

setManager (AuthManager $manager)

Protected Member Functions
	beginLinkAttempt ( $user, $key)
	Begin the link attempt.

	continueLinkAttempt ( $user, $key, array $reqs)
	Continue the link attempt.

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.

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

LoggerInterface	$logger

AuthManager	$manager

UserNameUtils	$userNameUtils

Detailed Description

Links third-party authentication to the user's account.

If the user logged into linking provider accounts that aren't linked to a local user, this provider will prompt the user to link them after a successful login or account creation.

To avoid confusing behavior, this provider should be later in the configuration list than any provider that can abort the authentication process, so that it is only invoked for successful authentication.

Definition at line 18 of file ConfirmLinkSecondaryAuthenticationProvider.php.

Member Function Documentation

◆ beginLinkAttempt()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::beginLinkAttempt	(		$user,
			$key )

protected

Begin the link attempt.

Parameters

User	$user
string	$key	Session key to look in

Returns: AuthenticationResponse

Definition at line 46 of file ConfirmLinkSecondaryAuthenticationProvider.php.

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

Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginSecondaryAccountCreation(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginSecondaryAuthentication(), and MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt().

◆ beginSecondaryAccountCreation()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::beginSecondaryAccountCreation	(		$user,
			$creator,
		array	$reqs )

Start an account creation flow.

Note: There is no guarantee this will be called in a successful account creation process as the user can just abandon the process at any time after the primary provider has issued a PASS and still have a valid account. Be prepared to handle any database inconsistencies that result from this or continueSecondaryAccountCreation() not being called.

Parameters

User	$user	User being created (has been added to the database). 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 creation is ok. Additional secondary providers may run.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\SecondaryAuthenticationProvider.

Definition at line 32 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt().

◆ beginSecondaryAuthentication()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::beginSecondaryAuthentication	(		$user,
		array	$reqs )

Start an authentication flow.

Note that this may be called for a user even if beginSecondaryAccountCreation() was never called. The module should take the opportunity to do any necessary setup in that case.

Parameters

User	$user	User being authenticated. 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 authenticated. Additional secondary providers may run.
FAIL: The user is not authenticated. Fail the authentication process.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\SecondaryAuthenticationProvider.

Definition at line 24 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt().

◆ continueLinkAttempt()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::continueLinkAttempt	(		$user,
			$key,
		array	$reqs )

protected

Continue the link attempt.

Parameters

User	$user
string	$key	Session key to look in
AuthenticationRequest[]	$reqs

Returns: AuthenticationResponse

Definition at line 79 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References MediaWiki\Auth\AuthManager\ACTION_CHANGE, MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt(), MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\ButtonAuthenticationRequest\getRequestByName(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newPass(), MediaWiki\Auth\AuthenticationResponse\newUI(), and wfMessage().

Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueSecondaryAccountCreation(), and MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueSecondaryAuthentication().

◆ continueSecondaryAccountCreation()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::continueSecondaryAccountCreation	(		$user,
			$creator,
		array	$reqs )

Continue an authentication flow.

Parameters

User	$user	User being created (has been added to the database). 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 creation is ok. Additional secondary providers may run.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Stability: stable: to override

Stability: stable: to override

Reimplemented from MediaWiki\Auth\AbstractSecondaryAuthenticationProvider.

Definition at line 36 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt().

◆ continueSecondaryAuthentication()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::continueSecondaryAuthentication	(		$user,
		array	$reqs )

Continue an authentication flow.

Parameters

User	$user	User being authenticated. 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 authenticated. Additional secondary providers may run.
FAIL: The user is not authenticated. Fail the authentication process.
ABSTAIN: Additional secondary providers may run.
UI: Additional AuthenticationRequests are needed to complete the process.
REDIRECT: Redirection to a third party is needed to complete the process.

Stability: stable: to override

Stability: stable: to override

Reimplemented from MediaWiki\Auth\AbstractSecondaryAuthenticationProvider.

Definition at line 28 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt().

◆ getAuthenticationRequests()

MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider::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 20 of file ConfirmLinkSecondaryAuthenticationProvider.php.

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

includes/auth/ConfirmLinkSecondaryAuthenticationProvider.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ beginLinkAttempt()

◆ beginSecondaryAccountCreation()

◆ beginSecondaryAuthentication()

◆ continueLinkAttempt()

◆ continueSecondaryAccountCreation()

◆ continueSecondaryAuthentication()

◆ getAuthenticationRequests()