1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* Many thanks to Stuart Lynne for contributing the original code for this
11 driver. Further contributions from Michael Haardt, Brian Candler, Barry
12 Pederson, Peter Savitch and Christian Kellner. Particular thanks to Brian for
13 researching how to handle the different kinds of error. */
17 #include "lf_functions.h"
20 /* Include LDAP headers. The code below uses some "old" LDAP interfaces that
21 are deprecated in OpenLDAP. I don't know their status in other LDAP
22 implementations. LDAP_DEPRECATED causes their prototypes to be defined in
25 #define LDAP_DEPRECATED 1
31 /* Annoyingly, the different LDAP libraries handle errors in different ways,
32 and some other things too. There doesn't seem to be an automatic way of
33 distinguishing between them. Local/Makefile should contain a setting of
34 LDAP_LIB_TYPE, which in turn causes appropriate macros to be defined for the
35 different kinds. Those that matter are:
38 LDAP_LIB_SOLARIS with synonym LDAP_LIB_SOLARIS7
41 These others may be defined, but are in fact the default, so are not tested:
47 #if defined(LDAP_LIB_SOLARIS7) && ! defined(LDAP_LIB_SOLARIS)
48 #define LDAP_LIB_SOLARIS
52 /* Just in case LDAP_NO_LIMIT is not defined by some of these libraries. */
55 #define LDAP_NO_LIMIT 0
59 /* Just in case LDAP_DEREF_NEVER is not defined */
61 #ifndef LDAP_DEREF_NEVER
62 #define LDAP_DEREF_NEVER 0
66 /* Four types of LDAP search are implemented */
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 */
73 /* In all 4 cases, the DN is left in $ldap_dn (which post-dates the
74 SEARCH_LDAP_DN lookup). */
77 /* Structure and anchor for caching connections. */
79 typedef struct ldap_connection {
80 struct ldap_connection *next;
86 BOOL is_start_tls_called;
90 static LDAP_CONNECTION *ldap_connections = NULL;
94 /*************************************************
95 * Internal search function *
96 *************************************************/
98 /* This is the function that actually does the work. It is called (indirectly
99 via control_ldap_search) from eldap_find(), eldapauth_find(), eldapdn_find(),
100 and eldapm_find(), with a difference in the "search_type" argument.
102 The case of eldapauth_find() is special in that all it does is do
103 authentication, returning OK or FAIL as appropriate. This isn't used as a
104 lookup. Instead, it is called via the generic search interface from expand.c
105 as an expansion condition test. We take a non/NULL return string as OK/FAIL.
106 We do not advertise or document it as a general search method,
109 The DN from a successful lookup is placed in $ldap_dn. This feature postdates
110 the provision of the SEARCH_LDAP_DN facility for returning just the DN as the
114 ldap_url the URL to be looked up
115 server server host name, when URL contains none
116 s_port server port, used when URL contains no name
117 search_type SEARCH_LDAP_MULTIPLE allows values from multiple entries
118 SEARCH_LDAP_SINGLE allows values from one entry only
119 SEARCH_LDAP_DN gets the DN from one entry
120 res set to point at the result (ldapauth gets an empty string if OK)
121 errmsg set to point a message if result is not OK
122 defer_break set TRUE if no more servers to be tried after a DEFER
123 user user name for authentication, or NULL
124 password password for authentication, or NULL
125 sizelimit max number of entries returned, or 0 for no limit
126 timelimit max time to wait, or 0 for no limit
127 tcplimit max time for network activity, e.g. connect, or 0 for OS default
128 deference the dereference option, which is one of
129 LDAP_DEREF_{NEVER,SEARCHING,FINDING,ALWAYS}
130 referrals the referral option, which is LDAP_OPT_ON or LDAP_OPT_OFF
132 Returns: OK or FAIL or DEFER
133 FAIL is given only if a lookup was performed successfully, but
138 perform_ldap_search(const uschar *ldap_url, uschar *server, int s_port,
139 int search_type, uschar **res, uschar **errmsg, BOOL *defer_break,
140 uschar *user, uschar *password, int sizelimit, int timelimit, int tcplimit,
141 int dereference, void *referrals)
143 LDAPURLDesc *ludp = NULL;
144 LDAPMessage *result = NULL;
146 LDAP_CONNECTION *lcp;
148 struct timeval timeout;
149 struct timeval *timeoutptr = NULL;
151 gstring * data = NULL;
158 uschar *error1 = NULL; /* string representation of errcode (static) */
159 uschar *error2 = NULL; /* error message from the server */
160 uschar *matched = NULL; /* partially matched DN */
162 int attrs_requested = 0;
163 int error_yield = DEFER;
165 int rc, ldap_rc, ldap_parse_rc;
168 BOOL attribute_found = FALSE;
171 DEBUG(D_lookup) debug_printf_indent("perform_ldap_search:"
172 " ldap%s URL = \"%s\" server=%s port=%d "
173 "sizelimit=%d timelimit=%d tcplimit=%d\n",
174 search_type == SEARCH_LDAP_MULTIPLE ? "m" :
175 search_type == SEARCH_LDAP_DN ? "dn" :
176 search_type == SEARCH_LDAP_AUTH ? "auth" : "",
177 ldap_url, server, s_port, sizelimit, timelimit, tcplimit);
179 /* Check if LDAP thinks the URL is a valid LDAP URL. We assume that if the LDAP
180 library that is in use doesn't recognize, say, "ldapi", it will barf here. */
182 if (!ldap_is_ldap_url(CS ldap_url))
184 *errmsg = string_sprintf("ldap_is_ldap_url: not an LDAP url \"%s\"\n",
186 goto RETURN_ERROR_BREAK;
191 if ((rc = ldap_url_parse(CS ldap_url, &ludp)) != 0)
193 *errmsg = string_sprintf("ldap_url_parse: (error %d) parsing \"%s\"\n", rc,
195 goto RETURN_ERROR_BREAK;
198 /* If the host name is empty, take it from the separate argument, if one is
199 given. OpenLDAP 2.0.6 sets an unset hostname to "" rather than empty, but
200 expects NULL later in ldap_init() to mean "default", annoyingly. In OpenLDAP
201 2.0.11 this has changed (it uses NULL). */
203 if ((!ludp->lud_host || !ludp->lud_host[0]) && server)
210 host = US ludp->lud_host;
211 if (host && !host[0]) host = NULL;
212 port = ludp->lud_port;
215 DEBUG(D_lookup) debug_printf_indent("after ldap_url_parse: host=%s port=%d\n",
218 if (port == 0) port = LDAP_PORT; /* Default if none given */
219 sprintf(CS porttext, ":%d", port); /* For messages */
221 /* If the "host name" is actually a path, we are going to connect using a Unix
222 socket, regardless of whether "ldapi" was actually specified or not. This means
223 that a Unix socket can be declared in eldap_default_servers, and "traditional"
224 LDAP queries using just "ldap" can be used ("ldaps" is similarly overridden).
225 The path may start with "/" or it may already be escaped as "%2F" if it was
226 actually declared that way in eldap_default_servers. (I did it that way the
227 first time.) If the host name is not a path, the use of "ldapi" causes an
228 error, except in the default case. (But lud_scheme doesn't seem to exist in
233 if ((host[0] == '/' || Ustrncmp(host, "%2F", 3) == 0))
236 porttext[0] = 0; /* Remove port from messages */
239 #if defined LDAP_LIB_OPENLDAP2
240 else if (strncmp(ludp->lud_scheme, "ldapi", 5) == 0)
242 *errmsg = string_sprintf("ldapi requires an absolute path (\"%s\" given)",
249 /* Count the attributes; we need this later to tell us how to format results */
251 for (uschar ** attrp = USS ludp->lud_attrs; attrp && *attrp; attrp++)
254 /* See if we can find a cached connection to this host. The port is not
255 relevant for ldapi. The host name pointer is set to NULL if no host was given
256 (implying the library default), rather than to the empty string. Note that in
257 this case, there is no difference between ldap and ldapi. */
259 for (lcp = ldap_connections; lcp; lcp = lcp->next)
261 if ((host == NULL) != (lcp->host == NULL) ||
262 (host != NULL && strcmpic(lcp->host, host) != 0))
264 if (ldapi || port == lcp->port) break;
267 /* Use this network timeout in any requests. */
271 timeout.tv_sec = tcplimit;
273 timeoutptr = &timeout;
276 /* If no cached connection found, we must open a connection to the server. If
277 the server name is actually an absolute path, we set ldapi=TRUE above. This
278 requests connection via a Unix socket. However, as far as I know, only OpenLDAP
279 supports the use of sockets, and the use of ldap_initialize(). */
285 #ifdef LDAP_OPT_X_TLS_NEWCTX
289 LDAP *ldsetctx = NULL;
293 /* --------------------------- OpenLDAP ------------------------ */
295 /* There seems to be a preference under OpenLDAP for ldap_initialize()
296 instead of ldap_init(), though I have as yet been unable to find
297 documentation that says this. (OpenLDAP documentation is sparse to
298 non-existent). So we handle OpenLDAP differently here. Also, support for
299 ldapi seems to be OpenLDAP-only at present. */
301 #ifdef LDAP_LIB_OPENLDAP2
303 /* We now need an empty string for the default host. Get some store in which
304 to build a URL for ldap_initialize(). In the ldapi case, it can't be bigger
305 than (9 + 3*Ustrlen(shost)), whereas in the other cases it can't be bigger
306 than the host name + "ldaps:///" plus : and a port number, say 20 + the
307 length of the host name. What we get should accommodate both, easily. */
309 uschar * shost = host ? host : US"";
310 rmark reset_point = store_mark();
313 /* Handle connection via Unix socket ("ldapi"). We build a basic LDAP URI to
314 contain the path name, with slashes escaped as %2F. */
318 g = string_catn(NULL, US"ldapi://", 8);
319 for (uschar ch; (ch = *shost); shost++)
320 g = ch == '/' ? string_catn(g, US"%2F", 3) : string_catn(g, shost, 1);
323 /* This is not an ldapi call. Just build a URI with the protocol type, host
328 uschar * init_ptr = Ustrchr(ldap_url, '/');
329 g = string_catn(NULL, ldap_url, init_ptr - ldap_url);
330 g = string_fmt_append(g, "//%s:%d/", shost, port);
333 /* Call ldap_initialize() and check the result */
335 const uschar * s = string_from_gstring(g);
337 DEBUG(D_lookup) debug_printf_indent("ldap_initialize with URL %s\n", s);
338 if ((rc = ldap_initialize(&ld, CS s)) != LDAP_SUCCESS)
340 *errmsg = string_sprintf("ldap_initialize: (error %d) URL \"%s\"\n",
345 store_reset(reset_point); /* Might as well save memory when we can */
348 /* ------------------------- Not OpenLDAP ---------------------- */
350 /* For libraries other than OpenLDAP, use ldap_init(). */
352 #else /* LDAP_LIB_OPENLDAP2 */
353 ld = ldap_init(CS host, port);
354 #endif /* LDAP_LIB_OPENLDAP2 */
356 /* -------------------------------------------------------------- */
359 /* Handle failure to initialize */
363 *errmsg = string_sprintf("failed to initialize for LDAP server %s%s - %s",
364 host, porttext, strerror(errno));
368 #ifdef LDAP_OPT_X_TLS_NEWCTX
372 /* Set the TCP connect time limit if available. This is something that is
373 in Netscape SDK v4.1; I don't know about other libraries. */
375 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT
378 int timeout1000 = tcplimit*1000;
379 ldap_set_option(ld, LDAP_X_OPT_CONNECT_TIMEOUT, (void *)&timeout1000);
383 int notimeout = LDAP_X_IO_TIMEOUT_NO_TIMEOUT;
384 ldap_set_option(ld, LDAP_X_OPT_CONNECT_TIMEOUT, (void *)¬imeout);
388 /* Set the TCP connect timeout. This works with OpenLDAP 2.2.14. */
390 #ifdef LDAP_OPT_NETWORK_TIMEOUT
392 ldap_set_option(ld, LDAP_OPT_NETWORK_TIMEOUT, (void *)timeoutptr);
395 /* I could not get TLS to work until I set the version to 3. That version
396 seems to be the default nowadays. The RFC is dated 1997, so I would hope
397 that all the LDAP libraries support it. Therefore, if eldap_version hasn't
398 been set, go for v3 if we can. */
400 if (eldap_version < 0)
403 eldap_version = LDAP_VERSION3;
409 #ifdef LDAP_OPT_PROTOCOL_VERSION
410 ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, (void *)&eldap_version);
413 DEBUG(D_lookup) debug_printf_indent("initialized for LDAP (v%d) server %s%s\n",
414 eldap_version, host, porttext);
416 /* If not using ldapi and TLS is available, set appropriate TLS options: hard
417 for "ldaps" and soft otherwise. */
419 #ifdef LDAP_OPT_X_TLS
423 # ifdef LDAP_OPT_X_TLS_REQUIRE_CERT
424 if (eldap_require_cert)
427 Ustrcmp(eldap_require_cert, "hard") == 0 ? LDAP_OPT_X_TLS_HARD
428 : Ustrcmp(eldap_require_cert, "demand") == 0 ? LDAP_OPT_X_TLS_DEMAND
429 : Ustrcmp(eldap_require_cert, "allow") == 0 ? LDAP_OPT_X_TLS_ALLOW
430 : Ustrcmp(eldap_require_cert, "try") == 0 ? LDAP_OPT_X_TLS_TRY
431 : LDAP_OPT_X_TLS_NEVER;
433 DEBUG(D_lookup) debug_printf_indent(
434 "Require certificate overrides LDAP_OPT_X_TLS option (%d)\n",
438 # endif /* LDAP_OPT_X_TLS_REQUIRE_CERT */
439 if (strncmp(ludp->lud_scheme, "ldaps", 5) == 0)
441 tls_option = LDAP_OPT_X_TLS_HARD;
443 debug_printf_indent("LDAP_OPT_X_TLS_HARD set due to ldaps:// URI\n");
447 tls_option = LDAP_OPT_X_TLS_TRY;
449 debug_printf_indent("LDAP_OPT_X_TLS_TRY set due to ldap:// URI\n");
451 ldap_set_option(ld, LDAP_OPT_X_TLS, (void *)&tls_option);
453 #endif /* LDAP_OPT_X_TLS */
455 #ifdef LDAP_OPT_X_TLS_CACERTFILE
456 if (eldap_ca_cert_file)
457 ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_CACERTFILE, eldap_ca_cert_file);
459 #ifdef LDAP_OPT_X_TLS_CACERTDIR
460 if (eldap_ca_cert_dir)
461 ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_CACERTDIR, eldap_ca_cert_dir);
463 #ifdef LDAP_OPT_X_TLS_CERTFILE
465 ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_CERTFILE, eldap_cert_file);
467 #ifdef LDAP_OPT_X_TLS_KEYFILE
469 ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_KEYFILE, eldap_cert_key);
471 #ifdef LDAP_OPT_X_TLS_CIPHER_SUITE
472 if (eldap_cipher_suite)
473 ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_CIPHER_SUITE, eldap_cipher_suite);
475 #ifdef LDAP_OPT_X_TLS_REQUIRE_CERT
476 if (eldap_require_cert)
479 Ustrcmp(eldap_require_cert, "hard") == 0 ? LDAP_OPT_X_TLS_HARD
480 : Ustrcmp(eldap_require_cert, "demand") == 0 ? LDAP_OPT_X_TLS_DEMAND
481 : Ustrcmp(eldap_require_cert, "allow") == 0 ? LDAP_OPT_X_TLS_ALLOW
482 : Ustrcmp(eldap_require_cert, "try") == 0 ? LDAP_OPT_X_TLS_TRY
483 : LDAP_OPT_X_TLS_NEVER;
485 /* This ldap handle is set at compile time based on client libs. Older
486 * versions want it to be global and newer versions can force a reload
487 * of the TLS context (to reload these settings we are changing from the
488 * default that loaded at instantiation). */
489 rc = ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_REQUIRE_CERT, &cert_option);
492 debug_printf_indent("Unable to set TLS require cert_option(%d) globally: %s\n",
493 cert_option, ldap_err2string(rc));
496 #ifdef LDAP_OPT_X_TLS_NEWCTX
497 if ((rc = ldap_set_option(ldsetctx, LDAP_OPT_X_TLS_NEWCTX, &am_server)))
499 debug_printf_indent("Unable to reload TLS context %d: %s\n",
500 rc, ldap_err2string(rc));
503 /* Now add this connection to the chain of cached connections */
505 lcp = store_get(sizeof(LDAP_CONNECTION), GET_UNTAINTED);
506 lcp->host = host ? string_copy(host) : NULL;
509 lcp->password = NULL;
512 lcp->next = ldap_connections;
513 lcp->is_start_tls_called = FALSE;
514 ldap_connections = lcp;
517 /* Found cached connection */
521 debug_printf_indent("re-using cached connection to LDAP server %s%s\n",
524 /* Bind with the user/password supplied, or an anonymous bind if these values
525 are NULL, unless a cached connection is already bound with the same values. */
528 || !lcp->user && user
529 || lcp->user && !user
530 || lcp->user && user && Ustrcmp(lcp->user, user) != 0
531 || !lcp->password && password
532 || lcp->password && !password
533 || lcp->password && password && Ustrcmp(lcp->password, password) != 0
536 DEBUG(D_lookup) debug_printf_indent("%sbinding with user=%s password=%s\n",
537 lcp->bound ? "re-" : "", user, password);
539 if (eldap_start_tls && !lcp->is_start_tls_called && !ldapi)
541 #if defined(LDAP_OPT_X_TLS) && !defined(LDAP_LIB_SOLARIS)
542 /* The Oracle LDAP libraries (LDAP_LIB_TYPE=SOLARIS) don't support this.
543 * Note: moreover, they appear to now define LDAP_OPT_X_TLS and still not
544 * export an ldap_start_tls_s symbol.
546 if ( (rc = ldap_start_tls_s(lcp->ld, NULL, NULL)) != LDAP_SUCCESS)
548 *errmsg = string_sprintf("failed to initiate TLS processing on an "
549 "LDAP session to server %s%s - ldap_start_tls_s() returned %d:"
550 " %s", host, porttext, rc, ldap_err2string(rc));
553 lcp->is_start_tls_called = TRUE;
555 DEBUG(D_lookup) debug_printf_indent("TLS initiation not supported with this Exim"
556 " and your LDAP library.\n");
559 if ((msgid = ldap_bind(lcp->ld, CS user, CS password, LDAP_AUTH_SIMPLE))
562 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
563 "%s%s - ldap_bind() returned -1", host, porttext);
567 if ((rc = ldap_result(lcp->ld, msgid, 1, timeoutptr, &result)) <= 0)
569 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
570 "%s%s - LDAP error: %s", host, porttext,
571 rc == -1 ? "result retrieval failed" : "timeout" );
576 rc = ldap_result2error(lcp->ld, result, 0);
578 /* Invalid credentials when just checking credentials returns FAIL. This
579 stops any further servers being tried. */
581 if (search_type == SEARCH_LDAP_AUTH && rc == LDAP_INVALID_CREDENTIALS)
584 debug_printf_indent("Invalid credentials: ldapauth returns FAIL\n");
586 goto RETURN_ERROR_NOMSG;
589 /* Otherwise we have a problem that doesn't stop further servers from being
592 if (rc != LDAP_SUCCESS)
594 *errmsg = string_sprintf("failed to bind the LDAP connection to server "
595 "%s%s - LDAP error %d: %s", host, porttext, rc, ldap_err2string(rc));
599 /* Successful bind */
602 lcp->user = !user ? NULL : string_copy(user);
603 lcp->password = !password ? NULL : string_copy(password);
605 ldap_msgfree(result);
609 /* If we are just checking credentials, return OK. */
611 if (search_type == SEARCH_LDAP_AUTH)
613 DEBUG(D_lookup) debug_printf_indent("Bind succeeded: ldapauth returns OK\n");
618 /* Before doing the search, set the time and size limits (if given). Here again
619 the different implementations of LDAP have chosen to do things differently. */
621 #if defined(LDAP_OPT_SIZELIMIT)
622 ldap_set_option(lcp->ld, LDAP_OPT_SIZELIMIT, (void *)&sizelimit);
623 ldap_set_option(lcp->ld, LDAP_OPT_TIMELIMIT, (void *)&timelimit);
625 lcp->ld->ld_sizelimit = sizelimit;
626 lcp->ld->ld_timelimit = timelimit;
629 /* Similarly for dereferencing aliases. Don't know if this is possible on
630 an LDAP library without LDAP_OPT_DEREF. */
632 #if defined(LDAP_OPT_DEREF)
633 ldap_set_option(lcp->ld, LDAP_OPT_DEREF, (void *)&dereference);
636 /* Similarly for the referral setting; should the library follow referrals that
637 the LDAP server returns? The conditional is just in case someone uses a library
640 #if defined(LDAP_OPT_REFERRALS)
641 ldap_set_option(lcp->ld, LDAP_OPT_REFERRALS, referrals);
644 /* Start the search on the server. */
646 DEBUG(D_lookup) debug_printf_indent("Start search\n");
648 msgid = ldap_search(lcp->ld, ludp->lud_dn, ludp->lud_scope, ludp->lud_filter,
653 #if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
655 ldap_get_option(lcp->ld, LDAP_OPT_ERROR_NUMBER, &err);
656 *errmsg = string_sprintf("ldap_search failed: %d, %s", err,
657 ldap_err2string(err));
659 *errmsg = string_sprintf("ldap_search failed");
665 /* Loop to pick up results as they come in, setting a timeout if one was
668 while ((rc = ldap_result(lcp->ld, msgid, 0, timeoutptr, &result)) ==
669 LDAP_RES_SEARCH_ENTRY)
672 int valuecount; /* We can see an attr spread across several
673 entries. If B is derived from A and we request
674 A and the directory contains both, A and B,
675 then we get two entries, one for A and one for B.
676 Here we just count the values per entry */
678 DEBUG(D_lookup) debug_printf_indent("LDAP result loop\n");
680 for(e = ldap_first_entry(lcp->ld, result), valuecount = 0;
682 e = ldap_next_entry(lcp->ld, e))
685 BOOL insert_space = FALSE;
687 DEBUG(D_lookup) debug_printf_indent("LDAP entry loop\n");
689 rescount++; /* Count results */
691 /* Results for multiple entries values are separated by newlines. */
693 if (data) data = string_catn(data, US"\n", 1);
695 /* Get the DN from the last result. */
697 if ((new_dn = US ldap_get_dn(lcp->ld, e)))
701 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
703 #else /* OPENLDAP 1, UMich, Solaris */
711 /* If the data we want is actually the DN rather than any attribute values,
712 (an "ldapdn" search) add it to the data string. If there are multiple
713 entries, the DNs will be concatenated, but we test for this case below, as
714 for SEARCH_LDAP_SINGLE, and give an error. */
716 if (search_type == SEARCH_LDAP_DN) /* Do not amalgamate these into one */
717 { /* condition, because of the else */
718 if (new_dn) /* below, that's for the first only */
720 data = string_cat(data, new_dn);
721 (void) string_from_gstring(data);
722 attribute_found = TRUE;
726 /* Otherwise, loop through the entry, grabbing attribute values. If there's
727 only one attribute being retrieved, no attribute name is given, and the
728 result is not quoted. Multiple values are separated by (comma).
729 If more than one attribute is being retrieved, the data is given as a
730 sequence of name=value pairs, separated by (space), with the value always in quotes.
731 If there are multiple values, they are given within the quotes, comma separated. */
733 else for (uschar * attr = US ldap_first_attribute(lcp->ld, e, &ber);
734 attr; attr = US ldap_next_attribute(lcp->ld, e, ber))
736 DEBUG(D_lookup) debug_printf_indent("LDAP attr loop\n");
738 /* In case of attrs_requested == 1 we just count the values, in all other cases
739 (0, >1) we count the values per attribute */
740 if (attrs_requested != 1) valuecount = 0;
744 /* Get array of values for this attribute. */
746 if ((firstval = values = USS ldap_get_values(lcp->ld, e, CS attr)))
748 if (attrs_requested != 1)
751 data = string_catn(data, US" ", 1);
754 data = string_cat(data, attr);
755 data = string_catn(data, US"=\"", 2);
760 uschar *value = *values;
761 int len = Ustrlen(value);
764 DEBUG(D_lookup) debug_printf_indent("LDAP value loop %s:%s\n", attr, value);
766 /* In case we requested one attribute only but got several times
767 into that attr loop, we need to append the additional values.
768 (This may happen if you derive attributeTypes B and C from A and
769 then query for A.) In all other cases we detect the different
770 attribute and append only every non first value. */
772 if (data && valuecount > 1)
773 data = string_catn(data, US",", 1);
775 /* For multiple attributes, the data is in quotes. We must escape
776 internal quotes, backslashes, newlines, and must double commas. */
778 if (attrs_requested != 1)
779 for (int j = 0; j < len; j++)
781 if (value[j] == '\n')
782 data = string_catn(data, US"\\n", 2);
783 else if (value[j] == ',')
784 data = string_catn(data, US",,", 2);
787 if (value[j] == '\"' || value[j] == '\\')
788 data = string_catn(data, US"\\", 1);
789 data = string_catn(data, value+j, 1);
793 /* For single attributes, just double commas */
796 for (int j = 0; j < len; j++)
798 data = string_catn(data, US",,", 2);
800 data = string_catn(data, value+j, 1);
803 /* Move on to the next value */
806 attribute_found = TRUE;
809 /* Closing quote at the end of the data for a named attribute. */
811 if (attrs_requested != 1)
812 data = string_catn(data, US"\"", 1);
814 /* Free the values */
816 ldap_value_free(CSS firstval);
820 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
822 /* Netscape and OpenLDAP2 LDAP's attrs are dynamically allocated and need
823 to be freed. UMich LDAP stores them in static storage and does not require
828 } /* End "for" loop for extracting attributes from an entry */
829 } /* End "for" loop for extracting entries from a result */
831 /* Free the result */
833 ldap_msgfree(result);
835 } /* End "while" loop for multiple results */
837 /* Terminate the dynamic string that we have built and reclaim unused store.
838 In the odd case of a single attribute with zero-length value, allocate
841 if (!data) data = string_get(1);
842 (void) string_from_gstring(data);
843 gstring_release_unused(data);
845 /* Copy the last dn into eldap_dn */
849 eldap_dn = string_copy(dn);
850 #if defined LDAP_LIB_NETSCAPE || defined LDAP_LIB_OPENLDAP2
852 #else /* OPENLDAP 1, UMich, Solaris */
857 DEBUG(D_lookup) debug_printf_indent("search ended by ldap_result yielding %d\n",rc);
861 *errmsg = US"ldap_result timed out";
865 /* A return code of -1 seems to mean "ldap_result failed internally or couldn't
866 provide you with a message". Other error states seem to exist where
867 ldap_result() didn't give us any message from the server at all, leaving result
868 set to NULL. Apparently, "the error parameters of the LDAP session handle will
869 be set accordingly". That's the best we can do to retrieve an error status; we
870 can't use functions like ldap_result2error because they parse a message from
871 the server, which we didn't get.
873 Annoyingly, the different implementations of LDAP have gone for different
874 methods of handling error codes and generating error messages. */
876 if (rc == -1 || !result)
879 DEBUG(D_lookup) debug_printf_indent("ldap_result failed\n");
881 #if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
882 ldap_get_option(lcp->ld, LDAP_OPT_ERROR_NUMBER, &err);
883 *errmsg = string_sprintf("ldap_result failed: %d, %s",
884 err, ldap_err2string(err));
886 #elif defined LDAP_LIB_NETSCAPE
887 /* Dubious (surely 'matched' is spurious here?) */
888 (void)ldap_get_lderrno(lcp->ld, &matched, &error1);
889 *errmsg = string_sprintf("ldap_result failed: %s (%s)", error1, matched);
891 #else /* UMich LDAP aka OpenLDAP 1.x */
892 *errmsg = string_sprintf("ldap_result failed: %d, %s",
893 lcp->ld->ld_errno, ldap_err2string(lcp->ld->ld_errno));
899 /* A return code that isn't -1 doesn't necessarily mean there were no problems
900 with the search. The message must be an LDAP_RES_SEARCH_RESULT or
901 LDAP_RES_SEARCH_REFERENCE or else it's something we can't handle. Some versions
902 of LDAP do not define LDAP_RES_SEARCH_REFERENCE (LDAP v1 is one, it seems). So
903 we don't provide that functionality when we can't. :-) */
905 if (rc != LDAP_RES_SEARCH_RESULT
906 #ifdef LDAP_RES_SEARCH_REFERENCE
907 && rc != LDAP_RES_SEARCH_REFERENCE
911 *errmsg = string_sprintf("ldap_result returned unexpected code %d", rc);
915 /* We have a result message from the server. This doesn't yet mean all is well.
916 We need to parse the message to find out exactly what's happened. */
918 #if defined LDAP_LIB_SOLARIS || defined LDAP_LIB_OPENLDAP2
920 ldap_parse_rc = ldap_parse_result(lcp->ld, result, &rc, CSS &matched,
921 CSS &error2, NULL, NULL, 0);
922 DEBUG(D_lookup) debug_printf_indent("ldap_parse_result: %d\n", ldap_parse_rc);
923 if (ldap_parse_rc < 0 &&
924 (ldap_parse_rc != LDAP_NO_RESULTS_RETURNED
925 #ifdef LDAP_RES_SEARCH_REFERENCE
926 || ldap_rc != LDAP_RES_SEARCH_REFERENCE
930 *errmsg = string_sprintf("ldap_parse_result failed %d", ldap_parse_rc);
933 error1 = US ldap_err2string(rc);
935 #elif defined LDAP_LIB_NETSCAPE
936 /* Dubious (it doesn't reference 'result' at all!) */
937 rc = ldap_get_lderrno(lcp->ld, &matched, &error1);
939 #else /* UMich LDAP aka OpenLDAP 1.x */
940 rc = ldap_result2error(lcp->ld, result, 0);
941 error1 = ldap_err2string(rc);
942 error2 = lcp->ld->ld_error;
943 matched = lcp->ld->ld_matched;
946 /* Process the status as follows:
948 (1) If we get LDAP_SIZELIMIT_EXCEEDED, just carry on, to return the
949 truncated result list.
951 (2) If we get LDAP_RES_SEARCH_REFERENCE, also just carry on. This was a
952 submitted patch that is reported to "do the right thing" with Solaris
953 LDAP libraries. (The problem it addresses apparently does not occur with
956 (3) The range of errors defined by LDAP_NAME_ERROR generally mean "that
957 object does not, or cannot, exist in the database". For those cases we
960 (4) All other non-successes here are treated as some kind of problem with
961 the lookup, so return DEFER (which is the default in error_yield).
964 DEBUG(D_lookup) debug_printf_indent("ldap_parse_result yielded %d: %s\n",
965 rc, ldap_err2string(rc));
967 if (rc != LDAP_SUCCESS && rc != LDAP_SIZELIMIT_EXCEEDED
968 #ifdef LDAP_RES_SEARCH_REFERENCE
969 && rc != LDAP_RES_SEARCH_REFERENCE
973 *errmsg = string_sprintf("LDAP search failed - error %d: %s%s%s%s%s",
975 error1 ? error1 : US"",
976 error2 && error2[0] ? US"/" : US"",
977 error2 ? error2 : US"",
978 matched && matched[0] ? US"/" : US"",
979 matched ? matched : US"");
981 #if defined LDAP_NAME_ERROR
982 if (LDAP_NAME_ERROR(rc))
983 #elif defined NAME_ERROR /* OPENLDAP1 calls it this */
986 if (rc == LDAP_NO_SUCH_OBJECT)
990 DEBUG(D_lookup) debug_printf_indent("lookup failure forced\n");
996 /* The search succeeded. Check if we have too many results */
998 if (search_type != SEARCH_LDAP_MULTIPLE && rescount > 1)
1000 *errmsg = string_sprintf("LDAP search: more than one entry (%d) was returned "
1001 "(filter not specific enough?)", rescount);
1002 goto RETURN_ERROR_BREAK;
1005 /* Check if we have too few (zero) entries */
1009 *errmsg = US"LDAP search: no results";
1011 goto RETURN_ERROR_BREAK;
1014 /* If an entry was found, but it had no attributes, we behave as if no entries
1015 were found, that is, the lookup failed. */
1017 if (!attribute_found)
1019 *errmsg = US"LDAP search: found no attributes";
1024 /* Otherwise, it's all worked */
1026 DEBUG(D_lookup) debug_printf_indent("LDAP search: returning: %s\n", data->s);
1030 if (result) ldap_msgfree(result);
1031 ldap_free_urldesc(ludp);
1037 *defer_break = TRUE;
1040 DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);
1043 if (result) ldap_msgfree(result);
1044 if (ludp) ldap_free_urldesc(ludp);
1046 #if defined LDAP_LIB_OPENLDAP2
1047 if (error2) ldap_memfree(error2);
1048 if (matched) ldap_memfree(matched);
1056 /*************************************************
1057 * Internal search control function *
1058 *************************************************/
1060 /* This function is called from eldap_find(), eldapauth_find(), eldapdn_find(),
1061 and eldapm_find() with a difference in the "search_type" argument. It controls
1062 calls to perform_ldap_search() which actually does the work. We call that
1063 repeatedly for certain types of defer in the case when the URL contains no host
1064 name and eldap_default_servers is set to a list of servers to try. This gives
1065 more control than just passing over a list of hosts to ldap_open() because it
1066 handles other kinds of defer as well as just a failure to open. Note that the
1067 URL is defined to contain either zero or one "hostport" only.
1069 Parameter data in addition to the URL can be passed as preceding text in the
1070 string, as items of the form XXX=yyy. The URL itself can be detected because it
1071 must begin "ldapx://", where x is empty, s, or i.
1074 ldap_url the URL to be looked up, optionally preceded by other parameter
1076 search_type SEARCH_LDAP_MULTIPLE allows values from multiple entries
1077 SEARCH_LDAP_SINGLE allows values from one entry only
1078 SEARCH_LDAP_DN gets the DN from one entry
1079 res set to point at the result
1080 errmsg set to point a message if result is not OK
1082 Returns: OK or FAIL or DEFER
1086 control_ldap_search(const uschar *ldap_url, int search_type, uschar **res,
1089 BOOL defer_break = FALSE;
1090 int timelimit = LDAP_NO_LIMIT, sizelimit = LDAP_NO_LIMIT;
1093 int dereference = LDAP_DEREF_NEVER;
1094 void * referrals = LDAP_OPT_ON;
1095 const uschar * url = ldap_url, * p, * list;
1096 uschar * user = NULL, * password = NULL, * local_servers = NULL;
1098 Uskip_whitespace(&url);
1100 /* Until the string begins "ldap", search for the other parameter settings that
1101 are recognized. They are of the form NAME=VALUE, with the value being
1102 optionally double-quoted. There must still be a space after it, however. No
1103 NAME has the value "ldap". */
1105 while (strncmpic(url, US"ldap", 4) != 0)
1107 const uschar *name = url;
1108 while (*url && *url != '=') url++;
1113 namelen = ++url - name;
1114 value = string_dequote(&url);
1117 if (strncmpic(name, US"USER=", namelen) == 0) user = value;
1118 else if (strncmpic(name, US"PASS=", namelen) == 0) password = value;
1119 else if (strncmpic(name, US"SIZE=", namelen) == 0) sizelimit = Uatoi(value);
1120 else if (strncmpic(name, US"TIME=", namelen) == 0) timelimit = Uatoi(value);
1121 else if (strncmpic(name, US"CONNECT=", namelen) == 0) tcplimit = Uatoi(value);
1122 else if (strncmpic(name, US"NETTIME=", namelen) == 0) tcplimit = Uatoi(value);
1123 else if (strncmpic(name, US"SERVERS=", namelen) == 0) local_servers = value;
1125 /* Don't know if all LDAP libraries have LDAP_OPT_DEREF */
1127 #ifdef LDAP_OPT_DEREF
1128 else if (strncmpic(name, US"DEREFERENCE=", namelen) == 0)
1130 if (strcmpic(value, US"never") == 0) dereference = LDAP_DEREF_NEVER;
1131 else if (strcmpic(value, US"searching") == 0)
1132 dereference = LDAP_DEREF_SEARCHING;
1133 else if (strcmpic(value, US"finding") == 0)
1134 dereference = LDAP_DEREF_FINDING;
1135 if (strcmpic(value, US"always") == 0) dereference = LDAP_DEREF_ALWAYS;
1138 else if (strncmpic(name, US"DEREFERENCE=", namelen) == 0)
1140 *errmsg = string_sprintf("LDAP_OP_DEREF not defined in this LDAP "
1141 "library - cannot use \"dereference\"");
1142 DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);
1147 #ifdef LDAP_OPT_REFERRALS
1148 else if (strncmpic(name, US"REFERRALS=", namelen) == 0)
1150 if (strcmpic(value, US"follow") == 0) referrals = LDAP_OPT_ON;
1151 else if (strcmpic(value, US"nofollow") == 0) referrals = LDAP_OPT_OFF;
1154 *errmsg = US"LDAP option REFERRALS is not \"follow\" or \"nofollow\"";
1155 DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);
1160 else if (strncmpic(name, US"REFERRALS=", namelen) == 0)
1162 *errmsg = string_sprintf("LDAP_OP_REFERRALS not defined in this LDAP "
1163 "library - cannot use \"referrals\"");
1164 DEBUG(D_lookup) debug_printf_indent("%s\n", *errmsg);
1172 string_sprintf("unknown parameter \"%.*s\" precedes LDAP URL",
1174 DEBUG(D_lookup) debug_printf_indent("LDAP query error: %s\n", *errmsg);
1177 Uskip_whitespace(&url);
1181 *errmsg = US"malformed parameter setting precedes LDAP URL";
1182 DEBUG(D_lookup) debug_printf_indent("LDAP query error: %s\n", *errmsg);
1186 /* If user is set, de-URL-quote it. Some LDAP libraries do this for themselves,
1187 but it seems that not all behave like this. The DN for the user is often the
1188 result of ${quote_ldap_dn:...} quoting, which does apply URL quoting, because
1189 that is needed when the DN is used as a base DN in a query. Sigh. This is all
1190 far too complicated. */
1195 for (uschar * s = user; *s != 0; s++)
1198 if (*s == '%' && isxdigit(c=s[1]) && isxdigit(d=s[2]))
1203 (((c >= 'a')? (10 + c - 'a') : c - '0') << 4) |
1204 ((d >= 'a')? (10 + d - 'a') : d - '0');
1213 debug_printf_indent("LDAP parameters: user=%s pass=%s size=%d time=%d connect=%d "
1214 "dereference=%d referrals=%s\n", user, password, sizelimit, timelimit,
1215 tcplimit, dereference, referrals == LDAP_OPT_ON ? "on" : "off");
1217 /* If the request is just to check authentication, some credentials must
1218 be given. The password must not be empty because LDAP binds with an empty
1219 password are considered anonymous, and will succeed on most installations. */
1221 if (search_type == SEARCH_LDAP_AUTH)
1223 if (!user || !password)
1225 *errmsg = US"ldapauth lookups must specify the username and password";
1230 DEBUG(D_lookup) debug_printf_indent("Empty password: ldapauth returns FAIL\n");
1235 /* Check for valid ldap url starters */
1238 if (tolower(*p) == 's' || tolower(*p) == 'i') p++;
1239 if (Ustrncmp(p, "://", 3) != 0)
1241 *errmsg = string_sprintf("LDAP URL does not start with \"ldap://\", "
1242 "\"ldaps://\", or \"ldapi://\" (it starts with \"%.16s...\")", url);
1243 DEBUG(D_lookup) debug_printf_indent("LDAP query error: %s\n", *errmsg);
1247 /* No default servers, or URL contains a server name: just one attempt */
1249 if (!eldap_default_servers && !local_servers || p[3] != '/')
1250 return perform_ldap_search(url, NULL, 0, search_type, res, errmsg,
1251 &defer_break, user, password, sizelimit, timelimit, tcplimit, dereference,
1254 /* Loop through the servers until OK or FAIL. Use local_servers list
1255 if defined in the lookup, otherwise use the global default list */
1257 list = local_servers ? local_servers : eldap_default_servers;
1258 for (uschar * server; server = string_nextinlist(&list, &sep, NULL, 0); )
1261 uschar *colon = Ustrchr(server, ':');
1265 port = Uatoi(colon+1);
1267 rc = perform_ldap_search(url, server, port, search_type, res, errmsg,
1268 &defer_break, user, password, sizelimit, timelimit, tcplimit, dereference,
1270 if (rc != DEFER || defer_break) return rc;
1278 /*************************************************
1279 * Find entry point *
1280 *************************************************/
1282 /* See local README for interface description. The different kinds of search
1283 are handled by a common function, with a flag to differentiate between them.
1284 The handle and filename arguments are not used. */
1287 eldap_find(void * handle, const uschar * filename, const uschar * ldap_url,
1288 int length, uschar ** result, uschar ** errmsg, uint * do_cache,
1289 const uschar * opts)
1291 return(control_ldap_search(ldap_url, SEARCH_LDAP_SINGLE, result, errmsg));
1295 eldapm_find(void * handle, const uschar * filename, const uschar * ldap_url,
1296 int length, uschar ** result, uschar ** errmsg, uint * do_cache,
1297 const uschar * opts)
1299 return(control_ldap_search(ldap_url, SEARCH_LDAP_MULTIPLE, result, errmsg));
1303 eldapdn_find(void * handle, const uschar * filename, const uschar * ldap_url,
1304 int length, uschar ** result, uschar ** errmsg, uint * do_cache,
1305 const uschar * opts)
1307 return(control_ldap_search(ldap_url, SEARCH_LDAP_DN, result, errmsg));
1311 eldapauth_find(void * handle, const uschar * filename, const uschar * ldap_url,
1312 int length, uschar ** result, uschar ** errmsg, uint * do_cache,
1313 const uschar * opts)
1315 return(control_ldap_search(ldap_url, SEARCH_LDAP_AUTH, result, errmsg));
1320 /*************************************************
1321 * Open entry point *
1322 *************************************************/
1324 /* See local README for interface description. */
1327 eldap_open(const uschar * filename, uschar ** errmsg)
1329 return (void *)(1); /* Just return something non-null */
1334 /*************************************************
1335 * Tidy entry point *
1336 *************************************************/
1338 /* See local README for interface description.
1339 Make sure that eldap_dn does not refer to reclaimed or worse, freed store */
1346 for (LDAP_CONNECTION *lcp; lcp = ldap_connections; ldap_connections = lcp->next)
1348 DEBUG(D_lookup) debug_printf_indent("unbind LDAP connection to %s:%d\n",
1349 lcp->host, lcp->port);
1350 if(lcp->bound) ldap_unbind(lcp->ld);
1356 /*************************************************
1357 * Quote entry point *
1358 *************************************************/
1360 /* LDAP quoting is unbelievably messy. For a start, two different levels of
1361 quoting have to be done: LDAP quoting, and URL quoting. The current
1362 specification is the result of a suggestion by Brian Candler. It recognizes
1365 (1) For text that appears in a search filter, the following escapes are
1366 required (see RFC 2254):
1374 Then the entire filter text must be URL-escaped. This kind of quoting is
1375 implemented by ${quote_ldap:....}. Note that we can never have a NULL
1376 in the input string, because that's a terminator.
1378 (2) For a DN that is part of a URL (i.e. the base DN), the characters
1382 must be quoted by backslashing. See RFC 2253. Leading and trailing spaces
1383 must be escaped, as must a leading #. Then the string must be URL-quoted.
1384 This type of quoting is implemented by ${quote_ldap_dn:....}.
1386 For URL quoting, the only characters that need not be quoted are the
1391 All the others must be hexified and preceded by %. This includes the
1392 backslashes used for LDAP quoting.
1394 For a DN that is given in the USER parameter for authentication, we need the
1395 same initial quoting as (2) but in this case, the result must NOT be
1396 URL-escaped, because it isn't a URL. The way this is handled is by
1397 de-URL-quoting the text when processing the USER parameter in
1398 control_ldap_search() above. That means that the same quote operator can be
1399 used. This has the additional advantage that spaces in the DN won't cause
1400 parsing problems. For example:
1402 USER=cn=${quote_ldap_dn:$1},%20dc=example,%20dc=com
1404 should be safe if there are spaces in $1.
1408 s the string to be quoted
1409 opt additional option text or NULL if none
1410 only "dn" is recognized
1411 idx lookup type index
1413 Returns: the processed string or NULL for a bad option
1418 /* The characters in this string, together with alphanumerics, never need
1419 quoting in any way. */
1421 #define ALWAYS_LITERAL "!$'-._"
1423 /* The special characters in this string do not need to be URL-quoted. The set
1424 is a bit larger than the general literals. */
1426 #define URL_NONQUOTE ALWAYS_LITERAL "()*+"
1428 /* The following macros define the characters that are quoted by quote_ldap and
1429 quote_ldap_dn, respectively. */
1431 #define LDAP_QUOTE "*()\\"
1432 #define LDAP_DN_QUOTE ",+\"\\<>;"
1437 eldap_quote(uschar * s, uschar * opt, unsigned idx)
1439 int c, count = 0, len = 0;
1441 uschar * t = s, * quoted;
1443 /* Test for a DN quotation. */
1447 if (Ustrcmp(opt, "dn") != 0) return NULL; /* No others recognized */
1451 /* Compute how much extra store we need for the string. This doesn't have to be
1452 exact as long as it isn't an underestimate. The worst case is the addition of 5
1453 extra bytes for a single character. This occurs for certain characters in DNs,
1454 where, for example, < turns into %5C%3C. For simplicity, we just add 5 for each
1455 possibly escaped character. The really fast way would be just to test for
1456 non-alphanumerics, but it is probably better to spot a few others that are
1457 never escaped, because if there are no specials at all, we can avoid copying
1459 XXX No longer true; we always copy, to support quoted-enforcement */
1464 if (!isalnum(c) && Ustrchr(ALWAYS_LITERAL, c) == NULL) count += 5;
1466 /*if (count == 0) return s;*/
1468 /* Get sufficient store to hold the quoted string */
1470 t = quoted = store_get_quoted(len + count + 1, s, idx);
1472 /* Handle plain quote_ldap */
1480 if (Ustrchr(LDAP_QUOTE, c) != NULL)
1482 sprintf(CS t, "%%5C%02X", c); /* e.g. * => %5C2A */
1486 if (Ustrchr(URL_NONQUOTE, c) == NULL) /* e.g. ] => %5D */
1488 sprintf(CS t, "%%%02X", c);
1493 *t++ = c; /* unquoted character */
1497 /* Handle quote_ldap_dn */
1501 uschar * ss = s + len;
1503 /* Find the last char before any trailing spaces */
1505 while (ss > s && ss[-1] == ' ') ss--;
1507 /* Quote leading spaces and sharps */
1511 if (*s != ' ' && *s != '#') break;
1512 sprintf(CS t, "%%5C%%%02X", *s);
1516 /* Handle the rest of the string, up to the trailing spaces */
1523 if (Ustrchr(LDAP_DN_QUOTE, c) != NULL)
1525 memcpy(t, US"%5C", 3); /* insert \ where needed */
1526 t += 3; /* fall through to check URL */
1528 if (Ustrchr(URL_NONQUOTE, c) == NULL) /* e.g. ] => %5D */
1530 sprintf(CS t, "%%%02X", c);
1535 *t++ = c; /* unquoted character, or non-URL quoted after %5C */
1538 /* Handle the trailing spaces */
1542 memcpy(t, US"%5C%20", 6);
1547 /* Terminate the new string and return */
1555 /*************************************************
1556 * Version reporting entry point *
1557 *************************************************/
1559 /* See local README for interface description. */
1561 #include "../version.h"
1564 ldap_version_report(gstring * g)
1567 /*XXX it would be nice to haul a version string for the underlying ldap library */
1568 g = string_fmt_append(g, "Library version: LDAP: Exim version %s\n", EXIM_VERSION_STR);
1574 static lookup_info ldap_lookup_info = {
1575 .name = US"ldap", /* lookup name */
1576 .type = lookup_querystyle, /* query-style lookup */
1577 .open = eldap_open, /* open function */
1578 .check = NULL, /* check function */
1579 .find = eldap_find, /* find function */
1580 .close = NULL, /* no close function */
1581 .tidy = eldap_tidy, /* tidy function */
1582 .quote = eldap_quote, /* quoting function */
1583 .version_report = ldap_version_report /* version reporting */
1586 static lookup_info ldapdn_lookup_info = {
1587 .name = US"ldapdn", /* lookup name */
1588 .type = lookup_querystyle, /* query-style lookup */
1589 .open = eldap_open, /* sic */ /* open function */
1590 .check = NULL, /* check function */
1591 .find = eldapdn_find, /* find function */
1592 .close = NULL, /* no close function */
1593 .tidy = eldap_tidy, /* sic */ /* tidy function */
1594 .quote = eldap_quote, /* sic */ /* quoting function */
1595 .version_report = NULL /* no version reporting (redundant) */
1598 static lookup_info ldapm_lookup_info = {
1599 .name = US"ldapm", /* lookup name */
1600 .type = lookup_querystyle, /* query-style lookup */
1601 .open = eldap_open, /* sic */ /* open function */
1602 .check = NULL, /* check function */
1603 .find = eldapm_find, /* find function */
1604 .close = NULL, /* no close function */
1605 .tidy = eldap_tidy, /* sic */ /* tidy function */
1606 .quote = eldap_quote, /* sic */ /* quoting function */
1607 .version_report = NULL /* no version reporting (redundant) */
1610 static lookup_info ldapauth_lookup_info = {
1611 .name = US"ldapauth", /* lookup name */
1612 .type = lookup_querystyle, /* query-style lookup */
1613 .open = eldap_open, /* sic */ /* open function */
1614 .check = NULL, /* check function */
1615 .find = eldapauth_find, /* find function */
1616 .close = NULL, /* no close function */
1617 .tidy = eldap_tidy, /* sic */ /* tidy function */
1618 .quote = NULL, /* NO quoting function */
1619 .version_report = NULL /* no version reporting (redundant) */
1623 #define ldap_lookup_module_info _lookup_module_info
1626 static lookup_info *_lookup_list[] = {
1628 &ldapdn_lookup_info,
1630 &ldapauth_lookup_info,
1632 lookup_module_info ldap_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 4 };
1634 /* End of lookups/ldap.c */