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