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
|
<?php
require_once 'Horde/Auth/sql.php';
require_once 'Horde/IMAP/Admin.php';
/**
* The Auth_cyrsql class provides a SQL implementation of the Horde
* authentication system for the Cyrus IMAP server. Most of the functionality
* is the same as for the SQL class; only what is different overrides the
* parent class implementations.
*
* Required parameters:<pre>
* 'cyradmin' The username of the cyrus administrator.
* 'cyrpass' The password for the cyrus administrator.
* 'imap_dsn' The full IMAP DSN
* (i.e. {localhost:993/imap/ssl/novalidate-cert}).
* 'phptype' The database type (ie. 'pgsql', 'mysql', etc.).</pre>
*
* Optional parameters:<pre>
* 'domain_field' If set to anything other than 'none' this is used as
* field name where domain is stored.
* DEFAULT: 'domain_name'
* 'encryption' The encryption to use to store the password in the
* table (e.g. plain, crypt, md5-hex, md5-base64, smd5,
* sha, ssha).
* DEFAULT: 'md5-hex'
* 'folders' An array of folders to create under username.
* DEFAULT: NONE
* 'password_field' The name of the password field in the auth table.
* DEFAULT: 'password'
* 'quota' The quota (in kilobytes) to grant on the mailbox.
* DEFAULT: NONE
* 'table' The name of the auth table in 'database'.
* DEFAULT: 'accountuser'
* 'unixhier' The value of imapd.conf's unixhierarchysep setting.
* Set this to true if the value is true in imapd.conf.
* 'username_field' The name of the username field in the auth table.
* DEFAULT: 'username'</pre>
*
* Required by some database implementations:<pre>
* 'database' The name of the database.
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* '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 as follows:
*
* <pre>
* CREATE TABLE accountuser (
* username VARCHAR(255) BINARY NOT NULL DEFAULT '',
* password VARCHAR(32) BINARY NOT NULL DEFAULT '',
* prefix VARCHAR(50) NOT NULL DEFAULT '',
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* UNIQUE KEY username (username)
* );
*
* CREATE TABLE adminuser (
* username VARCHAR(50) BINARY NOT NULL DEFAULT '',
* password VARCHAR(50) BINARY NOT NULL DEFAULT '',
* type INT(11) NOT NULL DEFAULT '0',
* SID VARCHAR(255) NOT NULL DEFAULT '',
* home VARCHAR(255) NOT NULL DEFAULT '',
* PRIMARY KEY (username)
* );
*
* CREATE TABLE alias (
* alias VARCHAR(255) NOT NULL DEFAULT '',
* dest LONGTEXT,
* username VARCHAR(50) NOT NULL DEFAULT '',
* status INT(11) NOT NULL DEFAULT '1',
* PRIMARY KEY (alias)
* );
*
* CREATE TABLE domain (
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* prefix VARCHAR(50) NOT NULL DEFAULT '',
* maxaccounts INT(11) NOT NULL DEFAULT '20',
* quota INT(10) NOT NULL DEFAULT '20000',
* transport VARCHAR(255) NOT NULL DEFAULT 'cyrus',
* freenames ENUM('YES','NO') NOT NULL DEFAULT 'NO',
* freeaddress ENUM('YES','NO') NOT NULL DEFAULT 'NO',
* PRIMARY KEY (domain_name),
* UNIQUE KEY prefix (prefix)
* );
*
* CREATE TABLE domainadmin (
* domain_name VARCHAR(255) NOT NULL DEFAULT '',
* adminuser VARCHAR(255) NOT NULL DEFAULT ''
* );
*
* CREATE TABLE search (
* search_id VARCHAR(255) NOT NULL DEFAULT '',
* search_sql TEXT NOT NULL,
* perpage INT(11) NOT NULL DEFAULT '0',
* timestamp TIMESTAMP(14) NOT NULL,
* PRIMARY KEY (search_id),
* KEY search_id (search_id)
* );
*
* CREATE TABLE virtual (
* alias VARCHAR(255) NOT NULL DEFAULT '',
* dest LONGTEXT,
* username VARCHAR(50) NOT NULL DEFAULT '',
* status INT(11) NOT NULL DEFAULT '1',
* KEY alias (alias)
* );
*
* CREATE TABLE log (
* id INT(11) NOT NULL AUTO_INCREMENT,
* msg TEXT NOT NULL,
* user VARCHAR(255) NOT NULL DEFAULT '',
* host VARCHAR(255) NOT NULL DEFAULT '',
* time DATETIME NOT NULL DEFAULT '2000-00-00 00:00:00',
* pid VARCHAR(255) NOT NULL DEFAULT '',
* PRIMARY KEY (id)
* );
* </pre>
*
* $Horde: framework/Auth/Auth/cyrsql.php,v 1.33.10.14 2006/08/14 02:48:48 chuck Exp $
*
* Copyright 2002-2006 Ilya <mail@krel.org>
* Copyright 2005-2006 Jan Schneider <jan@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 Ilya <mail@krel.org>
* @author Jan Schneider <jan@horde.org>
* @since Horde 3.0
* @package Horde_Auth
*/
class Auth_cyrsql extends Auth_sql {
/**
* Handle for the current IMAP connection.
*
* @var resource
*/
var $_imapStream;
/**
* Handle for an IMAP_Admin object.
*
* @var IMAP_Admin
*/
var $_admin;
/**
* Hierarchy separator to use (e.g., is it user/mailbox or user.mailbox)
*
* @var string
*/
var $_separator = '.';
/**
* Constructor.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_cyrsql($params = array())
{
if (!Util::extensionExists('imap')) {
Horde::fatal(_("Auth_cyrsql: Required imap extension not found."), __FILE__, __LINE__);
}
parent::Auth_sql($params);
$admin_params = array('admin_user' => $params['cyradmin'],
'admin_password' => $params['cyrpass'],
'dsn' => $params['imap_dsn']);
if (!empty($this->_params['unixhier'])) {
$admin_params['userhierarchy'] = 'user/';
}
$this->_admin = &new IMAP_Admin($admin_params);
}
/**
* 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();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $userId);
/* Build the SQL query. */
$query = sprintf('INSERT INTO %s (%s, %s, %s) VALUES (?, ?, ?)',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['domain_field'],
$this->_params['password_field']);
$values = array($name,
$domain,
$this->getCryptedPassword($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption']));
Horde::logMessage('SQL Query by Auth_cyrsql::addUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$dbresult = $this->_db->query($query, $values);
$query = 'INSERT INTO virtual (alias, dest, username, status) VALUES (?, ?, ?, 1)';
$values = array($userId, $name, $name);
Horde::logMessage('SQL Query by Auth_cyrsql::addUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$dbresult2 = $this->_db->query($query, $values);
if (is_a($dbresult2, 'PEAR_Error')) {
return $dbresult2;
}
} else {
$dbresult = parent::addUser($userId, $credentials);
$name = $userId;
}
if (is_a($dbresult, 'PEAR_Error')) {
return $dbresult;
}
if (!is_a($result = $this->_admin->addMailbox($name), 'PEAR_Error')) {
@array_walk($this->_params['folders'],
array($this, '_createSubFolders'), $name);
} else {
Horde::logMessage('IMAP mailbox creation for ' . $name . ' failed: ' . $result->getMessage(),
__FILE__, __LINE__, PEAR_LOG_ERR);
return PEAR::raiseError(sprintf(_("IMAP mailbox creation failed: %s"), $result->getMessage()));
}
if (isset($this->_params['quota']) && $this->_params['quota'] >= 0) {
if (!@imap_set_quota($this->_imapStream,
'user' . $this->_separator . $name,
$this->_params['quota'])) {
return PEAR::raiseError(sprintf(_("IMAP mailbox quota creation failed: %s"), imap_last_error()));
}
}
return true;
}
/**
* Delete a set of authentication credentials.
*
* @param string $userId The userId to delete.
*
* @return boolean Success or failure.
*/
function removeUser($userId)
{
$this->_connect();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $userId);
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE %s = ? and %s = ?',
$this->_params['table'],
$this->_params['username_field'],
$this->_params['domain_field']);
$values = array($name, $domain);
Horde::logMessage('SQL Query by Auth_cyrsql::removeUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$dbresult = $this->_db->query($query, $values);
$query = 'DELETE FROM virtual WHERE dest = ?';
$values = array($name);
Horde::logMessage('SQL Query by Auth_cyrsql::removeUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$dbresult2 = $this->_db->query($query, $values);
if (is_a($dbresult2, 'PEAR_Error')) {
return $dbresult2;
}
} else {
$dbresult = parent::removeUser($userId);
$name = $userId;
}
if (is_a($dbresult, 'PEAR_Error')) {
return $dbresult;
}
/* Delete IMAP mailbox. */
$imapresult = $this->_admin->removeMailbox($name);
if (is_a($imapresult, 'PEAR_Error')) {
return PEAR::raiseError(sprintf(_("IMAP mailbox deletion failed: %s"), $imapresult->getMessage()));
}
return $this->removeUserData($userId);
}
/**
* Attempts to open connections to the SQL and IMAP servers.
*
* @access private
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function _connect()
{
if (!$this->_connected) {
parent::_connect();
// Reset the $_connected flag; we haven't yet successfully opened
// everything.
$this->_connected = false;
$this->_imapStream = @imap_open($this->_params['imap_dsn'], $this->_params['cyradmin'], $this->_params['cyrpass'], OP_HALFOPEN);
if (!$this->_imapStream) {
Horde::fatal(sprintf(_("Can't connect to IMAP server: %s"), imap_last_error()), __FILE__, __LINE__);
}
if (!empty($this->_params['unixhier'])) {
$this->_separator = '/';
}
$this->_connected = true;
}
return true;
}
/**
* Disconnect from the SQL and IMAP servers and clean up the connections.
*
* @access private
*
* @return boolean True on success, false on failure.
*/
function _disconnect()
{
if ($this->_connected) {
parent::_disconnect();
@imap_close($this->_imapStream);
}
return true;
}
/**
* Creates all mailboxes supplied in configuration
*
* @access private
*
* @param string $value
* @param string $key Unused by this driver
* @param string userName
*/
function _createSubFolders($value, $key, $userName)
{
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($userName) = explode('@', $userName);
}
$this->_admin->addMailbox($userName . $this->_separator . $value);
}
/**
* 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();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
/* Build the SQL query with domain. */
$query = sprintf('SELECT %s, %s FROM %s ORDER BY %s',
$this->_params['username_field'],
$this->_params['domain_field'],
$this->_params['table'],
$this->_params['username_field']);
} else {
/* Build the SQL query without domain. */
$query = sprintf('SELECT %s FROM %s ORDER BY %s',
$this->_params['username_field'],
$this->_params['table'],
$this->_params['username_field']);
}
Horde::logMessage('SQL Query by Auth_cyrsql::listUsers(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
$result = $this->_db->getAll($query, null, DB_FETCHMODE_ORDERED);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
/* Loop through and build return array. */
$users = array();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
foreach ($result as $ar) {
$users[] = $ar[0] . '@' . $ar[1];
}
} else {
foreach ($result as $ar) {
$users[] = $ar[0];
}
}
return $users;
}
/**
* 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();
if (!empty($this->_params['domain_field']) &&
($this->_params['domain_field'] != 'none')) {
list($name, $domain) = explode('@', $oldID);
/* Build the SQL query with domain. */
$query = sprintf('UPDATE %s SET %s = ? WHERE %s = ? and %s = ?',
$this->_params['table'],
$this->_params['password_field'],
$this->_params['username_field'],
$this->_params['domain_field']);
$values = array($this->getCryptedPassword($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption']),
$name, $domain);
} else {
/* 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($credentials['password'],
'',
$this->_params['encryption'],
$this->_params['show_encryption']),
$oldID);
}
Horde::logMessage('SQL Query by Auth_cyrsql::updateUser(): ' . $query, __FILE__, __LINE__, PEAR_LOG_DEBUG);
return $this->_db->query($query, $values);
}
}
|
