MediaWiki master
|
A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider. More...
Inherits MediaWiki\Auth\AbstractAuthenticationProvider, and MediaWiki\Auth\PrimaryAuthenticationProvider.
Inherited by MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider.
Public Member Functions | ||||||||||
autoCreatedAccount ( $user, $source) | ||||||||||
Post-auto-creation callback.
| ||||||||||
beginPrimaryAccountLink ( $user, array $reqs) | ||||||||||
Start linking an account to an existing user.
| ||||||||||
continuePrimaryAccountCreation ( $user, $creator, array $reqs) | ||||||||||
Continue an account creation flow.
| ||||||||||
continuePrimaryAccountLink ( $user, array $reqs) | ||||||||||
Continue linking an account to an existing user.
| ||||||||||
continuePrimaryAuthentication (array $reqs) | ||||||||||
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.
| ||||||||||
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).
| ||||||||||
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.
| ||||||||||
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.
| ||||||||||
providerAllowsPropertyChange ( $property) | ||||||||||
Determine whether a property can change.
| ||||||||||
providerNormalizeUsername ( $username) | ||||||||||
Normalize the username for authentication.Any two inputs that would result in the same user being authenticated should return the same string here, while inputs that would result in different users should return different strings.If possible, the best thing to do here is to return the canonicalized name of the local user account that would be used. If not, return something that would be invalid as a local username (e.g. wrap an email address in "<>", or append "#servicename" to the username passed to a third-party service).If the provider doesn't use a username at all in its AuthenticationRequests, return null. If the name is syntactically invalid, it's probably best to return null.
| ||||||||||
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).
| ||||||||||
testForAccountCreation ( $user, $creator, array $reqs) | ||||||||||
Determine whether an account creation may begin.Called from AuthManager::beginAccountCreation()
| ||||||||||
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.
| ||||||||||
testUserForCreation ( $user, $autocreate, array $options=[]) | ||||||||||
Determine whether an account may be created.
| ||||||||||
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.
| ||||||||||
init (LoggerInterface $logger, AuthManager $manager, HookContainer $hookContainer, Config $config, UserNameUtils $userNameUtils) | ||||||||||
Initialise with dependencies of an AuthenticationProvider. | ||||||||||
Public Member Functions inherited from MediaWiki\Auth\PrimaryAuthenticationProvider | ||||||||||
accountCreationType () | ||||||||||
Fetch the account-creation type. | ||||||||||
beginPrimaryAccountCreation ( $user, $creator, array $reqs) | ||||||||||
Start an account creation flow. | ||||||||||
beginPrimaryAuthentication (array $reqs) | ||||||||||
Start an authentication flow. | ||||||||||
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.
| ||||||||||
providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true) | ||||||||||
Validate a change of authentication data (e.g. | ||||||||||
providerChangeAuthenticationData (AuthenticationRequest $req) | ||||||||||
Change or remove authentication data (e.g. | ||||||||||
testUserExists ( $username, $flags=IDBAccessObject::READ_NORMAL) | ||||||||||
Test whether the named user exists. | ||||||||||
Additional Inherited Members | |
Public Attributes inherited from MediaWiki\Auth\PrimaryAuthenticationProvider | |
const | TYPE_CREATE = 'create' |
Provider can create accounts. | |
const | TYPE_LINK = 'link' |
Provider can link to existing accounts elsewhere. | |
const | TYPE_NONE = 'none' |
Provider cannot create or link to accounts. | |
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. | |
Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider | |
Config | $config |
LoggerInterface | $logger |
AuthManager | $manager |
UserNameUtils | $userNameUtils |
A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider.
Definition at line 31 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::autoCreatedAccount | ( | $user, | |
$source ) |
Post-auto-creation callback.
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(). |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 144 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::beginPrimaryAccountLink | ( | $user, | |
array | $reqs ) |
Start linking an account to an existing user.
User | $user | User being linked. This may become a "UserValue" in the future, or User may be refactored into such. |
AuthenticationRequest[] | $reqs |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 151 of file AbstractPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\PrimaryAuthenticationProvider\accountCreationType().
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAccountCreation | ( | $user, | |
$creator, | |||
array | $reqs ) |
Continue an account creation flow.
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 |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 112 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAccountLink | ( | $user, | |
array | $reqs ) |
Continue linking an account to an existing user.
User | $user | User being linked. This may become a "UserValue" in the future, or User may be refactored into such. |
AuthenticationRequest[] | $reqs |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 166 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::continuePrimaryAuthentication | ( | array | $reqs | ) |
array | $reqs |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 42 of file AbstractPrimaryAuthenticationProvider.php.
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.
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. |
User | $creator | User doing the creation. This may become a "UserValue" in the future, or User may be refactored into such. |
AuthenticationResponse | $response | PASS response returned earlier |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Reimplemented in MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider, and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider.
Definition at line 121 of file AbstractPrimaryAuthenticationProvider.php.
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).
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\PrimaryAuthenticationProvider.
Definition at line 129 of file AbstractPrimaryAuthenticationProvider.php.
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.
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\PrimaryAuthenticationProvider.
Definition at line 175 of file AbstractPrimaryAuthenticationProvider.php.
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.
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\PrimaryAuthenticationProvider.
Definition at line 51 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerAllowsPropertyChange | ( | $property | ) |
Determine whether a property can change.
string | $property |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 96 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::providerNormalizeUsername | ( | $username | ) |
Normalize the username for authentication.Any two inputs that would result in the same user being authenticated should return the same string here, while inputs that would result in different users should return different strings.If possible, the best thing to do here is to return the canonicalized name of the local user account that would be used. If not, return something that would be invalid as a local username (e.g. wrap an email address in "<>", or append "#servicename" to the username passed to a third-party service).If the provider doesn't use a username at all in its AuthenticationRequests, return null. If the name is syntactically invalid, it's probably best to return null.
string | $username |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 70 of file AbstractPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::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).
string | $username |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 81 of file AbstractPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\AuthManager\ACTION_REMOVE, MediaWiki\Auth\PrimaryAuthenticationProvider\getAuthenticationRequests(), and MediaWiki\Auth\PrimaryAuthenticationProvider\providerChangeAuthenticationData().
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::testForAccountCreation | ( | $user, | |
$creator, | |||
array | $reqs ) |
Determine whether an account creation may begin.Called from AuthManager::beginAccountCreation()
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 |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Reimplemented in MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider, and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider.
Definition at line 104 of file AbstractPrimaryAuthenticationProvider.php.
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.
string | $username | MediaWiki username |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Reimplemented in MediaWiki\Auth\AbstractTemporaryPasswordPrimaryAuthenticationProvider, and MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider.
Definition at line 58 of file AbstractPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\PrimaryAuthenticationProvider\testUserExists().
MediaWiki\Auth\AbstractPrimaryAuthenticationProvider::testUserForCreation | ( | $user, | |
$autocreate, | |||
array | $options = [] ) |
Determine whether an account may be created.
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 |
|
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 136 of file AbstractPrimaryAuthenticationProvider.php.