src/modules/rlm_ldap/ldap.c

   1 /*
   2  *   This program is is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License, version 2 if the
   4  *   License as published by the Free Software Foundation.
   5  *
   6  *   This program is distributed in the hope that it will be useful,
   7  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9  *   GNU General Public License for more details.
  10  *
  11  *   You should have received a copy of the GNU General Public License
  12  *   along with this program; if not, write to the Free Software
  13  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  14  */
  15
  16 /**
  17  * $Id$
  18  * @file ldap.c
  19  * @brief LDAP module library functions.
  20  *
  21  * @author Arran Cudbard-Bell <a.cudbardb@freeradius.org>
  22  * @copyright 2013 Network RADIUS SARL <info@networkradius.com>
  23  * @copyright 2013 The FreeRADIUS Server Project.
  24  */
  25 #include        <freeradius-devel/radiusd.h>
  26 #include        <freeradius-devel/modules.h>
  27 #include        <freeradius-devel/rad_assert.h>
  28
  29 #include        <stdarg.h>
  30 #include        <ctype.h>
  31
  32 #include        <lber.h>
  33 #include        <ldap.h>
  34 #include        "ldap.h"
  35
  36
  37
  38 /** Converts "bad" strings into ones which are safe for LDAP
  39  *
  40  * This is a callback for xlat operations.
  41  *
  42  * Will escape any characters in input strings that would cause the string to be interpreted as part of a DN and or
  43  * filter. Escape sequence is @verbatim \<hex><hex> @endverbatim
  44  *
  45  * @param request The current request.
  46  * @param out Pointer to output buffer.
  47  * @param outlen Size of the output buffer.
  48  * @param in Raw unescaped string.
  49  * @param arg Any additional arguments (unused).
  50  */
  51 size_t rlm_ldap_escape_func(UNUSED REQUEST *request, char *out, size_t outlen, char const *in, UNUSED void *arg)
  52 {
  53         static char const encode[] = ",+\"\\<>;*=()";
  54         static char const hextab[] = "0123456789abcdef";
  55         size_t left = outlen;
  56
  57         if (*in && ((*in == ' ') || (*in == '#'))) {
  58                 goto encode;
  59         }
  60
  61         while (*in) {
  62                 /*
  63                  *      Encode unsafe characters.
  64                  */
  65                 if (memchr(encode, *in, sizeof(encode) - 1)) {
  66                         encode:
  67
  68                         /*
  69                          *      Only 3 or less bytes available.
  70                          */
  71                         if (left <= 3) break;
  72
  73                         *out++ = '\\';
  74                         *out++ = hextab[(*in >> 4) & 0x0f];
  75                         *out++ = hextab[*in & 0x0f];
  76                         in++;
  77                         left -= 3;
  78
  79                         continue;
  80                 }
  81
  82                 if (left <= 1) break;
  83
  84                 /*
  85                  *      Doesn't need encoding
  86                  */
  87                 *out++ = *in++;
  88                 left--;
  89         }
  90
  91         *out = '\0';
  92
  93         return outlen - left;
  94 }
  95
  96 /** Check whether a string is a DN
  97  *
  98  * @param str to check.
  99  * @return true if string is a DN, else false.
 100  */
 101 int rlm_ldap_is_dn(char const *str)
 102 {
 103         return strrchr(str, ',') == NULL ? false : true;
 104 }
 105
 106 /** Find the place at which the two DN strings diverge
 107  *
 108  * Returns the length of the non matching string in full.
 109  *
 110  * @param full DN.
 111  * @param part Partial DN as returned by ldap_parse_result.
 112  * @return the length of the portion of full which wasn't matched or -1 on error.
 113  */
 114 static size_t rlm_ldap_common_dn(char const *full, char const *part)
 115 {
 116         size_t f_len, p_len, i;
 117
 118         if (!full) {
 119                 return -1;
 120         }
 121
 122         f_len = strlen(full);
 123
 124         if (!part) {
 125                 return -1;
 126         }
 127
 128         p_len = strlen(part);
 129         if (!p_len) {
 130                 return f_len;
 131         }
 132
 133         if ((f_len < p_len) || !f_len) {
 134                 return -1;
 135         }
 136
 137         for (i = 0; i < p_len; i++) {
 138                 if (part[p_len - i] != full[f_len - i]) {
 139                         return -1;
 140                 }
 141         }
 142
 143         return f_len - p_len;
 144 }
 145
 146 /** Combine and expand filters
 147  *
 148  * @param request Current request.
 149  * @param out Where to write the expanded string.
 150  * @param outlen Length of output buffer.
 151  * @param sub Array of subfilters (may contain NULLs).
 152  * @param sublen Number of potential subfilters in array.
 153  * @return length of expanded data.
 154  */
 155 ssize_t rlm_ldap_xlat_filter(REQUEST *request, char const **sub, size_t sublen, char *out, size_t outlen)
 156 {
 157         char buffer[LDAP_MAX_FILTER_STR_LEN + 1];
 158         char const *in = NULL;
 159         char *p = buffer;
 160
 161         ssize_t len = 0;
 162
 163         unsigned int i;
 164         int cnt = 0;
 165
 166         /*
 167          *      Figure out how many filter elements we need to integrate
 168          */
 169         for (i = 0; i < sublen; i++) {
 170                 if (sub[i] && *sub[i]) {
 171                         in = sub[i];
 172                         cnt++;
 173                 }
 174         }
 175
 176         if (!cnt) {
 177                 out[0] = '\0';
 178                 return 0;
 179         }
 180
 181         if (cnt > 1) {
 182                 if (outlen < 3) {
 183                         goto oob;
 184                 }
 185
 186                 p[len++] = '(';
 187                 p[len++] = '&';
 188
 189                 for (i = 0; i < sublen; i++) {
 190                         if (sub[i] && (*sub[i] != '\0')) {
 191                                 len += strlcpy(p + len, sub[i], outlen - len);
 192
 193                                 if ((size_t) len >= outlen) {
 194                                         oob:
 195                                         REDEBUG("Out of buffer space creating filter");
 196
 197                                         return -1;
 198                                 }
 199                         }
 200                 }
 201
 202                 if ((outlen - len) < 2) {
 203                         goto oob;
 204                 }
 205
 206                 p[len++] = ')';
 207                 p[len] = '\0';
 208
 209                 in = buffer;
 210         }
 211
 212         len = radius_xlat(out, outlen, request, in, rlm_ldap_escape_func, NULL);
 213         if (len < 0) {
 214                 REDEBUG("Failed creating filter");
 215
 216                 return -1;
 217         }
 218
 219         return len;
 220 }
 221
 222 /** Return the error string associated with a handle
 223  *
 224  * @param conn to retrieve error from.
 225  * @return error string.
 226  */
 227 char const *rlm_ldap_error_str(ldap_handle_t const *conn)
 228 {
 229         int lib_errno;
 230         ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &lib_errno);
 231         if (lib_errno == LDAP_SUCCESS) {
 232                 return "unknown";
 233         }
 234
 235         return ldap_err2string(lib_errno);
 236 }
 237
 238 /** Parse response from LDAP server dealing with any errors
 239  *
 240  * Should be called after an LDAP operation. Will check result of operation and if it was successful, then attempt
 241  * to retrieve and parse the result.
 242  *
 243  * Will also produce extended error output including any messages the server sent, and information about partial
 244  * DN matches.
 245  *
 246  * @param[in] inst of LDAP module.
 247  * @param[in] conn Current connection.
 248  * @param[in] msgid returned from last operation.
 249  * @param[in] dn Last search or bind DN.
 250  * @param[out] result Where to write result, if NULL result will be freed.
 251  * @param[out] error Where to write the error string, may be NULL, must not be freed.
 252  * @param[out] extra Where to write additional error string to, may be NULL (faster) or must be freed
 253  *      (with talloc_free).
 254  * @return One of the LDAP_PROC_* codes.
 255  */
 256 static ldap_rcode_t rlm_ldap_result(ldap_instance_t const *inst, ldap_handle_t const *conn, int msgid, char const *dn,
 257                                     LDAPMessage **result, char const **error, char **extra)
 258 {
 259         ldap_rcode_t status = LDAP_PROC_SUCCESS;
 260
 261         int lib_errno = LDAP_SUCCESS;   // errno returned by the library.
 262         int srv_errno = LDAP_SUCCESS;   // errno in the result message.
 263
 264         char *part_dn = NULL;           // Partial DN match.
 265         char *our_err = NULL;           // Our extended error message.
 266         char *srv_err = NULL;           // Server's extended error message.
 267         char *p, *a;
 268
 269         int freeit = false;             // Whether the message should be freed after being processed.
 270         int len;
 271
 272         struct timeval tv;              // Holds timeout values.
 273
 274         LDAPMessage *tmp_msg;           // Temporary message pointer storage if we weren't provided with one.
 275
 276         char const *tmp_err;            // Temporary error pointer storage if we weren't provided with one.
 277
 278         if (!error) {
 279                 error = &tmp_err;
 280         }
 281         *error = NULL;
 282
 283         if (extra) {
 284                 *extra = NULL;
 285         }
 286
 287         /*
 288          *      We always need the result, but our caller may not
 289          */
 290         if (!result) {
 291                 result = &tmp_msg;
 292                 freeit = true;
 293         }
 294
 295         *result = NULL;
 296
 297         /*
 298          *      Check if there was an error sending the request
 299          */
 300         ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
 301                         &lib_errno);
 302         if (lib_errno != LDAP_SUCCESS) {
 303                 goto process_error;
 304         }
 305
 306         memset(&tv, 0, sizeof(tv));
 307         tv.tv_sec = inst->res_timeout;
 308
 309         /*
 310          *      Now retrieve the result and check for errors
 311          *      ldap_result returns -1 on error, and 0 on timeout
 312          */
 313         lib_errno = ldap_result(conn->handle, msgid, 1, &tv, result);
 314         if (lib_errno == 0) {
 315                 lib_errno = LDAP_TIMEOUT;
 316
 317                 goto process_error;
 318         }
 319
 320         if (lib_errno == -1) {
 321                 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
 322                                 &lib_errno);
 323                 goto process_error;
 324         }
 325
 326         /*
 327          *      Parse the result and check for errors sent by the server
 328          */
 329         lib_errno = ldap_parse_result(conn->handle, *result,
 330                                       &srv_errno,
 331                                       extra ? &part_dn : NULL,
 332                                       extra ? &srv_err : NULL,
 333                                       NULL, NULL, freeit);
 334         if (freeit) {
 335                 *result = NULL;
 336         }
 337
 338         if (lib_errno != LDAP_SUCCESS) {
 339                 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
 340                                 &lib_errno);
 341                 goto process_error;
 342         }
 343
 344         process_error:
 345
 346         if ((lib_errno == LDAP_SUCCESS) && (srv_errno != LDAP_SUCCESS)) {
 347                 lib_errno = srv_errno;
 348         } else if ((lib_errno != LDAP_SUCCESS) && (srv_errno == LDAP_SUCCESS)) {
 349                 srv_errno = lib_errno;
 350         }
 351
 352         switch (lib_errno) {
 353         case LDAP_SUCCESS:
 354                 *error = "Success";
 355
 356                 break;
 357
 358         case LDAP_NO_SUCH_OBJECT:
 359                 *error = "The specified DN wasn't found, check base_dn and identity";
 360
 361                 status = LDAP_PROC_BAD_DN;
 362
 363                 if (!extra) break;
 364
 365                 /*
 366                  *      Build our own internal diagnostic string
 367                  */
 368                 len = rlm_ldap_common_dn(dn, part_dn);
 369                 if (len < 0) break;
 370
 371                 our_err = talloc_asprintf(conn, "Match stopped here: [%.*s]%s", len, dn, part_dn ? part_dn : "");
 372
 373                 goto error_string;
 374
 375         case LDAP_INSUFFICIENT_ACCESS:
 376                 *error = "Insufficient access. Check the identity and password configuration directives";
 377
 378                 status = LDAP_PROC_NOT_PERMITTED;
 379                 break;
 380
 381         case LDAP_UNWILLING_TO_PERFORM:
 382                 *error = "Server was unwilling to perform";
 383
 384                 status = LDAP_PROC_NOT_PERMITTED;
 385                 break;
 386
 387         case LDAP_TIMEOUT:
 388                 exec_trigger(NULL, inst->cs, "modules.ldap.timeout", true);
 389
 390                 *error = "Timed out while waiting for server to respond";
 391
 392                 status = LDAP_PROC_ERROR;
 393                 break;
 394
 395         case LDAP_FILTER_ERROR:
 396                 *error = "Bad search filter";
 397
 398                 status = LDAP_PROC_ERROR;
 399                 break;
 400
 401         case LDAP_TIMELIMIT_EXCEEDED:
 402                 exec_trigger(NULL, inst->cs, "modules.ldap.timeout", true);
 403
 404                 *error = "Time limit exceeded";
 405                 /* FALL-THROUGH */
 406
 407         case LDAP_BUSY:
 408         case LDAP_UNAVAILABLE:
 409         case LDAP_SERVER_DOWN:
 410                 status = LDAP_PROC_RETRY;
 411
 412                 goto error_string;
 413
 414         case LDAP_INVALID_CREDENTIALS:
 415         case LDAP_CONSTRAINT_VIOLATION:
 416                 status = LDAP_PROC_REJECT;
 417
 418                 goto error_string;
 419
 420         case LDAP_OPERATIONS_ERROR:
 421                 *error = "Please set 'chase_referrals=yes' and 'rebind=yes'. See the ldap module configuration "
 422                          "for details.";
 423
 424                 /* FALL-THROUGH */
 425         default:
 426                 status = LDAP_PROC_ERROR;
 427
 428                 error_string:
 429
 430                 if (!*error) {
 431                         *error = ldap_err2string(lib_errno);
 432                 }
 433
 434                 if (!extra || ((lib_errno == srv_errno) && !our_err && !srv_err)) {
 435                         break;
 436                 }
 437
 438                 /*
 439                  *      Output the error codes from the library and server
 440                  */
 441                 p = talloc_zero_array(conn, char, 1);
 442                 if (!p) break;
 443
 444                 if (lib_errno != srv_errno) {
 445                         a = talloc_asprintf_append(p, "LDAP lib error: %s (%u), srv error: %s (%u). ",
 446                                                    ldap_err2string(lib_errno), lib_errno,
 447                                                    ldap_err2string(srv_errno), srv_errno);
 448                         if (!a) {
 449                                 talloc_free(p);
 450                                 break;
 451                         }
 452
 453                         p = a;
 454                 }
 455
 456                 if (our_err) {
 457                         a = talloc_asprintf_append_buffer(p, "%s. ", our_err);
 458                         if (!a) {
 459                                 talloc_free(p);
 460                                 break;
 461                         }
 462
 463                         p = a;
 464                 }
 465
 466                 if (srv_err) {
 467                         a = talloc_asprintf_append_buffer(p, "Server said: %s. ", srv_err);
 468                         if (!a) {
 469                                 talloc_free(p);
 470                                 break;
 471                         }
 472
 473                         p = a;
 474                 }
 475
 476                 *extra = p;
 477
 478                 break;
 479         }
 480
 481         /*
 482          *      Cleanup memory
 483          */
 484         if (srv_err) {
 485                 ldap_memfree(srv_err);
 486         }
 487
 488         if (part_dn) {
 489                 ldap_memfree(part_dn);
 490         }
 491
 492         if (our_err) {
 493                 talloc_free(our_err);
 494         }
 495
 496         if ((lib_errno || srv_errno) && *result) {
 497                 ldap_msgfree(*result);
 498                 *result = NULL;
 499         }
 500
 501         return status;
 502 }
 503
 504 /** Bind to the LDAP directory as a user
 505  *
 506  * Performs a simple bind to the LDAP directory, and handles any errors that occur.
 507  *
 508  * @param[in] inst rlm_ldap configuration.
 509  * @param[in] request Current request, this may be NULL, in which case all debug logging is done with radlog.
 510  * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
 511  * @param[in] dn of the user, may be NULL to bind anonymously.
 512  * @param[in] password of the user, may be NULL if no password is specified.
 513  * @param[in] retry if the server is down.
 514  * @return one of the LDAP_PROC_* values.
 515  */
 516 ldap_rcode_t rlm_ldap_bind(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn, char const *dn,
 517                            char const *password, int retry)
 518 {
 519         ldap_rcode_t    status;
 520
 521         int             msgid;
 522
 523         char const      *error = NULL;
 524         char            *extra = NULL;
 525
 526         rad_assert(*pconn && (*pconn)->handle);
 527
 528         /*
 529          *      Bind as anonymous user
 530          */
 531         if (!dn) dn = "";
 532
 533 retry:
 534         msgid = ldap_bind((*pconn)->handle, dn, password, LDAP_AUTH_SIMPLE);
 535         /* We got a valid message ID */
 536         if (msgid >= 0) {
 537                 if (request) {
 538                         RDEBUG2("Waiting for bind result...");
 539                 } else {
 540                         DEBUG2("rlm_ldap (%s): Waiting for bind result...", inst->xlat_name);
 541                 }
 542         }
 543
 544         status = rlm_ldap_result(inst, *pconn, msgid, dn, NULL, &error, &extra);
 545         switch (status) {
 546         case LDAP_PROC_SUCCESS:
 547                 LDAP_DBG_REQ("Bind successful");
 548                 break;
 549         case LDAP_PROC_NOT_PERMITTED:
 550                 LDAP_ERR_REQ("Bind was not permitted: %s", error);
 551                 LDAP_EXT_REQ();
 552
 553                 break;
 554
 555         case LDAP_PROC_REJECT:
 556                 LDAP_ERR_REQ("Bind credentials incorrect: %s", error);
 557                 LDAP_EXT_REQ();
 558
 559                 break;
 560
 561         case LDAP_PROC_RETRY:
 562                 if (retry) {
 563                         *pconn = fr_connection_reconnect(inst->pool, *pconn);
 564                         if (*pconn) {
 565                                 LDAP_DBGW_REQ("Bind with %s to %s:%d failed: %s. Got new socket, retrying...",
 566                                               dn, inst->server, inst->port, error);
 567
 568                                 talloc_free(extra); /* don't leak debug info */
 569
 570                                 goto retry;
 571                         }
 572                 };
 573
 574                 status = LDAP_PROC_ERROR;
 575
 576                 /*
 577                  *      Were not allowed to retry, or there are no more
 578                  *      sockets, treat this as a hard failure.
 579                  */
 580                 /* FALL-THROUGH */
 581         default:
 582 #ifdef HAVE_LDAP_INITIALIZE
 583                 if (inst->is_url) {
 584                         LDAP_ERR_REQ("Bind with %s to %s failed: %s", dn, inst->server, error);
 585                 } else
 586 #endif
 587                 {
 588                         LDAP_ERR_REQ("Bind with %s to %s:%d failed: %s", dn, inst->server,
 589                                      inst->port, error);
 590                 }
 591                 LDAP_EXT_REQ();
 592
 593                 break;
 594         }
 595
 596         if (extra) {
 597                 talloc_free(extra);
 598         }
 599
 600         return status; /* caller closes the connection */
 601 }
 602
 603
 604 /** Search for something in the LDAP directory
 605  *
 606  * Binds as the administrative user and performs a search, dealing with any errors.
 607  *
 608  * @param[in] inst rlm_ldap configuration.
 609  * @param[in] request Current request.
 610  * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
 611  * @param[in] dn to use as base for the search.
 612  * @param[in] scope to use (LDAP_SCOPE_BASE, LDAP_SCOPE_ONE, LDAP_SCOPE_SUB).
 613  * @param[in] filter to use, should be pre-escaped.
 614  * @param[in] attrs to retrieve.
 615  * @param[out] result Where to store the result. Must be freed with ldap_msgfree if LDAP_PROC_SUCCESS is returned.
 616  *      May be NULL in which case result will be automatically freed after use.
 617  * @return One of the LDAP_PROC_* values.
 618  */
 619 ldap_rcode_t rlm_ldap_search(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
 620                              char const *dn, int scope, char const *filter, char const * const *attrs,
 621                              LDAPMessage **result)
 622 {
 623         ldap_rcode_t    status;
 624         LDAPMessage     *our_result = NULL;
 625
 626         int             msgid;          // Message id returned by
 627                                         // ldap_search_ext.
 628
 629         int             count = 0;      // Number of results we got.
 630
 631         struct timeval  tv;             // Holds timeout values.
 632
 633         char const      *error = NULL;
 634         char            *extra = NULL;
 635
 636         rad_assert(*pconn && (*pconn)->handle);
 637
 638         /*
 639          *      OpenLDAP library doesn't declare attrs array as const, but
 640          *      it really should be *sigh*.
 641          */
 642         char **search_attrs;
 643         memcpy(&search_attrs, &attrs, sizeof(attrs));
 644
 645         /*
 646          *      Do all searches as the admin user.
 647          */
 648         if ((*pconn)->rebound) {
 649                 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
 650                 if (status != LDAP_PROC_SUCCESS) {
 651                         return LDAP_PROC_ERROR;
 652                 }
 653
 654                 rad_assert(*pconn);
 655
 656                 (*pconn)->rebound = false;
 657         }
 658
 659         LDAP_DBG_REQ("Performing search in '%s' with filter '%s'", dn, filter);
 660
 661         /*
 662          *      If LDAP search produced an error it should also be logged
 663          *      to the ld. result should pick it up without us
 664          *      having to pass it explicitly.
 665          */
 666         memset(&tv, 0, sizeof(tv));
 667         tv.tv_sec = inst->res_timeout;
 668 retry:
 669         (void) ldap_search_ext((*pconn)->handle, dn, scope, filter, search_attrs, 0, NULL, NULL, &tv, 0, &msgid);
 670
 671         LDAP_DBG_REQ("Waiting for search result...");
 672         status = rlm_ldap_result(inst, *pconn, msgid, dn, &our_result, &error, &extra);
 673         switch (status) {
 674                 case LDAP_PROC_SUCCESS:
 675                         break;
 676                 case LDAP_PROC_RETRY:
 677                         *pconn = fr_connection_reconnect(inst->pool, *pconn);
 678                         if (*pconn) {
 679                                 LDAP_DBGW_REQ("Search failed: %s. Got new socket, retrying...", error);
 680
 681                                 talloc_free(extra); /* don't leak debug info */
 682
 683                                 goto retry;
 684                         }
 685
 686                         status = LDAP_PROC_ERROR;
 687
 688                         /* FALL-THROUGH */
 689                 default:
 690                         LDAP_ERR_REQ("Failed performing search: %s", error);
 691                         if (extra) LDAP_ERR_REQ("%s", extra);
 692
 693                         goto finish;
 694         }
 695
 696         count = ldap_count_entries((*pconn)->handle, our_result);
 697         if (count < 0) {
 698                 LDAP_ERR_REQ("Error counting results: %s", rlm_ldap_error_str(*pconn));
 699                 status = LDAP_PROC_ERROR;
 700
 701                 ldap_msgfree(our_result);
 702                 our_result = NULL;
 703         } else if (count == 0) {
 704                 LDAP_DBG_REQ("Search returned no results");
 705                 status = LDAP_PROC_NO_RESULT;
 706
 707                 ldap_msgfree(our_result);
 708                 our_result = NULL;
 709         }
 710
 711         finish:
 712         if (extra) {
 713                 talloc_free(extra);
 714         }
 715
 716         /*
 717          *      We always need to get the result to count entries, but the caller
 718          *      may not of requested one. If that's the case, free it, else write
 719          *      it to where our caller said.
 720          */
 721         if (!result) {
 722                 if (our_result) {
 723                         ldap_msgfree(our_result);
 724                 }
 725         } else {
 726                 *result = our_result;
 727         }
 728
 729         return status;
 730 }
 731
 732 /** Modify something in the LDAP directory
 733  *
 734  * Binds as the administrative user and attempts to modify an LDAP object.
 735  *
 736  * @param[in] inst rlm_ldap configuration.
 737  * @param[in] request Current request.
 738  * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
 739  * @param[in] dn of the object to modify.
 740  * @param[in] mods to make, see 'man ldap_modify' for more information.
 741  * @return One of the LDAP_PROC_* values.
 742  */
 743 ldap_rcode_t rlm_ldap_modify(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
 744                              char const *dn, LDAPMod *mods[])
 745 {
 746         ldap_rcode_t    status;
 747
 748         int             msgid;          // Message id returned by ldap_search_ext.
 749
 750         char const      *error = NULL;
 751         char            *extra = NULL;
 752
 753         rad_assert(*pconn && (*pconn)->handle);
 754
 755         /*
 756          *      Perform all modifications as the admin user.
 757          */
 758         if ((*pconn)->rebound) {
 759                 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
 760                 if (status != LDAP_PROC_SUCCESS) {
 761                         return LDAP_PROC_ERROR;
 762                 }
 763
 764                 rad_assert(*pconn);
 765
 766                 (*pconn)->rebound = false;
 767         }
 768
 769         RDEBUG2("Modifying object with DN \"%s\"", dn);
 770         retry:
 771         (void) ldap_modify_ext((*pconn)->handle, dn, mods, NULL, NULL, &msgid);
 772
 773         RDEBUG2("Waiting for modify result...");
 774         status = rlm_ldap_result(inst, *pconn, msgid, dn, NULL, &error, &extra);
 775         switch (status) {
 776                 case LDAP_PROC_SUCCESS:
 777                         break;
 778                 case LDAP_PROC_RETRY:
 779                         *pconn = fr_connection_reconnect(inst->pool, *pconn);
 780                         if (*pconn) {
 781                                 RWDEBUG("Modify failed: %s. Got new socket, retrying...", error);
 782
 783                                 talloc_free(extra); /* don't leak debug info */
 784
 785                                 goto retry;
 786                         }
 787
 788                         status = LDAP_PROC_ERROR;
 789
 790                         /* FALL-THROUGH */
 791                 default:
 792                         REDEBUG("Failed modifying object: %s", error);
 793                         REDEBUG("%s", extra);
 794
 795                         goto finish;
 796         }
 797
 798         finish:
 799         if (extra) {
 800                 talloc_free(extra);
 801         }
 802
 803         return status;
 804 }
 805
 806 /** Retrieve the DN of a user object
 807  *
 808  * Retrieves the DN of a user and adds it to the control list as LDAP-UserDN. Will also retrieve any attributes
 809  * passed and return the result in *result.
 810  *
 811  * This potentially allows for all authorization and authentication checks to be performed in one ldap search
 812  * operation, which is a big bonus given the number of crappy, slow *cough*AD*cough* LDAP directory servers out there.
 813  *
 814  * @param[in] inst rlm_ldap configuration.
 815  * @param[in] request Current request.
 816  * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
 817  * @param[in] attrs Additional attributes to retrieve, may be NULL.
 818  * @param[in] force Query even if the User-DN already exists.
 819  * @param[out] result Where to write the result, may be NULL in which case result is discarded.
 820  * @param[out] rcode The status of the operation, one of the RLM_MODULE_* codes.
 821  * @return The user's DN or NULL on error.
 822  */
 823 char const *rlm_ldap_find_user(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
 824                                char const *attrs[], int force, LDAPMessage **result, rlm_rcode_t *rcode)
 825 {
 826         static char const *tmp_attrs[] = { NULL };
 827
 828         ldap_rcode_t    status;
 829         VALUE_PAIR      *vp = NULL;
 830         LDAPMessage     *tmp_msg = NULL, *entry = NULL;
 831         int             ldap_errno;
 832         char            *dn = NULL;
 833         char            filter[LDAP_MAX_FILTER_STR_LEN];
 834         char            base_dn[LDAP_MAX_DN_STR_LEN];
 835
 836         int freeit = false;                                     //!< Whether the message should
 837                                                                 //!< be freed after being processed.
 838
 839         *rcode = RLM_MODULE_FAIL;
 840
 841         if (!result) {
 842                 result = &tmp_msg;
 843                 freeit = true;
 844         }
 845         *result = NULL;
 846
 847         if (!attrs) {
 848                 memset(&attrs, 0, sizeof(tmp_attrs));
 849         }
 850
 851         /*
 852          *      If the caller isn't looking for the result we can just return the current userdn value.
 853          */
 854         if (!force) {
 855                 vp = pairfind(request->config_items, PW_LDAP_USERDN, 0, TAG_ANY);
 856                 if (vp) {
 857                         RDEBUG("Using user DN from request \"%s\"", vp->vp_strvalue);
 858                         *rcode = RLM_MODULE_OK;
 859                         return vp->vp_strvalue;
 860                 }
 861         }
 862
 863         /*
 864          *      Perform all searches as the admin user.
 865          */
 866         if ((*pconn)->rebound) {
 867                 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
 868                 if (status != LDAP_PROC_SUCCESS) {
 869                         *rcode = RLM_MODULE_FAIL;
 870                         return NULL;
 871                 }
 872
 873                 rad_assert(*pconn);
 874
 875                 (*pconn)->rebound = false;
 876         }
 877
 878         if (radius_xlat(filter, sizeof(filter), request, inst->userobj_filter, rlm_ldap_escape_func, NULL) < 0) {
 879                 REDEBUG("Unable to create filter");
 880
 881                 *rcode = RLM_MODULE_INVALID;
 882                 return NULL;
 883         }
 884
 885         if (radius_xlat(base_dn, sizeof(base_dn), request, inst->userobj_base_dn, rlm_ldap_escape_func, NULL) < 0) {
 886                 REDEBUG("Unable to create base_dn");
 887
 888                 *rcode = RLM_MODULE_INVALID;
 889                 return NULL;
 890         }
 891
 892         status = rlm_ldap_search(inst, request, pconn, base_dn, inst->userobj_scope, filter, attrs, result);
 893         switch (status) {
 894                 case LDAP_PROC_SUCCESS:
 895                         break;
 896                 case LDAP_PROC_NO_RESULT:
 897                         *rcode = RLM_MODULE_NOTFOUND;
 898                         return NULL;
 899                 default:
 900                         *rcode = RLM_MODULE_FAIL;
 901                         return NULL;
 902         }
 903
 904         rad_assert(*pconn);
 905
 906         entry = ldap_first_entry((*pconn)->handle, *result);
 907         if (!entry) {
 908                 ldap_get_option((*pconn)->handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
 909                 REDEBUG("Failed retrieving entry: %s",
 910                         ldap_err2string(ldap_errno));
 911
 912                 goto finish;
 913         }
 914
 915         dn = ldap_get_dn((*pconn)->handle, entry);
 916         if (!dn) {
 917                 ldap_get_option((*pconn)->handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
 918
 919                 REDEBUG("Retrieving object DN from entry failed: %s",
 920                         ldap_err2string(ldap_errno));
 921
 922                 goto finish;
 923         }
 924
 925         RDEBUG("User object found at DN \"%s\"", dn);
 926         vp = pairmake(request, &request->config_items, "LDAP-UserDN", dn, T_OP_EQ);
 927         if (vp) {
 928                 *rcode = RLM_MODULE_OK;
 929         }
 930
 931         finish:
 932         ldap_memfree(dn);
 933
 934         if ((freeit || (*rcode != RLM_MODULE_OK)) && *result) {
 935                 ldap_msgfree(*result);
 936                 *result = NULL;
 937         }
 938
 939         return vp ? vp->vp_strvalue : NULL;
 940 }
 941
 942 /** Check for presence of access attribute in result
 943  *
 944  * @param[in] inst rlm_ldap configuration.
 945  * @param[in] request Current request.
 946  * @param[in] conn used to retrieve access attributes.
 947  * @param[in] entry retrieved by rlm_ldap_find_user or rlm_ldap_search.
 948  * @return RLM_MODULE_USERLOCK if the user was denied access, else RLM_MODULE_OK.
 949  */
 950 rlm_rcode_t rlm_ldap_check_access(ldap_instance_t const *inst, REQUEST *request,
 951                                   ldap_handle_t const *conn, LDAPMessage *entry)
 952 {
 953         rlm_rcode_t rcode = RLM_MODULE_OK;
 954         char **vals = NULL;
 955
 956         vals = ldap_get_values(conn->handle, entry, inst->userobj_access_attr);
 957         if (vals) {
 958                 if (inst->access_positive) {
 959                         if (strncmp(vals[0], "false", 5) == 0) {
 960                                 RDEBUG("\"%s\" attribute exists but is set to 'false' - user locked out");
 961                                 rcode = RLM_MODULE_USERLOCK;
 962                         }
 963                         /* RLM_MODULE_OK set above... */
 964                 } else {
 965                         RDEBUG("\"%s\" attribute exists - user locked out", inst->userobj_access_attr);
 966                         rcode = RLM_MODULE_USERLOCK;
 967                 }
 968
 969                 ldap_value_free(vals);
 970         } else if (inst->access_positive) {
 971                 RDEBUG("No \"%s\" attribute - user locked out", inst->userobj_access_attr);
 972                 rcode = RLM_MODULE_USERLOCK;
 973         }
 974
 975         return rcode;
 976 }
 977
 978 /** Verify we got a password from the search
 979  *
 980  * Checks to see if after the LDAP to RADIUS mapping has been completed that a reference password.
 981  *
 982  * @param inst rlm_ldap configuration.
 983  * @param request Current request.
 984  */
 985 void rlm_ldap_check_reply(ldap_instance_t const *inst, REQUEST *request)
 986 {
 987        /*
 988         *       More warning messages for people who can't be bothered to read the documentation.
 989         *
 990         *       Expect_password is set when we process the mapping, and is only true if there was a mapping between
 991         *       an LDAP attribute and a password reference attribute in the control list.
 992         */
 993         if (inst->expect_password && (debug_flag > 1)) {
 994                 if (!pairfind(request->config_items, PW_CLEARTEXT_PASSWORD, 0, TAG_ANY) &&
 995                     !pairfind(request->config_items, PW_NT_PASSWORD, 0, TAG_ANY) &&
 996                     !pairfind(request->config_items, PW_USER_PASSWORD, 0, TAG_ANY) &&
 997                     !pairfind(request->config_items, PW_PASSWORD_WITH_HEADER, 0, TAG_ANY) &&
 998                     !pairfind(request->config_items, PW_CRYPT_PASSWORD, 0, TAG_ANY)) {
 999                         RWDEBUG("No \"reference\" password added. Ensure the admin user has permission to "
1000                                 "read the password attribute");
1001                         RWDEBUG("PAP authentication will *NOT* work with Active Directory (if that is what you "
1002                                 "were trying to configure)");
1003                 }
1004        }
1005 }
1006
1007 #if LDAP_SET_REBIND_PROC_ARGS == 3
1008 /** Callback for OpenLDAP to rebind and chase referrals
1009  *
1010  * Called by OpenLDAP when it receives a referral and has to rebind.
1011  *
1012  * @param handle to rebind.
1013  * @param url to bind to.
1014  * @param request that triggered the rebind.
1015  * @param msgid that triggered the rebind.
1016  * @param ctx rlm_ldap configuration.
1017  */
1018 static int rlm_ldap_rebind(LDAP *handle, LDAP_CONST char *url, UNUSED ber_tag_t request, UNUSED ber_int_t msgid,
1019                            void *ctx)
1020 {
1021         ldap_rcode_t status;
1022         ldap_handle_t *conn = talloc_get_type_abort(ctx, ldap_handle_t);
1023
1024         int ldap_errno;
1025
1026         conn->referred = true;
1027         conn->rebound = true;   /* not really, but oh well... */
1028         rad_assert(handle == conn->handle);
1029
1030         DEBUG("rlm_ldap (%s): Rebinding to URL %s", conn->inst->xlat_name, url);
1031
1032         status = rlm_ldap_bind(conn->inst, NULL, &conn, conn->inst->admin_dn, conn->inst->password, false);
1033         if (status != LDAP_PROC_SUCCESS) {
1034                 ldap_get_option(handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1035
1036                 return ldap_errno;
1037         }
1038
1039
1040         return LDAP_SUCCESS;
1041 }
1042 #endif
1043
1044 /** Create and return a new connection
1045  *
1046  * Create a new ldap connection and allocate memory for a new rlm_handle_t
1047  *
1048  * @param instance rlm_ldap instance.
1049  * @return A new connection handle or NULL on error.
1050  */
1051 void *mod_conn_create(void *instance)
1052 {
1053         ldap_rcode_t status;
1054
1055         int ldap_errno, ldap_version;
1056         struct timeval tv;
1057
1058         ldap_instance_t *inst = instance;
1059         ldap_handle_t *conn;
1060
1061         /*
1062          *      Allocate memory for the handle.
1063          */
1064         conn = talloc_zero(instance, ldap_handle_t);
1065         if (!conn) return NULL;
1066
1067         conn->inst = inst;
1068         conn->rebound = false;
1069         conn->referred = false;
1070
1071 #ifdef HAVE_LDAP_INITIALIZE
1072         if (inst->is_url) {
1073                 DEBUG("rlm_ldap (%s): Connecting to %s", inst->xlat_name, inst->server);
1074
1075                 ldap_errno = ldap_initialize(&conn->handle, inst->server);
1076                 if (ldap_errno != LDAP_SUCCESS) {
1077                         LDAP_ERR("ldap_initialize failed: %s", ldap_err2string(ldap_errno));
1078                         goto error;
1079                 }
1080         } else
1081 #endif
1082         {
1083                 DEBUG("rlm_ldap (%s): Connecting to %s:%d", inst->xlat_name, inst->server, inst->port);
1084
1085                 conn->handle = ldap_init(inst->server, inst->port);
1086                 if (!conn->handle) {
1087                         LDAP_ERR("ldap_init() failed");
1088                         goto error;
1089                 }
1090         }
1091
1092         /*
1093          *      We now have a connection structure, but no actual TCP connection.
1094          *
1095          *      Set a bunch of LDAP options, using common code.
1096          */
1097 #define do_ldap_option(_option, _name, _value) \
1098         if (ldap_set_option(conn->handle, _option, _value) != LDAP_OPT_SUCCESS) { \
1099                 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno); \
1100                 LDAP_ERR("Could not set %s: %s", _name, ldap_err2string(ldap_errno)); \
1101         }
1102
1103         if (inst->ldap_debug) {
1104                 do_ldap_option(LDAP_OPT_DEBUG_LEVEL, "ldap_debug", &(inst->ldap_debug));
1105         }
1106
1107         /*
1108          *      Leave "chase_referrals" unset to use the OpenLDAP default.
1109          */
1110         if (!inst->chase_referrals_unset) {
1111                 if (inst->chase_referrals) {
1112                         do_ldap_option(LDAP_OPT_REFERRALS, "chase_referrals", LDAP_OPT_ON);
1113
1114                         if (inst->rebind == true) {
1115 #if LDAP_SET_REBIND_PROC_ARGS == 3
1116                                 ldap_set_rebind_proc(conn->handle, rlm_ldap_rebind, conn);
1117 #endif
1118                         }
1119                 } else {
1120                         do_ldap_option(LDAP_OPT_REFERRALS, "chase_referrals", LDAP_OPT_OFF);
1121                 }
1122         }
1123
1124         memset(&tv, 0, sizeof(tv));
1125         tv.tv_sec = inst->net_timeout;
1126
1127         do_ldap_option(LDAP_OPT_NETWORK_TIMEOUT, "net_timeout", &tv);
1128
1129         do_ldap_option(LDAP_OPT_TIMELIMIT, "srv_timelimit", &(inst->srv_timelimit));
1130
1131         ldap_version = LDAP_VERSION3;
1132         do_ldap_option(LDAP_OPT_PROTOCOL_VERSION, "ldap_version", &ldap_version);
1133
1134 #ifdef LDAP_OPT_X_KEEPALIVE_IDLE
1135         do_ldap_option(LDAP_OPT_X_KEEPALIVE_IDLE, "keepalive idle", &(inst->keepalive_idle));
1136 #endif
1137
1138 #ifdef LDAP_OPT_X_KEEPALIVE_PROBES
1139         do_ldap_option(LDAP_OPT_X_KEEPALIVE_PROBES, "keepalive probes", &(inst->keepalive_probes));
1140 #endif
1141
1142 #ifdef LDAP_OPT_X_KEEPALIVE_INTERVAL
1143         do_ldap_option(LDAP_OPT_X_KEEPALIVE_INTERVAL, "keepalive interval", &(inst->keepalive_interval));
1144 #endif
1145
1146 #ifdef HAVE_LDAP_START_TLS
1147         /*
1148          *      Set all of the TLS options
1149          */
1150
1151 #  ifdef LDAP_OPT_X_TLS_NEWCTX
1152         {
1153                 /* Always use the new TLS configuration context */
1154                 int is_server = 0;
1155                 do_ldap_option(LDAP_OPT_X_TLS_NEWCTX, "new TLS context", &is_server);
1156
1157         }
1158 #  endif
1159
1160         if (inst->tls_mode) {
1161                 do_ldap_option(LDAP_OPT_X_TLS, "tls_mode", &(inst->tls_mode));
1162         }
1163
1164 #  define maybe_ldap_option(_option, _name, _value) \
1165         if (_value) do_ldap_option(_option, _name, _value)
1166
1167         maybe_ldap_option(LDAP_OPT_X_TLS_CACERTFILE, "ca_file", inst->tls_ca_file);
1168         maybe_ldap_option(LDAP_OPT_X_TLS_CACERTDIR, "ca_path", inst->tls_ca_path);
1169
1170
1171         /*
1172          *      Set certificate options
1173          */
1174         maybe_ldap_option(LDAP_OPT_X_TLS_CERTFILE, "certificate_file", inst->tls_certificate_file);
1175         maybe_ldap_option(LDAP_OPT_X_TLS_KEYFILE, "private_key_file", inst->tls_private_key_file);
1176         maybe_ldap_option(LDAP_OPT_X_TLS_RANDOM_FILE, "random_file", inst->tls_random_file);
1177
1178 #  ifdef LDAP_OPT_X_TLS_NEVER
1179         if (inst->tls_require_cert_str) {
1180                 do_ldap_option(LDAP_OPT_X_TLS_REQUIRE_CERT, "require_cert", &inst->tls_require_cert);
1181         }
1182 #  endif
1183
1184         /*
1185          *      And finally start the TLS code.
1186          */
1187         if (inst->start_tls) {
1188                 if (inst->port == 636) {
1189                         WDEBUG("Told to Start TLS on LDAPS port this will probably fail, please correct the "
1190                                "configuration");
1191                 }
1192
1193                 if (ldap_start_tls_s(conn->handle, NULL, NULL) != LDAP_SUCCESS) {
1194                         ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1195
1196                         LDAP_ERR("Could not start TLS: %s", ldap_err2string(ldap_errno));
1197                         goto error;
1198                 }
1199         }
1200 #endif /* HAVE_LDAP_START_TLS */
1201
1202         status = rlm_ldap_bind(inst, NULL, &conn, inst->admin_dn, inst->password, false);
1203         if (status != LDAP_PROC_SUCCESS) {
1204                 goto error;
1205         }
1206
1207         return conn;
1208
1209         error:
1210         if (conn->handle) ldap_unbind_s(conn->handle);
1211         talloc_free(conn);
1212
1213         return NULL;
1214 }
1215
1216
1217 /** Close and delete a connection
1218  *
1219  * Unbinds the LDAP connection, informing the server and freeing any memory, then releases the memory used by the
1220  * connection handle.
1221  *
1222  * @param instance rlm_ldap instance.
1223  * @param handle to destroy.
1224  * @return always indicates success.
1225  */
1226 int mod_conn_delete(UNUSED void *instance, void *handle)
1227 {
1228         ldap_handle_t *conn = handle;
1229
1230         ldap_unbind_s(conn->handle);
1231         talloc_free(conn);
1232
1233         return 0;
1234 }
1235
1236
1237 /** Gets an LDAP socket from the connection pool
1238  *
1239  * Retrieve a socket from the connection pool, or NULL on error (of if no sockets are available).
1240  *
1241  * @param inst rlm_ldap configuration.
1242  * @param request Current request (may be NULL).
1243  */
1244 ldap_handle_t *rlm_ldap_get_socket(ldap_instance_t const *inst, REQUEST *request)
1245 {
1246         ldap_handle_t *conn;
1247
1248         conn = fr_connection_get(inst->pool);
1249         if (!conn) {
1250                 REDEBUG("All ldap connections are in use");
1251
1252                 return NULL;
1253         }
1254
1255         return conn;
1256 }
1257
1258
1259 /** Frees an LDAP socket back to the connection pool
1260  *
1261  * If the socket was rebound chasing a referral onto another server then we destroy it.
1262  * If the socket was rebound to another user on the same server, we let the next caller rebind it.
1263  *
1264  * @param inst rlm_ldap configuration.
1265  * @param conn to release.
1266  */
1267 void rlm_ldap_release_socket(ldap_instance_t const *inst, ldap_handle_t *conn)
1268 {
1269         /*
1270          *      Could have already been free'd due to a previous error.
1271          */
1272         if (!conn) return;
1273
1274         /*
1275          *      We chased a referral to another server.
1276          *
1277          *      This connection is no longer part of the pool which is connected to and bound to the configured server.
1278          *      Close it.
1279          *
1280          *      Note that we do NOT close it if it was bound to another user.  Instead, we let the next caller do the
1281          *      rebind.
1282          */
1283         if (conn->referred) {
1284                 fr_connection_del(inst->pool, conn);
1285                 return;
1286         }
1287
1288         fr_connection_release(inst->pool, conn);
1289         return;
1290 }