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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\Login;
use Exception;
use Piwik\API\Request;
use Piwik\Common;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\FrontController;
use Piwik\Http\HttpCodeException;
use Piwik\IP;
use Piwik\Piwik;
use Piwik\Plugins\Login\Security\BruteForceDetection;
use Piwik\Session;
use Piwik\SettingsServer;
/**
*
*/
class Login extends \Piwik\Plugin
{
private $hasAddedFailedAttempt = false;
private $hasPerformedBruteForceCheck = false;
private $hasPerformedBruteForceCheckForUserPwdLogin = false;
/**
* @see \Piwik\Plugin::registerEvents
*/
public function registerEvents()
{
$hooks = array(
'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
'User.isNotAuthorized' => 'noAccess',
'API.Request.authenticate' => 'ApiRequestAuthenticate',
'AssetManager.getJavaScriptFiles' => 'getJsFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'Session.beforeSessionStart' => 'beforeSessionStart',
// for brute force prevention of all tracking + reporting api requests
'Request.initAuthenticationObject' => 'onInitAuthenticationObject',
'API.UsersManager.createAppSpecificTokenAuth' => 'beforeLoginCheckBruteForce', // doesn't require auth but can be used to authenticate
// for brute force prevention of all UI requests
'Controller.Login.logme' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.index' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.confirmResetPassword' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.confirmPassword' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.resetPassword' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.Login.login' => 'beforeLoginCheckBruteForceForUserPwdLogin',
'Controller.TwoFactorAuth.loginTwoFactorAuth' => 'beforeLoginCheckBruteForce',
'Controller.Login.acceptInvitation' => 'beforeLoginCheckBruteForce',
'Controller.Login.declineInvitation' => 'beforeLoginCheckBruteForce',
'Login.authenticate.successful' => 'beforeLoginCheckBruteForce',
'Login.beforeLoginCheckAllowed' => 'beforeLoginCheckBruteForceForUserPwdLogin', // record any failed attempt in UI
'Login.recordFailedLoginAttempt' => 'onFailedLoginRecordAttempt', // record any failed attempt in UI
'Login.authenticate.failed' => 'onFailedLoginRecordAttempt', // record any failed attempt in UI
'API.Request.authenticate.failed' => 'onFailedLoginRecordAttempt', // record any failed attempt in Reporting API
'Tracker.Request.authenticate.failed' => 'onFailedLoginRecordAttempt', // record any failed attempt in Tracker API
);
$loginPlugin = Piwik::getLoginPluginName();
if ($loginPlugin && $loginPlugin !== 'Login') {
$hooks['Controller.'.$loginPlugin.'.logme'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin. '.'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin.'.index'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin.'.confirmResetPassword'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin.'.confirmPassword'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin.'.resetPassword'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
$hooks['Controller.'.$loginPlugin.'.login'] = 'beforeLoginCheckBruteForceForUserPwdLogin';
}
return $hooks;
}
public function getClientSideTranslationKeys(&$translations)
{
$translations[] = 'Login_CurrentlyBlockedIPs';
$translations[] = 'Login_CurrentlyBlockedIPsUnblockInfo';
$translations[] = 'Login_UnblockAllIPs';
$translations[] = 'Login_CurrentlyBlockedIPsUnblockConfirm';
$translations[] = 'Login_IPsAlwaysBlocked';
}
public function isTrackerPlugin()
{
return true;
}
public function onInitAuthenticationObject()
{
if (SettingsServer::isTrackerApiRequest() || Request::isRootRequestApiRequest()) {
// we check it for all API requests...
// we do not check it for other UI requests as otherwise we would be logging out someone possibly already
// logged in with a valid session which we don't want currently... regular UI requests are checked through
// 1) any successful or failed login attempt, plus through specific controller action that a user can use
// to log in
$this->beforeLoginCheckBruteForce();
}
}
public function onFailedLoginRecordAttempt()
{
// we're always making sure on any success or failed login to check if user is actually allowed to log in
// in case for some reason it forgot to run the check
$this->beforeLoginCheckBruteForce();
// we are recording new failed attempts only when user can currently log in and is not blocked...
// this is to kind of block eg a certain IP continuously. could alternatively also still keep writing those failed
// attempts into the log and only allow login attempts again after the user had no login attempts for the configured
// time frame
$bruteForce = StaticContainer::get('Piwik\Plugins\Login\Security\BruteForceDetection');
if ($bruteForce->isEnabled() && !$this->hasAddedFailedAttempt) {
$login = $this->getUsernameUsedInPasswordLogin();
$bruteForce->addFailedAttempt(IP::getIpFromHeader(), $login);
// we make sure to log max one failed login attempt per request... otherwise we might log 3 or many more
// if eg API is called etc.
$this->hasAddedFailedAttempt = true;
}
}
public function beforeLoginCheckBruteForce()
{
$bruteForce = StaticContainer::get('Piwik\Plugins\Login\Security\BruteForceDetection');
if (!$this->hasPerformedBruteForceCheck && $bruteForce->isEnabled() && !$bruteForce->isAllowedToLogin(IP::getIpFromHeader())) {
throw new Exception(Piwik::translate('Login_LoginNotAllowedBecauseBlocked'));
}
// for performance reasons we make sure to execute it only once per request
$this->hasPerformedBruteForceCheck = true;
}
public function beforeLoginCheckBruteForceForUserPwdLogin()
{
// check that IP is not blocked
$this->beforeLoginCheckBruteForce();
// now check that user login (from any ip) is not blocked
$login = $this->getUsernameUsedInPasswordLogin();
if (empty($login)
|| $login == 'anonymous'
) {
return; // can't do the check if we don't know the login
}
/** @var BruteForceDetection $bruteForce */
$bruteForce = StaticContainer::get('Piwik\Plugins\Login\Security\BruteForceDetection');
if (!$this->hasPerformedBruteForceCheckForUserPwdLogin && $bruteForce->isEnabled() && $bruteForce->isUserLoginBlocked($login)) {
$ex = new HttpCodeException(Piwik::translate('Login_LoginNotAllowedBecauseUserLoginBlocked'), 403);
throw $ex;
}
// for performance reasons we make sure to execute it only once per request
$this->hasPerformedBruteForceCheckForUserPwdLogin = true;
}
public function getJsFiles(&$jsFiles)
{
$jsFiles[] = "plugins/Login/javascripts/login.js";
$jsFiles[] = "plugins/Login/javascripts/bruteforcelog.js";
}
public function getStylesheetFiles(&$stylesheetFiles)
{
$stylesheetFiles[] = "plugins/Login/stylesheets/login.less";
$stylesheetFiles[] = "plugins/Login/stylesheets/variables.less";
}
public function beforeSessionStart()
{
if (!$this->shouldHandleRememberMe()) {
return;
}
// if this is a login request & form_rememberme was set, change the session cookie expire time before starting the session
$rememberMe = isset($_POST['form_rememberme']) ? $_POST['form_rememberme'] : null;
if ($rememberMe == '1') {
Session::rememberMe(Config::getInstance()->General['login_cookie_expire']);
}
}
private function shouldHandleRememberMe()
{
$module = Piwik::getModule();
$action = Piwik::getAction();
return ($module == 'Login' || $module == 'CoreHome') && (empty($action) || $action == 'index' || $action == 'login');
}
/**
* Redirects to Login form with error message.
* Listens to User.isNotAuthorized hook.
*/
public function noAccess(Exception $exception)
{
$frontController = FrontController::getInstance();
if (Common::isXmlHttpRequest()) {
echo $frontController->dispatch(Piwik::getLoginPluginName(), 'ajaxNoAccess', array($exception->getMessage()));
return;
}
echo $frontController->dispatch(Piwik::getLoginPluginName(), 'login', array($exception->getMessage()));
}
/**
* Set login name and authentication token for API request.
* Listens to API.Request.authenticate hook.
*/
public function ApiRequestAuthenticate($tokenAuth)
{
$this->beforeLoginCheckBruteForce();
/** @var \Piwik\Auth $auth */
$auth = StaticContainer::get('Piwik\Auth');
$auth->setLogin($login = null);
$auth->setTokenAuth($tokenAuth);
}
protected static function isModuleIsAPI()
{
return Piwik::getModule() === 'API'
&& (Piwik::getAction() == '' || Piwik::getAction() == 'index');
}
private function getUsernameUsedInPasswordLogin()
{
$login = StaticContainer::get(\Piwik\Auth::class)->getLogin();
if (empty($login) || $login == 'anonymous') {
$login = Common::getRequestVar('form_login', false);
if (Piwik::getAction() === 'logme') {
$login = Common::getRequestVar('login', $login);
}
}
return $login;
}
}
|
