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
|
<?php
/**
* Horde_String class.
*/
require_once 'Horde/String.php';
/**
* Preferences storage implementation for PHP's LDAP extention.
*
* Required parameters:<pre>
* 'basedn' The base DN for the LDAP server.
* 'hostspec' The hostname of the LDAP server.
* 'uid' The username search key.</pre>
*
* Optional parameters:<pre>
* 'password' 'rootdn's password for bind authentication.
* 'port' The port of the LDAP server.
* DEFAULT: 389
* 'rootdn' The DN of the root (administrative) account to bind for
* write operations.
* 'username' TODO
* 'version' The version of the LDAP protocol to use.
* DEFAULT: NONE (system default will be used)</pre>
*
* NOTE: parameter 'username' has been deprecated. Use 'rootdn'.
*
*
* If setting up as the Horde preference handler in conf.php, the following
* is an example configuration.
* The schemas needed for ldap are in horde/scripts/ldap.
*
* <pre>
* $conf['prefs']['driver'] = 'ldap';
* $conf['prefs']['params']['hostspec'] = 'localhost';
* $conf['prefs']['params']['port'] = '389';
* $conf['prefs']['params']['basedn'] = 'dc=example,dc=org';
* $conf['prefs']['params']['uid'] = 'mail';
* </pre>
*
* The following is valid but would only be necessary if users
* do NOT have permission to modify their own LDAP accounts.
*
* <pre>
* $conf['prefs']['params']['rootdn'] = 'cn=Manager,dc=example,dc=org';
* $conf['prefs']['params']['password'] = 'password';
* </pre>
*
*
* $Horde: framework/Prefs/Prefs/ldap.php,v 1.85.10.20 2006/06/21 20:07:55 jan 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_Prefs
*/
class Prefs_ldap extends Prefs {
/**
* Hash containing connection parameters.
*
* @var array
*/
var $_params = array();
/**
* Handle for the current LDAP connection.
*
* @var resource
*/
var $_connection;
/**
* Boolean indicating whether or not we're connected to the LDAP server.
*
* @var boolean
*/
var $_connected = false;
/**
* String holding the user's DN.
*
* @var string
*/
var $_dn = '';
/**
* Constructs a new LDAP preferences object.
*
* @param string $user The user who owns these preferences.
* @param string $password The password associated with $user.
* @param string $scope The current application scope.
* @param array $params A hash containing connection parameters.
* @param boolean $caching Should caching be used?
*/
function Prefs_ldap($user, $password, $scope = '',
$params = array(), $caching = false)
{
if (!Util::extensionExists('ldap')) {
Horde::fatal(PEAR::raiseError(_("Prefs_ldap: Required LDAP extension not found.")), __FILE__, __LINE__);
}
$this->_user = $user;
$this->_scope = $scope;
$this->_params = $params;
$this->_caching = $caching;
/* If a valid server port has not been specified, set the default. */
if (!isset($this->_params['port']) || !is_int($this->_params['port'])) {
$this->_params['port'] = 389;
}
/* If $params['rootdn'] is empty, authenticate as the current user.
Note: This assumes the user is allowed to modify their own LDAP
entry. */
if (empty($this->_params['username']) &&
empty($this->_params['rootdn'])) {
$this->_params['username'] = $user;
$this->_params['password'] = $password;
}
parent::Prefs();
}
/**
* Opens a connection to the LDAP server.
*
* @access private
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function _connect()
{
/* Return if already connected. */
if ($this->_connected) {
return true;
}
Horde::assertDriverConfig($this->_params, 'prefs',
array('hostspec', 'basedn', 'uid', 'password'),
'preferences LDAP');
/* Allow for multiple uid search fields */
if (!is_array($this->_params['uid'])) {
$this->_params['uid'] = array($this->_params['uid']);
}
/* Connect to the LDAP server anonymously. */
$conn = ldap_connect($this->_params['hostspec'], $this->_params['port']);
if (!$conn) {
Horde::logMessage(
sprintf('Failed to open an LDAP connection to %s.',
$this->_params['hostspec']),
__FILE__, __LINE__);
return false;
}
/* Set the LDAP protocol version. */
if (isset($this->_params['version'])) {
if (!ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION,
$this->_params['version'])) {
Horde::logMessage(
sprintf('Set LDAP protocol version to %d failed: [%d] %s',
$this->_params['version'],
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
}
}
/* If necessary, bind to the LDAP server as the user with search
* permissions. */
if (!empty($this->_params['searchdn'])) {
$bind = @ldap_bind($conn, $this->_params['searchdn'],
$this->_params['searchpass']);
if (!$bind) {
return PEAR::raiseError(sprintf('Bind to server %s:%d with DN %s failed: [%d] %s',
$this->_params['hostspec'],
$this->_params['port'],
$this->_params['searchdn'],
ldap_errno($this->_connection),
ldap_error($this->_connection)));
}
}
/* Register our callback function to handle referrals. */
if (function_exists('ldap_set_rebind_proc') &&
!ldap_set_rebind_proc($conn, array($this, '_rebindProc'))) {
Horde::logMessage(
sprintf('Set rebind proc failed: [%d] %s',
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
return false;
}
/* Store the connection handle at the instance level. */
$this->_connection = $conn;
$this->_connected = true;
if (!$this->_params['fetchdn']) {
/* Define the DN of the current user. */
$this->_dn = sprintf('%s=%s,%s', $this->_params['uid'][0],
$this->_user,
$this->_params['basedn']);
/* And the DN of the authenticating user (may be the same as above). */
if (!empty($this->_params['rootdn'])) {
$bind_dn = $this->_params['rootdn'];
} else {
$bind_dn = sprintf('%s=%s,%s', $this->_params['uid'][0],
$this->_params['username'],
$this->_params['basedn']);
}
/* Bind to the LDAP server as the authenticating user. */
$bind = @ldap_bind($this->_connection, $bind_dn,
$this->_params['password']);
if (!$bind) {
Horde::logMessage(
sprintf('Bind to server %s:%d with DN %s failed: [%d] %s',
$this->_params['hostspec'],
$this->_params['port'],
$bind_dn,
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
return false;
}
}
/* Search for the user's full DN. */
foreach ($this->_params['uid'] as $uid_field) {
$search = ldap_search($this->_connection, $this->_params['basedn'],
$uid_field . '=' . $this->_user, array('dn'));
if ($search) {
$result = ldap_get_entries($this->_connection, $search);
if ($result && $result['count'] > 0) {
$this->_dn = $result[0]['dn'];
if ($this->_params['fetchdn']) {
// Re-bind as the user.
$bind = @ldap_bind($this->_connection, $this->_dn,
$this->_params['password']);
}
return true;
}
}
}
Horde::logMessage(
sprintf('Failed to retrieve user\'s DN: [%d] %s',
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
return false;
}
/**
* Disconnect from the LDAP server and clean up the connection.
*
* @access private
*
* @return boolean True on success, false on failure.
*/
function _disconnect()
{
if ($this->_connected) {
$this->_dn = '';
$this->_connected = false;
return ldap_close($this->_connection);
} else {
return true;
}
}
/**
* Callback function for LDAP referrals. This function is called when an
* LDAP operation returns a referral to an alternate server.
*
* @access private
*
* @return integer 1 on error, 0 on success.
*/
function _rebindProc($conn, $who)
{
/* Strip out the hostname we're being redirected to. */
$who = preg_replace(array('|^.*://|', '|:\d*$|'), '', $who);
/* Figure out the DN of the authenticating user. */
if (!empty($this->_params['rootdn'])) {
$bind_dn = $this->_params['rootdn'];
} else {
$bind_dn = sprintf('%s=%s,%s', $this->_params['uid'][0],
$this->_params['username'],
$this->_params['basedn']);
}
/* Make sure the server we're being redirected to is in our list of
valid servers. */
if (strpos($this->_params['hostspec'], $who) === false) {
Horde::logMessage(
sprintf('Referral target %s for DN %s is not in the authorized server list!', $who, $bind_dn),
__FILE__, __LINE__);
return 1;
}
/* Bind to the new server. */
$bind = @ldap_bind($conn, $bind_dn, $this->_params['password']);
if (!$bind) {
Horde::logMessage(
sprintf('Rebind to server %s:%d with DN %s failed: [%d] %s',
$this->_params['hostspec'],
$this->_params['port'],
$bind_dn,
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
}
return 0;
}
/**
* Retrieves the requested set of preferences from the user's LDAP entry.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function retrieve()
{
/* Attempt to pull the values from the session cache first. */
if ($this->cacheLookup()) {
return true;
}
/* Load defaults to make sure we have all preferences. */
parent::retrieve();
/* Make sure we are connected. */
$this->_connect();
/* Only fetch the fields for the attributes we need. */
$attrs = array('hordePrefs');
if (strcmp($this->_scope, 'horde') != 0) {
$attrs[] = $this->_scope . 'Prefs';
}
/* Search for the multi-valued field containing the array of
preferences. */
foreach ($this->_params['uid'] as $uid_field) {
$search = ldap_search($this->_connection, $this->_params['basedn'],
$uid_field . '=' . $this->_user, $attrs);
if ($search) {
$result = ldap_get_entries($this->_connection, $search);
if ($result && $result['count'] > 0) {
break;
}
}
}
if (!isset($result)) {
Horde::logMessage('Failed to connect to LDAP preferences server.', __FILE__, __LINE__);
}
/* ldap_get_entries() converts attribute indexes to lowercase. */
$field = String::lower($this->_scope . 'prefs');
if (isset($result)) {
/* Set the requested values in the $this->_prefs hash based on
the contents of the LDAP result.
Preferences are stored as colon-separated name:value pairs.
Each pair is stored as its own attribute off of the multi-
value attribute named in: $this->_scope . 'Prefs'
Note that Prefs::setValue() can't be used here because of the
check for the "changeable" bit. We want to override that
check when populating the $this->_prefs hash from the LDAP
server.
*/
$prefs = array();
/* If hordePrefs exists, merge them as the base of the prefs. */
if (isset($result[0]['hordeprefs'])) {
$prefs = array_merge($prefs, $result[0]['hordeprefs']);
}
/* If this scope's prefs are available, merge them as will. Give
* them a higher precedence than hordePrefs. */
if (strcmp($this->_scope, 'horde') != 0) {
if (isset($result[0][$field])) {
$prefs = array_merge($prefs, $result[0][$field]);
}
}
foreach ($prefs as $prefstr) {
/* If the string doesn't contain a colon delimiter, skip it. */
if (substr_count($prefstr, ':') == 0) {
continue;
}
/* Split the string into its name:value components. */
list($pref, $val) = split(':', $prefstr, 2);
/* Retrieve this preference. */
if (isset($this->_prefs[$pref])) {
$this->_setValue($pref, base64_decode($val), false);
$this->setDefault($pref, false);
} else {
$this->add($pref, base64_decode($val), _PREF_SHARED);
}
}
/* Call hooks. */
$this->_callHooks();
} else {
Horde::logMessage('No preferences were retrieved.', __FILE__, __LINE__);
return;
}
/* Update the session cache. */
$this->cacheUpdate();
return true;
}
/**
* Stores preferences to the LDAP server.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function store()
{
$updated = true;
/* Check for any "dirty" preferences. If no "dirty"
* preferences are found, there's no need to update the LDAP
* server. Exit successfully. */
$dirty_prefs = $this->_dirtyPrefs();
if (!count($dirty_prefs)) {
return true;
}
/* Make sure we are connected. */
$this->_connect();
/* Build a hash of the preferences and their values that need
* to be stored in the LDAP server. Because we have to update
* all of the values of a multi-value entry wholesale, we
* can't just pick out the dirty preferences; we must update
* everything. */
$new_values = array();
foreach (array_keys($this->_prefs) as $pref) {
// Don't store locked preferences.
if (!$this->isLocked($pref)) {
$entry = $pref . ':' . base64_encode($this->getValue($pref));
$field = $this->getScope($pref) . 'Prefs';
$new_values[$field][] = $entry;
}
}
/* Entries must have the objectclasses 'top' and 'hordeperson'
* to successfully store LDAP prefs. Check for both of them,
* and add them if necessary. */
foreach ($this->_params['uid'] as $uid_field) {
$search = ldap_search($this->_connection, $this->_params['basedn'],
$uid_field . '=' . $this->_user,
array('objectclass'));
if ($search) {
$result = ldap_get_entries($this->_connection, $search);
if ($result && $result['count'] > 0) {
$top = false;
$hordeperson = false;
for ($i = 0; $i < $result[0]['objectclass']['count']; $i++) {
if ($result[0]['objectclass'][$i] == 'top') {
$top = true;
} elseif ($result[0]['objectclass'][$i] == 'hordePerson') {
$hordeperson = true;
}
}
/* Add any missing objectclasses. */
if (!$top) {
ldap_mod_add($this->_connection, $this->_dn, array('objectclass' => 'top'));
}
if (!$hordeperson) {
ldap_mod_add($this->_connection, $this->_dn, array('objectclass' => 'hordePerson'));
}
continue;
}
}
}
/* Send the hash to the LDAP server. */
if (ldap_mod_replace($this->_connection, $this->_dn, $new_values)) {
foreach ($dirty_prefs as $pref) {
$this->setDirty($pref, false);
}
} else {
Horde::logMessage(
sprintf('Unable to modify preferences: [%d] %s',
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
$updated = false;
}
/* Attempt to cache the preferences in the session. */
$this->cacheUpdate();
return $updated;
}
/**
* Clears all preferences from the LDAP backend.
*/
function clear()
{
/* Make sure we are connected. */
$this->_connect();
$attrs = $GLOBALS['registry']->listApps(array('inactive', 'active', 'hidden', 'notoolbar', 'admin'));
foreach ($attrs as $key => $val) {
$attrs[$key] = $val . 'Prefs';
}
$search = ldap_read($this->_connection, $this->_dn,
'objectClass=hordePerson', $attrs, 1);
if ($search) {
$result = ldap_get_entries($this->_connection, $search);
} else {
Horde::logMessage('Failed to connect to LDAP preferences server.', __FILE__, __LINE__);
}
$attrs = array();
if ($result) {
for ($i = 0; $i < $result[0]['count']; $i++) {
$attrs[$result[0][$i]] = array();
}
if (!ldap_mod_del($this->_connection, $this->_dn, $attrs)) {
Horde::logMessage(
sprintf('Unable to clear preferences: [%d] %s',
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
}
} else {
Horde::logMessage(
sprintf('Unable to clear preferences: [%d] %s',
ldap_errno($this->_connection),
ldap_error($this->_connection)),
__FILE__, __LINE__);
}
$this->cleanup(true);
}
/**
* Perform cleanup operations.
*
* @param boolean $all Cleanup all Horde preferences.
*/
function cleanup($all = false)
{
/* Close the LDAP connection. */
$this->_disconnect();
parent::cleanup($all);
}
}
|
