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 The FreeRADIUS server project
21 * Copyright 2000 Alan DeKok <aland@ox.org>
22 * Copyright 2000 Alan Curry <pacman@world.std.com>
25 static const char rcsid[] = "$Id$";
27 #include <freeradius-devel/autoconf.h>
33 #include <freeradius-devel/radiusd.h>
34 #include <freeradius-devel/modpriv.h>
35 #include <freeradius-devel/modcall.h>
36 #include <freeradius-devel/rad_assert.h>
38 typedef struct indexed_modcallable {
41 modcallable *modulelist;
42 } indexed_modcallable;
45 * For each component, keep an ordered list of ones to call.
47 static lrad_hash_table_t *components;
49 static rbtree_t *module_tree = NULL;
51 typedef struct section_type_value_t {
55 } section_type_value_t;
59 * Ordered by component
61 static const section_type_value_t section_type_value[RLM_COMPONENT_COUNT] = {
62 { "authenticate", "Auth-Type", PW_AUTH_TYPE },
63 { "authorize", "Autz-Type", PW_AUTZ_TYPE },
64 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },
65 { "accounting", "Acct-Type", PW_ACCT_TYPE },
66 { "session", "Session-Type", PW_SESSION_TYPE },
67 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE },
68 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE },
69 { "post-auth", "Post-Auth-Type", PW_POST_AUTH_TYPE },
75 static const section_type_value_t old_section_type_value[] = {
76 { "authenticate", "authtype", PW_AUTH_TYPE },
77 { "authorize", "autztype", PW_AUTZ_TYPE },
78 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },/* unused */
79 { "accounting", "acctype", PW_ACCT_TYPE },
80 { "session", "sesstype", PW_SESSION_TYPE },
81 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE }, /* unused */
82 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE }, /* unused */
83 { "post-auth", "post-authtype", PW_POST_AUTH_TYPE }
87 static void indexed_modcallable_free(void *data)
89 indexed_modcallable *c = data;
91 modcallable_free(&c->modulelist);
95 static uint32_t indexed_modcallable_hash(const void *data)
98 const indexed_modcallable *c = data;
100 hash = lrad_hash(&c->comp, sizeof(c->comp));
101 return lrad_hash_update(&c->idx, sizeof(c->idx), hash);
104 static int indexed_modcallable_cmp(const void *one, const void *two)
106 const indexed_modcallable *a = one;
107 const indexed_modcallable *b = two;
109 if (a->comp < b->comp) return -1;
110 if (a->comp > b->comp) return +1;
112 return a->idx - b->idx;
117 * Free a module instance.
119 static void module_instance_free(void *data)
121 module_instance_t *this = data;
123 if (this->entry->module->detach)
124 (this->entry->module->detach)(this->insthandle);
125 #ifdef HAVE_PTHREAD_H
129 * The mutex MIGHT be locked...
130 * we'll check for that later, I guess.
132 pthread_mutex_destroy(this->mutex);
141 * Compare two module entries
143 static int module_entry_cmp(const void *one, const void *two)
145 const module_entry_t *a = one;
146 const module_entry_t *b = two;
148 return strcmp(a->name, b->name);
152 * Free a module entry.
154 static void module_entry_free(void *data)
156 module_entry_t *this = data;
158 lt_dlclose(this->handle); /* ignore any errors */
164 * Remove the module lists.
166 int detach_modules(void)
168 lrad_hash_table_free(components);
175 * Find a module on disk or in memory, and link to it.
177 static module_entry_t *linkto_module(const char *module_name,
178 const char *cffilename, int cflineno)
180 module_entry_t myentry;
181 module_entry_t *node;
183 char module_struct[256];
187 strNcpy(myentry.name, module_name, sizeof(myentry.name));
188 node = rbtree_finddata(module_tree, &myentry);
189 if (node) return node;
192 * Keep the handle around so we can dlclose() it.
194 handle = lt_dlopenext(module_name);
195 if (handle == NULL) {
196 radlog(L_ERR|L_CONS, "%s[%d] Failed to link to module '%s':"
197 " %s\n", cffilename, cflineno, module_name, lt_dlerror());
202 * Link to the module's rlm_FOO{} module structure.
204 * The module_name variable has the version number
205 * embedded in it, and we don't want that here.
207 strcpy(module_struct, module_name);
208 p = strrchr(module_struct, '-');
211 DEBUG3(" (Loaded %s, checking if it's valid)", module_name);
214 * libltld MAY core here, if the handle it gives us contains
217 module = lt_dlsym(handle, module_struct);
219 radlog(L_ERR|L_CONS, "%s[%d] Failed linking to "
220 "%s structure in %s: %s\n",
221 cffilename, cflineno,
222 module_name, cffilename, lt_dlerror());
227 * Before doing anything else, check if it's sane.
229 if ((*(const uint32_t *) module) != RLM_MODULE_MAGIC_NUMBER) {
231 radlog(L_ERR|L_CONS, "%s[%d] Invalid version in module '%s'",
232 cffilename, cflineno, module_name);
237 /* make room for the module type */
238 node = rad_malloc(sizeof(*node));
239 memset(node, 0, sizeof(*node));
240 strNcpy(node->name, module_name, sizeof(node->name));
241 node->module = module;
242 node->handle = handle;
244 DEBUG("Module: Loaded %s ", node->module->name);
247 * Add the module as "rlm_foo-version" to the configuration
250 if (!rbtree_insert(module_tree, node)) {
251 radlog(L_ERR, "Failed to cache module %s", module_name);
261 * Find a module instance.
263 module_instance_t *find_module_instance(CONF_SECTION *modules,
264 const char *instname)
267 const char *name1, *name2;
268 module_instance_t *node;
269 char module_name[256];
271 if (!modules) return NULL;
274 * Module instances are declared in the modules{} block
275 * and referenced later by their name, which is the
276 * name2 from the config section, or name1 if there was
279 cs = cf_section_sub_find_name2(modules, NULL, instname);
281 radlog(L_ERR|L_CONS, "ERROR: Cannot find a configuration entry for module \"%s\".\n", instname);
286 * If there's already a module instance, return it.
288 node = cf_data_find(cs, "instance");
289 if (node) return node;
291 name1 = cf_section_name1(cs);
292 name2 = cf_section_name2(cs);
295 * Found the configuration entry.
297 node = rad_malloc(sizeof(*node));
298 memset(node, 0, sizeof(*node));
300 node->insthandle = NULL;
303 * Names in the "modules" section aren't prefixed
304 * with "rlm_", so we add it here.
306 snprintf(module_name, sizeof(module_name), "rlm_%s", name1);
308 node->entry = linkto_module(module_name,
309 mainconfig.radiusd_conf,
310 cf_section_lineno(cs));
313 /* linkto_module logs any errors */
318 * Call the module's instantiation routine.
320 if ((node->entry->module->instantiate) &&
321 ((node->entry->module->instantiate)(cs, &node->insthandle) < 0)) {
323 "%s[%d]: %s: Module instantiation failed.\n",
324 mainconfig.radiusd_conf, cf_section_lineno(cs),
331 * We're done. Fill in the rest of the data structure,
332 * and link it to the module instance list.
334 strNcpy(node->name, instname, sizeof(node->name));
336 #ifdef HAVE_PTHREAD_H
338 * If we're threaded, check if the module is thread-safe.
340 * If it isn't, we create a mutex.
342 if ((node->entry->module->type & RLM_TYPE_THREAD_UNSAFE) != 0) {
343 node->mutex = (pthread_mutex_t *) rad_malloc(sizeof(pthread_mutex_t));
345 * Initialize the mutex.
347 pthread_mutex_init(node->mutex, NULL);
350 * The module is thread-safe. Don't give it a mutex.
356 cf_data_add(cs, "instance", node, module_instance_free);
358 DEBUG("Module: Instantiated %s (%s) ", name1, node->name);
363 static indexed_modcallable *lookup_by_index(int comp, int idx)
365 indexed_modcallable myc;
370 return lrad_hash_table_finddata(components, &myc);
374 * Create a new sublist.
376 static indexed_modcallable *new_sublist(int comp, int idx)
378 indexed_modcallable *c;
380 c = lookup_by_index(comp, idx);
382 /* It is an error to try to create a sublist that already
383 * exists. It would almost certainly be caused by accidental
384 * duplication in the config file.
386 * index 0 is the exception, because it is used when we want
387 * to collect _all_ listed modules under a single index by
388 * default, which is currently the case in all components
389 * except authenticate. */
397 c = rad_malloc(sizeof(*c));
398 c->modulelist = NULL;
402 if (!lrad_hash_table_insert(components, c)) {
410 static int indexed_modcall(int comp, int idx, REQUEST *request)
413 indexed_modcallable *this;
415 this = lookup_by_index(comp, idx);
417 if (idx != 0) DEBUG2(" ERROR: Unknown value specified for %s. Cannot perform requested action.",
418 section_type_value[comp].typename);
419 request->component = section_type_value[comp].typename;
420 rcode = modcall(comp, NULL, request); /* does default action */
422 DEBUG2(" Processing the %s section of %s",
423 section_type_value[comp].section,
424 mainconfig.radiusd_conf);
425 request->component = section_type_value[comp].typename;
426 rcode = modcall(comp, this->modulelist, request);
428 request->module = "<server-core>";
429 request->component = "<server-core>";
434 * Load a sub-module list, as found inside an Auth-Type foo {}
437 static int load_subcomponent_section(modcallable *parent,
438 CONF_SECTION *cs, int comp,
439 const char *filename)
441 indexed_modcallable *subcomp;
444 const char *name2 = cf_section_name2(cs);
446 rad_assert(comp >= RLM_COMPONENT_AUTH);
447 rad_assert(comp <= RLM_COMPONENT_COUNT);
454 "%s[%d]: No name specified for %s block",
455 filename, cf_section_lineno(cs),
456 section_type_value[comp].typename);
463 ml = compile_modgroup(parent, comp, cs, filename);
469 * We must assign a numeric index to this subcomponent.
470 * It is generated and placed in the dictionary by
471 * setup_modules(), when it loads the sections. If it
472 * isn't found, it's a serious error.
474 dval = dict_valbyname(section_type_value[comp].attr, name2);
477 "%s[%d] %s %s Not previously configured",
478 filename, cf_section_lineno(cs),
479 section_type_value[comp].typename, name2);
480 modcallable_free(&ml);
484 subcomp = new_sublist(comp, dval->value);
487 "%s[%d] %s %s already configured - skipping",
488 filename, cf_section_lineno(cs),
489 section_type_value[comp].typename, name2);
490 modcallable_free(&ml);
494 subcomp->modulelist = ml;
498 static int load_component_section(modcallable *parent,
499 CONF_SECTION *cs, int comp,
500 const char *filename)
505 indexed_modcallable *subcomp;
507 const char *visiblename;
510 * Loop over the entries in the named section.
512 for (modref = cf_item_find_next(cs, NULL);
514 modref = cf_item_find_next(cs, modref)) {
515 CONF_PAIR *cp = NULL;
516 CONF_SECTION *scs = NULL;
519 * Look for Auth-Type foo {}, which are special
520 * cases of named sections, and allowable ONLY
523 * i.e. They're not allowed in a "group" or "redundant"
526 if (cf_item_is_section(modref)) {
527 const char *sec_name;
528 scs = cf_itemtosection(modref);
530 sec_name = cf_section_name1(scs);
533 section_type_value[comp].typename) == 0) {
534 if (!load_subcomponent_section(parent, scs,
537 return -1; /* FIXME: memleak? */
543 * Allow old names, too.
546 old_section_type_value[comp].typename) == 0) {
547 if (!load_subcomponent_section(parent, scs,
550 return -1; /* FIXME: memleak? */
555 } else if (cf_item_is_pair(modref)) {
556 cp = cf_itemtopair(modref);
558 continue; /* ignore it */
562 * Try to compile one entry.
564 this = compile_modsingle(parent, comp, modref, filename,
568 "%s[%d] Failed to parse %s section.\n",
569 filename, cf_section_lineno(cs),
570 cf_section_name1(cs));
574 if (comp == RLM_COMPONENT_AUTH) {
576 const char *modrefname = NULL;
579 modrefname = cf_pair_attr(cp);
581 modrefname = cf_section_name2(scs);
584 "%s[%d] Failed to parse %s sub-section.\n",
585 filename, cf_section_lineno(scs),
586 cf_section_name1(scs));
591 dval = dict_valbyname(PW_AUTH_TYPE, modrefname);
594 * It's a section, but nothing we
597 radlog(L_ERR|L_CONS, "%s[%d] Unknown Auth-Type \"%s\" in %s sub-section.",
598 filename, cf_section_lineno(scs),
599 modrefname, section_type_value[comp].section);
604 /* See the comment in new_sublist() for explanation
605 * of the special index 0 */
609 subcomp = new_sublist(comp, idx);
610 if (subcomp == NULL) {
611 radlog(L_INFO|L_CONS,
612 "%s %s %s already configured - skipping",
613 filename, section_type_value[comp].typename,
615 modcallable_free(&this);
619 /* If subcomp->modulelist is NULL, add_to_modcallable will
621 visiblename = cf_section_name2(cs);
622 if (visiblename == NULL)
623 visiblename = cf_section_name1(cs);
624 add_to_modcallable(&subcomp->modulelist, this,
633 * Parse the module config sections, and load
634 * and call each module's init() function.
636 * Libtool makes your life a LOT easier, especially with libltdl.
637 * see: http://www.gnu.org/software/libtool/
639 int setup_modules(int reload)
642 CONF_SECTION *cs, *modules;
643 int do_component[RLM_COMPONENT_COUNT];
644 rad_listen_t *listener;
647 * If necessary, initialize libltdl.
651 * Set the default list of preloaded symbols.
652 * This is used to initialize libltdl's list of
655 * i.e. Static modules.
657 LTDL_SET_PRELOADED_SYMBOLS();
659 if (lt_dlinit() != 0) {
660 radlog(L_ERR|L_CONS, "Failed to initialize libraries: %s\n",
666 * Set the search path to ONLY our library directory.
667 * This prevents the modules from being found from
668 * any location on the disk.
670 lt_dlsetsearchpath(radlib_dir);
672 DEBUG2("Module: Library search path is %s",
673 lt_dlgetsearchpath());
676 * Set up the internal module struct.
678 module_tree = rbtree_create(module_entry_cmp,
679 module_entry_free, 0);
681 radlog(L_ERR|L_CONS, "Failed to initialize modules\n");
685 lrad_hash_table_free(components);
688 components = lrad_hash_table_create(indexed_modcallable_hash,
689 indexed_modcallable_cmp,
690 indexed_modcallable_free);
692 radlog(L_ERR|L_CONS, "Failed to initialize components\n");
697 * Figure out which sections to load.
699 memset(do_component, 0, sizeof(do_component));
700 for (listener = mainconfig.listen;
702 listener = listener->next) {
703 switch (listener->type) {
704 case RAD_LISTEN_AUTH:
705 do_component[RLM_COMPONENT_AUTZ] = 1;
706 do_component[RLM_COMPONENT_AUTH] = 1;
707 do_component[RLM_COMPONENT_POST_AUTH] = 1;
708 do_component[RLM_COMPONENT_SESS] = 1;
711 case RAD_LISTEN_DETAIL: /* just like acct */
712 case RAD_LISTEN_ACCT:
713 do_component[RLM_COMPONENT_PREACCT] = 1;
714 do_component[RLM_COMPONENT_ACCT] = 1;
717 case RAD_LISTEN_PROXY:
718 do_component[RLM_COMPONENT_PRE_PROXY] = 1;
719 do_component[RLM_COMPONENT_POST_PROXY] = 1;
728 for (comp = RLM_COMPONENT_AUTH; comp < RLM_COMPONENT_COUNT; comp++) {
730 * Have the debugging messages all in one place.
732 if (!do_component[comp]) {
733 DEBUG2("modules: Not loading %s{} section",
734 section_type_value[comp].section);
739 * Create any DICT_VALUE's for the types. See
740 * 'doc/configurable_failover' for examples of 'authtype'
741 * used to create new Auth-Type values. In order to
742 * let the user create new names, we've got to look for
743 * those names, and create DICT_VALUE's for them.
745 for (comp = RLM_COMPONENT_AUTH; comp < RLM_COMPONENT_COUNT; comp++) {
750 CONF_SECTION *sub, *next;
754 * Not needed, don't load it.
756 if (!do_component[comp]) {
759 cs = cf_section_find(section_type_value[comp].section);
766 * See if there's a sub-section by that
769 next = cf_subsection_find_next(cs, sub,
770 section_type_value[comp].typename);
773 * Allow some old names, too.
775 if (!next && (comp <= 4)) {
776 next = cf_subsection_find_next(cs, sub,
777 old_section_type_value[comp].typename);
782 * If so, look for it to define a new
785 name2 = cf_section_name2(sub);
786 if (!name2) continue;
790 * If the value already exists, don't
793 dval = dict_valbyname(section_type_value[comp].attr,
798 * Find the attribute for the value.
800 dattr = dict_attrbyvalue(section_type_value[comp].attr);
802 radlog(L_ERR, "%s[%d]: No such attribute %s",
803 mainconfig.radiusd_conf,
804 cf_section_lineno(sub),
805 section_type_value[comp].typename);
810 * Create a new unique value with a
811 * meaningless number. You can't look at
812 * it from outside of this code, so it
813 * doesn't matter. The only requirement
814 * is that it's unique.
817 value = lrad_rand() & 0x00ffffff;
818 } while (dict_valbyattr(dattr->attr, value));
820 if (dict_addvalue(name2, dattr->name, value) < 0) {
821 radlog(L_ERR, "%s", librad_errstr);
824 } while (sub != NULL);
827 * Loop over the non-sub-sections, too.
832 * See if there's a conf-pair by that
835 cp = cf_pair_find_next(cs, cp, NULL);
840 * If the value already exists, don't
843 name2 = cf_pair_attr(cp);
844 dval = dict_valbyname(section_type_value[comp].attr,
849 * Find the attribute for the value.
851 dattr = dict_attrbyvalue(section_type_value[comp].attr);
853 radlog(L_ERR, "%s[%d]: No such attribute %s",
854 mainconfig.radiusd_conf,
855 cf_section_lineno(sub),
856 section_type_value[comp].typename);
861 * Finally, create the new attribute.
864 value = lrad_rand() & 0x00ffffff;
865 } while (dict_valbyattr(dattr->attr, value));
866 if (dict_addvalue(name2, dattr->name, value) < 0) {
867 radlog(L_ERR, "%s", librad_errstr);
870 } while (cp != NULL);
871 } /* over the sections which can have redundent sub-sections */
874 * Remember where the modules were stored.
876 modules = cf_section_find("modules");
878 radlog(L_ERR, "Cannot find a \"modules\" section in the configuration file!");
883 * Look for the 'instantiate' section, which tells us
884 * the instantiation order of the modules, and also allows
885 * us to load modules with no authorize/authenticate/etc.
888 cs = cf_section_find("instantiate");
892 module_instance_t *module;
896 * Loop over the items in the 'instantiate' section.
898 for (ci=cf_item_find_next(cs, NULL);
900 ci=cf_item_find_next(cs, ci)) {
903 * Skip sections. They'll be handled
904 * later, if they're referenced at all...
906 if (cf_item_is_section(ci)) {
910 cp = cf_itemtopair(ci);
911 name = cf_pair_attr(cp);
912 module = find_module_instance(modules, name);
916 } /* loop over items in the subsection */
917 } /* if there's an 'instantiate' section. */
920 * Loop over all of the known components, finding their
921 * configuration section, and loading it.
923 for (comp = 0; comp < RLM_COMPONENT_COUNT; ++comp) {
924 cs = cf_section_find(section_type_value[comp].section);
928 if (!do_component[comp]) {
932 if (load_component_section(NULL, cs, comp, mainconfig.radiusd_conf) < 0) {
941 * Call all authorization modules until one returns
942 * somethings else than RLM_MODULE_OK
944 int module_authorize(int autz_type, REQUEST *request)
947 * Older versions of the server would pass proxy requests
948 * through the 'authorize' sections twice; once when the
949 * packet was received from the NAS, and again after the
950 * reply was received from the home server. Now that we
951 * have a 'post_proxy' section, the replies from the home
952 * server should be sent through that, instead of through
953 * the 'authorize' section again.
955 if (request->proxy != NULL) {
956 DEBUG2(" authorize: Skipping authorize in post-proxy stage");
957 return RLM_MODULE_NOOP;
960 return indexed_modcall(RLM_COMPONENT_AUTZ, autz_type, request);
964 * Authenticate a user/password with various methods.
966 int module_authenticate(int auth_type, REQUEST *request)
968 return indexed_modcall(RLM_COMPONENT_AUTH, auth_type, request);
972 * Do pre-accounting for ALL configured sessions
974 int module_preacct(REQUEST *request)
976 return indexed_modcall(RLM_COMPONENT_PREACCT, 0, request);
980 * Do accounting for ALL configured sessions
982 int module_accounting(int acct_type, REQUEST *request)
984 return indexed_modcall(RLM_COMPONENT_ACCT, acct_type, request);
988 * See if a user is already logged in.
990 * Returns: 0 == OK, 1 == double logins, 2 == multilink attempt
992 int module_checksimul(int sess_type, REQUEST *request, int maxsimul)
996 if(!request->username)
999 request->simul_count = 0;
1000 request->simul_max = maxsimul;
1001 request->simul_mpp = 1;
1003 rcode = indexed_modcall(RLM_COMPONENT_SESS, sess_type, request);
1005 if (rcode != RLM_MODULE_OK) {
1006 /* FIXME: Good spot for a *rate-limited* warning to the log */
1010 return (request->simul_count < maxsimul) ? 0 : request->simul_mpp;
1014 * Do pre-proxying for ALL configured sessions
1016 int module_pre_proxy(int type, REQUEST *request)
1018 return indexed_modcall(RLM_COMPONENT_PRE_PROXY, type, request);
1022 * Do post-proxying for ALL configured sessions
1024 int module_post_proxy(int type, REQUEST *request)
1026 return indexed_modcall(RLM_COMPONENT_POST_PROXY, type, request);
1030 * Do post-authentication for ALL configured sessions
1032 int module_post_auth(int postauth_type, REQUEST *request)
1034 return indexed_modcall(RLM_COMPONENT_POST_AUTH, postauth_type, request);