2 * modules.c Radius module support.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2003,2006 The FreeRADIUS server project
21 * Copyright 2000 Alan DeKok <aland@ox.org>
22 * Copyright 2000 Alan Curry <pacman@world.std.com>
25 #include <freeradius-devel/ident.h>
28 #include <freeradius-devel/autoconf.h>
34 #include <freeradius-devel/radiusd.h>
35 #include <freeradius-devel/modpriv.h>
36 #include <freeradius-devel/modcall.h>
37 #include <freeradius-devel/rad_assert.h>
39 typedef struct indexed_modcallable {
42 modcallable *modulelist;
43 } indexed_modcallable;
46 * For each component, keep an ordered list of ones to call.
48 static lrad_hash_table_t *components;
50 static rbtree_t *module_tree = NULL;
52 typedef struct section_type_value_t {
56 } section_type_value_t;
60 * Ordered by component
62 static const section_type_value_t section_type_value[RLM_COMPONENT_COUNT] = {
63 { "authenticate", "Auth-Type", PW_AUTH_TYPE },
64 { "authorize", "Autz-Type", PW_AUTZ_TYPE },
65 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },
66 { "accounting", "Acct-Type", PW_ACCT_TYPE },
67 { "session", "Session-Type", PW_SESSION_TYPE },
68 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE },
69 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE },
70 { "post-auth", "Post-Auth-Type", PW_POST_AUTH_TYPE },
76 static const section_type_value_t old_section_type_value[] = {
77 { "authenticate", "authtype", PW_AUTH_TYPE },
78 { "authorize", "autztype", PW_AUTZ_TYPE },
79 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },/* unused */
80 { "accounting", "acctype", PW_ACCT_TYPE },
81 { "session", "sesstype", PW_SESSION_TYPE },
82 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE }, /* unused */
83 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE }, /* unused */
84 { "post-auth", "post-authtype", PW_POST_AUTH_TYPE }
88 static void indexed_modcallable_free(void *data)
90 indexed_modcallable *c = data;
92 modcallable_free(&c->modulelist);
96 static uint32_t indexed_modcallable_hash(const void *data)
99 const indexed_modcallable *c = data;
101 hash = lrad_hash(&c->comp, sizeof(c->comp));
102 return lrad_hash_update(&c->idx, sizeof(c->idx), hash);
105 static int indexed_modcallable_cmp(const void *one, const void *two)
107 const indexed_modcallable *a = one;
108 const indexed_modcallable *b = two;
110 if (a->comp < b->comp) return -1;
111 if (a->comp > b->comp) return +1;
113 return a->idx - b->idx;
118 * Free a module instance.
120 static void module_instance_free(void *data)
122 module_instance_t *this = data;
124 if (this->entry->module->detach)
125 (this->entry->module->detach)(this->insthandle);
126 #ifdef HAVE_PTHREAD_H
130 * The mutex MIGHT be locked...
131 * we'll check for that later, I guess.
133 pthread_mutex_destroy(this->mutex);
142 * Compare two module entries
144 static int module_entry_cmp(const void *one, const void *two)
146 const module_entry_t *a = one;
147 const module_entry_t *b = two;
149 return strcmp(a->name, b->name);
153 * Free a module entry.
155 static void module_entry_free(void *data)
157 module_entry_t *this = data;
159 lt_dlclose(this->handle); /* ignore any errors */
165 * Remove the module lists.
167 int detach_modules(void)
169 lrad_hash_table_free(components);
176 * Find a module on disk or in memory, and link to it.
178 static module_entry_t *linkto_module(const char *module_name,
179 const char *cffilename, int cflineno)
181 module_entry_t myentry;
182 module_entry_t *node;
184 char module_struct[256];
188 strNcpy(myentry.name, module_name, sizeof(myentry.name));
189 node = rbtree_finddata(module_tree, &myentry);
190 if (node) return node;
193 * Keep the handle around so we can dlclose() it.
195 handle = lt_dlopenext(module_name);
196 if (handle == NULL) {
197 radlog(L_ERR|L_CONS, "%s[%d] Failed to link to module '%s':"
198 " %s\n", cffilename, cflineno, module_name, lt_dlerror());
203 * Link to the module's rlm_FOO{} module structure.
205 * The module_name variable has the version number
206 * embedded in it, and we don't want that here.
208 strcpy(module_struct, module_name);
209 p = strrchr(module_struct, '-');
212 DEBUG3(" (Loaded %s, checking if it's valid)", module_name);
215 * libltld MAY core here, if the handle it gives us contains
218 module = lt_dlsym(handle, module_struct);
220 radlog(L_ERR|L_CONS, "%s[%d] Failed linking to "
221 "%s structure in %s: %s\n",
222 cffilename, cflineno,
223 module_name, cffilename, lt_dlerror());
228 * Before doing anything else, check if it's sane.
230 if ((*(const uint32_t *) module) != RLM_MODULE_MAGIC_NUMBER) {
232 radlog(L_ERR|L_CONS, "%s[%d] Invalid version in module '%s'",
233 cffilename, cflineno, module_name);
238 /* make room for the module type */
239 node = rad_malloc(sizeof(*node));
240 memset(node, 0, sizeof(*node));
241 strNcpy(node->name, module_name, sizeof(node->name));
242 node->module = module;
243 node->handle = handle;
245 DEBUG("Module: Loaded %s ", node->module->name);
248 * Add the module as "rlm_foo-version" to the configuration
251 if (!rbtree_insert(module_tree, node)) {
252 radlog(L_ERR, "Failed to cache module %s", module_name);
262 * Find a module instance.
264 module_instance_t *find_module_instance(CONF_SECTION *modules,
265 const char *instname)
268 const char *name1, *name2;
269 module_instance_t *node;
270 char module_name[256];
272 if (!modules) return NULL;
275 * Module instances are declared in the modules{} block
276 * and referenced later by their name, which is the
277 * name2 from the config section, or name1 if there was
280 cs = cf_section_sub_find_name2(modules, NULL, instname);
282 radlog(L_ERR|L_CONS, "ERROR: Cannot find a configuration entry for module \"%s\".\n", instname);
287 * If there's already a module instance, return it.
289 node = cf_data_find(cs, "instance");
290 if (node) return node;
292 name1 = cf_section_name1(cs);
293 name2 = cf_section_name2(cs);
296 * Found the configuration entry.
298 node = rad_malloc(sizeof(*node));
299 memset(node, 0, sizeof(*node));
301 node->insthandle = NULL;
304 * Names in the "modules" section aren't prefixed
305 * with "rlm_", so we add it here.
307 snprintf(module_name, sizeof(module_name), "rlm_%s", name1);
309 node->entry = linkto_module(module_name,
310 mainconfig.radiusd_conf,
311 cf_section_lineno(cs));
314 /* linkto_module logs any errors */
319 * Call the module's instantiation routine.
321 if ((node->entry->module->instantiate) &&
322 ((node->entry->module->instantiate)(cs, &node->insthandle) < 0)) {
324 "%s[%d]: %s: Module instantiation failed.\n",
325 mainconfig.radiusd_conf, cf_section_lineno(cs),
332 * We're done. Fill in the rest of the data structure,
333 * and link it to the module instance list.
335 strNcpy(node->name, instname, sizeof(node->name));
337 #ifdef HAVE_PTHREAD_H
339 * If we're threaded, check if the module is thread-safe.
341 * If it isn't, we create a mutex.
343 if ((node->entry->module->type & RLM_TYPE_THREAD_UNSAFE) != 0) {
344 node->mutex = (pthread_mutex_t *) rad_malloc(sizeof(pthread_mutex_t));
346 * Initialize the mutex.
348 pthread_mutex_init(node->mutex, NULL);
351 * The module is thread-safe. Don't give it a mutex.
357 cf_data_add(cs, "instance", node, module_instance_free);
359 DEBUG("Module: Instantiated %s (%s) ", name1, node->name);
364 static indexed_modcallable *lookup_by_index(int comp, int idx)
366 indexed_modcallable myc;
371 return lrad_hash_table_finddata(components, &myc);
375 * Create a new sublist.
377 static indexed_modcallable *new_sublist(int comp, int idx)
379 indexed_modcallable *c;
381 c = lookup_by_index(comp, idx);
383 /* It is an error to try to create a sublist that already
384 * exists. It would almost certainly be caused by accidental
385 * duplication in the config file.
387 * index 0 is the exception, because it is used when we want
388 * to collect _all_ listed modules under a single index by
389 * default, which is currently the case in all components
390 * except authenticate. */
398 c = rad_malloc(sizeof(*c));
399 c->modulelist = NULL;
403 if (!lrad_hash_table_insert(components, c)) {
411 static int indexed_modcall(int comp, int idx, REQUEST *request)
414 indexed_modcallable *this;
416 this = lookup_by_index(comp, idx);
418 if (idx != 0) DEBUG2(" ERROR: Unknown value specified for %s. Cannot perform requested action.",
419 section_type_value[comp].typename);
420 request->component = section_type_value[comp].typename;
421 rcode = modcall(comp, NULL, request); /* does default action */
423 DEBUG2(" Processing the %s section of %s",
424 section_type_value[comp].section,
425 mainconfig.radiusd_conf);
426 request->component = section_type_value[comp].typename;
427 rcode = modcall(comp, this->modulelist, request);
429 request->module = "<server-core>";
430 request->component = "<server-core>";
435 * Load a sub-module list, as found inside an Auth-Type foo {}
438 static int load_subcomponent_section(modcallable *parent,
439 CONF_SECTION *cs, int comp,
440 const char *filename)
442 indexed_modcallable *subcomp;
445 const char *name2 = cf_section_name2(cs);
447 rad_assert(comp >= RLM_COMPONENT_AUTH);
448 rad_assert(comp <= RLM_COMPONENT_COUNT);
455 "%s[%d]: No name specified for %s block",
456 filename, cf_section_lineno(cs),
457 section_type_value[comp].typename);
464 ml = compile_modgroup(parent, comp, cs, filename);
470 * We must assign a numeric index to this subcomponent.
471 * It is generated and placed in the dictionary by
472 * setup_modules(), when it loads the sections. If it
473 * isn't found, it's a serious error.
475 dval = dict_valbyname(section_type_value[comp].attr, name2);
478 "%s[%d] %s %s Not previously configured",
479 filename, cf_section_lineno(cs),
480 section_type_value[comp].typename, name2);
481 modcallable_free(&ml);
485 subcomp = new_sublist(comp, dval->value);
488 "%s[%d] %s %s already configured - skipping",
489 filename, cf_section_lineno(cs),
490 section_type_value[comp].typename, name2);
491 modcallable_free(&ml);
495 subcomp->modulelist = ml;
499 static int load_component_section(modcallable *parent,
500 CONF_SECTION *cs, int comp,
501 const char *filename)
506 indexed_modcallable *subcomp;
508 const char *visiblename;
511 * Loop over the entries in the named section.
513 for (modref = cf_item_find_next(cs, NULL);
515 modref = cf_item_find_next(cs, modref)) {
516 CONF_PAIR *cp = NULL;
517 CONF_SECTION *scs = NULL;
520 * Look for Auth-Type foo {}, which are special
521 * cases of named sections, and allowable ONLY
524 * i.e. They're not allowed in a "group" or "redundant"
527 if (cf_item_is_section(modref)) {
528 const char *sec_name;
529 scs = cf_itemtosection(modref);
531 sec_name = cf_section_name1(scs);
534 section_type_value[comp].typename) == 0) {
535 if (!load_subcomponent_section(parent, scs,
538 return -1; /* FIXME: memleak? */
544 * Allow old names, too.
547 old_section_type_value[comp].typename) == 0) {
548 if (!load_subcomponent_section(parent, scs,
551 return -1; /* FIXME: memleak? */
556 } else if (cf_item_is_pair(modref)) {
557 cp = cf_itemtopair(modref);
559 continue; /* ignore it */
563 * Try to compile one entry.
565 this = compile_modsingle(parent, comp, modref, filename,
569 "%s[%d] Failed to parse %s section.\n",
570 filename, cf_section_lineno(cs),
571 cf_section_name1(cs));
575 if (comp == RLM_COMPONENT_AUTH) {
577 const char *modrefname = NULL;
580 modrefname = cf_pair_attr(cp);
582 modrefname = cf_section_name2(scs);
585 "%s[%d] Failed to parse %s sub-section.\n",
586 filename, cf_section_lineno(scs),
587 cf_section_name1(scs));
592 dval = dict_valbyname(PW_AUTH_TYPE, modrefname);
595 * It's a section, but nothing we
598 radlog(L_ERR|L_CONS, "%s[%d] Unknown Auth-Type \"%s\" in %s sub-section.",
599 filename, cf_section_lineno(scs),
600 modrefname, section_type_value[comp].section);
605 /* See the comment in new_sublist() for explanation
606 * of the special index 0 */
610 subcomp = new_sublist(comp, idx);
611 if (subcomp == NULL) {
612 radlog(L_INFO|L_CONS,
613 "%s %s %s already configured - skipping",
614 filename, section_type_value[comp].typename,
616 modcallable_free(&this);
620 /* If subcomp->modulelist is NULL, add_to_modcallable will
622 visiblename = cf_section_name2(cs);
623 if (visiblename == NULL)
624 visiblename = cf_section_name1(cs);
625 add_to_modcallable(&subcomp->modulelist, this,
634 * Parse the module config sections, and load
635 * and call each module's init() function.
637 * Libtool makes your life a LOT easier, especially with libltdl.
638 * see: http://www.gnu.org/software/libtool/
640 int setup_modules(int reload)
643 CONF_SECTION *cs, *modules;
644 int do_component[RLM_COMPONENT_COUNT];
645 rad_listen_t *listener;
648 * If necessary, initialize libltdl.
652 * Set the default list of preloaded symbols.
653 * This is used to initialize libltdl's list of
656 * i.e. Static modules.
658 LTDL_SET_PRELOADED_SYMBOLS();
660 if (lt_dlinit() != 0) {
661 radlog(L_ERR|L_CONS, "Failed to initialize libraries: %s\n",
667 * Set the search path to ONLY our library directory.
668 * This prevents the modules from being found from
669 * any location on the disk.
671 lt_dlsetsearchpath(radlib_dir);
673 DEBUG2("Module: Library search path is %s",
674 lt_dlgetsearchpath());
677 * Set up the internal module struct.
679 module_tree = rbtree_create(module_entry_cmp,
680 module_entry_free, 0);
682 radlog(L_ERR|L_CONS, "Failed to initialize modules\n");
686 lrad_hash_table_free(components);
689 components = lrad_hash_table_create(indexed_modcallable_hash,
690 indexed_modcallable_cmp,
691 indexed_modcallable_free);
693 radlog(L_ERR|L_CONS, "Failed to initialize components\n");
698 * Figure out which sections to load.
700 memset(do_component, 0, sizeof(do_component));
701 for (listener = mainconfig.listen;
703 listener = listener->next) {
704 switch (listener->type) {
705 case RAD_LISTEN_AUTH:
706 do_component[RLM_COMPONENT_AUTZ] = 1;
707 do_component[RLM_COMPONENT_AUTH] = 1;
708 do_component[RLM_COMPONENT_POST_AUTH] = 1;
709 do_component[RLM_COMPONENT_SESS] = 1;
712 case RAD_LISTEN_DETAIL: /* just like acct */
713 case RAD_LISTEN_ACCT:
714 do_component[RLM_COMPONENT_PREACCT] = 1;
715 do_component[RLM_COMPONENT_ACCT] = 1;
718 case RAD_LISTEN_PROXY:
719 do_component[RLM_COMPONENT_PRE_PROXY] = 1;
720 do_component[RLM_COMPONENT_POST_PROXY] = 1;
729 for (comp = RLM_COMPONENT_AUTH; comp < RLM_COMPONENT_COUNT; comp++) {
731 * Have the debugging messages all in one place.
733 if (!do_component[comp]) {
734 DEBUG2("modules: Not loading %s{} section",
735 section_type_value[comp].section);
740 * Create any DICT_VALUE's for the types. See
741 * 'doc/configurable_failover' for examples of 'authtype'
742 * used to create new Auth-Type values. In order to
743 * let the user create new names, we've got to look for
744 * those names, and create DICT_VALUE's for them.
746 for (comp = RLM_COMPONENT_AUTH; comp < RLM_COMPONENT_COUNT; comp++) {
751 CONF_SECTION *sub, *next;
755 * Not needed, don't load it.
757 if (!do_component[comp]) {
760 cs = cf_section_find(section_type_value[comp].section);
767 * See if there's a sub-section by that
770 next = cf_subsection_find_next(cs, sub,
771 section_type_value[comp].typename);
774 * Allow some old names, too.
776 if (!next && (comp <= 4)) {
777 next = cf_subsection_find_next(cs, sub,
778 old_section_type_value[comp].typename);
783 * If so, look for it to define a new
786 name2 = cf_section_name2(sub);
787 if (!name2) continue;
791 * If the value already exists, don't
794 dval = dict_valbyname(section_type_value[comp].attr,
799 * Find the attribute for the value.
801 dattr = dict_attrbyvalue(section_type_value[comp].attr);
803 radlog(L_ERR, "%s[%d]: No such attribute %s",
804 mainconfig.radiusd_conf,
805 cf_section_lineno(sub),
806 section_type_value[comp].typename);
811 * Create a new unique value with a
812 * meaningless number. You can't look at
813 * it from outside of this code, so it
814 * doesn't matter. The only requirement
815 * is that it's unique.
818 value = lrad_rand() & 0x00ffffff;
819 } while (dict_valbyattr(dattr->attr, value));
821 if (dict_addvalue(name2, dattr->name, value) < 0) {
822 radlog(L_ERR, "%s", librad_errstr);
825 } while (sub != NULL);
828 * Loop over the non-sub-sections, too.
833 * See if there's a conf-pair by that
836 cp = cf_pair_find_next(cs, cp, NULL);
841 * If the value already exists, don't
844 name2 = cf_pair_attr(cp);
845 dval = dict_valbyname(section_type_value[comp].attr,
850 * Find the attribute for the value.
852 dattr = dict_attrbyvalue(section_type_value[comp].attr);
854 radlog(L_ERR, "%s[%d]: No such attribute %s",
855 mainconfig.radiusd_conf,
856 cf_section_lineno(sub),
857 section_type_value[comp].typename);
862 * Finally, create the new attribute.
865 value = lrad_rand() & 0x00ffffff;
866 } while (dict_valbyattr(dattr->attr, value));
867 if (dict_addvalue(name2, dattr->name, value) < 0) {
868 radlog(L_ERR, "%s", librad_errstr);
871 } while (cp != NULL);
872 } /* over the sections which can have redundent sub-sections */
875 * Remember where the modules were stored.
877 modules = cf_section_find("modules");
879 radlog(L_ERR, "Cannot find a \"modules\" section in the configuration file!");
884 * Look for the 'instantiate' section, which tells us
885 * the instantiation order of the modules, and also allows
886 * us to load modules with no authorize/authenticate/etc.
889 cs = cf_section_find("instantiate");
893 module_instance_t *module;
897 * Loop over the items in the 'instantiate' section.
899 for (ci=cf_item_find_next(cs, NULL);
901 ci=cf_item_find_next(cs, ci)) {
904 * Skip sections. They'll be handled
905 * later, if they're referenced at all...
907 if (cf_item_is_section(ci)) {
911 cp = cf_itemtopair(ci);
912 name = cf_pair_attr(cp);
913 module = find_module_instance(modules, name);
917 } /* loop over items in the subsection */
918 } /* if there's an 'instantiate' section. */
921 * Loop over all of the known components, finding their
922 * configuration section, and loading it.
924 for (comp = 0; comp < RLM_COMPONENT_COUNT; ++comp) {
925 cs = cf_section_find(section_type_value[comp].section);
929 if (!do_component[comp]) {
933 if (load_component_section(NULL, cs, comp, mainconfig.radiusd_conf) < 0) {
942 * Call all authorization modules until one returns
943 * somethings else than RLM_MODULE_OK
945 int module_authorize(int autz_type, REQUEST *request)
948 * Older versions of the server would pass proxy requests
949 * through the 'authorize' sections twice; once when the
950 * packet was received from the NAS, and again after the
951 * reply was received from the home server. Now that we
952 * have a 'post_proxy' section, the replies from the home
953 * server should be sent through that, instead of through
954 * the 'authorize' section again.
956 if (request->proxy != NULL) {
957 DEBUG2(" authorize: Skipping authorize in post-proxy stage");
958 return RLM_MODULE_NOOP;
961 return indexed_modcall(RLM_COMPONENT_AUTZ, autz_type, request);
965 * Authenticate a user/password with various methods.
967 int module_authenticate(int auth_type, REQUEST *request)
969 return indexed_modcall(RLM_COMPONENT_AUTH, auth_type, request);
973 * Do pre-accounting for ALL configured sessions
975 int module_preacct(REQUEST *request)
977 return indexed_modcall(RLM_COMPONENT_PREACCT, 0, request);
981 * Do accounting for ALL configured sessions
983 int module_accounting(int acct_type, REQUEST *request)
985 return indexed_modcall(RLM_COMPONENT_ACCT, acct_type, request);
989 * See if a user is already logged in.
991 * Returns: 0 == OK, 1 == double logins, 2 == multilink attempt
993 int module_checksimul(int sess_type, REQUEST *request, int maxsimul)
997 if(!request->username)
1000 request->simul_count = 0;
1001 request->simul_max = maxsimul;
1002 request->simul_mpp = 1;
1004 rcode = indexed_modcall(RLM_COMPONENT_SESS, sess_type, request);
1006 if (rcode != RLM_MODULE_OK) {
1007 /* FIXME: Good spot for a *rate-limited* warning to the log */
1011 return (request->simul_count < maxsimul) ? 0 : request->simul_mpp;
1015 * Do pre-proxying for ALL configured sessions
1017 int module_pre_proxy(int type, REQUEST *request)
1019 return indexed_modcall(RLM_COMPONENT_PRE_PROXY, type, request);
1023 * Do post-proxying for ALL configured sessions
1025 int module_post_proxy(int type, REQUEST *request)
1027 return indexed_modcall(RLM_COMPONENT_POST_PROXY, type, request);
1031 * Do post-authentication for ALL configured sessions
1033 int module_post_auth(int postauth_type, REQUEST *request)
1035 return indexed_modcall(RLM_COMPONENT_POST_AUTH, postauth_type, request);