The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
dict.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/** Multi-protocol AVP dictionary API
19 *
20 * @file src/lib/util/dict.h
21 *
22 * @copyright 2015 The FreeRADIUS server project
23 */
24
25RCSIDH(dict_h, "$Id: 4d30d529d080308d4aba11c46b282174b3040c8a $")
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#include <freeradius-devel/build.h>
32#include <freeradius-devel/missing.h>
33#include <freeradius-devel/util/dl.h>
34#include <freeradius-devel/util/ext.h>
35#include <freeradius-devel/util/hash.h>
36#include <freeradius-devel/util/rb.h>
37#include <freeradius-devel/util/sbuff.h>
38#include <freeradius-devel/util/table.h>
39#include <freeradius-devel/util/talloc.h>
40#include <freeradius-devel/util/types.h>
41
42#include <stdbool.h>
43#include <stdint.h>
44
45/*
46 * Avoid circular type references.
47 */
49typedef struct fr_dict_s fr_dict_t;
50
52
53/*
54 * Allow public and private versions of the same structures
55 */
56#ifdef _CONST
57# error _CONST can only be defined in the local header
58#endif
59#ifndef _DICT_PRIVATE
60# define _CONST const
61#else
62# define _CONST
63#endif
64
65#ifdef WITH_VERIFY_PTR
66# define DA_VERIFY(_x) fr_dict_attr_verify(__FILE__, __LINE__, _x)
67#else
68# define DA_VERIFY(_x) fr_cond_assert(_x)
69#endif
70
73
74/** Values of the encryption flags
75 */
76typedef struct {
77 unsigned int is_root : 1; //!< Is root of a dictionary.
78
79 unsigned int is_unknown : 1; //!< This dictionary attribute is ephemeral
80 ///< and not part of the main dictionary.
81
82 unsigned int is_raw : 1; //!< This dictionary attribute was constructed
83 ///< from a known attribute to allow the user
84 ///< to assign octets values directly.
85 ///< See .is_unknown to determine if it is
86 ///< ephemeral.
87 unsigned int is_alias : 1; //!< This isn't a real attribute, it's a reference to
88 ///< to one.
89 unsigned int internal : 1; //!< Internal attribute, should not be received
90 ///< in protocol packets, should not be encoded.
91 unsigned int array : 1; //!< Pack multiples into 1 attr.
92
93 unsigned int is_known_width : 1; //!< is treated as if it has a known width for structs
94
95 unsigned int has_value : 1; //!< Has a value.
96
97 unsigned int is_unsigned : 1; //!< hackity hack for dates and time deltas
98
99 unsigned int counter : 1; //!< integer attribute is actually an impulse / counter
100
101 unsigned int name_only : 1; //!< this attribute should always be referred to by name.
102 ///< A number will be allocated, but the allocation scheme
103 ///< will depend on the parent, and definition type, and
104 ///< may not be stable in all instances.
105
106 unsigned int secret : 1; //!< this attribute should be omitted in debug mode
107
108 unsigned int unsafe : 1; //!< e.g. Cleartext-Password
109
110 /*
111 * @todo - if we want to clean these fields up, make
112 * "subtype" and "type_size" both 4-bit bitfields. That
113 * gives us an extra 8 bits for adding new flags, and we
114 * can likely get rid of "extra", in order to save one
115 * more bit.
116 */
117 unsigned int extra : 1; //!< really "subtype is used by dict, not by protocol"
118
119 unsigned int local : 1; //!< is a local variable
120
121 unsigned int has_fixup : 1;
122
123 /*
124 * main: extra is set, then this field is is key, bit, or a uint16 length field.
125 * radius: is one of 9 options for flags
126 * dhcp v4/v6: DNS label, or partial DNS label
127 */
128 uint8_t subtype; //!< protocol-specific values, OR key fields
129
130 /*
131 * Length in bytes for most attributes.
132 * Length in bits for da_is_bit_field(da)
133 */
134 uint8_t length; //!< length of the attribute
135
136 /*
137 * TLVs: 1, 2, or 4.
138 * date / time types: fr_time_res_t, which has 4 possible values.
139 * bit fields: offset in the byte where this bit field ends, which is only
140 * used as a caching mechanism during parsing of the dictionaries.
141 */
142 uint8_t type_size; //!< For TLV2 and root attributes.
144
145#define flag_time_res type_size
146#define flag_byte_offset type_size
147
148/** subtype values for the dictionary when extra=1
149 *
150 */
151enum {
152 FLAG_EXTRA_NONE = 0, //!< no extra meaning, should be invalid
153 FLAG_KEY_FIELD, //!< this is a key field for a subsequent struct
154 FLAG_BIT_FIELD, //!< bit field inside of a struct
155 FLAG_LENGTH_UINT8, //!< string / octets type is prefixed by uint8 of length
156 FLAG_LENGTH_UINT16, //!< string / octets type is prefixed by uint16 of length
157};
158
159#define fr_dict_attr_is_key_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_KEY_FIELD))
160#define da_is_bit_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_BIT_FIELD))
161#define da_is_length_field(_da) ((_da)->flags.extra && (((_da)->flags.subtype == FLAG_LENGTH_UINT8) || ((_da)->flags.subtype == FLAG_LENGTH_UINT16)))
162#define da_length_offset(_da) ((_da)->flags.type_size)
163
164/** Extension identifier
165 *
166 * @note New extension structures should also be added to the to the appropriate table in dict_ext.c
167 */
168typedef enum {
169 FR_DICT_ATTR_EXT_NAME = 0, //!< Name of the attribute.
170 FR_DICT_ATTR_EXT_CHILDREN, //!< Attribute has children.
171 FR_DICT_ATTR_EXT_REF, //!< Attribute references another
172 ///< attribute and/or dictionary.
173 FR_DICT_ATTR_EXT_VENDOR, //!< Cached vendor pointer.
174 FR_DICT_ATTR_EXT_DA_STACK, //!< Cached da stack.
175 FR_DICT_ATTR_EXT_ENUMV, //!< Enumeration values.
176 FR_DICT_ATTR_EXT_NAMESPACE, //!< Attribute has its own namespace.
177 FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC, //!< Protocol specific extensions
180
181/** Dictionary attribute
182 */
184 fr_dict_t _CONST* _CONST dict; //!< Dict attribute belongs to.
185
186 char const *name; //!< Attribute name.
187 size_t name_len; //!< Length of the name.
188
189 unsigned int attr; //!< Attribute number.
190 unsigned int depth; //!< Depth of nesting for this attribute.
191
192 unsigned int last_child_attr; //!< highest value of last child attribute.
193
194 fr_type_t type; //!< Value type.
195
196 fr_dict_attr_t const *parent; //!< Immediate parent of this attribute.
197 fr_dict_attr_t const *next; //!< Next child in bin.
198
200
201 struct {
202 bool attr_set : 1; //!< Attribute number has been set.
203 //!< We need the full range of values 0-UINT32_MAX
204 ///< so we can't use any attr values to indicate
205 ///< "unsetness".
206
207 bool finalised : 1; //!< Attribute definition is complete and modifications
208 ///< that would change the address of the memory chunk
209 ///< of the attribute are no longer permitted.
211
212 char const *filename; //!< Where the attribute was defined.
213 ///< this buffer's lifetime is bound to the
214 ///< fr_dict_t.
215 int line; //!< Line number where the attribute was defined.
216
217 uint8_t ext[FR_DICT_ATTR_EXT_MAX]; //!< Extensions to the dictionary attribute.
218} CC_HINT(aligned(FR_EXT_ALIGNMENT));
219
220/** Extension identifier
221 *
222 * @note New extension structures should also be added to the appropriate table in dict_ext.c
223 */
224typedef enum {
225 FR_DICT_ENUM_EXT_UNION_REF = 0, //!< Reference to a union/subs-struct.
228
229/** Value of an enumerated attribute
230 *
231 * Maps one of more string values to integers and vice versa.
232 */
233typedef struct {
234 char const *name; //!< Enum name.
235 size_t name_len; //!< Allows for efficient name lookups when operating
236 ///< on partial buffers.
237 fr_value_box_t const *value; //!< Enum value (what name maps to).
238
239 uint8_t ext[FR_DICT_ENUM_EXT_MAX]; //!< Extensions to the dictionary attribute.
240
241 fr_dict_attr_t const *child_struct[]; //!< for key fields
242} fr_dict_enum_value_t CC_HINT(aligned(FR_EXT_ALIGNMENT));
243
244/** Private enterprise
245 *
246 * Represents an IANA private enterprise allocation.
247 *
248 * The width of the private enterprise number must be the same for all protocols
249 * so we can represent a vendor with a single struct.
250 */
251typedef struct {
252 uint32_t pen; //!< Private enterprise number.
253 bool continuation; //!< we only have one flag for now, for WiMAX
254 size_t type; //!< Length of type data
255 size_t length; //!< Length of length data
256 char const *name; //!< Vendor name.
258
259/** Specifies a value which must be present for the module to function
260 *
261 */
262typedef struct {
263 fr_value_box_t const **out; //!< Enumeration value.
264 fr_dict_attr_t const **attr; //!< The protocol dictionary the attribute should
265 ///< be resolved in. ** so it's a compile time
266 ///< constant.
267 char const *name; //!< of the attribute.
269
270/** Specifies an attribute which must be present for the module to function
271 *
272 */
273typedef struct {
274 fr_dict_attr_t const **out; //!< Where to write a pointer to the resolved
275 //!< #fr_dict_attr_t.
276 fr_dict_t const **dict; //!< The protocol dictionary the attribute should
277 ///< be resolved in. ** so it's a compile time
278 ///< constant.
279 char const *name; //!< of the attribute.
280 fr_type_t type; //!< of the attribute. Mismatch is a fatal error.
282
283/** Specifies a dictionary which must be loaded/loadable for the module to function
284 *
285 */
286typedef struct {
287 fr_dict_t const **out; //!< Where to write a pointer to the loaded/resolved
288 //!< #fr_dict_t.
289 char const *base_dir; //!< Directory structure beneath share.
290 char const *proto; //!< The protocol dictionary name.
292
293/** Errors returned by attribute lookup functions
294 *
295 */
296typedef enum {
297 FR_DICT_ATTR_OK = 0, //!< No error.
298 FR_DICT_ATTR_NOTFOUND = -1, //!< Attribute couldn't be found.
299 FR_DICT_ATTR_PROTOCOL_NOTFOUND = -2, //!< Protocol couldn't be found.
300 FR_DICT_ATTR_PARSE_ERROR = -3, //!< Attribute string couldn't be parsed
301 FR_DICT_ATTR_INTERNAL_ERROR = -4, //!< Internal error occurred.
302 FR_DICT_ATTR_OOM = -5, //!< Memory allocation error.
303 FR_DICT_ATTR_NOT_DESCENDENT = -6, //!< Attribute is not a descendent of the parent
304 ///< attribute.
305 FR_DICT_ATTR_NOT_ANCESTOR = -7, //!< Attribute is not an ancestor of the child
306 ///< attribute.
307 FR_DICT_ATTR_NO_CHILDREN = -8, //!< Child lookup in attribute with no children.
308 FR_DICT_ATTR_EINVAL = -9 //!< Invalid arguments.
309
311
314
315/*
316 * Forward declarations to avoid circular references.
317 */
319typedef struct fr_dbuff_s fr_dbuff_t;
320
321/** A generic interface for decoding packets to fr_pair_ts
322 *
323 * A decoding function should decode a single top level packet from wire format.
324 *
325 * Note that unlike #fr_tp_proto_decode_t, this function is NOT passed an encode_ctx. That is because when we
326 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
327 *
328 * @param[in] ctx to allocate new pairs in.
329 * @param[in] vps where new VPs will be added
330 * @param[in] data to decode.
331 * @param[in] data_len The length of the incoming data.
332 * @return
333 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
334 * - > 0 on success. How many bytes were decoded.
335 */
336typedef ssize_t (*fr_dict_attr_decode_func_t)(TALLOC_CTX *ctx, fr_pair_list_t *vps,
337 uint8_t const *data, size_t data_len);
338
339/** A generic interface for encoding fr_pair_ts to packets
340 *
341 * An encoding function should encode multiple VPs to a wire format packet
342 *
343 * Note that unlike #fr_tp_proto_encode_t, this function is NOT passed an encode_ctx. That is because when we
344 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
345 *
346 * @param[in] vps vps to encode
347 * @param[in] dbuff buffer where data can be written
348 * @return
349 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
350 * - > 0 on success. How many bytes were encoded
351 */
353
354/** Init / free callbacks
355 *
356 * Only for "autoref" usage.
357 */
358typedef int (*fr_dict_protocol_init_t)(void);
359typedef void (*fr_dict_protocol_free_t)(void);
360
362
363/** Custom protocol-specific flag parsing function
364 *
365 * @note This function should be used to implement table based flag parsing.
366 *
367 * @param[in] da_p we're currently populating
368 * @param[in] value flag value to parse.
369 * @param[in] rule How to parse the flag.
370 */
372
374 fr_dict_flag_parse_func_t func; //!< Custom parsing function to convert a flag value string to a C type value.
375 void *uctx; //!< Use context to pass to the custom parsing function.
376 bool needs_value; //!< This parsing flag must have a value. Else we error.
377};
378
379/** Copy custom flags from one attribute to another
380 *
381 * @param[out] da_to attribute to copy to. Use for the talloc_ctx for any heap allocated flag values.
382 * @param[out] flags_to protocol specific flags struct to copy to.
383 * @param[in] flags_from protocol specific flags struct to copy from.
384 * @return
385 * - 0 on success.
386 * - -1 on error.
387 */
388typedef int (*fr_dict_flags_copy_func_t)(fr_dict_attr_t *da_to, void *flags_to, void *flags_from);
389
390/** Compare the protocol specific flags struct from two attributes
391 *
392 * @param[in] da_a first attribute to compare.
393 * @param[in] da_b second attribute to compare.
394 * @return
395 * - 0 if the flags are equal.
396 * - < 0 if da_a < da_b.
397 * - > 0 if da_a > da_b.
398 */
399 typedef int (*fr_dict_flags_cmp_func_t)(fr_dict_attr_t const *da_a, fr_dict_attr_t const *da_b);
400
401/** Protocol specific custom flag definitnion
402 *
403 */
404typedef struct {
405 fr_table_elem_name_t name; //!< Name of the flag
406 fr_dict_flag_parser_rule_t value; //!< Function and context to parse the flag.
408
409/** Define a flag setting function, which sets one bit in a fr_dict_attr_flags_t
410 *
411 * This is here, because AFAIK there's no completely portable way to get the bit
412 * offset of a bit field in a structure.
413 */
414#define FR_DICT_ATTR_FLAG_FUNC(_struct, _name) \
415static int dict_flag_##_name(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)\
416{ \
417 _struct *flags = fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC); \
418 flags->_name = 1; \
419 return 0; \
420}
421
422/** conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
423 *
424 * @param[in] _struct containing the field to write the result to.
425 * @param[in] _field to write the flag to
426 */
427# define FR_DICT_PROTOCOL_FLAG(_struct, _field) \
428 .type = FR_CTYPE_TO_TYPE((((_struct *)NULL)->_field)), \
429 .offset = offsetof(_struct, _field)
430
431/** Protocol-specific callbacks in libfreeradius-PROTOCOL
432 *
433 */
434typedef struct {
435 char const *name; //!< name of this protocol
436
437 int default_type_size; //!< how many octets are in "type" field
438 int default_type_length; //!< how many octets are in "length" field
439
440 struct {
441 /** Custom flags for this protocol
442 */
443 struct {
444 fr_dict_flag_parser_t const *table; //!< Flags for this protocol, an array of fr_dict_flag_parser_t
445 size_t table_len; //!< Length of protocol_flags table.
446
447 size_t len; //!< Length of the protocol specific flags structure.
448 ///< This is used to allocate a FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
449 ///< extension of the specified length.
450
451 fr_dict_flags_copy_func_t copy; //!< Copy protocol-specific flags from one attribute to another.
452 ///< Called when copying attributes.
453
454 fr_dict_flags_cmp_func_t cmp; //!< Compare protocol-specific flags from two attributes.
455 ///< Called when comparing attributes by their fields.
456 } flags;
457
458 fr_dict_attr_type_parse_t type_parse; //!< parse unknown type names
459 fr_dict_attr_valid_func_t valid; //!< Validation function to ensure that
460 ///< new attributes are valid.
461 } attr;
462
463 fr_dict_protocol_init_t init; //!< initialize the library
464 fr_dict_protocol_free_t free; //!< free the library
465
466 fr_dict_attr_decode_func_t decode; //!< for decoding attributes. Used for implementing foreign
467 ///< protocol attributes.
468 fr_dict_attr_encode_func_t encode; //!< for encoding attributes. Used for implementing foreign
469 ///< protocol attributes.
471
473
474/*
475 * Dictionary constants
476 */
477#define FR_DICT_PROTO_MAX_NAME_LEN (128) //!< Maximum length of a protocol name.
478#define FR_DICT_ENUM_MAX_NAME_LEN (128) //!< Maximum length of a enum value.
479#define FR_DICT_VENDOR_MAX_NAME_LEN (128) //!< Maximum length of a vendor name.
480#define FR_DICT_ATTR_MAX_NAME_LEN (128) //!< Maximum length of a attribute name.
481
482/** Maximum level of TLV nesting allowed
483 */
484#define FR_DICT_TLV_NEST_MAX (24)
485
486/** Maximum level of da stack caching
487 */
488#define FR_DICT_DA_STACK_CACHE_MAX (5)
489
490/** Maximum TLV stack size
491 *
492 * The additional attributes are to account for
493 *
494 * Root + Vendor + NULL (top frame).
495 * Root + Embedded protocol + Root + Vendor + NULL.
496 *
497 * Code should ensure that it doesn't run off the end of the stack,
498 * as this could be remotely exploitable, using odd nesting.
499 */
500#define FR_DICT_MAX_TLV_STACK (FR_DICT_TLV_NEST_MAX + 5)
501
502/** Characters that are allowed in dictionary attribute names
503 *
504 */
505extern bool const fr_dict_attr_allowed_chars[UINT8_MAX + 1];
506
507/** Characters that are allowed in dictionary enumeration value names
508 *
509 */
510extern bool const fr_dict_enum_allowed_chars[UINT8_MAX + 1];
511
512/** @name Dictionary structure extensions
513 *
514 * @{
515 */
516#include <freeradius-devel/util/dict_ext.h>
517/** @} */
518
519/** @name Programmatically create dictionary attributes and values
520 *
521 * @{
522 */
524
525int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr,
526 fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
527
529 char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
530
531int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name,
532 fr_value_box_t const *value, bool coerce, bool replace);
533
534int fr_dict_enum_add_name_next(fr_dict_attr_t *da, char const *name) CC_HINT(nonnull);
535
536int fr_dict_str_to_argv(char *str, char **argv, int max_argc);
537
538int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src) CC_HINT(nonnull);
539
541/** @} */
542
543/** @name Dict accessors
544 *
545 * @{
546 */
548/** @} */
549
550/** @name Unknown ephemeral attributes
551 *
552 * @{
553 */
555
557
558fr_dict_attr_t *fr_dict_attr_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da) CC_HINT(nonnull(2));
559
560static inline fr_dict_attr_t *fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
561{
562 fr_assert(da->flags.is_unknown);
563
564 return fr_dict_attr_unknown_afrom_da(ctx, da);
565}
566
568 fr_dict_attr_t const *parent,
569 unsigned int num, fr_type_t type, bool raw)
570 CC_HINT(nonnull(2));
571
572static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_typed_afrom_num(TALLOC_CTX *ctx,
573 fr_dict_attr_t const *parent,
574 unsigned int num, fr_type_t type)
575{
576 return fr_dict_attr_unknown_typed_afrom_num_raw(ctx, parent, num, type, false);
577}
578
579
580static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_vendor_afrom_num(TALLOC_CTX *ctx,
581 fr_dict_attr_t const *parent,
582 unsigned int vendor)
583{
585}
586
587static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_raw_afrom_num(TALLOC_CTX *ctx,
588 fr_dict_attr_t const *parent,
589 unsigned int attr)
590{
592}
593
595 CC_HINT(nonnull(2));
596
597
599 fr_dict_attr_t const **out,
600 fr_dict_attr_t const *parent,
602 CC_HINT(nonnull(2,3,4));
603
605
607/** @} */
608
609/** @name Attribute comparisons
610 *
611 * @{
612 */
613static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
614{
615 int8_t ret;
616
617 /*
618 * Comparing unknowns or raws is expensive
619 * because we need to check the lineage.
620 */
621 if (a->flags.is_unknown | a->flags.is_raw | b->flags.is_unknown | b->flags.is_raw) {
622 ret = CMP(a->depth, b->depth);
623 if (ret != 0) return ret;
624
625 ret = CMP(a->attr, b->attr);
626 if (ret != 0) return ret;
627
628 ret = (a->parent == NULL) - (b->parent == NULL);
629 if ((ret != 0) || !a->parent) return ret;
630
631 return fr_dict_attr_cmp(a->parent, b->parent);
632 }
633
634 /*
635 * Comparing knowns is cheap because the
636 * DAs are unique.
637 */
638 return CMP(a, b);
639}
640
641/** Compare two dictionary attributes by their contents
642 *
643 * @param[in] a First attribute to compare.
644 * @param[in] b Second attribute to compare.
645 * @return
646 * - 0 if the attributes are equal.
647 * - -1 if a < b.
648 * - +1 if a > b.
649 */
650static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp_fields(const fr_dict_attr_t *a, const fr_dict_attr_t *b)
651{
652 int8_t ret;
653 fr_dict_protocol_t const *a_proto = fr_dict_protocol(a->dict);
654
655 /*
656 * Technically this isn't a property of the attribute
657 * but we need them to be the same to be able to
658 * compare protocol specific flags successfully.
659 */
660 ret = CMP(a_proto, fr_dict_protocol(b->dict));
661 if (ret != 0) return ret;
662
663 ret = CMP(a->attr, b->attr);
664 if (ret != 0) return ret;
665
666 ret = CMP(a->parent, b->parent);
667 if (ret != 0) return ret;
668
670 if (ret != 0) return ret;
671
672 /*
673 * Compare protocol specific flags
674 */
675 if (a_proto->attr.flags.cmp && (ret = a_proto->attr.flags.cmp(a, b))) return ret;
676
677 return CMP(memcmp(&a->flags, &b->flags, sizeof(a->flags)), 0);
678}
679/** @} */
680
681/** @name Debugging functions
682 *
683 * @{
684 */
685void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da);
686
687void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da);
688
689void fr_dict_debug(FILE *fp, fr_dict_t const *dict);
690
691void fr_dict_export(FILE *fp, fr_dict_t const *dict);
692
693void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent);
694/** @} */
695
696/** @name Attribute lineage
697 *
698 * @{
699 */
700fr_dict_attr_t const *fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor);
701
702int fr_dict_oid_component_legacy(unsigned int *out, char const **oid);
703
705 fr_type_t type, fr_dict_attr_flags_t const *flags);
706
708 fr_dict_attr_t const *ancestor, fr_dict_attr_t const *da, bool numeric);
709#define FR_DICT_ATTR_OID_PRINT_RETURN(...) FR_SBUFF_RETURN(fr_dict_attr_oid_print, ##__VA_ARGS__)
710
712 unsigned int *attr, char const *oid) CC_HINT(nonnull);
713
715 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
716 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
717 CC_HINT(nonnull(2,3,4));
718
720 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
721 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
722 CC_HINT(nonnull(2,3,4));
723
725 fr_dict_attr_t const *parent, char const *oid)
726 CC_HINT(nonnull(2,3));
727
728bool fr_dict_attr_can_contain(fr_dict_attr_t const *parent, fr_dict_attr_t const *child) CC_HINT(nonnull);
729
730/** @} */
731
732/** @name Attribute, vendor and dictionary lookup
733 *
734 * @{
735 */
736
737/** @hidecallergraph */
738fr_dict_attr_t const *fr_dict_root(fr_dict_t const *dict) CC_HINT(nonnull);
739
740bool fr_dict_is_read_only(fr_dict_t const *dict);
741
742dl_t *fr_dict_dl(fr_dict_t const *dict);
743
745 fr_dict_t const **out, fr_sbuff_t *name, fr_dict_t const *dict_def);
746
747fr_dict_t const *fr_dict_by_protocol_name(char const *name);
748
749fr_dict_t const *fr_dict_by_protocol_num(unsigned int num);
750
751fr_dict_attr_t const *fr_dict_unlocal(fr_dict_attr_t const *da) CC_HINT(nonnull);
752
753fr_dict_t const *fr_dict_proto_dict(fr_dict_t const *dict) CC_HINT(nonnull);
754
755fr_dict_t const *fr_dict_by_da(fr_dict_attr_t const *da) CC_HINT(nonnull);
756
757fr_dict_t const *fr_dict_by_attr_name(fr_dict_attr_t const **found, char const *name);
758
759bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2) CC_HINT(nonnull);
760
761/** Return true if this attribute is parented directly off the dictionary root
762 *
763 * @param[in] da to check.
764 * @return
765 * - true if attribute is top level.
766 * - false if attribute is not top level.
767 */
768static inline bool fr_dict_attr_is_top_level(fr_dict_attr_t const *da)
769{
770 if (unlikely(!da) || unlikely(!da->parent)) return false;
771 return da->parent->flags.is_root;
772}
773
775
776fr_dict_vendor_t const *fr_dict_vendor_by_name(fr_dict_t const *dict, char const *name);
777
778fr_dict_vendor_t const *fr_dict_vendor_by_num(fr_dict_t const *dict, uint32_t vendor_pen);
779
780fr_dict_attr_t const *fr_dict_vendor_da_by_num(fr_dict_attr_t const *vendor_root, uint32_t vendor_pen);
781
783 fr_dict_t const *dict_def,
784 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
785 bool internal, bool foreign)
786 CC_HINT(nonnull(2, 4));
787
789 fr_dict_t const *dict_def,
790 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
791 bool internal, bool foreign)
792 CC_HINT(nonnull(2, 4));
793
795 fr_dict_t const *dict_def,
796 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
797 bool internal, bool foreign)
798 CC_HINT(nonnull(2, 4));
799
801 fr_dict_t const *dict_def, char const *attr,
802 bool internal, bool foreign)
803 CC_HINT(nonnull(3));
804
806 fr_dict_t const *dict_def,
807 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
808 bool internal, bool foreign)
809 CC_HINT(nonnull(2, 4));
810
812 fr_dict_attr_t const *parent,
813 fr_sbuff_t *name, fr_sbuff_term_t const *tt)
814 CC_HINT(nonnull(2,3,4));
815
817 char const *attr)
818 CC_HINT(nonnull(2,3));
819
820fr_dict_attr_t const *fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr);
821
822typedef fr_hash_iter_t fr_dict_enum_iter_t; /* Alias this in case we want to change it in future */
823
825
827
829
831
832fr_dict_enum_value_t const *fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len);
833
835
837 fr_sbuff_t *in, fr_sbuff_term_t const *tt);
838
840 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
842/** @} */
843
844/** @name Dictionary and protocol loading
845 *
846 * @{
847 */
848int fr_dict_internal_afrom_file(fr_dict_t **out, char const *internal_name,
849 char const *dependent);
850
851int fr_dict_protocol_afrom_file(fr_dict_t **out, char const *proto_name, char const *proto_dir,
852 char const *dependent);
853
855
856int fr_dict_read(fr_dict_t *dict, char const *dict_dir, char const *filename);
857/** @} */
858
859/** @name Autoloader interface
860 *
861 * @{
862 */
864
866
867#define fr_dict_autoload(_to_load) _fr_dict_autoload(_to_load, __FILE__)
868int _fr_dict_autoload(fr_dict_autoload_t const *to_load, char const *dependent);
869
870#define fr_dict_autofree(_to_free) _fr_dict_autofree(_to_free, __FILE__)
871int _fr_dict_autofree(fr_dict_autoload_t const *to_free, char const *dependent);
872
873#define fr_dict_autoload_talloc(_ctx, _dict_out, _proto) _fr_dict_autoload_talloc(_ctx, _dict_out, _proto, __FILE__)
874fr_dict_autoload_talloc_t *_fr_dict_autoload_talloc(TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent);
875
876int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx);
877
878int fr_dl_dict_attr_autoload(dl_t const *module, void *symbol, void *user_ctx);
879
880int fr_dl_dict_autoload(dl_t const *module, void *symbol, void *user_ctx);
881
882void fr_dl_dict_autofree(dl_t const *module, void *symbol, void *user_ctx);
883/** @} */
884
885/** @name Allocating and freeing
886 *
887 * @{
888 */
889fr_dict_t *fr_dict_alloc(char const *proto_name, unsigned int proto_number) CC_HINT(nonnull);
890
891int fr_dict_dependent_add(fr_dict_t const *dict, char const *dependent) CC_HINT(nonnull);
892
893int fr_dict_free(fr_dict_t **dict, char const *dependent) CC_HINT(nonnull);
894
895int fr_dict_const_free(fr_dict_t const **dict, char const *dependent) CC_HINT(nonnull);
896/** @} */
897
898/** @name Global dictionary management
899 *
900 * @{
901 */
902fr_dict_gctx_t *fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir);
903
904void fr_dict_global_ctx_perm_check(fr_dict_gctx_t *gctx, bool enable);
905
906void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx);
907
909
910int fr_dict_global_ctx_dir_set(char const *dict_dir);
911
913
915
916char const *fr_dict_global_ctx_dir(void);
917
919
921
923
925
927
928fr_dict_t const *fr_dict_internal(void);
929
930/** @} */
931
932/** @name Dictionary testing and validation
933 *
934 * @{
935 */
937
938int fr_dict_parse_str(fr_dict_t *dict, char *buf,
939 fr_dict_attr_t const *parent);
940
941ssize_t fr_dict_valid_name(char const *name, ssize_t len);
942
943ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len);
944
946
947typedef int (*fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx);
948
949int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx);
950
951void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da);
952/** @} */
953
954#undef _CONST
955
956#ifdef __cplusplus
957}
958#endif
int const char * file
Definition acutest.h:702
int const char int line
Definition acutest.h:702
#define RCSIDH(h, id)
Definition build.h:486
#define CMP(_a, _b)
Same as CMP_PREFER_SMALLER use when you don't really care about ordering, you just want an ordering.
Definition build.h:112
#define unlikely(_x)
Definition build.h:383
#define UNUSED
Definition build.h:317
static int type_parse(TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
fr_table_elem_name_t name
Name of the flag.
Definition dict.h:405
fr_dict_t * fr_dict_global_ctx_iter_next(fr_dict_global_ctx_iter_t *iter)
Definition dict_util.c:4618
bool continuation
we only have one flag for now, for WiMAX
Definition dict.h:253
size_t type
Length of type data.
Definition dict.h:254
fr_dict_t const * fr_dict_by_attr_name(fr_dict_attr_t const **found, char const *name)
void fr_dict_global_ctx_debug(fr_dict_gctx_t const *gctx)
Dump information about currently loaded dictionaries.
Definition dict_util.c:4574
fr_dict_protocol_free_t free
free the library
Definition dict.h:464
void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:230
fr_dict_gctx_t * fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir)
Initialise the global protocol hashes.
Definition dict_util.c:4436
size_t name_len
Allows for efficient name lookups when operating on partial buffers.
Definition dict.h:235
fr_dict_attr_flags_t flags
Flags.
Definition dict.h:199
fr_dict_attr_decode_func_t decode
for decoding attributes.
Definition dict.h:466
int(* fr_dict_flag_parse_func_t)(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Custom protocol-specific flag parsing function.
Definition dict.h:371
fr_slen_t fr_dict_attr_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *name, fr_sbuff_term_t const *tt))
int fr_dict_attr_add_initialised(fr_dict_attr_t *da)
A variant of fr_dict_attr_t that allows a pre-allocated, populated fr_dict_attr_t to be added.
Definition dict_util.c:1593
char const * name
of the attribute.
Definition dict.h:279
int fr_dict_internal_afrom_file(fr_dict_t **out, char const *internal_name, char const *dependent)
(Re-)Initialize the special internal dictionary
unsigned int name_only
this attribute should always be referred to by name.
Definition dict.h:101
ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len)
Definition dict_util.c:4707
int fr_dict_global_ctx_dir_set(char const *dict_dir)
Allow the default dict dir to be changed after initialisation.
Definition dict_util.c:4527
fr_slen_t fr_dict_enum_name_from_substr(fr_sbuff_t *out, fr_sbuff_parse_error_t *err, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
Extract an enumeration name from a string.
Definition dict_util.c:3559
int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name, fr_value_box_t const *value, bool coerce, bool replace)
Add a value name.
Definition dict_util.c:1944
fr_dict_attr_t const * fr_dict_attr_search_by_qualified_oid(fr_dict_attr_err_t *err, fr_dict_t const *dict_def, char const *attr, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
Definition dict_util.c:3084
fr_dict_attr_t const * fr_dict_attr_unknown_resolve(fr_dict_t const *dict, fr_dict_attr_t const *da)
Check to see if we can convert a nested TLV structure to known attributes.
unsigned int has_value
Has a value.
Definition dict.h:95
fr_dict_enum_ext_t
Extension identifier.
Definition dict.h:224
@ FR_DICT_ENUM_EXT_MAX
Definition dict.h:226
@ FR_DICT_ENUM_EXT_UNION_REF
Reference to a union/subs-struct.
Definition dict.h:225
fr_slen_t fr_dict_attr_oid_print(fr_sbuff_t *out, fr_dict_attr_t const *ancestor, fr_dict_attr_t const *da, bool numeric)
Build the da_stack for the specified DA and encode the path by name in OID form.
int fr_dict_attr_add_name_only(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags))
Add an attribute to the dictionary.
Definition dict_util.c:1741
char const * name
Vendor name.
Definition dict.h:256
char const * filename
Where the attribute was defined.
Definition dict.h:212
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4629
void * uctx
Use context to pass to the custom parsing function.
Definition dict.h:375
fr_dict_attr_t const ** attr
The protocol dictionary the attribute should be resolved in.
Definition dict.h:264
fr_dict_t const * fr_dict_by_da(fr_dict_attr_t const *da)
Attempt to locate the protocol dictionary containing an attribute.
Definition dict_util.c:2609
unsigned int is_root
Is root of a dictionary.
Definition dict.h:77
int fr_dict_enum_autoload(fr_dict_enum_autoload_t const *to_load)
Process a dict_attr_autoload element to load/verify a dictionary attribute.
Definition dict_util.c:4095
fr_dict_enum_value_t const * fr_dict_enum_iter_init(fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
Iterate over all enumeration values for an attribute.
Definition dict_util.c:3352
int _fr_dict_autofree(fr_dict_autoload_t const *to_free, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4216
int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
Definition dict_util.c:4821
fr_dict_attr_t const * fr_dict_unlocal(fr_dict_attr_t const *da)
Definition dict_util.c:5000
fr_dict_attr_t const * fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor)
Find a common ancestor that two TLV type attributes share.
Definition dict_util.c:2040
size_t name_len
Length of the name.
Definition dict.h:187
int line
Line number where the attribute was defined.
Definition dict.h:215
bool(* fr_dict_attr_valid_func_t)(fr_dict_attr_t *da)
Definition dict.h:312
int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx)
static fr_slen_t err
Definition dict.h:841
fr_dict_t * fr_dict_alloc(char const *proto_name, unsigned int proto_number)
fr_dict_t const * fr_dict_proto_dict(fr_dict_t const *dict)
Definition dict_util.c:5016
unsigned int has_fixup
Definition dict.h:121
static fr_dict_attr_t * fr_dict_attr_unknown_vendor_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int vendor)
Definition dict.h:580
void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent)
Definition dict_print.c:312
bool const fr_dict_attr_allowed_chars[UINT8_MAX+1]
Characters that are allowed in dictionary attribute names.
Definition dict_util.c:47
static fr_dict_attr_t * fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Definition dict.h:560
int fr_dict_attr_set_group(fr_dict_attr_t **da_p)
Definition dict_util.c:5023
fr_dict_protocol_t const * fr_dict_protocol(fr_dict_t const *dict)
Return the protocol descriptor for the dictionary.
Definition dict_util.c:4992
ssize_t(* fr_dict_attr_encode_func_t)(fr_dbuff_t *dbuff, fr_pair_list_t const *vps)
A generic interface for encoding fr_pair_ts to packets.
Definition dict.h:352
fr_dict_attr_t const * fr_dict_attr_unknown_add(fr_dict_t *dict, fr_dict_attr_t const *old)
Converts an unknown to a known by adding it to the internal dictionaries.
int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src)
Definition dict_util.c:1072
fr_dict_attr_t const * fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *attr))
Locate a fr_dict_attr_t by its name.
Definition dict_util.c:3266
fr_dict_autoload_talloc_t * _fr_dict_autoload_talloc(TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent)
Autoload a dictionary and bind the lifetime to a talloc chunk.
Definition dict_util.c:4267
bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2)
See if two dictionaries have the same end parent.
Definition dict_util.c:2622
int(* fr_dict_flags_cmp_func_t)(fr_dict_attr_t const *da_a, fr_dict_attr_t const *da_b)
Compare the protocol specific flags struct from two attributes.
Definition dict.h:399
void fr_dict_debug(FILE *fp, fr_dict_t const *dict)
Definition dict_print.c:266
fr_value_box_t const ** out
Enumeration value.
Definition dict.h:263
fr_dict_attr_t * fr_dict_attr_unconst(fr_dict_attr_t const *da)
Coerce to non-const.
Definition dict_util.c:4641
fr_dict_attr_t * fr_dict_attr_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da))
Copy a known or unknown attribute to produce an unknown attribute with the specified name.
fr_dict_t const ** dict
The protocol dictionary the attribute should be resolved in.
Definition dict.h:276
fr_slen_t fr_dict_attr_by_oid_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt))
Resolve an attribute using an OID string.
Definition dict_util.c:2327
static fr_dict_attr_t * fr_dict_attr_unknown_raw_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int attr)
Definition dict.h:587
void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da)
Definition dict_util.c:4827
int fr_dict_protocol_afrom_file(fr_dict_t **out, char const *proto_name, char const *proto_dir, char const *dependent)
(Re)-initialize a protocol dictionary
int fr_dict_str_to_argv(char *str, char **argv, int max_argc)
bool fr_dict_attr_can_contain(fr_dict_attr_t const *parent, fr_dict_attr_t const *child)
See if a structural da is allowed to contain another da.
Definition dict_util.c:4919
struct dict_attr_s::@126 state
fr_slen_t fr_dict_attr_flags_print(fr_sbuff_t *out, fr_dict_t const *dict, fr_type_t type, fr_dict_attr_flags_t const *flags)
fr_dict_t * fr_dict_global_ctx_iter_init(fr_dict_global_ctx_iter_t *iter)
Iterate protocols by name.
Definition dict_util.c:4611
int(* fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx)
Definition dict.h:947
unsigned int array
Pack multiples into 1 attr.
Definition dict.h:91
unsigned int secret
this attribute should be omitted in debug mode
Definition dict.h:106
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2403
fr_dict_flag_parse_func_t func
Custom parsing function to convert a flag value string to a C type value.
Definition dict.h:374
fr_dict_attr_t const * fr_dict_vendor_da_by_num(fr_dict_attr_t const *vendor_root, uint32_t vendor_pen)
Return vendor attribute for the specified dictionary and pen.
Definition dict_util.c:2698
unsigned int extra
really "subtype is used by dict, not by protocol"
Definition dict.h:117
unsigned int internal
Internal attribute, should not be received in protocol packets, should not be encoded.
Definition dict.h:89
fr_dict_attr_t const ** out
Where to write a pointer to the resolved fr_dict_attr_t.
Definition dict.h:274
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:287
void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx)
Set a new, active, global dictionary context.
Definition dict_util.c:4497
fr_dict_attr_t const * next
Next child in bin.
Definition dict.h:197
fr_dict_t _CONST *_CONST dict
Dict attribute belongs to.
Definition dict.h:184
fr_dict_attr_t * fr_dict_attr_unknown_raw_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da))
Initialise an octets type attribute from a da.
fr_slen_t fr_dict_attr_search_by_oid_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by a dictionary using a non-qualified OID string.
Definition dict_util.c:3065
char const * name
Attribute name.
Definition dict.h:186
unsigned int unsafe
e.g. Cleartext-Password
Definition dict.h:108
fr_dict_protocol_init_t init
initialize the library
Definition dict.h:463
unsigned int is_raw
This dictionary attribute was constructed from a known attribute to allow the user to assign octets v...
Definition dict.h:82
fr_slen_t fr_dict_attr_by_oid_legacy(fr_dict_t const *dict, fr_dict_attr_t const **parent, unsigned int *attr, char const *oid)
Get the leaf attribute of an OID string.
Definition dict_util.c:2128
bool const fr_dict_enum_allowed_chars[UINT8_MAX+1]
Characters that are allowed in dictionary enumeration value names.
Definition dict_util.c:68
int fr_dict_attr_unknown_parent_to_known(fr_dict_attr_t *da, fr_dict_attr_t const *parent)
Fixup the parent of an unknown attribute using an equivalent known attribute.
char const * name
of the attribute.
Definition dict.h:267
dl_t * fr_dict_dl(fr_dict_t const *dict)
Definition dict_util.c:2413
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:237
void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:254
@ FLAG_EXTRA_NONE
no extra meaning, should be invalid
Definition dict.h:152
@ FLAG_LENGTH_UINT8
string / octets type is prefixed by uint8 of length
Definition dict.h:155
@ FLAG_LENGTH_UINT16
string / octets type is prefixed by uint16 of length
Definition dict.h:156
@ FLAG_KEY_FIELD
this is a key field for a subsequent struct
Definition dict.h:153
@ FLAG_BIT_FIELD
bit field inside of a struct
Definition dict.h:154
unsigned int attr
Attribute number.
Definition dict.h:189
struct fr_dict_protocol_t::@127 attr
char const * fr_dict_enum_name_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
Lookup the name of an enum value in a fr_dict_attr_t.
Definition dict_util.c:3426
fr_dict_enum_value_t const * fr_dict_enum_iter_next(fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
Definition dict_util.c:3373
int fr_dict_enum_add_name_next(fr_dict_attr_t *da, char const *name)
Add an name to an integer attribute hashing the name for the integer value.
Definition dict_util.c:1956
uint8_t ext[FR_DICT_ATTR_EXT_MAX]
Extensions to the dictionary attribute.
Definition dict.h:217
int(* fr_dict_flags_copy_func_t)(fr_dict_attr_t *da_to, void *flags_to, void *flags_from)
Copy custom flags from one attribute to another.
Definition dict.h:388
int default_type_size
how many octets are in "type" field
Definition dict.h:437
uint32_t pen
Private enterprise number.
Definition dict.h:252
int fr_dict_free(fr_dict_t **dict, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4068
void fr_dict_attr_unknown_free(fr_dict_attr_t const **da)
Free dynamically allocated (unknown attributes)
fr_dict_enum_value_t const * fr_dict_enum_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
Lookup the structure representing an enum value in a fr_dict_attr_t.
Definition dict_util.c:3393
fr_type_t type
of the attribute. Mismatch is a fatal error.
Definition dict.h:280
fr_dict_flag_parser_rule_t value
Function and context to parse the flag.
Definition dict.h:406
#define _CONST
Definition dict.h:60
int fr_dict_oid_component_legacy(unsigned int *out, char const **oid)
Process a single OID component.
Definition dict_util.c:2083
fr_slen_t fr_dict_enum_by_name_substr(fr_dict_enum_value_t **out, fr_dict_attr_t const *da, fr_sbuff_t *in)
Definition dict_util.c:3465
void fr_dict_global_ctx_perm_check(fr_dict_gctx_t *gctx, bool enable)
Set whether we check dictionary file permissions.
Definition dict_util.c:4488
void fr_dict_global_ctx_read_only(void)
Mark all dictionaries and the global dictionary ctx as read only.
Definition dict_util.c:4547
uint8_t type_size
For TLV2 and root attributes.
Definition dict.h:142
unsigned int depth
Depth of nesting for this attribute.
Definition dict.h:190
int fr_dict_const_free(fr_dict_t const **dict, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4052
int fr_dict_attr_autoload(fr_dict_attr_autoload_t const *to_load)
Process a dict_attr_autoload element to load/verify a dictionary attribute.
Definition dict_util.c:4134
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4654
bool(* fr_dict_attr_type_parse_t)(fr_type_t *type, fr_dict_attr_t **da_p, char const *name)
Definition dict.h:313
fr_slen_t fr_dict_by_protocol_substr(fr_dict_attr_err_t *err, fr_dict_t const **out, fr_sbuff_t *name, fr_dict_t const *dict_def)
Look up a protocol name embedded in another string.
Definition dict_util.c:2500
int fr_dict_dependent_add(fr_dict_t const *dict, char const *dependent)
Manually increase the reference count for a dictionary.
Definition dict_util.c:3735
fr_slen_t fr_dict_attr_search_by_qualified_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
Definition dict_util.c:2978
size_t length
Length of length data.
Definition dict.h:255
fr_dict_t const * fr_dict_by_protocol_name(char const *name)
Lookup a protocol by its name.
Definition dict_util.c:2580
bool fr_dict_is_read_only(fr_dict_t const *dict)
Definition dict_util.c:2408
char const * base_dir
Directory structure beneath share.
Definition dict.h:289
fr_dict_attr_t const * parent
Immediate parent of this attribute.
Definition dict.h:196
fr_slen_t fr_dict_attr_unknown_afrom_oid_substr(TALLOC_CTX *ctx, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_type_t type))
Create a fr_dict_attr_t from an ASCII attribute and value.
fr_slen_t fr_dict_attr_search_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a fr_dict_attr_t by its name in the top level namespace of a dictionary.
Definition dict_util.c:3007
static bool fr_dict_attr_is_top_level(fr_dict_attr_t const *da)
Return true if this attribute is parented directly off the dictionary root.
Definition dict.h:768
void(* fr_dict_protocol_free_t)(void)
Definition dict.h:359
fr_dict_attr_encode_func_t encode
for encoding attributes.
Definition dict.h:468
char const * fr_dict_global_ctx_dir(void)
Definition dict_util.c:4538
unsigned int local
is a local variable
Definition dict.h:119
fr_dict_attr_ext_t
Extension identifier.
Definition dict.h:168
@ FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
Protocol specific extensions.
Definition dict.h:177
@ FR_DICT_ATTR_EXT_MAX
Definition dict.h:178
@ FR_DICT_ATTR_EXT_ENUMV
Enumeration values.
Definition dict.h:175
@ FR_DICT_ATTR_EXT_NAMESPACE
Attribute has its own namespace.
Definition dict.h:176
@ FR_DICT_ATTR_EXT_DA_STACK
Cached da stack.
Definition dict.h:174
@ FR_DICT_ATTR_EXT_REF
Attribute references another attribute and/or dictionary.
Definition dict.h:171
@ FR_DICT_ATTR_EXT_VENDOR
Cached vendor pointer.
Definition dict.h:173
@ FR_DICT_ATTR_EXT_NAME
Name of the attribute.
Definition dict.h:169
@ FR_DICT_ATTR_EXT_CHILDREN
Attribute has children.
Definition dict.h:170
static fr_slen_t fr_dict_enum_name_afrom_substr(TALLOC_CTX *ctx, char **out, fr_sbuff_parse_error_t *err, fr_sbuff_t *in, fr_sbuff_term_t const *tt) 1(fr_dict_enum_name_from_substr
unsigned int last_child_attr
highest value of last child attribute.
Definition dict.h:192
int fr_dict_global_ctx_free(fr_dict_gctx_t const *gctx)
Explicitly free all data associated with a global dictionary context.
Definition dict_util.c:4513
unsigned int is_known_width
is treated as if it has a known width for structs
Definition dict.h:93
int fr_dict_parse_str(fr_dict_t *dict, char *buf, fr_dict_attr_t const *parent)
int fr_dict_read(fr_dict_t *dict, char const *dict_dir, char const *filename)
Read supplementary attribute definitions into an existing dictionary.
void fr_dl_dict_autofree(dl_t const *module, void *symbol, void *user_ctx)
int default_type_length
how many octets are in "length" field
Definition dict.h:438
fr_dict_attr_err_t
Errors returned by attribute lookup functions.
Definition dict.h:296
@ FR_DICT_ATTR_OK
No error.
Definition dict.h:297
@ FR_DICT_ATTR_NOT_ANCESTOR
Attribute is not an ancestor of the child attribute.
Definition dict.h:305
@ FR_DICT_ATTR_NOT_DESCENDENT
Attribute is not a descendent of the parent attribute.
Definition dict.h:303
@ FR_DICT_ATTR_NOTFOUND
Attribute couldn't be found.
Definition dict.h:298
@ FR_DICT_ATTR_EINVAL
Invalid arguments.
Definition dict.h:308
@ FR_DICT_ATTR_PROTOCOL_NOTFOUND
Protocol couldn't be found.
Definition dict.h:299
@ FR_DICT_ATTR_NO_CHILDREN
Child lookup in attribute with no children.
Definition dict.h:307
@ FR_DICT_ATTR_OOM
Memory allocation error.
Definition dict.h:302
@ FR_DICT_ATTR_PARSE_ERROR
Attribute string couldn't be parsed.
Definition dict.h:300
@ FR_DICT_ATTR_INTERNAL_ERROR
Internal error occurred.
Definition dict.h:301
fr_slen_t fr_dict_attr_search_by_qualified_oid_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by a dictionary qualified OID string.
Definition dict_util.c:3036
fr_dict_vendor_t const * fr_dict_vendor_by_name(fr_dict_t const *dict, char const *name)
Look up a vendor by its name.
Definition dict_util.c:2660
int(* fr_dict_protocol_init_t)(void)
Init / free callbacks.
Definition dict.h:358
bool needs_value
This parsing flag must have a value. Else we error.
Definition dict.h:376
fr_dict_attr_t const * fr_dict_attr_iterate_children(fr_dict_attr_t const *parent, fr_dict_attr_t const **prev)
Iterate over children of a DA.
Definition dict_util.c:4740
int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr, fr_type_t type, fr_dict_attr_flags_t const *flags))
Add an attribute to the dictionary.
Definition dict_util.c:1715
fr_dict_attr_t const * fr_dict_attr_by_oid(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *oid))
Resolve an attribute using an OID string.
Definition dict_util.c:2376
int _fr_dict_autoload(fr_dict_autoload_t const *to_load, char const *dependent)
Process a dict_autoload element to load a protocol.
Definition dict_util.c:4183
unsigned int is_unsigned
hackity hack for dates and time deltas
Definition dict.h:97
static fr_dict_attr_t * fr_dict_attr_unknown_typed_afrom_num(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int num, fr_type_t type)
Definition dict.h:572
fr_dict_vendor_t const * fr_dict_vendor_by_num(fr_dict_t const *dict, uint32_t vendor_pen)
Look up a vendor by its PEN.
Definition dict_util.c:2683
int fr_dl_dict_autoload(dl_t const *module, void *symbol, void *user_ctx)
fr_hash_iter_t fr_dict_enum_iter_t
Definition dict.h:822
ssize_t fr_dict_valid_name(char const *name, ssize_t len)
Definition dict_util.c:4664
fr_dict_t * fr_dict_protocol_alloc(fr_dict_t const *parent)
Allocate a new local dictionary.
Definition dict_util.c:4005
fr_slen_t fr_dict_oid_component(fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt))
Parse an OID component, resolving it to a defined attribute.
Definition dict_util.c:2232
ssize_t(* fr_dict_attr_decode_func_t)(TALLOC_CTX *ctx, fr_pair_list_t *vps, uint8_t const *data, size_t data_len)
A generic interface for decoding packets to fr_pair_ts.
Definition dict.h:336
fr_dict_attr_t const * fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr)
Check if a child attribute exists in a parent using an attribute number.
Definition dict_util.c:3331
char const * proto
The protocol dictionary name.
Definition dict.h:290
fr_dict_attr_t * fr_dict_attr_unknown_typed_afrom_num_raw(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, unsigned int num, fr_type_t type, bool raw))
Initialise a fr_dict_attr_t from a number and a data type.
fr_dict_enum_value_t const * fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len)
Definition dict_util.c:3439
char const * name
Enum name.
Definition dict.h:234
static fr_slen_t in
Definition dict.h:841
fr_type_t type
Value type.
Definition dict.h:194
char const * name
name of this protocol
Definition dict.h:435
fr_dict_t const * fr_dict_by_protocol_num(unsigned int num)
Lookup a protocol by its number.
Definition dict_util.c:2593
uint8_t subtype
protocol-specific values, OR key fields
Definition dict.h:128
static int8_t fr_dict_attr_cmp_fields(const fr_dict_attr_t *a, const fr_dict_attr_t *b)
Compare two dictionary attributes by their contents.
Definition dict.h:650
uint8_t length
length of the attribute
Definition dict.h:134
unsigned int is_alias
This isn't a real attribute, it's a reference to to one.
Definition dict.h:87
fr_dict_vendor_t const * fr_dict_vendor_by_da(fr_dict_attr_t const *da)
Look up a vendor by one of its child attributes.
Definition dict_util.c:2638
unsigned int counter
integer attribute is actually an impulse / counter
Definition dict.h:99
unsigned int is_unknown
This dictionary attribute is ephemeral and not part of the main dictionary.
Definition dict.h:79
void dict_dctx_debug(dict_tokenize_ctx_t *dctx)
void fr_dict_export(FILE *fp, fr_dict_t const *dict)
Export in the standard form: ATTRIBUTE name oid flags.
Definition dict_print.c:307
int fr_dl_dict_attr_autoload(dl_t const *module, void *symbol, void *user_ctx)
static int8_t fr_dict_attr_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
Definition dict.h:613
Dictionary attribute.
Definition dict.h:183
Specifies an attribute which must be present for the module to function.
Definition dict.h:273
Values of the encryption flags.
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:286
Specifies a value which must be present for the module to function.
Definition dict.h:262
Value of an enumerated attribute.
Definition dict.h:233
Protocol specific custom flag definitnion.
Definition dict.h:404
Protocol-specific callbacks in libfreeradius-PROTOCOL.
Definition dict.h:434
Private enterprise.
Definition dict.h:251
static uint32_t fr_dict_vendor_num_by_da(fr_dict_attr_t const *da)
Return the vendor number for an attribute.
Definition dict_ext.h:212
fr_dict_t * internal
Magic internal dictionary.
Definition dict_priv.h:155
bool free_at_exit
This gctx will be freed on exit.
Definition dict_priv.h:130
Vendors and attribute names.
Definition dict_priv.h:85
Test enumeration values.
Definition dict_test.h:92
Structure used to managed the lifetime of a dictionary.
Definition dict_util.c:4240
Module handle.
Definition dl.h:58
#define FR_EXT_ALIGNMENT
The alignment of object extension structures.
Definition ext.h:54
Stores the state of the current iteration operation.
Definition hash.h:41
fr_type_t
@ FR_TYPE_VENDOR
Attribute that represents a vendor in the attribute tree.
@ FR_TYPE_OCTETS
Raw octets.
unsigned int uint32_t
long int ssize_t
unsigned char bool
unsigned char uint8_t
ssize_t fr_slen_t
#define UINT8_MAX
fr_sbuff_parse_error_t
#define fr_assert(_expr)
Definition rad_assert.h:38
static char const * name
#define SBUFF_OUT_TALLOC_FUNC_NO_LEN_DEF(_func,...)
Set of terminal elements.
fr_aka_sim_id_type_t type
static fr_slen_t parent
Definition pair.h:839
static fr_slen_t data
Definition value.h:1288
int nonnull(2, 5))
static size_t char ** out
Definition value.h:1020
Union containing all data types supported by the server.
Definition value.h:186