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