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: 88f32d57c614fa6a29bfc25be9f43cea1b660944 $")
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; //! needs a fixup during dictionary parsing
122
123 unsigned int migration_union_key : 1; //!< for migrating key fields
124
125 /*
126 * main: extra is set, then this field is is key, bit, or a uint16 length field.
127 * radius: is one of 9 options for flags
128 * dhcp v4/v6: DNS label, or partial DNS label
129 */
130 uint8_t subtype; //!< protocol-specific values, OR key fields
131
132 /*
133 * TLVs: Number of bytes in the "type" field for TLVs (typically 1, 2, or 4)
134 *
135 * da_is_bit_field(da): offset in the byte where this bit
136 * field ends. This is only used as a caching mechanism
137 * during parsing of the dictionaries.
138 *
139 * time/time_delta: fr_time_res_t, which has 4 possible values.
140 *
141 * otherwise: unused.
142 */
143 uint8_t type_size; //!< Type size for TLVs
144
145 /*
146 * da_is_bit_field(da): Length of the field in bits.
147 *
148 * TLV: Number of bytes in the "length" field
149 *
150 * otherwise: Length in bytes
151 */
152 uint16_t length; //!< length of the attribute
154
155#define flag_time_res type_size
156#define flag_byte_offset type_size
157
158/** subtype values for the dictionary when extra=1
159 *
160 */
161enum {
162 FLAG_EXTRA_NONE = 0, //!< no extra meaning, should be invalid
163 FLAG_KEY_FIELD, //!< this is a key field for a subsequent struct
164 FLAG_BIT_FIELD, //!< bit field inside of a struct
165 FLAG_LENGTH_UINT8, //!< string / octets type is prefixed by uint8 of length
166 FLAG_LENGTH_UINT16, //!< string / octets type is prefixed by uint16 of length
167};
168
169#define fr_dict_attr_is_key_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_KEY_FIELD))
170#define da_is_bit_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_BIT_FIELD))
171#define da_is_length_field(_da) ((_da)->flags.extra && (((_da)->flags.subtype == FLAG_LENGTH_UINT8) || ((_da)->flags.subtype == FLAG_LENGTH_UINT16)))
172#define da_is_length_field8(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_LENGTH_UINT8))
173#define da_is_length_field16(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_LENGTH_UINT16))
174#define da_length_offset(_da) ((_da)->flags.type_size)
175
176/** Extension identifier
177 *
178 * @note New extension structures should also be added to the to the appropriate table in dict_ext.c
179 */
180typedef enum {
181 FR_DICT_ATTR_EXT_NAME = 0, //!< Name of the attribute.
182 FR_DICT_ATTR_EXT_CHILDREN, //!< Attribute has children.
183 FR_DICT_ATTR_EXT_REF, //!< Attribute references another
184 ///< attribute and/or dictionary.
185 FR_DICT_ATTR_EXT_KEY, //!< UNION attribute references a key
186 FR_DICT_ATTR_EXT_VENDOR, //!< Cached vendor pointer.
187 FR_DICT_ATTR_EXT_DA_STACK, //!< Cached da stack.
188 FR_DICT_ATTR_EXT_ENUMV, //!< Enumeration values.
189 FR_DICT_ATTR_EXT_NAMESPACE, //!< Attribute has its own namespace.
190 FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC, //!< Protocol specific extensions
193
194/** Dictionary attribute
195 */
197 fr_dict_t _CONST* _CONST dict; //!< Dict attribute belongs to.
198
199 char const *name; //!< Attribute name.
200 size_t name_len; //!< Length of the name.
201
202 unsigned int attr; //!< Attribute number.
203 unsigned int depth; //!< Depth of nesting for this attribute.
204
205 unsigned int last_child_attr; //!< highest value of last child attribute.
206
207 fr_type_t type; //!< Value type.
208
209 fr_dict_attr_t const *parent; //!< Immediate parent of this attribute.
210 fr_dict_attr_t const *next; //!< Next child in bin.
211
213
214 struct {
215 bool attr_set : 1; //!< Attribute number has been set.
216 //!< We need the full range of values 0-UINT32_MAX
217 ///< so we can't use any attr values to indicate
218 ///< "unsetness".
219
220 bool finalised : 1; //!< Attribute definition is complete and modifications
221 ///< that would change the address of the memory chunk
222 ///< of the attribute are no longer permitted.
224
225 char const *filename; //!< Where the attribute was defined.
226 ///< this buffer's lifetime is bound to the
227 ///< fr_dict_t.
228 int line; //!< Line number where the attribute was defined.
229
230 uint8_t ext[FR_DICT_ATTR_EXT_MAX]; //!< Extensions to the dictionary attribute.
231} CC_HINT(aligned(FR_EXT_ALIGNMENT));
232
233/** Extension identifier
234 *
235 * @note New extension structures should also be added to the appropriate table in dict_ext.c
236 */
237typedef enum {
238 FR_DICT_ENUM_EXT_KEY_CHILD_REF = 0, //!< Reference to a child associated with this key
241
242/** Value of an enumerated attribute
243 *
244 * Maps one of more string values to integers and vice versa.
245 */
246typedef struct {
247 char const *name; //!< Enum name.
248 size_t name_len; //!< Allows for efficient name lookups when operating
249 ///< on partial buffers.
250 fr_value_box_t const *value; //!< Enum value (what name maps to).
251
252 uint8_t ext[FR_DICT_ENUM_EXT_MAX]; //!< Extensions to the dictionary attribute.
253
254 fr_dict_attr_t const *key_child_ref[]; //!< for key fields
255} fr_dict_enum_value_t CC_HINT(aligned(FR_EXT_ALIGNMENT));
256
257/** Private enterprise
258 *
259 * Represents an IANA private enterprise allocation.
260 *
261 * The width of the private enterprise number must be the same for all protocols
262 * so we can represent a vendor with a single struct.
263 */
264typedef struct {
265 uint32_t pen; //!< Private enterprise number.
266 bool continuation; //!< we only have one flag for now, for WiMAX
267 size_t type; //!< Length of type data
268 size_t length; //!< Length of length data
269 char const *name; //!< Vendor name.
271
272/** Specifies a value which must be present for the module to function
273 *
274 */
275typedef struct {
276 fr_value_box_t const **out; //!< Enumeration value.
277 fr_dict_attr_t const **attr; //!< The protocol dictionary the attribute should
278 ///< be resolved in. ** so it's a compile time
279 ///< constant.
280 char const *name; //!< of the attribute.
282
283/** Specifies an attribute which must be present for the module to function
284 *
285 */
286typedef struct {
287 fr_dict_attr_t const **out; //!< Where to write a pointer to the resolved
288 //!< #fr_dict_attr_t.
289 fr_dict_t const **dict; //!< The protocol dictionary the attribute should
290 ///< be resolved in. ** so it's a compile time
291 ///< constant.
292 char const *name; //!< of the attribute.
293 fr_type_t type; //!< of the attribute. Mismatch is a fatal error.
295
296/** Specifies a dictionary which must be loaded/loadable for the module to function
297 *
298 */
299typedef struct {
300 fr_dict_t const **out; //!< Where to write a pointer to the loaded/resolved
301 //!< #fr_dict_t.
302 char const *base_dir; //!< Directory structure beneath share.
303 char const *proto; //!< The protocol dictionary name.
305
306/** Errors returned by attribute lookup functions
307 *
308 */
309typedef enum {
310 FR_DICT_ATTR_OK = 0, //!< No error.
311 FR_DICT_ATTR_NOTFOUND = -1, //!< Attribute couldn't be found.
312 FR_DICT_ATTR_PROTOCOL_NOTFOUND = -2, //!< Protocol couldn't be found.
313 FR_DICT_ATTR_PARSE_ERROR = -3, //!< Attribute string couldn't be parsed
314 FR_DICT_ATTR_INTERNAL_ERROR = -4, //!< Internal error occurred.
315 FR_DICT_ATTR_OOM = -5, //!< Memory allocation error.
316 FR_DICT_ATTR_NOT_DESCENDENT = -6, //!< Attribute is not a descendent of the parent
317 ///< attribute.
318 FR_DICT_ATTR_NOT_ANCESTOR = -7, //!< Attribute is not an ancestor of the child
319 ///< attribute.
320 FR_DICT_ATTR_NO_CHILDREN = -8, //!< Child lookup in attribute with no children.
321 FR_DICT_ATTR_EINVAL = -9 //!< Invalid arguments.
322
324
327
328/*
329 * Forward declarations to avoid circular references.
330 */
332typedef struct fr_dbuff_s fr_dbuff_t;
333
334/** A generic interface for decoding packets to fr_pair_ts
335 *
336 * A decoding function should decode a single top level packet from wire format.
337 *
338 * Note that unlike #fr_tp_proto_decode_t, this function is NOT passed an encode_ctx. That is because when we
339 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
340 *
341 * @param[in] ctx to allocate new pairs in.
342 * @param[in] vps where new VPs will be added
343 * @param[in] data to decode.
344 * @param[in] data_len The length of the incoming data.
345 * @return
346 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
347 * - > 0 on success. How many bytes were decoded.
348 */
349typedef ssize_t (*fr_dict_attr_decode_func_t)(TALLOC_CTX *ctx, fr_pair_list_t *vps,
350 uint8_t const *data, size_t data_len);
351
352/** A generic interface for encoding fr_pair_ts to packets
353 *
354 * An encoding function should encode multiple VPs to a wire format packet
355 *
356 * Note that unlike #fr_tp_proto_encode_t, this function is NOT passed an encode_ctx. That is because when we
357 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
358 *
359 * @param[in] vps vps to encode
360 * @param[in] dbuff buffer where data can be written
361 * @return
362 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
363 * - > 0 on success. How many bytes were encoded
364 */
366
367/** Init / free callbacks
368 *
369 * Only for "autoref" usage.
370 */
371typedef int (*fr_dict_protocol_init_t)(void);
372typedef void (*fr_dict_protocol_free_t)(void);
373
375
376/** Custom protocol-specific flag parsing function
377 *
378 * @note This function should be used to implement table based flag parsing.
379 *
380 * @param[in] da_p we're currently populating
381 * @param[in] value flag value to parse.
382 * @param[in] rule How to parse the flag.
383 */
385
387 fr_dict_flag_parse_func_t func; //!< Custom parsing function to convert a flag value string to a C type value.
388 void *uctx; //!< Use context to pass to the custom parsing function.
389 bool needs_value; //!< This parsing flag must have a value. Else we error.
390};
391
392/** Copy custom flags from one attribute to another
393 *
394 * @param[out] da_to attribute to copy to. Use for the talloc_ctx for any heap allocated flag values.
395 * @param[out] flags_to protocol specific flags struct to copy to.
396 * @param[in] flags_from protocol specific flags struct to copy from.
397 * @return
398 * - 0 on success.
399 * - -1 on error.
400 */
401typedef int (*fr_dict_flags_copy_func_t)(fr_dict_attr_t *da_to, void *flags_to, void *flags_from);
402
403/** Compare the protocol specific flags struct from two attributes
404 *
405 * @param[in] da_a first attribute to compare.
406 * @param[in] da_b second attribute to compare.
407 * @return
408 * - 0 if the flags are equal.
409 * - < 0 if da_a < da_b.
410 * - > 0 if da_a > da_b.
411 */
412 typedef int (*fr_dict_flags_cmp_func_t)(fr_dict_attr_t const *da_a, fr_dict_attr_t const *da_b);
413
414/** Protocol specific custom flag definitnion
415 *
416 */
417typedef struct {
418 fr_table_elem_name_t name; //!< Name of the flag
419 fr_dict_flag_parser_rule_t value; //!< Function and context to parse the flag.
421
422/** Define a flag setting function, which sets one bit in a fr_dict_attr_flags_t
423 *
424 * This is here, because AFAIK there's no completely portable way to get the bit
425 * offset of a bit field in a structure.
426 */
427#define FR_DICT_ATTR_FLAG_FUNC(_struct, _name) \
428static int dict_flag_##_name(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)\
429{ \
430 _struct *flags = fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC); \
431 flags->_name = 1; \
432 return 0; \
433}
434
435/** conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
436 *
437 * @param[in] _struct containing the field to write the result to.
438 * @param[in] _field to write the flag to
439 */
440# define FR_DICT_PROTOCOL_FLAG(_struct, _field) \
441 .type = FR_CTYPE_TO_TYPE((((_struct *)NULL)->_field)), \
442 .offset = offsetof(_struct, _field)
443
444/** Protocol-specific callbacks in libfreeradius-PROTOCOL
445 *
446 */
447typedef struct {
448 char const *name; //!< name of this protocol
449
450 int default_type_size; //!< how many octets are in "type" field
451 int default_type_length; //!< how many octets are in "length" field
452
453 struct {
454 /** Custom flags for this protocol
455 */
456 struct {
457 fr_dict_flag_parser_t const *table; //!< Flags for this protocol, an array of fr_dict_flag_parser_t
458 size_t table_len; //!< Length of protocol_flags table.
459
460 size_t len; //!< Length of the protocol specific flags structure.
461 ///< This is used to allocate a FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
462 ///< extension of the specified length.
463
464 fr_dict_flags_copy_func_t copy; //!< Copy protocol-specific flags from one attribute to another.
465 ///< Called when copying attributes.
466
467 fr_dict_flags_cmp_func_t cmp; //!< Compare protocol-specific flags from two attributes.
468 ///< Called when comparing attributes by their fields.
469 } flags;
470
471 fr_dict_attr_type_parse_t type_parse; //!< parse unknown type names
472 fr_dict_attr_valid_func_t valid; //!< Validation function to ensure that
473 ///< new attributes are valid.
474 } attr;
475
476 fr_dict_protocol_init_t init; //!< initialize the library
477 fr_dict_protocol_free_t free; //!< free the library
478
479 fr_dict_attr_decode_func_t decode; //!< for decoding attributes. Used for implementing foreign
480 ///< protocol attributes.
481 fr_dict_attr_encode_func_t encode; //!< for encoding attributes. Used for implementing foreign
482 ///< protocol attributes.
484
486
487/*
488 * Dictionary constants
489 */
490#define FR_DICT_PROTO_MAX_NAME_LEN (128) //!< Maximum length of a protocol name.
491#define FR_DICT_ENUM_MAX_NAME_LEN (128) //!< Maximum length of a enum value.
492#define FR_DICT_VENDOR_MAX_NAME_LEN (128) //!< Maximum length of a vendor name.
493#define FR_DICT_ATTR_MAX_NAME_LEN (128) //!< Maximum length of a attribute name.
494
495/** Maximum level of TLV nesting allowed
496 */
497#define FR_DICT_TLV_NEST_MAX (24)
498
499/** Maximum level of da stack caching
500 */
501#define FR_DICT_DA_STACK_CACHE_MAX (5)
502
503/** Maximum TLV stack size
504 *
505 * The additional attributes are to account for
506 *
507 * Root + Vendor + NULL (top frame).
508 * Root + Embedded protocol + Root + Vendor + NULL.
509 *
510 * Code should ensure that it doesn't run off the end of the stack,
511 * as this could be remotely exploitable, using odd nesting.
512 */
513#define FR_DICT_MAX_TLV_STACK (FR_DICT_TLV_NEST_MAX + 5)
514
515/** Characters allowed in a single dictionary attribute name
516 *
517 */
518extern bool const fr_dict_attr_allowed_chars[UINT8_MAX + 1];
519
520/** Characters allowed in a nested dictionary attribute name
521 *
522 */
523extern bool const fr_dict_attr_nested_allowed_chars[UINT8_MAX + 1];
524
525/** Characters that are allowed in dictionary enumeration value names
526 *
527 */
528extern bool const fr_dict_enum_allowed_chars[UINT8_MAX + 1];
529
530/** @name Dictionary structure extensions
531 *
532 * @{
533 */
534#include <freeradius-devel/util/dict_ext.h>
535/** @} */
536
537/** @name Programmatically create dictionary attributes and values
538 *
539 * @{
540 */
542
543int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr,
544 fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
545
547 char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
548
549int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name,
550 fr_value_box_t const *value, bool coerce, bool replace);
551
552int fr_dict_enum_add_name_next(fr_dict_attr_t *da, char const *name) CC_HINT(nonnull);
553
554int fr_dict_str_to_argv(char *str, char **argv, int max_argc);
555
556int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src) CC_HINT(nonnull);
557
559/** @} */
560
561/** @name Dict accessors
562 *
563 * @{
564 */
566/** @} */
567
568/** @name Unknown ephemeral attributes
569 *
570 * @{
571 */
573
575
576fr_dict_attr_t *fr_dict_attr_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da) CC_HINT(nonnull(2));
577
578static inline fr_dict_attr_t *fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
579{
580 fr_assert(da->flags.is_unknown);
581
582 return fr_dict_attr_unknown_afrom_da(ctx, da);
583}
584
586 fr_dict_attr_t const *parent,
587 unsigned int num, fr_type_t type, bool raw)
588 CC_HINT(nonnull(2));
589
590static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_typed_afrom_num(TALLOC_CTX *ctx,
591 fr_dict_attr_t const *parent,
592 unsigned int num, fr_type_t type)
593{
594 return fr_dict_attr_unknown_typed_afrom_num_raw(ctx, parent, num, type, false);
595}
596
597
598static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_vendor_afrom_num(TALLOC_CTX *ctx,
599 fr_dict_attr_t const *parent,
600 unsigned int vendor)
601{
603}
604
605static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_raw_afrom_num(TALLOC_CTX *ctx,
606 fr_dict_attr_t const *parent,
607 unsigned int attr)
608{
610}
611
613 CC_HINT(nonnull(2));
614
615
617 fr_dict_attr_t const **out,
618 fr_dict_attr_t const *parent,
620 CC_HINT(nonnull(2,3,4));
621
623
625/** @} */
626
627/** @name Attribute comparisons
628 *
629 * @{
630 */
632
633static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
634{
635 int8_t ret;
636
637 /*
638 * Comparing unknowns or raws is expensive
639 * because we need to check the lineage.
640 */
641 if (a->flags.is_unknown | a->flags.is_raw | b->flags.is_unknown | b->flags.is_raw) {
642 ret = CMP(a->depth, b->depth);
643 if (ret != 0) return ret;
644
645 ret = CMP(a->attr, b->attr);
646 if (ret != 0) return ret;
647
648 ret = (a->parent == NULL) - (b->parent == NULL);
649 if ((ret != 0) || !a->parent) return ret;
650
651 return fr_dict_attr_cmp(a->parent, b->parent);
652 }
653
654 /*
655 * Comparing knowns is cheap because the
656 * DAs are unique.
657 */
658 return CMP(a, b);
659}
660
661/** Compare two dictionary attributes by their contents
662 *
663 * @param[in] a First attribute to compare.
664 * @param[in] b Second attribute to compare.
665 * @return
666 * - 0 if the attributes are equal.
667 * - -1 if a < b.
668 * - +1 if a > b.
669 */
670static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp_fields(const fr_dict_attr_t *a, const fr_dict_attr_t *b)
671{
672 int8_t ret;
673 fr_dict_protocol_t const *a_proto = fr_dict_protocol(a->dict);
674
675 /*
676 * Technically this isn't a property of the attribute
677 * but we need them to be the same to be able to
678 * compare protocol specific flags successfully.
679 */
680 ret = CMP(a_proto, fr_dict_protocol(b->dict));
681 if (ret != 0) return ret;
682
683 ret = CMP(a->attr, b->attr);
684 if (ret != 0) return ret;
685
686 ret = CMP(a->parent, b->parent);
687 if (ret != 0) return ret;
688
690 if (ret != 0) return ret;
691
692 /*
693 * Compare protocol specific flags
694 */
695 if (a_proto->attr.flags.cmp && (ret = a_proto->attr.flags.cmp(a, b))) return ret;
696
697 return CMP(memcmp(&a->flags, &b->flags, sizeof(a->flags)), 0);
698}
699/** @} */
700
701/** @name Debugging functions
702 *
703 * @{
704 */
705void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da);
706
707void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da);
708
709void fr_dict_debug(FILE *fp, fr_dict_t const *dict);
710
711void fr_dict_export(FILE *fp, fr_dict_t const *dict);
712
713void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent);
714/** @} */
715
716/** @name Attribute lineage
717 *
718 * @{
719 */
720fr_dict_attr_t const *fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor);
721
722int fr_dict_oid_component_legacy(unsigned int *out, char const **oid);
723
725 fr_type_t type, fr_dict_attr_flags_t const *flags);
726
728 fr_dict_attr_t const *ancestor, fr_dict_attr_t const *da, bool numeric);
729#define FR_DICT_ATTR_OID_PRINT_RETURN(...) FR_SBUFF_RETURN(fr_dict_attr_oid_print, ##__VA_ARGS__)
730
732 unsigned int *attr, char const *oid) CC_HINT(nonnull);
733
735 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
736 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
737 CC_HINT(nonnull(2,3,4));
738
740 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
741 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
742 CC_HINT(nonnull(2,3,4));
743
745 fr_dict_attr_t const *parent, char const *oid)
746 CC_HINT(nonnull(2,3));
747
748bool fr_dict_attr_can_contain(fr_dict_attr_t const *parent, fr_dict_attr_t const *child) CC_HINT(nonnull);
749
750/** @} */
751
752/** @name Attribute, vendor and dictionary lookup
753 *
754 * @{
755 */
756
757/** @hidecallergraph */
758fr_dict_attr_t const *fr_dict_root(fr_dict_t const *dict) CC_HINT(nonnull);
759
760bool fr_dict_is_read_only(fr_dict_t const *dict);
761
762dl_t *fr_dict_dl(fr_dict_t const *dict);
763
765 fr_dict_t const **out, fr_sbuff_t *name, fr_dict_t const *dict_def);
766
767fr_dict_t const *fr_dict_by_protocol_name(char const *name);
768
769fr_dict_t const *fr_dict_by_protocol_num(unsigned int num);
770
771fr_dict_attr_t const *fr_dict_unlocal(fr_dict_attr_t const *da) CC_HINT(nonnull);
772
773fr_dict_t const *fr_dict_proto_dict(fr_dict_t const *dict) CC_HINT(nonnull);
774
775fr_dict_t const *fr_dict_by_da(fr_dict_attr_t const *da) CC_HINT(nonnull);
776
777fr_dict_t const *fr_dict_by_attr_name(fr_dict_attr_t const **found, char const *name);
778
779bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2) CC_HINT(nonnull);
780
781/** Return true if this attribute is parented directly off the dictionary root
782 *
783 * @param[in] da to check.
784 * @return
785 * - true if attribute is top level.
786 * - false if attribute is not top level.
787 */
788static inline bool fr_dict_attr_is_top_level(fr_dict_attr_t const *da)
789{
790 if (unlikely(!da) || unlikely(!da->parent)) return false;
791 return da->parent->flags.is_root;
792}
793
795
796fr_dict_vendor_t const *fr_dict_vendor_by_name(fr_dict_t const *dict, char const *name);
797
798fr_dict_vendor_t const *fr_dict_vendor_by_num(fr_dict_t const *dict, uint32_t vendor_pen);
799
800fr_dict_attr_t const *fr_dict_vendor_da_by_num(fr_dict_attr_t const *vendor_root, uint32_t vendor_pen);
801
803 fr_dict_t const *dict_def,
804 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
805 bool internal, bool foreign)
806 CC_HINT(nonnull(2, 4));
807
809 fr_dict_t const *dict_def,
810 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
811 bool internal, bool foreign)
812 CC_HINT(nonnull(2, 4));
813
815 fr_dict_t const *dict_def,
816 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
817 bool internal, bool foreign)
818 CC_HINT(nonnull(2, 4));
819
821 fr_dict_t const *dict_def, char const *attr,
822 bool internal, bool foreign)
823 CC_HINT(nonnull(3));
824
826 fr_dict_t const *dict_def,
827 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
828 bool internal, bool foreign)
829 CC_HINT(nonnull(2, 4));
830
832 fr_dict_attr_t const *parent,
833 fr_sbuff_t *name, fr_sbuff_term_t const *tt)
834 CC_HINT(nonnull(2,3,4));
835
837 char const *attr)
838 CC_HINT(nonnull(2,3));
839
840fr_dict_attr_t const *fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr);
841
842typedef fr_hash_iter_t fr_dict_enum_iter_t; /* Alias this in case we want to change it in future */
843
845
847
849
851
852fr_dict_enum_value_t const *fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len);
853
855
857 fr_sbuff_t *in, fr_sbuff_term_t const *tt);
858
860 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
862/** @} */
863
864/** @name Dictionary and protocol loading
865 *
866 * @{
867 */
868int fr_dict_internal_afrom_file(fr_dict_t **out, char const *internal_name,
869 char const *dependent);
870
871int fr_dict_protocol_afrom_file(fr_dict_t **out, char const *proto_name, char const *proto_dir,
872 char const *dependent);
873
875
877
878int fr_dict_read(fr_dict_t *dict, char const *dict_dir, char const *filename);
879/** @} */
880
881/** @name Autoloader interface
882 *
883 * @{
884 */
886
888
889#define fr_dict_autoload(_to_load) _fr_dict_autoload(_to_load, __FILE__)
890int _fr_dict_autoload(fr_dict_autoload_t const *to_load, char const *dependent);
891
892#define fr_dict_autofree(_to_free) _fr_dict_autofree(_to_free, __FILE__)
893int _fr_dict_autofree(fr_dict_autoload_t const *to_free, char const *dependent);
894
895#define fr_dict_autoload_talloc(_ctx, _dict_out, _proto) _fr_dict_autoload_talloc(_ctx, _dict_out, _proto, __FILE__)
896fr_dict_autoload_talloc_t *_fr_dict_autoload_talloc(TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent);
897
898int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx);
899
900int fr_dl_dict_attr_autoload(dl_t const *module, void *symbol, void *user_ctx);
901
902int fr_dl_dict_autoload(dl_t const *module, void *symbol, void *user_ctx);
903
904void fr_dl_dict_autofree(dl_t const *module, void *symbol, void *user_ctx);
905/** @} */
906
907/** @name Allocating and freeing
908 *
909 * @{
910 */
911fr_dict_t *fr_dict_alloc(char const *proto_name, unsigned int proto_number) CC_HINT(nonnull);
912
913int fr_dict_dependent_add(fr_dict_t const *dict, char const *dependent) CC_HINT(nonnull);
914
915int fr_dict_free(fr_dict_t **dict, char const *dependent) CC_HINT(nonnull);
916
917int fr_dict_const_free(fr_dict_t const **dict, char const *dependent) CC_HINT(nonnull);
918/** @} */
919
920/** @name Global dictionary management
921 *
922 * @{
923 */
924fr_dict_gctx_t *fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir);
925
926void fr_dict_global_ctx_perm_check(fr_dict_gctx_t *gctx, bool enable);
927
928void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx);
929
931
932int fr_dict_global_ctx_dir_set(char const *dict_dir);
933
935
936void fr_dict_gctx_debug(FILE *fp, fr_dict_gctx_t const *gctx);
937
938char const *fr_dict_global_ctx_dir(void);
939
941
943
945
947
949
950fr_dict_t const *fr_dict_internal(void);
951
952/** @} */
953
954/** @name Dictionary testing and validation
955 *
956 * @{
957 */
959
960int fr_dict_parse_str(fr_dict_t *dict, char *buf,
961 fr_dict_attr_t const *parent);
962
963ssize_t fr_dict_valid_name(char const *name, ssize_t len);
964
965ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len);
966
968
969typedef int (*fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx);
970
971int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx);
972
973void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da);
974/** @} */
975
976#undef _CONST
977
978#ifdef __cplusplus
979}
980#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:418
fr_dict_t * fr_dict_global_ctx_iter_next(fr_dict_global_ctx_iter_t *iter)
Definition dict_util.c:4713
bool continuation
we only have one flag for now, for WiMAX
Definition dict.h:266
size_t type
Length of type data.
Definition dict.h:267
fr_dict_t const * fr_dict_by_attr_name(fr_dict_attr_t const **found, char const *name)
fr_dict_protocol_free_t free
free the library
Definition dict.h:477
void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:238
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:4529
size_t name_len
Allows for efficient name lookups when operating on partial buffers.
Definition dict.h:248
fr_dict_attr_flags_t flags
Flags.
Definition dict.h:212
fr_dict_attr_decode_func_t decode
for decoding attributes.
Definition dict.h:479
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:384
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:1668
char const * name
of the attribute.
Definition dict.h:292
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:4802
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:4620
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:3652
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:2037
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:3177
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:237
@ FR_DICT_ENUM_EXT_MAX
Definition dict.h:239
@ FR_DICT_ENUM_EXT_KEY_CHILD_REF
Reference to a child associated with this key.
Definition dict.h:238
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:1816
char const * name
Vendor name.
Definition dict.h:269
char const * filename
Where the attribute was defined.
Definition dict.h:225
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4724
void * uctx
Use context to pass to the custom parsing function.
Definition dict.h:388
fr_dict_attr_t const ** attr
The protocol dictionary the attribute should be resolved in.
Definition dict.h:277
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:2702
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:4188
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:3445
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:4309
int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
Definition dict_util.c:4916
fr_dict_attr_t const * fr_dict_unlocal(fr_dict_attr_t const *da)
Definition dict_util.c:5097
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:2133
size_t name_len
Length of the name.
Definition dict.h:200
int line
Line number where the attribute was defined.
Definition dict.h:228
bool(* fr_dict_attr_valid_func_t)(fr_dict_attr_t *da)
Definition dict.h:325
int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx)
static fr_slen_t err
Definition dict.h:861
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:5113
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:598
void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent)
Definition dict_print.c:322
bool const fr_dict_attr_allowed_chars[UINT8_MAX+1]
Characters allowed in a single dictionary attribute name.
Definition dict_util.c:64
static fr_dict_attr_t * fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Definition dict.h:578
int8_t fr_dict_attr_ordered_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
Compare two attributes by total order.
Definition dict_util.c:229
int fr_dict_attr_set_group(fr_dict_attr_t **da_p)
Definition dict_util.c:5120
fr_dict_protocol_t const * fr_dict_protocol(fr_dict_t const *dict)
Return the protocol descriptor for the dictionary.
Definition dict_util.c:5089
int fr_dict_protocol_reference(fr_dict_attr_t const **da_p, fr_dict_attr_t const *root, fr_sbuff_t *in)
Resolve a reference string to a dictionary attribute.
Definition dict_fixup.c:135
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:365
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:1144
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:3359
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:4360
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:2715
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:412
void fr_dict_debug(FILE *fp, fr_dict_t const *dict)
Definition dict_print.c:276
fr_value_box_t const ** out
Enumeration value.
Definition dict.h:276
fr_dict_attr_t * fr_dict_attr_unconst(fr_dict_attr_t const *da)
Coerce to non-const.
Definition dict_util.c:4736
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:289
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:2420
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:605
void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da)
Definition dict_util.c:4922
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:5014
struct dict_attr_s::@126 state
bool const fr_dict_attr_nested_allowed_chars[UINT8_MAX+1]
Characters allowed in a nested dictionary attribute name.
Definition dict_util.c:71
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:4706
int(* fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx)
Definition dict.h:969
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:2496
fr_dict_flag_parse_func_t func
Custom parsing function to convert a flag value string to a C type value.
Definition dict.h:387
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:2791
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:287
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:300
void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx)
Set a new, active, global dictionary context.
Definition dict_util.c:4590
fr_dict_attr_t const * next
Next child in bin.
Definition dict.h:210
fr_dict_t _CONST *_CONST dict
Dict attribute belongs to.
Definition dict.h:197
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:3158
char const * name
Attribute name.
Definition dict.h:199
unsigned int unsafe
e.g. Cleartext-Password
Definition dict.h:108
fr_dict_protocol_init_t init
initialize the library
Definition dict.h:476
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:2221
bool const fr_dict_enum_allowed_chars[UINT8_MAX+1]
Characters that are allowed in dictionary enumeration value names.
Definition dict_util.c:79
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:280
dl_t * fr_dict_dl(fr_dict_t const *dict)
Definition dict_util.c:2506
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:250
void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:262
@ FLAG_EXTRA_NONE
no extra meaning, should be invalid
Definition dict.h:162
@ FLAG_LENGTH_UINT8
string / octets type is prefixed by uint8 of length
Definition dict.h:165
@ FLAG_LENGTH_UINT16
string / octets type is prefixed by uint16 of length
Definition dict.h:166
@ FLAG_KEY_FIELD
this is a key field for a subsequent struct
Definition dict.h:163
@ FLAG_BIT_FIELD
bit field inside of a struct
Definition dict.h:164
unsigned int attr
Attribute number.
Definition dict.h:202
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:3519
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:3466
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:2049
uint8_t ext[FR_DICT_ATTR_EXT_MAX]
Extensions to the dictionary attribute.
Definition dict.h:230
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:401
int default_type_size
how many octets are in "type" field
Definition dict.h:450
unsigned int migration_union_key
needs a fixup during dictionary parsing
Definition dict.h:123
uint32_t pen
Private enterprise number.
Definition dict.h:265
int fr_dict_free(fr_dict_t **dict, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4161
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:3486
fr_type_t type
of the attribute. Mismatch is a fatal error.
Definition dict.h:293
fr_dict_flag_parser_rule_t value
Function and context to parse the flag.
Definition dict.h:419
#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:2176
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:3558
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:4581
void fr_dict_global_ctx_read_only(void)
Mark all dictionaries and the global dictionary ctx as read only.
Definition dict_util.c:4640
uint8_t type_size
Type size for TLVs.
Definition dict.h:143
unsigned int depth
Depth of nesting for this attribute.
Definition dict.h:203
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:4145
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:4227
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4749
bool(* fr_dict_attr_type_parse_t)(fr_type_t *type, fr_dict_attr_t **da_p, char const *name)
Definition dict.h:326
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:2593
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:3828
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:3071
size_t length
Length of length data.
Definition dict.h:268
fr_dict_t const * fr_dict_by_protocol_name(char const *name)
Lookup a protocol by its name.
Definition dict_util.c:2673
bool fr_dict_is_read_only(fr_dict_t const *dict)
Definition dict_util.c:2501
char const * base_dir
Directory structure beneath share.
Definition dict.h:302
fr_dict_attr_t const * parent
Immediate parent of this attribute.
Definition dict.h:209
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:3100
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:788
void(* fr_dict_protocol_free_t)(void)
Definition dict.h:372
uint16_t length
length of the attribute
Definition dict.h:152
fr_dict_attr_encode_func_t encode
for encoding attributes.
Definition dict.h:481
char const * fr_dict_global_ctx_dir(void)
Definition dict_util.c:4631
unsigned int local
is a local variable
Definition dict.h:119
fr_dict_attr_ext_t
Extension identifier.
Definition dict.h:180
@ FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
Protocol specific extensions.
Definition dict.h:190
@ FR_DICT_ATTR_EXT_MAX
Definition dict.h:191
@ FR_DICT_ATTR_EXT_ENUMV
Enumeration values.
Definition dict.h:188
@ FR_DICT_ATTR_EXT_NAMESPACE
Attribute has its own namespace.
Definition dict.h:189
@ FR_DICT_ATTR_EXT_DA_STACK
Cached da stack.
Definition dict.h:187
@ FR_DICT_ATTR_EXT_REF
Attribute references another attribute and/or dictionary.
Definition dict.h:183
@ FR_DICT_ATTR_EXT_KEY
UNION attribute references a key.
Definition dict.h:185
@ FR_DICT_ATTR_EXT_VENDOR
Cached vendor pointer.
Definition dict.h:186
@ FR_DICT_ATTR_EXT_NAME
Name of the attribute.
Definition dict.h:181
@ FR_DICT_ATTR_EXT_CHILDREN
Attribute has children.
Definition dict.h:182
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:205
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:4606
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:451
fr_dict_attr_err_t
Errors returned by attribute lookup functions.
Definition dict.h:309
@ FR_DICT_ATTR_OK
No error.
Definition dict.h:310
@ FR_DICT_ATTR_NOT_ANCESTOR
Attribute is not an ancestor of the child attribute.
Definition dict.h:318
@ FR_DICT_ATTR_NOT_DESCENDENT
Attribute is not a descendent of the parent attribute.
Definition dict.h:316
@ FR_DICT_ATTR_NOTFOUND
Attribute couldn't be found.
Definition dict.h:311
@ FR_DICT_ATTR_EINVAL
Invalid arguments.
Definition dict.h:321
@ FR_DICT_ATTR_PROTOCOL_NOTFOUND
Protocol couldn't be found.
Definition dict.h:312
@ FR_DICT_ATTR_NO_CHILDREN
Child lookup in attribute with no children.
Definition dict.h:320
@ FR_DICT_ATTR_OOM
Memory allocation error.
Definition dict.h:315
@ FR_DICT_ATTR_PARSE_ERROR
Attribute string couldn't be parsed.
Definition dict.h:313
@ FR_DICT_ATTR_INTERNAL_ERROR
Internal error occurred.
Definition dict.h:314
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:3129
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:2753
int(* fr_dict_protocol_init_t)(void)
Init / free callbacks.
Definition dict.h:371
bool needs_value
This parsing flag must have a value. Else we error.
Definition dict.h:389
void fr_dict_gctx_debug(FILE *fp, fr_dict_gctx_t const *gctx)
Dump information about currently loaded dictionaries.
Definition dict_util.c:4667
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:4835
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:1790
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:2469
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:4276
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:590
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:2776
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:842
ssize_t fr_dict_valid_name(char const *name, ssize_t len)
Definition dict_util.c:4759
fr_dict_t * fr_dict_protocol_alloc(fr_dict_t const *parent)
Allocate a new local dictionary.
Definition dict_util.c:4098
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:2325
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:349
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:3424
char const * proto
The protocol dictionary name.
Definition dict.h:303
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:3532
char const * name
Enum name.
Definition dict.h:247
static fr_slen_t in
Definition dict.h:861
fr_type_t type
Value type.
Definition dict.h:207
char const * name
name of this protocol
Definition dict.h:448
fr_dict_t const * fr_dict_by_protocol_num(unsigned int num)
Lookup a protocol by its number.
Definition dict_util.c:2686
uint8_t subtype
protocol-specific values, OR key fields
Definition dict.h:130
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:670
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:2731
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:317
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:633
Dictionary attribute.
Definition dict.h:196
Specifies an attribute which must be present for the module to function.
Definition dict.h:286
Values of the encryption flags.
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:299
Specifies a value which must be present for the module to function.
Definition dict.h:275
Value of an enumerated attribute.
Definition dict.h:246
Protocol specific custom flag definitnion.
Definition dict.h:417
Protocol-specific callbacks in libfreeradius-PROTOCOL.
Definition dict.h:447
Private enterprise.
Definition dict.h:264
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:213
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:4333
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
unsigned short uint16_t
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:841
static fr_slen_t data
Definition value.h:1291
int nonnull(2, 5))
static size_t char ** out
Definition value.h:1023
Union containing all data types supported by the server.
Definition value.h:188