2 * rlm_ldap.c LDAP authorization and authentication module.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 * This module is based on LDAP patch to Cistron radiusd by James Golovich
19 * <james@wwnet.net>, which in turn was based mostly on a Mysql+Cistron patch
20 * from <oyarzun@wilmington.net>
22 * 17 Jan 2000, Adrian Pavlykevych <pam@polynet.lviv.ua>
23 * - OpenLDAP SDK porting, basic TLS support, LDAP authorization,
24 * fault tolerance with multiple LDAP server support
25 * 24 May 2000, Adrian Pavlykevych <pam@polynet.lviv.ua>
26 * - Converting to new configuration file format, futher improvements
27 * in fault tolerance, threaded operation
28 * 12 Dec 2000, Adrian Pavlykevych <pam@polynet.lviv.ua>
29 * - Added preliminary support for multiple instances
30 * - moved all instance configuration into dynamicly allocated structure
31 * - Removed connection maintenance thread and all attempts for multihreading
32 * the module itself. OpenLDAP SDK is not thread safe when used with shared
34 * - Added configuration option for defining LDAP attribute of user object,
35 * which controls remote access.
36 * 16 Feb 2001, Hannu Laurila <hannu.laurila@japo.fi>
37 * - LDAP<->RADIUS attribute mappings are now read from a file
38 * - Support for generic RADIUS check and reply attribute.
39 * Jun 2001, Kostas Kalevras <kkalev@noc.ntua.gr>
40 * - Fix: check and reply attributes from LDAP _replace_ existing ones
41 * - Added "default_profile" directive, which points to radiusProfile
42 * object, which contains default values for RADIUS users
43 * - Added "profile_attribute" directive, which specifies user object
44 * attribute pointing to radiusProfile object.
45 * Nov 2001, Kostas Kalevras <kkalev@noc.ntua.gr>
46 * - Added support for adding the user password to the check. Based on
47 * the password_header directive rlm_ldap will strip the
48 * password header if needed. This will make support for CHAP much easier.
49 * - Added module messages when we reject a user.
50 * - Added ldap_groupcmp to allow searching for user group membership.
51 * - Added ldap_xlat to allow ldap urls in xlat strings. Something like:
52 * %{ldap:ldap:///dc=company,dc=com?cn?sub?uid=user}
53 * Nov 2001, Gordon Tetlow <gordont@gnf.org>
54 * - Do an xlat on the access_group attribute.
55 * Dec 2001, Kostas Kalevras <kkalev@noc.ntua.gr>
56 * - Added ldap caching for the default/regular profiles and group entries.
57 * - Fixed a memory leak in ldap_xlat.
58 * - Removed dict_attrbyname from ldap_pairget. They are not needed.
59 * - Moved the radius_xlat's for filter and basedn in ldap_authenticate() to
61 * - Made the module thread safe. We create a connection pool and each thread
62 * will call ldap_get_conn to lock one of the ldap connections and release with
63 * a call to ldap_release_conn when it has finished.
64 * - Request only the user attributes that interest us (radius attributes,regular
65 * profile,user password and access attribute).
66 * Mar 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
67 * - Fixed a bug where the ldap server will kill the idle connections from the ldap
68 * connection pool. We now check if ldap_search returns LDAP_SERVER_DOWN and try to
69 * reconnect if it does. Bug noted by Dan Perik <dan_perik-work@ntm.org.pg>
70 * May 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
71 * - Instead of the Group attribute we now have the Ldap-Group attribute, to avoid
72 * collisions with other modules
73 * - If perform_search fails check the ld != NULL before using it. Based on a bug report
74 * by John <jhogenmiller@pennswoods.net>
75 * Jun 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
76 * - Add the ability to do a paircmp on the check items. Add a compare_check_items boolean
77 * configuration directive which defaults to no. If it is set then we will do a compare
78 * - Add another configuration directive. access_attr_used_for_allow. If it is set to yes
79 * then the access_attr will be used to allow user access. If it is set to no then it will
80 * be used to deny user access.
81 * - Remember to free inst->atts in ldap_detach()
82 * - Add a forgotten ldap_free_urldesc in ldap_xlat()
83 * - Add a variable locked in the LDAP_CONN structure. We use this to avoid deadlocks. The mutex
84 * we are using is of type fast and can deadlock if the same thread tries to relock it. That
85 * could happen in case of calls to xlat.
86 * - When ldap_search returns NO_SUCH_OBJECT don't return fail but notfound
87 * Jul 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
88 * - Fix the logic when we get an LDAP_SERVER_DOWN or we have conn->ld == NULL in perform_search
89 * - Try to minimize the penalty of having the ldap server go down. The comments before
90 * MAX_FAILED_CONNS_* definitions should explain things.
91 * - Check for a number of error codes from ldap_search and log corresponding error messages
92 * We should only reconnect when that can help things.
93 * - In ldap_groupcmp instead of first searching for the group object and then checking user
94 * group membership combine them in one ldap search operation. That should make group
95 * membership checks a lot faster.
96 * - Remember to do ldap_release_conn and ldap_msgfree when we do paircmp and the result is reject
97 * Aug 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
98 * - Add support for group membership attribute inside the user entry in ldap_groupcmp. The attribute
99 * can either contain the name or the DN of the group. Added the groupmembership_attribute
100 * configuration directive
101 * - Move the ldap_{get,release}_conn in ldap_groupcmp so that we hold a connection for the minimum time.
102 * - Now that ldap_groupcmp is complete we really don't need access_group. Removed it.
103 * - Remember to free groupmembership_attribute in ldap_detach
104 * - Don't delete existing generic attributes in ldap_pairget when adding new ones. Since generic attributes
105 * have operators we don't need to try to be cleaver.
106 * Sep 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
107 * - Fix a crash in ldap_pairget when the attribute value is larger than the buffer size
108 * Bug report by Stefan Radovanovici <sra@rtsffm.com>
109 * - If we add a check item then use the == operator. Based on an idea by Allister Maguire <amaguire@gnc.net.nz>
110 * - Only add a failure message for bind as user failed in ldap_authenticate if the result of ldap_connect was
112 * - Make tls_mode a configurable option. Patch from John <jhogenmiller@pennswoods.net>
113 * - Allow multiple regular profiles for an entry
114 * Oct 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
115 * - Disable cache after searching for the default profile
116 * - Use the MAX_FAILED_CONNS_* in ldap_authenticate() when calling ldap_connect()
117 * Nov 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
118 * - Set LDAP version to V3 before binding. Now freeradius should work with openldap21
119 * Dec 2002, Kostas Kalevras <kkalev@noc.ntua.gr>
120 * - Set default values for the server and basedn parameters
121 * Feb 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
122 * - Add support for ldap_initialize. That way we can specify the server as an ldap url.
123 * Based on ideas from Derrik Pates <dpates@dsdk12.net>
124 * Mar 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
125 * - Add an ldap_escape_func. Escape the * character from the filter so that we can avoid
126 * the trivial DoS of username=*
127 * - Remove the caching code. It does not exist in openldap21.
128 * Based on a report from Mike Denka <mdenk@whidbey.net>
129 * May 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
130 * - Don't do a double free on the attribute maps. Bug noted by Derrik Pates <dpates@dsdk12.net>
131 * - Apply a patch from Alexander M. Pravking <fduch@antar.bryansk.ru> to do an xlat on the
132 * retrieved attributes.
133 * Aug 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
134 * - In case of a bad search filter, print out the corresponding filter
135 * Sep 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
136 * - Compile even if we don't have pthread's
137 * Oct 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
138 * - Add a new configuration directive, base_filter which is used for base scope searches
139 * (When searching for the default/regular profiles for example)
140 * Nov 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
141 * - Add a new configuration directive, do_xlat (default: yes). If set we use pairxlatmove
142 * on the radius attributes, else we fall back to the plain old pairadd. That way people
143 * can fall back on the 0.8.1 behaviour without making changes to their ldap database or
144 * gain a little performance by not using pairxlatmove
145 * Dec 2003, Kostas Kalevras <kkalev@noc.ntua.gr>
146 * - Add a patch from Jon Miner <miner@doit.wisc.edu> to add the ability to configure
147 * various LDAP TLS options
148 * - Only call pairfree if we are using pairxlatmove not for pairadd
149 * Mar 2004, Kostas Kalevras <kkalev@noc.ntua.gr>
150 * - If we are passed an empty password log a module failure message not an error message
151 * Apr 2004, Kostas Kalveras <kkalev@noc.ntua.gr>
152 * - Add a patch from Tarun Bhushan <tarun.bhushan@macquarie.com> to add a tls_mode boolean
153 * directive so that we can enable TLS connetions even if port is not set to 636
154 * - Add an error message if ldap_initialize() is not available and we are passed a URL like
155 * 'server' directive.
156 * - Add a per instance Ldap-Group attribute (of the form <instance>-Ldap-Group) and register
157 * a corresponding ldap_groupcmp function
159 static const char rcsid[] = "$Id$";
161 #include "autoconf.h"
163 #include <sys/types.h>
164 #include <sys/socket.h>
165 #include <sys/time.h>
166 #include <netinet/in.h>
183 #include "libradius.h"
185 #include "conffile.h"
187 #include "rad_assert.h"
189 #ifndef HAVE_PTHREAD_H
191 * This is a lot simpler than putting ifdef's around
192 * every use of the pthread functions.
194 #define pthread_mutex_lock(a)
195 #define pthread_mutex_unlock(a)
196 #define pthread_mutex_init(a,b)
197 #define pthread_mutex_destroy(a)
201 #define MAX_FILTER_STR_LEN 1024
205 * These are used in case ldap_search returns LDAP_SERVER_DOWN
206 * In that case we do conn->failed_conns++ and then check it:
207 * If conn->failed_conns <= MAX_FAILED_CONNS_START then we try
209 * conn->failed_conns is also checked on entrance in perform_search:
210 * If conn->failed_conns > MAX_FAILED_CONNS_START then we don't
211 * try to do anything and we just do conn->failed_conns++ and
212 * return RLM_MODULE_FAIL
213 * if conn->failed_conns >= MAX_FAILED_CONNS_END then we give it
214 * another chance and we set it to MAX_FAILED_CONNS_RESTART and
218 * We are assuming that the majority of the LDAP_SERVER_DOWN cases
219 * will either be an ldap connection timeout or a temporary ldap
221 * As a result we make a few attempts to reconnect hoping that the problem
222 * will soon go away. If it does not go away then we just return
223 * RLM_MODULE_FAIL on entrance in perform_search until conn->failed_conns
224 * gets to MAX_FAILED_CONNS_END. After that we give it one more chance by
225 * going back to MAX_FAILED_CONNS_RESTART
229 #define MAX_FAILED_CONNS_END 20
230 #define MAX_FAILED_CONNS_RESTART 4
231 #define MAX_FAILED_CONNS_START 5
233 /* linked list of mappings between RADIUS attributes and LDAP attributes */
234 struct TLDAP_RADIUS {
237 struct TLDAP_RADIUS* next;
239 typedef struct TLDAP_RADIUS TLDAP_RADIUS;
241 typedef struct ldap_conn {
246 pthread_mutex_t mutex;
253 struct timeval net_timeout;
254 struct timeval timeout;
269 char *default_profile;
274 char *dictionary_mapping;
275 char *groupname_attr;
276 char *groupmemb_filt;
277 char *groupmemb_attr;
279 TLDAP_RADIUS *check_item_map;
280 TLDAP_RADIUS *reply_item_map;
282 int ldap_debug; /* Debug flag for LDAP SDK */
283 char *xlat_name; /* name used to xlat */
284 char *tls_cacertfile;
289 char *tls_require_cert;
292 /* The default setting for TLS Certificate Verification */
293 #define TLS_DEFAULT_VERIFY "allow"
295 static CONF_PARSER module_config[] = {
296 {"server", PW_TYPE_STRING_PTR, offsetof(ldap_instance,server), NULL, "localhost"},
297 {"port", PW_TYPE_INTEGER, offsetof(ldap_instance,port), NULL, "389"},
298 /* wait forever on network activity */
299 {"net_timeout", PW_TYPE_INTEGER, offsetof(ldap_instance,net_timeout.tv_sec), NULL, "10"},
300 /* wait forever for search results */
301 {"timeout", PW_TYPE_INTEGER, offsetof(ldap_instance,timeout.tv_sec), NULL, "20"},
302 /* allow server unlimited time for search (server-side limit) */
303 {"timelimit", PW_TYPE_INTEGER, offsetof(ldap_instance,timelimit), NULL, "20"},
304 {"identity", PW_TYPE_STRING_PTR, offsetof(ldap_instance,login), NULL, ""},
305 {"tls_mode", PW_TYPE_BOOLEAN, offsetof(ldap_instance,tls_mode), NULL, "no"},
306 {"start_tls", PW_TYPE_BOOLEAN, offsetof(ldap_instance,start_tls), NULL, "no"},
307 {"tls_cacertfile", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_cacertfile), NULL, NULL},
308 {"tls_cacertdir", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_cacertdir), NULL, NULL},
309 {"tls_certfile", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_certfile), NULL, NULL},
310 {"tls_keyfile", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_keyfile), NULL, NULL},
311 {"tls_randfile", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_randfile), NULL, NULL},
312 {"tls_require_cert", PW_TYPE_STRING_PTR, offsetof(ldap_instance,tls_require_cert), NULL, TLS_DEFAULT_VERIFY},
313 {"password", PW_TYPE_STRING_PTR, offsetof(ldap_instance,password), NULL, ""},
314 {"basedn", PW_TYPE_STRING_PTR, offsetof(ldap_instance,basedn), NULL, "o=notexist"},
315 {"filter", PW_TYPE_STRING_PTR, offsetof(ldap_instance,filter), NULL, "(uid=%u)"},
316 {"base_filter", PW_TYPE_STRING_PTR, offsetof(ldap_instance,base_filter), NULL, "(objectclass=radiusprofile)"},
317 {"default_profile", PW_TYPE_STRING_PTR, offsetof(ldap_instance,default_profile), NULL, NULL},
318 {"profile_attribute", PW_TYPE_STRING_PTR, offsetof(ldap_instance,profile_attr), NULL, NULL},
319 {"password_header", PW_TYPE_STRING_PTR, offsetof(ldap_instance,passwd_hdr), NULL, NULL},
320 {"password_attribute", PW_TYPE_STRING_PTR, offsetof(ldap_instance,passwd_attr), NULL, NULL},
321 /* LDAP attribute name that controls remote access */
322 {"access_attr", PW_TYPE_STRING_PTR, offsetof(ldap_instance,access_attr), NULL, NULL},
323 /* file with mapping between LDAP and RADIUS attributes */
324 {"groupname_attribute", PW_TYPE_STRING_PTR, offsetof(ldap_instance,groupname_attr), NULL, "cn"},
325 {"groupmembership_filter", PW_TYPE_STRING_PTR, offsetof(ldap_instance,groupmemb_filt), NULL, "(|(&(objectClass=GroupOfNames)(member=%{Ldap-UserDn}))(&(objectClass=GroupOfUniqueNames)(uniquemember=%{Ldap-UserDn})))"},
326 {"groupmembership_attribute", PW_TYPE_STRING_PTR, offsetof(ldap_instance,groupmemb_attr), NULL, NULL},
327 {"dictionary_mapping", PW_TYPE_STRING_PTR, offsetof(ldap_instance,dictionary_mapping), NULL, "${confdir}/ldap.attrmap"},
328 {"ldap_debug", PW_TYPE_INTEGER, offsetof(ldap_instance,ldap_debug), NULL, "0x0000"},
329 {"ldap_connections_number", PW_TYPE_INTEGER, offsetof(ldap_instance,num_conns), NULL, "5"},
330 {"compare_check_items", PW_TYPE_BOOLEAN, offsetof(ldap_instance,do_comp), NULL, "no"},
331 {"access_attr_used_for_allow", PW_TYPE_BOOLEAN, offsetof(ldap_instance,default_allow), NULL, "yes"},
332 {"do_xlat", PW_TYPE_BOOLEAN, offsetof(ldap_instance,do_xlat), NULL, "yes"},
334 {NULL, -1, 0, NULL, NULL}
337 #define ld_valid ld_options.ldo_valid
338 #define LDAP_VALID_SESSION 0x2
339 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
342 static void fieldcpy(char *, char **);
344 static VALUE_PAIR *ldap_pairget(LDAP *, LDAPMessage *, TLDAP_RADIUS *,VALUE_PAIR **,char);
345 static int ldap_groupcmp(void *, REQUEST *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR *, VALUE_PAIR **);
346 static int ldap_xlat(void *,REQUEST *, char *, char *,int, RADIUS_ESCAPE_STRING);
347 static LDAP *ldap_connect(void *instance, const char *, const char *, int, int *);
348 static int read_mappings(ldap_instance* inst);
350 static inline int ldap_get_conn(LDAP_CONN *conns,LDAP_CONN **ret,void *instance)
352 ldap_instance *inst = instance;
355 for(;i<inst->num_conns;i++){
356 if (conns[i].locked == 0 && pthread_mutex_trylock(&(conns[i].mutex)) == 0){
359 DEBUG("ldap_get_conn: Got Id: %d",i);
367 static inline void ldap_release_conn(int i, LDAP_CONN *conns)
369 DEBUG("ldap_release_conn: Release Id: %d",i);
371 pthread_mutex_unlock(&(conns[i].mutex));
374 /*************************************************************************
376 * Function: rlm_ldap_instantiate
378 * Purpose: Uses section of radiusd config file passed as parameter
379 * to create an instance of the module.
381 *************************************************************************/
383 ldap_instantiate(CONF_SECTION * conf, void **instance)
388 int reply_map_num = 0;
389 int check_map_num = 0;
390 int att_map[3] = {0,0,0};
395 inst = rad_malloc(sizeof *inst);
399 memset(inst, 0, sizeof(*inst));
401 if (cf_section_parse(conf, inst, module_config) < 0) {
406 if (inst->server == NULL) {
407 radlog(L_ERR, "rlm_ldap: missing 'server' directive.");
412 if (ldap_is_ldap_url(inst->server)){
413 #ifdef HAVE_LDAP_INITIALIZE
417 radlog(L_ERR, "rlm_ldap: 'server' directive is in URL form but ldap_initialize() is not available.");
423 inst->timeout.tv_usec = 0;
424 inst->net_timeout.tv_usec = 0;
425 /* workaround for servers which support LDAPS but not START TLS */
426 if(inst->port == LDAPS_PORT || inst->tls_mode)
427 inst->tls_mode = LDAP_OPT_X_TLS_HARD;
430 inst->reply_item_map = NULL;
431 inst->check_item_map = NULL;
433 inst->failed_conns = 0;
435 DEBUG("rlm_ldap: Registering ldap_groupcmp for Ldap-Group");
436 paircompare_register(PW_LDAP_GROUP, PW_USER_NAME, ldap_groupcmp, inst);
438 xlat_name = cf_section_name2(conf);
439 if (xlat_name != NULL){
444 * Allocate room for <instance>-Ldap-Group
446 group_name = malloc((strlen(xlat_name) + 1 + 11) * sizeof(char));
447 rad_assert(group_name != NULL);
448 sprintf(group_name,"%s-Ldap-Group",xlat_name);
449 DEBUG("rlm_ldap: Creating new attribute %s",group_name);
450 dict_addattr(group_name, 0, PW_TYPE_STRING, -1, flags);
451 dattr = dict_attrbyname(group_name);
453 radlog(L_ERR, "rlm_ldap: Failed to create attribute %s",group_name);
457 DEBUG("rlm_ldap: Registering ldap_groupcmp for %s",group_name);
458 paircompare_register(dattr->attr, PW_USER_NAME, ldap_groupcmp, inst);
461 xlat_name = cf_section_name1(conf);
462 rad_assert(xlat_name != NULL); /* or all hell breaks loose */
464 inst->xlat_name = strdup(xlat_name);
465 DEBUG("rlm_ldap: Registering ldap_xlat with xlat_name %s",xlat_name);
466 xlat_register(xlat_name,ldap_xlat,inst);
468 if (inst->num_conns <= 0){
469 radlog(L_ERR, "rlm_ldap: Invalid ldap connections number passed.");
473 inst->conns = (LDAP_CONN *)malloc(sizeof(LDAP_CONN)*inst->num_conns);
474 if (inst->conns == NULL){
475 radlog(L_ERR, "rlm_ldap: Could not allocate memory. Aborting.");
479 for(;i<inst->num_conns;i++){
480 inst->conns[i].bound = 0;
481 inst->conns[i].locked = 0;
482 inst->conns[i].failed_conns = 0;
483 inst->conns[i].ld = NULL;
484 pthread_mutex_init(&inst->conns[i].mutex, NULL);
487 if (read_mappings(inst) != 0) {
488 radlog(L_ERR, "rlm_ldap: Reading dictionary mappings from file %s failed",
489 inst->dictionary_mapping);
490 radlog(L_ERR, "rlm_ldap: Proceeding with no mappings");
493 pair = inst->check_item_map;
498 check_map_num = (atts_num - 1);
499 pair = inst->reply_item_map;
504 reply_map_num = (atts_num - 1);
505 if (inst->profile_attr)
507 if (inst->passwd_attr)
509 if (inst->access_attr)
511 inst->atts = (char **)malloc(sizeof(char *)*(atts_num + 1));
512 if (inst->atts == NULL){
513 radlog(L_ERR, "rlm_ldap: Could not allocate memory. Aborting.");
517 pair = inst->check_item_map;
518 for(i=0;i<atts_num;i++){
519 if (i <= check_map_num ){
520 inst->atts[i] = pair->attr;
521 if (i == check_map_num)
522 pair = inst->reply_item_map;
526 else if (i <= reply_map_num){
527 inst->atts[i] = pair->attr;
531 if (inst->profile_attr && !att_map[0]){
532 inst->atts[i] = inst->profile_attr;
535 else if (inst->passwd_attr && !att_map[1]){
536 inst->atts[i] = inst->passwd_attr;
539 else if (inst->access_attr && !att_map[2]){
540 inst->atts[i] = inst->access_attr;
545 inst->atts[atts_num] = NULL;
547 DEBUG("conns: %p",inst->conns);
557 * read_mappings(...) reads a ldap<->radius mappings file to inst->reply_item_map and inst->check_item_map
560 #define MAX_LINE_LEN 160
561 #define GENERIC_ATTRIBUTE_ID "$GENERIC$"
564 read_mappings(ldap_instance* inst)
568 /* all buffers are of MAX_LINE_LEN so we can use sscanf without being afraid of buffer overflows */
569 char buf[MAX_LINE_LEN], itemType[MAX_LINE_LEN], radiusAttribute[MAX_LINE_LEN], ldapAttribute[MAX_LINE_LEN];
572 /* open the mappings file for reading */
574 filename = inst->dictionary_mapping;
575 DEBUG("rlm_ldap: reading ldap<->radius mappings from file %s", filename);
576 mapfile = fopen(filename, "r");
578 if (mapfile == NULL) {
579 radlog(L_ERR, "rlm_ldap: Opening file %s failed", filename);
580 return -1; /* error */
583 /* read file line by line. Note that if line length exceed MAX_LINE_LEN, line numbers will be mixed up */
587 while (fgets(buf, sizeof buf, mapfile)!=NULL) {
595 ptr = strchr(buf, '#');
599 if (buf[0] == 0) continue;
601 /* extract tokens from the string */
602 token_count = sscanf(buf, "%s %s %s", itemType, radiusAttribute, ldapAttribute);
604 if (token_count <= 0) /* no tokens */
607 if (token_count != 3) {
608 radlog(L_ERR, "rlm_ldap: Skipping %s line %i: %s", filename, linenumber, buf);
609 radlog(L_ERR, "rlm_ldap: Expected 3 tokens "
610 "(Item type, RADIUS Attribute and LDAP Attribute) but found only %i", token_count);
614 /* create new TLDAP_RADIUS list node */
615 pair = rad_malloc(sizeof(TLDAP_RADIUS));
617 pair->attr = strdup(ldapAttribute);
618 pair->radius_attr = strdup(radiusAttribute);
620 if ( (pair->attr == NULL) || (pair->radius_attr == NULL) ) {
621 radlog(L_ERR, "rlm_ldap: Out of memory");
622 if (pair->attr) free(pair->attr);
623 if (pair->radius_attr) free(pair->radius_attr);
629 /* push node to correct list */
630 if (strcasecmp(itemType, "checkItem") == 0) {
631 pair->next = inst->check_item_map;
632 inst->check_item_map = pair;
633 } else if (strcasecmp(itemType, "replyItem") == 0) {
634 pair->next = inst->reply_item_map;
635 inst->reply_item_map = pair;
637 radlog(L_ERR, "rlm_ldap: file %s: skipping line %i: unknown itemType %s",
638 filename, linenumber, itemType);
640 free(pair->radius_attr);
645 DEBUG("rlm_ldap: LDAP %s mapped to RADIUS %s",
646 pair->attr, pair->radius_attr);
651 return 0; /* success */
655 perform_search(void *instance, LDAP_CONN *conn, char *search_basedn, int scope, char *filter,
656 char **attrs, LDAPMessage ** result)
658 int res = RLM_MODULE_OK;
660 ldap_instance *inst = instance;
661 int search_retry = 0;
666 radlog(L_ERR, "rlm_ldap: NULL connection handle passed");
667 return RLM_MODULE_FAIL;
669 if (conn->failed_conns > MAX_FAILED_CONNS_START){
670 conn->failed_conns++;
671 if (conn->failed_conns >= MAX_FAILED_CONNS_END){
672 conn->failed_conns = MAX_FAILED_CONNS_RESTART;
677 if (!conn->bound || conn->ld == NULL) {
678 DEBUG2("rlm_ldap: attempting LDAP reconnection");
680 DEBUG2("rlm_ldap: closing existing LDAP connection");
681 ldap_unbind_s(conn->ld);
683 if ((conn->ld = ldap_connect(instance, inst->login, inst->password, 0, &res)) == NULL) {
684 radlog(L_ERR, "rlm_ldap: (re)connection attempt failed");
685 if (search_retry == 0)
686 conn->failed_conns++;
687 return (RLM_MODULE_FAIL);
690 conn->failed_conns = 0;
692 DEBUG2("rlm_ldap: performing search in %s, with filter %s", search_basedn ? search_basedn : "(null)" , filter);
693 switch (ldap_search_st(conn->ld, search_basedn, scope, filter, attrs, 0, &(inst->timeout), result)) {
695 case LDAP_NO_SUCH_OBJECT:
697 case LDAP_SERVER_DOWN:
698 radlog(L_ERR, "rlm_ldap: ldap_search() failed: LDAP connection lost.");
699 conn->failed_conns++;
700 if (search_retry == 0){
701 if (conn->failed_conns <= MAX_FAILED_CONNS_START){
702 radlog(L_INFO, "rlm_ldap: Attempting reconnect");
705 ldap_msgfree(*result);
709 ldap_msgfree(*result);
710 return RLM_MODULE_FAIL;
711 case LDAP_INSUFFICIENT_ACCESS:
712 radlog(L_ERR, "rlm_ldap: ldap_search() failed: Insufficient access. Check the identity and password configuration directives.");
713 ldap_msgfree(*result);
714 return RLM_MODULE_FAIL;
716 radlog(L_ERR, "rlm_ldap: ldap_search() failed: Timed out while waiting for server to respond. Please increase the timeout.");
717 ldap_msgfree(*result);
718 return RLM_MODULE_FAIL;
719 case LDAP_FILTER_ERROR:
720 radlog(L_ERR, "rlm_ldap: ldap_search() failed: Bad search filter: %s",filter);
721 ldap_msgfree(*result);
722 return RLM_MODULE_FAIL;
723 case LDAP_TIMELIMIT_EXCEEDED:
725 case LDAP_UNAVAILABLE:
726 /* We don't need to reconnect in these cases so we don't set conn->bound */
727 ldap_get_option(conn->ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
728 radlog(L_ERR, "rlm_ldap: ldap_search() failed: %s", ldap_err2string(ldap_errno));
729 ldap_msgfree(*result);
730 return (RLM_MODULE_FAIL);
732 ldap_get_option(conn->ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
733 radlog(L_ERR, "rlm_ldap: ldap_search() failed: %s", ldap_err2string(ldap_errno));
735 ldap_msgfree(*result);
736 return (RLM_MODULE_FAIL);
739 if ((ldap_count_entries(conn->ld, *result)) != 1) {
740 DEBUG("rlm_ldap: object not found or got ambiguous search result");
741 res = RLM_MODULE_NOTFOUND;
742 ldap_msgfree(*result);
749 * Translate the LDAP queries.
751 static int ldap_escape_func(char *out, int outlen, const char *in)
757 * Only one byte left.
763 if (strchr("*", *in)) {
770 * Else it's a nice character.
783 * ldap_groupcmp(). Implement the Ldap-Group == "group" filter
786 static int ldap_groupcmp(void *instance, REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
787 VALUE_PAIR *check_pairs, VALUE_PAIR **reply_pairs)
789 char filter[MAX_FILTER_STR_LEN];
790 char gr_filter[MAX_FILTER_STR_LEN];
792 LDAPMessage *result = NULL;
793 LDAPMessage *msg = NULL;
794 char basedn[MAX_FILTER_STR_LEN];
795 char *attrs[] = {"dn",NULL};
797 ldap_instance *inst = instance;
798 char *group_attrs[] = {inst->groupmemb_attr,NULL};
801 VALUE_PAIR *vp_user_dn;
802 VALUE_PAIR **request_pairs;
804 request_pairs = &req->packet->vps;
806 DEBUG("rlm_ldap: Entering ldap_groupcmp()");
808 if (check->strvalue == NULL || check->length == 0){
809 DEBUG("rlm_ldap::ldap_groupcmp: Illegal group name");
814 DEBUG("rlm_ldap::ldap_groupcmp: NULL request");
818 if (!radius_xlat(basedn, sizeof(basedn), inst->basedn, req, NULL)) {
819 DEBUG("rlm_ldap::ldap_groupcmp: unable to create basedn.");
823 while((vp_user_dn = pairfind(*request_pairs, PW_LDAP_USERDN)) == NULL){
824 char *user_dn = NULL;
826 if (!radius_xlat(filter, sizeof(filter), inst->filter,
827 req, ldap_escape_func)){
828 DEBUG("rlm_ldap::ldap_groupcmp: unable to create filter");
831 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
832 radlog(L_ERR, "rlm_ldap: All ldap connections are in use");
835 if ((res = perform_search(inst, conn, basedn, LDAP_SCOPE_SUBTREE,
836 filter, attrs, &result)) != RLM_MODULE_OK){
837 DEBUG("rlm_ldap::ldap_groupcmp: search failed");
838 ldap_release_conn(conn_id,inst->conns);
841 if ((msg = ldap_first_entry(conn->ld, result)) == NULL) {
842 DEBUG("rlm_ldap::ldap_groupcmp: ldap_first_entry() failed");
843 ldap_release_conn(conn_id,inst->conns);
844 ldap_msgfree(result);
847 if ((user_dn = ldap_get_dn(conn->ld, msg)) == NULL) {
848 DEBUG("rlm_ldap:ldap_groupcmp:: ldap_get_dn() failed");
849 ldap_release_conn(conn_id,inst->conns);
850 ldap_msgfree(result);
853 ldap_release_conn(conn_id,inst->conns);
855 * Adding new attribute containing DN for LDAP object associated with
858 pairadd(request_pairs, pairmake("Ldap-UserDn", user_dn, T_OP_EQ));
859 ldap_memfree(user_dn);
860 ldap_msgfree(result);
863 if(!radius_xlat(gr_filter, sizeof(gr_filter), inst->groupmemb_filt, req, NULL)){
864 DEBUG("rlm_ldap::ldap_groupcmp: unable to create filter.");
868 if (strchr((char *)check->strvalue,',') != NULL) {
869 /* This looks like a DN */
870 snprintf(filter,sizeof(filter), "%s",gr_filter);
871 snprintf(basedn,sizeof(basedn), "%s",(char *)check->strvalue);
873 snprintf(filter,sizeof(filter), "(&(%s=%s)%s)",inst->groupname_attr,(char *)check->strvalue,gr_filter);
875 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
876 radlog(L_ERR, "rlm_ldap: All ldap connections are in use");
880 if ((res = perform_search(inst, conn, basedn, LDAP_SCOPE_SUBTREE,
881 filter, attrs, &result)) == RLM_MODULE_OK){
882 DEBUG("rlm_ldap::ldap_groupcmp: User found in group %s",
883 (char *)check->strvalue);
884 ldap_msgfree(result);
885 ldap_release_conn(conn_id,inst->conns);
889 ldap_release_conn(conn_id,inst->conns);
891 if (res != RLM_MODULE_NOTFOUND ) {
892 DEBUG("rlm_ldap::ldap_groupcmp: Search returned error");
896 if (inst->groupmemb_attr == NULL){
897 /* search returned NOTFOUND and searching for membership
898 * using user object attributes is not specified in config
901 DEBUG("rlm_ldap::ldap_groupcmp: Group %s not found or user is not a member.",(char *)check->strvalue);
905 snprintf(filter,sizeof(filter), "(objectclass=*)");
906 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
907 radlog(L_ERR, "rlm_ldap: Add ldap connections are in use");
910 if ((res = perform_search(inst, conn, vp_user_dn->strvalue, LDAP_SCOPE_BASE,
911 filter, group_attrs,&result)) != RLM_MODULE_OK){
912 DEBUG("rlm_ldap::ldap_groupcmp: Search returned error");
913 ldap_release_conn(conn_id, inst->conns);
917 if ((msg = ldap_first_entry(conn->ld, result)) == NULL) {
918 DEBUG("rlm_ldap::ldap_groupcmp: ldap_first_entry() failed");
919 ldap_release_conn(conn_id,inst->conns);
920 ldap_msgfree(result);
923 if ((vals = ldap_get_values(conn->ld, msg, inst->groupmemb_attr)) != NULL) {
926 for (;i < ldap_count_values(vals);i++){
927 if (strchr(vals[i],',') != NULL){
928 /* This looks like a DN */
929 LDAPMessage *gr_result = NULL;
930 snprintf(filter,sizeof(filter), "(%s=%s)",
931 inst->groupname_attr,
932 (char *)check->strvalue);
933 if ((res = perform_search(inst, conn, vals[i],
934 LDAP_SCOPE_BASE, filter,
935 attrs, &gr_result)) != RLM_MODULE_OK){
936 if (res != RLM_MODULE_NOTFOUND){
937 DEBUG("rlm_ldap::ldap_groupcmp: \
938 Search returned error");
939 ldap_value_free(vals);
940 ldap_msgfree(result);
941 ldap_release_conn(conn_id,inst->conns);
945 ldap_msgfree(gr_result);
950 if (strcmp(vals[i],(char *)check->strvalue) == 0){
956 ldap_value_free(vals);
957 ldap_msgfree(result);
959 DEBUG("rlm_ldap::groupcmp: Group %s not found \
960 or user not a member",
961 (char *)check->strvalue);
962 ldap_release_conn(conn_id,inst->conns);
966 DEBUG("rlm_ldap::ldap_groupcmp: ldap_get_values() failed");
967 ldap_msgfree(result);
968 ldap_release_conn(conn_id,inst->conns);
972 DEBUG("rlm_ldap::ldap_groupcmp: User found in group %s",(char *)check->strvalue);
973 ldap_release_conn(conn_id,inst->conns);
980 * Do an xlat on an LDAP URL
983 static int ldap_xlat(void *instance, REQUEST *request, char *fmt, char *out, int freespace,
984 RADIUS_ESCAPE_STRING func)
986 char url[MAX_FILTER_STR_LEN];
989 ldap_instance *inst = instance;
990 LDAPURLDesc *ldap_url;
991 LDAPMessage *result = NULL;
992 LDAPMessage *msg = NULL;
997 DEBUG("rlm_ldap: - ldap_xlat");
998 if (!radius_xlat(url, sizeof(url), fmt, request, func)) {
999 radlog (L_ERR, "rlm_ldap: Unable to create LDAP URL.\n");
1002 if (!ldap_is_ldap_url(url)){
1003 radlog (L_ERR, "rlm_ldap: String passed does not look like an LDAP URL.\n");
1006 if (ldap_url_parse(url,&ldap_url)){
1007 radlog (L_ERR, "rlm_ldap: LDAP URL parse failed.\n");
1010 if (ldap_url->lud_attrs == NULL || ldap_url->lud_attrs[0] == NULL || \
1011 ( ldap_url->lud_attrs[1] != NULL || ( ! strlen(ldap_url->lud_attrs[0]) || \
1012 ! strcmp(ldap_url->lud_attrs[0],"*") ) ) ){
1013 radlog (L_ERR, "rlm_ldap: Invalid Attribute(s) request.\n");
1014 ldap_free_urldesc(ldap_url);
1017 if (ldap_url->lud_host){
1018 if (strncmp(inst->server,ldap_url->lud_host,strlen(inst->server)) != 0 || \
1019 ldap_url->lud_port != inst->port){
1020 DEBUG("rlm_ldap: Requested server/port is not known to this module instance.");
1021 ldap_free_urldesc(ldap_url);
1025 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
1026 radlog(L_ERR, "rlm_ldap: All ldap connections are in use");
1027 ldap_free_urldesc(ldap_url);
1030 if ((res = perform_search(inst, conn, ldap_url->lud_dn, ldap_url->lud_scope, ldap_url->lud_filter, ldap_url->lud_attrs, &result)) != RLM_MODULE_OK){
1031 if (res == RLM_MODULE_NOTFOUND){
1032 DEBUG("rlm_ldap: Search returned not found");
1033 ldap_free_urldesc(ldap_url);
1034 ldap_release_conn(conn_id,inst->conns);
1037 DEBUG("rlm_ldap: Search returned error");
1038 ldap_free_urldesc(ldap_url);
1039 ldap_release_conn(conn_id,inst->conns);
1042 if ((msg = ldap_first_entry(conn->ld, result)) == NULL){
1043 DEBUG("rlm_ldap: ldap_first_entry() failed");
1044 ldap_msgfree(result);
1045 ldap_free_urldesc(ldap_url);
1046 ldap_release_conn(conn_id,inst->conns);
1049 if ((vals = ldap_get_values(conn->ld, msg, ldap_url->lud_attrs[0])) != NULL) {
1050 ret = strlen(vals[0]);
1051 if (ret > freespace){
1052 DEBUG("rlm_ldap: Insufficient string space");
1053 ldap_free_urldesc(ldap_url);
1054 ldap_value_free(vals);
1055 ldap_msgfree(result);
1056 ldap_release_conn(conn_id,inst->conns);
1059 DEBUG("rlm_ldap: Adding attribute %s, value: %s",ldap_url->lud_attrs[0],vals[0]);
1060 strncpy(out,vals[0],ret);
1061 ldap_value_free(vals);
1066 ldap_msgfree(result);
1067 ldap_free_urldesc(ldap_url);
1068 ldap_release_conn(conn_id,inst->conns);
1070 DEBUG("rlm_ldap: - ldap_xlat end");
1076 /******************************************************************************
1078 * Function: rlm_ldap_authorize
1080 * Purpose: Check if user is authorized for remote access
1082 ******************************************************************************/
1084 ldap_authorize(void *instance, REQUEST * request)
1086 LDAPMessage *result = NULL;
1087 LDAPMessage *msg = NULL;
1088 LDAPMessage *def_msg = NULL;
1089 LDAPMessage *def_attr_msg = NULL;
1090 LDAPMessage *def_result = NULL;
1091 LDAPMessage *def_attr_result = NULL;
1092 ldap_instance *inst = instance;
1093 char *user_dn = NULL;
1094 char filter[MAX_FILTER_STR_LEN];
1095 char basedn[MAX_FILTER_STR_LEN];
1096 VALUE_PAIR *check_tmp;
1097 VALUE_PAIR *reply_tmp;
1099 VALUE_PAIR **check_pairs, **reply_pairs;
1101 VALUE_PAIR *module_fmsg_vp;
1102 VALUE_PAIR *user_profile;
1103 char module_fmsg[MAX_STRING_LEN];
1107 DEBUG("rlm_ldap: - authorize");
1109 if (!request->username){
1110 radlog(L_AUTH, "rlm_ldap: Attribute \"User-Name\" is required for authentication.\n");
1111 return RLM_MODULE_INVALID;
1114 check_pairs = &request->config_items;
1115 reply_pairs = &request->reply->vps;
1118 * Check for valid input, zero length names not permitted
1120 if (request->username->strvalue == 0) {
1121 radlog(L_ERR, "rlm_ldap: zero length username not permitted\n");
1122 return RLM_MODULE_INVALID;
1124 DEBUG("rlm_ldap: performing user authorization for %s",
1125 request->username->strvalue);
1127 if (!radius_xlat(filter, sizeof(filter), inst->filter,
1128 request, ldap_escape_func)) {
1129 radlog (L_ERR, "rlm_ldap: unable to create filter.\n");
1130 return RLM_MODULE_INVALID;
1133 if (!radius_xlat(basedn, sizeof(basedn), inst->basedn,
1135 radlog (L_ERR, "rlm_ldap: unable to create basedn.\n");
1136 return RLM_MODULE_INVALID;
1139 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
1140 radlog(L_ERR, "rlm_ldap: All ldap connections are in use");
1141 return RLM_MODULE_FAIL;
1143 if ((res = perform_search(instance, conn, basedn, LDAP_SCOPE_SUBTREE, filter, inst->atts, &result)) != RLM_MODULE_OK) {
1144 DEBUG("rlm_ldap: search failed");
1145 if (res == RLM_MODULE_NOTFOUND){
1146 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: User not found");
1147 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1148 pairadd(&request->packet->vps, module_fmsg_vp);
1150 ldap_release_conn(conn_id,inst->conns);
1153 if ((msg = ldap_first_entry(conn->ld, result)) == NULL) {
1154 DEBUG("rlm_ldap: ldap_first_entry() failed");
1155 ldap_msgfree(result);
1156 ldap_release_conn(conn_id,inst->conns);
1157 return RLM_MODULE_FAIL;
1159 if ((user_dn = ldap_get_dn(conn->ld, msg)) == NULL) {
1160 DEBUG("rlm_ldap: ldap_get_dn() failed");
1161 ldap_msgfree(result);
1162 ldap_release_conn(conn_id,inst->conns);
1163 return RLM_MODULE_FAIL;
1166 * Adding new attribute containing DN for LDAP object associated with
1169 pairadd(&request->packet->vps, pairmake("Ldap-UserDn", user_dn, T_OP_EQ));
1170 ldap_memfree(user_dn);
1173 /* Remote access is controled by attribute of the user object */
1174 if (inst->access_attr) {
1175 if ((vals = ldap_get_values(conn->ld, msg, inst->access_attr)) != NULL) {
1176 if (inst->default_allow){
1177 DEBUG("rlm_ldap: checking if remote access for %s is allowed by %s", request->username->strvalue, inst->access_attr);
1178 if (!strncmp(vals[0], "FALSE", 5)) {
1179 DEBUG("rlm_ldap: dialup access disabled");
1180 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: Access Attribute denies access");
1181 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1182 pairadd(&request->packet->vps, module_fmsg_vp);
1183 ldap_msgfree(result);
1184 ldap_value_free(vals);
1185 ldap_release_conn(conn_id,inst->conns);
1186 return RLM_MODULE_USERLOCK;
1188 ldap_value_free(vals);
1191 DEBUG("rlm_ldap: %s attribute exists - access denied by default", inst->access_attr);
1192 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: Access Attribute denies access");
1193 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1194 pairadd(&request->packet->vps, module_fmsg_vp);
1195 ldap_msgfree(result);
1196 ldap_value_free(vals);
1197 ldap_release_conn(conn_id,inst->conns);
1198 return RLM_MODULE_USERLOCK;
1201 if (inst->default_allow){
1202 DEBUG("rlm_ldap: no %s attribute - access denied by default", inst->access_attr);
1203 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: Access Attribute denies access");
1204 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1205 pairadd(&request->packet->vps, module_fmsg_vp);
1206 ldap_msgfree(result);
1207 ldap_release_conn(conn_id,inst->conns);
1208 return RLM_MODULE_USERLOCK;
1214 * Check for the default profile entry. If it exists then add the
1215 * attributes it contains in the check and reply pairs
1218 user_profile = pairfind(request->config_items, PW_USER_PROFILE);
1219 if (inst->default_profile || user_profile){
1220 char *profile = inst->default_profile;
1222 strNcpy(filter,inst->base_filter,sizeof(filter));
1224 profile = user_profile->strvalue;
1225 if (profile && strlen(profile)){
1226 if ((res = perform_search(instance, conn,
1227 profile, LDAP_SCOPE_BASE,
1228 filter, inst->atts, &def_result)) == RLM_MODULE_OK){
1229 if ((def_msg = ldap_first_entry(conn->ld,def_result))){
1230 if ((check_tmp = ldap_pairget(conn->ld,def_msg,inst->check_item_map,check_pairs,1))) {
1232 pairxlatmove(request, check_pairs, &check_tmp);
1233 pairfree(&check_tmp);
1236 pairadd(check_pairs,check_tmp);
1238 if ((reply_tmp = ldap_pairget(conn->ld,def_msg,inst->reply_item_map,reply_pairs,0))) {
1240 pairxlatmove(request, reply_pairs, &reply_tmp);
1241 pairfree(&reply_tmp);
1244 pairadd(reply_pairs,reply_tmp);
1247 ldap_msgfree(def_result);
1249 DEBUG("rlm_ldap: default_profile/user-profile search failed");
1254 * Check for the profile attribute. If it exists, we assume that it
1255 * contains the DN of an entry containg a profile for the user. That
1256 * way we can have different general profiles for various user groups
1257 * (students,faculty,staff etc)
1260 if (inst->profile_attr){
1261 if ((vals = ldap_get_values(conn->ld, msg, inst->profile_attr)) != NULL) {
1263 strNcpy(filter,inst->base_filter,sizeof(filter));
1264 while(vals[i] != NULL && strlen(vals[i])){
1265 if ((res = perform_search(instance, conn,
1266 vals[i], LDAP_SCOPE_BASE,
1267 filter, inst->atts, &def_attr_result)) == RLM_MODULE_OK){
1268 if ((def_attr_msg = ldap_first_entry(conn->ld,def_attr_result))){
1269 if ((check_tmp = ldap_pairget(conn->ld,def_attr_msg,inst->check_item_map,check_pairs,1))) {
1271 pairxlatmove(request, check_pairs, &check_tmp);
1272 pairfree(&check_tmp);
1275 pairadd(check_pairs,check_tmp);
1277 if ((reply_tmp = ldap_pairget(conn->ld,def_attr_msg,inst->reply_item_map,reply_pairs,0))) {
1279 pairxlatmove(request, reply_pairs, &reply_tmp);
1280 pairfree(&reply_tmp);
1283 pairadd(reply_pairs,reply_tmp);
1286 ldap_msgfree(def_attr_result);
1288 DEBUG("rlm_ldap: profile_attribute search failed");
1291 ldap_value_free(vals);
1294 if (inst->passwd_attr && strlen(inst->passwd_attr)){
1295 VALUE_PAIR *passwd_item;
1297 if ((passwd_item = pairfind(request->config_items, PW_PASSWORD)) == NULL){
1299 char *passwd_val = NULL;
1302 if ((passwd_vals = ldap_get_values(conn->ld,msg,inst->passwd_attr)) != NULL){
1304 while(passwd_vals[i] != NULL){
1305 if (strlen(passwd_vals[i])){
1306 passwd_val = passwd_vals[i];
1308 if (inst->passwd_hdr && strlen(inst->passwd_hdr)){
1309 passwd_val = strstr(passwd_val,inst->passwd_hdr);
1310 if (passwd_val != NULL)
1311 passwd_val += strlen(inst->passwd_hdr);
1313 DEBUG("rlm_ldap: Password header not found in password %s for user %s", passwd_vals[0],request->username->strvalue);
1316 if ((passwd_item = paircreate(PW_PASSWORD,PW_TYPE_STRING)) == NULL){
1317 radlog(L_ERR|L_CONS, "no memory");
1318 ldap_value_free(passwd_vals);
1319 ldap_msgfree(result);
1320 ldap_release_conn(conn_id,inst->conns);
1321 return RLM_MODULE_FAIL;
1323 passwd_len = strlen(passwd_val);
1324 strncpy(passwd_item->strvalue,passwd_val,MAX_STRING_LEN - 1);
1325 passwd_item->length = (passwd_len > (MAX_STRING_LEN - 1)) ? (MAX_STRING_LEN - 1) : passwd_len;
1326 pairadd(&request->config_items,passwd_item);
1327 DEBUG("rlm_ldap: Added password %s in check items",passwd_item->strvalue);
1332 ldap_value_free(passwd_vals);
1339 DEBUG("rlm_ldap: looking for check items in directory...");
1341 if ((check_tmp = ldap_pairget(conn->ld, msg, inst->check_item_map,check_pairs,1)) != NULL) {
1343 pairxlatmove(request, check_pairs, &check_tmp);
1344 pairfree(&check_tmp);
1347 pairadd(check_pairs,check_tmp);
1351 DEBUG("rlm_ldap: looking for reply items in directory...");
1354 if ((reply_tmp = ldap_pairget(conn->ld, msg, inst->reply_item_map,reply_pairs,0)) != NULL) {
1356 pairxlatmove(request, reply_pairs, &reply_tmp);
1357 pairfree(&reply_tmp);
1360 pairadd(reply_pairs,reply_tmp);
1363 if (inst->do_comp && paircmp(request,request->packet->vps,*check_pairs,reply_pairs) != 0){
1364 DEBUG("rlm_ldap: Pairs do not match. Rejecting user.");
1365 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: Pairs do not match");
1366 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1367 pairadd(&request->packet->vps, module_fmsg_vp);
1368 ldap_msgfree(result);
1369 ldap_release_conn(conn_id,inst->conns);
1371 return RLM_MODULE_REJECT;
1375 * Module should default to LDAP authentication if no Auth-Type
1378 if (pairfind(*check_pairs, PW_AUTHTYPE) == NULL)
1379 pairadd(check_pairs, pairmake("Auth-Type", "LDAP", T_OP_EQ));
1382 DEBUG("rlm_ldap: user %s authorized to use remote access",
1383 request->username->strvalue);
1384 ldap_msgfree(result);
1385 ldap_release_conn(conn_id,inst->conns);
1387 return RLM_MODULE_OK;
1390 /*****************************************************************************
1392 * Function: rlm_ldap_authenticate
1394 * Purpose: Check the user's password against ldap database
1396 *****************************************************************************/
1398 ldap_authenticate(void *instance, REQUEST * request)
1401 LDAPMessage *result, *msg;
1402 ldap_instance *inst = instance;
1403 char *user_dn, *attrs[] = {"uid", NULL};
1404 char filter[MAX_FILTER_STR_LEN];
1405 char basedn[MAX_FILTER_STR_LEN];
1407 VALUE_PAIR *vp_user_dn;
1408 VALUE_PAIR *module_fmsg_vp;
1409 char module_fmsg[MAX_STRING_LEN];
1413 DEBUG("rlm_ldap: - authenticate");
1416 * Ensure that we're being passed a plain-text password, and not
1420 if (!request->username) {
1421 radlog(L_AUTH, "rlm_ldap: Attribute \"User-Name\" is required for authentication.\n");
1422 return RLM_MODULE_INVALID;
1425 if (!request->password){
1426 radlog(L_AUTH, "rlm_ldap: Attribute \"User-Password\" is required for authentication.");
1427 return RLM_MODULE_INVALID;
1430 if(request->password->attribute != PW_PASSWORD) {
1431 radlog(L_AUTH, "rlm_ldap: Attribute \"User-Password\" is required for authentication. Cannot use \"%s\".", request->password->name);
1432 return RLM_MODULE_INVALID;
1435 if (request->password->length == 0) {
1436 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: empty password supplied");
1437 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1438 pairadd(&request->packet->vps, module_fmsg_vp);
1439 return RLM_MODULE_INVALID;
1443 * Check that we don't have any failed connections. If we do there's no real need
1444 * of runing. Also give it another chance if we have a lot of failed connections.
1446 if (inst->failed_conns > MAX_FAILED_CONNS_END)
1447 inst->failed_conns = 0;
1448 if (inst->failed_conns > MAX_FAILED_CONNS_START){
1449 inst->failed_conns++;
1450 return RLM_MODULE_FAIL;
1454 DEBUG("rlm_ldap: login attempt by \"%s\" with password \"%s\"",
1455 request->username->strvalue, request->password->strvalue);
1457 while((vp_user_dn = pairfind(request->packet->vps, PW_LDAP_USERDN)) == NULL) {
1458 if (!radius_xlat(filter, sizeof(filter), inst->filter,
1460 radlog (L_ERR, "rlm_ldap: unable to create filter.\n");
1461 return RLM_MODULE_INVALID;
1464 if (!radius_xlat(basedn, sizeof(basedn), inst->basedn,
1466 radlog (L_ERR, "rlm_ldap: unable to create basedn.\n");
1467 return RLM_MODULE_INVALID;
1470 if ((conn_id = ldap_get_conn(inst->conns,&conn,inst)) == -1){
1471 radlog(L_ERR, "rlm_ldap: All ldap connections are in use");
1472 return RLM_MODULE_FAIL;
1474 if ((res = perform_search(instance, conn, basedn, LDAP_SCOPE_SUBTREE, filter, attrs, &result)) != RLM_MODULE_OK) {
1475 if (res == RLM_MODULE_NOTFOUND){
1476 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: User not found");
1477 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1478 pairadd(&request->packet->vps, module_fmsg_vp);
1480 ldap_release_conn(conn_id,inst->conns);
1483 if ((msg = ldap_first_entry(conn->ld, result)) == NULL) {
1484 ldap_msgfree(result);
1485 ldap_release_conn(conn_id,inst->conns);
1486 return RLM_MODULE_FAIL;
1488 if ((user_dn = ldap_get_dn(conn->ld, msg)) == NULL) {
1489 DEBUG("rlm_ldap: ldap_get_dn() failed");
1490 ldap_msgfree(result);
1491 ldap_release_conn(conn_id,inst->conns);
1492 return RLM_MODULE_FAIL;
1494 ldap_release_conn(conn_id,inst->conns);
1495 pairadd(&request->packet->vps, pairmake("Ldap-UserDn", user_dn, T_OP_EQ));
1496 ldap_memfree(user_dn);
1497 ldap_msgfree(result);
1500 user_dn = vp_user_dn->strvalue;
1502 DEBUG("rlm_ldap: user DN: %s", user_dn);
1504 ld_user = ldap_connect(instance, user_dn, request->password->strvalue,
1506 if (ld_user == NULL){
1507 if (res == RLM_MODULE_REJECT){
1508 inst->failed_conns = 0;
1509 snprintf(module_fmsg,sizeof(module_fmsg),"rlm_ldap: Bind as user failed");
1510 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
1511 pairadd(&request->packet->vps, module_fmsg_vp);
1513 if (res == RLM_MODULE_FAIL){
1514 DEBUG("rlm_ldap: ldap_connect() failed");
1515 inst->failed_conns++;
1520 DEBUG("rlm_ldap: user %s authenticated succesfully",
1521 request->username->strvalue);
1522 ldap_unbind_s(ld_user);
1523 inst->failed_conns = 0;
1525 return RLM_MODULE_OK;
1529 ldap_connect(void *instance, const char *dn, const char *password, int auth, int *result)
1531 ldap_instance *inst = instance;
1533 int msgid, rc, ldap_version;
1538 #ifdef HAVE_LDAP_INITIALIZE
1539 DEBUG("rlm_ldap: (re)connect to %s, authentication %d", inst->server, auth);
1540 if (ldap_initialize(&ld, inst->server) != LDAP_SUCCESS) {
1541 radlog(L_ERR, "rlm_ldap: ldap_initialize() failed");
1542 *result = RLM_MODULE_FAIL;
1548 DEBUG("rlm_ldap: (re)connect to %s:%d, authentication %d", inst->server, inst->port, auth);
1549 if ((ld = ldap_init(inst->server, inst->port)) == NULL) {
1550 radlog(L_ERR, "rlm_ldap: ldap_init() failed");
1551 *result = RLM_MODULE_FAIL;
1555 if (ldap_set_option(ld, LDAP_OPT_NETWORK_TIMEOUT, (void *) &(inst->net_timeout)) != LDAP_OPT_SUCCESS) {
1556 radlog(L_ERR, "rlm_ldap: Could not set LDAP_OPT_NETWORK_TIMEOUT %ld.%ld", inst->net_timeout.tv_sec, inst->net_timeout.tv_usec);
1558 if (ldap_set_option(ld, LDAP_OPT_TIMELIMIT, (void *) &(inst->timelimit)) != LDAP_OPT_SUCCESS) {
1559 radlog(L_ERR, "rlm_ldap: Could not set LDAP_OPT_TIMELIMIT %d", inst->timelimit);
1561 if (inst->ldap_debug && ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, &(inst->ldap_debug)) != LDAP_OPT_SUCCESS) {
1562 radlog(L_ERR, "rlm_ldap: Could not set LDAP_OPT_DEBUG_LEVEL %d", inst->ldap_debug);
1564 ldap_version = LDAP_VERSION3;
1565 if (ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, &ldap_version) != LDAP_OPT_SUCCESS) {
1566 radlog(L_ERR, "rlm_ldap: Could not set LDAP version to V3");
1568 #ifdef HAVE_LDAP_START_TLS
1569 if(inst->tls_mode) {
1570 DEBUG("rlm_ldap: setting TLS mode to %d", inst->tls_mode);
1571 if(ldap_set_option(ld, LDAP_OPT_X_TLS,
1572 (void *) &(inst->tls_mode)) != LDAP_OPT_SUCCESS) {
1573 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1574 radlog(L_ERR, "rlm_ldap: could not set LDAP_OPT_X_TLS option %s", ldap_err2string(ldap_errno));
1578 if(inst->tls_cacertfile != NULL) {
1579 DEBUG("rlm_ldap: setting TLS CACert File to %s", inst->tls_cacertfile);
1581 if ( ldap_set_option( NULL, LDAP_OPT_X_TLS_CACERTFILE,
1582 (void *) inst->tls_cacertfile )
1583 != LDAP_OPT_SUCCESS) {
1584 radlog(L_ERR, "rlm_ldap: could not set "
1585 "LDAP_OPT_X_TLS_CACERTFILE option to %s", inst->tls_cacertfile);
1589 if(inst->tls_cacertdir != NULL) {
1590 DEBUG("rlm_ldap: setting TLS CACert File to %s", inst->tls_cacertdir);
1592 if ( ldap_set_option( NULL, LDAP_OPT_X_TLS_CACERTDIR,
1593 (void *) inst->tls_cacertdir )
1594 != LDAP_OPT_SUCCESS) {
1595 radlog(L_ERR, "rlm_ldap: could not set "
1596 "LDAP_OPT_X_TLS_CACERTDIR option to %s", inst->tls_cacertdir);
1600 if( strcmp( TLS_DEFAULT_VERIFY, inst->tls_require_cert ) != 0 ) {
1601 DEBUG("rlm_ldap: setting TLS Require Cert to %s",
1602 inst->tls_require_cert);
1606 #ifdef HAVE_INT_TLS_CONFIG
1608 if ( ldap_int_tls_config( NULL, LDAP_OPT_X_TLS_REQUIRE_CERT,
1609 (inst->tls_require_cert) )
1610 != LDAP_OPT_SUCCESS) {
1611 radlog(L_ERR, "rlm_ldap: could not set "
1612 "LDAP_OPT_X_TLS_REQUIRE_CERT option to %s",
1613 inst->tls_require_cert);
1618 if(inst->tls_certfile != NULL) {
1619 DEBUG("rlm_ldap: setting TLS Cert File to %s", inst->tls_certfile);
1621 if ( ldap_set_option( NULL, LDAP_OPT_X_TLS_CERTFILE,
1622 (void *) inst->tls_certfile )
1623 != LDAP_OPT_SUCCESS) {
1624 radlog(L_ERR, "rlm_ldap: could not set "
1625 "LDAP_OPT_X_TLS_CERTFILE option to %s",
1626 inst->tls_certfile);
1630 if(inst->tls_keyfile != NULL) {
1631 DEBUG("rlm_ldap: setting TLS Key File to %s", inst->tls_keyfile);
1633 if ( ldap_set_option( NULL, LDAP_OPT_X_TLS_KEYFILE,
1634 (void *) inst->tls_keyfile )
1635 != LDAP_OPT_SUCCESS) {
1636 radlog(L_ERR, "rlm_ldap: could not set "
1637 "LDAP_OPT_X_TLS_KEYFILE option to %s",
1642 if(inst->tls_randfile != NULL) {
1643 DEBUG("rlm_ldap: setting TLS Key File to %s", inst->tls_randfile);
1645 if ( ldap_set_option( NULL, LDAP_OPT_X_TLS_RANDOM_FILE,
1646 (void *) inst->tls_randfile )
1647 != LDAP_OPT_SUCCESS) {
1648 radlog(L_ERR, "rlm_ldap: could not set "
1649 "LDAP_OPT_X_TLS_RANDOM_FILE option to %s",
1650 inst->tls_randfile);
1653 if (inst->start_tls) {
1654 DEBUG("rlm_ldap: starting TLS");
1655 rc = ldap_start_tls_s(ld, NULL, NULL);
1656 if (rc != LDAP_SUCCESS) {
1657 DEBUG("rlm_ldap: ldap_start_tls_s()");
1658 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1659 radlog(L_ERR, "rlm_ldap: could not start TLS %s", ldap_err2string(ldap_errno));
1660 *result = RLM_MODULE_FAIL;
1665 #endif /* HAVE_LDAP_START_TLS */
1668 DEBUG("rlm_ldap: bind as %s/%s to %s", dn, password, inst->server);
1671 DEBUG("rlm_ldap: bind as %s/%s to %s:%d", dn, password, inst->server, inst->port);
1673 msgid = ldap_bind(ld, dn, password,LDAP_AUTH_SIMPLE);
1675 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1677 radlog(L_ERR, "rlm_ldap: %s bind to %s failed: %s",
1678 dn, inst->server, ldap_err2string(ldap_errno));
1680 radlog(L_ERR, "rlm_ldap: %s bind to %s:%d failed: %s",
1681 dn, inst->server, inst->port,
1682 ldap_err2string(ldap_errno));
1683 *result = RLM_MODULE_FAIL;
1687 DEBUG("rlm_ldap: waiting for bind result ...");
1689 rc = ldap_result(ld, msgid, 1, &(inst->timeout), &res);
1692 DEBUG("rlm_ldap: ldap_result()");
1693 ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &ldap_errno);
1695 radlog(L_ERR, "rlm_ldap: %s bind to %s failed: %s",
1696 dn, inst->server, (rc == 0) ? "timeout" : ldap_err2string(ldap_errno));
1698 radlog(L_ERR, "rlm_ldap: %s bind to %s:%d failed: %s",
1699 dn, inst->server, inst->port,
1700 (rc == 0) ? "timeout" : ldap_err2string(ldap_errno));
1701 *result = RLM_MODULE_FAIL;
1705 ldap_errno = ldap_result2error(ld, res, 1);
1706 switch (ldap_errno) {
1708 DEBUG("rlm_ldap: Bind was successful");
1709 *result = RLM_MODULE_OK;
1712 case LDAP_INVALID_CREDENTIALS:
1714 DEBUG("rlm_ldap: Bind failed with invalid credentials");
1715 *result = RLM_MODULE_REJECT;
1718 radlog(L_ERR, "rlm_ldap: LDAP login failed: check identity, password settings in ldap section of radiusd.conf");
1719 *result = RLM_MODULE_FAIL;
1725 radlog(L_ERR,"rlm_ldap: %s bind to %s failed %s",
1726 dn, inst->server, ldap_err2string(ldap_errno));
1728 radlog(L_ERR,"rlm_ldap: %s bind to %s:%d failed %s",
1729 dn, inst->server, inst->port,
1730 ldap_err2string(ldap_errno));
1731 *result = RLM_MODULE_FAIL;
1734 if (*result != RLM_MODULE_OK) {
1741 /*****************************************************************************
1743 * Detach from the LDAP server and cleanup internal state.
1745 *****************************************************************************/
1747 ldap_detach(void *instance)
1749 ldap_instance *inst = instance;
1750 TLDAP_RADIUS *pair, *nextpair;
1753 free((char *) inst->server);
1755 free((char *) inst->login);
1757 free((char *) inst->password);
1759 free((char *) inst->basedn);
1760 if (inst->dictionary_mapping)
1761 free(inst->dictionary_mapping);
1763 free((char *) inst->filter);
1764 if (inst->base_filter)
1765 free((char *) inst->base_filter);
1766 if (inst->passwd_hdr)
1767 free((char *) inst->passwd_hdr);
1768 if (inst->passwd_attr)
1769 free((char *) inst->passwd_attr);
1770 if (inst->groupname_attr)
1771 free((char *) inst->groupname_attr);
1772 if (inst->groupmemb_filt)
1773 free((char *) inst->groupmemb_filt);
1774 if (inst->groupmemb_attr)
1775 free((char *) inst->groupmemb_attr);
1776 if (inst->access_attr)
1777 free((char *) inst->access_attr);
1778 if (inst->profile_attr)
1779 free((char *) inst->profile_attr);
1783 for(;i<inst->num_conns;i++){
1784 if (inst->conns[i].ld){
1785 ldap_unbind_s(inst->conns[i].ld);
1787 pthread_mutex_destroy(&inst->conns[i].mutex);
1792 pair = inst->check_item_map;
1794 while (pair != NULL) {
1795 nextpair = pair->next;
1797 free(pair->radius_attr);
1802 pair = inst->reply_item_map;
1804 while (pair != NULL) {
1805 nextpair = pair->next;
1807 free(pair->radius_attr);
1815 paircompare_unregister(PW_LDAP_GROUP, ldap_groupcmp);
1816 xlat_unregister(inst->xlat_name,ldap_xlat);
1817 free(inst->xlat_name);
1826 fieldcpy(char *string, char **uptr)
1831 while (*ptr == ' ' || *ptr == '\t') {
1836 while (*ptr != '"' && *ptr != '\0' && *ptr != '\n') {
1846 while (*ptr != ' ' && *ptr != '\t' && *ptr != '\0' && *ptr != '\n' &&
1847 *ptr != '=' && *ptr != ',') {
1855 /*****************************************************************************
1856 * Get RADIUS attributes from LDAP object
1857 * ( according to draft-adoba-radius-05.txt
1858 * <http://www.ietf.org/internet-drafts/draft-adoba-radius-05.txt> )
1860 *****************************************************************************/
1863 ldap_pairget(LDAP * ld, LDAPMessage * entry,
1864 TLDAP_RADIUS * item_map, VALUE_PAIR **pairs,char is_check)
1870 TLDAP_RADIUS *element;
1872 int is_generic_attribute;
1874 VALUE_PAIR *pairlist = NULL;
1875 VALUE_PAIR *newpair = NULL;
1877 /* check if there is a mapping from this LDAP attribute to a RADIUS attribute */
1878 for (element = item_map; element != NULL; element = element->next) {
1879 if ((vals = ldap_get_values(ld,entry,element->attr)) != NULL){
1880 /* check whether this is a one-to-one-mapped ldap attribute or a generic
1881 attribute and set flag accordingly */
1883 if (strcasecmp(element->radius_attr, GENERIC_ATTRIBUTE_ID)==0)
1884 is_generic_attribute = 1;
1886 is_generic_attribute = 0;
1888 /* find out how many values there are for the attribute and extract all of them */
1890 vals_count = ldap_count_values(vals);
1892 for (vals_idx = 0; vals_idx < vals_count; vals_idx++) {
1893 ptr = vals[vals_idx];
1895 if (is_generic_attribute) {
1896 /* this is a generic attribute */
1897 LRAD_TOKEN dummy; /* makes pairread happy */
1899 /* not sure if using pairread here is ok ... */
1900 if ( (newpair = pairread(&ptr, &dummy)) != NULL) {
1901 DEBUG("rlm_ldap: extracted attribute %s from generic item %s",
1902 newpair->name, vals[vals_idx]);
1903 pairadd(&pairlist, newpair);
1905 radlog(L_ERR, "rlm_ldap: parsing %s failed: %s",
1906 element->attr, vals[vals_idx]);
1909 /* this is a one-to-one-mapped attribute */
1910 token = gettoken(&ptr, value, sizeof(value) - 1);
1911 if (token < T_EQSTART || token > T_EQEND) {
1912 token = (is_check) ? T_OP_CMP_EQ : T_OP_EQ;
1914 gettoken(&ptr, value, sizeof(value) - 1);
1916 if (value[0] == 0) {
1917 DEBUG("rlm_ldap: Attribute %s has no value", element->attr);
1920 DEBUG("rlm_ldap: Adding %s as %s, value %s & op=%d", element->attr, element->radius_attr, value, token);
1921 if ((newpair = pairmake(element->radius_attr, value, token)) == NULL)
1924 pairdelete(pairs,newpair->attribute);
1926 pairadd(&pairlist, newpair);
1929 ldap_value_free(vals);
1936 /* globally exported name */
1937 module_t rlm_ldap = {
1939 RLM_TYPE_THREAD_SAFE, /* type: reserved */
1940 NULL, /* initialization */
1941 ldap_instantiate, /* instantiation */
1943 ldap_authenticate, /* authentication */
1944 ldap_authorize, /* authorization */
1945 NULL, /* preaccounting */
1946 NULL, /* accounting */
1947 NULL, /* checksimul */
1948 NULL, /* pre-proxy */
1949 NULL, /* post-proxy */
1950 NULL /* post-auth */
1952 ldap_detach, /* detach */