1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Auth
*/
namespace MediaWiki\Auth;
use BagOStuff;
use Config;
/**
* 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.
* @ingroup Auth
* @since 1.27
*/
class ThrottlePreAuthenticationProvider extends AbstractPreAuthenticationProvider {
/** @var array */
protected $throttleSettings;
/** @var Throttler */
protected $accountCreationThrottle;
/** @var Throttler */
protected $passwordAttemptThrottle;
/** @var BagOStuff */
protected $cache;
/**
* @param 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.
*/
public function __construct( $params = [] ) {
$this->throttleSettings = array_intersect_key( $params,
[ 'accountCreationThrottle' => true, 'passwordAttemptThrottle' => true ] );
$this->cache = isset( $params['cache'] ) ? $params['cache'] :
\ObjectCache::getLocalClusterInstance();
}
public function setConfig( Config $config ) {
parent::setConfig( $config );
$accountCreationThrottle = $this->config->get( 'AccountCreationThrottle' );
// Handle old $wgAccountCreationThrottle format (number of attempts per 24 hours)
if ( !is_array( $accountCreationThrottle ) ) {
$accountCreationThrottle = [ [
'count' => $accountCreationThrottle,
'seconds' => 86400,
] ];
}
// @codeCoverageIgnoreStart
$this->throttleSettings += [
// @codeCoverageIgnoreEnd
'accountCreationThrottle' => $accountCreationThrottle,
'passwordAttemptThrottle' => $this->config->get( 'PasswordAttemptThrottle' ),
];
if ( !empty( $this->throttleSettings['accountCreationThrottle'] ) ) {
$this->accountCreationThrottle = new Throttler(
$this->throttleSettings['accountCreationThrottle'], [
'type' => 'acctcreate',
'cache' => $this->cache,
]
);
}
if ( !empty( $this->throttleSettings['passwordAttemptThrottle'] ) ) {
$this->passwordAttemptThrottle = new Throttler(
$this->throttleSettings['passwordAttemptThrottle'], [
'type' => 'password',
'cache' => $this->cache,
]
);
}
}
public function testForAccountCreation( $user, $creator, array $reqs ) {
if ( !$this->accountCreationThrottle || !$creator->isPingLimitable() ) {
return \StatusValue::newGood();
}
$ip = $this->manager->getRequest()->getIP();
if ( !\Hooks::run( 'ExemptFromAccountCreationThrottle', [ $ip ] ) ) {
$this->logger->debug( __METHOD__ . ": a hook allowed account creation w/o throttle\n" );
return \StatusValue::newGood();
}
$result = $this->accountCreationThrottle->increase( null, $ip, __METHOD__ );
if ( $result ) {
$message = wfMessage( 'acct_creation_throttle_hit' )->params( $result['count'] )
->durationParams( $result['wait'] );
return \StatusValue::newFatal( $message );
}
return \StatusValue::newGood();
}
public function testForAuthentication( array $reqs ) {
if ( !$this->passwordAttemptThrottle ) {
return \StatusValue::newGood();
}
$ip = $this->manager->getRequest()->getIP();
try {
$username = AuthenticationRequest::getUsernameFromRequests( $reqs );
} catch ( \UnexpectedValueException $e ) {
$username = '';
}
// Get everything this username could normalize to, and throttle each one individually.
// If nothing uses usernames, just throttle by IP.
$usernames = $this->manager->normalizeUsername( $username );
$result = false;
foreach ( $usernames as $name ) {
$r = $this->passwordAttemptThrottle->increase( $name, $ip, __METHOD__ );
if ( $r && ( !$result || $result['wait'] < $r['wait'] ) ) {
$result = $r;
}
}
if ( $result ) {
$message = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
return \StatusValue::newFatal( $message );
} else {
$this->manager->setAuthenticationSessionData( 'LoginThrottle',
[ 'users' => $usernames, 'ip' => $ip ] );
return \StatusValue::newGood();
}
}
/**
* @param null|\User $user
* @param AuthenticationResponse $response
*/
public function postAuthentication( $user, AuthenticationResponse $response ) {
if ( $response->status !== AuthenticationResponse::PASS ) {
return;
} elseif ( !$this->passwordAttemptThrottle ) {
return;
}
$data = $this->manager->getAuthenticationSessionData( 'LoginThrottle' );
if ( !$data ) {
// this can occur when login is happening via AuthenticationRequest::$loginRequest
// so testForAuthentication is skipped
$this->logger->info( 'throttler data not found for {user}', [ 'user' => $user->getName() ] );
return;
}
foreach ( $data['users'] as $name ) {
$this->passwordAttemptThrottle->clear( $name, $data['ip'] );
}
}
}
|
