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
|
<?php
/**
* Ingo_Driver_ldap:: Implements the Sieve_Driver api to allow scripts to be
* installed and set active via an LDAP server.
*
* $Horde: ingo/lib/Driver/ldap.php,v 1.8.2.4 2007/12/20 14:05:47 jan Exp $
*
* See the enclosed file LICENSE for license information (ASL). If you
* did not receive this file, see http://www.horde.org/licenses/asl.php.
*
* @author Jason M. Felice <jason.m.felice@gmail.com>
* @since Ingo 1.1
* @package Ingo
*/
class Ingo_Driver_ldap extends Ingo_Driver {
/**
* Constructor.
*/
function Ingo_Driver_ldap($params = array())
{
if (!Util::extensionExists('ldap')) {
Horde::fatal(PEAR::raiseError(_("LDAP support is required but the LDAP module is not available or not loaded.")), __FILE__, __LINE__);
}
$default_params = array('hostspec' => 'localhost',
'port' => 389,
'script_attribute' => 'mailSieveRuleSource');
$this->_params = array_merge($this->_params, $default_params, $params);
}
/**
* Create a DN from a DN template.
*
* This is done by substituting the username for %u and the 'dc='
* components for %d.
*
* @access private
*
* @param string $templ The DN template (from the config).
*
* @return string The resulting DN.
*/
function _substUser($templ)
{
$domain = '';
$username = $this->_params['username'];
if (strpos($username, '@') !== false) {
list($username, $domain) = explode('@', $username);
}
$domain = implode(', dc=', explode('.', $domain));
if (!empty($domain)) {
$domain = 'dc=' . $domain;
}
if (preg_match('/^\s|\s$|\s\s|[,+="\r\n<>#;]/', $username)) {
$username = '"' . str_replace('"', '\\"', $username) . '"';
}
return str_replace(array('%u', '%d'),
array($username, $domain),
$templ);
}
/**
* Connect and bind to ldap server.
*/
function _connect()
{
if (!($ldapcn = @ldap_connect($this->_params['hostspec'],
$this->_params['port']))) {
return PEAR::raiseError(_("Connection failure"));
}
/* Set the LDAP protocol version. */
if (!empty($this->_params['version'])) {
@ldap_set_option($ldapcn,
LDAP_OPT_PROTOCOL_VERSION,
$this->_params['version']);
}
/* Start TLS if we're using it. */
if (!empty($this->_params['tls'])) {
if (!@ldap_start_tls($ldapcn)) {
return PEAR::raiseError(sprintf(_("STARTTLS failed: (%s) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
}
/* Bind to the server. */
if (isset($this->_params['bind_dn'])) {
$bind_dn = $this->_substUser($this->_params['bind_dn']);
if (is_a($bind_dn, 'PEAR_Error')) {
return $bind_dn;
}
if (isset($this->_params['bind_password'])) {
$password = $this->_params['bind_password'];
} else {
$password = $this->_params['password'];
}
if (!@ldap_bind($ldapcn, $bind_dn, $password)) {
return PEAR::raiseError(sprintf(_("Bind failed: (%s) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
} elseif (!(@ldap_bind($ldapcn))) {
return PEAR::raiseError(sprintf(_("Bind failed: (%s) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
return $ldapcn;
}
/**
* Retrieve current user's scripts.
*
* @access private
*
* @param resource $ldapcn The connection to the LDAP server.
* @param string $userDN Set to the user object's real DN.
*
* @return mixed Array of script sources, or PEAR_Error on failure.
*/
function _getScripts($ldapcn, &$userDN)
{
$attrs = array($this->_params['script_attribute'], 'dn');
$filter = $this->_substUser($this->_params['script_filter']);
/* Find the user object. */
$sr = @ldap_search($ldapcn, $this->_params['script_base'], $filter,
$attrs);
if ($sr === false) {
return PEAR::raiseError(sprintf(_("Error retrieving current script: (%d) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
if (@ldap_count_entries($ldapcn, $sr) != 1) {
return PEAR::raiseError(sprintf(_("Expected 1 object, got %d."),
ldap_count_entries($ldapcn, $sr)));
}
$ent = @ldap_first_entry($ldapcn, $sr);
if ($ent === false) {
return PEAR::raiseError(sprintf(_("Error retrieving current script: (%d) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
/* Retrieve the user's DN. */
$v = @ldap_get_dn($ldapcn, $ent);
if ($v === false) {
@ldap_free_result($sr);
return PEAR::raiseError(sprintf(_("Error retrieving current script: (%d) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
$userDN = $v;
/* Retrieve the user's scripts. */
$attrs = @ldap_get_attributes($ldapcn, $ent);
@ldap_free_result($sr);
if ($attrs === false) {
return PEAR::raiseError(sprintf(_("Error retrieving current script: (%d) %s"),
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
/* Attribute can be in any case, and can have a ";binary"
* specifier. */
$regexp = '/^' . preg_quote($this->_params['script_attribute'], '/') .
'(?:;.*)?$/i';
unset($attrs['count']);
foreach ($attrs as $name => $values) {
if (preg_match($regexp, $name)) {
unset($values['count']);
return array_values($values);
}
}
return array();
}
/**
* Sets a script running on the backend.
*
* @param string $script The sieve script.
*
* @return mixed True on success, PEAR_Error on error.
*/
function setScriptActive($script)
{
$ldapcn = $this->_connect();
if (is_a($ldapcn, 'PEAR_Error')) {
return $ldapcn;
}
$values = $this->_getScripts($ldapcn, $userDN);
if (is_a($values, 'PEAR_Error')) {
return $values;
}
$found = false;
foreach ($values as $i => $value) {
if (strpos($value, "# Sieve Filter\n") !== false) {
if (empty($script)) {
unset($values[$i]);
} else {
$values[$i] = $script;
}
$found = true;
break;
}
}
if (!$found && !empty($script)) {
$values[] = $script;
}
$replace = array(String::lower($this->_params['script_attribute']) => $values);
if (empty($values)) {
$r = @ldap_mod_del($ldapcn, $userDN, $replace);
} else {
$r = @ldap_mod_replace($ldapcn, $userDN, $replace);
}
if (!$r) {
return PEAR::raiseError(sprintf(_("Activating the script for \"%s\" failed: (%d) %s"),
$userDN,
ldap_errno($ldapcn),
ldap_error($ldapcn)));
}
@ldap_close($ldapcn);
return true;
}
/**
* Returns the content of the currently active script.
*
* @return string The complete ruleset of the specified user.
*/
function getScript()
{
$ldapcn = $this->_connect();
if (is_a($ldapcn, 'PEAR_Error')) {
return $ldapcn;
}
$values = $this->_getScripts($ldapcn, $userDN);
if (is_a($values, 'PEAR_Error')) {
return $values;
}
$script = '';
foreach ($values as $value) {
if (strpos($value, "# Sieve Filter\n") !== false) {
$script = $value;
break;
}
}
@ldap_close($ldapcn);
return $script;
}
}
|
