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 */
24RCSIDH(dict_h, "$Id: e3885cec9995265d3d86e4a9fcdabaf8a1daa018 $")
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30#include <freeradius-devel/build.h>
31#include <freeradius-devel/missing.h>
32#include <freeradius-devel/util/dl.h>
33#include <freeradius-devel/util/ext.h>
34#include <freeradius-devel/util/rb.h>
35#include <freeradius-devel/util/sbuff.h>
36#include <freeradius-devel/util/table.h>
37#include <freeradius-devel/util/talloc.h>
38#include <freeradius-devel/util/types.h>
39
40#include <stdbool.h>
41#include <stdint.h>
42
43/*
44 * Avoid circular type references.
45 */
47typedef struct fr_dict_s fr_dict_t;
48
50
51/*
52 * Allow public and private versions of the same structures
53 */
54#ifdef _CONST
55# error _CONST can only be defined in the local header
56#endif
57#ifndef _DICT_PRIVATE
58# define _CONST const
59#else
60# define _CONST
61#endif
62
63#ifdef WITH_VERIFY_PTR
64# define DA_VERIFY(_x) fr_dict_attr_verify(__FILE__, __LINE__, _x)
65#else
66# define DA_VERIFY(_x) fr_cond_assert(_x)
67#endif
68
71
72/** Values of the encryption flags
73 */
74typedef struct {
75 unsigned int is_root : 1; //!< Is root of a dictionary.
76
77 unsigned int is_unknown : 1; //!< This dictionary attribute is ephemeral
78 ///< and not part of the main dictionary.
79
80 unsigned int is_raw : 1; //!< This dictionary attribute was constructed
81 ///< from a known attribute to allow the user
82 ///< to assign octets values directly.
83 ///< See .is_unknown to determine if it is
84 ///< ephemeral.
85 unsigned int is_alias : 1; //!< This isn't a real attribute, it's a reference to
86 ///< to one.
87 unsigned int internal : 1; //!< Internal attribute, should not be received
88 ///< in protocol packets, should not be encoded.
89 unsigned int array : 1; //!< Pack multiples into 1 attr.
90
91 unsigned int is_known_width : 1; //!< is treated as if it has a known width for structs
92
93 unsigned int has_value : 1; //!< Has a value.
94
95 unsigned int is_unsigned : 1; //!< hackity hack for dates and time deltas
96
97 unsigned int counter : 1; //!< integer attribute is actually an impulse / counter
98
99 unsigned int name_only : 1; //!< this attribute should always be referred to by name.
100 ///< A number will be allocated, but the allocation scheme
101 ///< will depend on the parent, and definition type, and
102 ///< may not be stable in all instances.
103
104 unsigned int secret : 1; //!< this attribute should be omitted in debug mode
105
106 unsigned int unsafe : 1; //!< e.g. Cleartext-Password
107
108 /*
109 * @todo - if we want to clean these fields up, make
110 * "subtype" and "type_size" both 4-bit bitfields. That
111 * gives us an extra 8 bits for adding new flags, and we
112 * can likely get rid of "extra", in order to save one
113 * more bit.
114 */
115 unsigned int extra : 1; //!< really "subtype is used by dict, not by protocol"
116
117 unsigned int local : 1; //!< is a local variable
118
119 unsigned int has_fixup : 1;
120
121 /*
122 * main: extra is set, then this field is is key, bit, or a uint16 length field.
123 * radius: is one of 9 options for flags
124 * dhcp v4/v6: DNS label, or partial DNS label
125 */
126 uint8_t subtype; //!< protocol-specific values, OR key fields
127
128 /*
129 * Length in bytes for most attributes.
130 * Length in bits for da_is_bit_field(da)
131 */
132 uint8_t length; //!< length of the attribute
133
134 /*
135 * TLVs: 1, 2, or 4.
136 * date / time types: fr_time_res_t, which has 4 possible values.
137 * bit fields: offset in the byte where this bit field ends, which is only
138 * used as a caching mechanism during parsing of the dictionaries.
139 */
140 uint8_t type_size; //!< For TLV2 and root attributes.
142
143#define flag_time_res type_size
144#define flag_byte_offset type_size
145
146/** subtype values for the dictionary when extra=1
147 *
148 */
149enum {
150 FLAG_EXTRA_NONE = 0, //!< no extra meaning, should be invalid
151 FLAG_KEY_FIELD, //!< this is a key field for a subsequent struct
152 FLAG_BIT_FIELD, //!< bit field inside of a struct
153 FLAG_LENGTH_UINT8, //!< string / octets type is prefixed by uint8 of length
154 FLAG_LENGTH_UINT16, //!< string / octets type is prefixed by uint16 of length
155};
156
157#define fr_dict_attr_is_key_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_KEY_FIELD))
158#define da_is_bit_field(_da) ((_da)->flags.extra && ((_da)->flags.subtype == FLAG_BIT_FIELD))
159#define da_is_length_field(_da) ((_da)->flags.extra && (((_da)->flags.subtype == FLAG_LENGTH_UINT8) || ((_da)->flags.subtype == FLAG_LENGTH_UINT16)))
160#define da_length_offset(_da) ((_da)->flags.type_size)
161
162/** Extension identifier
163 *
164 * @note New extension structures should also be added to the to the appropriate table in dict_ext.c
165 */
166typedef enum {
167 FR_DICT_ATTR_EXT_NAME = 0, //!< Name of the attribute.
168 FR_DICT_ATTR_EXT_CHILDREN, //!< Attribute has children.
169 FR_DICT_ATTR_EXT_REF, //!< Attribute references another
170 ///< attribute and/or dictionary.
171 FR_DICT_ATTR_EXT_VENDOR, //!< Cached vendor pointer.
172 FR_DICT_ATTR_EXT_DA_STACK, //!< Cached da stack.
173 FR_DICT_ATTR_EXT_ENUMV, //!< Enumeration values.
174 FR_DICT_ATTR_EXT_NAMESPACE, //!< Attribute has its own namespace.
175 FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC, //!< Protocol specific extensions
178
179/** Dictionary attribute
180 */
182 fr_dict_t _CONST* _CONST dict; //!< Dict attribute belongs to.
183
184 char const *name; //!< Attribute name.
185 size_t name_len; //!< Length of the name.
186
187 unsigned int attr; //!< Attribute number.
188 unsigned int depth; //!< Depth of nesting for this attribute.
189
190 unsigned int last_child_attr; //!< highest value of last child attribute.
191
192 fr_type_t type; //!< Value type.
193
194 fr_dict_attr_t const *parent; //!< Immediate parent of this attribute.
195 fr_dict_attr_t const *next; //!< Next child in bin.
196
198
199 struct {
200 bool attr_set : 1; //!< Attribute number has been set.
201 //!< We need the full range of values 0-UINT32_MAX
202 ///< so we can't use any attr values to indicate
203 ///< "unsetness".
204
205 bool finalised : 1; //!< Attribute definition is complete and modifications
206 ///< that would change the address of the memory chunk
207 ///< of the attribute are no longer permitted.
209
210 char const *filename; //!< Where the attribute was defined.
211 ///< this buffer's lifetime is bound to the
212 ///< fr_dict_t.
213 int line; //!< Line number where the attribute was defined.
214
215 uint8_t ext[FR_DICT_ATTR_EXT_MAX]; //!< Extensions to the dictionary attribute.
216} CC_HINT(aligned(FR_EXT_ALIGNMENT));
217
218/** Extension identifier
219 *
220 * @note New extension structures should also be added to the appropriate table in dict_ext.c
221 */
222typedef enum {
223 FR_DICT_ENUM_EXT_UNION_REF = 0, //!< Reference to a union/subs-struct.
226
227/** Value of an enumerated attribute
228 *
229 * Maps one of more string values to integers and vice versa.
230 */
231typedef struct {
232 char const *name; //!< Enum name.
233 size_t name_len; //!< Allows for efficient name lookups when operating
234 ///< on partial buffers.
235 fr_value_box_t const *value; //!< Enum value (what name maps to).
236
237 uint8_t ext[FR_DICT_ENUM_EXT_MAX]; //!< Extensions to the dictionary attribute.
238
239 fr_dict_attr_t const *child_struct[]; //!< for key fields
240} fr_dict_enum_value_t CC_HINT(aligned(FR_EXT_ALIGNMENT));
241
242/** Private enterprise
243 *
244 * Represents an IANA private enterprise allocation.
245 *
246 * The width of the private enterprise number must be the same for all protocols
247 * so we can represent a vendor with a single struct.
248 */
249typedef struct {
250 uint32_t pen; //!< Private enterprise number.
251 bool continuation; //!< we only have one flag for now, for WiMAX
252 size_t type; //!< Length of type data
253 size_t length; //!< Length of length data
254 char const *name; //!< Vendor name.
256
257/** Specifies a value which must be present for the module to function
258 *
259 */
260typedef struct {
261 fr_value_box_t const **out; //!< Enumeration value.
262 fr_dict_attr_t const **attr; //!< The protocol dictionary the attribute should
263 ///< be resolved in. ** so it's a compile time
264 ///< constant.
265 char const *name; //!< of the attribute.
267
268/** Specifies an attribute which must be present for the module to function
269 *
270 */
271typedef struct {
272 fr_dict_attr_t const **out; //!< Where to write a pointer to the resolved
273 //!< #fr_dict_attr_t.
274 fr_dict_t const **dict; //!< The protocol dictionary the attribute should
275 ///< be resolved in. ** so it's a compile time
276 ///< constant.
277 char const *name; //!< of the attribute.
278 fr_type_t type; //!< of the attribute. Mismatch is a fatal error.
280
281/** Specifies a dictionary which must be loaded/loadable for the module to function
282 *
283 */
284typedef struct {
285 fr_dict_t const **out; //!< Where to write a pointer to the loaded/resolved
286 //!< #fr_dict_t.
287 char const *base_dir; //!< Directory structure beneath share.
288 char const *proto; //!< The protocol dictionary name.
290
291/** Errors returned by attribute lookup functions
292 *
293 */
294typedef enum {
295 FR_DICT_ATTR_OK = 0, //!< No error.
296 FR_DICT_ATTR_NOTFOUND = -1, //!< Attribute couldn't be found.
297 FR_DICT_ATTR_PROTOCOL_NOTFOUND = -2, //!< Protocol couldn't be found.
298 FR_DICT_ATTR_PARSE_ERROR = -3, //!< Attribute string couldn't be parsed
299 FR_DICT_ATTR_INTERNAL_ERROR = -4, //!< Internal error occurred.
300 FR_DICT_ATTR_OOM = -5, //!< Memory allocation error.
301 FR_DICT_ATTR_NOT_DESCENDENT = -6, //!< Attribute is not a descendent of the parent
302 ///< attribute.
303 FR_DICT_ATTR_NOT_ANCESTOR = -7, //!< Attribute is not an ancestor of the child
304 ///< attribute.
305 FR_DICT_ATTR_NO_CHILDREN = -8, //!< Child lookup in attribute with no children.
306 FR_DICT_ATTR_EINVAL = -9 //!< Invalid arguments.
307
309
312
313/*
314 * Forward declarations to avoid circular references.
315 */
317typedef struct fr_dbuff_s fr_dbuff_t;
318
319/** A generic interface for decoding packets to fr_pair_ts
320 *
321 * A decoding function should decode a single top level packet from wire format.
322 *
323 * Note that unlike #fr_tp_proto_decode_t, this function is NOT passed an encode_ctx. That is because when we
324 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
325 *
326 * @param[in] ctx to allocate new pairs in.
327 * @param[in] vps where new VPs will be added
328 * @param[in] data to decode.
329 * @param[in] data_len The length of the incoming data.
330 * @return
331 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
332 * - > 0 on success. How many bytes were decoded.
333 */
334typedef ssize_t (*fr_dict_attr_decode_func_t)(TALLOC_CTX *ctx, fr_pair_list_t *vps,
335 uint8_t const *data, size_t data_len);
336
337/** A generic interface for encoding fr_pair_ts to packets
338 *
339 * An encoding function should encode multiple VPs to a wire format packet
340 *
341 * Note that unlike #fr_tp_proto_encode_t, this function is NOT passed an encode_ctx. That is because when we
342 * do cross-protocol encoding, the "outer" protocol has no information it can share with the "inner" protocol.
343 *
344 * @param[in] vps vps to encode
345 * @param[in] dbuff buffer where data can be written
346 * @return
347 * - <= 0 on error. May be the offset (as a negative value) where the error occurred.
348 * - > 0 on success. How many bytes were encoded
349 */
351
352/** Init / free callbacks
353 *
354 * Only for "autoref" usage.
355 */
356typedef int (*fr_dict_protocol_init_t)(void);
357typedef void (*fr_dict_protocol_free_t)(void);
358
360
361/** Custom protocol-specific flag parsing function
362 *
363 * @note This function should be used to implement table based flag parsing.
364 *
365 * @param[in] da_p we're currently populating
366 * @param[in] value flag value to parse.
367 * @param[in] rule How to parse the flag.
368 */
370
372 fr_dict_flag_parse_func_t func; //!< Custom parsing function to convert a flag value string to a C type value.
373 void *uctx; //!< Use context to pass to the custom parsing function.
374 bool needs_value; //!< This parsing flag must have a value. Else we error.
375};
376
377/** Copy custom flags from one attribute to another
378 *
379 * @param[out] da_to attribute to copy to. Use for the talloc_ctx for any heap allocated flag values.
380 * @param[out] flags_to protocol specific flags struct to copy to.
381 * @param[in] flags_from protocol specific flags struct to copy from.
382 * @return
383 * - 0 on success.
384 * - -1 on error.
385 */
386typedef int (*fr_dict_flags_copy_func_t)(fr_dict_attr_t *da_to, void *flags_to, void *flags_from);
387
388/** Compare the protocol specific flags struct from two attributes
389 *
390 * @param[in] da_a first attribute to compare.
391 * @param[in] da_b second attribute to compare.
392 * @return
393 * - 0 if the flags are equal.
394 * - < 0 if da_a < da_b.
395 * - > 0 if da_a > da_b.
396 */
397 typedef int (*fr_dict_flags_cmp_func_t)(fr_dict_attr_t const *da_a, fr_dict_attr_t const *da_b);
398
399/** Protocol specific custom flag definitnion
400 *
401 */
402typedef struct {
403 fr_table_elem_name_t name; //!< Name of the flag
404 fr_dict_flag_parser_rule_t value; //!< Function and context to parse the flag.
406
407/** Define a flag setting function, which sets one bit in a fr_dict_attr_flags_t
408 *
409 * This is here, because AFAIK there's no completely portable way to get the bit
410 * offset of a bit field in a structure.
411 */
412#define FR_DICT_ATTR_FLAG_FUNC(_struct, _name) \
413static int dict_flag_##_name(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)\
414{ \
415 _struct *flags = fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC); \
416 flags->_name = 1; \
417 return 0; \
418}
419
420/** conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
421 *
422 * @param[in] _struct containing the field to write the result to.
423 * @param[in] _field to write the flag to
424 */
425# define FR_DICT_PROTOCOL_FLAG(_struct, _field) \
426 .type = FR_CTYPE_TO_TYPE((((_struct *)NULL)->_field)), \
427 .offset = offsetof(_struct, _field)
428
429/** Protocol-specific callbacks in libfreeradius-PROTOCOL
430 *
431 */
432typedef struct {
433 char const *name; //!< name of this protocol
434
435 int default_type_size; //!< how many octets are in "type" field
436 int default_type_length; //!< how many octets are in "length" field
437
438 struct {
439 /** Custom flags for this protocol
440 */
441 struct {
442 fr_dict_flag_parser_t const *table; //!< Flags for this protocol, an array of fr_dict_flag_parser_t
443 size_t table_len; //!< Length of protocol_flags table.
444
445 size_t len; //!< Length of the protocol specific flags structure.
446 ///< This is used to allocate a FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
447 ///< extension of the specified length.
448
449 fr_dict_flags_copy_func_t copy; //!< Copy protocol-specific flags from one attribute to another.
450 ///< Called when copying attributes.
451
452 fr_dict_flags_cmp_func_t cmp; //!< Compare protocol-specific flags from two attributes.
453 ///< Called when comparing attributes by their fields.
454 } flags;
455
456 fr_dict_attr_type_parse_t type_parse; //!< parse unknown type names
457 fr_dict_attr_valid_func_t valid; //!< Validation function to ensure that
458 ///< new attributes are valid.
459 } attr;
460
461 fr_dict_protocol_init_t init; //!< initialize the library
462 fr_dict_protocol_free_t free; //!< free the library
463
464 fr_dict_attr_decode_func_t decode; //!< for decoding attributes. Used for implementing foreign
465 ///< protocol attributes.
466 fr_dict_attr_encode_func_t encode; //!< for encoding attributes. Used for implementing foreign
467 ///< protocol attributes.
469
471
472/*
473 * Dictionary constants
474 */
475#define FR_DICT_PROTO_MAX_NAME_LEN (128) //!< Maximum length of a protocol name.
476#define FR_DICT_ENUM_MAX_NAME_LEN (128) //!< Maximum length of a enum value.
477#define FR_DICT_VENDOR_MAX_NAME_LEN (128) //!< Maximum length of a vendor name.
478#define FR_DICT_ATTR_MAX_NAME_LEN (128) //!< Maximum length of a attribute name.
479
480/** Maximum level of TLV nesting allowed
481 */
482#define FR_DICT_TLV_NEST_MAX (24)
483
484/** Maximum level of da stack caching
485 */
486#define FR_DICT_DA_STACK_CACHE_MAX (5)
487
488/** Maximum TLV stack size
489 *
490 * The additional attributes are to account for
491 *
492 * Root + Vendor + NULL (top frame).
493 * Root + Embedded protocol + Root + Vendor + NULL.
494 *
495 * Code should ensure that it doesn't run off the end of the stack,
496 * as this could be remotely exploitable, using odd nesting.
497 */
498#define FR_DICT_MAX_TLV_STACK (FR_DICT_TLV_NEST_MAX + 5)
499
500/** Characters that are allowed in dictionary attribute names
501 *
502 */
503extern bool const fr_dict_attr_allowed_chars[UINT8_MAX + 1];
504
505/** Characters that are allowed in dictionary enumeration value names
506 *
507 */
508extern bool const fr_dict_enum_allowed_chars[UINT8_MAX + 1];
509
510/** @name Dictionary structure extensions
511 *
512 * @{
513 */
514#include <freeradius-devel/util/dict_ext.h>
515/** @} */
516
517/** @name Programmatically create dictionary attributes and values
518 *
519 * @{
520 */
522
523int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr,
524 fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
525
527 char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags) CC_HINT(nonnull(1,2,3));
528
529int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name,
530 fr_value_box_t const *value, bool coerce, bool replace);
531
532int fr_dict_enum_add_name_next(fr_dict_attr_t *da, char const *name) CC_HINT(nonnull);
533
534int fr_dict_str_to_argv(char *str, char **argv, int max_argc);
535
536int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src) CC_HINT(nonnull);
537
539/** @} */
540
541/** @name Dict accessors
542 *
543 * @{
544 */
546/** @} */
547
548/** @name Unknown ephemeral attributes
549 *
550 * @{
551 */
553
555
556fr_dict_attr_t *fr_dict_attr_unknown_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da) CC_HINT(nonnull(2));
557
558static inline fr_dict_attr_t *fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
559{
560 fr_assert(da->flags.is_unknown);
561
562 return fr_dict_attr_unknown_afrom_da(ctx, da);
563}
564
566 fr_dict_attr_t const *parent,
567 unsigned int num, fr_type_t type, bool raw)
568 CC_HINT(nonnull(2));
569
570static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_typed_afrom_num(TALLOC_CTX *ctx,
571 fr_dict_attr_t const *parent,
572 unsigned int num, fr_type_t type)
573{
574 return fr_dict_attr_unknown_typed_afrom_num_raw(ctx, parent, num, type, false);
575}
576
577
578static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_vendor_afrom_num(TALLOC_CTX *ctx,
579 fr_dict_attr_t const *parent,
580 unsigned int vendor)
581{
583}
584
585static inline CC_HINT(nonnull(2)) fr_dict_attr_t *fr_dict_attr_unknown_raw_afrom_num(TALLOC_CTX *ctx,
586 fr_dict_attr_t const *parent,
587 unsigned int attr)
588{
590}
591
593 CC_HINT(nonnull(2));
594
595
597 fr_dict_attr_t const **out,
598 fr_dict_attr_t const *parent,
600 CC_HINT(nonnull(2,3,4));
601
603
605/** @} */
606
607/** @name Attribute comparisons
608 *
609 * @{
610 */
611static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
612{
613 int8_t ret;
614
615 /*
616 * Comparing unknowns or raws is expensive
617 * because we need to check the lineage.
618 */
619 if (a->flags.is_unknown | a->flags.is_raw | b->flags.is_unknown | b->flags.is_raw) {
620 ret = CMP(a->depth, b->depth);
621 if (ret != 0) return ret;
622
623 ret = CMP(a->attr, b->attr);
624 if (ret != 0) return ret;
625
626 ret = (a->parent == NULL) - (b->parent == NULL);
627 if ((ret != 0) || !a->parent) return ret;
628
629 return fr_dict_attr_cmp(a->parent, b->parent);
630 }
631
632 /*
633 * Comparing knowns is cheap because the
634 * DAs are unique.
635 */
636 return CMP(a, b);
637}
638
639/** Compare two dictionary attributes by their contents
640 *
641 * @param[in] a First attribute to compare.
642 * @param[in] b Second attribute to compare.
643 * @return
644 * - 0 if the attributes are equal.
645 * - -1 if a < b.
646 * - +1 if a > b.
647 */
648static inline CC_HINT(nonnull) int8_t fr_dict_attr_cmp_fields(const fr_dict_attr_t *a, const fr_dict_attr_t *b)
649{
650 int8_t ret;
651 fr_dict_protocol_t const *a_proto = fr_dict_protocol(a->dict);
652
653 /*
654 * Technically this isn't a property of the attribute
655 * but we need them to be the same to be able to
656 * compare protocol specific flags successfully.
657 */
658 ret = CMP(a_proto, fr_dict_protocol(b->dict));
659 if (ret != 0) return ret;
660
661 ret = CMP(a->attr, b->attr);
662 if (ret != 0) return ret;
663
664 ret = CMP(a->parent, b->parent);
665 if (ret != 0) return ret;
666
668 if (ret != 0) return ret;
669
670 /*
671 * Compare protocol specific flags
672 */
673 if (a_proto->attr.flags.cmp && (ret = a_proto->attr.flags.cmp(a, b))) return ret;
674
675 return CMP(memcmp(&a->flags, &b->flags, sizeof(a->flags)), 0);
676}
677/** @} */
678
679/** @name Debugging functions
680 *
681 * @{
682 */
683void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da);
684
685void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da);
686
687void fr_dict_debug(FILE *fp, fr_dict_t const *dict);
688
689void fr_dict_export(FILE *fp, fr_dict_t const *dict);
690
691void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent);
692/** @} */
693
694/** @name Attribute lineage
695 *
696 * @{
697 */
698fr_dict_attr_t const *fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor);
699
700int fr_dict_oid_component_legacy(unsigned int *out, char const **oid);
701
703 fr_type_t type, fr_dict_attr_flags_t const *flags);
704
706 fr_dict_attr_t const *ancestor, fr_dict_attr_t const *da, bool numeric);
707#define FR_DICT_ATTR_OID_PRINT_RETURN(...) FR_SBUFF_RETURN(fr_dict_attr_oid_print, ##__VA_ARGS__)
708
710 unsigned int *attr, char const *oid) CC_HINT(nonnull);
711
713 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
714 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
715 CC_HINT(nonnull(2,3,4));
716
718 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
719 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
720 CC_HINT(nonnull(2,3,4));
721
723 fr_dict_attr_t const *parent, char const *oid)
724 CC_HINT(nonnull(2,3));
725
726bool fr_dict_attr_can_contain(fr_dict_attr_t const *parent, fr_dict_attr_t const *child) CC_HINT(nonnull);
727
728/** @} */
729
730/** @name Attribute, vendor and dictionary lookup
731 *
732 * @{
733 */
734
735/** @hidecallergraph */
736fr_dict_attr_t const *fr_dict_root(fr_dict_t const *dict) CC_HINT(nonnull);
737
738bool fr_dict_is_read_only(fr_dict_t const *dict);
739
740dl_t *fr_dict_dl(fr_dict_t const *dict);
741
743 fr_dict_t const **out, fr_sbuff_t *name, fr_dict_t const *dict_def);
744
745fr_dict_t const *fr_dict_by_protocol_name(char const *name);
746
747fr_dict_t const *fr_dict_by_protocol_num(unsigned int num);
748
749fr_dict_attr_t const *fr_dict_unlocal(fr_dict_attr_t const *da) CC_HINT(nonnull);
750
751fr_dict_t const *fr_dict_by_da(fr_dict_attr_t const *da) CC_HINT(nonnull);
752
753fr_dict_t const *fr_dict_by_attr_name(fr_dict_attr_t const **found, char const *name);
754
755bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2) CC_HINT(nonnull);
756
757/** Return true if this attribute is parented directly off the dictionary root
758 *
759 * @param[in] da to check.
760 * @return
761 * - true if attribute is top level.
762 * - false if attribute is not top level.
763 */
764static inline bool fr_dict_attr_is_top_level(fr_dict_attr_t const *da)
765{
766 if (unlikely(!da) || unlikely(!da->parent)) return false;
767 return da->parent->flags.is_root;
768}
769
771
772fr_dict_vendor_t const *fr_dict_vendor_by_name(fr_dict_t const *dict, char const *name);
773
774fr_dict_vendor_t const *fr_dict_vendor_by_num(fr_dict_t const *dict, uint32_t vendor_pen);
775
776fr_dict_attr_t const *fr_dict_vendor_da_by_num(fr_dict_attr_t const *vendor_root, uint32_t vendor_pen);
777
779 fr_dict_t const *dict_def,
780 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
781 bool internal, bool foreign)
782 CC_HINT(nonnull(2, 4));
783
785 fr_dict_t const *dict_def,
786 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
787 bool internal, bool foreign)
788 CC_HINT(nonnull(2, 4));
789
791 fr_dict_t const *dict_def,
792 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
793 bool internal, bool foreign)
794 CC_HINT(nonnull(2, 4));
795
797 fr_dict_t const *dict_def, char const *attr,
798 bool internal, bool foreign)
799 CC_HINT(nonnull(3));
800
802 fr_dict_t const *dict_def,
803 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
804 bool internal, bool foreign)
805 CC_HINT(nonnull(2, 4));
806
808 fr_dict_attr_t const *parent,
809 fr_sbuff_t *name, fr_sbuff_term_t const *tt)
810 CC_HINT(nonnull(2,3,4));
811
813 char const *attr)
814 CC_HINT(nonnull(2,3));
815
816fr_dict_attr_t const *fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr);
817
819
821
823
825
827 fr_sbuff_t *in, fr_sbuff_term_t const *tt);
828
830 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
832/** @} */
833
834/** @name Dictionary and protocol loading
835 *
836 * @{
837 */
838int fr_dict_internal_afrom_file(fr_dict_t **out, char const *internal_name,
839 char const *dependent);
840
841int fr_dict_protocol_afrom_file(fr_dict_t **out, char const *proto_name, char const *proto_dir,
842 char const *dependent);
843
845
846int fr_dict_read(fr_dict_t *dict, char const *dict_dir, char const *filename);
847/** @} */
848
849/** @name Autoloader interface
850 *
851 * @{
852 */
854
856
857#define fr_dict_autoload(_to_load) _fr_dict_autoload(_to_load, __FILE__)
858int _fr_dict_autoload(fr_dict_autoload_t const *to_load, char const *dependent);
859
860#define fr_dict_autofree(_to_free) _fr_dict_autofree(_to_free, __FILE__)
861int _fr_dict_autofree(fr_dict_autoload_t const *to_free, char const *dependent);
862
863#define fr_dict_autoload_talloc(_ctx, _dict_out, _proto) _fr_dict_autoload_talloc(_ctx, _dict_out, _proto, __FILE__)
864fr_dict_autoload_talloc_t *_fr_dict_autoload_talloc(TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent);
865
866int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx);
867
868int fr_dl_dict_attr_autoload(dl_t const *module, void *symbol, void *user_ctx);
869
870int fr_dl_dict_autoload(dl_t const *module, void *symbol, void *user_ctx);
871
872void fr_dl_dict_autofree(dl_t const *module, void *symbol, void *user_ctx);
873/** @} */
874
875/** @name Allocating and freeing
876 *
877 * @{
878 */
879fr_dict_t *fr_dict_alloc(char const *proto_name, unsigned int proto_number) CC_HINT(nonnull);
880
881int fr_dict_dependent_add(fr_dict_t const *dict, char const *dependent) CC_HINT(nonnull);
882
883int fr_dict_free(fr_dict_t **dict, char const *dependent) CC_HINT(nonnull);
884
885int fr_dict_const_free(fr_dict_t const **dict, char const *dependent) CC_HINT(nonnull);
886/** @} */
887
888/** @name Global dictionary management
889 *
890 * @{
891 */
892fr_dict_gctx_t *fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir);
893
894void fr_dict_global_ctx_perm_check(fr_dict_gctx_t *gctx, bool enable);
895
896void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx);
897
899
900int fr_dict_global_ctx_dir_set(char const *dict_dir);
901
903
905
906char const *fr_dict_global_ctx_dir(void);
907
909
911
913
915
917
918fr_dict_t const *fr_dict_internal(void);
919
920/** @} */
921
922/** @name Dictionary testing and validation
923 *
924 * @{
925 */
927
928int fr_dict_parse_str(fr_dict_t *dict, char *buf,
929 fr_dict_attr_t const *parent);
930
931ssize_t fr_dict_valid_name(char const *name, ssize_t len);
932
933ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len);
934
936
937typedef int (*fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx);
938
939int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx);
940
941void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da);
942/** @} */
943
944#undef _CONST
945
946#ifdef __cplusplus
947}
948#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:403
fr_dict_t * fr_dict_global_ctx_iter_next(fr_dict_global_ctx_iter_t *iter)
Definition dict_util.c:4581
bool continuation
we only have one flag for now, for WiMAX
Definition dict.h:251
size_t type
Length of type data.
Definition dict.h:252
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:4537
fr_dict_protocol_free_t free
free the library
Definition dict.h:462
void fr_dict_namespace_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:231
fr_dict_enum_value_t * 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:3356
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:4399
size_t name_len
Allows for efficient name lookups when operating on partial buffers.
Definition dict.h:233
fr_dict_attr_flags_t flags
Flags.
Definition dict.h:197
fr_dict_attr_decode_func_t decode
for decoding attributes.
Definition dict.h:464
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:369
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:1597
char const * name
of the attribute.
Definition dict.h:277
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:99
ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len)
Definition dict_util.c:4670
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:4490
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:3522
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:1948
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:3088
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:93
fr_dict_enum_ext_t
Extension identifier.
Definition dict.h:222
@ FR_DICT_ENUM_EXT_MAX
Definition dict.h:224
@ FR_DICT_ENUM_EXT_UNION_REF
Reference to a union/subs-struct.
Definition dict.h:223
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:1745
char const * name
Vendor name.
Definition dict.h:254
char const * filename
Where the attribute was defined.
Definition dict.h:210
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4592
void * uctx
Use context to pass to the custom parsing function.
Definition dict.h:373
fr_dict_attr_t const ** attr
The protocol dictionary the attribute should be resolved in.
Definition dict.h:262
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:2613
unsigned int is_root
Is root of a dictionary.
Definition dict.h:75
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:4058
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:4179
int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
Definition dict_util.c:4784
fr_dict_attr_t const * fr_dict_unlocal(fr_dict_attr_t const *da)
Definition dict_util.c:4963
struct dict_attr_s::@121 state
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:2044
size_t name_len
Length of the name.
Definition dict.h:185
int line
Line number where the attribute was defined.
Definition dict.h:213
bool(* fr_dict_attr_valid_func_t)(fr_dict_attr_t *da)
Definition dict.h:310
int fr_dl_dict_enum_autoload(dl_t const *module, void *symbol, void *user_ctx)
static fr_slen_t err
Definition dict.h:831
fr_dict_t * fr_dict_alloc(char const *proto_name, unsigned int proto_number)
unsigned int has_fixup
Definition dict.h:119
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:578
void fr_dict_alias_export(FILE *fp, fr_dict_attr_t const *parent)
Definition dict_print.c:313
bool const fr_dict_attr_allowed_chars[UINT8_MAX+1]
Characters that are allowed in dictionary attribute names.
Definition dict_util.c:51
static fr_dict_attr_t * fr_dict_attr_unknown_copy(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Definition dict.h:558
int fr_dict_attr_set_group(fr_dict_attr_t **da_p)
Definition dict_util.c:4976
fr_dict_protocol_t const * fr_dict_protocol(fr_dict_t const *dict)
Return the protocol descriptor for the dictionary.
Definition dict_util.c:4955
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:350
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:1076
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:3270
struct fr_dict_protocol_t::@122 attr
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:4230
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:2626
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:397
void fr_dict_debug(FILE *fp, fr_dict_t const *dict)
Definition dict_print.c:267
fr_value_box_t const ** out
Enumeration value.
Definition dict.h:261
fr_dict_attr_t * fr_dict_attr_unconst(fr_dict_attr_t const *da)
Coerce to non-const.
Definition dict_util.c:4604
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:274
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:2331
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:585
void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da)
Definition dict_util.c:4790
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:4882
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:4574
int(* fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx)
Definition dict.h:937
unsigned int array
Pack multiples into 1 attr.
Definition dict.h:89
unsigned int secret
this attribute should be omitted in debug mode
Definition dict.h:104
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2407
fr_dict_flag_parse_func_t func
Custom parsing function to convert a flag value string to a C type value.
Definition dict.h:372
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:2702
unsigned int extra
really "subtype is used by dict, not by protocol"
Definition dict.h:115
unsigned int internal
Internal attribute, should not be received in protocol packets, should not be encoded.
Definition dict.h:87
fr_dict_attr_t const ** out
Where to write a pointer to the resolved fr_dict_attr_t.
Definition dict.h:272
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:285
void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx)
Set a new, active, global dictionary context.
Definition dict_util.c:4460
fr_dict_attr_t const * next
Next child in bin.
Definition dict.h:195
fr_dict_t _CONST *_CONST dict
Dict attribute belongs to.
Definition dict.h:182
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:3069
char const * name
Attribute name.
Definition dict.h:184
unsigned int unsafe
e.g. Cleartext-Password
Definition dict.h:106
fr_dict_protocol_init_t init
initialize the library
Definition dict.h:461
unsigned int is_raw
This dictionary attribute was constructed from a known attribute to allow the user to assign octets v...
Definition dict.h:80
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:2132
bool const fr_dict_enum_allowed_chars[UINT8_MAX+1]
Characters that are allowed in dictionary enumeration value names.
Definition dict_util.c:72
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:265
dl_t * fr_dict_dl(fr_dict_t const *dict)
Definition dict_util.c:2417
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:235
void fr_dict_attr_debug(FILE *fp, fr_dict_attr_t const *da)
Definition dict_print.c:255
unsigned int attr
Attribute number.
Definition dict.h:187
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:3389
fr_dict_enum_value_t * fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len)
Definition dict_util.c:3402
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:1960
uint8_t ext[FR_DICT_ATTR_EXT_MAX]
Extensions to the dictionary attribute.
Definition dict.h:215
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:386
int default_type_size
how many octets are in "type" field
Definition dict.h:435
uint32_t pen
Private enterprise number.
Definition dict.h:250
int fr_dict_free(fr_dict_t **dict, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4031
void fr_dict_attr_unknown_free(fr_dict_attr_t const **da)
Free dynamically allocated (unknown attributes)
fr_type_t type
of the attribute. Mismatch is a fatal error.
Definition dict.h:278
fr_dict_flag_parser_rule_t value
Function and context to parse the flag.
Definition dict.h:404
#define _CONST
Definition dict.h:58
int fr_dict_oid_component_legacy(unsigned int *out, char const **oid)
Process a single OID component.
Definition dict_util.c:2087
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:3428
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:4451
void fr_dict_global_ctx_read_only(void)
Mark all dictionaries and the global dictionary ctx as read only.
Definition dict_util.c:4510
uint8_t type_size
For TLV2 and root attributes.
Definition dict.h:140
unsigned int depth
Depth of nesting for this attribute.
Definition dict.h:188
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:4015
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:4097
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4617
bool(* fr_dict_attr_type_parse_t)(fr_type_t *type, fr_dict_attr_t **da_p, char const *name)
Definition dict.h:311
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:2504
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:3698
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:2982
size_t length
Length of length data.
Definition dict.h:253
fr_dict_t const * fr_dict_by_protocol_name(char const *name)
Lookup a protocol by its name.
Definition dict_util.c:2584
bool fr_dict_is_read_only(fr_dict_t const *dict)
Definition dict_util.c:2412
char const * base_dir
Directory structure beneath share.
Definition dict.h:287
fr_dict_attr_t const * parent
Immediate parent of this attribute.
Definition dict.h:194
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:3011
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:764
void(* fr_dict_protocol_free_t)(void)
Definition dict.h:357
fr_dict_attr_encode_func_t encode
for encoding attributes.
Definition dict.h:466
char const * fr_dict_global_ctx_dir(void)
Definition dict_util.c:4501
unsigned int local
is a local variable
Definition dict.h:117
fr_dict_attr_ext_t
Extension identifier.
Definition dict.h:166
@ FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
Protocol specific extensions.
Definition dict.h:175
@ FR_DICT_ATTR_EXT_MAX
Definition dict.h:176
@ FR_DICT_ATTR_EXT_ENUMV
Enumeration values.
Definition dict.h:173
@ FR_DICT_ATTR_EXT_NAMESPACE
Attribute has its own namespace.
Definition dict.h:174
@ FR_DICT_ATTR_EXT_DA_STACK
Cached da stack.
Definition dict.h:172
@ FR_DICT_ATTR_EXT_REF
Attribute references another attribute and/or dictionary.
Definition dict.h:169
@ FR_DICT_ATTR_EXT_VENDOR
Cached vendor pointer.
Definition dict.h:171
@ FR_DICT_ATTR_EXT_NAME
Name of the attribute.
Definition dict.h:167
@ FR_DICT_ATTR_EXT_CHILDREN
Attribute has children.
Definition dict.h:168
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:190
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:4476
unsigned int is_known_width
is treated as if it has a known width for structs
Definition dict.h:91
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:436
fr_dict_attr_err_t
Errors returned by attribute lookup functions.
Definition dict.h:294
@ FR_DICT_ATTR_OK
No error.
Definition dict.h:295
@ FR_DICT_ATTR_NOT_ANCESTOR
Attribute is not an ancestor of the child attribute.
Definition dict.h:303
@ FR_DICT_ATTR_NOT_DESCENDENT
Attribute is not a descendent of the parent attribute.
Definition dict.h:301
@ FR_DICT_ATTR_NOTFOUND
Attribute couldn't be found.
Definition dict.h:296
@ FR_DICT_ATTR_EINVAL
Invalid arguments.
Definition dict.h:306
@ FR_DICT_ATTR_PROTOCOL_NOTFOUND
Protocol couldn't be found.
Definition dict.h:297
@ FR_DICT_ATTR_NO_CHILDREN
Child lookup in attribute with no children.
Definition dict.h:305
@ FR_DICT_ATTR_OOM
Memory allocation error.
Definition dict.h:300
@ FR_DICT_ATTR_PARSE_ERROR
Attribute string couldn't be parsed.
Definition dict.h:298
@ FR_DICT_ATTR_INTERNAL_ERROR
Internal error occurred.
Definition dict.h:299
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:3040
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:2664
int(* fr_dict_protocol_init_t)(void)
Init / free callbacks.
Definition dict.h:356
bool needs_value
This parsing flag must have a value. Else we error.
Definition dict.h:374
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:4703
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:1719
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:2380
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:4146
unsigned int is_unsigned
hackity hack for dates and time deltas
Definition dict.h:95
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:570
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:2687
int fr_dl_dict_autoload(dl_t const *module, void *symbol, void *user_ctx)
ssize_t fr_dict_valid_name(char const *name, ssize_t len)
Definition dict_util.c:4627
fr_dict_t * fr_dict_protocol_alloc(fr_dict_t const *parent)
Allocate a new local dictionary.
Definition dict_util.c:3968
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:2236
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:334
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:3335
char const * proto
The protocol dictionary name.
Definition dict.h:288
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.
char const * name
Enum name.
Definition dict.h:232
@ FLAG_EXTRA_NONE
no extra meaning, should be invalid
Definition dict.h:150
@ FLAG_LENGTH_UINT8
string / octets type is prefixed by uint8 of length
Definition dict.h:153
@ FLAG_LENGTH_UINT16
string / octets type is prefixed by uint16 of length
Definition dict.h:154
@ FLAG_KEY_FIELD
this is a key field for a subsequent struct
Definition dict.h:151
@ FLAG_BIT_FIELD
bit field inside of a struct
Definition dict.h:152
static fr_slen_t in
Definition dict.h:831
fr_type_t type
Value type.
Definition dict.h:192
char const * name
name of this protocol
Definition dict.h:433
fr_dict_t const * fr_dict_by_protocol_num(unsigned int num)
Lookup a protocol by its number.
Definition dict_util.c:2597
uint8_t subtype
protocol-specific values, OR key fields
Definition dict.h:126
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:648
uint8_t length
length of the attribute
Definition dict.h:132
unsigned int is_alias
This isn't a real attribute, it's a reference to to one.
Definition dict.h:85
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:2642
unsigned int counter
integer attribute is actually an impulse / counter
Definition dict.h:97
unsigned int is_unknown
This dictionary attribute is ephemeral and not part of the main dictionary.
Definition dict.h:77
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:308
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:611
Dictionary attribute.
Definition dict.h:181
Specifies an attribute which must be present for the module to function.
Definition dict.h:271
Values of the encryption flags.
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:284
Specifies a value which must be present for the module to function.
Definition dict.h:260
Value of an enumerated attribute.
Definition dict.h:231
Protocol specific custom flag definitnion.
Definition dict.h:402
Protocol-specific callbacks in libfreeradius-PROTOCOL.
Definition dict.h:432
Private enterprise.
Definition dict.h:249
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:4203
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:845
static fr_slen_t data
Definition value.h:1274
int nonnull(2, 5))
static size_t char ** out
Definition value.h:1012
Union containing all data types supported by the server.
Definition value.h:181