The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
tmpl.h
Go to the documentation of this file.
1#pragma once
2/*
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
16 */
17
18/**
19 * $Id: 4a0d4e7291d8370e22f1848a04397eefeea1be02 $
20 *
21 * @file lib/server/tmpl.h
22 * @brief Structures and prototypes for templates
23 *
24 * These functions are used to work with #tmpl_t structs.
25 *
26 * #tmpl_t (VPTs) specify either a data source, or a data sink.
27 *
28 * Examples of sources are #TMPL_TYPE_XLAT_UNRESOLVED, #TMPL_TYPE_EXEC and #TMPL_TYPE_ATTR.
29 * Examples of sinks are #TMPL_TYPE_ATTR.
30 *
31 * VPTs are used to gather values or attributes for evaluation, or copying, and to specify
32 * where values or #fr_pair_t should be copied to.
33 *
34 * To create new #tmpl_t use one of the tmpl_*from_* functions. These parse
35 * strings into VPTs. The main parsing function is #tmpl_afrom_substr, which can produce
36 * most types of VPTs. It uses the type of quoting (passed as an #fr_token_t) to determine
37 * what type of VPT to parse the string as. For example a #T_DOUBLE_QUOTED_STRING will
38 * produce either a #TMPL_TYPE_XLAT_UNRESOLVED or a #TMPL_TYPE_DATA_UNRESOLVED (depending if the string
39 * contained a non-literal expansion).
40 *
41 * @see tmpl_afrom_substr
42 * @see tmpl_afrom_attr_str
43 *
44 * In the case of #TMPL_TYPE_ATTR, there are special cursor overlay
45 * functions which can be used to iterate over only the #fr_pair_t that match a
46 * tmpl_t in a given list.
47 *
48 * @see tmpl_dcursor_init
49 * @see tmpl_cursor_next
50 *
51 * Or for simplicity, there are functions which wrap the cursor functions, to copy or
52 * return the #fr_pair_t that match the VPT.
53 *
54 * @see tmpl_copy_pairs
55 * @see tmpl_find_vp
56 *
57 * If you just need the string value of whatever the VPT refers to, the tmpl_*expand
58 * functions may be used. These functions evaluate the VPT, execing, and xlat expanding
59 * as necessary. In the case of #TMPL_TYPE_ATTR, and #FR_TYPE_STRING or #FR_TYPE_OCTETS
60 * #tmpl_expand will return a pointer to the raw #fr_pair_t buffer. This can be very
61 * useful when using the #CONF_FLAG_TMPL type in #conf_parser_t structs, as it allows the
62 * user to determine whether they want the module to sanitise the value using presentation
63 * format specific #xlat_escape_legacy_t function, or to operate on the raw value.
64 *
65 * @see tmpl_expand
66 * @see tmpl_aexpand
67 *
68 * @copyright 2014-2015 The FreeRADIUS server project
69 */
70RCSIDH(tmpl_h, "$Id: 4a0d4e7291d8370e22f1848a04397eefeea1be02 $")
71
72#ifdef __cplusplus
73extern "C" {
74#endif
75
76#include <freeradius-devel/util/table.h>
77#include <freeradius-devel/util/dlist.h>
78#include <freeradius-devel/util/value.h>
79
80#include <freeradius-devel/server/tmpl_escape.h>
81
82/** The maximum number of request references allowed
83 *
84 */
85#define TMPL_MAX_REQUEST_REF_NESTING 10
86
88extern size_t pair_list_table_len;
89
90typedef enum requests_ref_e {
91 REQUEST_CURRENT = 0, //!< The current request (default).
92 REQUEST_OUTER, //!< #request_t containing the outer layer of the EAP
93 //!< conversation. Usually the RADIUS request sent
94 //!< by the NAS.
95
96 REQUEST_PARENT, //!< Parent (whatever it is).
97 REQUEST_UNKNOWN //!< Unknown request.
99
101extern size_t tmpl_request_ref_table_len;
102
103/** Base data type is an attribute reference
104 *
105 */
106#define TMPL_FLAG_ATTR 0x01000000
107
108/** Base data type is an xlat expansion
109 *
110 */
111#define TMPL_FLAG_XLAT 0x02000000
112
113/** Is a type of regular expression
114 *
115 */
116#define TMPL_FLAG_REGEX 0x04000000
117
118/** Needs resolution
119 *
120 */
121#define TMPL_FLAG_UNRESOLVED 0x08000000
122
123/** Types of #tmpl_t
124 *
125 * Types may be compound types made up of multiple other types.
126 *
127 * Types which are used as part of compound types are:
128 * - XLAT_TYPE_XLAT - #tmpl_t contains xlat expansion.
129 * - XLAT_TYPE_UNRESOLVED - #tmpl_t contains unresolved elements such as xlat functions or other expansions.
130 */
131typedef enum tmpl_type_e {
132 /** Uninitialised
133 */
135
136 /** Has no value. Usually a placeholder in a binary expression that's really a unary expression
137 */
139
140 /** Value in native boxed format
141 */
143
144 /** Reference to one or more attributes
145 */
147
148 /** Pre-parsed xlat expansion
149 */
151
152 /** Callout to an external script or program
153 */
155
156 /** Compiled (and possibly JIT'd) regular expression
157 */
159
160 /** Regex where compilation is possible but hasn't been performed yet
161 */
163
164 /** A regex containing xlat expansions. Cannot be pre-compiled
165 */
167
168 /** @name unresolved types
169 *
170 * These are tmpls which could not immediately be transformed into
171 * their "resolved" form due to missing references or because
172 * additional parsing is required.
173 *
174 * @{
175 */
176
177 /** Unparsed literal string
178 *
179 * May be an intermediary phase where the tmpl is created as a
180 * temporary structure during parsing. The value here MUST be raw
181 * data, and cannot be anything else.
182 */
184
185 /** An attribute reference that we couldn't resolve but looked valid
186 *
187 * May be resolvable later once more attributes are defined.
188 */
190
191 /** An exec with unresolved xlat function or attribute references
192 */
194
195 /** A xlat expansion with unresolved xlat functions or attribute references
196 */
198
199 /** A regular expression with unresolved xlat functions or attribute references
200 */
202
203 TMPL_TYPE_MAX //!< Marker for the last tmpl type.
205
206/** Helpers to verify the type of #tmpl_t
207 */
208#define tmpl_is_uninitialised(vpt) ((vpt)->type == TMPL_TYPE_UNINITIALISED)
209
210#define tmpl_is_null(vpt) ((vpt)->type == TMPL_TYPE_NULL)
211#define tmpl_is_data(vpt) ((vpt)->type == TMPL_TYPE_DATA)
212
213#define tmpl_is_attr(vpt) ((vpt)->type == TMPL_TYPE_ATTR)
214
215#define tmpl_is_xlat(vpt) ((vpt)->type == TMPL_TYPE_XLAT)
216#define tmpl_is_exec(vpt) ((vpt)->type == TMPL_TYPE_EXEC)
217
218#define tmpl_is_regex(vpt) ((vpt)->type == TMPL_TYPE_REGEX)
219#define tmpl_is_regex_uncompiled(vpt) ((vpt)->type == TMPL_TYPE_REGEX_UNCOMPILED)
220#define tmpl_is_regex_xlat(vpt) ((vpt)->type == TMPL_TYPE_REGEX_XLAT)
221
222#define tmpl_is_data_unresolved(vpt) ((vpt)->type == TMPL_TYPE_DATA_UNRESOLVED)
223#define tmpl_is_exec_unresolved(vpt) ((vpt)->type == TMPL_TYPE_EXEC_UNRESOLVED)
224#define tmpl_is_attr_unresolved(vpt) ((vpt)->type == TMPL_TYPE_ATTR_UNRESOLVED)
225#define tmpl_is_xlat_unresolved(vpt) ((vpt)->type == TMPL_TYPE_XLAT_UNRESOLVED)
226#define tmpl_is_regex_xlat_unresolved(vpt) ((vpt)->type == TMPL_TYPE_REGEX_XLAT_UNRESOLVED)
227
228#define tmpl_needs_resolving(vpt) ((vpt)->type & TMPL_FLAG_UNRESOLVED)
229#define tmpl_contains_data(vpt) ((vpt)->type & TMPL_TYPE_DATA)
230#define tmpl_contains_attr(vpt) ((vpt)->type & TMPL_FLAG_ATTR)
231#define tmpl_contains_regex(vpt) ((vpt)->type & TMPL_FLAG_REGEX)
232#define tmpl_contains_xlat(vpt) ((vpt)->type & TMPL_FLAG_XLAT)
233
234
236extern size_t tmpl_type_table_len;
237
241typedef struct tmpl_literal_rules_s tmpl_literal_rules_t;
243typedef struct tmpl_s tmpl_t;
244
245#include <freeradius-devel/unlang/xlat.h>
246#include <freeradius-devel/unlang/xlat_ctx.h>
247#include <freeradius-devel/util/packet.h>
248#include <freeradius-devel/util/proto.h>
249#include <freeradius-devel/util/regex.h>
250
251/*
252 * Allow public and private versions of the same structures
253 */
254#ifdef _CONST
255# error _CONST can only be defined in the local header
256#endif
257#ifndef _TMPL_PRIVATE
258# define _CONST const
259#else
260# define _CONST
261#endif
262
263/** Specify whether attribute references can have a list (or parent) reference
264 *
265 */
266typedef enum {
267 TMPL_ATTR_LIST_ALLOW = 0, //!< Attribute refs are allowed to have a list
268 TMPL_ATTR_LIST_FORBID, //!< Attribute refs are forbidden from having a list
269 TMPL_ATTR_LIST_REQUIRE //!< Attribute refs are required to have a list.
271
272/** Define entry and head types for tmpl request references
273 *
274 */
275FR_DLIST_TYPES(tmpl_request_list)
276
278 fr_dict_t const *dict_def; //!< Default dictionary to use
279 ///< with unqualified attribute references.
280
281 fr_dict_attr_t const *namespace; //!< Point in dictionary tree to resume parsing
282 ///< from. If this is provided then dict_def
283 ///< request_def and list_def will be ignored
284 ///< and the presence of any of those qualifiers
285 ///< will be treated as an error.
286
287 FR_DLIST_HEAD(tmpl_request_list) _CONST *request_def; //!< Default request to use with
288 ///< unqualified attribute references.
289 ///< If NULL the request is assumed to
290 ///< but the current request.
291 ///< Usually this will be one of
292 ///< - tmpl_request_def_current
293 ///< - tmpl_request_def_outer
294 ///< - tmpl_request_def_parent
295 ///< If a custom list needs to be
296 ///< used it should be allocated on
297 ///< the stack and a pointer to it
298 ///< placed here.
299
300 fr_dict_attr_t const *list_def; //!< Default list to use with unqualified
301 ///< attribute reference.
302
303 tmpl_attr_list_presence_t list_presence; //!< Whether the attribute reference can
304 ///< have a list, forbid it, or require it.
305
306 uint8_t allow_unknown:1; //!< Allow unknown attributes i.e. attributes
307 ///< defined by OID string.
308
309 uint8_t allow_unresolved:1; //!< Allow attributes that look valid but were
310 ///< not found in the dictionaries.
311 ///< This should be used as part of a multi-pass
312 ///< approach to parsing.
313
314 uint8_t allow_wildcard:1; //!< Allow the special case of .[*] representing
315 ///< all children of a structural attribute.
316
317 uint8_t allow_foreign:1; //!< Allow arguments not found in dict_def.
318
319 uint8_t disallow_filters:1; //!< disallow filters.
320
321 uint8_t xlat:1 ; //!< for %{User-Name}
322
323 uint8_t bare_word_enum:1; //!< for v3 compatibility.
324
325 uint8_t disallow_rhs_resolve:1; //!< map RHS is NOT immediately resolved in the context of the LHS.
326};
327
329 fr_event_list_t *runtime_el; //!< The eventlist to use for runtime instantiation
330 ///< of xlats.
331 bool new_functions; //!< new function syntax
332};
333
334/** Optional arguments passed to vp_tmpl functions
335 *
336 */
338 tmpl_rules_t const *parent; //!< for parent / child relationships
339
340 tmpl_attr_rules_t attr; //!< Rules/data for parsing attribute references.
341 tmpl_xlat_rules_t xlat; //!< Rules/data for parsing xlats.
342
343 fr_dict_attr_t const *enumv; //!< Enumeration attribute used to resolve enum values.
344
345 fr_type_t cast; //!< Whether there was an explicit cast.
346 ///< Used to determine if barewords or other values
347 ///< should be converted to an internal data type.
348
349 bool at_runtime; //!< Produce an ephemeral/runtime tmpl.
350 ///< Instantiated xlats are not added to the global
351 ///< trees, regexes are not JIT'd.
352 fr_value_box_safe_for_t literals_safe_for; //!< safe_for value assigned to literal values in
353 ///< xlats, execs, and data.
354 tmpl_escape_t escape; //!< How escaping should be handled during evaluation.
355};
356
357/** Similar to tmpl_rules_t, but used to specify parameters that may change during subsequent resolution passes
358 *
359 * When a tmpl is parsed initially the rules are stored in the #tmpl_t.
360 *
361 * During subsequent resolution phases where unresolved attributes are resolved to dictionary
362 * attributes the initial #tmpl_rules_t is used to control resolution.
363 *
364 * In some instances however (primarily policies), some rules may need change between initial
365 * parsing and subsequent resolution phases.
366 *
367 * This structure holds rules which may override the tmpl_rules_s during subsequent resolution passes.
368 */
370 fr_dict_t const *dict_def; //!< Alternative default dictionary to use if
371 ///< vpt->rules->dict_def is NULL.
372 //!< Will be written to vpt->rules->dict_def
373 ///< if used.
374
375 bool force_dict_def; //!< Use supplied dict_def even if original
376 ///< vpt->rules->dict_def was not NULL.
377
378 fr_dict_attr_t const *enumv; //!< for resolving T_BARE_WORD
379};
380
381typedef enum {
382 TMPL_ATTR_TYPE_NORMAL = 0, //!< Normal, resolved, attribute ref.
383 TMPL_ATTR_TYPE_UNSPEC, //!< No attribute was specified as this level
384 ///< only a filter.
385 TMPL_ATTR_TYPE_UNKNOWN, //!< We have an attribute number but
386 ///< it doesn't match anything in the
387 ///< dictionary, or isn't a child of
388 ///< the previous ref. May be resolved
389 ///< later.
390 TMPL_ATTR_TYPE_UNRESOLVED //!< We have a name, but nothing else
391 ///< to identify the attribute.
392 ///< may be resolved later.
394
395#define NUM_UNSPEC INT16_MIN
396#define NUM_ALL (INT16_MIN + 1)
397#define NUM_COUNT (INT16_MIN + 2)
398#define NUM_LAST (INT16_MIN + 3)
399
400/** Define entry and head types for attribute reference lists
401 *
402 */
403FR_DLIST_TYPES(tmpl_attr_list)
404
405/** Different types of filter that can be applied to an attribute reference
406 *
407 */
408typedef enum {
409 TMPL_ATTR_FILTER_TYPE_NONE = 0, //!< No filter present.
410 TMPL_ATTR_FILTER_TYPE_INDEX, //!< Filter is an index type.
411 TMPL_ATTR_FILTER_TYPE_CONDITION, //!< Filter is a condition
412 TMPL_ATTR_FILTER_TYPE_TMPL, //!< Filter is a tmpl
413 TMPL_ATTR_FILTER_TYPE_EXPR, //!< Filter is an expression
415
416typedef struct {
417 tmpl_attr_filter_type_t _CONST type; //!< Type of filter this is.
418 int16_t _CONST num; //!< For array references.
419
420 /*
421 * These are "union" because they are disjoint. The "num" field is arguably disjoint, too, but
422 * there is currently a lot of code in tmpl_tokenize.c which directly references ar->ar_num
423 * without checking the type.
424 */
425 union {
426 xlat_exp_head_t _CONST *cond; //!< xlat condition
427 tmpl_t _CONST *tmpl; //!< tmpl
428 xlat_exp_head_t _CONST *expr; //!< xlat expression
429 };
431
432/** An element in a list of nested attribute references
433 *
434 */
435typedef struct {
436 FR_DLIST_ENTRY(tmpl_attr_list) _CONST entry; //!< Entry in the doubly linked list
437 ///< of attribute references.
438
439 fr_dict_attr_t const * _CONST da; //!< Resolved dictionary attribute.
440
441 union {
442 struct {
443 fr_dict_attr_t * _CONST da; //!< Unknown dictionary attribute.
444 } unknown;
445
446 struct {
447 char * _CONST name; //!< Undefined reference type.
448 fr_dict_attr_t const * _CONST namespace; //!< Namespace we should be trying
449 ///< to resolve this attribute in.
450 } unresolved;
451 };
452
453 fr_dict_attr_t const * _CONST parent; //!< The parent we used when trying to
454 ///< resolve the attribute originally.
455 ///< Should point to the referenced
456 ///< attribute.
457
458 unsigned int _CONST resolve_only : 1; //!< This reference and those before it
459 ///< in the list can only be used for
460 ///< resolution, not building out trees.
461 unsigned int _CONST is_raw : 1; /// is a raw reference
462
463 tmpl_attr_type_t _CONST type; //!< Type of attribute reference.
464
465 tmpl_attr_filter_t _CONST filter; //!< Filter associated with the attribute reference.
467
468/** Define manipulation functions for the attribute reference list
469 *
470 */
471FR_DLIST_FUNCS(tmpl_attr_list, tmpl_attr_t, entry)
472
473/** An element in a list of request references
474 *
475 */
476typedef struct {
477 FR_DLIST_ENTRY(tmpl_request_list) _CONST entry; //!< Entry in the doubly linked list
478 ///< of request references.
479
482
483/** Define manipulation functions for the attribute reference list
484 *
485 */
486FR_DLIST_FUNCS(tmpl_request_list, tmpl_request_t, entry)
487
488/** How many additional headers to allocate in a pool for a tmpl_t
489 *
490 */
491#define TMPL_POOL_DEF_HEADERS 4
492
493/** How many additional bytes to allocate in a pool for a tmpl_t
494 *
495 */
496#define TMPL_POOL_DEF_LEN (sizeof(tmpl_t) + 64 + sizeof(tmpl_attr_t) + sizeof(tmpl_request_t))
497
498/** @name Field accessors for attribute references
499 *
500 * @{
501 */
502#define ar_type type
503#define ar_depth depth
504#define ar_da da
505#define ar_parent parent
506#define ar_unknown unknown.da
507#define ar_unresolved unresolved.name
508#define ar_unresolved_namespace unresolved.namespace
509
510#define ar_is_normal(_ar) ((_ar)->ar_type == TMPL_ATTR_TYPE_NORMAL)
511#define ar_is_unspecified(_ar) ((_ar)->ar_type == TMPL_ATTR_TYPE_UNSPEC)
512#define ar_is_unknown(_ar) ((_ar)->ar_type == TMPL_ATTR_TYPE_UNKNOWN)
513#define ar_is_unresolved(_ar) ((_ar)->ar_type == TMPL_ATTR_TYPE_UNRESOLVED)
514#define ar_is_raw(_ar) ((_ar)->is_raw)
515
516#define ar_num filter.num
517#define ar_cond filter.cond
518#define ar_tmpl filter.tmpl
519#define ar_expr filter.expr
520#define ar_filter_type filter.type
521
522#define ar_filter_is_none(_ar) ((_ar)->ar_filter_type == TMPL_ATTR_FILTER_TYPE_NONE)
523#define ar_filter_is_num(_ar) ((_ar)->ar_filter_type == TMPL_ATTR_FILTER_TYPE_INDEX)
524#define ar_filter_is_cond(_ar) ((_ar)->ar_filter_type == TMPL_ATTR_FILTER_TYPE_CONDITION)
525#define ar_filter_is_tmpl(_ar) ((_ar)->ar_filter_type == TMPL_ATTR_FILTER_TYPE_TMPL)
526#define ar_filter_is_expr(_ar) ((_ar)->ar_filter_type == TMPL_ATTR_FILTER_TYPE_EXPR)
527/** @} */
528
529/** A source or sink of value data.
530 *
531 * Is used as both the RHS and LHS of a map (both update, and conditional types)
532 *
533 * @section update_maps Use in update map_t
534 * When used on the LHS it describes an attribute to create and should be one of these types:
535 * - #TMPL_TYPE_ATTR
536 *
537 * When used on the RHS it describes the value to assign to the attribute being created and
538 * should be one of these types:
539 * - #TMPL_TYPE_DATA_UNRESOLVED
540 * - #TMPL_TYPE_XLAT_UNRESOLVED
541 * - #TMPL_TYPE_ATTR
542 * - #TMPL_TYPE_EXEC
543 * - #TMPL_TYPE_DATA
544 * - #TMPL_TYPE_XLAT (pre-parsed xlat)
545 *
546 * @section conditional_maps Use in conditional map_t
547 * When used as part of a condition it may be any of the RHS side types, as well as:
548 * - #TMPL_TYPE_REGEX (pre-parsed regex)
549 *
550 * @see map_t
551 */
552struct tmpl_s {
553 tmpl_type_t _CONST type; //!< What type of value tmpl refers to.
554
555 char const * _CONST name; //!< Raw string used to create the template.
556 ///< this string will have any escape sequences left intact.
557 size_t _CONST len; //!< Length of the raw string used to create the template.
558 fr_token_t _CONST quote; //!< What type of quoting was around the raw string.
559
560 union {
561 char *unescaped; //!< Unescaped form of the name, used for TMPL_TYPE_DATA_UNRESOLVED
562 ///< and TMPL_TYPE_REGEX_UNCOMPILED.
563
564 _CONST struct {
565 FR_DLIST_HEAD(tmpl_request_list) rr; //!< Request to search or insert in.
566 FR_DLIST_HEAD(tmpl_attr_list) ar; //!< Head of the attribute reference list.
567 } attribute;
568
569 /*
570 * Attribute value. Typically used as the RHS of an update map.
571 */
572 fr_value_box_t literal; //!< Value data.
573
574 struct {
575 union {
576 _CONST struct {
577 xlat_exp_head_t *ex; //!< pre-parsed xlat expansion
578 ///< and expansion.
579 } xlat;
580#ifdef HAVE_REGEX
581 _CONST struct {
582 char *src; //!< Original unescaped source string.
583 regex_t *ex; //!< pre-parsed regex_t
584 bool subcaptures; //!< Whether the regex was compiled with
585 ///< subcaptures.
586 } reg;
587#endif
588 };
589 fr_regex_flags_t reg_flags; //!< Flags for regular expressions.
590 ///< Used by:
591 ///< - TMPL_TYPE_REGEX_XLAT
592 ///< - TMPL_TYPE_REGEX_UNCOMPILED
593 ///< - TMPL_TYPE_REGEX
594 ///< - TMPL_TYPE_REGEX_XLAT_UNRESOLVED
595 };
597
598 tmpl_rules_t _CONST rules; //!< The rules that were used when creating the tmpl.
599 ///< These are useful for multiple resolution passes as
600 ///< they ensure the correct parsing rules are applied.
601};
602
603/** Describes the current extents of a pair tree in relation to the tree described by a tmpl_t
604 *
605 */
606typedef struct {
607 fr_dlist_t entry; //!< Entry in the dlist of extents
608
609 tmpl_attr_t const *ar; //!< Attribute representing the ar
610 ///< after the deepest node that was found
611 ///< in the existing pair tree when evaluating
612 ///< this path. If this is NULL, then all ars
613 ///< were evaluated.
614
615 TALLOC_CTX *list_ctx; //!< Where to allocate new attributes if building
616 ///< out from the current extents of the tree.
617 fr_pair_list_t *list; //!< List that we tried to evaluate ar in and failed.
618 ///< Or if ar is NULL, the list that represents the
619 ///< deepest grouping or TLV attribute the chain of
620 ///< ars referenced.
622
623/** Convenience macro for printing a meaningful assert message when we get a bad tmpl type
624 */
625#define tmpl_assert_type(_cond) \
626 fr_assert_msg(_cond, "Unexpected tmpl type '%s'", \
627 tmpl_type_to_str(vpt->type))
628
629
630/** @name Functions for printing and parsing tmpl type names
631 *
632 * @{
633 */
634/** Return a static string containing the type name
635 *
636 * @param[in] type to return name for.
637 * @return name of the type
638 */
639static inline char const *tmpl_type_to_str(tmpl_type_t type)
640{
641 return fr_table_str_by_value(tmpl_type_table, type, "<INVALID>");
642}
643
644/** Return the constant value representing a type
645 *
646 * @param[in] type to return the constant value for.
647 * @return The constant type value or TMPL_TYPE_UNINITIALISED if no type matches.
648 */
653/** @} */
654
655/** @name Field accessors for #TMPL_TYPE_ATTR, #TMPL_TYPE_ATTR_UNRESOLVED
656 *
657 * @{
658 */
659 #define tmpl_attr(_tmpl) &(_tmpl)->data.attribute.ar
660
661static inline FR_DLIST_HEAD(tmpl_request_list) const *tmpl_request(tmpl_t const *vpt)
662{
665
666 return &vpt->data.attribute.rr;
667}
668
669/** The number of request references contained within a tmpl
670 *
671 */
672static inline size_t tmpl_request_ref_count(tmpl_t const *vpt)
673{
676
677 return tmpl_request_list_num_elements(&vpt->data.attribute.rr);
678}
679
680/** Return true if the tmpl_attr is one of the list types
681 *
682 * @hidecallergraph
683*/
684static inline bool tmpl_attr_is_list_attr(tmpl_attr_t const *ar)
685{
686 if (!ar || !ar_is_normal(ar)) return false;
687
688 return (ar->ar_da == request_attr_request) ||
689 (ar->ar_da == request_attr_reply) ||
690 (ar->ar_da == request_attr_control) ||
691 (ar->ar_da == request_attr_state) ||
692 (ar->ar_da == request_attr_local);
693}
694
695/** Return true if the head attribute reference is a list reference
696 *
697 * @hidecallergraph
698 */
699static inline bool tmpl_attr_head_is_list(tmpl_t const *vpt)
700{
701 tmpl_attr_t *ar;
702
704
705 ar = tmpl_attr_list_head(tmpl_attr(vpt));
706 if (unlikely(!ar)) return false;
707
708 return tmpl_attr_is_list_attr(ar);
709}
710
711/** Return true if the last attribute reference is "normal"
712 *
713 * @hidecallergraph
714 */
715static inline bool tmpl_attr_tail_is_normal(tmpl_t const *vpt)
716{
717 tmpl_attr_t *ar;
718
720
721 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
722 if (unlikely(!ar)) return false;
723
724 return ar_is_normal(ar);
725}
726
727/** Return true if the last attribute reference is "unspecified"
728 *
729 * @hidecallergraph
730 */
731static inline bool tmpl_attr_tail_is_unspecified(tmpl_t const *vpt)
732{
733 tmpl_attr_t *ar;
734
736
737 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
738 if (unlikely(!ar)) return false;
739
740 return ar_is_unspecified(ar);
741}
742
743/** Return true if the last attribute reference is "unknown"
744 *
745 * @hidecallergraph
746 */
747static inline bool tmpl_attr_tail_is_unknown(tmpl_t const *vpt)
748{
749 tmpl_attr_t *ar;
750
752
753 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
754 if (unlikely(!ar)) return false;
755
756 return ar_is_unknown(ar);
757}
758
759/** Return true if the last attribute reference is "unresolved"
760 *
761 * @hidecallergraph
762 */
763static inline bool tmpl_attr_tail_is_unresolved(tmpl_t const *vpt)
764{
765 tmpl_attr_t *ar;
766
768
769 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
770 if (unlikely(!ar)) return false;
771
772 return ar_is_unresolved(ar);
773}
774
775/** Return true if the last attribute reference is "raw"
776 *
777 * @hidecallergraph
778 */
779static inline bool tmpl_attr_tail_is_raw(tmpl_t const *vpt)
780{
781 tmpl_attr_t *ar;
782
784
785 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
786 if (unlikely(!ar)) return false;
787
788 return ar_is_raw(ar);
789}
790
791/** Return the last attribute reference
792 *
793 * @hidecallergraph
794 */
795static inline tmpl_attr_t const *tmpl_attr_tail(tmpl_t const *vpt)
796{
798
799 return tmpl_attr_list_tail(tmpl_attr(vpt));
800}
801
802/** Return the last attribute reference da
803 *
804 * @hidecallergraph
805 */
806static inline fr_dict_attr_t const *tmpl_attr_tail_da(tmpl_t const *vpt)
807{
808 tmpl_attr_t *ar;
809
811
812 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
813 if (!ar) return NULL;
814
815 return ar->ar_da;
816}
817
818/** Return true if the the last attribute reference is a leaf attribute
819 *
820 * @hidecallergraph
821 */
822static inline bool tmpl_attr_tail_da_is_leaf(tmpl_t const *vpt)
823{
824 tmpl_attr_t *ar;
825
827
828 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
829 if (!ar) return false;
830
832
833 return fr_type_is_leaf(ar->ar_da->type);
834}
835
836/** Return true if the the last attribute reference is a structural attribute
837 *
838 * @hidecallergraph
839 */
841{
842 tmpl_attr_t *ar;
843
845
846 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
847 if (!ar) return false;
848
850
851 return fr_type_is_structural(ar->ar_da->type);
852}
853
854/** Return the last attribute reference unknown da
855 *
856 * @hidecallergraph
857 */
859{
860 tmpl_attr_t *ar;
861
863
864 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
865 if (!ar) return NULL;
866
867 return ar->ar_unknown;
868}
869
870/** Return the last attribute reference unresolved da
871 *
872 * @hidecallergraph
873 */
874static inline char const *tmpl_attr_tail_unresolved(tmpl_t const *vpt)
875{
876 tmpl_attr_t *ar;
877
879
880 ar = tmpl_attr_list_tail(tmpl_attr(vpt));
881 if (!ar) return NULL;
882
883 return ar->ar_unresolved;
884}
885
886/** Return the last attribute reference's attribute number
887 *
888 * @hidecallergraph
889 */
890static inline int16_t tmpl_attr_tail_num(tmpl_t const *vpt)
891{
894
895 return tmpl_attr_list_tail(tmpl_attr(vpt))->ar_num;
896}
897
898/** The number of attribute references contained within a tmpl
899 *
900 */
901static inline size_t tmpl_attr_num_elements(tmpl_t const *vpt)
902{
905
906 return tmpl_attr_list_num_elements(tmpl_attr(vpt));
907}
908
909static inline fr_dict_attr_t const *tmpl_list(tmpl_t const *vpt)
910{
911 if (!tmpl_attr_head_is_list(vpt)) return NULL;
912
913 return tmpl_attr_list_head(tmpl_attr(vpt))->ar_da;
914}
915/** @} */
916
917/** Return the name of a tmpl list or def if list not provided
918 *
919*/
920static inline char const *tmpl_list_name(fr_dict_attr_t const *list, char const *def)
921{
922 return (list ? list->name : def);
923}
924
925static inline bool tmpl_is_list(tmpl_t const *vpt)
926{
927 if (!tmpl_is_attr(vpt)) return false;
929}
930
931/** @name Field accessors for #TMPL_TYPE_XLAT
932 *
933 * @{
934 */
935#define tmpl_xlat(_tmpl) (_tmpl)->data.xlat.ex
936/** @} */
937
938/** @name Field accessors for #TMPL_TYPE_DATA
939 *
940 * @{
941 */
942#define tmpl_value(_tmpl) (&(_tmpl)->data.literal)
943#define tmpl_value_length(_tmpl) (_tmpl)->data.literal.vb_length
944#define tmpl_value_type(_tmpl) (_tmpl)->data.literal.type
945#define tmpl_value_enumv(_tmpl) (_tmpl)->data.literal.enumv
946
947#define tmpl_rules_cast(_tmpl) (_tmpl)->rules.cast
948#define tmpl_rules_enumv(_tmpl) (_tmpl)->rules.enumv
949
950fr_type_t tmpl_data_type(tmpl_t const *vpt) CC_HINT(nonnull);
951
952/** @} */
953
954/** @name Field accessors for #TMPL_TYPE_REGEX and #TMPL_TYPE_REGEX_XLAT_UNRESOLVED
955 *
956 * @{
957 */
958#ifdef HAVE_REGEX
959# define tmpl_regex(_tmpl) (_tmpl)->data.reg.ex //!< #TMPL_TYPE_REGEX only.
960# define tmpl_regex_flags(_tmpl) (&(_tmpl)->data.reg_flags)
961#endif
962/** @} */
963
964#ifndef WITH_VERIFY_PTR
965# define TMPL_ATTR_VERIFY(_vpt)
966# define TMPL_VERIFY(_vpt)
967#else
968# define TMPL_ATTR_VERIFY(_vpt) tmpl_attr_verify(__FILE__, __LINE__, _vpt)
969# define TMPL_VERIFY(_vpt) tmpl_verify(__FILE__, __LINE__, _vpt)
970void tmpl_attr_verify(char const *file, int line, tmpl_t const *vpt);
971void tmpl_verify(char const *file, int line, tmpl_t const *vpt);
972#endif
973
974/** Determine the correct context and list head
975 *
976 * Used in conjunction with the fr_dcursor functions to determine the correct list
977 * and TALLOC_CTX for inserting fr_pair_ts.
978 *
979 * Example:
980 @code{.c}
981 TALLOC_CTX *ctx;
982 fr_pair_list_t *head;
983 fr_value_box_t value;
984
985 tmpl_pair_list_and_ctx(ctx, head, request, CURRENT_REQUEST, request_attr_request);
986 if (!list) return -1; // error
987
988 value.strvalue = talloc_typed_strdup(NULL, "my new username");
989 value.length = talloc_array_length(value.strvalue) - 1;
990 @endcode
991 *
992 * @param _ctx new #fr_pair_t s should be allocated in for the specified list.
993 * @param _head of the #fr_pair_t list.
994 * @param _request The current request.
995 * @param _ref to resolve.
996 * @param _list to resolve.
997 */
998#define tmpl_pair_list_and_ctx(_ctx, _head, _request, _ref, _list) \
999do {\
1000 request_t *_rctx = _request; \
1001 if ((tmpl_request_ptr(&_rctx, _ref) < 0) || \
1002 !(_head = tmpl_list_head(_rctx, _list)) || \
1003 !(_ctx = tmpl_list_ctx(_rctx, _list))) {\
1004 _ctx = NULL; \
1005 _head = NULL; \
1006 }\
1007} while (0)
1008
1009typedef enum {
1010 TMPL_ATTR_ERROR_NONE = 0, //!< No error.
1011 TMPL_ATTR_ERROR_EMPTY, //!< Attribute ref contains no data.
1012 TMPL_ATTR_ERROR_BAD_PREFIX, //!< Missing '&' or has '&' when it shouldn't.
1013 TMPL_ATTR_ERROR_LIST_NOT_ALLOWED, //!< List qualifier is not allowed here.
1014 TMPL_ATTR_ERROR_LIST_MISSING, //!< List qualifier is required, but missing.
1015 TMPL_ATTR_ERROR_UNKNOWN_NOT_ALLOWED, //!< Attribute specified as OID, could not be
1016 ///< found in the dictionaries, and is disallowed
1017 ///< because 'disallow_internal' in tmpl_rules_t
1018 ///< is trie.
1019 TMPL_ATTR_ERROR_UNRESOLVED_NOT_ALLOWED, //!< Attribute couldn't be found in the dictionaries.
1020 TMPL_ATTR_ERROR_UNQUALIFIED_NOT_ALLOWED, //!< Attribute must be qualified to be used here.
1021 TMPL_ATTR_ERROR_INVALID_NAME, //!< Attribute ref length is zero, or longer than
1022 ///< the maximum.
1023 TMPL_ATTR_ERROR_INTERNAL_NOT_ALLOWED, //!< Attribute resolved to an internal attribute
1024 ///< which is disallowed.
1025 TMPL_ATTR_ERROR_FOREIGN_NOT_ALLOWED, //!< Attribute resolved in a dictionary different
1026 ///< to the one specified.
1027 TMPL_ATTR_ERROR_FILTER_NOT_ALLOWED, //!< Filters disallowed by rules.
1028 TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX, //!< Invalid array index.
1030 TMPL_ATTR_ERROR_NESTING_TOO_DEEP, //!< Too many levels of nesting.
1031 TMPL_ATTR_ERROR_MISSING_TERMINATOR, //!< Unexpected text found after attribute reference
1032 TMPL_ATTR_ERROR_BAD_CAST //!< Specified cast was invalid.
1034
1035/** Map ptr type to a boxed type
1036 *
1037 */
1038#define FR_TYPE_FROM_PTR(_ptr) \
1039 _Generic((_ptr), \
1040 char **: FR_TYPE_STRING, \
1041 char const **: FR_TYPE_STRING, \
1042 uint8_t **: FR_TYPE_OCTETS, \
1043 uint8_t const **: FR_TYPE_OCTETS, \
1044 uint8_t *: FR_TYPE_UINT8, \
1045 uint16_t *: FR_TYPE_UINT16, \
1046 uint32_t *: FR_TYPE_UINT32, \
1047 uint64_t *: FR_TYPE_UINT64, \
1048 fr_value_box_t **: FR_TYPE_VALUE_BOX, \
1049 fr_value_box_t const **: FR_TYPE_VALUE_BOX)
1050
1051/** Expand a tmpl to a C type, using existing storage to hold variably sized types
1052 *
1053 * Expands a template using the _out ptr to determinate the cast type.
1054 *
1055 * @see _tmpl_to_type
1056 */
1057#define tmpl_expand(_out, _buff, _buff_len, _request, _vpt) \
1058 _tmpl_to_type((void *)(_out), (uint8_t *)_buff, _buff_len, \
1059 _request, _vpt, FR_TYPE_FROM_PTR(_out))
1060
1061/** Expand a tmpl to a C type, allocing a new buffer to hold the string
1062 *
1063 * Expands a template using the _out ptr to determinate the cast type.
1064 *
1065 * @see _tmpl_to_atype
1066 */
1067#define tmpl_aexpand(_ctx, _out, _request, _vpt, _escape, _escape_ctx) \
1068 _tmpl_to_atype(_ctx, (void *)(_out), _request, _vpt, _escape, _escape_ctx, FR_TYPE_FROM_PTR(_out))
1069
1070/** Expand a tmpl to a C type, allocing a new buffer to hold the string
1071 *
1072 * Takes an explicit type which must match the ctype pointed to by out.
1073 *
1074 * @see _tmpl_to_atype
1075 */
1076#define tmpl_aexpand_type(_ctx, _out, _type, _request, _vpt) \
1077 _tmpl_to_atype(_ctx, (void *)(_out), _request, _vpt, NULL, NULL, _type)
1078
1079void tmpl_debug(tmpl_t const *vpt) CC_HINT(nonnull);
1080
1082
1083fr_packet_t *tmpl_packet_ptr(request_t *request, fr_dict_attr_t const *list) CC_HINT(nonnull);
1084
1085TALLOC_CTX *tmpl_list_ctx(request_t *request, fr_dict_attr_t const *list);
1086
1088
1089tmpl_t *tmpl_init_printf(tmpl_t *vpt, tmpl_type_t type, fr_token_t quote, char const *fmt, ...) CC_HINT(nonnull(1,4));
1090
1092 char const *name, ssize_t len,
1093 tmpl_rules_t const *t_rules) CC_HINT(nonnull(1,4));
1094
1096 char const *name, ssize_t len,
1097 tmpl_rules_t const *t_rules) CC_HINT(nonnull(1,4));
1098
1099tmpl_t *tmpl_alloc(TALLOC_CTX *ctx, tmpl_type_t type, fr_token_t quote, char const *name, ssize_t len);
1100
1101/** @name Parse request qualifiers
1102 *
1103 * @{
1104 */
1105/** Static default request ref list for the current request
1106 *
1107 * Passed as request_def in tmpl_attr_rules_t.
1108 */
1109extern FR_DLIST_HEAD(tmpl_request_list) tmpl_request_def_current;
1110
1111/** Static default request ref list for the outer request
1112 *
1113 * Passed as request_def in tmpl_attr_rules_t.
1114 */
1115extern FR_DLIST_HEAD(tmpl_request_list) tmpl_request_def_outer;
1116
1117/** Static default request ref list for the parent request
1118 *
1119 * Passed as request_def in tmpl_attr_rules_t.
1120 */
1121extern FR_DLIST_HEAD(tmpl_request_list) tmpl_request_def_parent;
1122
1123int tmpl_request_ptr(request_t **request, FR_DLIST_HEAD(tmpl_request_list) const *rql) CC_HINT(nonnull);
1124
1125void tmpl_request_ref_list_debug(FR_DLIST_HEAD(tmpl_request_list) const *rql);
1126
1127int8_t tmpl_request_ref_list_cmp(FR_DLIST_HEAD(tmpl_request_list) const *a,
1128 FR_DLIST_HEAD(tmpl_request_list) const *b);
1129
1130/** Returns true if the specified qualifier list points to the current request
1131 *
1132 * @param[in] _list to check.
1133 * @return
1134 * - true if the list only contains a current request qualifier.
1135 * - false otherwise.
1136 */
1137#define tmpl_request_ref_is_current(_list) (tmpl_request_ref_list_cmp(_list, &tmpl_request_def_current) == 0)
1138
1139/** Returns true if the specified qualifier list points to the parent request
1140 *
1141 * @param[in] _list to check.
1142 * @return
1143 * - true if the list only contains a parent request qualifier.
1144 * - false otherwise.
1145 */
1146#define tmpl_request_ref_is_parent(_list) (tmpl_request_ref_list_cmp(_list, &tmpl_request_def_parent) == 0)
1147
1148/** Returns true if the specified qualifier list points to the outer request
1149 *
1150 * @param[in] _list to check.
1151 * @return
1152 * - true if the list only contains a outer request qualifier.
1153 * - false otherwise.
1154 */
1155#define tmpl_request_ref_is_outer(_list) (tmpl_request_ref_list_cmp(_list, &tmpl_request_def_outer) == 0)
1156
1157
1159 FR_DLIST_HEAD(tmpl_request_list) _CONST **out,
1160 fr_sbuff_t *in);
1161/** @} */
1162
1163void tmpl_set_name_printf(tmpl_t *vpt, fr_token_t quote, char const *fmt, ...) CC_HINT(nonnull(1,3));
1164
1165void tmpl_set_name_shallow(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len) CC_HINT(nonnull);
1166
1167void tmpl_set_name(tmpl_t *vpt, fr_token_t quote, char const *name, ssize_t len) CC_HINT(nonnull);
1168
1169void tmpl_set_dict_def(tmpl_t *vpt, fr_dict_t const *dict) CC_HINT(nonnull);
1170
1171void tmpl_set_escape(tmpl_t *vpt, tmpl_escape_t const *escape) CC_HINT(nonnull);
1172
1173void tmpl_set_xlat(tmpl_t *vpt, xlat_exp_head_t *xlat) CC_HINT(nonnull);
1174
1175int tmpl_afrom_value_box(TALLOC_CTX *ctx, tmpl_t **out, fr_value_box_t *data, bool steal) CC_HINT(nonnull);
1176
1177void tmpl_attr_ref_debug(const tmpl_attr_t *ar, int idx) CC_HINT(nonnull);
1178
1179void tmpl_attr_ref_list_debug(FR_DLIST_HEAD(tmpl_attr_list) const *ar_head) CC_HINT(nonnull);
1180
1181void tmpl_attr_debug(tmpl_t const *vpt) CC_HINT(nonnull);
1182
1183int tmpl_attr_copy(tmpl_t *dst, tmpl_t const *src) CC_HINT(nonnull);
1184
1185int tmpl_attr_set_da(tmpl_t *vpt, fr_dict_attr_t const *da) CC_HINT(nonnull);
1186
1187int tmpl_attr_set_leaf_da(tmpl_t *vpt, fr_dict_attr_t const *da) CC_HINT(nonnull);
1188
1189void tmpl_attr_rewrite_leaf_num(tmpl_t *vpt, int16_t num) CC_HINT(nonnull);
1190
1191void tmpl_attr_set_request_ref(tmpl_t *vpt, FR_DLIST_HEAD(tmpl_request_list) const *request_def) CC_HINT(nonnull);
1192
1193void tmpl_attr_set_list(tmpl_t *vpt, fr_dict_attr_t const *list) CC_HINT(nonnull);
1194
1195int tmpl_attr_afrom_list(TALLOC_CTX *ctx, tmpl_t **out, tmpl_t const *list,
1196 fr_dict_attr_t const *da) CC_HINT(nonnull);
1197
1198/** @name Produce a #tmpl_t from a string or substring
1199 *
1200 * @{
1201 */
1204 fr_sbuff_parse_rules_t const *p_rules,
1205 tmpl_rules_t const *t_rules) CC_HINT(nonnull(3,4));
1206
1208 tmpl_t **out, char const *name,
1209 tmpl_rules_t const *rules) CC_HINT(nonnull (3, 4));
1210
1211ssize_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out,
1212 fr_sbuff_t *in,
1213 fr_token_t quote,
1214 fr_sbuff_parse_rules_t const *p_rules,
1215 tmpl_rules_t const *t_rules) CC_HINT(nonnull(2,3));
1216
1217tmpl_t *tmpl_copy(TALLOC_CTX *ctx, tmpl_t const *in) CC_HINT(nonnull);
1218
1219ssize_t tmpl_cast_from_substr(tmpl_rules_t *t_rules, fr_sbuff_t *in) CC_HINT(nonnull(2)); /* Parses cast string */
1220
1221int tmpl_cast_set(tmpl_t *vpt, fr_type_t type) CC_HINT(nonnull); /* Sets cast type */
1222
1224{
1225 return vpt->rules.cast;
1226}
1227
1228#ifdef HAVE_REGEX
1229ssize_t tmpl_regex_flags_substr(tmpl_t *vpt, fr_sbuff_t *in,
1230 fr_sbuff_term_t const *terminals) CC_HINT(nonnull(1,2));
1231#endif
1232/** @} */
1233
1234/** @name Change a #tmpl_t type, usually by casting or resolving a reference
1235 * @{
1236 */
1237int tmpl_cast_in_place(tmpl_t *vpt, fr_type_t type, fr_dict_attr_t const *enumv) CC_HINT(nonnull(1));
1238
1239int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules) CC_HINT(nonnull(1));
1240
1241void tmpl_unresolve(tmpl_t *vpt) CC_HINT(nonnull);
1242
1243void tmpl_attr_to_raw(tmpl_t *vpt) CC_HINT(nonnull);
1244
1246
1248 fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1));
1249
1250#ifdef HAVE_REGEX
1251ssize_t tmpl_regex_compile(tmpl_t *vpt, bool subcaptures) CC_HINT(nonnull);
1252#endif
1253/** @} */
1254
1255/** @name Print the contents of a #tmpl_t
1256 * @{
1257 */
1258fr_slen_t tmpl_request_ref_list_print(fr_sbuff_t *out, FR_DLIST_HEAD(tmpl_request_list) const *rql)
1259 CC_HINT(nonnull(1,2));
1260
1261static inline fr_slen_t tmpl_request_ref_list_aprint(TALLOC_CTX *ctx, char **out, FR_DLIST_HEAD(tmpl_request_list) const *rql)
1263
1265
1266static inline fr_slen_t tmpl_attr_aprint(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt)
1268
1270 fr_sbuff_escape_rules_t const *e_rules) CC_HINT(nonnull(1,2));
1271
1272static inline fr_slen_t tmpl_aprint(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt,
1273 fr_sbuff_escape_rules_t const *e_rules)
1275
1277
1278static inline fr_slen_t tmpl_aprint_quoted(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt)
1280/** @} */
1281
1282/** @name Expand the tmpl, returning one or more values
1283 * @{
1284 */
1286
1288 uint8_t *buff, size_t outlen,
1289 request_t *request,
1290 tmpl_t const *vpt,
1291 fr_type_t dst_type)
1292 CC_HINT(nonnull (1, 4, 5));
1293
1294ssize_t _tmpl_to_atype(TALLOC_CTX *ctx, void *out,
1295 request_t *request,
1296 tmpl_t const *vpt,
1297 xlat_escape_legacy_t escape, void const *escape_ctx,
1298 fr_type_t dst_type)
1299 CC_HINT(nonnull (2, 3, 4));
1300
1301int tmpl_copy_pairs(TALLOC_CTX *ctx, fr_pair_list_t *out,
1302 request_t *request, tmpl_t const *vpt) CC_HINT(nonnull(2,3,4));
1303
1304int tmpl_copy_pair_children(TALLOC_CTX *ctx, fr_pair_list_t *out,
1305 request_t *request, tmpl_t const *vpt) CC_HINT(nonnull(2,3,4));
1306
1307int tmpl_find_vp(fr_pair_t **out, request_t *request, tmpl_t const *vpt) CC_HINT(nonnull(2,3));
1308
1309int tmpl_find_or_add_vp(fr_pair_t **out, request_t *request, tmpl_t const *vpt) CC_HINT(nonnull);
1310
1311int pair_append_by_tmpl_parent(TALLOC_CTX *ctx, fr_pair_t **out, fr_pair_list_t *list,
1312 tmpl_t const *vpt, bool skip_list) CC_HINT(nonnull(1,3,4));
1313
1314int tmpl_extents_find(TALLOC_CTX *ctx,
1315 fr_dlist_head_t *leaf, fr_dlist_head_t *interior,
1316 request_t *request, tmpl_t const *vpt) CC_HINT(nonnull(5));
1317
1319 tmpl_t const *vpt) CC_HINT(nonnull);
1320
1322
1323int tmpl_eval_pair(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt);
1324
1325int tmpl_eval(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt);
1326
1327int tmpl_eval_cast_in_place(fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt);
1328/** @} */
1329
1330ssize_t tmpl_preparse(char const **out, size_t *outlen, char const *in, size_t inlen,
1331 fr_token_t *type) CC_HINT(nonnull(1,2,3,5));
1332
1333bool tmpl_async_required(tmpl_t const *vpt) CC_HINT(nonnull);
1334
1335int tmpl_value_list_insert_tail(fr_value_box_list_t *list, fr_value_box_t *vb, tmpl_t const *vpt) CC_HINT(nonnull);
1336
1337void tmpl_rules_child_init(TALLOC_CTX *ctx, tmpl_rules_t *out, tmpl_rules_t const *parent, tmpl_t *vpt) CC_HINT(nonnull);
1338
1339void tmpl_rules_debug(tmpl_rules_t const *rules) CC_HINT(nonnull);
1340
1341int tmpl_global_init(void);
1342
1343#undef _CONST
1344
1345#ifdef __cplusplus
1346}
1347#endif
int const char * file
Definition acutest.h:702
static int const char * fmt
Definition acutest.h:573
int const char int line
Definition acutest.h:702
#define RCSIDH(h, id)
Definition build.h:486
#define unlikely(_x)
Definition build.h:383
static fr_slen_t err
Definition dict.h:831
static fr_slen_t in
Definition dict.h:831
Values of the encryption flags.
#define FR_DLIST_TYPES(_name)
Define type specific wrapper structs for dlists.
Definition dlist.h:1129
#define FR_DLIST_FUNCS(_name, _element_type, _element_entry)
Define type specific wrapper functions for dlists.
Definition dlist.h:1152
#define FR_DLIST_HEAD(_name)
Expands to the type name used for the head wrapper structure.
Definition dlist.h:1122
Head of a doubly linked list.
Definition dlist.h:51
Entry in a doubly linked list.
Definition dlist.h:41
Stores all information relating to an event list.
Definition event.c:380
size_t(* xlat_escape_legacy_t)(request_t *request, char *out, size_t outlen, char const *in, void *arg)
fr_type_t
long int ssize_t
unsigned char uint8_t
ssize_t fr_slen_t
#define fr_assert(_expr)
Definition rad_assert.h:38
fr_dict_attr_t const * request_attr_request
Definition request.c:45
fr_dict_attr_t const * request_attr_control
Definition request.c:47
fr_dict_attr_t const * request_attr_local
Definition request.c:49
fr_dict_attr_t const * request_attr_state
Definition request.c:48
fr_dict_attr_t const * request_attr_reply
Definition request.c:46
static char const * name
#define SBUFF_OUT_TALLOC_FUNC_NO_LEN_DEF(_func,...)
Set of terminal elements.
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.
int tmpl_find_vp(fr_pair_t **out, request_t *request, tmpl_t const *vpt))
Returns the first VP matching a tmpl_t.
Definition tmpl_eval.c:880
void tmpl_request_ref_list_debug(FR_DLIST_HEAD(tmpl_request_list) const *rql)
Dump a request list to stderr.
static tmpl_attr_t const * tmpl_attr_tail(tmpl_t const *vpt)
Return the last attribute reference.
Definition tmpl.h:795
static int16_t tmpl_attr_tail_num(tmpl_t const *vpt)
Return the last attribute reference's attribute number.
Definition tmpl.h:890
void tmpl_attr_set_list(tmpl_t *vpt, fr_dict_attr_t const *list)
#define ar_is_unspecified(_ar)
Definition tmpl.h:511
static char const * tmpl_type_to_str(tmpl_type_t type)
Return a static string containing the type name.
Definition tmpl.h:639
void tmpl_unresolve(tmpl_t *vpt)
Reset the tmpl, leaving only the name in place.
#define tmpl_is_attr_unresolved(vpt)
Definition tmpl.h:224
enum requests_ref_e tmpl_request_ref_t
void tmpl_set_name_printf(tmpl_t *vpt, fr_token_t quote, char const *fmt,...))
Set the name on a pre-initialised tmpl.
static bool tmpl_attr_tail_is_unspecified(tmpl_t const *vpt)
Return true if the last attribute reference is "unspecified".
Definition tmpl.h:731
void tmpl_set_xlat(tmpl_t *vpt, xlat_exp_head_t *xlat)
Change the default dictionary in the tmpl's resolution rules.
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.
int tmpl_attr_set_da(tmpl_t *vpt, fr_dict_attr_t const *da)
Replace the current attribute reference.
fr_packet_t * tmpl_packet_ptr(request_t *request, fr_dict_attr_t const *list)
Resolve a list to the fr_packet_t holding the HEAD pointer for a fr_pair_t list.
Definition tmpl_eval.c:146
tmpl_escape_t escape
How escaping should be handled during evaluation.
Definition tmpl.h:354
static bool tmpl_attr_tail_is_normal(tmpl_t const *vpt)
Return true if the last attribute reference is "normal".
Definition tmpl.h:715
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.
int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules))
Attempt to resolve functions and attributes in xlats and attribute references.
static fr_slen_t tmpl_aprint_quoted(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt) 1(tmpl_print_quoted
TALLOC_CTX * list_ctx
Where to allocate new attributes if building out from the current extents of the tree.
Definition tmpl.h:615
fr_table_num_sorted_t const tmpl_request_ref_table[]
Map keywords to tmpl_request_ref_t values.
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.
#define TMPL_FLAG_ATTR
Base data type is an attribute reference.
Definition tmpl.h:106
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.
#define ar_is_unknown(_ar)
Definition tmpl.h:512
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.
int tmpl_attr_unknown_add(tmpl_t *vpt)
Add an unknown fr_dict_attr_t specified by a tmpl_t to the main dictionary.
static bool tmpl_attr_tail_is_unknown(tmpl_t const *vpt)
Return true if the last attribute reference is "unknown".
Definition tmpl.h:747
int tmpl_extents_build_to_leaf_parent(fr_dlist_head_t *leaf, fr_dlist_head_t *interior, tmpl_t const *vpt)
Allocate interior pairs.
static tmpl_type_t tmpl_type_from_str(char const *type)
Return the constant value representing a type.
Definition tmpl.h:649
void tmpl_attr_ref_debug(const tmpl_attr_t *ar, int idx)
fr_value_box_safe_for_t literals_safe_for
safe_for value assigned to literal values in xlats, execs, and data.
Definition tmpl.h:352
void tmpl_set_escape(tmpl_t *vpt, tmpl_escape_t const *escape)
Set escape parameters for the tmpl output.
#define TMPL_FLAG_UNRESOLVED
Needs resolution.
Definition tmpl.h:121
#define ar_is_raw(_ar)
Definition tmpl.h:514
size_t pair_list_table_len
#define tmpl_is_attr(vpt)
Definition tmpl.h:213
bool tmpl_async_required(tmpl_t const *vpt)
Return whether or not async is required for this tmpl.
fr_dict_attr_t const * enumv
Enumeration attribute used to resolve enum values.
Definition tmpl.h:343
tmpl_rules_t const * parent
for parent / child relationships
Definition tmpl.h:338
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.
static fr_slen_t tmpl_aprint(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt, fr_sbuff_escape_rules_t const *e_rules) 1(tmpl_print
static fr_dict_attr_t const * tmpl_list(tmpl_t const *vpt)
Definition tmpl.h:909
int16_t _CONST num
For array references.
Definition tmpl.h:418
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:684
int tmpl_extents_find(TALLOC_CTX *ctx, fr_dlist_head_t *leaf, fr_dlist_head_t *interior, request_t *request, tmpl_t const *vpt))
Determines points where the reference list extends beyond the current pair tree.
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.
static fr_slen_t tmpl_request_ref_list_aprint(TALLOC_CTX *ctx, char **out, FR_DLIST_HEAD(tmpl_request_list) const *rql) 1(tmpl_request_ref_list_print
int tmpl_eval_cast_in_place(fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt)
Casts a value or list of values according to the tmpl.
Definition tmpl_eval.c:1340
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.
tmpl_type_e
Types of tmpl_t.
Definition tmpl.h:131
@ TMPL_TYPE_REGEX_UNCOMPILED
Regex where compilation is possible but hasn't been performed yet.
Definition tmpl.h:162
@ TMPL_TYPE_MAX
Marker for the last tmpl type.
Definition tmpl.h:203
@ TMPL_TYPE_ATTR_UNRESOLVED
An attribute reference that we couldn't resolve but looked valid.
Definition tmpl.h:189
@ TMPL_TYPE_ATTR
Reference to one or more attributes.
Definition tmpl.h:146
@ TMPL_TYPE_XLAT
Pre-parsed xlat expansion.
Definition tmpl.h:150
@ TMPL_TYPE_NULL
Has no value.
Definition tmpl.h:138
@ TMPL_TYPE_EXEC
Callout to an external script or program.
Definition tmpl.h:154
@ TMPL_TYPE_REGEX_XLAT_UNRESOLVED
A regular expression with unresolved xlat functions or attribute references.
Definition tmpl.h:201
@ TMPL_TYPE_DATA
Value in native boxed format.
Definition tmpl.h:142
@ TMPL_TYPE_REGEX
Compiled (and possibly JIT'd) regular expression.
Definition tmpl.h:158
@ TMPL_TYPE_DATA_UNRESOLVED
Unparsed literal string.
Definition tmpl.h:183
@ TMPL_TYPE_XLAT_UNRESOLVED
A xlat expansion with unresolved xlat functions or attribute references.
Definition tmpl.h:197
@ TMPL_TYPE_REGEX_XLAT
A regex containing xlat expansions.
Definition tmpl.h:166
@ TMPL_TYPE_EXEC_UNRESOLVED
An exec with unresolved xlat function or attribute references.
Definition tmpl.h:193
@ TMPL_TYPE_UNINITIALISED
Uninitialised.
Definition tmpl.h:134
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.
void tmpl_attr_to_raw(tmpl_t *vpt)
Convert the leaf attribute of a tmpl to a unknown/raw type.
static bool tmpl_attr_tail_da_is_leaf(tmpl_t const *vpt)
Return true if the the last attribute reference is a leaf attribute.
Definition tmpl.h:822
#define tmpl_assert_type(_cond)
Convenience macro for printing a meaningful assert message when we get a bad tmpl type.
Definition tmpl.h:625
static fr_slen_t vpt fr_slen_t tmpl_print(fr_sbuff_t *out, tmpl_t const *vpt, fr_sbuff_escape_rules_t const *e_rules))
Print a tmpl_t to a string.
#define tmpl_contains_attr(vpt)
Definition tmpl.h:230
int tmpl_eval(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt)
Gets the value of a tmpl.
Definition tmpl_eval.c:1212
tmpl_t * tmpl_copy(TALLOC_CTX *ctx, tmpl_t const *in)
Copy a tmpl.
static bool tmpl_attr_tail_da_is_structural(tmpl_t const *vpt)
Return true if the the last attribute reference is a structural attribute.
Definition tmpl.h:840
int tmpl_copy_pairs(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, tmpl_t const *vpt))
Copy pairs matching a tmpl_t in the current request_t.
Definition tmpl_eval.c:789
ssize_t _tmpl_to_atype(TALLOC_CTX *ctx, void *out, request_t *request, tmpl_t const *vpt, xlat_escape_legacy_t escape, void const *escape_ctx, fr_type_t dst_type))
Expand a template to a string, allocing a new buffer to hold the string.
Definition tmpl_eval.c:547
#define TMPL_FLAG_REGEX
Is a type of regular expression.
Definition tmpl.h:116
fr_pair_list_t * tmpl_list_head(request_t *request, fr_dict_attr_t const *list)
Resolve attribute fr_pair_list_t value to an attribute list.
Definition tmpl_eval.c:76
static size_t tmpl_request_ref_count(tmpl_t const *vpt)
The number of request references contained within a tmpl.
Definition tmpl.h:672
TALLOC_CTX * tmpl_list_ctx(request_t *request, fr_dict_attr_t const *list)
Return the correct TALLOC_CTX to alloc fr_pair_t in, for a list.
Definition tmpl_eval.c:116
ssize_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_token_t quote, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Convert an arbitrary string into a tmpl_t.
tmpl_rules_t _CONST rules
The rules that were used when creating the tmpl.
Definition tmpl.h:598
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.
fr_dlist_t entry
Entry in the dlist of extents.
Definition tmpl.h:607
fr_type_t tmpl_data_type(tmpl_t const *vpt)
Definition tmpl_eval.c:1447
int tmpl_global_init(void)
Definition tmpl_eval.c:1486
tmpl_xlat_rules_t xlat
Rules/data for parsing xlats.
Definition tmpl.h:341
static char const * tmpl_attr_tail_unresolved(tmpl_t const *vpt)
Return the last attribute reference unresolved da.
Definition tmpl.h:874
bool at_runtime
Produce an ephemeral/runtime tmpl.
Definition tmpl.h:349
static bool tmpl_is_list(tmpl_t const *vpt)
Definition tmpl.h:925
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.
bool new_functions
new function syntax
Definition tmpl.h:331
int tmpl_eval_pair(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt)
Gets the value of a real or virtual attribute.
Definition tmpl_eval.c:1068
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...
bool force_dict_def
Use supplied dict_def even if original vpt->rules->dict_def was not NULL.
Definition tmpl.h:375
void tmpl_debug(tmpl_t const *vpt)
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.
static fr_slen_t vpt
Definition tmpl.h:1274
fr_dict_t const * dict_def
Alternative default dictionary to use if vpt->rules->dict_def is NULL.
Definition tmpl.h:370
static bool tmpl_attr_tail_is_unresolved(tmpl_t const *vpt)
Return true if the last attribute reference is "unresolved".
Definition tmpl.h:763
tmpl_type_t _CONST type
What type of value tmpl refers to.
Definition tmpl.h:553
#define _CONST
Definition tmpl.h:258
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()
union tmpl_s::@87 data
static size_t tmpl_attr_num_elements(tmpl_t const *vpt)
The number of attribute references contained within a tmpl.
Definition tmpl.h:901
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)
fr_table_num_ordered_t const pair_list_table[]
#define tmpl_attr(_tmpl)
Definition tmpl.h:659
void tmpl_attr_rewrite_leaf_num(tmpl_t *vpt, int16_t num)
Rewrite the leaf's instance number.
static fr_slen_t tmpl_attr_aprint(TALLOC_CTX *ctx, char **out, tmpl_t const *vpt) 1(tmpl_attr_print
void tmpl_attr_ref_list_debug(FR_DLIST_HEAD(tmpl_attr_list) const *ar_head)
static fr_type_t tmpl_cast_get(tmpl_t *vpt)
Definition tmpl.h:1223
int tmpl_request_ptr(request_t **request, FR_DLIST_HEAD(tmpl_request_list) const *rql)
Resolve a tmpl_request_ref_t to a request_t.
Definition tmpl_eval.c:169
char const *_CONST name
Raw string used to create the template.
Definition tmpl.h:555
tmpl_attr_error_t
Definition tmpl.h:1009
@ TMPL_ATTR_ERROR_INVALID_ARRAY_INDEX
Invalid array index.
Definition tmpl.h:1028
@ TMPL_ATTR_ERROR_LIST_NOT_ALLOWED
List qualifier is not allowed here.
Definition tmpl.h:1013
@ TMPL_ATTR_ERROR_INTERNAL_NOT_ALLOWED
Attribute resolved to an internal attribute which is disallowed.
Definition tmpl.h:1023
@ TMPL_ATTR_ERROR_UNRESOLVED_NOT_ALLOWED
Attribute couldn't be found in the dictionaries.
Definition tmpl.h:1019
@ TMPL_ATTR_ERROR_INVALID_FILTER
Invalid filter.
Definition tmpl.h:1029
@ TMPL_ATTR_ERROR_BAD_CAST
Specified cast was invalid.
Definition tmpl.h:1032
@ TMPL_ATTR_ERROR_INVALID_NAME
Attribute ref length is zero, or longer than the maximum.
Definition tmpl.h:1021
@ TMPL_ATTR_ERROR_UNQUALIFIED_NOT_ALLOWED
Attribute must be qualified to be used here.
Definition tmpl.h:1020
@ TMPL_ATTR_ERROR_MISSING_TERMINATOR
Unexpected text found after attribute reference.
Definition tmpl.h:1031
@ TMPL_ATTR_ERROR_LIST_MISSING
List qualifier is required, but missing.
Definition tmpl.h:1014
@ TMPL_ATTR_ERROR_NONE
No error.
Definition tmpl.h:1010
@ TMPL_ATTR_ERROR_FOREIGN_NOT_ALLOWED
Attribute resolved in a dictionary different to the one specified.
Definition tmpl.h:1025
@ 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:1015
@ TMPL_ATTR_ERROR_FILTER_NOT_ALLOWED
Filters disallowed by rules.
Definition tmpl.h:1027
@ TMPL_ATTR_ERROR_EMPTY
Attribute ref contains no data.
Definition tmpl.h:1011
@ TMPL_ATTR_ERROR_NESTING_TOO_DEEP
Too many levels of nesting.
Definition tmpl.h:1030
@ TMPL_ATTR_ERROR_BAD_PREFIX
Missing '&' or has '&' when it shouldn't.
Definition tmpl.h:1012
fr_type_t cast
Whether there was an explicit cast.
Definition tmpl.h:345
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:340
void tmpl_rules_debug(tmpl_rules_t const *rules)
int tmpl_attr_copy(tmpl_t *dst, tmpl_t const *src)
Copy a list of attribute and request references from one tmpl to another.
fr_pair_list_t * list
List that we tried to evaluate ar in and failed.
Definition tmpl.h:617
ssize_t _tmpl_to_type(void *out, uint8_t *buff, size_t outlen, request_t *request, tmpl_t const *vpt, fr_type_t dst_type))
Expand a tmpl_t to a string writing the result to a buffer.
Definition tmpl_eval.c:282
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.
static fr_dict_attr_t const * tmpl_attr_tail_da(tmpl_t const *vpt)
Return the last attribute reference da.
Definition tmpl.h:806
tmpl_attr_list_presence_t
Specify whether attribute references can have a list (or parent) reference.
Definition tmpl.h:266
@ TMPL_ATTR_LIST_REQUIRE
Attribute refs are required to have a list.
Definition tmpl.h:269
@ TMPL_ATTR_LIST_ALLOW
Attribute refs are allowed to have a list.
Definition tmpl.h:267
@ TMPL_ATTR_LIST_FORBID
Attribute refs are forbidden from having a list.
Definition tmpl.h:268
void tmpl_extents_debug(fr_dlist_head_t *head)
#define ar_is_unresolved(_ar)
Definition tmpl.h:513
static bool tmpl_attr_head_is_list(tmpl_t const *vpt)
Return true if the head attribute reference is a list reference.
Definition tmpl.h:699
enum tmpl_type_e tmpl_type_t
Types of tmpl_t.
size_t tmpl_type_table_len
struct tmpl_literal_rules_s tmpl_literal_rules_t
Definition tmpl.h:241
#define ar_is_normal(_ar)
Definition tmpl.h:510
int tmpl_attr_set_leaf_da(tmpl_t *vpt, fr_dict_attr_t const *da)
Replace the leaf attribute only.
static fr_dict_attr_t const * tmpl_attr_tail_unknown(tmpl_t const *vpt)
Return the last attribute reference unknown da.
Definition tmpl.h:858
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:920
static bool tmpl_attr_tail_is_raw(tmpl_t const *vpt)
Return true if the last attribute reference is "raw".
Definition tmpl.h:779
requests_ref_e
Definition tmpl.h:90
@ REQUEST_OUTER
request_t containing the outer layer of the EAP conversation.
Definition tmpl.h:92
@ REQUEST_PARENT
Parent (whatever it is).
Definition tmpl.h:96
@ REQUEST_UNKNOWN
Unknown request.
Definition tmpl.h:97
@ REQUEST_CURRENT
The current request (default).
Definition tmpl.h:91
fr_slen_t tmpl_request_ref_list_print(fr_sbuff_t *out, FR_DLIST_HEAD(tmpl_request_list) const *rql))
int tmpl_find_or_add_vp(fr_pair_t **out, request_t *request, tmpl_t const *vpt)
Returns the first VP matching a tmpl_t, or if no VPs match, creates a new one.
Definition tmpl_eval.c:909
int tmpl_value_list_insert_tail(fr_value_box_list_t *list, fr_value_box_t *vb, tmpl_t const *vpt)
Insert a value-box to a list, with casting.
Definition tmpl_eval.c:1043
void tmpl_set_dict_def(tmpl_t *vpt, fr_dict_t const *dict)
Change the default dictionary in the tmpl's resolution rules.
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.
int tmpl_copy_pair_children(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, tmpl_t const *vpt))
Copy children of pairs matching a tmpl_t in the current request_t.
Definition tmpl_eval.c:832
fr_dict_attr_t const * enumv
for resolving T_BARE_WORD
Definition tmpl.h:378
size_t _CONST len
Length of the raw string used to create the template.
Definition tmpl.h:557
ssize_t tmpl_cast_from_substr(tmpl_rules_t *t_rules, fr_sbuff_t *in))
Parse a cast specifier.
int pair_append_by_tmpl_parent(TALLOC_CTX *ctx, fr_pair_t **out, fr_pair_list_t *list, tmpl_t const *vpt, bool skip_list))
Allocate and insert a leaf vp from a tmpl_t, building the parent vps if needed.
Definition tmpl_eval.c:965
tmpl_attr_type_t
Definition tmpl.h:381
@ TMPL_ATTR_TYPE_UNSPEC
No attribute was specified as this level only a filter.
Definition tmpl.h:383
@ TMPL_ATTR_TYPE_NORMAL
Normal, resolved, attribute ref.
Definition tmpl.h:382
@ 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:385
@ TMPL_ATTR_TYPE_UNRESOLVED
We have a name, but nothing else to identify the attribute.
Definition tmpl.h:390
#define TMPL_FLAG_XLAT
Base data type is an xlat expansion.
Definition tmpl.h:111
tmpl_attr_t const * ar
Attribute representing the ar after the deepest node that was found in the existing pair tree when ev...
Definition tmpl.h:609
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.
tmpl_attr_filter_type_t
Define entry and head types for attribute reference lists.
Definition tmpl.h:408
@ TMPL_ATTR_FILTER_TYPE_TMPL
Filter is a tmpl.
Definition tmpl.h:412
@ TMPL_ATTR_FILTER_TYPE_INDEX
Filter is an index type.
Definition tmpl.h:410
@ TMPL_ATTR_FILTER_TYPE_CONDITION
Filter is a condition.
Definition tmpl.h:411
@ TMPL_ATTR_FILTER_TYPE_NONE
No filter present.
Definition tmpl.h:409
@ TMPL_ATTR_FILTER_TYPE_EXPR
Filter is an expression.
Definition tmpl.h:413
fr_event_list_t * runtime_el
The eventlist to use for runtime instantiation of xlats.
Definition tmpl.h:329
fr_table_num_ordered_t const tmpl_type_table[]
Map tmpl_type_t values to descriptive strings.
int tmpl_cast_set(tmpl_t *vpt, fr_type_t type)
Set a cast for a tmpl.
fr_token_t _CONST quote
What type of quoting was around the raw string.
Definition tmpl.h:558
void tmpl_attr_debug(tmpl_t const *vpt)
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.
fr_type_t tmpl_expanded_type(tmpl_t const *vpt)
Return the native data type of the expression.
Definition tmpl_eval.c:209
tmpl_attr_filter_type_t _CONST type
Type of filter this is.
Definition tmpl.h:417
size_t tmpl_request_ref_table_len
Describes the current extents of a pair tree in relation to the tree described by a tmpl_t.
Definition tmpl.h:606
Similar to tmpl_rules_t, but used to specify parameters that may change during subsequent resolution ...
Definition tmpl.h:369
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:337
A source or sink of value data.
Definition tmpl.h:552
static char buff[sizeof("18446744073709551615")+3]
Definition size_tests.c:41
fr_aka_sim_id_type_t type
Define entry and head types for tmpl request references.
Definition tmpl.h:277
uint8_t disallow_rhs_resolve
map RHS is NOT immediately resolved in the context of the LHS.
Definition tmpl.h:325
tmpl_attr_list_presence_t list_presence
Whether the attribute reference can have a list, forbid it, or require it.
Definition tmpl.h:303
fr_dict_attr_t const * list_def
Default list to use with unqualified attribute reference.
Definition tmpl.h:300
uint8_t disallow_filters
disallow filters.
Definition tmpl.h:319
uint8_t allow_unresolved
Allow attributes that look valid but were not found in the dictionaries.
Definition tmpl.h:309
uint8_t bare_word_enum
for v3 compatibility.
Definition tmpl.h:323
uint8_t allow_foreign
Allow arguments not found in dict_def.
Definition tmpl.h:317
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:278
FR_DLIST_HEAD(tmpl_request_list) _CONST *request_def
< Point in dictionary tree to resume parsing from.
uint8_t allow_wildcard
Allow the special case of .
Definition tmpl.h:314
uint8_t allow_unknown
Allow unknown attributes i.e.
Definition tmpl.h:306
uint8_t xlat
for %{User-Name}
Definition tmpl.h:321
An element in a list of nested attribute references.
Definition tmpl.h:435
unsigned int _CONST resolve_only
This reference and those before it.
Definition tmpl.h:458
unsigned int _CONST is_raw
Definition tmpl.h:461
fr_dict_attr_t const *_CONST da
Resolved dictionary attribute.
Definition tmpl.h:439
fr_dict_attr_t const *_CONST parent
The parent we used when trying to resolve the attribute originally.
Definition tmpl.h:453
FR_DLIST_ENTRY(tmpl_attr_list) _CONST entry
Entry in the doubly linked list of attribute references.
tmpl_attr_filter_t _CONST filter
Filter associated with the attribute reference.
Definition tmpl.h:465
tmpl_attr_type_t _CONST type
is a raw reference
Definition tmpl.h:463
Define manipulation functions for the attribute reference list.
Definition tmpl.h:476
FR_DLIST_ENTRY(tmpl_request_list) _CONST entry
Entry in the doubly linked list of request references.
tmpl_request_ref_t _CONST request
Definition tmpl.h:480
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
#define fr_table_value_by_str(_table, _name, _def)
Convert a string to a value using a sorted or ordered table.
Definition table.h:653
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
An element in a lexicographically sorted array of name to num mappings.
Definition table.h:49
Escaping rules for tmpls.
Definition tmpl_escape.h:80
enum fr_token fr_token_t
static fr_slen_t head
Definition xlat.h:418
static fr_slen_t parent
Definition pair.h:845
#define fr_type_is_structural(_x)
Definition types.h:371
#define fr_type_is_leaf(_x)
Definition types.h:372
static fr_slen_t data
Definition value.h:1274
static size_t char fr_sbuff_t size_t inlen
Definition value.h:1012
uintptr_t fr_value_box_safe_for_t
Escaping that's been applied to a value box.
Definition value.h:155
int nonnull(2, 5))
static size_t char ** out
Definition value.h:1012