MediaWiki  REL1_31
ThrottlePreAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
22 namespace MediaWiki\Auth;
23 
25 use Config;
26 
39  protected $throttleSettings;
40 
43 
46 
48  protected $cache;
49 
58  public function __construct( $params = [] ) {
59  $this->throttleSettings = array_intersect_key( $params,
60  [ 'accountCreationThrottle' => true, 'passwordAttemptThrottle' => true ] );
61  $this->cache = isset( $params['cache'] ) ? $params['cache'] :
63  }
64 
65  public function setConfig( Config $config ) {
66  parent::setConfig( $config );
67 
68  $accountCreationThrottle = $this->config->get( 'AccountCreationThrottle' );
69  // Handle old $wgAccountCreationThrottle format (number of attempts per 24 hours)
70  if ( !is_array( $accountCreationThrottle ) ) {
72  'count' => $accountCreationThrottle,
73  'seconds' => 86400,
74  ] ];
75  }
76 
77  // @codeCoverageIgnoreStart
78  $this->throttleSettings += [
79  // @codeCoverageIgnoreEnd
80  'accountCreationThrottle' => $accountCreationThrottle,
81  'passwordAttemptThrottle' => $this->config->get( 'PasswordAttemptThrottle' ),
82  ];
83 
84  if ( !empty( $this->throttleSettings['accountCreationThrottle'] ) ) {
85  $this->accountCreationThrottle = new Throttler(
86  $this->throttleSettings['accountCreationThrottle'], [
87  'type' => 'acctcreate',
88  'cache' => $this->cache,
89  ]
90  );
91  }
92  if ( !empty( $this->throttleSettings['passwordAttemptThrottle'] ) ) {
93  $this->passwordAttemptThrottle = new Throttler(
94  $this->throttleSettings['passwordAttemptThrottle'], [
95  'type' => 'password',
96  'cache' => $this->cache,
97  ]
98  );
99  }
100  }
101 
102  public function testForAccountCreation( $user, $creator, array $reqs ) {
103  if ( !$this->accountCreationThrottle || !$creator->isPingLimitable() ) {
104  return \StatusValue::newGood();
105  }
106 
107  $ip = $this->manager->getRequest()->getIP();
108 
109  if ( !\Hooks::run( 'ExemptFromAccountCreationThrottle', [ $ip ] ) ) {
110  $this->logger->debug( __METHOD__ . ": a hook allowed account creation w/o throttle\n" );
111  return \StatusValue::newGood();
112  }
113 
114  $result = $this->accountCreationThrottle->increase( null, $ip, __METHOD__ );
115  if ( $result ) {
116  $message = wfMessage( 'acct_creation_throttle_hit' )->params( $result['count'] )
117  ->durationParams( $result['wait'] );
118  return \StatusValue::newFatal( $message );
119  }
120 
121  return \StatusValue::newGood();
122  }
123 
124  public function testForAuthentication( array $reqs ) {
125  if ( !$this->passwordAttemptThrottle ) {
126  return \StatusValue::newGood();
127  }
128 
129  $ip = $this->manager->getRequest()->getIP();
130  try {
132  } catch ( \UnexpectedValueException $e ) {
133  $username = '';
134  }
135 
136  // Get everything this username could normalize to, and throttle each one individually.
137  // If nothing uses usernames, just throttle by IP.
138  $usernames = $this->manager->normalizeUsername( $username );
139  $result = false;
140  foreach ( $usernames as $name ) {
141  $r = $this->passwordAttemptThrottle->increase( $name, $ip, __METHOD__ );
142  if ( $r && ( !$result || $result['wait'] < $r['wait'] ) ) {
143  $result = $r;
144  }
145  }
146 
147  if ( $result ) {
148  $message = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
149  return \StatusValue::newFatal( $message );
150  } else {
151  $this->manager->setAuthenticationSessionData( 'LoginThrottle',
152  [ 'users' => $usernames, 'ip' => $ip ] );
153  return \StatusValue::newGood();
154  }
155  }
156 
162  if ( $response->status !== AuthenticationResponse::PASS ) {
163  return;
164  } elseif ( !$this->passwordAttemptThrottle ) {
165  return;
166  }
167 
168  $data = $this->manager->getAuthenticationSessionData( 'LoginThrottle' );
169  if ( !$data ) {
170  // this can occur when login is happening via AuthenticationRequest::$loginRequest
171  // so testForAuthentication is skipped
172  $this->logger->info( 'throttler data not found for {user}', [ 'user' => $user->getName() ] );
173  return;
174  }
175 
176  foreach ( $data['users'] as $name ) {
177  $this->passwordAttemptThrottle->clear( $name, $data['ip'] );
178  }
179  }
180 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
MediaWiki\Auth\ThrottlePreAuthenticationProvider\$passwordAttemptThrottle
Throttler $passwordAttemptThrottle
Definition: ThrottlePreAuthenticationProvider.php:45
MediaWiki\Auth\ThrottlePreAuthenticationProvider\postAuthentication
postAuthentication( $user, AuthenticationResponse $response)
Definition: ThrottlePreAuthenticationProvider.php:161
MediaWiki\Auth\ThrottlePreAuthenticationProvider\$throttleSettings
array $throttleSettings
Definition: ThrottlePreAuthenticationProvider.php:39
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:367
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
$response
this hook is for auditing only $response
Definition: hooks.txt:783
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MediaWiki\Auth\ThrottlePreAuthenticationProvider\$accountCreationThrottle
Throttler $accountCreationThrottle
Definition: ThrottlePreAuthenticationProvider.php:42
MediaWiki\Auth\ThrottlePreAuthenticationProvider\setConfig
setConfig(Config $config)
Set configuration.
Definition: ThrottlePreAuthenticationProvider.php:65
$params
$params
Definition: styleTest.css.php:40
BagOStuff
interface is intended to be more or less compatible with the PHP memcached client.
Definition: BagOStuff.php:47
MediaWiki\Auth\Throttler
Definition: Throttler.php:37
MediaWiki\Auth\ThrottlePreAuthenticationProvider\$cache
BagOStuff $cache
Definition: ThrottlePreAuthenticationProvider.php:48
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
cache
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:55
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Config
Interface for configuration instances.
Definition: Config.php:28
MediaWiki\Auth\AuthenticationRequest\getUsernameFromRequests
static getUsernameFromRequests(array $reqs)
Get the username from the set of requests.
Definition: AuthenticationRequest.php:273
MediaWiki\Auth\AuthenticationResponse
This is a value object to hold authentication response data.
Definition: AuthenticationResponse.php:37
MediaWiki\Auth\ThrottlePreAuthenticationProvider\__construct
__construct( $params=[])
Definition: ThrottlePreAuthenticationProvider.php:58
MediaWiki\Auth\ThrottlePreAuthenticationProvider
A pre-authentication provider to throttle authentication actions.
Definition: ThrottlePreAuthenticationProvider.php:37
MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAuthentication
testForAuthentication(array $reqs)
Determine whether an authentication may begin.
Definition: ThrottlePreAuthenticationProvider.php:124
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
MediaWiki\Auth\AbstractPreAuthenticationProvider
A base class that implements some of the boilerplate for a PreAuthenticationProvider.
Definition: AbstractPreAuthenticationProvider.php:31
MediaWiki\Auth\AuthenticationResponse\PASS
const PASS
Indicates that the authentication succeeded.
Definition: AuthenticationResponse.php:39
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
MediaWiki\Auth\AbstractAuthenticationProvider\$config
Config $config
Definition: AbstractAuthenticationProvider.php:38
MediaWiki\Auth\ThrottlePreAuthenticationProvider\testForAccountCreation
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
Definition: ThrottlePreAuthenticationProvider.php:102
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171