/
AuthLDAP.php
583 lines (539 loc) · 23.4 KB
/
AuthLDAP.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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
<?php
class AuthLDAP extends LimeSurvey\PluginManager\AuthPluginBase
{
protected $storage = 'DbStorage';
protected static $description = 'Core: LDAP authentication';
protected static $name = 'LDAP';
/** @inheritdoc, this plugin didn't have any public method */
public $allowedPublicMethods = array();
/**
* Can we autocreate users? For the moment this is disabled, will be moved
* to a setting when we have more robust user creation system.
*
* @var boolean
*/
protected $autoCreate = false;
protected $settings = array(
'server' => array(
'type' => 'string',
'label' => 'LDAP server',
'help' => 'e.g. ldap://ldap.example.com or ldaps://ldap.example.com'
),
'ldapport' => array(
'type' => 'string',
'label' => 'Port number',
'help' => 'Default when omitted is 389',
),
'ldapversion' => array(
'type' => 'select',
'label' => 'LDAP version',
'options' => array('2' => 'LDAPv2', '3' => 'LDAPv3'),
'default' => '2',
'submitonchange' => true
),
'ldapoptreferrals' => array(
'type' => 'boolean',
'label' => 'Select true if referrals must be followed (use false for ActiveDirectory)',
'default' => '0'
),
'ldaptls' => array(
'type' => 'boolean',
'help' => 'Check to enable Start-TLS encryption, when using LDAPv3',
'label' => 'Enable Start-TLS',
'default' => '0'
),
'ldapmode' => array(
'type' => 'select',
'label' => 'Select how to perform authentication.',
'options' => array("simplebind" => "Simple bind", "searchandbind" => "Search and bind"),
'default' => "simplebind",
'submitonchange' => true
),
'userprefix' => array(
'type' => 'string',
'label' => 'Username prefix',
'help' => 'e.g. cn= or uid=',
),
'domainsuffix' => array(
'type' => 'string',
'label' => 'Username suffix',
'help' => 'e.g. @mydomain.com or remaining part of ldap query',
),
'searchuserattribute' => array(
'type' => 'string',
'label' => 'Attribute to compare to the given login can be uid, cn, mail, ...'
),
'usersearchbase' => array(
'type' => 'string',
'label' => 'Base DN for the user search operation. Multiple bases may be separated by a semicolon (;)'
),
'extrauserfilter' => array(
'type' => 'string',
'label' => 'Optional extra LDAP filter to be ANDed to the basic (searchuserattribute=username) filter. Don\'t forget the outmost enclosing parentheses'
),
'binddn' => array(
'type' => 'string',
'label' => 'Optional DN of the LDAP account used to search for the end-user\'s DN. An anonymous bind is performed if empty.'
),
'bindpwd' => array(
'type' => 'password',
'label' => 'Password of the LDAP account used to search for the end-user\'s DN if previoulsy set.'
),
'mailattribute' => array(
'type' => 'string',
'label' => 'LDAP attribute of email address'
),
'fullnameattribute' => array(
'type' => 'string',
'label' => 'LDAP attribute of full name'
),
'is_default' => array(
'type' => 'checkbox',
'label' => 'Check to make default authentication method'
),
'autocreate' => array(
'type' => 'checkbox',
'label' => 'Automatically create user if it exists in LDAP server'
),
'automaticsurveycreation' => array(
'type' => 'checkbox',
'label' => 'Grant survey creation permission to automatically created users'
),
'groupsearchbase' => array(
'type' => 'string',
'label' => 'Optional base DN for group restriction',
'help' => 'E.g., ou=Groups,dc=example,dc=com'
),
'groupsearchfilter' => array(
'type' => 'string',
'label' => 'Optional filter for group restriction',
'help' => 'Required if group search base set. E.g. (&(cn=limesurvey)(memberUid=$username)) or (&(cn=limesurvey)(member=$userdn))'
),
'allowInitialUser' => array(
'type' => 'checkbox',
'label' => 'Allow initial user to login via LDAP',
)
);
public function init()
{
/**
* Here you should handle subscribing to the events your plugin will handle
*/
$this->subscribe('beforeActivate');
$this->subscribe('getGlobalBasePermissions');
$this->subscribe('beforeHasPermission');
$this->subscribe('createNewUser');
$this->subscribe('beforeLogin');
$this->subscribe('newLoginForm');
$this->subscribe('afterLoginFormSubmit');
$this->subscribe('remoteControlLogin');
$this->subscribe('newUserSession');
}
/**
* Check availability of LDAP Apache Module
*
* @return void
*/
public function beforeActivate()
{
if (!function_exists("ldap_connect")) {
$event = $this->getEvent();
$event->set('success', false);
$event->set('message', gT("LDAP authentication failed: LDAP PHP module is not available."));
}
}
/**
* Add AuthLDAP Permission to global Permission
* @return void
*/
public function getGlobalBasePermissions()
{
$this->getEvent()->append('globalBasePermissions', array(
'auth_ldap' => array(
'create' => false,
'update' => false,
'delete' => false,
'import' => false,
'export' => false,
'title' => gT("Use LDAP authentication"),
'description' => gT("Use LDAP authentication"),
'img' => 'usergroup'
),
));
}
/**
* Validation of AuthPermission (for super-admin only)
* @return void
*/
public function beforeHasPermission()
{
$oEvent = $this->getEvent();
if ($oEvent->get('sEntityName') != 'global' || $oEvent->get('sPermission') != 'auth_ldap' || $oEvent->get('sCRUD') != 'read') {
return;
}
$iUserId = Permission::model()->getUserId($oEvent->get('iUserID'));
if ($iUserId == 1) {
$oEvent->set('bPermission', (bool) $this->get('allowInitialUser'));
}
}
/**
* Create a LDAP user
*
* @return void
*/
public function createNewUser()
{
// Do nothing if the user to be added is not LDAP type
if (flattenText(Yii::app()->request->getPost('user_type')) != 'LDAP') {
return;
}
$this->_createNewUser(flattenText(Yii::app()->request->getPost('new_user'), false, true));
}
/**
* Create a LDAP user
*
* @param string $new_user
* @return null|integer New user ID
*/
private function _createNewUser($new_user)
{
$oEvent = $this->getEvent();
// Get configuration settings:
$ldapmode = $this->get('ldapmode');
$searchuserattribute = $this->get('searchuserattribute');
$extrauserfilter = $this->get('extrauserfilter');
$usersearchbase = $this->get('usersearchbase');
$binddn = $this->get('binddn');
$bindpwd = $this->get('bindpwd');
$mailattribute = $this->get('mailattribute');
$fullnameattribute = $this->get('fullnameattribute');
// Try to connect
$ldapconn = $this->createConnection();
if (!is_resource($ldapconn)) {
$oEvent->set('errorCode', self::ERROR_LDAP_CONNECTION);
$oEvent->set('errorMessageTitle', '');
$oEvent->set('errorMessageBody', $ldapconn['errorMessage']);
return null;
}
if (empty($ldapmode) || $ldapmode == 'simplebind') {
$oEvent->set('errorCode', self::ERROR_LDAP_MODE);
$oEvent->set('errorMessageTitle', gT("Failed to add user"));
$oEvent->set('errorMessageBody', gT("Simple bind LDAP configuration doesn't allow LDAP user creation"));
return null;
}
// Search email address and full name
if (empty($binddn)) {
// There is no account defined to do the LDAP search,
// let's use anonymous bind instead
$ldapbindsearch = @ldap_bind($ldapconn);
} else {
// An account is defined to do the LDAP search, let's use it
$ldapbindsearch = @ldap_bind($ldapconn, $binddn, $bindpwd);
}
if (!$ldapbindsearch) {
$oEvent->set('errorCode', self::ERROR_LDAP_NO_BIND);
$oEvent->set('errorMessageTitle', gT('Could not connect to LDAP server.'));
$oEvent->set('errorMessageBody', gT(ldap_error($ldapconn)));
ldap_close($ldapconn); // all done? close connection
return null;
}
// Now prepare the search fitler
if ($extrauserfilter != "") {
$usersearchfilter = "(&($searchuserattribute=$new_user)$extrauserfilter)";
} else {
$usersearchfilter = "($searchuserattribute=$new_user)";
}
// Search for the user
$userentry = false;
// try each semicolon-separated search base in order
foreach (explode(";", $usersearchbase) as $usb) {
$dnsearchres = ldap_search($ldapconn, $usb, $usersearchfilter, array($mailattribute, $fullnameattribute));
$rescount = ldap_count_entries($ldapconn, $dnsearchres);
if ($rescount == 1) {
$userentry = ldap_get_entries($ldapconn, $dnsearchres);
$new_email = flattenText($userentry[0][strtolower($mailattribute)][0]);
$new_full_name = flattenText($userentry[0][strtolower($fullnameattribute)][0]);
break;
}
}
if (!$userentry) {
$oEvent->set('errorCode', self::ERROR_LDAP_NO_SEARCH_RESULT);
$oEvent->set('errorMessageTitle', gT('Username not found in LDAP server'));
$oEvent->set('errorMessageBody', gT('Verify username and try again'));
ldap_close($ldapconn); // all done? close connection
return null;
}
if (!validateEmailAddress($new_email)) {
$oEvent->set('errorCode', self::ERROR_INVALID_EMAIL);
$oEvent->set('errorMessageTitle', gT("Failed to add user"));
$oEvent->set('errorMessageBody', gT("The email address is not valid."));
return null;
}
$new_pass = createPassword();
// If user is being auto created we set parent ID to 1 (admin user)
if (isset(Yii::app()->session['loginID'])) {
$parentID = Yii::app()->session['loginID'];
} else {
$parentID = 1;
}
$iNewUID = User::insertUser($new_user, $new_pass, $new_full_name, $parentID, $new_email);
if (!$iNewUID) {
$oEvent->set('errorCode', self::ERROR_ALREADY_EXISTING_USER);
$oEvent->set('errorMessageTitle', '');
$oEvent->set('errorMessageBody', gT("Failed to add user"));
return null;
}
Permission::model()->setGlobalPermission($iNewUID, 'auth_ldap');
$oEvent->set('newUserID', $iNewUID);
$oEvent->set('newPassword', $new_pass);
$oEvent->set('newEmail', $new_email);
$oEvent->set('newFullName', $new_full_name);
$oEvent->set('errorCode', self::ERROR_NONE);
return $iNewUID;
}
/**
* Create LDAP connection
*
* @return mixed
*/
private function createConnection()
{
// Get configuration settings:
$ldapserver = $this->get('server');
$ldapport = $this->get('ldapport');
$ldapver = $this->get('ldapversion');
$ldaptls = $this->get('ldaptls');
$ldapoptreferrals = $this->get('ldapoptreferrals');
if (empty($ldapport)) {
$ldapport = 389;
}
// Try to connect
if (strpos($ldapserver, 'ldaps://') === false && strpos($ldapserver, 'ldap://') === false) {
$ldapserver = 'ldap://' . $ldapserver;
}
$ldapconn = ldap_connect($ldapserver . ':' . (int) $ldapport);
if (false == $ldapconn) {
// LDAP connect does not connect, but just checks the URI
// A real connection is only created on the first following ldap_* command
return array("errorCode" => 2, "errorMessage" => gT('LDAP URI could not be parsed.'));
}
// using LDAP version
if (empty($ldapver)) {
// If the version hasn't been set, default = 2
$ldapver = 2;
}
$connectionSuccessful = ldap_set_option($ldapconn, LDAP_OPT_PROTOCOL_VERSION, $ldapver);
if (!$connectionSuccessful) {
return array("errorCode" => 1, "errorMessage" => gT('Error creating LDAP connection'));
}
ldap_set_option($ldapconn, LDAP_OPT_REFERRALS, $ldapoptreferrals);
// Apply TLS only if ldaps is not used - you can use either SSL or TLS - both does not work
// TLS also requires LDAPv3
if (!empty($ldaptls) && $ldaptls == '1' && $ldapver == 3 && preg_match("/^ldaps:\/\//", $ldapserver) === 0) {
// starting TLS secure layer
if (!ldap_start_tls($ldapconn)) {
ldap_unbind($ldapconn); // Could not properly connect, unbind everything.
return array("errorCode" => 100, 'errorMessage' => ldap_error($ldapconn));
}
}
return $ldapconn;
}
public function beforeLogin()
{
if ($this->get('is_default', null, null, false) == true) {
// This is configured to be the default login method
$this->getEvent()->set('default', get_class($this));
}
}
public function newLoginForm()
{
$this->getEvent()->getContent($this)
->addContent(CHtml::tag('span', array(), "<label for='user'>" . gT("Username") . "</label>" . CHtml::textField('user', '', array('size' => 240, 'maxlength' => 240, 'class' => "form-control"))))
->addContent(CHtml::tag('span', array(), "<label for='password'>" . gT("Password") . "</label>" . CHtml::passwordField('password', '', array('size' => 240, 'maxlength' => 240, 'class' => "form-control"))));
}
/**
* Modified getPluginSettings since we have a select box that autosubmits
* and we only want to show the relevant options.
*
* @param boolean $getValues
* @return array
*/
public function getPluginSettings($getValues = true)
{
$aPluginSettings = parent::getPluginSettings($getValues);
if ($getValues) {
$ldapmode = $aPluginSettings['ldapmode']['current'];
$ldapver = $aPluginSettings['ldapversion']['current'];
// If it is a post request, it could be an autosubmit so read posted
// value over the saved value
if (App()->request->isPostRequest) {
$ldapmode = App()->request->getPost('ldapmode', $ldapmode);
$aPluginSettings['ldapmode']['current'] = $ldapmode;
$ldapver = App()->request->getPost('ldapversion', $ldapver);
$aPluginSettings['ldapversion']['current'] = $ldapver;
}
if ($ldapver == '2') {
unset($aPluginSettings['ldaptls']);
}
if ($ldapmode == 'searchandbind') {
// Hide simple settings
unset($aPluginSettings['userprefix']);
unset($aPluginSettings['domainsuffix']);
} else {
// Hide searchandbind settings
unset($aPluginSettings['searchuserattribute']);
unset($aPluginSettings['usersearchbase']);
unset($aPluginSettings['extrauserfilter']);
unset($aPluginSettings['binddn']);
unset($aPluginSettings['bindpwd']);
unset($aPluginSettings['ldapoptreferrals']);
unset($aPluginSettings['mailattribute']);
unset($aPluginSettings['fullnameattribute']);
unset($aPluginSettings['autocreate']);
unset($aPluginSettings['automaticsurveycreation']);
}
}
return $aPluginSettings;
}
public function newUserSession()
{
// Do nothing if this user is not AuthLDAP type
$identity = $this->getEvent()->get('identity');
if ($identity->plugin != 'AuthLDAP') {
return;
}
/* unsubscribe from beforeHasPermission, else updating event */
$this->unsubscribe('beforeHasPermission');
// Here we do the actual authentication
$username = $this->getUsername();
$password = $this->getPassword();
$ldapmode = $this->get('ldapmode');
$autoCreateFlag = false;
$user = $this->api->getUserByName($username);
// No user found!
if ($user === null) {
// If ldap mode is searchandbind and autocreation is enabled we can continue
if ($ldapmode == 'searchandbind' && $this->get('autocreate', null, null, false) == true) {
$autoCreateFlag = true;
} else {
// If the user doesnt exist in the LS database, he can not login
$this->setAuthFailure(self::ERROR_USERNAME_INVALID); // Error shown : user or password invalid
return;
}
}
if ($user !== null) {
//If user cannot login via LDAP: setAuthFailure
if (
($user->uid == 1 && !$this->get('allowInitialUser'))
|| !Permission::model()->hasGlobalPermission('auth_ldap', 'read', $user->uid)
) {
$this->setAuthFailure(self::ERROR_AUTH_METHOD_INVALID); // Error shown : user or password invalid - swe how a generic message to prevent disclosure if user exists or not
return;
}
}
if (empty($password)) {
// If password is null or blank reject login
// This is necessary because in simple bind ldap server authenticates with blank password
$this->setAuthFailure(self::ERROR_PASSWORD_INVALID); // Error shown : user or password invalid
return;
}
// Get configuration settings:
$suffix = $this->get('domainsuffix');
$prefix = $this->get('userprefix');
$searchuserattribute = $this->get('searchuserattribute');
$extrauserfilter = $this->get('extrauserfilter');
$usersearchbase = $this->get('usersearchbase');
$binddn = $this->get('binddn');
$bindpwd = $this->get('bindpwd');
$groupsearchbase = $this->get('groupsearchbase');
$groupsearchfilter = $this->get('groupsearchfilter');
// Try to connect
$ldapconn = $this->createConnection();
if (!is_resource($ldapconn)) {
$this->setAuthFailure($ldapconn['errorCode'], gT($ldapconn['errorMessage']));
return;
}
if (empty($ldapmode) || $ldapmode == 'simplebind') {
// in simple bind mode we know how to construct the userDN from the username
$ldapbind = @ldap_bind($ldapconn, $prefix . $username . $suffix, $password);
} else {
// in search and bind mode we first do a LDAP search from the username given
// to foind the userDN and then we procced to the bind operation
if (empty($binddn)) {
// There is no account defined to do the LDAP search,
// let's use anonymous bind instead
$ldapbindsearch = @ldap_bind($ldapconn);
} else {
// An account is defined to do the LDAP search, let's use it
$ldapbindsearch = @ldap_bind($ldapconn, $binddn, $bindpwd);
}
if (!$ldapbindsearch) {
$this->setAuthFailure(100, ldap_error($ldapconn));
ldap_close($ldapconn); // all done? close connection
return;
}
// Now prepare the search fitler
if ($extrauserfilter != "") {
$usersearchfilter = "(&($searchuserattribute=$username)$extrauserfilter)";
} else {
$usersearchfilter = "($searchuserattribute=$username)";
}
// Search for the user
$userentry = false;
foreach (explode(";", $usersearchbase) as $usb) {
$dnsearchres = ldap_search($ldapconn, $usb, $usersearchfilter, array($searchuserattribute));
$rescount = ldap_count_entries($ldapconn, $dnsearchres);
if ($rescount == 1) {
$userentry = ldap_get_entries($ldapconn, $dnsearchres);
$userdn = $userentry[0]["dn"];
}
}
if (!$userentry) {
// if no entry or more than one entry returned
// then deny authentication
$this->setAuthFailure(self::ERROR_USERNAME_INVALID);
ldap_close($ldapconn); // all done? close connection
return;
}
// If specified, check group membership
if ($groupsearchbase != '' && $groupsearchfilter != '') {
$keywords = array('$username', '$userdn');
$substitutions = array($username, ldap_escape($userdn, "", LDAP_ESCAPE_FILTER));
$filter = str_replace($keywords, $substitutions, $groupsearchfilter);
$groupsearchres = ldap_search($ldapconn, $groupsearchbase, $filter);
$grouprescount = ldap_count_entries($ldapconn, $groupsearchres);
if ($grouprescount < 1) {
$this->setAuthFailure(
self::ERROR_USERNAME_INVALID,
gT('Valid username but not authorized by group restriction')
);
ldap_close($ldapconn); // all done? close connection
return;
}
}
// binding to ldap server with the userDN and provided credentials
$ldapbind = @ldap_bind($ldapconn, $userdn, $password);
}
// verify user binding
if (!$ldapbind) {
$this->setAuthFailure(100, ldap_error($ldapconn));
ldap_close($ldapconn); // all done? close connection
return;
}
ldap_close($ldapconn); // all done? close connection
// Finally, if user didn't exist and auto creation (i.e. autoCreateFlag == true) is enabled, we create it
if ($autoCreateFlag) {
if (($iNewUID = $this->_createNewUser($username)) && $this->get('automaticsurveycreation', null, null, false)) {
Permission::model()->setGlobalPermission($iNewUID, 'surveys', array('create_p'));
}
$user = $this->api->getUserByName($username);
if ($user === null) {
$this->setAuthFailure(self::ERROR_USERNAME_INVALID, gT('Credentials are valid but we failed to create a user'));
return;
}
}
// If we made it here, authentication was a success and we do have a valid user
$this->pluginManager->dispatchEvent(new PluginEvent('newUserLogin', $this));
$this->setAuthSuccess($user);
}
}