MediaWiki  master
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider Class Reference

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

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

Public Member Functions

 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)
 
 providerRevokeAccessForUser ( $username)
 
 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 ()
 
 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...
 
 getAuthenticationRequests ( $action, array $options)
 
 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...
 

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...
 
- 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 PrimaryAuthenticationProvider.

Since
1.27

Definition at line 32 of file AbstractPrimaryAuthenticationProvider.php.

Member Function Documentation

◆ autoCreatedAccount()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::autoCreatedAccount (   $user,
  $source 
)

Post-auto-creation callback.

Parameters
User$userUser 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$sourceThe source of the auto-creation passed to AuthManager::autoCreateUser().

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 98 of file AbstractPrimaryAuthenticationProvider.php.

◆ beginPrimaryAccountLink()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::beginPrimaryAccountLink (   $user,
array  $reqs 
)

Start linking an account to an existing user.

Parameters
User$userUser being linked. 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 linked.
  • FAIL: The user is not linked. Fail the linking process.
  • ABSTAIN: These $reqs are not handled. Some other primary provider may handle it.
  • UI: The $reqs are accepted, no other primary provider will run. Additional AuthenticationRequests are needed to complete the process.
  • REDIRECT: The $reqs are accepted, no other primary provider will run. Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 101 of file AbstractPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\PrimaryAuthenticationProvider\accountCreationType().

◆ continuePrimaryAccountCreation()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAccountCreation (   $user,
  $creator,
array  $reqs 
)

Continue an account creation flow.

Parameters
User$userUser being created (not added to the database yet). 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 may be created. Secondary providers will now run.
  • FAIL: The user may not be created. Fail the creation process.
  • UI: Additional AuthenticationRequests are needed to complete the process.
  • REDIRECT: Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 83 of file AbstractPrimaryAuthenticationProvider.php.

◆ continuePrimaryAccountLink()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAccountLink (   $user,
array  $reqs 
)

Continue linking an account to an existing user.

Parameters
User$userUser being linked. 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 linked.
  • FAIL: The user is not linked. Fail the linking process.
  • UI: Additional AuthenticationRequests are needed to complete the process.
  • REDIRECT: Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 111 of file AbstractPrimaryAuthenticationProvider.php.

◆ continuePrimaryAuthentication()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAuthentication ( array  $reqs)

Continue an authentication flow.

Parameters
AuthenticationRequest[]$reqs
Returns
AuthenticationResponse Expected responses:
  • PASS: The user is authenticated. Secondary providers will now run.
  • FAIL: The user is not authenticated. Fail the authentication process.
  • UI: Additional AuthenticationRequests are needed to complete the process.
  • REDIRECT: Redirection to a third party is needed to complete the process.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 36 of file AbstractPrimaryAuthenticationProvider.php.

◆ finishAccountCreation()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::finishAccountCreation (   $user,
  $creator,
AuthenticationResponse  $response 
)

Post-creation callback.

Called after the user is added to the database, before secondary authentication providers are run. Only called if this provider was the one that issued a PASS.

Parameters
User$userUser being created (has been added to the database now). 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.
AuthenticationResponse$responsePASS response returned earlier
Returns
string|null 'newusers' log subtype to use for logging the account creation. If null, either 'create' or 'create2' will be used depending on $creator.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 87 of file AbstractPrimaryAuthenticationProvider.php.

References null.

◆ postAccountCreation()

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

Post-creation callback.

This will be called at the end of any account creation attempt, regardless of whether this provider was the one that handled it. 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$userUser that was attempted to be created. 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.
AuthenticationResponse$responseAuthentication response that will be returned (PASS or FAIL)

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 91 of file AbstractPrimaryAuthenticationProvider.php.

◆ postAccountLink()

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

Post-link callback.

This will be called at the end of any account linking attempt, regardless of whether this provider was the one that handled it.

Parameters
User$userUser that was attempted to be linked. This may become a "UserValue" in the future, or User may be refactored into such.
AuthenticationResponse$responseAuthentication response that will be returned (PASS or FAIL)

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 115 of file AbstractPrimaryAuthenticationProvider.php.

◆ postAuthentication()

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

Post-login callback.

This will be called at the end of any login attempt, regardless of whether this provider was the one that handled it. It will not be called for unfinished login attempts that fail by the session timing out.

Parameters
User | null$userUser 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$responseAuthentication response that will be returned (PASS or FAIL)

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 40 of file AbstractPrimaryAuthenticationProvider.php.

◆ providerAllowsPropertyChange()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerAllowsPropertyChange (   $property)

Determine whether a property can change.

See also
AuthManager::allowsPropertyChange()
Parameters
string$property
Returns
bool

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 75 of file AbstractPrimaryAuthenticationProvider.php.

◆ providerNormalizeUsername()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerNormalizeUsername (   $username)

Note
Reimplement this if you do anything other than User::getCanonicalName( $req->username ) to determine the user being authenticated.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 54 of file AbstractPrimaryAuthenticationProvider.php.

References $name, $username, User\getCanonicalName(), and null.

◆ providerRevokeAccessForUser()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerRevokeAccessForUser (   $username)

Note
Reimplement this if self::getAuthenticationRequests( AuthManager::ACTION_REMOVE ) doesn't return requests that will revoke all access for the user.

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 64 of file AbstractPrimaryAuthenticationProvider.php.

References $req, $username, MediaWiki\Auth\AuthManager\ACTION_REMOVE, as, MediaWiki\Auth\PrimaryAuthenticationProvider\getAuthenticationRequests(), and MediaWiki\Auth\PrimaryAuthenticationProvider\providerChangeAuthenticationData().

◆ testForAccountCreation()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::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$userUser being created (not added to the database yet). 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
StatusValue

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 79 of file AbstractPrimaryAuthenticationProvider.php.

◆ testUserCanAuthenticate()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::testUserCanAuthenticate (   $username)

Test whether the named user can authenticate with this provider.

Should return true if the provider has any data for this user which can be used to authenticate it, even if the user is temporarily prevented from authentication somehow.

Parameters
string$usernameMediaWiki username
Returns
bool

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 43 of file AbstractPrimaryAuthenticationProvider.php.

References $username, and MediaWiki\Auth\PrimaryAuthenticationProvider\testUserExists().

◆ testUserForCreation()

MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::testUserForCreation (   $user,
  $autocreate,
array  $options = [] 
)

Determine whether an account may be created.

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

Definition at line 94 of file AbstractPrimaryAuthenticationProvider.php.


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