MediaWiki  1.29.1
MediaWiki\Auth\AuthenticationProvider Interface Reference

An AuthenticationProvider is used by AuthManager when authenticating users. More...

Inheritance diagram for MediaWiki\Auth\AuthenticationProvider:
Collaboration diagram for MediaWiki\Auth\AuthenticationProvider:

Public Member Functions

 getAuthenticationRequests ( $action, array $options)
 Return the applicable list of AuthenticationRequests. More...
 getUniqueId ()
 Return a unique identifier for this instance. More...
 setConfig (Config $config)
 Set configuration. More...
 setManager (AuthManager $manager)
 Set AuthManager. More...

Detailed Description

An AuthenticationProvider is used by AuthManager when authenticating users.

This interface should not be implemented directly; use one of its children.

Authentication providers can be registered via $wgAuthManagerAutoConfig.


Definition at line 39 of file AuthenticationProvider.php.

Member Function Documentation

◆ getAuthenticationRequests()

MediaWiki\Auth\AuthenticationProvider::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
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).

Implemented in MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider, MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider, MediaWiki\Auth\PrimaryAuthenticationProvider, MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider, MediaWiki\Auth\EmailNotificationSecondaryAuthenticationProvider, MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider, MediaWiki\Auth\AbstractPreAuthenticationProvider, TitleBlacklistPreAuthenticationProvider, MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider, and CaptchaPreAuthenticationProvider.

Referenced by MediaWiki\Auth\AbstractSecondaryAuthenticationProvider\providerRevokeAccessForUser().

◆ getUniqueId()

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


Implemented in MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider, and MediaWiki\Auth\AbstractAuthenticationProvider.

◆ setConfig()

◆ setManager()

MediaWiki\Auth\AuthenticationProvider::setManager ( AuthManager  $manager)

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