MediaWiki
1.30.0
|
Primary authentication provider wrapper for AuthPlugin. More...
Public Member Functions | |
__construct (AuthPlugin $auth, $requestType=null) | |
accountCreationType () | |
Fetch the account-creation type. More... | |
autoCreatedAccount ( $user, $source) | |
Post-auto-creation callback. More... | |
beginPrimaryAccountCreation ( $user, $creator, array $reqs) | |
Start an account creation flow. More... | |
beginPrimaryAuthentication (array $reqs) | |
Start an authentication flow. More... | |
getAuthenticationRequests ( $action, array $options) | |
@inheritDoc More... | |
getUniqueId () | |
@inheritDoc More... | |
onLocalUserCreated ( $user, $autocreated) | |
Hook function to call AuthPlugin::initUser() More... | |
onUserGroupsChanged ( $user, $added, $removed) | |
Hook function to call AuthPlugin::updateExternalDBGroups() More... | |
onUserLoggedIn ( $user) | |
Hook function to call AuthPlugin::updateUser() More... | |
onUserSaveSettings ( $user) | |
Hook function to call AuthPlugin::updateExternalDB() More... | |
providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true) | |
Validate a change of authentication data (e.g. More... | |
providerAllowsPropertyChange ( $property) | |
Determine whether a property can change. More... | |
providerChangeAuthenticationData (AuthenticationRequest $req) | |
Change or remove authentication data (e.g. More... | |
providerRevokeAccessForUser ( $username) | |
@inheritDoc More... | |
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... | |
testUserExists ( $username, $flags=User::READ_NORMAL) | |
Test whether the named user exists. More... | |
Public Member Functions inherited from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider | |
__construct (array $params=[]) | |
Public Member Functions inherited from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider | |
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... | |
providerNormalizeUsername ( $username) | |
@inheritDoc More... | |
testUserForCreation ( $user, $autocreate, array $options=[]) | |
Determine whether an account may be created. More... | |
Public Member Functions inherited from MediaWiki\Auth\AbstractAuthenticationProvider | |
setConfig (Config $config) | |
Set configuration. More... | |
setLogger (LoggerInterface $logger) | |
setManager (AuthManager $manager) | |
Set AuthManager. More... | |
Protected Member Functions | |
makeAuthReq () | |
Create an appropriate AuthenticationRequest. More... | |
setDomain ( $req) | |
Call $this->auth->setDomain() More... | |
Protected Member Functions inherited from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider | |
checkPasswordValidity ( $username, $password) | |
Check that the password is valid. More... | |
failResponse (PasswordAuthenticationRequest $req) | |
Return the appropriate response for failure. More... | |
getNewPasswordExpiry ( $username) | |
Get expiration date for a new password, if any. More... | |
getPassword ( $hash) | |
Get a Password object from the hash. More... | |
getPasswordFactory () | |
Get the PasswordFactory. More... | |
getPasswordResetData ( $username, $data) | |
Get password reset data, if any. More... | |
setPasswordResetFlag ( $username, Status $status, $data=null) | |
Check if the password should be reset. More... | |
Private Member Functions | |
testUserCanAuthenticateInternal ( $user) | |
Private Attributes | |
$auth | |
$hasDomain | |
$requestType = null | |
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\AbstractPasswordPrimaryAuthenticationProvider | |
bool | $authoritative |
Whether this provider should ABSTAIN (false) or FAIL (true) on password failure. More... | |
Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider | |
Config | $config |
LoggerInterface | $logger |
AuthManager | $manager |
Primary authentication provider wrapper for AuthPlugin.
Definition at line 36 of file AuthPluginPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::__construct | ( | AuthPlugin | $auth, |
$requestType = null |
|||
) |
AuthPlugin | $auth | AuthPlugin to wrap |
string | null | $requestType | Class name of the PasswordAuthenticationRequest to use. If $auth->domainList() returns more than one domain, this must be a PasswordDomainAuthenticationRequest. |
Definition at line 49 of file AuthPluginPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\$auth, MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\$requestType, class, captcha-old\count, and Hooks\register().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::accountCreationType | ( | ) |
Fetch the account-creation type.
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 381 of file AuthPluginPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_CREATE, and MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_NONE.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\beginPrimaryAccountCreation().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::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(). |
Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.
Definition at line 419 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::beginPrimaryAccountCreation | ( | $user, | |
$creator, | |||
array | $reqs | ||
) |
Start 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 390 of file AuthPluginPrimaryAuthenticationProvider.php.
References $req, $user, $username, MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\accountCreationType(), User\getCanonicalName(), MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newFail(), MediaWiki\Auth\AuthenticationResponse\newPass(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\setDomain().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::beginPrimaryAuthentication | ( | array | $reqs | ) |
Start an authentication flow.
AuthenticationRequest[] | $reqs |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 192 of file AuthPluginPrimaryAuthenticationProvider.php.
References $req, $username, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\failResponse(), User\getCanonicalName(), MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), User\newFromName(), MediaWiki\Auth\AuthenticationResponse\newPass(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\setDomain(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\testUserCanAuthenticateInternal().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::getAuthenticationRequests | ( | $action, | |
array | $options | ||
) |
@inheritDoc
Of the requests returned by this method, exactly one should have AuthenticationRequest::$required set to REQUIRED.
Reimplemented from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider.
Definition at line 176 of file AuthPluginPrimaryAuthenticationProvider.php.
References MediaWiki\$action, MediaWiki\Auth\AuthManager\ACTION_CHANGE, MediaWiki\Auth\AuthManager\ACTION_CREATE, MediaWiki\Auth\AuthManager\ACTION_LOGIN, MediaWiki\Auth\AuthManager\ACTION_REMOVE, and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\makeAuthReq().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::getUniqueId | ( | ) |
@inheritDoc
Reimplemented from MediaWiki\Auth\AbstractAuthenticationProvider.
Definition at line 172 of file AuthPluginPrimaryAuthenticationProvider.php.
|
protected |
Create an appropriate AuthenticationRequest.
Definition at line 88 of file AuthPluginPrimaryAuthenticationProvider.php.
References MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\$requestType.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\getAuthenticationRequests().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::onLocalUserCreated | ( | $user, | |
$autocreated | |||
) |
Hook function to call AuthPlugin::initUser()
User | $user | |
bool | $autocreated |
Definition at line 158 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::onUserGroupsChanged | ( | $user, | |
$added, | |||
$removed | |||
) |
Hook function to call AuthPlugin::updateExternalDBGroups()
User | $user | |
array | $added | |
array | $removed |
Definition at line 133 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::onUserLoggedIn | ( | $user | ) |
Hook function to call AuthPlugin::updateUser()
User | $user |
Definition at line 142 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::onUserSaveSettings | ( | $user | ) |
Hook function to call AuthPlugin::updateExternalDB()
User | $user |
Definition at line 122 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::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.
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. |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 308 of file AuthPluginPrimaryAuthenticationProvider.php.
References $req, $username, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\checkPasswordValidity(), User\getCanonicalName(), StatusValue\newGood(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\setDomain().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::providerAllowsPropertyChange | ( | $property | ) |
Determine whether a property can change.
string | $property |
Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.
Definition at line 303 of file AuthPluginPrimaryAuthenticationProvider.php.
References $property.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::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).
AuthenticationRequest | $req |
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 356 of file AuthPluginPrimaryAuthenticationProvider.php.
References $req, $user, $username, User\getCanonicalName(), User\newFromName(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\setDomain().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::providerRevokeAccessForUser | ( | $username | ) |
@inheritDoc
Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.
Definition at line 252 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user, $username, as, User\getCanonicalName(), User\newFromName(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\testUserCanAuthenticateInternal().
|
protected |
Call $this->auth->setDomain()
PasswordAuthenticationRequest | $req |
Definition at line 101 of file AuthPluginPrimaryAuthenticationProvider.php.
References $req.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\beginPrimaryAccountCreation(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\providerChangeAuthenticationData().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::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 |
Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.
Definition at line 386 of file AuthPluginPrimaryAuthenticationProvider.php.
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::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 |
Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.
Definition at line 216 of file AuthPluginPrimaryAuthenticationProvider.php.
References $username, as, User\getCanonicalName(), User\newFromName(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\testUserCanAuthenticateInternal().
|
private |
User | $user |
Definition at line 244 of file AuthPluginPrimaryAuthenticationProvider.php.
References $user.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\beginPrimaryAuthentication(), MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\providerRevokeAccessForUser(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\testUserCanAuthenticate().
MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider::testUserExists | ( | $username, | |
$flags = User::READ_NORMAL |
|||
) |
Test whether the named user exists.
Single-sign-on providers can use this to reserve a username for autocreation.
Implements MediaWiki\Auth\PrimaryAuthenticationProvider.
Definition at line 281 of file AuthPluginPrimaryAuthenticationProvider.php.
References $username, as, and User\getCanonicalName().
|
private |
Definition at line 39 of file AuthPluginPrimaryAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\__construct().
|
private |
Definition at line 40 of file AuthPluginPrimaryAuthenticationProvider.php.
|
private |
Definition at line 41 of file AuthPluginPrimaryAuthenticationProvider.php.
Referenced by MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\__construct(), and MediaWiki\Auth\AuthPluginPrimaryAuthenticationProvider\makeAuthReq().