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 */
73 } grouptype; /* after mc */
74 modcallable *children;
75 modcallable *tail; /* of the children list */
77 value_pair_map_t *map; /* update */
78 value_pair_tmpl_t *vpt; /* switch */
79 fr_cond_t *cond; /* if/elsif */
85 module_instance_t *modinst;
100 /* Simple conversions: modsingle and modgroup are subclasses of modcallable,
101 * so we often want to go back and forth between them. */
102 static modsingle *mod_callabletosingle(modcallable *p)
104 rad_assert(p->type==MOD_SINGLE);
105 return (modsingle *)p;
107 static modgroup *mod_callabletogroup(modcallable *p)
109 rad_assert((p->type > MOD_SINGLE) && (p->type <= MOD_POLICY));
111 return (modgroup *)p;
113 static modcallable *mod_singletocallable(modsingle *p)
115 return (modcallable *)p;
117 static modcallable *mod_grouptocallable(modgroup *p)
119 return (modcallable *)p;
122 static modref *mod_callabletoref(modcallable *p)
124 rad_assert(p->type==MOD_REFERENCE);
127 static modcallable *mod_reftocallable(modref *p)
129 return (modcallable *)p;
132 static modxlat *mod_callabletoxlat(modcallable *p)
134 rad_assert(p->type==MOD_XLAT);
137 static modcallable *mod_xlattocallable(modxlat *p)
139 return (modcallable *)p;
142 /* modgroups are grown by adding a modcallable to the end */
143 static void add_child(modgroup *g, modcallable *c)
147 (void) talloc_steal(g, c);
150 g->children = g->tail = c;
152 rad_assert(g->tail->next == NULL);
157 c->parent = mod_grouptocallable(g);
160 /* Here's where we recognize all of our keywords: first the rcodes, then the
162 const FR_NAME_NUMBER mod_rcode_table[] = {
163 { "reject", RLM_MODULE_REJECT },
164 { "fail", RLM_MODULE_FAIL },
165 { "ok", RLM_MODULE_OK },
166 { "handled", RLM_MODULE_HANDLED },
167 { "invalid", RLM_MODULE_INVALID },
168 { "userlock", RLM_MODULE_USERLOCK },
169 { "notfound", RLM_MODULE_NOTFOUND },
170 { "noop", RLM_MODULE_NOOP },
171 { "updated", RLM_MODULE_UPDATED },
176 static char const *group_name[];
179 * Compile action && rcode for later use.
181 static int compile_action(modcallable *c, CONF_PAIR *cp)
184 char const *attr, *value;
186 attr = cf_pair_attr(cp);
187 value = cf_pair_value(cp);
188 if (!value) return 0;
190 if (c->type != MOD_SINGLE) {
191 ERROR("%s[%d] Invalid return code assigment inside of a %s section",
192 cf_pair_filename(cp), cf_pair_lineno(cp), group_name[c->type]);
196 if (!strcasecmp(value, "return"))
197 action = MOD_ACTION_RETURN;
199 else if (!strcasecmp(value, "break"))
200 action = MOD_ACTION_RETURN;
202 else if (!strcasecmp(value, "reject"))
203 action = MOD_ACTION_REJECT;
205 else if (strspn(value, "0123456789")==strlen(value)) {
206 action = atoi(value);
209 * Don't allow priority zero, for future use.
211 if (action == 0) return 0;
213 cf_log_err_cp(cp, "Unknown action '%s'.\n",
218 if (strcasecmp(attr, "default") != 0) {
221 rcode = fr_str2int(mod_rcode_table, attr, -1);
224 "Unknown module rcode '%s'.\n",
228 c->actions[rcode] = action;
230 } else { /* set all unset values to the default */
233 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
234 if (!c->actions[i]) c->actions[i] = action;
241 /* Some short names for debugging output */
242 static char const * const comp2str[] = {
258 #ifdef HAVE_PTHREAD_H
260 * Lock the mutex for the module
262 static void safe_lock(module_instance_t *instance)
265 pthread_mutex_lock(instance->mutex);
269 * Unlock the mutex for the module
271 static void safe_unlock(module_instance_t *instance)
274 pthread_mutex_unlock(instance->mutex);
278 * No threads: these functions become NULL's.
280 #define safe_lock(foo)
281 #define safe_unlock(foo)
284 static rlm_rcode_t CC_HINT(nonnull) call_modsingle(rlm_components_t component, modsingle *sp, REQUEST *request)
287 int indent = request->log.indent;
290 * If the request should stop, refuse to do anything.
292 blocked = (request->master_state == REQUEST_STOP_PROCESSING);
293 if (blocked) return RLM_MODULE_NOOP;
295 RDEBUG3("modsingle[%s]: calling %s (%s) for request %d",
296 comp2str[component], sp->modinst->name,
297 sp->modinst->entry->name, request->number);
298 request->log.indent = 0;
300 if (sp->modinst->force) {
301 request->rcode = sp->modinst->code;
306 * For logging unresponsive children.
308 request->module = sp->modinst->name;
310 safe_lock(sp->modinst);
311 request->rcode = sp->modinst->entry->module->methods[component](sp->modinst->insthandle, request);
312 safe_unlock(sp->modinst);
314 request->module = "";
317 * Wasn't blocked, and now is. Complain!
319 blocked = (request->master_state == REQUEST_STOP_PROCESSING);
321 RWARN("Module %s became unblocked for request %u", sp->modinst->entry->name, request->number);
325 request->log.indent = indent;
326 RDEBUG3("modsingle[%s]: returned from %s (%s) for request %d",
327 comp2str[component], sp->modinst->name,
328 sp->modinst->entry->name, request->number);
330 return request->rcode;
333 static int default_component_results[RLM_COMPONENT_COUNT] = {
334 RLM_MODULE_REJECT, /* AUTH */
335 RLM_MODULE_NOTFOUND, /* AUTZ */
336 RLM_MODULE_NOOP, /* PREACCT */
337 RLM_MODULE_NOOP, /* ACCT */
338 RLM_MODULE_FAIL, /* SESS */
339 RLM_MODULE_NOOP, /* PRE_PROXY */
340 RLM_MODULE_NOOP, /* POST_PROXY */
341 RLM_MODULE_NOOP /* POST_AUTH */
344 RLM_MODULE_NOOP, /* RECV_COA_TYPE */
345 RLM_MODULE_NOOP /* SEND_COA_TYPE */
350 static char const *group_name[] = {
354 "load-balance group",
355 "redundant-load-balance group",
372 static char const modcall_spaces[] = " ";
374 #define MODCALL_STACK_MAX (32)
377 * Don't call the modules recursively. Instead, do them
378 * iteratively, and manage the call stack ourselves.
380 typedef struct modcall_stack_entry_t {
383 int unwind; /* unwind to this one if it exists */
385 } modcall_stack_entry_t;
388 static bool modcall_recurse(REQUEST *request, rlm_components_t component, int depth,
389 modcall_stack_entry_t *entry);
392 * Call a child of a block.
394 static void modcall_child(REQUEST *request, rlm_components_t component, int depth,
395 modcall_stack_entry_t *entry, modcallable *c,
398 modcall_stack_entry_t *next;
400 if (depth >= MODCALL_STACK_MAX) {
401 ERROR("Internal sanity check failed: module stack is too deep");
406 * Initialize the childs stack frame.
410 next->result = entry->result;
414 if (!modcall_recurse(request, component,
416 *result = RLM_MODULE_FAIL;
421 * Unwind back up the stack
423 if (next->unwind != 0) {
424 entry->unwind = next->unwind;
427 *result = next->result;
434 * Interpret the various types of blocks.
436 static bool modcall_recurse(REQUEST *request, rlm_components_t component, int depth,
437 modcall_stack_entry_t *entry)
439 bool if_taken, was_if;
444 was_if = if_taken = false;
445 result = RLM_MODULE_UNKNOWN;
453 * Nothing more to do. Return the code and priority
454 * which was set by the caller.
459 * We've been asked to stop. Do so.
461 if ((request->master_state == REQUEST_STOP_PROCESSING) ||
463 (request->parent->master_state == REQUEST_STOP_PROCESSING))) {
464 entry->result = RLM_MODULE_FAIL;
465 entry->priority = 9999;
471 * Handle "if" conditions.
473 if (c->type == MOD_IF) {
478 g = mod_callabletogroup(c);
479 rad_assert(g->cond != NULL);
481 RDEBUG2("%s %s{", group_name[c->type], c->name);
483 condition = radius_evaluate_cond(request, result, 0, g->cond);
486 REDEBUG("Failed retrieving values required to evaluate condition");
488 RDEBUG2("%s %s -> %s",
490 c->name, condition ? "TRUE" : "FALSE");
494 * Didn't pass. Remember that.
503 * We took the "if". Go recurse into its' children.
511 * "else" if the previous "if" was taken.
512 * "if" if the previous if wasn't taken.
514 if (c->type == MOD_ELSIF) {
515 if (!was_if) goto elsif_error;
518 * Like MOD_ELSE, but allow for a later "else"
521 RDEBUG2("... skipping %s for request %d: Preceding \"if\" was taken",
522 group_name[c->type], request->number);
529 * Check the "if" condition.
535 * "else" for a preceding "if".
537 if (c->type == MOD_ELSE) {
538 if (!was_if) { /* error */
540 RDEBUG2("... skipping %s for request %d: No preceding \"if\"",
541 group_name[c->type], request->number);
546 RDEBUG2("... skipping %s for request %d: Preceding \"if\" was taken",
547 group_name[c->type], request->number);
554 * We need to process it. Go do that.
562 * We're no longer processing if/else/elsif. Reset the
563 * trackers for those conditions.
567 #endif /* WITH_UNLANG */
569 if (c->type == MOD_SINGLE) {
573 * Process a stand-alone child, and fall through
574 * to dealing with it's parent.
576 sp = mod_callabletosingle(c);
578 result = call_modsingle(c->method, sp, request);
579 RDEBUG2("[%s] = %s", c->name ? c->name : "",
580 fr_int2str(mod_rcode_table, result, "<invalid>"));
581 goto calculate_result;
586 * Update attribute(s)
588 if (c->type == MOD_UPDATE) {
590 modgroup *g = mod_callabletogroup(c);
591 value_pair_map_t *map;
595 for (map = g->map; map != NULL; map = map->next) {
596 rcode = map_to_request(request, map, map_to_vp, NULL);
598 result = (rcode == -2) ? RLM_MODULE_INVALID : RLM_MODULE_FAIL;
601 goto calculate_result;
605 result = RLM_MODULE_NOOP;
607 goto calculate_result;
611 * Loop over a set of attributes.
613 if (c->type == MOD_FOREACH) {
614 int i, foreach_depth = -1;
615 VALUE_PAIR *vps, *vp;
616 modcall_stack_entry_t *next = NULL;
618 modgroup *g = mod_callabletogroup(c);
620 if (depth >= MODCALL_STACK_MAX) {
621 ERROR("Internal sanity check failed: module stack is too deep");
626 * Figure out how deep we are in nesting by looking at request_data
629 for (i = 0; i < 8; i++) {
630 if (!request_data_reference(request,
637 if (foreach_depth < 0) {
638 REDEBUG("foreach Nesting too deep!");
639 result = RLM_MODULE_FAIL;
640 goto calculate_result;
644 * Copy the VPs from the original request, this ensures deterministic
645 * behaviour if someone decides to add or remove VPs in the set were
648 if (tmpl_copy_vps(request, &vps, request, g->vpt) < 0) { /* nothing to loop over */
650 result = RLM_MODULE_NOOP;
652 goto calculate_result;
655 rad_assert(vps != NULL);
656 fr_cursor_init(©, &vps);
658 RDEBUG2("foreach %s ", c->name);
661 * This is the actual body of the foreach loop
663 for (vp = fr_cursor_first(©);
665 vp = fr_cursor_next(©)) {
667 if (fr_debug_flag >= 2) {
670 vp_prints_value(buffer, sizeof(buffer), vp, '"');
671 RDEBUG2("# Foreach-Variable-%d = %s", foreach_depth, buffer);
676 * Add the vp to the request, so that
677 * xlat.c, xlat_foreach() can find it.
679 request_data_add(request, radius_get_vp, foreach_depth, &vp, false);
682 * Initialize the childs stack frame.
685 next->c = g->children;
686 next->result = entry->result;
690 if (!modcall_recurse(request, component, depth + 1, next)) {
695 * We've unwound to the enclosing
696 * "foreach". Stop the unwinding.
698 if (next->unwind == MOD_FOREACH) {
703 * Unwind all the way.
705 if (next->unwind == MOD_RETURN) {
706 entry->unwind = MOD_RETURN;
709 } /* loop over VPs */
712 * Free the copied vps and the request data
713 * If we don't remove the request data, something could call
714 * the xlat outside of a foreach loop and trigger a segv.
717 request_data_get(request, radius_get_vp, foreach_depth);
719 rad_assert(next != NULL);
720 result = next->result;
721 priority = next->priority;
723 goto calculate_result;
727 * Break out of a "foreach" loop, or return from a nested
730 if ((c->type == MOD_BREAK) || (c->type == MOD_RETURN)) {
734 RDEBUG2("%s", group_name[c->type]);
736 for (i = 8; i >= 0; i--) {
737 copy_p = request_data_get(request, radius_get_vp, i);
739 if (c->type == MOD_BREAK) {
740 RDEBUG2("# break Foreach-Variable-%d", i);
747 * Leave result / priority on the stack, and stop processing the section.
749 entry->unwind = c->type;
753 #endif /* WITH_UNLANG */
756 * Child is a group that has children of it's own.
758 if ((c->type == MOD_GROUP) || (c->type == MOD_POLICY)
760 || (c->type == MOD_CASE)
768 g = mod_callabletogroup(c);
771 * This should really have been caught in the
772 * compiler, and the node never generated. But
773 * doing that requires changing it's API so that
774 * it returns a flag instead of the compiled
778 RDEBUG2("%s { ... } # empty sub-section is ignored", c->name);
783 modcall_child(request, component,
784 depth + 1, entry, g->children,
787 goto calculate_result;
791 if (c->type == MOD_SWITCH) {
792 modcallable *this, *found, *null_case;
795 value_pair_map_t map;
796 value_pair_tmpl_t vpt;
797 char *expanded = NULL;
802 g = mod_callabletogroup(c);
804 memset(&cond, 0, sizeof(cond));
805 memset(&map, 0, sizeof(map));
807 cond.type = COND_TYPE_MAP;
808 cond.data.map = ↦
810 map.op = T_OP_CMP_EQ;
811 map.ci = cf_sectiontoitem(g->cs);
813 rad_assert(g->vpt != NULL);
815 null_case = found = NULL;
818 * The attribute doesn't exist. We can skip
819 * directly to the default 'case' statement.
821 if ((g->vpt->type == TMPL_TYPE_ATTR) && (tmpl_find_vp(NULL, request, g->vpt) < 0)) {
823 for (this = g->children; this; this = this->next) {
824 rad_assert(this->type == MOD_CASE);
826 h = mod_callabletogroup(this);
827 if (h->vpt) continue;
837 * Expand the template if necessary, so that it
838 * is evaluated once instead of for each 'case'
841 if ((g->vpt->type == TMPL_TYPE_XLAT_STRUCT) ||
842 (g->vpt->type == TMPL_TYPE_XLAT) ||
843 (g->vpt->type == TMPL_TYPE_EXEC)) {
844 if (radius_expand_tmpl(&expanded, request, g->vpt) < 0) goto find_null_case;
845 tmpl_init(&vpt, TMPL_TYPE_LITERAL, expanded, talloc_array_length(expanded) - 1);
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,
910 talloc_free(expanded);
912 if (!found) found = null_case;
915 modcall_child(request, component, depth + 1, entry, found, &result);
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) {
946 if (c->type == MOD_LOAD_BALANCE) {
947 modcall_child(request, component,
948 depth + 1, entry, found,
955 modcall_child(request, component,
956 depth + 1, entry, this,
958 if (this->actions[result] == MOD_ACTION_RETURN) {
964 if (!this) this = g->children;
965 } while (this != found);
968 goto calculate_result;
969 } /* MOD_LOAD_BALANCE */
972 * Reference another virtual server.
974 * This should really be deleted, and replaced with a
975 * more abstracted / functional version.
977 if (c->type == MOD_REFERENCE) {
978 modref *mr = mod_callabletoref(c);
979 char const *server = request->server;
981 if (server == mr->ref_name) {
982 RWDEBUG("Suppressing recursive call to server %s", server);
986 request->server = mr->ref_name;
987 RDEBUG("server %s { # nested call", mr->ref_name);
988 result = indexed_modcall(component, 0, request);
989 RDEBUG("} # server %s with nested call", mr->ref_name);
990 request->server = server;
991 goto calculate_result;
992 } /* MOD_REFERENCE */
995 * xlat a string without doing anything else
997 * This should really be deleted, and replaced with a
998 * more abstracted / functional version.
1000 if (c->type == MOD_XLAT) {
1001 modxlat *mx = mod_callabletoxlat(c);
1005 radius_xlat(buffer, sizeof(buffer), request, mx->xlat_name, NULL, NULL);
1007 RDEBUG("`%s`", mx->xlat_name);
1008 radius_exec_program(NULL, 0, NULL, request, mx->xlat_name, request->packet->vps,
1009 false, true, EXEC_TIMEOUT);
1016 * Add new module types here.
1021 RDEBUG("(%s, %d) ? (%s, %d)",
1022 fr_int2str(mod_rcode_table, result, "<invalid>"),
1024 fr_int2str(mod_rcode_table, entry->result, "<invalid>"),
1029 rad_assert(result != RLM_MODULE_UNKNOWN);
1032 * The child's action says return. Do so.
1034 if ((c->actions[result] == MOD_ACTION_RETURN) &&
1036 entry->result = result;
1041 * If "reject", break out of the loop and return
1044 if (c->actions[result] == MOD_ACTION_REJECT) {
1045 entry->result = RLM_MODULE_REJECT;
1050 * The array holds a default priority for this return
1051 * code. Grab it in preference to any unset priority.
1054 priority = c->actions[result];
1058 * We're higher than any previous priority, remember this
1059 * return code and priority.
1061 if (priority > entry->priority) {
1062 entry->result = result;
1063 entry->priority = priority;
1068 * If we're processing a "case" statement, we return once
1069 * it's done, rather than going to the next "case" statement.
1071 if (c->type == MOD_CASE) goto finish;
1075 * If we've been told to stop processing
1078 if (entry->unwind == MOD_BREAK) {
1079 RDEBUG2("# unwind to enclosing foreach");
1084 if (entry->unwind == MOD_RETURN) {
1089 entry->c = entry->c->next;
1091 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])) {
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 group_name[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{} and
1187 * append{} are based on my guesses of what they will be used for. --Pac. */
1189 defaultactions[RLM_COMPONENT_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 */
1219 MOD_ACTION_RETURN, /* reject */
1221 MOD_ACTION_RETURN, /* ok */
1222 MOD_ACTION_RETURN, /* handled */
1223 MOD_ACTION_RETURN, /* invalid */
1224 MOD_ACTION_RETURN, /* userlock */
1226 MOD_ACTION_RETURN, /* noop */
1227 MOD_ACTION_RETURN /* updated */
1234 MOD_ACTION_RETURN, /* reject */
1235 MOD_ACTION_RETURN, /* fail */
1237 MOD_ACTION_RETURN, /* handled */
1238 MOD_ACTION_RETURN, /* invalid */
1239 MOD_ACTION_RETURN, /* userlock */
1246 MOD_ACTION_RETURN, /* reject */
1248 MOD_ACTION_RETURN, /* ok */
1249 MOD_ACTION_RETURN, /* handled */
1250 MOD_ACTION_RETURN, /* invalid */
1251 MOD_ACTION_RETURN, /* userlock */
1252 MOD_ACTION_RETURN, /* notfound */
1253 MOD_ACTION_RETURN, /* noop */
1254 MOD_ACTION_RETURN /* updated */
1258 MOD_ACTION_RETURN, /* reject */
1260 MOD_ACTION_RETURN, /* ok */
1261 MOD_ACTION_RETURN, /* handled */
1262 MOD_ACTION_RETURN, /* invalid */
1263 MOD_ACTION_RETURN, /* userlock */
1265 MOD_ACTION_RETURN, /* noop */
1266 MOD_ACTION_RETURN /* updated */
1273 MOD_ACTION_RETURN, /* reject */
1274 MOD_ACTION_RETURN, /* fail */
1276 MOD_ACTION_RETURN, /* handled */
1277 MOD_ACTION_RETURN, /* invalid */
1278 MOD_ACTION_RETURN, /* userlock */
1279 MOD_ACTION_RETURN, /* notfound */
1285 MOD_ACTION_RETURN, /* reject */
1287 MOD_ACTION_RETURN, /* ok */
1288 MOD_ACTION_RETURN, /* handled */
1289 MOD_ACTION_RETURN, /* invalid */
1290 MOD_ACTION_RETURN, /* userlock */
1291 MOD_ACTION_RETURN, /* notfound */
1292 MOD_ACTION_RETURN, /* noop */
1293 MOD_ACTION_RETURN /* updated */
1297 MOD_ACTION_RETURN, /* reject */
1299 MOD_ACTION_RETURN, /* ok */
1300 MOD_ACTION_RETURN, /* handled */
1301 MOD_ACTION_RETURN, /* invalid */
1302 MOD_ACTION_RETURN, /* userlock */
1304 MOD_ACTION_RETURN, /* noop */
1305 MOD_ACTION_RETURN /* updated */
1312 MOD_ACTION_RETURN, /* reject */
1313 MOD_ACTION_RETURN, /* fail */
1315 MOD_ACTION_RETURN, /* handled */
1316 MOD_ACTION_RETURN, /* invalid */
1317 MOD_ACTION_RETURN, /* userlock */
1318 MOD_ACTION_RETURN, /* notfound */
1326 MOD_ACTION_RETURN, /* ok */
1327 MOD_ACTION_RETURN, /* handled */
1336 MOD_ACTION_RETURN, /* reject */
1338 MOD_ACTION_RETURN, /* ok */
1339 MOD_ACTION_RETURN, /* handled */
1340 MOD_ACTION_RETURN, /* invalid */
1341 MOD_ACTION_RETURN, /* userlock */
1343 MOD_ACTION_RETURN, /* noop */
1344 MOD_ACTION_RETURN /* updated */
1351 MOD_ACTION_RETURN, /* reject */
1353 MOD_ACTION_RETURN, /* ok */
1354 MOD_ACTION_RETURN, /* handled */
1355 MOD_ACTION_RETURN, /* invalid */
1356 MOD_ACTION_RETURN, /* userlock */
1357 MOD_ACTION_RETURN, /* notfound */
1358 MOD_ACTION_RETURN, /* noop */
1359 MOD_ACTION_RETURN /* updated */
1363 MOD_ACTION_RETURN, /* reject */
1365 MOD_ACTION_RETURN, /* ok */
1366 MOD_ACTION_RETURN, /* handled */
1367 MOD_ACTION_RETURN, /* invalid */
1368 MOD_ACTION_RETURN, /* userlock */
1369 MOD_ACTION_RETURN, /* notfound */
1370 MOD_ACTION_RETURN, /* noop */
1371 MOD_ACTION_RETURN /* updated */
1375 MOD_ACTION_RETURN, /* reject */
1377 MOD_ACTION_RETURN, /* ok */
1378 MOD_ACTION_RETURN, /* handled */
1379 MOD_ACTION_RETURN, /* invalid */
1380 MOD_ACTION_RETURN, /* userlock */
1381 MOD_ACTION_RETURN, /* notfound */
1382 MOD_ACTION_RETURN, /* noop */
1383 MOD_ACTION_RETURN /* updated */
1390 MOD_ACTION_RETURN, /* reject */
1391 MOD_ACTION_RETURN, /* fail */
1393 MOD_ACTION_RETURN, /* handled */
1394 MOD_ACTION_RETURN, /* invalid */
1395 MOD_ACTION_RETURN, /* userlock */
1402 MOD_ACTION_RETURN, /* reject */
1404 MOD_ACTION_RETURN, /* ok */
1405 MOD_ACTION_RETURN, /* handled */
1406 MOD_ACTION_RETURN, /* invalid */
1407 MOD_ACTION_RETURN, /* userlock */
1408 MOD_ACTION_RETURN, /* notfound */
1409 MOD_ACTION_RETURN, /* noop */
1410 MOD_ACTION_RETURN /* updated */
1414 MOD_ACTION_RETURN, /* reject */
1416 MOD_ACTION_RETURN, /* ok */
1417 MOD_ACTION_RETURN, /* handled */
1418 MOD_ACTION_RETURN, /* invalid */
1419 MOD_ACTION_RETURN, /* userlock */
1421 MOD_ACTION_RETURN, /* noop */
1422 MOD_ACTION_RETURN /* updated */
1429 MOD_ACTION_RETURN, /* reject */
1430 MOD_ACTION_RETURN, /* fail */
1432 MOD_ACTION_RETURN, /* handled */
1433 MOD_ACTION_RETURN, /* invalid */
1434 MOD_ACTION_RETURN, /* userlock */
1441 MOD_ACTION_RETURN, /* reject */
1443 MOD_ACTION_RETURN, /* ok */
1444 MOD_ACTION_RETURN, /* handled */
1445 MOD_ACTION_RETURN, /* invalid */
1446 MOD_ACTION_RETURN, /* userlock */
1447 MOD_ACTION_RETURN, /* notfound */
1448 MOD_ACTION_RETURN, /* noop */
1449 MOD_ACTION_RETURN /* updated */
1453 MOD_ACTION_RETURN, /* reject */
1455 MOD_ACTION_RETURN, /* ok */
1456 MOD_ACTION_RETURN, /* handled */
1457 MOD_ACTION_RETURN, /* invalid */
1458 MOD_ACTION_RETURN, /* userlock */
1460 MOD_ACTION_RETURN, /* noop */
1461 MOD_ACTION_RETURN /* updated */
1468 MOD_ACTION_RETURN, /* reject */
1469 MOD_ACTION_RETURN, /* fail */
1471 MOD_ACTION_RETURN, /* handled */
1472 MOD_ACTION_RETURN, /* invalid */
1473 MOD_ACTION_RETURN, /* userlock */
1480 MOD_ACTION_RETURN, /* reject */
1482 MOD_ACTION_RETURN, /* ok */
1483 MOD_ACTION_RETURN, /* handled */
1484 MOD_ACTION_RETURN, /* invalid */
1485 MOD_ACTION_RETURN, /* userlock */
1486 MOD_ACTION_RETURN, /* notfound */
1487 MOD_ACTION_RETURN, /* noop */
1488 MOD_ACTION_RETURN /* updated */
1492 MOD_ACTION_RETURN, /* reject */
1494 MOD_ACTION_RETURN, /* ok */
1495 MOD_ACTION_RETURN, /* handled */
1496 MOD_ACTION_RETURN, /* invalid */
1497 MOD_ACTION_RETURN, /* userlock */
1499 MOD_ACTION_RETURN, /* noop */
1500 MOD_ACTION_RETURN /* updated */
1509 MOD_ACTION_RETURN, /* reject */
1510 MOD_ACTION_RETURN, /* fail */
1512 MOD_ACTION_RETURN, /* handled */
1513 MOD_ACTION_RETURN, /* invalid */
1514 MOD_ACTION_RETURN, /* userlock */
1521 MOD_ACTION_RETURN, /* reject */
1523 MOD_ACTION_RETURN, /* ok */
1524 MOD_ACTION_RETURN, /* handled */
1525 MOD_ACTION_RETURN, /* invalid */
1526 MOD_ACTION_RETURN, /* userlock */
1527 MOD_ACTION_RETURN, /* notfound */
1528 MOD_ACTION_RETURN, /* noop */
1529 MOD_ACTION_RETURN /* updated */
1533 MOD_ACTION_RETURN, /* reject */
1535 MOD_ACTION_RETURN, /* ok */
1536 MOD_ACTION_RETURN, /* handled */
1537 MOD_ACTION_RETURN, /* invalid */
1538 MOD_ACTION_RETURN, /* userlock */
1540 MOD_ACTION_RETURN, /* noop */
1541 MOD_ACTION_RETURN /* updated */
1548 MOD_ACTION_RETURN, /* reject */
1549 MOD_ACTION_RETURN, /* fail */
1551 MOD_ACTION_RETURN, /* handled */
1552 MOD_ACTION_RETURN, /* invalid */
1553 MOD_ACTION_RETURN, /* userlock */
1560 MOD_ACTION_RETURN, /* reject */
1562 MOD_ACTION_RETURN, /* ok */
1563 MOD_ACTION_RETURN, /* handled */
1564 MOD_ACTION_RETURN, /* invalid */
1565 MOD_ACTION_RETURN, /* userlock */
1566 MOD_ACTION_RETURN, /* notfound */
1567 MOD_ACTION_RETURN, /* noop */
1568 MOD_ACTION_RETURN /* updated */
1572 MOD_ACTION_RETURN, /* reject */
1574 MOD_ACTION_RETURN, /* ok */
1575 MOD_ACTION_RETURN, /* handled */
1576 MOD_ACTION_RETURN, /* invalid */
1577 MOD_ACTION_RETURN, /* userlock */
1579 MOD_ACTION_RETURN, /* noop */
1580 MOD_ACTION_RETURN /* updated */
1586 /** Validate and fixup a map that's part of an update section.
1588 * @param map to validate.
1589 * @param ctx data to pass to fixup function (currently unused).
1590 * @return 0 if valid else -1.
1592 int modcall_fixup_update(value_pair_map_t *map, UNUSED void *ctx)
1594 CONF_PAIR *cp = cf_itemtopair(map->ci);
1597 * Anal-retentive checks.
1599 if (DEBUG_ENABLED2) {
1600 if ((map->lhs->type == TMPL_TYPE_ATTR) && (map->lhs->name[0] != '&')) {
1601 WARN("%s[%d]: Please change attribute reference to '&%s %s ...'",
1602 cf_pair_filename(cp), cf_pair_lineno(cp),
1603 map->lhs->name, fr_int2str(fr_tokens, map->op, "<INVALID>"));
1606 if ((map->rhs->type == TMPL_TYPE_ATTR) && (map->rhs->name[0] != '&')) {
1607 WARN("%s[%d]: Please change attribute reference to '... %s &%s'",
1608 cf_pair_filename(cp), cf_pair_lineno(cp),
1609 fr_int2str(fr_tokens, map->op, "<INVALID>"), map->rhs->name);
1614 * Values used by unary operators should be literal ANY
1616 * We then free the template and alloc a NULL one instead.
1618 if (map->op == T_OP_CMP_FALSE) {
1619 if ((map->rhs->type != TMPL_TYPE_LITERAL) || (strcmp(map->rhs->name, "ANY") != 0)) {
1620 WARN("%s[%d] Wildcard deletion MUST use '!* ANY'",
1621 cf_pair_filename(cp), cf_pair_lineno(cp));
1624 tmpl_free(&map->rhs);
1626 map->rhs = tmpl_alloc(map, TMPL_TYPE_NULL, NULL, 0);
1630 * Lots of sanity checks for insane people...
1634 * We don't support implicit type conversion,
1635 * except for "octets"
1637 if (((map->lhs->type == TMPL_TYPE_ATTR) || (map->lhs->type == TMPL_TYPE_DATA)) &&
1638 ((map->rhs->type == TMPL_TYPE_ATTR) || (map->rhs->type == TMPL_TYPE_DATA))) {
1642 switch (map->lhs->type) {
1643 case TMPL_TYPE_ATTR:
1644 lhs_type = map->lhs->tmpl_da->type;
1647 case TMPL_TYPE_DATA:
1648 lhs_type = map->lhs->tmpl_data_type;
1656 switch (map->rhs->type) {
1657 case TMPL_TYPE_ATTR:
1658 rhs_type = map->rhs->tmpl_da->type;
1661 case TMPL_TYPE_DATA:
1662 rhs_type = map->rhs->tmpl_data_type;
1671 if ((lhs_type != rhs_type) &&
1672 (lhs_type != PW_TYPE_OCTETS) &&
1673 (rhs_type != PW_TYPE_OCTETS)) {
1674 cf_log_err(map->ci, "Attribute type mismatch");
1680 * What exactly where you expecting to happen here?
1682 if ((map->lhs->type == TMPL_TYPE_ATTR) &&
1683 (map->rhs->type == TMPL_TYPE_LIST)) {
1684 cf_log_err(map->ci, "Can't copy list into an attribute");
1689 * Depending on the attribute type, some operators are disallowed.
1691 if (map->lhs->type == TMPL_TYPE_ATTR) {
1694 cf_log_err(map->ci, "Invalid operator for attribute");
1703 case T_OP_CMP_FALSE:
1709 if (map->lhs->type == TMPL_TYPE_LIST) {
1711 * Can't copy an xlat expansion or literal into a list,
1712 * we don't know what type of attribute we'd need
1715 * The only exception is where were using a unary
1718 if (map->op != T_OP_CMP_FALSE) switch (map->rhs->type) {
1719 case TMPL_TYPE_XLAT:
1720 case TMPL_TYPE_LITERAL:
1721 cf_log_err(map->ci, "Can't copy value into list (we don't know which attribute to create)");
1729 * Only += and :=, and !* operators are supported
1733 case T_OP_CMP_FALSE:
1737 if ((map->rhs->type != TMPL_TYPE_LIST) &&
1738 (map->rhs->type != TMPL_TYPE_EXEC)) {
1739 cf_log_err(map->ci, "Invalid source for list assignment '%s += ...'", map->lhs->name);
1745 if (map->rhs->type == TMPL_TYPE_EXEC) {
1746 WARN("%s[%d] Please change ':=' to '=' for list assignment",
1747 cf_pair_filename(cp), cf_pair_lineno(cp));
1750 if (map->rhs->type != TMPL_TYPE_LIST) {
1751 cf_log_err(map->ci, "Invalid source for list assignment '%s := ...'", map->lhs->name);
1757 if (map->rhs->type != TMPL_TYPE_EXEC) {
1758 cf_log_err(map->ci, "Invalid source for list assignment '%s = ...'", map->lhs->name);
1764 cf_log_err(map->ci, "Operator \"%s\" not allowed for list assignment",
1765 fr_int2str(fr_tokens, map->op, "<INVALID>"));
1771 * If the map has a unary operator there's no further
1772 * processing we need to, as RHS is unused.
1774 if (map->op == T_OP_CMP_FALSE) return 0;
1777 * If LHS is an attribute, and RHS is a literal, we can
1778 * preparse the information into a TMPL_TYPE_DATA.
1780 * Unless it's a unary operator in which case we
1783 if ((map->lhs->type == TMPL_TYPE_ATTR) && (map->rhs->type == TMPL_TYPE_LITERAL)) {
1785 * It's a literal string, just copy it.
1786 * Don't escape anything.
1788 if (!cf_new_escape &&
1789 (map->lhs->tmpl_da->type == PW_TYPE_STRING) &&
1790 (cf_pair_value_type(cp) == T_SINGLE_QUOTED_STRING)) {
1791 tmpl_cast_in_place_str(map->rhs);
1793 if (!tmpl_cast_in_place(map->rhs, map->lhs->tmpl_da)) {
1794 cf_log_err(map->ci, "%s", fr_strerror());
1799 * Fixup LHS da if it doesn't match the type
1802 if (map->lhs->tmpl_da->type != map->rhs->tmpl_data_type) {
1803 DICT_ATTR const *da;
1805 da = dict_attrbytype(map->lhs->tmpl_da->attr, map->lhs->tmpl_da->vendor,
1806 map->rhs->tmpl_data_type);
1808 fr_strerror_printf("Cannot find %s variant of attribute \"%s\"",
1809 fr_int2str(dict_attr_types, map->rhs->tmpl_data_type,
1810 "<INVALID>"), map->lhs->tmpl_da->name);
1813 map->lhs->tmpl_da = da;
1816 } /* else we can't precompile the data */
1823 static modcallable *do_compile_modupdate(modcallable *parent, UNUSED rlm_components_t component,
1824 CONF_SECTION *cs, char const *name2)
1828 modcallable *csingle;
1830 value_pair_map_t *head;
1833 * This looks at cs->name2 to determine which list to update
1835 rcode = map_afrom_cs(&head, cs, PAIR_LIST_REQUEST, PAIR_LIST_REQUEST, modcall_fixup_update, NULL, 128);
1836 if (rcode < 0) return NULL; /* message already printed */
1838 cf_log_err_cs(cs, "'update' sections cannot be empty");
1842 g = talloc_zero(parent, modgroup);
1843 csingle = mod_grouptocallable(g);
1845 csingle->parent = parent;
1846 csingle->next = NULL;
1849 csingle->name = name2;
1853 csingle->type = MOD_UPDATE;
1854 csingle->method = component;
1856 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
1857 sizeof(csingle->actions));
1859 g->grouptype = GROUPTYPE_SIMPLE;
1862 g->map = talloc_steal(g, head);
1868 static modcallable *do_compile_modswitch (modcallable *parent, rlm_components_t component, CONF_SECTION *cs)
1873 bool had_seen_default = false;
1874 modcallable *csingle;
1877 value_pair_tmpl_t *vpt;
1879 name2 = cf_section_name2(cs);
1881 cf_log_err_cs(cs, "You must specify a variable to switch over for 'switch'");
1885 if (!cf_item_find_next(cs, NULL)) {
1886 cf_log_err_cs(cs, "'switch' statements cannot be empty");
1891 * Create the template. If we fail, AND it's a bare word
1892 * with &Foo-Bar, it MAY be an attribute defined by a
1893 * module. Allow it for now. The pass2 checks below
1896 type = cf_section_name2_type(cs);
1897 slen = tmpl_afrom_str(cs, &vpt, name2, type, REQUEST_CURRENT, PAIR_LIST_REQUEST);
1898 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
1899 char *spaces, *text;
1901 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
1903 cf_log_err_cs(cs, "Syntax error");
1904 cf_log_err_cs(cs, "%s", name2);
1905 cf_log_err_cs(cs, "%s^ %s", spaces, text);
1907 talloc_free(spaces);
1914 * Otherwise a NULL vpt may refer to an attribute defined
1915 * by a module. That is checked in pass 2.
1919 * Walk through the children of the switch section,
1920 * ensuring that they're all 'case' statements
1922 for (ci = cf_item_find_next(cs, NULL);
1924 ci = cf_item_find_next(cs, ci)) {
1925 CONF_SECTION *subcs;
1928 if (!cf_item_is_section(ci)) {
1929 if (!cf_item_is_pair(ci)) continue;
1931 cf_log_err(ci, "\"switch\" sections can only have \"case\" subsections");
1936 subcs = cf_itemtosection(ci); /* can't return NULL */
1937 name1 = cf_section_name1(subcs);
1939 if (strcmp(name1, "case") != 0) {
1940 cf_log_err(ci, "\"switch\" sections can only have \"case\" subsections");
1945 name2 = cf_section_name2(subcs);
1947 if (!had_seen_default) {
1948 had_seen_default = true;
1952 cf_log_err(ci, "Cannot have two 'default' case statements");
1958 csingle = do_compile_modgroup(parent, component, cs,
1967 g = mod_callabletogroup(csingle);
1968 g->vpt = talloc_steal(g, vpt);
1973 static modcallable *do_compile_modcase(modcallable *parent, rlm_components_t component, CONF_SECTION *cs)
1977 modcallable *csingle;
1979 value_pair_tmpl_t *vpt;
1981 if (!parent || (parent->type != MOD_SWITCH)) {
1982 cf_log_err_cs(cs, "\"case\" statements may only appear within a \"switch\" section");
1987 * case THING means "match THING"
1988 * case means "match anything"
1990 name2 = cf_section_name2(cs);
1995 type = cf_section_name2_type(cs);
1997 slen = tmpl_afrom_str(cs, &vpt, name2, type, REQUEST_CURRENT, PAIR_LIST_REQUEST);
1998 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
1999 char *spaces, *text;
2001 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
2003 cf_log_err_cs(cs, "Syntax error");
2004 cf_log_err_cs(cs, "%s", name2);
2005 cf_log_err_cs(cs, "%s^ %s", spaces, text);
2007 talloc_free(spaces);
2014 * Otherwise a NULL vpt may refer to an attribute defined
2015 * by a module. That is checked in pass 2.
2022 csingle = do_compile_modgroup(parent, component, cs,
2032 * The interpretor expects this to be NULL for the
2033 * default case. do_compile_modgroup sets it to name2,
2034 * unless name2 is NULL, in which case it sets it to name1.
2036 csingle->name = name2;
2038 g = mod_callabletogroup(csingle);
2039 g->vpt = talloc_steal(g, vpt);
2042 * Set all of it's codes to return, so that
2043 * when we pick a 'case' statement, we don't
2044 * fall through to processing the next one.
2046 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
2047 csingle->actions[i] = MOD_ACTION_RETURN;
2053 static modcallable *do_compile_modforeach(modcallable *parent,
2054 UNUSED rlm_components_t component, CONF_SECTION *cs)
2058 modcallable *csingle;
2061 value_pair_tmpl_t *vpt;
2063 name2 = cf_section_name2(cs);
2066 "You must specify an attribute to loop over in 'foreach'");
2070 if (!cf_item_find_next(cs, NULL)) {
2071 cf_log_err_cs(cs, "'foreach' blocks cannot be empty");
2076 * Create the template. If we fail, AND it's a bare word
2077 * with &Foo-Bar, it MAY be an attribute defined by a
2078 * module. Allow it for now. The pass2 checks below
2081 type = cf_section_name2_type(cs);
2082 slen = tmpl_afrom_str(cs, &vpt, name2, type, REQUEST_CURRENT, PAIR_LIST_REQUEST);
2083 if ((slen < 0) && ((type != T_BARE_WORD) || (name2[0] != '&'))) {
2084 char *spaces, *text;
2086 fr_canonicalize_error(cs, &spaces, &text, slen, fr_strerror());
2088 cf_log_err_cs(cs, "Syntax error");
2089 cf_log_err_cs(cs, "%s", name2);
2090 cf_log_err_cs(cs, "%s^ %s", spaces, text);
2092 talloc_free(spaces);
2098 if (vpt && (vpt->type != TMPL_TYPE_ATTR)) {
2099 cf_log_err_cs(cs, "MUST use attribute reference in 'foreach'");
2104 * Fix up the template to iterate over all instances of
2105 * the attribute. In a perfect consistent world, users would do
2106 * foreach &attr[*], but that's taking the consistency thing a bit far.
2108 if (vpt && (vpt->type == TMPL_TYPE_ATTR)) {
2109 vpt->tmpl_num = NUM_ALL;
2112 csingle = do_compile_modgroup(parent, component, cs,
2113 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2121 g = mod_callabletogroup(csingle);
2127 static modcallable *do_compile_modbreak(modcallable *parent,
2128 rlm_components_t component, CONF_ITEM const *ci)
2130 CONF_SECTION const *cs = NULL;
2132 for (cs = cf_item_parent(ci);
2134 cs = cf_item_parent(cf_sectiontoitem(cs))) {
2135 if (strcmp(cf_section_name1(cs), "foreach") == 0) {
2141 cf_log_err(ci, "'break' can only be used in a 'foreach' section");
2145 return do_compile_modgroup(parent, component, NULL,
2146 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2151 static modcallable *do_compile_modserver(modcallable *parent,
2152 rlm_components_t component, CONF_ITEM *ci,
2157 modcallable *csingle;
2158 CONF_SECTION *subcs;
2161 subcs = cf_section_sub_find_name2(cs, comp2str[component], NULL);
2163 cf_log_err(ci, "Server %s has no %s section",
2164 server, comp2str[component]);
2168 mr = talloc_zero(parent, modref);
2170 csingle = mod_reftocallable(mr);
2171 csingle->parent = parent;
2172 csingle->next = NULL;
2173 csingle->name = name;
2174 csingle->type = MOD_REFERENCE;
2175 csingle->method = component;
2177 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
2178 sizeof(csingle->actions));
2180 mr->ref_name = strdup(server);
2186 static modcallable *do_compile_modxlat(modcallable *parent,
2187 rlm_components_t component, char const *fmt)
2189 modcallable *csingle;
2192 mx = talloc_zero(parent, modxlat);
2194 csingle = mod_xlattocallable(mx);
2195 csingle->parent = parent;
2196 csingle->next = NULL;
2197 csingle->name = "expand";
2198 csingle->type = MOD_XLAT;
2199 csingle->method = component;
2201 memcpy(csingle->actions, defaultactions[component][GROUPTYPE_SIMPLE],
2202 sizeof(csingle->actions));
2204 mx->xlat_name = strdup(fmt);
2205 if (fmt[0] != '%') {
2209 strcpy(mx->xlat_name, fmt + 1);
2210 p = strrchr(mx->xlat_name, '`');
2218 * redundant, etc. can refer to modules or groups, but not much else.
2220 static int all_children_are_modules(CONF_SECTION *cs, char const *name)
2224 for (ci=cf_item_find_next(cs, NULL);
2226 ci=cf_item_find_next(cs, ci)) {
2228 * If we're a redundant, etc. group, then the
2229 * intention is to call modules, rather than
2230 * processing logic. These checks aren't
2231 * *strictly* necessary, but they keep the users
2232 * from doing crazy things.
2234 if (cf_item_is_section(ci)) {
2235 CONF_SECTION *subcs = cf_itemtosection(ci);
2236 char const *name1 = cf_section_name1(subcs);
2238 if ((strcmp(name1, "if") == 0) ||
2239 (strcmp(name1, "else") == 0) ||
2240 (strcmp(name1, "elsif") == 0) ||
2241 (strcmp(name1, "update") == 0) ||
2242 (strcmp(name1, "switch") == 0) ||
2243 (strcmp(name1, "case") == 0)) {
2244 cf_log_err(ci, "%s sections cannot contain a \"%s\" statement",
2251 if (cf_item_is_pair(ci)) {
2252 CONF_PAIR *cp = cf_itemtopair(ci);
2253 if (cf_pair_value(cp) != NULL) {
2255 "Entry with no value is invalid");
2266 * Compile one entry of a module call.
2268 static modcallable *do_compile_modsingle(modcallable *parent,
2269 rlm_components_t component, CONF_ITEM *ci,
2271 char const **modname)
2273 char const *modrefname;
2275 modcallable *csingle;
2276 module_instance_t *this;
2277 CONF_SECTION *cs, *subcs, *modules;
2278 char const *realname;
2280 if (cf_item_is_section(ci)) {
2283 cs = cf_itemtosection(ci);
2284 modrefname = cf_section_name1(cs);
2285 name2 = cf_section_name2(cs);
2286 if (!name2) name2 = "";
2289 * group{}, redundant{}, or append{} may appear
2290 * where a single module instance was expected.
2291 * In that case, we hand it off to
2294 if (strcmp(modrefname, "group") == 0) {
2296 return do_compile_modgroup(parent, component, cs,
2298 grouptype, MOD_GROUP);
2300 } else if (strcmp(modrefname, "redundant") == 0) {
2303 if (!all_children_are_modules(cs, modrefname)) {
2307 return do_compile_modgroup(parent, component, cs,
2308 GROUPTYPE_REDUNDANT,
2309 grouptype, MOD_GROUP);
2311 } else if (strcmp(modrefname, "append") == 0) {
2313 return do_compile_modgroup(parent, component, cs,
2315 grouptype, MOD_GROUP);
2317 } else if (strcmp(modrefname, "load-balance") == 0) {
2320 if (!all_children_are_modules(cs, modrefname)) {
2324 return do_compile_modgroup(parent, component, cs,
2326 grouptype, MOD_LOAD_BALANCE);
2328 } else if (strcmp(modrefname, "redundant-load-balance") == 0) {
2331 if (!all_children_are_modules(cs, modrefname)) {
2335 return do_compile_modgroup(parent, component, cs,
2336 GROUPTYPE_REDUNDANT,
2337 grouptype, MOD_REDUNDANT_LOAD_BALANCE);
2340 } else if (strcmp(modrefname, "if") == 0) {
2341 if (!cf_section_name2(cs)) {
2342 cf_log_err(ci, "'if' without condition");
2347 csingle= do_compile_modgroup(parent, component, cs,
2350 if (!csingle) return NULL;
2355 } else if (strcmp(modrefname, "elsif") == 0) {
2357 ((parent->type == MOD_LOAD_BALANCE) ||
2358 (parent->type == MOD_REDUNDANT_LOAD_BALANCE))) {
2359 cf_log_err(ci, "'elsif' cannot be used in this section");
2363 if (!cf_section_name2(cs)) {
2364 cf_log_err(ci, "'elsif' without condition");
2369 return do_compile_modgroup(parent, component, cs,
2371 grouptype, MOD_ELSIF);
2373 } else if (strcmp(modrefname, "else") == 0) {
2375 ((parent->type == MOD_LOAD_BALANCE) ||
2376 (parent->type == MOD_REDUNDANT_LOAD_BALANCE))) {
2377 cf_log_err(ci, "'else' cannot be used in this section section");
2381 if (cf_section_name2(cs)) {
2382 cf_log_err(ci, "Cannot have conditions on 'else'");
2387 return do_compile_modgroup(parent, component, cs,
2389 grouptype, MOD_ELSE);
2391 } else if (strcmp(modrefname, "update") == 0) {
2394 return do_compile_modupdate(parent, component, cs,
2397 } else if (strcmp(modrefname, "switch") == 0) {
2400 return do_compile_modswitch (parent, component, cs);
2402 } else if (strcmp(modrefname, "case") == 0) {
2405 return do_compile_modcase(parent, component, cs);
2407 } else if (strcmp(modrefname, "foreach") == 0) {
2410 return do_compile_modforeach(parent, component, cs);
2413 } /* else it's something like sql { fail = 1 ...} */
2415 } else if (!cf_item_is_pair(ci)) { /* CONF_DATA or some such */
2419 * Else it's a module reference, with updated return
2424 CONF_PAIR *cp = cf_itemtopair(ci);
2425 modrefname = cf_pair_attr(cp);
2428 * Actions (ok = 1), etc. are orthogonal to just
2429 * about everything else.
2431 if (cf_pair_value(cp) != NULL) {
2432 cf_log_err(ci, "Entry is not a reference to a module");
2436 if (((modrefname[0] == '%') && (modrefname[1] == '{')) ||
2437 (modrefname[0] == '`')) {
2438 return do_compile_modxlat(parent, component,
2443 * See if the module is a virtual one. If so,
2444 * return that, rather than doing anything here.
2447 cs = cf_section_find("instantiate");
2448 if (cs) subcs = cf_section_sub_find_name2(cs, NULL,
2451 (cs = cf_section_find("policy")) != NULL) {
2454 snprintf(buffer, sizeof(buffer), "%s.%s",
2455 modrefname, comp2str[component]);
2458 * Prefer name.section, then name.
2460 subcs = cf_section_sub_find_name2(cs, NULL,
2463 subcs = cf_section_sub_find_name2(cs, NULL,
2469 * Allow policies to over-ride module names.
2470 * i.e. the "sql" policy can do some extra things,
2471 * and then call the "sql" module.
2473 for (loop = cf_item_parent(ci);
2475 loop = cf_item_parent(cf_sectiontoitem(loop))) {
2476 if (loop == subcs) {
2483 * redundant foo {} is a single.
2485 if (cf_section_name2(subcs)) {
2486 return do_compile_modsingle(parent,
2488 cf_sectiontoitem(subcs),
2493 * foo {} is a group.
2495 return do_compile_modgroup(parent,
2499 grouptype, MOD_GROUP);
2505 if (strcmp(modrefname, "break") == 0) {
2506 return do_compile_modbreak(parent, component, ci);
2509 if (strcmp(modrefname, "return") == 0) {
2510 return do_compile_modgroup(parent, component, NULL,
2511 GROUPTYPE_SIMPLE, GROUPTYPE_SIMPLE,
2517 * Not a virtual module. It must be a real module.
2519 modules = cf_section_find("modules");
2521 realname = modrefname;
2525 * Try to load the optional module.
2527 if (realname[0] == '-') realname++;
2530 * As of v3, only known modules are in the
2531 * "modules" section.
2533 if (cf_section_sub_find_name2(modules, NULL, realname)) {
2534 this = find_module_instance(modules, realname, true);
2535 if (!this && (realname != modrefname)) {
2541 * We were asked to MAYBE load it and it
2542 * doesn't exist. Return a soft error.
2544 if (realname != modrefname) {
2545 *modname = modrefname;
2556 * Maybe it's module.method
2558 p = strrchr(modrefname, '.');
2559 if (p) for (i = RLM_COMPONENT_AUTH;
2560 i < RLM_COMPONENT_COUNT;
2562 if (strcmp(p + 1, comp2str[i]) == 0) {
2565 strlcpy(buffer, modrefname, sizeof(buffer));
2566 buffer[p - modrefname] = '\0';
2569 this = find_module_instance(modules, buffer, true);
2570 if (this && !this->entry->module->methods[i]) {
2572 cf_log_err(ci, "Module %s has no such method %s", buffer, comp2str[i]);
2581 * Call a server. This should really be deleted...
2583 if (strncmp(modrefname, "server[", 7) == 0) {
2586 strlcpy(buffer, modrefname + 7, sizeof(buffer));
2587 p = strrchr(buffer, ']');
2588 if (!p || p[1] != '\0' || (p == buffer)) {
2589 cf_log_err(ci, "Invalid server reference in \"%s\".", modrefname);
2594 cs = cf_section_sub_find_name2(NULL, "server", buffer);
2596 cf_log_err(ci, "No such server \"%s\".", buffer);
2600 return do_compile_modserver(parent, component, ci,
2601 modrefname, cs, buffer);
2605 cf_log_err(ci, "Failed to find \"%s\" in the \"modules\" section.", modrefname);
2610 * We know it's all OK, allocate the structures, and fill
2613 single = talloc_zero(parent, modsingle);
2614 csingle = mod_singletocallable(single);
2615 csingle->parent = parent;
2616 csingle->next = NULL;
2617 if (!parent || (component != RLM_COMPONENT_AUTH)) {
2618 memcpy(csingle->actions, defaultactions[component][grouptype],
2619 sizeof csingle->actions);
2620 } else { /* inside Auth-Type has different rules */
2621 memcpy(csingle->actions, defaultactions[RLM_COMPONENT_AUTZ][grouptype],
2622 sizeof csingle->actions);
2624 rad_assert(modrefname != NULL);
2625 csingle->name = realname;
2626 csingle->type = MOD_SINGLE;
2627 csingle->method = component;
2630 * Singles can override the actions, virtual modules cannot.
2632 * FIXME: We may want to re-visit how to do this...
2633 * maybe a csingle as a ref?
2635 if (cf_item_is_section(ci)) {
2638 cs = cf_itemtosection(ci);
2639 for (csi=cf_item_find_next(cs, NULL);
2641 csi=cf_item_find_next(cs, csi)) {
2643 if (cf_item_is_section(csi)) {
2644 cf_log_err(csi, "Subsection of module instance call not allowed");
2645 talloc_free(csingle);
2649 if (!cf_item_is_pair(csi)) continue;
2651 if (!compile_action(csingle, cf_itemtopair(csi))) {
2652 talloc_free(csingle);
2659 * Bail out if the module in question does not supply the
2662 if (!this->entry->module->methods[component]) {
2663 cf_log_err(ci, "\"%s\" modules aren't allowed in '%s' sections -- they have no such method.", this->entry->module->name,
2664 comp2str[component]);
2665 talloc_free(csingle);
2669 single->modinst = this;
2670 *modname = this->entry->module->name;
2674 modcallable *compile_modsingle(TALLOC_CTX *ctx,
2675 modcallable **parent,
2676 rlm_components_t component, CONF_ITEM *ci,
2677 char const **modname)
2684 CONF_SECTION *parentcs;
2686 g = talloc_zero(ctx, modgroup);
2687 memset(g, 0, sizeof(*g));
2688 g->grouptype = GROUPTYPE_SIMPLE;
2689 c = mod_grouptocallable(g);
2692 defaultactions[component][GROUPTYPE_SIMPLE],
2693 sizeof(c->actions));
2695 parentcs = cf_item_parent(ci);
2696 c->name = cf_section_name2(parentcs);
2698 c->name = cf_section_name1(parentcs);
2701 c->type = MOD_GROUP;
2702 c->method = component;
2705 *parent = mod_grouptocallable(g);
2708 ret = do_compile_modsingle(*parent, component, ci,
2711 dump_tree(component, ret);
2717 * Internal compile group code.
2719 static modcallable *do_compile_modgroup(modcallable *parent,
2720 rlm_components_t component, CONF_SECTION *cs,
2721 int grouptype, int parentgrouptype, int mod_type)
2728 g = talloc_zero(parent, modgroup);
2729 g->grouptype = grouptype;
2733 c = mod_grouptocallable(g);
2737 memset(c->actions, 0, sizeof(c->actions));
2739 if (!cs) { /* only for "break" and "return" */
2745 * Remember the name for printing, etc.
2747 * FIXME: We may also want to put the names into a
2748 * rbtree, so that groups can reference each other...
2750 c->name = cf_section_name2(cs);
2752 c->name = cf_section_name1(cs);
2753 if ((strcmp(c->name, "group") == 0) ||
2754 (strcmp(c->name, "redundant") == 0)) {
2756 } else if (c->type == MOD_GROUP) {
2757 c->type = MOD_POLICY;
2763 * Do load-time optimizations
2765 if ((c->type == MOD_IF) || (c->type == MOD_ELSIF) || (c->type == MOD_ELSE)) {
2768 rad_assert(parent != NULL);
2770 if (c->type == MOD_IF) {
2771 g->cond = cf_data_find(g->cs, "if");
2772 rad_assert(g->cond != NULL);
2775 if (g->cond->type == COND_TYPE_FALSE) {
2776 INFO(" # Skipping contents of '%s' as it is always 'false' -- %s:%d",
2777 group_name[g->mc.type],
2778 cf_section_filename(g->cs), cf_section_lineno(g->cs));
2782 } else if (c->type == MOD_ELSIF) {
2784 g->cond = cf_data_find(g->cs, "if");
2785 rad_assert(g->cond != NULL);
2787 rad_assert(parent != NULL);
2788 p = mod_callabletogroup(parent);
2790 rad_assert(p->tail != NULL);
2792 f = mod_callabletogroup(p->tail);
2793 rad_assert((f->mc.type == MOD_IF) ||
2794 (f->mc.type == MOD_ELSIF));
2797 * If we took the previous condition, we
2798 * don't need to take this one.
2800 * We reset our condition to 'true', so
2801 * that subsequent sections can check
2802 * that they don't need to be executed.
2804 if (f->cond->type == COND_TYPE_TRUE) {
2806 INFO(" # Skipping contents of '%s' as previous '%s' is always 'true' -- %s:%d",
2807 group_name[g->mc.type],
2808 group_name[f->mc.type],
2809 cf_section_filename(g->cs), cf_section_lineno(g->cs));
2816 rad_assert(c->type == MOD_ELSE);
2818 rad_assert(parent != NULL);
2819 p = mod_callabletogroup(parent);
2821 rad_assert(p->tail != NULL);
2823 f = mod_callabletogroup(p->tail);
2824 rad_assert((f->mc.type == MOD_IF) ||
2825 (f->mc.type == MOD_ELSIF));
2828 * If we took the previous condition, we
2829 * don't need to take this one.
2831 if (f->cond->type == COND_TYPE_TRUE) goto skip_true;
2835 * Else we need to compile this section
2841 * Loop over the children of this group.
2843 for (ci=cf_item_find_next(cs, NULL);
2845 ci=cf_item_find_next(cs, ci)) {
2848 * Sections are references to other groups, or
2849 * to modules with updated return codes.
2851 if (cf_item_is_section(ci)) {
2852 char const *junk = NULL;
2853 modcallable *single;
2854 CONF_SECTION *subcs = cf_itemtosection(ci);
2856 single = do_compile_modsingle(c, component, ci,
2859 cf_log_err(ci, "Failed to parse \"%s\" subsection.",
2860 cf_section_name1(subcs));
2864 add_child(g, single);
2866 } else if (!cf_item_is_pair(ci)) { /* CONF_DATA */
2870 char const *attr, *value;
2871 CONF_PAIR *cp = cf_itemtopair(ci);
2873 attr = cf_pair_attr(cp);
2874 value = cf_pair_value(cp);
2877 * A CONF_PAIR is either a module
2878 * instance with no actions
2882 modcallable *single;
2883 char const *junk = NULL;
2885 single = do_compile_modsingle(c,
2891 if (cf_item_is_pair(ci) &&
2892 cf_pair_attr(cf_itemtopair(ci))[0] == '-') {
2897 "Failed to parse \"%s\" entry.",
2902 add_child(g, single);
2905 * Or a module instance with action.
2907 } else if (!compile_action(c, cp)) {
2910 } /* else it worked */
2916 * Set the default actions, if they haven't already been
2919 for (i = 0; i < RLM_MODULE_NUMCODES; i++) {
2920 if (!c->actions[i]) {
2921 if (!parent || (component != RLM_COMPONENT_AUTH)) {
2922 c->actions[i] = defaultactions[component][parentgrouptype][i];
2923 } else { /* inside Auth-Type has different rules */
2924 c->actions[i] = defaultactions[RLM_COMPONENT_AUTZ][parentgrouptype][i];
2934 if (grouptype != GROUPTYPE_REDUNDANT) break;
2937 case MOD_LOAD_BALANCE:
2938 case MOD_REDUNDANT_LOAD_BALANCE:
2940 cf_log_err_cs(g->cs, "%s sections cannot be empty",
2941 cf_section_name1(g->cs));
2948 * FIXME: If there are no children, return NULL?
2950 return mod_grouptocallable(g);
2953 modcallable *compile_modgroup(modcallable *parent,
2954 rlm_components_t component, CONF_SECTION *cs)
2956 modcallable *ret = do_compile_modgroup(parent, component, cs,
2958 GROUPTYPE_SIMPLE, MOD_GROUP);
2960 if (debug_flag > 3) {
2961 modcall_debug(ret, 2);
2967 void add_to_modcallable(modcallable *parent, modcallable *this)
2971 rad_assert(this != NULL);
2972 rad_assert(parent != NULL);
2974 g = mod_callabletogroup(parent);
2981 static bool pass2_xlat_compile(CONF_ITEM const *ci, value_pair_tmpl_t **pvpt, bool convert,
2982 DICT_ATTR const *da)
2988 value_pair_tmpl_t *vpt;
2992 rad_assert(vpt->type == TMPL_TYPE_XLAT);
2994 fmt = talloc_typed_strdup(vpt, vpt->name);
2995 slen = xlat_tokenize(vpt, fmt, &head, &error);
2998 char *spaces, *text;
3000 fr_canonicalize_error(vpt, &spaces, &text, slen, vpt->name);
3002 cf_log_err(ci, "Failed parsing expanded string:");
3003 cf_log_err(ci, "%s", text);
3004 cf_log_err(ci, "%s^ %s", spaces, error);
3006 talloc_free(spaces);
3012 * Convert %{Attribute-Name} to &Attribute-Name
3015 value_pair_tmpl_t *attr;
3017 attr = radius_xlat2tmpl(talloc_parent(vpt), head);
3020 * If it's a virtual attribute, leave it
3023 if (attr->tmpl_da->flags.virtual) {
3029 * If the attribute is of incompatible
3030 * type, leave it alone.
3032 if (da && (da->type != attr->tmpl_da->type)) {
3037 if (cf_item_is_pair(ci)) {
3038 CONF_PAIR *cp = cf_itemtopair(ci);
3040 WARN("%s[%d] Please change %%{%s} to &%s",
3041 cf_pair_filename(cp), cf_pair_lineno(cp),
3042 attr->name, attr->name);
3044 CONF_SECTION *cs = cf_itemtosection(ci);
3046 WARN("%s[%d] Please change %%{%s} to &%s",
3047 cf_section_filename(cs), cf_section_lineno(cs),
3048 attr->name, attr->name);
3057 * Re-write it to be a pre-parsed XLAT structure.
3059 vpt->type = TMPL_TYPE_XLAT_STRUCT;
3060 vpt->tmpl_xlat = head;
3067 static int _free_compiled_regex(regex_t *preg)
3073 static bool pass2_regex_compile(CONF_ITEM const *ci, value_pair_tmpl_t *vpt)
3078 rad_assert(vpt->type == TMPL_TYPE_REGEX);
3081 * It's a dynamic expansion. We can't expand the string,
3082 * but we can pre-parse it as an xlat struct. In that
3083 * case, we convert it to a pre-compiled XLAT.
3085 * This is a little more complicated than it needs to be
3086 * because radius_evaluate_map() keys off of the src
3087 * template type, instead of the operators. And, the
3088 * pass2_xlat_compile() function expects to get passed an
3089 * XLAT instead of a REGEX.
3091 if (strchr(vpt->name, '%')) {
3092 vpt->type = TMPL_TYPE_XLAT;
3093 return pass2_xlat_compile(ci, &vpt, false, NULL);
3096 preg = talloc_zero(vpt, regex_t);
3097 talloc_set_destructor(preg, _free_compiled_regex);
3098 if (!preg) return false;
3100 rcode = regcomp(preg, vpt->name, REG_EXTENDED | (vpt->tmpl_iflag ? REG_ICASE : 0));
3103 regerror(rcode, preg, buffer, sizeof(buffer));
3105 cf_log_err(ci, "Invalid regular expression %s: %s",
3110 vpt->type = TMPL_TYPE_REGEX_STRUCT;
3111 vpt->tmpl_preg = preg;
3117 static bool pass2_fixup_undefined(CONF_ITEM const *ci, value_pair_tmpl_t *vpt)
3119 DICT_ATTR const *da;
3121 rad_assert(vpt->type == TMPL_TYPE_ATTR_UNDEFINED);
3123 da = dict_attrbyname(vpt->tmpl_unknown_name);
3125 cf_log_err(ci, "Unknown attribute '%s'", vpt->tmpl_unknown_name);
3130 vpt->type = TMPL_TYPE_ATTR;
3134 static bool pass2_callback(UNUSED void *ctx, fr_cond_t *c)
3136 value_pair_map_t *map;
3138 if (c->type == COND_TYPE_EXISTS) {
3140 if (c->data.vpt->type == TMPL_TYPE_XLAT) {
3141 return pass2_xlat_compile(c->ci, &c->data.vpt, true, NULL);
3144 rad_assert(c->data.vpt->type != TMPL_TYPE_REGEX);
3147 * The existence check might have been &Foo-Bar,
3148 * where Foo-Bar is defined by a module.
3150 if (c->pass2_fixup == PASS2_FIXUP_ATTR) {
3151 if (!pass2_fixup_undefined(c->ci, c->data.vpt)) return false;
3152 c->pass2_fixup = PASS2_FIXUP_NONE;
3158 * Maps have a paircompare fixup applied to them.
3159 * Others get ignored.
3161 if (c->pass2_fixup == PASS2_FIXUP_NONE) {
3162 if (c->type == COND_TYPE_MAP) {
3170 map = c->data.map; /* shorter */
3175 * Where "foo" is dynamically defined.
3177 if (c->pass2_fixup == PASS2_FIXUP_TYPE) {
3178 if (!dict_valbyname(map->lhs->tmpl_da->attr,
3179 map->lhs->tmpl_da->vendor,
3181 cf_log_err(map->ci, "Invalid reference to non-existent %s %s { ... }",
3182 map->lhs->tmpl_da->name,
3188 * These guys can't have a paircompare fixup applied.
3190 c->pass2_fixup = PASS2_FIXUP_NONE;
3194 if (c->pass2_fixup == PASS2_FIXUP_ATTR) {
3195 if (map->lhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3196 if (!pass2_fixup_undefined(map->ci, map->lhs)) return false;
3199 if (map->rhs->type == TMPL_TYPE_ATTR_UNDEFINED) {
3200 if (!pass2_fixup_undefined(map->ci, map->rhs)) return false;
3203 c->pass2_fixup = PASS2_FIXUP_NONE;
3208 * Just in case someone adds a new fixup later.
3210 rad_assert((c->pass2_fixup == PASS2_FIXUP_NONE) ||
3211 (c->pass2_fixup == PASS2_PAIRCOMPARE));
3216 if (map->lhs->type == TMPL_TYPE_XLAT) {
3218 * Don't compile the LHS to an attribute
3219 * reference for now. When we do that, we've got
3220 * to check the RHS for type-specific data, and
3221 * parse it to a TMPL_TYPE_DATA.
3223 if (!pass2_xlat_compile(map->ci, &map->lhs, false, NULL)) {
3228 if (map->rhs->type == TMPL_TYPE_XLAT) {
3230 * Convert the RHS to an attribute reference only
3231 * if the LHS is an attribute reference, AND is
3232 * of the same type as the RHS.
3234 * We can fix this when the code in evaluate.c
3235 * can handle strings on the LHS, and attributes
3236 * on the RHS. For now, the code in parser.c
3239 if (map->lhs->type == TMPL_TYPE_ATTR) {
3240 DICT_ATTR const *da = c->cast;
3242 if (!c->cast) da = map->lhs->tmpl_da;
3244 if (!pass2_xlat_compile(map->ci, &map->rhs, true, da)) {
3249 if (!pass2_xlat_compile(map->ci, &map->rhs, false, NULL)) {
3256 * Convert bare refs to %{Foreach-Variable-N}
3258 if ((map->lhs->type == TMPL_TYPE_LITERAL) &&
3259 (strncmp(map->lhs->name, "Foreach-Variable-", 17) == 0)) {
3262 value_pair_tmpl_t *vpt;
3264 fmt = talloc_asprintf(map->lhs, "%%{%s}", map->lhs->name);
3265 slen = tmpl_afrom_str(map, &vpt, fmt, T_DOUBLE_QUOTED_STRING, REQUEST_CURRENT, PAIR_LIST_REQUEST);
3267 char *spaces, *text;
3269 fr_canonicalize_error(map->ci, &spaces, &text, slen, fr_strerror());
3271 cf_log_err(map->ci, "Failed converting %s to xlat", map->lhs->name);
3272 cf_log_err(map->ci, "%s", fmt);
3273 cf_log_err(map->ci, "%s^ %s", spaces, text);
3275 talloc_free(spaces);
3281 talloc_free(map->lhs);
3286 if (map->rhs->type == TMPL_TYPE_REGEX) {
3287 if (!pass2_regex_compile(map->ci, map->rhs)) {
3291 rad_assert(map->lhs->type != TMPL_TYPE_REGEX);
3295 * Only attributes can have a paircompare registered, and
3296 * they can only be with the current REQUEST, and only
3297 * with the request pairs.
3299 if ((map->lhs->type != TMPL_TYPE_ATTR) ||
3300 (map->lhs->tmpl_request != REQUEST_CURRENT) ||
3301 (map->lhs->tmpl_list != PAIR_LIST_REQUEST)) {
3305 if (!radius_find_compare(map->lhs->tmpl_da)) return true;
3307 if (map->rhs->type == TMPL_TYPE_ATTR) {
3308 cf_log_err(map->ci, "Cannot compare virtual attribute %s to another attribute",
3313 if (map->rhs->type == TMPL_TYPE_REGEX) {
3314 cf_log_err(map->ci, "Cannot compare virtual attribute %s via a regex",
3320 cf_log_err(map->ci, "Cannot cast virtual attribute %s",
3325 if (map->op != T_OP_CMP_EQ) {
3326 cf_log_err(map->ci, "Must use '==' for comparisons with virtual attribute %s",
3332 * Mark it as requiring a paircompare() call, instead of
3335 c->pass2_fixup = PASS2_PAIRCOMPARE;
3342 * Compile the RHS of update sections to xlat_exp_t
3344 static bool modcall_pass2_update(modgroup *g)
3346 value_pair_map_t *map;
3348 for (map = g->map; map != NULL; map = map->next) {
3349 if (map->rhs->type == TMPL_TYPE_XLAT) {
3350 rad_assert(map->rhs->tmpl_xlat == NULL);
3353 * FIXME: compile to attribute && handle
3354 * the conversion in map_to_vp().
3356 if (!pass2_xlat_compile(map->ci, &map->rhs, false, NULL)) {
3361 rad_assert(map->rhs->type != TMPL_TYPE_REGEX);
3369 * Do a second-stage pass on compiling the modules.
3371 bool modcall_pass2(modcallable *mc)
3378 for (c = mc; c != NULL; c = c->next) {
3386 g = mod_callabletogroup(c);
3387 if (g->done_pass2) return true;
3389 name2 = cf_section_name2(g->cs);
3391 c->debug_name = group_name[c->type];
3393 c->debug_name = talloc_asprintf(c, "update %s", name2);
3396 if (!modcall_pass2_update(g)) {
3399 g->done_pass2 = true;
3402 case MOD_XLAT: /* @todo: pre-parse xlat's */
3409 c->debug_name = c->name;
3410 break; /* do nothing */
3415 g = mod_callabletogroup(c);
3416 if (g->done_pass2) return true;
3418 name2 = cf_section_name2(g->cs);
3419 c->debug_name = talloc_asprintf(c, "%s %s", group_name[c->type], name2);
3422 * Don't walk over these.
3424 if ((g->cond->type == COND_TYPE_TRUE) ||
3425 (g->cond->type == COND_TYPE_FALSE)) {
3430 * The compilation code takes care of
3431 * simplifying 'true' and 'false'
3432 * conditions. For others, we have to do
3433 * a second pass to parse && compile xlats.
3435 if (!fr_condition_walk(g->cond, pass2_callback, NULL)) {
3439 if (!modcall_pass2(g->children)) return false;
3440 g->done_pass2 = true;
3446 g = mod_callabletogroup(c);
3447 if (g->done_pass2) return true;
3449 name2 = cf_section_name2(g->cs);
3450 c->debug_name = talloc_asprintf(c, "%s %s", group_name[c->type], name2);
3453 * We had &Foo-Bar, where Foo-Bar is
3454 * defined by a module.
3457 rad_assert(c->name != NULL);
3458 rad_assert(c->name[0] == '&');
3459 rad_assert(cf_section_name2_type(g->cs) == T_BARE_WORD);
3461 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name,
3462 cf_section_name2_type(g->cs),
3463 REQUEST_CURRENT, PAIR_LIST_REQUEST);
3465 char *spaces, *text;
3468 fr_canonicalize_error(g->cs, &spaces, &text, slen, fr_strerror());
3470 cf_log_err_cs(g->cs, "Syntax error");
3471 cf_log_err_cs(g->cs, "%s", c->name);
3472 cf_log_err_cs(g->cs, "%s^ %s", spaces, text);
3474 talloc_free(spaces);
3484 * Statically compile xlats
3486 if (g->vpt->type == TMPL_TYPE_XLAT) {
3487 if (!pass2_xlat_compile(cf_sectiontoitem(g->cs),
3488 &g->vpt, true, NULL)) {
3496 * We may have: switch Foo-Bar {
3498 * where Foo-Bar is an attribute defined
3499 * by a module. Since there's no leading
3500 * &, it's parsed as a literal. But if
3501 * we can parse it as an attribute,
3502 * switch to using that.
3504 if (g->vpt->type == TMPL_TYPE_LITERAL) {
3505 value_pair_tmpl_t *vpt;
3507 slen = tmpl_afrom_str(g->cs, &vpt, c->name, cf_section_name2_type(g->cs),
3508 REQUEST_CURRENT, PAIR_LIST_REQUEST);
3509 if (slen < 0) goto parse_error;
3510 if (vpt->type == TMPL_TYPE_ATTR) {
3511 talloc_free(g->vpt);
3519 * Warn about old-style configuration.
3521 * DEPRECATED: switch User-Name { ...
3522 * ALLOWED : switch &User-Name { ...
3524 if ((g->vpt->type == TMPL_TYPE_ATTR) &&
3525 (c->name[0] != '&')) {
3526 WARN("%s[%d]: Please change %s to &%s",
3527 cf_section_filename(g->cs),
3528 cf_section_lineno(g->cs),
3533 if (!modcall_pass2(g->children)) return false;
3534 g->done_pass2 = true;
3538 g = mod_callabletogroup(c);
3539 if (g->done_pass2) return true;
3541 name2 = cf_section_name2(g->cs);
3543 c->debug_name = group_name[c->type];
3545 c->debug_name = talloc_asprintf(c, "%s %s", group_name[c->type], name2);
3548 rad_assert(c->parent != NULL);
3549 rad_assert(c->parent->type == MOD_SWITCH);
3552 * The statement may refer to an
3553 * attribute which doesn't exist until
3554 * all of the modules have been loaded.
3555 * Check for that now.
3557 if (!g->vpt && c->name &&
3558 (c->name[0] == '&') &&
3559 (cf_section_name2_type(g->cs) == T_BARE_WORD)) {
3560 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name,
3561 cf_section_name2_type(g->cs),
3562 REQUEST_CURRENT, PAIR_LIST_REQUEST);
3563 if (slen < 0) goto parse_error;
3567 * We have "case {...}". There's no
3568 * argument, so we don't need to check
3571 if (!g->vpt) goto do_children;
3574 * Do type-specific checks on the case statement
3576 if (g->vpt->type == TMPL_TYPE_LITERAL) {
3579 f = mod_callabletogroup(mc->parent);
3580 rad_assert(f->vpt != NULL);
3583 * We're switching over an
3584 * attribute. Check that the
3587 if (f->vpt->type == TMPL_TYPE_ATTR) {
3588 rad_assert(f->vpt->tmpl_da != NULL);
3590 if (!tmpl_cast_in_place(g->vpt, f->vpt->tmpl_da)) {
3591 cf_log_err_cs(g->cs, "Invalid argument for case statement: %s",
3601 * Compile and sanity check xlat
3604 if (g->vpt->type == TMPL_TYPE_XLAT) {
3607 f = mod_callabletogroup(mc->parent);
3608 rad_assert(f->vpt != NULL);
3611 * Don't expand xlat's into an
3612 * attribute of a different type.
3614 if (f->vpt->type == TMPL_TYPE_ATTR) {
3615 if (!pass2_xlat_compile(cf_sectiontoitem(g->cs),
3616 &g->vpt, true, f->vpt->tmpl_da)) {
3620 if (!pass2_xlat_compile(cf_sectiontoitem(g->cs),
3621 &g->vpt, true, NULL)) {
3627 if (!modcall_pass2(g->children)) return false;
3628 g->done_pass2 = true;
3632 g = mod_callabletogroup(c);
3633 if (g->done_pass2) return true;
3635 name2 = cf_section_name2(g->cs);
3636 c->debug_name = talloc_asprintf(c, "%s %s", group_name[c->type], name2);
3639 * Already parsed, handle the children.
3641 if (g->vpt) goto check_children;
3644 * We had &Foo-Bar, where Foo-Bar is
3645 * defined by a module.
3647 rad_assert(c->name != NULL);
3648 rad_assert(c->name[0] == '&');
3649 rad_assert(cf_section_name2_type(g->cs) == T_BARE_WORD);
3652 * The statement may refer to an
3653 * attribute which doesn't exist until
3654 * all of the modules have been loaded.
3655 * Check for that now.
3657 slen = tmpl_afrom_str(g->cs, &g->vpt, c->name, cf_section_name2_type(g->cs),
3658 REQUEST_CURRENT, PAIR_LIST_REQUEST);
3659 if (slen < 0) goto parse_error;
3662 rad_assert(g->vpt->type == TMPL_TYPE_ATTR);
3663 if (g->vpt->tmpl_num != NUM_ALL) {
3664 cf_log_err_cs(g->cs, "MUST NOT use instance selectors in 'foreach'");
3667 if (!modcall_pass2(g->children)) return false;
3668 g->done_pass2 = true;
3672 c->debug_name = group_name[c->type];
3676 g = mod_callabletogroup(c);
3677 c->debug_name = talloc_asprintf(c, "%s %s", group_name[c->type], cf_section_name1(g->cs));
3682 case MOD_LOAD_BALANCE:
3683 case MOD_REDUNDANT_LOAD_BALANCE:
3684 c->debug_name = group_name[c->type];
3689 g = mod_callabletogroup(c);
3691 c->debug_name = mc->name; /* for authorize, etc. */
3693 } else if (c->type == MOD_GROUP) { /* for Auth-Type, etc. */
3694 char const *name1 = cf_section_name1(g->cs);
3696 if (strcmp(name1, group_name[c->type]) != 0) {
3697 c->debug_name = talloc_asprintf(c, "%s %s", name1, cf_section_name2(g->cs));
3701 if (g->done_pass2) return true;
3702 if (!modcall_pass2(g->children)) return false;
3703 g->done_pass2 = true;
3711 void modcall_debug(modcallable *mc, int depth)
3715 value_pair_map_t *map;
3718 for (this = mc; this != NULL; this = this->next) {
3719 switch (this->type) {
3724 modsingle *single = mod_callabletosingle(this);
3726 DEBUG("%.*s%s", depth, modcall_spaces,
3727 single->modinst->name);
3733 g = mod_callabletogroup(this);
3734 DEBUG("%.*s%s {", depth, modcall_spaces,
3735 group_name[this->type]);
3737 for (map = g->map; map != NULL; map = map->next) {
3738 map_prints(buffer, sizeof(buffer), map);
3739 DEBUG("%.*s%s", depth + 1, modcall_spaces, buffer);
3742 DEBUG("%.*s}", depth, modcall_spaces);
3746 g = mod_callabletogroup(this);
3747 DEBUG("%.*s%s {", depth, modcall_spaces,
3748 group_name[this->type]);
3749 modcall_debug(g->children, depth + 1);
3750 DEBUG("%.*s}", depth, modcall_spaces);
3755 g = mod_callabletogroup(this);
3756 fr_cond_sprint(buffer, sizeof(buffer), g->cond);
3757 DEBUG("%.*s%s (%s) {", depth, modcall_spaces,
3758 group_name[this->type], buffer);
3759 modcall_debug(g->children, depth + 1);
3760 DEBUG("%.*s}", depth, modcall_spaces);
3765 g = mod_callabletogroup(this);
3766 tmpl_prints(buffer, sizeof(buffer), g->vpt, NULL);
3767 DEBUG("%.*s%s %s {", depth, modcall_spaces,
3768 group_name[this->type], buffer);
3769 modcall_debug(g->children, depth + 1);
3770 DEBUG("%.*s}", depth, modcall_spaces);
3775 g = mod_callabletogroup(this);
3776 DEBUG("%.*s%s %s {", depth, modcall_spaces,
3777 group_name[this->type], this->name);
3778 modcall_debug(g->children, depth + 1);
3779 DEBUG("%.*s}", depth, modcall_spaces);
3783 DEBUG("%.*sbreak", depth, modcall_spaces);
3788 g = mod_callabletogroup(this);
3789 DEBUG("%.*s%s {", depth, modcall_spaces,
3790 group_name[this->type]);
3791 modcall_debug(g->children, depth + 1);
3792 DEBUG("%.*s}", depth, modcall_spaces);
3796 case MOD_LOAD_BALANCE:
3797 case MOD_REDUNDANT_LOAD_BALANCE:
3798 g = mod_callabletogroup(this);
3799 DEBUG("%.*s%s {", depth, modcall_spaces,
3800 group_name[this->type]);
3801 modcall_debug(g->children, depth + 1);
3802 DEBUG("%.*s}", depth, modcall_spaces);