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
|
<?php
/**
* The Auth_imap:: class provides an IMAP implementation of the Horde
* authentication system.
*
* Optional parameters:<pre>
* 'hostspec' The hostname or IP address of the server.
* DEFAULT: 'localhost'
* 'port' The server port to which we will connect.
* IMAP is generally 143, while IMAP-SSL is generally 993.
* DEFAULT: 143
* 'protocol' The connection protocol (e.g. 'imap', 'pop3', 'nntp').
* Protocol is one of 'imap/notls' (or only 'imap' if you
* have a c-client version 2000c or older), 'imap/ssl',
* or 'imap/ssl/novalidate-cert' (for a self-signed
* certificate).
* DEFAULT: 'imap'
* 'admin_user' The name of a user with admin privileges.
* DEFAULT: null
* 'admin_password' The password of the adminstrator.
* DEFAULT: null
* 'userhierarchy' The hierarchy where user mailboxes are stored.
* DEFAULT: 'user.'
* 'dsn' The full IMAP connection string.
* If not present, this is built from 'hostspec', 'port'
* and 'protocol' parameters.</pre>
*
*
* If setting up as Horde auth handler in conf.php, this is a sample entry:<pre>
* $conf['auth']['params']['hostspec'] = 'imap.example.com';
* $conf['auth']['params']['port'] = 143;
* $conf['auth']['params']['protocol'] = 'imap/notls/novalidate-cert';</pre>
*
*
* $Horde: framework/Auth/Auth/imap.php,v 1.28.10.9 2006/05/31 19:39:48 slusarz Exp $
*
* Copyright 1999-2006 Chuck Hagenbuch <chuck@horde.org>
* Copyright 1999-2006 Gaudenz Steinlin <gaudenz.steinlin@id.unibe.ch>
* Copyright 2004-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 Chuck Hagenbuch <chuck@horde.org>
* @author Gaudenz Steinlin <gaudenz.steinlin@id.unibe.ch>
* @author Jan Schneider <jan@horde.org>
* @since Horde 1.3
* @package Horde_Auth
*/
class Auth_imap extends Auth {
/**
* Constructs a new IMAP authentication object.
*
* @param array $params A hash containing connection parameters.
*/
function Auth_imap($params = array())
{
if (!Util::extensionExists('imap')) {
Horde::fatal(_("Auth_imap: Required IMAP extension not found."), __FILE__, __LINE__);
}
$default_params = array(
'hostspec' => 'localhost',
'port' => '143',
'protocol' => 'imap',
'userhierarchy' => 'user.'
);
$this->_params = array_merge($default_params, $params);
if (!empty($this->_params['admin_user'])) {
$this->capabilities['add'] = true;
$this->capabilities['remove'] = true;
$this->capabilities['list'] = true;
}
/* Create DSN string. */
if (!isset($this->_params['dsn'])) {
$this->_params['dsn'] = sprintf('{%s:%d/%s}',
$this->_params['hostspec'],
$this->_params['port'],
$this->_params['protocol']);
}
}
/**
* Find out if a set of login credentials are valid.
*
* @access private
*
* @param string $userId The userId to check.
* @param array $credentials An array of login credentials. For IMAP,
* this must contain a password entry.
*
* @return boolean Whether or not the credentials are valid.
*/
function _authenticate($userId, $credentials)
{
if (empty($credentials['password'])) {
Horde::fatal(_("No password provided for IMAP authentication."), __FILE__, __LINE__);
}
$imap = @imap_open($this->_params['dsn'], $userId,
$credentials['password'], OP_HALFOPEN);
if ($imap) {
@imap_close($imap);
return true;
} else {
$this->_setAuthError(AUTH_REASON_BADLOGIN);
return false;
}
}
/**
* Add a set of authentication credentials.
*
* @param string $userId The userId to add.
* @param array $credentials The credentials to use.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function addUser($userId, $credentials)
{
require_once 'Horde/IMAP/Admin.php';
$imap = &new IMAP_Admin($this->_params);
return $imap->addMailbox(String::convertCharset($userId, NLS::getCharset(), 'utf7-imap'));
}
/**
* Delete a set of authentication credentials.
*
* @param string $userId The userId to delete.
*
* @return mixed True on success or a PEAR_Error object on failure.
*/
function removeUser($userId)
{
require_once 'Horde/IMAP/Admin.php';
$imap = &new IMAP_Admin($this->_params);
$result = $imap->removeMailbox(String::convertCharset($userId, NLS::getCharset(), 'utf7-imap'));
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 a PEAR_Error object on failure.
*/
function listUsers()
{
require_once 'Horde/IMAP/Admin.php';
$imap = &new IMAP_Admin($this->_params);
return $imap->listMailboxes();
}
}
|
