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.
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.
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
19 * @brief LDAP module library functions.
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.
25 #include <freeradius-devel/radiusd.h>
26 #include <freeradius-devel/modules.h>
27 #include <freeradius-devel/rad_assert.h>
38 /** Converts "bad" strings into ones which are safe for LDAP
40 * This is a callback for xlat operations.
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
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).
51 size_t rlm_ldap_escape_func(UNUSED REQUEST *request, char *out, size_t outlen, char const *in, UNUSED void *arg)
53 static char const encode[] = ",+\"\\<>;*=()";
54 static char const hextab[] = "0123456789abcdef";
57 if (*in && ((*in == ' ') || (*in == '#'))) {
63 * Encode unsafe characters.
65 if (memchr(encode, *in, sizeof(encode) - 1)) {
69 * Only 3 or less bytes available.
74 *out++ = hextab[(*in >> 4) & 0x0f];
75 *out++ = hextab[*in & 0x0f];
85 * Doesn't need encoding
96 /** Check whether a string is a DN
98 * @param str to check.
99 * @return true if string is a DN, else false.
101 int rlm_ldap_is_dn(char const *str)
103 return strrchr(str, ',') == NULL ? false : true;
106 /** Find the place at which the two DN strings diverge
108 * Returns the length of the non matching string in full.
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.
114 static size_t rlm_ldap_common_dn(char const *full, char const *part)
116 size_t f_len, p_len, i;
122 f_len = strlen(full);
128 p_len = strlen(part);
133 if ((f_len < p_len) || !f_len) {
137 for (i = 0; i < p_len; i++) {
138 if (part[p_len - i] != full[f_len - i]) {
143 return f_len - p_len;
146 /** Combine and expand filters
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.
155 ssize_t rlm_ldap_xlat_filter(REQUEST *request, char const **sub, size_t sublen, char *out, size_t outlen)
157 char buffer[LDAP_MAX_FILTER_STR_LEN + 1];
158 char const *in = NULL;
167 * Figure out how many filter elements we need to integrate
169 for (i = 0; i < sublen; i++) {
170 if (sub[i] && *sub[i]) {
189 for (i = 0; i < sublen; i++) {
190 if (sub[i] && (*sub[i] != '\0')) {
191 len += strlcpy(p + len, sub[i], outlen - len);
193 if ((size_t) len >= outlen) {
195 REDEBUG("Out of buffer space creating filter");
202 if ((outlen - len) < 2) {
212 len = radius_xlat(out, outlen, request, in, rlm_ldap_escape_func, NULL);
214 REDEBUG("Failed creating filter");
222 /** Return the error string associated with a handle
224 * @param conn to retrieve error from.
225 * @return error string.
227 char const *rlm_ldap_error_str(ldap_handle_t const *conn)
230 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &lib_errno);
231 if (lib_errno == LDAP_SUCCESS) {
235 return ldap_err2string(lib_errno);
238 /** Parse response from LDAP server dealing with any errors
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.
243 * Will also produce extended error output including any messages the server sent, and information about partial
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.
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)
259 ldap_rcode_t status = LDAP_PROC_SUCCESS;
261 int lib_errno = LDAP_SUCCESS; // errno returned by the library.
262 int srv_errno = LDAP_SUCCESS; // errno in the result message.
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.
269 bool freeit = false; // Whether the message should be freed after being processed.
272 struct timeval tv; // Holds timeout values.
274 LDAPMessage *tmp_msg; // Temporary message pointer storage if we weren't provided with one.
276 char const *tmp_err; // Temporary error pointer storage if we weren't provided with one.
288 * We always need the result, but our caller may not
298 * Check if there was an error sending the request
300 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
302 if (lib_errno != LDAP_SUCCESS) {
306 memset(&tv, 0, sizeof(tv));
307 tv.tv_sec = inst->res_timeout;
310 * Now retrieve the result and check for errors
311 * ldap_result returns -1 on error, and 0 on timeout
313 lib_errno = ldap_result(conn->handle, msgid, 1, &tv, result);
314 if (lib_errno == 0) {
315 lib_errno = LDAP_TIMEOUT;
320 if (lib_errno == -1) {
321 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
327 * Parse the result and check for errors sent by the server
329 lib_errno = ldap_parse_result(conn->handle, *result,
331 extra ? &part_dn : NULL,
332 extra ? &srv_err : NULL,
338 if (lib_errno != LDAP_SUCCESS) {
339 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER,
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;
358 case LDAP_NO_SUCH_OBJECT:
359 *error = "The specified DN wasn't found, check base_dn and identity";
361 status = LDAP_PROC_BAD_DN;
366 * Build our own internal diagnostic string
368 len = rlm_ldap_common_dn(dn, part_dn);
371 our_err = talloc_typed_asprintf(conn, "Match stopped here: [%.*s]%s", len, dn, part_dn ? part_dn : "");
375 case LDAP_INSUFFICIENT_ACCESS:
376 *error = "Insufficient access. Check the identity and password configuration directives";
378 status = LDAP_PROC_NOT_PERMITTED;
381 case LDAP_UNWILLING_TO_PERFORM:
382 *error = "Server was unwilling to perform";
384 status = LDAP_PROC_NOT_PERMITTED;
388 exec_trigger(NULL, inst->cs, "modules.ldap.timeout", true);
390 *error = "Timed out while waiting for server to respond";
392 status = LDAP_PROC_ERROR;
395 case LDAP_FILTER_ERROR:
396 *error = "Bad search filter";
398 status = LDAP_PROC_ERROR;
401 case LDAP_TIMELIMIT_EXCEEDED:
402 exec_trigger(NULL, inst->cs, "modules.ldap.timeout", true);
404 *error = "Time limit exceeded";
408 case LDAP_UNAVAILABLE:
409 case LDAP_SERVER_DOWN:
410 status = LDAP_PROC_RETRY;
414 case LDAP_INVALID_CREDENTIALS:
415 case LDAP_CONSTRAINT_VIOLATION:
416 status = LDAP_PROC_REJECT;
420 case LDAP_OPERATIONS_ERROR:
421 *error = "Please set 'chase_referrals=yes' and 'rebind=yes'. See the ldap module configuration "
426 status = LDAP_PROC_ERROR;
431 *error = ldap_err2string(lib_errno);
434 if (!extra || ((lib_errno == srv_errno) && !our_err && !srv_err)) {
439 * Output the error codes from the library and server
441 p = talloc_zero_array(conn, char, 1);
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);
457 a = talloc_asprintf_append_buffer(p, "%s. ", our_err);
467 a = talloc_asprintf_append_buffer(p, "Server said: %s. ", srv_err);
485 ldap_memfree(srv_err);
489 ldap_memfree(part_dn);
493 talloc_free(our_err);
496 if ((lib_errno || srv_errno) && *result) {
497 ldap_msgfree(*result);
504 /** Bind to the LDAP directory as a user
506 * Performs a simple bind to the LDAP directory, and handles any errors that occur.
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.
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, bool retry)
523 char const *error = NULL;
528 rad_assert(*pconn && (*pconn)->handle);
529 rad_assert(!retry || inst->pool);
532 * Bind as anonymous user
537 * For sanity, for when no connections are viable,
538 * and we can't make a new one.
540 num = retry ? fr_connection_get_num(inst->pool) : 0;
541 for (i = num; i >= 0; i--) {
542 msgid = ldap_bind((*pconn)->handle, dn, password, LDAP_AUTH_SIMPLE);
543 /* We got a valid message ID */
546 RDEBUG2("Waiting for bind result...");
548 DEBUG2("rlm_ldap (%s): Waiting for bind result...", inst->xlat_name);
552 status = rlm_ldap_result(inst, *pconn, msgid, dn, NULL, &error, &extra);
554 case LDAP_PROC_SUCCESS:
555 LDAP_DBG_REQ("Bind successful");
558 case LDAP_PROC_NOT_PERMITTED:
559 LDAP_ERR_REQ("Bind was not permitted: %s", error);
564 case LDAP_PROC_REJECT:
565 LDAP_ERR_REQ("Bind credentials incorrect: %s", error);
570 case LDAP_PROC_RETRY:
572 *pconn = fr_connection_reconnect(inst->pool, *pconn);
574 LDAP_DBGW_REQ("Bind with %s to %s:%d failed: %s. Got new socket, retrying...",
575 dn, inst->server, inst->port, error);
577 talloc_free(extra); /* don't leak debug info */
582 status = LDAP_PROC_ERROR;
585 * Were not allowed to retry, or there are no more
586 * sockets, treat this as a hard failure.
590 #ifdef HAVE_LDAP_INITIALIZE
592 LDAP_ERR_REQ("Bind with %s to %s failed: %s", dn, inst->server, error);
596 LDAP_ERR_REQ("Bind with %s to %s:%d failed: %s", dn, inst->server,
605 if (retry && (i < 0)) {
606 LDAP_ERR_REQ("Hit reconnection limit");
607 status = LDAP_PROC_ERROR;
612 return status; /* caller closes the connection */
616 /** Search for something in the LDAP directory
618 * Binds as the administrative user and performs a search, dealing with any errors.
620 * @param[in] inst rlm_ldap configuration.
621 * @param[in] request Current request.
622 * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
623 * @param[in] dn to use as base for the search.
624 * @param[in] scope to use (LDAP_SCOPE_BASE, LDAP_SCOPE_ONE, LDAP_SCOPE_SUB).
625 * @param[in] filter to use, should be pre-escaped.
626 * @param[in] attrs to retrieve.
627 * @param[out] result Where to store the result. Must be freed with ldap_msgfree if LDAP_PROC_SUCCESS is returned.
628 * May be NULL in which case result will be automatically freed after use.
629 * @return One of the LDAP_PROC_* values.
631 ldap_rcode_t rlm_ldap_search(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
632 char const *dn, int scope, char const *filter, char const * const *attrs,
633 LDAPMessage **result)
636 LDAPMessage *our_result = NULL;
638 int msgid; // Message id returned by
641 int count = 0; // Number of results we got.
643 struct timeval tv; // Holds timeout values.
645 char const *error = NULL;
651 rad_assert(*pconn && (*pconn)->handle);
654 * OpenLDAP library doesn't declare attrs array as const, but
655 * it really should be *sigh*.
658 memcpy(&search_attrs, &attrs, sizeof(attrs));
661 * Do all searches as the admin user.
663 if ((*pconn)->rebound) {
664 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
665 if (status != LDAP_PROC_SUCCESS) {
666 return LDAP_PROC_ERROR;
671 (*pconn)->rebound = false;
675 LDAP_DBG_REQ("Performing search in '%s' with filter '%s', scope '%s'", dn, filter,
676 fr_int2str(ldap_scope, scope, "<INVALID>"));
678 LDAP_DBG_REQ("Performing unfiltered search in '%s', scope '%s'", dn,
679 fr_int2str(ldap_scope, scope, "<INVALID>"));
682 * If LDAP search produced an error it should also be logged
683 * to the ld. result should pick it up without us
684 * having to pass it explicitly.
686 memset(&tv, 0, sizeof(tv));
687 tv.tv_sec = inst->res_timeout;
690 * For sanity, for when no connections are viable,
691 * and we can't make a new one.
693 for (i = fr_connection_get_num(inst->pool); i >= 0; i--) {
694 (void) ldap_search_ext((*pconn)->handle, dn, scope, filter, search_attrs,
695 0, NULL, NULL, &tv, 0, &msgid);
697 LDAP_DBG_REQ("Waiting for search result...");
698 status = rlm_ldap_result(inst, *pconn, msgid, dn, &our_result, &error, &extra);
700 case LDAP_PROC_SUCCESS:
703 case LDAP_PROC_RETRY:
704 *pconn = fr_connection_reconnect(inst->pool, *pconn);
706 LDAP_DBGW_REQ("Search failed: %s. Got new socket, retrying...", error);
708 talloc_free(extra); /* don't leak debug info */
713 status = LDAP_PROC_ERROR;
717 LDAP_ERR_REQ("Failed performing search: %s", error);
718 if (extra) LDAP_ERR_REQ("%s", extra);
725 LDAP_ERR_REQ("Hit reconnection limit");
726 status = LDAP_PROC_ERROR;
731 count = ldap_count_entries((*pconn)->handle, our_result);
733 LDAP_ERR_REQ("Error counting results: %s", rlm_ldap_error_str(*pconn));
734 status = LDAP_PROC_ERROR;
736 ldap_msgfree(our_result);
738 } else if (count == 0) {
739 LDAP_DBG_REQ("Search returned no results");
740 status = LDAP_PROC_NO_RESULT;
742 ldap_msgfree(our_result);
750 * We always need to get the result to count entries, but the caller
751 * may not of requested one. If that's the case, free it, else write
752 * it to where our caller said.
756 ldap_msgfree(our_result);
759 *result = our_result;
765 /** Modify something in the LDAP directory
767 * Binds as the administrative user and attempts to modify an LDAP object.
769 * @param[in] inst rlm_ldap configuration.
770 * @param[in] request Current request.
771 * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
772 * @param[in] dn of the object to modify.
773 * @param[in] mods to make, see 'man ldap_modify' for more information.
774 * @return One of the LDAP_PROC_* values.
776 ldap_rcode_t rlm_ldap_modify(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
777 char const *dn, LDAPMod *mods[])
781 int msgid; // Message id returned by ldap_search_ext.
783 char const *error = NULL;
788 rad_assert(*pconn && (*pconn)->handle);
791 * Perform all modifications as the admin user.
793 if ((*pconn)->rebound) {
794 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
795 if (status != LDAP_PROC_SUCCESS) {
796 return LDAP_PROC_ERROR;
801 (*pconn)->rebound = false;
805 * For sanity, for when no connections are viable,
806 * and we can't make a new one.
808 for (i = fr_connection_get_num(inst->pool); i >= 0; i--) {
809 RDEBUG2("Modifying object with DN \"%s\"", dn);
810 (void) ldap_modify_ext((*pconn)->handle, dn, mods, NULL, NULL, &msgid);
812 RDEBUG2("Waiting for modify result...");
813 status = rlm_ldap_result(inst, *pconn, msgid, dn, NULL, &error, &extra);
815 case LDAP_PROC_SUCCESS:
817 case LDAP_PROC_RETRY:
818 *pconn = fr_connection_reconnect(inst->pool, *pconn);
820 RWDEBUG("Modify failed: %s. Got new socket, retrying...", error);
822 talloc_free(extra); /* don't leak debug info */
827 status = LDAP_PROC_ERROR;
831 REDEBUG("Failed modifying object: %s", error);
832 REDEBUG("%s", extra);
839 LDAP_ERR_REQ("Hit reconnection limit");
840 status = LDAP_PROC_ERROR;
849 /** Retrieve the DN of a user object
851 * Retrieves the DN of a user and adds it to the control list as LDAP-UserDN. Will also retrieve any attributes
852 * passed and return the result in *result.
854 * This potentially allows for all authorization and authentication checks to be performed in one ldap search
855 * operation, which is a big bonus given the number of crappy, slow *cough*AD*cough* LDAP directory servers out there.
857 * @param[in] inst rlm_ldap configuration.
858 * @param[in] request Current request.
859 * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect.
860 * @param[in] attrs Additional attributes to retrieve, may be NULL.
861 * @param[in] force Query even if the User-DN already exists.
862 * @param[out] result Where to write the result, may be NULL in which case result is discarded.
863 * @param[out] rcode The status of the operation, one of the RLM_MODULE_* codes.
864 * @return The user's DN or NULL on error.
866 char const *rlm_ldap_find_user(ldap_instance_t const *inst, REQUEST *request, ldap_handle_t **pconn,
867 char const *attrs[], int force, LDAPMessage **result, rlm_rcode_t *rcode)
869 static char const *tmp_attrs[] = { NULL };
872 VALUE_PAIR *vp = NULL;
873 LDAPMessage *tmp_msg = NULL, *entry = NULL;
876 char filter[LDAP_MAX_FILTER_STR_LEN];
877 char base_dn[LDAP_MAX_DN_STR_LEN];
879 bool freeit = false; //!< Whether the message should
880 //!< be freed after being processed.
882 *rcode = RLM_MODULE_FAIL;
891 memset(&attrs, 0, sizeof(tmp_attrs));
895 * If the caller isn't looking for the result we can just return the current userdn value.
898 vp = pairfind(request->config_items, PW_LDAP_USERDN, 0, TAG_ANY);
900 RDEBUG("Using user DN from request \"%s\"", vp->vp_strvalue);
901 *rcode = RLM_MODULE_OK;
902 return vp->vp_strvalue;
907 * Perform all searches as the admin user.
909 if ((*pconn)->rebound) {
910 status = rlm_ldap_bind(inst, request, pconn, inst->admin_dn, inst->password, true);
911 if (status != LDAP_PROC_SUCCESS) {
912 *rcode = RLM_MODULE_FAIL;
918 (*pconn)->rebound = false;
921 if (radius_xlat(filter, sizeof(filter), request, inst->userobj_filter, rlm_ldap_escape_func, NULL) < 0) {
922 REDEBUG("Unable to create filter");
924 *rcode = RLM_MODULE_INVALID;
928 if (radius_xlat(base_dn, sizeof(base_dn), request, inst->userobj_base_dn, rlm_ldap_escape_func, NULL) < 0) {
929 REDEBUG("Unable to create base_dn");
931 *rcode = RLM_MODULE_INVALID;
935 status = rlm_ldap_search(inst, request, pconn, base_dn, inst->userobj_scope, filter, attrs, result);
937 case LDAP_PROC_SUCCESS:
939 case LDAP_PROC_NO_RESULT:
940 *rcode = RLM_MODULE_NOTFOUND;
943 *rcode = RLM_MODULE_FAIL;
949 entry = ldap_first_entry((*pconn)->handle, *result);
951 ldap_get_option((*pconn)->handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
952 REDEBUG("Failed retrieving entry: %s",
953 ldap_err2string(ldap_errno));
958 dn = ldap_get_dn((*pconn)->handle, entry);
960 ldap_get_option((*pconn)->handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
962 REDEBUG("Retrieving object DN from entry failed: %s",
963 ldap_err2string(ldap_errno));
968 RDEBUG("User object found at DN \"%s\"", dn);
969 vp = pairmake(request, &request->config_items, "LDAP-UserDN", dn, T_OP_EQ);
971 *rcode = RLM_MODULE_OK;
977 if ((freeit || (*rcode != RLM_MODULE_OK)) && *result) {
978 ldap_msgfree(*result);
982 return vp ? vp->vp_strvalue : NULL;
985 /** Check for presence of access attribute in result
987 * @param[in] inst rlm_ldap configuration.
988 * @param[in] request Current request.
989 * @param[in] conn used to retrieve access attributes.
990 * @param[in] entry retrieved by rlm_ldap_find_user or rlm_ldap_search.
991 * @return RLM_MODULE_USERLOCK if the user was denied access, else RLM_MODULE_OK.
993 rlm_rcode_t rlm_ldap_check_access(ldap_instance_t const *inst, REQUEST *request,
994 ldap_handle_t const *conn, LDAPMessage *entry)
996 rlm_rcode_t rcode = RLM_MODULE_OK;
999 vals = ldap_get_values(conn->handle, entry, inst->userobj_access_attr);
1001 if (inst->access_positive) {
1002 if (strncasecmp(vals[0], "false", 5) == 0) {
1003 RDEBUG("\"%s\" attribute exists but is set to 'false' - user locked out",
1004 inst->userobj_access_attr);
1005 rcode = RLM_MODULE_USERLOCK;
1007 /* RLM_MODULE_OK set above... */
1008 } else if (strncasecmp(vals[0], "false", 5) != 0) {
1009 RDEBUG("\"%s\" attribute exists - user locked out", inst->userobj_access_attr);
1010 rcode = RLM_MODULE_USERLOCK;
1013 ldap_value_free(vals);
1014 } else if (inst->access_positive) {
1015 RDEBUG("No \"%s\" attribute - user locked out", inst->userobj_access_attr);
1016 rcode = RLM_MODULE_USERLOCK;
1022 /** Verify we got a password from the search
1024 * Checks to see if after the LDAP to RADIUS mapping has been completed that a reference password.
1026 * @param inst rlm_ldap configuration.
1027 * @param request Current request.
1029 void rlm_ldap_check_reply(ldap_instance_t const *inst, REQUEST *request)
1032 * More warning messages for people who can't be bothered to read the documentation.
1034 * Expect_password is set when we process the mapping, and is only true if there was a mapping between
1035 * an LDAP attribute and a password reference attribute in the control list.
1037 if (inst->expect_password && (debug_flag > 1)) {
1038 if (!pairfind(request->config_items, PW_CLEARTEXT_PASSWORD, 0, TAG_ANY) &&
1039 !pairfind(request->config_items, PW_NT_PASSWORD, 0, TAG_ANY) &&
1040 !pairfind(request->config_items, PW_USER_PASSWORD, 0, TAG_ANY) &&
1041 !pairfind(request->config_items, PW_PASSWORD_WITH_HEADER, 0, TAG_ANY) &&
1042 !pairfind(request->config_items, PW_CRYPT_PASSWORD, 0, TAG_ANY)) {
1043 RWDEBUG("No \"known good\" password added. Ensure the admin user has permission to "
1044 "read the password attribute");
1045 RWDEBUG("PAP authentication will *NOT* work with Active Directory (if that is what you "
1046 "were trying to configure)");
1051 #if LDAP_SET_REBIND_PROC_ARGS == 3
1052 /** Callback for OpenLDAP to rebind and chase referrals
1054 * Called by OpenLDAP when it receives a referral and has to rebind.
1056 * @param handle to rebind.
1057 * @param url to bind to.
1058 * @param request that triggered the rebind.
1059 * @param msgid that triggered the rebind.
1060 * @param ctx rlm_ldap configuration.
1062 static int rlm_ldap_rebind(LDAP *handle, LDAP_CONST char *url, UNUSED ber_tag_t request, UNUSED ber_int_t msgid,
1065 ldap_rcode_t status;
1066 ldap_handle_t *conn = talloc_get_type_abort(ctx, ldap_handle_t);
1070 conn->referred = true;
1071 conn->rebound = true; /* not really, but oh well... */
1072 rad_assert(handle == conn->handle);
1074 DEBUG("rlm_ldap (%s): Rebinding to URL %s", conn->inst->xlat_name, url);
1076 status = rlm_ldap_bind(conn->inst, NULL, &conn, conn->inst->admin_dn, conn->inst->password, false);
1077 if (status != LDAP_PROC_SUCCESS) {
1078 ldap_get_option(handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1084 return LDAP_SUCCESS;
1088 /** Create and return a new connection
1090 * Create a new ldap connection and allocate memory for a new rlm_handle_t
1092 * @param instance rlm_ldap instance.
1093 * @return A new connection handle or NULL on error.
1095 void *mod_conn_create(void *instance)
1097 ldap_rcode_t status;
1099 int ldap_errno, ldap_version;
1102 ldap_instance_t *inst = instance;
1103 ldap_handle_t *conn;
1106 * Allocate memory for the handle.
1108 conn = talloc_zero(instance, ldap_handle_t);
1109 if (!conn) return NULL;
1112 conn->rebound = false;
1113 conn->referred = false;
1115 #ifdef HAVE_LDAP_INITIALIZE
1117 DEBUG("rlm_ldap (%s): Connecting to %s", inst->xlat_name, inst->server);
1119 ldap_errno = ldap_initialize(&conn->handle, inst->server);
1120 if (ldap_errno != LDAP_SUCCESS) {
1121 LDAP_ERR("ldap_initialize failed: %s", ldap_err2string(ldap_errno));
1127 DEBUG("rlm_ldap (%s): Connecting to %s:%d", inst->xlat_name, inst->server, inst->port);
1129 conn->handle = ldap_init(inst->server, inst->port);
1130 if (!conn->handle) {
1131 LDAP_ERR("ldap_init() failed");
1137 * We now have a connection structure, but no actual TCP connection.
1139 * Set a bunch of LDAP options, using common code.
1141 #define do_ldap_option(_option, _name, _value) \
1142 if (ldap_set_option(conn->handle, _option, _value) != LDAP_OPT_SUCCESS) { \
1143 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno); \
1144 LDAP_ERR("Could not set %s: %s", _name, ldap_err2string(ldap_errno)); \
1147 #define do_ldap_global_option(_option, _name, _value) \
1148 if (ldap_set_option(NULL, _option, _value) != LDAP_OPT_SUCCESS) { \
1149 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno); \
1150 LDAP_ERR("Could not set %s: %s", _name, ldap_err2string(ldap_errno)); \
1154 if (inst->ldap_debug) {
1155 do_ldap_global_option(LDAP_OPT_DEBUG_LEVEL, "ldap_debug", &(inst->ldap_debug));
1159 * Leave "chase_referrals" unset to use the OpenLDAP default.
1161 if (!inst->chase_referrals_unset) {
1162 if (inst->chase_referrals) {
1163 do_ldap_option(LDAP_OPT_REFERRALS, "chase_referrals", LDAP_OPT_ON);
1165 if (inst->rebind == true) {
1166 #if LDAP_SET_REBIND_PROC_ARGS == 3
1167 ldap_set_rebind_proc(conn->handle, rlm_ldap_rebind, conn);
1171 do_ldap_option(LDAP_OPT_REFERRALS, "chase_referrals", LDAP_OPT_OFF);
1175 memset(&tv, 0, sizeof(tv));
1176 tv.tv_sec = inst->net_timeout;
1178 do_ldap_option(LDAP_OPT_NETWORK_TIMEOUT, "net_timeout", &tv);
1180 do_ldap_option(LDAP_OPT_TIMELIMIT, "srv_timelimit", &(inst->srv_timelimit));
1182 ldap_version = LDAP_VERSION3;
1183 do_ldap_option(LDAP_OPT_PROTOCOL_VERSION, "ldap_version", &ldap_version);
1185 #ifdef LDAP_OPT_X_KEEPALIVE_IDLE
1186 do_ldap_option(LDAP_OPT_X_KEEPALIVE_IDLE, "keepalive idle", &(inst->keepalive_idle));
1189 #ifdef LDAP_OPT_X_KEEPALIVE_PROBES
1190 do_ldap_option(LDAP_OPT_X_KEEPALIVE_PROBES, "keepalive probes", &(inst->keepalive_probes));
1193 #ifdef LDAP_OPT_X_KEEPALIVE_INTERVAL
1194 do_ldap_option(LDAP_OPT_X_KEEPALIVE_INTERVAL, "keepalive interval", &(inst->keepalive_interval));
1197 #ifdef HAVE_LDAP_START_TLS
1199 * Set all of the TLS options
1201 if (inst->tls_mode) {
1202 do_ldap_option(LDAP_OPT_X_TLS, "tls_mode", &(inst->tls_mode));
1205 # define maybe_ldap_option(_option, _name, _value) \
1206 if (_value) do_ldap_option(_option, _name, _value)
1208 maybe_ldap_option(LDAP_OPT_X_TLS_CACERTFILE, "ca_file", inst->tls_ca_file);
1209 maybe_ldap_option(LDAP_OPT_X_TLS_CACERTDIR, "ca_path", inst->tls_ca_path);
1213 * Set certificate options
1215 maybe_ldap_option(LDAP_OPT_X_TLS_CERTFILE, "certificate_file", inst->tls_certificate_file);
1216 maybe_ldap_option(LDAP_OPT_X_TLS_KEYFILE, "private_key_file", inst->tls_private_key_file);
1217 maybe_ldap_option(LDAP_OPT_X_TLS_RANDOM_FILE, "random_file", inst->tls_random_file);
1219 # ifdef LDAP_OPT_X_TLS_NEVER
1220 if (inst->tls_require_cert_str) {
1221 do_ldap_option(LDAP_OPT_X_TLS_REQUIRE_CERT, "require_cert", &inst->tls_require_cert);
1226 * Counter intuitively the TLS context appears to need to be initialised
1227 * after all the TLS options are set on the handle.
1229 # ifdef LDAP_OPT_X_TLS_NEWCTX
1231 /* Always use the new TLS configuration context */
1233 do_ldap_option(LDAP_OPT_X_TLS_NEWCTX, "new TLS context", &is_server);
1239 * And finally start the TLS code.
1241 if (inst->start_tls) {
1242 if (inst->port == 636) {
1243 WARN("Told to Start TLS on LDAPS port this will probably fail, please correct the "
1247 if (ldap_start_tls_s(conn->handle, NULL, NULL) != LDAP_SUCCESS) {
1248 ldap_get_option(conn->handle, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1250 LDAP_ERR("Could not start TLS: %s", ldap_err2string(ldap_errno));
1254 #endif /* HAVE_LDAP_START_TLS */
1256 status = rlm_ldap_bind(inst, NULL, &conn, inst->admin_dn, inst->password, false);
1257 if (status != LDAP_PROC_SUCCESS) {
1264 if (conn->handle) ldap_unbind_s(conn->handle);
1271 /** Close and delete a connection
1273 * Unbinds the LDAP connection, informing the server and freeing any memory, then releases the memory used by the
1274 * connection handle.
1276 * @param instance rlm_ldap instance.
1277 * @param handle to destroy.
1278 * @return always indicates success.
1280 int mod_conn_delete(UNUSED void *instance, void *handle)
1282 ldap_handle_t *conn = handle;
1284 ldap_unbind_s(conn->handle);
1291 /** Gets an LDAP socket from the connection pool
1293 * Retrieve a socket from the connection pool, or NULL on error (of if no sockets are available).
1295 * @param inst rlm_ldap configuration.
1296 * @param request Current request (may be NULL).
1298 ldap_handle_t *rlm_ldap_get_socket(ldap_instance_t const *inst, UNUSED REQUEST *request)
1300 return fr_connection_get(inst->pool);
1304 /** Frees an LDAP socket back to the connection pool
1306 * If the socket was rebound chasing a referral onto another server then we destroy it.
1307 * If the socket was rebound to another user on the same server, we let the next caller rebind it.
1309 * @param inst rlm_ldap configuration.
1310 * @param conn to release.
1312 void rlm_ldap_release_socket(ldap_instance_t const *inst, ldap_handle_t *conn)
1315 * Could have already been free'd due to a previous error.
1320 * We chased a referral to another server.
1322 * This connection is no longer part of the pool which is connected to and bound to the configured server.
1325 * Note that we do NOT close it if it was bound to another user. Instead, we let the next caller do the
1328 if (conn->referred) {
1329 fr_connection_del(inst->pool, conn);
1333 fr_connection_release(inst->pool, conn);