The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
xlat_expr.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: 64f5d0401e0561e1bfd2565d5433323165f94167 $
19 *
20 * @file xlat_expr.c
21 * @brief Tokenizers and support functions for xlat expressions
22 *
23 * @copyright 2021 The FreeRADIUS server project
24 * @copyright 2021 Network RADIUS SAS (legal@networkradius.com)
25 */
26RCSID("$Id: 64f5d0401e0561e1bfd2565d5433323165f94167 $")
27
28#include <freeradius-devel/server/base.h>
29#include <freeradius-devel/unlang/xlat_priv.h>
30#include <freeradius-devel/util/calc.h>
31#include <freeradius-devel/util/debug.h>
32#include <freeradius-devel/server/tmpl_dcursor.h>
33
34#undef XLAT_DEBUG
35#ifdef DEBUG_XLAT
36# define XLAT_DEBUG(_fmt, ...) DEBUG3("%s[%i] "_fmt, __FILE__, __LINE__, ##__VA_ARGS__)
37#else
38# define XLAT_DEBUG(...)
39#endif
40
41/*
42 * The new tokenizer accepts most things which are accepted by the old one. Many of the errors will be
43 * different, though.
44 *
45 * @todo - add a "output" fr_type_t to xlat_t, which is mainly used by the comparison functions. Right
46 * now it will happily parse things like:
47 *
48 * (1 < 2) < 3
49 *
50 * though the result of (1 < 2) is a boolean, so the result is always true. We probably want to have
51 * that as a compile-time error / check. This can probably just be done with xlat_purify() ? which
52 * doesn't need to interpret the LHS, but just knows its limits. We perhaps want a "range compare"
53 * function, which just checks ranges on one side against values on the right.
54 *
55 * Even worse, when we do "((bool) 1) < 3", the RHS is cast to the type of the LHS by
56 * tmpl_afrom_substr(). This is because we pass the LHS data type recursively down, which works most of
57 * the time, but not all of the time. There are currently hacks in the "upcast" code here to fix this,
58 * but it's a hack.
59 *
60 * @todo - add instantiation routines for assignment operations. This lets us do things
61 * like:
62 * if ((&foo += 4) > 6) ...
63 *
64 * However, this would also require us adding an edit list pointer to the xlat evaluation functions,
65 * which is not trivial. Or, maybe we attach it to the request somehow?
66 */
67
68static xlat_exp_t *xlat_exists_alloc(TALLOC_CTX *ctx, xlat_exp_t *child);
69
70static void xlat_func_append_arg(xlat_exp_t *head, xlat_exp_t *node, bool exists)
71{
72 xlat_exp_t *group;
73
74 fr_assert(head->type == XLAT_FUNC);
75
76 /*
77 * Wrap existence checks for attribute reference.
78 */
79 if (exists && (node->type == XLAT_TMPL) && tmpl_contains_attr(node->vpt)) {
80 node = xlat_exists_alloc(head, node);
81 }
82
83 if (!head->call.args) {
84 MEM(head->call.args = xlat_exp_head_alloc(head));
85 head->call.args->is_argv = true;
86 }
87
88 /*
89 * Wrap it in a group.
90 */
91 group = xlat_exp_alloc(head->call.args, XLAT_GROUP, NULL, 0);
92 group->quote = T_BARE_WORD;
93
94 xlat_exp_set_name_shallow(group, node->fmt); /* not entirely correct, but good enough for now */
95 group->flags = node->flags;
96
97 talloc_steal(group->group, node);
98 xlat_exp_insert_tail(group->group, node);
99
100 xlat_exp_insert_tail(head->call.args, group);
101
102 xlat_flags_merge(&head->flags, &head->call.args->flags);
103}
104
105
106/** Allocate a specific cast node.
107 *
108 * With the first argument being a UINT8 of the data type.
109 * See xlat_func_cast() for the implementation.
110 *
111 */
112static xlat_exp_t *xlat_exists_alloc(TALLOC_CTX *ctx, xlat_exp_t *child)
113{
114 xlat_exp_t *node;
115
116 fr_assert(child->type == XLAT_TMPL);
117 fr_assert(tmpl_contains_attr(child->vpt));
118
119 /*
120 * Create an "exists" node.
121 */
122 MEM(node = xlat_exp_alloc(ctx, XLAT_FUNC, "exists", 6));
123 xlat_exp_set_name_shallow(node, child->vpt->name);
124
125 MEM(node->call.func = xlat_func_find("exists", 6));
126 fr_assert(node->call.func != NULL);
127
128 /*
129 * The attribute may need resolving, in which case we have to set the flag as appropriate.
130 */
131 node->flags = (xlat_flags_t) { .needs_resolving = tmpl_needs_resolving(child->vpt)};
132
133 if (!node->flags.needs_resolving) node->call.dict = tmpl_attr_tail_da(child->vpt)->dict;
134
135 xlat_func_append_arg(node, child, false);
136
137 return node;
138}
139
140
142{
143 size_t at_in = fr_sbuff_used_total(out);
144
145 FR_SBUFF_IN_STRCPY_RETURN(out, fr_tokens[node->call.func->token]);
146 xlat_print_node(out, node->call.args, xlat_exp_head(node->call.args), e_rules, 0);
147
148 return fr_sbuff_used_total(out) - at_in;
149}
150
152{
153 size_t at_in = fr_sbuff_used_total(out);
154 xlat_exp_t *child = xlat_exp_head(node->call.args);
155
156 fr_assert(child != NULL);
157
159 xlat_print_node(out, node->call.args, child, e_rules, 0); /* prints a space after the first argument */
160
161 FR_SBUFF_IN_STRCPY_RETURN(out, fr_tokens[node->call.func->token]);
163
164 child = xlat_exp_next(node->call.args, child);
165 fr_assert(child != NULL);
166
167 xlat_print_node(out, node->call.args, child, e_rules, 0);
168
170
171 return fr_sbuff_used_total(out) - at_in;
172}
173
174static int xlat_expr_resolve_binary(xlat_exp_t *node, UNUSED void *inst, xlat_res_rules_t const *xr_rules)
175{
176 xlat_exp_t *arg1, *arg2;
177 xlat_exp_t *a, *b;
178 tmpl_res_rules_t my_tr_rules;
179
180 XLAT_DEBUG("RESOLVE %s\n", node->fmt);
181
182 arg1 = xlat_exp_head(node->call.args);
183 fr_assert(arg1);
184 fr_assert(arg1->type == XLAT_GROUP);
185
186 arg2 = xlat_exp_next(node->call.args, arg1);
187 fr_assert(arg2);
188 fr_assert(arg2->type == XLAT_GROUP);
189
190 a = xlat_exp_head(arg1->group);
191 b = xlat_exp_head(arg2->group);
192
193 /*
194 * We have many things here, just call resolve recursively.
195 */
196 if (xlat_exp_next(arg1->group, a) || (xlat_exp_next(arg2->group, b))) goto resolve;
197
198 /*
199 * Anything else must get resolved at run time.
200 */
201 if ((a->type != XLAT_TMPL) || (b->type != XLAT_TMPL)) goto resolve;
202
203 /*
204 * The tr_rules should always contain dict_def
205 */
206 fr_assert(xr_rules); /* always set by xlat_resolve() */
207 if (xr_rules->tr_rules) {
208 my_tr_rules = *xr_rules->tr_rules;
209 } else {
210 my_tr_rules = (tmpl_res_rules_t) { };
211 }
212
213 /*
214 * The LHS attribute dictates the enumv for the RHS one.
215 */
216 if (tmpl_contains_attr(a->vpt)) {
217 XLAT_DEBUG("\ta - %s %s\n", a->fmt, b->fmt);
218
219 if (a->flags.needs_resolving) {
220 XLAT_DEBUG("\tresolve attr a\n");
221 if (tmpl_resolve(a->vpt, &my_tr_rules) < 0) return -1;
222 a->flags.needs_resolving = false;
223 }
224
225 my_tr_rules.enumv = tmpl_attr_tail_da(a->vpt);
226
227 XLAT_DEBUG("\tresolve other b\n");
228 if (tmpl_resolve(b->vpt, &my_tr_rules) < 0) return -1;
229
230 b->flags.needs_resolving = false;
231 b->flags.pure = tmpl_is_data(b->vpt);
232 b->flags.constant = b->flags.pure;
233 goto flags;
234 }
235
236 if (tmpl_contains_attr(b->vpt)) {
237 XLAT_DEBUG("\tb - %s %s\n", a->fmt, b->fmt);
238
239 if (b->flags.needs_resolving) {
240 XLAT_DEBUG("\tresolve attr b\n");
241 if (tmpl_resolve(b->vpt, &my_tr_rules) < 0) return -1;
242
243 b->flags.needs_resolving = false;
244 }
245
246 my_tr_rules.enumv = tmpl_attr_tail_da(b->vpt);
247
248 XLAT_DEBUG("\tresolve other a\n");
249 if (tmpl_resolve(a->vpt, &my_tr_rules) < 0) return -1;
250
251 a->flags.needs_resolving = false;
252 a->flags.pure = tmpl_is_data(a->vpt);
253 a->flags.constant = a->flags.pure;
254 goto flags;
255 }
256
257resolve:
258 /*
259 * This call will fix everything recursively.
260 */
261 return xlat_resolve(node->call.args, xr_rules);
262
263flags:
264 arg1->flags = arg1->group->flags = a->flags;
265 arg2->flags = arg2->group->flags = b->flags;
266 xlat_flags_merge(&node->call.args->flags, &arg2->flags);
267
270
273
274 node->call.args->flags.needs_resolving = false;
275 xlat_flags_merge(&node->flags, &node->call.args->flags);
276
277 return 0;
278}
279
281{
282 switch (type) {
283 case FR_TYPE_STRING:
284 fr_value_box_strdup_shallow(vb, NULL, "", false);
285 break;
286
287 case FR_TYPE_OCTETS:
288 fr_value_box_memdup_shallow(vb, NULL, (void const *) "", 0, false);
289 break;
290
291 default:
292 fr_value_box_init(vb, type, NULL, false);
293 break;
294 }
295}
296
298 { .required = false, .type = FR_TYPE_VOID },
299 { .required = false, .type = FR_TYPE_VOID },
301};
302
304 UNUSED xlat_ctx_t const *xctx,
305 request_t *request, fr_value_box_list_t *in,
306 fr_token_t op,
307 fr_type_t default_type, fr_dict_attr_t const *enumv)
308{
309 int rcode;
310 fr_value_box_t *dst, *a, *b;
311 fr_value_box_t one, two;
312
313 MEM(dst = fr_value_box_alloc_null(ctx));
314
315 /*
316 * Each argument is a FR_TYPE_GROUP, with one or more elements in a list.
317 */
318 a = fr_value_box_list_head(in);
319 if (!a) {
320 REDEBUG("Left argument to %s is missing", fr_tokens[op]);
321 fail:
322 talloc_free(dst);
323 return XLAT_ACTION_FAIL;
324 }
325
326 b = fr_value_box_list_next(in, a);
327 if (!b) {
328 REDEBUG("Right argument to %s is missing", fr_tokens[op]);
329 goto fail;
330 }
331
333
334 if (fr_value_box_list_num_elements(&a->vb_group) > 1) {
335 REDEBUG("Expected one value as the first argument, got %u",
336 fr_value_box_list_num_elements(&a->vb_group));
337 goto fail;
338 }
339 a = fr_value_box_list_head(&a->vb_group);
340
341 if (fr_value_box_list_num_elements(&b->vb_group) > 1) {
342 REDEBUG("Expected one value as the second argument, got %u",
343 fr_value_box_list_num_elements(&b->vb_group));
344 goto fail;
345 }
346 b = fr_value_box_list_head(&b->vb_group);
347
348 if (!a) {
349 a = &one;
350 fr_value_box_init_zero(a, b ? b->type : default_type);
351 }
352
353 if (!b) {
354 b = &two;
355 fr_value_box_init_zero(b, a ? a->type : default_type);
356 }
357
358 rcode = fr_value_calc_binary_op(dst, dst, default_type, a, op, b);
359 if (rcode < 0) {
360 RPEDEBUG("Failed calculating '%pR %s %pR'", a, fr_tokens[op], b);
361 goto fail;
362 }
363
364 /*
365 * Over-write, but only if it's present. Otherwise leave
366 * any existing enum alone.
367 */
368 if (enumv) dst->enumv = enumv;
370
371 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
372 return XLAT_ACTION_DONE;
373}
374
375#define XLAT_BINARY_FUNC(_name, _op) \
376static xlat_action_t xlat_func_ ## _name(TALLOC_CTX *ctx, fr_dcursor_t *out, \
377 xlat_ctx_t const *xctx, \
378 request_t *request, fr_value_box_list_t *in) \
379{ \
380 return xlat_binary_op(ctx, out, xctx, request, in, _op, FR_TYPE_NULL, NULL); \
381}
382
383XLAT_BINARY_FUNC(op_add, T_ADD)
384XLAT_BINARY_FUNC(op_sub, T_SUB)
385XLAT_BINARY_FUNC(op_mul, T_MUL)
386XLAT_BINARY_FUNC(op_div, T_DIV)
387XLAT_BINARY_FUNC(op_mod, T_MOD)
388XLAT_BINARY_FUNC(op_and, T_AND)
390XLAT_BINARY_FUNC(op_xor, T_XOR)
391XLAT_BINARY_FUNC(op_rshift, T_RSHIFT)
392XLAT_BINARY_FUNC(op_lshift, T_LSHIFT)
393
395 { .required = false, .type = FR_TYPE_VOID },
396 { .required = false, .type = FR_TYPE_VOID },
398};
399
400/*
401 * @todo - arguably this function should process its own arguments, like logical_or.
402 *
403 * That way it can return XLAT_ACTION_FAIL if either argument fails to be found,
404 * or if the comparison matches, it returns the RHS value. This behavior will
405 * let us to multiple comparisons, like:
406 *
407 * if (0 < x < 5) ...
408 *
409 * Which is then syntactic sugar for
410 *
411 * if ((0 < x) < 5) ...
412 *
413 * That means the comparisons no longer return "bool", so if we
414 * want to do this, the change has to be made before v4 is
415 * released.
416 *
417 * Other operators like "+=" would return their LHS value. But in order to do that, we would have to
418 * update the expression parser to allow in-place edits, and that may be a fair bit of work.
419 *
420 * It also lets us do more interesting selectors, such as:
421 *
422 * foo || (0 < x)
423 *
424 * which if "foo" doesn't exist, evaluates the RHS, and then returns "x" only if x is greater than zero.
425 * This short-hand can remove a lot of complex / nested "if" conditions.
426 *
427 * It could also allow us to do better attribute filtering:
428 *
429 * foo := (0 < foo < 5)
430 *
431 * Which ensures that "foo" has value only 1..4.
432 *
433 * It would be nice to have a syntax for "self", so we could instead do:
434 *
435 * foo := (0 < $$ < 5)
436 *
437 * Which could then also be used inside of attribute selectors:
438 *
439 * foreach foo (Vendor-Specific.Cisco.AVPair[$$ =~ /^x/]) { ...
440 *
441 * and now that we have pair cursors as value-boxes, this becomes a lot easier.
442 * "$$" then becomes syntactic sugar for "the pair at the current cursor".
443 *
444 * It also means tracking somehow the value of $$ in the interpreter? Maybe as a short-hand, just update
445 * the #request_t to add a #fr_pair_t of the current cursor value. This is a horrible hack, but would be
446 * easy to do. It doesn't allow nested cursors, but whatever. The syntax for that would be hard to get
447 * right.
448 */
449static xlat_action_t xlat_cmp_op(TALLOC_CTX *ctx, fr_dcursor_t *out,
450 UNUSED xlat_ctx_t const *xctx,
451 UNUSED request_t *request, fr_value_box_list_t *in,
452 fr_token_t op)
453{
454 int rcode;
455 fr_value_box_t *dst, *a, *b;
456
457 /*
458 * Each argument is a FR_TYPE_GROUP, with one or more elements in a list.
459 */
460 a = fr_value_box_list_head(in);
461 if (!a) {
462 REDEBUG("Left argument to %s is missing", fr_tokens[op]);
463 return XLAT_ACTION_FAIL;
464 }
465
466 b = fr_value_box_list_next(in, a);
467 if (!b) {
468 REDEBUG("Right argument to %s is missing", fr_tokens[op]);
469 return XLAT_ACTION_FAIL;
470 }
471
472 fr_assert(a->type == FR_TYPE_GROUP);
473 fr_assert(b->type == FR_TYPE_GROUP);
474
476
478
479 rcode = fr_value_calc_list_cmp(dst, dst, &a->vb_group, op, &b->vb_group);
480 if (rcode < 0) {
481 talloc_free(dst);
482 return XLAT_ACTION_FAIL;
483 }
484
485 fr_assert(dst->type == FR_TYPE_BOOL);
486 dst->enumv = attr_expr_bool_enum;
487
489 VALUE_BOX_LIST_VERIFY((fr_value_box_list_t *)out->dlist);
490 return XLAT_ACTION_DONE;
491}
492
493
494#define XLAT_CMP_FUNC(_name, _op) \
495static xlat_action_t xlat_func_ ## _name(TALLOC_CTX *ctx, fr_dcursor_t *out, \
496 xlat_ctx_t const *xctx, \
497 request_t *request, fr_value_box_list_t *in) \
498{ \
499 return xlat_cmp_op(ctx, out, xctx, request, in, _op); \
500}
501
503XLAT_CMP_FUNC(cmp_ne, T_OP_NE)
504XLAT_CMP_FUNC(cmp_lt, T_OP_LT)
505XLAT_CMP_FUNC(cmp_le, T_OP_LE)
506XLAT_CMP_FUNC(cmp_gt, T_OP_GT)
507XLAT_CMP_FUNC(cmp_ge, T_OP_GE)
510
511typedef struct {
513 regex_t *regex; //!< precompiled regex
514 xlat_exp_t *xlat; //!< to expand
515 fr_regex_flags_t *regex_flags;
517
518typedef struct {
520 fr_value_box_list_t list;
522
523static fr_slen_t xlat_expr_print_regex(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
524{
525 size_t at_in = fr_sbuff_used_total(out);
526 xlat_exp_t *child = xlat_exp_head(node->call.args);
527 xlat_regex_inst_t *inst = instance;
528
529 fr_assert(child != NULL);
530
532 xlat_print_node(out, node->call.args, child, e_rules, 0);
533
534 /*
535 * A space is printed after the first argument only if
536 * there's a second one. So add one if we "ate" the second argument.
537 */
538 if (inst->xlat) FR_SBUFF_IN_CHAR_RETURN(out, ' ');
539
540 FR_SBUFF_IN_STRCPY_RETURN(out, fr_tokens[node->call.func->token]);
542
543 /*
544 * Regexes which aren't instantiated: only for unit tests.
545 */
546 if (!inst->xlat) {
547 child = xlat_exp_next(node->call.args, child);
548
549 fr_assert(child != NULL);
550 fr_assert(!xlat_exp_next(node->call.args, child));
551 fr_assert(child->type == XLAT_GROUP);
552
556
557 child = xlat_exp_head(child->group);
558 fr_assert(child->type == XLAT_TMPL);
559
560 /*
561 * The RHS may be a group
562 */
563 FR_SBUFF_RETURN(regex_flags_print, out, tmpl_regex_flags(child->vpt));
564 goto done;
565 }
566
568
569 if (inst->xlat->quote == T_SINGLE_QUOTED_STRING) FR_SBUFF_IN_CHAR_RETURN(out, 'm');
571 FR_SBUFF_IN_STRCPY_RETURN(out, inst->xlat->vpt->name);
573
574 FR_SBUFF_RETURN(regex_flags_print, out, inst->regex_flags);
575
576done:
578
579 return fr_sbuff_used_total(out) - at_in;
580}
581
582
583/*
584 * Each argument is it's own head, because we do NOT always want
585 * to go to the next argument.
586 */
588{
589 xlat_regex_inst_t *inst = talloc_get_type_abort(xctx->inst, xlat_regex_inst_t);
590 xlat_exp_t *lhs, *rhs, *regex;
591
592 lhs = xlat_exp_head(xctx->ex->call.args);
593 rhs = xlat_exp_next(xctx->ex->call.args, lhs);
594
595 fr_assert(rhs);
596 fr_assert(rhs->type == XLAT_GROUP);
597 (void) fr_dlist_remove(&xctx->ex->call.args->dlist, rhs);
598
599 regex = xlat_exp_head(rhs->group);
600 fr_assert(tmpl_contains_regex(regex->vpt));
601
602 inst->op = xctx->ex->call.func->token;
603 inst->regex_flags = tmpl_regex_flags(regex->vpt);
604
605 inst->xlat = talloc_steal(inst, regex);
606 talloc_free(rhs); /* group wrapper is no longer needed */
607
608 /*
609 * The RHS is more then just one regex node, it has to be dynamically expanded.
610 */
611 if (tmpl_contains_xlat(regex->vpt)) {
612 return 0;
613 }
614
615 if (tmpl_is_data_unresolved(regex->vpt)) {
616 fr_strerror_const("Regex must be resolved before instantiation");
617 return -1;
618 }
619
620 /*
621 * Must have been caught in the parse phase.
622 */
623 fr_assert(tmpl_is_regex(regex->vpt));
624
625 inst->regex = tmpl_regex(regex->vpt);
626
627 return 0;
628}
629
630
632 { .required = true, .type = FR_TYPE_STRING },
633 { .concat = true, .type = FR_TYPE_STRING },
635};
636
638 { .required = true, .concat = true, .type = FR_TYPE_STRING }, /* regex string */
639 { .required = true, .concat = false, .type = FR_TYPE_STRING }, /* broken out things to match */
640 { .required = false, .concat = true, .type = FR_TYPE_STRING }, /* flags */
642};
643
644
645/** Perform a regular expressions comparison between two operands
646 *
647 * @param[in] ctx to allocate resulting box in.
648 * @param[in] request The current request.
649 * @param[in] in list of item or items
650 * @param[in,out] preg Pointer to pre-compiled or runtime-compiled
651 * regular expression. In the case of runtime-compiled
652 * the pattern may be stolen by the `regex_sub_to_request`
653 * function as the original pattern is needed to resolve
654 * capture groups.
655 * The caller should only free the `regex_t *` if it
656 * compiled it, and the pointer has not been set to NULL
657 * when this function returns.
658 * @param[out] out Where result is written.
659 * @param[in] op the operation to perform.
660 * @return
661 * - -1 on failure.
662 * - 0 for "no match".
663 * - 1 for "match".
664 */
665static xlat_action_t xlat_regex_do_op(TALLOC_CTX *ctx, request_t *request, fr_value_box_list_t *in, regex_t **preg,
667{
668 uint32_t subcaptures;
669 int ret = 0;
670
671 fr_regmatch_t *regmatch;
672 fr_value_box_t *dst;
673 fr_value_box_t *arg, *vb;
674 fr_sbuff_t *agg;
675 char const *subject;
676 size_t len;
677 fr_value_box_t safety = {};
678
679 FR_SBUFF_TALLOC_THREAD_LOCAL(&agg, 256, 8192);
680
681 arg = fr_value_box_list_head(in);
682 fr_assert(arg != NULL);
683 fr_assert(arg->type == FR_TYPE_GROUP);
684
685 subcaptures = regex_subcapture_count(*preg);
686 if (!subcaptures) subcaptures = REQUEST_MAX_REGEX + 1; /* +1 for %{0} (whole match) capture group */
687 MEM(regmatch = regex_match_data_alloc(NULL, subcaptures));
688
689 while ((vb = fr_value_box_list_pop_head(&arg->vb_group)) != NULL) {
690 if (vb->type == FR_TYPE_STRING) {
691 subject = vb->vb_strvalue;
692 len = vb->vb_length;
693 fr_value_box_safety_copy(&safety, vb);
694
695 } else {
696 fr_value_box_list_t list;
697
698 fr_value_box_list_init(&list);
699 fr_value_box_list_insert_head(&list, vb);
701
702 vb = NULL;
703
704 /*
705 * Concatenate everything, and escape untrusted inputs.
706 */
707 if (fr_value_box_list_concat_as_string(&safety, agg, &list, NULL, 0, &regex_escape_rules,
708 FR_VALUE_BOX_LIST_FREE_BOX, FR_REGEX_SAFE_FOR, true) < 0) {
709 RPEDEBUG("Failed concatenating regular expression string");
710 talloc_free(regmatch);
711 return XLAT_ACTION_FAIL;
712 }
713
714 subject = fr_sbuff_start(agg);
715 len = fr_sbuff_used(agg);
716 }
717
718 /*
719 * Evaluate the expression
720 */
721 ret = regex_exec(*preg, subject, len, regmatch);
722 talloc_free(vb);
723
724 switch (ret) {
725 default:
726 RPEDEBUG("REGEX failed");
727 talloc_free(regmatch);
728 return XLAT_ACTION_FAIL;
729
730 case 0:
731 regex_sub_to_request(request, NULL, NULL, NULL); /* clear out old entries */
732 continue;
733
734 case 1:
735 regex_sub_to_request(request, preg, &regmatch, &safety);
736 goto done;
737 }
738 }
739
740done:
741 talloc_free(regmatch); /* free if not consumed */
742
744 dst->vb_bool = (ret == (op == T_OP_REG_EQ));
745
747
748 return XLAT_ACTION_DONE;
749}
750
752 xlat_ctx_t const *xctx,
753 request_t *request, fr_value_box_list_t *in)
754{
756 xlat_regex_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_regex_rctx_t);
757 ssize_t slen;
758 regex_t *preg = NULL;
759 fr_sbuff_t *agg;
760
761 FR_SBUFF_TALLOC_THREAD_LOCAL(&agg, 256, 8192);
762
763 /*
764 * If the expansions fails, then we fail the entire thing.
765 */
766 if (!XLAT_RESULT_SUCCESS(&rctx->last_result)) {
767 talloc_free(rctx);
768 return XLAT_ACTION_FAIL;
769 }
770
771 /*
772 * Because we expanded the RHS ourselves, the "concat"
773 * flag to the RHS argument is ignored. So we just
774 * concatenate it here. We escape the various untrusted inputs.
775 */
776 if (fr_value_box_list_concat_as_string(NULL, agg, &rctx->list, NULL, 0, &regex_escape_rules,
777 FR_VALUE_BOX_LIST_FREE_BOX, FR_REGEX_SAFE_FOR, true) < 0) {
778 RPEDEBUG("Failed concatenating regular expression string");
779 return XLAT_ACTION_FAIL;
780 }
781
782 fr_assert(inst->regex == NULL);
783
784 slen = regex_compile(rctx, &preg, fr_sbuff_start(agg), fr_sbuff_used(agg),
785 tmpl_regex_flags(inst->xlat->vpt), true, true); /* flags, allow subcaptures, at runtime */
786 if (slen <= 0) return XLAT_ACTION_FAIL;
787
788 return xlat_regex_do_op(ctx, request, in, &preg, out, inst->op);
789}
790
792 xlat_ctx_t const *xctx,
793 request_t *request, fr_value_box_list_t *in,
794 fr_token_t op)
795{
797 xlat_regex_rctx_t *rctx;
798 regex_t *preg;
799
800 /*
801 * Just run precompiled regexes.
802 */
803 if (inst->regex) {
804 preg = tmpl_regex(inst->xlat->vpt);
805
806 return xlat_regex_do_op(ctx, request, in, &preg, out, op);
807 }
808
809 MEM(rctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), xlat_regex_rctx_t));
810 fr_value_box_list_init(&rctx->list);
811
812 if (unlang_xlat_yield(request, xlat_regex_resume, NULL, 0, rctx) != XLAT_ACTION_YIELD) {
813 fail:
814 talloc_free(rctx);
815 return XLAT_ACTION_FAIL;
816 }
817
818 if (unlang_xlat_push(ctx, &rctx->last_result, &rctx->list,
819 request, tmpl_xlat(inst->xlat->vpt), UNLANG_SUB_FRAME) < 0) goto fail;
820
822}
823
824#define XLAT_REGEX_FUNC(_name, _op) \
825static xlat_action_t xlat_func_ ## _name(TALLOC_CTX *ctx, fr_dcursor_t *out, \
826 xlat_ctx_t const *xctx, \
827 request_t *request, fr_value_box_list_t *in) \
828{ \
829 return xlat_regex_op(ctx, out, xctx, request, in, _op); \
830}
831
834
836 UNUSED xlat_ctx_t const *xctx,
837 request_t *request, fr_value_box_list_t *in)
838{
839 ssize_t slen;
840 regex_t *preg;
841 fr_value_box_t *regex;
842 xlat_action_t action;
843
844 regex = fr_value_box_list_pop_head(in);
845 fr_assert(regex);
846 fr_assert(regex->type == FR_TYPE_STRING);
847
848 slen = regex_compile(ctx, &preg, regex->vb_strvalue, regex->vb_length,
849 NULL, true, true); /* flags, allow subcaptures, at runtime */
850 if (slen <= 0) {
851 RPEDEBUG("Failed parsing regular expression %pV", regex);
852 talloc_free(regex);
853 return XLAT_ACTION_FAIL;
854 }
855
856 action = xlat_regex_do_op(ctx, request, in, &preg, out, T_OP_REG_EQ);
857 talloc_free(regex);
858 talloc_free(preg);
859 return action;
860}
861
868
869typedef struct {
870 TALLOC_CTX *ctx;
872 fr_value_box_t *box; //!< output value-box
874 fr_value_box_list_t list;
876
877static fr_slen_t xlat_expr_print_nary(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
878{
879 size_t at_in = fr_sbuff_used_total(out);
880 xlat_logical_inst_t *inst = instance;
882
884
885 /*
886 * We might get called before the node is instantiated.
887 */
888 if (!inst->argv) {
889 head = node->call.args;
890
891 fr_assert(head != NULL);
892
893 xlat_exp_foreach(head, child) {
894 xlat_print_node(out, head, child, e_rules, 0);
895
896 if (!xlat_exp_next(head, child)) break;
897
898 FR_SBUFF_IN_STRCPY_RETURN(out, fr_tokens[node->call.func->token]);
900 }
901 } else {
902 int i;
903
904 for (i = 0; i < inst->argc; i++) {
905 xlat_print(out, inst->argv[i], e_rules);
906 if (i == (inst->argc - 1)) break;
907
909 FR_SBUFF_IN_STRCPY_RETURN(out, fr_tokens[node->call.func->token]);
910 if ((i + 1) < inst->argc) FR_SBUFF_IN_CHAR_RETURN(out, ' ');
911 }
912 }
913
915
916 return fr_sbuff_used_total(out) - at_in;
917}
918
919/*
920 * This returns "false" for "ignore this argument"
921 *
922 * result is "false" for "delete this argument"
923 * result is "true" for "return this argument".
924 */
925static bool xlat_node_matches_bool(bool *result, xlat_exp_t *parent, xlat_exp_head_t *head, bool sense)
926{
927 fr_value_box_t *box;
928 xlat_exp_t *node;
929
930 if (!head->flags.pure) return false;
931
932 node = xlat_exp_head(head);
933 if (!node || xlat_exp_next(head, node)) {
934 return false;
935 }
936
937 if (node->type == XLAT_BOX) {
938 box = &node->data;
939 goto check;
940 }
941
942 if (node->type != XLAT_TMPL) {
943 return false;
944 }
945
946 if (!tmpl_is_data(node->vpt)) {
947 return false;
948 }
949
950 box = tmpl_value(node->vpt);
951
952check:
953 /*
954 * On "true", replace the entire logical operation with the value-box.
955 *
956 * On "false", omit this argument, and go to the next one.
957 */
958 *result = (fr_value_box_is_truthy(box) == sense);
959
960 if (!*result) return true;
961
963
965 if (!fr_cond_assert(fr_value_box_copy(parent, &parent->data, box) == 0)) return false;
966
967 return true;
968}
969
970/** Undo work which shouldn't have been done. :(
971 *
972 */
974{
975 xlat_exp_t *group, *node;
976
977 group = xlat_exp_head(head);
978 if (!group || xlat_exp_next(head, group)) return;
979
980 if (group->type != XLAT_GROUP) return;
981
982 node = xlat_exp_head(group->group);
983 if (!node || xlat_exp_next(group->group, node)) return;
984
985 (void) fr_dlist_remove(&head->dlist, group);
986 (void) fr_dlist_remove(&group->group->dlist, node);
987 (void) talloc_steal(head, node);
988
989 talloc_free(group);
990
991 fr_dlist_insert_tail(&head->dlist, node);
992 head->flags = node->flags;
993}
994
995/** If any argument resolves to inst->stop_on_match, the entire thing is a bool of inst->stop_on_match.
996 *
997 * If any argument resolves to !inst->stop_on_match, it is removed.
998 */
999static int xlat_expr_logical_purify(xlat_exp_t *node, void *instance, request_t *request)
1000{
1001 int i, j;
1002 int deleted = 0;
1003 bool result;
1004 xlat_logical_inst_t *inst = talloc_get_type_abort(instance, xlat_logical_inst_t);
1005 xlat_exp_head_t *group;
1006
1007 fr_assert(node->type == XLAT_FUNC);
1008
1009 /*
1010 * Don't check the last argument. If everything else gets deleted,
1011 * then we just return the last argument.
1012 */
1013 for (i = 0; i < inst->argc; i++) {
1014 /*
1015 * The argument is pure, so we purify it before
1016 * doing any other checks.
1017 */
1018 if (inst->argv[i]->flags.can_purify) {
1019 if (xlat_purify_list(inst->argv[i], request) < 0) return -1;
1020
1021 /*
1022 * xlat_purify_list expects that its outputs will be arguments to functions, so
1023 * they're grouped. We con't need that, so we ungroup them here.
1024 */
1025 xlat_ungroup(inst->argv[i]);
1026 }
1027
1028 /*
1029 * This returns "false" for "ignore".
1030 *
1031 * result is "false" for "delete this argument"
1032 * result is "true" for "return this argument".
1033 */
1034 if (!xlat_node_matches_bool(&result, node, inst->argv[i], inst->stop_on_match)) continue;
1035
1036 /*
1037 * 0 && EXPR --> 0.
1038 * 1 || EXPR --> 1
1039 *
1040 * Parent is now an XLAT_BOX, so we're done.
1041 */
1042 if (result) return 0;
1043
1044 /*
1045 * We're at the last argument. If we've deleted everything else, then just leave the
1046 * last argument alone. Otherwise some arguments remain, so we can delete the last one.
1047 */
1048 if (((i + 1) == inst->argc) && (deleted == i)) break;
1049
1050 TALLOC_FREE(inst->argv[i]);
1051 deleted++;
1052 }
1053
1054 if (!deleted) return 0;
1055
1056 /*
1057 * Pack the array. We insert at i, and read from j. We don't need to read the deleted entries,
1058 * as they all MUST be NULL.
1059 */
1060 i = 0;
1061 j = -1;
1062 while (i < (inst->argc - deleted)) {
1063 if (inst->argv[i]) {
1064 i++;
1065 continue;
1066 }
1067
1068 /*
1069 * Start searching from the next entry, OR start searching from where we left off before.
1070 */
1071 if (j < 0) j = i + 1;
1072
1073 /*
1074 * Find the first non-NULL entry, and insert it in argv[i]. We search here until the end
1075 * of the array, because we may have deleted entries from the start of the array.
1076 */
1077 while (j < inst->argc) {
1078 if (inst->argv[j]) break;
1079 j++;
1080 }
1081
1082 /*
1083 * Move the entry down, and clear out the tail end of the array.
1084 */
1085 inst->argv[i++] = inst->argv[j];
1086 inst->argv[j++] = NULL;
1087 }
1088
1089 inst->argc -= deleted;
1090
1091 if (inst->argc > 1) return 0;
1092
1093 /*
1094 * Only one argument left. We can hoist the child into ourselves, and omit the logical operation.
1095 */
1096 group = inst->argv[0];
1097 fr_assert(group != NULL);
1098 talloc_steal(node, group);
1099
1102
1103 /* re-print, with purified nodes removed */
1104 {
1105 char *name;
1106
1107 MEM(xlat_aprint(node, &name, group, NULL) >= 0);
1109 }
1110
1111 talloc_free(node->group);
1112 node->group = group;
1113 node->flags = group->flags;
1114
1115 return 0;
1116}
1117
1118/** Process one argument of a logical operation.
1119 *
1120 * If we see a list in a truthy context, then we DON'T expand the list. Instead, we return a bool which
1121 * indicates if the list was empty (or not). This prevents us from returning a whole mess of value-boxes
1122 * when the user just wanted to see if the list existed.
1123 *
1124 * Otherwise, we expand the xlat, and continue.
1125 */
1127 xlat_ctx_t const *xctx,
1128 request_t *request, UNUSED fr_value_box_list_t *in)
1129{
1131 xlat_logical_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_logical_rctx_t);
1132
1133 /*
1134 * Push the xlat onto the stack for expansion.
1135 */
1136 if (unlang_xlat_yield(request, inst->callback, NULL, 0, rctx) != XLAT_ACTION_YIELD) {
1137 fail:
1138 talloc_free(rctx->box);
1139 talloc_free(rctx);
1140 return XLAT_ACTION_FAIL;
1141 }
1142
1143 if (unlang_xlat_push(rctx, &rctx->last_result, &rctx->list,
1144 request, inst->argv[rctx->current], UNLANG_SUB_FRAME) < 0) goto fail;
1145
1147}
1148
1149/** See if the input is truthy or not.
1150 *
1151 * @param[in] rctx our ctx
1152 * @param[in] in list of value-boxes to check
1153 * @return
1154 * - false if there are no truthy values. The last box is copied to the rctx.
1155 * This is to allow us to return default values which may not be truthy,
1156 * e.g. %{&Counter || 0} or %{&Framed-IP-Address || 0.0.0.0}.
1157 * If we don't copy the last box to the rctx, the expression just returns NULL
1158 * which is never useful...
1159 * - true if we find a truthy value. The first truthy box is copied to the rctx.
1160 *
1161 * Empty lists are not truthy.
1162 */
1163static bool xlat_logical_or(xlat_logical_rctx_t *rctx, fr_value_box_list_t const *in)
1164{
1165 fr_value_box_t *last = NULL;
1166 bool ret = false;
1167
1168 /*
1169 * Empty lists are !truthy.
1170 */
1171 if (!fr_value_box_list_num_elements(in)) return false;
1172
1173 /*
1174 * Loop over the input list. We CANNOT do groups.
1175 */
1177 fr_assert(fr_type_is_leaf(box->type) || fr_type_is_null(box->type));
1178
1179 last = box;
1180
1181 /*
1182 * Remember the last box we found.
1183 *
1184 * If it's truthy, then we stop immediately.
1185 */
1186 if (fr_value_box_is_truthy(box)) {
1187 ret = true;
1188 break;
1189 }
1190 }
1191
1192 if (!rctx->box) {
1193 MEM(rctx->box = fr_value_box_alloc_null(rctx->ctx));
1194 } else {
1195 fr_value_box_clear(rctx->box);
1196 }
1197 if (last && !fr_cond_assert(fr_value_box_copy(rctx->box, rctx->box, last) == 0)) return false;
1198
1199 return ret;
1200}
1201
1202/*
1203 * We've evaluated an expression. Let's see if we need to continue with ||
1204 */
1206 xlat_ctx_t const *xctx,
1207 request_t *request, fr_value_box_list_t *in)
1208{
1210 xlat_logical_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_logical_rctx_t);
1211 bool match;
1212
1213 /*
1214 * If the expansions fails, then we fail the entire thing.
1215 */
1216 if (!XLAT_RESULT_SUCCESS(&rctx->last_result)) {
1217 talloc_free(rctx->box);
1218 talloc_free(rctx);
1219 return XLAT_ACTION_FAIL;
1220 }
1221
1222 /*
1223 * Recursively check groups. i.e. we effectively flatten each list.
1224 *
1225 * (a, b, c) || (d, e, f) == a || b || c || d || e || f
1226 */
1227 match = xlat_logical_or(rctx, &rctx->list);
1228 if (match) goto done;
1229
1230 fr_value_box_list_talloc_free(&rctx->list);
1231
1232 rctx->current++;
1233
1234 /*
1235 * Nothing to expand, return the final value we saw.
1236 */
1237 if (rctx->current >= inst->argc) {
1238 /*
1239 * Otherwise we stop on failure, with the boolean
1240 * we just updated.
1241 */
1242 done:
1243 if (rctx->box) fr_dcursor_append(out, rctx->box);
1244
1245 talloc_free(rctx);
1246 return XLAT_ACTION_DONE;
1247 }
1248
1249 return xlat_logical_process_arg(ctx, out, xctx, request, in);
1250}
1251
1252/** See if the input is truthy or not.
1253 *
1254 * @param[in] rctx our ctx
1255 * @param[in] in list of value-boxes to check
1256 * @return
1257 * - false on failure
1258 * - true for match, with dst updated to contain the relevant box.
1259 *
1260 * Empty lists are not truthy.
1261 */
1262static bool xlat_logical_and(xlat_logical_rctx_t *rctx, fr_value_box_list_t const *in)
1263{
1264 fr_value_box_t *found = NULL;
1265
1266 /*
1267 * Empty lists are !truthy.
1268 */
1269 if (!fr_value_box_list_num_elements(in)) return false;
1270
1271 /*
1272 * Loop over the input list. We CANNOT do groups.
1273 */
1275 fr_assert(fr_type_is_leaf(box->type));
1276
1277 /*
1278 * Remember the last box we found.
1279 *
1280 * If it's truthy, then we keep going either
1281 * until the end, or until we get a "false".
1282 */
1283 if (fr_value_box_is_truthy(box)) {
1284 found = box;
1285 continue;
1286 }
1287
1288 /*
1289 * Stop on the first "false"
1290 */
1291 return false;
1292 }
1293
1294 if (!found) return false;
1295
1296 if (!rctx->box) {
1297 MEM(rctx->box = fr_value_box_alloc_null(rctx));
1298 } else {
1299 fr_value_box_clear(rctx->box);
1300 }
1301 if (!fr_cond_assert(fr_value_box_copy(rctx->box, rctx->box, found) == 0)) return false;
1302
1303 return true;
1304}
1305
1306/*
1307 * We've evaluated an expression. Let's see if we need to continue with &&
1308 */
1310 xlat_ctx_t const *xctx,
1311 request_t *request, fr_value_box_list_t *in)
1312{
1314 xlat_logical_rctx_t *rctx = talloc_get_type_abort(xctx->rctx, xlat_logical_rctx_t);
1315 bool match;
1316
1317 /*
1318 * If the expansions fails, then we fail the entire thing.
1319 */
1320 if (!XLAT_RESULT_SUCCESS(&rctx->last_result)) {
1321 talloc_free(rctx->box);
1322 talloc_free(rctx);
1323 return XLAT_ACTION_FAIL;
1324 }
1325
1326 /*
1327 * Recursively check groups. i.e. we effectively flatten each list.
1328 *
1329 * (a, b, c) && (d, e, f) == a && b && c && d && e && f
1330 */
1331 match = xlat_logical_and(rctx, &rctx->list);
1332 if (!match) {
1333 TALLOC_FREE(rctx->box); /* parented from ctx */
1334 goto done;
1335 }
1336
1337 fr_value_box_list_talloc_free(&rctx->list);
1338
1339 rctx->current++;
1340
1341 /*
1342 * Nothing to expand, return the final value we saw.
1343 */
1344 if (rctx->current >= inst->argc) {
1345 /*
1346 * Otherwise we stop on failure, with the boolean
1347 * we just updated.
1348 */
1349 fr_assert(rctx->box != NULL);
1350 fr_dcursor_append(out, rctx->box);
1351
1352 done:
1353 talloc_free(rctx);
1354 return XLAT_ACTION_DONE;
1355 }
1356
1357 return xlat_logical_process_arg(ctx, out, xctx, request, in);
1358}
1359
1360/*
1361 * Each argument is it's own head, because we do NOT always want
1362 * to go to the next argument.
1363 */
1365{
1366 xlat_logical_inst_t *inst = talloc_get_type_abort(xctx->inst, xlat_logical_inst_t);
1367
1368 inst->argc = xlat_flatten_to_argv(inst, &inst->argv, xctx->ex->call.args);
1369 if (xctx->ex->call.func->token == T_LOR) {
1370 inst->callback = xlat_logical_or_resume;
1371 inst->stop_on_match = true;
1372 } else {
1373 inst->callback = xlat_logical_and_resume;
1374 inst->stop_on_match = false;
1375 }
1376
1377 return 0;
1378}
1379
1380
1381/** Process logical &&, ||
1382 *
1383 */
1385 xlat_ctx_t const *xctx,
1386 request_t *request, fr_value_box_list_t *in)
1387{
1388 xlat_logical_rctx_t *rctx;
1390
1391 MEM(rctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), xlat_logical_rctx_t));
1392 rctx->ctx = ctx;
1393 rctx->current = 0;
1394
1395 if (inst->stop_on_match) {
1396 rctx->box = NULL;
1397 } else {
1399 rctx->box->vb_bool = true;
1400 }
1401 fr_value_box_list_init(&rctx->list);
1402
1403 (UNCONST(xlat_ctx_t *, xctx))->rctx = rctx; /* ensure it's there before a resume! */
1404
1405 return xlat_logical_process_arg(ctx, out, xctx, request, in);
1406}
1407
1408
1410 { .required = true, .single = true, .concat = true },
1412};
1413
1415 UNUSED xlat_ctx_t const *xctx,
1416 request_t *request, fr_value_box_list_t *in, fr_token_t op)
1417{
1418 int rcode;
1419 fr_value_box_t *dst, *group, *vb;
1420
1421 /*
1422 * We do some basic type checks here.
1423 */
1424 group = fr_value_box_list_head(in);
1425 vb = fr_value_box_list_head(&group->vb_group);
1426
1427 /*
1428 * -NULL is an error
1429 * ~NULL is an error
1430 * !NULL is handled by xlat_func_unary_not
1431 */
1432 if (!vb) {
1433 fr_strerror_printf("Input is empty");
1434 return XLAT_ACTION_FAIL;
1435 }
1436
1437 if (!fr_type_is_leaf(vb->type) || fr_type_is_variable_size(vb->type)) {
1438 REDEBUG("Cannot perform operation on data type %s", fr_type_to_str(vb->type));
1439 return XLAT_ACTION_FAIL;
1440 }
1441
1442 MEM(dst = fr_value_box_alloc_null(ctx));
1443
1444 /*
1445 * We rely on this function to do the remainder of the type checking.
1446 */
1447 rcode = fr_value_calc_unary_op(dst, dst, op, vb);
1448 if ((rcode < 0) || fr_type_is_null(dst->type)) {
1449 talloc_free(dst);
1450 return XLAT_ACTION_FAIL;
1451 }
1452
1453 fr_dcursor_append(out, dst);
1454 return XLAT_ACTION_DONE;
1455}
1456
1457
1459 UNUSED xlat_ctx_t const *xctx,
1460 UNUSED request_t *request, fr_value_box_list_t *in)
1461{
1462 fr_value_box_t *dst, *group, *vb;
1463
1464 group = fr_value_box_list_head(in);
1465 vb = fr_value_box_list_head(&group->vb_group);
1466
1467 /*
1468 * Don't call calc_unary_op(), because we want the enum names.
1469 */
1471
1472 /*
1473 * !NULL = true
1474 */
1475 if (!vb) {
1476 dst->vb_bool = true;
1477 } else {
1478 dst->vb_bool = !fr_value_box_is_truthy(vb);
1479 }
1480
1481 fr_dcursor_append(out, dst);
1482 return XLAT_ACTION_DONE;
1483}
1484
1486 xlat_ctx_t const *xctx,
1487 request_t *request, fr_value_box_list_t *in)
1488{
1489 return xlat_func_unary_op(ctx, out, xctx, request, in, T_SUB);
1490}
1491
1493 xlat_ctx_t const *xctx,
1494 request_t *request, fr_value_box_list_t *in)
1495{
1496 return xlat_func_unary_op(ctx, out, xctx, request, in, T_COMPLEMENT);
1497}
1498
1500 { .concat = true, .type = FR_TYPE_STRING },
1502};
1503
1504/** Holds the result of pre-parsing the rcode on startup
1505 */
1506typedef struct {
1507 rlm_rcode_t rcode; //!< The preparsed rcode.
1509
1510/** Convert static expr_rcode arguments into rcodes
1511 *
1512 * This saves doing the lookup at runtime, which given how frequently this xlat is used
1513 * could get quite expensive.
1514 */
1516{
1517 xlat_rcode_inst_t *inst = talloc_get_type_abort(xctx->inst, xlat_rcode_inst_t);
1518 xlat_exp_t *arg;
1519 xlat_exp_t *rcode_arg;
1520 fr_value_box_t *rcode;
1521
1522 /*
1523 * If it's literal data, then we can pre-resolve it to
1524 * a rcode now, and skip that at runtime.
1525 */
1526 arg = xlat_exp_head(xctx->ex->call.args);
1527 fr_assert(arg->type == XLAT_GROUP);
1528
1529 /*
1530 * We can only pre-parse if this if the value is
1531 * in a single box...
1532 */
1533 if (fr_dlist_num_elements(&arg->group->dlist) != 1) return 0;
1534 rcode_arg = xlat_exp_head(arg->group);
1535
1536 /*
1537 * We can only pre-parse is this is a static value.
1538 */
1539 if (rcode_arg->type != XLAT_BOX) return 0;
1540
1541 rcode = &rcode_arg->data;
1542
1543 switch (rcode->type) {
1544 case FR_TYPE_STRING:
1545 inst->rcode = fr_table_value_by_str(rcode_table, rcode->vb_strvalue, RLM_MODULE_NOT_SET);
1546 if (inst->rcode == RLM_MODULE_NOT_SET) {
1547 unknown:
1548 ERROR("Unknown rcode '%pV'", rcode);
1549 return -1;
1550 }
1551 break;
1552
1553 case FR_TYPE_INT8:
1554 case FR_TYPE_INT16:
1555 case FR_TYPE_INT32:
1556 case FR_TYPE_INT64:
1557 case FR_TYPE_UINT16:
1558 case FR_TYPE_UINT32:
1559 case FR_TYPE_UINT64:
1560 case FR_TYPE_SIZE:
1561 if (fr_value_box_cast_in_place(rcode_arg, rcode, FR_TYPE_UINT8, NULL) < 0) {
1562 invalid:
1563 ERROR("Invalid value for rcode '%pV'", rcode);
1564 return -1;
1565 }
1567
1568 case FR_TYPE_UINT8:
1569 if (rcode->vb_uint8 >= RLM_MODULE_NUMCODES) goto invalid;
1570 inst->rcode = rcode->vb_uint8;
1571 break;
1572
1573 default:
1574 goto unknown;
1575 }
1576
1577 /*
1578 * No point in creating useless boxes at runtime,
1579 * nuke the argument now.
1580 */
1581 (void) fr_dlist_remove(&xctx->ex->call.args->dlist, arg);
1582 talloc_free(arg);
1583
1584 return 0;
1585}
1586
1587static fr_slen_t xlat_expr_print_rcode(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, UNUSED fr_sbuff_escape_rules_t const *e_rules)
1588{
1589 size_t at_in = fr_sbuff_used_total(out);
1590 xlat_rcode_inst_t *inst = instance;
1591
1592 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(out, "%interpreter.rcode('");
1593 if (xlat_exp_head(node->call.args)) {
1594 ssize_t slen;
1595
1596 xlat_exp_foreach(node->call.args, child) {
1597 slen = xlat_print_node(out, node->call.args, child, NULL, 0);
1598 if (slen < 0) return slen;
1599 }
1600 } else {
1602 }
1604
1605 return fr_sbuff_used_total(out) - at_in;
1606}
1607
1608/** Match the passed rcode against request->rcode
1609 *
1610 * Example:
1611@verbatim
1612%interpreter.rcode('handled') == true
1613
1614# ...or how it's used normally used
1615if (handled) {
1616 ...
1617}
1618@endverbatim
1619 *
1620 * @ingroup xlat_functions
1621 */
1623 xlat_ctx_t const *xctx,
1624 request_t *request, fr_value_box_list_t *args)
1625{
1627 fr_value_box_t *arg_rcode;
1628 rlm_rcode_t rcode;
1629 fr_value_box_t *vb;
1630
1631 /*
1632 * If we have zero args, it's because the instantiation
1633 * function consumed them. Unless the user read the debug
1634 * output, and tried to see what the rcode is, in case we
1635 */
1636 if (fr_value_box_list_num_elements(args) == 0) {
1637 if (inst->rcode == RLM_MODULE_NOT_SET) {
1638 RDEBUG("Request rcode is '%s'",
1639 fr_table_str_by_value(rcode_table, request->rcode, "<INVALID>"));
1640 return XLAT_ACTION_DONE;
1641 }
1642
1643 rcode = inst->rcode;
1644 } else {
1645 XLAT_ARGS(args, &arg_rcode);
1646 rcode = fr_table_value_by_str(rcode_table, arg_rcode->vb_strvalue, RLM_MODULE_NOT_SET);
1647 if (rcode == RLM_MODULE_NOT_SET) {
1648 REDEBUG("Invalid rcode '%pV'", arg_rcode);
1649 return XLAT_ACTION_FAIL;
1650 }
1651 }
1652
1653 RDEBUG3("Request rcode is '%s'",
1654 fr_table_str_by_value(rcode_table, request->rcode, "<INVALID>"));
1655
1658 vb->vb_bool = (request->rcode == rcode);
1659
1660 return XLAT_ACTION_DONE;
1661}
1662
1663/** Takes no arguments
1664 */
1666 XLAT_ARG_PARSER_TERMINATOR, /* Coverity gets tripped up by only having a single entry here */
1668};
1669
1670/** Return the current rcode as a string
1671 *
1672 * Example:
1673@verbatim
1674"%rcode()" == "handled"
1675@endverbatim
1676 *
1677 * @ingroup xlat_functions
1678 */
1680 UNUSED xlat_ctx_t const *xctx,
1681 request_t *request, UNUSED fr_value_box_list_t *args)
1682{
1683 fr_value_box_t *vb;
1684
1685 /*
1686 * FIXME - This should really be an enum
1687 */
1688 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
1689 if (fr_value_box_strdup(vb, vb, NULL, fr_table_str_by_value(rcode_table, request->rcode, "<INVALID>"), false) < 0) {
1690 talloc_free(vb);
1691 return XLAT_ACTION_FAIL;
1692 }
1694
1695 return XLAT_ACTION_DONE;
1696}
1697
1698typedef struct {
1699 tmpl_t const *vpt; //!< the attribute reference
1701
1706
1707/*
1708 * We just print the node as-is.
1709 */
1710static fr_slen_t xlat_expr_print_exists(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
1711{
1712 size_t at_in = fr_sbuff_used_total(out);
1713 xlat_exists_inst_t *inst = instance;
1714
1715 if (inst->vpt) {
1716 FR_SBUFF_IN_STRCPY_RETURN(out, inst->vpt->name);
1717 } else {
1718 xlat_print_node(out, node->call.args, xlat_exp_head(node->call.args), e_rules, 0);
1719 }
1720
1721 return fr_sbuff_used_total(out) - at_in;
1722}
1723
1724/*
1725 * Don't expand the argument if it's already an attribute reference.
1726 */
1728{
1729 xlat_exists_inst_t *inst = talloc_get_type_abort(xctx->inst, xlat_exists_inst_t);
1730 xlat_exp_t *arg, *node;
1731
1732 arg = xlat_exp_head(xctx->ex->call.args);
1733
1734 fr_assert(arg->type == XLAT_GROUP);
1735 node = xlat_exp_head(arg->group);
1736
1737 /*
1738 * @todo - add an escape callback to this xlat
1739 * registration, so that it can take untrusted inputs.
1740 */
1741 if ((node->type != XLAT_TMPL) || !tmpl_contains_attr(node->vpt)) {
1742 fr_strerror_const("The %exists() function can only be used internally");
1743 return -1;
1744 }
1745
1746 inst->vpt = talloc_steal(inst, node->vpt);
1747
1748 /*
1749 * Free the input arguments so that they don't get expanded.
1750 */
1751 while ((arg = fr_dlist_pop_head(&xctx->ex->call.args->dlist)) != NULL) {
1752 talloc_free(arg);
1753 }
1754
1755 return 0;
1756}
1757
1759 request_t *request, tmpl_t const *vpt, bool do_free)
1760{
1761 fr_pair_t *vp;
1762 fr_value_box_t *dst;
1763 fr_dcursor_t cursor;
1765
1767
1768 vp = tmpl_dcursor_init(NULL, NULL, &cc, &cursor, request, vpt);
1769 dst->vb_bool = (vp != NULL);
1770
1771 if (do_free) talloc_const_free(vpt);
1772 tmpl_dcursor_clear(&cc);
1773 fr_dcursor_append(out, dst);
1774 return XLAT_ACTION_DONE;
1775}
1776
1777/** See if a named attribute exists
1778 *
1779 * Example:
1780@verbatim
1781"%{exists:&Foo}" == true
1782@endverbatim
1783 *
1784 * @ingroup xlat_functions
1785 */
1787 xlat_ctx_t const *xctx,
1788 request_t *request, UNUSED fr_value_box_list_t *in)
1789{
1791
1792 /*
1793 * We return "true" if the attribute exists. Otherwise we return "false".
1794 */
1795 fr_assert(inst->vpt);
1796
1797 return xlat_attr_exists(ctx, out, request, inst->vpt, false);
1798}
1799
1800#undef XLAT_REGISTER_BINARY_OP
1801#define XLAT_REGISTER_BINARY_OP(_op, _name) \
1802do { \
1803 if (unlikely((xlat = xlat_func_register(NULL, "op_" STRINGIFY(_name), xlat_func_op_ ## _name, FR_TYPE_VOID)) == NULL)) return -1; \
1804 xlat_func_args_set(xlat, binary_op_xlat_args); \
1805 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
1806 xlat_func_print_set(xlat, xlat_expr_print_binary); \
1807 xlat->token = _op; \
1808} while (0)
1809
1810#undef XLAT_REGISTER_BINARY_CMP
1811#define XLAT_REGISTER_BINARY_CMP(_op, _name) \
1812do { \
1813 if (unlikely((xlat = xlat_func_register(NULL, "cmp_" STRINGIFY(_name), xlat_func_cmp_ ## _name, FR_TYPE_BOOL)) == NULL)) return -1; \
1814 xlat_func_args_set(xlat, binary_cmp_xlat_args); \
1815 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
1816 xlat_func_print_set(xlat, xlat_expr_print_binary); \
1817 xlat_func_resolve_set(xlat, xlat_expr_resolve_binary); \
1818 xlat->token = _op; \
1819} while (0)
1820
1821#undef XLAT_REGISTER_NARY_OP
1822#define XLAT_REGISTER_NARY_OP(_op, _name, _func_name) \
1823do { \
1824 if (unlikely((xlat = xlat_func_register(NULL, STRINGIFY(_name), xlat_func_ ## _func_name, FR_TYPE_VOID)) == NULL)) return -1; \
1825 xlat_func_instantiate_set(xlat, xlat_instantiate_ ## _func_name, xlat_ ## _func_name ## _inst_t, NULL, NULL); \
1826 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
1827 xlat_func_print_set(xlat, xlat_expr_print_nary); \
1828 xlat_purify_func_set(xlat, xlat_expr_logical_purify); \
1829 xlat->token = _op; \
1830} while (0)
1831
1832#undef XLAT_REGISTER_REGEX_OP
1833#define XLAT_REGISTER_REGEX_OP(_op, _name) \
1834do { \
1835 if (unlikely((xlat = xlat_func_register(NULL, STRINGIFY(_name), xlat_func_ ## _name, FR_TYPE_BOOL)) == NULL)) return -1; \
1836 xlat_func_args_set(xlat, regex_op_xlat_args); \
1837 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
1838 xlat_func_instantiate_set(xlat, xlat_instantiate_regex, xlat_regex_inst_t, NULL, NULL); \
1839 xlat_func_print_set(xlat, xlat_expr_print_regex); \
1840 xlat->token = _op; \
1841} while (0)
1842
1843#define XLAT_REGISTER_BOOL(_xlat, _func, _arg, _ret_type) \
1844do { \
1845 if (unlikely((xlat = xlat_func_register(NULL, _xlat, _func, _ret_type)) == NULL)) return -1; \
1846 xlat_func_args_set(xlat, _arg); \
1847 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_INTERNAL); \
1848} while (0)
1849
1850#define XLAT_REGISTER_UNARY(_op, _xlat, _func) \
1851do { \
1852 if (unlikely((xlat = xlat_func_register(NULL, _xlat, _func, FR_TYPE_VOID)) == NULL)) return -1; \
1853 xlat_func_args_set(xlat, unary_op_xlat_args); \
1854 xlat_func_flags_set(xlat, XLAT_FUNC_FLAG_PURE | XLAT_FUNC_FLAG_INTERNAL); \
1855 xlat_func_print_set(xlat, xlat_expr_print_unary); \
1856 xlat->token = _op; \
1857} while (0)
1858
1860{
1861 xlat_t *xlat;
1862
1873
1882
1885
1886 if (unlikely((xlat = xlat_func_register(NULL, "regex.search", xlat_func_regex_search, FR_TYPE_BOOL)) == NULL)) return -1;
1889
1890 /*
1891 * &&, ||
1892 *
1893 * @todo - remove tmpl_resolve() from tokenize_field(), and add xlat_resolve_logical_or() / xlat_resolve_logical_and()
1894 * functions which do partial resolution.
1895 */
1896 XLAT_REGISTER_NARY_OP(T_LAND, logical_and, logical);
1897 XLAT_REGISTER_NARY_OP(T_LOR, logical_or, logical);
1898
1902
1904 xlat->deprecated = true;
1907
1912
1913 if (unlikely((xlat = xlat_func_register(NULL, "rcode", xlat_func_rcode, FR_TYPE_STRING)) == NULL)) return -1;
1916
1917 /*
1918 * -EXPR
1919 * ~EXPR
1920 * !EXPR
1921 */
1925
1926 return 0;
1927}
1928
1929/*
1930 * Must use the same names as above.
1931 */
1933 [ T_ADD ] = L("op_add"),
1934 [ T_SUB ] = L("op_sub"),
1935 [ T_MUL ] = L("op_mul"),
1936 [ T_DIV ] = L("op_div"),
1937 [ T_MOD ] = L("op_mod"),
1938 [ T_AND ] = L("op_and"),
1939 [ T_OR ] = L("op_or"),
1940 [ T_XOR ] = L("op_xor"),
1941 [ T_RSHIFT ] = L("op_rshift"),
1942 [ T_LSHIFT ] = L("op_lshift"),
1943
1944 [ T_LAND ] = L("logical_and"),
1945 [ T_LOR ] = L("logical_or"),
1946
1947 [ T_OP_CMP_EQ ] = L("cmp_eq"),
1948 [ T_OP_NE ] = L("cmp_ne"),
1949 [ T_OP_LT ] = L("cmp_lt"),
1950 [ T_OP_LE ] = L("cmp_le"),
1951 [ T_OP_GT ] = L("cmp_gt"),
1952 [ T_OP_GE ] = L("cmp_ge"),
1953
1954 [ T_OP_CMP_EQ_TYPE ] = L("cmp_eq_type"),
1955 [ T_OP_CMP_NE_TYPE ] = L("cmp_ne_type"),
1956
1957 [ T_OP_REG_EQ ] = L("reg_eq"),
1958 [ T_OP_REG_NE ] = L("reg_ne"),
1959};
1960
1961/*
1962 * Which are logical operations
1963 */
1964static const bool logical_ops[T_TOKEN_LAST] = {
1965 [T_LAND] = true,
1966 [T_LOR] = true,
1967};
1968
1969/*
1970 * These operators can take multiple arguments.
1971 *
1972 * @todo - include T_ADD, T_SUB, T_MUL, T_AND, T_OR, T_XOR, here too.
1973 *
1974 * This array should contain a function pointer to the code which either appends the results, or does
1975 * peephole optimizations to merge the arguments together. This merging will reduce run-time effort.
1976 */
1977static const bool multivalue_ops[T_TOKEN_LAST] = {
1978 [T_LAND] = true,
1979 [T_LOR] = true,
1980};
1981
1982/*
1983 * Allow for BEDMAS ordering. Gross ordering is first number,
1984 * fine ordering is second number. Unused operators are assigned as zero.
1985 *
1986 * Larger numbers are higher precedence.
1987 */
1988#define P(_x, _y) (((_x) << 4) | (_y))
1989
1990static const int precedence[T_TOKEN_LAST] = {
1991 [T_INVALID] = 0,
1992
1993 /*
1994 * Assignment operators go here as P(1,n)
1995 *
1996 * += -= *= /= %= <<= >>= &= ^= |=
1997 *
1998 * We want the output of the assignment operators to be the result of the assignment. This means
1999 * that the assignments can really only be done for simple attributes, and not tmpls with filters
2000 * which select multiple attributes.
2001 *
2002 * Which (for now) means that we likely want to disallow assignments in expressions. That's
2003 * fine, as this isn't C, and we're not sure that it makes sense to do something like:
2004 *
2005 * if ((&foo += 5) > 60) ...
2006 *
2007 * Or maybe it does. Who knows?
2008 */
2009
2010 [T_LOR] = P(2,0),
2011 [T_LAND] = P(2,1),
2012
2013 [T_OR] = P(3,0),
2014 [T_XOR] = P(3,1),
2015 [T_AND] = P(3,2),
2016
2017 [T_OP_REG_EQ] = P(4,0),
2018 [T_OP_REG_NE] = P(4,0),
2019
2020 [T_OP_CMP_EQ] = P(4,1),
2021 [T_OP_NE] = P(4,1),
2022
2023 [T_OP_CMP_EQ_TYPE] = P(4,1),
2024 [T_OP_CMP_NE_TYPE] = P(4,1),
2025
2026 [T_OP_LT] = P(5,0),
2027 [T_OP_LE] = P(5,0),
2028 [T_OP_GT] = P(5,0),
2029 [T_OP_GE] = P(5,0),
2030
2031 [T_RSHIFT] = P(6,0),
2032 [T_LSHIFT] = P(6,0),
2033
2034 [T_SUB] = P(7,0),
2035 [T_ADD] = P(7,1),
2036
2037 [T_MOD] = P(8,0),
2038 [T_MUL] = P(8,1),
2039 [T_DIV] = P(8,2),
2040
2041 [T_LBRACE] = P(10,0),
2042};
2043
2044#define fr_sbuff_skip_whitespace(_x) \
2045 do { \
2046 while (isspace((uint8_t) fr_sbuff_char(_x, '\0'))) fr_sbuff_advance(_x, 1); \
2047 } while (0)
2048
2050 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2051 fr_token_t prev, fr_sbuff_parse_rules_t const *bracket_rules,
2052 fr_sbuff_parse_rules_t const *input_rules, bool cond) CC_HINT(nonnull(1,2,3,4,5));
2053
2055 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2056 fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond) CC_HINT(nonnull(1,2,3,4,5));
2057
2059 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2060 fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond) CC_HINT(nonnull(1,2,3,4,5));
2061
2063 { L("\""), T_DOUBLE_QUOTED_STRING }, /* Don't re-order, backslash throws off ordering */
2064 { L("'"), T_SINGLE_QUOTED_STRING },
2065 { L("/"), T_SOLIDUS_QUOTED_STRING },
2066 { L("`"), T_BACK_QUOTED_STRING }
2067};
2069
2070
2071/*
2072 * Look for prefix operators
2073 *
2074 * + = ignore
2075 * - = unary_minus(next)
2076 * ! = unary_not(next)
2077 * ~ = unary_xor(0, next)
2078 * (expr) = recurse, and parse expr
2079 *
2080 * as a special case, <type> is a cast. Which lets us know how
2081 * to parse the next thing we get. Otherwise, parse the thing as
2082 * int64_t.
2083 */
2085 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2086 fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond)
2087{
2088 xlat_exp_t *node = NULL, *unary = NULL;
2089 xlat_t *func = NULL;
2090 fr_sbuff_t our_in = FR_SBUFF(in);
2091 char c = '\0';
2092
2094
2095 /*
2096 * Handle !-~ by adding a unary function to the xlat
2097 * node, with the first argument being the _next_ thing
2098 * we allocate.
2099 */
2100 if (fr_sbuff_next_if_char(&our_in, '!')) { /* unary not */
2101 func = xlat_func_find("unary_not", 9);
2102 fr_assert(func != NULL);
2103 c = '!';
2104 goto check_for_double;
2105
2106 }
2107 else if (fr_sbuff_next_if_char(&our_in, '-')) { /* unary minus */
2108 fr_sbuff_skip_whitespace(&our_in);
2109
2110 /*
2111 * -4 is a number, not minus(4).
2112 */
2113 if (fr_sbuff_is_digit(&our_in)) goto field;
2114
2115 func = xlat_func_find("unary_minus", 11);
2116 fr_assert(func != NULL);
2117 c = '-';
2118 goto check_for_double;
2119
2120 }
2121 else if (fr_sbuff_next_if_char(&our_in, '~')) { /* unary complement */
2122 func = xlat_func_find("unary_complement", 16);
2123 fr_assert(func != NULL);
2124 c = '~';
2125 goto check_for_double;
2126
2127 }
2128 else if (fr_sbuff_next_if_char(&our_in, '+')) { /* ignore unary + */
2129 c = '+';
2130
2131 check_for_double:
2132 fr_sbuff_skip_whitespace(&our_in);
2133 fr_sbuff_skip_whitespace(&our_in);
2134 if (fr_sbuff_is_char(&our_in, c)) {
2135 fr_strerror_const("Double operator is invalid");
2136 FR_SBUFF_ERROR_RETURN(&our_in);
2137 }
2138 }
2139
2140 /*
2141 * Maybe we have a unary not / etc. If so, make sure
2142 * that we return that, and not the child node
2143 */
2144 if (!func) {
2145 field:
2146 return tokenize_field(head, out, in, p_rules, t_rules, bracket_rules, out_c, cond);
2147 }
2148
2149 /*
2150 * Tokenize_field may reset this if the operation is wrapped inside of another expression.
2151 */
2152 *out_c = c;
2153
2154 MEM(unary = xlat_exp_alloc(head, XLAT_FUNC, fr_tokens[func->token], strlen(fr_tokens[func->token])));
2155 xlat_exp_set_func(unary, func, t_rules->attr.dict_def);
2156 MEM(unary->call.args = xlat_exp_head_alloc(unary));
2157 unary->call.args->is_argv = true;
2158
2159 if (tokenize_field(unary->call.args, &node, &our_in, p_rules, t_rules, bracket_rules, out_c, (c == '!')) <= 0) {
2160 talloc_free(unary);
2161 FR_SBUFF_ERROR_RETURN(&our_in);
2162 }
2163
2164 if (!node) {
2165 fr_strerror_const("Empty expressions are invalid");
2166 FR_SBUFF_ERROR_RETURN(&our_in);
2167 }
2168
2169 xlat_func_append_arg(unary, node, (c == '!'));
2170 unary->flags.can_purify = (unary->call.func->flags.pure && unary->call.args->flags.pure) | unary->call.args->flags.can_purify;
2171
2172 /*
2173 * Don't add it to head->flags, that will be done when it's actually inserted.
2174 */
2175
2176 *out = unary;
2177
2178 FR_SBUFF_SET_RETURN(in, &our_in);
2179}
2180
2181/** Allocate a specific cast node.
2182 *
2183 * With the first argument being a UINT8 of the data type.
2184 * See xlat_func_cast() for the implementation.
2185 *
2186 */
2187static xlat_exp_t *expr_cast_alloc(TALLOC_CTX *ctx, fr_type_t type, xlat_exp_t *child)
2188{
2189 xlat_exp_t *cast, *node;
2190 char const *str;
2191
2192 /*
2193 * Create a "cast" node. The first argument is a UINT8 value-box of the cast type. The RHS is
2194 * whatever "node" comes next.
2195 */
2196 MEM(cast = xlat_exp_alloc(ctx, XLAT_FUNC, "cast", 4));
2197 MEM(cast->call.func = xlat_func_find("cast", 4));
2198 // no need to set dict here
2199 fr_assert(cast->call.func != NULL);
2200 cast->flags = cast->call.func->flags;
2201
2202 /*
2203 * Create argv[0] UINT8, with "Cast-Base" as
2204 * the "da". This allows the printing routines
2205 * to print the name of the type, and not the
2206 * number.
2207 */
2208 str = fr_type_to_str(type);
2209 fr_assert(str != NULL);
2210
2211 MEM(node = xlat_exp_alloc(cast, XLAT_BOX, NULL, 0));
2212 xlat_exp_set_name(node, str, strlen(str));
2213
2214 fr_value_box_init(&node->data, FR_TYPE_UINT8, attr_cast_base, false);
2215 node->data.vb_uint8 = type;
2216
2217 xlat_func_append_arg(cast, node, false);
2218 (void) talloc_steal(cast, child);
2219 xlat_func_append_arg(cast, child, false);
2220
2221 return cast;
2222}
2223
2225{
2226 fr_sbuff_t our_in = FR_SBUFF(in);
2227 ssize_t slen;
2228
2229 if (!fr_sbuff_next_if_char(&our_in, '(')) {
2230 no_cast:
2231 *cast = FR_TYPE_NULL;
2232 return 0;
2233 }
2234
2235 /*
2236 * Check for an actual data type.
2237 */
2239
2240 /*
2241 * It's not a known data type, so it's not a cast.
2242 */
2243 if (*cast == FR_TYPE_NULL) {
2244 goto no_cast;
2245 }
2246
2247 /*
2248 * We're not allowed to start expressions with data types:
2249 *
2250 * (ipaddr ...
2251 * (ipaddr+...
2252 * (ipaddr(...
2253 */
2254 if (!fr_sbuff_next_if_char(&our_in, ')')) {
2255 if (!fr_sbuff_is_in_charset(&our_in, sbuff_char_word)) {
2256 fr_strerror_printf("Unexpected text after data type '%s'", fr_type_to_str(*cast));
2257 FR_SBUFF_ERROR_RETURN(&our_in);
2258 }
2259
2260 goto no_cast;
2261 }
2262
2263 /*
2264 * We're not allowed to cast to a structural data type: (group)
2265 *
2266 * @todo - maybe cast to structural data type could mean "parse it as a string"? But then where
2267 * do the pairs go..
2268 */
2269 if (!fr_type_is_leaf(*cast)) {
2270 fr_strerror_printf("Invalid structural data type '%s' in cast", fr_type_to_str(*cast));
2271 FR_SBUFF_ERROR_RETURN(&our_in);
2272 }
2273
2274 fr_sbuff_adv_past_whitespace(&our_in, SIZE_MAX, NULL);
2275 FR_SBUFF_SET_RETURN(in, &our_in);
2276}
2277
2278/*
2279 * Tokenize the RHS of a regular expression.
2280 */
2282 tmpl_rules_t const *t_rules,
2283 fr_sbuff_parse_rules_t const *bracket_rules)
2284{
2285 ssize_t slen;
2286 xlat_exp_t *node = NULL;
2287 fr_sbuff_t our_in = FR_SBUFF(in);
2288 fr_sbuff_marker_t opand_m, flag;
2289 tmpl_t *vpt;
2291
2293
2294 fr_sbuff_skip_whitespace(&our_in);
2295
2296 /*
2297 * Record where the operand begins for better error offsets later
2298 */
2299 fr_sbuff_marker(&opand_m, &our_in);
2300
2301 /*
2302 * Regexes cannot have casts or sub-expressions.
2303 */
2304 if (!fr_sbuff_next_if_char(&our_in, '/')) {
2305 /*
2306 * Allow for m'...' ala Perl
2307 */
2308 if (!fr_sbuff_is_str(&our_in, "m'", 2)) {
2309 fr_strerror_const("Expected regular expression");
2310 goto error;
2311 }
2312
2313 fr_sbuff_advance(&our_in, 2);
2314 quote = T_SINGLE_QUOTED_STRING;
2315 }
2316
2317 /*
2318 * Allocate the xlat node now so the talloc hierarchy is correct
2319 */
2320 MEM(node = xlat_exp_alloc(head, XLAT_TMPL, NULL, 0));
2321
2322 /*
2323 * tmpl_afrom_substr does pretty much all the work of parsing the operand. Note that we pass '/'
2324 * as the quote, so that the tmpl gets parsed as a regex.
2325 */
2326 (void) tmpl_afrom_substr(node, &vpt, &our_in, T_SOLIDUS_QUOTED_STRING, value_parse_rules_quoted[quote], t_rules);
2327 if (!vpt) {
2328 error:
2329 talloc_free(node);
2330 FR_SBUFF_ERROR_RETURN(&our_in);
2331 }
2332
2333 /*
2334 * @todo - allow for the RHS to be an attribute, too?
2335 */
2336
2337 /*
2338 * It would be nice if tmpl_afrom_substr() did this :(
2339 */
2340 if (!fr_sbuff_next_if_char(&our_in, fr_token_quote[quote])) {
2341 fr_strerror_const("Unterminated regular expression");
2342 goto error;
2343 }
2344
2345 /*
2346 * Remember where the flags start
2347 */
2348 fr_sbuff_marker(&flag, &our_in);
2349 if (tmpl_regex_flags_substr(vpt, &our_in, bracket_rules->terminals) < 0) {
2350 talloc_free(node);
2351 FR_SBUFF_ERROR_RETURN(&our_in);
2352 }
2353
2354 fr_sbuff_skip_whitespace(&our_in);
2355
2356 /*
2357 * Try to compile regular expressions, but only if
2358 * they're not being dynamically expanded.
2359 */
2360 if (!tmpl_contains_xlat(vpt)) {
2361 slen = tmpl_regex_compile(vpt, true);
2362 if (slen <= 0) goto error;
2363 }
2364
2365 node->quote = quote;
2366 xlat_exp_set_vpt(node, vpt);
2367
2368 XLAT_VERIFY(node);
2369 *out = node;
2370
2371 FR_SBUFF_SET_RETURN(in, &our_in);
2372}
2373
2374
2376{
2377 rlm_rcode_t rcode;
2378 ssize_t slen;
2379 xlat_t *func;
2380 xlat_exp_t *node, *arg;
2381 fr_sbuff_t our_in = FR_SBUFF(in);
2382
2383 fr_sbuff_out_by_longest_prefix(&slen, &rcode, rcode_table, &our_in, T_BARE_WORD);
2384 if (slen <= 0) return 0;
2385
2386 if (!fr_sbuff_is_terminal(&our_in, terminals)) {
2387 if (!fr_dict_attr_allowed_chars[fr_sbuff_char(&our_in, '\0')]) {
2388 fr_strerror_const("Unexpected text after return code");
2389 FR_SBUFF_ERROR_RETURN(&our_in);
2390 }
2391 return 0;
2392 }
2393
2394 /*
2395 * We do NOT do math on return codes. But these two characters are allowed for attribute names.
2396 * So we don't parse "Invalid-Packet" as "Invalid - packet".
2397 */
2398 if (fr_sbuff_is_char(&our_in, '-') || fr_sbuff_is_char(&our_in, '/')) {
2399 return 0;
2400 }
2401
2402 /*
2403 * @todo - allow for attributes to have the name "ok-foo" ???
2404 */
2405 func = xlat_func_find("interpreter.rcode", -1);
2406 fr_assert(func != NULL);
2407
2408 MEM(node = xlat_exp_alloc(head, XLAT_FUNC, fr_sbuff_start(&our_in), slen));
2409 node->call.func = func;
2410 // no need to set dict here
2411 node->flags = func->flags; /* rcode is impure, but can be calculated statically */
2412
2413 MEM(arg = xlat_exp_alloc(node, XLAT_BOX, fr_sbuff_start(&our_in), slen));
2414
2415 /*
2416 * We need a string for unit tests, but this should really be just a number.
2417 */
2418 fr_value_box_init(&arg->data, FR_TYPE_STRING, NULL, false);
2419 (void) fr_value_box_bstrndup(arg, &arg->data, NULL, fr_sbuff_start(&our_in), slen, false);
2420
2421 xlat_func_append_arg(node, arg, false);
2422
2423 *out = node;
2424
2425 FR_SBUFF_SET_RETURN(in, &our_in);
2426}
2427
2428
2429/*
2430 * Tokenize a field without unary operators.
2431 */
2433 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2434 fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond)
2435{
2436 ssize_t slen;
2437 xlat_exp_t *node = NULL;
2438 fr_sbuff_t our_in = FR_SBUFF(in);
2439 fr_sbuff_marker_t opand_m;
2440 tmpl_rules_t our_t_rules;
2441 tmpl_t *vpt = NULL;
2442 fr_token_t quote;
2443 fr_type_t cast_type;
2444 fr_dict_attr_t const *enumv;
2445
2447
2448 /*
2449 * Allow for explicit casts. Non-leaf types are forbidden.
2450 */
2451 if (expr_cast_from_substr(&cast_type, &our_in) < 0) FR_SBUFF_ERROR_RETURN(&our_in);
2452
2453 /*
2454 * Do NOT pass the cast down to the next set of parsing routines. Instead, let the next data be
2455 * parsed as whatever, and then add a cast, or cast in place as necessary.
2456 */
2457 our_t_rules = *t_rules;
2458 if (cast_type == FR_TYPE_NULL) {
2459 cast_type = our_t_rules.cast;
2460 enumv = our_t_rules.enumv;
2461 } else {
2462 enumv = NULL;
2463 }
2464
2465 our_t_rules.cast = FR_TYPE_NULL;
2466// our_t_rules.enumv = NULL;
2467
2468 /*
2469 * As a special case, we allow
2470 *
2471 * &reply = "foo = bar"
2472 *
2473 * and then we don't parse the RHS as any enum.
2474 */
2475 if ( our_t_rules.enumv && !fr_type_is_leaf(our_t_rules.enumv->type)) {
2476 our_t_rules.enumv = enumv = NULL;
2477 }
2478
2479 /*
2480 * If we still have '(', then recurse for other expressions
2481 *
2482 * Tokenize the sub-expression, ensuring that we stop at ')'.
2483 *
2484 * Note that if we have a sub-expression, then we don't use the hinting for "type".
2485 * That's because we're parsing a complete expression here (EXPR). So the intermediate
2486 * nodes in the expression can be almost anything. And we only cast it to the final
2487 * value when we get the output of the expression.
2488 */
2489 if (fr_sbuff_next_if_char(&our_in, '(')) {
2490 our_t_rules.cast = FR_TYPE_NULL;
2491 our_t_rules.enumv = NULL;
2492
2493 fr_sbuff_skip_whitespace(&our_in);
2494 if (fr_sbuff_is_char(&our_in, ')')) {
2495 fr_strerror_printf("Empty expressions are invalid");
2496 FR_SBUFF_ERROR_RETURN(&our_in);
2497 }
2498
2499 /*
2500 * No input rules means "ignore external terminal sequences, as we're expecting a ')' as
2501 * our terminal sequence.
2502 */
2503 if (tokenize_expression(head, &node, &our_in, bracket_rules, &our_t_rules, T_INVALID, bracket_rules, NULL, cond) <= 0) {
2504 FR_SBUFF_ERROR_RETURN(&our_in);
2505 }
2506
2507 if (!fr_sbuff_next_if_char(&our_in, ')')) {
2508 fr_strerror_printf("Failed to find trailing ')'");
2509 FR_SBUFF_ERROR_RETURN(&our_in);
2510 }
2511
2512 /*
2513 * We've parsed one "thing", so we stop. The next thing should be an operator, not
2514 * another value.
2515 *
2516 * The nested call to tokenize_expression() can return >=0 if there are spaces followed by a
2517 * terminal character. So "node" may be NULL;
2518 */
2519 if (!node) {
2520 fr_strerror_const("Empty expressions are invalid");
2521 FR_SBUFF_ERROR_RETURN(&our_in);
2522 }
2523
2524 *out_c = '\0';
2525 goto done;
2526 }
2527
2528 /*
2529 * Record where the operand begins for better error offsets later
2530 */
2531 fr_sbuff_skip_whitespace(&our_in);
2532 fr_sbuff_marker(&opand_m, &our_in);
2533
2535
2536 switch (quote) {
2537 case T_BARE_WORD:
2538 p_rules = bracket_rules;
2539
2540 /*
2541 * Peek for rcodes.
2542 */
2543 if (cond) {
2544 slen = tokenize_rcode(head, &node, &our_in, p_rules->terminals);
2545 if (slen < 0) FR_SBUFF_ERROR_RETURN(&our_in);
2546
2547 if (slen > 0) {
2548 fr_assert(node != NULL);
2549 goto done;
2550 }
2551 }
2553
2554 default:
2555 slen = xlat_tokenize_word(head, &node, &our_in, quote, p_rules, &our_t_rules);
2556 if (slen <= 0) FR_SBUFF_ERROR_RETURN(&our_in);
2557
2558 fr_assert(node != NULL);
2559 break;
2560 }
2561
2562 /*
2563 * Cast value-box.
2564 */
2565 if (node->type == XLAT_BOX) {
2566 if (cast_type != FR_TYPE_NULL) {
2567 if (node->data.type != cast_type) {
2568 if (fr_value_box_cast_in_place(node, &node->data, cast_type, NULL) < 0) goto error;
2569 }
2570
2571 cast_type = FR_TYPE_NULL;
2572 }
2573 }
2574
2575 /*
2576 * Something other than a tmpl, we can just return.
2577 */
2578 if (node->type != XLAT_TMPL) {
2579 xlat_exp_set_name(node, fr_sbuff_current(&opand_m), fr_sbuff_behind(&opand_m));
2580 goto done;
2581 }
2582
2583 vpt = node->vpt;
2584
2585 /*
2586 * The tmpl has a cast, and it's the same as the explicit cast we were given, we can sometimes
2587 * discard the explicit cast.
2588 */
2589 if (cast_type != FR_TYPE_NULL) {
2590 if (tmpl_rules_cast(vpt) == cast_type) {
2591 fr_assert(0);
2592 cast_type = FR_TYPE_NULL;
2593
2594 } else if (tmpl_is_attr(vpt)) {
2595 fr_dict_attr_t const *da;
2596
2598
2599 da = tmpl_attr_tail_da(vpt); /* could be a list! */
2600
2601 /*
2602 * Set the cast for attributes. Note that tmpl_cast_set() will take care of
2603 * suppressing redundant casts. But it still allows (uint32)&Service-Type,
2604 * which means "return the raw value", and not "return enum name".
2605 */
2606 if (da) {
2607 if (tmpl_cast_set(vpt, cast_type) < 0) {
2608 error:
2609 fr_sbuff_set(&our_in, &opand_m);
2610 talloc_free(node);
2611 FR_SBUFF_ERROR_RETURN(&our_in);
2612 }
2613
2614 cast_type = FR_TYPE_NULL;
2615
2616 } else { /* it's something like &reply. */
2617 fr_assert(0);
2618 }
2619
2620 } else if (tmpl_is_data(vpt)) {
2622
2623 /*
2624 * Omit our cast type if the data is already of the right type.
2625 *
2626 * Otherwise if we have a cast, then convert the data now, and then reset the
2627 * cast_type to nothing. This work allows for better errors at startup, and
2628 * minimizes run-time work.
2629 */
2630 if (tmpl_value_type(vpt) == cast_type) {
2631 cast_type = FR_TYPE_NULL;
2632
2633 } else if (tmpl_cast_in_place(vpt, cast_type, enumv) < 0) {
2634 fr_sbuff_set(&our_in, &opand_m);
2635 goto error;
2636
2637 } else {
2638 /*
2639 * We've parsed the data as the new data type, so we don't need any more
2640 * casting.
2641 */
2642 cast_type = FR_TYPE_NULL;
2643 }
2644
2645 } else if (tmpl_contains_xlat(vpt)) {
2646 /*
2647 * (string) "foo %{...}" is redundant. Drop the cast.
2648 */
2649 if ((cast_type == FR_TYPE_STRING) && (vpt->quote != T_BARE_WORD)) {
2651 cast_type = FR_TYPE_NULL;
2652
2653 } else {
2654 /*
2655 * Push the cast to the tmpl.
2656 */
2657 tmpl_cast_set(vpt, cast_type);
2658 cast_type = FR_TYPE_NULL;
2659 }
2660
2661 } else if (tmpl_is_attr_unresolved(vpt)) {
2663
2664 } else if (tmpl_is_data_unresolved(vpt)) {
2665 fr_assert(0);
2666
2667 fr_assert(quote == T_BARE_WORD);
2668 fr_strerror_const("Failed parsing input");
2669 fr_sbuff_set(&our_in, &opand_m);
2670 goto error;
2671
2672 } else {
2673 /*
2674 * Regex? Or something else weird?
2675 */
2676 tmpl_debug(stderr, vpt);
2677 fr_assert(0);
2678 }
2679 }
2680
2682
2683done:
2684 /*
2685 * If there is a cast, then reparent the node with a cast wrapper.
2686 */
2687 if (cast_type != FR_TYPE_NULL) {
2688 xlat_exp_t *cast;
2689
2690 MEM(cast = expr_cast_alloc(head, cast_type, node));
2691 node = cast;
2692 }
2693
2694 *out = node;
2695
2696 fr_sbuff_skip_whitespace(&our_in);
2697 FR_SBUFF_SET_RETURN(in, &our_in);
2698}
2699
2700/*
2701 * A mapping of operators to tokens.
2702 */
2704 { L("!="), T_OP_NE },
2705 { L("!=="), T_OP_CMP_NE_TYPE },
2706
2707 { L("&"), T_AND },
2708 { L("&&"), T_LAND },
2709 { L("*"), T_MUL },
2710 { L("+"), T_ADD },
2711 { L("-"), T_SUB },
2712 { L("/"), T_DIV },
2713 { L("%"), T_MOD },
2714 { L("^"), T_XOR },
2715
2716 { L("|"), T_OR },
2717 { L("||"), T_LOR },
2718
2719 { L("<"), T_OP_LT },
2720 { L("<<"), T_LSHIFT },
2721 { L("<="), T_OP_LE },
2722
2723 { L("="), T_OP_EQ },
2724 { L("=="), T_OP_CMP_EQ },
2725 { L("==="), T_OP_CMP_EQ_TYPE },
2726
2727 { L("=~"), T_OP_REG_EQ },
2728 { L("!~"), T_OP_REG_NE },
2729
2730 { L(">"), T_OP_GT },
2731 { L(">="), T_OP_GE },
2732 { L(">>"), T_RSHIFT },
2733
2734};
2736
2737static bool valid_type(xlat_exp_t *node)
2738{
2739 fr_dict_attr_t const *da;
2740
2741#ifdef STATIC_ANALYZER
2742 if (!node) return false;
2743#endif
2744
2745 if (node->type != XLAT_TMPL) return true;
2746
2747 if (tmpl_is_list(node->vpt)) {
2748 list:
2749 fr_strerror_const("Cannot use list references in condition");
2750 return false;
2751 }
2752
2753 if (!tmpl_is_attr(node->vpt)) return true;
2754
2755 da = tmpl_attr_tail_da(node->vpt);
2756 if (fr_type_is_structural(da->type)) {
2757 if (da->dict == fr_dict_internal()) goto list;
2758
2759 fr_strerror_const("Cannot use structural types in condition");
2760 return false;
2761 }
2762
2763 return true;
2764}
2765
2766
2767/** Tokenize a mathematical operation.
2768 *
2769 * (EXPR)
2770 * !EXPR
2771 * A OP B
2772 *
2773 * If "out" is NULL then the expression is added to "head".
2774 * Otherwise, it's returned to the caller.
2775 */
2777 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules,
2778 fr_token_t prev, fr_sbuff_parse_rules_t const *bracket_rules,
2779 fr_sbuff_parse_rules_t const *input_rules, bool cond)
2780{
2781 xlat_exp_t *lhs = NULL, *rhs, *node;
2782 xlat_t *func = NULL;
2783 fr_token_t op;
2784 ssize_t slen;
2785 fr_sbuff_marker_t m_lhs, m_op, m_rhs;
2786 fr_sbuff_t our_in = FR_SBUFF(in);
2787 char c = '\0';
2788
2790
2791 fr_sbuff_skip_whitespace(&our_in);
2792
2793 fr_sbuff_marker(&m_lhs, &our_in);
2794
2795 /*
2796 * Get the LHS of the operation.
2797 */
2798 slen = tokenize_unary(head, &lhs, &our_in, p_rules, t_rules, bracket_rules, &c, cond);
2799 if (slen <= 0) FR_SBUFF_ERROR_RETURN(&our_in);
2800
2801 if (slen == 0) {
2802 fr_assert(lhs == NULL);
2803 *out = NULL;
2804 FR_SBUFF_SET_RETURN(in, &our_in);
2805 }
2806
2807redo:
2808 rhs = NULL;
2809
2810 fr_sbuff_skip_whitespace(&our_in);
2811
2812 /*
2813 * No more input, we're done.
2814 */
2815 if (fr_sbuff_extend(&our_in) == 0) {
2816 done:
2817 /*
2818 * LHS may be NULL if the expression has spaces followed by a terminal character.
2819 */
2820 *out = lhs;
2821 FR_SBUFF_SET_RETURN(in, &our_in);
2822 }
2823
2824 /*
2825 * ')' is a terminal, even if we didn't expect it.
2826 * Because if we didn't expect it, then it's an error.
2827 *
2828 * If we did expect it, then we return whatever we found,
2829 * and let the caller eat the ')'.
2830 */
2831 if (fr_sbuff_is_char(&our_in, ')')) {
2832 if (!bracket_rules) {
2833 fr_strerror_printf("Unexpected ')'");
2834 FR_SBUFF_ERROR_RETURN(&our_in);
2835 }
2836
2837 goto done;
2838 }
2839 fr_sbuff_skip_whitespace(&our_in);
2840
2841 /*
2842 * We hit a terminal sequence, stop.
2843 */
2844 if (input_rules && fr_sbuff_is_terminal(&our_in, input_rules->terminals)) goto done;
2845
2846 /*
2847 * Remember where we were after parsing the LHS.
2848 */
2849 fr_sbuff_marker(&m_op, &our_in);
2850
2851 /*
2852 * Get the operator.
2853 */
2854 XLAT_DEBUG(" operator <-- %pV", fr_box_strvalue_len(fr_sbuff_current(&our_in), fr_sbuff_remaining(&our_in)));
2856 if ((op == T_INVALID) || !binary_ops[op].str) {
2857 fr_strerror_const("Invalid operator");
2858 fr_sbuff_set(&our_in, &m_op);
2859 talloc_free(lhs);
2860 FR_SBUFF_ERROR_RETURN(&our_in);
2861 }
2862
2863 /*
2864 * We can't (yet) do &list1 = &list2 + &list3
2865 */
2866 if (fr_binary_op[op] && t_rules->enumv && fr_type_is_structural(t_rules->enumv->type)) {
2867 fr_strerror_const("Invalid operator for structural attribute");
2868 fr_sbuff_set(&our_in, &m_op);
2869 talloc_free(lhs);
2870 FR_SBUFF_ERROR_RETURN(&our_in);
2871 }
2872
2873 fr_assert(precedence[op] != 0);
2874
2875 /*
2876 * a * b + c ... = (a * b) + c ...
2877 *
2878 * Feed the current expression to the caller, who will
2879 * take care of continuing.
2880 */
2881 if (precedence[op] <= precedence[prev]) {
2882 fr_sbuff_set(&our_in, &m_op);
2883 goto done;
2884 }
2885
2886 /*
2887 * &Foo and !&Foo are permitted as the LHS of || and &&
2888 */
2889 if (((c == '!') || (c == '~')) && (op != T_LAND) && (op != T_LOR)) {
2890 fr_strerror_printf("Operator '%c' is only applied to the left hand side of the '%s' operation, add (..) to evaluate the operation first", c, fr_tokens[op]);
2891 fail_lhs:
2892 fr_sbuff_set(&our_in, &m_lhs);
2893 FR_SBUFF_ERROR_RETURN(&our_in);
2894 }
2895
2896 fr_sbuff_skip_whitespace(&our_in);
2897 fr_sbuff_marker(&m_rhs, &our_in);
2898
2899 /*
2900 * We now parse the RHS, allowing a (perhaps different) cast on the RHS.
2901 */
2902 XLAT_DEBUG(" recurse RHS <-- %pV", fr_box_strvalue_len(fr_sbuff_current(&our_in), fr_sbuff_remaining(&our_in)));
2903 if ((op == T_OP_REG_EQ) || (op == T_OP_REG_NE)) {
2905
2906 /*
2907 * @todo - LHS shouldn't be anything else.
2908 */
2909 switch (lhs->type) {
2910 case XLAT_TMPL:
2911 type = tmpl_cast_get(lhs->vpt);
2912 if ((type != FR_TYPE_NULL) && (type != FR_TYPE_STRING)) {
2913 fr_strerror_const("Casts cannot be used with regular expressions");
2914 fr_sbuff_set(&our_in, &m_lhs);
2915 FR_SBUFF_ERROR_RETURN(&our_in);
2916 }
2917
2918 /*
2919 * Cast the LHS to a string, if it's not already one!
2920 */
2921 if (lhs->vpt->quote == T_BARE_WORD) tmpl_cast_set(lhs->vpt, FR_TYPE_STRING);
2922 break;
2923
2924 case XLAT_BOX:
2925 /*
2926 * 192.168.0.1 =~ /foo/
2927 *
2928 * Gets the LHS automatically converted to a string.
2929 */
2930 if (lhs->data.type != FR_TYPE_STRING) {
2931 if (fr_value_box_cast_in_place(lhs, &lhs->data, FR_TYPE_STRING, NULL) < 0) {
2932 fr_sbuff_set(&our_in, &m_lhs);
2933 FR_SBUFF_ERROR_RETURN(&our_in);
2934 }
2935 }
2936 break;
2937
2938 default:
2939 /*
2940 * @todo - if we hoist the LHS to a function instead of an xlat->tmpl->xlat, then
2941 * we can't cast the LHS to a string. OR, we have to manually add a lHS cast to
2942 * a string. Maybe we need to delay the LHS hoisting until such time as we know
2943 * it's safe.
2944 *
2945 * Also, hoisting a double-quoted xlat string to a _list_ of xlats is hard,
2946 * because we expect the LHS here to be one node. So perhaps the hoisting has to
2947 * be from an XLAT_TMPL to an XLAT_GROUP, which is still perhaps a bit of an
2948 * improvement.
2949 */
2950 break;
2951
2952 }
2953
2954 slen = tokenize_regex_rhs(head, &rhs, &our_in, t_rules, bracket_rules);
2955 } else {
2956 tmpl_rules_t our_t_rules = *t_rules;
2957
2958 /*
2959 * Pass the enumv down ONLY if the RHS name begins with "::".
2960 *
2961 * Otherwise, the terminal rules for expressions includes "-" and "+", both of which are
2962 * allowed in enum names. If we pass the enumv down to the next function, it will see
2963 * "Access-Accept", and then only parse "Access". Which is wrong.
2964 */
2965 if ((lhs->type == XLAT_TMPL) && tmpl_is_attr(lhs->vpt) &&
2966 fr_sbuff_is_str_literal(&our_in, "::")) {
2967 our_t_rules.enumv = tmpl_attr_tail_da(lhs->vpt);
2968 }
2969
2970 slen = tokenize_expression(head, &rhs, &our_in, p_rules, &our_t_rules, op, bracket_rules, input_rules, cond);
2971 }
2972 if (slen <= 0) {
2973 talloc_free(lhs);
2974 FR_SBUFF_ERROR_RETURN(&our_in);
2975 }
2976
2977 /*
2978 * The nested call to tokenize_expression() can return >=0 if there are spaces followed by a
2979 * terminal character.
2980 */
2981 if (!rhs) goto done;
2982
2983 func = xlat_func_find(binary_ops[op].str, binary_ops[op].len);
2984 fr_assert(func != NULL);
2985
2986 if (multivalue_ops[op]) {
2987 if ((lhs->type == XLAT_FUNC) && (lhs->call.func->token == op)) {
2988 xlat_func_append_arg(lhs, rhs, cond);
2989
2990 lhs->call.args->flags.can_purify |= rhs->flags.can_purify | rhs->flags.pure;
2991 lhs->flags.can_purify = lhs->call.args->flags.can_purify;
2992 goto redo;
2993 }
2994 goto purify;
2995 }
2996
2997 /*
2998 * Complain on comparisons between invalid data types.
2999 *
3000 * @todo - allow
3001 *
3002 * &structural == {}
3003 * &structural != {}
3004 *
3005 * as special cases, so we can check lists for emptiness.
3006 */
3007 if (fr_comparison_op[op]) {
3008 if (!valid_type(lhs)) goto fail_lhs;
3009 if (!valid_type(rhs)) {
3010 fr_sbuff_set(&our_in, &m_rhs);
3011 FR_SBUFF_ERROR_RETURN(&our_in);
3012 }
3013
3014 /*
3015 * Peephole optimization. If both LHS
3016 * and RHS are static values, then just call the
3017 * relevant condition code to get the result.
3018 */
3019 if (cond) {
3020 int rcode;
3021
3022 purify:
3023 rcode = xlat_purify_op(head, &node, lhs, op, rhs);
3024 if (rcode < 0) goto fail_lhs;
3025
3026 if (rcode) {
3027 lhs = node;
3028 goto redo;
3029 }
3030 }
3031 }
3032
3033 /*
3034 * Create the function node, with the LHS / RHS arguments.
3035 */
3036 MEM(node = xlat_exp_alloc(head, XLAT_FUNC, fr_tokens[op], strlen(fr_tokens[op])));
3037 xlat_exp_set_func(node, func, t_rules->attr.dict_def);
3038
3039 xlat_func_append_arg(node, lhs, logical_ops[op] && cond);
3040 xlat_func_append_arg(node, rhs, logical_ops[op] && cond);
3041
3042 fr_assert(xlat_exp_head(node->call.args) != NULL);
3043
3044 /*
3045 * Logical operations can be purified if ANY of their arguments can be purified.
3046 */
3047 if (logical_ops[op]) {
3048 xlat_exp_foreach(node->call.args, arg) {
3049 node->call.args->flags.can_purify |= arg->flags.can_purify | arg->flags.pure;
3050 if (node->call.args->flags.can_purify) break;
3051 }
3052 node->flags.can_purify = node->call.args->flags.can_purify;
3053
3054 } else {
3055 node->flags.can_purify = (node->call.func->flags.pure && node->call.args->flags.pure) | node->call.args->flags.can_purify;
3056 }
3057
3058 lhs = node;
3059 goto redo;
3060}
3061
3063 L(""),
3064 L(")"),
3065);
3066
3068 L("\t"),
3069 L("\n"),
3070 L("\r"),
3071 L(" "),
3072 L("!"),
3073 L("%"),
3074 L("&"),
3075 L("*"),
3076 L("+"),
3077 L("-"),
3078 L("/"),
3079 L("<"),
3080 L("="),
3081 L(">"),
3082 L("^"),
3083 L("|"),
3084 L("~"),
3085);
3086
3088 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, bool cond)
3089{
3090 fr_slen_t slen;
3091 fr_sbuff_parse_rules_t *bracket_rules = NULL;
3092 fr_sbuff_parse_rules_t *terminal_rules = NULL;
3093 tmpl_rules_t my_rules = { };
3095 xlat_exp_t *node = NULL;
3096
3097 /*
3098 * Whatever the caller passes, ensure that we have a
3099 * terminal rule which ends on operators, and a terminal
3100 * rule which ends on ')'.
3101 */
3102 MEM(bracket_rules = talloc_zero(ctx, fr_sbuff_parse_rules_t));
3103 MEM(terminal_rules = talloc_zero(ctx, fr_sbuff_parse_rules_t));
3104 if (p_rules) {
3105 *bracket_rules = *p_rules;
3106 *terminal_rules = *p_rules;
3107
3108 if (p_rules->terminals) {
3109 MEM(terminal_rules->terminals = fr_sbuff_terminals_amerge(terminal_rules,
3110 p_rules->terminals,
3111 &operator_terms));
3112 } else {
3113 terminal_rules->terminals = &operator_terms;
3114 }
3115 } else {
3116 terminal_rules->terminals = &operator_terms;
3117 }
3118 MEM(bracket_rules->terminals = fr_sbuff_terminals_amerge(bracket_rules,
3119 terminal_rules->terminals,
3120 &bracket_terms));
3121
3123 if (!t_rules) t_rules = &my_rules;
3124
3125 slen = tokenize_expression(head, &node, in, terminal_rules, t_rules, T_INVALID, bracket_rules, p_rules, cond);
3126 talloc_free(bracket_rules);
3127 talloc_free(terminal_rules);
3128
3129 if (slen <= 0) {
3131 return slen;
3132 }
3133
3134 if (!node) {
3135 *out = head;
3136 return slen;
3137 }
3138
3139 /*
3140 * If the tmpl is not resolved, then it refers to an attribute which doesn't exist. That's an
3141 * error.
3142 */
3143 if (node->type == XLAT_TMPL) {
3144 if (tmpl_is_data_unresolved(node->vpt)) {
3145 fr_strerror_const("Unknown attribute");
3146 return -1;
3147 }
3148
3149 /*
3150 * Convert raw existence checks to existence functions.
3151 */
3152 if (tmpl_contains_attr(node->vpt)) {
3153 if (cond) MEM(node = xlat_exists_alloc(head, node));
3154 }
3155 }
3156
3158
3159 *out = head;
3160 return slen;
3161}
3162
3164 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
3165{
3166 fr_slen_t slen;
3167
3168 slen = xlat_tokenize_expression_internal(ctx, out, in, p_rules, t_rules, false);
3169 if (slen < 0) return slen;
3170
3171#ifdef STATIC_ANALYZER
3172 /*
3173 * Coverity doesn't realise that out will be set by this point
3174 * by a successful call to xlat_tokenize_expression_internal.
3175 */
3176 if (!out) return -1;
3177#endif
3178 if (!*out) {
3179 fr_strerror_const("Empty expressions are invalid");
3180 return -1;
3181 }
3182
3183 if (xlat_finalize(*out, t_rules->xlat.runtime_el) < 0) {
3184 TALLOC_FREE(*out);
3185 return -1;
3186 }
3187
3188 return slen;
3189}
3190
3192 fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
3193{
3194 fr_slen_t slen;
3195
3196 slen = xlat_tokenize_expression_internal(ctx, out, in, p_rules, t_rules, true);
3197 if (slen < 0) return slen;
3198
3199#ifdef STATIC_ANALYZER
3200 if (!out) return -1;
3201#endif
3202 if (!*out) {
3203 fr_strerror_const("Empty conditions are invalid");
3204 return -1;
3205 }
3206
3207 if (xlat_finalize(*out, t_rules->xlat.runtime_el) < 0) {
3208 TALLOC_FREE(*out);
3209 return -1;
3210 }
3211
3212 return slen;
3213}
3214
3215/** Allow callers to see if an xlat is truthy
3216 *
3217 * So the caller can cache it, and needs to check fewer things at run
3218 * time.
3219 *
3220 * @param[in] head of the xlat to check
3221 * @param[out] out truthiness of the box
3222 * @return
3223 * - false - xlat is not truthy, *out is unchanged.
3224 * - true - xlat is truthy, *out is the result of fr_value_box_is_truthy()
3225 */
3227{
3228 xlat_exp_t const *node;
3229 fr_value_box_t const *box;
3230
3231 /*
3232 * Only pure / constant things can be truthy.
3233 */
3234 if (!head->flags.pure) goto return_false;
3235
3236 node = xlat_exp_head(head);
3237 if (!node) {
3238 *out = false;
3239 return true;
3240 }
3241
3242 if (xlat_exp_next(head, node)) goto return_false;
3243
3244 if (node->type == XLAT_BOX) {
3245 box = &node->data;
3246
3247 } else if ((node->type == XLAT_TMPL) && tmpl_is_data(node->vpt)) {
3248 box = tmpl_value(node->vpt);
3249
3250 } else {
3251 return_false:
3252 *out = false;
3253 return false;
3254 }
3255
3257 return true;
3258}
va_list args
Definition acutest.h:770
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
Definition build.h:186
#define RCSID(id)
Definition build.h:512
#define L(_str)
Helper for initialising arrays of string literals.
Definition build.h:228
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
Definition build.h:343
#define unlikely(_x)
Definition build.h:407
#define UNUSED
Definition build.h:336
#define NUM_ELEMENTS(_t)
Definition build.h:358
int fr_value_calc_list_cmp(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_value_box_list_t const *list1, fr_token_t op, fr_value_box_list_t const *list2)
Definition calc.c:2724
int fr_value_calc_binary_op(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t hint, fr_value_box_t const *a, fr_token_t op, fr_value_box_t const *b)
Calculate DST = A OP B.
Definition calc.c:1991
int fr_value_calc_unary_op(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_token_t op, fr_value_box_t const *src)
Calculate unary operations.
Definition calc.c:2558
static int fr_dcursor_append(fr_dcursor_t *cursor, void *v)
Insert a single item at the end of the list.
Definition dcursor.h:406
#define fr_cond_assert(_x)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:141
#define MEM(x)
Definition debug.h:46
#define ERROR(fmt,...)
Definition dhcpclient.c:40
bool const fr_dict_attr_allowed_chars[SBUFF_CHAR_CLASS]
Characters allowed in a single dictionary attribute name.
Definition dict_util.c:63
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4928
static fr_slen_t in
Definition dict.h:882
static void * fr_dlist_remove(fr_dlist_head_t *list_head, void *ptr)
Remove an item from the list.
Definition dlist.h:620
static unsigned int fr_dlist_num_elements(fr_dlist_head_t const *head)
Return the number of elements in the dlist.
Definition dlist.h:921
static void * fr_dlist_pop_head(fr_dlist_head_t *list_head)
Remove the head item in a list.
Definition dlist.h:654
static int fr_dlist_insert_tail(fr_dlist_head_t *list_head, void *ptr)
Insert an item into the tail of a list.
Definition dlist.h:360
static xlat_action_t xlat_func_rcode(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *args)
Return the current rcode as a string.
Definition xlat_expr.c:1679
static xlat_action_t xlat_func_exists(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
See if a named attribute exists.
Definition xlat_expr.c:1786
static xlat_action_t xlat_func_expr_rcode(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
Match the passed rcode against request->rcode.
Definition xlat_expr.c:1622
talloc_free(hp)
TALLOC_CTX * unlang_interpret_frame_talloc_ctx(request_t *request)
Get a talloc_ctx which is valid only for this frame.
Definition interpret.c:1685
#define UNLANG_SUB_FRAME
Definition interpret.h:37
#define RDEBUG3(fmt,...)
Definition log.h:355
#define RPEDEBUG(fmt,...)
Definition log.h:388
fr_type_t
@ FR_TYPE_INT8
8 Bit signed integer.
@ FR_TYPE_STRING
String of printable characters.
@ FR_TYPE_NULL
Invalid (uninitialised) attribute type.
@ FR_TYPE_UINT16
16 Bit unsigned integer.
@ FR_TYPE_INT64
64 Bit signed integer.
@ FR_TYPE_INT16
16 Bit signed integer.
@ FR_TYPE_UINT8
8 Bit unsigned integer.
@ FR_TYPE_UINT32
32 Bit unsigned integer.
@ FR_TYPE_INT32
32 Bit signed integer.
@ FR_TYPE_UINT64
64 Bit unsigned integer.
@ FR_TYPE_VOID
User data.
@ FR_TYPE_BOOL
A truth value.
@ FR_TYPE_SIZE
Unsigned integer capable of representing any memory address on the local system.
@ FR_TYPE_OCTETS
Raw octets.
@ FR_TYPE_GROUP
A grouping of other attributes.
unsigned int uint32_t
long int ssize_t
ssize_t fr_slen_t
#define fr_assert(_expr)
Definition rad_assert.h:37
#define REDEBUG(fmt,...)
#define RDEBUG(fmt,...)
static bool done
Definition radclient.c:80
fr_table_num_sorted_t const rcode_table[]
Definition rcode.c:35
rlm_rcode_t
Return codes indicating the result of the module call.
Definition rcode.h:44
@ RLM_MODULE_NOT_SET
Error resolving rcode (should not be returned by modules).
Definition rcode.h:45
@ RLM_MODULE_NUMCODES
How many valid return codes there are.
Definition rcode.h:57
static char const * name
bool const sbuff_char_word[SBUFF_CHAR_CLASS]
Definition sbuff.c:100
bool fr_sbuff_is_terminal(fr_sbuff_t *in, fr_sbuff_term_t const *tt)
Efficient terminal string search.
Definition sbuff.c:2193
fr_sbuff_term_t * fr_sbuff_terminals_amerge(TALLOC_CTX *ctx, fr_sbuff_term_t const *a, fr_sbuff_term_t const *b)
Merge two sets of terminal strings.
Definition sbuff.c:658
bool fr_sbuff_next_if_char(fr_sbuff_t *sbuff, char c)
Return true if the current char matches, and if it does, advance.
Definition sbuff.c:2129
#define fr_sbuff_start(_sbuff_or_marker)
#define fr_sbuff_out_by_longest_prefix(_match_len, _out, _table, _sbuff, _def)
#define fr_sbuff_is_str_literal(_sbuff, _str)
#define FR_SBUFF_IN_CHAR_RETURN(_sbuff,...)
#define fr_sbuff_set(_dst, _src)
#define fr_sbuff_adv_past_whitespace(_sbuff, _len, _tt)
#define fr_sbuff_current(_sbuff_or_marker)
#define fr_sbuff_char(_sbuff_or_marker, _eob)
#define FR_SBUFF_TERMS(...)
Initialise a terminal structure with a list of sorted strings.
Definition sbuff.h:190
#define FR_SBUFF_IN_STRCPY_LITERAL_RETURN(_sbuff, _str)
#define fr_sbuff_extend(_sbuff_or_marker)
#define fr_sbuff_used_total(_sbuff_or_marker)
#define FR_SBUFF_RETURN(_func, _sbuff,...)
#define fr_sbuff_is_char(_sbuff_or_marker, _c)
#define FR_SBUFF_ERROR_RETURN(_sbuff_or_marker)
#define FR_SBUFF_SET_RETURN(_dst, _src)
#define fr_sbuff_is_digit(_sbuff_or_marker)
#define FR_SBUFF(_sbuff_or_marker)
#define fr_sbuff_advance(_sbuff_or_marker, _len)
#define fr_sbuff_remaining(_sbuff_or_marker)
#define fr_sbuff_used(_sbuff_or_marker)
#define fr_sbuff_behind(_sbuff_or_marker)
#define FR_SBUFF_IN_STRCPY_RETURN(...)
#define FR_SBUFF_TALLOC_THREAD_LOCAL(_out, _init, _max)
Terminal element with pre-calculated lengths.
Definition sbuff.h:159
Set of terminal elements.
#define tmpl_contains_xlat(vpt)
Definition tmpl.h:227
#define tmpl_is_attr_unresolved(vpt)
Definition tmpl.h:219
int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules))
Attempt to resolve functions and attributes in xlats and attribute references.
#define tmpl_value(_tmpl)
Definition tmpl.h:937
#define tmpl_contains_regex(vpt)
Definition tmpl.h:226
#define tmpl_is_attr(vpt)
Definition tmpl.h:208
fr_dict_attr_t const * enumv
Enumeration attribute used to resolve enum values.
Definition tmpl.h:342
#define tmpl_xlat(_tmpl)
Definition tmpl.h:930
#define tmpl_rules_cast(_tmpl)
Definition tmpl.h:942
#define tmpl_contains_attr(vpt)
Definition tmpl.h:225
ssize_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_token_t quote, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Convert an arbitrary string into a tmpl_t.
tmpl_xlat_rules_t xlat
Rules/data for parsing xlats.
Definition tmpl.h:340
static bool tmpl_is_list(tmpl_t const *vpt)
Definition tmpl.h:920
int tmpl_cast_in_place(tmpl_t *vpt, fr_type_t type, fr_dict_attr_t const *enumv))
Convert tmpl_t of type TMPL_TYPE_DATA_UNRESOLVED or TMPL_TYPE_DATA to TMPL_TYPE_DATA of type specifie...
#define tmpl_is_data(vpt)
Definition tmpl.h:206
static fr_slen_t vpt
Definition tmpl.h:1269
void tmpl_debug(FILE *fp, tmpl_t const *vpt)
#define tmpl_value_type(_tmpl)
Definition tmpl.h:939
static fr_type_t tmpl_cast_get(tmpl_t *vpt)
Definition tmpl.h:1220
#define tmpl_is_data_unresolved(vpt)
Definition tmpl.h:217
fr_type_t cast
Whether there was an explicit cast.
Definition tmpl.h:344
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:339
static fr_dict_attr_t const * tmpl_attr_tail_da(tmpl_t const *vpt)
Return the last attribute reference da.
Definition tmpl.h:801
struct tmpl_res_rules_s tmpl_res_rules_t
Definition tmpl.h:237
#define tmpl_is_regex(vpt)
Definition tmpl.h:213
fr_dict_attr_t const * enumv
for resolving T_BARE_WORD
Definition tmpl.h:377
fr_event_list_t * runtime_el
The eventlist to use for runtime instantiation of xlats.
Definition tmpl.h:328
#define tmpl_needs_resolving(vpt)
Definition tmpl.h:223
int tmpl_cast_set(tmpl_t *vpt, fr_type_t type)
Set a cast for a tmpl.
Similar to tmpl_rules_t, but used to specify parameters that may change during subsequent resolution ...
Definition tmpl.h:368
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:336
static void xor(char *out, char *in1, char *in2, int n)
Definition smbdes.c:183
static void lshift(char *d, int count, int n)
Definition smbdes.c:165
eap_aka_sim_process_conf_t * inst
fr_aka_sim_id_type_t type
fr_pair_t * vp
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:273
unsigned int allow_unresolved
Allow attributes that look valid but were not found in the dictionaries.
Definition tmpl.h:306
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
#define fr_table_value_by_str(_table, _name, _def)
Convert a string to a value using a sorted or ordered table.
Definition table.h:653
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
An element in a lexicographically sorted array of name to num mappings.
Definition table.h:49
#define talloc_get_type_abort_const
Definition talloc.h:110
static int talloc_const_free(void const *ptr)
Free const'd memory.
Definition talloc.h:253
void tmpl_dcursor_clear(tmpl_dcursor_ctx_t *cc)
Clear any temporary state allocations.
#define tmpl_dcursor_init(_err, _ctx, _cc, _cursor, _request, _vpt)
Maintains state between cursor calls.
const char fr_token_quote[T_TOKEN_LAST]
Convert tokens back to a quoting character.
Definition token.c:158
char const * fr_tokens[T_TOKEN_LAST]
Definition token.c:80
const bool fr_comparison_op[T_TOKEN_LAST]
Definition token.c:200
const bool fr_binary_op[T_TOKEN_LAST]
Definition token.c:218
enum fr_token fr_token_t
@ T_AND
Definition token.h:53
@ T_INVALID
Definition token.h:37
@ T_SUB
Definition token.h:50
@ T_RSHIFT
Definition token.h:60
@ T_NOT
Definition token.h:55
@ T_XOR
Definition token.h:56
@ T_DIV
Definition token.h:52
@ T_SINGLE_QUOTED_STRING
Definition token.h:120
@ T_MOD
Definition token.h:58
@ T_BARE_WORD
Definition token.h:118
@ T_OP_EQ
Definition token.h:81
@ T_LAND
Definition token.h:89
@ T_COMPLEMENT
Definition token.h:57
@ T_ADD
Definition token.h:49
@ T_BACK_QUOTED_STRING
Definition token.h:121
@ T_OP_NE
Definition token.h:95
@ T_LOR
Definition token.h:90
@ T_LSHIFT
Definition token.h:61
@ T_OP_REG_EQ
Definition token.h:100
@ T_OP_CMP_EQ_TYPE
Definition token.h:105
@ T_DOUBLE_QUOTED_STRING
Definition token.h:119
@ T_OP_CMP_EQ
Definition token.h:104
@ T_LBRACE
Definition token.h:41
@ T_MUL
Definition token.h:51
@ T_OP_LE
Definition token.h:98
@ T_OP_CMP_NE_TYPE
Definition token.h:106
@ T_OP_GE
Definition token.h:96
@ T_OP_GT
Definition token.h:97
@ T_SOLIDUS_QUOTED_STRING
Definition token.h:122
@ T_OP_LT
Definition token.h:99
@ T_OP_REG_NE
Definition token.h:101
@ T_OR
Definition token.h:54
#define T_TOKEN_LAST
Definition token.h:127
xlat_action_t unlang_xlat_yield(request_t *request, xlat_func_t resume, xlat_func_signal_t signal, fr_signal_t sigmask, void *rctx)
Yield a request back to the interpreter from within a module.
Definition xlat.c:543
int unlang_xlat_push(TALLOC_CTX *ctx, unlang_result_t *p_result, fr_value_box_list_t *out, request_t *request, xlat_exp_head_t const *xlat, bool top_frame)
Push a pre-compiled xlat onto the stack for evaluation.
Definition xlat.c:269
tmpl_res_rules_t const * tr_rules
tmpl resolution rules.
Definition xlat.h:165
fr_type_t type
Type to cast argument to.
Definition xlat.h:155
unsigned int pure
has no external side effects, true for BOX, LITERAL, and some functions
Definition xlat.h:110
fr_slen_t xlat_print(fr_sbuff_t *in, xlat_exp_head_t const *node, fr_sbuff_escape_rules_t const *e_rules)
Reconstitute an xlat expression from its constituent nodes.
unsigned int concat
Concat boxes together.
Definition xlat.h:147
static fr_slen_t head
Definition xlat.h:420
#define XLAT_RESULT_SUCCESS(_p_result)
Definition xlat.h:500
static fr_slen_t xlat_aprint(TALLOC_CTX *ctx, char **out, xlat_exp_head_t const *head, fr_sbuff_escape_rules_t const *e_rules) 1(xlat_print
int xlat_purify_op(TALLOC_CTX *ctx, xlat_exp_t **out, xlat_exp_t *lhs, fr_token_t op, xlat_exp_t *rhs)
xlat_action_t(* xlat_func_t)(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
xlat callback function
Definition xlat.h:232
#define XLAT_ARGS(_list,...)
Populate local variables with value boxes from the input list.
Definition xlat.h:383
int xlat_flatten_to_argv(TALLOC_CTX *ctx, xlat_exp_head_t ***argv, xlat_exp_head_t *head)
Turn am xlat list into an argv[] array, and nuke the input list.
Definition xlat_eval.c:1900
unsigned int required
Argument must be present, and non-empty.
Definition xlat.h:146
#define XLAT_VERIFY(_node)
Definition xlat.h:463
int xlat_resolve(xlat_exp_head_t *head, xlat_res_rules_t const *xr_rules)
Walk over an xlat tree recursively, resolving any unresolved functions or references.
#define XLAT_ARG_PARSER_TERMINATOR
Definition xlat.h:170
int xlat_finalize(xlat_exp_head_t *head, fr_event_list_t *runtime_el)
Bootstrap static xlats, or instantiate ephemeral ones.
Definition xlat_inst.c:692
xlat_action_t
Definition xlat.h:37
@ XLAT_ACTION_FAIL
An xlat function failed.
Definition xlat.h:44
@ XLAT_ACTION_YIELD
An xlat function pushed a resume frame onto the stack.
Definition xlat.h:42
@ XLAT_ACTION_PUSH_UNLANG
An xlat function pushed an unlang frame onto the unlang stack.
Definition xlat.h:39
@ XLAT_ACTION_DONE
We're done evaluating this level of nesting.
Definition xlat.h:43
unsigned int can_purify
if the xlat has a pure function with pure arguments.
Definition xlat.h:112
unsigned int constant
xlat is just tmpl_attr_tail_data, or XLAT_BOX
Definition xlat.h:114
unsigned int needs_resolving
Needs pass2 resolution.
Definition xlat.h:109
int xlat_instance_unregister_func(xlat_exp_t *node)
Remove a node from the list of xlat instance data.
Definition xlat_inst.c:547
Definition for a single argument consumed by an xlat function.
Definition xlat.h:145
Flags that control resolution and evaluation.
Definition xlat.h:108
static fr_slen_t parent
Definition pair.h:858
#define add(_type, _out, _in)
Definition stats.c:187
#define fr_strerror_printf(_fmt,...)
Log to thread local error buffer.
Definition strerror.h:64
#define fr_strerror_const(_msg)
Definition strerror.h:223
fr_table_num_ordered_t const fr_type_table[]
Map data types to names representing those types.
Definition types.c:31
#define fr_type_is_variable_size(_x)
Definition types.h:388
#define fr_type_is_structural(_x)
Definition types.h:392
#define fr_type_is_null(_x)
Definition types.h:347
#define fr_type_is_leaf(_x)
Definition types.h:393
static char const * fr_type_to_str(fr_type_t type)
Return a static string containing the type name.
Definition types.h:454
ssize_t fr_value_box_list_concat_as_string(fr_value_box_t *safety, fr_sbuff_t *sbuff, fr_value_box_list_t *list, char const *sep, size_t sep_len, fr_sbuff_escape_rules_t const *e_rules, fr_value_box_list_action_t proc_action, fr_value_box_safe_for_t safe_for, bool flatten)
Concatenate a list of value boxes together.
Definition value.c:6373
fr_sbuff_parse_rules_t const * value_parse_rules_quoted[T_TOKEN_LAST]
Parse rules for quoted strings.
Definition value.c:611
int fr_value_box_copy(TALLOC_CTX *ctx, fr_value_box_t *dst, const fr_value_box_t *src)
Copy value data verbatim duplicating any buffers.
Definition value.c:4379
bool fr_value_box_is_truthy(fr_value_box_t const *in)
Check truthiness of values.
Definition value.c:7375
int fr_value_box_cast_in_place(TALLOC_CTX *ctx, fr_value_box_t *vb, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv)
Convert one type of fr_value_box_t to another in place.
Definition value.c:4181
void fr_value_box_memdup_shallow(fr_value_box_t *dst, fr_dict_attr_t const *enumv, uint8_t const *src, size_t len, bool tainted)
Assign a buffer to a box, but don't copy it.
Definition value.c:5148
int fr_value_box_strdup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Copy a nul terminated string to a fr_value_box_t.
Definition value.c:4604
void fr_value_box_strdup_shallow(fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Assign a buffer containing a nul terminated string to a box, but don't copy it.
Definition value.c:4714
void fr_value_box_safety_copy(fr_value_box_t *out, fr_value_box_t const *in)
Copy the safety values from one box to another.
Definition value.c:7315
void fr_value_box_clear(fr_value_box_t *data)
Clear/free any existing value and metadata.
Definition value.c:4362
int fr_value_box_bstrndup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, size_t len, bool tainted)
Copy a string to to a fr_value_box_t.
Definition value.c:4823
@ FR_VALUE_BOX_LIST_FREE_BOX
Free each processed box.
Definition value.h:235
#define fr_value_box_alloc(_ctx, _type, _enumv)
Allocate a value box of a specific type.
Definition value.h:644
#define fr_value_box_mark_safe_for(_box, _safe_for)
Definition value.h:1093
#define fr_box_strvalue_len(_val, _len)
Definition value.h:309
#define VALUE_BOX_LIST_VERIFY(_x)
Definition value.h:1371
int nonnull(2, 5))
#define fr_value_box_alloc_null(_ctx)
Allocate a value box for later use with a value assignment function.
Definition value.h:655
#define fr_value_box_init(_vb, _type, _enumv, _tainted)
Initialise a fr_value_box_t.
Definition value.h:610
#define fr_value_box_list_foreach(_list_head, _iter)
Definition value.h:224
static size_t char ** out
Definition value.h:1030
#define FR_VALUE_BOX_SAFE_FOR_ANY
Definition value.h:173
void xlat_exp_set_vpt(xlat_exp_t *node, tmpl_t *vpt)
Set the tmpl for a node, along with flags and the name.
Definition xlat_alloc.c:252
void xlat_exp_set_name(xlat_exp_t *node, char const *fmt, size_t len)
Set the format string for an xlat node.
Definition xlat_alloc.c:308
void xlat_exp_set_func(xlat_exp_t *node, xlat_t const *func, fr_dict_t const *dict)
Set the function for a node.
Definition xlat_alloc.c:274
void xlat_exp_set_name_shallow(xlat_exp_t *node, char const *fmt)
Set the format string for an xlat node from a pre-existing buffer.
Definition xlat_alloc.c:338
void * rctx
Resume context.
Definition xlat_ctx.h:54
xlat_exp_t * ex
Tokenized expression to use in expansion.
Definition xlat_ctx.h:64
void const * inst
xlat instance data.
Definition xlat_ctx.h:50
void * inst
xlat instance data to populate.
Definition xlat_ctx.h:63
An xlat calling ctx.
Definition xlat_ctx.h:49
An xlat instantiation ctx.
Definition xlat_ctx.h:62
fr_dict_attr_t const * attr_expr_bool_enum
Definition xlat_eval.c:42
fr_dict_attr_t const * attr_cast_base
Definition xlat_eval.c:43
static xlat_action_t xlat_func_regex_search(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:835
tmpl_t const * vpt
the attribute reference
Definition xlat_expr.c:1699
#define fr_sbuff_skip_whitespace(_x)
Definition xlat_expr.c:2044
static size_t const expr_assignment_op_table_len
Definition xlat_expr.c:2735
static fr_slen_t xlat_expr_print_binary(fr_sbuff_t *out, xlat_exp_t const *node, UNUSED void *inst, fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:151
#define XLAT_REGISTER_BOOL(_xlat, _func, _arg, _ret_type)
Definition xlat_expr.c:1843
static fr_slen_t xlat_expr_print_rcode(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, UNUSED fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:1587
static void xlat_func_append_arg(xlat_exp_t *head, xlat_exp_t *node, bool exists)
Definition xlat_expr.c:70
bool xlat_is_truthy(xlat_exp_head_t const *head, bool *out)
Allow callers to see if an xlat is truthy.
Definition xlat_expr.c:3226
static xlat_action_t xlat_func_logical(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Process logical &&, ||.
Definition xlat_expr.c:1384
xlat_exp_t * xlat
to expand
Definition xlat_expr.c:514
#define XLAT_BINARY_FUNC(_name, _op)
Definition xlat_expr.c:375
static const fr_sbuff_term_t bracket_terms
Definition xlat_expr.c:3062
static size_t expr_quote_table_len
Definition xlat_expr.c:2068
static int xlat_instantiate_exists(xlat_inst_ctx_t const *xctx)
Definition xlat_expr.c:1727
static fr_slen_t xlat_expr_print_nary(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:877
int xlat_register_expressions(void)
Definition xlat_expr.c:1859
static xlat_arg_parser_t const xlat_func_exists_arg[]
Definition xlat_expr.c:1702
static xlat_action_t xlat_logical_process_arg(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Process one argument of a logical operation.
Definition xlat_expr.c:1126
static fr_slen_t xlat_tokenize_expression_internal(TALLOC_CTX *ctx, xlat_exp_head_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, bool cond)
Definition xlat_expr.c:3087
static fr_slen_t xlat_expr_print_unary(fr_sbuff_t *out, xlat_exp_t const *node, UNUSED void *inst, fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:141
#define P(_x, _y)
Definition xlat_expr.c:1988
static xlat_arg_parser_t const regex_op_xlat_args[]
Definition xlat_expr.c:631
static void xlat_ungroup(xlat_exp_head_t *head)
Undo work which shouldn't have been done.
Definition xlat_expr.c:973
static xlat_action_t xlat_func_unary_complement(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:1492
static xlat_action_t xlat_cmp_op(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in, fr_token_t op)
Definition xlat_expr.c:449
static const int precedence[T_TOKEN_LAST]
Definition xlat_expr.c:1990
static xlat_action_t xlat_func_unary_minus(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:1485
static xlat_action_t xlat_logical_or_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:1205
unlang_result_t last_result
Definition xlat_expr.c:871
static fr_table_num_sorted_t const expr_quote_table[]
Definition xlat_expr.c:2062
#define XLAT_REGISTER_BINARY_OP(_op, _name)
Definition xlat_expr.c:1801
#define XLAT_REGEX_FUNC(_name, _op)
Definition xlat_expr.c:824
static xlat_action_t xlat_binary_op(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in, fr_token_t op, fr_type_t default_type, fr_dict_attr_t const *enumv)
Definition xlat_expr.c:303
static bool valid_type(xlat_exp_t *node)
Definition xlat_expr.c:2737
static bool xlat_logical_and(xlat_logical_rctx_t *rctx, fr_value_box_list_t const *in)
See if the input is truthy or not.
Definition xlat_expr.c:1262
fr_value_box_t * box
output value-box
Definition xlat_expr.c:872
#define XLAT_DEBUG(...)
Definition xlat_expr.c:38
fr_value_box_list_t list
Definition xlat_expr.c:520
static xlat_action_t xlat_regex_op(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in, fr_token_t op)
Definition xlat_expr.c:791
static xlat_action_t xlat_func_unary_not(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:1458
fr_regex_flags_t * regex_flags
Definition xlat_expr.c:515
static bool xlat_node_matches_bool(bool *result, xlat_exp_t *parent, xlat_exp_head_t *head, bool sense)
Definition xlat_expr.c:925
static int xlat_instantiate_regex(xlat_inst_ctx_t const *xctx)
Definition xlat_expr.c:587
static xlat_action_t xlat_func_unary_op(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in, fr_token_t op)
Definition xlat_expr.c:1414
static int xlat_expr_resolve_binary(xlat_exp_t *node, UNUSED void *inst, xlat_res_rules_t const *xr_rules)
Definition xlat_expr.c:174
static const bool logical_ops[T_TOKEN_LAST]
Definition xlat_expr.c:1964
xlat_func_t callback
Definition xlat_expr.c:864
static xlat_arg_parser_t const binary_op_xlat_args[]
Definition xlat_expr.c:297
static xlat_action_t xlat_attr_exists(TALLOC_CTX *ctx, fr_dcursor_t *out, request_t *request, tmpl_t const *vpt, bool do_free)
Definition xlat_expr.c:1758
static xlat_arg_parser_t const binary_cmp_xlat_args[]
Definition xlat_expr.c:394
static const bool multivalue_ops[T_TOKEN_LAST]
Definition xlat_expr.c:1977
static fr_slen_t tokenize_unary(xlat_exp_head_t *head, xlat_exp_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond))
Definition xlat_expr.c:2084
static const fr_sbuff_term_elem_t binary_ops[T_TOKEN_LAST]
Definition xlat_expr.c:1932
static bool xlat_logical_or(xlat_logical_rctx_t *rctx, fr_value_box_list_t const *in)
See if the input is truthy or not.
Definition xlat_expr.c:1163
fr_token_t op
Definition xlat_expr.c:512
TALLOC_CTX * ctx
Definition xlat_expr.c:870
regex_t * regex
precompiled regex
Definition xlat_expr.c:513
#define XLAT_REGISTER_NARY_OP(_op, _name, _func_name)
Definition xlat_expr.c:1822
static int xlat_instantiate_expr_rcode(xlat_inst_ctx_t const *xctx)
Convert static expr_rcode arguments into rcodes.
Definition xlat_expr.c:1515
static void fr_value_box_init_zero(fr_value_box_t *vb, fr_type_t type)
Definition xlat_expr.c:280
static xlat_action_t xlat_regex_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:751
static fr_table_num_ordered_t const expr_assignment_op_table[]
Definition xlat_expr.c:2703
static xlat_exp_t * xlat_exists_alloc(TALLOC_CTX *ctx, xlat_exp_t *child)
Allocate a specific cast node.
Definition xlat_expr.c:112
static xlat_exp_t * expr_cast_alloc(TALLOC_CTX *ctx, fr_type_t type, xlat_exp_t *child)
Allocate a specific cast node.
Definition xlat_expr.c:2187
static xlat_arg_parser_t const regex_search_xlat_args[]
Definition xlat_expr.c:637
static fr_slen_t expr_cast_from_substr(fr_type_t *cast, fr_sbuff_t *in)
Definition xlat_expr.c:2224
static ssize_t tokenize_rcode(xlat_exp_head_t *head, xlat_exp_t **out, fr_sbuff_t *in, fr_sbuff_term_t const *terminals)
Definition xlat_expr.c:2375
#define XLAT_REGISTER_BINARY_CMP(_op, _name)
Definition xlat_expr.c:1811
static xlat_arg_parser_t const xlat_func_rcode_arg[]
Takes no arguments.
Definition xlat_expr.c:1665
static int xlat_expr_logical_purify(xlat_exp_t *node, void *instance, request_t *request)
If any argument resolves to inst->stop_on_match, the entire thing is a bool of inst->stop_on_match.
Definition xlat_expr.c:999
fr_value_box_list_t list
Definition xlat_expr.c:874
rlm_rcode_t rcode
The preparsed rcode.
Definition xlat_expr.c:1507
xlat_exp_head_t ** argv
Definition xlat_expr.c:866
static fr_slen_t xlat_expr_print_exists(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:1710
static int xlat_instantiate_logical(xlat_inst_ctx_t const *xctx)
Definition xlat_expr.c:1364
#define XLAT_REGISTER_UNARY(_op, _xlat, _func)
Definition xlat_expr.c:1850
static xlat_arg_parser_t const unary_op_xlat_args[]
Definition xlat_expr.c:1409
fr_slen_t xlat_tokenize_expression(TALLOC_CTX *ctx, xlat_exp_head_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
Definition xlat_expr.c:3163
static xlat_arg_parser_t const xlat_func_expr_rcode_arg[]
Definition xlat_expr.c:1499
static fr_slen_t tokenize_regex_rhs(xlat_exp_head_t *head, xlat_exp_t **out, fr_sbuff_t *in, tmpl_rules_t const *t_rules, fr_sbuff_parse_rules_t const *bracket_rules)
Definition xlat_expr.c:2281
static fr_slen_t xlat_expr_print_regex(fr_sbuff_t *out, xlat_exp_t const *node, void *instance, fr_sbuff_escape_rules_t const *e_rules)
Definition xlat_expr.c:523
static const fr_sbuff_term_t operator_terms
Definition xlat_expr.c:3067
#define XLAT_REGISTER_REGEX_OP(_op, _name)
Definition xlat_expr.c:1833
static xlat_action_t xlat_logical_and_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Definition xlat_expr.c:1309
static ssize_t tokenize_expression(xlat_exp_head_t *head, xlat_exp_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, fr_token_t prev, fr_sbuff_parse_rules_t const *bracket_rules, fr_sbuff_parse_rules_t const *input_rules, bool cond))
Tokenize a mathematical operation.
Definition xlat_expr.c:2776
#define XLAT_CMP_FUNC(_name, _op)
Definition xlat_expr.c:494
static ssize_t tokenize_field(xlat_exp_head_t *head, xlat_exp_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, fr_sbuff_parse_rules_t const *bracket_rules, char *out_c, bool cond))
Definition xlat_expr.c:2432
unlang_result_t last_result
Definition xlat_expr.c:519
fr_slen_t xlat_tokenize_condition(TALLOC_CTX *ctx, xlat_exp_head_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
Definition xlat_expr.c:3191
static xlat_action_t xlat_regex_do_op(TALLOC_CTX *ctx, request_t *request, fr_value_box_list_t *in, regex_t **preg, fr_dcursor_t *out, fr_token_t op)
Perform a regular expressions comparison between two operands.
Definition xlat_expr.c:665
Holds the result of pre-parsing the rcode on startup.
Definition xlat_expr.c:1506
void xlat_func_flags_set(xlat_t *x, xlat_func_flags_t flags)
Specify flags that alter the xlat's behaviour.
Definition xlat_func.c:399
int xlat_func_args_set(xlat_t *x, xlat_arg_parser_t const args[])
Register the arguments of an xlat.
Definition xlat_func.c:363
xlat_t * xlat_func_register(TALLOC_CTX *ctx, char const *name, xlat_func_t func, fr_type_t return_type)
Register an xlat function.
Definition xlat_func.c:216
void xlat_func_print_set(xlat_t *xlat, xlat_print_t func)
Set a print routine for an xlat function.
Definition xlat_func.c:411
xlat_t * xlat_func_find(char const *in, ssize_t inlen)
Definition xlat_func.c:77
#define xlat_func_instantiate_set(_xlat, _instantiate, _inst_struct, _detach, _uctx)
Set a callback for global instantiation of xlat functions.
Definition xlat_func.h:93
@ XLAT_FUNC_FLAG_PURE
Definition xlat_func.h:38
@ XLAT_FUNC_FLAG_INTERNAL
Definition xlat_func.h:39
#define xlat_exp_head_alloc(_ctx)
Definition xlat_priv.h:274
xlat_flags_t flags
Flags that control resolution and evaluation.
Definition xlat_priv.h:154
static xlat_exp_t * xlat_exp_next(xlat_exp_head_t const *head, xlat_exp_t const *node)
Definition xlat_priv.h:247
xlat_flags_t flags
Flags that control resolution and evaluation.
Definition xlat_priv.h:190
fr_slen_t xlat_tokenize_word(TALLOC_CTX *ctx, xlat_exp_t **out, fr_sbuff_t *in, fr_token_t quote, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
fr_token_t quote
Type of quoting around XLAT_GROUP types.
Definition xlat_priv.h:152
@ XLAT_BOX
fr_value_box_t
Definition xlat_priv.h:108
@ XLAT_TMPL
xlat attribute
Definition xlat_priv.h:112
@ XLAT_FUNC
xlat module
Definition xlat_priv.h:110
@ XLAT_GROUP
encapsulated string of xlats
Definition xlat_priv.h:116
bool deprecated
this function was deprecated
Definition xlat_priv.h:68
static void xlat_flags_merge(xlat_flags_t *parent, xlat_flags_t const *child)
Merge flags from child to parent.
Definition xlat_priv.h:230
#define xlat_exp_set_type(_node, _type)
Definition xlat_priv.h:277
fr_token_t token
for expressions
Definition xlat_priv.h:70
char const *_CONST fmt
The original format string (a talloced buffer).
Definition xlat_priv.h:151
ssize_t xlat_print_node(fr_sbuff_t *out, xlat_exp_head_t const *head, xlat_exp_t const *node, fr_sbuff_escape_rules_t const *e_rules, char c)
int xlat_purify_list(xlat_exp_head_t *head, request_t *request)
Definition xlat_purify.c:65
xlat_type_t _CONST type
type of this expansion.
Definition xlat_priv.h:155
#define xlat_exp_alloc(_ctx, _type, _in, _inlen)
Definition xlat_priv.h:283
xlat_flags_t flags
various flags
Definition xlat_priv.h:92
#define xlat_exp_foreach(_list_head, _iter)
Iterate over the contents of a list, only one level.
Definition xlat_priv.h:223
static int xlat_exp_insert_tail(xlat_exp_head_t *head, xlat_exp_t *node)
Definition xlat_priv.h:239
static xlat_exp_t * xlat_exp_head(xlat_exp_head_t const *head)
Definition xlat_priv.h:210
An xlat expansion node.
Definition xlat_priv.h:148