Solaris build fix for Oracle's LDAP libraries.
[exim.git] / src / src / lookups / ldap.c
CommitLineData
0a49a7a4 1/* $Cambridge: exim/src/src/lookups/ldap.c,v 1.15 2009/11/16 19:50:38 nm4 Exp $ */
0756eb3c
PH
2
3/*************************************************
4* Exim - an Internet mail transport agent *
5*************************************************/
6
0a49a7a4 7/* Copyright (c) University of Cambridge 1995 - 2009 */
0756eb3c
PH
8/* See the file NOTICE for conditions of use and distribution. */
9
10/* Many thanks to Stuart Lynne for contributing the original code for this
11driver. Further contibutions from Michael Haardt, Brian Candler, Barry
12Pederson, Peter Savitch and Christian Kellner. Particular thanks to Brian for
13researching how to handle the different kinds of error. */
14
15
16#include "../exim.h"
17#include "lf_functions.h"
0756eb3c
PH
18
19
765b530f
PH
20/* Include LDAP headers. The code below uses some "old" LDAP interfaces that
21are deprecated in OpenLDAP. I don't know their status in other LDAP
22implementations. LDAP_DEPRECATED causes their prototypes to be defined in
23ldap.h. */
24
25#define LDAP_DEPRECATED 1
0756eb3c
PH
26
27#include <lber.h>
28#include <ldap.h>
29
30
31/* Annoyingly, the different LDAP libraries handle errors in different ways,
32and some other things too. There doesn't seem to be an automatic way of
33distinguishing between them. Local/Makefile should contain a setting of
34LDAP_LIB_TYPE, which in turn causes appropriate macros to be defined for the
35different kinds. Those that matter are:
36
37LDAP_LIB_NETSCAPE
38LDAP_LIB_SOLARIS with synonym LDAP_LIB_SOLARIS7
39LDAP_LIB_OPENLDAP2
40
41These others may be defined, but are in fact the default, so are not tested:
42
43LDAP_LIB_UMICHIGAN
44LDAP_LIB_OPENLDAP1
45*/
46
47#if defined(LDAP_LIB_SOLARIS7) && ! defined(LDAP_LIB_SOLARIS)
48#define LDAP_LIB_SOLARIS
49#endif
50
51
52/* Just in case LDAP_NO_LIMIT is not defined by some of these libraries. */
53
54#ifndef LDAP_NO_LIMIT
55#define LDAP_NO_LIMIT 0
56#endif
57
58
59/* Just in case LDAP_DEREF_NEVER is not defined */
60
61#ifndef LDAP_DEREF_NEVER
62#define LDAP_DEREF_NEVER 0
63#endif
64
65
0756eb3c
PH
66/* Four types of LDAP search are implemented */
67
68#define SEARCH_LDAP_MULTIPLE 0 /* Get attributes from multiple entries */
69#define SEARCH_LDAP_SINGLE 1 /* Get attributes from one entry only */
70#define SEARCH_LDAP_DN 2 /* Get just the DN from one entry */
71#define SEARCH_LDAP_AUTH 3 /* Just checking for authentication */
72
73/* In all 4 cases, the DN is left in $ldap_dn (which post-dates the
74SEARCH_LDAP_DN lookup). */
75
76
77/* Structure and anchor for caching connections. */
78
79typedef struct ldap_connection {
80 struct ldap_connection *next;
81 uschar *host;
82 uschar *user;
83 uschar *password;
84 BOOL bound;
85 int port;
86 LDAP *ld;
87} LDAP_CONNECTION;
88
89static LDAP_CONNECTION *ldap_connections = NULL;
90
91
92
93/*************************************************
94* Internal search function *
95*************************************************/
96
97/* This is the function that actually does the work. It is called (indirectly
98via control_ldap_search) from eldap_find(), eldapauth_find(), eldapdn_find(),
99and eldapm_find(), with a difference in the "search_type" argument.
100
101The case of eldapauth_find() is special in that all it does is do
102authentication, returning OK or FAIL as appropriate. This isn't used as a
103lookup. Instead, it is called from expand.c as an expansion condition test.
104
105The DN from a successful lookup is placed in $ldap_dn. This feature postdates
106the provision of the SEARCH_LDAP_DN facility for returning just the DN as the
107data.
108
109Arguments:
110 ldap_url the URL to be looked up
111 server server host name, when URL contains none
112 s_port server port, used when URL contains no name
113 search_type SEARCH_LDAP_MULTIPLE allows values from multiple entries
114 SEARCH_LDAP_SINGLE allows values from one entry only
115 SEARCH_LDAP_DN gets the DN from one entry
116 res set to point at the result (not used for ldapauth)
117 errmsg set to point a message if result is not OK
118 defer_break set TRUE if no more servers to be tried after a DEFER
119 user user name for authentication, or NULL
120 password password for authentication, or NULL
121 sizelimit max number of entries returned, or 0 for no limit
122 timelimit max time to wait, or 0 for no limit
d00328e2 123 tcplimit max time for network activity, e.g. connect, or 0 for OS default
0756eb3c
PH
124 deference the dereference option, which is one of
125 LDAP_DEREF_{NEVER,SEARCHING,FINDING,ALWAYS}
6ec97b1b 126 referrals the referral option, which is LDAP_OPT_ON or LDAP_OPT_OFF
0756eb3c
PH
127
128Returns: OK or FAIL or DEFER
129 FAIL is given only if a lookup was performed successfully, but
130 returned no data.
131*/
132
133static int
134perform_ldap_search(uschar *ldap_url, uschar *server, int s_port, int search_type,
135 uschar **res, uschar **errmsg, BOOL *defer_break, uschar *user, uschar *password,
6ec97b1b 136 int sizelimit, int timelimit, int tcplimit, int dereference, void *referrals)
0756eb3c
PH
137{
138LDAPURLDesc *ludp = NULL;
139LDAPMessage *result = NULL;
140BerElement *ber;
141LDAP_CONNECTION *lcp;
142
143struct timeval timeout;
144struct timeval *timeoutptr = NULL;
145
146uschar *attr;
147uschar **attrp;
148uschar *data = NULL;
149uschar *dn = NULL;
150uschar *host;
151uschar **values;
152uschar **firstval;
153uschar porttext[16];
154
155uschar *error1 = NULL; /* string representation of errcode (static) */
156uschar *error2 = NULL; /* error message from the server */
157uschar *matched = NULL; /* partially matched DN */
158
159int attr_count = 0;
160int error_yield = DEFER;
161int msgid;
d38f8232 162int rc, ldap_rc, ldap_parse_rc;
0756eb3c
PH
163int port;
164int ptr = 0;
165int rescount = 0;
166int size = 0;
167BOOL attribute_found = FALSE;
168BOOL ldapi = FALSE;
169
170DEBUG(D_lookup)
171 debug_printf("perform_ldap_search: ldap%s URL = \"%s\" server=%s port=%d "
172 "sizelimit=%d timelimit=%d tcplimit=%d\n",
173 (search_type == SEARCH_LDAP_MULTIPLE)? "m" :
174 (search_type == SEARCH_LDAP_DN)? "dn" :
175 (search_type == SEARCH_LDAP_AUTH)? "auth" : "",
176 ldap_url, server, s_port, sizelimit, timelimit, tcplimit);
177
178/* Check if LDAP thinks the URL is a valid LDAP URL. We assume that if the LDAP
179library that is in use doesn't recognize, say, "ldapi", it will barf here. */
180
181if (!ldap_is_ldap_url(CS ldap_url))
182 {
183 *errmsg = string_sprintf("ldap_is_ldap_url: not an LDAP url \"%s\"\n",
184 ldap_url);
185 goto RETURN_ERROR_BREAK;
186 }
187
188/* Parse the URL */
189
190if ((rc = ldap_url_parse(CS ldap_url, &ludp)) != 0)
191 {
192 *errmsg = string_sprintf("ldap_url_parse: (error %d) parsing \"%s\"\n", rc,
193 ldap_url);
194 goto RETURN_ERROR_BREAK;
195 }
196
197/* If the host name is empty, take it from the separate argument, if one is
198given. OpenLDAP 2.0.6 sets an unset hostname to "" rather than empty, but
199expects NULL later in ldap_init() to mean "default", annoyingly. In OpenLDAP
2002.0.11 this has changed (it uses NULL). */
201
202if ((ludp->lud_host == NULL || ludp->lud_host[0] == 0) && server != NULL)
203 {
204 host = server;
205 port = s_port;
206 }
207else
208 {
209 host = US ludp->lud_host;
210 if (host != NULL && host[0] == 0) host = NULL;
211 port = ludp->lud_port;
212 }
213
214DEBUG(D_lookup) debug_printf("after ldap_url_parse: host=%s port=%d\n",
215 host, port);
216
217if (port == 0) port = LDAP_PORT; /* Default if none given */
218sprintf(CS porttext, ":%d", port); /* For messages */
219
220/* If the "host name" is actually a path, we are going to connect using a Unix
221socket, regardless of whether "ldapi" was actually specified or not. This means
222that a Unix socket can be declared in eldap_default_servers, and "traditional"
223LDAP queries using just "ldap" can be used ("ldaps" is similarly overridden).
224The path may start with "/" or it may already be escaped as "%2F" if it was
225actually declared that way in eldap_default_servers. (I did it that way the
226first time.) If the host name is not a path, the use of "ldapi" causes an
227error, except in the default case. (But lud_scheme doesn't seem to exist in
228older libraries.) */
229
230if (host != NULL)
231 {
232 if ((host[0] == '/' || Ustrncmp(host, "%2F", 3) == 0))
233 {
234 ldapi = TRUE;
235 porttext[0] = 0; /* Remove port from messages */
236 }
237
238 #if defined LDAP_LIB_OPENLDAP2
239 else if (strncmp(ludp->lud_scheme, "ldapi", 5) == 0)
240 {
241 *errmsg = string_sprintf("ldapi requires an absolute path (\"%s\" given)",
242 host);
243 goto RETURN_ERROR;
244 }
245 #endif
246 }
247
248/* Count the attributes; we need this later to tell us how to format results */
249
250for (attrp = USS ludp->lud_attrs; attrp != NULL && *attrp != NULL; attrp++)
251 attr_count++;
252
253/* See if we can find a cached connection to this host. The port is not
254relevant for ldapi. The host name pointer is set to NULL if no host was given
255(implying the library default), rather than to the empty string. Note that in
256this case, there is no difference between ldap and ldapi. */
257
258for (lcp = ldap_connections; lcp != NULL; lcp = lcp->next)
259 {
260 if ((host == NULL) != (lcp->host == NULL) ||
261 (host != NULL && strcmpic(lcp->host, host) != 0))
262 continue;
263 if (ldapi || port == lcp->port) break;
264 }
265
d00328e2
PH
266/* Use this network timeout in any requests. */
267
268if (tcplimit > 0)
269 {
270 timeout.tv_sec = tcplimit;
271 timeout.tv_usec = 0;
272 timeoutptr = &timeout;
273 }
274
0756eb3c
PH
275/* If no cached connection found, we must open a connection to the server. If
276the server name is actually an absolute path, we set ldapi=TRUE above. This
277requests connection via a Unix socket. However, as far as I know, only OpenLDAP
278supports the use of sockets, and the use of ldap_initialize(). */
279
280if (lcp == NULL)
281 {
282 LDAP *ld;
283
284
285 /* --------------------------- OpenLDAP ------------------------ */
286
287 /* There seems to be a preference under OpenLDAP for ldap_initialize()
288 instead of ldap_init(), though I have as yet been unable to find
289 documentation that says this. (OpenLDAP documentation is sparse to
290 non-existent). So we handle OpenLDAP differently here. Also, support for
291 ldapi seems to be OpenLDAP-only at present. */
292
293 #ifdef LDAP_LIB_OPENLDAP2
294
295 /* We now need an empty string for the default host. Get some store in which
296 to build a URL for ldap_initialize(). In the ldapi case, it can't be bigger
297 than (9 + 3*Ustrlen(shost)), whereas in the other cases it can't be bigger
298 than the host name + "ldaps:///" plus : and a port number, say 20 + the
299 length of the host name. What we get should accommodate both, easily. */
300
301 uschar *shost = (host == NULL)? US"" : host;
302 uschar *init_url = store_get(20 + 3 * Ustrlen(shost));
303 uschar *init_ptr;
304
305 /* Handle connection via Unix socket ("ldapi"). We build a basic LDAP URI to
306 contain the path name, with slashes escaped as %2F. */
307
308 if (ldapi)
309 {
310 int ch;
311 init_ptr = init_url + 8;
312 Ustrcpy(init_url, "ldapi://");
313 while ((ch = *shost++) != 0)
314 {
315 if (ch == '/')
316 {
317 Ustrncpy(init_ptr, "%2F", 3);
318 init_ptr += 3;
319 }
320 else *init_ptr++ = ch;
321 }
322 *init_ptr = 0;
323 }
324
325 /* This is not an ldapi call. Just build a URI with the protocol type, host
326 name, and port. */
327
328 else
329 {
330 init_ptr = Ustrchr(ldap_url, '/');
331 Ustrncpy(init_url, ldap_url, init_ptr - ldap_url);
332 init_ptr = init_url + (init_ptr - ldap_url);
333 sprintf(CS init_ptr, "//%s:%d/", shost, port);
334 }
335
336 /* Call ldap_initialize() and check the result */
337
338 DEBUG(D_lookup) debug_printf("ldap_initialize with URL %s\n", init_url);
339 rc = ldap_initialize(&ld, CS init_url);
340 if (rc != LDAP_SUCCESS)
341 {
342 *errmsg = string_sprintf("ldap_initialize: (error %d) URL \"%s\"\n",
343 rc, init_url);
344 goto RETURN_ERROR;
345 }
346 store_reset(init_url); /* Might as well save memory when we can */
347
348
349 /* ------------------------- Not OpenLDAP ---------------------- */
350
351 /* For libraries other than OpenLDAP, use ldap_init(). */
352
353 #else /* LDAP_LIB_OPENLDAP2 */
354 ld = ldap_init(CS host, port);
355 #endif /* LDAP_LIB_OPENLDAP2 */
356
357 /* -------------------------------------------------------------- */
358
359
360 /* Handle failure to initialize */
361
362 if (ld == NULL)
363 {
364 *errmsg = string_sprintf("failed to initialize for LDAP server %s%s - %s",
365 host, porttext, strerror(errno));
366 goto RETURN_ERROR;
367 }
368
369 /* Set the TCP connect time limit if available. This is something that is
370 in Netscape SDK v4.1; I don't know about other libraries. */
371
372 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT
7c7ad977
PH
373 if (tcplimit > 0)
374 {
994a09e9 375 int timeout1000 = tcplimit*1000;
7c7ad977
PH
376 ldap_set_option(ld, LDAP_X_OPT_CONNECT_TIMEOUT, (void *)&timeout1000);
377 }
994a09e9
PH
378 else
379 {
380 int notimeout = LDAP_X_IO_TIMEOUT_NO_TIMEOUT;
381 ldap_set_option(ld, LDAP_X_OPT_CONNECT_TIMEOUT, (void *)&notimeout);
382 }
0756eb3c
PH
383 #endif
384
7c7ad977
PH
385 /* Set the TCP connect timeout. This works with OpenLDAP 2.2.14. */
386
387 #ifdef LDAP_OPT_NETWORK_TIMEOUT
388 if (tcplimit > 0)
389 ldap_set_option(ld, LDAP_OPT_NETWORK_TIMEOUT, (void *)timeoutptr);
8e669ac1 390 #endif
7c7ad977 391
0756eb3c
PH
392 /* I could not get TLS to work until I set the version to 3. That version
393 seems to be the default nowadays. The RFC is dated 1997, so I would hope
394 that all the LDAP libraries support it. Therefore, if eldap_version hasn't
395 been set, go for v3 if we can. */
396
397 if (eldap_version < 0)
398 {
399 #ifdef LDAP_VERSION3
400 eldap_version = LDAP_VERSION3;
401 #else
402 eldap_version = 2;
403 #endif
404 }
405
406 #ifdef LDAP_OPT_PROTOCOL_VERSION
407 ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, (void *)&eldap_version);
408 #endif
409
410 DEBUG(D_lookup) debug_printf("initialized for LDAP (v%d) server %s%s\n",
411 eldap_version, host, porttext);
412
413 /* If not using ldapi and TLS is available, set appropriate TLS options: hard
414 for "ldaps" and soft otherwise. */
415
416 #ifdef LDAP_OPT_X_TLS
417 if (!ldapi)
418 {
419 int tls_option;
420 if (strncmp(ludp->lud_scheme, "ldaps", 5) == 0)
421 {
422 tls_option = LDAP_OPT_X_TLS_HARD;
423 DEBUG(D_lookup) debug_printf("LDAP_OPT_X_TLS_HARD set\n");
424 }
425 else
426 {
427 tls_option = LDAP_OPT_X_TLS_TRY;
428 DEBUG(D_lookup) debug_printf("LDAP_OPT_X_TLS_TRY set\n");
429 }
430 ldap_set_option(ld, LDAP_OPT_X_TLS, (void *)&tls_option);
431 }
432 #endif /* LDAP_OPT_X_TLS */
433
bc19a55b
PP
434 #ifdef LDAP_OPT_X_TLS_CACERTFILE
435 if (eldap_ca_cert_file != NULL)
436 {
437 ldap_set_option(ld, LDAP_OPT_X_TLS_CACERTFILE, eldap_ca_cert_file);
438 }
439 #endif
440 #ifdef LDAP_OPT_X_TLS_CACERTDIR
441 if (eldap_ca_cert_dir != NULL)
442 {
443 ldap_set_option(ld, LDAP_OPT_X_TLS_CACERTDIR, eldap_ca_cert_dir);
444 }
445 #endif
446 #ifdef LDAP_OPT_X_TLS_CERTFILE
447 if (eldap_cert_file != NULL)
448 {
449 ldap_set_option(ld, LDAP_OPT_X_TLS_CERTFILE, eldap_cert_file);
450 }
451 #endif
452 #ifdef LDAP_OPT_X_TLS_KEYFILE
453 if (eldap_cert_key != NULL)
454 {
455 ldap_set_option(ld, LDAP_OPT_X_TLS_KEYFILE, eldap_cert_key);
456 }
457 #endif
458 #ifdef LDAP_OPT_X_TLS_CIPHER_SUITE
459 if (eldap_cipher_suite != NULL)
460 {
461 ldap_set_option(ld, LDAP_OPT_X_TLS_CIPHER_SUITE, eldap_cipher_suite);
462 }
463 #endif
464 #ifdef LDAP_OPT_X_TLS_REQUIRE_CERT
465 if (eldap_require_cert != NULL)
466 {
467 int cert_option = LDAP_OPT_X_TLS_NEVER;
468 if (Ustrcmp(eldap_require_cert, "hard") == 0)
469 {
470 cert_option = LDAP_OPT_X_TLS_HARD;
471 }
472 else if (Ustrcmp(eldap_require_cert, "demand") == 0)
473 {
474 cert_option = LDAP_OPT_X_TLS_DEMAND;
475 }
476 else if (Ustrcmp(eldap_require_cert, "allow") == 0)
477 {
478 cert_option = LDAP_OPT_X_TLS_ALLOW;
479 }
480 else if (Ustrcmp(eldap_require_cert, "try") == 0)
481 {
482 cert_option = LDAP_OPT_X_TLS_TRY;
483 }
10906672 484 ldap_set_option(ld, LDAP_OPT_X_TLS_REQUIRE_CERT, &cert_option);
bc19a55b
PP
485 }
486 #endif
487
0756eb3c
PH
488 /* Now add this connection to the chain of cached connections */
489
490 lcp = store_get(sizeof(LDAP_CONNECTION));
491 lcp->host = (host == NULL)? NULL : string_copy(host);
492 lcp->bound = FALSE;
493 lcp->user = NULL;
494 lcp->password = NULL;
495 lcp->port = port;
496 lcp->ld = ld;
497 lcp->next = ldap_connections;
498 ldap_connections = lcp;
499 }
500
501/* Found cached connection */
502
503else
504 {
505 DEBUG(D_lookup)
506 debug_printf("re-using cached connection to LDAP server %s%s\n",
507 host, porttext);
508 }
509
510/* Bind with the user/password supplied, or an anonymous bind if these values
511are NULL, unless a cached connection is already bound with the same values. */
512
513if (!lcp->bound ||
514 (lcp->user == NULL && user != NULL) ||
515 (lcp->user != NULL && user == NULL) ||
516 (lcp->user != NULL && user != NULL && Ustrcmp(lcp->user, user) != 0) ||
517 (lcp->password == NULL && password != NULL) ||
518 (lcp->password != NULL && password == NULL) ||
519 (lcp->password != NULL && password != NULL &&
520 Ustrcmp(lcp->password, password) != 0))
521 {
522 DEBUG(D_lookup) debug_printf("%sbinding with user=%s password=%s\n",
523 (lcp->bound)? "re-" : "", user, password);
867fcbf5
PP
524#ifdef LDAP_OPT_X_TLS
525 /* The Oracle LDAP libraries (LDAP_LIB_TYPE=SOLARIS) don't support this: */
bc19a55b
PP
526 if (eldap_start_tls)
527 {
528 ldap_start_tls_s(lcp->ld, NULL, NULL);
529 }
867fcbf5 530#endif
7c7ad977
PH
531 if ((msgid = ldap_bind(lcp->ld, CS user, CS password, LDAP_AUTH_SIMPLE))
532 == -1)
0756eb3c 533 {
7c7ad977 534 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
d00328e2 535 "%s%s - ldap_bind() returned -1", host, porttext);
7c7ad977
PH
536 goto RETURN_ERROR;
537 }
0756eb3c 538
7c7ad977
PH
539 if ((rc = ldap_result( lcp->ld, msgid, 1, timeoutptr, &result )) <= 0)
540 {
541 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
8e669ac1 542 "%s%s - LDAP error: %s", host, porttext,
7c7ad977
PH
543 rc == -1 ? "result retrieval failed" : "timeout" );
544 result = NULL;
545 goto RETURN_ERROR;
546 }
547
548 rc = ldap_result2error( lcp->ld, result, 0 );
549
550 /* Invalid credentials when just checking credentials returns FAIL. This
551 stops any further servers being tried. */
0756eb3c 552
7c7ad977
PH
553 if (search_type == SEARCH_LDAP_AUTH && rc == LDAP_INVALID_CREDENTIALS)
554 {
555 DEBUG(D_lookup)
556 debug_printf("Invalid credentials: ldapauth returns FAIL\n");
557 error_yield = FAIL;
558 goto RETURN_ERROR_NOMSG;
559 }
0756eb3c 560
7c7ad977
PH
561 /* Otherwise we have a problem that doesn't stop further servers from being
562 tried. */
563
564 if (rc != LDAP_SUCCESS)
565 {
0756eb3c
PH
566 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
567 "%s%s - LDAP error %d: %s", host, porttext, rc, ldap_err2string(rc));
568 goto RETURN_ERROR;
569 }
570
571 /* Successful bind */
572
573 lcp->bound = TRUE;
574 lcp->user = (user == NULL)? NULL : string_copy(user);
575 lcp->password = (password == NULL)? NULL : string_copy(password);
7c7ad977
PH
576
577 ldap_msgfree(result);
578 result = NULL;
0756eb3c
PH
579 }
580
581/* If we are just checking credentials, return OK. */
582
583if (search_type == SEARCH_LDAP_AUTH)
584 {
585 DEBUG(D_lookup) debug_printf("Bind succeeded: ldapauth returns OK\n");
586 goto RETURN_OK;
587 }
588
589/* Before doing the search, set the time and size limits (if given). Here again
590the different implementations of LDAP have chosen to do things differently. */
591
592#if defined(LDAP_OPT_SIZELIMIT)
593ldap_set_option(lcp->ld, LDAP_OPT_SIZELIMIT, (void *)&sizelimit);
594ldap_set_option(lcp->ld, LDAP_OPT_TIMELIMIT, (void *)&timelimit);
595#else
596lcp->ld->ld_sizelimit = sizelimit;
597lcp->ld->ld_timelimit = timelimit;
598#endif
599
600/* Similarly for dereferencing aliases. Don't know if this is possible on
601an LDAP library without LDAP_OPT_DEREF. */
602
603#if defined(LDAP_OPT_DEREF)
604ldap_set_option(lcp->ld, LDAP_OPT_DEREF, (void *)&dereference);
605#endif
606
6ec97b1b
PH
607/* Similarly for the referral setting; should the library follow referrals that
608the LDAP server returns? The conditional is just in case someone uses a library
609without it. */
610
611#if defined(LDAP_OPT_REFERRALS)
612ldap_set_option(lcp->ld, LDAP_OPT_REFERRALS, referrals);
613#endif
614
0756eb3c
PH
615/* Start the search on the server. */
616
617DEBUG(D_lookup) debug_printf("Start search\n");
618
619msgid = ldap_search(lcp->ld, ludp->lud_dn, ludp->lud_scope, ludp->lud_filter,
620 ludp->lud_attrs, 0);
621
622if (msgid == -1)
623 {
3ca0ba97
PH
624 #if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
625 int err;
626 ldap_get_option(lcp->ld, LDAP_OPT_ERROR_NUMBER, &err);
8e669ac1 627 *errmsg = string_sprintf("ldap_search failed: %d, %s", err,
3ca0ba97 628 ldap_err2string(err));
8e669ac1
PH
629
630 #else
3ca0ba97
PH
631 *errmsg = string_sprintf("ldap_search failed");
632 #endif
8e669ac1 633
0756eb3c
PH
634 goto RETURN_ERROR;
635 }
636
637/* Loop to pick up results as they come in, setting a timeout if one was
638given. */
639
0756eb3c
PH
640while ((rc = ldap_result(lcp->ld, msgid, 0, timeoutptr, &result)) ==
641 LDAP_RES_SEARCH_ENTRY)
642 {
643 LDAPMessage *e;
644
645 DEBUG(D_lookup) debug_printf("ldap_result loop\n");
646
647 for(e = ldap_first_entry(lcp->ld, result);
648 e != NULL;
649 e = ldap_next_entry(lcp->ld, e))
650 {
651 uschar *new_dn;
652 BOOL insert_space = FALSE;
653
654 DEBUG(D_lookup) debug_printf("LDAP entry loop\n");
655
656 rescount++; /* Count results */
657
658 /* Results for multiple entries values are separated by newlines. */
659
660 if (data != NULL) data = string_cat(data, &size, &ptr, US"\n", 1);
661
662 /* Get the DN from the last result. */
663
664 new_dn = US ldap_get_dn(lcp->ld, e);
665 if (new_dn != NULL)
666 {
667 if (dn != NULL)
668 {
669 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
670 ldap_memfree(dn);
671 #else /* OPENLDAP 1, UMich, Solaris */
672 free(dn);
673 #endif
674 }
675 /* Save for later */
676 dn = new_dn;
677 }
678
679 /* If the data we want is actually the DN rather than any attribute values,
680 (an "ldapdn" search) add it to the data string. If there are multiple
681 entries, the DNs will be concatenated, but we test for this case below, as
682 for SEARCH_LDAP_SINGLE, and give an error. */
683
684 if (search_type == SEARCH_LDAP_DN) /* Do not amalgamate these into one */
685 { /* condition, because of the else */
686 if (new_dn != NULL) /* below, that's for the first only */
687 {
688 data = string_cat(data, &size, &ptr, new_dn, Ustrlen(new_dn));
689 data[ptr] = 0;
690 attribute_found = TRUE;
691 }
692 }
693
694 /* Otherwise, loop through the entry, grabbing attribute values. If there's
695 only one attribute being retrieved, no attribute name is given, and the
696 result is not quoted. Multiple values are separated by (comma, space).
697 If more than one attribute is being retrieved, the data is given as a
698 sequence of name=value pairs, with the value always in quotes. If there are
699 multiple values, they are given within the quotes, comma separated. */
700
701 else for (attr = US ldap_first_attribute(lcp->ld, e, &ber);
702 attr != NULL;
703 attr = US ldap_next_attribute(lcp->ld, e, ber))
704 {
705 if (attr[0] != 0)
706 {
707 /* Get array of values for this attribute. */
708
709 if ((firstval = values = USS ldap_get_values(lcp->ld, e, CS attr))
710 != NULL)
711 {
712 if (attr_count != 1)
713 {
714 if (insert_space)
715 data = string_cat(data, &size, &ptr, US" ", 1);
716 else
717 insert_space = TRUE;
718 data = string_cat(data, &size, &ptr, attr, Ustrlen(attr));
719 data = string_cat(data, &size, &ptr, US"=\"", 2);
720 }
721
722 while (*values != NULL)
723 {
724 uschar *value = *values;
725 int len = Ustrlen(value);
726
727 DEBUG(D_lookup) debug_printf("LDAP attr loop %s:%s\n", attr, value);
728
729 if (values != firstval)
730 data = string_cat(data, &size, &ptr, US", ", 2);
731
732 /* For multiple attributes, the data is in quotes. We must escape
733 internal quotes, backslashes, newlines. */
734
735 if (attr_count != 1)
736 {
737 int j;
738 for (j = 0; j < len; j++)
739 {
740 if (value[j] == '\n')
741 data = string_cat(data, &size, &ptr, US"\\n", 2);
742 else
743 {
744 if (value[j] == '\"' || value[j] == '\\')
745 data = string_cat(data, &size, &ptr, US"\\", 1);
746 data = string_cat(data, &size, &ptr, value+j, 1);
747 }
748 }
749 }
750
751 /* For single attributes, copy the value verbatim */
752
753 else data = string_cat(data, &size, &ptr, value, len);
754
755 /* Move on to the next value */
756
757 values++;
758 attribute_found = TRUE;
759 }
760
761 /* Closing quote at the end of the data for a named attribute. */
762
763 if (attr_count != 1)
764 data = string_cat(data, &size, &ptr, US"\"", 1);
765
766 /* Free the values */
767
768 ldap_value_free(CSS firstval);
769 }
770 }
771
772 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
773
774 /* Netscape and OpenLDAP2 LDAP's attrs are dynamically allocated and need
775 to be freed. UMich LDAP stores them in static storage and does not require
776 this. */
777
778 ldap_memfree(attr);
779 #endif
780 } /* End "for" loop for extracting attributes from an entry */
781 } /* End "for" loop for extracting entries from a result */
782
783 /* Free the result */
784
785 ldap_msgfree(result);
786 result = NULL;
787 } /* End "while" loop for multiple results */
788
789/* Terminate the dynamic string that we have built and reclaim unused store */
790
791if (data != NULL)
792 {
793 data[ptr] = 0;
794 store_reset(data + ptr + 1);
795 }
796
797/* Copy the last dn into eldap_dn */
798
799if (dn != NULL)
800 {
801 eldap_dn = string_copy(dn);
802 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
803 ldap_memfree(dn);
804 #else /* OPENLDAP 1, UMich, Solaris */
805 free(dn);
806 #endif
807 }
808
809DEBUG(D_lookup) debug_printf("search ended by ldap_result yielding %d\n",rc);
810
811if (rc == 0)
812 {
813 *errmsg = US"ldap_result timed out";
814 goto RETURN_ERROR;
815 }
816
817/* A return code of -1 seems to mean "ldap_result failed internally or couldn't
818provide you with a message". Other error states seem to exist where
819ldap_result() didn't give us any message from the server at all, leaving result
820set to NULL. Apparently, "the error parameters of the LDAP session handle will
821be set accordingly". That's the best we can do to retrieve an error status; we
822can't use functions like ldap_result2error because they parse a message from
823the server, which we didn't get.
824
825Annoyingly, the different implementations of LDAP have gone for different
826methods of handling error codes and generating error messages. */
827
828if (rc == -1 || result == NULL)
829 {
830 int err;
831 DEBUG(D_lookup) debug_printf("ldap_result failed\n");
832
833 #if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
834 ldap_get_option(lcp->ld, LDAP_OPT_ERROR_NUMBER, &err);
835 *errmsg = string_sprintf("ldap_result failed: %d, %s",
836 err, ldap_err2string(err));
837
838 #elif defined LDAP_LIB_NETSCAPE
839 /* Dubious (surely 'matched' is spurious here?) */
840 (void)ldap_get_lderrno(lcp->ld, &matched, &error1);
841 *errmsg = string_sprintf("ldap_result failed: %s (%s)", error1, matched);
842
843 #else /* UMich LDAP aka OpenLDAP 1.x */
844 *errmsg = string_sprintf("ldap_result failed: %d, %s",
845 lcp->ld->ld_errno, ldap_err2string(lcp->ld->ld_errno));
846 #endif
847
848 goto RETURN_ERROR;
849 }
850
851/* A return code that isn't -1 doesn't necessarily mean there were no problems
8e669ac1
PH
852with the search. The message must be an LDAP_RES_SEARCH_RESULT or
853LDAP_RES_SEARCH_REFERENCE or else it's something we can't handle. Some versions
854of LDAP do not define LDAP_RES_SEARCH_REFERENCE (LDAP v1 is one, it seems). So
3295e65b
PH
855we don't provide that functionality when we can't. :-) */
856
8e669ac1 857if (rc != LDAP_RES_SEARCH_RESULT
3295e65b
PH
858#ifdef LDAP_RES_SEARCH_REFERENCE
859 && rc != LDAP_RES_SEARCH_REFERENCE
8e669ac1 860#endif
3295e65b 861 )
0756eb3c
PH
862 {
863 *errmsg = string_sprintf("ldap_result returned unexpected code %d", rc);
864 goto RETURN_ERROR;
865 }
866
867/* We have a result message from the server. This doesn't yet mean all is well.
868We need to parse the message to find out exactly what's happened. */
869
d38f8232
PH
870#if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
871 ldap_rc = rc;
8e669ac1 872 ldap_parse_rc = ldap_parse_result(lcp->ld, result, &rc, CSS &matched,
d38f8232
PH
873 CSS &error2, NULL, NULL, 0);
874 DEBUG(D_lookup) debug_printf("ldap_parse_result: %d\n", ldap_parse_rc);
8e669ac1 875 if (ldap_parse_rc < 0 &&
3295e65b 876 (ldap_parse_rc != LDAP_NO_RESULTS_RETURNED
8e669ac1 877 #ifdef LDAP_RES_SEARCH_REFERENCE
3295e65b 878 || ldap_rc != LDAP_RES_SEARCH_REFERENCE
8e669ac1 879 #endif
3295e65b 880 ))
0756eb3c 881 {
d38f8232 882 *errmsg = string_sprintf("ldap_parse_result failed %d", ldap_parse_rc);
0756eb3c
PH
883 goto RETURN_ERROR;
884 }
885 error1 = US ldap_err2string(rc);
886
887#elif defined LDAP_LIB_NETSCAPE
888 /* Dubious (it doesn't reference 'result' at all!) */
889 rc = ldap_get_lderrno(lcp->ld, &matched, &error1);
890
891#else /* UMich LDAP aka OpenLDAP 1.x */
892 rc = ldap_result2error(lcp->ld, result, 0);
893 error1 = ldap_err2string(rc);
894 error2 = lcp->ld->ld_error;
895 matched = lcp->ld->ld_matched;
896#endif
897
898/* Process the status as follows:
899
900 (1) If we get LDAP_SIZELIMIT_EXCEEDED, just carry on, to return the
901 truncated result list.
902
21eb6e72
PH
903 (2) If we get LDAP_RES_SEARCH_REFERENCE, also just carry on. This was a
904 submitted patch that is reported to "do the right thing" with Solaris
905 LDAP libraries. (The problem it addresses apparently does not occur with
906 Open LDAP.)
907
908 (3) The range of errors defined by LDAP_NAME_ERROR generally mean "that
0756eb3c
PH
909 object does not, or cannot, exist in the database". For those cases we
910 fail the lookup.
911
21eb6e72 912 (4) All other non-successes here are treated as some kind of problem with
0756eb3c
PH
913 the lookup, so return DEFER (which is the default in error_yield).
914*/
915
916DEBUG(D_lookup) debug_printf("ldap_parse_result yielded %d: %s\n",
917 rc, ldap_err2string(rc));
918
21eb6e72
PH
919if (rc != LDAP_SUCCESS && rc != LDAP_SIZELIMIT_EXCEEDED
920 #ifdef LDAP_RES_SEARCH_REFERENCE
921 && rc != LDAP_RES_SEARCH_REFERENCE
922 #endif
923 )
0756eb3c
PH
924 {
925 *errmsg = string_sprintf("LDAP search failed - error %d: %s%s%s%s%s",
926 rc,
927 (error1 != NULL)? error1 : US"",
928 (error2 != NULL && error2[0] != 0)? US"/" : US"",
929 (error2 != NULL)? error2 : US"",
930 (matched != NULL && matched[0] != 0)? US"/" : US"",
931 (matched != NULL)? matched : US"");
932
933 #if defined LDAP_NAME_ERROR
934 if (LDAP_NAME_ERROR(rc))
935 #elif defined NAME_ERROR /* OPENLDAP1 calls it this */
936 if (NAME_ERROR(rc))
937 #else
938 if (rc == LDAP_NO_SUCH_OBJECT)
939 #endif
940
941 {
942 DEBUG(D_lookup) debug_printf("lookup failure forced\n");
943 error_yield = FAIL;
944 }
945 goto RETURN_ERROR;
946 }
947
948/* The search succeeded. Check if we have too many results */
949
950if (search_type != SEARCH_LDAP_MULTIPLE && rescount > 1)
951 {
952 *errmsg = string_sprintf("LDAP search: more than one entry (%d) was returned "
953 "(filter not specific enough?)", rescount);
954 goto RETURN_ERROR_BREAK;
955 }
956
957/* Check if we have too few (zero) entries */
958
959if (rescount < 1)
960 {
961 *errmsg = string_sprintf("LDAP search: no results");
962 error_yield = FAIL;
963 goto RETURN_ERROR_BREAK;
964 }
965
966/* If an entry was found, but it had no attributes, we behave as if no entries
967were found, that is, the lookup failed. */
968
969if (!attribute_found)
970 {
971 *errmsg = US"LDAP search: found no attributes";
972 error_yield = FAIL;
973 goto RETURN_ERROR;
974 }
975
976/* Otherwise, it's all worked */
977
978DEBUG(D_lookup) debug_printf("LDAP search: returning: %s\n", data);
979*res = data;
980
981RETURN_OK:
982if (result != NULL) ldap_msgfree(result);
983ldap_free_urldesc(ludp);
984return OK;
985
986/* Error returns */
987
988RETURN_ERROR_BREAK:
989*defer_break = TRUE;
990
991RETURN_ERROR:
992DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
993
994RETURN_ERROR_NOMSG:
995if (result != NULL) ldap_msgfree(result);
996if (ludp != NULL) ldap_free_urldesc(ludp);
997
998#if defined LDAP_LIB_OPENLDAP2
999 if (error2 != NULL) ldap_memfree(error2);
1000 if (matched != NULL) ldap_memfree(matched);
1001#endif
1002
1003return error_yield;
1004}
1005
1006
1007
1008/*************************************************
1009* Internal search control function *
1010*************************************************/
1011
1012/* This function is called from eldap_find(), eldapauth_find(), eldapdn_find(),
1013and eldapm_find() with a difference in the "search_type" argument. It controls
1014calls to perform_ldap_search() which actually does the work. We call that
1015repeatedly for certain types of defer in the case when the URL contains no host
1016name and eldap_default_servers is set to a list of servers to try. This gives
1017more control than just passing over a list of hosts to ldap_open() because it
1018handles other kinds of defer as well as just a failure to open. Note that the
1019URL is defined to contain either zero or one "hostport" only.
1020
1021Parameter data in addition to the URL can be passed as preceding text in the
1022string, as items of the form XXX=yyy. The URL itself can be detected because it
1023must begin "ldapx://", where x is empty, s, or i.
1024
1025Arguments:
1026 ldap_url the URL to be looked up, optionally preceded by other parameter
1027 settings
1028 search_type SEARCH_LDAP_MULTIPLE allows values from multiple entries
1029 SEARCH_LDAP_SINGLE allows values from one entry only
1030 SEARCH_LDAP_DN gets the DN from one entry
1031 res set to point at the result
1032 errmsg set to point a message if result is not OK
1033
1034Returns: OK or FAIL or DEFER
1035*/
1036
1037static int
1038control_ldap_search(uschar *ldap_url, int search_type, uschar **res,
1039 uschar **errmsg)
1040{
1041BOOL defer_break = FALSE;
1042int timelimit = LDAP_NO_LIMIT;
1043int sizelimit = LDAP_NO_LIMIT;
7c7ad977 1044int tcplimit = 0;
0756eb3c 1045int sep = 0;
6ec97b1b
PH
1046int dereference = LDAP_DEREF_NEVER;
1047void* referrals = LDAP_OPT_ON;
0756eb3c
PH
1048uschar *url = ldap_url;
1049uschar *p;
1050uschar *user = NULL;
1051uschar *password = NULL;
1052uschar *server, *list;
1053uschar buffer[512];
1054
1055while (isspace(*url)) url++;
1056
1057/* Until the string begins "ldap", search for the other parameter settings that
1058are recognized. They are of the form NAME=VALUE, with the value being
1059optionally double-quoted. There must still be a space after it, however. No
1060NAME has the value "ldap". */
1061
1062while (strncmpic(url, US"ldap", 4) != 0)
1063 {
1064 uschar *name = url;
1065 while (*url != 0 && *url != '=') url++;
1066 if (*url == '=')
1067 {
1068 int namelen;
1069 uschar *value;
1070 namelen = ++url - name;
1071 value = string_dequote(&url);
1072 if (isspace(*url))
1073 {
1074 if (strncmpic(name, US"USER=", namelen) == 0) user = value;
1075 else if (strncmpic(name, US"PASS=", namelen) == 0) password = value;
1076 else if (strncmpic(name, US"SIZE=", namelen) == 0) sizelimit = Uatoi(value);
1077 else if (strncmpic(name, US"TIME=", namelen) == 0) timelimit = Uatoi(value);
7c7ad977
PH
1078 else if (strncmpic(name, US"CONNECT=", namelen) == 0) tcplimit = Uatoi(value);
1079 else if (strncmpic(name, US"NETTIME=", namelen) == 0) tcplimit = Uatoi(value);
0756eb3c
PH
1080
1081 /* Don't know if all LDAP libraries have LDAP_OPT_DEREF */
1082
1083 #ifdef LDAP_OPT_DEREF
1084 else if (strncmpic(name, US"DEREFERENCE=", namelen) == 0)
1085 {
1086 if (strcmpic(value, US"never") == 0) dereference = LDAP_DEREF_NEVER;
1087 else if (strcmpic(value, US"searching") == 0)
1088 dereference = LDAP_DEREF_SEARCHING;
1089 else if (strcmpic(value, US"finding") == 0)
1090 dereference = LDAP_DEREF_FINDING;
1091 if (strcmpic(value, US"always") == 0) dereference = LDAP_DEREF_ALWAYS;
1092 }
1093 #else
1094 else if (strncmpic(name, US"DEREFERENCE=", namelen) == 0)
1095 {
1096 *errmsg = string_sprintf("LDAP_OP_DEREF not defined in this LDAP "
1097 "library - cannot use \"dereference\"");
1098 DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
1099 return DEFER;
1100 }
6ec97b1b 1101 #endif
0756eb3c 1102
6ec97b1b
PH
1103 #ifdef LDAP_OPT_REFERRALS
1104 else if (strncmpic(name, US"REFERRALS=", namelen) == 0)
1105 {
1106 if (strcmpic(value, US"follow") == 0) referrals = LDAP_OPT_ON;
1107 else if (strcmpic(value, US"nofollow") == 0) referrals = LDAP_OPT_OFF;
1108 else
1109 {
1110 *errmsg = string_sprintf("LDAP option REFERRALS is not \"follow\" "
1111 "or \"nofollow\"");
1112 DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
1113 return DEFER;
1114 }
1115 }
1116 #else
1117 else if (strncmpic(name, US"REFERRALS=", namelen) == 0)
1118 {
1119 *errmsg = string_sprintf("LDAP_OP_REFERRALS not defined in this LDAP "
1120 "library - cannot use \"referrals\"");
1121 DEBUG(D_lookup) debug_printf("%s\n", *errmsg);
1122 return DEFER;
1123 }
0756eb3c
PH
1124 #endif
1125
1126 else
1127 {
1128 *errmsg =
1129 string_sprintf("unknown parameter \"%.*s\" precedes LDAP URL",
1130 namelen, name);
1131 DEBUG(D_lookup) debug_printf("LDAP query error: %s\n", *errmsg);
1132 return DEFER;
1133 }
1134 while (isspace(*url)) url++;
1135 continue;
1136 }
1137 }
1138 *errmsg = US"malformed parameter setting precedes LDAP URL";
1139 DEBUG(D_lookup) debug_printf("LDAP query error: %s\n", *errmsg);
1140 return DEFER;
1141 }
1142
1143/* If user is set, de-URL-quote it. Some LDAP libraries do this for themselves,
1144but it seems that not all behave like this. The DN for the user is often the
1145result of ${quote_ldap_dn:...} quoting, which does apply URL quoting, because
1146that is needed when the DN is used as a base DN in a query. Sigh. This is all
1147far too complicated. */
1148
1149if (user != NULL)
1150 {
1151 uschar *s;
1152 uschar *t = user;
1153 for (s = user; *s != 0; s++)
1154 {
1155 int c, d;
1156 if (*s == '%' && isxdigit(c=s[1]) && isxdigit(d=s[2]))
1157 {
1158 c = tolower(c);
1159 d = tolower(d);
1160 *t++ =
1161 (((c >= 'a')? (10 + c - 'a') : c - '0') << 4) |
1162 ((d >= 'a')? (10 + d - 'a') : d - '0');
1163 s += 2;
1164 }
1165 else *t++ = *s;
1166 }
1167 *t = 0;
1168 }
1169
1170DEBUG(D_lookup)
1171 debug_printf("LDAP parameters: user=%s pass=%s size=%d time=%d connect=%d "
6ec97b1b
PH
1172 "dereference=%d referrals=%s\n", user, password, sizelimit, timelimit,
1173 tcplimit, dereference, (referrals == LDAP_OPT_ON)? "on" : "off");
0756eb3c
PH
1174
1175/* If the request is just to check authentication, some credentials must
1176be given. The password must not be empty because LDAP binds with an empty
1177password are considered anonymous, and will succeed on most installations. */
1178
1179if (search_type == SEARCH_LDAP_AUTH)
1180 {
1181 if (user == NULL || password == NULL)
1182 {
1183 *errmsg = US"ldapauth lookups must specify the username and password";
1184 return DEFER;
1185 }
1186 if (password[0] == 0)
1187 {
1188 DEBUG(D_lookup) debug_printf("Empty password: ldapauth returns FAIL\n");
1189 return FAIL;
1190 }
1191 }
1192
1193/* Check for valid ldap url starters */
1194
1195p = url + 4;
1196if (tolower(*p) == 's' || tolower(*p) == 'i') p++;
1197if (Ustrncmp(p, "://", 3) != 0)
1198 {
1199 *errmsg = string_sprintf("LDAP URL does not start with \"ldap://\", "
1200 "\"ldaps://\", or \"ldapi://\" (it starts with \"%.16s...\")", url);
1201 DEBUG(D_lookup) debug_printf("LDAP query error: %s\n", *errmsg);
1202 return DEFER;
1203 }
1204
1205/* No default servers, or URL contains a server name: just one attempt */
1206
1207if (eldap_default_servers == NULL || p[3] != '/')
1208 {
1209 return perform_ldap_search(url, NULL, 0, search_type, res, errmsg,
6ec97b1b
PH
1210 &defer_break, user, password, sizelimit, timelimit, tcplimit, dereference,
1211 referrals);
0756eb3c
PH
1212 }
1213
1214/* Loop through the default servers until OK or FAIL */
1215
1216list = eldap_default_servers;
1217while ((server = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
1218 {
1219 int rc;
1220 int port = 0;
1221 uschar *colon = Ustrchr(server, ':');
1222 if (colon != NULL)
1223 {
1224 *colon = 0;
1225 port = Uatoi(colon+1);
1226 }
1227 rc = perform_ldap_search(url, server, port, search_type, res, errmsg,
6ec97b1b
PH
1228 &defer_break, user, password, sizelimit, timelimit, tcplimit, dereference,
1229 referrals);
0756eb3c
PH
1230 if (rc != DEFER || defer_break) return rc;
1231 }
1232
1233return DEFER;
1234}
1235
1236
1237
1238/*************************************************
1239* Find entry point *
1240*************************************************/
1241
1242/* See local README for interface description. The different kinds of search
1243are handled by a common function, with a flag to differentiate between them.
1244The handle and filename arguments are not used. */
1245
e6d225ae 1246static int
0756eb3c
PH
1247eldap_find(void *handle, uschar *filename, uschar *ldap_url, int length,
1248 uschar **result, uschar **errmsg, BOOL *do_cache)
1249{
1250/* Keep picky compilers happy */
1251do_cache = do_cache;
1252return(control_ldap_search(ldap_url, SEARCH_LDAP_SINGLE, result, errmsg));
1253}
1254
e6d225ae 1255static int
0756eb3c
PH
1256eldapm_find(void *handle, uschar *filename, uschar *ldap_url, int length,
1257 uschar **result, uschar **errmsg, BOOL *do_cache)
1258{
1259/* Keep picky compilers happy */
1260do_cache = do_cache;
1261return(control_ldap_search(ldap_url, SEARCH_LDAP_MULTIPLE, result, errmsg));
1262}
1263
e6d225ae 1264static int
0756eb3c
PH
1265eldapdn_find(void *handle, uschar *filename, uschar *ldap_url, int length,
1266 uschar **result, uschar **errmsg, BOOL *do_cache)
1267{
1268/* Keep picky compilers happy */
1269do_cache = do_cache;
1270return(control_ldap_search(ldap_url, SEARCH_LDAP_DN, result, errmsg));
1271}
1272
1273int
1274eldapauth_find(void *handle, uschar *filename, uschar *ldap_url, int length,
1275 uschar **result, uschar **errmsg, BOOL *do_cache)
1276{
1277/* Keep picky compilers happy */
1278do_cache = do_cache;
1279return(control_ldap_search(ldap_url, SEARCH_LDAP_AUTH, result, errmsg));
1280}
1281
1282
1283
1284/*************************************************
1285* Open entry point *
1286*************************************************/
1287
1288/* See local README for interface description. */
1289
e6d225ae 1290static void *
0756eb3c
PH
1291eldap_open(uschar *filename, uschar **errmsg)
1292{
1293return (void *)(1); /* Just return something non-null */
1294}
1295
1296
1297
1298/*************************************************
1299* Tidy entry point *
1300*************************************************/
1301
1302/* See local README for interface description.
1303Make sure that eldap_dn does not refer to reclaimed or worse, freed store */
1304
e6d225ae 1305static void
0756eb3c
PH
1306eldap_tidy(void)
1307{
1308LDAP_CONNECTION *lcp = NULL;
1309eldap_dn = NULL;
1310
1311while ((lcp = ldap_connections) != NULL)
1312 {
1313 DEBUG(D_lookup) debug_printf("unbind LDAP connection to %s:%d\n", lcp->host,
1314 lcp->port);
1315 ldap_unbind(lcp->ld);
1316 ldap_connections = lcp->next;
1317 }
1318}
1319
1320
1321
1322/*************************************************
1323* Quote entry point *
1324*************************************************/
1325
1326/* LDAP quoting is unbelievably messy. For a start, two different levels of
1327quoting have to be done: LDAP quoting, and URL quoting. The current
1328specification is the result of a suggestion by Brian Candler. It recognizes
1329two separate cases:
1330
1331(1) For text that appears in a search filter, the following escapes are
1332 required (see RFC 2254):
1333
1334 * -> \2A
1335 ( -> \28
1336 ) -> \29
1337 \ -> \5C
1338 NULL -> \00
1339
1340 Then the entire filter text must be URL-escaped. This kind of quoting is
1341 implemented by ${quote_ldap:....}. Note that we can never have a NULL
1342 in the input string, because that's a terminator.
1343
1344(2) For a DN that is part of a URL (i.e. the base DN), the characters
1345
1346 , + " \ < > ;
1347
1348 must be quoted by backslashing. See RFC 2253. Leading and trailing spaces
1349 must be escaped, as must a leading #. Then the string must be URL-quoted.
1350 This type of quoting is implemented by ${quote_ldap_dn:....}.
1351
1352For URL quoting, the only characters that need not be quoted are the
1353alphamerics and
1354
1355 ! $ ' ( ) * + - . _
1356
1357All the others must be hexified and preceded by %. This includes the
1358backslashes used for LDAP quoting.
1359
1360For a DN that is given in the USER parameter for authentication, we need the
1361same initial quoting as (2) but in this case, the result must NOT be
1362URL-escaped, because it isn't a URL. The way this is handled is by
1363de-URL-quoting the text when processing the USER parameter in
1364control_ldap_search() above. That means that the same quote operator can be
1365used. This has the additional advantage that spaces in the DN won't cause
1366parsing problems. For example:
1367
1368 USER=cn=${quote_ldap_dn:$1},%20dc=example,%20dc=com
1369
1370should be safe if there are spaces in $1.
1371
1372
1373Arguments:
1374 s the string to be quoted
1375 opt additional option text or NULL if none
1376 only "dn" is recognized
1377
1378Returns: the processed string or NULL for a bad option
1379*/
1380
1381
1382
1383/* The characters in this string, together with alphanumerics, never need
1384quoting in any way. */
1385
1386#define ALWAYS_LITERAL "!$'-._"
1387
1388/* The special characters in this string do not need to be URL-quoted. The set
1389is a bit larger than the general literals. */
1390
1391#define URL_NONQUOTE ALWAYS_LITERAL "()*+"
1392
1393/* The following macros define the characters that are quoted by quote_ldap and
1394quote_ldap_dn, respectively. */
1395
1396#define LDAP_QUOTE "*()\\"
1397#define LDAP_DN_QUOTE ",+\"\\<>;"
1398
1399
1400
e6d225ae 1401static uschar *
0756eb3c
PH
1402eldap_quote(uschar *s, uschar *opt)
1403{
1404register int c;
1405int count = 0;
1406int len = 0;
1407BOOL dn = FALSE;
1408uschar *t = s;
1409uschar *quoted;
1410
1411/* Test for a DN quotation. */
1412
1413if (opt != NULL)
1414 {
1415 if (Ustrcmp(opt, "dn") != 0) return NULL; /* No others recognized */
1416 dn = TRUE;
1417 }
1418
1419/* Compute how much extra store we need for the string. This doesn't have to be
1420exact as long as it isn't an underestimate. The worst case is the addition of 5
1421extra bytes for a single character. This occurs for certain characters in DNs,
1422where, for example, < turns into %5C%3C. For simplicity, we just add 5 for each
1423possibly escaped character. The really fast way would be just to test for
1424non-alphanumerics, but it is probably better to spot a few others that are
1425never escaped, because if there are no specials at all, we can avoid copying
1426the string. */
1427
1428while ((c = *t++) != 0)
1429 {
1430 len++;
1431 if (!isalnum(c) && Ustrchr(ALWAYS_LITERAL, c) == NULL) count += 5;
1432 }
1433if (count == 0) return s;
1434
1435/* Get sufficient store to hold the quoted string */
1436
1437t = quoted = store_get(len + count + 1);
1438
1439/* Handle plain quote_ldap */
1440
1441if (!dn)
1442 {
1443 while ((c = *s++) != 0)
1444 {
1445 if (!isalnum(c))
1446 {
1447 if (Ustrchr(LDAP_QUOTE, c) != NULL)
1448 {
1449 sprintf(CS t, "%%5C%02X", c); /* e.g. * => %5C2A */
1450 t += 5;
1451 continue;
1452 }
1453 if (Ustrchr(URL_NONQUOTE, c) == NULL) /* e.g. ] => %5D */
1454 {
1455 sprintf(CS t, "%%%02X", c);
1456 t += 3;
1457 continue;
1458 }
1459 }
1460 *t++ = c; /* unquoted character */
1461 }
1462 }
1463
1464/* Handle quote_ldap_dn */
1465
1466else
1467 {
1468 uschar *ss = s + len;
1469
1470 /* Find the last char before any trailing spaces */
1471
1472 while (ss > s && ss[-1] == ' ') ss--;
1473
1474 /* Quote leading spaces and sharps */
1475
1476 for (; s < ss; s++)
1477 {
1478 if (*s != ' ' && *s != '#') break;
1479 sprintf(CS t, "%%5C%%%02X", *s);
1480 t += 6;
1481 }
1482
1483 /* Handle the rest of the string, up to the trailing spaces */
1484
1485 while (s < ss)
1486 {
1487 c = *s++;
1488 if (!isalnum(c))
1489 {
1490 if (Ustrchr(LDAP_DN_QUOTE, c) != NULL)
1491 {
1492 Ustrncpy(t, "%5C", 3); /* insert \ where needed */
1493 t += 3; /* fall through to check URL */
1494 }
1495 if (Ustrchr(URL_NONQUOTE, c) == NULL) /* e.g. ] => %5D */
1496 {
1497 sprintf(CS t, "%%%02X", c);
1498 t += 3;
1499 continue;
1500 }
1501 }
1502 *t++ = c; /* unquoted character, or non-URL quoted after %5C */
1503 }
1504
1505 /* Handle the trailing spaces */
1506
1507 while (*ss++ != 0)
1508 {
1509 Ustrncpy(t, "%5C%20", 6);
1510 t += 6;
1511 }
1512 }
1513
1514/* Terminate the new string and return */
1515
1516*t = 0;
1517return quoted;
1518}
1519
6545de78
PP
1520
1521
1522/*************************************************
1523* Version reporting entry point *
1524*************************************************/
1525
1526/* See local README for interface description. */
1527
1528#include "../version.h"
1529
1530void
1531ldap_version_report(FILE *f)
1532{
1533#ifdef DYNLOOKUP
1534fprintf(f, "Library version: LDAP: Exim version %s\n", EXIM_VERSION_STR);
1535#endif
1536}
1537
1538
e6d225ae
DW
1539static lookup_info ldap_lookup_info = {
1540 US"ldap", /* lookup name */
1541 lookup_querystyle, /* query-style lookup */
1542 eldap_open, /* open function */
1543 NULL, /* check function */
1544 eldap_find, /* find function */
1545 NULL, /* no close function */
1546 eldap_tidy, /* tidy function */
6545de78
PP
1547 eldap_quote, /* quoting function */
1548 ldap_version_report /* version reporting */
e6d225ae
DW
1549};
1550
1551static lookup_info ldapdn_lookup_info = {
1552 US"ldapdn", /* lookup name */
1553 lookup_querystyle, /* query-style lookup */
1554 eldap_open, /* sic */ /* open function */
1555 NULL, /* check function */
1556 eldapdn_find, /* find function */
1557 NULL, /* no close function */
1558 eldap_tidy, /* sic */ /* tidy function */
6545de78
PP
1559 eldap_quote, /* sic */ /* quoting function */
1560 NULL /* no version reporting (redundant) */
e6d225ae
DW
1561};
1562
1563static lookup_info ldapm_lookup_info = {
1564 US"ldapm", /* lookup name */
1565 lookup_querystyle, /* query-style lookup */
1566 eldap_open, /* sic */ /* open function */
1567 NULL, /* check function */
1568 eldapm_find, /* find function */
1569 NULL, /* no close function */
1570 eldap_tidy, /* sic */ /* tidy function */
6545de78
PP
1571 eldap_quote, /* sic */ /* quoting function */
1572 NULL /* no version reporting (redundant) */
e6d225ae
DW
1573};
1574
1575#ifdef DYNLOOKUP
1576#define ldap_lookup_module_info _lookup_module_info
1577#endif
1578
1579static lookup_info *_lookup_list[] = { &ldap_lookup_info, &ldapdn_lookup_info, &ldapm_lookup_info };
1580lookup_module_info ldap_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 3 };
0756eb3c
PH
1581
1582/* End of lookups/ldap.c */