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 2000,2006 The FreeRADIUS server project
25 #include <freeradius-devel/radiusd.h>
26 #include <freeradius-devel/modpriv.h>
27 #include <freeradius-devel/modcall.h>
28 #include <freeradius-devel/parser.h>
29 #include <freeradius-devel/rad_assert.h>
32 /* mutually-recursive static functions need a prototype up front */
33 static modcallable *do_compile_modgroup(modcallable *,
34 rlm_components_t, CONF_SECTION *,
37 /* Actions may be a positive integer (the highest one returned in the group
38 * will be returned), or the keyword "return", represented here by
39 * MOD_ACTION_RETURN, to cause an immediate return.
40 * There's also the keyword "reject", represented here by MOD_ACTION_REJECT
41 * to cause an immediate reject. */
42 #define MOD_ACTION_RETURN (-1)
43 #define MOD_ACTION_REJECT (-2)
45 /* Here are our basic types: modcallable, modgroup, and modsingle. For an
46 * explanation of what they are all about, see doc/configurable_failover.rst */
49 struct modcallable *next;
51 char const *debug_name;
52 enum { MOD_SINGLE = 1, MOD_GROUP, MOD_LOAD_BALANCE, MOD_REDUNDANT_LOAD_BALANCE,
54 MOD_IF, MOD_ELSE, MOD_ELSIF, MOD_UPDATE, MOD_SWITCH, MOD_CASE,
55 MOD_FOREACH, MOD_BREAK, MOD_RETURN,
57 MOD_POLICY, MOD_REFERENCE, MOD_XLAT } type;
58 rlm_components_t method;
59 int actions[RLM_MODULE_NUMCODES];
62 #define MOD_LOG_OPEN_BRACE RDEBUG2("%s {", c->debug_name)
64 #define MOD_LOG_CLOSE_BRACE RDEBUG2("} # %s = %s", c->debug_name, fr_int2str(mod_rcode_table, result, "<invalid>"))
67 modcallable mc; /* self */
72 } grouptype; /* after mc */
73 modcallable *children;
74 modcallable *tail; /* of the children list */
76 vp_map_t *map; /* update */
77 vp_tmpl_t *vpt; /* switch */
78 fr_cond_t *cond; /* if/elsif */
84 module_instance_t *modinst;
99 /* Simple conversions: modsingle and modgroup are subclasses of modcallable,
100 * so we often want to go back and forth between them. */
101 static modsingle *mod_callabletosingle(modcallable *p)
103 rad_assert(p->type==MOD_SINGLE);
104 return (modsingle *)p;
106 static modgroup *mod_callabletogroup(modcallable *p)
108 rad_assert((p->type > MOD_SINGLE) && (p->type <= MOD_POLICY));
110 return (modgroup *)p;
112 static modcallable *mod_singletocallable(modsingle *p)
114 return (modcallable *)p;
116 static modcallable *mod_grouptocallable(modgroup *p)
118 return (modcallable *)p;
121 static modref *mod_callabletoref(modcallable *p)
123 rad_assert(p->type==MOD_REFERENCE);
126 static modcallable *mod_reftocallable(modref *p)
128 return (modcallable *)p;
131 static modxlat *mod_callabletoxlat(modcallable *p)
133 rad_assert(p->type==MOD_XLAT);
136 static modcallable *mod_xlattocallable(modxlat *p)
138 return (modcallable *)p;
141 /* modgroups are grown by adding a modcallable to the end */
142 static void add_child(modgroup *g, modcallable *c)
146 (void) talloc_steal(g, c);
149 g->children = g->tail = c;
151 rad_assert(g->tail->next == NULL);
156 c->parent = mod_grouptocallable(g);
159 /* Here's where we recognize all of our keywords: first the rcodes, then the
161 const FR_NAME_NUMBER mod_rcode_table[] = {
162 { "reject", RLM_MODULE_REJECT },
163 { "fail", RLM_MODULE_FAIL },
164 { "ok", RLM_MODULE_OK },
165 { "handled", RLM_MODULE_HANDLED },
166 { "invalid", RLM_MODULE_INVALID },
167 { "userlock", RLM_MODULE_USERLOCK },
168 { "notfound", RLM_MODULE_NOTFOUND },
169 { "noop", RLM_MODULE_NOOP },
170 { "updated", RLM_MODULE_UPDATED },
176 * Compile action && rcode for later use.
178 static int compile_action(modcallable *c, CONF_PAIR *cp)
181 char const *attr, *value;
183 attr = cf_pair_attr(cp);
184 value = cf_pair_value(cp);
185 if (!value) return 0;
187 if (!strcasecmp(value, "return"))
188 action = MOD_ACTION_RETURN;
190 else if (!strcasecmp(value, "break"))
191 action = MOD_ACTION_RETURN;
193 else if (!strcasecmp(value, "reject"))
194 action = MOD_ACTION_REJECT;
196 else if (strspn(value, "0123456789")==strlen(value)) {
197 action = atoi(value);
200 * Don't allow priority zero, for future use.
202 if (action == 0) return 0;
204 cf_log_err_cp(cp, "Unknown action '%s'.\n",
209 if (strcasecmp(attr, "default") != 0) {
212 rcode = fr_str2int(mod_rcode_table, attr, -1);
215 "Unknown module rcode '%s'.\n",
219 c->actions[rcode] = action;
221 } else { /* set all unset values to the default */
224 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
225 if (!c->actions[i]) c->actions[i] = action;
232 /* Some short names for debugging output */
233 static char const * const comp2str[] = {
249 #ifdef HAVE_PTHREAD_H
251 * Lock the mutex for the module
253 static void safe_lock(module_instance_t *instance)
256 pthread_mutex_lock(instance->mutex);
260 * Unlock the mutex for the module
262 static void safe_unlock(module_instance_t *instance)
265 pthread_mutex_unlock(instance->mutex);
269 * No threads: these functions become NULL's.
271 #define safe_lock(foo)
272 #define safe_unlock(foo)
275 static rlm_rcode_t CC_HINT(nonnull) call_modsingle(rlm_components_t component, modsingle *sp, REQUEST *request)
278 int indent = request->log.indent;
281 * If the request should stop, refuse to do anything.
283 blocked = (request->master_state == REQUEST_STOP_PROCESSING);
284 if (blocked) return RLM_MODULE_NOOP;
286 RDEBUG3("modsingle[%s]: calling %s (%s) for request %d",
287 comp2str[component], sp->modinst->name,
288 sp->modinst->entry->name, request->number);
289 request->log.indent = 0;
291 if (sp->modinst->force) {
292 request->rcode = sp->modinst->code;
297 * For logging unresponsive children.
299 request->module = sp->modinst->name;
301 safe_lock(sp->modinst);
302 request->rcode = sp->modinst->entry->module->methods[component](sp->modinst->insthandle, request);
303 safe_unlock(sp->modinst);
305 request->module = "";
308 * Wasn't blocked, and now is. Complain!
310 blocked = (request->master_state == REQUEST_STOP_PROCESSING);
312 RWARN("Module %s became unblocked for request %u", sp->modinst->entry->name, request->number);
316 request->log.indent = indent;
317 RDEBUG3("modsingle[%s]: returned from %s (%s) for request %d",
318 comp2str[component], sp->modinst->name,
319 sp->modinst->entry->name, request->number);
321 return request->rcode;
324 static int default_component_results[MOD_COUNT] = {
325 RLM_MODULE_REJECT, /* AUTH */
326 RLM_MODULE_NOTFOUND, /* AUTZ */
327 RLM_MODULE_NOOP, /* PREACCT */
328 RLM_MODULE_NOOP, /* ACCT */
329 RLM_MODULE_FAIL, /* SESS */
330 RLM_MODULE_NOOP, /* PRE_PROXY */
331 RLM_MODULE_NOOP, /* POST_PROXY */
332 RLM_MODULE_NOOP /* POST_AUTH */
335 RLM_MODULE_NOOP, /* RECV_COA_TYPE */
336 RLM_MODULE_NOOP /* SEND_COA_TYPE */
341 extern char const *unlang_keyword[];
343 char const *unlang_keyword[] = {
347 "load-balance group",
348 "redundant-load-balance group",
366 static char const modcall_spaces[] = " ";
368 #define MODCALL_STACK_MAX (32)
371 * Don't call the modules recursively. Instead, do them
372 * iteratively, and manage the call stack ourselves.
374 typedef struct modcall_stack_entry_t {
377 int unwind; /* unwind to this one if it exists */
379 } modcall_stack_entry_t;
382 static bool modcall_recurse(REQUEST *request, rlm_components_t component, int depth,
383 modcall_stack_entry_t *entry, bool do_next_sibling);
386 * Call a child of a block.
388 static void modcall_child(REQUEST *request, rlm_components_t component, int depth,
389 modcall_stack_entry_t *entry, modcallable *c,
390 rlm_rcode_t *result, bool do_next_sibling)
392 modcall_stack_entry_t *next;
394 if (depth >= MODCALL_STACK_MAX) {
395 ERROR("Internal sanity check failed: module stack is too deep");
400 * Initialize the childs stack frame.
404 next->result = entry->result;
408 if (!modcall_recurse(request, component,
409 depth, next, do_next_sibling)) {
410 *result = RLM_MODULE_FAIL;
415 * Unwind back up the stack
417 if (next->unwind != 0) {
418 entry->unwind = next->unwind;
421 *result = next->result;
428 * Interpret the various types of blocks.
430 static bool modcall_recurse(REQUEST *request, rlm_components_t component, int depth,
431 modcall_stack_entry_t *entry, bool do_next_sibling)
433 bool if_taken, was_if;
438 was_if = if_taken = false;
439 result = RLM_MODULE_UNKNOWN;
447 * Nothing more to do. Return the code and priority
448 * which was set by the caller.
452 rad_assert(c->debug_name != NULL); /* if this happens, all bets are off. */
455 * We've been asked to stop. Do so.
457 if ((request->master_state == REQUEST_STOP_PROCESSING) ||
459 (request->parent->master_state == REQUEST_STOP_PROCESSING))) {
460 entry->result = RLM_MODULE_FAIL;
461 entry->priority = 9999;
467 * Handle "if" conditions.
469 if (c->type == MOD_IF) {
474 g = mod_callabletogroup(c);
475 rad_assert(g->cond != NULL);
477 RDEBUG2("%s %s{", unlang_keyword[c->type], c->name);
479 condition = radius_evaluate_cond(request, result, 0, g->cond);
482 REDEBUG("Failed retrieving values required to evaluate condition");
484 RDEBUG2("%s %s -> %s",
485 unlang_keyword[c->type],
486 c->name, condition ? "TRUE" : "FALSE");
490 * Didn't pass. Remember that.
499 * We took the "if". Go recurse into its' children.
507 * "else" if the previous "if" was taken.
508 * "if" if the previous if wasn't taken.
510 if (c->type == MOD_ELSIF) {
511 if (!was_if) goto elsif_error;
514 * Like MOD_ELSE, but allow for a later "else"
517 RDEBUG2("... skipping %s for request %d: Preceding \"if\" was taken",
518 unlang_keyword[c->type], request->number);
525 * Check the "if" condition.
531 * "else" for a preceding "if".
533 if (c->type == MOD_ELSE) {
534 if (!was_if) { /* error */
536 RDEBUG2("... skipping %s for request %d: No preceding \"if\"",
537 unlang_keyword[c->type], request->number);
542 RDEBUG2("... skipping %s for request %d: Preceding \"if\" was taken",
543 unlang_keyword[c->type], request->number);
550 * We need to process it. Go do that.
558 * We're no longer processing if/else/elsif. Reset the
559 * trackers for those conditions.
563 #endif /* WITH_UNLANG */
565 if (c->type == MOD_SINGLE) {
569 * Process a stand-alone child, and fall through
570 * to dealing with it's parent.
572 sp = mod_callabletosingle(c);
574 result = call_modsingle(c->method, sp, request);
575 RDEBUG2("[%s] = %s", c->name ? c->name : "",
576 fr_int2str(mod_rcode_table, result, "<invalid>"));
577 goto calculate_result;
582 * Update attribute(s)
584 if (c->type == MOD_UPDATE) {
586 modgroup *g = mod_callabletogroup(c);
591 for (map = g->map; map != NULL; map = map->next) {
592 rcode = map_to_request(request, map, map_to_vp, NULL);
594 result = (rcode == -2) ? RLM_MODULE_INVALID : RLM_MODULE_FAIL;
597 goto calculate_result;
601 result = RLM_MODULE_NOOP;
603 goto calculate_result;
607 * Loop over a set of attributes.
609 if (c->type == MOD_FOREACH) {
610 int i, foreach_depth = -1;
611 VALUE_PAIR *vps, *vp;
612 modcall_stack_entry_t *next = NULL;
614 modgroup *g = mod_callabletogroup(c);
616 if (depth >= MODCALL_STACK_MAX) {
617 ERROR("Internal sanity check failed: module stack is too deep");
622 * Figure out how deep we are in nesting by looking at request_data
625 for (i = 0; i < 8; i++) {
626 if (!request_data_reference(request, (void *)radius_get_vp, i)) {
632 if (foreach_depth < 0) {
633 REDEBUG("foreach Nesting too deep!");
634 result = RLM_MODULE_FAIL;
635 goto calculate_result;
639 * Copy the VPs from the original request, this ensures deterministic
640 * behaviour if someone decides to add or remove VPs in the set were
643 if (tmpl_copy_vps(request, &vps, request, g->vpt) < 0) { /* nothing to loop over */
645 result = RLM_MODULE_NOOP;
647 goto calculate_result;
650 rad_assert(vps != NULL);
651 fr_cursor_init(©, &vps);
653 RDEBUG2("foreach %s ", c->name);
656 * This is the actual body of the foreach loop
658 for (vp = fr_cursor_first(©);
660 vp = fr_cursor_next(©)) {
662 if (fr_debug_lvl >= 2) {
665 vp_prints_value(buffer, sizeof(buffer), vp, '"');
666 RDEBUG2("# Foreach-Variable-%d = %s", foreach_depth, buffer);
671 * Add the vp to the request, so that
672 * xlat.c, xlat_foreach() can find it.
674 request_data_add(request, (void *)radius_get_vp, foreach_depth, &vp, false);
677 * Initialize the childs stack frame.
680 next->c = g->children;
681 next->result = entry->result;
685 if (!modcall_recurse(request, component, depth + 1, next, true)) {
690 * We've unwound to the enclosing
691 * "foreach". Stop the unwinding.
693 if (next->unwind == MOD_FOREACH) {
698 * Unwind all the way.
700 if (next->unwind == MOD_RETURN) {
701 entry->unwind = MOD_RETURN;
704 } /* loop over VPs */
707 * Free the copied vps and the request data
708 * If we don't remove the request data, something could call
709 * the xlat outside of a foreach loop and trigger a segv.
712 request_data_get(request, (void *)radius_get_vp, foreach_depth);
714 rad_assert(next != NULL);
715 result = next->result;
716 priority = next->priority;
718 goto calculate_result;
722 * Break out of a "foreach" loop, or return from a nested
725 if ((c->type == MOD_BREAK) || (c->type == MOD_RETURN)) {
729 RDEBUG2("%s", unlang_keyword[c->type]);
731 for (i = 8; i >= 0; i--) {
732 copy_p = request_data_get(request, (void *)radius_get_vp, i);
734 if (c->type == MOD_BREAK) {
735 RDEBUG2("# break Foreach-Variable-%d", i);
742 * Leave result / priority on the stack, and stop processing the section.
744 entry->unwind = c->type;
748 #endif /* WITH_UNLANG */
751 * Child is a group that has children of it's own.
753 if ((c->type == MOD_GROUP) || (c->type == MOD_POLICY)
755 || (c->type == MOD_CASE)
763 g = mod_callabletogroup(c);
766 * This should really have been caught in the
767 * compiler, and the node never generated. But
768 * doing that requires changing it's API so that
769 * it returns a flag instead of the compiled
773 RDEBUG2("%s { ... } # empty sub-section is ignored", c->name);
778 modcall_child(request, component,
779 depth + 1, entry, g->children,
782 goto calculate_result;
786 if (c->type == MOD_SWITCH) {
787 modcallable *this, *found, *null_case;
796 g = mod_callabletogroup(c);
798 memset(&cond, 0, sizeof(cond));
799 memset(&map, 0, sizeof(map));
801 cond.type = COND_TYPE_MAP;
802 cond.data.map = ↦
804 map.op = T_OP_CMP_EQ;
805 map.ci = cf_section_to_item(g->cs);
807 rad_assert(g->vpt != NULL);
809 null_case = found = NULL;
813 * The attribute doesn't exist. We can skip
814 * directly to the default 'case' statement.
816 if ((g->vpt->type == TMPL_TYPE_ATTR) && (tmpl_find_vp(NULL, request, g->vpt) < 0)) {
818 for (this = g->children; this; this = this->next) {
819 rad_assert(this->type == MOD_CASE);
821 h = mod_callabletogroup(this);
822 if (h->vpt) continue;
832 * Expand the template if necessary, so that it
833 * is evaluated once instead of for each 'case'
836 if ((g->vpt->type == TMPL_TYPE_XLAT_STRUCT) ||
837 (g->vpt->type == TMPL_TYPE_XLAT) ||
838 (g->vpt->type == TMPL_TYPE_EXEC)) {
842 len = tmpl_aexpand(request, &p, request, g->vpt, NULL, NULL);
843 if (len < 0) goto find_null_case;
845 tmpl_init(&vpt, TMPL_TYPE_LITERAL, data.strvalue, len);
849 * Find either the exact matching name, or the
850 * "case {...}" statement.
852 for (this = g->children; this; this = this->next) {
853 rad_assert(this->type == MOD_CASE);
855 h = mod_callabletogroup(this);
858 * Remember the default case
861 if (!null_case) null_case = this;
866 * If we're switching over an attribute
867 * AND we haven't pre-parsed the data for
868 * the case statement, then cast the data
869 * to the type of the attribute.
871 if ((g->vpt->type == TMPL_TYPE_ATTR) &&
872 (h->vpt->type != TMPL_TYPE_DATA)) {
875 cond.cast = g->vpt->tmpl_da;
878 * Remove unnecessary casting.
880 if ((h->vpt->type == TMPL_TYPE_ATTR) &&
881 (g->vpt->tmpl_da->type == h->vpt->tmpl_da->type)) {
886 * Use the pre-expanded string.
888 } else if ((g->vpt->type == TMPL_TYPE_XLAT_STRUCT) ||
889 (g->vpt->type == TMPL_TYPE_XLAT) ||
890 (g->vpt->type == TMPL_TYPE_EXEC)) {
896 * Else evaluate the 'switch' statement.
904 if (radius_evaluate_map(request, RLM_MODULE_UNKNOWN, 0,
911 if (!found) found = null_case;
914 talloc_free(data.ptr);
915 modcall_child(request, component, depth + 1, entry, found, &result, true);
917 goto calculate_result;
921 if ((c->type == MOD_LOAD_BALANCE) ||
922 (c->type == MOD_REDUNDANT_LOAD_BALANCE)) {
924 modcallable *this, *found;
929 g = mod_callabletogroup(c);
931 rad_assert(g->children != NULL);
934 * Choose a child at random.
936 for (this = g->children; this; this = this->next) {
939 if ((count * (fr_rand() & 0xffff)) < (uint32_t) 0x10000) {
944 if (c->type == MOD_LOAD_BALANCE) {
945 modcall_child(request, component,
946 depth + 1, entry, found,
953 modcall_child(request, component,
954 depth + 1, entry, this,
956 if (this->actions[result] == MOD_ACTION_RETURN) {
962 if (!this) this = g->children;
963 } while (this != found);
966 goto calculate_result;
967 } /* MOD_LOAD_BALANCE */
970 * Reference another virtual server.
972 * This should really be deleted, and replaced with a
973 * more abstracted / functional version.
975 if (c->type == MOD_REFERENCE) {
976 modref *mr = mod_callabletoref(c);
977 char const *server = request->server;
979 if (server == mr->ref_name) {
980 RWDEBUG("Suppressing recursive call to server %s", server);
984 request->server = mr->ref_name;
985 RDEBUG("server %s { # nested call", mr->ref_name);
986 result = indexed_modcall(component, 0, request);
987 RDEBUG("} # server %s with nested call", mr->ref_name);
988 request->server = server;
989 goto calculate_result;
990 } /* MOD_REFERENCE */
993 * xlat a string without doing anything else
995 * This should really be deleted, and replaced with a
996 * more abstracted / functional version.
998 if (c->type == MOD_XLAT) {
999 modxlat *mx = mod_callabletoxlat(c);
1003 radius_xlat(buffer, sizeof(buffer), request, mx->xlat_name, NULL, NULL);
1005 RDEBUG("`%s`", mx->xlat_name);
1006 radius_exec_program(request, NULL, 0, NULL, request, mx->xlat_name, request->packet->vps,
1007 false, true, EXEC_TIMEOUT);
1014 * Add new module types here.
1019 RDEBUG("(%s, %d) ? (%s, %d)",
1020 fr_int2str(mod_rcode_table, result, "<invalid>"),
1022 fr_int2str(mod_rcode_table, entry->result, "<invalid>"),
1027 rad_assert(result != RLM_MODULE_UNKNOWN);
1030 * The child's action says return. Do so.
1032 if ((c->actions[result] == MOD_ACTION_RETURN) &&
1034 entry->result = result;
1039 * If "reject", break out of the loop and return
1042 if (c->actions[result] == MOD_ACTION_REJECT) {
1043 entry->result = RLM_MODULE_REJECT;
1048 * The array holds a default priority for this return
1049 * code. Grab it in preference to any unset priority.
1052 priority = c->actions[result];
1056 * We're higher than any previous priority, remember this
1057 * return code and priority.
1059 if (priority > entry->priority) {
1060 entry->result = result;
1061 entry->priority = priority;
1066 * If we're processing a "case" statement, we return once
1067 * it's done, rather than going to the next "case" statement.
1069 if (c->type == MOD_CASE) goto finish;
1073 * If we've been told to stop processing
1076 if (entry->unwind == MOD_BREAK) {
1077 RDEBUG2("# unwind to enclosing foreach");
1082 if (entry->unwind == MOD_RETURN) {
1087 if (do_next_sibling) {
1088 entry->c = entry->c->next;
1090 if (entry->c) goto redo;
1102 /** Call a module, iteratively, with a local stack, rather than recursively
1104 * What did Paul Graham say about Lisp...?
1106 int modcall(rlm_components_t component, modcallable *c, REQUEST *request)
1108 modcall_stack_entry_t stack[MODCALL_STACK_MAX];
1111 memset(stack, 0, sizeof(stack));
1114 * Set up the initial stack frame.
1117 stack[0].result = default_component_results[component];
1118 stack[0].priority = 0;
1119 stack[0].unwind = 0;
1122 * Call the main handler.
1124 if (!modcall_recurse(request, component, 0, &stack[0], true)) {
1125 return RLM_MODULE_FAIL;
1129 * Return the result.
1131 return stack[0].result;
1136 static char const *action2str(int action)
1138 static char buf[32];
1139 if(action==MOD_ACTION_RETURN)
1141 if(action==MOD_ACTION_REJECT)
1143 snprintf(buf, sizeof buf, "%d", action);
1147 /* If you suspect a bug in the parser, you'll want to use these dump
1148 * functions. dump_tree should reproduce a whole tree exactly as it was found
1149 * in radiusd.conf, but in long form (all actions explicitly defined) */
1150 static void dump_mc(modcallable *c, int indent)
1154 if(c->type==MOD_SINGLE) {
1155 modsingle *single = mod_callabletosingle(c);
1156 DEBUG("%.*s%s {", indent, "\t\t\t\t\t\t\t\t\t\t\t",
1157 single->modinst->name);
1158 } else if ((c->type > MOD_SINGLE) && (c->type <= MOD_POLICY)) {
1159 modgroup *g = mod_callabletogroup(c);
1161 DEBUG("%.*s%s {", indent, "\t\t\t\t\t\t\t\t\t\t\t",
1162 unlang_keyword[c->type]);
1163 for(p = g->children;p;p = p->next)
1164 dump_mc(p, indent+1);
1165 } /* else ignore it for now */
1167 for(i = 0; i<RLM_MODULE_NUMCODES; ++i) {
1168 DEBUG("%.*s%s = %s", indent+1, "\t\t\t\t\t\t\t\t\t\t\t",
1169 fr_int2str(mod_rcode_table, i, "<invalid>"),
1170 action2str(c->actions[i]));
1173 DEBUG("%.*s}", indent, "\t\t\t\t\t\t\t\t\t\t\t");
1176 static void dump_tree(rlm_components_t comp, modcallable *c)
1178 DEBUG("[%s]", comp2str[comp]);
1182 #define dump_tree(a, b)
1185 /* These are the default actions. For each component, the group{} block
1186 * behaves like the code from the old module_*() function. redundant{}
1187 * are based on my guesses of what they will be used for. --Pac. */
1189 defaultactions[MOD_COUNT][GROUPTYPE_COUNT][RLM_MODULE_NUMCODES] =
1195 MOD_ACTION_RETURN, /* reject */
1197 MOD_ACTION_RETURN, /* ok */
1198 MOD_ACTION_RETURN, /* handled */
1200 MOD_ACTION_RETURN, /* userlock */
1201 MOD_ACTION_RETURN, /* notfound */
1207 MOD_ACTION_RETURN, /* reject */
1209 MOD_ACTION_RETURN, /* ok */
1210 MOD_ACTION_RETURN, /* handled */
1211 MOD_ACTION_RETURN, /* invalid */
1212 MOD_ACTION_RETURN, /* userlock */
1213 MOD_ACTION_RETURN, /* notfound */
1214 MOD_ACTION_RETURN, /* noop */
1215 MOD_ACTION_RETURN /* updated */
1222 MOD_ACTION_RETURN, /* reject */
1223 MOD_ACTION_RETURN, /* fail */
1225 MOD_ACTION_RETURN, /* handled */
1226 MOD_ACTION_RETURN, /* invalid */
1227 MOD_ACTION_RETURN, /* userlock */
1234 MOD_ACTION_RETURN, /* reject */
1236 MOD_ACTION_RETURN, /* ok */
1237 MOD_ACTION_RETURN, /* handled */
1238 MOD_ACTION_RETURN, /* invalid */
1239 MOD_ACTION_RETURN, /* userlock */
1240 MOD_ACTION_RETURN, /* notfound */
1241 MOD_ACTION_RETURN, /* noop */
1242 MOD_ACTION_RETURN /* updated */
1249 MOD_ACTION_RETURN, /* reject */
1250 MOD_ACTION_RETURN, /* fail */
1252 MOD_ACTION_RETURN, /* handled */
1253 MOD_ACTION_RETURN, /* invalid */
1254 MOD_ACTION_RETURN, /* userlock */
1255 MOD_ACTION_RETURN, /* notfound */
1261 MOD_ACTION_RETURN, /* reject */
1263 MOD_ACTION_RETURN, /* ok */
1264 MOD_ACTION_RETURN, /* handled */
1265 MOD_ACTION_RETURN, /* invalid */
1266 MOD_ACTION_RETURN, /* userlock */
1267 MOD_ACTION_RETURN, /* notfound */
1268 MOD_ACTION_RETURN, /* noop */
1269 MOD_ACTION_RETURN /* updated */
1276 MOD_ACTION_RETURN, /* reject */
1277 MOD_ACTION_RETURN, /* fail */
1279 MOD_ACTION_RETURN, /* handled */
1280 MOD_ACTION_RETURN, /* invalid */
1281 MOD_ACTION_RETURN, /* userlock */
1282 MOD_ACTION_RETURN, /* notfound */
1290 MOD_ACTION_RETURN, /* ok */
1291 MOD_ACTION_RETURN, /* handled */
1303 MOD_ACTION_RETURN, /* reject */
1305 MOD_ACTION_RETURN, /* ok */
1306 MOD_ACTION_RETURN, /* handled */
1307 MOD_ACTION_RETURN, /* invalid */
1308 MOD_ACTION_RETURN, /* userlock */
1309 MOD_ACTION_RETURN, /* notfound */
1310 MOD_ACTION_RETURN, /* noop */
1311 MOD_ACTION_RETURN /* updated */
1315 MOD_ACTION_RETURN, /* reject */
1317 MOD_ACTION_RETURN, /* ok */
1318 MOD_ACTION_RETURN, /* handled */
1319 MOD_ACTION_RETURN, /* invalid */
1320 MOD_ACTION_RETURN, /* userlock */
1321 MOD_ACTION_RETURN, /* notfound */
1322 MOD_ACTION_RETURN, /* noop */
1323 MOD_ACTION_RETURN /* updated */
1330 MOD_ACTION_RETURN, /* reject */
1331 MOD_ACTION_RETURN, /* fail */
1333 MOD_ACTION_RETURN, /* handled */
1334 MOD_ACTION_RETURN, /* invalid */
1335 MOD_ACTION_RETURN, /* userlock */
1342 MOD_ACTION_RETURN, /* reject */
1344 MOD_ACTION_RETURN, /* ok */
1345 MOD_ACTION_RETURN, /* handled */
1346 MOD_ACTION_RETURN, /* invalid */
1347 MOD_ACTION_RETURN, /* userlock */
1348 MOD_ACTION_RETURN, /* notfound */
1349 MOD_ACTION_RETURN, /* noop */
1350 MOD_ACTION_RETURN /* updated */
1357 MOD_ACTION_RETURN, /* reject */
1358 MOD_ACTION_RETURN, /* fail */
1360 MOD_ACTION_RETURN, /* handled */
1361 MOD_ACTION_RETURN, /* invalid */
1362 MOD_ACTION_RETURN, /* userlock */
1369 MOD_ACTION_RETURN, /* reject */
1371 MOD_ACTION_RETURN, /* ok */
1372 MOD_ACTION_RETURN, /* handled */
1373 MOD_ACTION_RETURN, /* invalid */
1374 MOD_ACTION_RETURN, /* userlock */
1375 MOD_ACTION_RETURN, /* notfound */
1376 MOD_ACTION_RETURN, /* noop */
1377 MOD_ACTION_RETURN /* updated */
1384 MOD_ACTION_RETURN, /* reject */
1385 MOD_ACTION_RETURN, /* fail */
1387 MOD_ACTION_RETURN, /* handled */
1388 MOD_ACTION_RETURN, /* invalid */
1389 MOD_ACTION_RETURN, /* userlock */
1396 MOD_ACTION_RETURN, /* reject */
1398 MOD_ACTION_RETURN, /* ok */
1399 MOD_ACTION_RETURN, /* handled */
1400 MOD_ACTION_RETURN, /* invalid */
1401 MOD_ACTION_RETURN, /* userlock */
1402 MOD_ACTION_RETURN, /* notfound */
1403 MOD_ACTION_RETURN, /* noop */
1404 MOD_ACTION_RETURN /* updated */
1413 MOD_ACTION_RETURN, /* reject */
1414 MOD_ACTION_RETURN, /* fail */
1416 MOD_ACTION_RETURN, /* handled */
1417 MOD_ACTION_RETURN, /* invalid */
1418 MOD_ACTION_RETURN, /* userlock */
1425 MOD_ACTION_RETURN, /* reject */
1427 MOD_ACTION_RETURN, /* ok */
1428 MOD_ACTION_RETURN, /* handled */
1429 MOD_ACTION_RETURN, /* invalid */
1430 MOD_ACTION_RETURN, /* userlock */
1431 MOD_ACTION_RETURN, /* notfound */
1432 MOD_ACTION_RETURN, /* noop */
1433 MOD_ACTION_RETURN /* updated */
1440 MOD_ACTION_RETURN, /* reject */
1441 MOD_ACTION_RETURN, /* fail */
1443 MOD_ACTION_RETURN, /* handled */
1444 MOD_ACTION_RETURN, /* invalid */
1445 MOD_ACTION_RETURN, /* userlock */
1452 MOD_ACTION_RETURN, /* reject */
1454 MOD_ACTION_RETURN, /* ok */
1455 MOD_ACTION_RETURN, /* handled */
1456 MOD_ACTION_RETURN, /* invalid */
1457 MOD_ACTION_RETURN, /* userlock */
1458 MOD_ACTION_RETURN, /* notfound */
1459 MOD_ACTION_RETURN, /* noop */
1460 MOD_ACTION_RETURN /* updated */
1466 static const int authtype_actions[GROUPTYPE_COUNT][RLM_MODULE_NUMCODES] =
1470 MOD_ACTION_RETURN, /* reject */
1471 MOD_ACTION_RETURN, /* fail */
1473 MOD_ACTION_RETURN, /* handled */
1474 MOD_ACTION_RETURN, /* invalid */
1475 MOD_ACTION_RETURN, /* userlock */
1482 MOD_ACTION_RETURN, /* reject */
1484 MOD_ACTION_RETURN, /* ok */
1485 MOD_ACTION_RETURN, /* handled */
1486 MOD_ACTION_RETURN, /* invalid */
1487 MOD_ACTION_RETURN, /* userlock */
1488 MOD_ACTION_RETURN, /* notfound */
1489 MOD_ACTION_RETURN, /* noop */
1490 MOD_ACTION_RETURN /* updated */
1494 /** Validate and fixup a map that's part of an update section.
1496 * @param map to validate.
1497 * @param ctx data to pass to fixup function (currently unused).
1498 * @return 0 if valid else -1.
1500 int modcall_fixup_update(vp_map_t *map, UNUSED void *ctx)
1502 CONF_PAIR *cp = cf_item_to_pair(map->ci);
1505 * Anal-retentive checks.
1507 if (DEBUG_ENABLED3) {
1508 if ((map->lhs->type == TMPL_TYPE_ATTR) && (map->lhs->name[0] != '&')) {
1509 WARN("%s[%d]: Please change attribute reference to '&%s %s ...'",
1510 cf_pair_filename(cp), cf_pair_lineno(cp),
1511 map->lhs->name, fr_int2str(fr_tokens, map->op, "<INVALID>"));
1514 if ((map->rhs->type == TMPL_TYPE_ATTR) && (map->rhs->name[0] != '&')) {
1515 WARN("%s[%d]: Please change attribute reference to '... %s &%s'",
1516 cf_pair_filename(cp), cf_pair_lineno(cp),
1517 fr_int2str(fr_tokens, map->op, "<INVALID>"), map->rhs->name);
1522 * Values used by unary operators should be literal ANY
1524 * We then free the template and alloc a NULL one instead.
1526 if (map->op == T_OP_CMP_FALSE) {
1527 if ((map->rhs->type != TMPL_TYPE_LITERAL) || (strcmp(map->rhs->name, "ANY") != 0)) {
1528 WARN("%s[%d] Wildcard deletion MUST use '!* ANY'",
1529 cf_pair_filename(cp), cf_pair_lineno(cp));
1532 TALLOC_FREE(map->rhs);
1534 map->rhs = tmpl_alloc(map, TMPL_TYPE_NULL, NULL, 0);
1538 * Lots of sanity checks for insane people...
1542 * What exactly where you expecting to happen here?
1544 if ((map->lhs->type == TMPL_TYPE_ATTR) &&
1545 (map->rhs->type == TMPL_TYPE_LIST)) {
1546 cf_log_err(map->ci, "Can't copy list into an attribute");
1551 * Depending on the attribute type, some operators are disallowed.
1553 if ((map->lhs->type == TMPL_TYPE_ATTR) && (!fr_assignment_op[map->op] && !fr_equality_op[map->op])) {
1554 cf_log_err(map->ci, "Invalid operator \"%s\" in update section. "
1555 "Only assignment or filter operators are allowed",
1556 fr_int2str(fr_tokens, map->op, "<INVALID>"));
1560 if (map->lhs->type == TMPL_TYPE_LIST) {
1562 * Can't copy an xlat expansion or literal into a list,
1563 * we don't know what type of attribute we'd need
1566 * The only exception is where were using a unary
1569 if (map->op != T_OP_CMP_FALSE) switch (map->rhs->type) {
1570 case TMPL_TYPE_XLAT:
1571 case TMPL_TYPE_LITERAL:
1572 cf_log_err(map->ci, "Can't copy value into list (we don't know which attribute to create)");
1580 * Only += and :=, and !* operators are supported
1584 case T_OP_CMP_FALSE:
1588 if ((map->rhs->type != TMPL_TYPE_LIST) &&
1589 (map->rhs->type != TMPL_TYPE_EXEC)) {
1590 cf_log_err(map->ci, "Invalid source for list assignment '%s += ...'", map->lhs->name);
1596 if (map->rhs->type == TMPL_TYPE_EXEC) {
1597 WARN("%s[%d] Please change ':=' to '=' for list assignment",
1598 cf_pair_filename(cp), cf_pair_lineno(cp));
1601 if (map->rhs->type != TMPL_TYPE_LIST) {
1602 cf_log_err(map->ci, "Invalid source for list assignment '%s := ...'", map->lhs->name);
1608 if (map->rhs->type != TMPL_TYPE_EXEC) {
1609 cf_log_err(map->ci, "Invalid source for list assignment '%s = ...'", map->lhs->name);
1615 cf_log_err(map->ci, "Operator \"%s\" not allowed for list assignment",
1616 fr_int2str(fr_tokens, map->op, "<INVALID>"));
1622 * If the map has a unary operator there's no further
1623 * processing we need to, as RHS is unused.
1625 if (map->op == T_OP_CMP_FALSE) return 0;
1628 * If LHS is an attribute, and RHS is a literal, we can
1629 * preparse the information into a TMPL_TYPE_DATA.
1631 * Unless it's a unary operator in which case we
1634 if ((map->lhs->type == TMPL_TYPE_ATTR) && (map->rhs->type == TMPL_TYPE_LITERAL)) {
1636 * It's a literal string, just copy it.
1637 * Don't escape anything.
1639 if (!cf_new_escape &&
1640 (map->lhs->tmpl_da->type == PW_TYPE_STRING) &&
1641 (cf_pair_value_type(cp) == T_SINGLE_QUOTED_STRING)) {
1642 tmpl_cast_in_place_str(map->rhs);
1648 if (map->lhs->auto_converted &&
1649 (map->rhs->name[0] == '0') && (map->rhs->name[1] == 'x') &&
1650 (map->rhs->len > 2) && ((map->rhs->len & 0x01) == 0)) {
1651 vp_tmpl_t *vpt = map->rhs;
1654 if (!map_cast_from_hex(map, T_BARE_WORD, vpt->name)) {
1656 cf_log_err(map->ci, "%s", fr_strerror());
1661 } else if (tmpl_cast_in_place(map->rhs, map->lhs->tmpl_da->type, map->lhs->tmpl_da) < 0) {
1662 cf_log_err(map->ci, "%s", fr_strerror());
1667 * Fixup LHS da if it doesn't match the type
1670 if (map->lhs->tmpl_da->type != map->rhs->tmpl_data_type) {
1671 DICT_ATTR const *da;
1673 da = dict_attrbytype(map->lhs->tmpl_da->attr, map->lhs->tmpl_da->vendor,
1674 map->rhs->tmpl_data_type);
1676 fr_strerror_printf("Cannot find %s variant of attribute \"%s\"",
1677 fr_int2str(dict_attr_types, map->rhs->tmpl_data_type,
1678 "<INVALID>"), map->lhs->tmpl_da->name);
1681 map->lhs->tmpl_da = da;
1684 } /* else we can't precompile the data */
1691 static modcallable *do_compile_modupdate(modcallable *parent, rlm_components_t component,
1692 CONF_SECTION *cs, char const *name2)
1696 modcallable *csingle;
1701 * This looks at cs->name2 to determine which list to update
1703 rcode = map_afrom_cs(&head, cs, PAIR_LIST_REQUEST, PAIR_LIST_REQUEST, modcall_fixup_update, NULL, 128);
1704 if (rcode < 0) return NULL; /* message already printed */
1706 cf_log_err_cs(cs, "'update' sections cannot be empty");
1710 g = talloc_zero(parent, modgroup);
1711 csingle = mod_grouptocallable(g);
1713 csingle->parent = parent;
1714 csingle->next = NULL;
1717 csingle->name = name2;
1721 csingle->type = MOD_UPDATE;
1722 csingle->method = component;
1724 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
1725 sizeof(csingle->actions));
1727 g->grouptype = GROUPTYPE_SIMPLE;
1730 g->map = talloc_steal(g, head);
1736 static modcallable *do_compile_modswitch (modcallable *parent, rlm_components_t component, CONF_SECTION *cs)
1741 bool had_seen_default = false;
1742 modcallable *csingle;
1747 name2 = cf_section_name2(cs);
1749 cf_log_err_cs(cs, "You must specify a variable to switch over for 'switch'");
1753 if (!cf_item_find_next(cs, NULL)) {
1754 cf_log_err_cs(cs, "'switch' statements cannot be empty");
1759 * Create the template. If we fail, AND it's a bare word
1760 * with &Foo-Bar, it MAY be an attribute defined by a
1761 * module. Allow it for now. The pass2 checks below
1764 type = cf_section_name2_type(cs);
1765 slen = tmpl_afrom_str(cs, &vpt, name2, strlen(name2), type, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
1766 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
1767 char *spaces, *text;
1769 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
1771 cf_log_err_cs(cs, "Syntax error");
1772 cf_log_err_cs(cs, "%s", name2);
1773 cf_log_err_cs(cs, "%s^ %s", spaces, text);
1775 talloc_free(spaces);
1782 * Otherwise a NULL vpt may refer to an attribute defined
1783 * by a module. That is checked in pass 2.
1786 if (vpt->type == TMPL_TYPE_LIST) {
1787 cf_log_err_cs(cs, "Syntax error: Cannot switch over list '%s'", name2);
1793 * Walk through the children of the switch section,
1794 * ensuring that they're all 'case' statements
1796 for (ci = cf_item_find_next(cs, NULL);
1798 ci = cf_item_find_next(cs, ci)) {
1799 CONF_SECTION *subcs;
1802 if (!cf_item_is_section(ci)) {
1803 if (!cf_item_is_pair(ci)) continue;
1805 cf_log_err(ci, "\"switch\" sections can only have \"case\" subsections");
1810 subcs = cf_item_to_section(ci); /* can't return NULL */
1811 name1 = cf_section_name1(subcs);
1813 if (strcmp(name1, "case") != 0) {
1814 cf_log_err(ci, "\"switch\" sections can only have \"case\" subsections");
1819 name2 = cf_section_name2(subcs);
1821 if (!had_seen_default) {
1822 had_seen_default = true;
1826 cf_log_err(ci, "Cannot have two 'default' case statements");
1832 csingle = do_compile_modgroup(parent, component, cs,
1841 g = mod_callabletogroup(csingle);
1842 g->vpt = talloc_steal(g, vpt);
1847 static modcallable *do_compile_modcase(modcallable *parent, rlm_components_t component, CONF_SECTION *cs)
1851 modcallable *csingle;
1855 if (!parent || (parent->type != MOD_SWITCH)) {
1856 cf_log_err_cs(cs, "\"case\" statements may only appear within a \"switch\" section");
1861 * case THING means "match THING"
1862 * case means "match anything"
1864 name2 = cf_section_name2(cs);
1869 type = cf_section_name2_type(cs);
1871 slen = tmpl_afrom_str(cs, &vpt, name2, strlen(name2), type, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
1872 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
1873 char *spaces, *text;
1875 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
1877 cf_log_err_cs(cs, "Syntax error");
1878 cf_log_err_cs(cs, "%s", name2);
1879 cf_log_err_cs(cs, "%s^ %s", spaces, text);
1881 talloc_free(spaces);
1887 if (vpt->type == TMPL_TYPE_LIST) {
1888 cf_log_err_cs(cs, "Syntax error: Cannot match list '%s'", name2);
1893 * Otherwise a NULL vpt may refer to an attribute defined
1894 * by a module. That is checked in pass 2.
1901 csingle = do_compile_modgroup(parent, component, cs,
1911 * The interpretor expects this to be NULL for the
1912 * default case. do_compile_modgroup sets it to name2,
1913 * unless name2 is NULL, in which case it sets it to name1.
1915 csingle->name = name2;
1917 g = mod_callabletogroup(csingle);
1918 g->vpt = talloc_steal(g, vpt);
1921 * Set all of it's codes to return, so that
1922 * when we pick a 'case' statement, we don't
1923 * fall through to processing the next one.
1925 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
1926 csingle->actions[i] = MOD_ACTION_RETURN;
1932 static modcallable *do_compile_modforeach(modcallable *parent,
1933 rlm_components_t component, CONF_SECTION *cs)
1937 modcallable *csingle;
1942 name2 = cf_section_name2(cs);
1945 "You must specify an attribute to loop over in 'foreach'");
1949 if (!cf_item_find_next(cs, NULL)) {
1950 cf_log_err_cs(cs, "'foreach' blocks cannot be empty");
1955 * Create the template. If we fail, AND it's a bare word
1956 * with &Foo-Bar, it MAY be an attribute defined by a
1957 * module. Allow it for now. The pass2 checks below
1960 type = cf_section_name2_type(cs);
1961 slen = tmpl_afrom_str(cs, &vpt, name2, strlen(name2), type, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
1962 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
1963 char *spaces, *text;
1965 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
1967 cf_log_err_cs(cs, "Syntax error");
1968 cf_log_err_cs(cs, "%s", name2);
1969 cf_log_err_cs(cs, "%s^ %s", spaces, text);
1971 talloc_free(spaces);
1978 * If we don't have a negative return code, we must have a vpt
1979 * (mostly to quiet coverity).
1983 if ((vpt->type != TMPL_TYPE_ATTR) && (vpt->type != TMPL_TYPE_LIST)) {
1984 cf_log_err_cs(cs, "MUST use attribute or list reference in 'foreach'");
1989 * Fix up the template to iterate over all instances of
1990 * the attribute. In a perfect consistent world, users would do
1991 * foreach &attr[*], but that's taking the consistency thing a bit far.
1993 vpt->tmpl_num = NUM_ALL;
1995 csingle = do_compile_modgroup(parent, component, cs,
1996 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2004 g = mod_callabletogroup(csingle);
2010 static modcallable *do_compile_modbreak(modcallable *parent,
2011 rlm_components_t component, CONF_ITEM const *ci)
2013 CONF_SECTION const *cs = NULL;
2015 for (cs = cf_item_parent(ci);
2017 cs = cf_item_parent(cf_section_to_item(cs))) {
2018 if (strcmp(cf_section_name1(cs), "foreach") == 0) {
2024 cf_log_err(ci, "'break' can only be used in a 'foreach' section");
2028 return do_compile_modgroup(parent, component, NULL,
2029 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2034 static modcallable *do_compile_modserver(modcallable *parent,
2035 rlm_components_t component, CONF_ITEM *ci,
2040 modcallable *csingle;
2041 CONF_SECTION *subcs;
2044 subcs = cf_section_sub_find_name2(cs, comp2str[component], NULL);
2046 cf_log_err(ci, "Server %s has no %s section",
2047 server, comp2str[component]);
2051 mr = talloc_zero(parent, modref);
2053 csingle = mod_reftocallable(mr);
2054 csingle->parent = parent;
2055 csingle->next = NULL;
2056 csingle->name = name;
2057 csingle->type = MOD_REFERENCE;
2058 csingle->method = component;
2060 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
2061 sizeof(csingle->actions));
2063 mr->ref_name = strdup(server);
2069 static modcallable *do_compile_modxlat(modcallable *parent,
2070 rlm_components_t component, char const *fmt)
2072 modcallable *csingle;
2075 mx = talloc_zero(parent, modxlat);
2077 csingle = mod_xlattocallable(mx);
2078 csingle->parent = parent;
2079 csingle->next = NULL;
2080 csingle->name = "expand";
2081 csingle->type = MOD_XLAT;
2082 csingle->method = component;
2084 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
2085 sizeof(csingle->actions));
2087 mx->xlat_name = strdup(fmt);
2088 if (fmt[0] != '%') {
2092 strcpy(mx->xlat_name, fmt + 1);
2093 p = strrchr(mx->xlat_name, '`');
2101 * redundant, etc. can refer to modules or groups, but not much else.
2103 static int all_children_are_modules(CONF_SECTION *cs, char const *name)
2107 for (ci=cf_item_find_next(cs, NULL);
2109 ci=cf_item_find_next(cs, ci)) {
2111 * If we're a redundant, etc. group, then the
2112 * intention is to call modules, rather than
2113 * processing logic. These checks aren't
2114 * *strictly* necessary, but they keep the users
2115 * from doing crazy things.
2117 if (cf_item_is_section(ci)) {
2118 CONF_SECTION *subcs = cf_item_to_section(ci);
2119 char const *name1 = cf_section_name1(subcs);
2121 if ((strcmp(name1, "if") == 0) ||
2122 (strcmp(name1, "else") == 0) ||
2123 (strcmp(name1, "elsif") == 0) ||
2124 (strcmp(name1, "update") == 0) ||
2125 (strcmp(name1, "switch") == 0) ||
2126 (strcmp(name1, "case") == 0)) {
2127 cf_log_err(ci, "%s sections cannot contain a \"%s\" statement",
2134 if (cf_item_is_pair(ci)) {
2135 CONF_PAIR *cp = cf_item_to_pair(ci);
2136 if (cf_pair_value(cp) != NULL) {
2138 "Entry with no value is invalid");
2149 * Compile one entry of a module call.
2151 static modcallable *do_compile_modsingle(modcallable *parent,
2152 rlm_components_t component, CONF_ITEM *ci,
2154 char const **modname)
2156 char const *modrefname, *p;
2158 modcallable *csingle;
2159 module_instance_t *this;
2160 CONF_SECTION *cs, *subcs, *modules;
2162 char const *realname;
2163 rlm_components_t method = component;
2165 if (cf_item_is_section(ci)) {
2168 cs = cf_item_to_section(ci);
2169 modrefname = cf_section_name1(cs);
2170 name2 = cf_section_name2(cs);
2171 if (!name2) name2 = "";
2174 * group{}, redundant{}, or append{} may appear
2175 * where a single module instance was expected.
2176 * In that case, we hand it off to
2179 if (strcmp(modrefname, "group") == 0) {
2181 return do_compile_modgroup(parent, component, cs,
2183 grouptype, MOD_GROUP);
2185 } else if (strcmp(modrefname, "redundant") == 0) {
2188 if (!all_children_are_modules(cs, modrefname)) {
2192 return do_compile_modgroup(parent, component, cs,
2193 GROUPTYPE_REDUNDANT,
2194 grouptype, MOD_GROUP);
2196 } else if (strcmp(modrefname, "load-balance") == 0) {
2199 if (!all_children_are_modules(cs, modrefname)) {
2203 return do_compile_modgroup(parent, component, cs,
2205 grouptype, MOD_LOAD_BALANCE);
2207 } else if (strcmp(modrefname, "redundant-load-balance") == 0) {
2210 if (!all_children_are_modules(cs, modrefname)) {
2214 return do_compile_modgroup(parent, component, cs,
2215 GROUPTYPE_REDUNDANT,
2216 grouptype, MOD_REDUNDANT_LOAD_BALANCE);
2219 } else if (strcmp(modrefname, "if") == 0) {
2220 if (!cf_section_name2(cs)) {
2221 cf_log_err(ci, "'if' without condition");
2226 csingle= do_compile_modgroup(parent, component, cs,
2229 if (!csingle) return NULL;
2234 } else if (strcmp(modrefname, "elsif") == 0) {
2236 ((parent->type == MOD_LOAD_BALANCE) ||
2237 (parent->type == MOD_REDUNDANT_LOAD_BALANCE))) {
2238 cf_log_err(ci, "'elsif' cannot be used in this section");
2242 if (!cf_section_name2(cs)) {
2243 cf_log_err(ci, "'elsif' without condition");
2248 return do_compile_modgroup(parent, component, cs,
2250 grouptype, MOD_ELSIF);
2252 } else if (strcmp(modrefname, "else") == 0) {
2254 ((parent->type == MOD_LOAD_BALANCE) ||
2255 (parent->type == MOD_REDUNDANT_LOAD_BALANCE))) {
2256 cf_log_err(ci, "'else' cannot be used in this section section");
2260 if (cf_section_name2(cs)) {
2261 cf_log_err(ci, "Cannot have conditions on 'else'");
2266 return do_compile_modgroup(parent, component, cs,
2268 grouptype, MOD_ELSE);
2270 } else if (strcmp(modrefname, "update") == 0) {
2273 return do_compile_modupdate(parent, component, cs,
2276 } else if (strcmp(modrefname, "switch") == 0) {
2279 return do_compile_modswitch (parent, component, cs);
2281 } else if (strcmp(modrefname, "case") == 0) {
2284 return do_compile_modcase(parent, component, cs);
2286 } else if (strcmp(modrefname, "foreach") == 0) {
2289 return do_compile_modforeach(parent, component, cs);
2292 } /* else it's something like sql { fail = 1 ...} */
2294 } else if (!cf_item_is_pair(ci)) { /* CONF_DATA or some such */
2298 * Else it's a module reference, with updated return
2302 CONF_PAIR *cp = cf_item_to_pair(ci);
2303 modrefname = cf_pair_attr(cp);
2306 * Actions (ok = 1), etc. are orthogonal to just
2307 * about everything else.
2309 if (cf_pair_value(cp) != NULL) {
2310 cf_log_err(ci, "Entry is not a reference to a module");
2315 * In-place xlat's via %{...}.
2317 * This should really be removed from the server.
2319 if (((modrefname[0] == '%') && (modrefname[1] == '{')) ||
2320 (modrefname[0] == '`')) {
2321 return do_compile_modxlat(parent, component,
2328 * These can't be over-ridden.
2330 if (strcmp(modrefname, "break") == 0) {
2331 if (!cf_item_is_pair(ci)) {
2332 cf_log_err(ci, "Invalid use of 'break' as section name.");
2336 return do_compile_modbreak(parent, component, ci);
2339 if (strcmp(modrefname, "return") == 0) {
2340 if (!cf_item_is_pair(ci)) {
2341 cf_log_err(ci, "Invalid use of 'return' as section name.");
2345 return do_compile_modgroup(parent, component, NULL,
2346 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2352 * Run a virtual server. This is really terrible and
2353 * should be deleted.
2355 if (strncmp(modrefname, "server[", 7) == 0) {
2358 if (!cf_item_is_pair(ci)) {
2359 cf_log_err(ci, "Invalid syntax");
2363 strlcpy(buffer, modrefname + 7, sizeof(buffer));
2364 p = strrchr(buffer, ']');
2365 if (!p || p[1] != '\0' || (p == buffer)) {
2366 cf_log_err(ci, "Invalid server reference in \"%s\".", modrefname);
2370 buffer[p - buffer] = '\0';
2372 cs = cf_section_sub_find_name2(NULL, "server", buffer);
2374 cf_log_err(ci, "No such server \"%s\".", buffer);
2379 * Ignore stupid attempts to over-ride the return
2382 return do_compile_modserver(parent, component, ci,
2383 modrefname, cs, buffer);
2387 * We now have a name. It can be one of two forms. A
2388 * bare module name, or a section named for the module,
2389 * with over-rides for the return codes.
2391 * The name can refer to a real module, in the "modules"
2392 * section. In that case, the name will be either the
2393 * first or second name of the sub-section of "modules".
2395 * Or, the name can refer to a policy, in the "policy"
2396 * section. In that case, the name will be first name of
2397 * the sub-section of "policy". Unless it's a "redudant"
2400 * Or, the name can refer to a "module.method", in which
2401 * case we're calling a different method than normal for
2404 * Or, the name can refer to a virtual module, in the
2405 * "instantiate" section. In that case, the name will be
2406 * the first of the sub-section of "instantiate". Unless
2407 * it's a "redudant" block...
2409 * We try these in sequence, from the bottom up. This is
2410 * so that things in "instantiate" and "policy" can
2411 * over-ride calls to real modules.
2418 * instantiate { ... name { ...} ... }
2419 * instantiate { ... name.method { ...} ... }
2420 * policy { ... name { .. } .. }
2421 * policy { ... name.method { .. } .. }
2423 * The "instantiate" virtual modules are identical to the
2424 * policies at this point. We should probably get rid of
2425 * the "instantiate" ones, as they're duplicate and
2429 cs = cf_section_find("instantiate");
2430 if (cs) subcs = cf_section_sub_find_name2(cs, NULL,
2433 (cs = cf_section_find("policy")) != NULL) {
2436 snprintf(buffer, sizeof(buffer), "%s.%s",
2437 modrefname, comp2str[component]);
2440 * Prefer name.section, then name.
2442 subcs = cf_section_sub_find_name2(cs, NULL,
2445 subcs = cf_section_sub_find_name2(cs, NULL,
2451 * Check that we're not creating a loop. We may
2452 * be compiling an "sql" module reference inside
2453 * of an "sql" policy. If so, we allow the
2454 * second "sql" to refer to the module.
2456 for (loop = cf_item_parent(ci);
2458 loop = cf_item_parent(cf_section_to_item(loop))) {
2459 if (loop == subcs) {
2465 * We've found the relevant entry. It MUST be a
2468 * However, it can be a "redundant" block, or just a
2473 * modules.c takes care of ensuring that this is:
2476 * load-balance foo { ...
2477 * redundant foo { ...
2478 * redundant-load-balance foo { ...
2480 * We can just recurs to compile the section as
2481 * if it was found here.
2483 if (cf_section_name2(subcs)) {
2484 csingle = do_compile_modsingle(parent,
2486 cf_section_to_item(subcs),
2495 * So we compile it like it was:
2499 csingle = do_compile_modgroup(parent,
2503 grouptype, MOD_GROUP);
2507 * Return the compiled thing if we can.
2509 if (!csingle) return NULL;
2510 if (cf_item_is_pair(ci)) return csingle;
2513 * Else we have a reference to a policy, and that reference
2514 * over-rides the return codes for the policy!
2516 goto action_override;
2520 * Not a virtual module. It must be a real module.
2522 modules = cf_section_find("modules");
2524 realname = modrefname;
2528 * Try to load the optional module.
2530 if (realname[0] == '-') realname++;
2533 * As of v3, the "modules" section contains
2534 * modules we use. Configuration for other
2535 * modules belongs in raddb/mods-available/,
2536 * which isn't loaded into the "modules" section.
2538 if (cf_section_sub_find_name2(modules, NULL, realname)) {
2539 this = module_instantiate(modules, realname);
2540 if (this) goto allocate_csingle;
2545 if (realname != modrefname) {
2551 * We were asked to MAYBE load it and it
2552 * doesn't exist. Return a soft error.
2554 if (realname != modrefname) {
2555 *modname = modrefname;
2562 * No module found by that name. Maybe we're calling
2565 p = strrchr(modrefname, '.');
2571 * Find the component.
2573 for (i = MOD_AUTHENTICATE;
2576 if (strcmp(p, comp2str[i]) == 0) {
2579 strlcpy(buffer, modrefname, sizeof(buffer));
2580 buffer[p - modrefname - 1] = '\0';
2583 this = module_instantiate(modules, buffer);
2586 goto allocate_csingle;
2592 * FIXME: check for "module", and give error "no
2593 * such component" when we don't find the method.
2598 * Can't de-reference it to anything. Ugh.
2601 cf_log_err(ci, "Failed to find \"%s\" as a module or policy.", modrefname);
2602 cf_log_err(ci, "Please verify that the configuration exists in %s/mods-enabled/%s.", get_radius_dir(), modrefname);
2606 * We know it's all OK, allocate the structures, and fill
2611 * Check if the module in question has the necessary
2614 if (!this->entry->module->methods[method]) {
2615 cf_log_err(ci, "\"%s\" modules aren't allowed in '%s' sections -- they have no such method.", this->entry->module->name,
2620 single = talloc_zero(parent, modsingle);
2621 single->modinst = this;
2622 *modname = this->entry->module->name;
2624 csingle = mod_singletocallable(single);
2625 csingle->parent = parent;
2626 csingle->next = NULL;
2627 if (!parent || (component != MOD_AUTHENTICATE)) {
2628 memcpy(csingle->actions, defaultactions[component][grouptype],
2629 sizeof csingle->actions);
2630 } else { /* inside Auth-Type has different rules */
2631 memcpy(csingle->actions, authtype_actions[grouptype],
2632 sizeof csingle->actions);
2634 rad_assert(modrefname != NULL);
2635 csingle->name = realname;
2636 csingle->type = MOD_SINGLE;
2637 csingle->method = method;
2641 * Over-ride the default return codes of the module.
2643 if (cf_item_is_section(ci)) {
2646 cs = cf_item_to_section(ci);
2647 for (csi=cf_item_find_next(cs, NULL);
2649 csi=cf_item_find_next(cs, csi)) {
2651 if (cf_item_is_section(csi)) {
2652 cf_log_err(csi, "Subsection of module instance call not allowed");
2653 talloc_free(csingle);
2657 if (!cf_item_is_pair(csi)) continue;
2659 if (!compile_action(csingle, cf_item_to_pair(csi))) {
2660 talloc_free(csingle);
2669 modcallable *compile_modsingle(TALLOC_CTX *ctx,
2670 modcallable **parent,
2671 rlm_components_t component, CONF_ITEM *ci,
2672 char const **modname)
2679 CONF_SECTION *parentcs;
2681 g = talloc_zero(ctx, modgroup);
2682 memset(g, 0, sizeof(*g));
2683 g->grouptype = GROUPTYPE_SIMPLE;
2684 c = mod_grouptocallable(g);
2687 defaultactions[component][GROUPTYPE_SIMPLE],
2688 sizeof(c->actions));
2690 parentcs = cf_item_parent(ci);
2691 c->name = cf_section_name2(parentcs);
2693 c->name = cf_section_name1(parentcs);
2696 c->type = MOD_GROUP;
2697 c->method = component;
2700 *parent = mod_grouptocallable(g);
2703 ret = do_compile_modsingle(*parent, component, ci,
2706 dump_tree(component, ret);
2712 * Internal compile group code.
2714 static modcallable *do_compile_modgroup(modcallable *parent,
2715 rlm_components_t component, CONF_SECTION *cs,
2716 int grouptype, int parentgrouptype, int mod_type)
2723 g = talloc_zero(parent, modgroup);
2724 g->grouptype = grouptype;
2728 c = mod_grouptocallable(g);
2732 memset(c->actions, 0, sizeof(c->actions));
2734 if (!cs) { /* only for "break" and "return" */
2740 * Remember the name for printing, etc.
2742 * FIXME: We may also want to put the names into a
2743 * rbtree, so that groups can reference each other...
2745 c->name = cf_section_name2(cs);
2747 c->name = cf_section_name1(cs);
2748 if ((strcmp(c->name, "group") == 0) ||
2749 (strcmp(c->name, "redundant") == 0)) {
2751 } else if (c->type == MOD_GROUP) {
2752 c->type = MOD_POLICY;
2758 * Do load-time optimizations
2760 if ((c->type == MOD_IF) || (c->type == MOD_ELSIF) || (c->type == MOD_ELSE)) {
2763 rad_assert(parent != NULL);
2765 if (c->type == MOD_IF) {
2766 g->cond = cf_data_find(g->cs, "if");
2767 rad_assert(g->cond != NULL);
2770 if (g->cond->type == COND_TYPE_FALSE) {
2771 INFO(" # Skipping contents of '%s' as it is always 'false' -- %s:%d",
2772 unlang_keyword[g->mc.type],
2773 cf_section_filename(g->cs), cf_section_lineno(g->cs));
2777 } else if (c->type == MOD_ELSIF) {
2779 g->cond = cf_data_find(g->cs, "if");
2780 rad_assert(g->cond != NULL);
2782 rad_assert(parent != NULL);
2783 p = mod_callabletogroup(parent);
2785 rad_assert(p->tail != NULL);
2787 f = mod_callabletogroup(p->tail);
2788 rad_assert((f->mc.type == MOD_IF) ||
2789 (f->mc.type == MOD_ELSIF));
2792 * If we took the previous condition, we
2793 * don't need to take this one.
2795 * We reset our condition to 'true', so
2796 * that subsequent sections can check
2797 * that they don't need to be executed.
2799 if (f->cond->type == COND_TYPE_TRUE) {
2801 INFO(" # Skipping contents of '%s' as previous '%s' is always 'true' -- %s:%d",
2802 unlang_keyword[g->mc.type],
2803 unlang_keyword[f->mc.type],
2804 cf_section_filename(g->cs), cf_section_lineno(g->cs));
2811 rad_assert(c->type == MOD_ELSE);
2813 rad_assert(parent != NULL);
2814 p = mod_callabletogroup(parent);
2816 rad_assert(p->tail != NULL);
2818 f = mod_callabletogroup(p->tail);
2819 rad_assert((f->mc.type == MOD_IF) ||
2820 (f->mc.type == MOD_ELSIF));
2823 * If we took the previous condition, we
2824 * don't need to take this one.
2826 if (f->cond->type == COND_TYPE_TRUE) goto skip_true;
2830 * Else we need to compile this section
2836 * Loop over the children of this group.
2838 for (ci=cf_item_find_next(cs, NULL);
2840 ci=cf_item_find_next(cs, ci)) {
2843 * Sections are references to other groups, or
2844 * to modules with updated return codes.
2846 if (cf_item_is_section(ci)) {
2847 char const *junk = NULL;
2848 modcallable *single;
2849 CONF_SECTION *subcs = cf_item_to_section(ci);
2851 single = do_compile_modsingle(c, component, ci,
2854 cf_log_err(ci, "Failed to parse \"%s\" subsection.",
2855 cf_section_name1(subcs));
2859 add_child(g, single);
2861 } else if (!cf_item_is_pair(ci)) { /* CONF_DATA */
2865 char const *attr, *value;
2866 CONF_PAIR *cp = cf_item_to_pair(ci);
2868 attr = cf_pair_attr(cp);
2869 value = cf_pair_value(cp);
2872 * A CONF_PAIR is either a module
2873 * instance with no actions
2877 modcallable *single;
2878 char const *junk = NULL;
2880 single = do_compile_modsingle(c,
2886 if (cf_item_is_pair(ci) &&
2887 cf_pair_attr(cf_item_to_pair(ci))[0] == '-') {
2892 "Failed to parse \"%s\" entry.",
2897 add_child(g, single);
2900 * Or a module instance with action.
2902 } else if (!compile_action(c, cp)) {
2905 } /* else it worked */
2911 * Set the default actions, if they haven't already been
2914 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
2915 if (!c->actions[i]) {
2916 if (!parent || (component != MOD_AUTHENTICATE)) {
2917 c->actions[i] = defaultactions[component][parentgrouptype][i];
2918 } else { /* inside Auth-Type has different rules */
2919 c->actions[i] = authtype_actions[parentgrouptype][i];
2929 if (grouptype != GROUPTYPE_REDUNDANT) break;
2932 case MOD_LOAD_BALANCE:
2933 case MOD_REDUNDANT_LOAD_BALANCE:
2935 cf_log_err_cs(g->cs, "%s sections cannot be empty",
2936 cf_section_name1(g->cs));
2943 * FIXME: If there are no children, return NULL?
2945 return mod_grouptocallable(g);
2948 modcallable *compile_modgroup(modcallable *parent,
2949 rlm_components_t component, CONF_SECTION *cs)
2951 modcallable *ret = do_compile_modgroup(parent, component, cs,
2953 GROUPTYPE_SIMPLE, MOD_GROUP);
2955 if (rad_debug_lvl > 3) {
2956 modcall_debug(ret, 2);
2962 void add_to_modcallable(modcallable *parent, modcallable *this)
2966 rad_assert(this != NULL);
2967 rad_assert(parent != NULL);
2969 g = mod_callabletogroup(parent);
2976 static bool pass2_xlat_compile(CONF_ITEM const *ci, vp_tmpl_t **pvpt, bool convert,
2977 DICT_ATTR const *da)
2987 rad_assert(vpt->type == TMPL_TYPE_XLAT);
2989 fmt = talloc_typed_strdup(vpt, vpt->name);
2990 slen = xlat_tokenize(vpt, fmt, &head, &error);
2993 char *spaces, *text;
2995 fr_canonicalize_error(vpt, &spaces, &text, slen, vpt->name);
2997 cf_log_err(ci, "Failed parsing expanded string:");
2998 cf_log_err(ci, "%s", text);
2999 cf_log_err(ci, "%s^ %s", spaces, error);
3001 talloc_free(spaces);
3007 * Convert %{Attribute-Name} to &Attribute-Name
3012 attr = xlat_to_tmpl_attr(talloc_parent(vpt), head);
3015 * If it's a virtual attribute, leave it
3018 if (attr->tmpl_da->flags.virtual) {
3024 * If the attribute is of incompatible
3025 * type, leave it alone.
3027 if (da && (da->type != attr->tmpl_da->type)) {
3032 if (cf_item_is_pair(ci)) {
3033 CONF_PAIR *cp = cf_item_to_pair(ci);
3035 WARN("%s[%d] Please change %%{%s} to &%s",
3036 cf_pair_filename(cp), cf_pair_lineno(cp),
3037 attr->name, attr->name);
3039 CONF_SECTION *cs = cf_item_to_section(ci);
3041 WARN("%s[%d] Please change %%{%s} to &%s",
3042 cf_section_filename(cs), cf_section_lineno(cs),
3043 attr->name, attr->name);
3052 * Re-write it to be a pre-parsed XLAT structure.
3054 vpt->type = TMPL_TYPE_XLAT_STRUCT;
3055 vpt->tmpl_xlat = head;
3062 static bool pass2_regex_compile(CONF_ITEM const *ci, vp_tmpl_t *vpt)
3067 rad_assert(vpt->type == TMPL_TYPE_REGEX);
3070 * It's a dynamic expansion. We can't expand the string,
3071 * but we can pre-parse it as an xlat struct. In that
3072 * case, we convert it to a pre-compiled XLAT.
3074 * This is a little more complicated than it needs to be
3075 * because radius_evaluate_map() keys off of the src
3076 * template type, instead of the operators. And, the
3077 * pass2_xlat_compile() function expects to get passed an
3078 * XLAT instead of a REGEX.
3080 if (strchr(vpt->name, '%')) {
3081 vpt->type = TMPL_TYPE_XLAT;
3082 return pass2_xlat_compile(ci, &vpt, false, NULL);
3085 slen = regex_compile(vpt, &preg, vpt->name, vpt->len,
3086 vpt->tmpl_iflag, vpt->tmpl_mflag, true, false);
3088 char *spaces, *text;
3090 fr_canonicalize_error(vpt, &spaces, &text, slen, vpt->name);
3092 cf_log_err(ci, "Invalid regular expression:");
3093 cf_log_err(ci, "%s", text);
3094 cf_log_err(ci, "%s^ %s", spaces, fr_strerror());
3096 talloc_free(spaces);
3102 vpt->type = TMPL_TYPE_REGEX_STRUCT;
3103 vpt->tmpl_preg = preg;
3109 static bool pass2_fixup_undefined(CONF_ITEM const *ci, vp_tmpl_t *vpt)
3111 DICT_ATTR const *da;
3113 rad_assert(vpt->type == TMPL_TYPE_ATTR_UNDEFINED);
3115 da = dict_attrbyname(vpt->tmpl_unknown_name);
3117 cf_log_err(ci, "Unknown attribute '%s'", vpt->tmpl_unknown_name);
3122 vpt->type = TMPL_TYPE_ATTR;
3126 static bool pass2_callback(UNUSED void *ctx, fr_cond_t *c)
3130 if (c->type == COND_TYPE_EXISTS) {
3131 if (c->data.vpt->type == TMPL_TYPE_XLAT) {
3132 return pass2_xlat_compile(c->ci, &c->data.vpt, true, NULL);
3135 rad_assert(c->data.vpt->type != TMPL_TYPE_REGEX);
3138 * The existence check might have been &Foo-Bar,
3139 * where Foo-Bar is defined by a module.
3141 if (c->pass2_fixup == PASS2_FIXUP_ATTR) {
3142 if (!pass2_fixup_undefined(c->ci, c->data.vpt)) return false;
3143 c->pass2_fixup = PASS2_FIXUP_NONE;
3149 * Maps have a paircompare fixup applied to them.
3150 * Others get ignored.
3152 if (c->pass2_fixup == PASS2_FIXUP_NONE) {
3153 if (c->type == COND_TYPE_MAP) {
3161 map = c->data.map; /* shorter */
3166 * Where "foo" is dynamically defined.
3168 if (c->pass2_fixup == PASS2_FIXUP_TYPE) {
3169 if (!dict_valbyname(map->lhs->tmpl_da->attr,
3170 map->lhs->tmpl_da->vendor,
3172 cf_log_err(map->ci, "Invalid reference to non-existent %s %s { ... }",
3173 map->lhs->tmpl_da->name,
3179 * These guys can't have a paircompare fixup applied.
3181 c->pass2_fixup = PASS2_FIXUP_NONE;
3185 if (c->pass2_fixup == PASS2_FIXUP_ATTR) {
3186 if (map->lhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3187 if (!pass2_fixup_undefined(map->ci, map->lhs)) return false;
3190 if (map->rhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3191 if (!pass2_fixup_undefined(map->ci, map->rhs)) return false;
3194 c->pass2_fixup = PASS2_FIXUP_NONE;
3199 * Just in case someone adds a new fixup later.
3201 rad_assert((c->pass2_fixup == PASS2_FIXUP_NONE) ||
3202 (c->pass2_fixup == PASS2_PAIRCOMPARE));
3207 if (map->lhs->type == TMPL_TYPE_XLAT) {
3209 * Don't compile the LHS to an attribute
3210 * reference for now. When we do that, we've got
3211 * to check the RHS for type-specific data, and
3212 * parse it to a TMPL_TYPE_DATA.
3214 if (!pass2_xlat_compile(map->ci, &map->lhs, false, NULL)) {
3219 if (map->rhs->type == TMPL_TYPE_XLAT) {
3221 * Convert the RHS to an attribute reference only
3222 * if the LHS is an attribute reference, AND is
3223 * of the same type as the RHS.
3225 * We can fix this when the code in evaluate.c
3226 * can handle strings on the LHS, and attributes
3227 * on the RHS. For now, the code in parser.c
3230 if (map->lhs->type == TMPL_TYPE_ATTR) {
3231 DICT_ATTR const *da = c->cast;
3233 if (!c->cast) da = map->lhs->tmpl_da;
3235 if (!pass2_xlat_compile(map->ci, &map->rhs, true, da)) {
3240 if (!pass2_xlat_compile(map->ci, &map->rhs, false, NULL)) {
3247 * Convert bare refs to %{Foreach-Variable-N}
3249 if ((map->lhs->type == TMPL_TYPE_LITERAL) &&
3250 (strncmp(map->lhs->name, "Foreach-Variable-", 17) == 0)) {
3255 fmt = talloc_asprintf(map->lhs, "%%{%s}", map->lhs->name);
3256 slen = tmpl_afrom_str(map, &vpt, fmt, talloc_array_length(fmt) - 1,
3257 T_DOUBLE_QUOTED_STRING, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
3259 char *spaces, *text;
3261 fr_canonicalize_error(map->ci, &spaces, &text, slen, fr_strerror());
3263 cf_log_err(map->ci, "Failed converting %s to xlat", map->lhs->name);
3264 cf_log_err(map->ci, "%s", fmt);
3265 cf_log_err(map->ci, "%s^ %s", spaces, text);
3267 talloc_free(spaces);
3273 talloc_free(map->lhs);
3278 if (map->rhs->type == TMPL_TYPE_REGEX) {
3279 if (!pass2_regex_compile(map->ci, map->rhs)) {
3283 rad_assert(map->lhs->type != TMPL_TYPE_REGEX);
3287 * Only attributes can have a paircompare registered, and
3288 * they can only be with the current REQUEST, and only
3289 * with the request pairs.
3291 if ((map->lhs->type != TMPL_TYPE_ATTR) ||
3292 (map->lhs->tmpl_request != REQUEST_CURRENT) ||
3293 (map->lhs->tmpl_list != PAIR_LIST_REQUEST)) {
3297 if (!radius_find_compare(map->lhs->tmpl_da)) return true;
3299 if (map->rhs->type == TMPL_TYPE_ATTR) {
3300 cf_log_err(map->ci, "Cannot compare virtual attribute %s to another attribute",
3305 if (map->rhs->type == TMPL_TYPE_REGEX) {
3306 cf_log_err(map->ci, "Cannot compare virtual attribute %s via a regex",
3312 cf_log_err(map->ci, "Cannot cast virtual attribute %s",
3317 if (map->op != T_OP_CMP_EQ) {
3318 cf_log_err(map->ci, "Must use '==' for comparisons with virtual attribute %s",
3324 * Mark it as requiring a paircompare() call, instead of
3327 c->pass2_fixup = PASS2_PAIRCOMPARE;
3334 * Compile the RHS of update sections to xlat_exp_t
3336 static bool modcall_pass2_update(modgroup *g)
3340 for (map = g->map; map != NULL; map = map->next) {
3341 if (map->rhs->type == TMPL_TYPE_XLAT) {
3342 rad_assert(map->rhs->tmpl_xlat == NULL);
3345 * FIXME: compile to attribute && handle
3346 * the conversion in map_to_vp().
3348 if (!pass2_xlat_compile(map->ci, &map->rhs, false, NULL)) {
3353 rad_assert(map->rhs->type != TMPL_TYPE_REGEX);
3356 * Deal with undefined attributes now.
3358 if (map->lhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3359 if (!pass2_fixup_undefined(map->ci, map->lhs)) return false;
3362 if (map->rhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3363 if (!pass2_fixup_undefined(map->ci, map->rhs)) return false;
3372 * Do a second-stage pass on compiling the modules.
3374 bool modcall_pass2(modcallable *mc)
3381 for (c = mc; c != NULL; c = c->next) {
3389 g = mod_callabletogroup(c);
3390 if (g->done_pass2) goto do_next;
3392 name2 = cf_section_name2(g->cs);
3394 c->debug_name = unlang_keyword[c->type];
3396 c->debug_name = talloc_asprintf(c, "update %s", name2);
3399 if (!modcall_pass2_update(g)) {
3402 g->done_pass2 = true;
3405 case MOD_XLAT: /* @todo: pre-parse xlat's */
3412 c->debug_name = c->name;
3413 break; /* do nothing */
3418 g = mod_callabletogroup(c);
3419 if (g->done_pass2) goto do_next;
3421 name2 = cf_section_name2(g->cs);
3422 c->debug_name = talloc_asprintf(c, "%s %s", unlang_keyword[c->type], name2);
3425 * The compilation code takes care of
3426 * simplifying 'true' and 'false'
3427 * conditions. For others, we have to do
3428 * a second pass to parse && compile
3431 if (!((g->cond->type == COND_TYPE_TRUE) ||
3432 (g->cond->type == COND_TYPE_FALSE))) {
3433 if (!fr_condition_walk(g->cond, pass2_callback, NULL)) {
3438 if (!modcall_pass2(g->children)) return false;
3439 g->done_pass2 = true;
3445 g = mod_callabletogroup(c);
3446 if (g->done_pass2) goto do_next;
3448 name2 = cf_section_name2(g->cs);
3449 c->debug_name = talloc_asprintf(c, "%s %s", unlang_keyword[c->type], name2);
3452 * We had &Foo-Bar, where Foo-Bar is
3453 * defined by a module.
3456 rad_assert(c->name != NULL);
3457 rad_assert(c->name[0] == '&');
3458 rad_assert(cf_section_name2_type(g->cs) == T_BARE_WORD);
3460 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name, strlen(c->name),
3461 cf_section_name2_type(g->cs),
3462 REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
3464 char *spaces, *text;
3467 fr_canonicalize_error(g->cs, &spaces, &text, slen, fr_strerror());
3469 cf_log_err_cs(g->cs, "Syntax error");
3470 cf_log_err_cs(g->cs, "%s", c->name);
3471 cf_log_err_cs(g->cs, "%s^ %s", spaces, text);
3473 talloc_free(spaces);
3483 * Statically compile xlats
3485 if (g->vpt->type == TMPL_TYPE_XLAT) {
3486 if (!pass2_xlat_compile(cf_section_to_item(g->cs),
3487 &g->vpt, true, NULL)) {
3495 * We may have: switch Foo-Bar {
3497 * where Foo-Bar is an attribute defined
3498 * by a module. Since there's no leading
3499 * &, it's parsed as a literal. But if
3500 * we can parse it as an attribute,
3501 * switch to using that.
3503 if (g->vpt->type == TMPL_TYPE_LITERAL) {
3506 slen = tmpl_afrom_str(g->cs, &vpt, c->name, strlen(c->name), cf_section_name2_type(g->cs),
3507 REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
3508 if (slen < 0) goto parse_error;
3509 if (vpt->type == TMPL_TYPE_ATTR) {
3510 talloc_free(g->vpt);
3518 * Warn about old-style configuration.
3520 * DEPRECATED: switch User-Name { ...
3521 * ALLOWED : switch &User-Name { ...
3523 if ((g->vpt->type == TMPL_TYPE_ATTR) &&
3524 (c->name[0] != '&')) {
3525 WARN("%s[%d]: Please change %s to &%s",
3526 cf_section_filename(g->cs),
3527 cf_section_lineno(g->cs),
3532 if (!modcall_pass2(g->children)) return false;
3533 g->done_pass2 = true;
3537 g = mod_callabletogroup(c);
3538 if (g->done_pass2) goto do_next;
3540 name2 = cf_section_name2(g->cs);
3542 c->debug_name = unlang_keyword[c->type];
3544 c->debug_name = talloc_asprintf(c, "%s %s", unlang_keyword[c->type], name2);
3547 rad_assert(c->parent != NULL);
3548 rad_assert(c->parent->type == MOD_SWITCH);
3551 * The statement may refer to an
3552 * attribute which doesn't exist until
3553 * all of the modules have been loaded.
3554 * Check for that now.
3556 if (!g->vpt && c->name &&
3557 (c->name[0] == '&') &&
3558 (cf_section_name2_type(g->cs) == T_BARE_WORD)) {
3559 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name, strlen(c->name),
3560 cf_section_name2_type(g->cs),
3561 REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
3562 if (slen < 0) goto parse_error;
3566 * We have "case {...}". There's no
3567 * argument, so we don't need to check
3570 if (!g->vpt) goto do_children;
3573 * Do type-specific checks on the case statement
3575 if (g->vpt->type == TMPL_TYPE_LITERAL) {
3578 f = mod_callabletogroup(mc->parent);
3579 rad_assert(f->vpt != NULL);
3582 * We're switching over an
3583 * attribute. Check that the
3586 if (f->vpt->type == TMPL_TYPE_ATTR) {
3587 rad_assert(f->vpt->tmpl_da != NULL);
3589 if (tmpl_cast_in_place(g->vpt, f->vpt->tmpl_da->type, f->vpt->tmpl_da) < 0) {
3590 cf_log_err_cs(g->cs, "Invalid argument for case statement: %s",
3600 * Compile and sanity check xlat
3603 if (g->vpt->type == TMPL_TYPE_XLAT) {
3606 f = mod_callabletogroup(mc->parent);
3607 rad_assert(f->vpt != NULL);
3610 * Don't expand xlat's into an
3611 * attribute of a different type.
3613 if (f->vpt->type == TMPL_TYPE_ATTR) {
3614 if (!pass2_xlat_compile(cf_section_to_item(g->cs),
3615 &g->vpt, true, f->vpt->tmpl_da)) {
3619 if (!pass2_xlat_compile(cf_section_to_item(g->cs),
3620 &g->vpt, true, NULL)) {
3626 if (!modcall_pass2(g->children)) return false;
3627 g->done_pass2 = true;
3631 g = mod_callabletogroup(c);
3632 if (g->done_pass2) goto do_next;
3634 name2 = cf_section_name2(g->cs);
3635 c->debug_name = talloc_asprintf(c, "%s %s", unlang_keyword[c->type], name2);
3638 * Already parsed, handle the children.
3640 if (g->vpt) goto check_children;
3643 * We had &Foo-Bar, where Foo-Bar is
3644 * defined by a module.
3646 rad_assert(c->name != NULL);
3647 rad_assert(c->name[0] == '&');
3648 rad_assert(cf_section_name2_type(g->cs) == T_BARE_WORD);
3651 * The statement may refer to an
3652 * attribute which doesn't exist until
3653 * all of the modules have been loaded.
3654 * Check for that now.
3656 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name, strlen(c->name), cf_section_name2_type(g->cs),
3657 REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
3658 if (slen < 0) goto parse_error;
3661 rad_assert((g->vpt->type == TMPL_TYPE_ATTR) || (g->vpt->type == TMPL_TYPE_LIST));
3662 if (g->vpt->tmpl_num != NUM_ALL) {
3663 cf_log_err_cs(g->cs, "MUST NOT use instance selectors in 'foreach'");
3666 if (!modcall_pass2(g->children)) return false;
3667 g->done_pass2 = true;
3671 c->debug_name = unlang_keyword[c->type];
3675 g = mod_callabletogroup(c);
3676 c->debug_name = talloc_asprintf(c, "%s %s", unlang_keyword[c->type], cf_section_name1(g->cs));
3681 case MOD_LOAD_BALANCE:
3682 case MOD_REDUNDANT_LOAD_BALANCE:
3683 c->debug_name = unlang_keyword[c->type];
3688 g = mod_callabletogroup(c);
3690 c->debug_name = mc->name; /* for authorize, etc. */
3692 } else if (c->type == MOD_GROUP) { /* for Auth-Type, etc. */
3693 char const *name1 = cf_section_name1(g->cs);
3695 if (strcmp(name1, unlang_keyword[c->type]) != 0) {
3696 c->debug_name = talloc_asprintf(c, "%s %s", name1, cf_section_name2(g->cs));
3700 if (g->done_pass2) goto do_next;
3701 if (!modcall_pass2(g->children)) return false;
3702 g->done_pass2 = true;
3707 rad_assert(c->debug_name != NULL);
3713 void modcall_debug(modcallable *mc, int depth)
3720 for (this = mc; this != NULL; this = this->next) {
3721 switch (this->type) {
3726 modsingle *single = mod_callabletosingle(this);
3728 DEBUG("%.*s%s", depth, modcall_spaces,
3729 single->modinst->name);
3735 g = mod_callabletogroup(this);
3736 DEBUG("%.*s%s {", depth, modcall_spaces,
3737 unlang_keyword[this->type]);
3739 for (map = g->map; map != NULL; map = map->next) {
3740 map_prints(buffer, sizeof(buffer), map);
3741 DEBUG("%.*s%s", depth + 1, modcall_spaces, buffer);
3744 DEBUG("%.*s}", depth, modcall_spaces);
3748 g = mod_callabletogroup(this);
3749 DEBUG("%.*s%s {", depth, modcall_spaces,
3750 unlang_keyword[this->type]);
3751 modcall_debug(g->children, depth + 1);
3752 DEBUG("%.*s}", depth, modcall_spaces);
3757 g = mod_callabletogroup(this);
3758 fr_cond_sprint(buffer, sizeof(buffer), g->cond);
3759 DEBUG("%.*s%s (%s) {", depth, modcall_spaces,
3760 unlang_keyword[this->type], buffer);
3761 modcall_debug(g->children, depth + 1);
3762 DEBUG("%.*s}", depth, modcall_spaces);
3767 g = mod_callabletogroup(this);
3768 tmpl_prints(buffer, sizeof(buffer), g->vpt, NULL);
3769 DEBUG("%.*s%s %s {", depth, modcall_spaces,
3770 unlang_keyword[this->type], buffer);
3771 modcall_debug(g->children, depth + 1);
3772 DEBUG("%.*s}", depth, modcall_spaces);
3777 g = mod_callabletogroup(this);
3778 DEBUG("%.*s%s %s {", depth, modcall_spaces,
3779 unlang_keyword[this->type], this->name);
3780 modcall_debug(g->children, depth + 1);
3781 DEBUG("%.*s}", depth, modcall_spaces);
3785 DEBUG("%.*sbreak", depth, modcall_spaces);
3790 g = mod_callabletogroup(this);
3791 DEBUG("%.*s%s {", depth, modcall_spaces,
3792 unlang_keyword[this->type]);
3793 modcall_debug(g->children, depth + 1);
3794 DEBUG("%.*s}", depth, modcall_spaces);
3798 case MOD_LOAD_BALANCE:
3799 case MOD_REDUNDANT_LOAD_BALANCE:
3800 g = mod_callabletogroup(this);
3801 DEBUG("%.*s%s {", depth, modcall_spaces,
3802 unlang_keyword[this->type]);
3803 modcall_debug(g->children, depth + 1);
3804 DEBUG("%.*s}", depth, modcall_spaces);