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
|
<?php
/**
* The Auth_ldap class provides an LDAP implementation of the Horde
* authentication system.
*
* Required parameters:<pre>
* 'basedn' The base DN for the LDAP server.
* 'hostspec' The hostname of the LDAP server.
* 'uid' The username search key.
* 'filter' The LDAP formatted search filter to search for users. This
* setting overrides the 'objectclass' method below.
* 'objectclass' The objectclass filter used to search for users. Can be a
* single objectclass or an array.</pre>
*
* Optional parameters:<pre>
* 'binddn' The DN used to bind to the LDAP server
* 'password' The password used to bind to the LDAP server
* 'version' The version of the LDAP protocol to use.
* DEFAULT: NONE (system default will be used)</pre>
*
*
* $Horde: framework/Auth/Auth/ldap.php,v 1.47.10.19 2006/08/14 02:48:48 chuck Exp $
*
* Copyright 1999-2006 Jon Parise <jon@horde.org>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Jon Parise <jon@horde.org>
* @since Horde 1.3
* @package Horde_Auth
*/
class Auth_ldap extends Auth {
/**
* An array of capabilities, so that the driver can report which
* operations it supports and which it doesn't.
*
* @var array
*/
var $capabilities = array('add' => true,
'update' => true,
'resetpassword' => false,
'remove' => true,
'list' => true,
'transparent' => false);
/**
* LDAP connection handle
*
* @var resource
*/
var $_ds;
/**
* Constructs a new LDAP authentication object.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_ldap($params = array())
{
if (!Util::extensionExists('ldap')) {
Horde::fatal(_("Auth_ldap: Required LDAP extension not found."), __FILE__, __LINE__);
}
$this->_setParams($params);
}
/**
* Set configuration parameters
*
* @access private
*
* @param array $params A hash containing connection parameters.
*/
function _setParams($params)
{
/* Ensure we've been provided with all of the necessary parameters. */
Horde::assertDriverConfig($params, 'auth',
array('hostspec', 'basedn', 'uid'),
'authentication LDAP');
$this->_params = $params;
}
/**
* Does an ldap connect and binds as the guest user or as the optional dn.
*
* @access private
*
* @return boolean True or False based on success of connect and bind.
*/
function _connect()
{
/* Connect to the LDAP server. */
$this->_ds = @ldap_connect($this->_params['hostspec']);
if (!$this->_ds) {
return PEAR::raiseError(_("Failed to connect to LDAP server."));
}
if (isset($this->_params['version'])) {
if (!ldap_set_option($this->_ds, LDAP_OPT_PROTOCOL_VERSION,
$this->_params['version'])) {
Horde::logMessage(sprintf('Set LDAP protocol version to %d failed: [%d] %s',
$this->_params['version'],
ldap_errno($conn),
ldap_error($conn)),
__FILE__, __LINE__, PEAR_LOG_ERR);
}
}
if (isset($this->_params['binddn'])) {
$bind = @ldap_bind($this->_ds, $this->_params['binddn'],
$this->_params['password']);
} else {
$bind = @ldap_bind($this->_ds);
}
if (!$bind) {
return PEAR::raiseError(_("Could not bind to LDAP server."));
}
return true;
}
/**
* Find the user dn
*
* @access private
*
* @param string $userId The userId to find.
*
* @return string The users full DN
*/
function _findDN($userId)
{
/* Search for the user's full DN. */
$search = @ldap_search($this->_ds, $this->_params['basedn'],
$this->_params['uid'] . '=' . $userId,
array($this->_params['uid']));
if (!$search) {
Horde::logMessage(ldap_error($this->_ds), __FILE__, __LINE__, PEAR_LOG_ERR);
return PEAR::raiseError(_("Could not search the LDAP server."));
}
$result = @ldap_get_entries($this->_ds, $search);
if (is_array($result) && (count($result) > 1)) {
$dn = $result[0]['dn'];
} else {
return PEAR::raiseError(_("Empty result."));
}
return $dn;
}
/**
* Checks for shadowLastChange and shadowMin/Max support and returns their
* values. We will also check for pwdLastSet if Active Directory is
* support is requested. For this check to succeed we need to be bound
* to the directory
*
* @access private
*
* @param string $dn The dn of the user
*
* @return array array with keys being "shadowlastchange", "shadowmin"
* "shadowmax", "shadowwarning" and containing their
* respective values or false for no support.
*/
function _lookupShadow($dn)
{
/* Init the return array. */
$lookupshadow = array('shadowlastchange' => false,
'shadowmin' => false,
'shadowmax' => false,
'shadowwarning' => false);
$result = @ldap_read($this->_ds, $dn, 'objectClass=*');
if ($result) {
$information = @ldap_get_entries($this->_ds, $result);
if ($this->_params['ad']) {
if (isset($information[0]['pwdlastset'][0])) {
/* Active Directory handles timestamps a bit
* differently. Convert the timestamp to a UNIX
* timestamp. */
$lookupshadow['shadowlastchange'] = floor((($information[0]['pwdlastset'][0] / 10000000) - 11644406783) / 86400) - 1;
/* Password expiry attributes are in a policy. We
* cannot read them so use the Horde config. */
$lookupshadow['shadowwarning'] = $this->_params['warnage'];
$lookupshadow['shadowmin'] = $this->_params['minage'];
$lookupshadow['shadowmax'] = $this->_params['maxage'];
}
} else {
if (isset($information[0]['shadowmax'][0])) {
$lookupshadow['shadowmax'] =
$information[0]['shadowmax'][0];
}
if (isset($information[0]['shadowmin'][0])) {
$lookupshadow['shadowmin'] =
$information[0]['shadowmin'][0];
}
if (isset($information[0]['shadowlastchange'][0])) {
$lookupshadow['shadowlastchange'] =
$information[0]['shadowlastchange'][0];
}
if (isset($information[0]['shadowwarning'][0])) {
$lookupshadow['shadowwarning'] =
$information[0]['shadowwarning'][0];
}
}
}
return $lookupshadow;
}
/**
* Find out if the given set of login credentials are valid.
*
* @access private
*
* @param string $userId The userId to check.
* @param array $credentials An array of login credentials.
*
* @return boolean True on success or a PEAR_Error object on failure.
*/
function _authenticate($userId, $credentials)
{
/* Connect to the LDAP server. */
$success = $this->_connect();
if (is_a($success, 'PEAR_Error')) {
$this->_setAuthError(AUTH_REASON_MESSAGE, $success->getMessage());
return false;
}
/* Search for the user's full DN. */
$dn = $this->_findDN($userId);
if (is_a($dn, 'PEAR_Error')) {
$this->_setAuthError(AUTH_REASON_MESSAGE, $dn->getMessage());
return false;
}
/* Attempt to bind to the LDAP server as the user. */
$bind = @ldap_bind($this->_ds, $dn, $credentials['password']);
if ($bind != false) {
if ($this->_params['password_expiration'] == 'yes') {
$shadow = $this->_lookupShadow($dn);
if ($shadow['shadowmax'] && $shadow['shadowlastchange'] &&
$shadow['shadowwarning']) {
$today = floor(time() / 86400);
$warnday = $shadow['shadowlastchange'] +
$shadow['shadowmax'] - $shadow['shadowwarning'];
$toexpire = $shadow['shadowlastchange'] +
$shadow['shadowmax'] - $today;
if ($today >= $warnday) {
$GLOBALS['notification']->push(sprintf(_("%d days until your password expires."), $toexpire),'horde.warning');
}
if ($toexpire = 0) {
$this->_authCredentials['changeRequested'] = true;
}
if ($toexpire < 0) {
$this->_setAuthError(AUTH_REASON_EXPIRED);
return false;
}
}
}
@ldap_close($this->_ds);
return true;
} else {
@ldap_close($this->_ds);
$this->_setAuthError(AUTH_REASON_FAILED);
return false;
}
}
/**
* Add a set of authentication credentials.
*
* @param string $userId The userId to add.
* @param array $credentials The credentials to be set.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function addUser($userId, $credentials)
{
if ($this->_params['ad']) {
return PEAR::raiseError(_("Auth_ldap: Adding users is not supported for Active Directory"), __FILE__, __LINE__);
}
/* Connect to the LDAP server. */
$success = $this->_connect();
global $conf;
if (!empty($conf['hooks']['authldap'])) {
@include HORDE_BASE . '/config/hooks.php';
if (function_exists('_horde_hook_authldap')) {
$entry = call_user_func('_horde_hook_authldap', $userId, $credentials);
$dn = $entry['dn'];
/* remove the dn entry from the array. */
unset($entry['dn']);
}
} else {
/* Try this simple default and hope it works. */
$dn = $this->_params['uid'] . '=' . $userId . ',' . $this->_params['basedn'];
$entry['cn'] = $userId;
$entry['sn'] = $userId;
$entry[$this->_params['uid']] = $userId;
$entry['objectclass'] = array_merge(array('top'),
$this->_params['newuser_objectclass']);
$entry['userPassword'] = $this->getCryptedPassword($credentials['password'],'',
$this->_params['encryption'],
'true');
if ($this->_params['password_expiration'] == 'yes') {
$entry['shadowMin'] = $this->_params['minage'];
$entry['shadowMax'] = $this->_params['maxage'];
$entry['shadowWarning'] = $this->_params['warnage'];
$entry['shadowLastChange'] = floor(time() / 86400);
}
}
$success = @ldap_add($this->_ds, $dn, $entry);
if (!$success) {
return PEAR::raiseError(sprintf(_("Auth_ldap: Unable to add user %s. This is what the server said: "), $userId) . @ldap_error($this->_ds));
}
@ldap_close($this->_ds);
return true;
}
/**
* Remove a set of authentication credentials.
*
* @param string $userId The userId to add.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function removeUser($userId)
{
if ($this->_params['ad']) {
return PEAR::raiseError(_("Auth_ldap: Removing users is not supported for Active Directory"), __FILE__, __LINE__);
}
/* Connect to the LDAP server. */
$success = $this->_connect();
if (is_a($success, 'PEAR_Error')) {
$this->_setAuthError(AUTH_REASON_MESSAGE, $success->getMessage());
return false;
}
global $conf;
if (!empty($conf['hooks']['authldap'])) {
@include HORDE_BASE . '/config/hooks.php';
if (function_exists('_horde_hook_authldap')) {
$entry = call_user_func('_horde_hook_authldap', $userId);
$dn = $entry['dn'];
}
} else {
/* Search for the user's full DN. */
$dn = $this->_findDN($userId);
if (is_a($dn, 'PEAR_Error')) {
$this->_setAuthError(AUTH_REASON_MESSAGE, $dn->getMessage());
return false;
}
}
$success = @ldap_delete($this->_ds,$dn);
if (!$success) {
return PEAR::raiseError(sprintf(_("Auth_ldap: Unable to remove user %s"), $userId), __FILE__, __LINE__);
}
@ldap_close($this->_ds);
return $this->removeUserData($userId);
}
/**
* Update a set of authentication credentials.
*
* @param string $oldID The old userId.
* @param string $newID The new userId.
* @param array $credentials The new credentials
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function updateUser($oldID, $newID, $credentials)
{
if ($this->_params['ad']) {
return PEAR::raiseError(_("Auth_ldap: Updating users is not supported for Active Directory."), __FILE__, __LINE__);
}
/* Connect to the LDAP server. */
$success = $this->_connect();
if (is_a($success, 'PEAR_Error')) {
return PEAR::raiseError($success->getMessage(), __FILE__, __LINE__);
}
global $conf;
if (!empty($conf['hooks']['authldap'])) {
@include HORDE_BASE . '/config/hooks.php';
if (function_exists('_horde_hook_authldap')) {
$entry = call_user_func('_horde_hook_authldap', $oldID, $credentials);
$olddn = $entry['dn'];
$entry = call_user_func('_horde_hook_authldap', $newID, $credentials);
$newdn = $entry['dn'];
unset($entry['dn']);
}
} else {
/* Search for the user's full DN. */
$dn = $this->_findDN($oldID);
if (is_a($dn, 'PEAR_Error')) {
return PEAR::raiseError($success->getMessage(), __FILE__, __LINE__);
} else {
$olddn = $dn;
$newdn = preg_replace('/uid=.*?,/','uid='.$newID.',',$dn,1);
$shadow = $this->_lookupShadow($dn);
/* if shadowmin hasn't yet expired only change when we are
administrator */
if ($shadow['shadowlastchange'] && $shadow['shadowmin']) {
if ($shadow['shadowlastchange'] + $shadow['shadowmin'] > (time() / 86400)) {
return PEAR::raiseError(_("Minimum password age has not yet expired"));
}
}
/* Set the lastchange field */
if ($shadow['shadowlastchange']) {
$entry['shadowlastchange'] = floor(time() / 86400);
}
/* Encrypt the new password */
$entry['userpassword'] = $this->getCryptedPassword($credentials['password'],'',
$this->_params['encryption'],
'true');
}
}
if ($oldID != $newID) {
if (LDAP_OPT_PROTOCOL_VERSION == 3) {
ldap_rename($this->_ds, $olddn, $newdn, $this->_params['basedn'], true);
$success = ldap_modify($this->_ds, $newdn, $entry);
} else {
/* Get the complete old record first */
$success = @ldap_read($this->_ds, $olddn, 'objectClass=*');
if ($success) {
$information = @ldap_get_entries($this->_ds, $success);
/* Remove the count elements from the array */
$counter = 0;
$newrecord = array();
while (isset($information[0][$counter])) {
if ($information[0][$information[0][$counter]]['count'] == 1) {
$newrecord[$information[0][$counter]] = $information[0][$information[0][$counter]][0];
} else {
$newrecord[$information[0][$counter]] = $information[0][$information[0][$counter]];
unset($newrecord[$information[0][$counter]]['count']);
}
$counter++;
}
/* Adjust the changed parameters */
unset($newrecord['dn']);
$newrecord[$this->_params['uid']] = $newID;
$newrecord['userpassword'] = $entry['userpassword'];
if (isset($entry['shadowlastchange'])) {
$newrecord['shadowlastchange'] = $entry['shadowlastchange'];
}
$success = ldap_add($this->_ds,$newdn,$newrecord);
if ($success) {
$success = @ldap_delete($this->_ds,$olddn);
}
}
}
} else {
$success = @ldap_modify($this->_ds, $olddn, $entry);
}
if (!$success) {
return PEAR::raiseError(sprintf(_("Auth_ldap: Unable to update user %s"), $newID), __FILE__, __LINE__);
}
@ldap_close($this->_ds);
return true;
}
/**
* List Users
*
* @return array List of Users
*/
function listUsers()
{
/* Connect to the LDAP server. */
$success = $this->_connect();
if (is_a($success, 'PEAR_Error')) {
return PEAR::raiseError($success->getMessage(), __FILE__, __LINE__);
}
if (!empty($this->_params['filter'])) {
$filter = $this->_params['filter'];
} elseif (!is_array($this->_params['objectclass'])) {
$filter = 'objectclass=' . $this->_params['objectclass'];
} else {
$filter = '';
foreach ($this->_params['objectclass'] as $objectclass) {
$filter = '(&' . $filter;
$filter .= '(objectclass=' . $objectclass . '))';
}
}
$search = @ldap_search($this->_ds, $this->_params['basedn'], $filter, array($this->_params['uid']));
$entries = @ldap_get_entries($this->_ds, $search);
$userlist = array();
$uid = String::lower($this->_params['uid']);
for ($i = 0; $i < $entries['count']; $i++) {
$userlist[$i] = $entries[$i][$uid][0];
}
return $userlist;
}
}
|
