-
Notifications
You must be signed in to change notification settings - Fork 30
/
LoginLdap.php
304 lines (277 loc) · 10.9 KB
/
LoginLdap.php
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?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\LoginLdap;
use Exception;
use Piwik\Auth;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\FrontController;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugin\Manager;
use Piwik\Plugins\LoginLdap\Auth\Base as AuthBase;
use Piwik\Plugins\LoginLdap\LdapInterop\UserMapper;
use Piwik\Plugins\LoginLdap\LdapInterop\UserSynchronizer;
use Piwik\View;
use Piwik\Plugins\UsersManager\API as UsersManagerAPI;
/**
*
* @package LoginLdap
*/
class LoginLdap extends \Piwik\Plugin
{
/**
* @return array
*/
public function registerEvents()
{
$hooks = array(
'Request.initAuthenticationObject' => 'initAuthenticationObject',
'User.isNotAuthorized' => 'noAccess',
'API.Request.authenticate' => 'ApiRequestAuthenticate',
'AssetManager.getJavaScriptFiles' => 'getJsFiles',
'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
'Controller.Login.resetPassword' => 'disablePasswordResetForLdapUsers',
'Controller.LoginLdap.resetPassword' => 'disablePasswordResetForLdapUsers',
'Controller.Login.confirmResetPassword' => 'disableConfirmResetPasswordForLdapUsers',
'UsersManager.checkPassword' => 'checkPassword',
'UsersManager.deleteUser' => 'onUserDeleted',
'Login.userRequiresPasswordConfirmation' => 'skipPasswordConfirmation',
);
return $hooks;
}
public function getJsFiles(&$jsFiles)
{
$jsFiles[] = "plugins/Login/javascripts/login.js";
}
public function getStylesheetFiles(&$stylesheetFiles)
{
$stylesheetFiles[] = "plugins/Login/stylesheets/login.less";
$stylesheetFiles[] = "plugins/Login/stylesheets/variables.less";
$stylesheetFiles[] = "plugins/LoginLdap/vue/src/Admin/Admin.less";
$stylesheetFiles[] = "plugins/LoginLdap/vue/src/TestableField/TestableField.less";
}
public function getClientSideTranslationKeys(&$keys)
{
$keys[] = "General_NUsers";
$keys[] = "LoginLdap_OneUser";
$keys[] = "LoginLdap_MemberOfCount";
$keys[] = "LoginLdap_FilterCount";
$keys[] = "LoginLdap_Test";
$keys[] = 'LoginLdap_Settings';
$keys[] = 'General_Note';
$keys[] = 'LoginLdap_UpdateFromPre300Warning';
$keys[] = 'LoginLdap_UseLdapForAuthentication';
$keys[] = 'LoginLdap_Kerberos';
$keys[] = 'LoginLdap_KerberosDescription';
$keys[] = 'LoginLdap_StripDomainFromWebAuth';
$keys[] = 'LoginLdap_StripDomainFromWebAuthDescription';
$keys[] = 'LoginLdap_NetworkTimeout';
$keys[] = 'LoginLdap_MemberOfField';
$keys[] = 'LoginLdap_MemberOfFieldDescription';
$keys[] = 'LoginLdap_MemberOf';
$keys[] = 'LoginLdap_Filter';
$keys[] = 'LoginLdap_FilterDescription';
$keys[] = 'LoginLdap_UserSyncSettings';
$keys[] = 'LoginLdap_UserIdField';
$keys[] = 'LoginLdap_UserIdFieldDescription';
$keys[] = 'LoginLdap_PasswordField';
$keys[] = 'LoginLdap_MailField';
$keys[] = 'LoginLdap_MailFieldDescription';
$keys[] = 'LoginLdap_UsernameSuffix';
$keys[] = 'LoginLdap_UsernameSuffixDescription';
$keys[] = 'LoginLdap_NewUserDefaultSitesViewAccess';
$keys[] = 'LoginLdap_NewUserDefaultSitesViewAccessDescription';
$keys[] = 'LoginLdap_AccessSyncSettings';
$keys[] = 'LoginLdap_EnableLdapAccessSynchronization';
$keys[] = 'LoginLdap_EnableLdapAccessSynchronizationDescription';
$keys[] = 'LoginLdap_ExpectedLdapAttributes';
$keys[] = 'LoginLdap_ExpectedLdapAttributesPrelude';
$keys[] = 'LoginLdap_LdapViewAccessField';
$keys[] = 'LoginLdap_LdapViewAccessFieldDescription';
$keys[] = 'LoginLdap_LdapAdminAccessField';
$keys[] = 'LoginLdap_LdapAdminAccessFieldDescription';
$keys[] = 'LoginLdap_LdapSuperUserAccessField';
$keys[] = 'LoginLdap_LdapSuperUserAccessFieldDescription';
$keys[] = 'LoginLdap_LdapUserAccessAttributeServerSpecDelimiter';
$keys[] = 'LoginLdap_LdapUserAccessAttributeServerSpecDelimiterDescription';
$keys[] = 'LoginLdap_LdapUserAccessAttributeServerSeparator';
$keys[] = 'LoginLdap_LdapUserAccessAttributeServerSeparatorDescription';
$keys[] = 'LoginLdap_ThisPiwikInstanceName';
$keys[] = 'LoginLdap_ThisPiwikInstanceNameDescription';
$keys[] = 'LoginLdap_LoadUser';
$keys[] = 'LoginLdap_LoadUserDescription';
$keys[] = 'LoginLdap_Go';
$keys[] = 'LoginLdap_LDAPServers';
$keys[] = 'LoginLdap_ServerName';
$keys[] = 'LoginLdap_ServerUrl';
$keys[] = 'LoginLdap_LdapPort';
$keys[] = 'LoginLdap_LdapUrlPortWarning';
$keys[] = 'LoginLdap_StartTLS';
$keys[] = 'LoginLdap_StartTLSFieldHelp';
$keys[] = 'LoginLdap_BaseDn';
$keys[] = 'LoginLdap_AdminUser';
$keys[] = 'LoginLdap_AdminUserDescription';
$keys[] = 'LoginLdap_AdminPass';
$keys[] = 'LoginLdap_PasswordFieldHelp';
$keys[] = 'LoginLdap_UseLdapForAuthenticationDescription';
$keys[] = 'LoginLdap_MobileAppIntegrationNote';
$keys[] = 'LoginLdap_NetworkTimeoutDescription';
$keys[] = 'LoginLdap_NetworkTimeoutDescription2';
$keys[] = 'LoginLdap_MemberOfDescription';
$keys[] = 'LoginLdap_MemberOfDescription2';
$keys[] = 'LoginLdap_PasswordFieldDescription';
$keys[] = 'LoginLdap_PasswordFieldDescription2';
$keys[] = 'LoginLdap_LoadUserCommandDesc';
$keys[] = 'LoginLdap_ReadMoreAboutAccessSynchronization';
$keys[] = 'LoginLdap_ThisMatomoInstanceNameDescription';
$keys[] = 'LoginLdap_ThisMatomoInstanceName';
$keys[] = 'LoginLdap_OptionsPWCONFIRMATION';
$keys[] = 'LoginLdap_OptionsPWCONFIRMATIONDescription';
$keys[] = 'General_Warning';
$keys[] = 'LoginLdap_LoginPluginEnabledWarning';
}
/**
* Deactivate default Login module, as both cannot be activated together
*
* TODO: shouldn't disable Login plugin but have to wait until Dependency Injection is added to core
*/
public function activate()
{
if (Manager::getInstance()->isPluginActivated("Login") == true) {
Manager::getInstance()->deactivatePlugin("Login");
}
}
/**
* Activate default Login module, as one of them is needed to access Piwik
*/
public function deactivate()
{
if (Manager::getInstance()->isPluginActivated("Login") == false) {
Manager::getInstance()->activatePlugin("Login");
}
}
public function disableConfirmResetPasswordForLdapUsers()
{
$login = Common::getRequestVar('login', false);
if (empty($login)) {
return;
}
if ($this->isUserLdapUser($login)) {
// redirect to login w/ error message
$errorMessage = Piwik::translate("LoginLdap_UnsupportedPasswordReset");
echo FrontController::getInstance()->dispatch('LoginLdap', 'login', array($errorMessage));
exit;
}
}
public function disablePasswordResetForLdapUsers()
{
$login = Common::getRequestVar('form_login', false);
if (empty($login)) {
return;
}
if ($this->isUserLdapUser($login)) {
$errorMessage = Piwik::translate("LoginLdap_UnsupportedPasswordReset");
$view = new View("@Login/resetPassword");
$view->infoMessage = null;
$view->formErrors = array($errorMessage);
echo $view->render();
exit;
}
}
/**
* Redirects to Login form with error message.
* Listens to User.isNotAuthorized hook.
*/
public function noAccess(Exception $exception)
{
$exceptionMessage = $exception->getMessage();
echo FrontController::getInstance()->dispatch('LoginLdap', 'login', array($exceptionMessage));
}
/**
* Initializes the authentication object.
* Listens to Request.initAuthenticationObject hook.
*/
function initAuthenticationObject($activateCookieAuth = false)
{
$auth = AuthBase::factory();
StaticContainer::getContainer()->set('Piwik\Auth', $auth);
}
/**
* Set login name and authentication token for authentication request.
* Listens to API.Request.authenticate hook.
*/
public function ApiRequestAuthenticate($tokenAuth)
{
/** @var Auth $auth */
$auth = StaticContainer::get('Piwik\Auth');
$auth->setLogin($login = null);
$auth->setTokenAuth($tokenAuth);
}
private function isUserLdapUser($login)
{
$userMapper = new UserMapper();
return $userMapper->isUserLdapUser($login);
}
private function isCurrentUserLdapUser(Auth $auth)
{
$currentUserLogin = $auth->getLogin();
if (empty($currentUserLogin)) {
return false;
}
return $this->isUserLdapUser($auth->getLogin());
}
/**
* Throws Exception when LDAP user tries to change password
* because such user's pass should be managed directly on LDAP host
*
* @throws Exception
*/
public function disablePasswordChangeForLdapUsers(Auth $auth)
{
if ($this->isCurrentUserLdapUser($auth)) {
throw new Exception(
Piwik::translate('LoginLdap_LdapUserCantChangePassword')
);
}
}
/**
* Listens to UsersManager.checkPassword hook.
*/
public function checkPassword()
{
$auth = StaticContainer::get('Piwik\Auth');
$this->disablePasswordChangeForLdapUsers($auth);
}
/**
* @param $requiresPasswordConfirmation
* @param $login
*
* Skip password confirmation if its being added by LDAP sync
*/
public function skipPasswordConfirmation(&$requiresPasswordConfirmation, $login)
{
if (UserSynchronizer::$skipPasswordConfirmation) {
$requiresPasswordConfirmation = false;
}
}
/**
* @param $userLogin
*
* On User deleted hook
*/
public function onUserDeleted($userLogin)
{
//if we do not delete this option value, it creates a problem in syncing the same user as checkPassword is executed and $this->>disablePasswordChangeForLdapUsers throws an exception, since it determines it as an LDAP user
if ($this->isUserLdapUser($userLogin)) {
$key = $userLogin . UsersManagerAPI::OPTION_NAME_PREFERENCE_SEPARATOR . UserMapper::USER_PREFERENCE_NAME_IS_LDAP_USER;
Option::delete($key);
}
}
}