The FreeRADIUS server $Id: f3670dba8951ca10eb4948feb3dc3db9423a334f $
Loading...
Searching...
No Matches
tmpl_tokenize.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: 5adb94d53609a5c64a60680c4b900dc7c3af4246 $
19 *
20 * @brief #fr_pair_t template functions
21 * @file src/lib/server/tmpl_tokenize.c
22 *
23 * @ingroup AVP
24 *
25 * @copyright 2014-2020 The FreeRADIUS server project
26 */
27RCSID("$Id: 5adb94d53609a5c64a60680c4b900dc7c3af4246 $")
28
29#define _TMPL_PRIVATE 1
30
31#include <freeradius-devel/server/tmpl.h>
32#include <freeradius-devel/server/base.h>
33#include <freeradius-devel/protocol/freeradius/freeradius.internal.h>
34
35#include <freeradius-devel/util/base16.h>
36#include <freeradius-devel/util/skip.h>
37
38/*
39 * For xlat_exp_head_alloc(), because xlat_copy() doesn't create an output head.
40 */
41#include <freeradius-devel/unlang/xlat_priv.h>
42
43/** Define a global variable for specifying a default request reference
44 *
45 * @param[in] _name what the global variable should be called.
46 * @param[in] _ref one of the values of tmpl_request_ref_t
47 * - REQUEST_CURRENT
48 * - REQUEST_OUTER,
49 * - REQUEST_PARENT,
50 * - REQUEST_UNKNOWN
51 */
52#define TMPL_REQUEST_REF_DEF(_name, _ref) \
53static tmpl_request_t _name ## _entry = { \
54 .entry = { \
55 .entry = { \
56 .next = &_name.head.entry, \
57 .prev = &_name.head.entry \
58 } \
59 }, \
60 .request = _ref \
61}; \
62FR_DLIST_HEAD(tmpl_request_list) _name = { \
63 .head = { \
64 .offset = offsetof(tmpl_request_t, entry), \
65 .entry = { \
66 .next = &_name ## _entry.entry.entry, \
67 .prev = &_name ## _entry.entry.entry, \
68 }, \
69 .num_elements = 1, \
70 } \
71}
72
73/** Use the current request as the default
74 *
75 * Used as .attr.request_def = \&tmpl_request_def_current;
76 */
77TMPL_REQUEST_REF_DEF(tmpl_request_def_current, REQUEST_CURRENT);
78
79/** Use the outer request as the default
80 *
81 * Used as .attr.request_def = \&tmpl_request_def_outer;
82 */
83TMPL_REQUEST_REF_DEF(tmpl_request_def_outer, REQUEST_OUTER);
84
85/** Use the parent request as the default
86 *
87 * Used as .attr.request_def = \&tmpl_request_def_parent;
88 */
89TMPL_REQUEST_REF_DEF(tmpl_request_def_parent, REQUEST_PARENT);
90
91/** Default parser rules
92 *
93 * Because this is getting to be a ridiculous number of parsing rules
94 * to pass in via arguments.
95 *
96 * Defaults are used if a NULL rules pointer is passed to the parsing function.
97 */
98#define DEFAULT_RULES tmpl_rules_t default_rules = { .attr = { .list_def = request_attr_request }}
99
100#define CHECK_T_RULES do { \
101 if (!t_rules) { \
102 t_rules = &default_rules; \
103 } \
104 } while (0)
105
106
107/* clang-format off */
108/** Map #tmpl_type_t values to descriptive strings
109 */
110fr_table_num_ordered_t const tmpl_type_table[] = {
111 { L("uninitialised"), TMPL_TYPE_UNINITIALISED },
112
113 { L("data"), TMPL_TYPE_DATA },
114
115 { L("attr"), TMPL_TYPE_ATTR },
116
117 { L("exec"), TMPL_TYPE_EXEC },
118 { L("xlat"), TMPL_TYPE_XLAT },
119
120 { L("regex"), TMPL_TYPE_REGEX },
121 { L("regex-uncompiled"), TMPL_TYPE_REGEX_UNCOMPILED },
122 { L("regex-xlat"), TMPL_TYPE_REGEX_XLAT },
123
124 { L("data-unresolved"), TMPL_TYPE_DATA_UNRESOLVED },
125 { L("attr-unresolved"), TMPL_TYPE_ATTR_UNRESOLVED },
126 { L("exec-unresolved"), TMPL_TYPE_EXEC_UNRESOLVED },
127 { L("xlat-unresolved"), TMPL_TYPE_XLAT_UNRESOLVED },
128 { L("regex-unresolved"), TMPL_TYPE_REGEX_XLAT_UNRESOLVED }
129};
130size_t tmpl_type_table_len = NUM_ELEMENTS(tmpl_type_table);
131
132/** Attr ref types
133 */
134static fr_table_num_ordered_t const attr_table[] = {
135 { L("normal"), TMPL_ATTR_TYPE_NORMAL },
136 { L("unspecified"), TMPL_ATTR_TYPE_UNSPEC },
137 { L("unknown"), TMPL_ATTR_TYPE_UNKNOWN },
138 { L("unresolved"), TMPL_ATTR_TYPE_UNRESOLVED }
139};
140static size_t attr_table_len = NUM_ELEMENTS(attr_table);
141
142/** We can print "current", but we shouldn't parse the "current" in a configuration.
143 */
144static fr_table_num_sorted_t const tmpl_request_ref_print_table[] = {
145 { L("current"), REQUEST_CURRENT },
146 { L("outer"), REQUEST_OUTER },
147 { L("parent"), REQUEST_PARENT },
148};
149static size_t tmpl_request_ref_print_table_len = NUM_ELEMENTS(tmpl_request_ref_print_table);
150
151/** Map keywords to #tmpl_request_ref_t values
152 */
153fr_table_num_sorted_t const tmpl_request_ref_table[] = {
154 { L("outer"), REQUEST_OUTER },
155 { L("parent"), REQUEST_PARENT },
156};
157size_t tmpl_request_ref_table_len = NUM_ELEMENTS(tmpl_request_ref_table);
158
159
160/** Special attribute reference indexes
161 */
162static fr_table_num_sorted_t const attr_num_table[] = {
163 { L("*"), NUM_ALL },
164 { L("#"), NUM_COUNT },
165 { L("u"), NUM_UNSPEC },
166 { L("n"), NUM_LAST }
167};
168static size_t attr_num_table_len = NUM_ELEMENTS(attr_num_table);
169/* clang-format on */
170
171/*
172 * Can't use |= or ^= else we get out of range errors
173 */
174#define UNRESOLVED_SET(_flags) (*(_flags) = (*(_flags) | TMPL_FLAG_UNRESOLVED))
175#define RESOLVED_SET(_flags) (*(_flags) = (*(_flags) & ~TMPL_FLAG_UNRESOLVED))
176
177/** Verify, after skipping whitespace, that a substring ends in a terminal char, or ends without further chars
178 *
179 * @param[in] in the sbuff to check.
180 * @param[in] p_rules to use terminals from.
181 * @return
182 * - true if substr is terminated correctly.
183 * - false if subst is not terminated correctly.
184 */
185static inline bool CC_HINT(always_inline) tmpl_substr_terminal_check(fr_sbuff_t *in,
186 fr_sbuff_parse_rules_t const *p_rules)
187{
188 fr_sbuff_marker_t m;
189 bool ret;
190
191 if (!fr_sbuff_extend(in)) return true; /* we're at the end of the string */
192 if (!p_rules || !p_rules->terminals) return false; /* more stuff to parse but don't have a terminal set */
193
194 fr_sbuff_marker(&m, in);
195 ret = fr_sbuff_is_terminal(in, p_rules->terminals);
196 fr_sbuff_set(in, &m);
197 fr_sbuff_marker_release(&m);
198 return ret;
199}
200
201void tmpl_attr_ref_debug(FILE *fp, const tmpl_attr_t *ar, int i)
202{
203 char buffer[sizeof(STRINGIFY(INT16_MAX)) + 1];
204
205 snprintf(buffer, sizeof(buffer), "%i", ar->ar_num);
206
207 switch (ar->type) {
208 case TMPL_ATTR_TYPE_NORMAL:
209 case TMPL_ATTR_TYPE_UNSPEC:
210 case TMPL_ATTR_TYPE_UNKNOWN:
211 if (!ar->da) {
212 fprintf(fp, "\t[%u] %s null%s%s%s\n",
213 i,
214 fr_table_str_by_value(attr_table, ar->type, "<INVALID>"),
215 ar->ar_num != NUM_UNSPEC ? "[" : "",
216 ar->ar_num != NUM_UNSPEC ? fr_table_str_by_value(attr_num_table, ar->ar_num, buffer) : "",
217 ar->ar_num != NUM_UNSPEC ? "]" : "");
218 return;
219 }
220
221 fprintf(fp, "\t[%u] %s %s %s%s%s%s (%p) attr %u\n ",
222 i,
223 fr_table_str_by_value(attr_table, ar->type, "<INVALID>"),
224 fr_type_to_str(ar->da->type),
225 ar->da->name,
226 ar->ar_num != NUM_UNSPEC ? "[" : "",
227 ar->ar_num != NUM_UNSPEC ? fr_table_str_by_value(attr_num_table, ar->ar_num, buffer) : "",
228 ar->ar_num != NUM_UNSPEC ? "]" : "",
229 ar->da,
230 ar->da->attr
231 );
232 fprintf(fp, "\t is_raw : %s\n", ar_is_raw(ar) ? "yes" : "no");
233 fprintf(fp, "\t is_unknown : %s\n", ar_is_unknown(ar) ? "yes" : "no");
234 if (ar->ar_parent) fprintf(fp, "\t parent : %s (%p)\n", ar->ar_parent->name, ar->ar_parent);
235 break;
236
237
238 case TMPL_ATTR_TYPE_UNRESOLVED:
239 /*
240 * Type reveals unresolved status
241 * so we don't need to add it explicitly
242 */
243 fprintf(fp, "\t[%u] %s %s%s%s%s\n",
244 i,
245 fr_table_str_by_value(attr_table, ar->type, "<INVALID>"),
246 ar->ar_unresolved,
247 ar->ar_num != NUM_UNSPEC ? "[" : "",
248 ar->ar_num != NUM_UNSPEC ? fr_table_str_by_value(attr_num_table, ar->ar_num, buffer) : "",
249 ar->ar_num != NUM_UNSPEC ? "]" : "");
250 if (ar->ar_parent) fprintf(fp, "\t parent : %s\n", ar->ar_parent->name);
251 if (ar->ar_unresolved_namespace) fprintf(fp, "\t namespace : %s\n", ar->ar_unresolved_namespace->name);
252 break;
253
254 default:
255 fprintf(fp, "\t[%u] Bad type %s(%u)\n",
256 i, fr_table_str_by_value(attr_table, ar->type, "<INVALID>"), ar->type);
257 break;
258 }
259}
260
261void tmpl_attr_ref_list_debug(FILE *fp, FR_DLIST_HEAD(tmpl_attr_list) const *ar_head)
262{
263 tmpl_attr_t *ar = NULL;
264 unsigned int i = 0;
265
266 fprintf(fp, "attribute references:\n");
267 /*
268 * Print all the attribute references
269 */
270 while ((ar = tmpl_attr_list_next(ar_head, ar))) {
271 tmpl_attr_ref_debug(fp, ar, i);
272 i++;
273 }
274}
275
276void tmpl_attr_debug(FILE *fp, tmpl_t const *vpt)
277{
278 tmpl_request_t *rr = NULL;
279 unsigned int i = 0;
280
281 switch (vpt->type) {
282 case TMPL_TYPE_ATTR:
283 case TMPL_TYPE_ATTR_UNRESOLVED:
284 break;
285
286 default:
287 fprintf(fp, "%s can't print tmpls of type %s\n", __FUNCTION__,
288 tmpl_type_to_str(vpt->type));
289 return;
290 }
291
292 fprintf(fp, "tmpl_t %s (%.8x) %pV (%p)\n",
293 tmpl_type_to_str(vpt->type),
294 vpt->type,
295 fr_box_strvalue_len(vpt->name, vpt->len), vpt);
296
297 fprintf(fp, "\tcast : %s\n", fr_type_to_str(tmpl_rules_cast(vpt)));
298 fprintf(fp, "\tquote : %s\n", fr_table_str_by_value(fr_token_quotes_table, vpt->quote, "<INVALID>"));
299
300 fprintf(fp, "request references:");
301
302 /*
303 * Print all the request references
304 */
305 while ((rr = tmpl_request_list_next(&vpt->data.attribute.rr, rr))) {
306 fprintf(fp, "\t[%u] %s (%u)\n", i,
307 fr_table_str_by_value(tmpl_request_ref_print_table, rr->request, "<INVALID>"), rr->request);
308 i++;
309 }
310
311 fprintf(fp, "list: %s\n", tmpl_list_name(tmpl_list(vpt), "<INVALID>"));
312 tmpl_attr_ref_list_debug(fp, tmpl_attr(vpt));
313}
314
315void tmpl_debug(FILE *fp, tmpl_t const *vpt)
316{
317 switch (vpt->type) {
318 case TMPL_TYPE_ATTR:
319 case TMPL_TYPE_ATTR_UNRESOLVED:
320 tmpl_attr_debug(fp, vpt);
321 return;
322
323 default:
324 break;
325 }
326
327 fprintf(fp, "tmpl_t %s (%.8x) %s (%p)\n",
328 tmpl_type_to_str(vpt->type),
329 vpt->type,
330 vpt->name, vpt);
331
332 fprintf(fp, "\tcast : %s\n", fr_type_to_str(tmpl_rules_cast(vpt)));
333 fprintf(fp, "\tquote : %s\n", fr_table_str_by_value(fr_token_quotes_table, vpt->quote, "<INVALID>"));
334 switch (vpt->type) {
335 case TMPL_TYPE_DATA:
336 fprintf(fp, "\ttype : %s\n", fr_type_to_str(tmpl_value_type(vpt)));
337 fprintf(fp, "\tlen : %zu\n", tmpl_value_length(vpt));
338 fprintf(fp, "\tvalue : %pV\n", tmpl_value(vpt));
339
340 if (tmpl_value_enumv(vpt)) fprintf(fp, "\tenumv : %s (%p)",
341 tmpl_value_enumv(vpt)->name, tmpl_value_enumv(vpt));
342 return;
343
344 case TMPL_TYPE_XLAT:
345 case TMPL_TYPE_EXEC:
346 case TMPL_TYPE_REGEX_XLAT:
347 {
348 char *str;
349
350 xlat_aprint(NULL, &str, tmpl_xlat(vpt), NULL);
351
352 fprintf(fp, "\texpansion : %s\n", str);
353
354 talloc_free(str);
355 }
356 break;
357
358 case TMPL_TYPE_REGEX:
359 {
360 fprintf(fp, "\tpattern : %s\n", vpt->name);
361 }
362 break;
363
364 default:
365 if (tmpl_needs_resolving(vpt)) {
366 if (tmpl_is_data_unresolved(vpt)) {
367 fprintf(fp, "\tunescaped : %s\n", vpt->data.unescaped);
368 fprintf(fp, "\tlen : %zu\n", talloc_strlen(vpt->data.unescaped));
369 } else {
370 fprintf(fp, "\tunresolved : %s\n", vpt->name);
371 fprintf(fp, "\tlen : %zu\n", vpt->len);
372 }
373 } else {
374 fprintf(fp, "debug nyi\n");
375 }
376 break;
377 }
378}
379
380/** @name Parse list and request qualifiers to #fr_pair_list_t and #tmpl_request_ref_t values
381 *
382 * These functions also resolve #fr_pair_list_t and #tmpl_request_ref_t values to #request_t
383 * structs and the head of #fr_pair_t lists in those structs.
384 *
385 * For adding new #fr_pair_t to the lists, the #tmpl_list_ctx function can be used
386 * to obtain the appropriate TALLOC_CTX pointer.
387 *
388 * @note These don't really have much to do with #tmpl_t. They're in the same
389 * file as they're used almost exclusively by the tmpl_* functions.
390 * @{
391 */
392
393/** Parse one a single list reference
394 *
395 * @param[out] da_p attribute representing a list.
396 * @param[in] in Sbuff to read request references from.
397 * @return
398 * - > 0 the number of bytes parsed.
399 * - 0 no list qualifier found.
400 */
401fr_slen_t tmpl_attr_list_from_substr(fr_dict_attr_t const **da_p, fr_sbuff_t *in)
402{
403 fr_dict_attr_t const *da;
404 fr_sbuff_t our_in = FR_SBUFF(in);
405
406 if (((fr_sbuff_adv_past_strcase(&our_in, request_attr_request->name, request_attr_request->name_len)) &&
407 (da = request_attr_request)) ||
408 ((fr_sbuff_adv_past_strcase(&our_in, request_attr_reply->name, request_attr_reply->name_len)) &&
409 (da = request_attr_reply)) ||
410 ((fr_sbuff_adv_past_strcase(&our_in, request_attr_control->name, request_attr_control->name_len)) &&
411 (da = request_attr_control)) ||
412 ((fr_sbuff_adv_past_strcase(&our_in, request_attr_state->name, request_attr_state->name_len)) &&
413 (da = request_attr_state))) {
414 /* note: no local variables */
415 *da_p = da;
416 FR_SBUFF_SET_RETURN(in, &our_in);
417 }
418
419 return 0;
420}
421
422 /** Allocate a new request reference and add it to the end of the attribute reference list
423 *
424 */
425static inline CC_HINT(always_inline) CC_HINT(nonnull(2,3))
426void tmpl_request_ref_list_copy(TALLOC_CTX *ctx,
427 FR_DLIST_HEAD(tmpl_request_list) *out, FR_DLIST_HEAD(tmpl_request_list) const *in)
428{
429 tmpl_request_t *rr = NULL;
430 tmpl_request_t *n_rr = NULL;
431
432 /*
433 * Duplicate the complete default list
434 */
435 while ((rr = tmpl_request_list_next(in, rr))) {
436 MEM(n_rr = talloc(ctx, tmpl_request_t));
437 *n_rr = (tmpl_request_t){
438 .request = rr->request
439 };
440 tmpl_request_list_insert_tail(out, n_rr);
441 ctx = n_rr; /* Chain the contexts */
442 }
443}
444
445 /** Allocate a new request reference list and copy request references into it
446 *
447 */
448static inline CC_HINT(always_inline) CC_HINT(nonnull(2,3))
449void tmpl_request_ref_list_acopy(TALLOC_CTX *ctx,
450 FR_DLIST_HEAD(tmpl_request_list) **out, FR_DLIST_HEAD(tmpl_request_list) const *in)
451{
452 FR_DLIST_HEAD(tmpl_request_list) *rql;
453
454 MEM(rql = talloc_zero(ctx, FR_DLIST_HEAD(tmpl_request_list)));
455 tmpl_request_list_talloc_init(rql);
456
457 tmpl_request_ref_list_copy(rql, rql, in);
458
459 *out = rql;
460}
461
462/** Dump a request list to stderr
463 *
464 */
465void tmpl_request_ref_list_debug(FR_DLIST_HEAD(tmpl_request_list) const *rql)
466{
467 tmpl_request_t *rr = NULL;
468
469 while ((rr = tmpl_request_list_next(rql, rr))) {
470 FR_FAULT_LOG("request - %s (%u)",
471 fr_table_str_by_value(tmpl_request_ref_print_table, rr->request, "<INVALID>"),
472 rr->request);
473 }
474}
475
476/** Compare a list of request qualifiers
477 *
478 * @param[in] a first list. If NULL tmpl_request_def_current will be used.
479 * @param[in] b second list. If NULL tmpl_request_def_current will be used.
480 * @return
481 * - >0 a > b
482 * - 0 a == b
483 * - <0 a < b
484 */
485int8_t tmpl_request_ref_list_cmp(FR_DLIST_HEAD(tmpl_request_list) const *a, FR_DLIST_HEAD(tmpl_request_list) const *b)
486{
487 tmpl_request_t *a_rr = NULL, *b_rr = NULL;
488
489 /*
490 * NULL, uninit, empty are all equivalent
491 * to tmpl_request_def_current.
492 *
493 * We need all these equivalent checks to
494 * deal with uninitialised tmpl rules.
495 */
496 if (!a || !tmpl_request_list_initialised(a) || tmpl_request_list_empty(a)) a = &tmpl_request_def_current;
497 if (!b || !tmpl_request_list_initialised(b) || tmpl_request_list_empty(b)) b = &tmpl_request_def_current;
498
499 /*
500 * Fast path...
501 */
502 if (a == b) return 0;
503
504 for (;;) {
505 a_rr = tmpl_request_list_next(a, a_rr);
506 b_rr = tmpl_request_list_next(b, b_rr);
507
508 if (!a_rr || !b_rr) return CMP(tmpl_request_list_num_elements(a), tmpl_request_list_num_elements(b));
509
510 CMP_RETURN(a_rr, b_rr, request);
511 }
512}
513
514static fr_dict_attr_t const *tmpl_namespace(tmpl_rules_t const *t_rules)
515{
516 if (!t_rules) {
517 return NULL;
518 }
519
520 if (t_rules->attr.namespace) {
521 if (request_attr_is_list(t_rules->attr.namespace)) {
522 return NULL;
523 }
524
525 if (t_rules->attr.namespace->type != FR_TYPE_GROUP) {
526 return t_rules->attr.namespace;
527 }
528
529 if (t_rules->attr.namespace->flags.local) {
530 return t_rules->attr.namespace;
531 }
532
533 if (t_rules->attr.namespace->flags.internal && t_rules->attr.dict_def) {
534 return fr_dict_root(t_rules->attr.dict_def);
535 }
536
537 return fr_dict_attr_ref(t_rules->attr.namespace);
538 }
539
540 if (t_rules->attr.dict_def) {
541 return fr_dict_root(t_rules->attr.dict_def);
542 }
543
544 return NULL;
545}
546
547/** Parse one or more request references, writing the list to out
548 *
549 * @param[in] ctx to allocate request refs in.
550 * @param[out] err If !NULL where to write the parsing error.
551 * @param[in] out The list to write to.
552 * @param[in] in Sbuff to read request references from.
553 * @param[in] t_rules Default list and other rules.
554 * @param[out] namespace the namespace to use
555 * @return
556 * - >= 0 the number of bytes parsed.
557 * - <0 negative offset for where the error occurred
558 */
559static fr_slen_t CC_HINT(nonnull(1,3,4,6)) tmpl_request_ref_list_from_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
560 FR_DLIST_HEAD(tmpl_request_list) *out,
561 fr_sbuff_t *in,
562 tmpl_rules_t const *t_rules,
563 fr_dict_attr_t const **namespace)
564{
565 tmpl_request_ref_t ref;
566 tmpl_request_t *rr;
567 fr_sbuff_t our_in = FR_SBUFF(in);
568 tmpl_request_t *tail = tmpl_request_list_tail(out);
569 fr_sbuff_marker_t m;
570
571 /*
572 * The caller needs to know the default namespace for resolving the attribute.
573 *
574 * But the first round can't have "namespace" set to the root, otherwise things complain.
575 */
576 *namespace = tmpl_namespace(t_rules);
577 if (*namespace && (*namespace)->flags.is_root) *namespace = NULL;
578
579 /*
580 * We could make the caller do this but as this
581 * function is intended to help populate tmpl rules,
582 * just be nice...
583 */
584 if (!tmpl_request_list_initialised(out)) tmpl_request_list_talloc_init(out);
585
586 /*
587 * We're in a name space, OR lists are forbidden, don't allow list qualifiers.
588 */
589 if (*namespace || (t_rules && (t_rules->attr.list_presence == TMPL_ATTR_LIST_FORBID))) {
590 if (fr_sbuff_is_str_literal(&our_in, "outer.") ||
591 fr_sbuff_is_str_literal(&our_in, "parent.")) {
592 fr_strerror_const("request list qualifiers are not allowed here");
593 if (err) *err = TMPL_ATTR_ERROR_LIST_NOT_ALLOWED;
594
595 fr_sbuff_set(&our_in, in); /* Marker at the start */
596 error:
597 tmpl_request_list_talloc_free_to_tail(out, tail);
598 FR_SBUFF_ERROR_RETURN(&our_in);
599 }
600
601 return 0;
602 }
603
604 /*
605 * See if there is a known reference.
606 */
607 fr_sbuff_marker(&m, &our_in);
608 if (fr_sbuff_adv_past_str_literal(&our_in, "outer.")) {
609 ref = REQUEST_OUTER;
610
611 } else if (fr_sbuff_adv_past_str_literal(&our_in, "parent.")) {
612 ref = REQUEST_PARENT;
613
614 } else {
615 /*
616 * No recognized string. Set the default list if it was specified.
617 */
618 if (t_rules && t_rules->attr.request_def) tmpl_request_ref_list_copy(ctx, out, t_rules->attr.request_def);
619
620 return 0;
621 }
622
623 /*
624 * Add a new entry to the dlist
625 */
626 MEM(rr = talloc(ctx, tmpl_request_t));
627 *rr = (tmpl_request_t){
628 .request = ref
629 };
630 tmpl_request_list_insert_tail(out, rr);
631
632 if (ref == REQUEST_OUTER) {
633 /*
634 * No parent? Guess.
635 *
636 * If there is a parent, we use the outermost one.
637 */
638 if (!t_rules || !t_rules->parent) {
639 t_rules = NULL;
640
641 } else while (t_rules->parent) {
642 t_rules = t_rules->parent;
643 }
644
645 } else {
646 int depth = 1;
647
648 if (t_rules) t_rules = t_rules->parent;
649
650 while (fr_sbuff_adv_past_str_literal(&our_in, "parent.")) {
651 if (t_rules) t_rules = t_rules->parent;
652 depth++;
653
654 /*
655 * Nesting level too deep
656 */
657 if (depth > TMPL_MAX_REQUEST_REF_NESTING) {
658 fr_strerror_const("Request ref nesting too deep");
659 if (err) *err = TMPL_ATTR_ERROR_NESTING_TOO_DEEP;
660 goto error; /* Leave marker at the end */
661 }
662
663 MEM(rr = talloc(ctx, tmpl_request_t));
664 *rr = (tmpl_request_t){
665 .request = ref
666 };
667 tmpl_request_list_insert_tail(out, rr);
668 }
669 }
670
671 /*
672 * If we mix and match the references, that's wrong.
673 */
674 if (fr_sbuff_is_str_literal(&our_in, "outer.") || fr_sbuff_is_str_literal(&our_in, "parent.")) {
675 if (err) *err = TMPL_ATTR_ERROR_INVALID_REQUEST_REF;
676 fr_strerror_const("Invalid list reference - cannot mix 'outer' and 'parent' references");
677 goto error;
678 }
679
680 /*
681 * Now that we have the correct set of tmpl_rules, update the namespace to match.
682 *
683 * This can have "namespace" set to a dict root, because it is not _our_ dict root. It is an
684 * outer / parent one.
685 */
686 *namespace = tmpl_namespace(t_rules);
687
688 FR_SBUFF_SET_RETURN(in, &our_in);
689}
690
691/** Parse one or more request references, allocing a new list and adding the references to it
692 *
693 * This can be used to create request ref lists for rules and for tmpls.
694 *
695 * @param[in] ctx to allocate request refs in.
696 * @param[out] err If !NULL where to write the parsing error.
697 * @param[out] out The new list.
698 * @param[in] in Sbuff to read request references from.
699 * @return
700 * - >= 0 the number of bytes parsed.
701 * - <0 negative offset for where the error occurred
702 */
703fr_slen_t tmpl_request_ref_list_afrom_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
704 FR_DLIST_HEAD(tmpl_request_list) **out,
705 fr_sbuff_t *in)
706{
707 fr_slen_t slen;
708 fr_dict_attr_t const *namespace;
709
710 FR_DLIST_HEAD(tmpl_request_list) *rql;
711
712 MEM(rql = talloc_zero(ctx, FR_DLIST_HEAD(tmpl_request_list)));
713 tmpl_request_list_talloc_init(rql);
714
715 slen = tmpl_request_ref_list_from_substr(rql, err, rql, in, NULL, &namespace);
716 if (slen < 0) {
717 talloc_free(rql);
718 return slen;
719 }
720
721 *out = rql;
722
723 return slen;
724}
725/** @} */
726
727/** @name Alloc or initialise #tmpl_t
728 *
729 * @note Should not usually be called outside of tmpl_* functions, use one of
730 * the tmpl_*from_* functions instead.
731 * @{
732 */
733
734/** Initialise fields inside a tmpl depending on its type
735 *
736 */
737static inline CC_HINT(always_inline) void tmpl_type_init(tmpl_t *vpt, tmpl_type_t type)
738{
739
740 switch (type) {
741#ifndef HAVE_REGEX
742 case TMPL_TYPE_REGEX:
743 case TMPL_TYPE_REGEX_UNCOMPILED:
744 case TMPL_TYPE_REGEX_XLAT:
745 case TMPL_TYPE_REGEX_XLAT_UNRESOLVED:
746 fr_assert(0);
747 return;
748#endif
749
750 case TMPL_TYPE_ATTR:
751 case TMPL_TYPE_ATTR_UNRESOLVED:
752 tmpl_attr_list_talloc_init(tmpl_attr(vpt));
753 tmpl_request_list_talloc_init(&vpt->data.attribute.rr);
754 break;
755
756 default:
757 break;
758 }
759 vpt->type = type;
760 }
761
762/** Set the name on a pre-initialised tmpl
763 *
764 * @param[in] vpt to set the name for.
765 * @param[in] quote Original quoting around the name.
766 * @param[in] fmt string.
767 * @param[in] ... format arguments.
768 */
769void tmpl_set_name_printf(tmpl_t *vpt, fr_token_t quote, char const *fmt, ...)
770{
771 va_list ap;
772 char const *old = NULL;
773
774 if (vpt->type != TMPL_TYPE_UNINITIALISED) old = vpt->name;
775
776 va_start(ap, fmt);
777 vpt->name = fr_vasprintf(vpt, fmt, ap);
778 vpt->quote = quote;
779 vpt->len = talloc_strlen(vpt->name);
780 va_end(ap);
781
782 talloc_const_free(old); /* Free name last so it can be used in the format string */
783}
784
785/** Set the name on a pre-initialised tmpl
786 *
787 * @param[in] vpt to set the name for.
788 * @param[in] quote Original quoting around the name.
789 * @param[in] name of the #tmpl_t.
790 * @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
791 * If < 0 strlen will be used to determine the length.
792 */
793void tmpl_set_name_shallow(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len)
794{
795 fr_assert(vpt->type != TMPL_TYPE_UNINITIALISED);
796
797 vpt->name = name;
798 vpt->len = len < 0 ? strlen(name) : (size_t)len;
799 vpt->quote = quote;
800}
801
802/** Set the name on a pre-initialised tmpl
803 *
804 * @param[in] vpt to set the name for.
805 * @param[in] quote Original quoting around the name.
806 * @param[in] name of the #tmpl_t.
807 * @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
808 * If < 0 strlen will be used to determine the length.
809 */
810void tmpl_set_name(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len)
811{
812 fr_assert(vpt->type != TMPL_TYPE_UNINITIALISED);
813
814 talloc_const_free(vpt->name);
815
816 vpt->name = talloc_bstrndup(vpt, name, len < 0 ? strlen(name) : (size_t)len);
817 vpt->len = talloc_strlen(vpt->name);
818 vpt->quote = quote;
819}
820
821/** Change the default dictionary in the tmpl's resolution rules
822 *
823 * @param[in] vpt to alter.
824 * @param[in] dict to set.
825 */
826void tmpl_set_dict_def(tmpl_t *vpt, fr_dict_t const *dict)
827{
828 vpt->rules.attr.dict_def = dict;
829}
830
831/** Set escape parameters for the tmpl output
832 *
833 * @param[in] vpt to alter.
834 * @param[in] escape to set.
835 */
836void tmpl_set_escape(tmpl_t *vpt, tmpl_escape_t const *escape)
837{
838 vpt->rules.escape = *escape;
839}
840
841/** Change the default dictionary in the tmpl's resolution rules
842 *
843 * @param[in] vpt to alter.
844 * @param[in] xlat to set.
845 */
846void tmpl_set_xlat(tmpl_t *vpt, xlat_exp_head_t *xlat)
847{
848 fr_assert((vpt->type == TMPL_TYPE_XLAT) || (vpt->type == TMPL_TYPE_EXEC));
849
850 tmpl_xlat(vpt) = xlat;
851}
852
853
854/** Initialise a tmpl using a format string to create the name
855 *
856 * @param[in] vpt to initialise.
857 * @param[in] type of tmpl to initialise.
858 * @param[in] quote Original quoting around the name.
859 * @param[in] fmt string.
860 * @param[in] ... format arguments.
861 * @return A pointer to the newly initialised tmpl.
862 */
863tmpl_t *tmpl_init_printf(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote, char const *fmt, ...)
864{
865 va_list ap;
866
867 memset(vpt, 0, sizeof(*vpt));
868 tmpl_type_init(vpt, type);
869
870 va_start(ap, fmt);
871 vpt->name = fr_vasprintf(vpt, fmt, ap);
872 vpt->len = talloc_strlen(vpt->name);
873 vpt->quote = quote;
874 va_end(ap);
875
876 return vpt;
877}
878
879/** Initialise a tmpl without copying the input name string
880 *
881 * @note Name is not talloc_strdup'd or memcpy'd so must be available, and must not change
882 * for the lifetime of the #tmpl_t.
883 *
884 * @param[out] vpt to initialise.
885 * @param[in] type to set in the #tmpl_t.
886 * @param[in] quote The type of quoting around the template name.
887 * @param[in] name of the #tmpl_t.
888 * @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
889 * If < 0 strlen will be used to determine the length.
890 * @param[in] t_rules used during parsing.
891 * @return a pointer to the initialised #tmpl_t. The same value as vpt.
892 */
893tmpl_t *tmpl_init_shallow(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote,
894 char const *name, ssize_t len, tmpl_rules_t const *t_rules)
895{
896 memset(vpt, 0, sizeof(*vpt));
897 tmpl_type_init(vpt, type);
898 tmpl_set_name_shallow(vpt, quote, name, len);
899 if (t_rules) vpt->rules = *t_rules;
900
901 return vpt;
902}
903
904/** Initialise a tmpl using a literal string to create the name
905 *
906 * @param[in] vpt to initialise.
907 * @param[in] type of tmpl to initialise.
908 * @param[in] quote Original quoting around the name.
909 * @param[in] name to set for the tmpl.
910 * @param[in] len Name length. If < 0 strlen will be used
911 * to determine the name.
912 * @param[in] t_rules used during parsing.
913 * @return A pointer to the newly initialised tmpl.
914 */
915tmpl_t *tmpl_init(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote,
916 char const *name, ssize_t len, tmpl_rules_t const *t_rules)
917{
918 memset(vpt, 0, sizeof(*vpt));
919 tmpl_type_init(vpt, type);
920 tmpl_set_name(vpt, quote, name, len);
921 if (t_rules) vpt->rules = *t_rules;
922
923 return vpt;
924}
925
926/** Create a new heap allocated #tmpl_t
927 *
928 * Must be later initialised with a tmpl_init_* function.
929 *
930 * This function is provided to allow tmpls to be pre-allocated for talloc purposes before
931 * their name is known.
932 */
933static inline CC_HINT(always_inline) tmpl_t *tmpl_alloc_null(TALLOC_CTX *ctx)
934{
935 tmpl_t *vpt;
936
937 /*
938 * Allocate enough memory to hold at least
939 * one attribute reference and one request
940 * reference.
941 */
942 MEM(vpt = talloc_pooled_object(ctx, tmpl_t, 2, sizeof(tmpl_request_t) + sizeof(tmpl_attr_t)));
943 vpt->type = TMPL_TYPE_UNINITIALISED;
944
945 return vpt;
946}
947
948/** Create a new heap allocated #tmpl_t
949 *
950 * @param[in,out] ctx to allocate in.
951 * @param[in] type to set in the #tmpl_t.
952 * @param[in] name of the #tmpl_t (will be copied to a new talloc buffer parented
953 * by the #tmpl_t).
954 * @param[in] len The length of the buffer (or a substring of the buffer) pointed to by name.
955 * If < 0 strlen will be used to determine the length.
956 * @param[in] quote The type of quoting around the template name.
957 * @return the newly allocated #tmpl_t.
958 */
959tmpl_t *tmpl_alloc(TALLOC_CTX *ctx, tmpl_type_t type, fr_token_t quote, char const *name, ssize_t len)
960{
961 tmpl_t *vpt;
962
963 vpt = tmpl_alloc_null(ctx);
964 memset(vpt, 0, sizeof(*vpt));
965
966 tmpl_type_init(vpt, type);
967 if (name) tmpl_set_name(vpt, quote, name, len);
968
969 return vpt;
970}
971/** @} */
972
973/** @name Create new #tmpl_t from a string
974 *
975 * @{
976 */
977
978/** Allocate a new attribute reference and add it to the end of the attribute reference list
979 *
980 */
981static tmpl_attr_t *tmpl_attr_add(tmpl_t *vpt, tmpl_attr_type_t type)
982{
983 tmpl_attr_t *ar;
984 TALLOC_CTX *ctx;
985
986 if (tmpl_attr_list_num_elements(tmpl_attr(vpt)) == 0) {
987 ctx = vpt;
988 } else {
989 ctx = tmpl_attr_list_tail(tmpl_attr(vpt));
990 }
991
992 MEM(ar = talloc(ctx, tmpl_attr_t));
993 *ar = (tmpl_attr_t){
994 .type = type,
995 .filter = {
996 .type = TMPL_ATTR_FILTER_TYPE_NONE,
997 .num = NUM_UNSPEC
998 }
999 };
1000 tmpl_attr_list_insert_tail(tmpl_attr(vpt), ar);
1001
1002 return ar;
1003}
1004
1005/** Create a #tmpl_t from a #fr_value_box_t
1006 *
1007 * @param[in,out] ctx to allocate #tmpl_t in.
1008 * @param[out] out Where to write pointer to new #tmpl_t.
1009 * @param[in] data to convert.
1010 * @param[in] steal If true, any buffers are moved to the new
1011 * ctx instead of being duplicated.
1012 * @return
1013 * - 0 on success.
1014 * - -1 on failure.
1015 */
1016int tmpl_afrom_value_box(TALLOC_CTX *ctx, tmpl_t **out, fr_value_box_t *data, bool steal)
1017{
1018 char *name;
1019 fr_slen_t slen;
1020 tmpl_t *vpt;
1021 fr_token_t quote = (data->type == FR_TYPE_STRING) ? T_SINGLE_QUOTED_STRING : T_BARE_WORD;
1022
1023 MEM(vpt = talloc(ctx, tmpl_t));
1024 slen = fr_value_box_aprint(vpt, &name, data, fr_value_escape_by_quote[quote]);
1025 if (slen < 0) {
1026 error:
1027 talloc_free(vpt);
1028 return -1;
1029 }
1030
1031 tmpl_init_shallow(vpt, TMPL_TYPE_DATA, quote, name, slen, NULL);
1032
1033 if (steal) {
1034 if (fr_value_box_steal(vpt, tmpl_value(vpt), data) < 0) goto error;
1035 } else {
1036 if (unlikely(fr_value_box_copy(vpt, tmpl_value(vpt), data) < 0)) goto error;
1037 }
1038 *out = vpt;
1039
1040 return 0;
1041}
1042
1043/** Copy a list of attribute and request references from one tmpl to another
1044 *
1045 */
1046int tmpl_attr_copy(tmpl_t *dst, tmpl_t const *src)
1047{
1048 tmpl_attr_t *src_ar = NULL, *dst_ar;
1049
1050 /*
1051 * Clear any existing attribute references
1052 */
1053 if (tmpl_attr_list_num_elements(tmpl_attr(dst)) > 0) tmpl_attr_list_talloc_reverse_free(tmpl_attr(dst));
1054
1055 while ((src_ar = tmpl_attr_list_next(tmpl_attr(src), src_ar))) {
1056 dst_ar = tmpl_attr_add(dst, src_ar->type);
1057
1058 switch (src_ar->type) {
1059 case TMPL_ATTR_TYPE_NORMAL:
1060 dst_ar->ar_da = src_ar->ar_da;
1061 break;
1062
1063 case TMPL_ATTR_TYPE_UNSPEC: /* Nothing to copy */
1064 break;
1065
1066 case TMPL_ATTR_TYPE_UNKNOWN:
1067 dst_ar->ar_unknown = fr_dict_attr_unknown_copy(dst_ar, src_ar->ar_unknown);
1068 break;
1069
1070 case TMPL_ATTR_TYPE_UNRESOLVED:
1071 dst_ar->ar_unresolved = talloc_bstrdup(dst_ar, src_ar->ar_unresolved);
1072 break;
1073
1074 default:
1075 if (!fr_cond_assert(0)) return -1;
1076 }
1077 dst_ar->ar_num = src_ar->ar_num;
1078 dst_ar->ar_filter_type = src_ar->ar_filter_type;
1079 dst_ar->parent = src_ar->parent;
1080 }
1081
1082 /*
1083 * Clear any existing request references
1084 * and copy the ones from the source.
1085 */
1086 tmpl_request_list_talloc_reverse_free(&dst->data.attribute.rr);
1087 tmpl_request_ref_list_copy(dst, &dst->data.attribute.rr, &src->data.attribute.rr);
1088
1089 /*
1090 * Ensure that we copy over any parsing rules, defaults, etc.
1091 */
1092 dst->rules = src->rules;
1093
1094 TMPL_ATTR_VERIFY(dst);
1095
1096 return 0;
1097}
1098
1099/** Replace the current attribute reference
1100 *
1101 */
1102int tmpl_attr_set_da(tmpl_t *vpt, fr_dict_attr_t const *da)
1103{
1104 tmpl_attr_t *ref;
1105
1106 (void)talloc_get_type_abort_const(da, fr_dict_attr_t);
1107
1108 /*
1109 * Clear any existing references
1110 */
1111 if (tmpl_attr_list_num_elements(tmpl_attr(vpt)) > 0) {
1112 tmpl_attr_list_talloc_reverse_free(tmpl_attr(vpt));
1113 }
1114
1115 /*
1116 * Unknown attributes get copied
1117 */
1118 if (da->flags.is_unknown) {
1119 ref = tmpl_attr_add(vpt, TMPL_ATTR_TYPE_UNKNOWN);
1120 ref->da = ref->ar_unknown = fr_dict_attr_unknown_copy(vpt, da);
1121 } else {
1122 ref = tmpl_attr_add(vpt, TMPL_ATTR_TYPE_NORMAL);
1123 ref->da = da;
1124 }
1125 ref->ar_parent = fr_dict_root(fr_dict_by_da(da)); /* Parent is the root of the dictionary */
1126
1127 TMPL_ATTR_VERIFY(vpt);
1128
1129 return 0;
1130}
1131
1132/** Replace the leaf attribute only
1133 *
1134 */
1135int tmpl_attr_set_leaf_da(tmpl_t *vpt, fr_dict_attr_t const *da)
1136{
1137 tmpl_attr_t *ref, *parent = NULL;
1138
1139 tmpl_assert_type(tmpl_is_attr(vpt));
1140 (void)talloc_get_type_abort_const(da, fr_dict_attr_t);
1141
1142 /*
1143 * Clear any existing references
1144 */
1145 if (tmpl_attr_list_num_elements(tmpl_attr(vpt)) > 0) {
1146 if (tmpl_attr_list_num_elements(tmpl_attr(vpt)) > 1) {
1147 ref = tmpl_attr_list_tail(tmpl_attr(vpt));
1148 parent = tmpl_attr_list_prev(tmpl_attr(vpt), ref);
1149
1150 if (!fr_dict_attr_common_parent(parent->ar_da, da, true)) {
1151 fr_strerror_const("New leaf da and old leaf da do not share the same ancestor");
1152 return -1;
1153 }
1154 } else {
1155 ref = tmpl_attr_list_tail(tmpl_attr(vpt));
1156 }
1157
1158 /*
1159 * Free old unknown and unresolved attributes...
1160 */
1161 talloc_free_children(ref);
1162
1163 /*
1164 *
1165 */
1166 ref->ar_filter_type = TMPL_ATTR_FILTER_TYPE_NONE;
1167 ref->ar_num = NUM_UNSPEC;
1168
1169 } else {
1170 ref = tmpl_attr_add(vpt, da->flags.is_unknown ? TMPL_ATTR_TYPE_UNKNOWN : TMPL_ATTR_TYPE_NORMAL);
1171 }
1172
1173
1174 /*
1175 * Unknown attributes get copied
1176 */
1177 if (da->flags.is_unknown) {
1178 ref->da = ref->ar_unknown = fr_dict_attr_unknown_copy(vpt, da);
1179 } else {
1180 ref->da = da;
1181 }
1182
1183 /*
1184 * FIXME - Should be calculated from existing ar
1185 */
1186 ref->ar_parent = fr_dict_root(fr_dict_by_da(da)); /* Parent is the root of the dictionary */
1187
1188 TMPL_ATTR_VERIFY(vpt);
1189
1190 return 0;
1191}
1192
1193/** Rewrite the leaf's instance number
1194 *
1195 * This function is _only_ called from the compiler, for "update" and "foreach" keywords. In those cases,
1196 * the user historically did "foo-bar", but really meant "foo-bar[*]". We silently update that for
1197 * "update" sections, and complain about it in "foreach" sections.
1198 *
1199 * As the server now supports multiple types of leaf references, we do the rewrite _only_ from "none" (no
1200 * filter), OR where it's a numerical index, AND the index hasn't been specified.
1201 */
1202void tmpl_attr_rewrite_leaf_num(tmpl_t *vpt, int16_t to)
1203{
1204 tmpl_attr_t *ref = NULL;
1205
1206 tmpl_assert_type(tmpl_is_attr(vpt) || tmpl_is_attr_unresolved(vpt));
1207
1208 if (tmpl_attr_list_num_elements(tmpl_attr(vpt)) == 0) return;
1209
1210 ref = tmpl_attr_list_tail(tmpl_attr(vpt));
1211
1212 if (ref->ar_filter_type == TMPL_ATTR_FILTER_TYPE_NONE) {
1213 ref->ar_filter_type = TMPL_ATTR_FILTER_TYPE_INDEX;
1214 ref->ar_num = to;
1215
1216 } else if (ref->ar_filter_type != TMPL_ATTR_FILTER_TYPE_INDEX) {
1217 return;
1218
1219 } else if (ref->ar_num == NUM_UNSPEC) {
1220 ref->ar_num = to;
1221 }
1222
1223 TMPL_ATTR_VERIFY(vpt);
1224}
1225
1226/** Set the request for an attribute ref
1227 *
1228 */
1229void tmpl_attr_set_request_ref(tmpl_t *vpt, FR_DLIST_HEAD(tmpl_request_list) const *request_def)
1230{
1231 fr_assert_msg(tmpl_is_attr(vpt), "Expected tmpl type 'attr', got '%s'",
1232 tmpl_type_to_str(vpt->type));
1233
1234 /*
1235 * Clear any existing request references
1236 */
1237 tmpl_request_list_talloc_reverse_free(&vpt->data.attribute.rr);
1238 tmpl_request_ref_list_copy(vpt, &vpt->data.attribute.rr, request_def);
1239
1240 TMPL_ATTR_VERIFY(vpt);
1241}
1242
1243void tmpl_attr_set_list(tmpl_t *vpt, fr_dict_attr_t const *list)
1244{
1245 tmpl_attr_t *ref = tmpl_attr_list_head(tmpl_attr(vpt));
1246 if (tmpl_attr_is_list_attr(ref)) ref->da = list;
1247
1248 TMPL_ATTR_VERIFY(vpt);
1249}
1250
1251/** Create a new tmpl from a list tmpl and a da
1252 *
1253 */
1254int tmpl_attr_afrom_list(TALLOC_CTX *ctx, tmpl_t **out, tmpl_t const *list, fr_dict_attr_t const *da)
1255{
1256 tmpl_t *vpt;
1257 tmpl_attr_t *ar;
1258
1259 char attr[256];
1260 ssize_t slen;
1261
1262 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_ATTR, T_BARE_WORD, NULL, 0));
1263
1264 /*
1265 * Copies request refs and the list ref
1266 */
1267 tmpl_attr_copy(vpt, list);
1268 tmpl_attr_set_list(vpt, tmpl_list(list));
1269
1270 if (da->flags.is_unknown) {
1271 ar = tmpl_attr_add(vpt, TMPL_ATTR_TYPE_UNKNOWN);
1272 ar->da = ar->ar_unknown = fr_dict_attr_unknown_copy(vpt, da);
1273 } else {
1274 ar = tmpl_attr_add(vpt, TMPL_ATTR_TYPE_NORMAL);
1275 ar->ar_da = da;
1276 }
1277
1278 ar->ar_parent = fr_dict_root(fr_dict_by_da(da));
1279
1280 /*
1281 * We need to rebuild the attribute name, to be the
1282 * one we copied from the source list.
1283 */
1284 slen = tmpl_print(&FR_SBUFF_OUT(attr, sizeof(attr)), vpt,
1285 fr_value_escape_by_quote[list->quote]);
1286 if (slen < 0) {
1287 fr_strerror_printf("Serialized attribute too long. Must be < "
1288 STRINGIFY(sizeof(attr)) " bytes, got %zu bytes", (size_t)-slen);
1289 talloc_free(vpt);
1290 return -1;
1291 }
1292
1293 vpt->len = (size_t)slen;
1294 vpt->name = talloc_strdup(vpt, attr);
1295 vpt->quote = T_BARE_WORD;
1296
1297 TMPL_ATTR_VERIFY(vpt);
1298
1299 *out = vpt;
1300
1301 return 0;
1302}
1303/** @} */
1304
1305/** Insert an attribute reference into a tmpl
1306 *
1307 * Not all attribute references can be used to create new attributes,
1308 * for example those accessing instance > 0 or those that resolve
1309 * to special indexes.
1310 *
1311 * We mark up these references and their parents as resolve only
1312 * meaning that if any code needs to use a reference chain to build
1313 * out a pair tree, it bails out early.
1314 *
1315 * @param[in] vpt containing the reference list.
1316 * @param[in] ar to insert and check.
1317 */
1318static inline CC_HINT(always_inline) void tmpl_attr_insert(tmpl_t *vpt, tmpl_attr_t *ar)
1319{
1320 /*
1321 * Insert the reference into the list.
1322 */
1323 tmpl_attr_list_insert_tail(tmpl_attr(vpt), ar);
1324
1325 switch (ar->ar_num) {
1326 case 0:
1327 case NUM_UNSPEC:
1328 break;
1329
1330 default:
1331 ar->resolve_only = true;
1332 while ((ar = tmpl_attr_list_prev(tmpl_attr(vpt), ar))) ar->resolve_only = true;
1333 break;
1334 }
1335}
1336
1337/** Parse array subscript and in future other filters
1338 *
1339 * @param[out] err Parse error code.
1340 * @param[in] ar to populate filter for.
1341 * @param[in] name containing more attribute ref data.
1342 * @param[in] at_rules see tmpl_attr_afrom_attr_substr.
1343 * @return
1344 * - >0 if a filter was parsed.
1345 * - 0 if no filter was available.
1346 * - <0 on filter parse error.
1347 */
1348static fr_slen_t tmpl_attr_parse_filter(tmpl_attr_error_t *err, tmpl_attr_t *ar,
1349 fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
1350{
1351 fr_sbuff_t our_name = FR_SBUFF(name);
1352
1353 /*
1354 * Parse array subscript (and eventually complex filters)
1355 */
1356 if (!fr_sbuff_next_if_char(&our_name, '[')) return 0;
1357
1358 if (at_rules->disallow_filters || tmpl_attr_is_list_attr(ar)) {
1359 fr_strerror_const("Filters not allowed here");
1360 if (err) *err = TMPL_ATTR_ERROR_FILTER_NOT_ALLOWED;
1361 fr_sbuff_set_to_start(&our_name);
1362 FR_SBUFF_ERROR_RETURN(&our_name);
1363 }
1364
1365 ar->ar_filter_type = TMPL_ATTR_FILTER_TYPE_INDEX;
1366 fr_sbuff_switch(&our_name, '\0') {
1367 case '#':
1368 ar->ar_num = NUM_COUNT;
1369 fr_sbuff_next(&our_name);
1370 break;
1371
1372 case '*':
1373 ar->ar_num = NUM_ALL;
1374 fr_sbuff_next(&our_name);
1375 break;
1376
1377 case '0':
1378 case '1':
1379 case '2':
1380 case '3':
1381 case '4':
1382 case '5':
1383 case '6':
1384 case '7':
1385 case '8':
1386 case '9':
1387 {
1388 ssize_t rcode;
1389 fr_sbuff_parse_error_t sberr = FR_SBUFF_PARSE_OK;
1390 fr_sbuff_t tmp = FR_SBUFF(&our_name);
1391
1392 /*
1393 * All digits (not hex).
1394 */
1395 rcode = fr_sbuff_out(&sberr, &ar->ar_num, &tmp);
1396 if ((rcode < 0) || !fr_sbuff_is_char(&tmp, ']')) goto parse_tmpl;
1397
1398 if ((ar->ar_num > 1000) || (ar->ar_num < 0)) {
1399 fr_strerror_printf("Invalid array index '%hi' (should be between 0-1000)", ar->ar_num);
1400 ar->ar_num = 0;
1401 goto error;
1402 }
1403
1404 fr_sbuff_set(&our_name, &tmp); /* Advance name _AFTER_ doing checks */
1405 break;
1406 }
1407
1408 case '"':
1409 case '\'':
1410 case '`':
1411 case '/':
1412 fr_strerror_const("Invalid data type for array index");
1413 goto error;
1414
1415 /* Used as EOB here */
1416 missing_closing:
1417 case '\0':
1418 fr_strerror_const("No closing ']' for array index");
1419 error:
1420 if (err) *err = TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX;
1421 FR_SBUFF_ERROR_RETURN(&our_name);
1422
1423 case '(': /* (...) expression */
1424 {
1425 fr_sbuff_t tmp = FR_SBUFF(&our_name);
1426 fr_slen_t slen;
1427 tmpl_rules_t t_rules;
1428 fr_sbuff_parse_rules_t p_rules;
1429 fr_sbuff_term_t const filter_terminals = FR_SBUFF_TERMS(L("]"));
1430
1431
1432 tmp = FR_SBUFF(&our_name);
1433 t_rules = (tmpl_rules_t) {};
1434 t_rules.attr = *at_rules;
1435
1436 /*
1437 * Unspecified child, we can create a filter starting from the children.
1438 *
1439 * @todo - When parsing the condition, we need to ensure that the condition contains a
1440 * reference to the current cursor, and we need to decide what that syntax is.
1441 */
1442 if (ar->type == TMPL_ATTR_TYPE_UNSPEC) {
1443 if (at_rules->dict_def) t_rules.attr.namespace = fr_dict_root(at_rules->dict_def);
1444
1445 } else {
1446 if (!ar->ar_da || !fr_type_is_structural(ar->ar_da->type)) {
1447 fr_strerror_printf("Invalid filter - cannot use filter on leaf attributes");
1448 ar->ar_num = 0;
1449 goto error;
1450 }
1451 t_rules.attr.namespace = ar->ar_da;
1452 }
1453
1454 p_rules = (fr_sbuff_parse_rules_t) {
1455 .terminals = &filter_terminals,
1456 .escapes = NULL
1457 };
1458
1459 /*
1460 * Check if it's a condition.
1461 */
1462 slen = xlat_tokenize_condition(ar, &ar->ar_cond, &tmp, &p_rules, &t_rules);
1463 if (slen < 0) goto error;
1464
1465 if (xlat_impure_func(ar->ar_cond)) {
1466 fr_strerror_const("Condition in attribute index cannot depend on functions which call external databases");
1467 goto error;
1468 }
1469
1470 ar->ar_filter_type = TMPL_ATTR_FILTER_TYPE_CONDITION;
1471 fr_sbuff_set(&our_name, &tmp); /* Advance name _AFTER_ doing checks */
1472 break;
1473 }
1474
1475 case '%': /* ${...} expansion */
1476 {
1477 fr_sbuff_t tmp = FR_SBUFF(&our_name);
1478 fr_slen_t slen;
1479 tmpl_rules_t t_rules;
1480 fr_sbuff_parse_rules_t p_rules;
1481 fr_sbuff_term_t const filter_terminals = FR_SBUFF_TERMS(L("]"));
1482
1483 if (!fr_sbuff_is_str(&our_name, "%{", 2)) {
1484 fr_strerror_const("Invalid expression in attribute index");
1485 goto error;
1486 }
1487
1488 tmp = FR_SBUFF(&our_name);
1489 t_rules = (tmpl_rules_t) {};
1490 t_rules.attr = *at_rules;
1491
1492 p_rules = (fr_sbuff_parse_rules_t) {
1493 .terminals = &filter_terminals,
1494 .escapes = NULL
1495 };
1496
1497 /*
1498 * Check if it's an expression.
1499 */
1500 slen = xlat_tokenize_expression(ar, &ar->ar_expr, &tmp, &p_rules, &t_rules);
1501 if (slen < 0) goto error;
1502
1503 if (xlat_impure_func(ar->ar_expr)) {
1504 fr_strerror_const("Expression in attribute index cannot depend on functions which call external databases");
1505 goto error;
1506 }
1507
1508 ar->ar_filter_type = TMPL_ATTR_FILTER_TYPE_EXPR;
1509
1510 fr_sbuff_set(&our_name, &tmp); /* Advance name _AFTER_ doing checks */
1511 break;
1512 }
1513
1514 case 'n':
1515 /*
1516 * [n] is the last one
1517 *
1518 * [nope] is a reference to "nope".
1519 */
1520 if (fr_sbuff_is_str(&our_name, "n]", 2)) {
1521 ar->ar_num = NUM_LAST;
1522 fr_sbuff_next(&our_name);
1523 break;
1524 }
1525 FALL_THROUGH;
1526
1527 default:
1528 parse_tmpl:
1529 {
1530 fr_sbuff_t tmp = FR_SBUFF(&our_name);
1531 ssize_t slen;
1532 tmpl_rules_t t_rules;
1533 fr_sbuff_parse_rules_t p_rules;
1534 fr_sbuff_term_t const filter_terminals = FR_SBUFF_TERMS(L("]"));
1535
1536 tmp = FR_SBUFF(&our_name);
1537 t_rules = (tmpl_rules_t) {};
1538 t_rules.attr = *at_rules;
1539
1540 /*
1541 * Don't reset namespace, we always want to start searching from the top level of the
1542 * dictionaries.
1543 */
1544
1545 p_rules = (fr_sbuff_parse_rules_t) {
1546 .terminals = &filter_terminals,
1547 .escapes = NULL
1548 };
1549
1550 /*
1551 * @todo - for some reason, the tokenize_condition code allows for internal
1552 * vs protocol vs local attributes, whereas the tmpl function only accepts
1553 * internal ones.
1554 */
1555 slen = tmpl_afrom_substr(ar, &ar->ar_tmpl, &tmp, T_BARE_WORD, &p_rules, &t_rules);
1556 if (slen <= 0) goto error;
1557
1558 if (!tmpl_is_attr(ar->ar_tmpl)) {
1559 fr_strerror_printf("Invalid array index '%s'", ar->ar_tmpl->name);
1560 goto error;
1561 }
1562
1563 /*
1564 * Arguably we _could_ say &User-Name["foo"] matches all user-name with value "foo",
1565 * but that would confuse the issue for &Integer-Thing[4].
1566 *
1567 * For matching therefore, we really need to have a way to define "self".
1568 */
1569 if (!fr_type_numeric[tmpl_attr_tail_da(ar->ar_tmpl)->type]) {
1570 fr_strerror_const("Invalid data type for array index (must be numeric)");
1571 goto error;
1572 }
1573
1574 ar->ar_filter_type = TMPL_ATTR_FILTER_TYPE_TMPL;
1575 fr_sbuff_set(&our_name, &tmp); /* Advance name _AFTER_ doing checks */
1576 break;
1577 }
1578 }
1579
1580 /*
1581 * Always advance here, so the error
1582 * marker points to the bad char.
1583 */
1584 if (!fr_sbuff_next_if_char(&our_name, ']')) goto missing_closing;
1585
1586 FR_SBUFF_SET_RETURN(name, &our_name);
1587}
1588
1589extern fr_dict_attr_t const *tmpl_attr_unspec;
1590
1591static inline CC_HINT(nonnull(3,4))
1592fr_slen_t tmpl_attr_ref_from_unspecified_substr(tmpl_attr_t *ar, tmpl_attr_error_t *err,
1593 tmpl_t *vpt,
1594 fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
1595{
1596 fr_slen_t slen;
1597
1598 *ar = (tmpl_attr_t){
1599 .ar_num = NUM_UNSPEC, /* May be changed by tmpl_attr_parse_filter */
1600 .ar_type = TMPL_ATTR_TYPE_UNSPEC,
1601 .ar_da = tmpl_attr_unspec,
1602 };
1603
1604 slen = tmpl_attr_parse_filter(err, ar, name, at_rules);
1605 if (slen < 0) {
1606 return slen;
1607
1608 /*
1609 * No filters and no previous elements is the equivalent of '&'
1610 * which is not allowed.
1611 *
1612 * &[<filter>] is allowed as this lets us perform filtering operations
1613 * at the root.
1614 */
1615 } else if (tmpl_attr_num_elements(vpt) == 0) {
1616 fr_strerror_const("Invalid attribute name");
1617 if (err) *err = TMPL_ATTR_ERROR_INVALID_NAME;
1618 return -1;
1619 }
1620
1621 tmpl_attr_insert(vpt, ar);
1622
1623 return slen;
1624}
1625
1626/** Parse an unresolved attribute, i.e. one which can't be found in the current dictionary
1627 *
1628 * This function calls itself recursively to process additional OID
1629 * components once we've failed to resolve one component.
1630 *
1631 * @note Do not call directly.
1632 *
1633 * @param[in] ctx to allocate new attribute reference in.
1634 * @param[out] err Parse error.
1635 * @param[in,out] vpt to append this reference to.
1636 * @param[in] parent Last known parent.
1637 * @param[in] namespace in which the attribute will be resolved.
1638 * @param[in] name to parse.
1639 * @param[in] at_rules see tmpl_attr_afrom_attr_substr.
1640 * @return
1641 * - <0 on error.
1642 * - 0 on success.
1643 */
1644static inline CC_HINT(nonnull(3,6))
1645fr_slen_t tmpl_attr_ref_afrom_unresolved_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
1646 tmpl_t *vpt,
1647 fr_dict_attr_t const *parent, fr_dict_attr_t const *namespace,
1648 fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
1649{
1650 tmpl_attr_t *ar = NULL, *ar_curr;
1651 fr_sbuff_t our_name = FR_SBUFF(name);
1652 fr_slen_t slen;
1653 char *unresolved;
1654
1655 /*
1656 * Point we free from if something goes wrong.
1657 */
1658 ar_curr = tmpl_attr_list_tail(tmpl_attr(vpt));
1659 for (;;) {
1660 MEM(ar = talloc(ctx, tmpl_attr_t));
1661 /*
1662 * Copy out a string of allowed dictionary chars to form
1663 * the unresolved attribute name.
1664 *
1665 * This will be resolved later (outside of this function).
1666 */
1667 slen = fr_sbuff_out_abstrncpy_allowed(ar, &unresolved,
1668 &our_name, FR_DICT_ATTR_MAX_NAME_LEN + 1,
1669 fr_dict_attr_allowed_chars);
1670 if (slen == 0) {
1671 slen = tmpl_attr_ref_from_unspecified_substr(ar, err, vpt, &our_name, at_rules);
1672 if (slen < 0) {
1673 fr_sbuff_advance(&our_name, +slen);
1674 error:
1675 talloc_free(ar);
1676 tmpl_attr_list_talloc_free_to_tail(tmpl_attr(vpt), ar_curr);
1677 return -1;
1678 }
1679 return fr_sbuff_set(name, &our_name);
1680 } else if (slen > FR_DICT_ATTR_MAX_NAME_LEN) {
1681 fr_strerror_const("Attribute name is too long");
1682 if (err) *err = TMPL_ATTR_ERROR_INVALID_NAME;
1683 goto error;
1684 }
1685
1686 *ar = (tmpl_attr_t){
1687 .ar_num = NUM_UNSPEC,
1688 .ar_type = TMPL_ATTR_TYPE_UNRESOLVED,
1689 .ar_unresolved = unresolved,
1690 .ar_unresolved_namespace = namespace,
1691 .ar_parent = parent
1692 };
1693
1694 if (tmpl_attr_parse_filter(err, ar, &our_name, at_rules) < 0) goto error;
1695
1696 /*
1697 * Insert the ar into the list of attribute references
1698 *
1699 * The tmpl is no longer a pure TMPL_TYPE_ATTR. We have to convert it to an unresolved
1700 * one. If we don't do this, then tmpl_afrom_attr_substr() would walk the ar list
1701 * expecting every ar->ar_da to be non-NULL, and would crash on the UNRESOLVED entry.
1702 */
1703 tmpl_attr_insert(vpt, ar);
1704 vpt->type = TMPL_TYPE_ATTR_UNRESOLVED;
1705
1706 /*
1707 * Once one OID component is created as unresolved all
1708 * future OID components are also unresolved.
1709 */
1710 if (!fr_sbuff_next_if_char(&our_name, '.')) break;
1711 }
1712
1713 /*
1714 * Mark the tmpl up as an unresolved attribute reference
1715 * the attribute reference will be resolved later.
1716 */
1717 vpt->type = TMPL_TYPE_ATTR_UNRESOLVED;
1718
1719 return fr_sbuff_set(name, &our_name);
1720}
1721
1722/*
1723 * Add attr_ref when we've parsed an intermediate dictionary name
1724 * which is itself a ref.
1725 */
1726static void tmpl_attr_ref_fixup(TALLOC_CTX *ctx, tmpl_t *vpt, fr_dict_attr_t const *da, fr_dict_attr_t const *parent)
1727{
1728 tmpl_attr_t *ar;
1729
1730 if (tmpl_attr_tail_da(vpt) == da) return;
1731
1732 if (da->parent != parent) tmpl_attr_ref_fixup(ctx, vpt, da->parent, parent);
1733
1734 MEM(ar = talloc(ctx, tmpl_attr_t));
1735 *ar = (tmpl_attr_t) {
1736 .ar_num = NUM_UNSPEC,
1737 .ar_type = TMPL_ATTR_TYPE_NORMAL,
1738 .ar_da = da,
1739 .ar_parent = da->parent,
1740 };
1741
1742 tmpl_attr_insert(vpt, ar);
1743}
1744
1745/** Parse an attribute reference, either an OID or attribute name
1746 *
1747 * @note Do not call directly.
1748 *
1749 * @param[in] ctx to allocate new attribute reference in.
1750 * @param[out] err Parse error.
1751 * @param[in,out] vpt to append this reference to.
1752 * @param[in] parent Parent where the attribute will be placed (group, struct, tlv, etc).
1753 * @param[in] namespace Where the child attribute will be parsed from (dict root, struct member, TLV child, etc)
1754 * @param[in] name to parse.
1755 * @param[in] p_rules Formatting rules used to check for trailing garbage.
1756 * @param[in] at_rules which places constraints on attribute reference parsing.
1757 * Rules interpreted by this function is:
1758 * - allow_unknown - If false unknown OID components
1759 * result in a parse error.
1760 * - allow_unresolved - If false unknown attribute names
1761 * result in a parse error.
1762 * - allow_foreign - If an attribute resolves in a dictionary
1763 * that does not match the parent
1764 * (exception being FR_TYPE_GROUP) then that results
1765 * in a parse error.
1766 * @param[in] depth How deep we are. Used to check for maximum nesting level.
1767 * @return
1768 * - <0 on error.
1769 * - 0 on success.
1770 */
1771static int tmpl_attr_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
1772 tmpl_t *vpt,
1773 fr_dict_attr_t const *parent, fr_dict_attr_t const *namespace,
1774 fr_sbuff_t *name,
1775 fr_sbuff_parse_rules_t const *p_rules, tmpl_attr_rules_t const *at_rules,
1776 unsigned int depth)
1777{
1778 uint32_t oid = 0;
1779 tmpl_attr_t *ar = NULL;
1780 fr_dict_attr_t const *da;
1781 fr_sbuff_marker_t m_s;
1782 fr_dict_attr_err_t dict_err;
1783 fr_dict_attr_t const *our_parent = parent;
1784
1785 fr_sbuff_marker(&m_s, name);
1786
1787 if (depth > FR_DICT_MAX_TLV_STACK) {
1788 fr_strerror_const("Attribute nesting too deep");
1789 if (err) *err = TMPL_ATTR_ERROR_NESTING_TOO_DEEP;
1790 error:
1791 talloc_free(ar);
1792 fr_sbuff_marker_release(&m_s);
1793 FR_SBUFF_ERROR_RETURN(name);
1794 }
1795
1796 /*
1797 * Input too short
1798 */
1799 if (!fr_sbuff_extend(name)) {
1800 fr_strerror_const("Unexpected end of input when trying to read an attribute name");
1801 if (err) *err = TMPL_ATTR_ERROR_INVALID_NAME;
1802 goto error;
1803 }
1804
1805 /*
1806 * This cannot possibly be an attribute name, so we just bypass all kinds of work.
1807 */
1808 if (!depth && !fr_dict_attr_nested_allowed_chars[fr_sbuff_uint8(name, '\0')]) {
1809 fr_strerror_printf("Unexpected input '%c' when trying to read an attribute name",
1810 fr_sbuff_char(name, '\0'));
1811 if (err) *err = TMPL_ATTR_ERROR_EMPTY;
1812 FR_SBUFF_ERROR_RETURN(name);
1813 }
1814
1815 /*
1816 * Maybe there's no child namespace (struct member, tlv child, etc). In which case we must
1817 * search from the default dictionary root.
1818 *
1819 * This search is probably wrong in some cases. See the comments below around FR_TYPE_GROUP.
1820 *
1821 * If we change out the dictionaries, we should arguably also change dict_def in the
1822 * tmpl_attr_rules_t. On top of that, the "dict_attr_search" functions take a #fr_dict_t
1823 * pointer, and not a pointer to the dict root. So we can't pass them a namespace.
1824 */
1825 if (!namespace) {
1826 fr_assert(parent == NULL);
1827
1828 (void)fr_dict_attr_search_by_qualified_name_substr(&dict_err, &da,
1829 at_rules->dict_def,
1830 name, p_rules ? p_rules->terminals : NULL,
1831 true,
1832 at_rules->allow_foreign);
1833 /*
1834 * The attribute was found either in the dict_def root, OR in the internal root, OR if
1835 * !dict_def && allow_foreign, in some other dictionary root.
1836 *
1837 * Otherwise we're still not sure what the attribute is. It may end up being an
1838 * unresolved one.
1839 */
1840 if (da) {
1841 our_parent = da->parent;
1842
1843 if (!our_parent->flags.is_root) {
1844 tmpl_attr_ref_fixup(ctx, vpt, our_parent, fr_dict_root(da->dict));
1845 }
1846 }
1847 } else {
1848 fr_assert(parent != NULL);
1849
1850 /*
1851 * Otherwise we're resolving the next piece in the context of where-ever we ended up from
1852 * parsing the last bit.
1853 *
1854 * The "parent" could be the same as "namespace", if both are at a dictionary root, OR
1855 * both are from a struct / tlv attribute.
1856
1857 * Or, "parent" could be a grouping attribute (e.g. request), and "namespace" could be
1858 * the dictionary root.
1859 */
1860 (void)fr_dict_attr_by_name_substr(&dict_err,
1861 &da,
1862 namespace,
1863 name,
1864 p_rules ? p_rules->terminals : NULL);
1865
1866 /*
1867 * Allow fallback to internal attributes
1868 * if the parent was a group, and we're
1869 * allowing internal resolution.
1870 *
1871 * Discard any errors here... It's more
1872 * useful to have the original.
1873 */
1874 if (!da) {
1875 ar = tmpl_attr_list_tail(&vpt->data.attribute.ar);
1876 if (!ar || ((ar->type == TMPL_ATTR_TYPE_NORMAL) && (ar->ar_da->type == FR_TYPE_GROUP))) {
1877 fr_dict_attr_t const *internal_root = fr_dict_root(fr_dict_internal());
1878
1879 (void)fr_dict_attr_by_name_substr(NULL,
1880 &da, internal_root,
1881 name,
1882 p_rules ? p_rules->terminals : NULL);
1883 if (da) {
1884 dict_err = FR_DICT_ATTR_OK;
1885 our_parent = internal_root;
1886 }
1887 }
1888 ar = NULL;
1889
1890 } else {
1891 /*
1892 * If we searched in a local dictionary, but found a real attribute
1893 * switch the namespace.
1894 */
1895 if (!da->flags.local && namespace->flags.local) namespace = our_parent = fr_dict_root(da->dict);
1896 }
1897 }
1898
1899 /*
1900 * Fatal errors related to nesting...
1901 */
1902 switch (dict_err) {
1903 case FR_DICT_ATTR_NO_CHILDREN:
1904 fr_assert(our_parent != NULL);
1905 if (our_parent->flags.is_unknown) break;
1906 goto error;
1907
1908 case FR_DICT_ATTR_NOT_DESCENDENT:
1909 goto error;
1910
1911 default:
1912 if (!da) break;
1913
1914 /*
1915 * The named component was a known attribute
1916 * so record it as a normal attribute
1917 * reference.
1918 */
1919 fr_assert(our_parent != NULL);
1920
1921 /*
1922 * We had an alias in the same namespace,
1923 * go add more things in.
1924 */
1925 if (da->parent != our_parent) {
1926 fr_assert(namespace == our_parent);
1927 tmpl_attr_ref_fixup(ctx, vpt, da->parent, our_parent);
1928 }
1929
1930 goto alloc_ar;
1931 }
1932
1933 /*
1934 * At this point we haven't found a known attribute. What remains MUST be an OID component, OR an
1935 * unresolved attribute.
1936 *
1937 * The default is to parse the OIDs in the current namespace. If there is none, then we parse
1938 * the OIDs and unresolved attributes in the dict_def. And if that doesn't exist, in the
1939 * internal dictionaries.
1940 *
1941 * Note that we do NOT allow unknown attributes in the internal dictionary. Those attributes are
1942 * generally just DEFINEs, and their numbers have no meaning.
1943 */
1944 if (!namespace) {
1945 if (at_rules->dict_def) {
1946 our_parent = namespace = fr_dict_root(at_rules->dict_def);
1947 } else {
1948 our_parent = namespace = fr_dict_root(fr_dict_internal());
1949 }
1950 }
1951
1952 fr_assert(our_parent != NULL);
1953 fr_assert(namespace != NULL);
1954
1955 /*
1956 * See if the ref begins with an unsigned integer
1957 * if it does it's probably an OID component
1958 *
1959 * .<oid>
1960 */
1961 if (fr_sbuff_out(NULL, &oid, name) > 0) {
1962 if (!at_rules->allow_oid) {
1963 uint8_t c = fr_sbuff_uint8(name, '\0');
1964
1965 /*
1966 * This extra test is to give the user better errors. The string "3G" is parsed
1967 * as "3", and then an error of "what the heck do you mean by G?"
1968 *
1969 * In contrast, the string "3." is parsed as "3", and then "nope, that's not an attribute reference".
1970 */
1971 if (c != '.') {
1972 fr_strerror_const("Unexpected text after attribute reference");
1973 if (err) *err = TMPL_ATTR_ERROR_MISSING_TERMINATOR;
1974 } else {
1975 fr_strerror_const("Numerical attribute references are not allowed here");
1976 if (err) *err = TMPL_ATTR_ERROR_INVALID_OID;
1977
1978 fr_sbuff_set(name, &m_s);
1979 }
1980 goto error;
1981 }
1982
1983 our_parent = namespace = fr_dict_unlocal(namespace);
1984
1985 fr_assert(ar == NULL);
1986
1987 fr_strerror_clear(); /* Clear out any existing errors */
1988
1989 if (fr_dict_by_da(namespace) == fr_dict_internal()) goto disallow_unknown;
1990
1991 /*
1992 * The OID component was a known attribute
1993 * so record it as a normal attribute
1994 * reference.
1995 */
1996 da = fr_dict_attr_child_by_num(namespace, oid);
1997 if (da) {
1998 fr_assert(da->parent == our_parent);
1999 goto alloc_ar;
2000 }
2001
2002 if (!at_rules->allow_unknown) {
2003 disallow_unknown:
2004 fr_strerror_const("Unknown attributes not allowed here");
2005 if (err) *err = TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED;
2006 fr_sbuff_set(name, &m_s);
2007 goto error;
2008 }
2009
2010 /*
2011 * If it's numeric and not a known attribute
2012 * then we create an unknown attribute with
2013 * the specified attribute number.
2014 */
2015 MEM(ar = talloc(ctx, tmpl_attr_t));
2016
2017 /*
2018 * VSAs have VENDORs as children. All others are just normal things.
2019 */
2020 switch (namespace->type) {
2021 case FR_TYPE_VSA:
2022 da = fr_dict_attr_unknown_vendor_afrom_num(ar, namespace, oid);
2023 break;
2024
2025 default:
2026 da = fr_dict_attr_unknown_raw_afrom_num(ar, namespace, oid);
2027 break;
2028 }
2029
2030 if (!da) {
2031 if (err) *err = TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED; /* strerror set by dict function */
2032 goto error;
2033 }
2034
2035 *ar = (tmpl_attr_t){
2036 .ar_num = NUM_UNSPEC,
2037 .ar_type = TMPL_ATTR_TYPE_UNKNOWN,
2038 .ar_unknown = UNCONST(fr_dict_attr_t *, da),
2039 .ar_da = da,
2040 .ar_parent = our_parent,
2041 };
2042 goto do_suffix;
2043 }
2044
2045 /*
2046 * Can't parse it as an attribute, might be a literal string
2047 * let the caller decide.
2048 *
2049 * Don't alter the fr_strerror buffer, may contain useful
2050 * errors from the dictionary code.
2051 */
2052 if (!at_rules->allow_unresolved && !(at_rules->allow_wildcard && fr_sbuff_is_char(name, '['))) {
2053 fr_strerror_const_push("Unresolved attributes are not allowed here");
2054 if (err) *err = TMPL_ATTR_ERROR_UNRESOLVED_NOT_ALLOWED;
2055 fr_sbuff_set(name, &m_s);
2056 goto error;
2057 }
2058
2059 fr_sbuff_marker_release(&m_s);
2060
2061 /*
2062 * Once we hit one unresolved attribute we have to treat
2063 * the rest of the components are unresolved as well.
2064 */
2065 return tmpl_attr_ref_afrom_unresolved_substr(ctx, err, vpt, our_parent, namespace, name, at_rules);
2066
2067alloc_ar:
2068 /*
2069 * We have a da, remove any of the errors recorded from failed
2070 * searches to find the attribute to avoid misleading messages
2071 * if something else fails.
2072 */
2073 fr_strerror_clear();
2074
2075 MEM(ar = talloc(ctx, tmpl_attr_t));
2076 *ar = (tmpl_attr_t) {
2077 .ar_num = NUM_UNSPEC,
2078 .ar_type = TMPL_ATTR_TYPE_NORMAL,
2079 .ar_da = da,
2080 .ar_parent = da->parent,
2081 };
2082
2083do_suffix:
2084 /*
2085 * Parse the attribute reference filter
2086 *
2087 * Error out immediately if the filter is bad
2088 * otherwise determine whether to keep the
2089 * attribute reference or omit it based on:
2090 *
2091 * - Whether there was a filter present.
2092 * - The type of attribute.
2093 * - If this is the leaf attribute reference.
2094 */
2095 if (tmpl_attr_parse_filter(err, ar, name, at_rules) < 0) goto error;
2096
2097 /*
2098 * Local variables are always unitary.
2099 *
2100 * [0] is allowed, as is [n], [*], and [#]. But [1], etc. aren't allowed.
2101 */
2102 if (da->flags.local && (ar->ar_num > 0)) {
2103 fr_strerror_printf("Invalid array reference for local variable");
2104 if (err) *err = TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX;
2105 fr_sbuff_set(name, &m_s);
2106 goto error;
2107 }
2108
2109 /*
2110 * At the end of the attribute reference. If there's a
2111 * trailing '.' then there's another attribute reference
2112 * we need to parse, otherwise we're done.
2113 */
2114 fr_sbuff_marker_release(&m_s);
2115 fr_sbuff_marker(&m_s, name);
2116
2117 if (fr_sbuff_next_if_char(name, '.')) {
2118 fr_dict_attr_t const *ref;
2119
2120 switch (da->type) {
2121 case FR_TYPE_GROUP:
2122 ref = fr_dict_attr_ref(da);
2123
2124 /*
2125 * If the ref is outside of the internal namespace, then we use it.
2126 *
2127 * If the ref is inside of the internal namespace (e.g. "request"), then we do
2128 * something else.
2129 *
2130 * If we were given a root dictionary on input, use that. We have to follow this
2131 * dictionary because this function calls itself recursively, WITHOUT updating
2132 * "dict_def" in the attr_rules. So the dict-def there is whatever got passed
2133 * into tmpl_afrom_attr_substr(), BEFORE the "parent.parent.parent..." parsing.
2134 * Which means that in many cases, the "dict_def" is completely irrelevant.
2135 *
2136 * If there is no parent on input, then we just use dict_def.
2137 *
2138 * Otherwise we search through all of the dictionaries.
2139 *
2140 * Note that we cannot put random protocol attributes into an internal attribute
2141 * of type "group".
2142 */
2143 if (ref != fr_dict_root(fr_dict_internal())) {
2144 our_parent = namespace = ref;
2145
2146 } else if (parent && parent->flags.is_root) {
2147 our_parent = namespace = parent;
2148
2149 } else if (request_attr_is_list(da)) {
2150 our_parent = namespace = NULL;
2151
2152 } else if (at_rules->dict_def) {
2153 our_parent = namespace = fr_dict_root(at_rules->dict_def);
2154
2155 } else {
2156 our_parent = namespace = NULL;
2157 }
2158 break;
2159
2160 case FR_TYPE_STRUCTURAL_EXCEPT_GROUP:
2161 /*
2162 * Structural types are parented and namespaced from their parent da.
2163 */
2164 namespace = our_parent = da;
2165 break;
2166
2167 default:
2168 fr_strerror_printf("Attribute %s of data type '%s' cannot have child attributes", da->name, fr_type_to_str(da->type));
2169 fr_sbuff_set(name, &m_s);
2170 goto error;
2171 }
2172
2173 if (ar) tmpl_attr_insert(vpt, ar);
2174
2175 if (tmpl_attr_afrom_attr_substr(ctx, err, vpt, our_parent, namespace, name, p_rules, at_rules, depth + 1) < 0) {
2176 if (ar) {
2177 tmpl_attr_list_talloc_free_tail(&vpt->data.attribute.ar); /* Remove and free ar */
2178 ar = NULL;
2179 }
2180 goto error;
2181 }
2182
2183 /*
2184 * If it's a leaf we always insert the attribute
2185 * reference into the list, even if it's a
2186 * nesting attribute.
2187 *
2188 * This is useful for nested edit sections
2189 * where the tmpl might be the name of a new
2190 * subsection.
2191 */
2192 } else {
2193 tmpl_attr_insert(vpt, ar);
2194 }
2195
2196 /*
2197 * Remove unnecessary casts.
2198 */
2199 if (tmpl_is_attr(vpt) && tmpl_attr_tail_is_normal(vpt) &&
2200 (tmpl_rules_cast(vpt) == tmpl_attr_tail_da(vpt)->type)) vpt->rules.cast = FR_TYPE_NULL;
2201
2202 TMPL_VERIFY(vpt);
2203
2204 fr_sbuff_marker_release(&m_s);
2205 return 0;
2206}
2207
2208static int attr_to_raw(tmpl_t *vpt, tmpl_attr_t *ref)
2209{
2210 switch (ref->type) {
2211 case TMPL_ATTR_TYPE_NORMAL:
2212 {
2213 ref->da = ref->ar_unknown = fr_dict_attr_unknown_afrom_da(vpt, ref->da);
2214 if (!ref->da) return -1;
2215
2216 ref->ar_unknown->type = FR_TYPE_OCTETS;
2217 ref->is_raw = 1;
2218 ref->type = TMPL_ATTR_TYPE_UNKNOWN;
2219 }
2220 break;
2221 case TMPL_ATTR_TYPE_UNSPEC: /* noop */
2222 break;
2223
2224 case TMPL_ATTR_TYPE_UNKNOWN:
2225 ref->ar_unknown->type = FR_TYPE_OCTETS;
2226 ref->is_raw = 1;
2227 break;
2228
2229 case TMPL_ATTR_TYPE_UNRESOLVED:
2230 ref->is_raw = true;
2231 break;
2232 }
2233
2234 TMPL_ATTR_VERIFY(vpt);
2235
2236 return 0;
2237}
2238
2239/** Parse a string into a TMPL_TYPE_ATTR_* type #tmpl_t
2240 *
2241 * @param[in,out] ctx to allocate #tmpl_t in.
2242 * @param[out] err May be NULL. Provides the exact error that the parser hit
2243 * when processing the attribute ref.
2244 * @param[out] out Where to write pointer to new #tmpl_t.
2245 * @param[in] name of attribute including #tmpl_request_ref_t and #fr_pair_list_t qualifiers.
2246 * @param[in] p_rules Formatting rules used to check for trailing garbage.
2247 * @param[in] t_rules Rules which control parsing:
2248 * - dict_def The default dictionary to use if attributes
2249 * are unqualified.
2250 * - request_def The default #request_t to set if no
2251 * #tmpl_request_ref_t qualifiers are found in name.
2252 * - list_def The default list to set if no #fr_pair_list_t
2253 * qualifiers are found in the name.
2254 * - allow_unknown If true, numerical attributes will be allowed,
2255 * even if they're not in the main dictionaries.
2256 * If an unknown attribute is found a #TMPL_TYPE_ATTR
2257 * #tmpl_t will be produced.
2258 * If #tmpl_afrom_attr_substr is being called on
2259 * startup, the #tmpl_t may be passed to
2260 * #tmpl_attr_unknown_add to
2261 * add the unknown attribute to the main dictionary.
2262 * If the unknown attribute is not added to
2263 * the main dictionary the #tmpl_t cannot be used
2264 * to search for a #fr_pair_t in a #request_t.
2265 * - allow_unresolved If true, we don't generate a parse error on
2266 * unknown attributes. If an unknown attribute is
2267 * found a #TMPL_TYPE_ATTR_UNRESOLVED
2268 * #tmpl_t will be produced.
2269 * - allow_foreign If true, allow attribute names to be qualified
2270 * with a protocol outside of the passed dict_def.
2271 * - disallow_filters
2272 *
2273 * @see REMARKER to produce pretty error markers from the return value.
2274 *
2275 * @return
2276 * - <= 0 on error (offset as negative integer)
2277 * - > 0 on success (number of bytes parsed).
2278 */
2279ssize_t tmpl_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
2280 tmpl_t **out, fr_sbuff_t *name,
2281 fr_sbuff_parse_rules_t const *p_rules,
2282 tmpl_rules_t const *t_rules)
2283{
2284 int ret;
2285 tmpl_t *vpt;
2286 fr_sbuff_t our_name = FR_SBUFF(name); /* Take a local copy in case we need to back track */
2287 bool is_raw = false;
2288 tmpl_attr_rules_t const *at_rules;
2289 tmpl_attr_rules_t my_attr_rules;
2290 fr_sbuff_marker_t m_l;
2291 fr_dict_attr_t const *namespace;
2292 DEFAULT_RULES;
2293
2294 CHECK_T_RULES;
2295
2296 at_rules = &t_rules->attr;
2297
2298 if (err) *err = TMPL_ATTR_ERROR_NONE;
2299
2300 if (!fr_sbuff_extend(&our_name)) {
2301 fr_strerror_const("Empty attribute reference");
2302 if (err) *err = TMPL_ATTR_ERROR_EMPTY;
2303 FR_SBUFF_ERROR_RETURN(&our_name);
2304 }
2305
2306 /*
2307 * '&' prefix is ignored.
2308 */
2309 if (fr_sbuff_next_if_char(&our_name, '&') && check_config && at_rules->ci) {
2310 cf_log_warn(at_rules->ci, "Using '&' is no longer necessary when referencing attributes. Please delete it.");
2311 }
2312
2313 if (fr_sbuff_is_char(name, '[')) {
2314 fr_strerror_const("Missing attribute name");
2315 if (err) *err = TMPL_ATTR_ERROR_EMPTY;
2316 FR_SBUFF_ERROR_RETURN(&our_name);
2317 }
2318
2319 /*
2320 * We parsed the tmpl as User-Name, but NOT %{User-Name}.
2321 */
2322 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_ATTR, T_BARE_WORD, NULL, 0));
2323
2324 /*
2325 * The "raw." prefix marks up the leaf attribute
2326 * as unknown if it wasn't already which allows
2327 * users to stick whatever they want in there as
2328 * a value.
2329 */
2330 if (fr_sbuff_adv_past_strcase_literal(&our_name, "raw.")) {
2331 my_attr_rules = *at_rules;
2332 my_attr_rules.allow_oid = true;
2333 at_rules = &my_attr_rules;
2334
2335 is_raw = true;
2336 }
2337
2338 /*
2339 * Parse one or more request references
2340 */
2341 ret = tmpl_request_ref_list_from_substr(vpt, err,
2342 &vpt->data.attribute.rr,
2343 &our_name,
2344 t_rules,
2345 &namespace);
2346 if (ret < 0) {
2347 error:
2348 *out = NULL;
2349 talloc_free(vpt);
2350 FR_SBUFF_ERROR_RETURN(&our_name);
2351 }
2352
2353 fr_sbuff_marker(&m_l, &our_name);
2354
2355 /*
2356 * Parse the list and / or attribute reference
2357 */
2358 ret = tmpl_attr_afrom_attr_substr(vpt, err,
2359 vpt,
2360 namespace, namespace,
2361 &our_name, p_rules, at_rules, 0);
2362 if (ret < 0) goto error;
2363
2364 if (!tmpl_substr_terminal_check(&our_name, p_rules)) {
2365 fr_strerror_const("Unexpected text after attribute reference");
2366 if (err) *err = TMPL_ATTR_ERROR_MISSING_TERMINATOR;
2367 goto error;
2368 }
2369
2370 /*
2371 * Check whether the tmpl has a list qualifier.
2372 */
2373 switch (at_rules->list_presence) {
2374 case TMPL_ATTR_LIST_ALLOW:
2375 break;
2376
2377 case TMPL_ATTR_LIST_FORBID:
2378 if (tmpl_attr_is_list_attr(tmpl_attr_list_head(tmpl_attr(vpt)))) {
2379 fr_strerror_const("List qualifiers are not allowed here.");
2380 if (err) *err = TMPL_ATTR_ERROR_LIST_NOT_ALLOWED;
2381 goto error;
2382 }
2383 break;
2384
2385 case TMPL_ATTR_LIST_REQUIRE:
2386 if (!tmpl_attr_is_list_attr(tmpl_attr_list_head(tmpl_attr(vpt)))) {
2387 fr_strerror_const("List qualifier is required, but no list was found.");
2388 if (err) *err = TMPL_ATTR_ERROR_LIST_MISSING;
2389 goto error;
2390 }
2391 break;
2392 }
2393
2394 tmpl_set_name(vpt, T_BARE_WORD, fr_sbuff_start(&our_name), fr_sbuff_used(&our_name));
2395 vpt->rules = *t_rules; /* Record the rules */
2396
2397 /*
2398 * Check to see if the user wants the leaf
2399 * attribute to be raw.
2400 *
2401 * We can only do the conversion now _if_
2402 * the complete hierarchy has been resolved
2403 * otherwise we'll need to do the conversion
2404 * later.
2405 */
2406 if (tmpl_is_attr(vpt)) {
2407 tmpl_attr_t *ar = tmpl_attr_list_head(tmpl_attr(vpt));
2408 bool is_local = ar->ar_da->flags.local;
2409 bool allow_local = is_local;
2410
2411 /*
2412 * Convert known attributes to raw ones if requested.
2413 */
2414 if (is_raw) {
2415 /*
2416 * Local variables cannot be raw.
2417 */
2418 if (is_local) {
2419 fr_strerror_printf("Local attributes cannot be 'raw'");
2420 if (err) *err = TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED;
2421 fr_sbuff_set(&our_name, &m_l);
2422 goto error;
2423 }
2424 ret = attr_to_raw(vpt, tmpl_attr_list_tail(tmpl_attr(vpt)));
2425 if (ret < 0) goto error;
2426 }
2427
2428 /*
2429 * We can transition from local to non-local, but not the other way around.
2430 */
2431 for (;
2432 ar != NULL;
2433 ar = tmpl_attr_list_next(tmpl_attr(vpt), ar)) {
2434 if (ar->ar_da->flags.local == allow_local) continue;
2435
2436 if (!ar->ar_da->flags.local && allow_local) {
2437 allow_local = false;
2438 continue;
2439 }
2440
2441 if (ar->ar_da->flags.local) {
2442 fr_strerror_printf("Local attributes cannot be used in any list");
2443 if (err) *err = TMPL_ATTR_ERROR_FOREIGN_NOT_ALLOWED;
2444 fr_sbuff_set(&our_name, &m_l);
2445 goto error;
2446 }
2447 }
2448
2449 /*
2450 * Local variables are named "foo", but are always put into the local list.
2451 *
2452 * We add the list after checking for non-local -> local transition, as
2453 * request_attr_local isn't a local attribute.
2454 *
2455 * When the list is forbidden, we're creating a local attribute inside of a local
2456 * TLV.
2457 */
2458 if (is_local && (at_rules->list_presence != TMPL_ATTR_LIST_FORBID)) {
2459 MEM(ar = talloc(vpt, tmpl_attr_t));
2460 *ar = (tmpl_attr_t){
2461 .ar_type = TMPL_ATTR_TYPE_NORMAL,
2462 .ar_da = request_attr_local,
2463 .ar_parent = fr_dict_root(fr_dict_internal())
2464 };
2465
2466 /*
2467 * Prepend the local list ref so it gets evaluated
2468 * first.
2469 */
2470 tmpl_attr_list_insert_head(tmpl_attr(vpt), ar);
2471 }
2472 }
2473
2474 /*
2475 * If a list wasn't already specified, then add one now.
2476 */
2477 if (!tmpl_attr_is_list_attr(tmpl_attr_list_head(tmpl_attr(vpt)))) {
2478 tmpl_attr_t *ar;
2479
2480 MEM(ar = talloc(vpt, tmpl_attr_t));
2481 *ar = (tmpl_attr_t){
2482 .ar_type = TMPL_ATTR_TYPE_NORMAL,
2483 .ar_parent = fr_dict_root(fr_dict_internal())
2484 };
2485
2486 fr_assert(at_rules->list_def);
2487 ar->ar_da = at_rules->list_def;
2488
2489 /*
2490 * Prepend the list ref so it gets evaluated
2491 * first.
2492 */
2493 tmpl_attr_list_insert_head(tmpl_attr(vpt), ar);
2494 }
2495
2496 /*
2497 * If there is a default request (parent, outer, etc.), add it to the ar list.
2498 *
2499 * A NULL request_def pointer is equivalent to the current request.
2500 */
2501 if (t_rules->attr.request_def) {
2502 tmpl_request_ref_list_acopy(vpt, &vpt->rules.attr.request_def, t_rules->attr.request_def);
2503 }
2504
2505 /*
2506 * Now that all of the lists are set correctly, do some final validation and updates on the
2507 * attribute.
2508 */
2509 if (tmpl_is_attr(vpt)) {
2510 tmpl_attr_t *ar;
2511
2512 /*
2513 * Ensure that the list is set correctly, so that the returned vpt doesn't just
2514 * match the input rules, it is also internally consistent.
2515 */
2516 ar = tmpl_attr_list_head(tmpl_attr(vpt));
2517 fr_assert(ar != NULL);
2518
2519 if (tmpl_attr_is_list_attr(ar)) vpt->rules.attr.list_def = ar->ar_da;
2520
2521 if (tmpl_attr_tail_is_normal(vpt)) {
2522 /*
2523 * Suppress useless casts.
2524 */
2525 if (tmpl_attr_tail_da(vpt)->type == tmpl_rules_cast(vpt)) {
2526 vpt->rules.cast = FR_TYPE_NULL;
2527 }
2528
2529 /*
2530 * Check if the cast is allowed. This lets us give better errors at compile time.
2531 */
2532 if ((tmpl_rules_cast(vpt)!= FR_TYPE_NULL) &&
2533 !fr_type_cast(tmpl_rules_cast(vpt), tmpl_attr_tail_da(vpt)->type)) {
2534 fr_strerror_printf("Cannot cast type '%s' to '%s'",
2535 fr_type_to_str(tmpl_attr_tail_da(vpt)->type), fr_type_to_str(t_rules->cast));
2536 if (err) *err = TMPL_ATTR_ERROR_BAD_CAST;
2537 fr_sbuff_set_to_start(&our_name);
2538 goto error;
2539 }
2540 }
2541 }
2542
2543 TMPL_VERIFY(vpt); /* Because we want to ensure we produced something sane */
2544
2545 *out = vpt;
2546 FR_SBUFF_SET_RETURN(name, &our_name);
2547}
2548
2549/** Parse a string into a TMPL_TYPE_ATTR_* type #tmpl_t
2550 *
2551 * @param[in,out] ctx to allocate #tmpl_t in.
2552 * @param[out] err May be NULL. Provides the exact error that the parser hit
2553 * when processing the attribute ref.
2554 * @param[out] out Where to write pointer to new #tmpl_t.
2555 * @param[in] name of attribute including #tmpl_request_ref_t and #fr_pair_list_t qualifiers.
2556 * @param[in] t_rules Rules which control parsing. See tmpl_afrom_attr_substr() for details.
2557 *
2558 * @note Unlike #tmpl_afrom_attr_substr this function will error out if the entire
2559 * name string isn't parsed.
2560 */
2561ssize_t tmpl_afrom_attr_str(TALLOC_CTX *ctx, tmpl_attr_error_t *err,
2562 tmpl_t **out, char const *name, tmpl_rules_t const *t_rules)
2563{
2564 ssize_t slen, name_len;
2565 DEFAULT_RULES;
2566
2567 CHECK_T_RULES;
2568
2569 name_len = strlen(name);
2570 slen = tmpl_afrom_attr_substr(ctx, err, out, &FR_SBUFF_IN(name, name_len), NULL, t_rules);
2571 if (slen <= 0) return slen;
2572
2573 if (!fr_cond_assert(*out)) return -1;
2574
2575 if (slen != name_len) {
2576 /* This looks wrong, but it produces meaningful errors for unknown attrs */
2577 fr_strerror_printf("Unexpected text after %s",
2578 tmpl_type_to_str((*out)->type));
2579 return -slen;
2580 }
2581
2582 TMPL_VERIFY(*out);
2583
2584 return slen;
2585}
2586
2587/** Create TMPL_TYPE_DATA from a string
2588 *
2589 * @param[in] ctx to allocate tmpl to.
2590 * @param[out] out where to write tmpl.
2591 * @param[in] in sbuff to parse.
2592 * @param[in] quote surrounding the operand to parse.
2593 * @param[in] t_rules specifying the cast and any enumeration values.
2594 * @param[in] allow_enum Whether parsing the value as an enum should be allowed.
2595 * @param[in] p_rules formatting rules.
2596 * @return
2597 * - <0 on error
2598 * - >=0 on success.
2599 */
2600static fr_slen_t tmpl_afrom_value_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2601 fr_token_t quote,
2602 tmpl_rules_t const *t_rules, bool allow_enum,
2603 fr_sbuff_parse_rules_t const *p_rules)
2604{
2605 fr_sbuff_t our_in = FR_SBUFF(in);
2606 fr_value_box_t tmp;
2607 tmpl_t *vpt;
2608 fr_type_t cast = FR_TYPE_STRING;
2609
2610 if (!fr_type_is_null(t_rules->cast)) cast = t_rules->cast;
2611
2612 if (!fr_type_is_leaf(cast)) {
2613 fr_strerror_printf("%s is not a valid cast type",
2614 fr_type_to_str(cast));
2615 FR_SBUFF_ERROR_RETURN(&our_in);
2616 }
2617
2618 vpt = tmpl_alloc_null(ctx);
2619 if (fr_value_box_from_substr(vpt, &tmp,
2620 cast, allow_enum ? t_rules->enumv : NULL,
2621 &our_in, p_rules) < 0) {
2622 talloc_free(vpt);
2623 FR_SBUFF_ERROR_RETURN(&our_in);
2624 }
2625 fr_value_box_mark_safe_for(&tmp, t_rules->literals_safe_for);
2626
2627 tmpl_init(vpt, TMPL_TYPE_DATA, quote, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in), t_rules);
2628
2629 fr_value_box_copy_shallow(NULL, tmpl_value(vpt), &tmp);
2630
2631 *out = vpt;
2632
2633 if (cast == tmpl_value_type(vpt)) vpt->rules.cast = FR_TYPE_NULL;
2634
2635 TMPL_VERIFY(vpt);
2636
2637 FR_SBUFF_SET_RETURN(in, &our_in);
2638}
2639
2640/** Match the bareword `null` and return a TMPL_TYPE_DATA carrying an FR_TYPE_NULL box
2641 *
2642 * Used as an explicit "no value" placeholder by callers that want the
2643 * argument slot to remain present (so positional xlat arguments line
2644 * up) without carrying any bytes. Downstream code distinguishes an
2645 * intentional null from an uninitialised one by checking
2646 * `fr_type_is_null(vb->type)` after the box has made it into an arg
2647 * list - if it reaches the xlat body, the author put it there.
2648 *
2649 * @param[in] ctx to allocate tmpl to.
2650 * @param[out] out where to write tmpl.
2651 * @param[in] in sbuff to parse.
2652 * @param[in] p_rules formatting rules.
2653 * @return
2654 * - 0 sbuff does not contain the `null` keyword.
2655 * - > 0 how many bytes were parsed.
2656 */
2657static fr_slen_t tmpl_afrom_null_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2658 fr_sbuff_parse_rules_t const *p_rules)
2659{
2660 fr_sbuff_t our_in = FR_SBUFF(in);
2661 tmpl_t *vpt;
2662
2663 if (!fr_sbuff_adv_past_strcase_literal(&our_in, "null")) return 0;
2664 if (!tmpl_substr_terminal_check(&our_in, p_rules)) return 0;
2665
2666 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA, T_BARE_WORD,
2667 fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
2668 fr_value_box_init(&vpt->data.literal, FR_TYPE_NULL, NULL, false);
2669
2670 *out = vpt;
2671
2672 FR_SBUFF_SET_RETURN(in, &our_in);
2673}
2674
2675/** Parse a truth value
2676 *
2677 * @param[in] ctx to allocate tmpl to.
2678 * @param[out] out where to write tmpl.
2679 * @param[in] in sbuff to parse.
2680 * @param[in] p_rules formatting rules.
2681 * @return
2682 * - < 0 sbuff does not contain a boolean value.
2683 * - > 0 how many bytes were parsed.
2684 */
2685static fr_slen_t tmpl_afrom_bool_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2686 fr_sbuff_parse_rules_t const *p_rules)
2687{
2688 fr_sbuff_t our_in = FR_SBUFF(in);
2689 bool a_bool;
2690 tmpl_t *vpt;
2691
2692 if (fr_sbuff_out(NULL, &a_bool, &our_in) < 0) {
2693 fr_strerror_const("Not a boolean value");
2694 return 0;
2695 }
2696
2697 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
2698 fr_strerror_const("Unexpected text after bool");
2699 FR_SBUFF_ERROR_RETURN(&our_in);
2700 }
2701
2702 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA, T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
2703
2704 fr_value_box_init(&vpt->data.literal, FR_TYPE_BOOL, NULL, false);
2705 vpt->data.literal.vb_bool = a_bool;
2706
2707 *out = vpt;
2708
2709 FR_SBUFF_SET_RETURN(in, &our_in);
2710}
2711
2712/** Parse bareword as an octet string
2713 *
2714 * @param[in] ctx to allocate tmpl to.
2715 * @param[out] out where to write tmpl.
2716 * @param[in] in sbuff to parse.
2717 * @param[in] p_rules formatting rules.
2718 * @return
2719 * - < 0 negative offset where parse error occurred.
2720 * - 0 sbuff does not contain a hex string.
2721 * - > 0 how many bytes were parsed.
2722 */
2723static fr_slen_t tmpl_afrom_octets_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2724 fr_sbuff_parse_rules_t const *p_rules)
2725{
2726 fr_sbuff_t our_in = FR_SBUFF(in);
2727 tmpl_t *vpt;
2728 char *hex;
2729 size_t binlen, len;
2730 uint8_t *bin;
2731
2732 if (!fr_sbuff_adv_past_strcase_literal(&our_in, "0x")) return 0;
2733
2734 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA, T_BARE_WORD, NULL, 0));
2735
2736 /*
2737 * This allows stream parsing to work correctly
2738 * we could be less lazy and copy hex data in
2739 * chunks, but never mind...
2740 */
2741 len = fr_sbuff_out_abstrncpy_allowed(vpt, &hex, &our_in, SIZE_MAX, sbuff_char_class_hex);
2742 if (len & 0x01) {
2743 fr_strerror_const("Hex string not even length");
2744 error:
2745 talloc_free(vpt);
2746 FR_SBUFF_ERROR_RETURN(&our_in);
2747 }
2748 if (len == 0) {
2749 fr_strerror_const("Zero length hex string is invalid");
2750 goto error;
2751 }
2752
2753 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
2754 fr_strerror_const("Unexpected text after hex string");
2755 goto error;
2756 }
2757
2758 bin = (uint8_t *)hex;
2759 binlen = len / 2;
2760
2761 tmpl_set_name(vpt, T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in));
2762
2763 (void)fr_base16_decode(NULL, &FR_DBUFF_TMP(bin, binlen), &FR_SBUFF_IN(hex, len), false);
2764 MEM(bin = talloc_realloc_size(vpt, bin, binlen)); /* Realloc to the correct length */
2765 (void)fr_value_box_memdup_shallow(&vpt->data.literal, NULL, bin, binlen, false);
2766
2767 *out = vpt;
2768
2769 FR_SBUFF_SET_RETURN(in, &our_in);
2770}
2771
2772/** Parse bareword as an IPv4 address or prefix
2773 *
2774 * @param[in] ctx to allocate tmpl to.
2775 * @param[out] out where to write tmpl.
2776 * @param[in] in sbuff to parse.
2777 * @param[in] p_rules formatting rules.
2778 * @return
2779 * - < 0 sbuff does not contain an IPv4 address or prefix.
2780 * - > 0 how many bytes were parsed.
2781 */
2782static fr_slen_t tmpl_afrom_ipv4_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2783 fr_sbuff_parse_rules_t const *p_rules)
2784{
2785 tmpl_t *vpt;
2786 fr_sbuff_t our_in = FR_SBUFF(in);
2787 fr_type_t type;
2788 int count;
2789 uint32_t ipaddr;
2790 uint8_t addr[4] = {}, prefix = 32;
2791
2792 for (count = 0; count < 4; count++) {
2793 if (!fr_sbuff_out(NULL, &addr[count], &our_in)) FR_SBUFF_ERROR_RETURN(&our_in);
2794
2795 if (count == 3) break;
2796
2797 if (fr_sbuff_next_if_char(&our_in, '.')) continue;
2798
2799 if (!fr_sbuff_is_char(&our_in, '/')) FR_SBUFF_ERROR_RETURN(&our_in);
2800 }
2801
2802 /*
2803 * If it has a trailing '/' then it's an IP prefix.
2804 */
2805 if (fr_sbuff_next_if_char(&our_in, '/')) {
2806 if (fr_sbuff_out(NULL, &prefix, &our_in) < 0) {
2807 fr_strerror_const("IPv4 CIDR mask malformed");
2808 FR_SBUFF_ERROR_RETURN(&our_in);
2809 }
2810
2811 if (prefix > 32) {
2812 fr_strerror_const("IPv4 CIDR mask too high");
2813 FR_SBUFF_ERROR_RETURN(&our_in);
2814 }
2815
2816 type = FR_TYPE_IPV4_PREFIX;
2817 } else {
2818 type = FR_TYPE_IPV4_ADDR;
2819 }
2820
2821 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
2822 fr_strerror_const("Unexpected text after IPv4 string or prefix");
2823 FR_SBUFF_ERROR_RETURN(&our_in);
2824 }
2825
2826 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA, T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
2827 fr_value_box_init(&vpt->data.literal, type, NULL, false);
2828 vpt->data.literal.vb_ip.af = AF_INET;
2829 vpt->data.literal.vb_ip.prefix = prefix;
2830
2831 /*
2832 * Zero out lower bits
2833 */
2834 ipaddr = (((uint32_t) addr[0]) << 24) | (((uint32_t) addr[1]) << 16) | (((uint32_t) addr[2]) << 8) | addr[3];
2835 if (prefix == 0) {
2836 ipaddr = 0;
2837
2838 } else if (prefix < 32) {
2839 ipaddr &= ~((uint32_t) 0) << (32 - prefix);
2840 }
2841 vpt->data.literal.vb_ipv4addr = htonl(ipaddr);
2842
2843 *out = vpt;
2844
2845 FR_SBUFF_SET_RETURN(in, &our_in);
2846}
2847
2848/** Parse bareword as an IPv6 address or prefix
2849 *
2850 * @param[in] ctx to allocate tmpl to.
2851 * @param[out] out where to write tmpl.
2852 * @param[in] in sbuff to parse.
2853 * @param[in] p_rules formatting rules.
2854 * @return
2855 * - < 0 sbuff does not contain an IPv6 address or prefix.
2856 * - > 0 how many bytes were parsed.
2857 */
2858static fr_slen_t tmpl_afrom_ipv6_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2859 fr_sbuff_parse_rules_t const *p_rules)
2860{
2861 tmpl_t *vpt;
2862 fr_sbuff_t our_in = FR_SBUFF(in);
2863 fr_sbuff_marker_t m;
2864 fr_type_t type;
2865 size_t len;
2866 char *sep_a, *sep_b;
2867
2868 static const bool ipv6_chars[SBUFF_CHAR_CLASS] = {
2869 ['0'] = true, ['1'] = true, ['2'] = true, ['3'] = true, ['4'] = true,
2870 ['5'] = true, ['6'] = true, ['7'] = true, ['8'] = true, ['9'] = true,
2871 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true,
2872 ['f'] = true,
2873 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true,
2874 ['F'] = true,
2875 [':'] = true, ['.'] = true
2876 };
2877
2878 /*
2879 * Drop a marker to pin the start of the
2880 * address in the buffer.
2881 */
2882 fr_sbuff_marker(&m, &our_in);
2883
2884 /*
2885 * Check for something looking like an IPv6 address
2886 *
2887 * Minimum string is '::'
2888 */
2889 len = fr_sbuff_adv_past_allowed(&our_in, FR_IPADDR_STRLEN + 1, ipv6_chars, NULL);
2890 if ((len < 2) || (len > FR_IPADDR_STRLEN)) {
2891 error:
2892 FR_SBUFF_ERROR_RETURN(&our_in);
2893 }
2894
2895 /*
2896 * Got ':' after '.', this isn't allowed.
2897 *
2898 * We need this check else IPv4 gets parsed
2899 * as blank IPv6 address.
2900 */
2901 sep_a = memchr(fr_sbuff_current(&m), '.', len);
2902 if (sep_a && (!(sep_b = memchr(fr_sbuff_current(&m), ':', len)) || (sep_b > sep_a))) {
2903 fr_strerror_const("First IPv6 component separator was a '.'");
2904 goto error;
2905 }
2906
2907 /*
2908 * The v6 parse function will happily turn
2909 * integers into v6 addresses *sigh*.
2910 */
2911 sep_a = memchr(fr_sbuff_current(&m), ':', len);
2912 if (!sep_a) {
2913 fr_strerror_const("No IPv6 component separator");
2914 goto error;
2915 }
2916
2917 /*
2918 * Handle scope
2919 */
2920 if (fr_sbuff_next_if_char(&our_in, '%')) {
2921 len = fr_sbuff_adv_until(&our_in, IFNAMSIZ + 1, p_rules ? p_rules->terminals : NULL, '\0');
2922 if ((len < 1) || (len > IFNAMSIZ)) {
2923 fr_strerror_const("IPv6 scope too long");
2924 goto error;
2925 }
2926 }
2927
2928 /*
2929 * ...and finally the prefix.
2930 */
2931 if (fr_sbuff_next_if_char(&our_in, '/')) {
2932 uint8_t mask;
2933
2934 if (fr_sbuff_out(NULL, &mask, &our_in) < 0) {
2935 fr_strerror_const("IPv6 CIDR mask malformed");
2936 goto error;
2937 }
2938 if (mask > 128) {
2939 fr_strerror_const("IPv6 CIDR mask too high");
2940 goto error;
2941 }
2942
2943 type = FR_TYPE_IPV6_PREFIX;
2944 } else {
2945 type = FR_TYPE_IPV6_ADDR;
2946 }
2947
2948 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
2949 fr_strerror_const("Unexpected text after IPv6 string or prefix");
2950 goto error;
2951 }
2952
2953 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA, T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
2954 if (fr_value_box_from_substr(vpt, &vpt->data.literal, type, NULL,
2955 &FR_SBUFF_REPARSE(&our_in),
2956 NULL) < 0) {
2957 talloc_free(vpt);
2958 goto error;
2959 }
2960 *out = vpt;
2961
2962 FR_SBUFF_SET_RETURN(in, &our_in);
2963}
2964
2965
2966/** Try and parse signed or unsigned integers
2967 *
2968 * @param[in] ctx to allocate tmpl to.
2969 * @param[out] out where to write tmpl.
2970 * @param[in] in sbuff to parse.
2971 * @param[in] p_rules formatting rules.
2972 * @return
2973 * - < 0 sbuff does not contain a mac address.
2974 * - > 0 how many bytes were parsed.
2975 */
2976static ssize_t tmpl_afrom_ether_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
2977 fr_sbuff_parse_rules_t const *p_rules)
2978{
2979 tmpl_t *vpt;
2980 fr_sbuff_t our_in = FR_SBUFF(in);
2981 uint8_t buff[6] = {};
2982 fr_dbuff_t dbuff;
2983 fr_value_box_t *vb;
2984 fr_sbuff_parse_error_t err;
2985
2986 fr_dbuff_init(&dbuff, buff, sizeof(buff));
2987
2988 fr_base16_decode(&err, &dbuff, &our_in, true);
2989 if (err != FR_SBUFF_PARSE_OK) return 0;
2990
2991 if (!fr_sbuff_next_if_char(&our_in, ':')) return 0;
2992
2993 fr_base16_decode(&err, &dbuff, &our_in, true);
2994 if (err != FR_SBUFF_PARSE_OK) return 0;
2995
2996 if (!fr_sbuff_next_if_char(&our_in, ':')) return 0;
2997
2998 fr_base16_decode(&err, &dbuff, &our_in, true);
2999 if (err != FR_SBUFF_PARSE_OK) return 0;
3000
3001 if (!fr_sbuff_next_if_char(&our_in, ':')) return 0;
3002
3003 fr_base16_decode(&err, &dbuff, &our_in, true);
3004 if (err != FR_SBUFF_PARSE_OK) return 0;
3005
3006 if (!fr_sbuff_next_if_char(&our_in, ':')) return 0;
3007
3008 fr_base16_decode(&err, &dbuff, &our_in, true);
3009 if (err != FR_SBUFF_PARSE_OK) return 0;
3010
3011 if (!fr_sbuff_next_if_char(&our_in, ':')) return 0;
3012
3013 fr_base16_decode(&err, &dbuff, &our_in, true);
3014 if (err != FR_SBUFF_PARSE_OK) return 0;
3015
3016 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
3017 fr_strerror_const("Unexpected text after mac address");
3018 return 0;
3019 }
3020
3021 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA,
3022 T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
3023 vb = tmpl_value(vpt);
3024
3025 fr_value_box_init(vb, FR_TYPE_ETHERNET, NULL, false);
3026 memcpy(vb->vb_ether, buff, sizeof(vb->vb_ether));
3027
3028 *out = vpt;
3029
3030 FR_SBUFF_SET_RETURN(in, &our_in);
3031}
3032
3033/** Try and parse signed or unsigned integers
3034 *
3035 * @param[in] ctx to allocate tmpl to.
3036 * @param[out] out where to write tmpl.
3037 * @param[in] in sbuff to parse.
3038 * @param[in] p_rules formatting rules.
3039 * @return
3040 * - < 0 sbuff does not contain an integer.
3041 * - > 0 how many bytes were parsed.
3042 */
3043static fr_slen_t tmpl_afrom_integer_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
3044 fr_sbuff_parse_rules_t const *p_rules)
3045{
3046 tmpl_t *vpt;
3047 fr_sbuff_t our_in = FR_SBUFF(in);
3048 ssize_t slen;
3049 fr_value_box_t *vb;
3050
3051 /*
3052 * Pick the narrowest signed type
3053 */
3054 if (fr_sbuff_is_char(&our_in, '-')) {
3055 int64_t a_int;
3056
3057 slen = fr_sbuff_out(NULL, &a_int, &our_in);
3058 if (slen <= 0) return 0;
3059
3060 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
3061 fr_strerror_const("Unexpected text after signed integer");
3062 error:
3063 FR_SBUFF_ERROR_RETURN(&our_in);
3064 }
3065
3066 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA,
3067 T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
3068 vb = tmpl_value(vpt);
3069 if (a_int >= INT8_MIN) {
3070 fr_value_box_init(vb, FR_TYPE_INT8, NULL, false);
3071 vb->vb_int8 = (int8_t)a_int;
3072 } else if (a_int >= INT16_MIN) {
3073 fr_value_box_init(vb, FR_TYPE_INT16, NULL, false);
3074 vb->vb_int16 = (int16_t)a_int;
3075 } else if (a_int >= INT32_MIN) {
3076 fr_value_box_init(vb, FR_TYPE_INT32, NULL, false);
3077 vb->vb_int32 = (int32_t)a_int;
3078 } else {
3079 fr_value_box_init(vb, FR_TYPE_INT64, NULL, false);
3080 vb->vb_int64 = (int64_t)a_int;
3081 }
3082 /*
3083 * Pick the narrowest unsigned type
3084 */
3085 } else {
3086 uint64_t a_uint;
3087
3088 slen = fr_sbuff_out(NULL, &a_uint, &our_in);
3089 if (slen <= 0) return slen;
3090
3091 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
3092 fr_strerror_const("Unexpected text after unsigned integer");
3093 goto error;
3094 }
3095
3096 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA,
3097 T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
3098 vb = tmpl_value(vpt);
3099 if (a_uint <= UINT8_MAX) {
3100 fr_value_box_init(vb, FR_TYPE_UINT8, NULL, false);
3101 vb->vb_uint8 = (uint8_t)a_uint;
3102 } else if (a_uint <= UINT16_MAX) {
3103 fr_value_box_init(vb, FR_TYPE_UINT16, NULL, false);
3104 vb->vb_uint16 = (uint16_t)a_uint;
3105 } else if (a_uint <= UINT32_MAX) {
3106 fr_value_box_init(vb, FR_TYPE_UINT32, NULL, false);
3107 vb->vb_uint32 = (uint32_t)a_uint;
3108 } else {
3109 fr_value_box_init(vb, FR_TYPE_UINT64, NULL, false);
3110 vb->vb_uint64 = (uint64_t)a_uint;
3111 }
3112 }
3113
3114 *out = vpt;
3115
3116 FR_SBUFF_SET_RETURN(in, &our_in);
3117}
3118
3119static ssize_t tmpl_afrom_float_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
3120 fr_sbuff_parse_rules_t const *p_rules)
3121{
3122 tmpl_t *vpt;
3123 fr_sbuff_t our_in = FR_SBUFF(in);
3124 double a_float;
3125 ssize_t slen;
3126 fr_value_box_t *vb;
3127
3128 slen = fr_sbuff_out(NULL, &a_float, &our_in);
3129 if (slen <= 0) return 0;
3130
3131 if (!tmpl_substr_terminal_check(&our_in, p_rules)) {
3132 fr_strerror_const("Unexpected text after float");
3133 FR_SBUFF_ERROR_RETURN(&our_in);
3134 }
3135
3136 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA,
3137 T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
3138 vb = tmpl_value(vpt);
3139 fr_value_box_init(vb, FR_TYPE_FLOAT64, NULL, false);
3140 vb->vb_float64 = a_float;
3141
3142 *out = vpt;
3143
3144 FR_SBUFF_SET_RETURN(in, &our_in);
3145}
3146
3147static ssize_t tmpl_afrom_time_delta(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
3148 fr_sbuff_parse_rules_t const *p_rules)
3149{
3150 tmpl_t *vpt;
3151 fr_sbuff_t our_in = FR_SBUFF(in);
3152 fr_time_delta_t a_delta;
3153 fr_slen_t slen;
3154 fr_value_box_t *vb;
3155
3156 slen = fr_time_delta_from_substr(&a_delta, &our_in, FR_TIME_RES_SEC, true, p_rules ? p_rules->terminals : NULL);
3157 if (slen <= 0) return 0;
3158
3159 MEM(vpt = tmpl_alloc(ctx, TMPL_TYPE_DATA,
3160 T_BARE_WORD, fr_sbuff_start(&our_in), fr_sbuff_used(&our_in)));
3161 vb = tmpl_value(vpt);
3162 fr_value_box_init(vb, FR_TYPE_TIME_DELTA, NULL, false);
3163 vb->vb_time_delta = a_delta;
3164
3165 *out = vpt;
3166
3167 FR_SBUFF_SET_RETURN(in, &our_in);
3168}
3169
3170/*
3171 * ::value
3172 *
3173 * Treated as enum name. Note that this check MUST be done after the test for IPv6, as
3174 * "::1" is an allowed IPv6 address.
3175 *
3176 * @todo - Mark this up as an enum name? Or do we really care? Maybe we want to allow
3177 *
3178 * Service-Type == 'Framed-User'
3179 *
3180 * or
3181 *
3182 * Service-Type == "Framed-User'
3183 *
3184 * as the second one allows for xlat expansions of enum names.
3185 *
3186 * We probably do want to forbid the single-quoted form of enums,
3187 * as that doesn't seem to make sense.
3188 *
3189 * We also need to distinguish unresolved bare words as enums
3190 * (with :: prefix) from unresolved attributes without an & prefix.
3191 */
3192static ssize_t tmpl_afrom_enum(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in,
3193 fr_sbuff_parse_rules_t const *p_rules,
3194 tmpl_rules_t const *t_rules)
3195{
3196 tmpl_t *vpt;
3197 fr_sbuff_parse_error_t sberr;
3198 fr_sbuff_t our_in = FR_SBUFF(in);
3199 fr_sbuff_t *enum_buff;
3200
3201 FR_SBUFF_TALLOC_THREAD_LOCAL(&enum_buff, 1024, SIZE_MAX);
3202
3203 /*
3204 * If there isn't a "::" prefix, then check for migration flags, and enum.
3205 *
3206 * If we require an enum prefix, then the input can't be an enum, and we don't do any more
3207 * parsing.
3208 *
3209 * Otherwise if there's no prefix and no enumv, we know this input can't be an enum name.
3210 */
3211 if (!fr_sbuff_adv_past_str_literal(&our_in, "::")) {
3212 return 0;
3213
3214 } else if (t_rules->enumv &&
3215 ((t_rules->enumv->type == FR_TYPE_IPV6_ADDR) ||
3216 ((t_rules->enumv->type == FR_TYPE_IPV6_PREFIX)))) {
3217
3218 /*
3219 * We can't have enumerated names for IPv6 addresses.
3220 *
3221 * @todo - allow them ONLY if the RHS string is a valid enum name.
3222 */
3223 return 0;
3224 }
3225
3226 /*
3227 * Need to store the value with the prefix, because the value box functions
3228 * expect it to be there...
3229 */
3230 fr_sbuff_in_strcpy_literal(enum_buff, "::");
3231
3232 vpt = tmpl_alloc_null(ctx);
3233
3234 /*
3235 * If it doesn't match any other type of bareword, parse it as an enum name.
3236 *
3237 * Note that we don't actually try to resolve the enum name. The caller is responsible
3238 * for doing that.
3239 */
3240 if (fr_dict_enum_name_from_substr(enum_buff, &sberr, &our_in, p_rules ? p_rules->terminals : NULL) < 0) {
3241 /*
3242 * Produce our own errors which make
3243 * more sense in the context of tmpls
3244 */
3245 switch (sberr) {
3246 case FR_SBUFF_PARSE_ERROR_NOT_FOUND:
3247 fr_strerror_const("No operand found. Expected &ref, literal, "
3248 "'quoted literal', \"%{expansion}\", or enum value");
3249 break;
3250
3251 case FR_SBUFF_PARSE_ERROR_FORMAT:
3252 fr_strerror_const("enum values must contain at least one alpha character");
3253 break;
3254
3255 default:
3256 fr_strerror_const("Unexpected text after enum value.");
3257 break;
3258 }
3259
3260 talloc_free(vpt);
3261 FR_SBUFF_ERROR_RETURN(&our_in);
3262 }
3263
3264 /*
3265 * If there's a valid enum name, then we use it. Otherwise we leave name resolution to run time.
3266 */
3267 if (t_rules->enumv) {
3268 fr_dict_enum_value_t const *dv;
3269
3270 dv = fr_dict_enum_by_name(t_rules->enumv, fr_sbuff_start(enum_buff), fr_sbuff_used(enum_buff));
3271 if (dv) {
3272 tmpl_init(vpt, TMPL_TYPE_DATA, T_BARE_WORD,
3273 fr_sbuff_start(&our_in), fr_sbuff_used(&our_in), t_rules);
3274 if (unlikely(fr_value_box_copy(vpt, &vpt->data.literal, dv->value) < 0)) {
3275 talloc_free(vpt);
3276 return -1;
3277 }
3278 vpt->data.literal.enumv = t_rules->enumv;
3279
3280 *out = vpt;
3281 FR_SBUFF_SET_RETURN(in, &our_in);
3282 }
3283 }
3284
3285 /*
3286 * Either there's no enum, or the enum name didn't match one of the listed ones. There's no
3287 * point in waiting for an enum which might be declared later. That's not possible, so we fall
3288 * back to parsing the various data types.
3289 */
3290 if (t_rules->at_runtime) return 0;
3291
3292 tmpl_init(vpt, TMPL_TYPE_DATA_UNRESOLVED, T_BARE_WORD,
3293 fr_sbuff_start(&our_in), fr_sbuff_used(&our_in), t_rules);
3294 MEM(vpt->data.unescaped = talloc_bstrndup(vpt, fr_sbuff_start(enum_buff), fr_sbuff_used(enum_buff)));
3295 *out = vpt;
3296
3297 FR_SBUFF_SET_RETURN(in, &our_in);
3298}
3299
3300/** Convert an arbitrary string into a #tmpl_t
3301 *
3302 * @note Unlike #tmpl_afrom_attr_str return code 0 doesn't necessarily indicate failure,
3303 * may just mean a 0 length string was parsed. Check to see if the function emitted
3304 * a #tmpl_t in *out.
3305 *
3306 * @note xlats and regexes are left uncompiled. This is to support the two pass parsing
3307 * done by the modcall code. Compilation on pass1 of that code could fail, as
3308 * attributes or xlat functions registered by modules may not be available (yet).
3309 *
3310 * @note For details of attribute parsing see #tmpl_afrom_attr_substr.
3311 *
3312 * @param[in,out] ctx To allocate #tmpl_t in.
3313 * @param[out] out Where to write the pointer to the new #tmpl_t.
3314 * @param[in] in String to parse.
3315 * @param[in] quote Quoting around the tmpl. Determines what we
3316 * attempt to parse the string as.
3317 * @param[in] p_rules Formatting rules for the tmpl.
3318 * @param[in] t_rules Validation rules for attribute references.
3319 * @return
3320 * - < 0 on error (offset as negative integer)
3321 * - >= 0 on success (number of bytes parsed).
3322 *
3323 * @see REMARKER to produce pretty error markers from the return value.
3324 *
3325 * @see tmpl_afrom_attr_substr
3326 */
3327fr_slen_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out,
3328 fr_sbuff_t *in, fr_token_t quote,
3329 fr_sbuff_parse_rules_t const *p_rules,
3330 tmpl_rules_t const *t_rules)
3331{
3332 fr_sbuff_t our_in = FR_SBUFF(in);
3333
3334 fr_slen_t slen;
3335 fr_sbuff_parse_error_t sberr;
3336 char *str;
3337
3338 tmpl_t *vpt = NULL;
3339 DEFAULT_RULES;
3340
3341 CHECK_T_RULES;
3342
3343 *out = NULL;
3344
3345 switch (quote) {
3346 case T_BARE_WORD:
3347 /*
3348 * Skip other bareword types if
3349 * we find a '&' prefix.
3350 */
3351 if (fr_sbuff_is_char(&our_in, '&')) return tmpl_afrom_attr_substr(ctx, NULL, out, in,
3352 p_rules, t_rules);
3353
3354 /*
3355 * Allow bareword xlats if we
3356 * find a '%' prefix.
3357 */
3358 if (fr_sbuff_is_char(&our_in, '%')) {
3359 tmpl_type_t type = TMPL_TYPE_XLAT;
3360 xlat_exp_head_t *head = NULL;
3361
3362 vpt = tmpl_alloc_null(ctx);
3363 slen = xlat_tokenize(vpt, &head, &our_in, p_rules, t_rules);
3364 if (slen <= 0) FR_SBUFF_ERROR_RETURN(&our_in);
3365
3366 if (xlat_needs_resolving(head)) {
3367 UNRESOLVED_SET(&type);
3368 goto set_tmpl;
3369
3370 } else if (fr_dlist_num_elements(&head->dlist) == 1) {
3371 xlat_exp_t *node = xlat_exp_head(head);
3372 tmpl_t *hoisted;
3373
3374 if (node->type != XLAT_TMPL) goto set_tmpl;
3375
3376 /*
3377 * We were asked to parse a tmpl. But it turned out to be an xlat %{...}
3378 *
3379 * If that xlat is identically a tmpl such as %{User-Name}, then we just
3380 * hoist the tmpl to this node. Otherwise at run time, we will have an
3381 * extra bounce through the xlat code, for no real reason.
3382 */
3383 hoisted = node->vpt;
3384
3385 (void) talloc_steal(ctx, hoisted);
3386 talloc_free(vpt);
3387 vpt = hoisted;
3388
3389 } else {
3390 set_tmpl:
3391 tmpl_init(vpt, type, quote, fr_sbuff_start(&our_in), slen, t_rules);
3392 vpt->data.xlat.ex = head;
3393 }
3394
3395 *out = vpt;
3396
3397 TMPL_VERIFY(vpt);
3398
3399 FR_SBUFF_SET_RETURN(in, &our_in);
3400 }
3401
3402 /*
3403 * Deal with explicit casts...
3404 */
3405 if (!fr_type_is_null(t_rules->cast)) {
3406 slen = tmpl_afrom_value_substr(ctx, out, in, quote, t_rules, true, p_rules);
3407
3408 /*
3409 * If the string doesn't cast to the destination type
3410 * parse it as an attribute.
3411 */
3412 if (slen < 0) return tmpl_afrom_attr_substr(ctx, NULL, out, in, p_rules, t_rules);
3413 return slen;
3414 }
3415
3416 /*
3417 * We're at runtime and have a data type. Just parse it as that data type, without doing
3418 * endless "maybe it's this thing" attempts.
3419 */
3420 if (t_rules->at_runtime && t_rules->enumv) {
3421 tmpl_rules_t my_t_rules = *t_rules;
3422
3423 fr_assert(fr_type_is_leaf(t_rules->enumv->type));
3424
3425 my_t_rules.cast = my_t_rules.enumv->type;
3426
3427 return tmpl_afrom_value_substr(ctx, out, in, quote, &my_t_rules, true, p_rules);
3428 }
3429
3430 /*
3431 * Prefer enum names to IPv6 addresses.
3432 */
3433 if (t_rules->enumv && fr_sbuff_is_str_literal(&our_in, "::")) {
3434 slen = tmpl_afrom_enum(ctx, out, &our_in, p_rules, t_rules);
3435 if (slen > 0) goto done_bareword;
3436 fr_assert(!*out);
3437 }
3438
3439 /*
3440 * See if it's the `null` keyword. Matched before the
3441 * numeric / address / enum branches so it isn't
3442 * shadowed by a dictionary attribute literally named
3443 * "null".
3444 */
3445 slen = tmpl_afrom_null_substr(ctx, out, &our_in, p_rules);
3446 if (slen > 0) goto done_bareword;
3447 fr_assert(!*out);
3448
3449 /*
3450 * See if it's a boolean value
3451 */
3452 slen = tmpl_afrom_bool_substr(ctx, out, &our_in, p_rules);
3453 if (slen > 0) {
3454 done_bareword:
3455 TMPL_VERIFY(*out);
3456
3457 FR_SBUFF_SET_RETURN(in, &our_in);
3458 }
3459 fr_assert(!*out);
3460
3461 /*
3462 * See if it's an octets string
3463 */
3464 slen = tmpl_afrom_octets_substr(ctx, out, &our_in, p_rules);
3465 if (slen > 0) goto done_bareword;
3466 fr_assert(!*out);
3467
3468 /*
3469 * See if it's a mac address
3470 *
3471 * Needs to be before IPv6 as the pton functions
3472 * are too greedy, and on macOS will happily
3473 * convert a mac address to an IPv6 address.
3474 */
3475 slen = tmpl_afrom_ether_substr(ctx, out, &our_in, p_rules);
3476 if (slen > 0) goto done_bareword;
3477 fr_assert(!*out);
3478
3479 /*
3480 * See if it's an IPv4 address or prefix
3481 */
3482 slen = tmpl_afrom_ipv4_substr(ctx, out, &our_in, p_rules);
3483 if (slen > 0) goto done_bareword;
3484 fr_assert(!*out);
3485
3486 /*
3487 * See if it's an IPv6 address or prefix
3488 */
3489 slen = tmpl_afrom_ipv6_substr(ctx, out, &our_in, p_rules);
3490 if (slen > 0) goto done_bareword;
3491 fr_assert(!*out);
3492
3493 slen = tmpl_afrom_enum(ctx, out, &our_in, p_rules, t_rules);
3494 if (slen > 0) goto done_bareword;
3495 fr_assert(!*out);
3496
3497 /*
3498 * See if it's a integer
3499 */
3500 slen = tmpl_afrom_integer_substr(ctx, out, &our_in, p_rules);
3501 if (slen > 0) goto done_bareword;
3502 fr_assert(!*out);
3503
3504 /*
3505 * See if it's a float
3506 */
3507 slen = tmpl_afrom_float_substr(ctx, out, &our_in, p_rules);
3508 if (slen > 0) goto done_bareword;
3509 fr_assert(!*out);
3510
3511 /*
3512 * See if it's a time delta
3513 *
3514 * We do this after floats and integers so that
3515 * they get parsed as integer and float types
3516 * and not time deltas.
3517 */
3518 slen = tmpl_afrom_time_delta(ctx, out, &our_in, p_rules);
3519 if (slen > 0) goto done_bareword;
3520 fr_assert(!*out);
3521
3522 /*
3523 * See if it's an attribute reference
3524 * without the prefix.
3525 */
3526 slen = tmpl_afrom_attr_substr(ctx, NULL, out, &our_in, p_rules, t_rules);
3527 if (slen > 0) goto done_bareword;
3528 fr_assert(!*out);
3529
3530 /*
3531 * We can't parse it as anything, that's an error.
3532 *
3533 * But it may be an enumeration value for an
3534 * attribute which is loaded later. In which
3535 * case we allow parsing the enumeration.
3536 */
3537 if (!fr_sbuff_is_str_literal(&our_in, "::")) {
3538 /*
3539 * Return the error string from parsing the attribute!
3540 */
3541 FR_SBUFF_ERROR_RETURN(&our_in);
3542 }
3543
3544 /*
3545 * Attempt to resolve enumeration values
3546 */
3547 vpt = tmpl_alloc_null(ctx);
3548
3549 /*
3550 * If it doesn't match any other type of bareword, parse it as an enum name.
3551 *
3552 * Note that we don't actually try to resolve the enum name. The caller is responsible
3553 * for doing that.
3554 */
3555 if (fr_dict_enum_name_afrom_substr(vpt, &str, &sberr, &our_in, p_rules ? p_rules->terminals : NULL) < 0) {
3556 /*
3557 * Produce our own errors which make
3558 * more sense in the context of tmpls
3559 */
3560 switch (sberr) {
3561 case FR_SBUFF_PARSE_ERROR_NOT_FOUND:
3562 fr_strerror_const("No operand found. Expected &ref, literal, "
3563 "'quoted literal', \"%{expansion}\", or enum value");
3564 break;
3565
3566 case FR_SBUFF_PARSE_ERROR_FORMAT:
3567 fr_strerror_const("enum values must contain at least one alpha character");
3568 break;
3569
3570 default:
3571 fr_strerror_const("Unexpected text after enum value.");
3572 break;
3573 }
3574
3575 talloc_free(vpt);
3576 FR_SBUFF_ERROR_RETURN(&our_in);
3577 }
3578
3579 tmpl_init(vpt, TMPL_TYPE_DATA_UNRESOLVED, quote,
3580 fr_sbuff_start(&our_in), fr_sbuff_used(&our_in), t_rules);
3581 vpt->data.unescaped = str;
3582 *out = vpt;
3583
3584 FR_SBUFF_SET_RETURN(in, &our_in);
3585
3586 case T_SINGLE_QUOTED_STRING:
3587 /*
3588 * Single quoted strings can be cast
3589 * to a specific data type immediately
3590 * as they cannot contain expansions.
3591 */
3592 if (!fr_type_is_null(t_rules->cast)) return tmpl_afrom_value_substr(ctx, out, in, quote,
3593 t_rules, false,
3594 p_rules);
3595 vpt = tmpl_alloc_null(ctx);
3596 slen = fr_sbuff_out_aunescape_until(vpt, &str, &our_in, SIZE_MAX,
3597 p_rules ? p_rules->terminals : NULL,
3598 p_rules ? p_rules->escapes : NULL);
3599 tmpl_init(vpt, TMPL_TYPE_DATA_UNRESOLVED, quote, fr_sbuff_start(&our_in), slen, t_rules);
3600 vpt->data.unescaped = str;
3601 break;
3602
3603 case T_DOUBLE_QUOTED_STRING:
3604 {
3605 xlat_exp_head_t *head = NULL;
3606 tmpl_type_t type = TMPL_TYPE_XLAT;
3607
3608 vpt = tmpl_alloc_null(ctx);
3609
3610 slen = xlat_tokenize(vpt, &head, &our_in, p_rules, t_rules);
3611 if (slen < 0) FR_SBUFF_ERROR_RETURN(&our_in);
3612
3613 /*
3614 * If the string doesn't contain an xlat,
3615 * and we want to cast it as a specific
3616 * type, then do the conversion now.
3617 */
3618 if (xlat_is_literal(head)) {
3619 if (!fr_type_is_null(t_rules->cast)) {
3620 talloc_free(vpt); /* Also frees any nodes */
3621
3622 return tmpl_afrom_value_substr(ctx, out,
3623 in, quote,
3624 t_rules, false, p_rules);
3625 }
3626
3627 /*
3628 * If the string doesn't contain an xlat
3629 * and there's no cast, we just store
3630 * the string for conversion later.
3631 */
3632 if (xlat_to_string(vpt, &str, &head)) {
3633 TALLOC_FREE(head);
3634
3635 tmpl_init(vpt, TMPL_TYPE_DATA_UNRESOLVED, quote,
3636 fr_sbuff_start(&our_in), slen, t_rules);
3637 vpt->data.unescaped = str; /* Store the unescaped string for parsing later */
3638 break;
3639 }
3640 }
3641
3642 /*
3643 * If the string actually contains an xlat
3644 * store the compiled xlat.
3645 */
3646 if (xlat_needs_resolving(head)) UNRESOLVED_SET(&type);
3647
3648 tmpl_init(vpt, type, quote, fr_sbuff_start(&our_in), slen, t_rules);
3649 vpt->data.xlat.ex = head;
3650 }
3651 break;
3652
3653 case T_BACK_QUOTED_STRING:
3654 {
3655 tmpl_type_t type = TMPL_TYPE_EXEC;
3656 xlat_exp_head_t *head = NULL;
3657
3658 vpt = tmpl_alloc_null(ctx);
3659
3660 /*
3661 * Ensure that we pre-parse the exec string.
3662 * This allows us to catch parse errors as early
3663 * as possible.
3664 *
3665 * FIXME - We need an ephemeral version of this
3666 * too.
3667 */
3668 slen = xlat_tokenize_argv(vpt, &head, &our_in, NULL, p_rules, t_rules, true);
3669 if ((slen <= 0) || !head) {
3670 talloc_free(vpt);
3671 FR_SBUFF_ERROR_RETURN(&our_in);
3672 }
3673
3674 /*
3675 * Ensure any xlats produced are bootstrapped
3676 * so that their instance data will be created.
3677 */
3678 if (xlat_finalize(head, t_rules->xlat.runtime_el) < 0) {
3679 talloc_free(vpt);
3680 fr_strerror_const("Failed to bootstrap xlat");
3681 FR_SBUFF_ERROR_RETURN(&our_in);
3682 }
3683
3684 if (xlat_needs_resolving(head)) UNRESOLVED_SET(&type);
3685
3686 tmpl_init(vpt, type, quote, fr_sbuff_start(&our_in), slen, t_rules);
3687 vpt->data.xlat.ex = head;
3688 }
3689 break;
3690
3691 case T_SOLIDUS_QUOTED_STRING:
3692 {
3693 xlat_exp_head_t *head = NULL;
3694 tmpl_type_t type = TMPL_TYPE_REGEX_XLAT;
3695 tmpl_rules_t arg_t_rules = *t_rules;
3696
3697 arg_t_rules.literals_safe_for = FR_REGEX_SAFE_FOR;
3698
3699 if (!fr_type_is_null(t_rules->cast)) {
3700 fr_strerror_const("Casts cannot be used with regular expressions");
3701 fr_sbuff_set_to_start(&our_in); /* Point to the cast */
3702 FR_SBUFF_ERROR_RETURN(&our_in);
3703 }
3704
3705 vpt = tmpl_alloc_null(ctx);
3706
3707 slen = xlat_tokenize(vpt, &head, &our_in, p_rules, &arg_t_rules);
3708 if (slen < 0) {
3709 talloc_free(vpt);
3710 FR_SBUFF_ERROR_RETURN(&our_in);
3711 }
3712
3713 /*
3714 * Check if the string actually contains an xlat
3715 * if it doesn't, we unfortunately still
3716 * can't compile the regex here, as we don't know if
3717 * it should be ephemeral or what flags should be used
3718 * during the compilation.
3719 *
3720 * The caller will need to do the compilation after we
3721 * return.
3722 */
3723 if (xlat_to_string(vpt, &str, &head)) {
3724 tmpl_init(vpt, TMPL_TYPE_REGEX_UNCOMPILED, quote,
3725 fr_sbuff_start(&our_in), slen, t_rules);
3726 vpt->data.unescaped = str; /* Store the unescaped string for compilation later */
3727 break;
3728 }
3729 /*
3730 * Mark the regex up as a regex-xlat which
3731 * will need expanding before evaluation, and can never
3732 * be pre-compiled.
3733 */
3734 if (xlat_needs_resolving(head)) UNRESOLVED_SET(&type);
3735
3736 tmpl_init(vpt, type, quote, fr_sbuff_start(&our_in), slen, t_rules);
3737 vpt->data.xlat.ex = head;
3738 }
3739 break;
3740
3741 default:
3742 fr_assert_msg(0, "Unknown quote type %i", quote);
3743 FR_SBUFF_ERROR_RETURN(&our_in);
3744 }
3745
3746 TMPL_VERIFY(vpt);
3747 *out = vpt;
3748
3749 FR_SBUFF_SET_RETURN(in, &our_in);
3750}
3751
3752/** Copy a tmpl
3753 *
3754 * Fully duplicates the contents of a tmpl including any nested attribute
3755 * references.
3756 *
3757 * @param[in] ctx to perform allocations under.
3758 * @param[in] in tmpl to duplicate.
3759 * @return
3760 * - NULL on error.
3761 * - A new tmpl on success.
3762 */
3763tmpl_t *tmpl_copy(TALLOC_CTX *ctx, tmpl_t const *in)
3764{
3765 tmpl_t *vpt;
3766
3767 MEM(vpt = tmpl_alloc(ctx, in->type, in->quote, in->name, in->len));
3768 vpt->rules = in->rules;
3769
3770 /*
3771 * Copy over the unescaped data
3772 */
3773 if (tmpl_is_data_unresolved(vpt) || tmpl_is_regex_uncompiled(vpt)) {
3774 if (unlikely(!(vpt->data.unescaped = talloc_bstrdup(vpt, in->data.unescaped)))) {
3775 error:
3776 talloc_free(vpt);
3777 return NULL;
3778 }
3779 }
3780
3781 /*
3782 * Copy attribute references
3783 */
3784 else if (tmpl_contains_attr(vpt)) {
3785 if (unlikely(tmpl_attr_copy(vpt, in) < 0)) goto error;
3786
3787 /*
3788 * Copy flags for all regex flavours (and possibly recompile the regex)
3789 */
3790 } else if (tmpl_contains_regex(vpt)) {
3791 vpt->data.reg_flags = in->data.reg_flags;
3792
3793 /*
3794 * If the tmpl contains a _compiled_ regex
3795 * then convert it back to an uncompiled
3796 * regex and recompile.
3797 *
3798 * Most of the regex libraries don't allow
3799 * copying compiled expressions.
3800 */
3801 if (tmpl_is_regex(vpt)) {
3802 vpt->type = TMPL_TYPE_REGEX_UNCOMPILED;
3803 if (unlikely(!(vpt->data.unescaped = talloc_bstrdup(vpt, in->data.reg.src)))) goto error;
3804 if (unlikely(tmpl_regex_compile(vpt, in->data.reg.subcaptures) < 0)) goto error;
3805 return vpt;
3806 }
3807
3808 /*
3809 * The regex could also be an xlat.
3810 */
3811 fr_assert(tmpl_contains_xlat(vpt));
3812
3813 goto copy_xlat;
3814
3815 /*
3816 * Copy the xlat component.
3817 *
3818 * @todo - in general we can't copy an xlat, as the instances need resolving!
3819 *
3820 * We add an assertion here because nothing allocates the head, and we need it.
3821 */
3822 } else if (tmpl_contains_xlat(vpt)) {
3823 copy_xlat:
3824 fr_assert(in->data.xlat.ex != NULL);
3825
3826 vpt->data.xlat.ex = xlat_exp_head_alloc(vpt);
3827 if (!vpt->data.xlat.ex) goto error;
3828
3829 if (unlikely(xlat_copy(vpt, vpt->data.xlat.ex, in->data.xlat.ex) < 0)) goto error;
3830
3831 } else if (tmpl_is_data(vpt)) {
3832 if (unlikely(fr_value_box_copy(vpt, &vpt->data.literal, &in->data.literal) < 0)) goto error;
3833
3834 } else {
3835 fr_assert(0); /* copy of this type is unimplemented */
3836 }
3837
3838 TMPL_VERIFY(vpt);
3839
3840 return vpt;
3841}
3842
3843/** Parse a cast specifier
3844 *
3845 * Note that casts are
3846 *
3847 * (foo)
3848 *
3849 * and NOT
3850 *
3851 * ( foo )
3852 *
3853 * Not for any particular reason, but to emphasize a bit that they're
3854 * not mathematical expressions.
3855 *
3856 * @param[out] rules to set the cast type in.
3857 * @param[in] in String containing the cast marker.
3858 * @return
3859 * - 0 no cast specifier found.
3860 * - >0 the number of bytes parsed.
3861 * - <0 offset of parse error.
3862 */
3863ssize_t tmpl_cast_from_substr(tmpl_rules_t *rules, fr_sbuff_t *in)
3864{
3865 char close = '\0';
3866 fr_sbuff_t our_in = FR_SBUFF(in);
3867 fr_sbuff_marker_t m;
3868 fr_type_t cast;
3869 ssize_t slen;
3870
3871 if (fr_sbuff_next_if_char(&our_in, '(')) {
3872 close = ')';
3873
3874 } else {
3875 if (rules) rules->cast = FR_TYPE_NULL;
3876 return 0;
3877 }
3878
3879 fr_sbuff_marker(&m, &our_in);
3880 fr_sbuff_out_by_longest_prefix(&slen, &cast, fr_type_table, &our_in, FR_TYPE_NULL);
3881 if (fr_type_is_null(cast)) {
3882 fr_strerror_const("Unknown data type");
3883 FR_SBUFF_ERROR_RETURN(&our_in);
3884 }
3885 if (fr_type_is_non_leaf(cast)) {
3886 fr_strerror_printf("Forbidden data type '%s' in cast", fr_type_to_str(cast));
3887 FR_SBUFF_ERROR_RETURN(&m);
3888 }
3889
3890 if (!fr_sbuff_next_if_char(&our_in, close)) {
3891 fr_strerror_const("Unterminated cast");
3892 FR_SBUFF_ERROR_RETURN(&our_in);
3893 }
3894 fr_sbuff_adv_past_whitespace(&our_in, SIZE_MAX, NULL);
3895
3896 if (rules) rules->cast = cast;
3897
3898 FR_SBUFF_SET_RETURN(in, &our_in);
3899}
3900
3901/** Set a cast for a tmpl
3902 *
3903 * @param[in,out] vpt to set cast for.
3904 * @param[in] dst_type to set.
3905 * @return
3906 * - 0 on success.
3907 * - -1 on failure.
3908 */
3909int tmpl_cast_set(tmpl_t *vpt, fr_type_t dst_type)
3910{
3911 fr_type_t src_type;
3912
3913 switch (dst_type) {
3914 default:
3915 fr_strerror_printf("Forbidden data type '%s' in cast",
3916 fr_type_to_str(dst_type));
3917 return -1;
3918
3919 /*
3920 * We can always remove a cast.
3921 */
3922 case FR_TYPE_NULL:
3923 goto done;
3924
3925 /*
3926 * Only "base" data types are allowed. Structural types
3927 * and horrid WiMAX crap is forbidden.
3928 */
3929 case FR_TYPE_LEAF:
3930 break;
3931 }
3932
3933 switch (vpt->type) {
3934 /*
3935 * This should have been fixed before we got here.
3936 */
3937 case TMPL_TYPE_ATTR_UNRESOLVED:
3938
3939 /*
3940 * By default, tmpl types cannot be cast to anything.
3941 */
3942 default:
3943 fr_strerror_const("Cannot use cast here.");
3944 return -1;
3945
3946 /*
3947 * These tmpl types are effectively of data type
3948 * "string", so they can be cast to anything.
3949 */
3950 case TMPL_TYPE_XLAT:
3951 case TMPL_TYPE_EXEC:
3952 case TMPL_TYPE_DATA_UNRESOLVED:
3953 case TMPL_TYPE_EXEC_UNRESOLVED:
3954 case TMPL_TYPE_XLAT_UNRESOLVED:
3955 break;
3956
3957 case TMPL_TYPE_DATA:
3958 src_type = tmpl_value_type(vpt);
3959 goto check_types;
3960
3961 case TMPL_TYPE_ATTR:
3962 {
3963 fr_dict_attr_t const *da = tmpl_attr_tail_da(vpt);
3964
3965 /*
3966 * If the attribute has an enum, then the cast means "use the raw value, and not
3967 * the enum name".
3968 */
3969 if (da->type == dst_type) {
3970 if (da->flags.has_value) goto done;
3971 return 0;
3972 }
3973 src_type = da->type;
3974 }
3975
3976 /*
3977 * Suppress casts where they are duplicate, unless there's an enumv. In which case the
3978 * cast means "don't print the enumv value, just print the raw data".
3979 */
3980 check_types:
3981 if (src_type == dst_type) {
3982 /*
3983 * Cast with enumv means "use the raw value, and not the enum name".
3984 */
3985 if (tmpl_rules_enumv(vpt)) {
3986 tmpl_rules_enumv(vpt) = NULL;
3987 goto done;
3988 }
3989 return 0;
3990 }
3991
3992 if (!fr_type_cast(dst_type, src_type)) {
3993 fr_strerror_printf("Cannot cast type '%s' to '%s'",
3994 fr_type_to_str(src_type),
3995 fr_type_to_str(dst_type));
3996 return -1;
3997 }
3998 break;
3999 }
4000
4001done:
4002 vpt->rules.cast = dst_type;
4003 return 0;
4004}
4005
4006#ifdef HAVE_REGEX
4007/** Parse a set of regular expression flags
4008 *
4009 * @param[out] vpt Write the flags to the regex flags field in this #tmpl_t.
4010 * @param[in] in Where to parse the flag string from.
4011 * @param[in] terminals That mark the end of the regex flag string.
4012 * @return
4013 * - 0 no flags found.
4014 * - >0 the number of bytes of flags parsed.
4015 * - <0 offset of parse error.
4016 */
4017ssize_t tmpl_regex_flags_substr(tmpl_t *vpt, fr_sbuff_t *in, fr_sbuff_term_t const *terminals)
4018{
4019 fr_slen_t slen;
4020 int err = 0;
4021
4022 fr_assert(tmpl_is_regex_uncompiled(vpt) || tmpl_is_regex_xlat(vpt) || tmpl_is_regex_xlat_unresolved(vpt));
4023
4024 slen = regex_flags_parse(&err, &vpt->data.reg_flags, in, terminals, true);
4025 switch (err) {
4026 case 0:
4027 break;
4028
4029 case -1: /* Non-flag and non-terminal */
4030 case -2: /* Duplicate flag */
4031 return slen;
4032 }
4033
4034 return slen;
4035}
4036#endif
4037
4038/** @name Change a #tmpl_t type, usually by casting or resolving a reference
4039 *
4040 * #tmpl_cast_in_place can be used to convert #TMPL_TYPE_DATA_UNRESOLVED to a #TMPL_TYPE_DATA of a
4041 * specified #fr_type_t.
4042 *
4043 * #tmpl_attr_unknown_add converts a #TMPL_TYPE_ATTR with an unknown #fr_dict_attr_t to a
4044 * #TMPL_TYPE_ATTR with a known #fr_dict_attr_t, by adding the unknown #fr_dict_attr_t to the main
4045 * dictionary, and updating the ``tmpl_attr_tail_da`` pointer.
4046 * @{
4047 */
4048
4049/** Determine the correct quoting after a cast
4050 *
4051 * @param[in] existing_quote Exiting quotation type.
4052 * @param[in] type Cast type.
4053 * @param[in] enumv Enumeration values.
4054 * @param[in] unescaped The unescaped value of an enumeration.
4055 * @param[in] unescaped_len Length of unescaped.
4056 */
4057static inline CC_HINT(always_inline)
4058fr_token_t tmpl_cast_quote(fr_token_t existing_quote,
4059 fr_type_t type, fr_dict_attr_t const *enumv,
4060 char const *unescaped, size_t unescaped_len)
4061{
4062 if (!fr_type_is_string(type)) return T_BARE_WORD;
4063
4064 if (enumv && fr_dict_enum_by_name(enumv, unescaped, unescaped_len)) return T_BARE_WORD;
4065
4066 /*
4067 * Leave the original quoting if it's
4068 * single or double, else default to
4069 * single quoting.
4070 */
4071 switch (existing_quote) {
4072 case T_SINGLE_QUOTED_STRING:
4073 case T_DOUBLE_QUOTED_STRING:
4074 return existing_quote;
4075
4076 default:
4077 return T_SINGLE_QUOTED_STRING;
4078 }
4079}
4080
4081
4082/** Convert #tmpl_t of type #TMPL_TYPE_DATA_UNRESOLVED or #TMPL_TYPE_DATA to #TMPL_TYPE_DATA of type specified
4083 *
4084 * @note Conversion is done in place.
4085 * @note For #TMPL_TYPE_DATA_UNRESOLVED, the type will be updated to #TMPL_TYPE_DATA
4086 *
4087 * @param[in,out] vpt The template to modify. Must be of type #TMPL_TYPE_DATA_UNRESOLVED
4088 * or #TMPL_TYPE_DATA, #TMPL_TYPE_ATTR_UNRESOLVED, or #TMPL_TYPE_ATTR
4089 * @param[in] type to cast to.
4090 * @param[in] enumv Enumerated dictionary values associated with a #fr_dict_attr_t.
4091 * @return
4092 * - 0 on success.
4093 * - -1 on failure.
4094 */
4095int tmpl_cast_in_place(tmpl_t *vpt, fr_type_t type, fr_dict_attr_t const *enumv)
4096{
4097 TMPL_VERIFY(vpt);
4098
4099 fr_assert(tmpl_is_data_unresolved(vpt) || tmpl_is_data(vpt) ||
4100 tmpl_is_attr_unresolved(vpt) || tmpl_is_attr(vpt));
4101
4102 switch (vpt->type) {
4103 case TMPL_TYPE_DATA_UNRESOLVED:
4104 {
4105 char *unescaped = vpt->data.unescaped;
4106
4107 /*
4108 * We're trying to convert an unresolved (bareword)
4109 * tmpl to octets.
4110 *
4111 * tmpl_afrom_substr uses the 0x prefix as type
4112 * inference, so if it was a hex string the tmpl
4113 * type would not have fallen through to
4114 * unresolved.
4115 *
4116 * That means if we're trying to resolve it here
4117 * it's really a printable string, not a sequence
4118 * of hexits, so we just want the binary
4119 * representation of that string, and not the hex
4120 * to bin conversion.
4121 */
4122 if (fr_type_is_octets(type)) {
4123 if (fr_value_box_memdup(vpt, &vpt->data.literal, enumv,
4124 (uint8_t const *)unescaped, talloc_strlen(unescaped),
4125 false) < 0) return -1;
4126 } else {
4127 if (fr_value_box_from_str(vpt, &vpt->data.literal, type,
4128 enumv,
4129 unescaped, talloc_strlen(unescaped),
4130 NULL) < 0) return -1;
4131 }
4132 vpt->type = TMPL_TYPE_DATA;
4133 vpt->quote = tmpl_cast_quote(vpt->quote, type, enumv,
4134 unescaped, talloc_strlen(unescaped));
4135 talloc_free(unescaped);
4136 fr_value_box_mark_safe_for(&vpt->data.literal, vpt->rules.literals_safe_for);
4137
4138 /*
4139 * The data is now of the correct type, so we don't need to keep a cast.
4140 */
4141 vpt->rules.cast = FR_TYPE_NULL;
4142 }
4143 break;
4144
4145 case TMPL_TYPE_DATA:
4146 {
4147 if (type == tmpl_value_type(vpt)) return 0; /* noop */
4148
4149 /*
4150 * Enumerations aren't used when casting between
4151 * data types. They're only used when processing
4152 * unresolved tmpls.
4153 *
4154 * i.e. TMPL_TYPE_DATA_UNRESOLVED != TMPL_TYPE_DATA(FR_TYPE_STRING)
4155 */
4156 if (fr_value_box_cast_in_place(vpt, &vpt->data.literal, type, NULL) < 0) return -1;
4157// fr_value_box_mark_safe_for(&vpt->data.literal, vpt->rules.literals_safe_for); ??? is this necessary?
4158
4159 /*
4160 * Strings get quoted, everything else is a bare
4161 * word...
4162 */
4163 if (fr_type_is_string(type)) {
4164 vpt->quote = T_SINGLE_QUOTED_STRING;
4165 } else {
4166 vpt->quote = T_BARE_WORD;
4167 }
4168
4169 /*
4170 * The data is now of the correct type, so we don't need to keep a cast.
4171 */
4172 vpt->rules.cast = FR_TYPE_NULL;
4173 }
4174 break;
4175
4176 case TMPL_TYPE_ATTR:
4177 /*
4178 * Suppress casts to the same type.
4179 */
4180 if (tmpl_attr_tail_da(vpt)->type == type) {
4181 vpt->rules.cast = FR_TYPE_NULL;
4182 break;
4183 }
4184 FALL_THROUGH;
4185
4186 case TMPL_TYPE_ATTR_UNRESOLVED:
4187 vpt->rules.cast = type;
4188 break;
4189
4190 default:
4191 fr_assert(0);
4192 }
4193 TMPL_VERIFY(vpt);
4194
4195 return 0;
4196}
4197
4198/** Resolve an unresolved attribute
4199 *
4200 * Multi-pass parsing fixups for attribute references.
4201 *
4202 * @param[in] vpt to resolve.
4203 * @param[in] tr_rules Combined with the original parse rules for
4204 * additional resolution passes.
4205 * @return
4206 * - 0 if all references were resolved.
4207 * - -1 if there are unknown attributes which need
4208 * adding to the global dictionary first.
4209 * - -2 if there are attributes we couldn't resolve.
4210 */
4211static inline CC_HINT(always_inline) int tmpl_attr_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules)
4212{
4213 tmpl_attr_t *ar = NULL, *next, *prev;
4214 fr_dict_attr_t const *da, *namespace;
4215 fr_dict_t const *dict_def;
4216
4217 fr_assert(tmpl_is_attr_unresolved(vpt));
4218
4219 TMPL_VERIFY(vpt);
4220
4221 dict_def = vpt->rules.attr.dict_def;
4222 if (!dict_def || tr_rules->force_dict_def) dict_def = tr_rules->dict_def;
4223
4224 /*
4225 * First component is special because we may need
4226 * to search for it in multiple dictionaries.
4227 *
4228 * This emulates what's done in the initial
4229 * tokenizer function.
4230 */
4231 ar = tmpl_attr_list_head(tmpl_attr(vpt));
4232 if (ar->type == TMPL_ATTR_TYPE_UNRESOLVED) {
4233 (void)fr_dict_attr_search_by_name_substr(NULL,
4234 &da,
4235 dict_def,
4236 &FR_SBUFF_IN(ar->ar_unresolved,
4237 talloc_strlen(ar->ar_unresolved)),
4238 NULL,
4239 true,
4240 vpt->rules.attr.allow_foreign);
4241 if (!da) return -2; /* Can't resolve, maybe the caller can resolve later */
4242
4243 ar->ar_type = TMPL_ATTR_TYPE_NORMAL;
4244 ar->ar_da = da;
4245 ar->ar_parent = fr_dict_root(fr_dict_by_da(da));
4246
4247 /*
4248 * Record the dictionary that was
4249 * successfully used for resolution.
4250 */
4251 vpt->rules.attr.dict_def = tr_rules->dict_def;
4252
4253 /*
4254 * Reach into the next reference
4255 * and correct its parent and
4256 * namespace.
4257 */
4258 next = tmpl_attr_list_next(tmpl_attr(vpt), ar);
4259 if (next) {
4260 next->ar_parent = da;
4261 next->ar_unresolved_namespace = da;
4262 }
4263 }
4264
4265 /*
4266 * Loop, resolving each unresolved attribute in turn
4267 */
4268 while ((ar = tmpl_attr_list_next(tmpl_attr(vpt), ar))) {
4269 switch (ar->type) {
4270 case TMPL_ATTR_TYPE_NORMAL:
4271 case TMPL_ATTR_TYPE_UNSPEC:
4272 continue; /* Don't need to resolve */
4273
4274 case TMPL_ATTR_TYPE_UNKNOWN:
4275 return -1; /* Unknown attributes must be resolved first */
4276
4277 default:
4278 break;
4279 }
4280
4281 prev = tmpl_attr_list_prev(tmpl_attr(vpt), ar);
4282
4283 /*
4284 * If the parent is a list AR, then use the default dictionary for the namespace
4285 */
4286 namespace = (prev && dict_def && tmpl_attr_is_list_attr(prev)) ? fr_dict_root(dict_def) : ar->ar_unresolved_namespace;
4287
4288 (void)fr_dict_attr_by_name_substr(NULL,
4289 &da,
4290 namespace,
4291 &FR_SBUFF_IN(ar->ar_unresolved,
4292 talloc_strlen(ar->ar_unresolved)),
4293 NULL);
4294 /*
4295 * Still can't resolve, check to see if
4296 * the last attribute reference was a
4297 * group.
4298 *
4299 * If it was, then we may be able to
4300 * fall back to resolving the attribute
4301 * in the internal dictionary.
4302 */
4303 if (!da) {
4304 if (prev && (prev->ar_da->type == FR_TYPE_GROUP)) {
4305 (void)fr_dict_attr_by_name_substr(NULL,
4306 &da,
4307 fr_dict_root(fr_dict_internal()),
4308 &FR_SBUFF_IN(ar->ar_unresolved,
4309 talloc_strlen(ar->ar_unresolved)),
4310 NULL);
4311 }
4312 if (!da) return -2;
4313 }
4314
4315 /*
4316 * Known attribute, just rewrite.
4317 */
4318 ar->ar_type = TMPL_ATTR_TYPE_NORMAL;
4319 ar->ar_da = da;
4320
4321 /*
4322 * Parent should have been corrected in
4323 * the previous loop iteration.
4324 */
4325 fr_assert(ar->ar_parent && !ar->ar_parent->flags.is_unknown);
4326
4327 /*
4328 * Reach into the next reference
4329 * and correct its parent.
4330 */
4331 next = tmpl_attr_list_next(tmpl_attr(vpt), ar);
4332 if (next) {
4333 next->ar_parent = da;
4334 next->ar_unresolved_namespace = da;
4335 }
4336
4337 /*
4338 * Remove redundant attributes
4339 *
4340 * If it's not a group or does not specify
4341 * an index, the ar is redundant and should
4342 * be removed.
4343 */
4344 prev = tmpl_attr_list_prev(tmpl_attr(vpt), ar);
4345 if (prev && (prev->ar_da->type != FR_TYPE_GROUP) && (prev->ar_num == NUM_UNSPEC)) {
4346 tmpl_attr_list_remove(tmpl_attr(vpt), prev);
4347 ar->ar_parent = prev->ar_parent;
4348 talloc_free(prev);
4349 }
4350 }
4351
4352 RESOLVED_SET(&vpt->type);
4353 TMPL_VERIFY(vpt);
4354
4355 return 0;
4356}
4357
4358/** Resolve an unresolved xlat, i.e. one containing unresolved attribute references or xlat functions
4359 *
4360 * Multi-pass parsing fixups for attribute references.
4361 *
4362 * Works for base types:
4363 * - TMPL_TYPE_XLAT
4364 * - TMPL_TYPE_EXEC
4365 * - TMPL_TYPE_REGEX_XLAT
4366 *
4367 * @param[in] vpt Containing the xlat expansion to resolve.
4368 * @param[in] tr_rules Combined with the original parse rules for
4369 * additional resolution passes.
4370 * @return
4371 * - 0 on success.
4372 * - -1 on failure.
4373 */
4374static inline CC_HINT(always_inline)
4375int tmpl_xlat_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules)
4376{
4377 if (xlat_resolve(vpt->data.xlat.ex,
4378 &(xlat_res_rules_t){
4379 .tr_rules = tr_rules,
4380 .allow_unresolved = false
4381 }) < 0) return -1;
4382
4383 fr_assert(!xlat_needs_resolving(vpt->data.xlat.ex));
4384
4385 RESOLVED_SET(&vpt->type);
4386 TMPL_VERIFY(vpt);
4387
4388 return 0;
4389}
4390
4391/** Attempt to resolve functions and attributes in xlats and attribute references
4392 *
4393 * @note If resolution is successful, the rules->attr.dict_def field will be modified to
4394 * reflect the dictionary resolution was successful in.
4395 *
4396 * @param[in,out] vpt to resolve. Should be of type TMPL_TYPE_XLAT_UNRESOLVED
4397 * or TMPL_TYPE_ATTR_UNRESOLVED. All other types will be
4398 * noops.
4399 * @param[in] tr_rules Combined with the original parse rules for
4400 * additional resolution passes.
4401 * @return
4402 * - 0 on success.
4403 * - -1 on failure.
4404 */
4405int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules)
4406{
4407 static tmpl_res_rules_t const default_tr_rules = {};
4408
4409 int ret = 0;
4410
4411 if (!tmpl_needs_resolving(vpt)) return 0; /* Nothing to do */
4412
4413 if (!tr_rules) tr_rules = &default_tr_rules;
4414
4415 /*
4416 * Sanity check. There shouldn't be conflicting
4417 * enumvs between the original rules and resolution
4418 * rules.
4419 *
4420 * Either the enumv was available during parsing
4421 * and shouldn't have changed during subsequent
4422 * resolution passes, or it wasn't available at
4423 * parse-time, but now is.
4424 */
4425 if (tr_rules->enumv && tmpl_rules_enumv(vpt) && !tmpl_rules_enumv(vpt)->flags.is_unknown &&
4426 (tr_rules->enumv != tmpl_rules_enumv(vpt))) {
4427 fr_strerror_printf("mismatch between parse-time enumv '%s' and resolution-time enumv '%s'",
4428 tmpl_rules_enumv(vpt)->name, tr_rules->enumv->name);
4429
4430 return -1;
4431 }
4432
4433 /*
4434 * The xlat component of the #tmpl_t needs resolving.
4435 *
4436 * This includes exec tmpls, which are largely xlats
4437 * "under the hood".
4438 */
4439 if (tmpl_contains_xlat(vpt)) {
4440 ret = tmpl_xlat_resolve(vpt, tr_rules);
4441
4442 /*
4443 * The attribute reference needs resolving.
4444 */
4445 } else if (tmpl_contains_attr(vpt)) {
4446 fr_type_t dst_type = tmpl_rules_cast(vpt);
4447
4448 fr_assert(vpt->quote == T_BARE_WORD); /* 'User-Name' or "User-Name" is not allowed. */
4449
4450 ret = tmpl_attr_resolve(vpt, tr_rules);
4451 if (ret < 0) return ret;
4452
4453 if (dst_type == tmpl_attr_tail_da(vpt)->type) {
4454 vpt->rules.cast = FR_TYPE_NULL;
4455 }
4456
4457 /*
4458 * Convert unresolved tmpls into enumvs, or failing that, string values.
4459 *
4460 * Unresolved tmpls are by definition TMPL_TYPE_DATA.
4461 */
4462 } else if (tmpl_is_data_unresolved(vpt)) {
4463 fr_type_t dst_type = tmpl_rules_cast(vpt);
4464 fr_dict_attr_t const *enumv = tmpl_rules_enumv(vpt);
4465
4466 /*
4467 * If there wasn't an enumv set in the
4468 * original rules, and we now have one
4469 * (possibly because the other side of a
4470 * binary expression has been resolved),
4471 * then use the new enumv.
4472 */
4473 if (!enumv) enumv = tr_rules->enumv;
4474
4475 /*
4476 * We don't have an explicit output type. Try to
4477 * interpret the data os the enumv data type, OR
4478 * if all else fails, it's a string.
4479 */
4480 if (fr_type_is_null(dst_type)) {
4481 /*
4482 * Infer the cast from the enumv type.
4483 */
4484 if (enumv) {
4485 dst_type = enumv->type;
4486
4487 } else if (vpt->quote != T_BARE_WORD) {
4488 dst_type = FR_TYPE_STRING; /* quoted strings are strings */
4489
4490 } else if (strncmp(vpt->data.unescaped, "::", 2) != 0) {
4491 /*
4492 * The rest of the code should have errored out before this.
4493 */
4494 fr_strerror_printf("Failed resolving data '%s' - it is not an attribute name or a quoted string", vpt->data.unescaped);
4495 return -1;
4496
4497 } else {
4498 /*
4499 * It's a valid enum ::NAME which was added _after_ the dictionaries were
4500 * loaded. That's fine. fr_value_box_from_substr() will skip over the
4501 * "::", and parse the enum name.
4502 */
4503 }
4504 }
4505
4506 /*
4507 * tmpl_cast_in_place first resolves using
4508 * the enumv, _then_ casts using the type.
4509 */
4510 if (tmpl_cast_in_place(vpt, dst_type, enumv) < 0) return -1;
4511
4512 TMPL_VERIFY(vpt);
4513 /*
4514 * Catch any other cases of unresolved things
4515 * we need to address. We put the assert here
4516 * so we don't end up running inappropriate
4517 * code for non-debug builds.
4518 */
4519 } else {
4520 fr_assert(0);
4521 }
4522
4523 TMPL_VERIFY(vpt);
4524
4525 return ret;
4526}
4527
4528/** Reset the tmpl, leaving only the name in place
4529 *
4530 * After calling this function, the tmpl type will revert to TMPL_TYPE_DATA_UNRESOLVED
4531 * and only the name and quoting will be preserved.
4532 *
4533 * @param[in] vpt to reset.
4534 */
4535void tmpl_unresolve(tmpl_t *vpt)
4536{
4537 tmpl_t tmp = {
4538 .type = TMPL_TYPE_DATA_UNRESOLVED,
4539 .name = vpt->name,
4540 .len = vpt->len,
4541 .quote = vpt->quote
4542 };
4543
4544 switch (vpt->type) {
4545 case TMPL_TYPE_UNINITIALISED:
4546 case TMPL_TYPE_MAX:
4547 fr_assert(0);
4548 break;
4549
4550 case TMPL_TYPE_DATA_UNRESOLVED:
4551 case TMPL_TYPE_REGEX_UNCOMPILED:
4552 break;
4553
4554 case TMPL_TYPE_DATA:
4555 fr_value_box_clear(&vpt->data.literal);
4556 break;
4557
4558 /*
4559 * These types contain dynamically allocated
4560 * attribute and request references.
4561 */
4562 case TMPL_TYPE_ATTR:
4563 case TMPL_TYPE_ATTR_UNRESOLVED:
4564 tmpl_attr_list_talloc_free(tmpl_attr(vpt));
4565 tmpl_request_list_talloc_free(&vpt->data.attribute.rr);
4566 break;
4567
4568 /*
4569 * These all store an xlat expansion
4570 */
4571 case TMPL_TYPE_EXEC:
4572 case TMPL_TYPE_XLAT:
4573 case TMPL_TYPE_REGEX_XLAT:
4574 case TMPL_TYPE_EXEC_UNRESOLVED:
4575 case TMPL_TYPE_XLAT_UNRESOLVED:
4576 case TMPL_TYPE_REGEX_XLAT_UNRESOLVED:
4577 TALLOC_FREE(vpt->data.xlat.ex);
4578 break;
4579
4580 case TMPL_TYPE_REGEX:
4581 talloc_free(vpt->data.reg.ex);
4582 break;
4583
4584 }
4585
4586 memcpy(vpt, &tmp, sizeof(*vpt));
4587 vpt->data.unescaped = talloc_bstrdup(vpt, vpt->name);
4588 TMPL_VERIFY(vpt);
4589}
4590
4591/** Add an unknown #fr_dict_attr_t specified by a #tmpl_t to the main dictionary
4592 *
4593 * @param vpt to add. ``tmpl_attr_tail_da`` pointer will be updated to point to the
4594 * #fr_dict_attr_t inserted into the dictionary.
4595 * @return
4596 * - 1 noop (did nothing) - Not possible to convert tmpl.
4597 * - 0 on success.
4598 * - -1 on failure.
4599 */
4600int tmpl_attr_unknown_add(tmpl_t *vpt)
4601{
4602 tmpl_attr_t *ar = NULL, *next = NULL;
4603
4604 if (!vpt) return 1;
4605
4606 /*
4607 * Can't do this for expressions parsed at runtime
4608 */
4609 if (vpt->rules.at_runtime) return 1;
4610
4611 tmpl_assert_type(tmpl_is_attr(vpt));
4612
4613 TMPL_VERIFY(vpt);
4614
4615 if (!tmpl_attr_tail_is_unknown(vpt)) return 1; /* Ensure at least the leaf is unknown */
4616
4617 while ((ar = tmpl_attr_list_next(tmpl_attr(vpt), ar))) {
4618 fr_dict_attr_t const *unknown, *known;
4619
4620 switch (ar->type) {
4621 case TMPL_ATTR_TYPE_NORMAL: /* Skip */
4622 case TMPL_ATTR_TYPE_UNSPEC:
4623 continue;
4624
4625 case TMPL_ATTR_TYPE_UNRESOLVED: /* Shouldn't have been called */
4626 fr_strerror_const("Remaining attributes are unresolved");
4627 return -1;
4628
4629 case TMPL_ATTR_TYPE_UNKNOWN:
4630 break;
4631 }
4632
4633 unknown = ar->ar_unknown;
4634 known = fr_dict_attr_unknown_add(fr_dict_unconst(fr_dict_by_da(unknown)), unknown);
4635 if (!known) return -1;
4636
4637 /*
4638 * Fixup the parent of the next unknown
4639 * now it's known.
4640 */
4641 next = tmpl_attr_list_next(tmpl_attr(vpt), ar);
4642 if (next && (next->type == TMPL_ATTR_TYPE_UNKNOWN) &&
4643 (next->ar_da->parent == unknown)) {
4644 if (fr_dict_attr_unknown_parent_to_known(fr_dict_attr_unconst(next->ar_da),
4645 known) < 0) return -1;
4646 next->ar_parent = known;
4647 }
4648
4649 /*
4650 * Convert the ref to a normal type.
4651 * At runtime there should be no
4652 * "unknown" references as they should
4653 * have all been added to a
4654 * dictionary.
4655 */
4656 ar->type = TMPL_ATTR_TYPE_NORMAL;
4657
4658 /*
4659 * If the attribute is *NOT* raw then
4660 * swap the canonical unknown with the
4661 * one that was previously associated
4662 * with the tmpl.
4663 *
4664 * This establishes the unknown attribute
4665 * in the dictionary if it was really
4666 * unknown whilst not mucking up the
4667 * types for raw attributes.
4668 */
4669 if (!ar_is_raw(ar)) {
4670 fr_dict_attr_unknown_free(&ar->ar_da);
4671 ar->ar_da = known;
4672 } else if (!fr_cond_assert(!next)) {
4673 fr_strerror_const("Only the leaf may be raw");
4674 return -1;
4675 }
4676 }
4677
4678 return 0;
4679}
4680
4681/** Add an unresolved #fr_dict_attr_t specified by a #tmpl_t to the main dictionary
4682 *
4683 * @note fr_dict_attr_add will not return an error if the attribute already exists
4684 * meaning that multiple #tmpl_t specifying the same attribute can be
4685 * passed to this function to be fixed up, so long as the type and flags
4686 * are identical.
4687 *
4688 * @param[in] dict_def Default dictionary to use if none is
4689 * specified by the tmpl_attr_tail_unresolved.
4690 * @param[in] vpt specifying unresolved attribute to add.
4691 * ``tmpl_attr_tail_da`` pointer will be updated to
4692 * point to the #fr_dict_attr_t inserted
4693 * into the dictionary. Lists and requests
4694 * will be preserved.
4695 * @param[in] type to define unresolved attribute as.
4696 * @param[in] flags to define unresolved attribute with.
4697 * @return
4698 * - 1 noop (did nothing) - Not possible to convert tmpl.
4699 * - 0 on success.
4700 * - -1 on failure.
4701 */
4702int tmpl_attr_tail_unresolved_add(fr_dict_t *dict_def, tmpl_t *vpt,
4703 fr_type_t type, fr_dict_attr_flags_t const *flags)
4704{
4705 fr_dict_attr_t const *da;
4706 fr_dict_attr_flags_t our_flags = *flags;
4707
4708 our_flags.name_only = true;
4709
4710 if (!vpt) return -1;
4711
4712 TMPL_VERIFY(vpt);
4713
4714 if (!tmpl_is_attr_unresolved(vpt)) return 1;
4715
4716 if (fr_dict_attr_add(dict_def,
4717 fr_dict_root(fr_dict_internal()), tmpl_attr_tail_unresolved(vpt), 0, type, &our_flags) < 0) {
4718 return -1;
4719 }
4720 da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_def), tmpl_attr_tail_unresolved(vpt));
4721 if (!da) return -1;
4722
4723 if (type != da->type) {
4724 fr_strerror_printf("Attribute %s of type %s already defined with type %s",
4725 da->name, fr_type_to_str(type),
4726 fr_type_to_str(da->type));
4727 return -1;
4728 }
4729
4730 if (memcmp(flags, &da->flags, sizeof(*flags)) != 0) {
4731 fr_strerror_printf("Attribute %s already defined with different flags", da->name);
4732 return -1;
4733 }
4734
4735 tmpl_attr_set_da(vpt, da);
4736 vpt->type = TMPL_TYPE_ATTR;
4737
4738 return 0;
4739}
4740
4741#ifdef HAVE_REGEX
4742/** Convert a TMPL_TYPE_REGEX_UNCOMPILED into a TMPL_TYPE_REGEX
4743 *
4744 * Other regex types become noops.
4745 */
4746ssize_t tmpl_regex_compile(tmpl_t *vpt, bool subcaptures)
4747{
4748 ssize_t slen;
4749 char *unescaped = vpt->data.unescaped;
4750
4751 if (tmpl_is_regex_xlat(vpt) || tmpl_is_regex(vpt)) return 0; /* Don't need compiling */
4752
4753 fr_assert(tmpl_is_regex_uncompiled(vpt));
4754
4755 slen = regex_compile(vpt, &vpt->data.reg.ex,
4756 unescaped, talloc_strlen(unescaped),
4757 &vpt->data.reg_flags, subcaptures, vpt->rules.at_runtime);
4758 if (slen <= 0) return vpt->quote != T_BARE_WORD ? slen - 1 : slen; /* Account for the quoting */
4759
4760 vpt->type = TMPL_TYPE_REGEX;
4761 vpt->data.reg.src = unescaped; /* Keep this around for debugging and copying */
4762 vpt->data.reg.subcaptures = subcaptures;
4763
4764 TMPL_VERIFY(vpt);
4765
4766 return slen;
4767}
4768#endif
4769/** @} */
4770
4771/** @name Print the contents of a #tmpl_t
4772 * @{
4773 */
4774fr_slen_t tmpl_request_ref_list_print(fr_sbuff_t *out, FR_DLIST_HEAD(tmpl_request_list) const *rql)
4775{
4776 fr_sbuff_t our_out = FR_SBUFF(out);
4777 tmpl_request_t *rr = tmpl_request_list_head(rql);
4778
4779 /*
4780 * Print request references
4781 */
4782 while (rr) {
4783 FR_SBUFF_IN_TABLE_STR_RETURN(&our_out, tmpl_request_ref_print_table, rr->request, "<INVALID>");
4784 rr = tmpl_request_list_next(rql, rr);
4785 if (rr) FR_SBUFF_IN_CHAR_RETURN(&our_out, '.');
4786 }
4787
4788 FR_SBUFF_SET_RETURN(out, &our_out);
4789}
4790
4791/** Print an attribute or list #tmpl_t to a string
4792 *
4793 * This function is the direct counterpart to #tmpl_afrom_attr_substr.
4794 *
4795 * @param[in] out Where to write the presentation format #tmpl_t string.
4796 * @param[in] vpt to print.
4797 * @return
4798 * - >0 the number of bytes written to the out buffer.
4799 * - 0 invalid argument.
4800 * - <0 the number of bytes we would have needed to complete the print.
4801 */
4802fr_slen_t tmpl_attr_print(fr_sbuff_t *out, tmpl_t const *vpt)
4803{
4804 tmpl_attr_t *ar = NULL;
4805 fr_da_stack_t stack;
4806 fr_sbuff_t our_out = FR_SBUFF(out);
4807 fr_slen_t slen;
4808
4809 TMPL_VERIFY(vpt);
4810
4811 /*
4812 * Only print things we can print...
4813 */
4814 switch (vpt->type) {
4815 case TMPL_TYPE_ATTR_UNRESOLVED:
4816 case TMPL_TYPE_ATTR:
4817 break;
4818
4819 default:
4820 fr_assert(0);
4821 return 0;
4822 }
4823
4824 /*
4825 * Print request references
4826 */
4827 slen = tmpl_request_ref_list_print(&our_out, &vpt->data.attribute.rr);
4828 if (slen > 0) FR_SBUFF_IN_CHAR_RETURN(&our_out, '.');
4829 if (slen < 0) return slen;
4830
4831 /*
4832 *
4833 * If the leaf attribute is unknown and raw we
4834 * add the raw. prefix.
4835 *
4836 * If the leaf attribute is unknown and not raw
4837 * we add the .unknown prefix.
4838 *
4839 */
4840 if (tmpl_attr_tail_is_raw(vpt)) FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "raw.");
4841
4842 /*
4843 * Print attribute identifiers
4844 */
4845 ar = NULL;
4846 while ((ar = tmpl_attr_list_next(tmpl_attr(vpt), ar))) {
4847 switch(ar->type) {
4848 case TMPL_ATTR_TYPE_UNSPEC:
4849 break;
4850
4851 case TMPL_ATTR_TYPE_NORMAL:
4852 case TMPL_ATTR_TYPE_UNKNOWN:
4853 {
4854 int i, depth = 0;
4855
4856 fr_assert(ar->ar_parent); /* All normal and unknown attributes must have parents */
4857
4858 fr_proto_da_stack_build_partial(&stack, ar->ar_parent, ar->ar_da);
4859
4860 /*
4861 * First component in the list has everything built
4862 */
4863 if (ar == tmpl_attr_list_head(tmpl_attr(vpt))) {
4864 depth = ar->ar_parent->depth - 1; /* Adjust for array index */
4865 /*
4866 * Everything else skips the first component
4867 */
4868 } else {
4869 depth = ar->ar_parent->depth;
4870 }
4871
4872 /*
4873 * Root attributes will be skipped by the build
4874 * function, so da[0] contains the attribute
4875 * we're looking for.
4876 */
4877 if (depth < 0) depth = 0;
4878
4879 /*
4880 * Print from our parent depth to the AR we're processing
4881 *
4882 * For refs we skip the attribute pointed to be the ref
4883 * and just print its children.
4884 *
4885 * In addition skip printing "request." in most cases.
4886 */
4887 if ((stack.da[depth] == request_attr_request) && tmpl_attr_list_next(tmpl_attr(vpt), ar) &&
4888 (ar->filter.type == TMPL_ATTR_FILTER_TYPE_NONE)) continue;
4889
4890 for (i = depth; (unsigned int)i < ar->ar_da->depth; i++) {
4891 FR_SBUFF_IN_STRCPY_RETURN(&our_out, stack.da[i]->name);
4892
4893 /*
4894 * Print intermediary separators
4895 * if necessary.
4896 */
4897 if (((unsigned int)i + 1) < ar->ar_da->depth) FR_SBUFF_IN_CHAR_RETURN(&our_out, '.');
4898 }
4899 }
4900 break;
4901
4902 /*
4903 * For unresolved attribute we print the raw identifier we
4904 * got when parsing the tmpl.
4905 */
4906 case TMPL_ATTR_TYPE_UNRESOLVED:
4907 {
4908 unsigned int i, depth;
4909
4910 /*
4911 * This is the first unresolved component in a potential
4912 * chain of unresolved components. Print the path up to
4913 * the last known parent.
4914 */
4915 if (ar->ar_parent && !ar->ar_parent->flags.is_root) {
4916 fr_proto_da_stack_build_partial(&stack, ar->ar_parent, ar->ar_parent);
4917 if (ar->ar_parent->flags.is_root) {
4918 depth = 0;
4919 } else {
4920 depth = ar->ar_parent->depth - 1;
4921 }
4922
4923 for (i = depth; i < ar->ar_parent->depth; i++) {
4924 FR_SBUFF_IN_STRCPY_RETURN(&our_out, stack.da[i]->name);
4925 FR_SBUFF_IN_CHAR_RETURN(&our_out, '.');
4926 }
4927 }
4928 /*
4929 * Then print the unresolved component
4930 */
4931 FR_SBUFF_IN_BSTRCPY_BUFFER_RETURN(&our_out, ar->ar_unresolved);
4932 break;
4933 }
4934 }
4935
4936 if (ar_filter_is_none(ar)) {
4937 /* do nothing */
4938
4939 } else if (ar_filter_is_num(ar)) {
4940 switch (ar->ar_num) {
4941 case NUM_UNSPEC:
4942 break;
4943
4944 case NUM_ALL:
4945 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "[*]");
4946 break;
4947
4948 case NUM_COUNT:
4949 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "[#]");
4950 break;
4951
4952 case NUM_LAST:
4953 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "[n]");
4954 break;
4955
4956 default:
4957 FR_SBUFF_IN_SPRINTF_RETURN(&our_out, "[%i]", ar->ar_num);
4958 break;
4959 }
4960
4961 } else if (ar_filter_is_cond(ar)) {
4962 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "[");
4963 (void) xlat_print(&our_out, ar->ar_cond, NULL);
4964 FR_SBUFF_IN_STRCPY_LITERAL_RETURN(&our_out, "]");
4965
4966 } else {
4967 fr_assert(0);
4968 }
4969
4970 if (tmpl_attr_list_next(tmpl_attr(vpt), ar)) FR_SBUFF_IN_CHAR_RETURN(&our_out, '.');
4971 }
4972 FR_SBUFF_SET_RETURN(out, &our_out);
4973}
4974
4975/** Print a #tmpl_t to a string
4976 *
4977 * This function should primarily be used for regenerating vpt->name when the contents
4978 * of the #tmpl_t is changed programmatically, or when the #tmpl_t is being serialized
4979 * in some non-standard way, i.e. as a value for a field in a database.
4980 *
4981 * This function is the direct counterpart to #tmpl_afrom_substr.
4982 *
4983 * @note Does not print flags for regular expressions, as the quoting char is needed
4984 * to separate the elements of the expression.
4985 * Call regex_flags_print to write the flags values to the output buffer.
4986 *
4987 * @param[out] out Where to write the presentation format #tmpl_t string.
4988 * @param[in] vpt to print.
4989 * @param[in] e_rules Escaping rules used to print strings.
4990 * @return
4991 * - >0 the number of bytes written to the out buffer.
4992 * - 0 invalid argument.
4993 * - <0 the number of bytes we would have needed to complete the print.
4994 */
4995fr_slen_t tmpl_print(fr_sbuff_t *out, tmpl_t const *vpt,
4996 fr_sbuff_escape_rules_t const *e_rules)
4997{
4998 fr_sbuff_t our_out = FR_SBUFF(out);
4999
5000 TMPL_VERIFY(vpt);
5001
5002 switch (vpt->type) {
5003 case TMPL_TYPE_ATTR_UNRESOLVED:
5004 case TMPL_TYPE_ATTR:
5005 FR_SBUFF_RETURN(tmpl_attr_print, &our_out, vpt);
5006 break;
5007
5008 case TMPL_TYPE_DATA:
5009 FR_SBUFF_RETURN(fr_value_box_print, &our_out, tmpl_value(vpt), e_rules);
5010 break;
5011
5012 case TMPL_TYPE_REGEX:
5013 FR_SBUFF_IN_BSTRNCPY_RETURN(&our_out, vpt->name, vpt->len); /* Fixme - double escapes */
5014 break;
5015
5016 case TMPL_TYPE_REGEX_UNCOMPILED:
5017 FR_SBUFF_IN_ESCAPE_BUFFER_RETURN(&our_out, vpt->data.unescaped, e_rules);
5018 break;
5019
5020 case TMPL_TYPE_UNINITIALISED:
5021 case TMPL_TYPE_MAX:
5022 fr_sbuff_terminate(out);
5023 break;
5024
5025 /*
5026 * The remaining types will either
5027 * be xlat expansions, or need
5028 * resolving, in which case the
5029 * unescaped string is available
5030 * in vpt->unescaped.
5031 */
5032 default:
5033 if (tmpl_contains_xlat(vpt)) {
5034 FR_SBUFF_RETURN(xlat_print, &our_out, tmpl_xlat(vpt), e_rules);
5035 break;
5036 }
5037
5038 if (tmpl_needs_resolving(vpt)) {
5039 FR_SBUFF_IN_ESCAPE_BUFFER_RETURN(&our_out, vpt->data.unescaped, e_rules);
5040 break;
5041 }
5042
5043 fr_assert_fail("Can't print invalid tmpl type %s", tmpl_type_to_str(vpt->type));
5044
5045 /*
5046 * Ensure we do something sane for non-debug builds
5047 */
5048 fr_sbuff_terminate(out);
5049 return 0;
5050 }
5051
5052 FR_SBUFF_SET_RETURN(out, &our_out);
5053}
5054
5055/** Print a #tmpl_t to a string with quotes
5056 *
5057 * This function should be used when the tmpl is embedded in some other construct
5058 * in the server's configuration.
5059 *
5060 * It adds standard quoting around tmpl's used as operands in expressions and applies
5061 * the correct escaping rules.
5062 *
5063 * @param[out] out Where to write the presentation format #tmpl_t string.
5064 * @param[in] vpt to print.
5065 * @return
5066 * - >0 the number of bytes written to the out buffer.
5067 * - 0 invalid argument.
5068 * - <0 the number of bytes we would have needed to complete the print.
5069 */
5070fr_slen_t tmpl_print_quoted(fr_sbuff_t *out, tmpl_t const *vpt)
5071{
5072 fr_sbuff_t our_out = FR_SBUFF(out);
5073
5074 char quote = fr_token_quote[vpt->quote];
5075
5076 if (quote != '\0') FR_SBUFF_IN_CHAR_RETURN(&our_out, quote);
5077 FR_SBUFF_RETURN(tmpl_print, &our_out, vpt,
5078 fr_value_escape_by_quote[vpt->quote]);
5079 if (quote != '\0') FR_SBUFF_IN_CHAR_RETURN(&our_out, quote);
5080
5081 /*
5082 * Optionally print the flags
5083 */
5084 if (vpt->type & TMPL_FLAG_REGEX) FR_SBUFF_RETURN(regex_flags_print, &our_out, tmpl_regex_flags(vpt));
5085
5086 FR_SBUFF_SET_RETURN(out, &our_out);
5087}
5088/** @} */
5089
5090
5091#ifdef WITH_VERIFY_PTR
5092/** Used to check whether areas of a tmpl_t are zeroed out
5093 *
5094 * @param ptr Offset to begin checking at.
5095 * @param len How many bytes to check.
5096 * @return
5097 * - Pointer to the first non-zero byte.
5098 * - NULL if all bytes were zero.
5099 */
5100static uint8_t const *is_zeroed(uint8_t const *ptr, size_t len)
5101{
5102 size_t i;
5103
5104 for (i = 0; i < len; i++) {
5105 if (ptr[i] != 0x00) return ptr + i;
5106 }
5107
5108 return NULL;
5109}
5110
5111/** Verify that unused regions of the struct are zeroed out
5112 *
5113 */
5114#define CHECK_ZEROED(_vpt, _field) is_zeroed(((uint8_t const *)&(_vpt)->data) + sizeof((_vpt)->data._field), sizeof((_vpt)->data) - sizeof((_vpt)->data._field))
5115
5116
5117/** Print hex data
5118 *
5119 */
5120#define PRINT_NON_ZEROED(_vpt, _field, _nz_ptr) \
5121do { \
5122 DEBUG("Expected live portion %p-%p (0-%zu)", \
5123 _vpt, \
5124 (uint8_t const *)&(_vpt)->data + sizeof((_vpt)->data._field), \
5125 sizeof((_vpt)->data._field)); \
5126 DEBUG("Expected zero portion %p-%p (%zu-%zu)", \
5127 (uint8_t const *)&(_vpt)->data + sizeof((_vpt)->data._field), \
5128 (uint8_t const *)&(_vpt)->data + sizeof((_vpt)->data), \
5129 sizeof((_vpt)->data._field), sizeof((_vpt)->data)); \
5130 HEX_MARKER1((uint8_t const *)&vpt->data, sizeof(vpt->data), nz - (uint8_t const *)&vpt->data, "non-zero memory", ""); \
5131} while (0)
5132
5133
5134/** Verify the attribute reference in a tmpl_t make sense
5135 *
5136 * @note If the attribute reference is invalid, causes the server to exit.
5137 *
5138 * @param file obtained with __FILE__.
5139 * @param line obtained with __LINE__.
5140 * @param vpt to check.
5141 */
5142void tmpl_attr_verify(char const *file, int line, tmpl_t const *vpt)
5143{
5144 tmpl_attr_t *ar = NULL;
5145 tmpl_attr_t *slow = NULL, *fast = NULL;
5146 tmpl_attr_t *seen_unknown = NULL;
5147 tmpl_attr_t *seen_unresolved = NULL;
5148
5149 fr_assert(tmpl_is_attr_unresolved(vpt) || tmpl_is_attr(vpt));
5150
5151 /*
5152 * Loop detection
5153 */
5154 while ((slow = tmpl_attr_list_next(tmpl_attr(vpt), slow)) &&
5155 (fast = tmpl_attr_list_next(tmpl_attr(vpt), fast))) {
5156
5157 /*
5158 * Advances twice as fast as slow...
5159 */
5160 fast = tmpl_attr_list_next(tmpl_attr(vpt), fast);
5161 fr_fatal_assert_msg(fast != slow,
5162 "CONSISTENCY CHECK FAILED %s[%u]: Looping reference list found. "
5163 "Fast pointer hit slow pointer at \"%s\"",
5164 file, line,
5165 slow->type == TMPL_ATTR_TYPE_UNRESOLVED ? slow->ar_unresolved :
5166 slow->da ? slow->da->name : "(null-attr)");
5167 }
5168
5169 /*
5170 * Lineage type check
5171 *
5172 * Known attribute cannot come after unresolved or unknown attributes
5173 * Unknown attributes cannot come after unresolved attributes
5174 */
5175 if (!tmpl_is_list(vpt)) while ((ar = tmpl_attr_list_next(tmpl_attr(vpt), ar))) {
5176 switch (ar->type) {
5177 case TMPL_ATTR_TYPE_NORMAL:
5178 if (seen_unknown) {
5179 tmpl_attr_debug(stderr, vpt);
5180 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: "
5181 "TMPL_TYPE_ATTR known attribute \"%s\" "
5182 "occurred after unknown attribute %s "
5183 "in attr ref list",
5184 file, line,
5185 ar->da->name,
5186 ar->unknown.da->name);
5187 }
5188 if (seen_unresolved) {
5189 tmpl_attr_debug(stderr, vpt);
5190 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: "
5191 "TMPL_TYPE_ATTR known attribute \"%s\" "
5192 "occurred after unresolved attribute \"%s\""
5193 "in attr ref list",
5194 file, line,
5195 ar->da->name,
5196 ar->ar_unresolved);
5197 }
5198 fr_fatal_assert_msg(ar->ar_parent,
5199 "CONSISTENCY CHECK FAILED %s[%u]: attr ref missing parent",
5200 file, line);
5201
5202 if (ar->ar_parent->type != FR_TYPE_GROUP) {
5203 fr_fatal_assert_msg(ar->ar_parent == ar->ar_da->parent,
5204 "CONSISTENCY CHECK FAILED %s[%u]: attr ref has wrong parent: "
5205 "Expected %s, got %s",
5206 file, line,
5207 ar->ar_da->parent->name,
5208 ar->ar_parent->name);
5209
5210 }
5211 break;
5212
5213 case TMPL_ATTR_TYPE_UNSPEC:
5214 if (seen_unknown) {
5215 tmpl_attr_debug(stderr, vpt);
5216 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: "
5217 "TMPL_TYPE_ATTR unspecified attribute "
5218 "occurred after unknown attribute %s "
5219 "in attr ref list",
5220 file, line,
5221 ar->unknown.da->name);
5222 }
5223 if (seen_unresolved) {
5224 tmpl_attr_debug(stderr, vpt);
5225 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: "
5226 "TMPL_TYPE_ATTR unspecified attribute "
5227 "occurred after unresolved attribute \"%s\""
5228 "in attr ref list",
5229 file, line,
5230 ar->ar_unresolved);
5231 }
5232 break;
5233
5234 case TMPL_ATTR_TYPE_UNRESOLVED:
5235 seen_unresolved = ar;
5236 fr_fatal_assert_msg(ar->ar_unresolved_namespace,
5237 "CONSISTENCY CHECK FAILED %s[%u]: unresolved attr ref missing namespace",
5238 file, line);
5239 break;
5240
5241 case TMPL_ATTR_TYPE_UNKNOWN:
5242 seen_unknown = ar;
5243 if (seen_unresolved) {
5244 tmpl_attr_debug(stderr, vpt);
5245 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: "
5246 "TMPL_TYPE_ATTR unknown attribute \"%s\" "
5247 "occurred after unresolved attribute %s "
5248 "in attr ref list",
5249 file, line, ar->da->name,
5250 ar->ar_unresolved);
5251 }
5252 break;
5253 }
5254 }
5255}
5256
5257/** Verify fields of a tmpl_t make sense
5258 *
5259 * @note If the #tmpl_t is invalid, causes the server to exit.
5260 *
5261 * @param file obtained with __FILE__.
5262 * @param line obtained with __LINE__.
5263 * @param vpt to check.
5264 */
5265void tmpl_verify(char const *file, int line, tmpl_t const *vpt)
5266{
5267 uint8_t const *nz;
5268
5269 fr_assert(vpt);
5270
5271 if (tmpl_is_uninitialised(vpt)) {
5272 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: tmpl_t type was "
5273 "TMPL_TYPE_UNINITIALISED (uninitialised)", file, line);
5274 }
5275
5276 if (vpt->type >= TMPL_TYPE_MAX) {
5277 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: tmpl_t type was %i "
5278 "(outside range of tmpl_type_table)", file, line, vpt->type);
5279 }
5280
5281 if (!vpt->name && (vpt->quote != T_INVALID)) {
5282 char quote = vpt->quote >= T_TOKEN_LAST ? '?' : fr_token_quote[vpt->quote];
5283
5284 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: Quote type '%c' (%i) was set for NULL name",
5285 file, line, quote, vpt->quote);
5286 }
5287
5288 if (vpt->name && (vpt->quote == T_INVALID)) {
5289 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: No quoting type was set for name \"%.*s\"",
5290 file, line, (int)vpt->len, vpt->name);
5291 }
5292
5293 /*
5294 * Do a memcmp of the bytes after where the space allocated for
5295 * the union member should have ended and the end of the union.
5296 * These should always be zero if the union has been initialised
5297 * properly.
5298 *
5299 * If they're still all zero, do TMPL_TYPE specific checks.
5300 */
5301 switch (vpt->type) {
5302 case TMPL_TYPE_DATA_UNRESOLVED:
5303 if (!vpt->data.unescaped) {
5304 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_DATA_UNRESOLVED "
5305 "unescaped field is NULL", file, line);
5306 }
5307 break;
5308
5309 case TMPL_TYPE_XLAT_UNRESOLVED:
5310 if (!vpt->data.xlat.ex) {
5311 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_XLAT "
5312 "has a NULL xlat.ex field", file, line);
5313
5314 }
5315
5316 if (!xlat_needs_resolving(vpt->data.xlat.ex)) {
5317 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_XLAT_UNRESOLVED "
5318 "does not have 'needs resolving' flag set", file, line);
5319 }
5320 break;
5321
5322 case TMPL_TYPE_XLAT:
5323 if (!vpt->data.xlat.ex) {
5324 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_XLAT "
5325 "has a NULL xlat.ex field", file, line);
5326
5327 }
5328 break;
5329
5330/* @todo When regexes get converted to xlat the flags field of the regex union is used
5331 case TMPL_TYPE_XLAT_UNRESOLVED:
5332 if (is_zeroed((uint8_t const *)&vpt->data, sizeof(vpt->data))) {
5333 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_XLAT_UNRESOLVED "
5334 "has non-zero bytes in its data union", file, line);
5335 }
5336 break;
5337
5338 case TMPL_TYPE_XLAT:
5339 if (CHECK_ZEROED(vpt, xlat)) {
5340 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_XLAT "
5341 "has non-zero bytes after the data.xlat pointer in the union", file, line);
5342 }
5343 break;
5344*/
5345
5346 case TMPL_TYPE_EXEC:
5347 case TMPL_TYPE_EXEC_UNRESOLVED:
5348 /* tmpl_xlat(vpt) can be initialized */
5349 break;
5350
5351 case TMPL_TYPE_ATTR_UNRESOLVED:
5352 if ((tmpl_attr_list_num_elements(tmpl_attr(vpt)) > 0) &&
5353 ((tmpl_attr_t *)tmpl_attr_list_tail(tmpl_attr(vpt)))->da) {
5354#ifndef NDEBUG
5355 tmpl_attr_debug(stderr, vpt);
5356#endif
5357 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_ATTR_UNRESOLVED contains %u "
5358 "references", file, line, tmpl_attr_list_num_elements(tmpl_attr(vpt)));
5359 }
5360 break;
5361
5362 case TMPL_TYPE_ATTR:
5363 if ((nz = CHECK_ZEROED(vpt, attribute))) {
5364 PRINT_NON_ZEROED(vpt, attribute, nz);
5365 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_ATTR "
5366 "has non-zero bytes after the data.attribute struct in the union",
5367 file, line);
5368 }
5369
5370 if (tmpl_attr_tail_is_unspecified(vpt)) {
5371 fr_assert(vpt->rules.cast == FR_TYPE_NULL);
5372 break;
5373 }
5374
5375 if (tmpl_attr_tail_is_unknown(vpt)) {
5376 if (tmpl_attr_tail_da(vpt) != tmpl_attr_tail_unknown(vpt)) {
5377 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_ATTR "
5378 "da is marked as unknown, but address is not equal to the template's "
5379 "unknown da pointer", file, line);
5380 }
5381 /*
5382 * Raw attributes may not have been added to the dictionary yet
5383 */
5384 } else {
5385 fr_dict_attr_t const *da;
5386 fr_dict_t const *dict;
5387
5388 /*
5389 * Attribute may be present with multiple names
5390 */
5391 dict = fr_dict_by_da(tmpl_attr_tail_da(vpt));
5392 if (!dict) {
5393 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_ATTR "
5394 "attribute \"%s\" (%s) not rooted in a dictionary",
5395 file, line, tmpl_attr_tail_da(vpt)->name,
5396 fr_type_to_str(tmpl_attr_tail_da(vpt)->type));
5397 }
5398
5399 da = tmpl_attr_tail_da(vpt);
5400 if (!tmpl_attr_tail_is_raw(vpt) && (da != tmpl_attr_tail_da(vpt))) {
5401 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_ATTR "
5402 "dictionary pointer %p \"%s\" (%s) "
5403 "and global dictionary pointer %p \"%s\" (%s) differ",
5404 file, line,
5405 tmpl_attr_tail_da(vpt), tmpl_attr_tail_da(vpt)->name,
5406 fr_type_to_str(tmpl_attr_tail_da(vpt)->type),
5407 da, da->name,
5408 fr_type_to_str(da->type));
5409 }
5410
5411 tmpl_attr_verify(file, line, vpt);
5412 }
5413 break;
5414
5415 case TMPL_TYPE_DATA:
5416 if ((nz = CHECK_ZEROED(vpt, literal))) {
5417 PRINT_NON_ZEROED(vpt, literal, nz);
5418 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_DATA "
5419 "has non-zero bytes after the data.literal struct in the union",
5420 file, line);
5421 }
5422
5423 /*
5424 * An FR_TYPE_NULL box inside a TMPL_TYPE_DATA used to
5425 * fire here as the "you forgot to init the box" signal,
5426 * but the `null` keyword (see tmpl_afrom_null_substr)
5427 * deliberately constructs one. Accept it.
5428 */
5429 if (tmpl_value_type(vpt) >= FR_TYPE_MAX) {
5430 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_DATA type was "
5431 "%i (outside the range of fr_type_ts)", file, line, tmpl_value_type(vpt));
5432 }
5433 /*
5434 * Unlike fr_pair_ts we can't guarantee that fr_pair_t_TMPL buffers will
5435 * be talloced. They may be allocated on the stack or in global variables.
5436 */
5437 switch (tmpl_value_type(vpt)) {
5438 case FR_TYPE_STRING:
5439 if (tmpl_value(vpt)->vb_strvalue[tmpl_value_length(vpt)] != '\0') {
5440 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_DATA char buffer not \\0 "
5441 "terminated", file, line);
5442 }
5443 break;
5444
5445 case FR_TYPE_STRUCTURAL:
5446 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_DATA is of type TLV",
5447 file, line);
5448
5449 default:
5450 break;
5451 }
5452
5453 break;
5454
5455 case TMPL_TYPE_REGEX_UNCOMPILED:
5456 case TMPL_TYPE_REGEX_XLAT:
5457 case TMPL_TYPE_REGEX_XLAT_UNRESOLVED:
5458#ifndef HAVE_REGEX
5459 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_REGEX_XLAT_UNRESOLVED - No regex support",
5460 file, line);
5461#endif
5462 break;
5463
5464 case TMPL_TYPE_REGEX:
5465#ifdef HAVE_REGEX
5466 if (tmpl_regex(vpt) == NULL) {
5467 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_REGEX "
5468 "reg.ex field was NULL", file, line);
5469 }
5470#else
5471 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_REGEX - No regex support",
5472 file, line);
5473#endif
5474 break;
5475
5476 case TMPL_TYPE_UNINITIALISED:
5477 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_UNINITIALISED", file, line);
5478
5479 case TMPL_TYPE_MAX:
5480 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%u]: TMPL_TYPE_MAX", file, line);
5481 }
5482}
5483#endif
5484
5485static const bool array_terminal[SBUFF_CHAR_CLASS] = {
5486 [ ']' ] = true,
5487};
5488
5489#define return_P(_x) fr_strerror_const(_x);goto return_p
5490
5491#define is_char(_offset, _x) (((p + _offset) < end) && (p[_offset] == _x))
5492
5493/** Preparse a string in preparation for passing it to tmpl_afrom_substr()
5494 *
5495 * Note that the input string is not modified, which means that the
5496 * tmpl_afrom_substr() function MUST un-escape it.
5497 *
5498 * The caller should pass 'out' and 'outlen' to tmpl_afrom_substr()
5499 * as 'in' and 'inlen'. The caller should also pass 'type'.
5500 * The caller should also pass do_unescape=true.
5501 *
5502 * @param[out] out start of the string to parse
5503 * @param[out] outlen length of the string to parse
5504 * @param in where we start looking for the string
5505 * @param inlen length of the input string
5506 * @param[out] type token type of the string.
5507 * @return
5508 * - > 0, amount of parsed string to skip, to get to the next token
5509 * - <=0, -offset in 'start' where the parse error was located
5510 */
5511ssize_t tmpl_preparse(char const **out, size_t *outlen, char const *in, size_t inlen,
5512 fr_token_t *type)
5513{
5514 char const *p = in, *end = in + inlen;
5515 char quote;
5516 char close;
5517 int depth;
5518 bool triple;
5519
5520 *type = T_INVALID;
5521
5522 while (isspace((uint8_t) *p) && (p < end)) p++;
5523 if (p >= end) return p - in;
5524
5525 switch (*p) {
5526 /*
5527 * Allow bare xlat's
5528 */
5529 case '%':
5530 if (p[1] != '{') {
5531 char const *q;
5532
5533 q = p + 1;
5534
5535 /*
5536 * Function syntax: %foo(...)
5537 */
5538 while ((q < end) && (isalnum((int) *q) || (*q == '.') || (*q == '_') || (*q == '-'))) {
5539 q++;
5540 }
5541
5542 if (*q != '(') {
5543 p++;
5544 fr_strerror_const("Invalid character after '%'");
5545 return_p:
5546 return -(p - in);
5547 }
5548
5549 /*
5550 * Return the whole %foo(...) string.
5551 */
5552 *out = p;
5553 if (*type == T_INVALID) *type = T_BARE_WORD;
5554 close = ')';
5555
5556 p = q + 1;
5557 depth = 1;
5558 goto loop;
5559 }
5560
5561 /*
5562 * For now, %{...} is treated as a double-quoted
5563 * string. Once we clean other things up, the
5564 * xlats will be treated as strongly typed values
5565 * / lists on their own.
5566 */
5567 if (*type == T_INVALID) *type = T_BARE_WORD;
5568 depth = 0;
5569 close = '}';
5570
5571 /*
5572 * Xlat's are quoted by %{...} / %(...) nesting, not by
5573 * escapes, so we need to do special escaping.
5574 */
5575 *out = p;
5576 loop:
5577 while (*p) {
5578 /*
5579 * End of expansion. Return the entire
5580 * expansion, including the enclosing %{}
5581 * characters.
5582 */
5583 if ((*p == '}') || (*p == ')')) {
5584 bool match = (*p == close);
5585
5586 p++;
5587 depth--;
5588
5589 if (depth == 0) {
5590 if (!match) break;
5591
5592 *outlen = p - (*out);
5593 return p - in;
5594 }
5595 continue;
5596 }
5597
5598 if (*p == '\\') {
5599 if (is_char(1, '\0')) {
5600 return_P("End of string after escape");
5601 }
5602 p += 2;
5603 continue;
5604 }
5605
5606 if ((p[0] == '%') && (is_char(1, '{') || is_char(1, '('))) {
5607 if (is_char(2, '\0')) {
5608 return_P("End of string after expansion");
5609 }
5610
5611 p += 2;
5612 depth++;
5613 continue;
5614 }
5615
5616 /*
5617 * Allow (...) and {...}
5618 */
5619 if ((*p == '{') || (*p == '(')) {
5620 p++;
5621 depth++;
5622 continue;
5623 }
5624
5625 p++;
5626 }
5627
5628 /*
5629 * End of input without end of string.
5630 * Point the error to the start of the string.
5631 */
5632 p = *out;
5633 return_P("Unterminated expansion");
5634
5635 case '/':
5636 goto bare_word;
5637
5638 case '\'':
5639 quote = *(p++);
5640 *type = T_SINGLE_QUOTED_STRING;
5641 goto skip_string;
5642
5643 case '`':
5644 quote = *(p++);
5645 *type = T_BACK_QUOTED_STRING;
5646 goto skip_string;
5647
5648 case '"':
5649 quote = *(p++);
5650 *type = T_DOUBLE_QUOTED_STRING;
5651
5652 /*
5653 * We're not trying to do a *correct* parsing of
5654 * every string here. We're trying to do a
5655 * simple parse that isn't wrong. We therefore
5656 * accept most anything that's vaguely well
5657 * formed, and rely on the next stage to do a
5658 * more rigorous check.
5659 */
5660 skip_string:
5661 if (is_char(0, quote) && is_char(1, quote)) {
5662 triple = true;
5663 p += 2;
5664 } else {
5665 triple = false;
5666 }
5667 *out = p;
5668
5669 while (*p) {
5670 if (p >= end) goto unterminated;
5671
5672 /*
5673 * End of string. Tell the caller the
5674 * length of the data inside of the
5675 * string, and return the number of
5676 * characters to skip.
5677 */
5678 if (*p == quote) {
5679 if (!triple) {
5680 *outlen = p - (*out);
5681 p++;
5682 return p - in;
5683
5684 }
5685
5686
5687 if (is_char(1, quote) && is_char(2, quote)) {
5688 *outlen = p - (*out);
5689 p += 3;
5690 return p - in;
5691 }
5692
5693 p++;
5694 continue;
5695 }
5696
5697 if (*p == '\\') {
5698 if (is_char(1, '\0')) {
5699 return_P("End of string after escape");
5700 }
5701 p++;
5702 }
5703 p++;
5704 }
5705
5706 /*
5707 * End of input without end of string.
5708 * Point the error to the start of the string.
5709 */
5710 unterminated:
5711 p = *out;
5712 return_P("Unterminated string");
5713
5714 case '&':
5715 *out = p; /* the output string starts with '&' */
5716 p++;
5717 quote = '[';
5718 goto skip_word;
5719
5720 default:
5721 bare_word:
5722 *out = p;
5723 quote = '['; /* foo[1] is OK */
5724
5725 skip_word:
5726 *type = T_BARE_WORD;
5727 depth = 0;
5728
5729 /*
5730 * Allow *most* things. But stop on spaces and special characters.
5731 */
5732 while (*p) {
5733 if (isspace((uint8_t) *p)) {
5734 break;
5735 }
5736
5737 if (*p == '$') {
5738 if (p[1] == '{') {
5739 p += 2;
5740 depth++;
5741 continue;
5742
5743 } else if ((p[1] >= 'A') && (p[1] <= 'Z')) {
5744 p++;
5745 while ((*p >= 'A') && (*p <= 'Z')) {
5746 p++;
5747 }
5748
5749 if (*p != '{') {
5750 return_P("Missing '{'");
5751 }
5752
5753 depth++;
5754 continue;
5755
5756 } else {
5757 /*
5758 * Bare '$' is wrong...
5759 */
5760 break;
5761 }
5762 }
5763
5764 if (*p == '%') {
5765 if (p[1] == '{') {
5766 p += 2;
5767 depth++;
5768 continue;
5769 }
5770
5771 p++;
5772 continue;
5773 }
5774
5775 /*
5776 * If we're inside of a ${...} expansion,
5777 * then allow everything until the
5778 * closing '}'. This means that we can
5779 * do ${foo[bar].baz}, among other
5780 * thingds.
5781 */
5782 if (depth > 0) {
5783 if (*p == '}') {
5784 depth--;
5785 }
5786
5787 p++;
5788 continue;
5789 }
5790
5791 /*
5792 * '-' is special. We allow it for
5793 * attribute names, BUT it's a
5794 * terminating token if the NEXT
5795 * character is '='.
5796 *
5797 * We have the same criteria for IPv6
5798 * addresses and tagged attributes. ':'
5799 * is allowed, but ':=' is a breaking
5800 * token.
5801 */
5802 if ((*p == '-') || (*p == ':')) {
5803 if (p[1] == '=') break;
5804 p++;
5805 continue;
5806 }
5807
5808 /*
5809 * Allowed in attribute names, and/or
5810 * host names and IP addresses, and IPv6 addresses.
5811 */
5812 if ((*p == '.') || (*p == '/') || (*p == '_') || (*p == '*') ||
5813 (*p == ']') || (*p == '@')) {
5814 p++;
5815 continue;
5816 }
5817
5818 /*
5819 * [...] is an IPv6 address.
5820 */
5821 if ((p == in) && (*p == '[')) {
5822 p++;
5823 continue;
5824 }
5825
5826 /*
5827 * Allow letters and numbers
5828 */
5829 if (((*p >= 'a') && (*p <= 'z')) ||
5830 ((*p >= 'A') && (*p <= 'Z')) ||
5831 ((*p >= '0') && (*p <= '9'))) {
5832 p++;
5833 continue;
5834 }
5835
5836 /*
5837 * Allow UTF-8 sequences.
5838 */
5839 if (*(uint8_t const *)p > 0x80) {
5840 p++;
5841 continue;
5842 }
5843
5844 /*
5845 * If it's an attribute reference, allow
5846 * a few more things inside of a "[...]"
5847 * block.
5848 */
5849 if (*p == '[') {
5850 if (quote != '[') {
5851 return_P("Invalid location for '['");
5852 }
5853
5854 p++;
5855
5856 /*
5857 * Allow [#], etc. But stop
5858 * immediately after the ']'.
5859 */
5860 if ((*p == '#') || (*p == '*') || (*p == 'n')) {
5861 p++;
5862
5863 } else {
5864 ssize_t slen;
5865 bool eol = false;
5866
5867 slen = fr_skip_condition(p, end, array_terminal, &eol);
5868 if (slen < 0) {
5869 p += -slen;
5870 return -(p - in);
5871 }
5872 p += slen;
5873 continue;
5874 }
5875
5876 if (*p == ']') {
5877 p++;
5878 continue;
5879 }
5880 }
5881
5882 /*
5883 * Everything else is a breaking token
5884 */
5885 break;
5886 }
5887
5888 /*
5889 * Give some slightly better error messages.
5890 */
5891 if (*p == '\\') {
5892 return_P("Unexpected escape");
5893 }
5894
5895 if ((*p == '"') || (*p == '\'') || (*p == '`')) {
5896 return_P("Unexpected start of string");
5897 }
5898
5899 if (p == *out) {
5900 return_P("Empty string is invalid");
5901 }
5902
5903 *outlen = p - (*out);
5904 break;
5905 }
5906
5907 return p - in;
5908}
5909
5910/** Return whether or not async is required for this tmpl.
5911 *
5912 * If the tmpl is needs_async, then it is async
5913 * If the tmpl is not needs_async, then it will not yield
5914 *
5915 * If the tmpl yields, then async is required.
5916 */
5917bool tmpl_async_required(tmpl_t const *vpt)
5918{
5919 switch (vpt->type) {
5920 case TMPL_TYPE_EXEC: /* we don't have "exec no-wait" here */
5921 case TMPL_TYPE_XLAT_UNRESOLVED: /* we have no idea, so be safe */
5922#ifndef HAVE_REGEX
5923 case TMPL_TYPE_REGEX_XLAT_UNRESOLVED:
5924#endif
5925 return true;
5926
5927#ifndef HAVE_REGEX
5928 case TMPL_TYPE_REGEX_XLAT:
5929#endif
5930 case TMPL_TYPE_XLAT: /* synchronous xlats use unlang_interpret_synchronous() */
5931 default:
5932 return false;
5933 }
5934}
5935
5936/** Initialize a set of rules from a parent set of rules, and a parsed tmpl_t
5937 *
5938 */
5939void tmpl_rules_child_init(TALLOC_CTX *ctx, tmpl_rules_t *out, tmpl_rules_t const *parent, tmpl_t *vpt)
5940{
5941 fr_dict_attr_t const *da;
5942 fr_dict_attr_t const *ref;
5943 fr_dict_t const *dict, *internal;
5944
5945 *out = *parent;
5946 /* don't set ->parent=parent, that is only for switching subrequest, etc. */
5947
5948 if (!tmpl_is_attr(vpt)) return;
5949
5950 da = tmpl_attr_tail_da(vpt);
5951
5952 /*
5953 * The input tmpl is a leaf. We must parse the child as
5954 * a normal attribute reference (as with the parent tmpl).
5955 */
5956 if (!fr_type_structural[da->type]) {
5957 return;
5958 }
5959
5960 if (vpt->rules.attr.request_def) {
5961 tmpl_request_ref_list_acopy(ctx, &out->attr.request_def, vpt->rules.attr.request_def);
5962 }
5963 out->attr.list_def = tmpl_list(vpt);
5964
5965 /*
5966 * Parse the child attributes in the context of the parent struct / tlv / whatever.
5967 */
5968 if (da->type != FR_TYPE_GROUP) {
5969 out->attr.dict_def = fr_dict_by_da(da);
5970 out->attr.namespace = da;
5971 return;
5972 }
5973
5974 ref = fr_dict_attr_ref(da);
5975 dict = fr_dict_by_da(ref);
5976 internal = fr_dict_internal();
5977
5978 /*
5979 * Groups MAY change dictionaries. If so, then swap the dictionary and the parent.
5980 */
5981 if ((dict != internal) && (dict != out->attr.dict_def)) {
5982 out->attr.dict_def = dict;
5983 out->attr.namespace = ref;
5984 }
5985
5986 /*
5987 * Otherwise the reference is swapping FROM a protocol
5988 * dictionary TO the internal dictionary, and TO an
5989 * internal group. We fall back to leaving well enough
5990 * alone, and leave things as-is. This allows internal
5991 * grouping attributes to appear anywhere.
5992 */
5993}
5994
5995static void tmpl_attr_rules_debug(tmpl_attr_rules_t const *at_rules)
5996{
5997 FR_FAULT_LOG("\tdict_def = %s", at_rules->dict_def ? fr_dict_root(at_rules->dict_def)->name : "");
5998 FR_FAULT_LOG("\tnamespace = %s", at_rules->namespace ? at_rules->namespace->name : "");
5999
6000 FR_FAULT_LOG("\tlist_def = %s", at_rules->list_def ? at_rules->list_def->name : "");
6001
6002 FR_FAULT_LOG("\tallow_unknown = %u", at_rules->allow_unknown);
6003 FR_FAULT_LOG("\tallow_unresolved = %u", at_rules->allow_unresolved);
6004 FR_FAULT_LOG("\tallow_wildcard = %u", at_rules->allow_wildcard);
6005 FR_FAULT_LOG("\tallow_foreign = %u", at_rules->allow_foreign);
6006 FR_FAULT_LOG("\tdisallow_filters = %u", at_rules->disallow_filters);
6007}
6008
6009
6010void tmpl_rules_debug(tmpl_rules_t const *rules)
6011{
6012 FR_FAULT_LOG("\tparent = %p", rules->parent);
6013 FR_FAULT_LOG(" attr {");
6014 tmpl_attr_rules_debug(&rules->attr);
6015 FR_FAULT_LOG(" }");
6016 FR_FAULT_LOG("\tenumv = %s", rules->enumv ? rules->enumv->name : "");
6017 FR_FAULT_LOG("\tcast = %s", fr_type_to_str(rules->cast));
6018 FR_FAULT_LOG("\tat_runtime = %u", rules->at_runtime);
6019 FR_FAULT_LOG("\tliterals_safe_for = %lx", rules->literals_safe_for);
6020
6021}
buffer
static int const char char buffer[256]
Definition acutest.h:576
va_end
va_end(args)
fmt
static int const char * fmt
Definition acutest.h:573
line
int const char int line
Definition acutest.h:702
va_start
va_start(args, fmt)
fr_base16_decode
#define fr_base16_decode(_err, _out, _in, _no_trailing)
Definition base16.h:92
UNCONST
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
Definition build.h:186
RCSID
#define RCSID(id)
Definition build.h:512
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:343
STRINGIFY
#define STRINGIFY(x)
Definition build.h:216
CMP_RETURN
#define CMP_RETURN(_a, _b, _field)
Return if the comparison is not 0 (is unequal)
Definition build.h:122
CMP
#define CMP(_a, _b)
Same as CMP_PREFER_SMALLER use when you don't really care about ordering, you just want an ordering.
Definition build.h:113
unlikely
#define unlikely(_x)
Definition build.h:407
NUM_ELEMENTS
#define NUM_ELEMENTS(_t)
Definition build.h:358
check_config
bool check_config
Definition cf_file.c:61
cf_log_warn
#define cf_log_warn(_cf, _fmt,...)
Definition cf_util.h:346
skip_word
static char const * skip_word(char const *text)
Definition command.c:1880
dict
fr_dict_t * dict
Definition common.c:31
fr_dbuff_init
#define fr_dbuff_init(_out, _start, _len_or_end)
Initialise an dbuff for encoding or decoding.
Definition dbuff.h:362
FR_DBUFF_TMP
#define FR_DBUFF_TMP(_start, _len_or_end)
Creates a compound literal to pass into functions which accept a dbuff.
Definition dbuff.h:522
fr_fatal_assert_fail
#define fr_fatal_assert_fail(_msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:183
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:131
fr_assert_msg
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:202
fr_assert_fail
#define fr_assert_fail(_msg,...)
Calls panic_action ifndef NDEBUG, else logs error.
Definition debug.h:208
FR_FAULT_LOG
#define FR_FAULT_LOG(_fmt,...)
Definition debug.h:50
fr_fatal_assert_msg
#define fr_fatal_assert_msg(_x, _fmt,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:176
MEM
#define MEM(x)
Definition debug.h:36
fr_dict_attr_by_name_substr
fr_slen_t fr_dict_attr_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *name, fr_sbuff_term_t const *tt))
fr_dict_attr_flags_t::name_only
unsigned int name_only
this attribute should always be referred to by name.
Definition dict.h:100
fr_dict_enum_name_from_substr
fr_slen_t fr_dict_enum_name_from_substr(fr_sbuff_t *out, fr_sbuff_parse_error_t *err, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
Extract an enumeration name from a string.
Definition dict_util.c:3798
fr_dict_unconst
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4880
fr_dict_by_da
fr_dict_t const * fr_dict_by_da(fr_dict_attr_t const *da)
Attempt to locate the protocol dictionary containing an attribute.
Definition dict_util.c:2848
fr_dict_attr_nested_allowed_chars
bool const fr_dict_attr_nested_allowed_chars[SBUFF_CHAR_CLASS]
Characters allowed in a nested dictionary attribute name.
Definition dict_util.c:63
fr_dict_attr_common_parent
fr_dict_attr_t const * fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor)
Find a common ancestor that two TLV type attributes share.
Definition dict_util.c:2287
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
err
static fr_slen_t err
Definition dict.h:882
fr_dict_attr_unknown_vendor_afrom_num
static fr_dict_attr_t * fr_dict_attr_unknown_vendor_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int vendor)
Definition dict.h:604
fr_dict_attr_unknown_copy
static fr_dict_attr_t * fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Definition dict.h:584
fr_dict_attr_unknown_add
fr_dict_attr_t const * fr_dict_attr_unknown_add(fr_dict_t *dict, fr_dict_attr_t const *old)
Converts an unknown to a known by adding it to the internal dictionaries.
Definition dict_unknown.c:123
fr_dict_attr_by_name
fr_dict_attr_t const * fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *attr))
Locate a fr_dict_attr_t by its name.
Definition dict_util.c:3505
fr_dict_attr_unconst
fr_dict_attr_t * fr_dict_attr_unconst(fr_dict_attr_t const *da)
Coerce to non-const.
Definition dict_util.c:4892
fr_dict_attr_unknown_afrom_da
fr_dict_attr_t * fr_dict_attr_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da))
Copy a known or unknown attribute to produce an unknown attribute with the specified name.
Definition dict_unknown.c:345
fr_dict_attr_unknown_raw_afrom_num
static fr_dict_attr_t * fr_dict_attr_unknown_raw_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int attr)
Definition dict.h:611
fr_dict_root
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2639
fr_dict_attr_unknown_parent_to_known
int fr_dict_attr_unknown_parent_to_known(fr_dict_attr_t *da, fr_dict_attr_t const *parent)
Fixup the parent of an unknown attribute using an equivalent known attribute.
Definition dict_unknown.c:641
fr_dict_enum_value_t::value
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:257
fr_dict_attr_unknown_free
void fr_dict_attr_unknown_free(fr_dict_attr_t const **da)
Free dynamically allocated (unknown attributes)
Definition dict_unknown.c:233
fr_dict_internal
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4905
fr_dict_attr_search_by_qualified_name_substr
fr_slen_t fr_dict_attr_search_by_qualified_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
Definition dict_util.c:3217
fr_dict_attr_search_by_name_substr
fr_slen_t fr_dict_attr_search_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a fr_dict_attr_t by its name in the top level namespace of a dictionary.
Definition dict_util.c:3246
fr_dict_enum_name_afrom_substr
static fr_slen_t fr_dict_enum_name_afrom_substr(TALLOC_CTX *ctx, char **out, fr_sbuff_parse_error_t *err, fr_sbuff_t *in, fr_sbuff_term_t const *tt) 1(fr_dict_enum_name_from_substr
FR_DICT_MAX_TLV_STACK
#define FR_DICT_MAX_TLV_STACK
Maximum TLV stack size.
Definition dict.h:517
fr_dict_attr_err_t
fr_dict_attr_err_t
Errors returned by attribute lookup functions.
Definition dict.h:317
FR_DICT_ATTR_OK
@ FR_DICT_ATTR_OK
No error.
Definition dict.h:318
FR_DICT_ATTR_NOT_DESCENDENT
@ FR_DICT_ATTR_NOT_DESCENDENT
Attribute is not a descendent of the parent attribute.
Definition dict.h:324
FR_DICT_ATTR_NO_CHILDREN
@ FR_DICT_ATTR_NO_CHILDREN
Child lookup in attribute with no children.
Definition dict.h:328
fr_dict_attr_add
int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr, fr_type_t type, fr_dict_attr_flags_t const *flags))
Add an attribute to the dictionary.
Definition dict_util.c:1942
fr_dict_attr_child_by_num
fr_dict_attr_t const * fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr)
Check if a child attribute exists in a parent using an attribute number.
Definition dict_util.c:3570
fr_dict_enum_by_name
fr_dict_enum_value_t const * fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len)
Definition dict_util.c:3678
in
static fr_slen_t in
Definition dict.h:882
FR_DICT_ATTR_MAX_NAME_LEN
#define FR_DICT_ATTR_MAX_NAME_LEN
Maximum length of a attribute name.
Definition dict.h:501
fr_dict_attr_flags_t
Values of the encryption flags.
Definition merged_model.c:139
fr_dict_enum_value_t
Value of an enumerated attribute.
Definition dict.h:253
fr_dict_attr_ref
static fr_dict_attr_t const * fr_dict_attr_ref(fr_dict_attr_t const *da)
Return the reference associated with a group type attribute.
Definition dict_ext.h:148
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_HEAD
#define FR_DLIST_HEAD(_name)
Expands to the type name used for the head wrapper structure.
Definition dlist.h:1104
tr_rules
static tmpl_res_rules_t tr_rules
Definition fuzzer_tmpl.c:53
talloc_free
talloc_free(hp)
FR_IPADDR_STRLEN
#define FR_IPADDR_STRLEN
Like INET6_ADDRSTRLEN but includes space for the textual Zone ID.
Definition inet.h:88
stack
static char * stack[MAX_STACK]
Definition radmin.c:158
uint16_t
unsigned short uint16_t
Definition merged_model.c:31
fr_type_t
fr_type_t
Definition merged_model.c:80
FR_TYPE_TIME_DELTA
@ FR_TYPE_TIME_DELTA
A period of time measured in nanoseconds.
Definition merged_model.c:113
FR_TYPE_IPV4_ADDR
@ FR_TYPE_IPV4_ADDR
32 Bit IPv4 Address.
Definition merged_model.c:86
FR_TYPE_INT8
@ FR_TYPE_INT8
8 Bit signed integer.
Definition merged_model.c:103
FR_TYPE_ETHERNET
@ FR_TYPE_ETHERNET
48 Bit Mac-Address.
Definition merged_model.c:93
FR_TYPE_IPV6_PREFIX
@ FR_TYPE_IPV6_PREFIX
IPv6 Prefix.
Definition merged_model.c:89
FR_TYPE_STRING
@ FR_TYPE_STRING
String of printable characters.
Definition merged_model.c:83
FR_TYPE_MAX
@ FR_TYPE_MAX
Number of defined data types.
Definition merged_model.c:130
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_IPV6_ADDR
@ FR_TYPE_IPV6_ADDR
128 Bit IPv6 Address.
Definition merged_model.c:88
FR_TYPE_IPV4_PREFIX
@ FR_TYPE_IPV4_PREFIX
IPv4 Prefix.
Definition merged_model.c:87
FR_TYPE_BOOL
@ FR_TYPE_BOOL
A truth value.
Definition merged_model.c:95
FR_TYPE_VSA
@ FR_TYPE_VSA
Vendor-Specific, for RADIUS attribute 26.
Definition merged_model.c:121
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
FR_TYPE_FLOAT64
@ FR_TYPE_FLOAT64
Double precision floating point.
Definition merged_model.c:109
uint32_t
unsigned int uint32_t
Definition merged_model.c:33
ssize_t
long int ssize_t
Definition merged_model.c:24
uint8_t
unsigned char uint8_t
Definition merged_model.c:30
fr_slen_t
ssize_t fr_slen_t
Definition merged_model.c:35
tmpl_print
fr_slen_t tmpl_print(fr_sbuff_t *out, tmpl_t const *vpt, fr_sbuff_escape_rules_t const *e_rules)
Definition merged_model.c:231
size_t
unsigned long int size_t
Definition merged_model.c:25
UINT8_MAX
#define UINT8_MAX
Definition merged_model.c:32
fr_sbuff_parse_error_t
fr_sbuff_parse_error_t
Definition merged_model.c:45
FR_SBUFF_PARSE_ERROR_NOT_FOUND
@ FR_SBUFF_PARSE_ERROR_NOT_FOUND
String does not contain a token matching the output type.
Definition merged_model.c:47
FR_SBUFF_PARSE_ERROR_FORMAT
@ FR_SBUFF_PARSE_ERROR_FORMAT
Format of data was invalid.
Definition merged_model.c:50
FR_SBUFF_PARSE_OK
@ FR_SBUFF_PARSE_OK
No error.
Definition merged_model.c:46
fr_dbuff_t
Definition merged_model.c:41
fr_dict_attr_t
Definition merged_model.c:133
fr_dict_t
Definition merged_model.c:198
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
tmpl_t
Definition merged_model.c:225
depth
static uint8_t depth(fr_minmax_heap_index_t i)
Definition minmax_heap.c:83
fr_vasprintf
char * fr_vasprintf(TALLOC_CTX *ctx, char const *fmt, va_list ap)
Definition print.c:860
fr_proto_da_stack_build_partial
void fr_proto_da_stack_build_partial(fr_da_stack_t *stack, fr_dict_attr_t const *parent, fr_dict_attr_t const *da)
Complete the DA stack for a child attribute.
Definition proto.c:145
fr_assert
#define fr_assert(_expr)
Definition rad_assert.h:37
done
static bool done
Definition radclient.c:80
mask
static uint32_t mask
Definition rbmonkey.c:39
request_attr_request
fr_dict_attr_t const * request_attr_request
Definition request.c:43
request_attr_control
fr_dict_attr_t const * request_attr_control
Definition request.c:45
request_attr_local
fr_dict_attr_t const * request_attr_local
Definition request.c:47
request_attr_state
fr_dict_attr_t const * request_attr_state
Definition request.c:46
request_attr_reply
fr_dict_attr_t const * request_attr_reply
Definition request.c:44
request_attr_is_list
static bool request_attr_is_list(fr_dict_attr_t const *da)
Definition request.h:364
name
static char const * name
Definition rlm_redis_ippool_tool.c:156
fr_sbuff_adv_past_allowed
size_t fr_sbuff_adv_past_allowed(fr_sbuff_t *sbuff, size_t len, bool const allowed[static SBUFF_CHAR_CLASS], fr_sbuff_term_t const *tt)
Wind position past characters in the allowed set.
Definition sbuff.c:1822
sbuff_char_class_hex
bool const sbuff_char_class_hex[SBUFF_CHAR_CLASS]
Definition sbuff.c:98
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:2197
fr_sbuff_adv_past_strcase
size_t fr_sbuff_adv_past_strcase(fr_sbuff_t *sbuff, char const *needle, size_t needle_len)
Return true and advance past the end of the needle if needle occurs next in the sbuff.
Definition sbuff.c:1788
fr_sbuff_adv_until
size_t fr_sbuff_adv_until(fr_sbuff_t *sbuff, size_t len, fr_sbuff_term_t const *tt, char escape_chr)
Wind position until we hit a character in the terminal set.
Definition sbuff.c:1897
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:2133
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_IN_TABLE_STR_RETURN
#define FR_SBUFF_IN_TABLE_STR_RETURN(_sbuff, _table, _number, _def)
fr_sbuff_adv_past_str_literal
#define fr_sbuff_adv_past_str_literal(_sbuff, _needle)
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)
SBUFF_CHAR_CLASS
#define SBUFF_CHAR_CLASS
Definition sbuff.h:203
FR_SBUFF_IN
#define FR_SBUFF_IN(_start, _len_or_end)
fr_sbuff_adv_past_whitespace
#define fr_sbuff_adv_past_whitespace(_sbuff, _len, _tt)
fr_sbuff_adv_past_strcase_literal
#define fr_sbuff_adv_past_strcase_literal(_sbuff, _needle)
fr_sbuff_current
#define fr_sbuff_current(_sbuff_or_marker)
FR_SBUFF_REPARSE
#define FR_SBUFF_REPARSE(_sbuff_or_marker)
fr_sbuff_char
#define fr_sbuff_char(_sbuff_or_marker, _eob)
FR_SBUFF_IN_ESCAPE_BUFFER_RETURN
#define FR_SBUFF_IN_ESCAPE_BUFFER_RETURN(...)
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_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_IN_SPRINTF_RETURN
#define FR_SBUFF_IN_SPRINTF_RETURN(...)
fr_sbuff_uint8
#define fr_sbuff_uint8(_sbuff_or_marker, _eob)
FR_SBUFF
#define FR_SBUFF(_sbuff_or_marker)
FR_SBUFF_IN_BSTRNCPY_RETURN
#define FR_SBUFF_IN_BSTRNCPY_RETURN(...)
fr_sbuff_advance
#define fr_sbuff_advance(_sbuff_or_marker, _len)
fr_sbuff_out
#define fr_sbuff_out(_err, _out, _in)
fr_sbuff_switch
#define fr_sbuff_switch(_sbuff_or_marker, _eob)
FR_SBUFF_OUT
#define FR_SBUFF_OUT(_start, _len_or_end)
fr_sbuff_used
#define fr_sbuff_used(_sbuff_or_marker)
fr_sbuff_in_strcpy_literal
#define fr_sbuff_in_strcpy_literal(_sbuff, _str)
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_IN_BSTRCPY_BUFFER_RETURN
#define FR_SBUFF_IN_BSTRCPY_BUFFER_RETURN(...)
fr_sbuff_ptr_s
Definition sbuff.h:82
fr_sbuff_term_t
Set of terminal elements.
Definition merged_model.c:161
tmpl_attr_set_list
void tmpl_attr_set_list(tmpl_t *vpt, fr_dict_attr_t const *list)
Definition tmpl_tokenize.c:1243
tmpl_contains_xlat
#define tmpl_contains_xlat(vpt)
Definition tmpl.h:227
TMPL_VERIFY
#define TMPL_VERIFY(_vpt)
Definition tmpl.h:961
tmpl_value_length
#define tmpl_value_length(_tmpl)
Definition tmpl.h:938
tmpl_type_to_str
static char const * tmpl_type_to_str(tmpl_type_t type)
Return a static string containing the type name.
Definition tmpl.h:638
tmpl_is_uninitialised
#define tmpl_is_uninitialised(vpt)
Helpers to verify the type of tmpl_t.
Definition tmpl.h:204
tmpl_unresolve
void tmpl_unresolve(tmpl_t *vpt)
Reset the tmpl, leaving only the name in place.
Definition tmpl_tokenize.c:4535
tmpl_is_attr_unresolved
#define tmpl_is_attr_unresolved(vpt)
Definition tmpl.h:219
tmpl_request_ref_t
enum requests_ref_e tmpl_request_ref_t
tmpl_set_name_printf
void tmpl_set_name_printf(tmpl_t *vpt, fr_token_t quote, char const *fmt,...))
Set the name on a pre-initialised tmpl.
Definition tmpl_tokenize.c:769
tmpl_attr_tail_is_unspecified
static bool tmpl_attr_tail_is_unspecified(tmpl_t const *vpt)
Return true if the last attribute reference is "unspecified".
Definition tmpl.h:726
tmpl_set_xlat
void tmpl_set_xlat(tmpl_t *vpt, xlat_exp_head_t *xlat)
Change the default dictionary in the tmpl's resolution rules.
Definition tmpl_tokenize.c:846
NUM_LAST
#define NUM_LAST
Definition tmpl.h:397
tmpl_attr_set_request_ref
void tmpl_attr_set_request_ref(tmpl_t *vpt, FR_DLIST_HEAD(tmpl_request_list) const *request_def)
Set the request for an attribute ref.
Definition tmpl_tokenize.c:1229
tmpl_attr_set_da
int tmpl_attr_set_da(tmpl_t *vpt, fr_dict_attr_t const *da)
Replace the current attribute reference.
Definition tmpl_tokenize.c:1102
tmpl_rules_enumv
#define tmpl_rules_enumv(_tmpl)
Definition tmpl.h:943
tmpl_attr_tail_is_normal
static bool tmpl_attr_tail_is_normal(tmpl_t const *vpt)
Return true if the last attribute reference is "normal".
Definition tmpl.h:710
tmpl_init
tmpl_t * tmpl_init(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote, char const *name, ssize_t len, tmpl_rules_t const *t_rules))
Initialise a tmpl using a literal string to create the name.
Definition tmpl_tokenize.c:915
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:4405
tmpl_value
#define tmpl_value(_tmpl)
Definition tmpl.h:937
tmpl_attr_print
static fr_slen_t rql fr_slen_t tmpl_attr_print(fr_sbuff_t *out, tmpl_t const *vpt)
Print an attribute or list tmpl_t to a string.
Definition tmpl_tokenize.c:4802
tmpl_attr_debug
void tmpl_attr_debug(FILE *fp, tmpl_t const *vpt)
Definition tmpl_tokenize.c:276
tmpl_afrom_value_box
int tmpl_afrom_value_box(TALLOC_CTX *ctx, tmpl_t **out, fr_value_box_t *data, bool steal)
Create a tmpl_t from a fr_value_box_t.
Definition tmpl_tokenize.c:1016
ar_is_unknown
#define ar_is_unknown(_ar)
Definition tmpl.h:511
tmpl_alloc
tmpl_t * tmpl_alloc(TALLOC_CTX *ctx, tmpl_type_t type, fr_token_t quote, char const *name, ssize_t len)
Create a new heap allocated tmpl_t.
Definition tmpl_tokenize.c:959
tmpl_attr_unknown_add
int tmpl_attr_unknown_add(tmpl_t *vpt)
Add an unknown fr_dict_attr_t specified by a tmpl_t to the main dictionary.
Definition tmpl_tokenize.c:4600
tmpl_attr_tail_is_unknown
static bool tmpl_attr_tail_is_unknown(tmpl_t const *vpt)
Return true if the last attribute reference is "unknown".
Definition tmpl.h:742
tmpl_contains_regex
#define tmpl_contains_regex(vpt)
Definition tmpl.h:226
tmpl_rules_s::literals_safe_for
fr_value_box_safe_for_t literals_safe_for
safe_for value assigned to literal values in xlats, execs, and data.
Definition tmpl.h:351
tmpl_set_escape
void tmpl_set_escape(tmpl_t *vpt, tmpl_escape_t const *escape)
Set escape parameters for the tmpl output.
Definition tmpl_tokenize.c:836
ar_is_raw
#define ar_is_raw(_ar)
Definition tmpl.h:513
tmpl_is_attr
#define tmpl_is_attr(vpt)
Definition tmpl.h:208
NUM_ALL
#define NUM_ALL
Definition tmpl.h:395
tmpl_async_required
bool tmpl_async_required(tmpl_t const *vpt)
Return whether or not async is required for this tmpl.
Definition tmpl_tokenize.c:5917
tmpl_rules_s::enumv
fr_dict_attr_t const * enumv
Enumeration attribute used to resolve enum values.
Definition tmpl.h:342
tmpl_rules_s::parent
tmpl_rules_t const * parent
for parent / child relationships
Definition tmpl.h:337
tmpl_rules_child_init
void tmpl_rules_child_init(TALLOC_CTX *ctx, tmpl_rules_t *out, tmpl_rules_t const *parent, tmpl_t *vpt)
Initialize a set of rules from a parent set of rules, and a parsed tmpl_t.
Definition tmpl_tokenize.c:5939
tmpl_value_enumv
#define tmpl_value_enumv(_tmpl)
Definition tmpl.h:940
tmpl_xlat
#define tmpl_xlat(_tmpl)
Definition tmpl.h:930
tmpl_list
static fr_dict_attr_t const * tmpl_list(tmpl_t const *vpt)
Definition tmpl.h:904
tmpl_attr_is_list_attr
static bool tmpl_attr_is_list_attr(tmpl_attr_t const *ar)
Return true if the tmpl_attr is one of the list types.
Definition tmpl.h:683
ar_filter_is_num
#define ar_filter_is_num(_ar)
Definition tmpl.h:522
tmpl_rules_cast
#define tmpl_rules_cast(_tmpl)
Definition tmpl.h:942
tmpl_afrom_attr_str
ssize_t tmpl_afrom_attr_str(TALLOC_CTX *ctx, tmpl_attr_error_t *err, tmpl_t **out, char const *name, tmpl_rules_t const *rules))
Parse a string into a TMPL_TYPE_ATTR_* type tmpl_t.
Definition tmpl_tokenize.c:2561
tmpl_set_name
void tmpl_set_name(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len)
Set the name on a pre-initialised tmpl.
Definition tmpl_tokenize.c:810
TMPL_TYPE_REGEX_UNCOMPILED
@ TMPL_TYPE_REGEX_UNCOMPILED
Regex where compilation is possible but hasn't been performed yet.
Definition tmpl.h:158
TMPL_TYPE_MAX
@ TMPL_TYPE_MAX
Marker for the last tmpl type.
Definition tmpl.h:199
TMPL_TYPE_ATTR_UNRESOLVED
@ TMPL_TYPE_ATTR_UNRESOLVED
An attribute reference that we couldn't resolve but looked valid.
Definition tmpl.h:185
TMPL_TYPE_ATTR
@ TMPL_TYPE_ATTR
Reference to one or more attributes.
Definition tmpl.h:142
TMPL_TYPE_XLAT
@ TMPL_TYPE_XLAT
Pre-parsed xlat expansion.
Definition tmpl.h:146
TMPL_TYPE_EXEC
@ TMPL_TYPE_EXEC
Callout to an external script or program.
Definition tmpl.h:150
TMPL_TYPE_REGEX_XLAT_UNRESOLVED
@ TMPL_TYPE_REGEX_XLAT_UNRESOLVED
A regular expression with unresolved xlat functions or attribute references.
Definition tmpl.h:197
TMPL_TYPE_DATA
@ TMPL_TYPE_DATA
Value in native boxed format.
Definition tmpl.h:138
TMPL_TYPE_REGEX
@ TMPL_TYPE_REGEX
Compiled (and possibly JIT'd) regular expression.
Definition tmpl.h:154
TMPL_TYPE_DATA_UNRESOLVED
@ TMPL_TYPE_DATA_UNRESOLVED
Unparsed literal string.
Definition tmpl.h:179
TMPL_TYPE_XLAT_UNRESOLVED
@ TMPL_TYPE_XLAT_UNRESOLVED
A xlat expansion with unresolved xlat functions or attribute references.
Definition tmpl.h:193
TMPL_TYPE_REGEX_XLAT
@ TMPL_TYPE_REGEX_XLAT
A regex containing xlat expansions.
Definition tmpl.h:162
TMPL_TYPE_EXEC_UNRESOLVED
@ TMPL_TYPE_EXEC_UNRESOLVED
An exec with unresolved xlat function or attribute references.
Definition tmpl.h:189
TMPL_TYPE_UNINITIALISED
@ TMPL_TYPE_UNINITIALISED
Uninitialised.
Definition tmpl.h:134
tmpl_attr_afrom_list
int tmpl_attr_afrom_list(TALLOC_CTX *ctx, tmpl_t **out, tmpl_t const *list, fr_dict_attr_t const *da)
Create a new tmpl from a list tmpl and a da.
Definition tmpl_tokenize.c:1254
tmpl_is_regex_xlat
#define tmpl_is_regex_xlat(vpt)
Definition tmpl.h:215
NUM_COUNT
#define NUM_COUNT
Definition tmpl.h:396
tmpl_assert_type
#define tmpl_assert_type(_cond)
Convenience macro for printing a meaningful assert message when we get a bad tmpl type.
Definition tmpl.h:624
tmpl_contains_attr
#define tmpl_contains_attr(vpt)
Definition tmpl.h:225
ar_da
#define ar_da
Definition tmpl.h:503
tmpl_copy
tmpl_t * tmpl_copy(TALLOC_CTX *ctx, tmpl_t const *in)
Copy a tmpl.
Definition tmpl_tokenize.c:3763
TMPL_FLAG_REGEX
#define TMPL_FLAG_REGEX
Is a type of regular expression.
Definition tmpl.h:116
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:3327
tmpl_print_quoted
static fr_slen_t e_rules fr_slen_t tmpl_print_quoted(fr_sbuff_t *out, tmpl_t const *vpt)
Print a tmpl_t to a string with quotes.
Definition tmpl_tokenize.c:5070
ar_filter_is_cond
#define ar_filter_is_cond(_ar)
Definition tmpl.h:523
tmpl_rules_s::xlat
tmpl_xlat_rules_t xlat
Rules/data for parsing xlats.
Definition tmpl.h:340
tmpl_attr_tail_unresolved
static char const * tmpl_attr_tail_unresolved(tmpl_t const *vpt)
Return the last attribute reference unresolved da.
Definition tmpl.h:869
tmpl_rules_s::at_runtime
bool at_runtime
Produce an ephemeral/runtime tmpl.
Definition tmpl.h:348
tmpl_is_list
static bool tmpl_is_list(tmpl_t const *vpt)
Definition tmpl.h:920
tmpl_afrom_attr_substr
ssize_t tmpl_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, tmpl_t **out, fr_sbuff_t *name, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Parse a string into a TMPL_TYPE_ATTR_* type tmpl_t.
Definition tmpl_tokenize.c:2279
TMPL_ATTR_VERIFY
#define TMPL_ATTR_VERIFY(_vpt)
Definition tmpl.h:960
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:4095
tmpl_res_rules_s::force_dict_def
bool force_dict_def
Use supplied dict_def even if original vpt->rules->dict_def was not NULL.
Definition tmpl.h:374
tmpl_is_data
#define tmpl_is_data(vpt)
Definition tmpl.h:206
tmpl_set_name_shallow
void tmpl_set_name_shallow(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len)
Set the name on a pre-initialised tmpl.
Definition tmpl_tokenize.c:793
vpt
static fr_slen_t vpt
Definition tmpl.h:1269
tmpl_res_rules_s::dict_def
fr_dict_t const * dict_def
Alternative default dictionary to use if vpt->rules->dict_def is NULL.
Definition tmpl.h:369
tmpl_preparse
ssize_t tmpl_preparse(char const **out, size_t *outlen, char const *in, size_t inlen, fr_token_t *type))
Preparse a string in preparation for passing it to tmpl_afrom_substr()
Definition tmpl_tokenize.c:5511
NUM_UNSPEC
#define NUM_UNSPEC
Definition tmpl.h:394
tmpl_attr_num_elements
static size_t tmpl_attr_num_elements(tmpl_t const *vpt)
The number of attribute references contained within a tmpl.
Definition tmpl.h:896
tmpl_request_ref_list_afrom_substr
fr_slen_t tmpl_request_ref_list_afrom_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, FR_DLIST_HEAD(tmpl_request_list) _CONST **out, fr_sbuff_t *in)
tmpl_value_type
#define tmpl_value_type(_tmpl)
Definition tmpl.h:939
tmpl_attr
#define tmpl_attr(_tmpl)
Definition tmpl.h:658
tmpl_attr_rewrite_leaf_num
void tmpl_attr_rewrite_leaf_num(tmpl_t *vpt, int16_t num)
Rewrite the leaf's instance number.
Definition tmpl_tokenize.c:1202
tmpl_attr_error_t
tmpl_attr_error_t
Definition tmpl.h:1004
TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX
@ TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX
Invalid array index.
Definition tmpl.h:1023
TMPL_ATTR_ERROR_LIST_NOT_ALLOWED
@ TMPL_ATTR_ERROR_LIST_NOT_ALLOWED
List qualifier is not allowed here.
Definition tmpl.h:1008
TMPL_ATTR_ERROR_UNRESOLVED_NOT_ALLOWED
@ TMPL_ATTR_ERROR_UNRESOLVED_NOT_ALLOWED
Attribute couldn't be found in the dictionaries.
Definition tmpl.h:1014
TMPL_ATTR_ERROR_BAD_CAST
@ TMPL_ATTR_ERROR_BAD_CAST
Specified cast was invalid.
Definition tmpl.h:1028
TMPL_ATTR_ERROR_INVALID_NAME
@ TMPL_ATTR_ERROR_INVALID_NAME
Attribute ref length is zero, or longer than the maximum.
Definition tmpl.h:1016
TMPL_ATTR_ERROR_MISSING_TERMINATOR
@ TMPL_ATTR_ERROR_MISSING_TERMINATOR
Unexpected text found after attribute reference.
Definition tmpl.h:1027
TMPL_ATTR_ERROR_INVALID_REQUEST_REF
@ TMPL_ATTR_ERROR_INVALID_REQUEST_REF
invalid request reference
Definition tmpl.h:1026
TMPL_ATTR_ERROR_LIST_MISSING
@ TMPL_ATTR_ERROR_LIST_MISSING
List qualifier is required, but missing.
Definition tmpl.h:1009
TMPL_ATTR_ERROR_NONE
@ TMPL_ATTR_ERROR_NONE
No error.
Definition tmpl.h:1005
TMPL_ATTR_ERROR_FOREIGN_NOT_ALLOWED
@ TMPL_ATTR_ERROR_FOREIGN_NOT_ALLOWED
Attribute resolved in a dictionary different to the one specified.
Definition tmpl.h:1020
TMPL_ATTR_ERROR_INVALID_OID
@ TMPL_ATTR_ERROR_INVALID_OID
OIDs are not allowed.
Definition tmpl.h:1029
TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED
@ TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED
Attribute specified as OID, could not be found in the dictionaries, and is disallowed because 'disall...
Definition tmpl.h:1010
TMPL_ATTR_ERROR_FILTER_NOT_ALLOWED
@ TMPL_ATTR_ERROR_FILTER_NOT_ALLOWED
Filters disallowed by rules.
Definition tmpl.h:1022
TMPL_ATTR_ERROR_EMPTY
@ TMPL_ATTR_ERROR_EMPTY
Attribute ref contains no data.
Definition tmpl.h:1006
TMPL_ATTR_ERROR_NESTING_TOO_DEEP
@ TMPL_ATTR_ERROR_NESTING_TOO_DEEP
Too many levels of nesting.
Definition tmpl.h:1025
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_rules_debug
void tmpl_rules_debug(tmpl_rules_t const *rules)
Definition tmpl_tokenize.c:6010
tmpl_attr_copy
int tmpl_attr_copy(tmpl_t *dst, tmpl_t const *src)
Copy a list of attribute and request references from one tmpl to another.
Definition tmpl_tokenize.c:1046
tmpl_init_printf
tmpl_t * tmpl_init_printf(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote, char const *fmt,...))
Initialise a tmpl using a format string to create the name.
Definition tmpl_tokenize.c:863
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_ATTR_LIST_REQUIRE
@ TMPL_ATTR_LIST_REQUIRE
Attribute refs are required to have a list.
Definition tmpl.h:264
TMPL_ATTR_LIST_ALLOW
@ TMPL_ATTR_LIST_ALLOW
Attribute refs are allowed to have a list.
Definition tmpl.h:262
TMPL_ATTR_LIST_FORBID
@ TMPL_ATTR_LIST_FORBID
Attribute refs are forbidden from having a list.
Definition tmpl.h:263
tmpl_type_t
enum tmpl_type_e tmpl_type_t
Types of tmpl_t.
tmpl_attr_set_leaf_da
int tmpl_attr_set_leaf_da(tmpl_t *vpt, fr_dict_attr_t const *da)
Replace the leaf attribute only.
Definition tmpl_tokenize.c:1135
tmpl_attr_tail_unknown
static fr_dict_attr_t const * tmpl_attr_tail_unknown(tmpl_t const *vpt)
Return the last attribute reference unknown da.
Definition tmpl.h:853
tmpl_is_regex
#define tmpl_is_regex(vpt)
Definition tmpl.h:213
tmpl_list_name
static char const * tmpl_list_name(fr_dict_attr_t const *list, char const *def)
Return the name of a tmpl list or def if list not provided.
Definition tmpl.h:915
tmpl_attr_tail_is_raw
static bool tmpl_attr_tail_is_raw(tmpl_t const *vpt)
Return true if the last attribute reference is "raw".
Definition tmpl.h:774
REQUEST_OUTER
@ REQUEST_OUTER
request_t containing the outer layer of the EAP conversation.
Definition tmpl.h:92
REQUEST_PARENT
@ REQUEST_PARENT
Parent (whatever it is).
Definition tmpl.h:96
REQUEST_CURRENT
@ REQUEST_CURRENT
The current request (default).
Definition tmpl.h:91
tmpl_request_ref_list_print
fr_slen_t tmpl_request_ref_list_print(fr_sbuff_t *out, FR_DLIST_HEAD(tmpl_request_list) const *rql))
Definition tmpl_tokenize.c:4774
tmpl_rules_t
struct tmpl_rules_s tmpl_rules_t
Definition tmpl.h:233
tmpl_is_regex_xlat_unresolved
#define tmpl_is_regex_xlat_unresolved(vpt)
Definition tmpl.h:221
tmpl_set_dict_def
void tmpl_set_dict_def(tmpl_t *vpt, fr_dict_t const *dict)
Change the default dictionary in the tmpl's resolution rules.
Definition tmpl_tokenize.c:826
tmpl_attr_tail_unresolved_add
int tmpl_attr_tail_unresolved_add(fr_dict_t *dict, tmpl_t *vpt, fr_type_t type, fr_dict_attr_flags_t const *flags))
Add an unresolved fr_dict_attr_t specified by a tmpl_t to the main dictionary.
Definition tmpl_tokenize.c:4702
tmpl_is_regex_uncompiled
#define tmpl_is_regex_uncompiled(vpt)
Definition tmpl.h:214
tmpl_res_rules_s::enumv
fr_dict_attr_t const * enumv
for resolving T_BARE_WORD
Definition tmpl.h:377
TMPL_MAX_REQUEST_REF_NESTING
#define TMPL_MAX_REQUEST_REF_NESTING
The maximum number of request references allowed.
Definition tmpl.h:85
tmpl_cast_from_substr
ssize_t tmpl_cast_from_substr(tmpl_rules_t *t_rules, fr_sbuff_t *in))
Parse a cast specifier.
Definition tmpl_tokenize.c:3863
tmpl_attr_type_t
tmpl_attr_type_t
Definition tmpl.h:380
TMPL_ATTR_TYPE_UNSPEC
@ TMPL_ATTR_TYPE_UNSPEC
No attribute was specified as this level only a filter.
Definition tmpl.h:382
TMPL_ATTR_TYPE_NORMAL
@ TMPL_ATTR_TYPE_NORMAL
Normal, resolved, attribute ref.
Definition tmpl.h:381
TMPL_ATTR_TYPE_UNKNOWN
@ TMPL_ATTR_TYPE_UNKNOWN
We have an attribute number but it doesn't match anything in the dictionary, or isn't a child of the ...
Definition tmpl.h:384
TMPL_ATTR_TYPE_UNRESOLVED
@ TMPL_ATTR_TYPE_UNRESOLVED
We have a name, but nothing else to identify the attribute.
Definition tmpl.h:389
TMPL_ATTR_FILTER_TYPE_TMPL
@ TMPL_ATTR_FILTER_TYPE_TMPL
Filter is a tmpl.
Definition tmpl.h:411
TMPL_ATTR_FILTER_TYPE_INDEX
@ TMPL_ATTR_FILTER_TYPE_INDEX
Filter is an index type.
Definition tmpl.h:409
TMPL_ATTR_FILTER_TYPE_CONDITION
@ TMPL_ATTR_FILTER_TYPE_CONDITION
Filter is a condition.
Definition tmpl.h:410
TMPL_ATTR_FILTER_TYPE_NONE
@ TMPL_ATTR_FILTER_TYPE_NONE
No filter present.
Definition tmpl.h:408
TMPL_ATTR_FILTER_TYPE_EXPR
@ TMPL_ATTR_FILTER_TYPE_EXPR
Filter is an expression.
Definition tmpl.h:412
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:3909
tmpl_init_shallow
tmpl_t * tmpl_init_shallow(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote, char const *name, ssize_t len, tmpl_rules_t const *t_rules))
Initialise a tmpl without copying the input name string.
Definition tmpl_tokenize.c:893
tmpl_attr_filter_t::type
tmpl_attr_filter_type_t _CONST type
Type of filter this is.
Definition tmpl.h:416
ar_filter_is_none
#define ar_filter_is_none(_ar)
Definition tmpl.h:521
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
buff
static char buff[sizeof("18446744073709551615")+3]
Definition size_tests.c:37
fr_skip_condition
ssize_t fr_skip_condition(char const *start, char const *end, bool const terminal[static SBUFF_CHAR_CLASS], bool *eol)
Skip a conditional expression.
Definition skip.c:317
snprintf
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
Definition snprintf.c:689
count
return count
Definition module.c:155
type
fr_aka_sim_id_type_t type
Definition state_machine.c:3648
tmpl_attr_rules_s
Define entry and head types for tmpl request references.
Definition tmpl.h:272
tmpl_attr_rules_s::allow_unknown
unsigned int allow_unknown
Allow unknown attributes i.e.
Definition tmpl.h:303
tmpl_attr_rules_s::list_presence
tmpl_attr_list_presence_t list_presence
Whether the attribute reference can have a list, forbid it, or require it.
Definition tmpl.h:298
tmpl_attr_rules_s::list_def
fr_dict_attr_t const * list_def
Default list to use with unqualified attribute reference.
Definition tmpl.h:295
tmpl_attr_rules_s::allow_wildcard
unsigned int allow_wildcard
Allow the special case of .
Definition tmpl.h:311
tmpl_attr_rules_s::ci
CONF_ITEM * ci
for migration support and various warnings
Definition tmpl.h:301
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::disallow_filters
unsigned int disallow_filters
disallow filters.
Definition tmpl.h:318
tmpl_attr_rules_s::allow_oid
unsigned int allow_oid
allow numerical OIDs.
Definition tmpl.h:316
tmpl_attr_rules_s::allow_foreign
unsigned int allow_foreign
Allow arguments not found in dict_def.
Definition tmpl.h:314
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
tmpl_attr_t
An element in a list of nested attribute references.
Definition tmpl.h:434
tmpl_attr_t::resolve_only
unsigned int _CONST resolve_only
This reference and those before it.
Definition tmpl.h:457
tmpl_attr_t::is_raw
unsigned int _CONST is_raw
Definition tmpl.h:460
tmpl_attr_t::da
fr_dict_attr_t const *_CONST da
Resolved dictionary attribute.
Definition tmpl.h:438
tmpl_attr_t::parent
fr_dict_attr_t const *_CONST parent
The parent we used when trying to resolve the attribute originally.
Definition tmpl.h:452
tmpl_attr_t::filter
tmpl_attr_filter_t _CONST filter
Filter associated with the attribute reference.
Definition tmpl.h:464
tmpl_attr_t::type
tmpl_attr_type_t _CONST type
is a raw reference
Definition tmpl.h:462
tmpl_request_t
Define manipulation functions for the attribute reference list.
Definition tmpl.h:475
tmpl_request_t::request
tmpl_request_ref_t _CONST request
Definition tmpl.h:479
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_bstrdup
char * talloc_bstrdup(TALLOC_CTX *ctx, char const *in)
Binary safe strdup function.
Definition talloc.c:590
talloc_bstrndup
char * talloc_bstrndup(TALLOC_CTX *ctx, char const *in, size_t inlen)
Binary safe strndup function.
Definition talloc.c:618
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:254
talloc_pooled_object
#define talloc_pooled_object(_ctx, _type, _num_subobjects, _total_subobjects_size)
Definition talloc.h:211
talloc_strdup
#define talloc_strdup(_ctx, _str)
Definition talloc.h:149
talloc_strlen
static size_t talloc_strlen(char const *s)
Returns the length of a talloc array containing a string.
Definition talloc.h:143
fr_time_delta_from_substr
fr_slen_t fr_time_delta_from_substr(fr_time_delta_t *out, fr_sbuff_t *in, fr_time_res_t hint, bool no_trailing, fr_sbuff_term_t const *tt)
Create fr_time_delta_t from a string.
Definition time.c:214
FR_TIME_RES_SEC
@ FR_TIME_RES_SEC
Definition time.h:50
fr_time_delta_s
A time delta, a difference in time measured in nanoseconds.
Definition time.h:80
tmpl_escape_t
Escaping rules for tmpls.
Definition tmpl_escape.h:80
tmpl_attr_unspec
fr_dict_attr_t const * tmpl_attr_unspec
Placeholder attribute for uses of unspecified attribute references.
Definition tmpl_eval.c:55
tmpl_request_ref_list_cmp
int8_t tmpl_request_ref_list_cmp(FR_DLIST_HEAD(tmpl_request_list) const *a, FR_DLIST_HEAD(tmpl_request_list) const *b)
Compare a list of request qualifiers.
Definition tmpl_tokenize.c:485
tmpl_afrom_time_delta
static ssize_t tmpl_afrom_time_delta(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Definition tmpl_tokenize.c:3147
tmpl_request_ref_list_debug
void tmpl_request_ref_list_debug(FR_DLIST_HEAD(tmpl_request_list) const *rql)
Dump a request list to stderr.
Definition tmpl_tokenize.c:465
tmpl_request_ref_print_table_len
static size_t tmpl_request_ref_print_table_len
Definition tmpl_tokenize.c:149
attr_num_table
static fr_table_num_sorted_t const attr_num_table[]
Special attribute reference indexes.
Definition tmpl_tokenize.c:162
tmpl_type_init
static void tmpl_type_init(tmpl_t *vpt, tmpl_type_t type)
Initialise fields inside a tmpl depending on its type.
Definition tmpl_tokenize.c:737
RESOLVED_SET
#define RESOLVED_SET(_flags)
Definition tmpl_tokenize.c:175
tmpl_attr_ref_afrom_unresolved_substr
static fr_slen_t tmpl_attr_ref_afrom_unresolved_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, tmpl_t *vpt, fr_dict_attr_t const *parent, fr_dict_attr_t const *namespace, fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
Parse an unresolved attribute, i.e.
Definition tmpl_tokenize.c:1645
tmpl_request_ref_print_table
static fr_table_num_sorted_t const tmpl_request_ref_print_table[]
We can print "current", but we shouldn't parse the "current" in a configuration.
Definition tmpl_tokenize.c:144
tmpl_attr_ref_debug
void tmpl_attr_ref_debug(FILE *fp, const tmpl_attr_t *ar, int i)
Definition tmpl_tokenize.c:201
attr_table
static fr_table_num_ordered_t const attr_table[]
Attr ref types.
Definition tmpl_tokenize.c:134
tmpl_xlat_resolve
static int tmpl_xlat_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules)
Resolve an unresolved xlat, i.e.
Definition tmpl_tokenize.c:4375
tmpl_request_ref_table
fr_table_num_sorted_t const tmpl_request_ref_table[]
Map keywords to tmpl_request_ref_t values.
Definition tmpl_tokenize.c:153
tmpl_attr_debug
void tmpl_attr_debug(FILE *fp, tmpl_t const *vpt)
Definition tmpl_tokenize.c:276
tmpl_afrom_null_substr
static fr_slen_t tmpl_afrom_null_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Match the bareword null and return a TMPL_TYPE_DATA carrying an FR_TYPE_NULL box.
Definition tmpl_tokenize.c:2657
tmpl_attr_ref_from_unspecified_substr
static fr_slen_t tmpl_attr_ref_from_unspecified_substr(tmpl_attr_t *ar, tmpl_attr_error_t *err, tmpl_t *vpt, fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
Definition tmpl_tokenize.c:1592
tmpl_attr_insert
static void tmpl_attr_insert(tmpl_t *vpt, tmpl_attr_t *ar)
Insert an attribute reference into a tmpl.
Definition tmpl_tokenize.c:1318
tmpl_attr_ref_list_debug
void tmpl_attr_ref_list_debug(FILE *fp, FR_DLIST_HEAD(tmpl_attr_list) const *ar_head)
Definition tmpl_tokenize.c:261
tmpl_afrom_ipv4_substr
static fr_slen_t tmpl_afrom_ipv4_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Parse bareword as an IPv4 address or prefix.
Definition tmpl_tokenize.c:2782
attr_to_raw
static int attr_to_raw(tmpl_t *vpt, tmpl_attr_t *ref)
Definition tmpl_tokenize.c:2208
tmpl_substr_terminal_check
static bool tmpl_substr_terminal_check(fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Verify, after skipping whitespace, that a substring ends in a terminal char, or ends without further ...
Definition tmpl_tokenize.c:185
tmpl_request_ref_list_copy
static void tmpl_request_ref_list_copy(TALLOC_CTX *ctx, FR_DLIST_HEAD(tmpl_request_list) *out, FR_DLIST_HEAD(tmpl_request_list) const *in)
Allocate a new request reference and add it to the end of the attribute reference list.
Definition tmpl_tokenize.c:426
tmpl_attr_rules_debug
static void tmpl_attr_rules_debug(tmpl_attr_rules_t const *at_rules)
Definition tmpl_tokenize.c:5995
TMPL_REQUEST_REF_DEF
#define TMPL_REQUEST_REF_DEF(_name, _ref)
Define a global variable for specifying a default request reference.
Definition tmpl_tokenize.c:52
UNRESOLVED_SET
#define UNRESOLVED_SET(_flags)
Definition tmpl_tokenize.c:174
tmpl_attr_afrom_attr_substr
static int tmpl_attr_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, tmpl_t *vpt, fr_dict_attr_t const *parent, fr_dict_attr_t const *namespace, fr_sbuff_t *name, fr_sbuff_parse_rules_t const *p_rules, tmpl_attr_rules_t const *at_rules, unsigned int depth)
Parse an attribute reference, either an OID or attribute name.
Definition tmpl_tokenize.c:1771
tmpl_afrom_ipv6_substr
static fr_slen_t tmpl_afrom_ipv6_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Parse bareword as an IPv6 address or prefix.
Definition tmpl_tokenize.c:2858
tmpl_afrom_bool_substr
static fr_slen_t tmpl_afrom_bool_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Parse a truth value.
Definition tmpl_tokenize.c:2685
tmpl_attr_add
static tmpl_attr_t * tmpl_attr_add(tmpl_t *vpt, tmpl_attr_type_t type)
Allocate a new attribute reference and add it to the end of the attribute reference list.
Definition tmpl_tokenize.c:981
attr_num_table_len
static size_t attr_num_table_len
Definition tmpl_tokenize.c:168
return_P
#define return_P(_x)
Definition tmpl_tokenize.c:5489
tmpl_debug
void tmpl_debug(FILE *fp, tmpl_t const *vpt)
Definition tmpl_tokenize.c:315
tmpl_request_ref_list_from_substr
static fr_slen_t tmpl_request_ref_list_from_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, FR_DLIST_HEAD(tmpl_request_list) *out, fr_sbuff_t *in, tmpl_rules_t const *t_rules, fr_dict_attr_t const **namespace)
Parse one or more request references, writing the list to out.
Definition tmpl_tokenize.c:559
CHECK_T_RULES
#define CHECK_T_RULES
Definition tmpl_tokenize.c:100
tmpl_alloc_null
static tmpl_t * tmpl_alloc_null(TALLOC_CTX *ctx)
Create a new heap allocated tmpl_t.
Definition tmpl_tokenize.c:933
array_terminal
static const bool array_terminal[SBUFF_CHAR_CLASS]
Definition tmpl_tokenize.c:5485
tmpl_afrom_ether_substr
static ssize_t tmpl_afrom_ether_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Try and parse signed or unsigned integers.
Definition tmpl_tokenize.c:2976
tmpl_afrom_float_substr
static ssize_t tmpl_afrom_float_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Definition tmpl_tokenize.c:3119
tmpl_afrom_octets_substr
static fr_slen_t tmpl_afrom_octets_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Parse bareword as an octet string.
Definition tmpl_tokenize.c:2723
tmpl_type_table_len
size_t tmpl_type_table_len
Definition tmpl_tokenize.c:130
tmpl_namespace
static fr_dict_attr_t const * tmpl_namespace(tmpl_rules_t const *t_rules)
Definition tmpl_tokenize.c:514
tmpl_attr_resolve
static int tmpl_attr_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules)
Resolve an unresolved attribute.
Definition tmpl_tokenize.c:4211
tmpl_afrom_enum
static ssize_t tmpl_afrom_enum(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
Definition tmpl_tokenize.c:3192
tmpl_cast_quote
static fr_token_t tmpl_cast_quote(fr_token_t existing_quote, fr_type_t type, fr_dict_attr_t const *enumv, char const *unescaped, size_t unescaped_len)
Determine the correct quoting after a cast.
Definition tmpl_tokenize.c:4058
tmpl_afrom_value_substr
static fr_slen_t tmpl_afrom_value_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_token_t quote, tmpl_rules_t const *t_rules, bool allow_enum, fr_sbuff_parse_rules_t const *p_rules)
Create TMPL_TYPE_DATA from a string.
Definition tmpl_tokenize.c:2600
tmpl_request_ref_list_acopy
static void tmpl_request_ref_list_acopy(TALLOC_CTX *ctx, FR_DLIST_HEAD(tmpl_request_list) **out, FR_DLIST_HEAD(tmpl_request_list) const *in)
Allocate a new request reference list and copy request references into it.
Definition tmpl_tokenize.c:449
tmpl_afrom_integer_substr
static fr_slen_t tmpl_afrom_integer_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules)
Try and parse signed or unsigned integers.
Definition tmpl_tokenize.c:3043
tmpl_attr_ref_fixup
static void tmpl_attr_ref_fixup(TALLOC_CTX *ctx, tmpl_t *vpt, fr_dict_attr_t const *da, fr_dict_attr_t const *parent)
Definition tmpl_tokenize.c:1726
tmpl_attr_parse_filter
static fr_slen_t tmpl_attr_parse_filter(tmpl_attr_error_t *err, tmpl_attr_t *ar, fr_sbuff_t *name, tmpl_attr_rules_t const *at_rules)
Parse array subscript and in future other filters.
Definition tmpl_tokenize.c:1348
tmpl_attr_list_from_substr
fr_slen_t tmpl_attr_list_from_substr(fr_dict_attr_t const **da_p, fr_sbuff_t *in)
Parse one a single list reference.
Definition tmpl_tokenize.c:401
DEFAULT_RULES
#define DEFAULT_RULES
Default parser rules.
Definition tmpl_tokenize.c:98
tmpl_type_table
fr_table_num_ordered_t const tmpl_type_table[]
Map tmpl_type_t values to descriptive strings.
Definition tmpl_tokenize.c:110
attr_table_len
static size_t attr_table_len
Definition tmpl_tokenize.c:140
is_char
#define is_char(_offset, _x)
Definition tmpl_tokenize.c:5491
tmpl_request_ref_table_len
size_t tmpl_request_ref_table_len
Definition tmpl_tokenize.c:157
fr_token_quotes_table
fr_table_num_sorted_t const fr_token_quotes_table[]
Definition token.c:68
fr_token_quote
const char fr_token_quote[T_TOKEN_LAST]
Convert tokens back to a quoting character.
Definition token.c:224
fr_token_t
enum fr_token fr_token_t
T_INVALID
@ T_INVALID
Definition token.h:37
T_SINGLE_QUOTED_STRING
@ T_SINGLE_QUOTED_STRING
Definition token.h:120
T_BARE_WORD
@ T_BARE_WORD
Definition token.h:118
T_BACK_QUOTED_STRING
@ T_BACK_QUOTED_STRING
Definition token.h:121
T_DOUBLE_QUOTED_STRING
@ T_DOUBLE_QUOTED_STRING
Definition token.h:119
T_SOLIDUS_QUOTED_STRING
@ T_SOLIDUS_QUOTED_STRING
Definition token.h:122
T_TOKEN_LAST
#define T_TOKEN_LAST
Definition token.h:127
xlat_needs_resolving
bool xlat_needs_resolving(xlat_exp_head_t const *head)
Check to see if the expansion needs resolving.
Definition xlat_tokenize.c:1988
xlat_is_literal
bool xlat_is_literal(xlat_exp_head_t const *head)
Check to see if the expansion consists entirely of value-box elements.
Definition xlat_tokenize.c:1972
xlat_tokenize_condition
fr_slen_t xlat_tokenize_condition(TALLOC_CTX *ctx, xlat_exp_head_t **head, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Definition xlat_expr.c:3191
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:1392
xlat_impure_func
bool xlat_impure_func(xlat_exp_head_t const *head)
Definition xlat_tokenize.c:2190
xlat_tokenize
fr_slen_t xlat_tokenize(TALLOC_CTX *ctx, xlat_exp_head_t **head, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules)
Tokenize an xlat expansion.
Definition xlat_tokenize.c:1934
head
static fr_slen_t head
Definition xlat.h:420
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_to_string
bool xlat_to_string(TALLOC_CTX *ctx, char **str, xlat_exp_head_t **head)
Convert an xlat node to an unescaped literal string and free the original node.
Definition xlat_tokenize.c:2004
xlat_copy
#define xlat_copy(_ctx, _out, _in)
Definition xlat.h:455
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:2043
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:692
xlat_tokenize_argv
fr_slen_t xlat_tokenize_argv(TALLOC_CTX *ctx, xlat_exp_head_t **head, fr_sbuff_t *in, xlat_arg_parser_t const *xlat_args, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules, bool spaces))
Tokenize an xlat expansion into a series of XLAT_TYPE_CHILD arguments.
Definition xlat_tokenize.c:1684
xlat_tokenize_expression
fr_slen_t xlat_tokenize_expression(TALLOC_CTX *ctx, xlat_exp_head_t **head, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Definition xlat_expr.c:3163
xlat_res_rules_t
Definition xlat.h:164
parent
static fr_slen_t parent
Definition pair.h:858
fr_da_stack_t
Structure for holding the stack of dictionary attributes being encoded.
Definition proto.h:55
fr_strerror_clear
void fr_strerror_clear(void)
Clears all pending messages from the talloc pools.
Definition strerror.c:581
fr_strerror_printf
#define fr_strerror_printf(_fmt,...)
Log to thread local error buffer.
Definition strerror.h:64
fr_strerror_const_push
#define fr_strerror_const_push(_msg)
Definition strerror.h:227
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_cast
bool fr_type_cast(fr_type_t dst, fr_type_t src)
Return if we're allowed to cast the types.
Definition types.c:352
fr_type_numeric
bool const fr_type_numeric[FR_TYPE_MAX+1]
Definition types.c:242
fr_type_structural
bool const fr_type_structural[FR_TYPE_MAX+1]
Definition types.c:252
FR_TYPE_STRUCTURAL_EXCEPT_GROUP
#define FR_TYPE_STRUCTURAL_EXCEPT_GROUP
Definition types.h:315
fr_type_is_non_leaf
#define fr_type_is_non_leaf(_x)
Definition types.h:394
fr_type_is_octets
#define fr_type_is_octets(_x)
Definition types.h:349
fr_type_is_structural
#define fr_type_is_structural(_x)
Definition types.h:392
fr_type_is_string
#define fr_type_is_string(_x)
Definition types.h:348
FR_TYPE_STRUCTURAL
#define FR_TYPE_STRUCTURAL
Definition types.h:316
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
FR_TYPE_LEAF
#define FR_TYPE_LEAF
Definition types.h:317
fr_value_box_print
ssize_t fr_value_box_print(fr_sbuff_t *out, fr_value_box_t const *data, fr_sbuff_escape_rules_t const *e_rules)
Print one boxed value to a string.
Definition value.c:6105
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:4394
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:4196
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:5163
fr_value_box_copy_shallow
void fr_value_box_copy_shallow(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_value_box_t const *src)
Perform a shallow copy of a value_box.
Definition value.c:4518
fr_value_box_from_str
ssize_t fr_value_box_from_str(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, char const *in, size_t inlen, fr_sbuff_unescape_rules_t const *erules)
Definition value.c:6068
fr_value_box_steal
int fr_value_box_steal(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_value_box_t *src)
Copy value data verbatim moving any buffers to the specified context.
Definition value.c:4552
fr_value_box_clear
void fr_value_box_clear(fr_value_box_t *data)
Clear/free any existing value and metadata.
Definition value.c:4377
fr_value_escape_by_quote
fr_sbuff_escape_rules_t const * fr_value_escape_by_quote[T_TOKEN_LAST]
Definition value.c:446
fr_value_box_from_substr
ssize_t fr_value_box_from_substr(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, fr_sbuff_t *in, fr_sbuff_parse_rules_t const *rules)
Convert string value to a fr_value_box_t type.
Definition value.c:5408
fr_value_box_memdup
int fr_value_box_memdup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, uint8_t const *src, size_t len, bool tainted)
Copy a buffer to a fr_value_box_t.
Definition value.c:5079
fr_value_box_mark_safe_for
#define fr_value_box_mark_safe_for(_box, _safe_for)
Definition value.h:1093
fr_value_box_aprint
static fr_slen_t fr_value_box_aprint(TALLOC_CTX *ctx, char **out, fr_value_box_t const *data, fr_sbuff_escape_rules_t const *e_rules) 1(fr_value_box_print
data
static fr_slen_t data
Definition value.h:1340
fr_box_strvalue_len
#define fr_box_strvalue_len(_val, _len)
Definition value.h:309
inlen
static size_t char fr_sbuff_t size_t inlen
Definition value.h:1030
vb_strvalue
#define vb_strvalue
Definition value.h:258
nonnull
int nonnull(2, 5))
fr_value_box_init
#define fr_value_box_init(_vb, _type, _enumv, _tainted)
Initialise a fr_value_box_t.
Definition value.h:610
out
static size_t char ** out
Definition value.h:1030
xlat_exp_head_alloc
#define xlat_exp_head_alloc(_ctx)
Definition xlat_priv.h:274
XLAT_TMPL
@ XLAT_TMPL
xlat attribute
Definition xlat_priv.h:112
xlat_exp_s::type
xlat_type_t _CONST type
type of this expansion.
Definition xlat_priv.h:155
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
Generated by   doxygen 1.9.8