MediaWiki REL1_28
Go to the documentation of this file.
22namespace MediaWiki\Auth;
26use Psr\Log\LoggerAwareInterface;
27use Psr\Log\LoggerInterface;
28use Psr\Log\LogLevel;
36class Throttler implements LoggerAwareInterface {
38 protected $type;
45 protected $conditions;
47 protected $cache;
49 protected $logger;
51 protected $warningLimit;
62 public function __construct( array $conditions = null, array $params = [] ) {
63 $invalidParams = array_diff_key( $params,
64 array_fill_keys( [ 'type', 'cache', 'warningLimit' ], true ) );
65 if ( $invalidParams ) {
66 throw new \InvalidArgumentException( 'unrecognized parameters: '
67 . implode( ', ', array_keys( $invalidParams ) ) );
68 }
70 if ( $conditions === null ) {
71 $config = \ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
72 $conditions = $config->get( 'PasswordAttemptThrottle' );
73 $params += [
74 'type' => 'password',
75 'cache' => \ObjectCache::getLocalClusterInstance(),
76 'warningLimit' => 50,
77 ];
78 } else {
79 $params += [
80 'type' => 'custom',
81 'cache' => \ObjectCache::getLocalClusterInstance(),
82 'warningLimit' => INF,
83 ];
84 }
86 $this->type = $params['type'];
87 $this->conditions = static::normalizeThrottleConditions( $conditions );
88 $this->cache = $params['cache'];
89 $this->warningLimit = $params['warningLimit'];
91 $this->setLogger( LoggerFactory::getInstance( 'throttler' ) );
92 }
94 public function setLogger( LoggerInterface $logger ) {
95 $this->logger = $logger;
96 }
112 public function increase( $username = null, $ip = null, $caller = null ) {
113 if ( $username === null && $ip === null ) {
114 throw new \InvalidArgumentException( 'Either username or IP must be set for throttling' );
115 }
117 $userKey = $username ? md5( $username ) : null;
118 foreach ( $this->conditions as $index => $throttleCondition ) {
119 $ipKey = isset( $throttleCondition['allIPs'] ) ? null : $ip;
120 $count = $throttleCondition['count'];
121 $expiry = $throttleCondition['seconds'];
123 // a limit of 0 is used as a disable flag in some throttling configuration settings
124 // throttling the whole world is probably a bad idea
125 if ( !$count || $userKey === null && $ipKey === null ) {
126 continue;
127 }
129 $throttleKey = wfGlobalCacheKey( 'throttler', $this->type, $index, $ipKey, $userKey );
130 $throttleCount = $this->cache->get( $throttleKey );
132 if ( !$throttleCount ) { // counter not started yet
133 $this->cache->add( $throttleKey, 1, $expiry );
134 } elseif ( $throttleCount < $count ) { // throttle limited not yet reached
135 $this->cache->incr( $throttleKey );
136 } else { // throttled
137 $this->logRejection( [
138 'type' => $this->type,
139 'index' => $index,
140 'ip' => $ipKey,
141 'username' => $username,
142 'count' => $count,
143 'expiry' => $expiry,
144 // @codeCoverageIgnoreStart
145 'method' => $caller ?: __METHOD__,
146 // @codeCoverageIgnoreEnd
147 ] );
149 return [
150 'throttleIndex' => $index,
151 'count' => $count,
152 'wait' => $expiry,
153 ];
154 }
155 }
156 return false;
157 }
168 public function clear( $username = null, $ip = null ) {
169 $userKey = $username ? md5( $username ) : null;
170 foreach ( $this->conditions as $index => $specificThrottle ) {
171 $ipKey = isset( $specificThrottle['allIPs'] ) ? null : $ip;
172 $throttleKey = wfGlobalCacheKey( 'throttler', $this->type, $index, $ipKey, $userKey );
173 $this->cache->delete( $throttleKey );
174 }
175 }
183 protected static function normalizeThrottleConditions( $throttleConditions ) {
184 if ( !is_array( $throttleConditions ) ) {
185 return [];
186 }
187 if ( isset( $throttleConditions['count'] ) ) { // old style
188 $throttleConditions = [ $throttleConditions ];
189 }
190 return $throttleConditions;
191 }
193 protected function logRejection( array $context ) {
194 $logMsg = 'Throttle {type} hit, throttled for {expiry} seconds due to {count} attempts '
195 . 'from username {username} and IP {ip}';
197 // If we are hitting a throttle for >= warningLimit attempts, it is much more likely to be
198 // an attack than someone simply forgetting their password, so log it at a higher level.
199 $level = $context['count'] >= $this->warningLimit ? LogLevel::WARNING : LogLevel::INFO;
201 // It should be noted that once the throttle is hit, every attempt to login will
202 // generate the log message until the throttle expires, not just the attempt that
203 // puts the throttle over the top.
204 $this->logger->log( $level, $logMsg, $context );
205 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly publicly and distribute the Work and such Derivative Works in Source or Object form Grant of Patent License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty have offer to and otherwise transfer the where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed Redistribution You may reproduce and distribute copies of the Work or Derivative Works thereof in any with or without and in Source or Object provided that You meet the following conditions
to add to the query
Make a cache key with database-agnostic prefix.
interface is intended to be more or less compatible with the PHP memcached client.
Definition BagOStuff.php:47
increase( $username=null, $ip=null, $caller=null)
Increase the throttle counter and return whether the attempt should be throttled.
clear( $username=null, $ip=null)
Clear the throttle counter.
array $conditions
See documentation of $wgPasswordAttemptThrottle for format.
Definition Throttler.php:45
setLogger(LoggerInterface $logger)
Definition Throttler.php:94
__construct(array $conditions=null, array $params=[])
Definition Throttler.php:62
logRejection(array $context)
static normalizeThrottleConditions( $throttleConditions)
Handles B/C for $wgPasswordAttemptThrottle.
LoggerInterface $logger
Definition Throttler.php:49
PSR-3 logger instance factory.
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
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:807
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
Definition load.php:50
you have access to all of the normal MediaWiki so you can get a DB use the cache
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition postgres.txt:36