MediaWiki REL1_33
Public Member Functions | Protected Member Functions | List of all members
MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider Class Reference

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

Inheritance diagram for MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider:
Inheritance graph
[legend]
Collaboration diagram for MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider:
Collaboration graph
[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.
 
 continueSecondaryAuthentication ( $user, array $reqs)
 Continue an authentication flow.
 
 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.
 
 postAccountCreation ( $user, $creator, AuthenticationResponse $response)
 Post-creation callback.
 
 postAuthentication ( $user, AuthenticationResponse $response)
 Post-login callback.
 
 providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)
 Validate a change of authentication data (e.g.
 
 providerAllowsPropertyChange ( $property)
 Determine whether a property can change.
 
 providerChangeAuthenticationData (AuthenticationRequest $req)
 Change or remove authentication data (e.g.
 
 providerRevokeAccessForUser ( $username)
 @inheritDoc
 
 testForAccountCreation ( $user, $creator, array $reqs)
 Determine whether an account creation 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.
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider
Config $config
 
LoggerInterface $logger
 
AuthManager $manager
 

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$keySession key to look in
Returns
AuthenticationResponse

Definition at line 46 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References $req, $user, MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newUI(), use, 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$userUser being created (has been added to the database). This may become a "UserValue" in the future, or User may be refactored into such.
User$creatorUser 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 $user, and 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$userUser 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 $user, and MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt().

◆ continueLinkAttempt()

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

Continue the link attempt.

Parameters
User$user
string$keySession key to look in
AuthenticationRequest[]$reqs
Returns
AuthenticationResponse

Definition at line 79 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References $data, $req, $user, MediaWiki\Auth\AuthManager\ACTION_CHANGE, as, MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt(), MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\ButtonAuthenticationRequest\getRequestByName(), list, MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newPass(), MediaWiki\Auth\AuthenticationResponse\newUI(), text, 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$userUser being created (has been added to the database). This may become a "UserValue" in the future, or User may be refactored into such.
User$creatorUser 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.

Reimplemented from MediaWiki\Auth\AbstractSecondaryAuthenticationProvider.

Definition at line 36 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References $user, and MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt().

◆ continueSecondaryAuthentication()

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

Continue an authentication flow.

Parameters
User$userUser 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.

Reimplemented from MediaWiki\Auth\AbstractSecondaryAuthenticationProvider.

Definition at line 28 of file ConfirmLinkSecondaryAuthenticationProvider.php.

References $user, and 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$optionsOptions 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: