The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
dict_util.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/** Multi-protocol AVP dictionary API
18 *
19 * @file src/lib/util/dict_util.c
20 *
21 * @copyright 2000,2006 The FreeRADIUS server project
22 * @copyright 2024 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
23 */
24RCSID("$Id: beb948d22d8f1c7e1d30dc6cf253bb4a3880177a $")
25
26#define _DICT_PRIVATE 1
27
28#include <freeradius-devel/util/atexit.h>
29#include <freeradius-devel/util/conf.h>
30#include <freeradius-devel/util/dict.h>
31#include <freeradius-devel/util/dict_ext_priv.h>
32#include <freeradius-devel/util/dict_fixup_priv.h>
33#include <freeradius-devel/util/hash.h>
34#include <freeradius-devel/util/proto.h>
35#include <freeradius-devel/util/rand.h>
36#include <freeradius-devel/util/syserror.h>
37
38#ifdef HAVE_SYS_STAT_H
39# include <sys/stat.h>
40#endif
41
42fr_dict_gctx_t *dict_gctx = NULL; //!< Top level structure containing global dictionary state.
43
44#define DICT_ATTR_ALLOWED_CHARS \
45 ['-'] = true, ['/'] = true, ['_'] = true, \
46 ['0'] = true, ['1'] = true, ['2'] = true, ['3'] = true, ['4'] = true, \
47 ['5'] = true, ['6'] = true, ['7'] = true, ['8'] = true, ['9'] = true, \
48 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true, \
49 ['F'] = true, ['G'] = true, ['H'] = true, ['I'] = true, ['J'] = true, \
50 ['K'] = true, ['L'] = true, ['M'] = true, ['N'] = true, ['O'] = true, \
51 ['P'] = true, ['Q'] = true, ['R'] = true, ['S'] = true, ['T'] = true, \
52 ['U'] = true, ['V'] = true, ['W'] = true, ['X'] = true, ['Y'] = true, \
53 ['Z'] = true, \
54 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true, \
55 ['f'] = true, ['g'] = true, ['h'] = true, ['i'] = true, ['j'] = true, \
56 ['k'] = true, ['l'] = true, ['m'] = true, ['n'] = true, ['o'] = true, \
57 ['p'] = true, ['q'] = true, ['r'] = true, ['s'] = true, ['t'] = true, \
58 ['u'] = true, ['v'] = true, ['w'] = true, ['x'] = true, ['y'] = true, \
59 ['z'] = true
60
61/** Characters allowed in a single dictionary attribute name
62 *
63 */
67
68/** Characters allowed in a nested dictionary attribute name
69 *
70 */
71bool const fr_dict_attr_nested_allowed_chars[UINT8_MAX + 1] = {
72 DICT_ATTR_ALLOWED_CHARS,
73 [ '.' ] = true
74};
75
76/** Characters allowed in enumeration value names
77 *
78 */
79bool const fr_dict_enum_allowed_chars[UINT8_MAX + 1] = {
80 ['+'] = true, ['-'] = true, ['.'] = true, ['/'] = true, ['_'] = true,
81 ['0'] = true, ['1'] = true, ['2'] = true, ['3'] = true, ['4'] = true,
82 ['5'] = true, ['6'] = true, ['7'] = true, ['8'] = true, ['9'] = true,
83 ['A'] = true, ['B'] = true, ['C'] = true, ['D'] = true, ['E'] = true,
84 ['F'] = true, ['G'] = true, ['H'] = true, ['I'] = true, ['J'] = true,
85 ['K'] = true, ['L'] = true, ['M'] = true, ['N'] = true, ['O'] = true,
86 ['P'] = true, ['Q'] = true, ['R'] = true, ['S'] = true, ['T'] = true,
87 ['U'] = true, ['V'] = true, ['W'] = true, ['X'] = true, ['Y'] = true,
88 ['Z'] = true,
89 ['a'] = true, ['b'] = true, ['c'] = true, ['d'] = true, ['e'] = true,
90 ['f'] = true, ['g'] = true, ['h'] = true, ['i'] = true, ['j'] = true,
91 ['k'] = true, ['l'] = true, ['m'] = true, ['n'] = true, ['o'] = true,
92 ['p'] = true, ['q'] = true, ['r'] = true, ['s'] = true, ['t'] = true,
93 ['u'] = true, ['v'] = true, ['w'] = true, ['x'] = true, ['y'] = true,
94 ['z'] = true
95};
96
97/** Default protocol rules set for every dictionary
98 *
99 * This is usually overriden by the public symbol from the protocol library
100 * associated with the dictionary
101 * e.g. libfreeradius-dhcpv6.so -> libfreeradius_dhcpv6_dict_protocol.
102 */
103static fr_dict_protocol_t dict_proto_default = {
104 .name = "default",
105 .default_type_size = 2,
106 .default_type_length = 2,
107};
108
109/*
110 * Create the hash of the name.
111 *
112 * We copy the hash function here because it's substantially faster.
113 */
114#define FNV_MAGIC_INIT (0x811c9dc5)
115#define FNV_MAGIC_PRIME (0x01000193)
116
117static void hash_pool_free(void *to_free)
118{
119 talloc_free(to_free);
120}
121
122/** Apply a simple (case insensitive) hashing function to the name of an attribute, vendor or protocol
123 *
124 * @param[in] name of the attribute, vendor or protocol.
125 * @param[in] len length of the input string.
126 *
127 * @return the hashed derived from the name.
128 */
129static uint32_t dict_hash_name(char const *name, size_t len)
130{
131 uint32_t hash = FNV_MAGIC_INIT;
132
133 char const *p = name, *q = name + len;
134
135 while (p < q) {
136 int c = *(unsigned char const *)p;
137 if (isalpha(c)) c = tolower(c);
138
139 /* coverity[overflow_const] */
140 hash *= FNV_MAGIC_PRIME;
141 hash ^= (uint32_t)(c & 0xff);
142 p++;
143 }
144
145 return hash;
146}
147
148/** Wrap name hash function for fr_dict_protocol_t
149 *
150 * @param[in] data fr_dict_attr_t to hash.
151 * @return the hash derived from the name of the attribute.
152 */
153static uint32_t dict_protocol_name_hash(void const *data)
154{
155 char const *name;
156
157 name = ((fr_dict_t const *)data)->root->name;
158
159 return dict_hash_name(name, strlen(name));
160}
161
162/** Compare two protocol names
163 *
164 */
165static int8_t dict_protocol_name_cmp(void const *one, void const *two)
166{
167 fr_dict_t const *a = one;
168 fr_dict_t const *b = two;
169 int ret;
170
171 ret = strcasecmp(a->root->name, b->root->name);
172 return CMP(ret, 0);
173}
174
175/** Hash a protocol number
176 *
177 */
178static uint32_t dict_protocol_num_hash(void const *data)
179{
180 return fr_hash(&(((fr_dict_t const *)data)->root->attr), sizeof(((fr_dict_t const *)data)->root->attr));
181}
182
183/** Compare two protocol numbers
184 *
185 */
186static int8_t dict_protocol_num_cmp(void const *one, void const *two)
187{
188 fr_dict_t const *a = one;
189 fr_dict_t const *b = two;
190
191 return CMP(a->root->attr, b->root->attr);
192}
193
194/** Wrap name hash function for fr_dict_attr_t
195 *
196 * @param data fr_dict_attr_t to hash.
197 * @return the hash derived from the name of the attribute.
198 */
199static uint32_t dict_attr_name_hash(void const *data)
200{
201 char const *name;
202
203 name = ((fr_dict_attr_t const *)data)->name;
204
205 return dict_hash_name(name, strlen(name));
206}
207
208/** Compare two attribute names
209 *
210 */
211static int8_t dict_attr_name_cmp(void const *one, void const *two)
212{
213 fr_dict_attr_t const *a = one, *b = two;
214 int ret;
215
216 ret = strcasecmp(a->name, b->name);
217 return CMP(ret, 0);
218}
219
220/** Compare two attributes by total order.
221 *
222 * This function is safe / ordered even when the attributes are in
223 * different dictionaries. This allows it to work for local
224 * variables, as those are in a different dictionary from the
225 * protocol ones.
226 *
227 * This function orders parents first, then their children.
228 */
229int8_t fr_dict_attr_ordered_cmp(fr_dict_attr_t const *a, fr_dict_attr_t const *b)
230{
231 int8_t ret;
232
233 /*
234 * Order by parent first. If the parents are different,
235 * we order by parent numbers.
236 *
237 * If the attributes share the same parent at some point,
238 * then the deeper child is sorted later.
239 */
240 if (a->depth < b->depth) {
241 ret = fr_dict_attr_ordered_cmp(a, b->parent);
242 if (ret != 0) return ret;
243
244 return -1; /* order a before b */
245 }
246
247 if (a->depth > b->depth) {
248 ret = fr_dict_attr_ordered_cmp(a->parent, b);
249 if (ret != 0) return ret;
250
251 return +1; /* order b before a */
252 }
253
254 /*
255 * We're at the root (e.g. "RADIUS"). Compare by
256 * protocol number.
257 *
258 * Or, the parents are the same. We can then order by
259 * our (i.e. child) attribute number.
260 */
261 if ((a->depth == 0) || (a->parent == b->parent)) {
262 /*
263 * Order known attributes before unknown / raw ones.
264 */
265 ret = CMP((a->flags.is_unknown | a->flags.is_raw), (b->flags.is_unknown | b->flags.is_raw));
266 if (ret != 0) return 0;
267
268 return CMP(a->attr, b->attr);
269 }
270
271 /*
272 * The parents are different, we don't need to order by
273 * our attribute number. Instead, we order by the
274 * parent.
275 *
276 * Note that at this point, the call below will never
277 * return 0, because the parents are different.
278 */
279 return fr_dict_attr_ordered_cmp(a->parent, b->parent);
280}
281
282/** Wrap name hash function for fr_dict_vendor_t
283 *
284 * @param data fr_dict_vendor_t to hash.
285 * @return the hash derived from the name of the attribute.
286 */
287static uint32_t dict_vendor_name_hash(void const *data)
288{
289 char const *name;
290
291 name = ((fr_dict_vendor_t const *)data)->name;
292
293 return dict_hash_name(name, strlen(name));
294}
295
296/** Compare two attribute names
297 *
298 */
299static int8_t dict_vendor_name_cmp(void const *one, void const *two)
300{
301 fr_dict_vendor_t const *a = one;
302 fr_dict_vendor_t const *b = two;
303 int ret;
304
305 ret = strcasecmp(a->name, b->name);
306 return CMP(ret, 0);
307}
308
309/** Hash a vendor number
310 *
311 */
312static uint32_t dict_vendor_pen_hash(void const *data)
313{
314 return fr_hash(&(((fr_dict_vendor_t const *)data)->pen),
315 sizeof(((fr_dict_vendor_t const *)data)->pen));
316}
317
318/** Compare two vendor numbers
319 *
320 */
321static int8_t dict_vendor_pen_cmp(void const *one, void const *two)
322{
323 fr_dict_vendor_t const *a = one;
324 fr_dict_vendor_t const *b = two;
325
326 return CMP(a->pen, b->pen);
327}
328
329/** Hash a enumeration name
330 *
331 */
332static uint32_t dict_enum_name_hash(void const *data)
333{
334 fr_dict_enum_value_t const *enumv = data;
335
336 return dict_hash_name((void const *)enumv->name, enumv->name_len);
337}
338
339/** Compare two dictionary attribute enum values
340 *
341 */
342static int8_t dict_enum_name_cmp(void const *one, void const *two)
343{
344 fr_dict_enum_value_t const *a = one;
345 fr_dict_enum_value_t const *b = two;
346 size_t len;
347 int ret;
348
349 if (a->name_len >= b->name_len) {
350 len = a->name_len;
351 } else {
352 len = b->name_len;
353 }
354
355 ret = strncasecmp(a->name, b->name, len);
356 return CMP(ret, 0);
357}
358
359/** Hash a dictionary enum value
360 *
361 */
362static uint32_t dict_enum_value_hash(void const *data)
363{
364 fr_dict_enum_value_t const *enumv = data;
365
366 return fr_value_box_hash(enumv->value);
367}
368
369/** Compare two dictionary enum values
370 *
371 */
372static int8_t dict_enum_value_cmp(void const *one, void const *two)
373{
374 fr_dict_enum_value_t const *a = one;
375 fr_dict_enum_value_t const *b = two;
376 int ret;
377
378 ret = fr_value_box_cmp(a->value, b->value); /* not yet int8_t! */
379 return CMP(ret, 0);
380}
381
382/** Resolve an alias attribute to the concrete attribute it points to
383 *
384 * @param[out] err where to write the error (if any).
385 * @param[in] da to resolve.
386 * @return
387 * - NULL on error.
388 * - The concrete attribute on success.
389 */
390static inline fr_dict_attr_t const *dict_attr_alias(fr_dict_attr_err_t *err, fr_dict_attr_t const *da)
391{
392 fr_dict_attr_t const *ref;
393
394 if (!da->flags.is_alias) return da;
395
396 ref = fr_dict_attr_ref(da);
397 if (unlikely(!ref)) {
398 fr_strerror_printf("ALIAS attribute '%s' missing reference", da->name);
399 if (err) *err = FR_DICT_ATTR_INTERNAL_ERROR;
400 return NULL;
401 } else {
402 if (err) *err = FR_DICT_ATTR_OK;
403 }
404
405 return ref;
406}
407
408/** Set a dictionary attribute's name
409 *
410 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
411 *
412 * @param[in] da_p to set name for.
413 * @param[in] name to set. If NULL a name will be automatically generated.
414 */
415static inline CC_HINT(always_inline) int dict_attr_name_set(fr_dict_attr_t **da_p, char const *name)
416{
417 char buffer[FR_DICT_ATTR_MAX_NAME_LEN + 1];
418 size_t name_len;
419 char *name_start, *name_end;
420 fr_dict_attr_t *da = *da_p;
421
422 /*
423 * Generate a name if none is specified
424 */
425 if (!name) {
426 fr_sbuff_t unknown_name = FR_SBUFF_OUT(buffer, sizeof(buffer));
427
428
429 (void) fr_sbuff_in_sprintf(&unknown_name, "%u", da->attr);
430
431 name = fr_sbuff_buff(&unknown_name);
432 name_len = fr_sbuff_used(&unknown_name);
433 } else {
434 name_len = strlen(name);
435 }
436
437 /*
438 * Grow the structure to hold the name
439 *
440 * We add the name as an extension because it makes
441 * the code less complex, and means the name value
442 * is copied automatically when if the fr_dict_attr_t
443 * is copied.
444 *
445 * We do still need to fixup the da->name pointer
446 * though.
447 */
448 name_start = dict_attr_ext_alloc_size(da_p, FR_DICT_ATTR_EXT_NAME, name_len + 1);
449 if (!name_start) return -1;
450
451 name_end = name_start + name_len;
452
453 memcpy(name_start, name, name_len);
454 *name_end = '\0';
455
456 (*da_p)->name = name_start;
457 (*da_p)->name_len = name_len;
458
459 return 0;
460}
461
462/** Add a child/nesting extension to an attribute
463 *
464 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
465 *
466 * @param[in] da_p to set a group reference for.
467 */
468static inline CC_HINT(always_inline) int dict_attr_children_init(fr_dict_attr_t **da_p)
469{
470 fr_dict_attr_ext_children_t *ext;
471
472 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_CHILDREN);
473 if (unlikely(!ext)) return -1;
474
475 return 0;
476}
477
478/** Cache the vendor pointer for an attribute
479 *
480 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
481 *
482 * @param[in] da_p to set a group reference for.
483 * @param[in] vendor to set.
484 */
485static inline CC_HINT(always_inline) int dict_attr_vendor_set(fr_dict_attr_t **da_p, fr_dict_attr_t const *vendor)
486{
487 fr_dict_attr_ext_vendor_t *ext;
488
489 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_VENDOR);
490 if (unlikely(!ext)) return -1;
491
492 ext->vendor = vendor;
493
494 return 0;
495}
496
497/** Initialise a per-attribute enumeration table
498 *
499 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
500 *
501 * @param[in] da_p to set a group reference for.
502 */
503static inline CC_HINT(always_inline) int dict_attr_enumv_init(fr_dict_attr_t **da_p)
504{
505 fr_dict_attr_ext_enumv_t *ext;
506
507 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_ENUMV);
508 if (unlikely(!ext)) return -1;
509
510 return 0;
511}
512
513/** Initialise a per-attribute namespace
514 *
515 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
516 *
517 * @param[in] da_p to set a group reference for.
518 */
519static inline CC_HINT(always_inline) int dict_attr_namespace_init(fr_dict_attr_t **da_p)
520{
521 fr_dict_attr_ext_namespace_t *ext;
522
523 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_NAMESPACE);
524 if (unlikely(!ext)) return -1;
525
526 /*
527 * Create the table of attributes by name.
528 * There MAY NOT be multiple attributes of the same name.
529 *
530 * If the attribute already has extensions
531 * then we don't want to leak the old
532 * namespace hash table.
533 */
534 if (!ext->namespace) {
535 ext->namespace = fr_hash_table_talloc_alloc(*da_p, fr_dict_attr_t,
536 dict_attr_name_hash, dict_attr_name_cmp, NULL);
537 if (!ext->namespace) {
538 fr_strerror_printf("Failed allocating \"namespace\" table");
539 return -1;
540 }
541 }
542
543 return 0;
544}
545
546/** Initialise type specific fields within the dictionary attribute
547 *
548 * Call when the type of the attribute is known.
549 *
550 * @param[in,out] da_p to set the type for.
551 * @param[in] type to set.
552 * @return
553 * - 0 on success.
554 * - < 0 on error.
555 */
556int dict_attr_type_init(fr_dict_attr_t **da_p, fr_type_t type)
557{
558 if (unlikely(((*da_p)->type != FR_TYPE_NULL) &&
559 ((*da_p)->type != type))) {
560 fr_strerror_printf("Cannot set data type to '%s' - it is already set to '%s'",
561 fr_type_to_str(type), fr_type_to_str((*da_p)->type));
562 return -1;
563 }
564
565 if (unlikely((*da_p)->state.finalised == true)) {
566 fr_strerror_const("Can't perform type initialisation on finalised attribute");
567 return -1;
568 }
569
570 /*
571 * Structural types can have children
572 * so add the extension for them.
573 */
574 switch (type) {
575 case FR_TYPE_STRUCTURAL:
576 /*
577 * Groups don't have children or namespaces. But
578 * they always have refs. Either to the root of
579 * the current dictionary, or to another dictionary,
580 * via its top-level TLV.
581 *
582 * Note that when multiple TLVs have the same
583 * children, the dictionary has to use "clone="
584 * instead of "ref=". That's because the
585 * children of the TLVs all require the correct
586 * parentage. Perhaps that can be changed when
587 * the encoders / decoders are updated. It would be good to just reference the DAs instead of cloning an entire subtree.
588 */
589 if ((type == FR_TYPE_GROUP) && !fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_REF)) {
590 if (dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_REF) == NULL) return -1;
591 break;
592 }
593
594 if (dict_attr_children_init(da_p) < 0) return -1;
595 if (dict_attr_namespace_init(da_p) < 0) return -1; /* Needed for all TLV style attributes */
596
597 (*da_p)->last_child_attr = (1 << 24); /* High enough not to conflict with protocol numbers */
598 break;
599
600 /*
601 * Leaf types
602 */
603 default:
604 if (dict_attr_enumv_init(da_p) < 0) return -1;
605 break;
606 }
607
608 (*da_p)->flags.is_known_width |= fr_type_fixed_size[type];
609
610 /*
611 * Set default type-based flags
612 */
613 switch (type) {
614 case FR_TYPE_DATE:
615 case FR_TYPE_TIME_DELTA:
616 (*da_p)->flags.length = 4;
617 (*da_p)->flags.flag_time_res = FR_TIME_RES_SEC;
618 break;
619
620
621 case FR_TYPE_OCTETS:
622 case FR_TYPE_STRING:
623 (*da_p)->flags.is_known_width = ((*da_p)->flags.length != 0);
624 break;
625
626 default:
627 break;
628 }
629
630 (*da_p)->type = type;
631
632 return 0;
633}
634
635/** Initialise fields which depend on a parent attribute
636 *
637 * @param[in,out] da_p to initialise.
638 * @param[in] parent of the attribute.
639 * @return
640 * - 0 on success.
641 * - < 0 on error.
642 */
643int dict_attr_parent_init(fr_dict_attr_t **da_p, fr_dict_attr_t const *parent)
644{
645 fr_dict_attr_t *da = *da_p;
646 fr_dict_t const *dict = parent->dict;
647 fr_dict_attr_ext_vendor_t *ext;
648
649 if (unlikely((*da_p)->type == FR_TYPE_NULL)) {
650 fr_strerror_const("Attribute type must be set before initialising parent. Use dict_attr_type_init() first");
651 return -1;
652 }
653
654 if (unlikely(da->parent != NULL)) {
655 fr_strerror_printf("Attempting to set parent for '%s' to '%s', but parent already set to '%s'",
656 da->name, parent->name, da->parent->name);
657 return -1;
658 }
659
660 if (unlikely((*da_p)->state.finalised == true)) {
661 fr_strerror_printf("Attempting to set parent for '%s' to '%s', but attribute already finalised",
662 da->name, parent->name);
663 return -1;
664 }
665
666 da->parent = parent;
667 da->dict = parent->dict;
668 da->depth = parent->depth + 1;
669 da->flags.internal |= parent->flags.internal;
670
671 /*
672 * Point to the vendor definition. Since ~90% of
673 * attributes are VSAs, caching this pointer will help.
674 */
675 if (da->type == FR_TYPE_VENDOR) {
676 da->flags.type_size = dict->root->flags.type_size;
677 da->flags.length = dict->root->flags.type_size;
678
679 if ((dict->root->attr == FR_DICT_PROTO_RADIUS) && (da->depth == 2)) {
680 fr_dict_vendor_t const *dv;
681
682 dv = fr_dict_vendor_by_num(dict, da->attr);
683 if (dv) {
684 da->flags.type_size = dv->type;
685 da->flags.length = dv->length;
686 }
687 }
688
689 } else if (da->type == FR_TYPE_TLV) {
690 da->flags.type_size = dict->root->flags.type_size;
691 da->flags.length = dict->root->flags.type_size;
692 }
693
694 if (parent->type == FR_TYPE_VENDOR) {
695 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_VENDOR);
696 if (unlikely(!ext)) return -1;
697
698 ext->vendor = parent;
699
700 } else {
701 ext = dict_attr_ext_copy(da_p, parent, FR_DICT_ATTR_EXT_VENDOR); /* Noop if no vendor extension */
702 }
703
704 da = *da_p;
705
706 if (!ext || ((da->type != FR_TYPE_TLV) && (da->type != FR_TYPE_VENDOR))) return 0;
707
708 da->flags.type_size = ext->vendor->flags.type_size;
709 da->flags.length = ext->vendor->flags.type_size;
710
711 return 0;
712}
713
714/** Set the attribute number (if any)
715 *
716 * @param[in] da to set the attribute number for.
717 * @param[in] num to set.
718 */
719int dict_attr_num_init(fr_dict_attr_t *da, unsigned int num)
720{
721 if (da->state.attr_set) {
722 fr_strerror_const("Attribute number already set");
723 return -1;
724 }
725 da->attr = num;
726 da->state.attr_set = true;
727
728 return 0;
729}
730
731/** Set the attribute number (if any)
732 *
733 * @note Must have a parent set.
734 *
735 * @param[in] da to set the attribute number for.
736 */
737int dict_attr_num_init_name_only(fr_dict_attr_t *da)
738{
739 if (!da->parent) {
740 fr_strerror_const("Attribute must have parent set before automatically setting attribute number");
741 return -1;
742 }
743 return dict_attr_num_init(da, ++fr_dict_attr_unconst(da->parent)->last_child_attr);
744}
745
746/** Set where the dictionary attribute was defined
747 *
748 */
749void dict_attr_location_init(fr_dict_attr_t *da, char const *filename, int line)
750{
751 da->filename = filename;
752 da->line = line;
753}
754
755/** Set remaining fields in a dictionary attribute before insertion
756 *
757 * @param[in] da_p to finalise.
758 * @param[in] name of the attribute.
759 * @return
760 * - 0 on success.
761 * - < 0 on error.
762 */
763int dict_attr_finalise(fr_dict_attr_t **da_p, char const *name)
764{
765 fr_dict_attr_t *da;
766
767 /*
768 * Finalising the attribute allocates its
769 * automatic number if its a name only attribute.
770 */
771 da = *da_p;
772
773 /*
774 * Initialize the length field automatically if it's not been set already
775 */
776 if (!da->flags.length && fr_type_is_leaf(da->type) && !fr_type_is_variable_size(da->type)) {
777 fr_value_box_t box;
778
779 fr_value_box_init(&box, da->type, NULL, false);
780 da->flags.length = fr_value_box_network_length(&box);
781 }
782
783 switch(da->type) {
784 case FR_TYPE_STRUCT:
785 da->flags.is_known_width |= da->flags.array;
786 break;
787
788 case FR_TYPE_GROUP:
789 {
790 fr_dict_attr_ext_ref_t *ext;
791 /*
792 * If it's a group attribute, the default
793 * reference goes to the root of the
794 * dictionary as that's where the default
795 * name/numberspace is.
796 *
797 * This may be updated by the caller.
798 */
799 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_REF);
800 if (unlikely(ext == NULL)) {
801 fr_strerror_const("Missing ref extension");
802 return -1;
803 }
804
805 /*
806 * For groups, if a ref wasn't provided then
807 * set it to the dictionary root.
808 */
809 if ((ext->type == FR_DICT_ATTR_REF_NONE) &&
810 (unlikely(dict_attr_ref_set(da, fr_dict_root(da->dict), FR_DICT_ATTR_REF_ALIAS) < 0))) {
811 return -1;
812 }
813 }
814 break;
815
816 default:
817 break;
818 }
819
820 /*
821 * Name is a separate talloc chunk. We allocate
822 * it last because we cache the pointer value.
823 */
824 if (dict_attr_name_set(da_p, name) < 0) return -1;
825
826 DA_VERIFY(*da_p);
827
828 (*da_p)->state.finalised = true;
829
830 return 0;
831}
832
833static inline CC_HINT(always_inline)
834int dict_attr_init_common(char const *filename, int line,
835 fr_dict_attr_t **da_p,
836 fr_dict_attr_t const *parent,
837 fr_type_t type, dict_attr_args_t const *args)
838{
839 dict_attr_location_init((*da_p), filename, line);
840
841 if (unlikely(dict_attr_type_init(da_p, type) < 0)) return -1;
842
843 if (args->flags) (*da_p)->flags = *args->flags;
844
845 if (parent && (dict_attr_parent_init(da_p, parent) < 0)) return -1;
846
847 if (args->ref && (dict_attr_ref_aset(da_p, args->ref, FR_DICT_ATTR_REF_ALIAS) < 0)) return -1;
848
849 /*
850 * Everything should be created correctly.
851 */
852 if (!(*da_p)->flags.internal && !(*da_p)->flags.is_alias &&
853 parent && ((parent->type == FR_TYPE_TLV) || (parent->type ==FR_TYPE_VENDOR))) {
854 if (!parent->flags.type_size) {
855 fr_strerror_printf("Parent %s has zero type_size", parent->name);
856 return -1;
857 }
858
859 if ((uint64_t) (*da_p)->attr >= ((uint64_t) 1 << (8 * parent->flags.type_size))) {
860 fr_strerror_printf("Child of parent %s has invalid attribute number %u for type_size %u",
861 parent->name, (*da_p)->attr, parent->flags.type_size);
862 return -1;
863 }
864 }
865
866 return 0;
867}
868
869/** Initialise fields in a dictionary attribute structure
870 *
871 * This function is a wrapper around the other initialisation functions.
872 *
873 * The reason for the separation, is that sometimes we're initialising a dictionary attribute
874 * by parsing an actual dictionary file, and other times we're copying attribute, or initialising
875 * them programatically.
876 *
877 * This function should only be used for the second case, where we have a complet attribute
878 * definition already.
879 *
880 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
881 *
882 * @param[in] filename file.
883 * @param[in] line number.
884 * @param[in] da_p to initialise.
885 * @param[in] parent of the attribute, if none, this attribute will
886 * be initialised as a dictionary root.
887 * @param[in] name of attribute. Pass NULL for auto-generated name.
888 * @param[in] attr number.
889 * @param[in] type of the attribute.
890 * @param[in] args optional initialisation arguments.
891 * @return
892 * - 0 on success.
893 * - <0 on error.
894 */
895int _dict_attr_init(char const *filename, int line,
896 fr_dict_attr_t **da_p,
897 fr_dict_attr_t const *parent,
898 char const *name, unsigned int attr,
899 fr_type_t type, dict_attr_args_t const *args)
900{
901 /*
902 * We initialize the number first, as doing that doesn't have any other side effects.
903 */
904 if (unlikely(dict_attr_num_init(*da_p, attr) < 0)) return -1;
905
906 /*
907 * This function then checks the number, for things like VSAs.
908 */
909 if (unlikely(dict_attr_init_common(filename, line, da_p, parent, type, args) < 0)) return -1;
910
911 if (unlikely(dict_attr_finalise(da_p, name) < 0)) return -1;
912
913 return 0;
914}
915
916/** Initialise fields in a dictionary attribute structure
917 *
918 * This function is a wrapper around the other initialisation functions.
919 *
920 * The reason for the separation, is that sometimes we're initialising a dictionary attribute
921 * by parsing an actual dictionary file, and other times we're copying attribute, or initialising
922 * them programatically.
923 *
924 * This function should only be used for the second case, where we have a complet attribute
925 * definition already.
926 *
927 * @note This function can only be used _before_ the attribute is inserted into the dictionary.
928 *
929 * @param[in] filename file.
930 * @param[in] line number.
931 * @param[in] da_p to initialise.
932 * @param[in] parent of the attribute, if none, this attribute will
933 * be initialised as a dictionary root.
934 * @param[in] name of attribute. Pass NULL for auto-generated name.
935 * automatically generated.
936 * @param[in] type of the attribute.
937 * @param[in] args optional initialisation arguments.
938 * @return
939 * - 0 on success.
940 * - <0 on error.
941 */
942int _dict_attr_init_name_only(char const *filename, int line,
943 fr_dict_attr_t **da_p,
944 fr_dict_attr_t const *parent,
945 char const *name,
946 fr_type_t type, dict_attr_args_t const *args)
947{
948 if (unlikely(dict_attr_init_common(filename, line, da_p, parent, type, args) < 0)) return -1;
949
950 /*
951 * Automatically generate the attribute number when the attribut is added.
952 */
953 (*da_p)->flags.name_only = true;
954
955 if (unlikely(dict_attr_finalise(da_p, name) < 0)) return -1;
956
957 return 0;
958}
959
960static int _dict_attr_free(fr_dict_attr_t *da)
961{
962 fr_dict_attr_ext_enumv_t *ext;
963
964#if 0
965#ifdef WITH_VERIFY_PTR
966 /*
967 * Check that any attribute we reference is still valid
968 * when we're being freed.
969 */
970 fr_dict_attr_t const *ref = fr_dict_attr_ref(da);
971
972 if (ref) (void)talloc_get_type_abort_const(ref, fr_dict_attr_t);
973#endif
974#endif
975
976 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
977 if (ext) talloc_free(ext->value_by_name); /* Ensure this is freed before the enumvs */
978
979 return 0;
980}
981
982/** Allocate a partially completed attribute
983 *
984 * This is useful in some instances where we need to pre-allocate the attribute
985 * for talloc hierarchy reasons, but want to finish initialising it
986 * with #dict_attr_init later.
987 *
988 * @param[in] ctx to allocate attribute in.
989 * @param[in] proto protocol specific extensions.
990 * @return
991 * - A new, partially completed, fr_dict_attr_t on success.
992 * - NULL on failure (memory allocation error).
993 */
994fr_dict_attr_t *dict_attr_alloc_null(TALLOC_CTX *ctx, fr_dict_protocol_t const *proto)
995{
996 fr_dict_attr_t *da;
997
998 /*
999 * Do not use talloc zero, the caller
1000 * always initialises memory allocated
1001 * here.
1002 */
1003 da = talloc_zero(ctx, fr_dict_attr_t);
1004 if (unlikely(!da)) return NULL;
1005
1006 /*
1007 * Allocate room for the protocol specific flags
1008 */
1009 if (proto->attr.flags.len > 0) {
1010 if (unlikely(dict_attr_ext_alloc_size(&da, FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC,
1011 proto->attr.flags.len) == NULL)) {
1012 talloc_free(da);
1013 return NULL;
1014 }
1015 }
1016 talloc_set_destructor(da, _dict_attr_free);
1017
1018 return da;
1019}
1020
1021/** Allocate a dictionary root attribute on the heap
1022 *
1023 * @param[in] filename file.
1024 * @param[in] line number.
1025 * @param[in] ctx to allocate the attribute in.
1026 * @param[in] dict the attribute will be used in.
1027 * @param[in] name of the attribute. If NULL an OID string
1028 * will be created and set as the name.
1029 * @param[in] proto_number number. This should be
1030 * @param[in] args optional initialisation arguments.
1031 * @return
1032 * - A new fr_dict_attr_t on success.
1033 * - NULL on failure.
1034 */
1035fr_dict_attr_t *_dict_attr_alloc_root(char const *filename, int line,
1036 TALLOC_CTX *ctx,
1037 fr_dict_t const *dict,
1038 char const *name, int proto_number,
1039 dict_attr_args_t const *args)
1040{
1041 fr_dict_attr_t *n;
1042
1043 n = dict_attr_alloc_null(ctx, dict->proto);
1044 if (unlikely(!n)) return NULL;
1045
1046 if (_dict_attr_init(filename, line, &n, NULL, name, proto_number, FR_TYPE_TLV, args) < 0) {
1047 talloc_free(n);
1048 return NULL;
1049 }
1050
1051 return n;
1052}
1053
1054/** Allocate a dictionary attribute on the heap
1055 *
1056 * @param[in] filename file.
1057 * @param[in] line number.
1058 * @param[in] ctx to allocate the attribute in.
1059 * @param[in] parent of the attribute.
1060 * @param[in] name of the attribute. If NULL an OID string
1061 * will be created and set as the name.
1062 * @param[in] attr number.
1063 * @param[in] type of the attribute.
1064 * @param[in] args optional initialisation arguments.
1065 * @return
1066 * - A new fr_dict_attr_t on success.
1067 * - NULL on failure.
1068 */
1069fr_dict_attr_t *_dict_attr_alloc(char const *filename, int line,
1070 TALLOC_CTX *ctx,
1071 fr_dict_attr_t const *parent,
1072 char const *name, int attr,
1073 fr_type_t type, dict_attr_args_t const *args)
1074{
1075 fr_dict_attr_t *n;
1076
1077 n = dict_attr_alloc_null(ctx, parent->dict->proto);
1078 if (unlikely(!n)) return NULL;
1079
1080 if (_dict_attr_init(filename, line, &n, parent, name, attr, type, args) < 0) {
1081 talloc_free(n);
1082 return NULL;
1083 }
1084
1085 return n;
1086}
1087
1088/** Copy a an existing attribute, possibly to a new location
1089 *
1090 * @param[in] ctx to allocate new attribute in.
1091 * @param[in] parent where to parent the copy from. If NULL, in->parent is used.
1092 * @param[in] in attribute to copy.
1093 * @param[in] name to assign to the attribute. If NULL, in->name is used.
1094 * @return
1095 * - A copy of the input fr_dict_attr_t on success.
1096 * - NULL on failure.
1097 */
1098fr_dict_attr_t *dict_attr_acopy(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, fr_dict_attr_t const *in,
1099 char const *name)
1100{
1101 fr_dict_attr_t *n;
1102
1103 if (in->flags.has_fixup) {
1104 fr_strerror_printf("Cannot copy from %s - source attribute is waiting for additional definitions",
1105 in->name);
1106 return NULL;
1107 }
1108
1109 fr_assert(parent || name);
1110
1111 n = dict_attr_alloc(ctx, parent ? parent : in->parent, name ? name : in->name,
1112 in->attr, in->type, &(dict_attr_args_t){ .flags = &in->flags });
1113 if (unlikely(!n)) return NULL;
1114
1115 /*
1116 * This newly allocated attribute is not the target of a ref.
1117 */
1118 n->flags.is_ref_target = false;
1119
1120 if (dict_attr_ext_copy_all(&n, in) < 0) {
1121 error:
1122 talloc_free(n);
1123 return NULL;
1124 }
1125 DA_VERIFY(n);
1126
1127 if (fr_type_is_structural(in->type) && in->flags.has_alias) {
1128 if (dict_attr_acopy_aliases(n, in) < 0) goto error;
1129 }
1130
1131 return n;
1132}
1133
1134int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src)
1135{
1136 if (!dst->flags.local) {
1137 fr_strerror_const("Cannot copy attributes to a non-local dictionary");
1138 return -1;
1139 }
1140
1141 if (src->flags.has_fixup) {
1142 fr_strerror_printf("Cannot copy from %s to %s - source attribute is waiting for additional definitions",
1143 src->name, dst->name);
1144 return -1;
1145 }
1146
1147 /*
1148 * Why not? @todo - check and fix
1149 */
1150 if (src->flags.local) {
1151 fr_strerror_const("Cannot copy a local attribute");
1152 return -1;
1153 }
1154
1155 return dict_attr_acopy_children(dst->dict, UNCONST(fr_dict_attr_t *, dst), src);
1156}
1157
1158static int dict_attr_acopy_child(fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src,
1159 fr_dict_attr_t const *child)
1160{
1161 fr_dict_attr_t *copy;
1162
1163 copy = dict_attr_acopy(dict->pool, dst, child, child->name);
1164 if (!copy) return -1;
1165
1166 fr_assert(copy->parent == dst);
1167 copy->depth = copy->parent->depth + 1;
1168
1169 if (dict_attr_child_add(dst, copy) < 0) return -1;
1170
1171 if (dict_attr_add_to_namespace(dst, copy) < 0) return -1;
1172
1173 if (!dict_attr_children(child)) return 0;
1174
1175 if (dict_attr_acopy_children(dict, copy, child) < 0) return -1;
1176
1177 /*
1178 * Children of a UNION get an ALIAS added to the parent of the UNION. This allows the UNION
1179 * attribute to be omitted from parsing and printing.
1180 */
1181 if (src->type != FR_TYPE_UNION) return 0;
1182
1183 return dict_attr_alias_add(dst->parent, copy->name, copy, false);
1184}
1185
1186
1187/** Copy the children of an existing attribute
1188 *
1189 * @param[in] dict to allocate the children in
1190 * @param[in] dst where to copy the children to
1191 * @param[in] src where to copy the children from
1192 * @return
1193 * - 0 on success
1194 * - <0 on error
1195 */
1196int dict_attr_acopy_children(fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src)
1197{
1198 uint child_num;
1199 fr_dict_attr_t const *child = NULL, *src_key = NULL;
1200 fr_dict_attr_t *dst_key;
1201
1202 fr_assert(fr_dict_attr_has_ext(dst, FR_DICT_ATTR_EXT_CHILDREN));
1203 fr_assert(dst->type == src->type);
1204 fr_assert(fr_dict_attr_is_key_field(src) == fr_dict_attr_is_key_field(dst));
1205
1206 /*
1207 * For non-struct parents, we can copy their children in any order.
1208 */
1209 if (likely(src->type != FR_TYPE_STRUCT)) {
1210 for (child = fr_dict_attr_iterate_children(src, &child);
1211 child != NULL;
1212 child = fr_dict_attr_iterate_children(src, &child)) {
1213 if (dict_attr_acopy_child(dict, dst, src, child) < 0) return -1;
1214 }
1215
1216 return 0;
1217 }
1218
1219 /*
1220 * For structs, we copy the children in order. This allows "key" fields to be copied before
1221 * fields which depend on them.
1222 *
1223 * Note that due to the checks in the DEFINE and ATTRIBUTE parsers (but not the validate
1224 * routines), STRUCTs can only have children which are MEMBERs. And MEMBERs are allocated in
1225 * order.
1226 */
1227 for (child_num = 1, child = fr_dict_attr_child_by_num(src, child_num);
1228 child != NULL;
1229 child_num++, child = fr_dict_attr_child_by_num(src, child_num)) {
1230 /*
1231 * If the key field has enums, then delay copying the enums until after we've copied all
1232 * of the other children.
1233 *
1234 * For a UNION which is inside of a STRUCT, the UNION has a reference to the key field.
1235 * So the key field needs to be defined before we create the UNION.
1236 *
1237 * But the key field also has a set of ENUMs, each of which has a key ref to the UNION
1238 * member which is associated with that key value. This means that we have circular
1239 * dependencies.
1240 *
1241 * The loop is resolved by creating the key first, and allocating room for an ENUM
1242 * extension. This allows the UNION to reference the key. Once the UNION is created, we
1243 * go back and copy all of the ENUMs over. The ENUM copy routine will take care of
1244 * fixing up the refs.
1245 */
1246 if (unlikely(fr_dict_attr_is_key_field(child) && child->flags.has_value)) {
1247 src_key = child;
1248
1249 if (src_key->flags.has_fixup) {
1250 fr_strerror_printf("Cannot copy from %s - source attribute is waiting for additional definitions",
1251 src_key->name);
1252 return -1;
1253 }
1254
1255 dst_key = dict_attr_alloc(dict, dst, src_key->name,
1256 src_key->attr, src_key->type, &(dict_attr_args_t){ .flags = &src_key->flags });
1257 if (unlikely(!dst_key)) return -1;
1258
1259 if (!dict_attr_ext_alloc(&dst_key, FR_DICT_ATTR_EXT_ENUMV)) return -1;
1260
1261 fr_assert(dst_key->parent == dst);
1262 dst_key->depth = dst->depth + 1;
1263
1264 if (dict_attr_child_add(dst, dst_key) < 0) return -1;
1265
1266 if (dict_attr_add_to_namespace(dst, dst_key) < 0) return -1;
1267
1268 continue;
1269 }
1270
1271 if (dict_attr_acopy_child(dict, dst, src, child) < 0) return -1;
1272
1273 DA_VERIFY(child);
1274 }
1275
1276 DA_VERIFY(dst);
1277
1278 if (!src_key) return 0;
1279
1280 if (!dict_attr_ext_copy(&dst_key, src_key, FR_DICT_ATTR_EXT_ENUMV)) return -1;
1281
1282 return 0;
1283}
1284
1285/** Copy the VALUEs of an existing attribute, by casting them
1286 *
1287 * @param[in] dst where to cast the VALUEs to
1288 * @param[in] src where to cast the VALUEs from
1289 * @return
1290 * - 0 on success
1291 * - <0 on error
1292 */
1293int dict_attr_acopy_enumv(fr_dict_attr_t *dst, fr_dict_attr_t const *src)
1294{
1295 fr_dict_attr_ext_enumv_t *ext;
1296
1297 fr_assert(!fr_type_is_non_leaf(dst->type));
1298 fr_assert(!fr_type_is_non_leaf(src->type));
1299
1300 fr_assert(fr_dict_attr_has_ext(dst, FR_DICT_ATTR_EXT_ENUMV));
1301 fr_assert(fr_dict_attr_has_ext(src, FR_DICT_ATTR_EXT_ENUMV));
1302
1303 ext = fr_dict_attr_ext(src, FR_DICT_ATTR_EXT_ENUMV);
1304 if (!ext) {
1305 fr_assert(0);
1306 return -1;
1307 }
1308
1309 if (!ext->name_by_value) {
1310 fr_strerror_printf("Reference enum %s does not have any VALUEs to copy", src->name);
1311 return -1;
1312 }
1313
1314 if (dict_attr_ext_copy(&dst, src, FR_DICT_ATTR_EXT_ENUMV)) return fr_hash_table_num_elements(ext->name_by_value);
1315
1316 return -1;
1317}
1318
1319
1320/** Copy aliases of an existing attribute to a new one.
1321 *
1322 * @param[in] dst where to copy the children to
1323 * @param[in] src where to copy the children from
1324 * @return
1325 * - 0 on success
1326 * - <0 on error
1327 */
1328int dict_attr_acopy_aliases(UNUSED fr_dict_attr_t *dst, fr_dict_attr_t const *src)
1329{
1330 fr_hash_table_t *namespace;
1331 fr_hash_iter_t iter;
1332 fr_dict_attr_t const *da;
1333
1334 if (!src->flags.has_alias) return 0;
1335
1336 switch (src->type) {
1337 case FR_TYPE_TLV:
1338 case FR_TYPE_VENDOR:
1339 case FR_TYPE_VSA:
1340 break;
1341
1342 /*
1343 * Automatically added aliases are copied in dict_attr_acopy_child().
1344 */
1345 case FR_TYPE_STRUCT:
1346 return 0;
1347
1348 default:
1349 fr_strerror_printf("Cannot add ALIAS to parent attribute %s of data type '%s'", src->name, fr_type_to_str(src->type));
1350 return -1;
1351
1352 }
1353
1354 namespace = dict_attr_namespace(src);
1355 fr_assert(namespace != NULL);
1356
1357 for (da = fr_hash_table_iter_init(namespace, &iter);
1358 da != NULL;
1359 da = fr_hash_table_iter_next(namespace, &iter)) {
1360 if (!da->flags.is_alias) continue;
1361
1362#if 1
1363 fr_strerror_printf("Cannot clone ALIAS %s.%s to %s.%s", src->name, da->name, dst->name, da->name);
1364 return -1;
1365
1366#else
1367 fr_dict_attr_t const *parent, *ref;
1368 fr_dict_attr_t const *new_ref;
1369
1370 ref = fr_dict_attr_ref(da);
1371 fr_assert(ref != NULL);
1372
1373 /*
1374 * ALIASes are normally down the tree, to shorten sibling relationships.
1375 * e.g. Cisco-AVPAir -> Vendor-Specific.Cisco.AV-Pair.
1376 *
1377 * The question is to we want to allow aliases to create cross-tree links? I suspect
1378 * not.
1379 */
1380 parent = fr_dict_attr_common_parent(src, ref, true);
1381 if (!parent) {
1382 fr_strerror_printf("Cannot clone ALIAS %s.%s to %s.%s, the alias reference %s is outside of the shared tree",
1383 src->name, da->name, dst->name, da->name, ref->name);
1384 return -1;
1385 }
1386
1387 fr_assert(parent == src);
1388
1389 new_ref = fr_dict_attr_by_name(NULL, dst, da->name);
1390 fr_assert(new_ref == NULL);
1391
1392 /*
1393 * This function needs to walk back up from "ref" to "src", finding the intermediate DAs.
1394 * Once that's done, it needs to walk down from "dst" to create a new "ref".
1395 */
1396 new_ref = dict_alias_reref(dst, src, ref);
1397 fr_assert(new_ref != NULL);
1398
1399 if (dict_attr_alias_add(dst, da->name, new_ref, false) < 0) return -1;
1400#endif
1401 }
1402
1403 return 0;
1404}
1405
1406/** Add an alias to an existing attribute
1407 *
1408 */
1409int dict_attr_alias_add(fr_dict_attr_t const *parent, char const *alias, fr_dict_attr_t const *ref, bool from_public)
1410{
1411 fr_dict_attr_t const *da;
1412 fr_dict_attr_t *self;
1413 fr_hash_table_t *namespace;
1414
1415 switch (parent->type) {
1416 case FR_TYPE_STRUCT:
1417 /*
1418 * If we are a STRUCT, the reference an only be to children of a UNION.
1419 */
1420 fr_assert(ref->parent->type == FR_TYPE_UNION);
1421
1422 /*
1423 * And the UNION must be a MEMBER of the STRUCT.
1424 */
1425 fr_assert(ref->parent->parent == parent);
1426 break;
1427
1428 case FR_TYPE_TLV:
1429 case FR_TYPE_VENDOR:
1430 case FR_TYPE_VSA:
1431 case FR_TYPE_GROUP:
1432 break;
1433
1434 default:
1435 fr_strerror_printf("Cannot add ALIAS to parent attribute %s of data type '%s'",
1436 parent->name, fr_type_to_str(parent->type));
1437 return -1;
1438 }
1439
1440 if ((ref->type == FR_TYPE_UNION) || fr_dict_attr_is_key_field(ref)) {
1441 fr_strerror_printf("Cannot add ALIAS to target attribute %s of data type '%s'",
1442 ref->name, fr_type_to_str(ref->type));
1443 return -1;
1444 }
1445
1446 da = dict_attr_by_name(NULL, parent, alias);
1447 if (da) {
1448 fr_strerror_printf("ALIAS '%s' conflicts with another attribute in namespace %s",
1449 alias, parent->name);
1450 return -1;
1451 }
1452
1453 /*
1454 * ALIASes from the dictionaries, need to point to a child of the same parent. ALIASes cannot go
1455 * back up the tree.
1456 *
1457 * ALIASes added internally, they can break this restriction.
1458 *
1459 * This restriction is here to prevent people from creating loops of ALIASes.
1460 */
1461 if (from_public && !fr_dict_attr_common_parent(parent, ref, true)) {
1462 fr_strerror_printf("Invalid ALIAS to target attribute %s of data type '%s' - the attributes do not share a parent",
1463 ref->name, fr_type_to_str(ref->type));
1464 return -1;
1465 }
1466
1467 /*
1468 * Note that we do NOT call fr_dict_attr_add() here.
1469 *
1470 * When that function adds two equivalent attributes, the
1471 * second one is prioritized for printing. For ALIASes,
1472 * we want the pre-existing one to be prioritized.
1473 *
1474 * i.e. you can lookup the ALIAS by "name", but you
1475 * actually get returned "ref".
1476 */
1477 {
1478 fr_dict_attr_flags_t flags = ref->flags;
1479
1480 flags.is_alias = 1; /* These get followed automatically by public functions */
1481
1482 self = dict_attr_alloc(parent->dict->pool, parent, alias, ref->attr, FR_TYPE_VOID, (&(dict_attr_args_t){ .flags = &flags, .ref = ref }));
1483 if (unlikely(!self)) return -1;
1484 }
1485
1486 self->dict = parent->dict;
1487 UNCONST(fr_dict_attr_t *, parent)->flags.has_alias = true;
1488
1489 fr_assert(fr_dict_attr_ref(self) == ref);
1490
1491 namespace = dict_attr_namespace(parent);
1492 if (!namespace) {
1493 fr_strerror_printf("Attribute '%s' does not contain a namespace", parent->name);
1494 error:
1495 talloc_free(self);
1496 return -1;
1497 }
1498
1499 if (!fr_hash_table_insert(namespace, self)) {
1500 fr_strerror_const("Internal error storing attribute");
1501 goto error;
1502 }
1503
1504 return 0;
1505}
1506
1507/** Add a protocol to the global protocol table
1508 *
1509 * Inserts a protocol into the global protocol table. Uses the root attributes
1510 * of the dictionary for comparisons.
1511 *
1512 * @param[in] dict of protocol we're inserting.
1513 * @return
1514 * - 0 on success.
1515 * - -1 on failure.
1516 */
1517int dict_protocol_add(fr_dict_t *dict)
1518{
1519 if (!dict->root) return -1; /* Should always have root */
1520
1521 if (!fr_hash_table_insert(dict_gctx->protocol_by_name, dict)) {
1522 fr_dict_t *old_proto;
1523
1524 old_proto = fr_hash_table_find(dict_gctx->protocol_by_name, dict);
1525 if (!old_proto) {
1526 fr_strerror_printf("%s: Failed inserting protocol name %s", __FUNCTION__, dict->root->name);
1527 return -1;
1528 }
1529
1530 if ((strcmp(old_proto->root->name, dict->root->name) == 0) &&
1531 (old_proto->root->name == dict->root->name)) {
1532 fr_strerror_printf("%s: Duplicate protocol name %s", __FUNCTION__, dict->root->name);
1533 return -1;
1534 }
1535
1536 return 0;
1537 }
1538 dict->in_protocol_by_name = true;
1539
1540 if (!fr_hash_table_insert(dict_gctx->protocol_by_num, dict)) {
1541 fr_strerror_printf("%s: Duplicate protocol number %u", __FUNCTION__, dict->root->attr);
1542 return -1;
1543 }
1544 dict->in_protocol_by_num = true;
1545
1546 dict_dependent_add(dict, "global");
1547
1548 /*
1549 * Create and add sub-attributes which allow other
1550 * protocols to be encapsulated in the internal
1551 * namespace.
1552 */
1553 if (dict_gctx->internal && (dict != dict_gctx->internal)) {
1554 fr_dict_attr_t const *da;
1555 fr_dict_attr_flags_t flags = { 0 };
1556
1557 if (!dict_gctx->attr_protocol_encapsulation) dict_gctx->attr_protocol_encapsulation = fr_dict_attr_by_name(NULL, dict_gctx->internal->root, "Proto");
1558 fr_assert(dict_gctx->attr_protocol_encapsulation != NULL);
1559
1560 da = fr_dict_attr_child_by_num(dict_gctx->attr_protocol_encapsulation, dict->root->attr);
1561 if (!da) {
1562 if (fr_dict_attr_add(dict_gctx->internal, dict_gctx->attr_protocol_encapsulation,
1563 dict->root->name, dict->root->attr, FR_TYPE_GROUP, &flags) < 0) {
1564 return -1;
1565 }
1566
1567 da = fr_dict_attr_child_by_num(dict_gctx->attr_protocol_encapsulation, dict->root->attr);
1568 fr_assert(da != NULL);
1569 }
1570
1571 dict_attr_ref_set(da, dict->root, FR_DICT_ATTR_REF_ALIAS);
1572 }
1573
1574 return 0;
1575}
1576
1577/** Add a vendor to the dictionary
1578 *
1579 * Inserts a vendor entry into the vendor hash table. This must be done before adding
1580 * attributes under a VSA.
1581 *
1582 * @param[in] dict of protocol context we're operating in.
1583 * If NULL the internal dictionary will be used.
1584 * @param[in] name of the vendor.
1585 * @param[in] num Vendor's Private Enterprise Number.
1586 * @return
1587 * - 0 on success.
1588 * - -1 on failure.
1589 */
1590int dict_vendor_add(fr_dict_t *dict, char const *name, unsigned int num)
1591{
1592 size_t len;
1593 fr_dict_vendor_t *vendor;
1594
1595 INTERNAL_IF_NULL(dict, -1);
1596
1597 len = strlen(name);
1598 if (len >= FR_DICT_VENDOR_MAX_NAME_LEN) {
1599 fr_strerror_printf("%s: Vendor name too long", __FUNCTION__);
1600 return -1;
1601 }
1602
1603 vendor = talloc_zero(dict, fr_dict_vendor_t);
1604 if (!vendor) {
1605 oom:
1606 fr_strerror_const("Out of memory");
1607 return -1;
1608 }
1609
1610 vendor->name = talloc_typed_strdup(vendor, name);
1611 if (!vendor->name) {
1612 talloc_free(vendor);
1613 goto oom;
1614 }
1615 vendor->pen = num;
1616 vendor->type = vendor->length = 1; /* defaults */
1617
1618 if (!fr_hash_table_insert(dict->vendors_by_name, vendor)) {
1619 fr_dict_vendor_t const *old_vendor;
1620
1621 old_vendor = fr_hash_table_find(dict->vendors_by_name, vendor);
1622 if (!old_vendor) {
1623 fr_strerror_printf("%s: Failed inserting vendor name %s", __FUNCTION__, name);
1624 return -1;
1625 }
1626 if ((strcmp(old_vendor->name, vendor->name) == 0) && (old_vendor->pen != vendor->pen)) {
1627 fr_strerror_printf("%s: Duplicate vendor name %s", __FUNCTION__, name);
1628 return -1;
1629 }
1630
1631 /*
1632 * Already inserted. Discard the duplicate entry.
1633 */
1634 talloc_free(vendor);
1635
1636 return 0;
1637 }
1638
1639 /*
1640 * Insert the SAME pointer (not free'd when this table is
1641 * deleted), into another table.
1642 *
1643 * We want this behaviour because we want OLD names for
1644 * the attributes to be read from the configuration
1645 * files, but when we're printing them, (and looking up
1646 * by value) we want to use the NEW name.
1647 */
1648 if (fr_hash_table_replace(NULL, dict->vendors_by_num, vendor) < 0) {
1649 fr_strerror_printf("%s: Failed inserting vendor %s", __FUNCTION__, name);
1650 return -1;
1651 }
1652
1653 return 0;
1654}
1655
1656/** See if a #fr_dict_attr_t can have children
1657 *
1658 * @param da the dictionary attribute to check.
1659 */
1660bool dict_attr_can_have_children(fr_dict_attr_t const *da)
1661{
1662 switch (da->type) {
1663 case FR_TYPE_TLV:
1664 case FR_TYPE_VENDOR:
1665 case FR_TYPE_VSA:
1666 case FR_TYPE_STRUCT:
1667 case FR_TYPE_UNION:
1668 return true;
1669
1670 default:
1671 break;
1672 }
1673
1674 return false;
1675}
1676
1677/** Add a child to a parent.
1678 *
1679 * @param[in] parent we're adding a child to.
1680 * @param[in] child to add to parent.
1681 * @return
1682 * - 0 on success.
1683 * - -1 on failure (memory allocation error).
1684 */
1685int dict_attr_child_add(fr_dict_attr_t *parent, fr_dict_attr_t *child)
1686{
1687 fr_dict_attr_t const * const *bin;
1688 fr_dict_attr_t **this;
1689 fr_dict_attr_t const **children;
1690
1691 /*
1692 * Setup fields in the child
1693 */
1694 fr_assert(child->parent == parent);
1695
1696 DA_VERIFY(child);
1697
1698 if (fr_dict_attr_ref(parent)) {
1699 fr_strerror_printf("Cannot add children to attribute '%s' which has 'ref=%s'",
1700 parent->name, fr_dict_attr_ref(parent)->name);
1701 return -1;
1702 }
1703
1704 if (!dict_attr_can_have_children(parent)) {
1705 fr_strerror_printf("Cannot add children to attribute '%s' of type %s",
1706 parent->name,
1707 fr_type_to_str(parent->type));
1708 return -1;
1709 }
1710
1711 if ((parent->type == FR_TYPE_VSA) && (child->type != FR_TYPE_VENDOR)) {
1712 fr_strerror_printf("Cannot add non-vendor children to attribute '%s' of type %s",
1713 parent->name,
1714 fr_type_to_str(parent->type));
1715 return -1;
1716 }
1717
1718 /*
1719 * The parent has children by name only, not by number. Don't even bother trying to track
1720 * numbers, except for VENDOR in root, and MEMBER of a struct.
1721 */
1722 if (!parent->flags.is_root && parent->flags.name_only &&
1723 (parent->type != FR_TYPE_STRUCT) && (parent->type != FR_TYPE_TLV)) {
1724 return 0;
1725 }
1726
1727 /*
1728 * We only allocate the pointer array *if* the parent has children.
1729 */
1730 children = dict_attr_children(parent);
1731 if (!children) {
1732 children = talloc_zero_array(parent, fr_dict_attr_t const *, UINT8_MAX + 1);
1733 if (!children) {
1734 fr_strerror_const("Out of memory");
1735 return -1;
1736 }
1737 if (dict_attr_children_set(parent, children) < 0) return -1;
1738 }
1739
1740 /*
1741 * Treat the array as a hash of 255 bins, with attributes
1742 * sorted into bins using num % 255.
1743 *
1744 * Although the various protocols may define numbers higher than 255:
1745 *
1746 * RADIUS/DHCPv4 - 1-255
1747 * Diameter/Internal - 1-4294967295
1748 * DHCPv6 - 1-65535
1749 *
1750 * In reality very few will ever use attribute numbers > 500, so for
1751 * the majority of lookups we get O(1) performance.
1752 *
1753 * Attributes are inserted into the bin in order of their attribute
1754 * numbers to allow slightly more efficient lookups.
1755 */
1756 for (bin = &children[child->attr & 0xff]; *bin; bin = &(*bin)->next) {
1757 /*
1758 * Workaround for vendors that overload the RFC space.
1759 * Structural attributes always take priority.
1760 */
1761 bool child_is_struct = fr_type_is_structural(child->type);
1762 bool bin_is_struct = fr_type_is_structural((*bin)->type);
1763
1764 if (child_is_struct && !bin_is_struct) break;
1765 if (fr_dict_vendor_num_by_da(child) <= fr_dict_vendor_num_by_da(*bin)) break; /* Prioritise RFC attributes */
1766 if (child->attr <= (*bin)->attr) break;
1767 }
1768
1769 memcpy(&this, &bin, sizeof(this));
1770 child->next = *this;
1771 *this = child;
1772
1773 return 0;
1774}
1775
1776/** Add an attribute to the name table for an attribute
1777 *
1778 * @param[in] parent containing the namespace to add this attribute to.
1779 * @param[in] da to add to the name lookup tables.
1780 * @return
1781 * - 0 on success.
1782 * - -1 on failure.
1783 */
1784int dict_attr_add_to_namespace(fr_dict_attr_t const *parent, fr_dict_attr_t *da)
1785{
1786 fr_hash_table_t *namespace;
1787
1788 namespace = dict_attr_namespace(parent);
1789 if (unlikely(!namespace)) {
1790 fr_strerror_printf("Parent \"%s\" has no namespace", parent->name);
1791 error:
1792 return -1;
1793 }
1794
1795 /*
1796 * Sanity check to stop children of vendors ending
1797 * up in the Vendor-Specific or root namespace.
1798 */
1799 if ((fr_dict_vendor_num_by_da(da) != 0) && (da->type != FR_TYPE_VENDOR) &&
1800 ((parent->type == FR_TYPE_VSA) || parent->flags.is_root)) {
1801 fr_strerror_printf("Cannot insert attribute '%s' of type %s into %s",
1802 da->name,
1803 fr_type_to_str(da->type),
1804 parent->name);
1805 goto error;
1806 }
1807
1808 /*
1809 * Insert the attribute, only if it's not a duplicate.
1810 */
1811 if (!fr_hash_table_insert(namespace, da)) {
1812 fr_dict_attr_t *a;
1813
1814 /*
1815 * Find the old name. If it's the same name and
1816 * but the parent, or number, or type are
1817 * different, that's an error.
1818 */
1819 a = fr_hash_table_find(namespace, da);
1820 if (a && (strcasecmp(a->name, da->name) == 0)) {
1821 if ((a->attr != da->attr) || (a->type != da->type) || (a->parent != da->parent)) {
1822 fr_strerror_printf("Duplicate attribute name '%s' in namespace '%s'. "
1823 "Originally defined %s[%d]",
1824 da->name, parent->name,
1825 a->filename, a->line);
1826 goto error;
1827 }
1828 }
1829
1830 /*
1831 * Otherwise the attribute has been redefined later
1832 * in the dictionary.
1833 *
1834 * The original fr_dict_attr_t remains in the
1835 * dictionary but entry in the name hash table is
1836 * updated to point to the new definition.
1837 */
1838 if (fr_hash_table_replace(NULL, namespace, da) < 0) {
1839 fr_strerror_const("Internal error storing attribute");
1840 goto error;
1841 }
1842 }
1843
1844 return 0;
1845}
1846
1847/** A variant of fr_dict_attr_t that allows a pre-allocated, populated fr_dict_attr_t to be added
1848 *
1849 */
1850int fr_dict_attr_add_initialised(fr_dict_attr_t *da)
1851{
1852 fr_dict_attr_t const *exists;
1853
1854 if (unlikely(da->dict->read_only)) {
1855 fr_strerror_printf("%s dictionary has been marked as read only", fr_dict_root(da->dict)->name);
1856 return -1;
1857 }
1858
1859 if (unlikely(da->state.finalised == false)) {
1860 fr_strerror_const("Attribute has not been finalised");
1861 return -1;
1862 }
1863
1864 /*
1865 * Check that the definition is valid.
1866 */
1867 if (!dict_attr_valid(da)) return -1;
1868
1869 /*
1870 * Don't allow duplicate names
1871 *
1872 * Previously we allowed duplicate names, but only if the
1873 * attributes were compatible (we'd just ignore the operation).
1874 *
1875 * But as attribute parsing may have generated fixups, which
1876 * we'd now need to unpick, it's easier just to error out
1877 * and have the user fix the duplicate.
1878 */
1879 exists = fr_dict_attr_by_name(NULL, da->parent, da->name);
1880 if (exists) {
1881 fr_strerror_printf("Duplicate attribute name '%s' in namespace '%s'. "
1882 "Originally defined %s[%d]", da->name, da->parent->name,
1883 exists->filename, exists->line);
1884 return -1;
1885 }
1886
1887 /*
1888 * In some cases name_only attributes may have explicitly
1889 * assigned numbers. Ensure that there are no conflicts
1890 * between auto-assigned and explkicitly assigned.
1891 */
1892 if (da->flags.name_only) {
1893 if (da->state.attr_set) {
1894 fr_dict_attr_t *parent = fr_dict_attr_unconst(da->parent);
1895
1896 if (da->attr > da->parent->last_child_attr) {
1897 parent->last_child_attr = da->attr;
1898
1899 /*
1900 * If the attribute is outside of the bounds of
1901 * the type size, then it MUST be an internal
1902 * attribute. Set the flag in this attribute, so
1903 * that the encoder doesn't have to do complex
1904 * checks.
1905 */
1906 if ((da->attr >= (((uint64_t)1) << (8 * parent->flags.type_size)))) da->flags.internal = true;
1907 }
1908 } else if (unlikely(dict_attr_num_init_name_only(da)) < 0) {
1909 return -1;
1910 }
1911 }
1912
1913 /*
1914 * Attributes can also be indexed by number. Ensure that
1915 * all attributes of the same number have the same
1916 * properties.
1917 */
1918 exists = fr_dict_attr_child_by_num(da->parent, da->attr);
1919 if (exists) {
1920 fr_strerror_printf("Duplicate attribute number %u in namespace '%s'. "
1921 "Originally defined by '%s' at %s[%d]",
1922 da->attr, da->parent->name, exists->name, exists->filename, exists->line);
1923 return -1;
1924 }
1925
1926 /*
1927 * Add in by number
1928 */
1929 if (dict_attr_child_add(UNCONST(fr_dict_attr_t *, da->parent), da) < 0) return -1;
1930
1931 /*
1932 * Add in by name
1933 */
1934 if (dict_attr_add_to_namespace(da->parent, da) < 0) return -1;
1935
1936#ifndef NDEBUG
1937 {
1938 fr_dict_attr_t const *found;
1939
1940 /*
1941 * Check if we added the attribute
1942 */
1943 found = dict_attr_child_by_num(da->parent, da->attr);
1944 if (!found) {
1945 fr_strerror_printf("FATAL - Failed to find attribute number %u we just added to namespace '%s'", da->attr, da->parent->name);
1946 return -1;
1947 }
1948
1949 if (!dict_attr_by_name(NULL, da->parent, da->name)) {
1950 fr_strerror_printf("FATAL - Failed to find attribute '%s' we just added to namespace '%s'", da->name, da->parent->name);
1951 return -1;
1952 }
1953 }
1954#endif
1955
1956 return 0;
1957}
1958
1959/** Add an attribute to the dictionary
1960 *
1961 * @param[in] dict of protocol context we're operating in.
1962 * If NULL the internal dictionary will be used.
1963 * @param[in] parent to add attribute under.
1964 * @param[in] name of the attribute.
1965 * @param[in] attr number.
1966 * @param[in] type of attribute.
1967 * @param[in] flags to set in the attribute.
1968 * @return
1969 * - 0 on success.
1970 * - -1 on failure.
1971 */
1972int fr_dict_attr_add(fr_dict_t *dict, fr_dict_attr_t const *parent,
1973 char const *name, unsigned int attr, fr_type_t type, fr_dict_attr_flags_t const *flags)
1974{
1975 fr_dict_attr_t *da;
1976
1977 if (fr_dict_attr_ref(parent)) {
1978 fr_strerror_printf("Cannot add children to attribute '%s' which has 'ref=%s'",
1979 parent->name, fr_dict_attr_ref(parent)->name);
1980 return -1;
1981 }
1982
1983 if (!dict_attr_can_have_children(parent)) {
1984 fr_strerror_printf("Cannot add children to attribute '%s' of type %s",
1985 parent->name,
1986 fr_type_to_str(parent->type));
1987 return -1;
1988 }
1989
1990 da = dict_attr_alloc_null(dict->pool, dict->proto);
1991 if (unlikely(!da)) return -1;
1992
1993 if (dict_attr_init(&da, parent, name,
1994 attr, type, &(dict_attr_args_t){ .flags = flags}) < 0) return -1;
1995
1996 return fr_dict_attr_add_initialised(da);
1997}
1998
1999/** Add an attribute to the dictionary
2000 *
2001 * @param[in] dict of protocol context we're operating in.
2002 * If NULL the internal dictionary will be used.
2003 * @param[in] parent to add attribute under.
2004 * @param[in] name of the attribute.
2005 * @param[in] type of attribute.
2006 * @param[in] flags to set in the attribute.
2007 * @return
2008 * - 0 on success.
2009 * - -1 on failure.
2010 */
2011int fr_dict_attr_add_name_only(fr_dict_t *dict, fr_dict_attr_t const *parent,
2012 char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags)
2013{
2014 fr_dict_attr_t *da;
2015
2016 da = dict_attr_alloc_null(dict->pool, dict->proto);
2017 if (unlikely(!da)) return -1;
2018
2019 if (dict_attr_init_name_only(&da, parent, name,type, &(dict_attr_args_t){ .flags = flags}) < 0) return -1;
2020
2021 return fr_dict_attr_add_initialised(da);
2022}
2023
2024
2025int dict_attr_enum_add_name(fr_dict_attr_t *da, char const *name,
2026 fr_value_box_t const *value,
2027 bool coerce, bool takes_precedence,
2028 fr_dict_attr_t const *key_child_ref)
2029{
2030 size_t len;
2031 fr_dict_enum_value_t *enumv = NULL;
2032 fr_value_box_t *enum_value = NULL;
2033 fr_dict_attr_ext_enumv_t *ext;
2034
2035 if (!da) {
2036 fr_strerror_printf("%s: Dictionary attribute not specified", __FUNCTION__);
2037 return -1;
2038 }
2039
2040 if (!*name) {
2041 fr_strerror_printf("%s: Empty names are not permitted", __FUNCTION__);
2042 return -1;
2043 }
2044
2045 len = strlen(name);
2046 if (len >= FR_DICT_ENUM_MAX_NAME_LEN) {
2047 fr_strerror_printf("VALUE name is too long");
2048 return -1;
2049 }
2050
2051 /*
2052 * If the parent isn't a key field, then we CANNOT add a child struct.
2053 */
2054 if (!fr_dict_attr_is_key_field(da) && key_child_ref) {
2055 fr_strerror_const("Child attributes cannot be defined for VALUEs which are not 'key' attributes");
2056 return -1;
2057 }
2058
2059 if (fr_type_is_structural(da->type) || (da->type == FR_TYPE_STRING)) {
2060 fr_strerror_printf("Enumeration names cannot be added for data type '%s'", fr_type_to_str(da->type));
2061 return -1;
2062 }
2063
2064 if (da->flags.is_alias) {
2065 fr_strerror_printf("Enumeration names cannot be added for ALIAS '%s'", da->name);
2066 return -1;
2067 }
2068
2069 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
2070 if (!ext) {
2071 fr_strerror_printf("VALUE cannot be defined for %s", da->name);
2072 return -1;
2073 }
2074
2075 /*
2076 * Initialise enumv hash tables
2077 */
2078 if (!ext->value_by_name || !ext->name_by_value) {
2079 ext->value_by_name = fr_hash_table_talloc_alloc(da, fr_dict_enum_value_t, dict_enum_name_hash,
2080 dict_enum_name_cmp, hash_pool_free);
2081 if (!ext->value_by_name) {
2082 fr_strerror_printf("Failed allocating \"value_by_name\" table");
2083 return -1;
2084 }
2085
2086 ext->name_by_value = fr_hash_table_talloc_alloc(da, fr_dict_enum_value_t, dict_enum_value_hash,
2087 dict_enum_value_cmp, NULL);
2088 if (!ext->name_by_value) {
2089 fr_strerror_printf("Failed allocating \"name_by_value\" table");
2090 return -1;
2091 }
2092 }
2093
2094 /*
2095 * Allocate a structure to map between
2096 * the name and value.
2097 */
2098 enumv = talloc_zero_size(da, sizeof(fr_dict_enum_value_t));
2099 if (!enumv) {
2100 oom:
2101 fr_strerror_printf("%s: Out of memory", __FUNCTION__);
2102 return -1;
2103 }
2104 talloc_set_type(enumv, fr_dict_enum_value_t);
2105
2106 enumv->name = talloc_typed_strdup(enumv, name);
2107 enumv->name_len = len;
2108
2109 if (key_child_ref) {
2110 fr_dict_enum_ext_attr_ref_t *ref;
2111
2112 ref = dict_enum_ext_alloc(&enumv, FR_DICT_ENUM_EXT_ATTR_REF);
2113 if (!ref) goto oom;
2114
2115 ref->da = key_child_ref;
2116 }
2117
2118 enum_value = fr_value_box_alloc(enumv, da->type, NULL);
2119 if (!enum_value) goto oom;
2120
2121 if (da->type != value->type) {
2122 if (!coerce) {
2123 fr_strerror_printf("Type mismatch between attribute (%s) and enum (%s)",
2124 fr_type_to_str(da->type),
2125 fr_type_to_str(value->type));
2126 return -1;
2127 }
2128
2129 if (fr_value_box_cast(enumv, enum_value, da->type, NULL, value) < 0) {
2130 fr_strerror_printf_push("Failed coercing enum type (%s) to attribute type (%s)",
2131 fr_type_to_str(value->type),
2132 fr_type_to_str(da->type));
2133
2134 return -1;
2135 }
2136 } else {
2137 if (unlikely(fr_value_box_copy(enum_value, enum_value, value) < 0)) {
2138 fr_strerror_printf_push("%s: Failed copying value into enum", __FUNCTION__);
2139 return -1;
2140 }
2141 }
2142
2143 enumv->value = enum_value;
2144
2145 /*
2146 * Add the value into the dictionary.
2147 */
2148 {
2149 fr_dict_attr_t *tmp;
2150 memcpy(&tmp, &enumv, sizeof(tmp));
2151
2152 if (!fr_hash_table_insert(ext->value_by_name, tmp)) {
2153 fr_dict_enum_value_t const *old;
2154
2155 /*
2156 * Suppress duplicates with the same
2157 * name and value. There are lots in
2158 * dictionary.ascend.
2159 */
2160 old = fr_dict_enum_by_name(da, name, -1);
2161 if (!fr_cond_assert(old)) return -1;
2162
2163 if (fr_value_box_cmp(old->value, enumv->value) == 0) {
2164 talloc_free(enumv);
2165 return 0;
2166 }
2167
2168 fr_strerror_printf("Duplicate VALUE name \"%s\" for Attribute '%s'. "
2169 "Old value was \"%pV\", new value was \"%pV\"", name, da->name,
2170 old->value, enumv->value);
2171 talloc_free(enumv);
2172 return -1;
2173 }
2174
2175 if (enumv->name_len > ext->max_name_len) ext->max_name_len = enumv->name_len;
2176 }
2177
2178 /*
2179 * There are multiple VALUE's, keyed by attribute, so we
2180 * take care of that here.
2181 */
2182 if (takes_precedence) {
2183 if (fr_hash_table_replace(NULL, ext->name_by_value, enumv) < 0) {
2184 fr_strerror_printf("%s: Failed inserting value %s", __FUNCTION__, name);
2185 return -1;
2186 }
2187 } else {
2188 (void) fr_hash_table_insert(ext->name_by_value, enumv);
2189 }
2190
2191 /*
2192 * Mark the attribute up as having an enumv
2193 */
2194 UNCONST(fr_dict_attr_t *, da)->flags.has_value = 1;
2195
2196 return 0;
2197}
2198
2199/** Add a value name
2200 *
2201 * Aliases are textual (string) names for a given value.
2202 *
2203 * Value names are not limited to integers, and may be added for any non-structural
2204 * attribute type.
2205 *
2206 * @param[in] da to add enumeration value to.
2207 * @param[in] name Name of value name.
2208 * @param[in] value to associate with name.
2209 * @param[in] coerce if the type of the value does not match the
2210 * type of the da, attempt to cast it to match
2211 * the type of the da. If this is false and there's
2212 * a type mismatch, we fail.
2213 * We also fail if the value cannot be coerced to
2214 * the attribute type.
2215 * @param[in] takes_precedence This name should take precedence over previous
2216 * names for the same value, when resolving value
2217 * to name.
2218 * @return
2219 * - 0 on success.
2220 * - -1 on failure.
2221 */
2222int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name,
2223 fr_value_box_t const *value,
2224 bool coerce, bool takes_precedence)
2225{
2226 return dict_attr_enum_add_name(da, name, value, coerce, takes_precedence, NULL);
2227}
2228
2229/** Add an name to an integer attribute hashing the name for the integer value
2230 *
2231 * If the integer value conflicts with an existing name, it's incremented
2232 * until we find a free value.
2233 */
2234int fr_dict_enum_add_name_next(fr_dict_attr_t *da, char const *name)
2235{
2236 fr_value_box_t v = {
2237 .type = da->type
2238 };
2239 fr_value_box_t s = {
2240 .type = da->type
2241 };
2242
2243 if (fr_dict_enum_by_name(da, name, -1)) return 0;
2244
2245 switch (da->type) {
2246 case FR_TYPE_INT8:
2247 v.vb_int8 = s.vb_int8 = fr_hash_string(name) & INT8_MAX;
2248 break;
2249
2250 case FR_TYPE_INT16:
2251 v.vb_int16 = s.vb_int16 = fr_hash_string(name) & INT16_MAX;
2252 break;
2253
2254 case FR_TYPE_INT32:
2255 v.vb_int32 = s.vb_int32 = fr_hash_string(name) & INT32_MAX;
2256 break;
2257
2258 case FR_TYPE_INT64:
2259 v.vb_int64 = s.vb_int64 = fr_hash_string(name) & INT64_MAX;
2260 break;
2261
2262 case FR_TYPE_UINT8:
2263 v.vb_uint8 = s.vb_uint8 = fr_hash_string(name) & UINT8_MAX;
2264 break;
2265
2266 case FR_TYPE_UINT16:
2267 v.vb_uint16 = s.vb_uint16 = fr_hash_string(name) & UINT16_MAX;
2268 break;
2269
2270 case FR_TYPE_UINT32:
2271 v.vb_uint32 = s.vb_uint32 = fr_hash_string(name) & UINT32_MAX;
2272 break;
2273
2274 case FR_TYPE_UINT64:
2275 v.vb_uint64 = s.vb_uint64 = fr_hash_string(name) & UINT64_MAX;
2276 break;
2277
2278 default:
2279 fr_strerror_printf("Attribute is wrong type for auto-numbering, expected numeric type, got %s",
2280 fr_type_to_str(da->type));
2281 return -1;
2282 }
2283
2284 /*
2285 * If there's no existing value, add an enum
2286 * with the hash value of the name.
2287 *
2288 * This helps with debugging as the values
2289 * are consistent.
2290 */
2291 if (!fr_dict_enum_by_value(da, &v)) {
2292 add:
2293 return fr_dict_enum_add_name(da, name, &v, false, false);
2294 }
2295
2296 for (;;) {
2297 fr_value_box_increment(&v);
2298
2299 if (fr_value_box_cmp_op(T_OP_CMP_EQ, &v, &s) == 0) {
2300 fr_strerror_const("No free integer values for enumeration");
2301 return -1;
2302 }
2303
2304 if (!fr_dict_enum_by_value(da, &v)) goto add;
2305 }
2306 /* NEVER REACHED */
2307}
2308
2309/** Find a common ancestor that two TLV type attributes share
2310 *
2311 * @param[in] a first TLV attribute.
2312 * @param[in] b second TLV attribute.
2313 * @param[in] is_ancestor Enforce a->b relationship (a is parent or ancestor of b).
2314 * @return
2315 * - Common ancestor if one exists.
2316 * - NULL if no common ancestor exists.
2317 */
2318fr_dict_attr_t const *fr_dict_attr_common_parent(fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor)
2319{
2320 unsigned int i;
2321 fr_dict_attr_t const *p_a, *p_b;
2322
2323 if (!a || !b) return NULL;
2324
2325 if (is_ancestor && (b->depth <= a->depth)) return NULL; /* fast_path */
2326
2327 /*
2328 * Find a common depth to work back from
2329 */
2330 if (a->depth > b->depth) {
2331 p_b = b;
2332 for (p_a = a, i = a->depth - b->depth; p_a && (i > 0); p_a = p_a->parent, i--);
2333 if (is_ancestor && (p_a != p_b)) return NULL;
2334 } else if (a->depth < b->depth) {
2335 p_a = a;
2336 for (p_b = b, i = b->depth - a->depth; p_b && (i > 0); p_b = p_b->parent, i--);
2337 if (is_ancestor && (p_a != p_b)) return NULL;
2338 } else {
2339 p_a = a;
2340 p_b = b;
2341 }
2342
2343 while (p_a && p_b) {
2344 if (p_a == p_b) return p_a;
2345
2346 p_a = p_a->parent;
2347 p_b = p_b->parent;
2348 }
2349
2350 return NULL;
2351}
2352
2353/** Process a single OID component
2354 *
2355 * @param[out] out Value of component.
2356 * @param[in] oid string to parse.
2357 * @return
2358 * - 0 on success.
2359 * - -1 on format error.
2360 */
2361int fr_dict_oid_component_legacy(unsigned int *out, char const **oid)
2362{
2363 char const *p = *oid;
2364 char *q;
2365 unsigned long num;
2366
2367 *out = 0;
2368
2369 num = strtoul(p, &q, 10);
2370 if ((p == q) || (num == ULONG_MAX)) {
2371 fr_strerror_printf("Invalid OID component \"%s\" (%lu)", p, num);
2372 return -1;
2373 }
2374
2375 switch (*q) {
2376 case '\0':
2377 case '.':
2378 *oid = q;
2379 *out = (unsigned int)num;
2380
2381 return 0;
2382
2383 default:
2384 fr_strerror_const("Unexpected text after OID component");
2385 *out = 0;
2386 return -1;
2387 }
2388}
2389
2390/** Get the leaf attribute of an OID string
2391 *
2392 * @note On error, vendor will be set (if present), parent will be the
2393 * maximum depth we managed to resolve to, and attr will be the child
2394 * we failed to resolve.
2395 *
2396 * @param[out] attr Number we parsed.
2397 * @param[in,out] parent attribute (or root of dictionary).
2398 * Will be updated to the parent directly beneath the leaf.
2399 * @param[in] oid string to parse.
2400 * @return
2401 * - > 0 on success (number of bytes parsed).
2402 * - <= 0 on parse error (negative offset of parse error).
2403 */
2404ssize_t fr_dict_attr_by_oid_legacy(fr_dict_attr_t const **parent, unsigned int *attr, char const *oid)
2405{
2406 char const *p = oid;
2407 unsigned int num = 0;
2408 ssize_t slen;
2409
2410 if (!*parent) return -1;
2411
2412 /*
2413 * It's a partial OID. Grab it, and skip to the next bit.
2414 */
2415 if (p[0] == '.') {
2416 p++;
2417 }
2418
2419 *attr = 0;
2420
2421 if (fr_dict_oid_component_legacy(&num, &p) < 0) return oid - p;
2422
2423 /*
2424 * Record progress even if we error out.
2425 *
2426 * Don't change this, you will break things.
2427 */
2428 *attr = num;
2429
2430 /*
2431 * Only a limited number of structural types can have children. Specifically, groups cannot.
2432 */
2433 if (!dict_attr_can_have_children(*parent)) {
2434 fr_strerror_printf("Attribute %s (%u) cannot contain a child attribute. "
2435 "Error at sub OID \"%s\"", (*parent)->name, (*parent)->attr, oid);
2436 return 0; /* We parsed nothing */
2437 }
2438
2439 switch (p[0]) {
2440 /*
2441 * We've not hit the leaf yet, so the attribute must be
2442 * defined already.
2443 */
2444 case '.':
2445 {
2446 fr_dict_attr_t const *child;
2447 p++;
2448
2449 child = dict_attr_child_by_num(*parent, num);
2450 if (!child) {
2451 fr_strerror_printf("Unknown attribute '%u' in OID string \"%s\" for parent %s",
2452 num, oid, (*parent)->name);
2453 return 0; /* We parsed nothing */
2454 }
2455
2456 /*
2457 * Record progress even if we error out.
2458 *
2459 * Don't change this, you will break things.
2460 */
2461 *parent = child;
2462
2463 slen = fr_dict_attr_by_oid_legacy(parent, attr, p);
2464 if (slen <= 0) return slen - (p - oid);
2465 return slen + (p - oid);
2466 }
2467
2468 /*
2469 * Hit the leaf, this is the attribute we need to define.
2470 */
2471 case '\0':
2472 *attr = num;
2473 return p - oid;
2474
2475 default:
2476 fr_strerror_printf("Malformed OID string, got trailing garbage '%s'", p);
2477 return oid - p;
2478 }
2479}
2480
2481/** Parse an OID component, resolving it to a defined attribute
2482 *
2483 * @note Will leave the sbuff pointing at the component the error occurred at
2484 * so that the caller can attempt to process the component in another way.
2485 *
2486 * @param[out] err The parsing error that occurred.
2487 * @param[out] out The deepest attribute we resolved.
2488 * @param[in] parent Where to resolve relative attributes from.
2489 * @param[in] in string to parse.
2490 * @param[in] tt Terminal strings.
2491 * @return
2492 * - >0 the number of bytes consumed.
2493 * - <0 Parse error occurred here.
2494 */
2495fr_slen_t fr_dict_oid_component(fr_dict_attr_err_t *err,
2496 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
2497 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
2498{
2499 fr_sbuff_t our_in = FR_SBUFF(in);
2500 uint32_t num = 0;
2501 fr_sbuff_parse_error_t sberr;
2502 fr_dict_attr_t const *child;
2503
2504 if (err) *err = FR_DICT_ATTR_OK;
2505
2506 *out = NULL;
2507
2508 if (!dict_attr_can_have_children(parent)) {
2509 fr_strerror_printf("Attribute '%s' is type %s and cannot contain child attributes. "
2510 "Error at OID \"%.*s\"",
2511 parent->name,
2512 fr_type_to_str(parent->type),
2513 (int)fr_sbuff_remaining(&our_in),
2514 fr_sbuff_current(&our_in));
2515 if (err) *err = FR_DICT_ATTR_NO_CHILDREN;
2516 FR_SBUFF_ERROR_RETURN(&our_in);
2517 }
2518
2519 if (fr_dict_attr_by_name_substr(err, &child, parent, &our_in, tt) > 0) goto done;
2520
2521 fr_sbuff_out(&sberr, &num, &our_in);
2522 switch (sberr) {
2523 /*
2524 * Lookup by number
2525 */
2526 case FR_SBUFF_PARSE_OK:
2527 if (!fr_sbuff_is_char(&our_in, '.') && !fr_sbuff_is_terminal(&our_in, tt)) {
2528 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
2529 fr_strerror_printf("Invalid OID component (%s) \"%.*s\"",
2530 fr_table_str_by_value(sbuff_parse_error_table, sberr, "<INVALID>"),
2531 (int)fr_sbuff_remaining(&our_in), fr_sbuff_current(&our_in));
2532 goto fail;
2533 }
2534
2535 child = dict_attr_child_by_num(parent, num);
2536 if (!child) {
2537 fr_sbuff_set_to_start(&our_in);
2538 fr_strerror_printf("Failed resolving child %u in namespace '%s'",
2539 num, parent->name);
2540 if (err) *err = FR_DICT_ATTR_NOTFOUND;
2541 FR_SBUFF_ERROR_RETURN(&our_in);
2542 }
2543
2544 if (err) *err = FR_DICT_ATTR_OK;
2545 break;
2546
2547 case FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW:
2548 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
2549
2550 fr_sbuff_set_to_start(&our_in);
2551
2552 {
2553 fr_sbuff_marker_t c_start;
2554
2555 fr_sbuff_marker(&c_start, &our_in);
2556 fr_sbuff_adv_past_allowed(&our_in, FR_DICT_ATTR_MAX_NAME_LEN, fr_dict_attr_allowed_chars, NULL);
2557 fr_strerror_printf("Invalid value \"%.*s\" - attribute numbers must be less than 2^32",
2558 (int)fr_sbuff_behind(&c_start), fr_sbuff_current(&c_start));
2559 }
2560 FR_SBUFF_ERROR_RETURN(&our_in);
2561
2562 default:
2563 fail:
2564 /*
2565 * Leave *err from the call to fr_dict_attr_by_name_substr().
2566 */
2567 fr_sbuff_set_to_start(&our_in);
2568 FR_SBUFF_ERROR_RETURN(&our_in);
2569 }
2570
2571done:
2572 child = dict_attr_alias(err, child);
2573 if (unlikely(!child)) FR_SBUFF_ERROR_RETURN(&our_in);
2574
2575 *out = child;
2576
2577 FR_SBUFF_SET_RETURN(in, &our_in);
2578}
2579
2580/** Resolve an attribute using an OID string
2581 *
2582 * @note Will leave the sbuff pointing at the component the error occurred at
2583 * so that the caller can attempt to process the component in another way.
2584 * An err pointer should be provided in order to determine if an error
2585 * occurred.
2586 *
2587 * @param[out] err The parsing error that occurred.
2588 * @param[out] out The deepest attribute we resolved.
2589 * @param[in] parent Where to resolve relative attributes from.
2590 * @param[in] in string to parse.
2591 * @param[in] tt Terminal strings.
2592 * @return The number of bytes of name consumed.
2593 */
2594fr_slen_t fr_dict_attr_by_oid_substr(fr_dict_attr_err_t *err,
2595 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
2596 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
2597{
2598 fr_sbuff_t our_in = FR_SBUFF(in);
2599 fr_sbuff_marker_t m_c;
2600 fr_dict_attr_t const *our_parent = parent;
2601
2602 fr_sbuff_marker(&m_c, &our_in);
2603
2604 /*
2605 * If the OID doesn't begin with '.' we
2606 * resolve it from the root.
2607 */
2608#if 0
2609 if (!fr_sbuff_next_if_char(&our_in, '.')) our_parent = fr_dict_root(fr_dict_by_da(parent));
2610#else
2611 (void) fr_sbuff_next_if_char(&our_in, '.');
2612#endif
2613 *out = NULL;
2614
2615 for (;;) {
2616 fr_dict_attr_t const *child;
2617
2618 if ((fr_dict_oid_component(err, &child, our_parent, &our_in, tt) < 0) || !child) {
2619 *out = our_parent;
2620 fr_sbuff_set(&our_in, &m_c); /* Reset to the start of the last component */
2621 break; /* Resolved as much as we can */
2622 }
2623
2624 our_parent = child;
2625 *out = child;
2626
2627 fr_sbuff_set(&m_c, &our_in);
2628 if (!fr_sbuff_next_if_char(&our_in, '.')) break;
2629 }
2630
2631 FR_SBUFF_SET_RETURN(in, &our_in);
2632}
2633
2634/** Resolve an attribute using an OID string
2635 *
2636 * @param[out] err The parsing error that occurred.
2637 * @param[in] parent Where to resolve relative attributes from.
2638 * @param[in] oid string to parse.
2639 * @return
2640 * - NULL if we couldn't resolve the attribute.
2641 * - The resolved attribute.
2642 */
2643fr_dict_attr_t const *fr_dict_attr_by_oid(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *oid)
2644{
2645 fr_sbuff_t sbuff = FR_SBUFF_IN(oid, strlen(oid));
2646 fr_dict_attr_t const *da;
2647
2648 if (fr_dict_attr_by_oid_substr(err, &da, parent, &sbuff, NULL) <= 0) return NULL;
2649 if (err && *err != FR_DICT_ATTR_OK) return NULL;
2650
2651 /*
2652 * If we didn't parse the entire string, then the parsing stopped at an unknown child.
2653 * e.g. Vendor-Specific.Cisco.Foo. In that case, the full attribute wasn't found.
2654 */
2655 if (fr_sbuff_remaining(&sbuff) > 0) {
2656 if (err) *err = FR_DICT_ATTR_NOTFOUND;
2657 return NULL;
2658 }
2659
2660 return da;
2661}
2662
2663/** Return the root attribute of a dictionary
2664 *
2665 * @param dict to return root for.
2666 * @return the root attribute of the dictionary.
2667 *
2668 * @hidecallergraph
2669 */
2670fr_dict_attr_t const *fr_dict_root(fr_dict_t const *dict)
2671{
2672 return dict->root;
2673}
2674
2675bool fr_dict_is_read_only(fr_dict_t const *dict)
2676{
2677 return dict->read_only;
2678}
2679
2680dl_t *fr_dict_dl(fr_dict_t const *dict)
2681{
2682 return dict->dl;
2683}
2684
2685fr_slen_t dict_by_protocol_substr(fr_dict_attr_err_t *err,
2686 fr_dict_t **out, fr_sbuff_t *name, fr_dict_t const *dict_def)
2687{
2688 fr_dict_attr_t root;
2689
2690 fr_sbuff_t our_name;
2691 fr_dict_t *dict;
2692 fr_slen_t slen;
2693 char buffer[FR_DICT_ATTR_MAX_NAME_LEN + 1 + 1]; /* +1 \0 +1 for "too long" */
2694
2695 if (!dict_gctx || !name || !out) {
2696 if (err) *err = FR_DICT_ATTR_EINVAL;
2697 if (name) FR_SBUFF_ERROR_RETURN(name);
2698 return 0;
2699 }
2700
2701 our_name = FR_SBUFF(name);
2702 memset(&root, 0, sizeof(root));
2703
2704 /*
2705 * Advance p until we get something that's not part of
2706 * the dictionary attribute name.
2707 */
2708 slen = fr_sbuff_out_bstrncpy_allowed(&FR_SBUFF_OUT(buffer, sizeof(buffer)),
2709 &our_name, SIZE_MAX,
2710 fr_dict_attr_allowed_chars);
2711 if (slen == 0) {
2712 fr_strerror_const("Zero length attribute name");
2713 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
2714 FR_SBUFF_ERROR_RETURN(&our_name);
2715 }
2716 if (slen > FR_DICT_ATTR_MAX_NAME_LEN) {
2717 fr_strerror_const("Attribute name too long");
2718 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
2719 FR_SBUFF_ERROR_RETURN(&our_name);
2720 }
2721
2722 /*
2723 * The remaining operations don't generate errors
2724 */
2725 if (err) *err = FR_DICT_ATTR_OK;
2726
2727 /*
2728 * If what we stopped at wasn't a '.', then there
2729 * can't be a protocol name in this string.
2730 */
2731 if (*(our_name.p) && (*(our_name.p) != '.')) {
2732 memcpy(out, &dict_def, sizeof(*out));
2733 return 0;
2734 }
2735
2736 root.name = buffer;
2737 dict = fr_hash_table_find(dict_gctx->protocol_by_name, &(fr_dict_t){ .root = &root });
2738
2739 if (!dict) {
2740 if (strcasecmp(root.name, "internal") != 0) {
2741 fr_strerror_printf("Unknown protocol '%s'", root.name);
2742 memcpy(out, &dict_def, sizeof(*out));
2743 fr_sbuff_set_to_start(&our_name);
2744 FR_SBUFF_ERROR_RETURN(&our_name);
2745 }
2746
2747 dict = dict_gctx->internal;
2748 }
2749
2750 *out = dict;
2751
2752 FR_SBUFF_SET_RETURN(name, &our_name);
2753}
2754
2755/** Look up a protocol name embedded in another string
2756 *
2757 * @param[out] err Parsing error.
2758 * @param[out] out the resolve dictionary or NULL if the dictionary
2759 * couldn't be resolved.
2760 * @param[in] name string start.
2761 * @param[in] dict_def The dictionary to return if no dictionary qualifier was found.
2762 * @return
2763 * - 0 and *out != NULL. Couldn't find a dictionary qualifier, so returned dict_def.
2764 * - < 0 on error and (*out == NULL) (offset as negative integer)
2765 * - > 0 on success (number of bytes parsed).
2766 */
2771
2772/** Internal version of #fr_dict_by_protocol_name
2773 *
2774 * @note For internal use by the dictionary API only.
2775 *
2776 * @copybrief fr_dict_by_protocol_name
2777 */
2778fr_dict_t *dict_by_protocol_name(char const *name)
2779{
2780 if (!dict_gctx || !name) return NULL;
2781
2782 return fr_hash_table_find(dict_gctx->protocol_by_name,
2783 &(fr_dict_t){ .root = &(fr_dict_attr_t){ .name = name } });
2784}
2785
2786/** Internal version of #fr_dict_by_protocol_num
2787 *
2788 * @note For internal use by the dictionary API only.
2789 *
2790 * @copybrief fr_dict_by_protocol_num
2791 */
2792fr_dict_t *dict_by_protocol_num(unsigned int num)
2793{
2794 if (!dict_gctx) return NULL;
2795
2796 return fr_hash_table_find(dict_gctx->protocol_by_num,
2797 &(fr_dict_t) { .root = &(fr_dict_attr_t){ .attr = num } });
2798}
2799
2800/** Internal version of #fr_dict_by_da
2801 *
2802 * @note For internal use by the dictionary API only.
2803 *
2804 * @copybrief fr_dict_by_da
2805 */
2806fr_dict_t *dict_by_da(fr_dict_attr_t const *da)
2807{
2808#ifndef NDEBUG
2809 {
2810 fr_dict_attr_t const *da_p = da;
2811 fr_dict_t const *dict;
2812
2813 dict = da->dict;
2814 while (da_p->parent) {
2815 da_p = da_p->parent;
2816 fr_cond_assert_msg(da_p->dict == dict, "Inconsistent dict membership. "
2817 "Expected %s, got %s",
2818 !da_p->dict ? "(null)" : fr_dict_root(da_p->dict)->name,
2819 !dict ? "(null)" : fr_dict_root(dict)->name);
2820 DA_VERIFY(da_p);
2821 }
2822
2823 if (!da_p->flags.is_root) {
2824 fr_strerror_printf("%s: Attribute %s has not been inserted into a dictionary",
2825 __FUNCTION__, da->name);
2826 return NULL;
2827 }
2828 }
2829#endif
2830
2831 /*
2832 * Parent of the root attribute must
2833 * be the dictionary.
2834 */
2835 return talloc_get_type_abort(da->dict, fr_dict_t);
2836}
2837
2838/** Lookup a protocol by its name
2839 *
2840 * @note For internal use by the dictionary API only.
2841 *
2842 * @param[in] name of the protocol to locate.
2843 * @return
2844 * - Attribute matching name.
2845 * - NULL if no matching protocol could be found.
2846 */
2847fr_dict_t const *fr_dict_by_protocol_name(char const *name)
2848{
2849 return dict_by_protocol_name(name);
2850}
2851
2852/** Lookup a protocol by its number
2853 *
2854 * Returns the #fr_dict_t belonging to the protocol with the specified number
2855 * if any have been registered.
2856 *
2857 * @param[in] num to search for.
2858 * @return dictionary representing the protocol (if it exists).
2859 */
2860fr_dict_t const *fr_dict_by_protocol_num(unsigned int num)
2861{
2862 return dict_by_protocol_num(num);
2863}
2864
2865/** Attempt to locate the protocol dictionary containing an attribute
2866 *
2867 * @note Unlike fr_dict_by_attr_name, doesn't search through all the dictionaries,
2868 * just uses the fr_dict_attr_t hierarchy and the talloc hierarchy to locate
2869 * the dictionary (much much faster and more scalable).
2870 *
2871 * @param[in] da To get the containing dictionary for.
2872 * @return
2873 * - The dictionary containing da.
2874 * - NULL.
2875 */
2876fr_dict_t const *fr_dict_by_da(fr_dict_attr_t const *da)
2877{
2878 return dict_by_da(da);
2879}
2880
2881/** See if two dictionaries have the same end parent
2882 *
2883 * @param[in] dict1 one dictionary
2884 * @param[in] dict2 two dictionary
2885 * @return
2886 * - true the dictionaries have the same end parent
2887 * - false the dictionaries do not have the same end parent.
2888 */
2889bool fr_dict_compatible(fr_dict_t const *dict1, fr_dict_t const *dict2)
2890{
2891 while (dict1->next) dict1 = dict1->next;
2892
2893 while (dict2->next) dict2 = dict2->next;
2894
2895 return (dict1 == dict2);
2896}
2897
2898/** Look up a vendor by one of its child attributes
2899 *
2900 * @param[in] da The vendor attribute.
2901 * @return
2902 * - The vendor.
2903 * - NULL if no vendor with that number was registered for this protocol.
2904 */
2905fr_dict_vendor_t const *fr_dict_vendor_by_da(fr_dict_attr_t const *da)
2906{
2907 fr_dict_t *dict;
2908 fr_dict_vendor_t dv;
2909
2910 dv.pen = fr_dict_vendor_num_by_da(da);
2911 if (!dv.pen) return NULL;
2912
2913 dict = dict_by_da(da);
2914
2915 return fr_hash_table_find(dict->vendors_by_num, &dv);
2916}
2917
2918/** Look up a vendor by its name
2919 *
2920 * @param[in] dict of protocol context we're operating in.
2921 * If NULL the internal dictionary will be used.
2922 * @param[in] name to search for.
2923 * @return
2924 * - The vendor.
2925 * - NULL if no vendor with that name was registered for this protocol.
2926 */
2927fr_dict_vendor_t const *fr_dict_vendor_by_name(fr_dict_t const *dict, char const *name)
2928{
2929 fr_dict_vendor_t *found;
2930
2931 INTERNAL_IF_NULL(dict, NULL);
2932
2933 if (!name) return NULL;
2934
2935 found = fr_hash_table_find(dict->vendors_by_name, &(fr_dict_vendor_t) { .name = name });
2936 if (!found) return NULL;
2937
2938 return found;
2939}
2940
2941/** Look up a vendor by its PEN
2942 *
2943 * @param[in] dict of protocol context we're operating in.
2944 * If NULL the internal dictionary will be used.
2945 * @param[in] vendor_pen to search for.
2946 * @return
2947 * - The vendor.
2948 * - NULL if no vendor with that number was registered for this protocol.
2949 */
2950fr_dict_vendor_t const *fr_dict_vendor_by_num(fr_dict_t const *dict, uint32_t vendor_pen)
2951{
2952 INTERNAL_IF_NULL(dict, NULL);
2953
2954 return fr_hash_table_find(dict->vendors_by_num, &(fr_dict_vendor_t) { .pen = vendor_pen });
2955}
2956
2957/** Return vendor attribute for the specified dictionary and pen
2958 *
2959 * @param[in] vendor_root of the vendor root attribute. Could be 26 (for example) in RADIUS.
2960 * @param[in] vendor_pen to find.
2961 * @return
2962 * - NULL if vendor does not exist.
2963 * - A fr_dict_attr_t representing the vendor in the dictionary hierarchy.
2964 */
2965fr_dict_attr_t const *fr_dict_vendor_da_by_num(fr_dict_attr_t const *vendor_root, uint32_t vendor_pen)
2966{
2967 fr_dict_attr_t const *vendor;
2968
2969 switch (vendor_root->type) {
2970 case FR_TYPE_VSA: /* Vendor specific attribute */
2971 break;
2972
2973 default:
2974 fr_strerror_printf("Wrong type for vendor root, expected '%s', got '%s'",
2975 fr_type_to_str(FR_TYPE_VSA),
2976 fr_type_to_str(vendor_root->type));
2977 return NULL;
2978 }
2979
2980 vendor = dict_attr_child_by_num(vendor_root, vendor_pen);
2981 if (!vendor) {
2982 fr_strerror_printf("Vendor %u not defined", vendor_pen);
2983 return NULL;
2984 }
2985
2986 if (vendor->type != FR_TYPE_VENDOR) {
2987 fr_strerror_printf("Wrong type for vendor, expected '%s' got '%s'",
2988 fr_type_to_str(vendor->type),
2989 fr_type_to_str(FR_TYPE_VENDOR));
2990 return NULL;
2991 }
2992
2993 return vendor;
2994}
2995
2996/** Callback function for resolving dictionary attributes
2997 *
2998 * @param[out] err Where to write error codes. Any error
2999 * other than FR_DICT_ATTR_NOTFOUND will
3000 * prevent resolution from continuing.
3001 * @param[out] out Where to write resolved DA.
3002 * @param[in] parent The dictionary root or other attribute to search from.
3003 * @param[in] in Contains the string to resolve.
3004 * @param[in] tt Terminal sequences to use to determine the portion
3005 * of in to search.
3006 * @return
3007 * - < 0 on failure.
3008 * - The number of bytes of name consumed on success.
3009 */
3010typedef fr_slen_t (*dict_attr_resolve_func_t)(fr_dict_attr_err_t *err,
3011 fr_dict_attr_t const **out, fr_dict_attr_t const *parent,
3012 fr_sbuff_t *in, fr_sbuff_term_t const *tt);
3013
3014/** Internal function for searching for attributes in multiple dictionaries
3015 *
3016 * @param[out] err Any errors that occurred searching.
3017 * @param[out] out The attribute we found.
3018 * @param[in] dict_def The default dictionary to search in.
3019 * @param[in] in string to resolve to an attribute.
3020 * @param[in] tt terminals that indicate the end of the string.
3021 * @param[in] internal Resolve the attribute in the internal dictionary.
3022 * @param[in] foreign Resolve attribute in a foreign dictionary,
3023 * i.e. one other than dict_def.
3024 * @param[in] func to use for resolution.
3025 * @return
3026 * - <=0 on error (the offset of the error).
3027 * - >0 on success.
3028 */
3029static inline CC_HINT(always_inline)
3030fr_slen_t dict_attr_search(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3031 fr_dict_t const *dict_def,
3032 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
3033 bool internal, bool foreign,
3034 dict_attr_resolve_func_t func)
3035{
3036 fr_dict_attr_err_t our_err = FR_DICT_ATTR_OK;
3037 fr_hash_iter_t iter;
3038 fr_dict_t *dict = NULL;
3039 fr_sbuff_t our_in = FR_SBUFF(in);
3040
3041 if (internal && !dict_gctx->internal) internal = false;
3042
3043 /*
3044 * Always going to fail...
3045 */
3046 if (unlikely(!internal && !foreign && !dict_def)) {
3047 if (err) *err = FR_DICT_ATTR_EINVAL;
3048 *out = NULL;
3049 return 0;
3050 }
3051
3052 /*
3053 * dict_def search in the specified dictionary
3054 */
3055 if (dict_def) {
3056 (void)func(&our_err, out, fr_dict_root(dict_def), &our_in, tt);
3057 switch (our_err) {
3058 case FR_DICT_ATTR_OK:
3059 FR_SBUFF_SET_RETURN(in, &our_in);
3060
3061 case FR_DICT_ATTR_NOTFOUND:
3062 if (!internal && !foreign) goto error;
3063 break;
3064
3065 default:
3066 goto error;
3067 }
3068 }
3069
3070 /*
3071 * Next in the internal dictionary
3072 */
3073 if (internal) {
3074 (void)func(&our_err, out, fr_dict_root(dict_gctx->internal), &our_in, tt);
3075 switch (our_err) {
3076 case FR_DICT_ATTR_OK:
3077 FR_SBUFF_SET_RETURN(in, &our_in);
3078
3079 case FR_DICT_ATTR_NOTFOUND:
3080 if (!foreign) goto error;
3081 break;
3082
3083 default:
3084 goto error;
3085 }
3086 }
3087
3088 /*
3089 * Now loop over the protocol dictionaries
3090 */
3091 for (dict = fr_hash_table_iter_init(dict_gctx->protocol_by_num, &iter);
3092 dict;
3093 dict = fr_hash_table_iter_next(dict_gctx->protocol_by_num, &iter)) {
3094 if (dict == dict_def) continue;
3095 if (dict == dict_gctx->internal) continue;
3096
3097 (void)func(&our_err, out, fr_dict_root(dict), &our_in, tt);
3098 switch (our_err) {
3099 case FR_DICT_ATTR_OK:
3100 FR_SBUFF_SET_RETURN(in, &our_in);
3101
3102 case FR_DICT_ATTR_NOTFOUND:
3103 continue;
3104
3105 default:
3106 break;
3107 }
3108 }
3109
3110error:
3111 /*
3112 * Add a more helpful error message about
3113 * which dictionaries we tried to locate
3114 * the attribute in.
3115 */
3116 if (our_err == FR_DICT_ATTR_NOTFOUND) {
3117 fr_sbuff_marker_t start;
3118 char *list = NULL;
3119
3120#define DICT_NAME_APPEND(_in, _dict) \
3121do { \
3122 char *_n; \
3123 _n = talloc_strdup_append_buffer(_in, fr_dict_root(_dict)->name); \
3124 if (unlikely(!_n)) { \
3125 talloc_free(_in); \
3126 goto done; \
3127 } \
3128 _in = _n; \
3129 _n = talloc_strdup_append_buffer(_in, ", "); \
3130 if (unlikely(!_n)) { \
3131 talloc_free(_in); \
3132 goto done; \
3133 } \
3134 _in = _n; \
3135} while (0)
3136
3137 our_in = FR_SBUFF(in);
3138 fr_sbuff_marker(&start, &our_in);
3139
3140 list = talloc_strdup(NULL, "");
3141 if (unlikely(!list)) goto done;
3142
3143 if (dict_def) DICT_NAME_APPEND(list, dict_def);
3144 if (internal) DICT_NAME_APPEND(list, dict_gctx->internal);
3145
3146 if (foreign) {
3147 for (dict = fr_hash_table_iter_init(dict_gctx->protocol_by_num, &iter);
3148 dict;
3149 dict = fr_hash_table_iter_next(dict_gctx->protocol_by_num, &iter)) {
3150 if (dict == dict_def) continue;
3151 if (dict == dict_gctx->internal) continue;
3152
3153 if (internal) DICT_NAME_APPEND(list, dict);
3154 }
3155 }
3156
3157 fr_strerror_printf("Attribute '%pV' not found. Searched in: %pV",
3158 fr_box_strvalue_len(fr_sbuff_current(&start),
3159 fr_sbuff_adv_until(&our_in, SIZE_MAX, tt, '\0')),
3160 fr_box_strvalue_len(list, talloc_array_length(list) - 3));
3161
3162 talloc_free(list);
3163 }
3164
3165done:
3166 if (err) *err = our_err;
3167 *out = NULL;
3168
3169 FR_SBUFF_ERROR_RETURN(&our_in);
3170}
3171
3172/** Internal function for searching for attributes in multiple dictionaries
3173 *
3174 * Unlike #dict_attr_search this function searches for a protocol name preceding
3175 * the attribute identifier.
3176 */
3177static inline CC_HINT(always_inline)
3178fr_slen_t dict_attr_search_qualified(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3179 fr_dict_t const *dict_def,
3180 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
3181 bool internal, bool foreign,
3182 dict_attr_resolve_func_t func)
3183{
3184 fr_sbuff_t our_in = FR_SBUFF(in);
3185 fr_dict_attr_err_t our_err;
3186 fr_dict_t *initial;
3187 fr_slen_t slen;
3188
3189 /*
3190 * Check for dictionary prefix
3191 */
3192 slen = dict_by_protocol_substr(&our_err, &initial, &our_in, dict_def);
3193 if (our_err != FR_DICT_ATTR_OK) {
3194 error:
3195 if (err) *err = our_err;
3196 *out = NULL;
3197 FR_SBUFF_ERROR_RETURN(&our_in);
3198 }
3199
3200 /*
3201 * Has dictionary qualifier, can't fallback
3202 */
3203 if (slen > 0) {
3204 /*
3205 * Next thing SHOULD be a '.'
3206 */
3207 if (!fr_sbuff_next_if_char(&our_in, '.')) {
3208 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
3209 *out = NULL;
3210 FR_SBUFF_ERROR_RETURN(&our_in);
3211 }
3212
3213 internal = foreign = false;
3214 }
3215
3216 if (dict_attr_search(&our_err, out, initial, &our_in, tt, internal, foreign, func) < 0) goto error;
3217 if (err) *err = FR_DICT_ATTR_OK;
3218
3219 FR_SBUFF_SET_RETURN(in, &our_in);
3220}
3221
3222/** Locate a qualified #fr_dict_attr_t by its name and a dictionary qualifier
3223 *
3224 * This function will search through all loaded dictionaries, or a subset of
3225 * loaded dictionaries, for a matching attribute in the top level namespace.
3226 *
3227 * This attribute may be qualified with `<protocol>.` to selection an attribute
3228 * in a specific case.
3229 *
3230 * @note If calling this function from the server any list or request qualifiers
3231 * should be stripped first.
3232 *
3233 * @param[out] err Why parsing failed. May be NULL.
3234 * @see fr_dict_attr_err_t
3235 * @param[out] out Dictionary found attribute.
3236 * @param[in] dict_def Default dictionary for non-qualified dictionaries.
3237 * @param[in] name Dictionary/Attribute name.
3238 * @param[in] tt Terminal strings.
3239 * @param[in] internal If true, fallback to the internal dictionary.
3240 * @param[in] foreign If true, fallback to foreign dictionaries.
3241 * @return
3242 * - < 0 on failure.
3243 * - The number of bytes of name consumed on success.
3244 */
3245fr_slen_t fr_dict_attr_search_by_qualified_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3246 fr_dict_t const *dict_def,
3247 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
3248 bool internal, bool foreign)
3249{
3250 return dict_attr_search_qualified(err, out, dict_def, name, tt,
3251 internal, foreign, fr_dict_attr_by_name_substr);
3252}
3253
3254/** Locate a #fr_dict_attr_t by its name in the top level namespace of a dictionary
3255 *
3256 * This function will search through all loaded dictionaries, or a subset of
3257 * loaded dictionaries, for a matching attribute in the top level namespace.
3258 *
3259 * @note If calling this function from the server any list or request qualifiers
3260 * should be stripped first.
3261 *
3262 * @param[out] err Why parsing failed. May be NULL.
3263 * @see fr_dict_attr_err_t
3264 * @param[out] out Dictionary found attribute.
3265 * @param[in] dict_def Default dictionary for non-qualified dictionaries.
3266 * @param[in] name Dictionary/Attribute name.
3267 * @param[in] tt Terminal strings.
3268 * @param[in] internal If true, fallback to the internal dictionary.
3269 * @param[in] foreign If true, fallback to foreign dictionaries.
3270 * @return
3271 * - < 0 on failure.
3272 * - The number of bytes of name consumed on success.
3273 */
3274fr_slen_t fr_dict_attr_search_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3275 fr_dict_t const *dict_def,
3276 fr_sbuff_t *name, fr_sbuff_term_t const *tt,
3277 bool internal, bool foreign)
3278{
3279 return dict_attr_search_qualified(err, out, dict_def, name, tt,
3280 internal, foreign, fr_dict_attr_by_name_substr);
3281}
3282
3283/** Locate a qualified #fr_dict_attr_t by a dictionary qualified OID string
3284 *
3285 * This function will search through all loaded dictionaries, or a subset of
3286 * loaded dictionaries, for a matching attribute.
3287 *
3288 * @note If calling this function from the server any list or request qualifiers
3289 * should be stripped first.
3290 *
3291 * @note err should be checked to determine if a parse error occurred.
3292 *
3293 * @param[out] err Why parsing failed. May be NULL.
3294 * @see fr_dict_attr_err_t
3295 * @param[out] out Dictionary found attribute.
3296 * @param[in] dict_def Default dictionary for non-qualified dictionaries.
3297 * @param[in] in Dictionary/Attribute name.
3298 * @param[in] tt Terminal strings.
3299 * @param[in] internal If true, fallback to the internal dictionary.
3300 * @param[in] foreign If true, fallback to foreign dictionaries.
3301 * @return The number of bytes of name consumed.
3302 */
3303fr_slen_t fr_dict_attr_search_by_qualified_oid_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3304 fr_dict_t const *dict_def,
3305 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
3306 bool internal, bool foreign)
3307{
3308 return dict_attr_search_qualified(err, out, dict_def, in, tt,
3309 internal, foreign, fr_dict_attr_by_oid_substr);
3310}
3311
3312/** Locate a qualified #fr_dict_attr_t by a dictionary using a non-qualified OID string
3313 *
3314 * This function will search through all loaded dictionaries, or a subset of
3315 * loaded dictionaries, for a matching attribute.
3316 *
3317 * @note If calling this function from the server any list or request qualifiers
3318 * should be stripped first.
3319 *
3320 * @note err should be checked to determine if a parse error occurred.
3321 *
3322 * @param[out] err Why parsing failed. May be NULL.
3323 * @see fr_dict_attr_err_t
3324 * @param[out] out Dictionary found attribute.
3325 * @param[in] dict_def Default dictionary for non-qualified dictionaries.
3326 * @param[in] in Dictionary/Attribute name.
3327 * @param[in] tt Terminal strings.
3328 * @param[in] internal If true, fallback to the internal dictionary.
3329 * @param[in] foreign If true, fallback to foreign dictionaries.
3330 * @return The number of bytes of name consumed.
3331 */
3332fr_slen_t fr_dict_attr_search_by_oid_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3333 fr_dict_t const *dict_def,
3334 fr_sbuff_t *in, fr_sbuff_term_t const *tt,
3335 bool internal, bool foreign)
3336{
3337 return dict_attr_search_qualified(err, out, dict_def, in, tt,
3338 internal, foreign, fr_dict_attr_by_oid_substr);
3339}
3340
3341/** Locate a qualified #fr_dict_attr_t by its name and a dictionary qualifier
3342 *
3343 * @param[out] err Why parsing failed. May be NULL.
3344 * @see fr_dict_attr_err_t.
3345 * @param[in] dict_def Default dictionary for non-qualified dictionaries.
3346 * @param[in] name Dictionary/Attribute name.
3347 * @param[in] internal If true, fallback to the internal dictionary.
3348 * @param[in] foreign If true, fallback to foreign dictionaries.
3349 * @return an #fr_dict_attr_err_t value.
3350 */
3351fr_dict_attr_t const *fr_dict_attr_search_by_qualified_oid(fr_dict_attr_err_t *err, fr_dict_t const *dict_def,
3352 char const *name,
3353 bool internal, bool foreign)
3354{
3355 ssize_t slen;
3356 fr_sbuff_t our_name;
3357 fr_dict_attr_t const *da;
3358 fr_dict_attr_err_t our_err;
3359
3360 fr_sbuff_init_in(&our_name, name, strlen(name));
3361
3362 slen = fr_dict_attr_search_by_qualified_oid_substr(&our_err, &da, dict_def, &our_name, NULL, internal, foreign);
3363 if (our_err != FR_DICT_ATTR_OK) {
3364 if (err) *err = our_err;
3365 return NULL;
3366 }
3367 if ((size_t)slen != fr_sbuff_len(&our_name)) {
3368 fr_strerror_printf("Trailing garbage after attr string \"%s\"", name);
3369 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
3370 return NULL;
3371 }
3372
3373 return da;
3374}
3375
3376/** Look up a dictionary attribute by a name embedded in another string
3377 *
3378 * Find the first invalid attribute name char in the string pointed
3379 * to by name.
3380 *
3381 * Copy the characters between the start of the name string and the first
3382 * none #fr_dict_attr_allowed_chars char to a buffer and perform a dictionary lookup
3383 * using that value.
3384 *
3385 * If the attribute exists, advance the pointer pointed to by name
3386 * to the first none #fr_dict_attr_allowed_chars char, and return the DA.
3387 *
3388 * If the attribute does not exist, don't advance the pointer and return
3389 * NULL.
3390 *
3391 * @param[out] err Why parsing failed. May be NULL.
3392 * @see fr_dict_attr_err_t
3393 * @param[out] out Where to store the resolve attribute.
3394 * @param[in] parent containing the namespace to search in.
3395 * @param[in] name string start.
3396 * @param[in] tt Terminal sequences to use to determine the portion
3397 * of in to search.
3398 * @return
3399 * - <= 0 on failure.
3400 * - The number of bytes of name consumed on success.
3401 */
3402fr_slen_t fr_dict_attr_by_name_substr(fr_dict_attr_err_t *err, fr_dict_attr_t const **out,
3403 fr_dict_attr_t const *parent, fr_sbuff_t *name, UNUSED fr_sbuff_term_t const *tt)
3404{
3405 fr_dict_attr_t const *da;
3406 size_t len;
3407 fr_dict_attr_t const *ref;
3408 char const *p;
3409 char buffer[FR_DICT_ATTR_MAX_NAME_LEN + 1 + 1]; /* +1 \0 +1 for "too long" */
3410 fr_sbuff_t our_name = FR_SBUFF(name);
3411 fr_hash_table_t *namespace;
3412
3413 *out = NULL;
3414
3415#ifdef STATIC_ANALYZER
3416 memset(buffer, 0, sizeof(buffer));
3417#endif
3418
3419 len = fr_sbuff_out_bstrncpy_allowed(&FR_SBUFF_OUT(buffer, sizeof(buffer)),
3420 &our_name, SIZE_MAX,
3421 fr_dict_attr_allowed_chars);
3422 if (len == 0) {
3423 fr_strerror_const("Zero length attribute name");
3424 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
3425 FR_SBUFF_ERROR_RETURN(&our_name);
3426 }
3427 if (len > FR_DICT_ATTR_MAX_NAME_LEN) {
3428 fr_strerror_const("Attribute name too long");
3429 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
3430 FR_SBUFF_ERROR_RETURN(&our_name);
3431 }
3432
3433 /*
3434 * Do a second pass, ensuring that the name has at least one alphanumeric character.
3435 */
3436 for (p = buffer; p < (buffer + len); p++) {
3437 if (sbuff_char_alpha_num[(uint8_t) *p]) break;
3438 }
3439
3440 if ((size_t) (p - buffer) == len) {
3441 fr_strerror_const("Invalid attribute name");
3442 if (err) *err = FR_DICT_ATTR_PARSE_ERROR;
3443 FR_SBUFF_ERROR_RETURN(&our_name);
3444 }
3445
3446 ref = fr_dict_attr_ref(parent);
3447 if (ref) parent = ref;
3448
3449redo:
3450 namespace = dict_attr_namespace(parent);
3451 if (!namespace) {
3452 fr_strerror_printf("Attribute '%s' does not contain a namespace", parent->name);
3453 if (err) *err = FR_DICT_ATTR_NO_CHILDREN;
3454 fr_sbuff_set_to_start(&our_name);
3455 FR_SBUFF_ERROR_RETURN(&our_name);
3456 }
3457
3458 da = fr_hash_table_find(namespace, &(fr_dict_attr_t){ .name = buffer });
3459 if (!da) {
3460 if (parent->flags.is_root) {
3461 fr_dict_t const *dict = fr_dict_by_da(parent);
3462
3463 if (dict->next) {
3464 parent = dict->next->root;
3465 goto redo;
3466 }
3467 }
3468
3469 if (err) *err = FR_DICT_ATTR_NOTFOUND;
3470 fr_strerror_printf("Attribute '%s' not found in namespace '%s'", buffer, parent->name);
3471 fr_sbuff_set_to_start(&our_name);
3472 FR_SBUFF_ERROR_RETURN(&our_name);
3473 }
3474
3475 da = dict_attr_alias(err, da);
3476 if (unlikely(!da)) FR_SBUFF_ERROR_RETURN(&our_name);
3477
3478 *out = da;
3479 if (err) *err = FR_DICT_ATTR_OK;
3480
3481 FR_SBUFF_SET_RETURN(name, &our_name);
3482}
3483
3484/* Internal version of fr_dict_attr_by_name
3485 *
3486 */
3487fr_dict_attr_t *dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
3488{
3489 fr_hash_table_t *namespace;
3490 fr_dict_attr_t *da;
3491
3492 DA_VERIFY(parent);
3493
3494redo:
3495 namespace = dict_attr_namespace(parent);
3496 if (!namespace) {
3497 fr_strerror_printf("Attribute '%s' does not contain a namespace", parent->name);
3498 if (err) *err = FR_DICT_ATTR_NO_CHILDREN;
3499 return NULL;
3500 }
3501
3502 da = fr_hash_table_find(namespace, &(fr_dict_attr_t) { .name = name });
3503 if (!da) {
3504 if (parent->flags.is_root) {
3505 fr_dict_t const *dict = fr_dict_by_da(parent);
3506
3507 if (dict->next) {
3508 parent = dict->next->root;
3509 goto redo;
3510 }
3511 }
3512
3513 if (err) *err = FR_DICT_ATTR_NOTFOUND;
3514 fr_strerror_printf("Attribute '%s' not found in namespace '%s'", name, parent->name);
3515 return NULL;
3516 }
3517
3518 if (err) *err = FR_DICT_ATTR_OK;
3519
3520 return da;
3521}
3522
3523/** Locate a #fr_dict_attr_t by its name
3524 *
3525 * @param[out] err Why the lookup failed. May be NULL.
3526 * @see fr_dict_attr_err_t.
3527 * @param[in] parent containing the namespace we're searching in.
3528 * @param[in] name of the attribute to locate.
3529 * @return
3530 * - Attribute matching name.
3531 * - NULL if no matching attribute could be found.
3532 */
3533fr_dict_attr_t const *fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
3534{
3535 fr_dict_attr_t const *da;
3536
3537 DA_VERIFY(parent);
3538
3539 da = dict_attr_by_name(err, parent, name);
3540 if (!da) return NULL;
3541
3542 da = dict_attr_alias(err, da);
3543 if (unlikely(!da)) return NULL;
3544
3545 return da;
3546}
3547
3548/** Internal version of fr_dict_attr_child_by_num
3549 *
3550 */
3551fr_dict_attr_t *dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr)
3552{
3553 fr_dict_attr_t const *bin;
3554 fr_dict_attr_t const **children;
3555 fr_dict_attr_t const *ref;
3556
3557 DA_VERIFY(parent);
3558
3559 /*
3560 * Do any necessary dereferencing
3561 */
3562 ref = fr_dict_attr_ref(parent);
3563 if (ref) parent = ref;
3564
3565 children = dict_attr_children(parent);
3566 if (!children) return NULL;
3567
3568 /*
3569 * Child arrays may be trimmed back to save memory.
3570 * Check that so we don't SEGV.
3571 */
3572 if ((attr & 0xff) >= talloc_array_length(children)) return NULL;
3573
3574 bin = children[attr & 0xff];
3575 for (;;) {
3576 if (!bin) return NULL;
3577 if (bin->attr == attr) {
3578 fr_dict_attr_t *out;
3579
3580 memcpy(&out, &bin, sizeof(bin));
3581
3582 return out;
3583 }
3584 bin = bin->next;
3585 }
3586
3587 return NULL;
3588}
3589
3590/** Check if a child attribute exists in a parent using an attribute number
3591 *
3592 * @param[in] parent to check for child in.
3593 * @param[in] attr number to look for.
3594 * @return
3595 * - The child attribute on success.
3596 * - NULL if the child attribute does not exist.
3597 */
3598fr_dict_attr_t const *fr_dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr)
3599{
3600 fr_dict_attr_t const *da;
3601
3602 da = dict_attr_child_by_num(parent, attr);
3603 if (!da) return NULL;
3604
3605 da = dict_attr_alias(NULL, da);
3606 if (unlikely(!da)) return NULL;
3607
3608 return da;
3609}
3610
3611/** Iterate over all enumeration values for an attribute
3612 *
3613 * @param[in] da to iterate over.
3614 * @param[in] iter to use for iteration.
3615 * @return
3616 * - First #fr_dict_enum_value_t in the attribute.
3617 * - NULL if no enumeration values exist.
3618 */
3619fr_dict_enum_value_t const *fr_dict_enum_iter_init(fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
3620{
3621 fr_dict_attr_ext_enumv_t *ext;
3622
3623 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
3624 if (!ext) {
3625 fr_strerror_printf("%s has no enumeration values to iterate over", da->name);
3626 return NULL;
3627 }
3628
3629 return fr_hash_table_iter_init(ext->value_by_name, iter);
3630}
3631
3632/* Iterate over next enumeration value for an attribute
3633 *
3634 * @param[in] da to iterate over.
3635 * @param[in] iter to use for iteration.
3636 * @return
3637 * - Next #fr_dict_enum_value_t in the attribute.
3638 * - NULL if no more enumeration values exist.
3639 */
3640fr_dict_enum_value_t const *fr_dict_enum_iter_next(fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
3641{
3642 fr_dict_attr_ext_enumv_t *ext;
3643 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
3644 if (!ext) {
3645 fr_strerror_printf("%s has no enumeration values to iterate over", da->name);
3646 return NULL;
3647 }
3648
3649 return fr_hash_table_iter_next(ext->value_by_name, iter);;
3650}
3651
3652/** Lookup the structure representing an enum value in a #fr_dict_attr_t
3653 *
3654 * @param[in] da to search in.
3655 * @param[in] value to search for.
3656 * @return
3657 * - Matching #fr_dict_enum_value_t.
3658 * - NULL if no matching #fr_dict_enum_value_t could be found.
3659 */
3660fr_dict_enum_value_t const *fr_dict_enum_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
3661{
3662 fr_dict_attr_ext_enumv_t *ext;
3663
3664 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
3665 if (!ext) {
3666 fr_strerror_printf("VALUE cannot be defined for %s attributes",
3667 fr_type_to_str(da->type));
3668 return NULL;
3669 }
3670
3671 /*
3672 * No values associated with this attribute
3673 */
3674 if (!ext->name_by_value) return NULL;
3675
3676 /*
3677 * Could be NULL or an unknown attribute, in which case
3678 * we want to avoid the lookup gracefully...
3679 */
3680 if (value->type != da->type) return NULL;
3681
3682 return fr_hash_table_find(ext->name_by_value, &(fr_dict_enum_value_t){ .value = value });
3683}
3684
3685/** Lookup the name of an enum value in a #fr_dict_attr_t
3686 *
3687 * @param[in] da to search in.
3688 * @param[in] value number to search for.
3689 * @return
3690 * - Name of value.
3691 * - NULL if no matching value could be found.
3692 */
3693char const *fr_dict_enum_name_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
3694{
3695 fr_dict_enum_value_t const *dv;
3696
3697 dv = fr_dict_enum_by_value(da, value);
3698 if (!dv) return NULL;
3699
3700 return dv->name;
3701}
3702
3703/*
3704 * Get a value by its name, keyed off of an attribute.
3705 */
3706fr_dict_enum_value_t const *fr_dict_enum_by_name(fr_dict_attr_t const *da, char const *name, ssize_t len)
3707{
3708 fr_dict_attr_ext_enumv_t *ext;
3709
3710 if (!name) return NULL;
3711
3712 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
3713 if (!ext) {
3714 fr_strerror_printf("VALUE cannot be defined for %s attributes",
3715 fr_type_to_str(da->type));
3716 return NULL;
3717 }
3718
3719 /*
3720 * No values associated with this attribute
3721 */
3722 if (!ext->value_by_name) return NULL;
3723
3724 if (len < 0) len = strlen(name);
3725
3726 return fr_hash_table_find(ext->value_by_name, &(fr_dict_enum_value_t){ .name = name, .name_len = len});
3727}
3728
3729/*
3730 * Get a value by its name, keyed off of an attribute, from an sbuff
3731 */
3732fr_slen_t fr_dict_enum_by_name_substr(fr_dict_enum_value_t **out, fr_dict_attr_t const *da, fr_sbuff_t *in)
3733{
3734 fr_dict_attr_ext_enumv_t *ext;
3735 fr_sbuff_t our_in = FR_SBUFF(in);
3736 fr_dict_enum_value_t *found = NULL;
3737 size_t found_len = 0;
3738 uint8_t *p;
3739 uint8_t name[FR_DICT_ENUM_MAX_NAME_LEN + 1];
3740
3741 /*
3742 * No values associated with this attribute, do nothing.
3743 */
3744 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_ENUMV);
3745 if (!ext || !ext->value_by_name) return 0;
3746
3747 /*
3748 * Loop until we exhaust all of the possibilities.
3749 */
3750 for (p = name; (size_t) (p - name) < ext->max_name_len; p++) {
3751 int len = (p - name) + 1;
3752 fr_dict_enum_value_t *enumv;
3753
3754 *p = fr_sbuff_char(&our_in, '\0');
3755 if (!fr_dict_enum_allowed_chars[*p]) {
3756 break;
3757 }
3758 fr_sbuff_next(&our_in);
3759
3760 enumv = fr_hash_table_find(ext->value_by_name, &(fr_dict_enum_value_t){ .name = (char const *) name,
3761 .name_len = len});
3762
3763 /*
3764 * Return the LONGEST match, as there may be
3765 * overlaps. e.g. "Framed", and "Framed-User".
3766 */
3767 if (enumv) {
3768 found = enumv;
3769 found_len = len;
3770 }
3771 }
3772
3773 if (found) {
3774 *out = found;
3775 FR_SBUFF_SET_RETURN(in, found_len);
3776 }
3777
3778 return 0;
3779}
3780
3781/** Extract an enumeration name from a string
3782 *
3783 * This function defines the canonical format for an enumeration name.
3784 *
3785 * An enumeration name is made up of one or more fr_dict_attr_allowed_chars
3786 * with at least one character in the sequence not being a special character
3787 * i.e. [-+/_] or a number.
3788 *
3789 * This disambiguates enumeration identifiers from mathematical expressions.
3790 *
3791 * If we allowed enumeration names consisting of sequences of numbers separated
3792 * by special characters it would not be possible to determine if the special
3793 * character were an operator in a subexpression.
3794 *
3795 * For example take:
3796 *
3797 * &My-Enum-Attr == 01234-5678
3798 *
3799 * Without having access to the enumeration values of My-Enum-Attr (which we
3800 * might not have during tokenisation), we cannot tell if this is:
3801 *
3802 * (&My-Enum-Attr == 01234-5678)
3803 *
3804 * OR
3805 *
3806 * ((&My-Enum-Attr == 01234) - 5678)
3807 *
3808 * If an alpha character occurs anywhere in the string i.e:
3809 *
3810 * (&My-Enum-Attr == 01234-A5678)
3811 *
3812 * we know 01234-A5678 can't be a mathematical sub-expression because the
3813 * second potential operand can no longer be parsed as an integer constant.
3814 *
3815 * @param[out] out The name string we managed to extract.
3816 * May be NULL in which case only the length of the name
3817 * will be returned.
3818 * @param[out] err Type of parsing error which occurred. May be NULL.
3819 * @param[in] in The string containing the enum identifier.
3820 * @param[in] tt If non-null verify that a terminal sequence occurs
3821 * after the enumeration name.
3822 * @return
3823 * - <0 the offset at which the parse error occurred.
3824 * - >1 the number of bytes parsed.
3825 */
3826fr_slen_t fr_dict_enum_name_from_substr(fr_sbuff_t *out, fr_sbuff_parse_error_t *err,
3827 fr_sbuff_t *in, fr_sbuff_term_t const *tt)
3828{
3829 fr_sbuff_t our_in = FR_SBUFF(in);
3830 bool seen_alpha = false;
3831
3832 while (fr_sbuff_is_in_charset(&our_in, fr_dict_enum_allowed_chars)) {
3833 if (fr_sbuff_is_alpha(&our_in)) seen_alpha = true;
3834 fr_sbuff_next(&our_in);
3835 }
3836
3837 if (!seen_alpha) {
3838 if (fr_sbuff_used(&our_in) == 0) {
3839 fr_strerror_const("VALUE name is empty");
3840 if (err) *err = FR_SBUFF_PARSE_ERROR_NOT_FOUND;
3841 FR_SBUFF_ERROR_RETURN(&our_in);
3842 }
3843
3844 fr_strerror_const("VALUE name must contain at least one alpha character");
3845 if (err) *err = FR_SBUFF_PARSE_ERROR_FORMAT;
3846 fr_sbuff_set_to_start(&our_in); /* Marker should be at the start of the enum */
3847 FR_SBUFF_ERROR_RETURN(&our_in);
3848 }
3849
3850 /*
3851 * Check that the sequence is correctly terminated
3852 */
3853 if (tt && !fr_sbuff_is_terminal(&our_in, tt)) {
3854 fr_strerror_const("VALUE name has trailing text");
3855 if (err) *err = FR_SBUFF_PARSE_ERROR_TRAILING;
3856 FR_SBUFF_ERROR_RETURN(&our_in);
3857 }
3858
3859 if (out) return fr_sbuff_out_bstrncpy_exact(out, in, fr_sbuff_used(&our_in));
3860
3861 if (err) *err = FR_SBUFF_PARSE_OK;
3862
3863 FR_SBUFF_SET_RETURN(in, &our_in);
3864}
3865
3866int dict_dlopen(fr_dict_t *dict, char const *name)
3867{
3868 char *lib_name;
3869 char *sym_name;
3870 fr_dict_protocol_t *proto;
3871
3872 if (!name) return 0;
3873
3874 lib_name = talloc_typed_asprintf(NULL, "libfreeradius-%s", name);
3875 if (unlikely(lib_name == NULL)) {
3876 oom:
3877 fr_strerror_const("Out of memory");
3878 return -1;
3879 }
3880 talloc_bstr_tolower(lib_name);
3881
3882 dict->dl = dl_by_name(dict_gctx->dict_loader, lib_name, NULL, false);
3883 if (!dict->dl) {
3884 fr_strerror_printf_push("Failed loading dictionary validation library \"%s\"", lib_name);
3885 talloc_free(lib_name);
3886 return -1;
3887 }
3888 talloc_free(lib_name);
3889
3890 /*
3891 * The public symbol that contains per-protocol rules
3892 * and extensions.
3893 *
3894 * It ends up being easier to do this using dlsym to
3895 * resolve the symbol and not use the autoloader
3896 * callbacks as theoretically multiple dictionaries
3897 * could use the same protocol library, and then the
3898 * autoloader callback would only run for the first
3899 * dictionary which loaded the protocol.
3900 */
3901 sym_name = talloc_typed_asprintf(NULL, "libfreeradius_%s_dict_protocol", name);
3902 if (unlikely(sym_name == NULL)) {
3903 goto oom;
3904 }
3905 talloc_bstr_tolower(sym_name);
3906
3907 /*
3908 * De-hyphenate the symbol name
3909 */
3910 {
3911 char *p, *q;
3912
3913 for (p = sym_name, q = p + (talloc_array_length(sym_name) - 1); p < q; p++) *p = *p == '-' ? '_' : *p;
3914 }
3915
3916 proto = dlsym(dict->dl->handle, sym_name);
3917 talloc_free(sym_name);
3918
3919 /*
3920 * Soft failure, not all protocol libraires provide
3921 * custom validation functions or flats.
3922 */
3923 if (!proto) return 0;
3924
3925 /*
3926 * Replace the default protocol with the custom one
3927 * if we have it...
3928 */
3929 dict->proto = proto;
3930
3931 return 0;
3932}
3933
3934/** Find a dependent in the tree of dependents
3935 *
3936 */
3937static int8_t _dict_dependent_cmp(void const *a, void const *b)
3938{
3939 fr_dict_dependent_t const *dep_a = a;
3940 fr_dict_dependent_t const *dep_b = b;
3941 int ret;
3942
3943 ret = strcmp(dep_a->dependent, dep_b->dependent);
3944 return CMP(ret, 0);
3945}
3946
3947/** Record a new dependency on a dictionary
3948 *
3949 * These are used to determine what is currently depending on a dictionary.
3950 *
3951 * @param[in] dict to record dependency on.
3952 * @param[in] dependent Either C src file, or another dictionary.
3953 * @return
3954 * - 0 on success.
3955 * - -1 on failure.
3956 */
3957int dict_dependent_add(fr_dict_t *dict, char const *dependent)
3958{
3959 fr_dict_dependent_t *found;
3960
3961 found = fr_rb_find(dict->dependents, &(fr_dict_dependent_t){ .dependent = dependent } );
3962 if (!found) {
3963 fr_dict_dependent_t *new;
3964
3965 new = talloc_zero(dict->dependents, fr_dict_dependent_t);
3966 if (unlikely(!new)) return -1;
3967
3968 /*
3969 * If the dependent is in a module that gets
3970 * unloaded, any strings in the text area also
3971 * get unloaded (including dependent locations).
3972 *
3973 * Strdup the string here so we don't get
3974 * random segfaults if a module forgets to unload
3975 * a dictionary.
3976 */
3977 new->dependent = talloc_typed_strdup(new, dependent);
3978 fr_rb_insert(dict->dependents, new);
3979
3980 new->count = 1;
3981
3982 return 0;
3983 }
3984
3985 found->count++; /* Increase ref count */
3986
3987 return 0;
3988}
3989
3990/** Manually increase the reference count for a dictionary
3991 *
3992 * This is useful if a previously loaded dictionary needs to
3993 * be bound to the lifetime of an additional object.
3994 *
3995 * @param[in] dict to increase the reference count for.
3996 * @param[in] dependent requesting the loading of the dictionary.
3997 * @return
3998 * - 0 on success.
3999 * - -1 on error.
4000 */
4001int fr_dict_dependent_add(fr_dict_t const *dict, char const *dependent)
4002{
4003 fr_dict_t *m_dict = fr_dict_unconst(dict);
4004
4005 if (unlikely(!m_dict)) return -1;
4006
4007 return dict_dependent_add(m_dict, dependent);
4008}
4009
4010/** Decrement ref count for a dependent in a dictionary
4011 *
4012 * @param[in] dict to remove dependency from.
4013 * @param[in] dependent Either C src, or another dictionary dependent.
4014 * What depends on this dictionary.
4015 */
4016int dict_dependent_remove(fr_dict_t *dict, char const *dependent)
4017{
4018 fr_dict_dependent_t *found;
4019
4020 found = fr_rb_find(dict->dependents, &(fr_dict_dependent_t){ .dependent = dependent } );
4021 if (!found) {
4022 fr_strerror_printf("Dependent \"%s\" not found in dictionary \"%s\"", dependent, dict->root->name);
4023 return -1;
4024 }
4025
4026 if (found->count == 0) {
4027 fr_strerror_printf("Zero ref count invalid for dependent \"%s\", dictionary \"%s\"",
4028 dependent, dict->root->name);
4029 return -1;
4030 }
4031
4032 if (--found->count == 0) {
4033 fr_rb_delete(dict->dependents, found);
4034 talloc_free(found);
4035 return 0;
4036 }
4037
4038 return 1;
4039}
4040
4041/** Check if a dictionary still has dependents
4042 *
4043 * @param[in] dict to check
4044 * @return
4045 * - true if there's still at least one dependent.
4046 * - false if there are no dependents.
4047 */
4048bool dict_has_dependents(fr_dict_t *dict)
4049{
4050 return (fr_rb_num_elements(dict->dependents) > 0);
4051}
4052
4053#ifndef NDEBUG
4054static void dependent_debug(fr_dict_t *dict)
4055{
4056 fr_rb_iter_inorder_t iter;
4057 fr_dict_dependent_t *dep;
4058
4059 if (!dict_has_dependents(dict)) return;
4060
4061 fprintf(stderr, "DEPENDENTS FOR %s\n", dict->root->name);
4062
4063 for (dep = fr_rb_iter_init_inorder(dict->dependents, &iter);
4064 dep;
4065 dep = fr_rb_iter_next_inorder(dict->dependents, &iter)) {
4066 fprintf(stderr, "\t<- %s (%d)\n", dep->dependent, dep->count);
4067 }
4068}
4069#endif
4070
4071
4072static int dict_autoref_free(fr_dict_t *dict)
4073{
4074 fr_dict_t **refd_list;
4075 unsigned int i;
4076
4077 if (!dict->autoref) return 0;
4078
4079 if (fr_hash_table_flatten(dict->autoref, (void ***)&refd_list, dict->autoref) < 0) {
4080 fr_strerror_const("failed flattening autoref hash table");
4081 return -1;
4082 }
4083
4084 /*
4085 * Free the dictionary. It will call proto->free() if there's nothing more to do.
4086 */
4087 for (i = 0; i < talloc_array_length(refd_list); i++) {
4088 if (fr_dict_free(&refd_list[i], dict->root->name) < 0) {
4089 fr_strerror_printf("failed freeing autoloaded protocol %s", refd_list[i]->root->name);
4090 return -1;
4091 }
4092 }
4093
4094 TALLOC_FREE(dict->autoref);
4095
4096 return 0;
4097}
4098
4099static int _dict_free(fr_dict_t *dict)
4100{
4101 /*
4102 * We don't necessarily control the order of freeing
4103 * children.
4104 */
4105 if (dict != dict->gctx->internal) {
4106 fr_dict_attr_t const *da;
4107
4108 if (dict->gctx->attr_protocol_encapsulation && dict->root) {
4109 da = fr_dict_attr_child_by_num(dict->gctx->attr_protocol_encapsulation, dict->root->attr);
4110 if (da && fr_dict_attr_ref(da)) dict_attr_ref_null(da);
4111 }
4112 }
4113
4114#ifdef STATIC_ANALYZER
4115 if (!dict->root) {
4116 fr_strerror_const("dict root is missing");
4117 return -1;
4118 }
4119#endif
4120
4121 /*
4122 * If we called init(), then call free()
4123 */
4124 if (dict->proto && dict->proto->free) {
4125 dict->proto->free();
4126 }
4127
4128 if (!fr_cond_assert(!dict->in_protocol_by_name || fr_hash_table_delete(dict->gctx->protocol_by_name, dict))) {
4129 fr_strerror_printf("Failed removing dictionary from protocol hash \"%s\"", dict->root->name);
4130 return -1;
4131 }
4132 dict->in_protocol_by_name = false;
4133
4134 if (!fr_cond_assert(!dict->in_protocol_by_num || fr_hash_table_delete(dict->gctx->protocol_by_num, dict))) {
4135 fr_strerror_printf("Failed removing dictionary from protocol number_hash \"%s\"", dict->root->name);
4136 return -1;
4137 }
4138 dict->in_protocol_by_num = false;
4139
4140 if (dict_has_dependents(dict)) {
4141 fr_rb_iter_inorder_t iter;
4142 fr_dict_dependent_t *dep;
4143
4144 fr_strerror_printf("Refusing to free dictionary \"%s\", still has dependents", dict->root->name);
4145
4146 for (dep = fr_rb_iter_init_inorder(dict->dependents, &iter);
4147 dep;
4148 dep = fr_rb_iter_next_inorder(dict->dependents, &iter)) {
4149 fr_strerror_printf_push("%s (%d)", dep->dependent, dep->count);
4150 }
4151
4152 return -1;
4153 }
4154
4155 /*
4156 * Free the hash tables with free functions first
4157 * so that the things the hash tables reference
4158 * are still there.
4159 */
4160 talloc_free(dict->vendors_by_name);
4161
4162 /*
4163 * Decrease the reference count on the validation
4164 * library we loaded.
4165 */
4166 dl_free(dict->dl);
4167
4168 if (dict == dict->gctx->internal) {
4169 dict->gctx->internal = NULL;
4170 dict->gctx->attr_protocol_encapsulation = NULL;
4171 }
4172
4173 return 0;
4174}
4175
4176/** Allocate a new dictionary
4177 *
4178 * @param[in] ctx to allocate dictionary in.
4179 * @return
4180 * - NULL on memory allocation error.
4181 */
4182fr_dict_t *dict_alloc(TALLOC_CTX *ctx)
4183{
4184 fr_dict_t *dict;
4185
4186 if (!dict_gctx) {
4187 fr_strerror_const("Initialise global dictionary ctx with fr_dict_global_ctx_init()");
4188 return NULL;
4189 }
4190
4191 dict = talloc_zero(ctx, fr_dict_t);
4192 if (!dict) {
4193 fr_strerror_const("Failed allocating memory for dictionary");
4194 error:
4195 talloc_free(dict);
4196 return NULL;
4197 }
4198 dict->gctx = dict_gctx; /* Record which global context this was allocated in */
4199 talloc_set_destructor(dict, _dict_free);
4200
4201 /*
4202 * A list of all the files that constitute this dictionary
4203 */
4204 fr_dlist_talloc_init(&dict->filenames, fr_dict_filename_t, entry);
4205
4206 /*
4207 * Pre-Allocate pool memory for rapid startup
4208 * As that's the working memory required during
4209 * dictionary initialisation.
4210 */
4211 dict->pool = talloc_pool(dict, DICT_POOL_SIZE);
4212 if (!dict->pool) {
4213 fr_strerror_const("Failed allocating talloc pool for dictionary");
4214 goto error;
4215 }
4216
4217 /*
4218 * Create the table of vendor by name. There MAY NOT
4219 * be multiple vendors of the same name.
4220 */
4221 dict->vendors_by_name = fr_hash_table_alloc(dict, dict_vendor_name_hash, dict_vendor_name_cmp, hash_pool_free);
4222 if (!dict->vendors_by_name) {
4223 fr_strerror_printf("Failed allocating \"vendors_by_name\" table");
4224 goto error;
4225 }
4226 /*
4227 * Create the table of vendors by value. There MAY
4228 * be vendors of the same value. If there are, we
4229 * pick the latest one.
4230 */
4231 dict->vendors_by_num = fr_hash_table_alloc(dict, dict_vendor_pen_hash, dict_vendor_pen_cmp, NULL);
4232 if (!dict->vendors_by_num) {
4233 fr_strerror_printf("Failed allocating \"vendors_by_num\" table");
4234 goto error;
4235 }
4236
4237 /*
4238 * Inter-dictionary reference caching
4239 */
4240 dict->autoref = fr_hash_table_alloc(dict, dict_protocol_name_hash, dict_protocol_name_cmp, NULL);
4241 if (!dict->autoref) {
4242 fr_strerror_printf("Failed allocating \"autoref\" table");
4243 goto error;
4244 }
4245
4246 /*
4247 * Who/what depends on this dictionary
4248 */
4249 dict->dependents = fr_rb_inline_alloc(dict, fr_dict_dependent_t, node, _dict_dependent_cmp, NULL);
4250
4251 /*
4252 * Set the default dictionary protocol, this can
4253 * be overriden by the protocol library.
4254 */
4255 dict->proto = &dict_proto_default;
4256
4257 return dict;
4258}
4259
4260/** Allocate a new local dictionary
4261 *
4262 * @param[in] parent parent dictionary and talloc ctx
4263 * @return
4264 * - NULL on memory allocation error.
4265 *
4266 * This dictionary cannot define vendors, or inter-dictionary
4267 * dependencies. However, we initialize the relevant fields just in
4268 * case. We should arguably just skip initializing those fields, and
4269 * just allow the server to crash if programmers do something stupid with it.
4270 */
4271fr_dict_t *fr_dict_protocol_alloc(fr_dict_t const *parent)
4272{
4273 fr_dict_t *dict;
4274 fr_dict_attr_t *da;
4275
4276 fr_dict_attr_flags_t flags = {
4277 .is_root = true,
4278 .local = true,
4279 .internal = true,
4280 .type_size = parent->root->flags.type_size,
4281 .length = parent->root->flags.length,
4282 };
4283
4284 dict = dict_alloc(UNCONST(fr_dict_t *, parent));
4285 if (!dict) return NULL;
4286
4287 /*
4288 * Allocate the root attribute. This dictionary is
4289 * always protocol "local", and number "0".
4290 */
4291 da = dict_attr_alloc_root(dict->pool, parent, "local", 0,
4292 &(dict_attr_args_t){ .flags = &flags });
4293 if (unlikely(!da)) {
4294 talloc_free(dict);
4295 return NULL;
4296 }
4297
4298 da->last_child_attr = fr_dict_root(parent)->last_child_attr;
4299
4300 dict->root = da;
4301 dict->root->dict = dict;
4302 dict->next = parent;
4303
4304 DA_VERIFY(dict->root);
4305
4306 return dict;
4307}
4308
4309/** Decrement the reference count on a previously loaded dictionary
4310 *
4311 * @param[in] dict to free.
4312 * @param[in] dependent that originally allocated this dictionary.
4313 * @return
4314 * - 0 on success (dictionary freed).
4315 * - 1 if other things still depend on the dictionary.
4316 * - -1 on error (dependent doesn't exist)
4317 */
4318int fr_dict_const_free(fr_dict_t const **dict, char const *dependent)
4319{
4320 fr_dict_t **our_dict = UNCONST(fr_dict_t **, dict);
4321
4322 return fr_dict_free(our_dict, dependent);
4323}
4324
4325/** Decrement the reference count on a previously loaded dictionary
4326 *
4327 * @param[in] dict to free.
4328 * @param[in] dependent that originally allocated this dictionary.
4329 * @return
4330 * - 0 on success (dictionary freed).
4331 * - 1 if other things still depend on the dictionary.
4332 * - -1 on error (dependent doesn't exist)
4333 */
4334int fr_dict_free(fr_dict_t **dict, char const *dependent)
4335{
4336 if (!*dict) return 0;
4337
4338 switch (dict_dependent_remove(*dict, dependent)) {
4339 case 0: /* dependent has no more refs */
4340 if (!dict_has_dependents(*dict)) {
4341 talloc_free(*dict);
4342 return 0;
4343 }
4344 FALL_THROUGH;
4345
4346 case 1: /* dependent has more refs */
4347 return 1;
4348
4349 default: /* error */
4350 return -1;
4351 }
4352}
4353
4354/** Process a dict_attr_autoload element to load/verify a dictionary attribute
4355 *
4356 * @param[in] to_load attribute definition
4357 * @return
4358 * - 0 on success.
4359 * - -1 on failure.
4360 */
4361int fr_dict_enum_autoload(fr_dict_enum_autoload_t const *to_load)
4362{
4363 fr_dict_enum_autoload_t const *p = to_load;
4364 fr_dict_enum_value_t const *enumv;
4365
4366 for (p = to_load; p->out; p++) {
4367 if (unlikely(!p->attr)) {
4368 fr_strerror_printf("Invalid attribute autoload entry for \"%s\", missing attribute pointer", p->name);
4369 return -1;
4370 }
4371
4372 if (unlikely(!*p->attr)) {
4373 fr_strerror_printf("Can't resolve value \"%s\", attribute not loaded", p->name);
4374 fr_strerror_printf_push("Check fr_dict_attr_autoload_t struct has "
4375 "an entry to load the attribute \"%s\" is located in, and that "
4376 "the fr_dict_autoload_attr_t symbol name is correct", p->name);
4377 return -1;
4378 }
4379
4380 enumv = fr_dict_enum_by_name(*(p->attr), p->name, -1);
4381 if (!enumv) {
4382 fr_strerror_printf("Value '%s' not found in \"%s\" attribute",
4383 p->name, (*(p->attr))->name);
4384 return -1;
4385 }
4386
4387 if (p->out) *(p->out) = enumv->value;
4388 }
4389
4390 return 0;
4391}
4392
4393/** Process a dict_attr_autoload element to load/verify a dictionary attribute
4394 *
4395 * @param[in] to_load attribute definition
4396 * @return
4397 * - 0 on success.
4398 * - -1 on failure.
4399 */
4400int fr_dict_attr_autoload(fr_dict_attr_autoload_t const *to_load)
4401{
4402 fr_dict_attr_t const *da;
4403 fr_dict_attr_autoload_t const *p = to_load;
4404 fr_dict_attr_t const *root = NULL;
4405
4406 for (p = to_load; p->out; p++) {
4407 if (!p->dict) {
4408 fr_strerror_printf("Invalid attribute autoload entry for \"%s\", missing dictionary pointer", p->name);
4409 return -1;
4410 }
4411
4412 if (!*p->dict) {
4413 fr_strerror_printf("Autoloader autoloader can't resolve attribute \"%s\", dictionary not loaded", p->name);
4414 fr_strerror_printf_push("Check fr_dict_autoload_t struct has "
4415 "an entry to load the dictionary \"%s\" is located in, and that "
4416 "the fr_dict_autoload_t symbol name is correct", p->name);
4417 return -1;
4418 }
4419
4420 if (!root || (root->dict != *p->dict) || (p->name[0] != '.')) {
4421 root = (*p->dict)->root;
4422 }
4423
4424 if (p->name[0] == '.') {
4425 da = fr_dict_attr_by_oid(NULL, root, p->name + 1);
4426 if (!da) {
4427 fr_strerror_printf("Autoloader attribute \"%s\" not found in \"%s\" dictionary under attribute %s", p->name,
4428 *p->dict ? (*p->dict)->root->name : "internal", root->name);
4429 return -1;
4430 }
4431 } else {
4432 da = fr_dict_attr_by_oid(NULL, fr_dict_root(*p->dict), p->name);
4433 if (!da) {
4434 fr_strerror_printf("Autoloader attribute \"%s\" not found in \"%s\" dictionary", p->name,
4435 *p->dict ? (*p->dict)->root->name : "internal");
4436 return -1;
4437 }
4438
4439 if (fr_type_is_structural(da->type)) root = da;
4440 }
4441
4442 if (da->type != p->type) {
4443 fr_strerror_printf("Autoloader attribute \"%s\" should be type %s, but defined as type %s", da->name,
4444 fr_type_to_str(p->type),
4445 fr_type_to_str(da->type));
4446 return -1;
4447 }
4448
4449 DA_VERIFY(da);
4450
4451 if (p->out) *(p->out) = da;
4452 }
4453
4454 return 0;
4455}
4456
4457/** Process a dict_autoload element to load a protocol
4458 *
4459 * @param[in] to_load dictionary definition.
4460 * @param[in] dependent that is loading this dictionary.
4461 * @return
4462 * - 0 on success.
4463 * - -1 on failure.
4464 */
4465int _fr_dict_autoload(fr_dict_autoload_t const *to_load, char const *dependent)
4466{
4467 fr_dict_autoload_t const *p;
4468
4469 for (p = to_load; p->out; p++) {
4470 fr_dict_t *dict = NULL;
4471
4472 if (unlikely(!p->proto)) {
4473 fr_strerror_const("autoload missing parameter proto");
4474 return -1;
4475 }
4476
4477 /*
4478 * Load the internal dictionary
4479 */
4480 if (strcmp(p->proto, "freeradius") == 0) {
4481 if (fr_dict_internal_afrom_file(&dict, p->proto, dependent) < 0) return -1;
4482 } else {
4483 if (fr_dict_protocol_afrom_file(&dict, p->proto, p->base_dir, dependent) < 0) return -1;
4484 }
4485
4486 *(p->out) = dict;
4487 }
4488
4489 return 0;
4490}
4491
4492
4493/** Decrement the reference count on a previously loaded dictionary
4494 *
4495 * @param[in] to_free previously loaded dictionary to free.
4496 * @param[in] dependent that originally allocated this dictionary
4497 */
4498int _fr_dict_autofree(fr_dict_autoload_t const *to_free, char const *dependent)
4499{
4500 fr_dict_autoload_t const *p;
4501
4502 for (p = to_free; p->out; p++) {
4503 int ret;
4504
4505 if (!*p->out) continue;
4506 ret = fr_dict_const_free(p->out, dependent);
4507
4508 if (ret == 0) *p->out = NULL;
4509 if (ret < 0) return -1;
4510 }
4511
4512 return 0;
4513}
4514
4515/** Structure used to managed the lifetime of a dictionary
4516 *
4517 * This should only be used when dictionaries are being dynamically loaded during
4518 * compilation. It should not be used to load dictionaries at runtime, or if
4519 * modules need to load dictionaries (use static fr_dict_autoload_t defs).
4520
4521 */
4522struct fr_dict_autoload_talloc_s {
4523 fr_dict_autoload_t load[2]; //!< Autoloader def.
4524 char const *dependent; //!< Dependent that loaded the dictionary.
4525};
4526
4527/** Talloc destructor to automatically free dictionaries
4528 *
4529 * @param[in] to_free dictionary autoloader definition describing the dictionary to free.
4530 */
4531static int _fr_dict_autoload_talloc_free(fr_dict_autoload_talloc_t const *to_free)
4532{
4533 return _fr_dict_autofree(to_free->load, to_free->dependent);
4534}
4535
4536/** Autoload a dictionary and bind the lifetime to a talloc chunk
4537 *
4538 * Mainly useful for resolving "forward" references from unlang immediately.
4539 *
4540 * @note If the talloc chunk is freed it does not mean the dictionary will
4541 * be immediately freed. It will be freed when all other references
4542 * to the dictionary are gone.
4543 *
4544 * @param[in] ctx to bind the dictionary lifetime to.
4545 * @param[out] out pointer to the loaded dictionary.
4546 * @param[in] proto to load.
4547 * @param[in] dependent to register this reference to. Will be dupd.
4548 */
4549fr_dict_autoload_talloc_t *_fr_dict_autoload_talloc(TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent)
4550{
4551 fr_dict_autoload_talloc_t *dict_ref;
4552 int ret;
4553
4554 dict_ref = talloc(ctx, fr_dict_autoload_talloc_t);
4555 if (unlikely(dict_ref == NULL)) {
4556 oom:
4557 fr_strerror_const("Out of memory");
4558 return NULL;
4559 }
4560
4561 dict_ref->load[0] = (fr_dict_autoload_t){ .proto = proto, .out = out};
4562 dict_ref->load[1] = (fr_dict_autoload_t) DICT_AUTOLOAD_TERMINATOR;
4563 dict_ref->dependent = talloc_strdup(dict_ref, dependent);
4564 if (unlikely(dict_ref->dependent == NULL)) {
4565 talloc_free(dict_ref);
4566 goto oom;
4567 }
4568
4569 ret = _fr_dict_autoload(dict_ref->load, dependent);
4570 if (ret < 0) {
4571 talloc_free(dict_ref);
4572 return NULL;
4573 }
4574
4575 return dict_ref;
4576}
4577
4578/** Callback to automatically resolve enum values
4579 *
4580 * @param[in] module being loaded.
4581 * @param[in] symbol An array of fr_dict_enum_autoload_t to load.
4582 * @param[in] user_ctx unused.
4583 * @return
4584 * - 0 on success.
4585 * - -1 on failure.
4586 */
4587int fr_dl_dict_enum_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
4588{
4589 if (fr_dict_enum_autoload((fr_dict_enum_autoload_t *)symbol) < 0) return -1;
4590
4591 return 0;
4592}
4593
4594/** Callback to automatically resolve attributes and check the types are correct
4595 *
4596 * @param[in] module being loaded.
4597 * @param[in] symbol An array of fr_dict_attr_autoload_t to load.
4598 * @param[in] user_ctx unused.
4599 * @return
4600 * - 0 on success.
4601 * - -1 on failure.
4602 */
4603int fr_dl_dict_attr_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
4604{
4605 if (fr_dict_attr_autoload((fr_dict_attr_autoload_t *)symbol) < 0) return -1;
4606
4607 return 0;
4608}
4609
4610/** Callback to automatically load dictionaries required by modules
4611 *
4612 * @param[in] module being loaded.
4613 * @param[in] symbol An array of fr_dict_autoload_t to load.
4614 * @param[in] user_ctx unused.
4615 * @return
4616 * - 0 on success.
4617 * - -1 on failure.
4618 */
4619int fr_dl_dict_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
4620{
4621 if (fr_dict_autoload((fr_dict_autoload_t const *)symbol) < 0) return -1;
4622
4623 return 0;
4624}
4625
4626/** Callback to automatically free a dictionary when the module is unloaded
4627 *
4628 * @param[in] module being loaded.
4629 * @param[in] symbol An array of fr_dict_autoload_t to load.
4630 * @param[in] user_ctx unused.
4631 */
4632void fr_dl_dict_autofree(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
4633{
4634 fr_dict_autofree(((fr_dict_autoload_t *)symbol));
4635}
4636
4637static int _dict_global_free_at_exit(void *uctx)
4638{
4639 return talloc_free(uctx);
4640}
4641
4642static int _dict_global_free(fr_dict_gctx_t *gctx)
4643{
4644 fr_hash_iter_t iter;
4645 fr_dict_t *dict;
4646 bool still_loaded = false;
4647
4648 /*
4649 * Make sure this doesn't fire later and mess
4650 * things up...
4651 */
4652 if (gctx->free_at_exit) fr_atexit_global_disarm(true, _dict_global_free_at_exit, gctx);
4653
4654 /*
4655 * Free up autorefs first, which will free up inter-dictionary dependencies.
4656 */
4657 for (dict = fr_hash_table_iter_init(gctx->protocol_by_name, &iter);
4658 dict;
4659 dict = fr_hash_table_iter_next(gctx->protocol_by_name, &iter)) {
4660 (void)talloc_get_type_abort(dict, fr_dict_t);
4661
4662 if (dict_autoref_free(dict) < 0) return -1;
4663 }
4664
4665 for (dict = fr_hash_table_iter_init(gctx->protocol_by_name, &iter);
4666 dict;
4667 dict = fr_hash_table_iter_next(gctx->protocol_by_name, &iter)) {
4668 (void)talloc_get_type_abort(dict, fr_dict_t);
4669 dict_dependent_remove(dict, "global"); /* remove our dependency */
4670
4671 if (talloc_free(dict) < 0) {
4672#ifndef NDEBUG
4673 FR_FAULT_LOG("gctx failed to free dictionary %s - %s", dict->root->name, fr_strerror());
4674#endif
4675 still_loaded = true;
4676 }
4677 }
4678
4679 /*
4680 * Free the internal dictionary as the last step, after all of the protocol dictionaries and
4681 * libraries have freed their references to it.
4682 */
4683 if (gctx->internal) {
4684 dict_dependent_remove(gctx->internal, "global"); /* remove our dependency */
4685
4686 if (talloc_free(gctx->internal) < 0) still_loaded = true;
4687 }
4688
4689 if (still_loaded) {
4690#ifndef NDEBUG
4691 fr_dict_gctx_debug(stderr, gctx);
4692#endif
4693 return -1;
4694 }
4695
4696 /*
4697 * Set this to NULL just in case the caller tries to use
4698 * dict_global_init() again.
4699 */
4700 if (gctx == dict_gctx) dict_gctx = NULL; /* In case the active context isn't this one */
4701
4702 return 0;
4703}
4704
4705/** Initialise the global protocol hashes
4706 *
4707 * @note Must be called before any other dictionary functions.
4708 *
4709 * @param[in] ctx to allocate global resources in.
4710 * @param[in] free_at_exit Install an at_exit handler to free the global ctx.
4711 * This is useful when dictionaries are held by other
4712 * libraries which free them using atexit handlers.
4713 * @param[in] dict_dir the default location for the dictionaries.
4714 * @return
4715 * - A pointer to the new global context on success.
4716 * - NULL on failure.
4717 */
4718fr_dict_gctx_t *fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir)
4719{
4720 fr_dict_gctx_t *new_ctx;
4721
4722 new_ctx = talloc_zero(ctx, fr_dict_gctx_t);
4723 if (!new_ctx) {
4724 fr_strerror_const("Out of Memory");
4725 return NULL;
4726 }
4727 new_ctx->perm_check = true; /* Check file permissions by default */
4728
4729 new_ctx->protocol_by_name = fr_hash_table_alloc(new_ctx, dict_protocol_name_hash, dict_protocol_name_cmp, NULL);
4730 if (!new_ctx->protocol_by_name) {
4731 fr_strerror_const("Failed initializing protocol_by_name hash");
4732 error:
4733 talloc_free(new_ctx);
4734 return NULL;
4735 }
4736
4737 new_ctx->protocol_by_num = fr_hash_table_alloc(new_ctx, dict_protocol_num_hash, dict_protocol_num_cmp, NULL);
4738 if (!new_ctx->protocol_by_num) {
4739 fr_strerror_const("Failed initializing protocol_by_num hash");
4740 goto error;
4741 }
4742
4743 new_ctx->dict_dir_default = talloc_strdup(new_ctx, dict_dir);
4744 if (!new_ctx->dict_dir_default) goto error;
4745
4746 new_ctx->dict_loader = dl_loader_init(new_ctx, NULL, false, false);
4747 if (!new_ctx->dict_loader) goto error;
4748
4749 new_ctx->free_at_exit = free_at_exit;
4750
4751 talloc_set_destructor(new_ctx, _dict_global_free);
4752
4753 if (!dict_gctx) dict_gctx = new_ctx; /* Set as the default */
4754
4755 if (free_at_exit) fr_atexit_global(_dict_global_free_at_exit, new_ctx);
4756
4757 return new_ctx;
4758}
4759
4760/** Set whether we check dictionary file permissions
4761 *
4762 * @param[in] gctx to alter.
4763 * @param[in] enable Whether we should check file permissions as they're loaded.
4764 */
4765void fr_dict_global_ctx_perm_check(fr_dict_gctx_t *gctx, bool enable)
4766{
4767 gctx->perm_check = enable;
4768}
4769
4770/** Set a new, active, global dictionary context
4771 *
4772 * @param[in] gctx To set.
4773 */
4774void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx)
4775{
4776 memcpy(&dict_gctx, &gctx, sizeof(dict_gctx));
4777}
4778
4779/** Explicitly free all data associated with a global dictionary context
4780 *
4781 * @note You should *NOT* ignore the return code of this function.
4782 * You should use perror() or PERROR() to print out the reason
4783 * why freeing failed.
4784 *
4785 * @param[in] gctx To set.
4786 * @return
4787 * - 0 on success.
4788 * - -1 on failure.
4789 */
4790int fr_dict_global_ctx_free(fr_dict_gctx_t const *gctx)
4791{
4792 if (dict_gctx == gctx) dict_gctx = NULL;
4793
4794 return talloc_const_free(gctx);
4795}
4796
4797/** Allow the default dict dir to be changed after initialisation
4798 *
4799 * @param[in] dict_dir New default dict dir to use.
4800 * @return
4801 * - 0 on success.
4802 * - -1 on failure.
4803 */
4804int fr_dict_global_ctx_dir_set(char const *dict_dir)
4805{
4806 if (!dict_gctx) return -1;
4807
4808 talloc_free(dict_gctx->dict_dir_default); /* Free previous value */
4809 dict_gctx->dict_dir_default = talloc_strdup(dict_gctx, dict_dir);
4810 if (!dict_gctx->dict_dir_default) return -1;
4811
4812 return 0;
4813}
4814
4815char const *fr_dict_global_ctx_dir(void)
4816{
4817 return dict_gctx->dict_dir_default;
4818}
4819
4820/** Mark all dictionaries and the global dictionary ctx as read only
4821 *
4822 * Any attempts to add new attributes will now fail.
4823 */
4824void fr_dict_global_ctx_read_only(void)
4825{
4826 fr_hash_iter_t iter;
4827 fr_dict_t *dict;
4828
4829 if (!dict_gctx) return;
4830
4831 /*
4832 * Set everything to read only
4833 */
4834 for (dict = fr_hash_table_iter_init(dict_gctx->protocol_by_num, &iter);
4835 dict;
4836 dict = fr_hash_table_iter_next(dict_gctx->protocol_by_num, &iter)) {
4837 dict_hash_tables_finalise(dict);
4838 dict->read_only = true;
4839 }
4840
4841 dict = dict_gctx->internal;
4842 dict_hash_tables_finalise(dict);
4843 dict->read_only = true;
4844 dict_gctx->read_only = true;
4845}
4846
4847/** Dump information about currently loaded dictionaries
4848 *
4849 * Intended to be called from a debugger
4850 */
4851void fr_dict_gctx_debug(FILE *fp, fr_dict_gctx_t const *gctx)
4852{
4853 fr_hash_iter_t dict_iter;
4854 fr_dict_t *dict;
4855 fr_rb_iter_inorder_t dep_iter;
4856 fr_dict_dependent_t *dep;
4857
4858 if (gctx == NULL) gctx = dict_gctx;
4859
4860 if (!gctx) {
4861 fprintf(fp, "gctx not initialised\n");
4862 return;
4863 }
4864
4865 fprintf(fp, "gctx %p report\n", dict_gctx);
4866 for (dict = fr_hash_table_iter_init(gctx->protocol_by_num, &dict_iter);
4867 dict;
4868 dict = fr_hash_table_iter_next(gctx->protocol_by_num, &dict_iter)) {
4869 for (dep = fr_rb_iter_init_inorder(dict->dependents, &dep_iter);
4870 dep;
4871 dep = fr_rb_iter_next_inorder(dict->dependents, &dep_iter)) {
4872 fprintf(fp, "\t%s is referenced from %s count (%d)\n",
4873 dict->root->name, dep->dependent, dep->count);
4874 }
4875 }
4876
4877 if (gctx->internal) {
4878 for (dep = fr_rb_iter_init_inorder(gctx->internal->dependents, &dep_iter);
4879 dep;
4880 dep = fr_rb_iter_next_inorder(gctx->internal->dependents, &dep_iter)) {
4881 fprintf(fp, "\t%s is referenced from %s count (%d)\n",
4882 gctx->internal->root->name, dep->dependent, dep->count);
4883 }
4884 }
4885}
4886
4887/** Iterate protocols by name
4888 *
4889 */
4896
4903
4904
4905/** Coerce to non-const
4906 *
4907 */
4908fr_dict_t *fr_dict_unconst(fr_dict_t const *dict)
4909{
4910 if (unlikely(dict->read_only)) {
4911 fr_strerror_printf("%s dictionary has been marked as read only", fr_dict_root(dict)->name);
4912 return NULL;
4913 }
4914 return UNCONST(fr_dict_t *, dict);
4915}
4916
4917/** Coerce to non-const
4918 *
4919 */
4920fr_dict_attr_t *fr_dict_attr_unconst(fr_dict_attr_t const *da)
4921{
4922 fr_dict_t *dict;
4923
4924 dict = dict_by_da(da);
4925 if (unlikely(dict->read_only)) {
4926 fr_strerror_printf("%s dictionary has been marked as read only", fr_dict_root(dict)->name);
4927 return NULL;
4928 }
4929
4930 return UNCONST(fr_dict_attr_t *, da);
4931}
4932
4933fr_dict_t const *fr_dict_internal(void)
4934{
4935 if (!dict_gctx) return NULL;
4936
4937 return dict_gctx->internal;
4938}
4939
4940/*
4941 * Check for the allowed characters.
4942 */
4943ssize_t fr_dict_valid_name(char const *name, ssize_t len)
4944{
4945 char const *p = name, *end;
4946 bool unknown = false;
4947 bool alnum = false;
4948
4949 if (len < 0) len = strlen(name);
4950
4951 if (len > FR_DICT_ATTR_MAX_NAME_LEN) {
4952 fr_strerror_const("Attribute name is too long");
4953 return -1;
4954 }
4955
4956 end = p + len;
4957
4958 /*
4959 * Unknown attributes can have '.' in their name.
4960 */
4961 if ((len > 5) && (memcmp(name, "Attr-", 5) == 0)) unknown = true;
4962
4963 while (p < end) {
4964 if ((*p == '.') && unknown) p++;
4965
4966 if (!fr_dict_attr_allowed_chars[(uint8_t)*p]) {
4967 fr_strerror_printf("Invalid character '%pV' in attribute name \"%pV\"",
4968 fr_box_strvalue_len(p, 1), fr_box_strvalue_len(name, len));
4969
4970 return -(p - name);
4971 }
4972
4973 alnum |= sbuff_char_alpha_num[(uint8_t)*p];
4974
4975 p++;
4976 }
4977
4978 if (!alnum) {
4979 fr_strerror_const("Invalid attribute name");
4980 return -1;
4981 }
4982
4983 return len;
4984}
4985
4986ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len)
4987{
4988 char const *p = name, *end;
4989 bool alnum = false;
4990
4991 if (len < 0) len = strlen(name);
4992 end = p + len;
4993
4994 do {
4995 if (!fr_dict_attr_allowed_chars[(uint8_t)*p] && (*p != '.')) {
4996 fr_strerror_printf("Invalid character '%pV' in oid string \"%pV\"",
4997 fr_box_strvalue_len(p, 1), fr_box_strvalue_len(name, len));
4998
4999 return -(p - name);
5000 }
5001
5002 alnum |= sbuff_char_alpha_num[(uint8_t)*p];
5003 p++;
5004 } while (p < end);
5005
5006 if (!alnum) return 0;
5007
5008 return len;
5009}
5010
5011/** Iterate over children of a DA.
5012 *
5013 * @param[in] parent the parent da to iterate over
5014 * @param[in,out] prev pointer to NULL to start, otherwise pointer to the previously returned child
5015 * @return
5016 * - NULL for end of iteration
5017 * - !NULL for a valid child. This child MUST be passed to the next loop.
5018 */
5019fr_dict_attr_t const *fr_dict_attr_iterate_children(fr_dict_attr_t const *parent, fr_dict_attr_t const **prev)
5020{
5021 fr_dict_attr_t const * const *bin;
5022 fr_dict_attr_t const **children;
5023 fr_dict_attr_t const *ref;
5024 size_t len, i, start;
5025
5026 ref = fr_dict_attr_ref(parent);
5027 if (ref) parent = ref;
5028
5029 children = dict_attr_children(parent);
5030 if (!children) return NULL;
5031
5032 if (!*prev) {
5033 start = 0;
5034
5035 } else if ((*prev)->next) {
5036 /*
5037 * There are more children in this bin, return
5038 * the next one.
5039 */
5040 return (*prev)->next;
5041
5042 } else {
5043 /*
5044 * Figure out which bin we were in. If it was
5045 * the last one, we're done.
5046 */
5047 start = (*prev)->attr & 0xff;
5048 if (start == 255) return NULL;
5049
5050 /*
5051 * Start at the next bin.
5052 */
5053 start++;
5054 }
5055
5056 /*
5057 * Look for a non-empty bin, and return the first child
5058 * from there.
5059 */
5060 len = talloc_array_length(children);
5061 for (i = start; i < len; i++) {
5062 bin = &children[i & 0xff];
5063
5064 if (*bin) return *bin;
5065 }
5066
5067 return NULL;
5068}
5069
5070/** Call the specified callback for da and then for all its children
5071 *
5072 */
5073static int dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
5074{
5075 size_t i, len;
5076 fr_dict_attr_t const **children;
5077
5078 children = dict_attr_children(da);
5079
5080 if (fr_dict_attr_ref(da) || !children) return callback(da, uctx);
5081
5082 len = talloc_array_length(children);
5083 for (i = 0; i < len; i++) {
5084 int ret;
5085 fr_dict_attr_t const *bin;
5086
5087 if (!children[i]) continue;
5088
5089 for (bin = children[i]; bin; bin = bin->next) {
5090 ret = dict_walk(bin, callback, uctx);
5091 if (ret < 0) return ret;
5092 }
5093 }
5094
5095 return 0;
5096}
5097
5098int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
5099{
5100 return dict_walk(da, callback, uctx);
5101}
5102
5103
5104void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da)
5105{
5106 int i;
5107 fr_dict_attr_t const *da_p;
5108
5109 (void) talloc_get_type_abort_const(da, fr_dict_attr_t);
5110
5111 if ((!da->flags.is_root) && (da->depth == 0)) {
5112 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: fr_dict_attr_t %s vendor: %u, attr %u: "
5113 "Is not root, but depth is 0",
5114 file, line, da->name, fr_dict_vendor_num_by_da(da), da->attr);
5115 }
5116
5117 if (da->depth > FR_DICT_MAX_TLV_STACK) {
5118 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: fr_dict_attr_t %s vendor: %u, attr %u: "
5119 "Indicated depth (%u) greater than TLV stack depth (%d)",
5120 file, line, da->name, fr_dict_vendor_num_by_da(da), da->attr,
5121 da->depth, FR_DICT_MAX_TLV_STACK);
5122 }
5123
5124 for (da_p = da; da_p; da_p = da_p->next) {
5125 (void) talloc_get_type_abort_const(da_p, fr_dict_attr_t);
5126 }
5127
5128 for (i = da->depth, da_p = da; i >= 0; i--, da_p = da_p->parent) {
5129 if (!da_p) {
5130 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: fr_dict_attr_t %s vendor: %u, attr %u: "
5131 "Depth indicated there should be a parent, but parent is NULL",
5132 file, line, da->name, fr_dict_vendor_num_by_da(da), da->attr);
5133 }
5134 if (i != (int)da_p->depth) {
5135 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: fr_dict_attr_t %s vendor: %u, attr %u: "
5136 "Depth out of sequence, expected %i, got %u",
5137 file, line, da->name, fr_dict_vendor_num_by_da(da), da->attr, i, da_p->depth);
5138 }
5139
5140 }
5141
5142 if ((i + 1) < 0) {
5143 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: fr_dict_attr_t top of hierarchy was not at depth 0",
5144 file, line);
5145 }
5146
5147 if (da->parent && (da->parent->type == FR_TYPE_VENDOR) && !fr_dict_attr_has_ext(da, FR_DICT_ATTR_EXT_VENDOR)) {
5148 fr_fatal_assert_fail("CONSISTENCY CHECK FAILED %s[%d]: VSA missing 'vendor' extension", file, line);
5149 }
5150
5151 switch (da->type) {
5152 case FR_TYPE_STRUCTURAL:
5153 {
5154 fr_hash_table_t *ht;
5155
5156 if (da->type == FR_TYPE_GROUP) break;
5157
5158 fr_assert_msg(fr_dict_attr_has_ext(da, FR_DICT_ATTR_EXT_CHILDREN),
5159 "CONSISTENCY CHECK FAILED %s[%d]: %s missing 'children' extension",
5160 file, line,
5161 fr_type_to_str(da->type));
5162
5163 fr_assert_msg(fr_dict_attr_has_ext(da, FR_DICT_ATTR_EXT_NAMESPACE),
5164 "CONSISTENCY CHECK FAILED %s[%d]: %s missing 'namespace' extension",
5165 file, line,
5166 fr_type_to_str(da->type));
5167
5168 /*
5169 * Check the namespace hash table is ok
5170 */
5171 ht = dict_attr_namespace(da);
5172 if (unlikely(!ht)) break;
5173 fr_hash_table_verify(ht);
5174 }
5175 break;
5176
5177 default:
5178 break;
5179 }
5180}
5181
5182/** See if a structural da is allowed to contain another da
5183 *
5184 * We have some complex rules with different structural types,
5185 * different protocol dictionaries, references to other protocols,
5186 * etc.
5187 *
5188 * @param[in] parent The parent da, must be structural
5189 * @param[in] child The alleged child
5190 * @return
5191 * - false - the child is not allowed to be contained by the parent
5192 * - true - the child is allowed to be contained by the parent
5193 */
5194bool fr_dict_attr_can_contain(fr_dict_attr_t const *parent, fr_dict_attr_t const *child)
5195{
5196 /*
5197 * This is the common case: child is from the parent.
5198 */
5199 if (child->parent == parent) return true;
5200
5201 if (child->flags.is_raw) return true; /* let people do stupid things */
5202
5203 /*
5204 * Only structural types can have children.
5205 */
5206 if (!fr_type_structural[parent->type]) return false;
5207
5208 /*
5209 * An internal attribute can go into any other container.
5210 *
5211 * Any other attribute can go into an internal structural
5212 * attribute, because why not?
5213 */
5214 if (dict_gctx) {
5215 if (child->dict == dict_gctx->internal) return true;
5216
5217 if (parent->dict == dict_gctx->internal) return true;
5218 }
5219
5220 /*
5221 * Anything can go into internal groups.
5222 */
5223 if ((parent->type == FR_TYPE_GROUP) && parent->flags.internal) return true;
5224
5225 /*
5226 * Protocol attributes have to be in the same dictionary.
5227 *
5228 * Unless they're a cross-protocol grouping attribute.
5229 * In which case we check if the ref is the same.
5230 */
5231 if (child->dict != parent->dict) {
5232 fr_dict_attr_t const *ref;
5233
5234 ref = fr_dict_attr_ref(parent);
5235
5236 return (ref && (ref->dict == child->dict));
5237 }
5238
5239 /*
5240 * Key fields can have children, but everyone else thinks
5241 * that the struct is the parent. <sigh>
5242 */
5243 if ((parent->type == FR_TYPE_STRUCT) && child->parent->parent == parent) return true;
5244
5245 /*
5246 * We're in the same protocol dictionary, but the child
5247 * isn't directly from the parent. Therefore the only
5248 * type of same-protocol structure it can go into is a
5249 * group.
5250 */
5251 return (parent->type == FR_TYPE_GROUP);
5252}
5253
5254/** Return the protocol descriptor for the dictionary.
5255 *
5256 */
5257fr_dict_protocol_t const *fr_dict_protocol(fr_dict_t const *dict)
5258{
5259 return dict->proto;
5260}
5261
5262/*
5263 * Get the real protocol namespace behind a local one.
5264 */
5265fr_dict_attr_t const *fr_dict_unlocal(fr_dict_attr_t const *da)
5266{
5267 if (!da->flags.local) return da;
5268
5269 fr_assert(da->dict->root == da);
5270
5271 while (da->dict->next) {
5272 da = da->dict->next->root;
5273 }
5274
5275 return da;
5276}
5277
5278/*
5279 * Get the real protocol dictionary behind a local one.
5280 */
5281fr_dict_t const *fr_dict_proto_dict(fr_dict_t const *dict)
5282{
5283 while (dict->next) dict = dict->next;
5284
5285 return dict;
5286}
5287
5288int fr_dict_attr_set_group(fr_dict_attr_t **da_p, fr_dict_attr_t const *ref)
5289{
5290 if ((*da_p)->type == FR_TYPE_GROUP) {
5291 fr_assert(fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_REF) != NULL);
5292 return 0;
5293 }
5294
5295 (*da_p)->type = FR_TYPE_GROUP;
5296 (*da_p)->flags.type_size = 0;
5297 (*da_p)->flags.length = 0;
5298
5299 fr_assert(fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_REF) == NULL);
5300
5301 return dict_attr_ref_aset(da_p, ref, FR_DICT_ATTR_REF_ALIAS);
5302}
buffer
static int const char char buffer[256]
Definition acutest.h:578
file
int const char * file
Definition acutest.h:704
n
int n
Definition acutest.h:579
args
va_list args
Definition acutest.h:772
line
int const char int line
Definition acutest.h:704
fr_atexit_global_disarm
unsigned int fr_atexit_global_disarm(bool uctx_scope, fr_atexit_t func, void const *uctx)
Remove a specific global destructor (without executing it)
Definition atexit.c:229
fr_atexit_global
#define fr_atexit_global(_func, _uctx)
Add a free function to the global free list.
Definition atexit.h:59
UNCONST
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
Definition build.h:167
RCSID
#define RCSID(id)
Definition build.h:487
FALL_THROUGH
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
Definition build.h:324
CMP
#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
unlikely
#define unlikely(_x)
Definition build.h:383
UNUSED
#define UNUSED
Definition build.h:317
fr_fatal_assert_fail
#define fr_fatal_assert_fail(_msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:183
fr_cond_assert
#define fr_cond_assert(_x)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:131
fr_assert_msg
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:202
FR_FAULT_LOG
#define FR_FAULT_LOG(_fmt,...)
Definition debug.h:50
fr_cond_assert_msg
#define fr_cond_assert_msg(_x, _fmt,...)
Calls panic_action ifndef NDEBUG, else logs error and evaluates to value of _x.
Definition debug.h:148
fr_dict_vendor_t::type
size_t type
Length of type data.
Definition dict.h:274
fr_dict_enum_value_t::name_len
size_t name_len
Allows for efficient name lookups when operating on partial buffers.
Definition dict.h:257
fr_dict_protocol_t::attr
struct fr_dict_protocol_t::@124 attr
fr_dict_attr_autoload_t::name
char const * name
of the attribute.
Definition dict.h:299
FR_DICT_ENUM_EXT_ATTR_REF
@ FR_DICT_ENUM_EXT_ATTR_REF
Reference to a child attribute associated with this key value.
Definition dict.h:240
fr_dict_vendor_t::name
char const * name
Vendor name.
Definition dict.h:276
fr_dict_enum_autoload_t::attr
fr_dict_attr_t const ** attr
The protocol dictionary the attribute should be resolved in.
Definition dict.h:284
fr_dict_by_da
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:2876
fr_dict_attr_flags_t::is_root
unsigned int is_root
Is root of a dictionary.
Definition dict.h:77
fr_dict_autofree
#define fr_dict_autofree(_to_free)
Definition dict.h:917
fr_dict_attr_common_parent
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:2318
err
static fr_slen_t err
Definition dict.h:884
fr_dict_attr_by_name
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:3533
fr_dict_internal_afrom_file
int fr_dict_internal_afrom_file(fr_dict_t **out, char const *dict_subdir, char const *dependent))
(Re-)Initialize the special internal dictionary
Definition dict_tokenize.c:3510
fr_dict_enum_autoload_t::out
fr_value_box_t const ** out
Enumeration value.
Definition dict.h:283
fr_dict_attr_autoload_t::dict
fr_dict_t const ** dict
The protocol dictionary the attribute should be resolved in.
Definition dict.h:296
fr_dict_walk_t
int(* fr_dict_walk_t)(fr_dict_attr_t const *da, void *uctx)
Definition dict.h:995
fr_dict_attr_autoload_t::out
fr_dict_attr_t const ** out
Where to write a pointer to the resolved fr_dict_attr_t.
Definition dict.h:294
fr_dict_autoload_t::out
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:307
DA_VERIFY
#define DA_VERIFY(_x)
Definition dict.h:68
fr_dict_enum_autoload_t::name
char const * name
of the attribute.
Definition dict.h:287
fr_dict_enum_value_t::value
fr_value_box_t const * value
Enum value (what name maps to).
Definition dict.h:259
fr_dict_vendor_t::pen
uint32_t pen
Private enterprise number.
Definition dict.h:272
fr_dict_attr_autoload_t::type
fr_type_t type
of the attribute. Mismatch is a fatal error.
Definition dict.h:300
fr_dict_protocol_afrom_file
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
Definition dict_tokenize.c:3647
fr_dict_vendor_t::length
size_t length
Length of length data.
Definition dict.h:275
fr_dict_autoload_t::base_dir
char const * base_dir
Directory structure beneath share.
Definition dict.h:309
FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
@ FR_DICT_ATTR_EXT_PROTOCOL_SPECIFIC
Protocol specific extensions.
Definition dict.h:192
FR_DICT_ATTR_EXT_ENUMV
@ FR_DICT_ATTR_EXT_ENUMV
Enumeration values.
Definition dict.h:190
FR_DICT_ATTR_EXT_NAMESPACE
@ FR_DICT_ATTR_EXT_NAMESPACE
Attribute has its own namespace.
Definition dict.h:191
FR_DICT_ATTR_EXT_REF
@ FR_DICT_ATTR_EXT_REF
Attribute references another attribute and/or dictionary.
Definition dict.h:186
FR_DICT_ATTR_EXT_VENDOR
@ FR_DICT_ATTR_EXT_VENDOR
Cached vendor pointer.
Definition dict.h:189
FR_DICT_ATTR_EXT_NAME
@ FR_DICT_ATTR_EXT_NAME
Name of the attribute.
Definition dict.h:184
FR_DICT_ATTR_EXT_CHILDREN
@ FR_DICT_ATTR_EXT_CHILDREN
Attribute has children.
Definition dict.h:185
fr_dict_autoload
#define fr_dict_autoload(_to_load)
Definition dict.h:914
FR_DICT_MAX_TLV_STACK
#define FR_DICT_MAX_TLV_STACK
Maximum TLV stack size.
Definition dict.h:519
fr_dict_attr_err_t
fr_dict_attr_err_t
Errors returned by attribute lookup functions.
Definition dict.h:319
FR_DICT_ATTR_OK
@ FR_DICT_ATTR_OK
No error.
Definition dict.h:320
FR_DICT_ATTR_NOTFOUND
@ FR_DICT_ATTR_NOTFOUND
Attribute couldn't be found.
Definition dict.h:321
FR_DICT_ATTR_EINVAL
@ FR_DICT_ATTR_EINVAL
Invalid arguments.
Definition dict.h:331
FR_DICT_ATTR_NO_CHILDREN
@ FR_DICT_ATTR_NO_CHILDREN
Child lookup in attribute with no children.
Definition dict.h:330
FR_DICT_ATTR_PARSE_ERROR
@ FR_DICT_ATTR_PARSE_ERROR
Attribute string couldn't be parsed.
Definition dict.h:323
FR_DICT_ATTR_INTERNAL_ERROR
@ FR_DICT_ATTR_INTERNAL_ERROR
Internal error occurred.
Definition dict.h:324
FR_DICT_ENUM_MAX_NAME_LEN
#define FR_DICT_ENUM_MAX_NAME_LEN
Maximum length of a enum value.
Definition dict.h:501
DICT_AUTOLOAD_TERMINATOR
#define DICT_AUTOLOAD_TERMINATOR
Definition dict.h:313
fr_dict_autoload_t::proto
char const * proto
The protocol dictionary name.
Definition dict.h:310
fr_dict_attr_is_key_field
#define fr_dict_attr_is_key_field(_da)
Definition dict.h:172
fr_dict_enum_value_t::name
char const * name
Enum name.
Definition dict.h:256
in
static fr_slen_t in
Definition dict.h:884
fr_dict_protocol_t::name
char const * name
name of this protocol
Definition dict.h:458
FR_DICT_VENDOR_MAX_NAME_LEN
#define FR_DICT_VENDOR_MAX_NAME_LEN
Maximum length of a vendor name.
Definition dict.h:502
FR_DICT_ATTR_MAX_NAME_LEN
#define FR_DICT_ATTR_MAX_NAME_LEN
Maximum length of a attribute name.
Definition dict.h:503
fr_dict_attr_flags_t::is_alias
unsigned int is_alias
This isn't a real attribute, it's a reference to to one.
Definition dict.h:87
fr_dict_enum_ext_attr_ref_t::da
fr_dict_attr_t const * da
the child structure referenced by this value of key
Definition dict.h:248
fr_dict_attr_autoload_t
Specifies an attribute which must be present for the module to function.
Definition dict.h:293
fr_dict_attr_flags_t
Values of the encryption flags.
Definition merged_model.c:139
fr_dict_autoload_t
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:306
fr_dict_enum_autoload_t
Specifies a value which must be present for the module to function.
Definition dict.h:282
fr_dict_enum_ext_attr_ref_t
Enum extension - Sub-struct or union pointer.
Definition dict.h:247
fr_dict_enum_value_t
Value of an enumerated attribute.
Definition dict.h:255
fr_dict_protocol_t
Protocol-specific callbacks in libfreeradius-PROTOCOL.
Definition dict.h:457
fr_dict_vendor_t
Private enterprise.
Definition dict.h:271
fr_dict_attr_ext_enumv_t::max_name_len
size_t max_name_len
maximum length of a name
Definition dict_ext.h:96
fr_dict_attr_ext_vendor_t::vendor
fr_dict_attr_t const * vendor
ancestor which has type FR_TYPE_VENDOR
Definition dict_ext.h:89
fr_dict_attr_ext_ref_t::type
fr_dict_attr_ref_type_t type
The state of the reference.
Definition dict_ext.h:78
fr_dict_attr_ext_enumv_t::name_by_value
fr_hash_table_t * name_by_value
Lookup a name by value.
Definition dict_ext.h:98
fr_dict_attr_ext
static void * fr_dict_attr_ext(fr_dict_attr_t const *da, fr_dict_attr_ext_t ext)
Definition dict_ext.h:121
fr_dict_attr_ext_enumv_t::value_by_name
fr_hash_table_t * value_by_name
Lookup an enumeration value by name.
Definition dict_ext.h:97
fr_dict_attr_ref
static fr_dict_attr_t const * fr_dict_attr_ref(fr_dict_attr_t const *da)
Return the reference associated with a group type attribute.
Definition dict_ext.h:148
fr_dict_attr_has_ext
static bool fr_dict_attr_has_ext(fr_dict_attr_t const *da, fr_dict_attr_ext_t ext)
Return whether a da has a given extension or not.
Definition dict_ext.h:136
FR_DICT_ATTR_REF_ALIAS
@ FR_DICT_ATTR_REF_ALIAS
The attribute is an alias for another attribute.
Definition dict_ext.h:59
FR_DICT_ATTR_REF_NONE
@ FR_DICT_ATTR_REF_NONE
No ref set.
Definition dict_ext.h:58
fr_dict_vendor_num_by_da
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:176
fr_dict_attr_ext_children_t
Attribute extension - Holds children for an attribute.
Definition dict_ext.h:52
fr_dict_attr_ext_enumv_t
Attribute extension - Holds enumeration values.
Definition dict_ext.h:95
fr_dict_attr_ext_namespace_t
Attribute extension - Holds a hash table with the names of all children of this attribute.
Definition dict_ext.h:104
fr_dict_attr_ext_ref_t
Attribute extension - Holds a reference to an attribute in another dictionary.
Definition dict_ext.h:77
fr_dict_attr_ext_vendor_t
Attribute extension - Cached vendor pointer.
Definition dict_ext.h:88
dict_attr_ref_set
static int dict_attr_ref_set(fr_dict_attr_t const *da, fr_dict_attr_t const *ref, fr_dict_attr_ref_type_t type)
Definition dict_ext_priv.h:172
dict_attr_children_set
static int dict_attr_children_set(fr_dict_attr_t const *da, fr_dict_attr_t const **children)
Definition dict_ext_priv.h:244
dict_attr_namespace
static fr_hash_table_t * dict_attr_namespace(fr_dict_attr_t const *da)
Return the namespace hash table associated with the attribute.
Definition dict_ext_priv.h:277
dict_attr_ref_null
static int dict_attr_ref_null(fr_dict_attr_t const *da)
Definition dict_ext_priv.h:128
dict_attr_ext_copy_all
static int dict_attr_ext_copy_all(fr_dict_attr_t **da_out_p, fr_dict_attr_t const *da_in)
Copy all attribute extensions from one attribute to another.
Definition dict_ext_priv.h:107
dict_attr_ext_copy
static void * dict_attr_ext_copy(fr_dict_attr_t **da_out_p, fr_dict_attr_t const *da_in, fr_dict_attr_ext_t ext)
Copy a single attribute extension from one attribute to another.
Definition dict_ext_priv.h:86
dict_attr_children
static fr_dict_attr_t const ** dict_attr_children(fr_dict_attr_t const *da)
Definition dict_ext_priv.h:258
dict_attr_ext_alloc_size
static void * dict_attr_ext_alloc_size(fr_dict_attr_t **da_p, fr_dict_attr_ext_t ext, size_t ext_len)
Allocate an attribute extension of a particular size.
Definition dict_ext_priv.h:58
dict_enum_ext_alloc
static void * dict_enum_ext_alloc(fr_dict_enum_value_t **enumv_p, fr_dict_enum_ext_t ext)
Allocate an enum extension.
Definition dict_ext_priv.h:295
dict_attr_ref_aset
static int dict_attr_ref_aset(fr_dict_attr_t **da_p, fr_dict_attr_t const *ref, fr_dict_attr_ref_type_t type)
Definition dict_ext_priv.h:149
dict_attr_ext_alloc
static void * dict_attr_ext_alloc(fr_dict_attr_t **da_p, fr_dict_attr_ext_t ext)
Allocate an attribute extension.
Definition dict_ext_priv.h:68
dict_hash_tables_finalise
void dict_hash_tables_finalise(fr_dict_t *dict)
Walk a dictionary finalising the hash tables in all attributes with a distinct namespace.
Definition dict_fixup.c:877
fr_dict_gctx_s::dict_dir_default
char * dict_dir_default
The default location for loading dictionaries if one wasn't provided.
Definition dict_priv.h:137
fr_dict_gctx_s::protocol_by_name
fr_hash_table_t * protocol_by_name
Hash containing names of all the registered protocols.
Definition dict_priv.h:142
dict_attr_alloc
#define dict_attr_alloc(_ctx, _parent, _name, _attr, _type, _args)
Definition dict_priv.h:255
INTERNAL_IF_NULL
#define INTERNAL_IF_NULL(_dict, _ret)
Set the internal dictionary if none was provided.
Definition dict_priv.h:45
fr_dict_gctx_s::protocol_by_num
fr_hash_table_t * protocol_by_num
Hash containing numbers of all the registered protocols.
Definition dict_priv.h:144
fr_dict_s::root
fr_dict_attr_t * root
Root attribute of this dictionary.
Definition dict_priv.h:109
DICT_POOL_SIZE
#define DICT_POOL_SIZE
Definition dict_priv.h:37
fr_dict_gctx_s::dict_loader
dl_loader_t * dict_loader
for protocol validation
Definition dict_priv.h:140
dict_attr_init
#define dict_attr_init(_da_p, _parent, _name, _attr, _type, _args)
Full initialisation functions.
Definition dict_priv.h:231
fr_dict_dependent_t::dependent
char const * dependent
File holding the reference.
Definition dict_priv.h:62
dict_attr_valid
bool dict_attr_valid(fr_dict_attr_t *da)
Validate a new attribute definition.
Definition dict_validate.c:642
dict_attr_init_name_only
#define dict_attr_init_name_only(_da_p, _parent, _name, _type, _args)
Definition dict_priv.h:239
fr_dict_gctx_s::attr_protocol_encapsulation
fr_dict_attr_t const * attr_protocol_encapsulation
Definition dict_priv.h:157
FR_DICT_PROTO_RADIUS
@ FR_DICT_PROTO_RADIUS
Definition dict_priv.h:161
dict_attr_alias_add
int dict_attr_alias_add(fr_dict_attr_t const *parent, char const *alias, fr_dict_attr_t const *ref, bool from_public)
Add an alias to an existing attribute.
Definition dict_util.c:1409
fr_dict_gctx_s::internal
fr_dict_t * internal
Magic internal dictionary.
Definition dict_priv.h:155
fr_dict_gctx_s::free_at_exit
bool free_at_exit
This gctx will be freed on exit.
Definition dict_priv.h:130
dict_attr_alloc_root
#define dict_attr_alloc_root(_ctx, _dict, _name, _attr, _args)
Definition dict_priv.h:247
fr_dict_gctx_s::perm_check
bool perm_check
Whether we should check dictionary file permissions as they're loaded.
Definition dict_priv.h:132
fr_dict_gctx_s::read_only
bool read_only
Definition dict_priv.h:135
fr_dict_dependent_t::count
int count
How many references are held by this file.
Definition dict_priv.h:60
dict_attr_args_t
Optional arguments for initialising/allocating attributes.
Definition dict_priv.h:191
fr_dict_dependent_t
Entry recording dictionary reference holders by file.
Definition dict_priv.h:58
fr_dict_filename_t
Entry in the filename list of files associated with this dictionary.
Definition dict_priv.h:69
fr_dict_gctx_s
Definition dict_priv.h:129
value
Test enumeration values.
Definition dict_test.h:92
dict_proto_default
static fr_dict_protocol_t dict_proto_default
Default protocol rules set for every dictionary.
Definition dict_util.c:103
fr_dl_dict_attr_autoload
int fr_dl_dict_attr_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
Callback to automatically resolve attributes and check the types are correct.
Definition dict_util.c:4603
fr_dict_global_ctx_iter_next
fr_dict_t * fr_dict_global_ctx_iter_next(fr_dict_global_ctx_iter_t *iter)
Definition dict_util.c:4897
fr_dict_attr_set_group
int fr_dict_attr_set_group(fr_dict_attr_t **da_p, fr_dict_attr_t const *ref)
Definition dict_util.c:5288
fr_dict_enum_add_name
int fr_dict_enum_add_name(fr_dict_attr_t *da, char const *name, fr_value_box_t const *value, bool coerce, bool takes_precedence)
Add a value name.
Definition dict_util.c:2222
fr_dict_attr_search_by_name_substr
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:3274
fr_dict_global_ctx_init
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:4718
fr_dict_attr_add_initialised
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:1850
fr_dict_valid_oid_str
ssize_t fr_dict_valid_oid_str(char const *name, ssize_t len)
Definition dict_util.c:4986
fr_dict_global_ctx_dir_set
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:4804
fr_dict_enum_name_from_substr
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:3826
_dict_global_free_at_exit
static int _dict_global_free_at_exit(void *uctx)
Definition dict_util.c:4637
dict_protocol_num_hash
static uint32_t dict_protocol_num_hash(void const *data)
Hash a protocol number.
Definition dict_util.c:178
dict_vendor_name_hash
static uint32_t dict_vendor_name_hash(void const *data)
Wrap name hash function for fr_dict_vendor_t.
Definition dict_util.c:287
DICT_NAME_APPEND
#define DICT_NAME_APPEND(_in, _dict)
_dict_free
static int _dict_free(fr_dict_t *dict)
Definition dict_util.c:4099
fr_dict_unconst
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4908
dict_attr_init_common
static int dict_attr_init_common(char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, fr_type_t type, dict_attr_args_t const *args)
Definition dict_util.c:834
fr_dict_by_da
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:2876
fr_dict_enum_autoload
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:4361
fr_dict_enum_iter_init
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:3619
_fr_dict_autofree
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:4498
dict_autoref_free
static int dict_autoref_free(fr_dict_t *dict)
Definition dict_util.c:4072
fr_dict_walk
int fr_dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
Definition dict_util.c:5098
dict_by_protocol_substr
fr_slen_t dict_by_protocol_substr(fr_dict_attr_err_t *err, fr_dict_t **out, fr_sbuff_t *name, fr_dict_t const *dict_def)
Definition dict_util.c:2685
fr_dict_unlocal
fr_dict_attr_t const * fr_dict_unlocal(fr_dict_attr_t const *da)
Definition dict_util.c:5265
fr_dict_attr_common_parent
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:2318
dict_walk
static int dict_walk(fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
Call the specified callback for da and then for all its children.
Definition dict_util.c:5073
dict_attr_alloc_null
fr_dict_attr_t * dict_attr_alloc_null(TALLOC_CTX *ctx, fr_dict_protocol_t const *proto)
Allocate a partially completed attribute.
Definition dict_util.c:994
dict_attr_type_init
int dict_attr_type_init(fr_dict_attr_t **da_p, fr_type_t type)
Initialise type specific fields within the dictionary attribute.
Definition dict_util.c:556
dict_attr_parent_init
int dict_attr_parent_init(fr_dict_attr_t **da_p, fr_dict_attr_t const *parent)
Initialise fields which depend on a parent attribute.
Definition dict_util.c:643
dependent_debug
static void dependent_debug(fr_dict_t *dict)
Definition dict_util.c:4054
fr_dict_proto_dict
fr_dict_t const * fr_dict_proto_dict(fr_dict_t const *dict)
Definition dict_util.c:5281
dict_alloc
fr_dict_t * dict_alloc(TALLOC_CTX *ctx)
Allocate a new dictionary.
Definition dict_util.c:4182
dict_vendor_pen_hash
static uint32_t dict_vendor_pen_hash(void const *data)
Hash a vendor number.
Definition dict_util.c:312
fr_dict_attr_allowed_chars
bool const fr_dict_attr_allowed_chars[UINT8_MAX+1]
Characters allowed in a single dictionary attribute name.
Definition dict_util.c:64
fr_dict_attr_ordered_cmp
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
fr_dict_protocol
fr_dict_protocol_t const * fr_dict_protocol(fr_dict_t const *dict)
Return the protocol descriptor for the dictionary.
Definition dict_util.c:5257
_dict_attr_alloc_root
fr_dict_attr_t * _dict_attr_alloc_root(char const *filename, int line, TALLOC_CTX *ctx, fr_dict_t const *dict, char const *name, int proto_number, dict_attr_args_t const *args)
Allocate a dictionary root attribute on the heap.
Definition dict_util.c:1035
_dict_attr_alloc
fr_dict_attr_t * _dict_attr_alloc(char const *filename, int line, TALLOC_CTX *ctx, fr_dict_attr_t const *parent, char const *name, int attr, fr_type_t type, dict_attr_args_t const *args)
Allocate a dictionary attribute on the heap.
Definition dict_util.c:1069
fr_dict_attr_acopy_local
int fr_dict_attr_acopy_local(fr_dict_attr_t const *dst, fr_dict_attr_t const *src)
Definition dict_util.c:1134
fr_dl_dict_autofree
void fr_dl_dict_autofree(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
Callback to automatically free a dictionary when the module is unloaded.
Definition dict_util.c:4632
_fr_dict_autoload_talloc
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:4549
fr_dict_compatible
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:2889
dict_attr_search_qualified
static fr_slen_t dict_attr_search_qualified(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, dict_attr_resolve_func_t func)
Internal function for searching for attributes in multiple dictionaries.
Definition dict_util.c:3178
dict_attr_can_have_children
bool dict_attr_can_have_children(fr_dict_attr_t const *da)
See if a fr_dict_attr_t can have children.
Definition dict_util.c:1660
fr_dict_attr_unconst
fr_dict_attr_t * fr_dict_attr_unconst(fr_dict_attr_t const *da)
Coerce to non-const.
Definition dict_util.c:4920
_dict_dependent_cmp
static int8_t _dict_dependent_cmp(void const *a, void const *b)
Find a dependent in the tree of dependents.
Definition dict_util.c:3937
fr_dict_attr_by_oid_substr
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:2594
fr_dict_attr_verify
void fr_dict_attr_verify(char const *file, int line, fr_dict_attr_t const *da)
Definition dict_util.c:5104
FNV_MAGIC_PRIME
#define FNV_MAGIC_PRIME
Definition dict_util.c:115
fr_dict_attr_can_contain
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:5194
dict_attr_location_init
void dict_attr_location_init(fr_dict_attr_t *da, char const *filename, int line)
Set where the dictionary attribute was defined.
Definition dict_util.c:749
dict_by_da
fr_dict_t * dict_by_da(fr_dict_attr_t const *da)
Internal version of fr_dict_by_da.
Definition dict_util.c:2806
fr_dict_attr_nested_allowed_chars
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_dict_global_ctx_iter_init
fr_dict_t * fr_dict_global_ctx_iter_init(fr_dict_global_ctx_iter_t *iter)
Iterate protocols by name.
Definition dict_util.c:4890
dict_vendor_name_cmp
static int8_t dict_vendor_name_cmp(void const *one, void const *two)
Compare two attribute names.
Definition dict_util.c:299
fr_dict_attr_search_by_qualified_name_substr
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:3245
fr_dict_root
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2670
fr_dict_vendor_da_by_num
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:2965
dict_attr_add_to_namespace
int dict_attr_add_to_namespace(fr_dict_attr_t const *parent, fr_dict_attr_t *da)
Add an attribute to the name table for an attribute.
Definition dict_util.c:1784
dict_attr_child_by_num
fr_dict_attr_t * dict_attr_child_by_num(fr_dict_attr_t const *parent, unsigned int attr)
Internal version of fr_dict_attr_child_by_num.
Definition dict_util.c:3551
fr_dict_global_ctx_set
void fr_dict_global_ctx_set(fr_dict_gctx_t const *gctx)
Set a new, active, global dictionary context.
Definition dict_util.c:4774
fr_dl_dict_autoload
int fr_dl_dict_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
Callback to automatically load dictionaries required by modules.
Definition dict_util.c:4619
dict_attr_name_cmp
static int8_t dict_attr_name_cmp(void const *one, void const *two)
Compare two attribute names.
Definition dict_util.c:211
dict_vendor_pen_cmp
static int8_t dict_vendor_pen_cmp(void const *one, void const *two)
Compare two vendor numbers.
Definition dict_util.c:321
dict_enum_value_cmp
static int8_t dict_enum_value_cmp(void const *one, void const *two)
Compare two dictionary enum values.
Definition dict_util.c:372
dict_attr_by_name
fr_dict_attr_t * dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
Definition dict_util.c:3487
hash_pool_free
static void hash_pool_free(void *to_free)
Definition dict_util.c:117
dict_attr_name_hash
static uint32_t dict_attr_name_hash(void const *data)
Wrap name hash function for fr_dict_attr_t.
Definition dict_util.c:199
fr_dict_enum_allowed_chars
bool const fr_dict_enum_allowed_chars[UINT8_MAX+1]
Characters allowed in enumeration value names.
Definition dict_util.c:79
_fr_dict_autoload_talloc_free
static int _fr_dict_autoload_talloc_free(fr_dict_autoload_talloc_t const *to_free)
Talloc destructor to automatically free dictionaries.
Definition dict_util.c:4531
dict_by_protocol_num
fr_dict_t * dict_by_protocol_num(unsigned int num)
Internal version of fr_dict_by_protocol_num.
Definition dict_util.c:2792
dict_attr_acopy_child
static int dict_attr_acopy_child(fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src, fr_dict_attr_t const *child)
Definition dict_util.c:1158
fr_dict_attr_search_by_qualified_oid_substr
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:3303
fr_dict_dl
dl_t * fr_dict_dl(fr_dict_t const *dict)
Definition dict_util.c:2680
dict_attr_search
static fr_slen_t dict_attr_search(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, dict_attr_resolve_func_t func)
Internal function for searching for attributes in multiple dictionaries.
Definition dict_util.c:3030
fr_dict_enum_name_by_value
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:3693
fr_dict_enum_iter_next
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:3640
fr_dict_enum_add_name_next
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:2234
dict_attr_child_add
int dict_attr_child_add(fr_dict_attr_t *parent, fr_dict_attr_t *child)
Add a child to a parent.
Definition dict_util.c:1685
dict_attr_children_init
static int dict_attr_children_init(fr_dict_attr_t **da_p)
Add a child/nesting extension to an attribute.
Definition dict_util.c:468
fr_dict_autoload_talloc_s::load
fr_dict_autoload_t load[2]
Autoloader def.
Definition dict_util.c:4523
fr_dict_free
int fr_dict_free(fr_dict_t **dict, char const *dependent)
Decrement the reference count on a previously loaded dictionary.
Definition dict_util.c:4334
fr_dict_enum_by_value
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:3660
dict_dependent_remove
int dict_dependent_remove(fr_dict_t *dict, char const *dependent)
Decrement ref count for a dependent in a dictionary.
Definition dict_util.c:4016
fr_dict_oid_component_legacy
int fr_dict_oid_component_legacy(unsigned int *out, char const **oid)
Process a single OID component.
Definition dict_util.c:2361
fr_dict_enum_by_name_substr
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:3732
dict_enum_name_cmp
static int8_t dict_enum_name_cmp(void const *one, void const *two)
Compare two dictionary attribute enum values.
Definition dict_util.c:342
fr_dict_global_ctx_perm_check
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:4765
fr_dict_global_ctx_read_only
void fr_dict_global_ctx_read_only(void)
Mark all dictionaries and the global dictionary ctx as read only.
Definition dict_util.c:4824
_dict_attr_init_name_only
int _dict_attr_init_name_only(char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, char const *name, fr_type_t type, dict_attr_args_t const *args)
Initialise fields in a dictionary attribute structure.
Definition dict_util.c:942
fr_dict_attr_by_oid
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:2643
dict_vendor_add
int dict_vendor_add(fr_dict_t *dict, char const *name, unsigned int num)
Add a vendor to the dictionary.
Definition dict_util.c:1590
_dict_global_free
static int _dict_global_free(fr_dict_gctx_t *gctx)
Definition dict_util.c:4642
dict_protocol_name_cmp
static int8_t dict_protocol_name_cmp(void const *one, void const *two)
Compare two protocol names.
Definition dict_util.c:165
dict_attr_enumv_init
static int dict_attr_enumv_init(fr_dict_attr_t **da_p)
Initialise a per-attribute enumeration table.
Definition dict_util.c:503
fr_dict_const_free
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:4318
fr_dl_dict_enum_autoload
int fr_dl_dict_enum_autoload(UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
Callback to automatically resolve enum values.
Definition dict_util.c:4587
fr_dict_attr_autoload
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:4400
fr_dict_internal
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4933
fr_dict_by_protocol_substr
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:2767
fr_dict_dependent_add
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:4001
dict_protocol_num_cmp
static int8_t dict_protocol_num_cmp(void const *one, void const *two)
Compare two protocol numbers.
Definition dict_util.c:186
fr_dict_by_protocol_name
fr_dict_t const * fr_dict_by_protocol_name(char const *name)
Lookup a protocol by its name.
Definition dict_util.c:2847
dict_protocol_name_hash
static uint32_t dict_protocol_name_hash(void const *data)
Wrap name hash function for fr_dict_protocol_t.
Definition dict_util.c:153
dict_attr_finalise
int dict_attr_finalise(fr_dict_attr_t **da_p, char const *name)
Set remaining fields in a dictionary attribute before insertion.
Definition dict_util.c:763
fr_dict_is_read_only
bool fr_dict_is_read_only(fr_dict_t const *dict)
Definition dict_util.c:2675
dict_hash_name
static uint32_t dict_hash_name(char const *name, size_t len)
Apply a simple (case insensitive) hashing function to the name of an attribute, vendor or protocol.
Definition dict_util.c:129
fr_dict_attr_add_name_only
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:2011
FNV_MAGIC_INIT
#define FNV_MAGIC_INIT
Definition dict_util.c:114
dict_attr_num_init
int dict_attr_num_init(fr_dict_attr_t *da, unsigned int num)
Set the attribute number (if any)
Definition dict_util.c:719
dict_attr_namespace_init
static int dict_attr_namespace_init(fr_dict_attr_t **da_p)
Initialise a per-attribute namespace.
Definition dict_util.c:519
fr_dict_global_ctx_dir
char const * fr_dict_global_ctx_dir(void)
Definition dict_util.c:4815
dict_attr_num_init_name_only
int dict_attr_num_init_name_only(fr_dict_attr_t *da)
Set the attribute number (if any)
Definition dict_util.c:737
_dict_attr_free
static int _dict_attr_free(fr_dict_attr_t *da)
Definition dict_util.c:960
fr_dict_global_ctx_free
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:4790
dict_dlopen
int dict_dlopen(fr_dict_t *dict, char const *name)
Definition dict_util.c:3866
dict_by_protocol_name
fr_dict_t * dict_by_protocol_name(char const *name)
Internal version of fr_dict_by_protocol_name.
Definition dict_util.c:2778
dict_attr_acopy_children
int dict_attr_acopy_children(fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src)
Copy the children of an existing attribute.
Definition dict_util.c:1196
fr_dict_vendor_by_name
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:2927
dict_attr_acopy_aliases
int dict_attr_acopy_aliases(UNUSED fr_dict_attr_t *dst, fr_dict_attr_t const *src)
Copy aliases of an existing attribute to a new one.
Definition dict_util.c:1328
dict_attr_resolve_func_t
fr_slen_t(* dict_attr_resolve_func_t)(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)
Callback function for resolving dictionary attributes.
Definition dict_util.c:3010
fr_dict_gctx_debug
void fr_dict_gctx_debug(FILE *fp, fr_dict_gctx_t const *gctx)
Dump information about currently loaded dictionaries.
Definition dict_util.c:4851
fr_dict_attr_iterate_children
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:5019
dict_attr_enum_add_name
int dict_attr_enum_add_name(fr_dict_attr_t *da, char const *name, fr_value_box_t const *value, bool coerce, bool takes_precedence, fr_dict_attr_t const *key_child_ref)
Definition dict_util.c:2025
_fr_dict_autoload
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:4465
fr_dict_vendor_by_num
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:2950
dict_attr_alias_add
int dict_attr_alias_add(fr_dict_attr_t const *parent, char const *alias, fr_dict_attr_t const *ref, bool from_public)
Add an alias to an existing attribute.
Definition dict_util.c:1409
fr_dict_attr_search_by_oid_substr
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:3332
fr_dict_valid_name
ssize_t fr_dict_valid_name(char const *name, ssize_t len)
Definition dict_util.c:4943
DICT_ATTR_ALLOWED_CHARS
#define DICT_ATTR_ALLOWED_CHARS
Definition dict_util.c:44
fr_dict_protocol_alloc
fr_dict_t * fr_dict_protocol_alloc(fr_dict_t const *parent)
Allocate a new local dictionary.
Definition dict_util.c:4271
fr_dict_attr_by_oid_legacy
ssize_t fr_dict_attr_by_oid_legacy(fr_dict_attr_t const **parent, unsigned int *attr, char const *oid)
Get the leaf attribute of an OID string.
Definition dict_util.c:2404
fr_dict_attr_by_name
fr_dict_attr_t const * fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
Locate a fr_dict_attr_t by its name.
Definition dict_util.c:3533
fr_dict_attr_by_name_substr
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, UNUSED fr_sbuff_term_t const *tt)
Look up a dictionary attribute by a name embedded in another string.
Definition dict_util.c:3402
fr_dict_attr_child_by_num
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:3598
dict_dependent_add
int dict_dependent_add(fr_dict_t *dict, char const *dependent)
Record a new dependency on a dictionary.
Definition dict_util.c:3957
fr_dict_enum_by_name
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:3706
dict_attr_name_set
static int dict_attr_name_set(fr_dict_attr_t **da_p, char const *name)
Set a dictionary attribute's name.
Definition dict_util.c:415
fr_dict_oid_component
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:2495
dict_attr_vendor_set
static int dict_attr_vendor_set(fr_dict_attr_t **da_p, fr_dict_attr_t const *vendor)
Cache the vendor pointer for an attribute.
Definition dict_util.c:485
dict_enum_name_hash
static uint32_t dict_enum_name_hash(void const *data)
Hash a enumeration name.
Definition dict_util.c:332
dict_protocol_add
int dict_protocol_add(fr_dict_t *dict)
Add a protocol to the global protocol table.
Definition dict_util.c:1517
dict_enum_value_hash
static uint32_t dict_enum_value_hash(void const *data)
Hash a dictionary enum value.
Definition dict_util.c:362
fr_dict_attr_search_by_qualified_oid
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 *name, bool internal, bool foreign)
Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
Definition dict_util.c:3351
dict_has_dependents
bool dict_has_dependents(fr_dict_t *dict)
Check if a dictionary still has dependents.
Definition dict_util.c:4048
dict_gctx
fr_dict_gctx_t * dict_gctx
Top level structure containing global dictionary state.
Definition dict_util.c:42
fr_dict_by_protocol_num
fr_dict_t const * fr_dict_by_protocol_num(unsigned int num)
Lookup a protocol by its number.
Definition dict_util.c:2860
dict_attr_acopy_enumv
int dict_attr_acopy_enumv(fr_dict_attr_t *dst, fr_dict_attr_t const *src)
Copy the VALUEs of an existing attribute, by casting them.
Definition dict_util.c:1293
fr_dict_attr_add
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:1972
fr_dict_autoload_talloc_s::dependent
char const * dependent
Dependent that loaded the dictionary.
Definition dict_util.c:4524
dict_attr_alias
static fr_dict_attr_t const * dict_attr_alias(fr_dict_attr_err_t *err, fr_dict_attr_t const *da)
Resolve an alias attribute to the concrete attribute it points to.
Definition dict_util.c:390
fr_dict_vendor_by_da
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:2905
dict_attr_acopy
fr_dict_attr_t * dict_attr_acopy(TALLOC_CTX *ctx, fr_dict_attr_t const *parent, fr_dict_attr_t const *in, char const *name)
Copy a an existing attribute, possibly to a new location.
Definition dict_util.c:1098
_dict_attr_init
int _dict_attr_init(char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, char const *name, unsigned int attr, fr_type_t type, dict_attr_args_t const *args)
Initialise fields in a dictionary attribute structure.
Definition dict_util.c:895
fr_dict_autoload_talloc_s
Structure used to managed the lifetime of a dictionary.
Definition dict_util.c:4522
dl_loader_init
dl_loader_t * dl_loader_init(TALLOC_CTX *ctx, void *uctx, bool uctx_free, bool defer_symbol_init)
Initialise structures needed by the dynamic linker.
Definition dl.c:900
dl_free
int dl_free(dl_t const *dl)
"free" a dl handle, possibly actually freeing it, and unloading the library
Definition dl.c:693
dl_by_name
dl_t * dl_by_name(dl_loader_t *dl_loader, char const *name, void *uctx, bool uctx_free)
Search for a dl's shared object in various locations.
Definition dl.c:470
dl_s
Module handle.
Definition dl.h:58
fr_dlist_talloc_init
#define fr_dlist_talloc_init(_head, _type, _field)
Initialise the head structure of a doubly linked list.
Definition dlist.h:257
fr_hash_table_iter_next
void * fr_hash_table_iter_next(fr_hash_table_t *ht, fr_hash_iter_t *iter)
Iterate over entries in a hash table.
Definition hash.c:627
fr_hash_table_find
void * fr_hash_table_find(fr_hash_table_t *ht, void const *data)
Find data in a hash table.
Definition hash.c:430
fr_hash_table_iter_init
void * fr_hash_table_iter_init(fr_hash_table_t *ht, fr_hash_iter_t *iter)
Initialise an iterator.
Definition hash.c:682
fr_hash
uint32_t fr_hash(void const *data, size_t size)
Definition hash.c:816
fr_hash_table_insert
bool fr_hash_table_insert(fr_hash_table_t *ht, void const *data)
Insert data into a hash table.
Definition hash.c:469
fr_hash_table_flatten
int fr_hash_table_flatten(TALLOC_CTX *ctx, void **out[], fr_hash_table_t *ht)
Copy all entries out of a hash table into an array.
Definition hash.c:699
fr_hash_string
uint32_t fr_hash_string(char const *p)
Definition hash.c:869
fr_hash_table_delete
bool fr_hash_table_delete(fr_hash_table_t *ht, void const *data)
Remove and free data (if a free function was specified)
Definition hash.c:595
fr_hash_table_verify
void fr_hash_table_verify(fr_hash_table_t *ht)
Check hash table is sane.
Definition hash.c:956
fr_hash_table_replace
int fr_hash_table_replace(void **old, fr_hash_table_t *ht, void const *data)
Replace old data with new data, OR insert if there is no old.
Definition hash.c:529
fr_hash_table_num_elements
uint32_t fr_hash_table_num_elements(fr_hash_table_t *ht)
Definition hash.c:611
fr_hash_table_s
Definition hash.c:50
fr_hash_table_alloc
#define fr_hash_table_alloc(_ctx, _hash_node, _cmp_node, _free_node)
Definition hash.h:61
fr_hash_table_talloc_alloc
#define fr_hash_table_talloc_alloc(_ctx, _type, _hash_node, _cmp_node, _free_node)
Definition hash.h:64
fr_hash_iter_s
Stores the state of the current iteration operation.
Definition hash.h:41
talloc_free
talloc_free(hp)
fr_type_t
fr_type_t
Definition merged_model.c:80
FR_TYPE_TIME_DELTA
@ FR_TYPE_TIME_DELTA
A period of time measured in nanoseconds.
Definition merged_model.c:113
FR_TYPE_INT8
@ FR_TYPE_INT8
8 Bit signed integer.
Definition merged_model.c:103
FR_TYPE_TLV
@ FR_TYPE_TLV
Contains nested attributes.
Definition merged_model.c:118
FR_TYPE_STRING
@ FR_TYPE_STRING
String of printable characters.
Definition merged_model.c:83
FR_TYPE_NULL
@ FR_TYPE_NULL
Invalid (uninitialised) attribute type.
Definition merged_model.c:81
FR_TYPE_UINT16
@ FR_TYPE_UINT16
16 Bit unsigned integer.
Definition merged_model.c:98
FR_TYPE_INT64
@ FR_TYPE_INT64
64 Bit signed integer.
Definition merged_model.c:106
FR_TYPE_INT16
@ FR_TYPE_INT16
16 Bit signed integer.
Definition merged_model.c:104
FR_TYPE_DATE
@ FR_TYPE_DATE
Unix time stamp, always has value >2^31.
Definition merged_model.c:111
FR_TYPE_UINT8
@ FR_TYPE_UINT8
8 Bit unsigned integer.
Definition merged_model.c:97
FR_TYPE_UINT32
@ FR_TYPE_UINT32
32 Bit unsigned integer.
Definition merged_model.c:99
FR_TYPE_STRUCT
@ FR_TYPE_STRUCT
like TLV, but without T or L, and fixed-width children
Definition merged_model.c:119
FR_TYPE_INT32
@ FR_TYPE_INT32
32 Bit signed integer.
Definition merged_model.c:105
FR_TYPE_VENDOR
@ FR_TYPE_VENDOR
Attribute that represents a vendor in the attribute tree.
Definition merged_model.c:122
FR_TYPE_UINT64
@ FR_TYPE_UINT64
64 Bit unsigned integer.
Definition merged_model.c:100
FR_TYPE_VOID
@ FR_TYPE_VOID
User data.
Definition merged_model.c:127
FR_TYPE_VSA
@ FR_TYPE_VSA
Vendor-Specific, for RADIUS attribute 26.
Definition merged_model.c:121
FR_TYPE_OCTETS
@ FR_TYPE_OCTETS
Raw octets.
Definition merged_model.c:84
FR_TYPE_GROUP
@ FR_TYPE_GROUP
A grouping of other attributes.
Definition merged_model.c:124
uint32_t
unsigned int uint32_t
Definition merged_model.c:33
ssize_t
long int ssize_t
Definition merged_model.c:24
fr_sbuff_out_bstrncpy_exact
ssize_t fr_sbuff_out_bstrncpy_exact(fr_sbuff_t *out, fr_sbuff_t *in, size_t len)
Definition merged_model.c:142
fr_sbuff_t::p
char * p
Definition merged_model.c:38
fr_sbuff_out_bstrncpy_allowed
size_t fr_sbuff_out_bstrncpy_allowed(fr_sbuff_t *out, fr_sbuff_t *in, size_t len, bool const allowed[static SBUFF_CHAR_CLASS])
Definition merged_model.c:151
uint8_t
unsigned char uint8_t
Definition merged_model.c:30
fr_slen_t
ssize_t fr_slen_t
Definition merged_model.c:35
size_t
unsigned long int size_t
Definition merged_model.c:25
UINT8_MAX
#define UINT8_MAX
Definition merged_model.c:32
fr_sbuff_parse_error_t
fr_sbuff_parse_error_t
Definition merged_model.c:45
FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW
@ FR_SBUFF_PARSE_ERROR_NUM_OVERFLOW
Integer type would overflow.
Definition merged_model.c:52
FR_SBUFF_PARSE_ERROR_NOT_FOUND
@ FR_SBUFF_PARSE_ERROR_NOT_FOUND
String does not contain a token matching the output type.
Definition merged_model.c:47
FR_SBUFF_PARSE_ERROR_FORMAT
@ FR_SBUFF_PARSE_ERROR_FORMAT
Format of data was invalid.
Definition merged_model.c:50
FR_SBUFF_PARSE_OK
@ FR_SBUFF_PARSE_OK
No error.
Definition merged_model.c:46
FR_SBUFF_PARSE_ERROR_TRAILING
@ FR_SBUFF_PARSE_ERROR_TRAILING
Trailing characters found.
Definition merged_model.c:49
fr_dict_attr_t
Definition merged_model.c:133
fr_dict_t
Definition merged_model.c:198
fr_sbuff_t
Definition merged_model.c:37
fr_value_box_t
Definition merged_model.c:136
strncasecmp
int strncasecmp(char *s1, char *s2, int n)
Definition missing.c:36
strcasecmp
int strcasecmp(char *s1, char *s2)
Definition missing.c:66
fr_assert
#define fr_assert(_expr)
Definition rad_assert.h:38
done
static bool done
Definition radclient.c:83
fr_rb_num_elements
uint32_t fr_rb_num_elements(fr_rb_tree_t *tree)
Return how many nodes there are in a tree.
Definition rb.c:781
fr_rb_iter_init_inorder
void * fr_rb_iter_init_inorder(fr_rb_tree_t *tree, fr_rb_iter_inorder_t *iter)
Initialise an in-order iterator.
Definition rb.c:824
fr_rb_find
void * fr_rb_find(fr_rb_tree_t const *tree, void const *data)
Find an element in the tree, returning the data, not the node.
Definition rb.c:577
fr_rb_insert
bool fr_rb_insert(fr_rb_tree_t *tree, void const *data)
Insert data into a tree.
Definition rb.c:626
fr_rb_delete
bool fr_rb_delete(fr_rb_tree_t *tree, void const *data)
Remove node and free data (if a free function was specified)
Definition rb.c:741
fr_rb_iter_next_inorder
void * fr_rb_iter_next_inorder(UNUSED fr_rb_tree_t *tree, fr_rb_iter_inorder_t *iter)
Return the next node.
Definition rb.c:850
fr_rb_inline_alloc
#define fr_rb_inline_alloc(_ctx, _type, _field, _data_cmp, _data_free)
Allocs a red black tree.
Definition rb.h:271
fr_rb_iter_inorder_t
Iterator structure for in-order traversal of an rbtree.
Definition rb.h:321
hash
static unsigned int hash(char const *username, unsigned int tablesize)
Definition rlm_passwd.c:132
name
static char const * name
Definition rlm_redis_ippool_tool.c:156
fr_sbuff_adv_past_allowed
size_t fr_sbuff_adv_past_allowed(fr_sbuff_t *sbuff, size_t len, bool const allowed[static SBUFF_CHAR_CLASS], fr_sbuff_term_t const *tt)
Wind position past characters in the allowed set.
Definition sbuff.c:1810
fr_sbuff_is_terminal
bool fr_sbuff_is_terminal(fr_sbuff_t *in, fr_sbuff_term_t const *tt)
Efficient terminal string search.
Definition sbuff.c:2185
sbuff_char_alpha_num
bool const sbuff_char_alpha_num[SBUFF_CHAR_CLASS]
Definition sbuff.c:98
fr_sbuff_adv_until
size_t fr_sbuff_adv_until(fr_sbuff_t *sbuff, size_t len, fr_sbuff_term_t const *tt, char escape_chr)
Wind position until we hit a character in the terminal set.
Definition sbuff.c:1885
sbuff_parse_error_table
fr_table_num_ordered_t const sbuff_parse_error_table[]
Definition sbuff.c:43
fr_sbuff_in_sprintf
ssize_t fr_sbuff_in_sprintf(fr_sbuff_t *sbuff, char const *fmt,...)
Print using a fmt string to an sbuff.
Definition sbuff.c:1597
fr_sbuff_next_if_char
bool fr_sbuff_next_if_char(fr_sbuff_t *sbuff, char c)
Return true if the current char matches, and if it does, advance.
Definition sbuff.c:2121
fr_sbuff_set
#define fr_sbuff_set(_dst, _src)
FR_SBUFF_IN
#define FR_SBUFF_IN(_start, _len_or_end)
fr_sbuff_current
#define fr_sbuff_current(_sbuff_or_marker)
fr_sbuff_char
#define fr_sbuff_char(_sbuff_or_marker, _eob)
fr_sbuff_is_alpha
#define fr_sbuff_is_alpha(_sbuff_or_marker)
fr_sbuff_buff
#define fr_sbuff_buff(_sbuff_or_marker)
fr_sbuff_is_char
#define fr_sbuff_is_char(_sbuff_or_marker, _c)
FR_SBUFF_ERROR_RETURN
#define FR_SBUFF_ERROR_RETURN(_sbuff_or_marker)
FR_SBUFF_SET_RETURN
#define FR_SBUFF_SET_RETURN(_dst, _src)
FR_SBUFF
#define FR_SBUFF(_sbuff_or_marker)
fr_sbuff_out
#define fr_sbuff_out(_err, _out, _in)
fr_sbuff_init_in
#define fr_sbuff_init_in(_out, _start, _len_or_end)
fr_sbuff_remaining
#define fr_sbuff_remaining(_sbuff_or_marker)
fr_sbuff_len
#define fr_sbuff_len(_sbuff_or_marker)
FR_SBUFF_OUT
#define FR_SBUFF_OUT(_start, _len_or_end)
fr_sbuff_used
#define fr_sbuff_used(_sbuff_or_marker)
fr_sbuff_behind
#define fr_sbuff_behind(_sbuff_or_marker)
fr_sbuff_ptr_s
Definition sbuff.h:85
fr_sbuff_term_t
Set of terminal elements.
Definition merged_model.c:161
type
fr_aka_sim_id_type_t type
Definition state_machine.c:3656
fr_table_str_by_value
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
talloc_typed_asprintf
char * talloc_typed_asprintf(TALLOC_CTX *ctx, char const *fmt,...)
Call talloc vasprintf, setting the type on the new chunk correctly.
Definition talloc.c:517
talloc_typed_strdup
char * talloc_typed_strdup(TALLOC_CTX *ctx, char const *p)
Call talloc_strdup, setting the type on the new chunk correctly.
Definition talloc.c:470
talloc_get_type_abort_const
#define talloc_get_type_abort_const
Definition talloc.h:245
talloc_const_free
static int talloc_const_free(void const *ptr)
Free const'd memory.
Definition talloc.h:230
talloc_bstr_tolower
static void talloc_bstr_tolower(char *str)
Convert a talloced string to lowercase.
Definition talloc.h:128
FR_TIME_RES_SEC
@ FR_TIME_RES_SEC
Definition time.h:50
T_OP_CMP_EQ
@ T_OP_CMP_EQ
Definition token.h:106
parent
static fr_slen_t parent
Definition pair.h:858
add
#define add(_type, _out, _in)
Definition stats.c:187
fr_strerror
char const * fr_strerror(void)
Get the last library error.
Definition strerror.c:553
fr_strerror_printf
#define fr_strerror_printf(_fmt,...)
Log to thread local error buffer.
Definition strerror.h:64
fr_strerror_printf_push
#define fr_strerror_printf_push(_fmt,...)
Add a message to an existing stack of messages at the tail.
Definition strerror.h:84
fr_strerror_const
#define fr_strerror_const(_msg)
Definition strerror.h:223
fr_type_fixed_size
bool const fr_type_fixed_size[FR_TYPE_MAX+1]
Definition types.c:189
fr_type_structural
bool const fr_type_structural[FR_TYPE_MAX+1]
Definition types.c:194
fr_type_is_non_leaf
#define fr_type_is_non_leaf(_x)
Definition types.h:395
fr_type_is_variable_size
#define fr_type_is_variable_size(_x)
Definition types.h:389
fr_type_is_structural
#define fr_type_is_structural(_x)
Definition types.h:393
FR_TYPE_UNION
@ FR_TYPE_UNION
A union of limited children.
Definition types.h:82
FR_TYPE_STRUCTURAL
#define FR_TYPE_STRUCTURAL
Definition types.h:317
fr_type_is_leaf
#define fr_type_is_leaf(_x)
Definition types.h:394
fr_type_to_str
static char const * fr_type_to_str(fr_type_t type)
Return a static string containing the type name.
Definition types.h:455
fr_value_box_network_length
size_t fr_value_box_network_length(fr_value_box_t const *value)
Get the size of the value held by the fr_value_box_t.
Definition value.c:1439
fr_value_box_hash
uint32_t fr_value_box_hash(fr_value_box_t const *vb)
Hash the contents of a value box.
Definition value.c:6982
fr_value_box_cast
int fr_value_box_cast(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, fr_value_box_t const *src)
Convert one type of fr_value_box_t to another.
Definition value.c:3961
fr_value_box_cmp
int8_t fr_value_box_cmp(fr_value_box_t const *a, fr_value_box_t const *b)
Compare two values.
Definition value.c:749
fr_value_box_copy
int fr_value_box_copy(TALLOC_CTX *ctx, fr_value_box_t *dst, const fr_value_box_t *src)
Copy value data verbatim duplicating any buffers.
Definition value.c:4409
fr_value_box_cmp_op
int fr_value_box_cmp_op(fr_token_t op, fr_value_box_t const *a, fr_value_box_t const *b)
Compare two attributes using an operator.
Definition value.c:1023
fr_value_box_increment
void fr_value_box_increment(fr_value_box_t *vb)
Increment a boxed value.
Definition value.c:5270
fr_value_box_alloc
#define fr_value_box_alloc(_ctx, _type, _enumv)
Allocate a value box of a specific type.
Definition value.h:644
data
static fr_slen_t data
Definition value.h:1334
fr_box_strvalue_len
#define fr_box_strvalue_len(_val, _len)
Definition value.h:309
fr_value_box_init
#define fr_value_box_init(_vb, _type, _enumv, _tainted)
Initialise a fr_value_box_t.
Definition value.h:610
out
static size_t char ** out
Definition value.h:1024
Generated by   doxygen 1.9.8