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>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modpriv.h>
29 #include <freeradius-devel/modcall.h>
30 #include <freeradius-devel/parser.h>
31 #include <freeradius-devel/rad_assert.h>
33 extern bool check_config;
35 typedef struct indexed_modcallable {
36 rlm_components_t comp;
38 modcallable *modulelist;
39 } indexed_modcallable;
41 typedef struct virtual_server_t {
47 modcallable *mc[RLM_COMPONENT_COUNT];
48 CONF_SECTION *subcs[RLM_COMPONENT_COUNT];
49 struct virtual_server_t *next;
53 * Keep a hash of virtual servers, so that we can reload them.
55 #define VIRTUAL_SERVER_HASH_SIZE (256)
56 static virtual_server_t *virtual_servers[VIRTUAL_SERVER_HASH_SIZE];
58 static rbtree_t *module_tree = NULL;
60 static rbtree_t *instance_tree = NULL;
62 struct fr_module_hup_t {
63 module_instance_t *mi;
66 fr_module_hup_t *next;
70 * Ordered by component
72 const section_type_value_t section_type_value[RLM_COMPONENT_COUNT] = {
73 { "authenticate", "Auth-Type", PW_AUTH_TYPE },
74 { "authorize", "Autz-Type", PW_AUTZ_TYPE },
75 { "preacct", "Pre-Acct-Type", PW_PRE_ACCT_TYPE },
76 { "accounting", "Acct-Type", PW_ACCT_TYPE },
77 { "session", "Session-Type", PW_SESSION_TYPE },
78 { "pre-proxy", "Pre-Proxy-Type", PW_PRE_PROXY_TYPE },
79 { "post-proxy", "Post-Proxy-Type", PW_POST_PROXY_TYPE },
80 { "post-auth", "Post-Auth-Type", PW_POST_AUTH_TYPE }
83 { "recv-coa", "Recv-CoA-Type", PW_RECV_COA_TYPE },
84 { "send-coa", "Send-CoA-Type", PW_SEND_COA_TYPE }
92 #define RTLD_LOCAL (0)
96 #define LT_SHREXT ".dylib"
97 #define LD_LIBRARY_PATH "DYLD_FALLBACK_LIBRARY_PATH"
99 #define LT_SHREXT ".dll"
101 #define LT_SHREXT ".so"
102 #define LD_LIBRARY_PATH "LD_LIBRARY_PATH"
105 /** Check if the magic number in the module matches the one in the library
107 * This is used to detect potential ABI issues caused by running with modules which
108 * were built for a different version of the server.
110 * @param cs being parsed.
111 * @param module being loaded.
112 * @returns 0 on success, -1 if prefix mismatch, -2 if version mismatch, -3 if commit mismatch.
114 static int check_module_magic(CONF_SECTION *cs, module_t const *module)
116 if (MAGIC_PREFIX(module->magic) != MAGIC_PREFIX(RADIUSD_MAGIC_NUMBER)) {
117 cf_log_err_cs(cs, "Application and rlm_%s magic number (prefix) mismatch."
118 " application: %x module: %x", module->name,
119 MAGIC_PREFIX(RADIUSD_MAGIC_NUMBER),
120 MAGIC_PREFIX(module->magic));
124 if (MAGIC_VERSION(module->magic) != MAGIC_VERSION(RADIUSD_MAGIC_NUMBER)) {
125 cf_log_err_cs(cs, "Application and rlm_%s magic number (version) mismatch."
126 " application: %lx module: %lx", module->name,
127 (unsigned long) MAGIC_VERSION(RADIUSD_MAGIC_NUMBER),
128 (unsigned long) MAGIC_VERSION(module->magic));
132 if (MAGIC_COMMIT(module->magic) != MAGIC_COMMIT(RADIUSD_MAGIC_NUMBER)) {
133 cf_log_err_cs(cs, "Application and rlm_%s magic number (commit) mismatch."
134 " application: %lx module: %lx", module->name,
135 (unsigned long) MAGIC_COMMIT(RADIUSD_MAGIC_NUMBER),
136 (unsigned long) MAGIC_COMMIT(module->magic));
144 * Because dlopen produces really shitty and inaccurate error messages
146 static void check_lib_access(char const *name)
148 if (access(name, R_OK) < 0) switch (errno) {
150 WARN("Library \"%s\" exists, but we don't have permission to read", name);
153 DEBUG4("Library not found at path \"%s\"", name);
156 DEBUG4("Possible issue accessing Library \"%s\": %s", name, fr_syserror(errno));
161 lt_dlhandle lt_dlopenext(char const *name)
163 int flags = RTLD_NOW;
169 if (strcmp(name, "rlm_perl") == 0) {
170 flags |= RTLD_GLOBAL;
177 * Bind all the symbols *NOW* so we don't hit errors later
182 * Prefer loading our libraries by absolute path.
184 snprintf(buffer, sizeof(buffer), "%s/%s%s", radlib_dir, name, LT_SHREXT);
186 DEBUG4("Loading library using absolute path");
188 handle = dlopen(buffer, flags);
192 check_lib_access(buffer);
194 DEBUG4("Falling back to linker search path(s)");
195 if (DEBUG_ENABLED4) {
197 env = getenv("LD_LIBRARY_PATH");
199 DEBUG4("LD_LIBRARY_PATH : %s", env);
201 env = getenv("DYLD_LIBRARY_PATH");
203 DEBUG4("DYLB_LIBRARY_PATH : %s", env);
205 env = getenv("DYLD_FALLBACK_LIBRARY_PATH");
207 DEBUG4("DYLD_FALLBACK_LIBRARY_PATH : %s", env);
209 env = getcwd(buffer, sizeof(buffer));
211 DEBUG4("Current directory : %s", env);
214 env = getenv("LD_LIBRARY_PATH");
216 DEBUG4("LD_LIBRARY_PATH : %s", env);
218 DEBUG4("Defaults : /lib:/usr/lib");
222 strlcpy(buffer, name, sizeof(buffer));
224 * FIXME: Make this configurable...
226 strlcat(buffer, LT_SHREXT, sizeof(buffer));
228 return dlopen(buffer, flags);
231 void *lt_dlsym(lt_dlhandle handle, UNUSED char const *symbol)
233 return dlsym(handle, symbol);
236 int lt_dlclose(lt_dlhandle handle)
238 if (!handle) return 0;
240 return dlclose(handle);
243 char const *lt_dlerror(void)
248 static int virtual_server_idx(char const *name)
254 hash = fr_hash_string(name);
256 return hash & (VIRTUAL_SERVER_HASH_SIZE - 1);
259 static virtual_server_t *virtual_server_find(char const *name)
262 virtual_server_t *server;
264 rcode = virtual_server_idx(name);
265 for (server = virtual_servers[rcode];
267 server = server->next) {
268 if (!name && !server->name) break;
270 if ((name && server->name) &&
271 (strcmp(name, server->name) == 0)) break;
277 static int _virtual_server_free(virtual_server_t *server)
279 if (server->components) rbtree_free(server->components);
283 void virtual_servers_free(time_t when)
286 virtual_server_t **last;
288 for (i = 0; i < VIRTUAL_SERVER_HASH_SIZE; i++) {
289 virtual_server_t *server, *next;
291 last = &virtual_servers[i];
292 for (server = virtual_servers[i];
298 * If we delete it, fix the links so that
299 * we don't orphan anything. Also,
300 * delete it if it's old, AND a newer one
303 * Otherwise, the last pointer gets set to
304 * the one we didn't delete.
307 ((server->created < when) && server->can_free)) {
308 *last = server->next;
311 last = &(server->next);
317 static int indexed_modcallable_free(indexed_modcallable *this)
319 modcallable_free(&this->modulelist);
323 static int indexed_modcallable_cmp(void const *one, void const *two)
325 indexed_modcallable const *a = one;
326 indexed_modcallable const *b = two;
328 if (a->comp < b->comp) return -1;
329 if (a->comp > b->comp) return +1;
331 return a->idx - b->idx;
336 * Compare two module entries
338 static int module_instance_cmp(void const *one, void const *two)
340 module_instance_t const *a = one;
341 module_instance_t const *b = two;
343 return strcmp(a->name, b->name);
347 static void module_instance_free_old(UNUSED CONF_SECTION *cs, module_instance_t *node,
350 fr_module_hup_t *mh, **last;
353 * Walk the list, freeing up old instances.
360 * Free only every 60 seconds.
362 if ((when - mh->when) < 60) {
367 talloc_free(mh->insthandle);
376 * Free a module instance.
378 static void module_instance_free(void *data)
380 module_instance_t *this = data;
382 module_instance_free_old(this->cs, this, time(NULL) + 100);
384 #ifdef HAVE_PTHREAD_H
388 * The mutex MIGHT be locked...
389 * we'll check for that later, I guess.
391 pthread_mutex_destroy(this->mutex);
392 talloc_free(this->mutex);
397 * Remove any registered paircompares.
399 paircompare_unregister_instance(this->insthandle);
401 xlat_unregister(this->name, NULL, this->insthandle);
404 memset(this, 0, sizeof(*this));
411 * Compare two module entries
413 static int module_entry_cmp(void const *one, void const *two)
415 module_entry_t const *a = one;
416 module_entry_t const *b = two;
418 return strcmp(a->name, b->name);
422 * Free a module entry.
424 static int module_entry_free(module_entry_t *this)
428 * Don't dlclose() modules if we're doing memory
429 * debugging. This removes the symbols needed by
432 if (!main_config.debug_memory)
434 dlclose(this->handle); /* ignore any errors */
440 * Remove the module lists.
442 int modules_free(void)
444 rbtree_free(instance_tree);
445 rbtree_free(module_tree);
452 * Find a module on disk or in memory, and link to it.
454 static module_entry_t *linkto_module(char const *module_name,
457 module_entry_t myentry;
458 module_entry_t *node;
460 module_t const *module;
462 strlcpy(myentry.name, module_name, sizeof(myentry.name));
463 node = rbtree_finddata(module_tree, &myentry);
464 if (node) return node;
467 * Link to the module's rlm_FOO{} structure, the same as
471 #if !defined(WITH_LIBLTDL) && defined(HAVE_DLFCN_H) && defined(RTLD_SELF)
472 module = dlsym(RTLD_SELF, module_name);
473 if (module) goto open_self;
477 * Keep the handle around so we can dlclose() it.
479 handle = lt_dlopenext(module_name);
482 "Failed to link to module '%s': %s\n",
483 module_name, dlerror());
487 DEBUG3(" (Loaded %s, checking if it's valid)", module_name);
490 * libltld MAY core here, if the handle it gives us contains
493 module = dlsym(handle, module_name);
496 "Failed linking to %s structure: %s\n",
497 module_name, dlerror());
502 #if !defined(WITH_LIBLTDL) && defined (HAVE_DLFCN_H) && defined(RTLD_SELF)
506 * Before doing anything else, check if it's sane.
508 if (check_module_magic(cs, module) < 0) {
513 /* make room for the module type */
514 node = talloc_zero(cs, module_entry_t);
515 talloc_set_destructor(node, module_entry_free);
516 strlcpy(node->name, module_name, sizeof(node->name));
517 node->module = module;
518 node->handle = handle;
520 cf_log_module(cs, "Loaded module %s", module_name);
523 * Add the module as "rlm_foo-version" to the configuration
526 if (!rbtree_insert(module_tree, node)) {
527 ERROR("Failed to cache module %s", module_name);
536 /** Parse module's configuration section and setup destructors
539 static int module_conf_parse(module_instance_t *node, void **handle)
544 * If there is supposed to be instance data, allocate it now.
545 * Also parse the configuration data, if required.
547 if (node->entry->module->inst_size) {
548 /* FIXME: make this rlm_config_t ?? */
549 *handle = talloc_zero_array(node, uint8_t, node->entry->module->inst_size);
553 * So we can see where this configuration is from
554 * FIXME: set it to rlm_NAME_t, or some such thing
556 talloc_set_name(*handle, "rlm_config_t");
558 if (node->entry->module->config &&
559 (cf_section_parse(node->cs, *handle, node->entry->module->config) < 0)) {
560 cf_log_err_cs(node->cs,"Invalid configuration for module \"%s\"", node->name);
561 talloc_free(*handle);
567 * Set the destructor.
569 if (node->entry->module->detach) {
570 talloc_set_destructor(*handle, node->entry->module->detach);
578 * Find a module instance.
580 module_instance_t *find_module_instance(CONF_SECTION *modules,
581 char const *askedname, int do_link)
583 bool check_config_safe = false;
585 char const *name1, *instname;
586 module_instance_t *node, myNode;
587 char module_name[256];
589 if (!modules) return NULL;
592 * Look for the real name. Ignore the first character,
593 * which tells the server "it's OK for this module to not
596 instname = askedname;
597 if (instname[0] == '-') {
602 * Module instances are declared in the modules{} block
603 * and referenced later by their name, which is the
604 * name2 from the config section, or name1 if there was
607 cs = cf_section_sub_find_name2(modules, NULL, instname);
609 ERROR("Cannot find a configuration entry for module \"%s\"", instname);
614 * If there's already a module instance, return it.
616 strlcpy(myNode.name, instname, sizeof(myNode.name));
618 node = rbtree_finddata(instance_tree, &myNode);
627 name1 = cf_section_name1(cs);
630 * Found the configuration entry, hang the node struct off of the
631 * configuration section. If the CS is free'd the instance will
634 node = talloc_zero(cs, module_instance_t);
638 * Names in the "modules" section aren't prefixed
639 * with "rlm_", so we add it here.
641 snprintf(module_name, sizeof(module_name), "rlm_%s", name1);
644 * Pull in the module object
646 node->entry = linkto_module(module_name, cs);
649 /* linkto_module logs any errors */
653 if (check_config && (node->entry->module->instantiate) &&
654 (node->entry->module->type & RLM_TYPE_CHECK_CONFIG_UNSAFE) != 0) {
655 char const *value = NULL;
658 cp = cf_pair_find(cs, "force_check_config");
660 value = cf_pair_value(cp);
663 if (value && (strcmp(value, "yes") == 0)) goto print_inst;
665 cf_log_module(cs, "Skipping instantiation of %s", instname);
668 check_config_safe = true;
669 cf_log_module(cs, "Instantiating module \"%s\" from file %s", instname,
670 cf_section_filename(cs));
673 strlcpy(node->name, instname, sizeof(node->name));
676 * Parse the module configuration, and setup destructors so the
677 * module's detach method is called when it's instance data is
680 if (module_conf_parse(node, &node->insthandle) < 0) {
687 * Call the module's instantiation routine.
689 if ((node->entry->module->instantiate) &&
690 (!check_config || check_config_safe) &&
691 ((node->entry->module->instantiate)(cs, node->insthandle) < 0)) {
692 cf_log_err_cs(cs, "Instantiation failed for module \"%s\"", node->name);
698 #ifdef HAVE_PTHREAD_H
700 * If we're threaded, check if the module is thread-safe.
702 * If it isn't, we create a mutex.
704 if ((node->entry->module->type & RLM_TYPE_THREAD_UNSAFE) != 0) {
705 node->mutex = talloc_zero(node, pthread_mutex_t);
708 * Initialize the mutex.
710 pthread_mutex_init(node->mutex, NULL);
713 * The module is thread-safe. Don't give it a mutex.
719 rbtree_insert(instance_tree, node);
724 static indexed_modcallable *lookup_by_index(rbtree_t *components,
725 rlm_components_t comp, int idx)
727 indexed_modcallable myc;
732 return rbtree_finddata(components, &myc);
736 * Create a new sublist.
738 static indexed_modcallable *new_sublist(CONF_SECTION *cs,
739 rbtree_t *components, rlm_components_t comp, int idx)
741 indexed_modcallable *c;
743 c = lookup_by_index(components, comp, idx);
745 /* It is an error to try to create a sublist that already
746 * exists. It would almost certainly be caused by accidental
747 * duplication in the config file.
749 * index 0 is the exception, because it is used when we want
750 * to collect _all_ listed modules under a single index by
751 * default, which is currently the case in all components
752 * except authenticate. */
760 c = talloc_zero(cs, indexed_modcallable);
761 c->modulelist = NULL;
765 if (!rbtree_insert(components, c)) {
770 talloc_set_destructor(c, indexed_modcallable_free);
775 rlm_rcode_t indexed_modcall(rlm_components_t comp, int idx, REQUEST *request)
778 modcallable *list = NULL;
779 virtual_server_t *server;
782 * Hack to find the correct virtual server.
784 server = virtual_server_find(request->server);
786 RDEBUG("No such virtual server \"%s\"", request->server);
787 return RLM_MODULE_FAIL;
791 list = server->mc[comp];
792 if (!list) RDEBUG3("Empty %s section. Using default return values.", section_type_value[comp].section);
795 indexed_modcallable *this;
797 this = lookup_by_index(server->components, comp, idx);
799 list = this->modulelist;
801 RDEBUG3("%s sub-section not found. Ignoring.",
802 section_type_value[comp].typename);
806 if (server->subcs[comp]) {
808 RDEBUG("# Executing section %s from file %s",
809 section_type_value[comp].section,
810 cf_section_filename(server->subcs[comp]));
812 RDEBUG("# Executing group from file %s",
813 cf_section_filename(server->subcs[comp]));
816 request->component = section_type_value[comp].section;
818 rcode = modcall(comp, list, request);
820 request->module = "";
821 request->component = "<core>";
826 * Load a sub-module list, as found inside an Auth-Type foo {}
829 static int load_subcomponent_section(modcallable *parent, CONF_SECTION *cs,
830 rbtree_t *components,
831 DICT_ATTR const *da, rlm_components_t comp)
833 indexed_modcallable *subcomp;
836 char const *name2 = cf_section_name2(cs);
848 ml = compile_modgroup(parent, comp, cs);
854 * We must assign a numeric index to this subcomponent.
855 * It is generated and placed in the dictionary
856 * automatically. If it isn't found, it's a serious
859 dval = dict_valbyname(da->attr, da->vendor, name2);
862 "%s %s Not previously configured",
863 section_type_value[comp].typename, name2);
864 modcallable_free(&ml);
868 subcomp = new_sublist(cs, components, comp, dval->value);
870 modcallable_free(&ml);
874 subcomp->modulelist = ml;
878 static int define_type(CONF_SECTION *cs, DICT_ATTR const *da, char const *name)
884 * If the value already exists, don't
887 dval = dict_valbyname(da->attr, da->vendor, name);
891 * Create a new unique value with a
892 * meaningless number. You can't look at
893 * it from outside of this code, so it
894 * doesn't matter. The only requirement
895 * is that it's unique.
898 value = fr_rand() & 0x00ffffff;
899 } while (dict_valbyattr(da->attr, da->vendor, value));
901 cf_log_module(cs, "Creating %s = %s", da->name, name);
902 if (dict_addvalue(name, da->name, value) < 0) {
903 ERROR("%s", fr_strerror());
911 * Don't complain too often.
913 #define MAX_IGNORED (32)
914 static int last_ignored = -1;
915 static char const *ignored[MAX_IGNORED];
917 static int load_component_section(CONF_SECTION *cs,
918 rbtree_t *components, rlm_components_t comp)
923 indexed_modcallable *subcomp;
928 * Find the attribute used to store VALUEs for this section.
930 da = dict_attrbyvalue(section_type_value[comp].attr, 0);
933 "No such attribute %s",
934 section_type_value[comp].typename);
939 * Loop over the entries in the named section, loading
940 * the sections this time.
942 for (modref = cf_item_find_next(cs, NULL);
944 modref = cf_item_find_next(cs, modref)) {
946 CONF_PAIR *cp = NULL;
947 CONF_SECTION *scs = NULL;
949 if (cf_item_is_section(modref)) {
950 scs = cf_itemtosection(modref);
952 name1 = cf_section_name1(scs);
955 section_type_value[comp].typename) == 0) {
956 if (!load_subcomponent_section(NULL, scs,
961 return -1; /* FIXME: memleak? */
968 } else if (cf_item_is_pair(modref)) {
969 cp = cf_itemtopair(modref);
972 continue; /* ignore it */
976 * Look for Auth-Type foo {}, which are special
977 * cases of named sections, and allowable ONLY
980 * i.e. They're not allowed in a "group" or "redundant"
983 if (comp == RLM_COMPONENT_AUTH) {
985 char const *modrefname = NULL;
987 modrefname = cf_pair_attr(cp);
989 modrefname = cf_section_name2(scs);
992 "Errors parsing %s sub-section.\n",
993 cf_section_name1(scs));
998 dval = dict_valbyname(PW_AUTH_TYPE, 0, modrefname);
1001 * It's a section, but nothing we
1005 "Unknown Auth-Type \"%s\" in %s sub-section.",
1006 modrefname, section_type_value[comp].section);
1011 /* See the comment in new_sublist() for explanation
1012 * of the special index 0 */
1016 subcomp = new_sublist(cs, components, comp, idx);
1017 if (!subcomp) continue;
1020 * Try to compile one entry.
1022 this = compile_modsingle(&subcomp->modulelist, comp, modref, &modname);
1025 * It's OK for the module to not exist.
1027 if (!this && modname && (modname[0] == '-')) {
1030 if (last_ignored < 0) {
1033 ignored[last_ignored] = modname;
1036 WARN("Ignoring \"%s\" (see raddb/mods-available/README.rst)", modname + 1);
1040 if (last_ignored >= MAX_IGNORED) goto complain;
1042 for (i = 0; i <= last_ignored; i++) {
1043 if (strcmp(ignored[i], modname) == 0) {
1048 if (i > last_ignored) goto save_complain;
1054 "Errors parsing %s section.\n",
1055 cf_section_name1(cs));
1059 if (debug_flag > 2) modcall_debug(this, 2);
1061 add_to_modcallable(subcomp->modulelist, this);
1068 static int load_byserver(CONF_SECTION *cs)
1070 rlm_components_t comp, found;
1071 char const *name = cf_section_name2(cs);
1072 rbtree_t *components;
1073 virtual_server_t *server = NULL;
1074 indexed_modcallable *c;
1077 cf_log_info(cs, "server %s { # from file %s",
1078 name, cf_section_filename(cs));
1080 cf_log_info(cs, "server { # from file %s",
1081 cf_section_filename(cs));
1084 server = talloc_zero(cs, virtual_server_t);
1085 server->name = name;
1086 server->created = time(NULL);
1088 server->components = components = rbtree_create(server, indexed_modcallable_cmp, NULL, 0);
1090 ERROR("Failed to initialize components");
1093 talloc_set_destructor(server, _virtual_server_free);
1096 * Define types first.
1098 for (comp = 0; comp < RLM_COMPONENT_COUNT; ++comp) {
1099 CONF_SECTION *subcs;
1101 DICT_ATTR const *da;
1103 subcs = cf_section_sub_find(cs,
1104 section_type_value[comp].section);
1105 if (!subcs) continue;
1107 if (cf_item_find_next(subcs, NULL) == NULL) continue;
1110 * Find the attribute used to store VALUEs for this section.
1112 da = dict_attrbyvalue(section_type_value[comp].attr, 0);
1114 cf_log_err_cs(subcs,
1115 "No such attribute %s",
1116 section_type_value[comp].typename);
1118 if (debug_flag == 0) {
1119 ERROR("Failed to load virtual server %s",
1120 (name != NULL) ? name : "<default>");
1122 talloc_free(server);
1127 * Define dynamic types, so that others can reference
1130 for (modref = cf_item_find_next(subcs, NULL);
1132 modref = cf_item_find_next(subcs, modref)) {
1134 CONF_SECTION *subsubcs;
1137 * Create types for simple references
1138 * only when parsing the authenticate
1141 if ((section_type_value[comp].attr == PW_AUTH_TYPE) &&
1142 cf_item_is_pair(modref)) {
1143 CONF_PAIR *cp = cf_itemtopair(modref);
1144 if (!define_type(cs, da, cf_pair_attr(cp))) {
1151 if (!cf_item_is_section(modref)) continue;
1153 subsubcs = cf_itemtosection(modref);
1154 name1 = cf_section_name1(subsubcs);
1156 if (strcmp(name1, section_type_value[comp].typename) == 0) {
1157 if (!define_type(cs, da,
1158 cf_section_name2(subsubcs))) {
1163 } /* loop over components */
1166 * Loop over all of the known components, finding their
1167 * configuration section, and loading it.
1170 for (comp = 0; comp < RLM_COMPONENT_COUNT; ++comp) {
1171 CONF_SECTION *subcs;
1173 subcs = cf_section_sub_find(cs,
1174 section_type_value[comp].section);
1175 if (!subcs) continue;
1177 if (cf_item_find_next(subcs, NULL) == NULL) continue;
1180 * Skip pre/post-proxy sections if we're not
1185 !main_config.proxy_requests &&
1187 ((comp == RLM_COMPONENT_PRE_PROXY) ||
1188 (comp == RLM_COMPONENT_POST_PROXY))) {
1192 #ifndef WITH_ACCOUNTING
1193 if (comp == RLM_COMPONENT_ACCT) continue;
1196 #ifndef WITH_SESSION_MGMT
1197 if (comp == RLM_COMPONENT_SESS) continue;
1200 if (debug_flag <= 3) {
1201 cf_log_module(cs, "Loading %s {...}",
1202 section_type_value[comp].section);
1204 DEBUG(" %s {", section_type_value[comp].section);
1207 if (load_component_section(subcs, components, comp) < 0) {
1211 if (debug_flag > 3) {
1212 DEBUG(" } # %s", section_type_value[comp].section);
1216 * Cache a default, if it exists. Some people
1217 * put empty sections for some reason...
1219 c = lookup_by_index(components, comp, 0);
1220 if (c) server->mc[comp] = c->modulelist;
1222 server->subcs[comp] = subcs;
1225 } /* loop over components */
1228 * We haven't loaded any of the normal sections. Maybe we're
1229 * supposed to load the vmps section.
1231 * This is a bit of a hack...
1234 #if defined(WITH_VMPS) || defined(WITH_DHCP)
1235 CONF_SECTION *subcs;
1238 DICT_ATTR const *da;
1242 subcs = cf_section_sub_find(cs, "vmps");
1244 cf_log_module(cs, "Loading vmps {...}");
1245 if (load_component_section(subcs, components,
1246 RLM_COMPONENT_POST_AUTH) < 0) {
1249 c = lookup_by_index(components,
1250 RLM_COMPONENT_POST_AUTH, 0);
1251 if (c) server->mc[RLM_COMPONENT_POST_AUTH] = c->modulelist;
1259 * It's OK to not have DHCP.
1261 subcs = cf_subsection_find_next(cs, NULL, "dhcp");
1264 da = dict_attrbyname("DHCP-Message-Type");
1267 * Handle each DHCP Message type separately.
1270 char const *name2 = cf_section_name2(subcs);
1273 cf_log_module(cs, "Loading dhcp %s {...}", name2);
1275 cf_log_module(cs, "Loading dhcp {...}");
1277 if (!load_subcomponent_section(NULL, subcs,
1280 RLM_COMPONENT_POST_AUTH)) {
1281 goto error; /* FIXME: memleak? */
1283 c = lookup_by_index(components,
1284 RLM_COMPONENT_POST_AUTH, 0);
1285 if (c) server->mc[RLM_COMPONENT_POST_AUTH] = c->modulelist;
1288 subcs = cf_subsection_find_next(cs, subcs, "dhcp");
1294 cf_log_info(cs, "} # server %s", name);
1296 cf_log_info(cs, "} # server");
1299 if (!found && name) {
1300 WARN("Server %s is empty, and will do nothing!",
1304 if (debug_flag == 0) {
1305 INFO("Loaded virtual server %s",
1306 (name != NULL) ? name : "<default>");
1310 * Now that it is OK, insert it into the list.
1312 * This is thread-safe...
1314 comp = virtual_server_idx(name);
1315 server->next = virtual_servers[comp];
1316 virtual_servers[comp] = server;
1319 * Mark OLDER ones of the same name as being unused.
1321 server = server->next;
1323 if ((!name && !server->name) ||
1324 (name && server->name &&
1325 (strcmp(server->name, name) == 0))) {
1326 server->can_free = true;
1329 server = server->next;
1336 static int pass2_cb(UNUSED void *ctx, void *data)
1338 indexed_modcallable *this = data;
1340 if (!modcall_pass2(this->modulelist)) return -1;
1346 * Load all of the virtual servers.
1348 int virtual_servers_load(CONF_SECTION *config)
1351 virtual_server_t *server;
1352 static bool first_time = true;
1354 DEBUG2("%s: #### Loading Virtual Servers ####", main_config.name);
1357 * If we have "server { ...}", then there SHOULD NOT be
1358 * bare "authorize", etc. sections. if there is no such
1359 * server, then try to load the old-style sections first.
1361 * In either case, load the "default" virtual server first.
1362 * this matches better with users expectations.
1364 cs = cf_section_find_name2(cf_subsection_find_next(config, NULL,
1368 if (load_byserver(cs) < 0) {
1372 if (load_byserver(config) < 0) {
1378 * Load all of the virtual servers.
1380 for (cs = cf_subsection_find_next(config, NULL, "server");
1382 cs = cf_subsection_find_next(config, cs, "server")) {
1385 name2 = cf_section_name2(cs);
1386 if (!name2) continue; /* handled above */
1388 server = virtual_server_find(name2);
1390 (cf_top_section(server->cs) == config)) {
1391 ERROR("Duplicate virtual server \"%s\" in file %s:%d and file %s:%d",
1393 cf_section_filename(server->cs),
1394 cf_section_lineno(server->cs),
1395 cf_section_filename(cs),
1396 cf_section_lineno(cs));
1400 if (load_byserver(cs) < 0) {
1402 * Once we successfully started once,
1403 * continue loading the OTHER servers,
1404 * even if one fails.
1406 if (!first_time) continue;
1412 * Now that we've loaded everything, run pass 2 over the
1413 * conditions and xlats.
1415 for (cs = cf_subsection_find_next(config, NULL, "server");
1417 cs = cf_subsection_find_next(config, cs, "server")) {
1421 name2 = cf_section_name2(cs);
1423 server = virtual_server_find(name2);
1424 if (!server) continue;
1426 for (i = RLM_COMPONENT_AUTH; i < RLM_COMPONENT_COUNT; i++) {
1427 if (!modcall_pass2(server->mc[i])) return -1;
1431 if (server->components &&
1432 (rbtree_walk(server->components, RBTREE_IN_ORDER,
1433 pass2_cb, NULL) != 0)) {
1439 * If we succeed the first time around, remember that.
1446 int module_hup_module(CONF_SECTION *cs, module_instance_t *node, time_t when)
1449 fr_module_hup_t *mh;
1452 !node->entry->module->instantiate ||
1453 ((node->entry->module->type & RLM_TYPE_HUP_SAFE) == 0)) {
1457 cf_log_module(cs, "Trying to reload module \"%s\"", node->name);
1460 * Parse the module configuration, and setup destructors so the
1461 * module's detach method is called when it's instance data is
1462 * about to be freed.
1464 if (module_conf_parse(node, &insthandle) < 0) {
1465 cf_log_err_cs(cs, "HUP failed for module \"%s\" (parsing config failed). "
1466 "Using old configuration", node->name);
1471 if ((node->entry->module->instantiate)(cs, insthandle) < 0) {
1472 cf_log_err_cs(cs, "HUP failed for module \"%s\". Using old configuration.", node->name);
1473 talloc_free(insthandle);
1478 INFO(" Module: Reloaded module \"%s\"", node->name);
1480 module_instance_free_old(cs, node, when);
1483 * Save the old instance handle for later deletion.
1485 mh = talloc_zero(cs, fr_module_hup_t);
1488 mh->insthandle = node->insthandle;
1489 mh->next = node->mh;
1492 node->insthandle = insthandle;
1495 * FIXME: Set a timeout to come back in 60s, so that
1496 * we can pro-actively clean up the old instances.
1503 int modules_hup(CONF_SECTION *modules)
1508 module_instance_t *node;
1510 if (!modules) return 0;
1515 * Loop over the modules
1517 for (ci=cf_item_find_next(modules, NULL);
1519 ci=cf_item_find_next(modules, ci)) {
1520 char const *instname;
1521 module_instance_t myNode;
1524 * If it's not a section, ignore it.
1526 if (!cf_item_is_section(ci)) continue;
1528 cs = cf_itemtosection(ci);
1529 instname = cf_section_name2(cs);
1530 if (!instname) instname = cf_section_name1(cs);
1532 strlcpy(myNode.name, instname, sizeof(myNode.name));
1533 node = rbtree_finddata(instance_tree, &myNode);
1535 module_hup_module(cs, node, when);
1543 * Parse the module config sections, and load
1544 * and call each module's init() function.
1546 int modules_init(CONF_SECTION *config)
1548 CONF_ITEM *ci, *next;
1549 CONF_SECTION *cs, *modules;
1550 rad_listen_t *listener;
1553 * Set up the internal module struct.
1555 module_tree = rbtree_create(NULL, module_entry_cmp, NULL, 0);
1557 ERROR("Failed to initialize modules\n");
1561 instance_tree = rbtree_create(NULL, module_instance_cmp,
1562 module_instance_free, 0);
1563 if (!instance_tree) {
1564 ERROR("Failed to initialize modules\n");
1568 memset(virtual_servers, 0, sizeof(virtual_servers));
1571 * Remember where the modules were stored.
1573 modules = cf_section_sub_find(config, "modules");
1575 WARN("Cannot find a \"modules\" section in the configuration file!");
1578 #if defined(WITH_VMPS) || defined(WITH_DHCP)
1580 * Load dictionaries.
1582 for (cs = cf_subsection_find_next(config, NULL, "server");
1584 cs = cf_subsection_find_next(config, cs, "server")) {
1585 CONF_SECTION *subcs;
1586 DICT_ATTR const *da;
1590 * Auto-load the VMPS/VQP dictionary.
1592 subcs = cf_section_sub_find(cs, "vmps");
1594 da = dict_attrbyname("VQP-Packet-Type");
1596 if (dict_read(main_config.dictionary_dir, "dictionary.vqp") < 0) {
1597 ERROR("Failed reading dictionary.vqp: %s",
1601 cf_log_module(cs, "Loading dictionary.vqp");
1603 da = dict_attrbyname("VQP-Packet-Type");
1605 ERROR("No VQP-Packet-Type in dictionary.vqp");
1614 * Auto-load the DHCP dictionary.
1616 subcs = cf_subsection_find_next(cs, NULL, "dhcp");
1618 da = dict_attrbyname("DHCP-Message-Type");
1620 cf_log_module(cs, "Loading dictionary.dhcp");
1621 if (dict_read(main_config.dictionary_dir, "dictionary.dhcp") < 0) {
1622 ERROR("Failed reading dictionary.dhcp: %s",
1627 da = dict_attrbyname("DHCP-Message-Type");
1629 ERROR("No DHCP-Message-Type in dictionary.dhcp");
1636 * Else it's a RADIUS virtual server, and the
1637 * dictionaries are already loaded.
1642 DEBUG2("%s: #### Instantiating modules ####", main_config.name);
1645 * Loop over module definitions, looking for duplicates.
1647 * This is O(N^2) in the number of modules, but most
1648 * systems should have less than 100 modules.
1650 for (ci=cf_item_find_next(modules, NULL);
1653 char const *name1, *name2;
1654 CONF_SECTION *subcs, *duplicate;
1656 next = cf_item_find_next(modules, ci);
1658 if (!cf_item_is_section(ci)) continue;
1660 if (!next || !cf_item_is_section(next)) continue;
1662 subcs = cf_itemtosection(ci);
1663 name1 = cf_section_name1(subcs);
1664 name2 = cf_section_name2(subcs);
1666 duplicate = cf_section_find_name2(cf_itemtosection(next),
1668 if (!duplicate) continue;
1670 if (!name2) name2 = "";
1672 ERROR("Duplicate module \"%s %s\", in file %s:%d and file %s:%d",
1674 cf_section_filename(subcs),
1675 cf_section_lineno(subcs),
1676 cf_section_filename(duplicate),
1677 cf_section_lineno(duplicate));
1682 * Look for the 'instantiate' section, which tells us
1683 * the instantiation order of the modules, and also allows
1684 * us to load modules with no authorize/authenticate/etc.
1687 cs = cf_section_sub_find(config, "instantiate");
1690 module_instance_t *module;
1693 cf_log_info(cs, " instantiate {");
1696 * Loop over the items in the 'instantiate' section.
1698 for (ci=cf_item_find_next(cs, NULL);
1700 ci=cf_item_find_next(cs, ci)) {
1703 * Skip sections and "other" stuff.
1704 * Sections will be handled later, if
1705 * they're referenced at all...
1707 if (!cf_item_is_pair(ci)) {
1711 cp = cf_itemtopair(ci);
1712 name = cf_pair_attr(cp);
1713 module = find_module_instance(modules, name, 1);
1714 if (!module && (name[0] != '-')) {
1717 } /* loop over items in the subsection */
1719 cf_log_info(cs, " }");
1720 } /* if there's an 'instantiate' section. */
1723 * Now that we've loaded the explicitly ordered modules,
1724 * load everything in the "modules" section. This is
1725 * because we've now split up the modules into
1728 cf_log_info(cs, " modules {");
1729 for (ci=cf_item_find_next(modules, NULL);
1733 module_instance_t *module;
1734 CONF_SECTION *subcs;
1736 next = cf_item_find_next(modules, ci);
1738 if (!cf_item_is_section(ci)) continue;
1740 subcs = cf_itemtosection(ci);
1741 name = cf_section_name2(subcs);
1742 if (!name) name = cf_section_name1(subcs);
1744 module = find_module_instance(modules, name, 1);
1745 if (!module) return -1;
1747 cf_log_info(cs, " } # modules");
1750 * Loop over the listeners, figuring out which sections
1753 for (listener = main_config.listen;
1755 listener = listener->next) {
1759 if (listener->type == RAD_LISTEN_PROXY) continue;
1762 cs = cf_section_sub_find_name2(config,
1763 "server", listener->server);
1764 if (!cs && (listener->server != NULL)) {
1765 listener->print(listener, buffer, sizeof(buffer));
1767 ERROR("No server has been defined for %s", buffer);
1772 if (virtual_servers_load(config) < 0) return -1;
1778 * Call all authorization modules until one returns
1779 * somethings else than RLM_MODULE_OK
1781 rlm_rcode_t process_authorize(int autz_type, REQUEST *request)
1783 return indexed_modcall(RLM_COMPONENT_AUTZ, autz_type, request);
1787 * Authenticate a user/password with various methods.
1789 rlm_rcode_t process_authenticate(int auth_type, REQUEST *request)
1791 return indexed_modcall(RLM_COMPONENT_AUTH, auth_type, request);
1794 #ifdef WITH_ACCOUNTING
1796 * Do pre-accounting for ALL configured sessions
1798 rlm_rcode_t module_preacct(REQUEST *request)
1800 return indexed_modcall(RLM_COMPONENT_PREACCT, 0, request);
1804 * Do accounting for ALL configured sessions
1806 rlm_rcode_t process_accounting(int acct_type, REQUEST *request)
1808 return indexed_modcall(RLM_COMPONENT_ACCT, acct_type, request);
1812 #ifdef WITH_SESSION_MGMT
1814 * See if a user is already logged in.
1816 * Returns: 0 == OK, 1 == double logins, 2 == multilink attempt
1818 int process_checksimul(int sess_type, REQUEST *request, int maxsimul)
1822 if(!request->username)
1825 request->simul_count = 0;
1826 request->simul_max = maxsimul;
1827 request->simul_mpp = 1;
1829 rcode = indexed_modcall(RLM_COMPONENT_SESS, sess_type, request);
1831 if (rcode != RLM_MODULE_OK) {
1832 /* FIXME: Good spot for a *rate-limited* warning to the log */
1836 return (request->simul_count < maxsimul) ? 0 : request->simul_mpp;
1842 * Do pre-proxying for ALL configured sessions
1844 rlm_rcode_t process_pre_proxy(int type, REQUEST *request)
1846 return indexed_modcall(RLM_COMPONENT_PRE_PROXY, type, request);
1850 * Do post-proxying for ALL configured sessions
1852 rlm_rcode_t process_post_proxy(int type, REQUEST *request)
1854 return indexed_modcall(RLM_COMPONENT_POST_PROXY, type, request);
1859 * Do post-authentication for ALL configured sessions
1861 rlm_rcode_t process_post_auth(int postauth_type, REQUEST *request)
1863 return indexed_modcall(RLM_COMPONENT_POST_AUTH, postauth_type, request);
1867 rlm_rcode_t process_recv_coa(int recv_coa_type, REQUEST *request)
1869 return indexed_modcall(RLM_COMPONENT_RECV_COA, recv_coa_type, request);
1872 rlm_rcode_t process_send_coa(int send_coa_type, REQUEST *request)
1874 return indexed_modcall(RLM_COMPONENT_SEND_COA, send_coa_type, request);