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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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$";
28 #include "libradius.h"
40 #include "rad_assert.h"
43 * Internal list of all of the modules we have loaded.
45 static module_list_t *module_list = NULL;
48 * Internal list of each module instance.
50 static module_instance_t *module_instance_list = NULL;
52 typedef struct indexed_modcallable {
53 struct indexed_modcallable *next;
55 modcallable *modulelist;
56 } indexed_modcallable;
59 * For each component, keep an ordered list of ones to call.
61 static indexed_modcallable *components[RLM_COMPONENT_COUNT];
64 * The component names.
66 * Hmm... we probably should be getting these from the configuration
69 const char *component_names[RLM_COMPONENT_COUNT] =
84 static const char *old_subcomponent_names[RLM_COMPONENT_COUNT] =
96 static const char *subcomponent_names[RLM_COMPONENT_COUNT] =
108 static void indexed_modcallable_free(indexed_modcallable **cf)
110 indexed_modcallable *c, *next;
115 modcallable_free(&c->modulelist);
122 static void instance_list_free(module_instance_t **i)
124 module_instance_t *c, *next;
129 if(c->entry->module->detach)
130 (c->entry->module->detach)(c->insthandle);
131 #ifdef HAVE_PTHREAD_H
135 * The mutex MIGHT be locked...
136 * we'll check for that later, I guess.
138 pthread_mutex_destroy(c->mutex);
149 * Remove all of the modules.
151 int detach_modules(void)
153 module_list_t *ml, *next;
157 * Delete the internal component pointers.
159 for (i = 0; i < RLM_COMPONENT_COUNT; i++) {
160 indexed_modcallable_free(&components[i]);
163 instance_list_free(&module_instance_list);
168 if (ml->module->destroy)
169 (ml->module->destroy)();
170 lt_dlclose(ml->handle); /* ignore any errors */
181 * Find a module on disk or in memory, and link to it.
183 static module_list_t *linkto_module(const char *module_name,
184 const char *cffilename, int cflineno)
188 char module_struct[256];
192 * Look through the global module library list for the
195 for (node = module_list; node != NULL; node = node->next) {
197 * Found the named module. Return it.
199 if (strcmp(node->name, module_name) == 0)
205 * Keep the handle around so we can dlclose() it.
207 handle = lt_dlopenext(module_name);
208 if (handle == NULL) {
209 radlog(L_ERR|L_CONS, "%s[%d] Failed to link to module '%s':"
210 " %s\n", cffilename, cflineno, module_name, lt_dlerror());
214 /* make room for the module type */
215 node = (module_list_t *) rad_malloc(sizeof(module_list_t));
217 /* fill in the module structure */
219 node->handle = handle;
220 strNcpy(node->name, module_name, sizeof(node->name));
223 * Link to the module's rlm_FOO{} module structure.
225 /* module_name has the version embedded; strip it. */
226 strcpy(module_struct, module_name);
227 p = strrchr(module_struct, '-');
230 node->module = (module_t *) lt_dlsym(node->handle, module_struct);
232 radlog(L_ERR|L_CONS, "%s[%d] Failed linking to "
233 "%s structure in %s: %s\n",
234 cffilename, cflineno,
235 module_name, cffilename, lt_dlerror());
236 lt_dlclose(node->handle); /* ignore any errors */
241 /* call the modules initialization */
242 if (node->module->init && (node->module->init)() < 0) {
243 radlog(L_ERR|L_CONS, "%s[%d] Module initialization failed.\n",
244 cffilename, cflineno);
245 lt_dlclose(node->handle); /* ignore any errors */
250 DEBUG("Module: Loaded %s ", node->module->name);
252 node->next = module_list;
259 * Find a module instance.
261 module_instance_t *find_module_instance(const char *instname)
263 CONF_SECTION *cs, *inst_cs;
264 const char *name1, *name2;
265 module_instance_t *node, **last;
266 char module_name[256];
269 * Look through the global module instance list for the
272 last = &module_instance_list;
273 for (node = module_instance_list; node != NULL; node = node->next) {
275 * Found the named instance. Return it.
277 if (strcmp(node->name, instname) == 0)
281 * Keep a pointer to the last entry to update...
287 * Instance doesn't exist yet. Try to find the
288 * corresponding configuration section and create it.
292 * Look for the 'modules' configuration section.
294 cs = cf_section_find("modules");
296 radlog(L_ERR|L_CONS, "ERROR: Cannot find a 'modules' section in the configuration file.\n");
301 * Module instances are declared in the modules{} block
302 * and referenced later by their name, which is the
303 * name2 from the config section, or name1 if there was
306 name1 = name2 = NULL;
307 for(inst_cs=cf_subsection_find_next(cs, NULL, NULL);
309 inst_cs=cf_subsection_find_next(cs, inst_cs, NULL)) {
310 name1 = cf_section_name1(inst_cs);
311 name2 = cf_section_name2(inst_cs);
312 if ( (name2 && !strcmp(name2, instname)) ||
313 (!name2 && !strcmp(name1, instname)) )
316 if (inst_cs == NULL) {
317 radlog(L_ERR|L_CONS, "ERROR: Cannot find a configuration entry for module \"%s\".\n", instname);
322 * Found the configuration entry.
324 node = rad_malloc(sizeof(*node));
326 node->insthandle = NULL;
329 * Link to the module by name: rlm_FOO-major.minor
331 if (strncmp(name1, "rlm_", 4)) {
333 snprintf(module_name, sizeof(module_name), "rlm_%s-%d.%d",
334 name1, RADIUSD_MAJOR_VERSION, RADIUSD_MINOR_VERSION);
336 snprintf(module_name, sizeof(module_name), "rlm_%s",
340 strNcpy(module_name, name1, sizeof(module_name));
345 * FIXME: "radiusd.conf" is wrong here; must find cf filename
347 node->entry = linkto_module(module_name, "radiusd.conf",
348 cf_section_lineno(inst_cs));
351 /* linkto_module logs any errors */
356 * Call the module's instantiation routine.
358 if ((node->entry->module->instantiate) &&
359 ((node->entry->module->instantiate)(inst_cs,
360 &node->insthandle) < 0)) {
362 "radiusd.conf[%d]: %s: Module instantiation failed.\n",
363 cf_section_lineno(inst_cs), instname);
369 * We're done. Fill in the rest of the data structure,
370 * and link it to the module instance list.
372 strNcpy(node->name, instname, sizeof(node->name));
374 #ifdef HAVE_PTHREAD_H
376 * If we're threaded, check if the module is thread-safe.
378 * If it isn't, we create a mutex.
380 if ((node->entry->module->type & RLM_TYPE_THREAD_UNSAFE) != 0) {
381 node->mutex = (pthread_mutex_t *) rad_malloc(sizeof(pthread_mutex_t));
383 * Initialize the mutex.
385 pthread_mutex_init(node->mutex, NULL);
388 * The module is thread-safe. Don't give it a mutex.
396 DEBUG("Module: Instantiated %s (%s) ", name1, node->name);
401 static indexed_modcallable *lookup_by_index(indexed_modcallable *head, int idx)
403 indexed_modcallable *p;
405 for (p = head; p != NULL; p = p->next) {
412 static indexed_modcallable *new_sublist(int comp, int idx)
414 indexed_modcallable **head = &components[comp];
415 indexed_modcallable *node = *head;
416 indexed_modcallable **last = head;
419 /* It is an error to try to create a sublist that already
420 * exists. It would almost certainly be caused by accidental
421 * duplication in the config file.
423 * index 0 is the exception, because it is used when we want
424 * to collect _all_ listed modules under a single index by
425 * default, which is currently the case in all components
426 * except authenticate. */
427 if (node->idx == idx) {
437 node = rad_malloc(sizeof *node);
439 node->modulelist = NULL;
445 static int indexed_modcall(int comp, int idx, REQUEST *request)
447 indexed_modcallable *this;
449 this = lookup_by_index(components[comp], idx);
451 if (idx != 0) DEBUG2(" ERROR: Unknown value specified for %s. Cannot perform requested action.",
452 subcomponent_names[comp]);
453 /* Return a default value appropriate for the component */
455 case RLM_COMPONENT_AUTZ: return RLM_MODULE_NOTFOUND;
456 case RLM_COMPONENT_AUTH: return RLM_MODULE_REJECT;
457 case RLM_COMPONENT_PREACCT: return RLM_MODULE_NOOP;
458 case RLM_COMPONENT_ACCT: return RLM_MODULE_NOOP;
459 case RLM_COMPONENT_SESS: return RLM_MODULE_FAIL;
460 case RLM_COMPONENT_PRE_PROXY: return RLM_MODULE_NOOP;
461 case RLM_COMPONENT_POST_PROXY: return RLM_MODULE_NOOP;
462 case RLM_COMPONENT_POST_AUTH: return RLM_MODULE_NOOP;
463 default: return RLM_MODULE_FAIL;
467 DEBUG2(" Processing the %s section of radiusd.conf",
468 component_names[comp]);
469 return modcall(comp, this->modulelist, request);
472 /* Load a flat module list, as found inside an authtype{} block */
473 static void load_subcomponent_section(CONF_SECTION *cs, int comp,
474 const char *filename)
477 indexed_modcallable *subcomp;
481 static int meaningless_counter = 1;
483 ml = compile_modgroup(comp, cs, filename);
485 /* We must assign a numeric index to this subcomponent. For
486 * auth, it is generated and placed in the dictionary by
487 * new_sectiontype_value(). The others are just numbers that are pulled
488 * out of thin air, and the names are neither put into the dictionary
489 * nor checked for uniqueness, but all that could be fixed in a few
490 * minutes, if anyone finds a real use for indexed config of
491 * components other than auth. */
493 if (comp==RLM_COMPONENT_AUTH) {
494 dval = dict_valbyname(PW_AUTH_TYPE, cf_section_name2(cs));
495 } else if (comp == RLM_COMPONENT_AUTZ) {
496 dval = dict_valbyname(PW_AUTZ_TYPE, cf_section_name2(cs));
497 } else if (comp == RLM_COMPONENT_ACCT) {
498 dval = dict_valbyname(PW_ACCT_TYPE, cf_section_name2(cs));
499 } else if (comp == RLM_COMPONENT_SESS) {
500 dval = dict_valbyname(PW_SESSION_TYPE, cf_section_name2(cs));
501 } else if (comp == RLM_COMPONENT_POST_AUTH) {
502 dval = dict_valbyname(PW_POST_AUTH_TYPE, cf_section_name2(cs));
508 idx = meaningless_counter++;
511 subcomp = new_sublist(comp, idx);
514 "%s[%d] %s %s already configured - skipping",
515 filename, cf_section_lineno(cs),
516 subcomponent_names[comp], cf_section_name2(cs));
517 modcallable_free(&ml);
521 subcomp->modulelist = ml;
524 static int load_component_section(CONF_SECTION *cs, int comp,
525 const char *filename)
530 indexed_modcallable *subcomp;
534 for (modref=cf_item_find_next(cs, NULL);
536 modref=cf_item_find_next(cs, modref)) {
538 if (cf_item_is_section(modref)) {
539 const char *sec_name;
541 scs = cf_itemtosection(modref);
543 sec_name = cf_section_name1(scs);
545 subcomponent_names[comp]) == 0) {
546 load_subcomponent_section(scs, comp, filename);
551 * Allow old names, too.
554 old_subcomponent_names[comp]) == 0) {
555 load_subcomponent_section(scs, comp, filename);
560 cp = cf_itemtopair(modref);
564 * FIXME: This calls exit if the reference can't be
565 * found. We should instead print a better error,
566 * and return the failure code up the stack.
568 this = compile_modsingle(comp, modref, filename, &modname);
570 if (comp == RLM_COMPONENT_AUTH) {
573 dval = dict_valbyname(PW_AUTH_TYPE, modname);
576 * It's a section, but nothing we
579 radlog(L_ERR|L_CONS, "%s[%d] Unknown Auth-Type \"%s\" in %s section.",
580 filename, cf_section_lineno(cs),
581 modname, component_names[comp]);
586 /* See the comment in new_sublist() for explanation
587 * of the special index 0 */
591 subcomp = new_sublist(comp, idx);
592 if (subcomp == NULL) {
593 radlog(L_INFO|L_CONS,
594 "%s %s %s already configured - skipping",
595 filename, subcomponent_names[comp],
597 modcallable_free(&this);
601 /* If subcomp->modulelist is NULL, add_to_modcallable will
603 visiblename = cf_section_name2(cs);
604 if (visiblename == NULL)
605 visiblename = cf_section_name1(cs);
606 add_to_modcallable(&subcomp->modulelist, this,
613 typedef struct section_type_value_t {
615 const char *typename;
617 } section_type_value_t;
619 static const section_type_value_t section_type_value[] = {
620 { "authorize", "Autz-Type", PW_AUTZ_TYPE },
621 { "authenticate", "Auth-Type", PW_AUTH_TYPE },
622 { "accounting", "Acct-Type", PW_ACCT_TYPE },
623 { "session", "Session-Type", PW_SESSION_TYPE },
624 { "post-auth", "Post-Auth-Type", PW_POST_AUTH_TYPE },
625 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },
626 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE },
627 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE },
634 static const section_type_value_t old_section_type_value[] = {
635 { "authorize", "autztype", PW_AUTZ_TYPE },
636 { "authenticate", "authtype", PW_AUTH_TYPE },
637 { "accounting", "acctype", PW_ACCT_TYPE },
638 { "session", "sesstype", PW_SESSION_TYPE },
639 { "post-auth", "post-authtype", PW_POST_AUTH_TYPE },
644 * Parse the module config sections, and load
645 * and call each module's init() function.
647 * Libtool makes your life a LOT easier, especially with libltdl.
648 * see: http://www.gnu.org/software/libtool/
650 int setup_modules(void)
656 * FIXME: This should be pulled from somewhere else.
658 const char *filename="radiusd.conf";
661 * No current list of modules: Go initialize libltdl.
665 * Set the default list of preloaded symbols.
666 * This is used to initialize libltdl's list of
669 * i.e. Static modules.
671 LTDL_SET_PRELOADED_SYMBOLS();
673 if (lt_dlinit() != 0) {
674 radlog(L_ERR|L_CONS, "Failed to initialize libraries: %s\n",
681 * Set the search path to ONLY our library directory.
682 * This prevents the modules from being found from
683 * any location on the disk.
685 lt_dlsetsearchpath(radlib_dir);
687 DEBUG2("Module: Library search path is %s",
688 lt_dlgetsearchpath());
691 * Initialize the components.
693 for (comp = 0; comp < RLM_COMPONENT_COUNT; comp++) {
694 components[comp] = NULL;
702 * Create any DICT_VALUE's for the types. See
703 * 'doc/configurable_failover' for examples of 'authtype'
704 * used to create new Auth-Type values. In order to
705 * let the user create new names, we've got to look for
706 * those names, and create DICT_VALUE's for them.
708 for (comp = 0; section_type_value[comp].section != NULL; comp++) {
712 CONF_SECTION *sub, *next;
718 static int my_value = 32767;
720 cs = cf_section_find(section_type_value[comp].section);
727 * See if there's a sub-section by that
730 next = cf_subsection_find_next(cs, sub,
731 section_type_value[comp].typename);
734 * Allow some old names, too.
736 if (!next && (comp <= 4)) {
738 next = cf_subsection_find_next(cs, sub,
739 old_section_type_value[comp].typename);
744 * If so, look for it to define a new
747 name2 = cf_section_name2(sub);
748 if (!name2) continue;
752 * If the value already exists, don't
755 dval = dict_valbyname(section_type_value[comp].attr,
760 * Find the attribute for the value.
762 dattr = dict_attrbyvalue(section_type_value[comp].attr);
763 if (!dattr) continue;
766 * Finally, create the new attribute.
768 if (dict_addvalue(name2, dattr->name, my_value++) < 0) {
769 radlog(L_ERR, "%s", librad_errstr);
772 } while (sub != NULL);
775 * Loop over the non-sub-sections, too.
780 * See if there's a conf-pair by that
783 cp = cf_pair_find_next(cs, cp, NULL);
788 * If the value already exists, don't
791 name2 = cf_pair_attr(cp);
792 dval = dict_valbyname(section_type_value[comp].attr,
797 * Find the attribute for the value.
799 dattr = dict_attrbyvalue(section_type_value[comp].attr);
800 if (!dattr) continue;
803 * Finally, create the new attribute.
805 if (dict_addvalue(name2, dattr->name, my_value++) < 0) {
806 radlog(L_ERR, "%s", librad_errstr);
809 } while (cp != NULL);
810 } /* over the sections which can have redundent sub-sections */
813 * Look for the 'instantiate' section, which tells us
814 * the instantiation order of the modules, and also allows
815 * us to load modules with no authorize/authenticate/etc.
818 cs = cf_section_find("instantiate");
822 module_instance_t *module;
826 * Loop over the items in the 'instantiate' section.
828 for (ci=cf_item_find_next(cs, NULL);
830 ci=cf_item_find_next(cs, ci)) {
832 if (cf_item_is_section(ci)) {
834 "%s[%d] Subsection for module instantiate is not allowed\n", filename,
836 cf_section_lineno(cf_itemtosection(ci)));
840 cp = cf_itemtopair(ci);
841 name = cf_pair_attr(cp);
842 module = find_module_instance(name);
846 } /* loop over items in the subsection */
847 } /* if there's an 'instantiate' section. */
850 * Loop over all of the known components, finding their
851 * configuration section, and loading it.
853 for (comp = 0; comp < RLM_COMPONENT_COUNT; ++comp) {
854 cs = cf_section_find(component_names[comp]);
858 if (load_component_section(cs, comp, filename) < 0) {
867 * Call all authorization modules until one returns
868 * somethings else than RLM_MODULE_OK
870 int module_authorize(int autz_type, REQUEST *request)
873 * We have a proxied packet, and we've been told
874 * to NOT pass proxied packets through 'authorize'
875 * a second time. So stop.
877 if ((request->proxy != NULL &&
878 mainconfig.post_proxy_authorize == FALSE)) {
879 DEBUG2(" authorize: Skipping authorize in post-proxy stage");
880 return RLM_MODULE_NOOP;
883 return indexed_modcall(RLM_COMPONENT_AUTZ, autz_type, request);
887 * Authenticate a user/password with various methods.
889 int module_authenticate(int auth_type, REQUEST *request)
891 return indexed_modcall(RLM_COMPONENT_AUTH, auth_type, request);
895 * Do pre-accounting for ALL configured sessions
897 int module_preacct(REQUEST *request)
899 return indexed_modcall(RLM_COMPONENT_PREACCT, 0, request);
903 * Do accounting for ALL configured sessions
905 int module_accounting(int acct_type, REQUEST *request)
907 return indexed_modcall(RLM_COMPONENT_ACCT, acct_type, request);
911 * See if a user is already logged in.
913 * Returns: 0 == OK, 1 == double logins, 2 == multilink attempt
915 int module_checksimul(int sess_type, REQUEST *request, int maxsimul)
919 if(!components[RLM_COMPONENT_SESS])
922 if(!request->username)
925 request->simul_count = 0;
926 request->simul_max = maxsimul;
927 request->simul_mpp = 1;
929 rcode = indexed_modcall(RLM_COMPONENT_SESS, sess_type, request);
931 if (rcode != RLM_MODULE_OK) {
932 /* FIXME: Good spot for a *rate-limited* warning to the log */
936 return (request->simul_count < maxsimul) ? 0 : request->simul_mpp;
940 * Do pre-proxying for ALL configured sessions
942 int module_pre_proxy(REQUEST *request)
944 return indexed_modcall(RLM_COMPONENT_PRE_PROXY, 0, request);
948 * Do post-proxying for ALL configured sessions
950 int module_post_proxy(REQUEST *request)
952 return indexed_modcall(RLM_COMPONENT_POST_PROXY, 0, request);
956 * Do post-authentication for ALL configured sessions
958 int module_post_auth(int postauth_type, REQUEST *request)
960 return indexed_modcall(RLM_COMPONENT_POST_AUTH, postauth_type, request);