A pre-authentication provider to throttle authentication actions. More...

Inheritance diagram for MediaWiki\Auth\ThrottlePreAuthenticationProvider:

[legend]

Collaboration diagram for MediaWiki\Auth\ThrottlePreAuthenticationProvider:

[legend]

Public Member Functions
	__construct ( $params=[])

	postAuthentication ( $user, AuthenticationResponse $response)

	setConfig (Config $config)
	Set configuration.

	testForAccountCreation ( $user, $creator, array $reqs)
	Determine whether an account creation may begin.

	testForAuthentication (array $reqs)
	Determine whether an authentication may begin.

Public Member Functions inherited from MediaWiki\Auth\AbstractPreAuthenticationProvider
	getAuthenticationRequests ( $action, array $options)
	Return the applicable list of AuthenticationRequests.

	postAccountCreation ( $user, $creator, AuthenticationResponse $response)
	Post-creation callback.

	postAccountLink ( $user, AuthenticationResponse $response)
	Post-link callback.

	testForAccountLink ( $user)
	Determine whether an account may linked to another authentication method.

	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

	setLogger (LoggerInterface $logger)

	setManager (AuthManager $manager)
	Set AuthManager.

Protected Attributes
Throttler	$accountCreationThrottle

BagOStuff	$cache

Throttler	$passwordAttemptThrottle

array	$throttleSettings

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

LoggerInterface	$logger

AuthManager	$manager

Detailed Description

A pre-authentication provider to throttle authentication actions.

Adding this provider will throttle account creations and primary authentication attempts (more specifically, any authentication that returns FAIL on failure). Secondary authentication cannot be easily throttled on a framework level (since it would typically return UI on failure); secondary providers are expected to do their own throttling.

Since: 1.27

Definition at line 37 of file ThrottlePreAuthenticationProvider.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array

$params

accountCreationThrottle: (array) Condition array for the account creation throttle; an array of arrays in a format like $wgPasswordAttemptThrottle, passed to the Throttler constructor.
passwordAttemptThrottle: (array) Condition array for the password attempt throttle, in the same format as accountCreationThrottle.
cache: (BagOStuff) Where to store the throttle, defaults to the local cluster instance.

Definition at line 58 of file ThrottlePreAuthenticationProvider.php.

References $params, and cache.

Member Function Documentation

◆ postAuthentication()

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

Parameters

null \| \\User	$user
AuthenticationResponse	$response

Reimplemented from MediaWiki\Auth\AbstractPreAuthenticationProvider.

Definition at line 161 of file ThrottlePreAuthenticationProvider.php.

References $name, $response, $user, as, and MediaWiki\Auth\AuthenticationResponse\PASS.

◆ setConfig()

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

Set configuration.

Parameters

Config $config

Reimplemented from MediaWiki\Auth\AbstractAuthenticationProvider.

Definition at line 65 of file ThrottlePreAuthenticationProvider.php.

References MediaWiki\Auth\ThrottlePreAuthenticationProvider\$accountCreationThrottle, MediaWiki\Auth\AbstractAuthenticationProvider\$config, and cache.

◆ testForAccountCreation()

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