src/src/lookups/ldap.c

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