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
|
<?php
/**
* The Auth_sql class provides a SQL implementation of the Horde
* authentication system.
*
* Required parameters:<pre>
* 'phptype' The database type (ie. 'pgsql', 'mysql', etc.).</pre>
*
* Optional parameters:<pre>
* 'encryption' The encryption to use to store the password in
* the table (e.g. plain, crypt, md5-hex,
* md5-base64, smd5, sha, ssha, aprmd5).
* DEFAULT: 'md5-hex'
* 'show_encryption' Whether or not to prepend the encryption in the
* password field.
* DEFAULT: 'false'
* 'password_field' The name of the password field in the auth table.
* DEFAULT: 'user_pass'
* 'table' The name of the SQL table to use in 'database'.
* DEFAULT: 'horde_users'
* 'username_field' The name of the username field in the auth table.
* DEFAULT: 'user_uid'
* 'soft_expiration_field' The name of the field containing a date after
* which the system will request the user change his
* or her password.
* DEFAULT: none
* 'hard_expiration_field' The name of the field containing a date after
* which the account is no longer valid and the user
* will not be able to log in at all.
* DEFAULT: none</pre>
*
* Required by some database implementations:<pre>
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'database' The name of the database.
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'options' Additional options to pass to the database.
* 'port' The port on which to connect to the database.
* 'tty' The TTY on which to connect to the database.</pre>
*
* The table structure for the Auth system is in
* scripts/sql/horde_users.sql.
*
* $Horde: framework/Auth/Auth/sql.php,v 1.69.10.19 2006/08/14 02:48:48 chuck Exp $
*
* Copyright 1999-2006 Chuck Hagenbuch <chuck@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 Chuck Hagenbuch <chuck@horde.org>
* @since Horde 1.3
* @package Horde_Auth
*/
class Auth_sql 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' => true,
'remove' => true,
'list' => true,
'transparent' => false);
/**
* Handle for the current database connection.
*
* @var DB
*/
var $_db;
/**
* Boolean indicating whether or not we're connected to the SQL server.
*
* @var boolean
*/
var $_connected = false;
/**
* Constructs a new SQL authentication object.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_sql($params = array())
{
$this->_params = $params;
}
/**
* Find out if a set of login credentials are valid.
*
* @access private
*
* @param string $userId The userId to check.
* @param array $credentials The credentials to use.
*
* @return boolean Whether or not the credentials are valid.
*/
function _authenticate($userId, $credentials)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('SELECT * FROM %s WHERE %s = ?',
$this->_params['table'],
$this->_params['username_field']);
$values = array($userId);
Horde::logMessage('SQL Query by Auth_sql::_authenticate(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
$this->_setAuthError(AUTH_REASON_FAILED);
return false;
}
$row = $result->fetchRow(DB_GETMODE_ASSOC);
if (is_array($row)) {
$result->free();
} else {
$this->_setAuthError(AUTH_REASON_BADLOGIN);
return false;
}
if (!$this->_comparePasswords($row[$this->_params['password_field']],
$credentials['password'])) {
$this->_setAuthError(AUTH_REASON_BADLOGIN);
return false;
}
$now = time();
if (!empty($this->_params['hard_expiration_field']) &&
!empty($row[$this->_params['hard_expiration_field']]) &&
($now > $row[$this->_params['hard_expiration_field']])) {
$this->_setAuthError(AUTH_REASON_EXPIRED);
return false;
}
if (!empty($this->_params['soft_expiration_field']) &&
!empty($row[$this->_params['soft_expiration_field']]) &&
($now > $row[$this->_params['soft_expiration_field']])) {
$this->_authCredentials['changeRequested'] = true;
}
return true;
}
/**
* Add a set of authentication credentials.
*
* @param string $userId The userId to add.
* @param array $credentials The credentials to add.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function addUser($userId, $credentials)
{
$this->_connect();
/* Build the SQL query. */
$query = sprintf('INSERT INTO %s (%s, %s) VALUES (?, ?)',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['password_field']);
$values = array($userId,
$this->getCryptedPassword($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption']));
Horde::logMessage('SQL Query by Auth_sql::addUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return true;
}
/**
* 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)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$tuple = array();
$tuple[$this->_params['username_field']] = $newID;
$tuple[$this->_params['password_field']] =
$this->getCryptedPassword($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption']);
if (empty($this->_params['soft_expiration_window'])) {
if (!empty($this->_params['soft_expiration_field'])) {
$tuple[$this->_params['soft_expiration_field']] = null;
}
} else {
$date = time();
$datea = localtime($date, true);
$date = mktime($datea['tm_hour'], $datea['tm_min'],
$datea['tm_sec'], $datea['tm_mon'] + 1,
$datea['tm_mday'] + $this->_params['soft_expiration_window'],
$datea['tm_year']);
$tuple[$this->_params['soft_expiration_field']] = $date;
global $notification;
if (!empty($notification)) {
$notification->push(strftime(_("New password will expire on %x."), $date), 'horde.message');
}
if (empty($this->_params['hard_expiration_window'])) {
$tuple[$this->_params['hard_expiration_field']] = null;
} else {
$datea = localtime($date, true);
$date = mktime($datea['tm_hour'], $datea['tm_min'],
$datea['tm_sec'], $datea['tm_mon'] + 1,
$datea['tm_mday'] + $this->_params['soft_expiration_window'],
$datea['tm_year']);
$tuple[$this->_params['hard_expiration_field']] = $date;
}
}
require_once 'Horde/SQL.php';
$query = sprintf('UPDATE %s SET %s WHERE %s = ?',
$this->_params['table'],
Horde_SQL::updateValues($this->_db, $tuple),
$this->_params['username_field']);
$values = array($oldID);
Horde::logMessage('SQL Query by Auth_sql:updateUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
return true;
}
/**
* Reset a user's password. Used for example when the user does not
* remember the existing password.
*
* @param string $user_id The user id for which to reset the password.
*
* @return mixed The new password on success or a PEAR_Error object on
* failure.
*/
function resetPassword($user_id)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Get a new random password. */
$password = Auth::genRandomPassword();
/* Build the SQL query. */
$query = sprintf('UPDATE %s SET %s = ? WHERE %s = ?',
$this->_params['table'],
$this->_params['password_field'],
$this->_params['username_field']);
$values = array($this->getCryptedPassword($password,
'',
$this->_params['encryption'],
$this->_params['show_encryption']),
$user_id);
Horde::logMessage('SQL Query by Auth_sql::resetPassword(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return $password;
}
/**
* Delete a set of authentication credentials.
*
* @param string $userId The userId to delete.
*
* @return boolean Success or failure.
*/
function removeUser($userId)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE %s = ?',
$this->_params['table'],
$this->_params['username_field']);
$values = array($userId);
Horde::logMessage('SQL Query by Auth_sql::removeUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->query($query, $values);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return $this->removeUserData($userId);
}
/**
* List all users in the system.
*
* @return mixed The array of userIds, or false on failure/unsupported.
*/
function listUsers()
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('SELECT %s FROM %s',
$this->_params['username_field'],
$this->_params['table']);
Horde::logMessage('SQL Query by Auth_sql::listUsers(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
return $this->_db->getCol($query);
}
/**
* Checks if a userId exists in the sistem.
*
* @return boolean Whether or not the userId already exists.
*/
function exists($userId)
{
/* _connect() will die with Horde::fatal() upon failure. */
$this->_connect();
/* Build the SQL query. */
$query = sprintf('SELECT %s FROM %s WHERE %s = ?',
$this->_params['username_field'],
$this->_params['table'],
$this->_params['username_field']);
$values = array($userId);
Horde::logMessage('SQL Query by Auth_sql::exists(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
return $this->_db->getOne($query, $values);
}
/**
* Compare an encrypted password to a plaintext string to see if
* they match.
*
* @access private
*
* @param string $encrypted The crypted password to compare against.
* @param string $plaintext The plaintext password to verify.
*
* @return boolean True if matched, false otherwise.
*/
function _comparePasswords($encrypted, $plaintext)
{
return $encrypted == $this->getCryptedPassword($plaintext,
$encrypted,
$this->_params['encryption'],
$this->_params['show_encryption']);
}
/**
* Attempts to open a connection to the SQL server.
*
* @access private
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function _connect()
{
if ($this->_connected) {
return true;
}
Horde::assertDriverConfig($this->_params, 'auth', array('phptype'),
'authentication SQL');
if (!isset($this->_params['database'])) {
$this->_params['database'] = '';
}
if (!isset($this->_params['username'])) {
$this->_params['username'] = '';
}
if (!isset($this->_params['password'])) {
$this->_params['password'] = '';
}
if (!isset($this->_params['hostspec'])) {
$this->_params['hostspec'] = '';
}
if (empty($this->_params['encryption'])) {
$this->_params['encryption'] = 'md5-hex';
}
if (!isset($this->_params['show_encryption'])) {
$this->_params['show_encryption'] = false;
}
if (empty($this->_params['table'])) {
$this->_params['table'] = 'horde_users';
}
if (empty($this->_params['username_field'])) {
$this->_params['username_field'] = 'user_uid';
} else {
$this->_params['username_field'] = String::lower($this->_params['username_field']);
}
if (empty($this->_params['password_field'])) {
$this->_params['password_field'] = 'user_pass';
} else {
$this->_params['password_field'] = String::lower($this->_params['password_field']);
}
/* Connect to the SQL server using the supplied parameters. */
include_once 'DB.php';
$this->_db = &DB::connect($this->_params,
array('persistent' => !empty($this->_params['persistent'])));
if (is_a($this->_db, 'PEAR_Error')) {
Horde::fatal(_("Unable to connect to SQL server."), __FILE__, __LINE__);
}
// Set DB portability options.
switch ($this->_db->phptype) {
case 'mssql':
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS | DB_PORTABILITY_RTRIM);
break;
default:
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS);
}
$this->_connected = true;
return true;
}
}
|
