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
|
<?php
/**
* The Auth_cyrus class provides horde with the ability of administrating
* a Cyrus mail server authentications against another backend that Horde
* can update (eg SQL or LDAP).
*
* 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})
* 'backend' The complete hash for the Auth_* driver that cyrus
* authenticates against (eg SQL, LDAP).
* 'separator' Hierarchy separator to use (e.g., is it user/mailbox or
* user.mailbox)</pre>
*
* Optional values:<pre>
* 'unixhier' The value of imapd.conf's unixhierarchysep setting.
* Set this to 'true' if the value is true in imapd.conf
* 'folders' An array of folders to create under username.
* Doesn't create subfolders by default.
* 'quota' The quota (in kilobytes) to grant on the mailbox.
* Does not establish quota by default.</pre>
*
* Example Usage:<pre>
* $conf['auth']['driver'] = 'composite';
* $conf['auth']['params']['loginscreen_switch'] = '_horde_select_loginscreen';
* $conf['auth']['params']['admin_driver'] = 'cyrus';
* $conf['auth']['params']['drivers']['imp'] = array('driver' => 'application',
* 'params' => array('app' => 'imp'));
* $conf['auth']['params']['drivers']['cyrus'] = array('driver' => 'cyrus',
* 'params' => array('cyradmin' => 'cyrus',
* 'cyrpass' => 'password',
* 'separator' => '.',
* 'imap_dsn' => '{maik.example.com/imap}'));
* $conf['auth']['params']['drivers']['cyrus']['params']['backend'] = array('driver' => 'sql',
* 'params' => array('phptype' => 'mysql',
* 'hostspec' => 'database.example.com',
* 'protocol' => 'tcp',
* 'username' => 'username',
* 'password' => 'password',
* 'database' => 'mail',
* 'table' => 'accountuser',
* 'encryption' => 'md5-hex',
* 'username_field' => 'username',
* 'password_field' => 'password'));
*
* if (!function_exists('_horde_select_loginscreen')) {
* function _horde_select_loginscreen() {
* return 'imp';
* }
* }</pre>
*
* $Horde: framework/Auth/Auth/cyrus.php,v 1.15.10.14 2006/08/14 02:48:48 chuck Exp $
*
* Copyright 2002-2006 Ilya <mail@krel.org>
* Copyright 2003-2006 Mike Cochrane <mike@graftonhall.co.nz>
*
* 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 Mike Cochrane <mike@graftonhall.co.nz>
* @since Horde 3.0
* @package Horde_Auth
*/
class Auth_cyrus extends Auth {
/**
* Handle for the current IMAP connection.
*
* @var resource
*/
var $_imapStream;
/**
* Flag indicating if the IMAP connection is connected.
*
* @var boolean
*/
var $_connected;
/**
* Pointer to another Auth_ backend that Cyrus authenticates against.
*
* @var Auth
*/
var $_backend;
/**
* 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' => false,
'groups' => false,
'transparent' => false);
/**
* Constructor.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_cyrus($params = array())
{
$this->_params = $params;
if (!isset($this->_params['separator'])) {
$this->_params['separator'] = '.';
}
if (isset($this->_params['unixhier']) && $this->_params['unixhier'] == true) {
$this->_params['separator'] = '/';
}
if (!Util::extensionExists('imap')) {
Horde::fatal(_("Auth_cyrus: Required imap extension not found."), __FILE__, __LINE__);
}
// Create backend instance.
$this->_backend = &Auth::singleton($this->_params['backend']['driver'], $this->_params['backend']['params']);
if (is_a($this->_backend, 'PEAR_Error')) {
return $this->_backend;
}
// Check the capabilities of the backend.
if (!$this->_backend->hasCapability('add') ||
!$this->_backend->hasCapability('update') ||
!$this->_backend->hasCapability('remove')) {
Horde::fatal(_("Auth_cyrus: Backend does not have required capabilites."), __FILE__, __LINE__);
}
$this->capabilities['list'] = $this->_backend->hasCapability('list');
$this->capabilities['groups'] = $this->_backend->hasCapability('groups');
$this->capabilities['transparent'] = $this->_backend->hasCapability('transparent');
}
/**
* 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();
$res = $this->_backend->addUser($userId, $credentials);
if (is_a($res, 'PEAR_Error')) {
return $res;
}
$name = imap_utf7_encode($userId);
if (@imap_createmailbox($this->_imapStream,
imap_utf7_encode($this->_params['imap_dsn'] .
'user' . $this->_params['separator'] . $name))) {
if (isset($this->_params['folders']) && is_array($this->_params['folders'])) {
foreach ($this->_params['folders'] as $folder) {
$this->_createSubFolder($name, $folder);
}
}
} else {
Horde::logMessage('IMAP mailbox creation for ' . $name . ' failed ',
__FILE__, __LINE__, PEAR_LOG_ERR);
return PEAR::raiseError(sprintf(_("IMAP mailbox creation failed: %s"), imap_last_error()));
}
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();
$res = $this->_backend->removeUser($userId);
if (is_a($res, 'PEAR_Error')) {
return $res;
}
/* Set ACL for mailbox deletion. */
list($admin) = explode('@', $this->_params['cyradmin']);
@imap_setacl($this->_imapStream,
'user' . $this->_params['separator'] . $userId,
$admin, 'lrswipcda');
/* Delete IMAP mailbox. */
$imapresult = @imap_deletemailbox($this->_imapStream,
$this->_params['imap_dsn'] .
'user' . $this->_params['separator'] . $userId);
if (!$imapresult) {
return PEAR::raiseError(sprintf(_("IMAP mailbox deletion failed: %s"), imap_last_error()));
}
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) {
$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__);
}
$this->_connected = true;
}
return true;
}
/**
* Disconnect from the IMAP server.
*
* @access private
*
* @return boolean True on success, false on failure.
*/
function _disconnect()
{
if ($this->_connected) {
@imap_close($this->_imapStream);
}
return true;
}
/**
* Creates a mailboxes supplied in configuration
*
* @access private
*
* @param string $userName For whom the folder will be created
* @param string $folderName Name of folder to create
*/
function _createSubFolder($userName, $folderName)
{
@imap_createmailbox($this->_imapStream,
imap_utf7_encode($this->_params['imap_dsn'] .
'user' . $this->_params['separator'] . $userName .
$this->_params['separator'] . $folderName));
}
/**
* List all users in the system.
*
* @return mixed The array of userIds, or false on failure/unsupported.
*/
function listUsers()
{
return $this->_backend->listUsers();
}
/**
* 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)
{
return $this->_backend->updateUser($oldID, $newID, $credentials);
}
/**
* Return the URI of the login screen for this authentication method.
*
* @access private
*
* @param string $app The application to use.
* @param string $url The URL to redirect to after login.
*
* @return string The login screen URI.
*/
function _getLoginScreen($app = 'horde', $url = '')
{
return $this->_backend->_getLoginScreen($app, $url);
}
/**
* Checks if a userId exists in the sistem.
*
* @return boolean Whether or not the userId already exists.
*/
function exists($userId)
{
return $this->_backend->exists($userId);
}
/**
* Automatic authentication: Find out if the client matches an allowed IP
* block.
*
* @return boolean Whether or not the client is allowed.
*/
function transparent()
{
return $this->_backend->transparent();
}
}
|
