A primary authentication provider that uses the temporary password field in the 'user' table. More...

Inheritance diagram for MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider:

[legend]

Collaboration diagram for MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider:

[legend]

Public Member Functions

__construct ( $params=[])

accountCreationType ()

Fetch the account-creation type.

beginPrimaryAccountCreation ( $user, $creator, array $reqs)

Start an account creation flow.

beginPrimaryAuthentication (array $reqs)

Start an authentication flow.

finishAccountCreation ( $user, $creator, AuthenticationResponse $res)

Post-creation callback.

getAuthenticationRequests ( $action, array $options)

Return the applicable list of AuthenticationRequests.

providerAllowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)

Validate a change of authentication data (e.g.

providerChangeAuthenticationData (AuthenticationRequest $req)

Change or remove authentication data (e.g.

setConfig (\Config $config)

testForAccountCreation ( $user, $creator, array $reqs)

Determine whether an account creation may begin.

testUserCanAuthenticate ( $username)

Test whether the named user can authenticate with this provider.

testUserExists ( $username, $flags=User::READ_NORMAL)

Test whether the named user exists.

Public Member Functions inherited from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider

__construct (array $params=[])

Public Member Functions inherited from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider

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)

Continue an authentication flow.

postAccountCreation ( $user, $creator, AuthenticationResponse $response)

Post-creation callback.

postAccountLink ( $user, AuthenticationResponse $response)

Post-link callback.

postAuthentication ( $user, AuthenticationResponse $response)

Post-login callback.

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.

Parameters

string $username

Returns: string|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).

Parameters

string $username

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.

Returns: string

setConfig (Config $config)

Set configuration.

setLogger (LoggerInterface $logger)

setManager (AuthManager $manager)

Set AuthManager.

Protected Member Functions
	getPasswordResetData ( $username, $data)
	Get password reset data, if any.

	isTimestampValid ( $timestamp)
	Check that a temporary password is still valid (hasn't expired).

	sendNewAccountEmail (User $user, User $creatingUser, $password)
	Send an email about the new account creation and the temporary password.

	sendPasswordResetEmail (TemporaryPasswordAuthenticationRequest $req)

Protected Member Functions inherited from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider
	checkPasswordValidity ( $username, $password)
	Check that the password is valid.

	failResponse (PasswordAuthenticationRequest $req)
	Return the appropriate response for failure.

	getNewPasswordExpiry ( $username)
	Get expiration date for a new password, if any.

	getPassword ( $hash)
	Get a Password object from the hash.

	getPasswordFactory ()
	Get the PasswordFactory.

	setPasswordResetFlag ( $username, Status $status, $data=null)
	Check if the password should be reset.

Protected Attributes
bool	$emailEnabled = null

int	$newPasswordExpiry = null

int	$passwordReminderResendTime = null

Protected Attributes inherited from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider
bool	$authoritative
	Whether this provider should ABSTAIN (false) or FAIL (true) on password failure.

Protected Attributes inherited from MediaWiki\Auth\AbstractAuthenticationProvider
Config	$config

LoggerInterface	$logger

AuthManager	$manager

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.

Detailed Description

A primary authentication provider that uses the temporary password field in the 'user' table.

A successful login will force a password reset.

Note: For proper operation, this should generally come before any other password-based authentication providers.

Since: 1.27

Definition at line 37 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::__construct ( $params = [] )

Parameters

array

$params

emailEnabled: (bool) must be true for the option to email passwords to be present
newPasswordExpiry: (int) expiraton time of temporary passwords, in seconds
passwordReminderResendTime: (int) cooldown period in hours until a password reminder can be sent to the same user again,

Definition at line 56 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $params.

Member Function Documentation

◆ accountCreationType()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::accountCreationType ( )

Fetch the account-creation type.

Returns: string One of the TYPE_* constants

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 317 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_CREATE.

◆ beginPrimaryAccountCreation()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::beginPrimaryAccountCreation	(		$user,
			$creator,
		array	$reqs
	)

Start an account creation flow.

Parameters

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

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.
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 344 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $ret, $user, MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), and MediaWiki\Auth\AuthenticationResponse\newPass().

◆ beginPrimaryAuthentication()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::beginPrimaryAuthentication ( array $reqs )

Start 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.
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 118 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $dbr, $req, $status, $username, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\checkPasswordValidity(), DB_REPLICA, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\failResponse(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPassword(), MediaWiki\Auth\AuthenticationRequest\getRequestByClass(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\isTimestampValid(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponse\newFail(), MediaWiki\Auth\AuthenticationResponse\newPass(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\setPasswordResetFlag(), and wfGetDB().

◆ finishAccountCreation()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::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	$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

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.

Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.

Definition at line 370 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $res, $user, DB_MASTER, MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendNewAccountEmail(), use, and wfGetDB().

◆ getAuthenticationRequests()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::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: AuthManager::getAuthenticationRequests()

Parameters

string	$action
array	$options	Options 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).

Returns: AuthenticationRequest[]

Reimplemented from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider.

Definition at line 92 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $options, MediaWiki\Auth\AuthManager\ACTION_CHANGE, MediaWiki\Auth\AuthManager\ACTION_CREATE, MediaWiki\Auth\AuthManager\ACTION_LOGIN, MediaWiki\Auth\AuthManager\ACTION_REMOVE, and MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom().

◆ getPasswordResetData()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::getPasswordResetData	(	$username,
		$data
	)

protected

Get password reset data, if any.

Parameters

string	$username
mixed	$data

Returns: object|null { 'hard' => bool, 'msg' => Message }

Reimplemented from MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider.

Definition at line 84 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References wfMessage().

◆ isTimestampValid()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::isTimestampValid ( $timestamp )

protected

Check that a temporary password is still valid (hasn't expired).

Parameters

string $timestamp A timestamp in MediaWiki (TS_MW) format

Returns: bool

Definition at line 397 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\$newPasswordExpiry, $time, $timestamp, TS_MW, TS_UNIX, wfTimestamp(), and wfTimestampOrNull().

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

◆ providerAllowsAuthenticationDataChange()

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

Parameters

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.

Returns: StatusValue

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 206 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $username, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\checkPasswordValidity(), DB_MASTER, IP\isValid(), TS_UNIX, wfGetDB(), and wfTimestamp().

◆ providerChangeAuthenticationData()

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

Parameters

AuthenticationRequest $req

Implements MediaWiki\Auth\PrimaryAuthenticationProvider.

Definition at line 274 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $username, MediaWiki\Auth\AuthManager\ACTION_REMOVE, DB_MASTER, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getPasswordFactory(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), use, and wfGetDB().

Referenced by MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\finishAccountCreation().

◆ sendNewAccountEmail()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::sendNewAccountEmail	(	User	$user,
		User	$creatingUser,
			$password
	)

protected

Send an email about the new account creation and the temporary password.

Parameters

User	$user	The new user account
User	$creatingUser	The user who created the account (can be anonymous)
string	$password	The temporary password

Returns: \Status

Definition at line 415 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $status, $user, User\getRequest(), and wfMessage().

Referenced by MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\finishAccountCreation().

◆ sendPasswordResetEmail()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::sendPasswordResetEmail ( TemporaryPasswordAuthenticationRequest $req )

protected

Parameters

TemporaryPasswordAuthenticationRequest $req

Returns: \Status

Definition at line 449 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $user, and wfMessage().

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

◆ setConfig()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::setConfig ( \Config $config )

Definition at line 70 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References MediaWiki\Auth\AbstractAuthenticationProvider\$config.

◆ testForAccountCreation()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::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	$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

Returns: StatusValue

Reimplemented from MediaWiki\Auth\AbstractPrimaryAuthenticationProvider.

Definition at line 321 of file TemporaryPasswordPrimaryAuthenticationProvider.php.

References $req, $ret, $user, MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\checkPasswordValidity(), and MediaWiki\Auth\AuthenticationRequest\getRequestByClass().

◆ testUserCanAuthenticate()

MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider::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 $username MediaWiki username