MediaWiki  master
MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider Class Reference

Basic framework for a primary authentication provider that uses passwords. More...

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

Public Member Functions

 __construct (array $params=[])
 
 getAuthenticationRequests ( $action, array $options)
 
- Public Member Functions inherited from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider
 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...
 
 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...
 

Protected Member Functions

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

Protected Attributes

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
 

Private Attributes

 $passwordFactory = 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...
 

Detailed Description

Basic framework for a primary authentication provider that uses passwords.

Since
1.27

Definition at line 33 of file AbstractPasswordPrimaryAuthenticationProvider.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::__construct ( array  $params = [])
Parameters
array$paramsSettings
  • authoritative: Whether this provider should ABSTAIN (false) or FAIL (true) on password failure

Definition at line 46 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $params.

Member Function Documentation

◆ checkPasswordValidity()

◆ failResponse()

◆ getAuthenticationRequests()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getAuthenticationRequests (   $action,
array  $options 
)

◆ getNewPasswordExpiry()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getNewPasswordExpiry (   $username)
protected

Get expiration date for a new password, if any.

Parameters
string$username
Returns
string|null

Definition at line 156 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $username, User\newFromName(), null, Hooks\run(), and wfTimestamp().

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData().

◆ getPassword()

◆ getPasswordFactory()

◆ getPasswordResetData()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::getPasswordResetData (   $username,
  $data 
)
protected

Get password reset data, if any.

Parameters
string$username
mixed$data
Returns
object|null { 'hard' => bool, 'msg' => Message }

Definition at line 146 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References null.

Referenced by MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag().

◆ setPasswordResetFlag()

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::setPasswordResetFlag (   $username,
Status  $status,
  $data = null 
)
protected

Check if the password should be reset.

This should be called after a successful login. It sets 'reset-pass' authentication data if necessary, see ResetPassSecondaryAuthenticationProvider.

Parameters
string$username
Status$statusFrom $this->checkPasswordValidity()
mixed | null$dataPassed through to $this->getPasswordResetData()

Definition at line 120 of file AbstractPasswordPrimaryAuthenticationProvider.php.

References $username, Status\getMessage(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordResetData(), StatusValue\getValue(), StatusValue\isGood(), and object.

Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication(), and MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\beginPrimaryAuthentication().

Member Data Documentation

◆ $authoritative

bool MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::$authoritative
protected

Whether this provider should ABSTAIN (false) or FAIL (true) on password failure.

Definition at line 37 of file AbstractPasswordPrimaryAuthenticationProvider.php.

◆ $passwordFactory

MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider::$passwordFactory = null
private

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