The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
dict_tokenize.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/** Parse dictionary files
18 *
19 * @file src/lib/util/dict_tokenize.c
20 *
21 * @copyright 2019 The FreeRADIUS server project
22 * @copyright 2024 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
23 */
24RCSID("$Id: d2bc4b0cab786bf2d5cd20509373dd3978910ea6 $")
25
26#include <freeradius-devel/radius/defs.h>
27#include <freeradius-devel/util/conf.h>
28#include <freeradius-devel/util/dict_fixup_priv.h>
29#include <freeradius-devel/util/file.h>
30#include <freeradius-devel/util/rand.h>
31#include <freeradius-devel/util/syserror.h>
32
33#include <sys/stat.h>
34
35/** Maximum number of arguments
36 *
37 * For any one keyword, this is the maxiumum number of arguments that can be passed.
38 */
39#define DICT_MAX_ARGV (8)
40
41/** Maximum stack size
42 *
43 * This is the maximum number of nested BEGIN and $INCLUDE statements.
44 */
45#define DICT_MAX_STACK (32)
46
47/** This represents explicit BEGIN/END frames pushed onto the stack
48 *
49 * These are flags to allow multiple nesting types to be passed to the search function.
50 */
51DIAG_OFF(attributes)
52typedef enum CC_HINT(flag_enum) {
53 NEST_NONE = 0x00,
54 NEST_TOP = 0x01, //!< top of the stack
55 NEST_PROTOCOL = 0x02, //!< BEGIN-PROTOCOL
56 NEST_VENDOR = 0x04, //!< BEGIN-VENDOR
57 NEST_ATTRIBUTE = 0x08 //!< BEGIN foo
58} dict_nest_t;
59DIAG_ON(attributes)
60
61#define NEST_ANY (NEST_TOP | NEST_PROTOCOL | NEST_VENDOR | NEST_ATTRIBUTE)
62
63static fr_table_num_sorted_t const dict_nest_table[] = {
64 { L("ATTRIBUTE"), NEST_ATTRIBUTE },
65 { L("NONE"), NEST_NONE },
66 { L("PROTOCOL"), NEST_PROTOCOL },
67 { L("TOP"), NEST_TOP },
68 { L("VENDOR"), NEST_VENDOR }
69};
70static size_t const dict_nest_table_len = NUM_ELEMENTS(dict_nest_table);
71
72typedef int (*fr_dict_keyword_finalise_t)(dict_tokenize_ctx_t *dctx);
73
74/** Parser context for dict_from_file
75 *
76 * Allows vendor and TLV context to persist across $INCLUDEs
77 */
78typedef struct {
79 char *filename; //!< name of the file where we read this entry
80 int line; //!< line number where we read this entry
81 fr_dict_attr_t const *da; //!< the da we care about
82 dict_nest_t nest; //!< for manual vs automatic begin / end things
83
84 fr_dict_keyword_finalise_t finalise; //!< function to call when popping
85 int member_num; //!< structure member numbers
86 fr_dict_attr_t const *struct_is_closed; //!< no more members are allowed
87 ssize_t struct_size; //!< size of the struct.
88} dict_tokenize_frame_t;
89
90struct dict_tokenize_ctx_s {
91 fr_dict_t *dict; //!< Protocol dictionary we're inserting attributes into.
92
93 dict_tokenize_frame_t stack[DICT_MAX_STACK]; //!< stack of attributes to track
94 int stack_depth; //!< points to the last used stack frame
95
96 fr_dict_attr_t *value_attr; //!< Cache of last attribute to speed up value processing.
97 fr_dict_attr_t const *relative_attr; //!< for ".82" instead of "1.2.3.82". only for parents of type "tlv"
98 dict_fixup_ctx_t fixup;
99
100 char *filename; //!< current filename
101 int line; //!< current line
102};
103
104static int _dict_from_file(dict_tokenize_ctx_t *dctx,
105 char const *dir_name, char const *filename,
106 char const *src_file, int src_line);
107
108#define CURRENT_FRAME(_dctx) (&(_dctx)->stack[(_dctx)->stack_depth])
109#define CURRENT_DA(_dctx) (CURRENT_FRAME(_dctx)->da)
110#define CURRENT_FILENAME(_dctx) (CURRENT_FRAME(_dctx)->filename)
111#define CURRENT_LINE(_dctx) (CURRENT_FRAME(_dctx)->line)
112
113#define ASSERT_CURRENT_NEST(_dctx, _nest) fr_assert_msg(CURRENT_FRAME(_dctx)->nest == (_nest), "Expected frame type %s, got %s", \
114 fr_table_str_by_value(dict_nest_table, (_nest), "<INVALID>"), fr_table_str_by_value(dict_nest_table, CURRENT_FRAME(_dctx)->nest, "<INVALID>"))
115
116void dict_dctx_debug(dict_tokenize_ctx_t *dctx)
117{
118 int i;
119
120 for (i = 0; i <= dctx->stack_depth; i++) {
121 dict_tokenize_frame_t const *frame = &dctx->stack[i];
122
123 FR_FAULT_LOG("[%d]: %s %s (%s): %s[%d]",
124 i,
125 fr_table_str_by_value(dict_nest_table, frame->nest, "<INVALID>"),
126 frame->da->name,
127 fr_type_to_str(frame->da->type),
128 frame->filename, frame->line);
129 }
130}
131
132static dict_tokenize_frame_t const *dict_dctx_find_frame(dict_tokenize_ctx_t *dctx, dict_nest_t nest)
133{
134 int i;
135
136 for (i = dctx->stack_depth; i >= 0; i--) {
137 if (dctx->stack[i].nest & nest) return &dctx->stack[i];
138 }
139
140 return NULL;
141}
142
143static int CC_HINT(nonnull) dict_dctx_push(dict_tokenize_ctx_t *dctx, fr_dict_attr_t const *da, dict_nest_t nest)
144{
145 if ((dctx->stack_depth + 1) >= DICT_MAX_STACK) {
146 fr_strerror_const("Attribute definitions are nested too deep.");
147 return -1;
148 }
149
150 dctx->stack[++dctx->stack_depth] = (dict_tokenize_frame_t) {
151 .da = da,
152 .filename = dctx->filename,
153 .line = dctx->line,
154 .nest = nest,
155 };
156
157 return 0;
158}
159
160
161/** Pop the current stack frame
162 *
163 * @param[in] dctx Stack to pop from.
164 * @return
165 * - Pointer to the current stack frame.
166 * - NULL, if we're already at the root.
167 */
168static dict_tokenize_frame_t const *dict_dctx_pop(dict_tokenize_ctx_t *dctx)
169{
170 if (dctx->stack_depth == 0) return NULL;
171
172 fr_assert(!dctx->stack[dctx->stack_depth].finalise);
173
174 return &dctx->stack[dctx->stack_depth--];
175}
176
177/** Unwind the stack until it points to a particular type of stack frame
178 *
179 * @param[in] dctx Stack to unwind.
180 * @param[in] nest Frame type to unwind to.
181 * @return
182 * - Pointer to the frame matching nest
183 * - NULL, if we unwound the complete stack and didn't find the frame.
184 */
185static dict_tokenize_frame_t const *dict_dctx_unwind_until(dict_tokenize_ctx_t *dctx, dict_nest_t nest)
186{
187 int i;
188
189 for (i = dctx->stack_depth; i >= 0; i--) {
190 dict_tokenize_frame_t *frame;
191
192 /*
193 * We mash the stack depth here, because the finalisation function needs it. Plus, if
194 * there's any error, we don't care about the dctx stack, we just return up the C stack.
195 */
196 dctx->stack_depth = i;
197 frame = CURRENT_FRAME(dctx);
198
199 if (frame->finalise) {
200 if (frame->finalise(dctx) < 0) return NULL;
201 frame->finalise = NULL;
202 }
203
204 /*
205 * END-foo cannot be used without BEGIN-foo.
206 */
207 if (frame->filename && (frame->filename != dctx->filename) &&
208 (nest != NEST_ANY)) {
209 char const *name;
210
211 name = fr_table_str_by_value(dict_nest_table, nest, "<INVALID>");
212 fr_strerror_printf("END-%s in file %s[%d] without matching BEGIN-%s",
213 name, dctx->filename, dctx->line, name);
214 return NULL;
215 }
216
217 if ((frame->nest & nest) != 0) {
218 return frame;
219 }
220 }
221
222 return NULL;
223}
224
225static inline dict_tokenize_frame_t const *dict_dctx_unwind(dict_tokenize_ctx_t *dctx)
226{
227 return dict_dctx_unwind_until(dctx, NEST_ANY);
228}
229
230/*
231 * String split routine. Splits an input string IN PLACE
232 * into pieces, based on spaces.
233 */
234int fr_dict_str_to_argv(char *str, char **argv, int max_argc)
235{
236 int argc = 0;
237
238 while (*str) {
239 if (argc >= max_argc) break;
240
241 /*
242 * Chop out comments early.
243 */
244 if (*str == '#') {
245 *str = '\0';
246 break;
247 }
248
249 while ((*str == ' ') ||
250 (*str == '\t') ||
251 (*str == '\r') ||
252 (*str == '\n'))
253 *(str++) = '\0';
254
255 if (!*str) break;
256
257 argv[argc] = str;
258 argc++;
259
260 while (*str &&
261 (*str != ' ') &&
262 (*str != '\t') &&
263 (*str != '\r') &&
264 (*str != '\n'))
265 str++;
266 }
267
268 return argc;
269}
270
271static int dict_read_sscanf_i(unsigned int *pvalue, char const *str)
272{
273 int unsigned ret = 0;
274 int base = 10;
275 static char const *tab = "0123456789";
276
277 if ((str[0] == '0') &&
278 ((str[1] == 'x') || (str[1] == 'X'))) {
279 tab = "0123456789abcdef";
280 base = 16;
281
282 str += 2;
283 }
284
285 while (*str) {
286 char const *c;
287
288 if (*str == '.') break;
289
290 c = memchr(tab, tolower((uint8_t)*str), base);
291 if (!c) return 0;
292
293 ret *= base;
294 ret += (c - tab);
295 str++;
296 }
297
298 *pvalue = ret;
299 return 1;
300}
301
302/** Set a new root dictionary attribute
303 *
304 * @note Must only be called once per dictionary.
305 *
306 * @param[in] dict to modify.
307 * @param[in] name of dictionary root.
308 * @param[in] proto_number The artificial (or IANA allocated) number for the protocol.
309 * This is only used for
310 * @return
311 * - 0 on success.
312 * - -1 on failure.
313 */
314static int dict_root_set(fr_dict_t *dict, char const *name, unsigned int proto_number)
315{
316 fr_dict_attr_t *da;
317
318 fr_dict_attr_flags_t flags = {
319 .is_root = 1,
320 .type_size = 1,
321 .length = 1
322 };
323
324 if (!fr_cond_assert(!dict->root)) {
325 fr_strerror_const("Dictionary root already set");
326 return -1;
327 }
328
329 da = dict_attr_alloc_root(dict->pool, dict, name, proto_number, &(dict_attr_args_t){ .flags = &flags });
330 if (unlikely(!da)) return -1;
331
332 dict->root = da;
333 dict->root->dict = dict;
334 DA_VERIFY(dict->root);
335
336 return 0;
337}
338
339static int dict_process_type_field(dict_tokenize_ctx_t *dctx, char const *name, fr_dict_attr_t **da_p)
340{
341 char *p;
342 fr_type_t type;
343
344 /*
345 * Some types can have fixed length
346 */
347 p = strchr(name, '[');
348 if (p) {
349 char *q;
350 unsigned int length;
351
352 *p = '\0';
353 q = strchr(p + 1, ']');
354 if (!q) {
355 fr_strerror_printf("Invalid format for '%s[...]'", name);
356 return -1;
357 }
358
359 *q = '\0';
360 if (q[1]) {
361 fr_strerror_const("length, if present, must end type field");
362 return -1;
363 }
364
365 if (!dict_read_sscanf_i(&length, p + 1)) {
366 fr_strerror_printf("Invalid length for '%s[...]'", name);
367 return -1;
368 }
369
370 /*
371 * "length" has to fit into the flags.length field.
372 */
373 if ((length == 0) || (length > UINT16_MAX)) {
374 fr_strerror_printf("Invalid length for '%s[...]'", name);
375 return -1;
376 }
377
378 /*
379 * Now that we have a length, check the data type.
380 */
381 if (strcmp(name, "octets") == 0) {
382 type = FR_TYPE_OCTETS;
383
384 } else if (strcmp(name, "string") == 0) {
385 type = FR_TYPE_STRING;
386
387 } else if (strcmp(name, "struct") == 0) {
388 type = FR_TYPE_STRUCT;
389
390 } else if (strcmp(name, "union") == 0) {
391 type = FR_TYPE_UNION;
392
393 } else if (strcmp(name, "bit") == 0) {
394 if (CURRENT_FRAME(dctx)->da->type != FR_TYPE_STRUCT) {
395 fr_strerror_const("Bit fields can only be defined as a MEMBER of data type 'struct'");
396 return -1;
397 }
398
399 (*da_p)->flags.extra = 1;
400 (*da_p)->flags.subtype = FLAG_BIT_FIELD;
401
402 if (length == 1) {
403 type = FR_TYPE_BOOL;
404 } else if (length <= 8) {
405 type = FR_TYPE_UINT8;
406 } else if (length <= 16) {
407 type = FR_TYPE_UINT16;
408 } else if (length <= 32) {
409 type = FR_TYPE_UINT32;
410 } else if (length <= 56) { /* for laziness in encode / decode */
411 type = FR_TYPE_UINT64;
412 } else {
413 fr_strerror_const("Invalid length for bit field");
414 return -1;
415 }
416
417 /*
418 * Cache where on a byte boundary this
419 * bit field ends. We could have the
420 * validation function loop through all
421 * previous siblings, but that's
422 * annoying.
423 */
424 (*da_p)->flags.flag_byte_offset = length;
425
426 } else {
427 fr_strerror_printf("Attributes of type '%s' cannot use the %s[...] syntax",
428 name, name);
429 return -1;
430 }
431
432 (*da_p)->flags.is_known_width = true;
433 (*da_p)->flags.length = length;
434 return dict_attr_type_init(da_p, type);
435 }
436
437 /*
438 * We default to using the standard FreeRADIUS types.
439 *
440 * However, if there is a protocol-specific type parsing
441 * function, we call that, too. That ordering allows the
442 * protocol-specific names to over-ride the default ones.
443 */
444 type = fr_type_from_str(name);
445
446 if (dctx->dict->proto->attr.type_parse &&
447 !dctx->dict->proto->attr.type_parse(&type, da_p, name)) {
448 return -1;
449 }
450
451 switch (type) {
452 /*
453 * Still not known, or is still a NULL type, that's an error.
454 *
455 * The protocol-specific function can return an error if
456 * it has an error in its parsing. Or, it can return
457 * "true"
458 */
459 case FR_TYPE_NULL:
460 fr_strerror_printf("Unknown data type '%s'", name);
461 return -1;
462
463 case FR_TYPE_LEAF:
464 case FR_TYPE_STRUCTURAL:
465 break;
466
467 case FR_TYPE_VALUE_BOX:
468 case FR_TYPE_VOID:
469 case FR_TYPE_VALUE_BOX_CURSOR:
470 case FR_TYPE_PAIR_CURSOR:
471 case FR_TYPE_MAX:
472 fr_strerror_printf("Invalid data type '%s'", name);
473 return -1;
474 }
475
476 return dict_attr_type_init(da_p, type);
477}
478
479/** Define a flag setting function, which sets one bit in a fr_dict_attr_flags_t
480 *
481 * This is here, because AFAIK there's no completely portable way to get the bit
482 * offset of a bit field in a structure.
483 */
484#define FLAG_FUNC(_name) \
485static int dict_flag_##_name(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)\
486{ \
487 (*da_p)->flags._name = 1; \
488 return 0; \
489}
490
491FLAG_FUNC(array)
492
493static int dict_flag_clone(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)
494{
495 /*
496 * Clone has a limited scope.
497 */
498 switch ((*da_p)->type) {
499 case FR_TYPE_LEAF:
500 case FR_TYPE_STRUCT:
501 case FR_TYPE_TLV:
502 break;
503
504 default:
505 fr_strerror_printf("Attributes of data type '%s' cannot use 'clone=...'", fr_type_to_str((*da_p)->type));
506 return -1;
507 }
508
509 /*
510 * Allow cloning of any types, so long as
511 * the types are the same. We do the checks later.
512 */
513 if (unlikely(dict_attr_ref_aunresolved(da_p, value, FR_DICT_ATTR_REF_CLONE) < 0)) return -1;
514
515 /*
516 * We don't know how big the cloned reference is, so it isn't known width.
517 */
518 (*da_p)->flags.is_known_width = 0;
519
520 return 0;
521}
522
523FLAG_FUNC(counter)
524
525static int dict_flag_enum(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
526{
527 /*
528 * Allow enum=... as an almost synonym for "clone", where we copy only the VALUEs, and not any
529 * children.
530 */
531 if (!fr_type_is_leaf((*da_p)->type)) {
532 fr_strerror_const("'enum=...' references cannot be used for structural types");
533 return -1;
534 }
535
536 /*
537 * Ensure that this attribute has room for enums.
538 */
539 if (!dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_ENUMV)) return -1;
540
541 if (unlikely(dict_attr_ref_aunresolved(da_p, value, FR_DICT_ATTR_REF_ENUM) < 0)) return -1;
542
543 return 0;
544}
545
546FLAG_FUNC(internal)
547
548static int dict_flag_key(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
549{
550 fr_dict_attr_t *da = *da_p;
551 fr_dict_attr_t const *key;
552 fr_dict_attr_ext_ref_t *ext;
553
554 if (fr_type_is_leaf(da->type)) {
555 if (value) {
556 fr_strerror_const("Attributes defining a 'key' field cannot specify a key reference");
557 return -1;
558 }
559
560 if ((da->type != FR_TYPE_UINT8) && (da->type != FR_TYPE_UINT16) && (da->type != FR_TYPE_UINT32)) {
561 fr_strerror_const("The 'key' flag can only be used for attributes of type 'uint8', 'uint16', or 'uint32'");
562 return -1;
563 }
564
565 if (da->flags.extra) {
566 fr_strerror_const("Bit fields cannot be key fields");
567 return -1;
568 }
569
570 da->flags.extra = 1;
571 da->flags.subtype = FLAG_KEY_FIELD;
572 return 0;
573 }
574
575 if (da->type != FR_TYPE_UNION) {
576 fr_strerror_printf("Attributes of type '%s' cannot define a 'key' reference", fr_type_to_str(da->type));
577 return -1;
578 }
579
580 if (!value) {
581 fr_strerror_const("Missing reference for 'key=...'");
582 return -1;
583 }
584
585 /*
586 * The reference must be to a sibling, which is marked "is key".
587 */
588 key = fr_dict_attr_by_name(NULL, da->parent, value);
589 if (!key) {
590 fr_strerror_printf("Invalid reference for 'key=...'. Parent %s does not have a child attribute named %s",
591 da->parent->name, value);
592 return -1;
593 }
594
595 if (da->parent != key->parent) {
596 fr_strerror_printf("Invalid reference for 'key=...'. Reference %s does not share a common parent",
597 value);
598 return -1;
599 }
600
601 if (!fr_dict_attr_is_key_field(key)) {
602 fr_strerror_printf("Invalid reference for 'key=...'. Reference %s is not a 'key' field",
603 value);
604 return -1;
605 }
606
607 /*
608 * Allocate the ref and save the value.
609 */
610 ext = fr_dict_attr_ext(da, FR_DICT_ATTR_EXT_KEY);
611 if (ext) {
612 fr_strerror_printf("Attribute already has a 'key=...' defined");
613 return -1;
614 }
615
616 ext = dict_attr_ext_alloc(da_p, FR_DICT_ATTR_EXT_KEY); /* can change da_p */
617 if (unlikely(!ext)) return -1;
618
619 ext->type = FR_DICT_ATTR_REF_KEY;
620 ext->ref = key;
621
622 return 0;
623}
624
625static int dict_flag_length(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
626{
627 fr_dict_attr_t *da = *da_p;
628
629 if (strcmp(value, "uint8") == 0) {
630 da->flags.is_known_width = true;
631 da->flags.extra = 1;
632 da->flags.subtype = FLAG_LENGTH_UINT8;
633
634 } else if (strcmp(value, "uint16") == 0) {
635 da->flags.is_known_width = true;
636 da->flags.extra = 1;
637 da->flags.subtype = FLAG_LENGTH_UINT16;
638
639 } else {
640 fr_strerror_const("Invalid value given for the 'length' flag");
641 return -1;
642 }
643 da->flags.type_size = 0;
644
645 return 0;
646}
647
648static int dict_flag_offset(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
649{
650 fr_dict_attr_t *da = *da_p;
651 int offset;
652
653 if (da->type != FR_TYPE_STRUCT) {
654 fr_strerror_const("The 'offset' flag can only be used with data type 'struct'");
655 return -1;
656 }
657
658 if (!da_is_length_field(da)) {
659 fr_strerror_const("The 'offset' flag can only be used in combination with 'length=uint8' or 'length=uint16'");
660 return -1;
661 }
662
663 offset = atoi(value);
664 if ((offset <= 0) || (offset > 255)) {
665 fr_strerror_const("The 'offset' value must be between 1..255");
666 return -1;
667 }
668 da->flags.type_size = offset;
669
670 return 0;
671}
672
673static int dict_flag_precision(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
674{
675 fr_dict_attr_t *da = *da_p;
676 int precision;
677
678 switch (da->type) {
679 case FR_TYPE_DATE:
680 case FR_TYPE_TIME_DELTA:
681 break;
682
683 default:
684 fr_strerror_const("The 'precision' flag can only be used with data types 'date' or 'time'");
685 return -1;
686 }
687
688 precision = fr_table_value_by_str(fr_time_precision_table, value, -1);
689 if (precision < 0) {
690 fr_strerror_printf("Unknown %s precision '%s'", fr_type_to_str(da->type), value);
691 return -1;
692 }
693 da->flags.flag_time_res = precision;
694
695 return 0;
696}
697
698static int dict_flag_ref(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
699{
700 fr_dict_attr_t *da = *da_p;
701
702 if (da->flags.extra) {
703 fr_strerror_const("Cannot use 'ref' with other flags");
704 return -1;
705 }
706
707 if (da->type != FR_TYPE_GROUP) {
708 fr_strerror_printf("The 'ref' flag cannot be used for type '%s'",
709 fr_type_to_str(da->type));
710 return -1;
711 }
712
713 if (unlikely(dict_attr_ref_aunresolved(da_p, value, FR_DICT_ATTR_REF_ALIAS) < 0)) return -1;
714
715 return 0;
716}
717
718static int dict_flag_secret(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
719{
720 fr_dict_attr_t *da = *da_p;
721
722 da->flags.secret = 1;
723
724 if ((da->type != FR_TYPE_STRING) && (da->type != FR_TYPE_OCTETS)) {
725 fr_strerror_const("The 'secret' flag can only be used with data types 'string' or 'octets'");
726 return -1;
727 }
728
729 return 0;
730}
731
732static int dict_flag_subtype(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
733{
734 fr_dict_attr_t *da = *da_p;
735 fr_type_t subtype;
736
737 switch (da->type) {
738 case FR_TYPE_DATE:
739 case FR_TYPE_TIME_DELTA:
740 break;
741
742 default:
743 fr_strerror_const("The 'subtype' flag can only be used with data types 'date' or 'time'");
744 return -1;
745 }
746
747 subtype = fr_type_from_str(value);
748 if (fr_type_is_null(subtype)) {
749 unknown_type:
750 fr_strerror_printf("Unknown or unsupported %s type '%s'",
751 fr_type_to_str(subtype),
752 value);
753 return -1;
754 }
755
756 switch (subtype) {
757 default:
758 goto unknown_type;
759
760 case FR_TYPE_INT16:
761 if (da->type == FR_TYPE_DATE) goto unknown_type;
762 da->flags.length = 2;
763 break;
764
765 case FR_TYPE_UINT16:
766 da->flags.is_unsigned = true;
767 da->flags.length = 2;
768 break;
769
770 case FR_TYPE_INT32:
771 if (da->type == FR_TYPE_DATE) goto unknown_type;
772 da->flags.length = 4;
773 break;
774
775 case FR_TYPE_UINT32:
776 da->flags.is_unsigned = true;
777 da->flags.length = 4;
778 break;
779
780 case FR_TYPE_INT64:
781 if (da->type == FR_TYPE_DATE) goto unknown_type;
782 da->flags.length = 8;
783 break;
784
785 case FR_TYPE_UINT64:
786 da->flags.is_unsigned = true;
787 da->flags.length = 8;
788 break;
789 }
790
791 return 0;
792}
793
794FLAG_FUNC(unsafe)
795
796/** A lookup function for dictionary attribute flags
797 *
798 */
799static TABLE_TYPE_NAME_FUNC_RPTR(table_sorted_value_by_str, fr_dict_flag_parser_t const *,
800 fr_dict_attr_flag_to_parser, fr_dict_flag_parser_rule_t const *, fr_dict_flag_parser_rule_t const *)
801
802static int CC_HINT(nonnull) dict_process_flag_field(dict_tokenize_ctx_t *dctx, char *name, fr_dict_attr_t **da_p)
803{
804 static fr_dict_flag_parser_t dict_common_flags[] = {
805 { L("array"), { .func = dict_flag_array } },
806 { L("clone"), { .func = dict_flag_clone, .needs_value = true } },
807 { L("counter"), { .func = dict_flag_counter } },
808 { L("enum"), { .func = dict_flag_enum, .needs_value = true } },
809 { L("internal"), { .func = dict_flag_internal } },
810 { L("key"), { .func = dict_flag_key } },
811 { L("length"), { .func = dict_flag_length, .needs_value = true } },
812 { L("offset"), { .func = dict_flag_offset, .needs_value = true } },
813 { L("precision"), { .func = dict_flag_precision, .needs_value = true } },
814 { L("ref"), { .func = dict_flag_ref, .needs_value = true } },
815 { L("secret"), { .func = dict_flag_secret } },
816 { L("subtype"), { .func = dict_flag_subtype, .needs_value = true } },
817 { L("unsafe"), { .func = dict_flag_unsafe } },
818 };
819 static size_t dict_common_flags_len = NUM_ELEMENTS(dict_common_flags);
820
821 char *p, *next = NULL;
822
823 if ((*da_p)->type == FR_TYPE_NULL) {
824 fr_strerror_const("Type must be specified before parsing flags");
825 return -1;
826 }
827
828 for (p = name; p && *p != '\0' ; p = next) {
829 char *key, *value;
830 fr_dict_flag_parser_rule_t const *parser;
831
832 key = p;
833
834 /*
835 * Search for the first '=' or ','
836 */
837 for (next = p + 1; *next && (*next != '=') && (*next != ','); next++) {
838 /* do nothing */
839 }
840
841 /*
842 * We have a value, zero out the '=' and point to the value.
843 */
844 if (*next == '=') {
845 *(next++) = '\0';
846 value = next;
847
848 if (!*value || (*value == ',')) {
849 fr_strerror_printf("Missing value after '%s='", key);
850 return -1;
851 }
852 } else {
853 value = NULL;
854 }
855
856 /*
857 * Skip any trailing text in the value.
858 */
859 for (/* nothing */; *next; next++) {
860 if (*next == ',') {
861 *(next++) = '\0';
862 break;
863 }
864 }
865
866 /*
867 * Search the protocol table, then the main table.
868 * This allows protocols to overload common flags.
869 */
870 if (!((dctx->dict->proto->attr.flags.table &&
871 fr_dict_attr_flag_to_parser(&parser, dctx->dict->proto->attr.flags.table,
872 dctx->dict->proto->attr.flags.table_len, key, NULL)) ||
873 fr_dict_attr_flag_to_parser(&parser, dict_common_flags, dict_common_flags_len, key, NULL))) {
874 fr_strerror_printf("Unknown flag '%s'", key);
875 return -1;
876 }
877
878 if (parser->needs_value && !value) {
879 fr_strerror_printf("Flag '%s' requires a value", key);
880 return -1;
881 }
882
883 if (unlikely(parser->func(da_p, value, parser) < 0)) return -1;
884 }
885
886 /*
887 * Don't check the flags field for validity via
888 * dict_attr_flags_valid(). It may be updated by various
889 * protocol-specific callback functions. And,
890 * fr_dict_attr_add() calls dict_attr_flags_valid() anyways.
891 */
892
893 return 0;
894}
895
896static int dict_finalise(dict_tokenize_ctx_t *dctx)
897{
898 if (dict_fixup_apply(&dctx->fixup) < 0) return -1;
899
900 dctx->value_attr = NULL;
901 dctx->relative_attr = NULL;
902
903 return 0;
904}
905
906static inline CC_HINT(always_inline)
907void dict_attr_location_set(dict_tokenize_ctx_t *dctx, fr_dict_attr_t *da)
908{
909 da->filename = CURRENT_FILENAME(dctx);
910 da->line = CURRENT_LINE(dctx);
911}
912
913/** Add an attribute to the dictionary, or add it to a list of attributes to clone later
914 *
915 * @param[in] fixup context to add an entry to (if needed).
916 * @param[in] da_p to either add, or create a fixup for.
917 * @return
918 * - 0 on success, and an attribute was added.
919 * - 1 on success, and a deferred entry was added.
920 * - -1 on failure.
921 */
922static int dict_attr_add_or_fixup(dict_fixup_ctx_t *fixup, fr_dict_attr_t **da_p)
923{
924 fr_dict_attr_ext_ref_t *ref;
925 fr_dict_attr_t *da = *da_p;
926 int ret = 0;
927
928 /*
929 * Check for any references associated with the attribute,
930 * if they're unresolved, then add fixups.
931 *
932 * We do this now, as we know the attribute memory chunk
933 * is stable, and we can safely add the fixups.
934 */
935 ref = fr_dict_attr_ext(*da_p, FR_DICT_ATTR_EXT_REF);
936 if (ref && fr_dict_attr_ref_is_unresolved(ref->type)) {
937 /*
938 * See if we can immediately apply the ref.
939 */
940 fr_dict_attr_t const *src;
941
942 switch (fr_dict_attr_ref_type(ref->type)) {
943 case FR_DICT_ATTR_REF_ALIAS:
944 /*
945 * IF the ref exists, we can always add it. The ref won't be changed later.
946 */
947 if (fr_dict_protocol_reference(&src, da->parent, &FR_SBUFF_IN_STR(ref->unresolved)) < 0) return -1;
948
949 if (src && (dict_attr_ref_set(*da_p, src, FR_DICT_ATTR_REF_ALIAS) < 0)) return -1;
950
951 if (fr_dict_attr_add_initialised(da) < 0) {
952 error:
953 talloc_free(da);
954 *da_p = NULL;
955 return -1;
956 }
957
958 if (!src && (dict_fixup_group_enqueue(fixup, da, ref->unresolved) < 0)) return -1;
959 ret = 1;
960 break;
961
962 case FR_DICT_ATTR_REF_ENUM:
963 /*
964 * Do NOT copy the enums now. Later dictionaries may add more values, and we
965 * want to be able to copy all values.
966 */
967 if (fr_dict_attr_add_initialised(da) < 0) goto error;
968
969 if (dict_fixup_clone_enum_enqueue(fixup, da, ref->unresolved) < 0) return -1;
970 break;
971
972 case FR_DICT_ATTR_REF_CLONE:
973 /*
974 * @todo - if we defer this clone, we get errors loading dictionary.wimax. That
975 * likely means there are issues with the dict_fixup_clone_apply() function.
976 */
977 if (fr_dict_protocol_reference(&src, da->parent, &FR_SBUFF_IN_STR(ref->unresolved)) < 0) return -1;
978 if (src) {
979 if (dict_fixup_clone(da_p, src) < 0) return -1;
980 break;
981 }
982
983 if (dict_fixup_clone_enqueue(fixup, da, ref->unresolved) < 0) return -1;
984 ret = 1;
985 break;
986
987 default:
988 fr_strerror_const("Unknown reference type");
989 return -1;
990 }
991 } else {
992 if (fr_dict_attr_add_initialised(da) < 0) goto error;
993 }
994
995 return ret;
996}
997
998/** Check if this definition is a duplicate, and if it is, whether we should skip it error out
999 *
1000 * @return
1001 * - 1 if this is not a duplicate.
1002 * - 0 if this is a duplicate, and we should ignore the definition.
1003 * - -1 if this is a duplicate, and we should error out.
1004 */
1005static int dict_attr_allow_dup(fr_dict_attr_t const *da)
1006{
1007 fr_dict_attr_t const *dup_name = NULL;
1008 fr_dict_attr_t const *dup_num = NULL;
1009 fr_dict_attr_t const *found;
1010
1011 /*
1012 * Search in the parent for a duplicate by name and then by num
1013 */
1014 if (!da->parent) return 1; /* no parent no conflicts possible */
1015
1016 dup_name = fr_dict_attr_by_name(NULL, da->parent, da->name);
1017 if (da->flags.name_only) dup_num = fr_dict_attr_child_by_num(da->parent, da->attr);
1018
1019 /*
1020 * Not a duplicate...
1021 */
1022 if (!dup_name && !dup_num) return 1;
1023
1024 found = dup_name ? dup_name : dup_num;
1025
1026 switch (da->type) {
1027 /*
1028 * For certain STRUCTURAL types, we allow strict duplicates
1029 * as if the user wants to add extra children in the custom
1030 * dictionary, or wants to avoid ordering issues between
1031 * multiple dictionaries, we need to support this.
1032 */
1033 case FR_TYPE_VSA:
1034 case FR_TYPE_VENDOR:
1035 case FR_TYPE_TLV:
1036 if (fr_dict_attr_cmp_fields(da, found) == 0) return -1;
1037 break;
1038
1039 default:
1040 break;
1041 }
1042
1043 if (dup_name) {
1044 fr_strerror_printf("Duplicate attribute name '%s' in namespace '%s'. Originally defined %s[%d]",
1045 da->name, da->parent->name, dup_name->filename, dup_name->line);
1046 return 0;
1047 }
1048
1049 fr_strerror_printf("Duplicate attribute number %u in parent '%s'. Originally defined %s[%d]",
1050 da->attr, da->parent->name, dup_num->filename, dup_num->line);
1051 return 0;
1052}
1053
1054static int dict_struct_finalise(dict_tokenize_ctx_t *dctx)
1055{
1056 fr_dict_attr_t const *da;
1057 dict_tokenize_frame_t const *frame = CURRENT_FRAME(dctx);
1058
1059 da = frame->da;
1060 fr_assert(da->type == FR_TYPE_STRUCT);
1061
1062 /*
1063 * The structure was fixed-size, but the fields don't fill it. That's an error.
1064 *
1065 * Since process_member() checks for overflow, the check here is really only for
1066 * underflow.
1067 */
1068 if (da->flags.is_known_width) {
1069 if (CURRENT_FRAME(dctx)->struct_size != da->flags.length) {
1070 fr_strerror_printf("MEMBERs of %s struct[%u] do not exactly fill the fixed-size structure",
1071 da->name, da->flags.length);
1072 return -1;
1073 }
1074
1075 return 0;
1076 }
1077
1078 /*
1079 * If we have discovered that the structure has a fixed size, then update the da with that
1080 * information.
1081 */
1082 if (frame->struct_size < UINT16_MAX) {
1083 UNCONST(fr_dict_attr_t *, da)->flags.length = frame->struct_size;
1084 } /* else length 0 means "unknown / variable size / too large */
1085
1086 return 0;
1087}
1088
1089static int dict_set_value_attr(dict_tokenize_ctx_t *dctx, fr_dict_attr_t *da)
1090{
1091 /*
1092 * Adding an attribute of type 'struct' is an implicit
1093 * BEGIN-STRUCT.
1094 */
1095 if (da->type == FR_TYPE_STRUCT) {
1096 if (dict_dctx_push(dctx, da, NEST_NONE) < 0) return -1;
1097
1098 CURRENT_FRAME(dctx)->finalise = dict_struct_finalise;
1099 dctx->value_attr = NULL;
1100
1101 } else if (fr_type_is_leaf(da->type)) {
1102 dctx->value_attr = da;
1103
1104 } else {
1105 dctx->value_attr = NULL;
1106 }
1107
1108 return 0;
1109}
1110
1111static int dict_read_process_common(dict_tokenize_ctx_t *dctx, fr_dict_attr_t **da_p,
1112 fr_dict_attr_t const *parent, char const *name,
1113 char const *type_name, char *flag_name,
1114 fr_dict_attr_flags_t const *base_flags)
1115{
1116 fr_dict_attr_t *da, *to_free = NULL;
1117
1118 /*
1119 * Dictionaries need to have real names, not shitty ones.
1120 */
1121 if (strncmp(name, "Attr-", 5) == 0) {
1122 fr_strerror_const("Invalid name");
1123 return -1;
1124 }
1125
1126 /*
1127 * Allocate the attribute here, and then fill in the fields
1128 * as we start parsing the various elements of the definition.
1129 */
1130 if (!*da_p) {
1131 da = dict_attr_alloc_null(dctx->dict->pool, dctx->dict->proto);
1132 if (unlikely(!da)) return -1;
1133 to_free = da;
1134
1135 } else {
1136 da = *da_p;
1137 }
1138 dict_attr_location_set(dctx, da);
1139 da->dict = dctx->dict;
1140
1141 /*
1142 * Set some fields to be friendlier to the type / flag
1143 * parsing and validation routines.
1144 */
1145 da->parent = parent;
1146 da->name = name;
1147
1148 /*
1149 * Set the attribute flags from the base flags.
1150 */
1151 memcpy(&da->flags, base_flags, sizeof(da->flags));
1152
1153 if (unlikely(strcmp(type_name, "auto") == 0)) {
1154 fr_dict_attr_t const *src;
1155 char const *p, *end;
1156
1157 if (!flag_name || !(p = strstr(flag_name, "clone="))) {
1158 fr_strerror_const("Data type of 'auto' is missing the required flag 'clone=...'");
1159 goto error;
1160 }
1161
1162 p += 6;
1163 for (end = p; *end != '\0'; end++) {
1164 if (*end == ',') break;
1165 }
1166
1167 if (fr_dict_protocol_reference(&src, parent, &FR_SBUFF_IN(p, end)) < 0) goto error;
1168 if (!src) {
1169 fr_strerror_const("Data type 'auto' requires that the 'clone=...' reference points to an attribute which already exists");
1170 goto error;
1171 }
1172
1173 /*
1174 * Don't copy the source yet, as later things may add enums, children, etc. to the source
1175 * attribute. Instead, we just copy the data type.
1176 */
1177 if (dict_attr_type_init(&da, src->type) < 0) goto error;
1178
1179 } else {
1180 /*
1181 * Set the base type of the attribute.
1182 */
1183 if (dict_process_type_field(dctx, type_name, &da) < 0) {
1184 error:
1185 if (da == to_free) talloc_free(to_free);
1186 return -1;
1187 }
1188 }
1189
1190 /*
1191 * Clear the temporary parent pointer.
1192 */
1193 da->parent = NULL;
1194 if (unlikely(dict_attr_parent_init(&da, parent) < 0)) goto error;
1195
1196 /*
1197 * Parse optional flags. We pass in the partially allocated
1198 * attribute so that flags can be set directly.
1199 *
1200 * Where flags contain variable length fields, this is
1201 * significantly easier than populating a temporary struct.
1202 */
1203 if (flag_name) if (dict_process_flag_field(dctx, flag_name, &da) < 0) goto error;
1204
1205 da->name = NULL; /* the real name will be a talloc'd chunk */
1206
1207 *da_p = da;
1208 return 0;
1209}
1210
1211/*
1212 * Process the $INCLUDE command
1213 */
1214static int dict_read_process_include(dict_tokenize_ctx_t *dctx, char **argv, int argc, char const *dir)
1215{
1216 int rcode;
1217 bool required = true;
1218 int stack_depth = dctx->stack_depth;
1219 char *src_file = dctx->filename;
1220 int src_line = dctx->line;
1221 char *pattern;
1222 char const *filename;
1223 fr_globdir_iter_t iter;
1224
1225 /*
1226 * Allow "$INCLUDE" or "$INCLUDE-", but
1227 * not anything else.
1228 */
1229 if ((argv[0][8] != '\0') && ((argv[0][8] != '-') || (argv[0][9] != '\0'))) {
1230 fr_strerror_printf("Invalid keyword '%s'", argv[0]);
1231 return -1;
1232 }
1233
1234 if (argc != 2) {
1235 fr_strerror_printf("Unexpected text after $INCLUDE at %s[%d]", fr_cwd_strip(src_file), src_line);
1236 return -1;
1237 }
1238
1239 pattern = argv[1];
1240 required = (argv[0][8] != '-');
1241
1242 /*
1243 * Allow limited macro capability, so people don't have
1244 * to remember where the root dictionaries are located.
1245 */
1246 if (strncmp(pattern, "${dictdir}/", 11) == 0) {
1247 dir = fr_dict_global_ctx_dir();
1248 pattern += 11;
1249 }
1250
1251 /*
1252 * Figure out what we need to open, and put the result into "filename".
1253 */
1254 rcode = fr_globdir_iter_init(&filename, dir, pattern, &iter);
1255 if (rcode < 0) {
1256 failed:
1257 fr_strerror_printf("Failed opening $INCLUDE of %s/%s at %s[%d] - %s",
1258 dir, pattern, fr_cwd_strip(src_file), src_line, fr_syserror(errno));
1259 return -1;
1260 }
1261
1262 /*
1263 * No files may or may not be an error, depending on if the $INCLUDE was required.
1264 */
1265 if (rcode == 0) {
1266 if (required) {
1267 errno = ENOENT;
1268 goto failed;
1269 }
1270
1271 fr_strerror_clear(); /* delete all errors */
1272 return 0;
1273 }
1274
1275 /*
1276 * "filename" is already the file, so we use do{}while() instead of while{}
1277 */
1278 do {
1279 rcode = _dict_from_file(dctx, dir, filename, src_file, src_line);
1280 if (rcode < 0) {
1281 fr_strerror_printf_push("from $INCLUDE at %s[%d]", fr_cwd_strip(src_file), src_line);
1282 break;
1283 }
1284
1285 if (dctx->stack_depth < stack_depth) {
1286 fr_strerror_printf("unexpected END-??? in $INCLUDE at %s[%d]",
1287 fr_cwd_strip(src_file), src_line);
1288 rcode = -1;
1289 break;
1290 }
1291
1292 } while ((rcode = fr_globdir_iter_next(&filename, &iter)) == 1);
1293 (void) fr_globdir_iter_free(&iter);
1294
1295 /*
1296 * Reset the filename and line number.
1297 */
1298 dctx->filename = src_file;
1299 dctx->line = src_line;
1300 return rcode; /* could be an error! */
1301}
1302
1303static int dict_read_parse_format(char const *format, int *ptype, int *plength, bool *pcontinuation)
1304{
1305 char const *p;
1306 int type, length;
1307 bool continuation = false;
1308
1309 if (strncasecmp(format, "format=", 7) != 0) {
1310 fr_strerror_printf("Invalid format for VENDOR. Expected 'format=', got '%s'",
1311 format);
1312 return -1;
1313 }
1314
1315 p = format + 7;
1316 if ((strlen(p) < 3) ||
1317 !isdigit((uint8_t)p[0]) ||
1318 (p[1] != ',') ||
1319 !isdigit((uint8_t)p[2]) ||
1320 (p[3] && (p[3] != ','))) {
1321 fr_strerror_printf("Invalid format for VENDOR. Expected text like '1,1', got '%s'",
1322 p);
1323 return -1;
1324 }
1325
1326 type = (int)(p[0] - '0');
1327 length = (int)(p[2] - '0');
1328
1329 if ((type != 1) && (type != 2) && (type != 4)) {
1330 fr_strerror_printf("Invalid type value %d for VENDOR", type);
1331 return -1;
1332 }
1333
1334 if ((length != 0) && (length != 1) && (length != 2)) {
1335 fr_strerror_printf("Invalid length value %d for VENDOR", length);
1336 return -1;
1337 }
1338
1339 if (p[3] == ',') {
1340 if (!p[4]) {
1341 fr_strerror_printf("Invalid format for VENDOR. Expected text like '1,1', got '%s'",
1342 p);
1343 return -1;
1344 }
1345
1346 if ((p[4] != 'c') ||
1347 (p[5] != '\0')) {
1348 fr_strerror_printf("Invalid format for VENDOR. Expected text like '1,1', got '%s'",
1349 p);
1350 return -1;
1351 }
1352 continuation = true;
1353
1354 if ((type != 1) || (length != 1)) {
1355 fr_strerror_const("Only VSAs with 'format=1,1' can have continuations");
1356 return -1;
1357 }
1358 }
1359
1360 *ptype = type;
1361 *plength = length;
1362 *pcontinuation = continuation;
1363 return 0;
1364}
1365
1366/*
1367 * Process the ALIAS command
1368 *
1369 * ALIAS name ref
1370 *
1371 * Creates an attribute "name" in the root namespace of the current
1372 * dictionary, which is a pointer to "ref".
1373 */
1374static int dict_read_process_alias(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
1375{
1376 fr_dict_attr_t const *da;
1377 fr_dict_attr_t const *parent = CURRENT_FRAME(dctx)->da;
1378 fr_dict_attr_t const *ref_namespace;
1379
1380 if (argc != 2) {
1381 fr_strerror_const("Invalid ALIAS syntax");
1382 return -1;
1383 }
1384
1385 /*
1386 * Dictionaries need to have real names, not shitty ones.
1387 */
1388 if (strncmp(argv[0], "Attr-", 5) == 0) {
1389 fr_strerror_const("Invalid ALIAS name");
1390 return -1;
1391 }
1392
1393 if (strchr(argv[0], '.') != NULL) {
1394 fr_strerror_const("ALIAS names must be in the local context, and cannot contain '.'");
1395 return -1;
1396 }
1397
1398 /*
1399 * Internally we can add aliases to STRUCTs. But the poor user can't.
1400 *
1401 * This limitation is mainly so that we can differentiate automatically added aliases (which
1402 * point to unions), from ones added by users. If we make dict_attr_acopy_aliases() a little
1403 * smarter, then we can relax those checks.
1404 */
1405 switch (parent->type) {
1406 case FR_TYPE_TLV:
1407 case FR_TYPE_VSA:
1408 case FR_TYPE_VENDOR:
1409 break;
1410
1411 default:
1412 fr_strerror_printf("ALIAS cannot be added to data type '%s'", fr_type_to_str(parent->type));
1413 return -1;
1414 }
1415
1416 /*
1417 * Relative refs get resolved from the current namespace.
1418 */
1419 if (argv[1][0] == '.') {
1420 ref_namespace = parent;
1421
1422 } else {
1423 /*
1424 * No dot, so we're looking in the root namespace.
1425 */
1426 ref_namespace = dctx->dict->root;
1427 }
1428
1429 /*
1430 * The <ref> can be a name.
1431 */
1432 da = fr_dict_attr_by_oid(NULL, ref_namespace, argv[1]);
1433 if (!da) {
1434 /*
1435 * If we can't find it now, the file
1436 * containing the ALIASes may have
1437 * been allowed before the ALIASed
1438 * attributes.
1439 */
1440 return dict_fixup_alias_enqueue(&dctx->fixup, CURRENT_FILENAME(dctx), CURRENT_LINE(dctx),
1441 fr_dict_attr_unconst(parent), argv[0],
1442 fr_dict_attr_unconst(ref_namespace), argv[1]);
1443 }
1444
1445 return dict_attr_alias_add(fr_dict_attr_unconst(parent), argv[0], da);
1446}
1447
1448/*
1449 * Process the ATTRIBUTE command
1450 */
1451static int dict_read_process_attribute(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
1452{
1453 bool set_relative_attr;
1454
1455 ssize_t slen;
1456 unsigned int attr;
1457
1458 fr_dict_attr_t const *parent, *key = NULL;
1459 fr_dict_attr_t *da;
1460 fr_value_box_t box;
1461
1462 if ((argc < 3) || (argc > 4)) {
1463 fr_strerror_const("Invalid ATTRIBUTE syntax");
1464 return -1;
1465 }
1466
1467#ifdef STATIC_ANALYZER
1468 if (!dctx->dict) return -1;
1469#endif
1470
1471 /*
1472 * A non-relative ATTRIBUTE definition means that it is
1473 * in the context of the previous BEGIN-FOO. So we
1474 * unwind the stack to match.
1475 */
1476 if (argv[1][0] != '.') {
1477 dict_tokenize_frame_t const *frame;
1478
1479 frame = dict_dctx_unwind(dctx);
1480 if (!frame) return -1;
1481
1482 parent = frame->da;
1483
1484 /*
1485 * Allow '0xff00' as attribute numbers, but only
1486 * if there is no OID component.
1487 */
1488 if (strchr(argv[1], '.') == 0) {
1489 if (!dict_read_sscanf_i(&attr, argv[1])) {
1490 fr_strerror_const("Invalid ATTRIBUTE number");
1491 return -1;
1492 }
1493
1494 } else {
1495 slen = fr_dict_attr_by_oid_legacy(dctx->dict, &parent, &attr, argv[1]);
1496 if (slen <= 0) return -1;
1497 }
1498
1499 /*
1500 * We allow relative attributes only for TLVs.
1501 *
1502 * We haven't parsed the type field yet, so we
1503 * just check it here manually.
1504 */
1505 set_relative_attr = (strcasecmp(argv[2], "tlv") == 0);
1506
1507 } else {
1508 if (!dctx->relative_attr) {
1509 fr_strerror_printf("No parent attribute reference was set for partial OID %s", argv[1]);
1510 return -1;
1511 }
1512
1513 parent = dctx->relative_attr;
1514
1515 slen = fr_dict_attr_by_oid_legacy(dctx->dict, &parent, &attr, argv[1]);
1516 if (slen <= 0) return -1;
1517
1518 set_relative_attr = false;
1519 }
1520
1521 if (!fr_cond_assert(parent)) return -1; /* Should have provided us with a parent */
1522
1523 /*
1524 * Members of a 'struct' MUST use MEMBER, not ATTRIBUTE.
1525 */
1526 if (parent->type == FR_TYPE_STRUCT) {
1527 fr_strerror_printf("Member %s of ATTRIBUTE %s type 'struct' MUST use the \"MEMBER\" keyword",
1528 argv[0], parent->name);
1529 return -1;
1530 }
1531
1532 /*
1533 * A UNION can have child ATTRIBUTEs
1534 */
1535 if (parent->type == FR_TYPE_UNION) {
1536 fr_dict_attr_ext_ref_t *ext;
1537
1538 /*
1539 * The parent is a union. Get and verify the key ref.
1540 */
1541 ext = fr_dict_attr_ext(parent, FR_DICT_ATTR_EXT_KEY);
1542 fr_assert(ext != NULL);
1543
1544 /*
1545 * Double-check names against the reference.
1546 */
1547 key = ext->ref;
1548 fr_assert(key);
1549 fr_assert(fr_dict_attr_is_key_field(key));
1550 da = UNCONST(fr_dict_attr_t *, key);
1551 }
1552
1553 da = dict_attr_alloc_null(dctx->dict->pool, dctx->dict->proto);
1554 if (unlikely(!da)) return -1;
1555
1556 /*
1557 * Record the attribute number BEFORE we parse the type and flags.
1558 *
1559 * This is needed for the DER dictionaries, and 'option'.
1560 *
1561 * It can also be useful for other protocols, which may
1562 * have restrictions on the various fields. It is
1563 * therefore useful to have all fields initialized before
1564 * the type/flag validation routines are called.
1565 */
1566 if (unlikely(dict_attr_num_init(da, attr) < 0)) {
1567 error:
1568 talloc_free(da);
1569 return -1;
1570 }
1571
1572 /*
1573 * Check the attribute number against the allowed values.
1574 */
1575 if (key) {
1576 fr_value_box_init(&box, FR_TYPE_UINT32, NULL, false);
1577 box.vb_uint32 = attr;
1578
1579 if (fr_value_box_cast_in_place(da, &box, key->type, NULL) < 0) {
1580 fr_strerror_printf_push("Invalid attribute number as key field %s has data type %s",
1581 key->name, fr_type_to_str(key->type));
1582 goto error;
1583 }
1584 }
1585
1586 if (dict_read_process_common(dctx, &da, parent, argv[0], argv[2],
1587 (argc > 3) ? argv[3] : NULL, base_flags) < 0) {
1588 goto error;
1589 }
1590
1591 if (da_is_bit_field(da)) {
1592 fr_strerror_const("Bit fields can only be defined as a MEMBER of data type 'struct'");
1593 goto error;
1594 }
1595
1596 /*
1597 * Unions need a key field. And key fields can only appear inside of a struct.
1598 */
1599 if (da->type == FR_TYPE_UNION) {
1600 fr_strerror_const("ATTRIBUTEs of type 'union' can only be defined as a MEMBER of data type 'struct'");
1601 return -1;
1602 }
1603
1604 /*
1605 * Cross-check fixed lengths.
1606 */
1607 if (key && (parent->flags.is_known_width)) {
1608 if (!da->flags.is_known_width) {
1609 da->flags.is_known_width = 1;
1610 da->flags.length = parent->flags.length;
1611
1612 } else if (da->flags.length != parent->flags.length) {
1613 fr_strerror_printf("Invalid length %u for struct, the parent union %s has a different length %u",
1614 da->flags.length, parent->name, parent->flags.length);
1615 return -1;
1616 }
1617 }
1618
1619#ifdef WITH_DICTIONARY_WARNINGS
1620 /*
1621 * Hack to help us discover which vendors have illegal
1622 * attributes.
1623 */
1624 if (!vendor && (attr < 256) &&
1625 !strstr(fn, "rfc") && !strstr(fn, "illegal")) {
1626 fprintf(stderr, "WARNING: Illegal attribute %s in %s\n",
1627 argv[0], fn);
1628 }
1629#endif
1630
1631 /*
1632 * Set the attribute name
1633 */
1634 if (unlikely(dict_attr_finalise(&da, argv[0]) < 0)) {
1635 goto error;
1636 }
1637
1638 /*
1639 * Check to see if this is a duplicate attribute
1640 * and whether we should ignore it or error out...
1641 */
1642 switch (dict_attr_allow_dup(da)) {
1643 case 1:
1644 break;
1645
1646 case 0:
1647 talloc_free(da);
1648 return 0;
1649
1650 default:
1651 goto error;
1652 }
1653
1654 /*
1655 * Add the attribute we allocated earlier
1656 */
1657 switch (dict_attr_add_or_fixup(&dctx->fixup, &da)) {
1658 default:
1659 goto error;
1660
1661 /* New attribute, fixup stack */
1662 case 0:
1663 /*
1664 * Dynamically define where VSAs go. Note that we CANNOT
1665 * define VSAs until we define an attribute of type VSA!
1666 */
1667 if (da->type == FR_TYPE_VSA) {
1668 if (parent->flags.is_root) dctx->dict->vsa_parent = attr;
1669
1670 if (dict_fixup_vsa_enqueue(&dctx->fixup, da) < 0) {
1671 return -1; /* Leaves attr added */
1672 }
1673 }
1674
1675 /*
1676 * Add the VALUE to the key attribute, and ensure that
1677 * the VALUE also contains a pointer to the child struct.
1678 */
1679 if (key && (dict_attr_enum_add_name(fr_dict_attr_unconst(key), da->name, &box, false, true, da) < 0)) {
1680 goto error;
1681 }
1682
1683 /*
1684 * Adding an attribute of type 'struct' is an implicit
1685 * BEGIN-STRUCT.
1686 */
1687 if (da->type == FR_TYPE_STRUCT) {
1688 if (dict_dctx_push(dctx, da, NEST_NONE) < 0) return -1;
1689
1690 CURRENT_FRAME(dctx)->finalise = dict_struct_finalise;
1691 dctx->value_attr = NULL;
1692 } else {
1693 dctx->value_attr = da;
1694 }
1695
1696 if (set_relative_attr) dctx->relative_attr = da;
1697 break;
1698
1699 /* Deferred attribute, don't begin the TLV section automatically */
1700 case 1:
1701 break;
1702 }
1703
1704 /*
1705 * While UNIONs are named, it's nicer to hide them.
1706 * Therefore we automatically add an ALIAS in the unions
1707 * parent, for the child in the union.
1708 */
1709 if (parent->type == FR_TYPE_UNION) {
1710 fr_assert(parent->parent);
1711
1712 if (dict_attr_alias_add(parent->parent, da->name, da) < 0) {
1713 goto error;
1714 }
1715 }
1716
1717 return 0;
1718}
1719
1720static int dict_read_process_begin(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
1721{
1722 dict_tokenize_frame_t const *frame;
1723 fr_dict_attr_t const *da;
1724 fr_dict_attr_t const *common;
1725
1726 dctx->value_attr = NULL;
1727 dctx->relative_attr = NULL;
1728
1729 if (argc != 1) {
1730 fr_strerror_const("Invalid BEGIN keyword. Expected BEGIN <name>");
1731 return -1;
1732 }
1733
1734 frame = dict_dctx_find_frame(dctx, NEST_TOP | NEST_PROTOCOL | NEST_ATTRIBUTE);
1735 if (!fr_cond_assert_msg(frame, "Context stack doesn't have an attribute or dictionary "
1736 "root to begin searching from %s[%d]", CURRENT_FILENAME(dctx), CURRENT_LINE(dctx)) ||
1737 !fr_cond_assert_msg(fr_type_is_structural(frame->da->type), "Context attribute is not structural %s[%d]",
1738 CURRENT_FILENAME(dctx), CURRENT_LINE(dctx))) {
1739 return -1;
1740 }
1741
1742 /*
1743 * Not really a reference as we don't support any of the
1744 * fancy syntaxes like refs do. A straight OID string
1745 * resolved from the current level of nesting is all we support.
1746 */
1747 da = fr_dict_attr_by_oid(NULL, frame->da, argv[0]);
1748 if (!da) {
1749 fr_strerror_printf("BEGIN %s is not resolvable in current context '%s'", argv[0], frame->da->name);
1750 return -1;
1751 }
1752
1753 /*
1754 * We cannot use BEGIN/END on structs. Once they're defined, they can't be modified.
1755 *
1756 * This restriction can be lifted once we don't auto-push on FR_TYPE_STRUCT.
1757 */
1758 if (!fr_type_is_tlv(da->type) && (da->type != FR_TYPE_UNION)) {
1759 fr_strerror_printf("BEGIN %s cannot be used with data type '%s'",
1760 argv[0],
1761 fr_type_to_str(da->type));
1762 return -1;
1763 }
1764
1765 common = fr_dict_attr_common_parent(frame->da, da, true);
1766 if (!common) {
1767 fr_strerror_printf("BEGIN %s should be a child of '%s'",
1768 argv[0], CURRENT_FRAME(dctx)->da->name);
1769 return -1;
1770 }
1771
1772 return dict_dctx_push(dctx, da, NEST_ATTRIBUTE);
1773}
1774
1775static int dict_read_process_begin_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc,
1776 UNUSED fr_dict_attr_flags_t *base_flags)
1777{
1778 fr_dict_t *found;
1779 dict_tokenize_frame_t const *frame;
1780
1781 dctx->value_attr = NULL;
1782 dctx->relative_attr = NULL;
1783
1784 if (argc != 1) {
1785 fr_strerror_const("Invalid BEGIN-PROTOCOL entry");
1786 return -1;
1787 }
1788
1789 /*
1790 * If we're not parsing in the context of the internal
1791 * dictionary, then we don't allow BEGIN-PROTOCOL
1792 * statements.
1793 */
1794 if (dctx->dict != dict_gctx->internal) {
1795 fr_strerror_const("Nested BEGIN-PROTOCOL statements are not allowed");
1796 return -1;
1797 }
1798
1799 found = dict_by_protocol_name(argv[0]);
1800 if (!found) {
1801 fr_strerror_printf("Unknown protocol '%s'", argv[0]);
1802 return -1;
1803 }
1804
1805 frame = dict_dctx_find_frame(dctx, NEST_PROTOCOL | NEST_VENDOR | NEST_ATTRIBUTE);
1806 if (frame) {
1807 fr_strerror_printf("BEGIN-PROTOCOL cannot be used inside of any other BEGIN/END block. Previous definition is at %s[%d]",
1808 frame->filename, frame->line);
1809 return -1;
1810 }
1811
1812 /*
1813 * Add a temporary fixup pool
1814 *
1815 * @todo - make a nested ctx?
1816 */
1817 dict_fixup_init(NULL, &dctx->fixup);
1818
1819 /*
1820 * We're in the middle of loading this dictionary. Tell
1821 * fr_dict_protocol_afrom_file() to suppress recursive references.
1822 */
1823 found->loading = true;
1824
1825 dctx->dict = found;
1826
1827 return dict_dctx_push(dctx, dctx->dict->root, NEST_PROTOCOL);
1828}
1829
1830static int dict_read_process_begin_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc,
1831 UNUSED fr_dict_attr_flags_t *base_flags)
1832{
1833 fr_dict_vendor_t const *vendor;
1834 fr_dict_attr_flags_t flags;
1835
1836 fr_dict_attr_t const *vsa_da;
1837 fr_dict_attr_t const *vendor_da;
1838 fr_dict_attr_t *new;
1839 dict_tokenize_frame_t const *frame;
1840 char *p;
1841
1842 dctx->value_attr = NULL;
1843 dctx->relative_attr = NULL;
1844
1845 if (argc < 1) {
1846 fr_strerror_const("Invalid BEGIN-VENDOR entry");
1847 return -1;
1848 }
1849
1850 vendor = fr_dict_vendor_by_name(dctx->dict, argv[0]);
1851 if (!vendor) {
1852 fr_strerror_printf("Unknown vendor '%s'", argv[0]);
1853 return -1;
1854 }
1855
1856 /*
1857 * Check for extended attr VSAs
1858 *
1859 * BEGIN-VENDOR foo parent=Foo-Encapsulation-Attr
1860 */
1861 if (argc > 1) {
1862 fr_dict_attr_t const *da;
1863
1864 if (strncmp(argv[1], "parent=", 7) != 0) {
1865 fr_strerror_printf("BEGIN-VENDOR invalid argument (%s)", argv[1]);
1866 return -1;
1867 }
1868
1869 p = argv[1] + 7;
1870 da = fr_dict_attr_by_oid(NULL, CURRENT_FRAME(dctx)->da, p);
1871 if (!da) {
1872 fr_strerror_printf("BEGIN-VENDOR invalid argument (%s)", argv[1]);
1873 return -1;
1874 }
1875
1876 if (da->type != FR_TYPE_VSA) {
1877 fr_strerror_printf("Invalid parent for BEGIN-VENDOR. "
1878 "Attribute '%s' should be 'vsa' but is '%s'", p,
1879 fr_type_to_str(da->type));
1880 return -1;
1881 }
1882
1883 vsa_da = da;
1884
1885 } else if (dctx->dict->vsa_parent) {
1886 /*
1887 * Check that the protocol-specific VSA parent exists.
1888 */
1889 vsa_da = dict_attr_child_by_num(CURRENT_FRAME(dctx)->da, dctx->dict->vsa_parent);
1890 if (!vsa_da) {
1891 fr_strerror_printf("Failed finding VSA parent for Vendor %s",
1892 vendor->name);
1893 return -1;
1894 }
1895
1896 } else if (dctx->dict->string_based) {
1897 vsa_da = dctx->dict->root;
1898
1899 } else {
1900 fr_strerror_printf("BEGIN-VENDOR is forbidden for protocol %s - it has no ATTRIBUTE of type 'vsa'",
1901 dctx->dict->root->name);
1902 return -1;
1903 }
1904
1905 frame = dict_dctx_find_frame(dctx, NEST_VENDOR);
1906 if (frame) {
1907 fr_strerror_printf("Nested BEGIN-VENDOR is forbidden. Previous definition is at %s[%d]",
1908 frame->filename, frame->line);
1909 return -1;
1910 }
1911
1912 /*
1913 * Create a VENDOR attribute on the fly, either in the context
1914 * of the VSA (26) attribute.
1915 */
1916 vendor_da = dict_attr_child_by_num(vsa_da, vendor->pen);
1917 if (!vendor_da) {
1918 memset(&flags, 0, sizeof(flags));
1919
1920 flags.type_size = dctx->dict->proto->default_type_size;
1921 flags.length = dctx->dict->proto->default_type_length;
1922
1923 /*
1924 * See if this vendor has
1925 * specific sizes for type /
1926 * length.
1927 *
1928 * @todo - Make this more protocol agnostic!
1929 */
1930 if ((vsa_da->type == FR_TYPE_VSA) &&
1931 (vsa_da->parent->flags.is_root)) {
1932 fr_dict_vendor_t const *dv;
1933
1934 dv = fr_dict_vendor_by_num(dctx->dict, vendor->pen);
1935 if (dv) {
1936 flags.type_size = dv->type;
1937 flags.length = dv->length;
1938 }
1939 }
1940
1941 new = dict_attr_alloc(dctx->dict->pool,
1942 vsa_da, argv[0], vendor->pen, FR_TYPE_VENDOR,
1943 &(dict_attr_args_t){ .flags = &flags });
1944 if (unlikely(!new)) return -1;
1945
1946 if (dict_attr_child_add(UNCONST(fr_dict_attr_t *, vsa_da), new) < 0) {
1947 talloc_free(new);
1948 return -1;
1949 }
1950
1951 if (dict_attr_add_to_namespace(UNCONST(fr_dict_attr_t *, vsa_da), new) < 0) {
1952 talloc_free(new);
1953 return -1;
1954 }
1955
1956 vendor_da = new;
1957 } else {
1958 fr_assert(vendor_da->type == FR_TYPE_VENDOR);
1959 }
1960
1961 return dict_dctx_push(dctx, vendor_da, NEST_VENDOR);
1962}
1963
1964/*
1965 * Process the DEFINE command
1966 *
1967 * Which is mostly like ATTRIBUTE, but does not have a number.
1968 */
1969static int dict_read_process_define(dict_tokenize_ctx_t *dctx, char **argv, int argc,
1970 fr_dict_attr_flags_t *base_flags)
1971{
1972 fr_dict_attr_t const *parent;
1973 fr_dict_attr_t *da = NULL;
1974 dict_tokenize_frame_t const *frame;
1975
1976 if ((argc < 2) || (argc > 3)) {
1977 fr_strerror_const("Invalid DEFINE syntax");
1978 return -1;
1979 }
1980
1981 frame = dict_dctx_unwind(dctx);
1982 if (!fr_cond_assert(frame && frame->da)) return -1; /* Should have provided us with a parent */
1983
1984 parent = frame->da;
1985
1986 /*
1987 * Members of a 'struct' MUST use MEMBER, not ATTRIBUTE.
1988 */
1989 if (parent->type == FR_TYPE_STRUCT) {
1990 fr_strerror_printf("Member %s of parent %s type 'struct' MUST use the \"MEMBER\" keyword",
1991 argv[0], parent->name);
1992 return -1;
1993 }
1994
1995 if (parent->type == FR_TYPE_UNION) {
1996 fr_strerror_printf("Parent attribute %s is of type 'union', and cannot use DEFINE for children",
1997 parent->name);
1998 return -1;
1999 }
2000
2001 /*
2002 * We don't set the attribute number before parsing the
2003 * type and flags. The number is chosen internally, and
2004 * no one should depend on it.
2005 */
2006 if (dict_read_process_common(dctx, &da, parent, argv[0], argv[1],
2007 (argc > 2) ? argv[2] : NULL, base_flags) < 0) {
2008 return -1;
2009 }
2010
2011 /*
2012 * Certain structural types MUST have numbers.
2013 */
2014 switch (da->type) {
2015 case FR_TYPE_VSA:
2016 case FR_TYPE_VENDOR:
2017 fr_strerror_printf("DEFINE cannot be used for type '%s'", argv[1]);
2018 error:
2019 talloc_free(da);
2020 return -1;
2021
2022 default:
2023 break;
2024 }
2025
2026 if (da_is_bit_field(da)) {
2027 fr_strerror_const("Bit fields can only be defined as a MEMBER of data type 'struct'");
2028 goto error;
2029 }
2030
2031#ifdef STATIC_ANALYZER
2032 if (!dctx->dict) goto error;
2033#endif
2034
2035 /*
2036 * Since there is no number, the attribute cannot be
2037 * encoded as a number.
2038 */
2039 da->flags.name_only = true;
2040
2041 /*
2042 * Add an attribute number now so the allocations occur in order
2043 */
2044 if (unlikely(dict_attr_num_init_name_only(da) < 0)) goto error;
2045
2046 /*
2047 * Set the attribute name
2048 */
2049 if (unlikely(dict_attr_finalise(&da, argv[0]) < 0)) goto error;
2050
2051 /*
2052 * Check to see if this is a duplicate attribute
2053 * and whether we should ignore it or error out...
2054 */
2055 switch (dict_attr_allow_dup(da)) {
2056 case 1:
2057 break;
2058
2059 case 0:
2060 talloc_free(da);
2061 return 0;
2062
2063 default:
2064 goto error;
2065 }
2066
2067 /*
2068 * Add the attribute we allocated earlier
2069 */
2070 switch (dict_attr_add_or_fixup(&dctx->fixup, &da)) {
2071 default:
2072 goto error;
2073
2074 /* New attribute, fixup stack */
2075 case 0:
2076 if (dict_set_value_attr(dctx, da) < 0) return -1;
2077
2078 if (da->type == FR_TYPE_TLV) {
2079 dctx->relative_attr = da;
2080 } else {
2081 dctx->relative_attr = NULL;
2082 }
2083 break;
2084
2085 /* Deferred attribute, don't begin the TLV section automatically */
2086 case 1:
2087 break;
2088 }
2089
2090 return 0;
2091}
2092
2093static int dict_read_process_end(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2094 UNUSED fr_dict_attr_flags_t *base_flags)
2095{
2096 fr_dict_attr_t const *current;
2097 fr_dict_attr_t const *da;
2098 dict_tokenize_frame_t const *frame;
2099
2100 dctx->value_attr = NULL;
2101 dctx->relative_attr = NULL;
2102
2103 if (argc > 2) {
2104 fr_strerror_const("Invalid END syntax, expected END <ref>");
2105 return -1;
2106 }
2107
2108 /*
2109 * Unwind until we hit an attribute nesting section
2110 */
2111 if (!dict_dctx_unwind_until(dctx, NEST_ATTRIBUTE)) {
2112 return -1;
2113 }
2114
2115 /*
2116 * Pop the stack to get the attribute we're ending.
2117 */
2118 current = dict_dctx_pop(dctx)->da;
2119
2120 /*
2121 * No checks on the attribute, we're just popping _A_ frame,
2122 * we don't care what attribute it represents.
2123 */
2124 if (argc == 1) return 0;
2125
2126 /*
2127 * This is where we'll have begun the previous search to
2128 * evaluate the BEGIN keyword.
2129 */
2130 frame = dict_dctx_find_frame(dctx, NEST_TOP | NEST_PROTOCOL | NEST_ATTRIBUTE);
2131 if (!fr_cond_assert(frame)) return -1;
2132
2133 da = fr_dict_attr_by_oid(NULL, frame->da, argv[0]);
2134 if (!da) {
2135 fr_strerror_const_push("Failed resolving attribute in BEGIN entry");
2136 return -1;
2137 }
2138
2139 if (da != current) {
2140 fr_strerror_printf("END %s does not match previous BEGIN %s", argv[0], current->name);
2141 return -1;
2142 }
2143
2144 return 0;
2145}
2146
2147static int dict_read_process_end_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2148 UNUSED fr_dict_attr_flags_t *base_flags)
2149{
2150 fr_dict_t const *found;
2151
2152 dctx->value_attr = NULL;
2153 dctx->relative_attr = NULL;
2154
2155 if (argc != 1) {
2156 fr_strerror_const("Invalid END-PROTOCOL entry");
2157 return -1;
2158 }
2159
2160 found = dict_by_protocol_name(argv[0]);
2161 if (!found) {
2162 fr_strerror_printf("END-PROTOCOL %s does not refer to a valid protocol", argv[0]);
2163 return -1;
2164 }
2165
2166 if (found != dctx->dict) {
2167 fr_strerror_printf("END-PROTOCOL %s does not match previous BEGIN-PROTOCOL %s",
2168 argv[0], dctx->dict->root->name);
2169 return -1;
2170 }
2171
2172 /*
2173 * Unwind until we get to a BEGIN-PROTOCOL nesting.
2174 */
2175 if (!dict_dctx_unwind_until(dctx, NEST_PROTOCOL)) {
2176 return -1;
2177 }
2178
2179 if (found->root != CURRENT_FRAME(dctx)->da) {
2180 fr_strerror_printf("END-PROTOCOL %s does not match previous BEGIN-PROTOCOL %s", argv[0],
2181 CURRENT_FRAME(dctx)->da->name);
2182 return -1;
2183 }
2184
2185 /*
2186 * Applies fixups to any attributes added to the protocol
2187 * dictionary. Note that the finalise function prints
2188 * out the original filename / line of the error. So we
2189 * don't need to do that here.
2190 */
2191 if (dict_finalise(dctx) < 0) return -1;
2192
2193 ASSERT_CURRENT_NEST(dctx, NEST_PROTOCOL);
2194
2195 fr_assert(!dctx->stack[dctx->stack_depth].finalise);
2196 dctx->stack_depth--; /* nuke the BEGIN-PROTOCOL */
2197
2198 ASSERT_CURRENT_NEST(dctx, NEST_TOP);
2199 dctx->dict = dict_gctx->internal;
2200
2201 return 0;
2202}
2203
2204static int dict_read_process_end_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2205 UNUSED fr_dict_attr_flags_t *base_flags)
2206{
2207 fr_dict_vendor_t const *vendor;
2208
2209 dctx->value_attr = NULL;
2210 dctx->relative_attr = NULL;
2211
2212 if (argc != 1) {
2213 fr_strerror_const("END-VENDOR is missing vendor name");
2214 return -1;
2215 }
2216
2217 vendor = fr_dict_vendor_by_name(dctx->dict, argv[0]);
2218 if (!vendor) {
2219 fr_strerror_printf("Unknown vendor '%s'", argv[0]);
2220 return -1;
2221 }
2222
2223 /*
2224 * Unwind until we get to a BEGIN-VENDOR nesting.
2225 */
2226 if (!dict_dctx_unwind_until(dctx, NEST_VENDOR)) {
2227 return -1;
2228 }
2229
2230 if (vendor->pen != CURRENT_FRAME(dctx)->da->attr) {
2231 fr_strerror_printf("END-VENDOR %s does not match previous BEGIN-VENDOR %s", argv[0],
2232 CURRENT_FRAME(dctx)->da->name);
2233 return -1;
2234 }
2235
2236 fr_assert(!dctx->stack[dctx->stack_depth].finalise);
2237 dctx->stack_depth--; /* nuke the BEGIN-VENDOR */
2238
2239 return 0;
2240}
2241
2242/*
2243 * Process the ENUM command
2244 */
2245static int dict_read_process_enum(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2246 fr_dict_attr_flags_t *base_flags)
2247{
2248 fr_dict_attr_t const *parent;
2249 fr_dict_attr_t *da = NULL;
2250
2251 if (argc != 2) {
2252 fr_strerror_const("Invalid ENUM syntax");
2253 return -1;
2254 }
2255
2256 /*
2257 * Dictionaries need to have real names, not shitty ones.
2258 */
2259 if (strncmp(argv[0], "Attr-", 5) == 0) {
2260 fr_strerror_const("Invalid ENUM name");
2261 return -1;
2262 }
2263
2264#ifdef STATIC_ANALYZER
2265 if (!dctx->dict) goto error;
2266#endif
2267
2268 /*
2269 * Allocate the attribute here, and then fill in the fields
2270 * as we start parsing the various elements of the definition.
2271 */
2272 da = dict_attr_alloc_null(dctx->dict->pool, dctx->dict->proto);
2273 if (unlikely(da == NULL)) return -1;
2274 dict_attr_location_set(dctx, da);
2275 da->dict = dctx->dict;
2276
2277 /*
2278 * Set the attribute flags from the base flags.
2279 */
2280 memcpy(&da->flags, base_flags, sizeof(da->flags));
2281
2282 da->flags.name_only = true; /* values for ENUM are irrelevant */
2283 da->flags.internal = true; /* ENUMs will never get encoded into a protocol */
2284#if 0
2285 flags.is_enum = true; /* it's an enum, and can't be assigned to a #fr_pair_t */
2286#endif
2287
2288 /*
2289 * Set the base type of the attribute.
2290 */
2291 if (dict_process_type_field(dctx, argv[1], &da) < 0) {
2292 error:
2293 talloc_free(da);
2294 return -1;
2295 }
2296
2297 if (da_is_bit_field(da)) {
2298 fr_strerror_const("Bit fields can only be defined as a MEMBER of a data type 'struct'");
2299 goto error;
2300 }
2301
2302 switch (da->type) {
2303 case FR_TYPE_LEAF:
2304 break;
2305
2306 default:
2307 fr_strerror_printf("ENUMs can only be a leaf type, not %s",
2308 fr_type_to_str(da->type));
2309 break;
2310 }
2311
2312 parent = CURRENT_FRAME(dctx)->da;
2313 if (!parent) {
2314 fr_strerror_const("Invalid location for ENUM");
2315 goto error;
2316 }
2317
2318 /*
2319 * ENUMs cannot have a flag field, so we don't parse that.
2320 *
2321 * Maybe we do want a flag field for named time deltas?
2322 */
2323
2324 if (unlikely(dict_attr_parent_init(&da, parent) < 0)) goto error;
2325 if (unlikely(dict_attr_finalise(&da, argv[0]) < 0)) goto error;
2326
2327 /*
2328 * Add the attribute we allocated earlier
2329 */
2330 switch (dict_attr_add_or_fixup(&dctx->fixup, &da)) {
2331 default:
2332 goto error;
2333
2334 case 0:
2335 memcpy(&dctx->value_attr, &da, sizeof(da));
2336 break;
2337
2338 case 1:
2339 break;
2340 }
2341
2342 return 0;
2343}
2344
2345/*
2346 * Process the FLAGS command
2347 */
2348static int dict_read_process_flags(UNUSED dict_tokenize_ctx_t *dctx, char **argv, int argc,
2349 fr_dict_attr_flags_t *base_flags)
2350{
2351 bool sense = true;
2352
2353 if (argc == 1) {
2354 char *p;
2355
2356 p = argv[0];
2357 if (*p == '!') {
2358 sense = false;
2359 p++;
2360 }
2361
2362 if (strcmp(p, "internal") == 0) {
2363 base_flags->internal = sense;
2364 return 0;
2365 }
2366 }
2367
2368 fr_strerror_const("Invalid FLAGS syntax");
2369 return -1;
2370}
2371
2372/*
2373 * Process the MEMBER command
2374 */
2375static int dict_read_process_member(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2376 fr_dict_attr_flags_t *base_flags)
2377{
2378 fr_dict_attr_t *da = NULL;
2379
2380 if ((argc < 2) || (argc > 3)) {
2381 fr_strerror_const("Invalid MEMBER syntax");
2382 return -1;
2383 }
2384
2385 if (CURRENT_FRAME(dctx)->da->type != FR_TYPE_STRUCT) {
2386 fr_strerror_printf("MEMBER can only be used for ATTRIBUTEs of type 'struct', not for data type %s",
2387 fr_type_to_str(CURRENT_FRAME(dctx)->da->type));
2388 return -1;
2389 }
2390
2391 /*
2392 * Check if the parent 'struct' is fixed size. And if
2393 * so, complain if we're adding a variable sized member.
2394 */
2395 if (CURRENT_FRAME(dctx)->struct_is_closed) {
2396 fr_strerror_printf("Cannot add MEMBER to 'struct' %s after a variable sized member %s",
2397 CURRENT_FRAME(dctx)->da->name,
2398 CURRENT_FRAME(dctx)->struct_is_closed->name);
2399 return -1;
2400 }
2401
2402 /*
2403 * We don't set the attribute number before parsing the
2404 * type and flags. The number is chosen internally, and
2405 * no one should depend on it.
2406 *
2407 * Although _arguably_, it may be useful to know which
2408 * field this is, 0..N?
2409 */
2410 if (dict_read_process_common(dctx, &da, CURRENT_FRAME(dctx)->da, argv[0], argv[1],
2411 (argc > 2) ? argv[2] : NULL, base_flags) < 0) {
2412 return -1;
2413 }
2414
2415#ifdef STATIC_ANALYZER
2416 if (!dctx->dict) goto error;
2417#endif
2418
2419 /*
2420 * If our parent is a known width struct, then we're
2421 * allowed to be variable width. The parent might just
2422 * have a "length=16" prefix, which lets its children be
2423 * variable sized.
2424 */
2425
2426 /*
2427 * Double check any bit field magic
2428 */
2429 if (CURRENT_FRAME(dctx)->member_num > 0) {
2430 fr_dict_attr_t const *previous;
2431
2432 previous = dict_attr_child_by_num(CURRENT_FRAME(dctx)->da,
2433 CURRENT_FRAME(dctx)->member_num);
2434 /*
2435 * Check that the previous bit field ended on a
2436 * byte boundary.
2437 *
2438 * Note that the previous attribute might be a deferred TLV, in which case it doesn't
2439 * exist. That's fine.
2440 */
2441 if (previous && da_is_bit_field(previous)) {
2442 /*
2443 * This attribute is a bit field. Keep
2444 * track of where in the byte we are
2445 * located.
2446 */
2447 if (da_is_bit_field(da)) {
2448 da->flags.flag_byte_offset = (da->flags.length + previous->flags.flag_byte_offset) & 0x07;
2449
2450 } else {
2451 if (previous->flags.flag_byte_offset != 0) {
2452 fr_strerror_printf("Previous bitfield %s did not end on a byte boundary",
2453 previous->name);
2454 error:
2455 talloc_free(da);
2456 return -1;
2457 }
2458 }
2459 }
2460 }
2461
2462 /*
2463 * Ensure that no previous child has "key" or "length" set.
2464 */
2465 if (da->type == FR_TYPE_TLV) {
2466 fr_dict_attr_t const *key;
2467 int i;
2468
2469 /*
2470 * @todo - cache the key field in the stack frame, so we don't have to loop over the children.
2471 */
2472 for (i = 1; i <= CURRENT_FRAME(dctx)->member_num; i++) {
2473 key = dict_attr_child_by_num(CURRENT_FRAME(dctx)->da, i);
2474 if (!key) continue; /* really should be WTF? */
2475
2476 /*
2477 * @todo - we can allow this if the _rest_ of the struct is fixed size, i.e. if
2478 * there is a key field, and then the union is fixed size.
2479 */
2480 if (fr_dict_attr_is_key_field(key)) {
2481 fr_strerror_printf("'struct' %s has a 'key' field %s, and cannot end with a TLV %s",
2482 CURRENT_FRAME(dctx)->da->name, key->name, argv[0]);
2483 goto error;
2484 }
2485
2486 if (da_is_length_field(key)) {
2487 fr_strerror_printf("'struct' %s has a 'length' field %s, and cannot end with a TLV %s",
2488 CURRENT_FRAME(dctx)->da->name, key->name, argv[0]);
2489 goto error;
2490 }
2491 }
2492
2493 /*
2494 * TLVs are variable sized, and close the parent struct.
2495 */
2496 CURRENT_FRAME(dctx)->struct_is_closed = da;
2497 }
2498
2499 /*
2500 * Unions close the parent struct, even if they're fixed size. For now, the struct to/from
2501 * network code assumes that a union is the last member of a structure.
2502 */
2503 if (da->type == FR_TYPE_UNION) {
2504 CURRENT_FRAME(dctx)->struct_is_closed = da;
2505 }
2506
2507 if (unlikely(dict_attr_num_init(da, ++CURRENT_FRAME(dctx)->member_num) < 0)) goto error;
2508 if (unlikely(dict_attr_finalise(&da, argv[0]) < 0)) goto error;
2509
2510 /*
2511 * Check to see if this is a duplicate attribute
2512 * and whether we should ignore it or error out...
2513 */
2514 switch (dict_attr_allow_dup(da)) {
2515 case 1:
2516 break;
2517
2518 case 0:
2519 talloc_free(da);
2520 return 0;
2521
2522 default:
2523 goto error;
2524 }
2525
2526 switch (dict_attr_add_or_fixup(&dctx->fixup, &da)) {
2527 default:
2528 goto error;
2529
2530 case 1:
2531 /*
2532 * @todo - a MEMBER can theoretically have a "ref=..", though non currently do.
2533 *
2534 * If the ref is deferred, then we cannot finalise the parent struct until we have
2535 * resolved the reference. But the "finalise struct on fixup" code isn't written. So
2536 * instead of silently doing the wrong thing, we just return an error.
2537 */
2538 fr_strerror_printf("Cannot have MEMBER with deferred ref=...");
2539 return -1;
2540
2541 case 0:
2542 /*
2543 * New attribute - avoid lots of indentation.
2544 */
2545 break;
2546 }
2547
2548 /*
2549 * Check if this MEMBER closes the structure.
2550 *
2551 * Close this struct if the child struct is variable sized. For now, it we only support
2552 * child structs at the end of the parent.
2553 *
2554 * The solution is to update the unwind() function to check if the da we've
2555 * unwound to is a struct, and then if so... get the last child, and mark it
2556 * closed.
2557 *
2558 * @todo - a MEMBER which is of type 'struct' and has 'clone=foo', we delay the clone
2559 * until after all of the dictionaries have been loaded. As such, this attribute
2560 * is unknown width, and MUST be at the end of the parent structure.
2561 *
2562 * If the cloned MEMBER is in the middle of a structure, then the user will get an opaque
2563 * error. But that case should be rare.
2564 */
2565 if (!da->flags.is_known_width) {
2566 /*
2567 * The child is unknown width, but we were told that the parent has known width.
2568 * That's an error.
2569 */
2570 if (CURRENT_FRAME(dctx)->da->flags.length) {
2571 fr_strerror_printf("'struct' %s has fixed size %u, but member %s is of unknown size",
2572 CURRENT_FRAME(dctx)->da->name, CURRENT_FRAME(dctx)->da->flags.length,
2573 argv[0]);
2574 return -1;
2575 }
2576
2577 /*
2578 * Mark the structure as closed by this attribute. And then set the size to
2579 * zero, for "unknown size".
2580 */
2581 CURRENT_FRAME(dctx)->struct_is_closed = da;
2582 CURRENT_FRAME(dctx)->struct_size = 0;
2583
2584 /*
2585 * A 'struct' can have a MEMBER of type 'tlv', but ONLY
2586 * as the last entry in the 'struct'. If we see that,
2587 * set the previous attribute to the TLV we just added.
2588 * This allows the children of the TLV to be parsed as
2589 * partial OIDs, so we don't need to know the full path
2590 * to them.
2591 */
2592 if (da->type == FR_TYPE_TLV) {
2593 dctx->relative_attr = da;
2594 if (dict_dctx_push(dctx, dctx->relative_attr, NEST_NONE) < 0) return -1;
2595 }
2596
2597 } else if (CURRENT_FRAME(dctx)->da->flags.length) {
2598 /*
2599 * The parent is fixed size, so we track the length of the children.
2600 */
2601 CURRENT_FRAME(dctx)->struct_size += da->flags.length;
2602
2603 /*
2604 * Adding this child may result in an overflow, so we check that.
2605 */
2606 if (CURRENT_FRAME(dctx)->struct_size > CURRENT_FRAME(dctx)->da->flags.length) {
2607 fr_strerror_printf("'struct' %s has fixed size %u, but member %s overflows that length",
2608 CURRENT_FRAME(dctx)->da->name, CURRENT_FRAME(dctx)->da->flags.length,
2609 argv[0]);
2610 return -1;
2611 }
2612 }
2613
2614 /*
2615 * Set or clear the attribute for VALUE statements.
2616 */
2617 return dict_set_value_attr(dctx, da);
2618}
2619
2620
2621/** Process a value alias
2622 *
2623 */
2624static int dict_read_process_value(dict_tokenize_ctx_t *dctx, char **argv, int argc,
2625 UNUSED fr_dict_attr_flags_t *base_flags)
2626{
2627 fr_dict_attr_t *da;
2628 fr_value_box_t value = FR_VALUE_BOX_INITIALISER_NULL(value);
2629 size_t enum_len;
2630 fr_dict_attr_t const *parent = CURRENT_FRAME(dctx)->da;
2631 fr_dict_attr_t const *enumv = NULL;
2632
2633 if (argc != 3) {
2634 fr_strerror_const("Invalid VALUE syntax");
2635 return -1;
2636 }
2637
2638 /*
2639 * Most VALUEs are bunched together by ATTRIBUTE. We can
2640 * save a lot of lookups on dictionary initialization by
2641 * caching the last attribute for a VALUE.
2642 *
2643 * If it's not the same, we look up the attribute in the
2644 * current context, which is generally:
2645 *
2646 * * the current attribute of type `struct`
2647 * * if no `struct`, then the VENDOR for VSAs
2648 * * if no VENDOR, then the dictionary root
2649 */
2650 if (!dctx->value_attr || (strcasecmp(argv[0], dctx->value_attr->name) != 0)) {
2651 fr_dict_attr_t const *tmp;
2652
2653 if (!(tmp = fr_dict_attr_by_oid(NULL, parent, argv[0]))) goto fixup;
2654 dctx->value_attr = fr_dict_attr_unconst(tmp);
2655 }
2656 da = dctx->value_attr;
2657
2658 /*
2659 * Verify the enum name matches the expected from.
2660 */
2661 enum_len = strlen(argv[1]);
2662 if (fr_dict_enum_name_from_substr(NULL, NULL, &FR_SBUFF_IN(argv[1], enum_len), NULL) != (fr_slen_t) enum_len) {
2663 fr_strerror_printf_push("Invalid VALUE name '%s' for attribute '%s'", argv[1], da->name);
2664 return -1;
2665 }
2666
2667 /*
2668 * enum names cannot be integers. People should just use the integer instead.
2669 *
2670 * But what about IPv6 addresses, which also use a "::" prefix?
2671 *
2672 * The ::FOO addresses were historically part of the "ipv4 compatible ipv6 address" range
2673 * "::0.0.0.0/96". That range has since been deprecated, and the "::FOO" range is tracked in the
2674 * IANA Special-Purpose Address Registry. That lists three things beginning with ::
2675 *
2676 * * ::/128 - unspecified address (i.e. ::0/128).
2677 * * ::1/128 - Loopback address
2678 * * ::ffff:0:0/96 - IPv4-mapped address.
2679 *
2680 * Since IPv6 addresses are 128 bits, the first two are just ::0 and ::1. No other possibilities
2681 * exist.
2682 *
2683 * For the range "::ffff:0:0/96", a value such as "::ffff:192.168.1.2 is not a valid enum name.
2684 * It contains an extra ':' (and MUST contain the extra ':'), and the ':' is not allowed in an
2685 * enum name.
2686 *
2687 * IANA could assign other values in the :: range, but this seems unlikely.
2688 *
2689 * As a result, the only overlap between enum ::FOO and IPv6 addresses is the single case of ::1.
2690 * This check disallows that.
2691 */
2692 if (fr_sbuff_adv_past_allowed( &FR_SBUFF_IN(argv[1], enum_len), SIZE_MAX, sbuff_char_class_int, NULL) == enum_len) {
2693 fr_strerror_printf("Invalid VALUE name '%s' for attribute '%s' - the name cannot be an integer", argv[1], da->name);
2694 return -1;
2695 }
2696
2697 /*
2698 * Remember which attribute is associated with this
2699 * value. This allows us to define enum
2700 * values before the attribute exists, and fix them
2701 * up later.
2702 */
2703 if (!da) {
2704 fixup:
2705 if (!fr_cond_assert_msg(dctx->fixup.pool, "fixup pool context invalid")) return -1;
2706
2707 if (dict_fixup_enumv_enqueue(&dctx->fixup,
2708 CURRENT_FILENAME(dctx), CURRENT_LINE(dctx),
2709 argv[0], strlen(argv[0]),
2710 argv[1], strlen(argv[1]),
2711 argv[2], strlen(argv[2]), parent) < 0) {
2712 fr_strerror_const("Out of memory");
2713 return -1;
2714 }
2715 return 0;
2716 }
2717
2718 /*
2719 * Only a leaf types can have values defined.
2720 */
2721 if (!fr_type_is_leaf(da->type)) {
2722 fr_strerror_printf("Cannot define VALUE for attribute '%s' of data type '%s'", da->name,
2723 fr_type_to_str(da->type));
2724 return -1;
2725 }
2726
2727 /*
2728 * Pass in the DA. The value-box parsing functions will figure out where the enums are found.
2729 */
2730 if (da->type == FR_TYPE_ATTR) enumv = da;
2731
2732 if (fr_value_box_from_str(NULL, &value, da->type, enumv,
2733 argv[2], strlen(argv[2]),
2734 NULL) < 0) {
2735 fr_strerror_printf_push("Invalid VALUE '%s' for attribute '%s' of data type '%s'",
2736 argv[2],
2737 da->name,
2738 fr_type_to_str(da->type));
2739 return -1;
2740 }
2741
2742 if (fr_dict_enum_add_name(da, argv[1], &value, false, true) < 0) {
2743 fr_value_box_clear(&value);
2744 return -1;
2745 }
2746 fr_value_box_clear(&value);
2747
2748 return 0;
2749}
2750
2751/*
2752 * Process the VENDOR command
2753 */
2754static int dict_read_process_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
2755{
2756 unsigned int value;
2757 int type, length;
2758 bool continuation = false;
2759 fr_dict_vendor_t const *dv;
2760 fr_dict_vendor_t *mutable;
2761 fr_dict_t *dict = dctx->dict;
2762
2763 dctx->value_attr = NULL;
2764 dctx->relative_attr = NULL;
2765
2766 if ((argc < 2) || (argc > 3)) {
2767 fr_strerror_const("Invalid VENDOR syntax");
2768 return -1;
2769 }
2770
2771 /*
2772 * Validate all entries
2773 */
2774 if (!dict_read_sscanf_i(&value, argv[1])) {
2775 fr_strerror_const("Invalid number in VENDOR");
2776 return -1;
2777 }
2778
2779 /*
2780 * Look for a format statement. Allow it to over-ride the hard-coded formats below.
2781 */
2782 if (argc == 3) {
2783 if (dict_read_parse_format(argv[2], &type, &length, &continuation) < 0) return -1;
2784
2785 } else {
2786 type = length = 1;
2787 }
2788
2789 /* Create a new VENDOR entry for the list */
2790 if (dict_vendor_add(dict, argv[0], value) < 0) return -1;
2791
2792 dv = fr_dict_vendor_by_num(dict, value);
2793 if (!dv) {
2794 fr_strerror_const("Failed adding format for VENDOR");
2795 return -1;
2796 }
2797
2798 mutable = UNCONST(fr_dict_vendor_t *, dv);
2799 mutable->type = type;
2800 mutable->length = length;
2801 mutable->continuation = continuation;
2802
2803 return 0;
2804}
2805
2806/** Register the specified dictionary as a protocol dictionary
2807 *
2808 * Allows vendor and TLV context to persist across $INCLUDEs
2809 */
2810static int dict_read_process_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flag)
2811{
2812 unsigned int value;
2813 unsigned int type_size = 0;
2814 fr_dict_t *dict;
2815 fr_dict_attr_t *mutable;
2816 bool require_dl = false;
2817 bool string_based = false;
2818
2819 /*
2820 * We cannot define a PROTOCOL inside of another protocol.
2821 */
2822 if (CURRENT_FRAME(dctx)->nest != NEST_TOP) {
2823 fr_strerror_const("PROTOCOL definitions cannot occur inside of any other BEGIN/END block");
2824 return -1;
2825 }
2826
2827 dctx->value_attr = NULL;
2828 dctx->relative_attr = NULL;
2829
2830 if ((argc < 2) || (argc > 3)) {
2831 fr_strerror_const("Missing arguments after PROTOCOL. Expected PROTOCOL <num> <name>");
2832 return -1;
2833 }
2834
2835 /*
2836 * Validate all entries
2837 */
2838 if (!dict_read_sscanf_i(&value, argv[1])) {
2839 fr_strerror_printf("Invalid number '%s' following PROTOCOL", argv[1]);
2840 return -1;
2841 }
2842
2843 /*
2844 * 255 protocols FR_TYPE_GROUP type_size hack
2845 */
2846 if (!value) {
2847 fr_strerror_printf("Invalid value '%u' following PROTOCOL", value);
2848 return -1;
2849 }
2850
2851 /*
2852 * Look for a format statement. This may specify the
2853 * type length of the protocol's types.
2854 */
2855 if (argc == 3) {
2856 char const *p;
2857 char *q;
2858
2859 /*
2860 * For now, we don't allow multiple options here.
2861 *
2862 * @todo - allow multiple options.
2863 */
2864 if (strcmp(argv[2], "verify=lib") == 0) {
2865 require_dl = true;
2866 goto post_option;
2867 }
2868
2869 if (strcmp(argv[2], "format=string") == 0) {
2870 type_size = 4;
2871 string_based = true;
2872 goto post_option;
2873 }
2874
2875 if (strncasecmp(argv[2], "format=", 7) != 0) {
2876 fr_strerror_printf("Invalid format for PROTOCOL. Expected 'format=', got '%s'", argv[2]);
2877 return -1;
2878 }
2879 p = argv[2] + 7;
2880
2881 type_size = strtoul(p, &q, 10);
2882 if (q != (p + strlen(p))) {
2883 fr_strerror_printf("Found trailing garbage '%s' after format specifier", p);
2884 return -1;
2885 }
2886 }
2887post_option:
2888
2889 /*
2890 * Cross check name / number.
2891 */
2892 dict = dict_by_protocol_name(argv[0]);
2893 if (dict) {
2894#ifdef STATIC_ANALYZER
2895 if (!dict->root) return -1;
2896#endif
2897
2898 if (dict->root->attr != value) {
2899 fr_strerror_printf("Conflicting numbers %u vs %u for PROTOCOL \"%s\"",
2900 dict->root->attr, value, dict->root->name);
2901 return -1;
2902 }
2903
2904 } else if ((dict = dict_by_protocol_num(value)) != NULL) {
2905#ifdef STATIC_ANALYZER
2906 if (!dict->root || !dict->root->name || !argv[0]) return -1;
2907#endif
2908
2909 if (strcasecmp(dict->root->name, argv[0]) != 0) {
2910 fr_strerror_printf("Conflicting names current \"%s\" vs new \"%s\" for PROTOCOL %u",
2911 dict->root->name, argv[0], dict->root->attr);
2912 return -1;
2913 }
2914 }
2915
2916 /*
2917 * And check types no matter what.
2918 */
2919 if (dict) {
2920 if (type_size && (dict->root->flags.type_size != type_size)) {
2921 fr_strerror_printf("Conflicting flags for PROTOCOL \"%s\" (current %d versus new %u)",
2922 dict->root->name, dict->root->flags.type_size, type_size);
2923 return -1;
2924 }
2925
2926 /*
2927 * Do NOT talloc_free() dict on error.
2928 */
2929 return dict_dctx_push(dctx, dict->root, NEST_NONE);
2930 }
2931
2932 dict = dict_alloc(dict_gctx);
2933
2934 /*
2935 * Try to load protocol-specific validation routines.
2936 * Some protocols don't need them, so it's OK if the
2937 * validation routines don't exist.
2938 */
2939 if ((dict_dlopen(dict, argv[0]) < 0) && require_dl) {
2940 error:
2941 talloc_free(dict);
2942 return -1;
2943 }
2944
2945 /*
2946 * Set the root attribute with the protocol name
2947 */
2948 if (dict_root_set(dict, argv[0], value) < 0) goto error;
2949
2950 if (dict_protocol_add(dict) < 0) goto error;
2951
2952 mutable = UNCONST(fr_dict_attr_t *, dict->root);
2953 dict->string_based = string_based;
2954 if (!type_size) {
2955 mutable->flags.type_size = dict->proto->default_type_size;
2956 mutable->flags.length = dict->proto->default_type_length;
2957 } else {
2958 mutable->flags.type_size = type_size;
2959 mutable->flags.length = 1; /* who knows... */
2960 }
2961
2962 /*
2963 * Make the root available on the stack, in case
2964 * something wants to begin it. Note that we mark it as
2965 * NONE, so that it can be cleaned up by anything.
2966 *
2967 * This stack entry is just a place-holder so that the
2968 * BEGIN statement can find the dictionary.
2969 */
2970 if (unlikely(dict_dctx_push(dctx, dict->root, NEST_NONE) < 0)) goto error;
2971
2972 return 0;
2973}
2974
2975/** Maintain a linked list of filenames which we've seen loading this dictionary
2976 *
2977 * This is used for debug messages, so we have a copy of the original file path
2978 * that we can reference from fr_dict_attr_t without having the memory bloat of
2979 * assigning a buffer to every attribute.
2980 */
2981static inline int dict_filename_add(char **filename_out, fr_dict_t *dict, char const *filename,
2982 char const *src_file, int src_line)
2983{
2984 fr_dict_filename_t *file;
2985
2986 file = talloc_zero(dict, fr_dict_filename_t);
2987 if (unlikely(!file)) {
2988 oom:
2989 fr_strerror_const("Out of memory");
2990 return -1;
2991 }
2992 *filename_out = file->filename = talloc_typed_strdup(file, filename);
2993 if (unlikely(!*filename_out)) goto oom;
2994
2995 if (src_file) {
2996 file->src_line = src_line;
2997 file->src_file = talloc_typed_strdup(file, src_file);
2998 if (!file->src_file) goto oom;
2999 }
3000
3001 fr_dlist_insert_tail(&dict->filenames, file);
3002
3003 return 0;
3004}
3005
3006#ifndef NDEBUG
3007/** See if we have already loaded the file,
3008 *
3009 */
3010static inline bool dict_filename_loaded(fr_dict_t *dict, char const *filename,
3011 char const *src_file, int src_line)
3012{
3013 fr_dict_filename_t *file;
3014
3015 for (file = (fr_dict_filename_t *) fr_dlist_head(&dict->filenames);
3016 file != NULL;
3017 file = (fr_dict_filename_t *) fr_dlist_next(&dict->filenames, &file->entry)) {
3018 if (file->src_file && src_file) {
3019 if (file->src_line != src_line) continue;
3020 if (strcmp(file->src_file, src_file) != 0) continue;
3021 }
3022
3023 if (strcmp(file->filename, filename) == 0) return true; /* this should always be true */
3024 }
3025
3026 return false;
3027}
3028#endif
3029
3030/** Process an inline BEGIN PROTOCOL block
3031 *
3032 * This function is called *after* the PROTOCOL handler.
3033 */
3034static int dict_begin_protocol(NDEBUG_UNUSED dict_tokenize_ctx_t *dctx)
3035{
3036 ASSERT_CURRENT_NEST(dctx, NEST_NONE);
3037 fr_assert(CURRENT_DA(dctx)->flags.is_root);
3038
3039 /*
3040 * Rewrite it in place.
3041 */
3042 CURRENT_FRAME(dctx)->nest = NEST_PROTOCOL;
3043 dctx->dict = CURRENT_DA(dctx)->dict;
3044
3045 return 0;
3046}
3047
3048/** Keyword parser
3049 *
3050 * @param[in] dctx containing the dictionary we're currently parsing.
3051 * @param[in] argv arguments to the keyword.
3052 * @param[in] argc number of arguments.
3053 * @param[in] base_flags set in the context of the current file.
3054 * @return
3055 * - 0 on success.
3056 * - -1 on failure.
3057 */
3058typedef int (*fr_dict_keyword_parse_t)(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags);
3059
3060/** Pushes a new frame onto the top of the stack based on the current frame
3061 *
3062 * Whenever a protocol, vendor, or attribute is defined in the dictionary it either mutates or
3063 * pushes a new NONE frame onto the stack. This holds the last defined object at a given level
3064 * of nesting.
3065 *
3066 * This function is used to push an additional frame onto the stack, effectively entering the
3067 * context of the last defined object at a given level of nesting
3068 *
3069 * @param[in] dctx Contains the current state of the dictionary parser.
3070 * Used to track what PROTOCOL, VENDOR or TLV block
3071 * we're in.
3072 * @return
3073 * - 0 on success.
3074 * - -1 on failure.
3075 */
3076typedef int (*fr_dict_section_begin_t)(dict_tokenize_ctx_t *dctx);
3077
3078typedef struct {
3079 fr_dict_keyword_parse_t parse; //!< Function to parse the keyword with.
3080 fr_dict_section_begin_t begin; //!< Can have a BEGIN prefix
3081} fr_dict_keyword_parser_t;
3082
3083typedef struct {
3084 fr_table_elem_name_t name; //!< Name of the keyword, e.g. "ATTRIBUTE"
3085 fr_dict_keyword_parser_t value; //!< Value to return from lookup.
3086} fr_dict_keyword_t;
3087
3088static TABLE_TYPE_NAME_FUNC_RPTR(table_sorted_value_by_str, fr_dict_keyword_t const *,
3089 fr_dict_keyword, fr_dict_keyword_parser_t const *, fr_dict_keyword_parser_t const *)
3090
3091/** Parse a dictionary file
3092 *
3093 * @param[in] dctx Contains the current state of the dictionary parser.
3094 * Used to track what PROTOCOL, VENDOR or TLV block
3095 * we're in. Block context changes in $INCLUDEs should
3096 * not affect the context of the including file.
3097 * @param[in] dir Directory containing the dictionary we're loading.
3098 * @param[in] filename we're parsing.
3099 * @param[in] src_file The including file.
3100 * @param[in] src_line Line on which the $INCLUDE or $NCLUDE- statement was found.
3101 * @return
3102 * - 0 on success.
3103 * - -1 on failure.
3104 */
3105static int _dict_from_file(dict_tokenize_ctx_t *dctx,
3106 char const *dir, char const *filename,
3107 char const *src_file, int src_line)
3108{
3109 static fr_dict_keyword_t const keywords[] = {
3110 { L("ALIAS"), { .parse = dict_read_process_alias } },
3111 { L("ATTRIBUTE"), { .parse = dict_read_process_attribute } },
3112 { L("BEGIN-PROTOCOL"), { .parse = dict_read_process_begin_protocol } },
3113 { L("BEGIN-VENDOR"), { .parse = dict_read_process_begin_vendor } },
3114 { L("DEFINE"), { .parse = dict_read_process_define } },
3115 { L("END"), { .parse = dict_read_process_end } },
3116 { L("END-PROTOCOL"), { .parse = dict_read_process_end_protocol } },
3117 { L("END-VENDOR"), { .parse = dict_read_process_end_vendor } },
3118 { L("ENUM"), { .parse = dict_read_process_enum } },
3119 { L("FLAGS"), { .parse = dict_read_process_flags } },
3120 { L("MEMBER"), { .parse = dict_read_process_member } },
3121 { L("PROTOCOL"), { .parse = dict_read_process_protocol, .begin = dict_begin_protocol }},
3122 { L("VALUE"), { .parse = dict_read_process_value } },
3123 { L("VENDOR"), { .parse = dict_read_process_vendor } },
3124 };
3125
3126 FILE *fp;
3127 char filename_buf[256];
3128 char buf[256];
3129 char *p;
3130 int line = 0;
3131
3132 struct stat statbuf;
3133 char *argv[DICT_MAX_ARGV];
3134 int argc;
3135
3136 int stack_depth = dctx->stack_depth;
3137
3138 /*
3139 * Base flags are only set for the current file
3140 */
3141 fr_dict_attr_flags_t base_flags = {};
3142
3143 if (!fr_cond_assert(!dctx->dict->root || CURRENT_FRAME(dctx)->da)) return -1;
3144
3145 if ((strlen(dir) + 2 + strlen(filename)) > sizeof(filename_buf)) {
3146 fr_strerror_printf("%s: Filename name too long", "Error reading dictionary");
3147 return -1;
3148 }
3149
3150 /*
3151 * The filename is relative to the current directory.
3152 *
3153 * Ensure that the directory name doesn't end with 2 '/',
3154 * and then create the full path from dir + filename.
3155 */
3156 if (FR_DIR_IS_RELATIVE(filename)) {
3157 /*
3158 * The filename is relative to the input
3159 * directory.
3160 */
3161 strlcpy(filename_buf, dir, sizeof(filename_buf));
3162 p = strrchr(filename_buf, FR_DIR_SEP);
3163 if (p && !p[1]) *p = '\0';
3164
3165 snprintf(filename_buf, sizeof(filename_buf), "%s/%s", dir, filename);
3166 filename = filename_buf;
3167 }
3168 /*
3169 * Else we ignore the input directory. We also assume
3170 * that the filename is normalized, and therefore don't
3171 * change it.
3172 */
3173
3174 /*
3175 * See if we have already loaded this filename. If so, suppress it.
3176 */
3177#ifndef NDEBUG
3178 if (unlikely(dict_filename_loaded(dctx->dict, filename, src_file, src_line))) {
3179 fr_strerror_printf("ERROR - we have a recursive $INCLUDE or load of dictionary %s", filename);
3180 return -1;
3181 }
3182#endif
3183
3184 if ((fp = fopen(filename, "r")) == NULL) {
3185 if (!src_file) {
3186 fr_strerror_printf("Couldn't open dictionary %s: %s", fr_syserror(errno), filename);
3187 } else {
3188 fr_strerror_printf("Error reading dictionary: %s[%d]: Couldn't open dictionary '%s': %s",
3189 fr_cwd_strip(src_file), src_line, filename,
3190 fr_syserror(errno));
3191 }
3192 return -2;
3193 }
3194
3195 /*
3196 * If fopen works, this works.
3197 */
3198 if (fstat(fileno(fp), &statbuf) < 0) {
3199 fr_strerror_printf("Failed stating dictionary \"%s\" - %s", filename, fr_syserror(errno));
3200
3201 perm_error:
3202 fclose(fp);
3203 return -1;
3204 }
3205
3206 if (!S_ISREG(statbuf.st_mode)) {
3207 fr_strerror_printf("Dictionary is not a regular file: %s", filename);
3208 goto perm_error;
3209 }
3210
3211 /*
3212 * Globally writable dictionaries means that users can control
3213 * the server configuration with little difficulty.
3214 */
3215#ifdef S_IWOTH
3216 if (dict_gctx->perm_check && ((statbuf.st_mode & S_IWOTH) != 0)) {
3217 fr_strerror_printf("Dictionary is globally writable: %s. "
3218 "Refusing to start due to insecure configuration", filename);
3219 goto perm_error;
3220 }
3221#endif
3222
3223 /*
3224 * Now that we've opened the file, copy the filename into the dictionary and add it to the ctx
3225 * This string is safe to assign to the filename pointer in any attributes added beneath the
3226 * dictionary.
3227 */
3228 if (unlikely(dict_filename_add(&dctx->filename, dctx->dict, filename, src_file, src_line) < 0)) {
3229 goto perm_error;
3230 }
3231
3232 while (fgets(buf, sizeof(buf), fp) != NULL) {
3233 bool do_begin = false;
3234 fr_dict_keyword_parser_t const *parser;
3235 char **argv_p = argv;
3236
3237 dctx->line = ++line;
3238
3239 switch (buf[0]) {
3240 case '#':
3241 case '\0':
3242 case '\n':
3243 case '\r':
3244 continue;
3245 }
3246
3247 /*
3248 * Comment characters should NOT be appearing anywhere but
3249 * as start of a comment;
3250 */
3251 p = strchr(buf, '#');
3252 if (p) *p = '\0';
3253
3254 argc = fr_dict_str_to_argv(buf, argv, DICT_MAX_ARGV);
3255 if (argc == 0) continue;
3256
3257 if (argc == 1) {
3258 /*
3259 * Be nice.
3260 */
3261 if ((strcmp(argv[0], "BEGIN") == 0) ||
3262 (fr_dict_keyword(&parser, keywords, NUM_ELEMENTS(keywords), argv_p[0], NULL))) {
3263 fr_strerror_printf("Keyword %s is missing all of its arguments", argv[0]);
3264 } else {
3265 fr_strerror_printf("Invalid syntax - unknown keyword %s", argv[0]);
3266 }
3267
3268 error:
3269 fr_strerror_printf_push("Failed parsing dictionary at %s[%d]", fr_cwd_strip(filename), line);
3270 fclose(fp);
3271 return -1;
3272 }
3273
3274 /*
3275 * Special prefix for "beginnable" keywords.
3276 * These are keywords that can automatically change
3277 * the context of subsequent definitions if they're
3278 * prefixed with a BEGIN keyword.
3279 */
3280 if (strcasecmp(argv_p[0], "BEGIN") == 0) {
3281 do_begin = true;
3282 argv_p++;
3283 argc--;
3284 }
3285
3286 if (fr_dict_keyword(&parser, keywords, NUM_ELEMENTS(keywords), argv_p[0], NULL)) {
3287 /*
3288 * We are allowed to have attributes
3289 * named for keywords. Most notably
3290 * "value". If there's no such attribute
3291 * 'value', then the user will get a
3292 * descriptive error.
3293 */
3294 if (do_begin && !parser->begin) {
3295 goto process_begin;
3296 }
3297
3298 if (unlikely(parser->parse(dctx, argv_p + 1 , argc - 1, &base_flags) < 0)) goto error;
3299
3300 /*
3301 * We've processed the definition, now enter the section
3302 */
3303 if (do_begin && unlikely(parser->begin(dctx) < 0)) goto error;
3304 continue;
3305 }
3306
3307 /*
3308 * It's a naked BEGIN keyword
3309 */
3310 if (do_begin) {
3311 process_begin:
3312 if (unlikely(dict_read_process_begin(dctx, argv_p, argc, &base_flags) < 0)) goto error;
3313 continue;
3314 }
3315
3316 /*
3317 * See if we need to import another dictionary.
3318 */
3319 if (strncasecmp(argv_p[0], "$INCLUDE", 8) == 0) {
3320 /*
3321 * Included files operate on a copy of the context.
3322 *
3323 * This copy means that they inherit the
3324 * current context, including parents,
3325 * TLVs, etc. But if the included file
3326 * leaves a "dangling" TLV or "last
3327 * attribute", then it won't affect the
3328 * parent.
3329 */
3330 if (dict_read_process_include(dctx, argv_p, argc, dir) < 0) goto error;
3331 continue;
3332 } /* $INCLUDE */
3333
3334 /*
3335 * Any other string: We don't recognize it.
3336 */
3337 fr_strerror_printf("Invalid keyword '%s'", argv_p[0]);
3338 goto error;
3339 }
3340
3341 /*
3342 * Unwind until the stack depth matches what we had on input.
3343 */
3344 while (dctx->stack_depth > stack_depth) {
3345 dict_tokenize_frame_t *frame = CURRENT_FRAME(dctx);
3346
3347 if (frame->nest == NEST_PROTOCOL) {
3348 fr_strerror_printf("BEGIN-PROTOCOL at %s[%d] is missing END-PROTOCOL",
3349 fr_cwd_strip(frame->filename), line);
3350 goto error;
3351 }
3352
3353 if (frame->nest == NEST_ATTRIBUTE) {
3354 fr_strerror_printf("BEGIN %s at %s[%d] is missing END %s",
3355 frame->da->name, fr_cwd_strip(frame->filename), line,
3356 frame->da->name);
3357 goto error;
3358 }
3359
3360 if (frame->nest == NEST_VENDOR) {
3361 fr_strerror_printf("BEGIN-VENDOR at %s[%d] is missing END-VENDOR",
3362 fr_cwd_strip(frame->filename), line);
3363 goto error;
3364 }
3365
3366 /*
3367 * Run any necessary finalise callback, and then pop the frame.
3368 */
3369 if (frame->finalise) {
3370 if (frame->finalise(dctx) < 0) goto error;
3371 frame->finalise = NULL;
3372 }
3373
3374 fr_assert(!dctx->stack[dctx->stack_depth].finalise);
3375 dctx->stack_depth--;
3376 }
3377
3378 fclose(fp);
3379
3380 return 0;
3381}
3382
3383static int dict_from_file(fr_dict_t *dict,
3384 char const *dir_name, char const *filename,
3385 char const *src_file, int src_line)
3386{
3387 int ret;
3388 dict_tokenize_ctx_t dctx;
3389
3390 memset(&dctx, 0, sizeof(dctx));
3391 dctx.dict = dict;
3392 dict_fixup_init(NULL, &dctx.fixup);
3393 dctx.stack[0].da = dict->root;
3394 dctx.stack[0].nest = NEST_TOP;
3395
3396 ret = _dict_from_file(&dctx, dir_name, filename, src_file, src_line);
3397 if (ret < 0) {
3398 talloc_free(dctx.fixup.pool);
3399 return ret;
3400 }
3401
3402 /*
3403 * Applies to any attributes added to the *internal*
3404 * dictionary.
3405 *
3406 * Fixups should have been applied already to any protocol
3407 * dictionaries.
3408 */
3409 return dict_finalise(&dctx);
3410}
3411
3412/** (Re-)Initialize the special internal dictionary
3413 *
3414 * This dictionary has additional programmatically generated attributes added to it,
3415 * and is checked in addition to the protocol specific dictionaries.
3416 *
3417 * @note The dictionary pointer returned in out must have its reference counter
3418 * decremented with #fr_dict_free when no longer used.
3419 *
3420 * @param[out] out Where to write pointer to the internal dictionary.
3421 * @param[in] dict_subdir name of the internal dictionary dir (may be NULL).
3422 * @param[in] dependent Either C src file, or another dictionary.
3423 * @return
3424 * - 0 on success.
3425 * - -1 on failure.
3426 */
3427int fr_dict_internal_afrom_file(fr_dict_t **out, char const *dict_subdir, char const *dependent)
3428{
3429 fr_dict_t *dict;
3430 char *dict_path = NULL;
3431 size_t i;
3432 fr_dict_attr_flags_t flags = { .internal = true };
3433 char *type_name;
3434 fr_dict_attr_t *cast_base;
3435 fr_value_box_t box = FR_VALUE_BOX_INITIALISER_NULL(box);
3436
3437 if (unlikely(!dict_gctx)) {
3438 fr_strerror_const("fr_dict_global_ctx_init() must be called before loading dictionary files");
3439 return -1;
3440 }
3441
3442 /*
3443 * Increase the reference count of the internal dictionary.
3444 */
3445 if (dict_gctx->internal) {
3446 dict_dependent_add(dict_gctx->internal, dependent);
3447 *out = dict_gctx->internal;
3448 return 0;
3449 }
3450
3451 dict_path = dict_subdir ?
3452 talloc_asprintf(NULL, "%s%c%s", fr_dict_global_ctx_dir(), FR_DIR_SEP, dict_subdir) :
3453 talloc_strdup(NULL, fr_dict_global_ctx_dir());
3454
3455 fr_strerror_clear(); /* Ensure we don't report spurious errors */
3456
3457 dict = dict_alloc(dict_gctx);
3458 if (!dict) {
3459 error:
3460 if (!dict_gctx->internal) talloc_free(dict);
3461 talloc_free(dict_path);
3462 return -1;
3463 }
3464
3465 /*
3466 * Set the root name of the dictionary
3467 */
3468 if (dict_root_set(dict, "internal", 0) < 0) goto error;
3469
3470 if (dict_path && dict_from_file(dict, dict_path, FR_DICTIONARY_FILE, NULL, 0) < 0) goto error;
3471
3472 TALLOC_FREE(dict_path);
3473
3474 dict_dependent_add(dict, dependent);
3475
3476 if (!dict_gctx->internal) {
3477 dict_gctx->internal = dict;
3478 dict_dependent_add(dict, "global");
3479 }
3480
3481 /*
3482 * Try to load libfreeradius-internal, too. If that
3483 * fails (i.e. fuzzers???), ignore it.
3484 */
3485 (void) dict_dlopen(dict, "internal");
3486
3487 cast_base = dict_attr_child_by_num(dict->root, FR_CAST_BASE);
3488 if (!cast_base) {
3489 fr_strerror_printf("Failed to find 'Cast-Base' in internal dictionary");
3490 goto error;
3491 }
3492
3493 fr_assert(cast_base->type == FR_TYPE_UINT8);
3494 fr_value_box_init(&box, FR_TYPE_UINT8, NULL, false);
3495
3496 /*
3497 * Add cast attributes. We do it this way,
3498 * so cast attributes get added automatically for new types.
3499 *
3500 * We manually add the attributes to the dictionary, and bypass
3501 * fr_dict_attr_add(), because we know what we're doing, and
3502 * that function does too many checks.
3503 */
3504 for (i = 0; i < fr_type_table_len; i++) {
3505 fr_dict_attr_t *n;
3506 fr_table_num_ordered_t const *p = &fr_type_table[i];
3507
3508 switch (p->value) {
3509 case FR_TYPE_NULL: /* Can't cast to NULL */
3510 case FR_TYPE_VENDOR: /* Vendors can't exist in dictionaries as attributes */
3511 continue;
3512 }
3513
3514 type_name = talloc_typed_asprintf(NULL, "Tmp-Cast-%s", p->name.str);
3515
3516 n = dict_attr_alloc(dict->pool, dict->root, type_name,
3517 FR_CAST_BASE + p->value, p->value, &(dict_attr_args_t){ .flags = &flags});
3518 if (!n) {
3519 talloc_free(type_name);
3520 goto error;
3521 }
3522
3523 if (dict_attr_add_to_namespace(dict->root, n) < 0) {
3524 fr_strerror_printf_push("Failed inserting '%s' into internal dictionary", type_name);
3525 talloc_free(type_name);
3526 goto error;
3527 }
3528
3529 talloc_free(type_name);
3530
3531 /*
3532 * Set up parenting for the attribute.
3533 */
3534 if (dict_attr_child_add(dict->root, n) < 0) goto error;
3535
3536 /*
3537 * Add the enum, too.
3538 */
3539 box.vb_uint8 = p->value;
3540 if (dict_attr_enum_add_name(cast_base, p->name.str, &box, false, false, NULL) < 0) {
3541 fr_strerror_printf_push("Failed adding '%s' as a VALUE into internal dictionary", p->name.str);
3542 goto error;
3543 }
3544 }
3545
3546 *out = dict;
3547
3548 return 0;
3549}
3550
3551/** (Re)-initialize a protocol dictionary
3552 *
3553 * Initialize the directory, then fix the attr number of all attributes.
3554 *
3555 * @param[out] out Where to write a pointer to the new dictionary. Will free existing
3556 * dictionary if files have changed and *out is not NULL.
3557 * @param[in] proto_name that we're loading the dictionary for.
3558 * @param[in] proto_dir Explicitly set where to hunt for the dictionary files. May be NULL.
3559 * @param[in] dependent Either C src file, or another dictionary.
3560 * @return
3561 * - 0 on success.
3562 * - -1 on failure.
3563 */
3564int fr_dict_protocol_afrom_file(fr_dict_t **out, char const *proto_name, char const *proto_dir, char const *dependent)
3565{
3566 char *dict_dir = NULL;
3567 fr_dict_t *dict;
3568 bool added = false;
3569
3570 *out = NULL;
3571
3572 if (unlikely(!dict_gctx)) {
3573 fr_strerror_const("fr_dict_global_ctx_init() must be called before loading dictionary files");
3574 return -1;
3575 }
3576
3577 if (unlikely(!dict_gctx->internal)) {
3578 fr_strerror_const("Internal dictionary must be initialised before loading protocol dictionaries");
3579 return -1;
3580 }
3581
3582 /*
3583 * Increment the reference count if the dictionary
3584 * has already been loaded and return that.
3585 */
3586 dict = dict_by_protocol_name(proto_name);
3587 if (dict) {
3588 /*
3589 * If we're in the middle of loading this dictionary, then the only way we get back here
3590 * is via a circular reference. So we catch that, and drop the circular dependency.
3591 *
3592 * When we have A->B->A, it means that we don't need to track B->A, because we track
3593 * A->B. And if A is freed, then B is freed.
3594 */
3595 added = true;
3596 dict_dependent_add(dict, dependent);
3597
3598 /*
3599 * But we only return a pre-existing dict if _this function_ has loaded it.
3600 */
3601 if (dict->loaded) {
3602 *out = dict;
3603 return 0;
3604 }
3605
3606 /*
3607 * Set the flag to true _before_ loading the file. That prevents recursion.
3608 */
3609 dict->loaded = true;
3610 }
3611
3612 if (!proto_dir) {
3613 dict_dir = talloc_asprintf(NULL, "%s%c%s", fr_dict_global_ctx_dir(), FR_DIR_SEP, proto_name);
3614 } else {
3615 dict_dir = talloc_asprintf(NULL, "%s%c%s", fr_dict_global_ctx_dir(), FR_DIR_SEP, proto_dir);
3616 }
3617
3618 fr_strerror_clear(); /* Ensure we don't report spurious errors */
3619
3620 /*
3621 * Start in the context of the internal dictionary,
3622 * and switch to the context of a protocol dictionary
3623 * when we hit a BEGIN-PROTOCOL line.
3624 *
3625 * This allows a single file to provide definitions
3626 * for multiple protocols, which'll probably be useful
3627 * at some point.
3628 */
3629 if (dict_from_file(dict_gctx->internal, dict_dir, FR_DICTIONARY_FILE, NULL, 0) < 0) {
3630 error:
3631 if (dict) dict->loading = false;
3632 talloc_free(dict_dir);
3633 return -1;
3634 }
3635
3636 /*
3637 * Check the dictionary actually defined the protocol
3638 */
3639 dict = dict_by_protocol_name(proto_name);
3640 if (!dict) {
3641 fr_strerror_printf("Dictionary \"%s\" missing \"BEGIN-PROTOCOL %s\" declaration", dict_dir, proto_name);
3642 goto error;
3643 }
3644
3645 /*
3646 * Initialize the library.
3647 */
3648 dict->loaded = true;
3649 if (dict->proto && dict->proto->init) {
3650 if (dict->proto->init() < 0) goto error;
3651 }
3652 dict->loading = false;
3653
3654 dict->dir = talloc_steal(dict, dict_dir);
3655
3656 if (!added) dict_dependent_add(dict, dependent);
3657
3658 *out = dict;
3659
3660 return 0;
3661}
3662
3663/* Alloc a new root dictionary attribute
3664 *
3665 * @note Must only be called once per dictionary.
3666 *
3667 * @param[in] proto_name that we're loading the dictionary for.
3668 * @param[in] proto_number The artificial (or IANA allocated) number for the protocol.
3669 * @return
3670 * - A pointer to the new dict context on success.
3671 * - NULL on failure.
3672 */
3673fr_dict_t *fr_dict_alloc(char const *proto_name, unsigned int proto_number)
3674{
3675 fr_dict_t *dict;
3676
3677 if (unlikely(!dict_gctx)) {
3678 fr_strerror_printf("fr_dict_global_ctx_init() must be called before loading dictionary files");
3679 return NULL;
3680 }
3681
3682 /*
3683 * Alloc dict instance.
3684 */
3685 dict = dict_alloc(dict_gctx);
3686 if (!dict) return NULL;
3687
3688 /*
3689 * Set the root name of the dictionary
3690 */
3691 if (dict_root_set(dict, proto_name, proto_number) < 0) {
3692 talloc_free(dict);
3693 return NULL;
3694 }
3695
3696 return dict;
3697}
3698
3699/** Read supplementary attribute definitions into an existing dictionary
3700 *
3701 * @param[in] dict Existing dictionary.
3702 * @param[in] dir dictionary is located in.
3703 * @param[in] filename of the dictionary.
3704 * @return
3705 * - 0 on success.
3706 * - -1 on failure.
3707 */
3708int fr_dict_read(fr_dict_t *dict, char const *dir, char const *filename)
3709{
3710 INTERNAL_IF_NULL(dict, -1);
3711
3712 if (!dir) dir = dict->dir;
3713
3714 if (unlikely(dict->read_only)) {
3715 fr_strerror_printf("%s dictionary has been marked as read only", fr_dict_root(dict)->name);
3716 return -1;
3717 }
3718
3719 if (!dict->vendors_by_name) {
3720 fr_strerror_printf("%s: Must initialise dictionary before calling fr_dict_read()", __FUNCTION__);
3721 return -1;
3722 }
3723
3724 return dict_from_file(dict, dir, filename, NULL, 0);
3725}
3726
3727/*
3728 * External API for testing
3729 */
3730int fr_dict_parse_str(fr_dict_t *dict, char *buf, fr_dict_attr_t const *parent)
3731{
3732 int argc;
3733 char *argv[DICT_MAX_ARGV];
3734 int ret;
3735 fr_dict_attr_flags_t base_flags;
3736 dict_tokenize_ctx_t dctx;
3737
3738 INTERNAL_IF_NULL(dict, -1);
3739
3740 argc = fr_dict_str_to_argv(buf, argv, DICT_MAX_ARGV);
3741 if (argc == 0) return 0;
3742
3743
3744 memset(&dctx, 0, sizeof(dctx));
3745 dctx.dict = dict;
3746 dctx.stack[0].nest = NEST_TOP;
3747
3748 if (dict_fixup_init(NULL, &dctx.fixup) < 0) return -1;
3749
3750 if (strcasecmp(argv[0], "VALUE") == 0) {
3751 if (argc < 4) {
3752 fr_strerror_printf("VALUE needs at least 4 arguments, got %i", argc);
3753 error:
3754 TALLOC_FREE(dctx.fixup.pool);
3755 return -1;
3756 }
3757
3758 if (!fr_dict_attr_by_oid(NULL, fr_dict_root(dict), argv[1])) {
3759 fr_strerror_printf("Attribute '%s' does not exist in dictionary \"%s\"",
3760 argv[1], dict->root->name);
3761 goto error;
3762 }
3763 ret = dict_read_process_value(&dctx, argv + 1, argc - 1, &base_flags);
3764 if (ret < 0) goto error;
3765
3766 } else if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
3767 if (parent && (parent != dict->root)) {
3768 (void) dict_dctx_push(&dctx, parent, NEST_NONE);
3769 }
3770
3771 memset(&base_flags, 0, sizeof(base_flags));
3772
3773 ret = dict_read_process_attribute(&dctx,
3774 argv + 1, argc - 1, &base_flags);
3775 if (ret < 0) goto error;
3776 } else if (strcasecmp(argv[0], "VENDOR") == 0) {
3777 ret = dict_read_process_vendor(&dctx, argv + 1, argc - 1, &base_flags);
3778 if (ret < 0) goto error;
3779 } else {
3780 fr_strerror_printf("Invalid input '%s'", argv[0]);
3781 goto error;
3782 }
3783
3784 return dict_finalise(&dctx);
3785}
file
int const char * file
Definition acutest.h:704
n
int n
Definition acutest.h:579
line
int const char int line
Definition acutest.h:704
UNCONST
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
Definition build.h:167
RCSID
#define RCSID(id)
Definition build.h:485
L
#define L(_str)
Helper for initialising arrays of string literals.
Definition build.h:209
NDEBUG_UNUSED
#define NDEBUG_UNUSED
Definition build.h:328
DIAG_ON
#define DIAG_ON(_x)
Definition build.h:460
unlikely
#define unlikely(_x)
Definition build.h:383
UNUSED
#define UNUSED
Definition build.h:317
NUM_ELEMENTS
#define NUM_ELEMENTS(_t)
Definition build.h:339
DIAG_OFF
#define DIAG_OFF(_x)
Definition build.h:459
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_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:273
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:1837
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:3817
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 replace)
Add a value name.
Definition dict_util.c:2209
fr_dict_vendor_t::name
char const * name
Vendor name.
Definition dict.h:275
fr_dict_attr_flags_t::is_root
unsigned int is_root
Is root of a dictionary.
Definition dict.h:77
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:2305
fr_dict_protocol_reference
int fr_dict_protocol_reference(fr_dict_attr_t const **da_p, fr_dict_attr_t const *root, fr_sbuff_t *in)
Resolve a reference string to a dictionary attribute.
Definition dict_fixup.c:135
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:3524
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:4901
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:2661
fr_dict_flag_parser_rule_s::func
fr_dict_flag_parse_func_t func
Custom parsing function to convert a flag value string to a C type value.
Definition dict.h:396
fr_dict_attr_flags_t::internal
unsigned int internal
Internal attribute, should not be received in protocol packets, should not be encoded.
Definition dict.h:90
DA_VERIFY
#define DA_VERIFY(_x)
Definition dict.h:68
fr_dict_attr_by_oid_legacy
fr_slen_t fr_dict_attr_by_oid_legacy(fr_dict_t const *dict, fr_dict_attr_t const **parent, unsigned int *attr, char const *oid)
Get the leaf attribute of an OID string.
Definition dict_util.c:2393
da_is_bit_field
#define da_is_bit_field(_da)
Definition dict.h:171
FLAG_LENGTH_UINT8
@ FLAG_LENGTH_UINT8
string / octets type is prefixed by uint8 of length
Definition dict.h:166
FLAG_LENGTH_UINT16
@ FLAG_LENGTH_UINT16
string / octets type is prefixed by uint16 of length
Definition dict.h:167
FLAG_KEY_FIELD
@ FLAG_KEY_FIELD
this is a key field for a subsequent struct
Definition dict.h:164
FLAG_BIT_FIELD
@ FLAG_BIT_FIELD
bit field inside of a struct
Definition dict.h:165
fr_dict_vendor_t::pen
uint32_t pen
Private enterprise number.
Definition dict.h:271
da_is_length_field
#define da_is_length_field(_da)
Definition dict.h:172
fr_dict_attr_flags_t::type_size
uint8_t type_size
Type size for TLVs.
Definition dict.h:144
fr_dict_vendor_t::length
size_t length
Length of length data.
Definition dict.h:274
fr_dict_attr_flags_t::length
uint16_t length
length of the attribute
Definition dict.h:153
fr_dict_global_ctx_dir
char const * fr_dict_global_ctx_dir(void)
Definition dict_util.c:4796
FR_DICT_ATTR_EXT_ENUMV
@ FR_DICT_ATTR_EXT_ENUMV
Enumeration values.
Definition dict.h:189
FR_DICT_ATTR_EXT_REF
@ FR_DICT_ATTR_EXT_REF
Attribute references another attribute and/or dictionary.
Definition dict.h:184
FR_DICT_ATTR_EXT_KEY
@ FR_DICT_ATTR_EXT_KEY
UNION attribute references a key.
Definition dict.h:186
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:2918
fr_dict_flag_parser_rule_s::needs_value
bool needs_value
This parsing flag must have a value. Else we error.
Definition dict.h:398
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:2634
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:2941
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:3589
fr_dict_attr_is_key_field
#define fr_dict_attr_is_key_field(_da)
Definition dict.h:170
fr_dict_attr_cmp_fields
static int8_t fr_dict_attr_cmp_fields(const fr_dict_attr_t *a, const fr_dict_attr_t *b)
Compare two dictionary attributes by their contents.
Definition dict.h:679
fr_dict_attr_flags_t
Values of the encryption flags.
Definition merged_model.c:139
fr_dict_flag_parser_rule_s
Definition dict.h:395
fr_dict_flag_parser_t
Protocol specific custom flag definitnion.
Definition dict.h:426
fr_dict_vendor_t
Private enterprise.
Definition dict.h:270
fr_dict_attr_ref_type
#define fr_dict_attr_ref_type(_type)
Definition dict_ext.h:72
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
static void * fr_dict_attr_ext(fr_dict_attr_t const *da, fr_dict_attr_ext_t ext)
Definition dict_ext.h:134
fr_dict_attr_ref_is_unresolved
#define fr_dict_attr_ref_is_unresolved(_type)
Definition dict_ext.h:71
FR_DICT_ATTR_REF_ENUM
@ FR_DICT_ATTR_REF_ENUM
The attribute is an enumeration value.
Definition dict_ext.h:64
FR_DICT_ATTR_REF_KEY
@ FR_DICT_ATTR_REF_KEY
it is a UNION which has a ref to a key, and children.
Definition dict_ext.h:65
FR_DICT_ATTR_REF_ALIAS
@ FR_DICT_ATTR_REF_ALIAS
The attribute is an alias for another attribute.
Definition dict_ext.h:60
FR_DICT_ATTR_REF_CLONE
@ FR_DICT_ATTR_REF_CLONE
The attribute is a "copy" of another attribute.
Definition dict_ext.h:63
fr_dict_attr_ext_ref_t
Attribute extension - Holds a reference to an attribute in another dictionary.
Definition dict_ext.h:77
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_ref_aunresolved
static int dict_attr_ref_aunresolved(fr_dict_attr_t **da_p, char const *ref, fr_dict_attr_ref_type_t type)
Definition dict_ext_priv.h:223
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_fixup_apply
int dict_fixup_apply(dict_fixup_ctx_t *fctx)
Apply all outstanding fixes to a set of dictionaries.
Definition dict_fixup.c:809
dict_fixup_enumv_enqueue
int dict_fixup_enumv_enqueue(dict_fixup_ctx_t *fctx, char const *filename, int line, char const *attr, size_t attr_len, char const *name, size_t name_len, char const *value, size_t value_len, fr_dict_attr_t const *parent)
Add an enumeration value to an attribute which has not yet been defined.
Definition dict_fixup.c:275
dict_fixup_alias_enqueue
int dict_fixup_alias_enqueue(dict_fixup_ctx_t *fctx, char const *filename, int line, fr_dict_attr_t *alias_parent, char const *alias, fr_dict_attr_t *ref_parent, char const *ref)
Resolve a group reference.
Definition dict_fixup.c:737
dict_fixup_clone_enqueue
int dict_fixup_clone_enqueue(dict_fixup_ctx_t *fctx, fr_dict_attr_t *da, char const *ref)
Clone one area of a tree into another.
Definition dict_fixup.c:425
dict_fixup_init
int dict_fixup_init(TALLOC_CTX *ctx, dict_fixup_ctx_t *fctx)
Initialise a fixup ctx.
Definition dict_fixup.c:789
dict_fixup_clone_enum_enqueue
int dict_fixup_clone_enum_enqueue(dict_fixup_ctx_t *fctx, fr_dict_attr_t *da, char const *ref)
Clone enumeration values from one attribute to another.
Definition dict_fixup.c:577
dict_fixup_vsa_enqueue
int dict_fixup_vsa_enqueue(dict_fixup_ctx_t *fctx, fr_dict_attr_t *da)
Push a fixup for a VSA.
Definition dict_fixup.c:676
dict_fixup_clone
int dict_fixup_clone(fr_dict_attr_t **dst_p, fr_dict_attr_t const *src)
Clone a dictionary attribute from a ref.
Definition dict_fixup.c:460
dict_fixup_group_enqueue
int dict_fixup_group_enqueue(dict_fixup_ctx_t *fctx, fr_dict_attr_t *da, char const *ref)
Resolve a group reference.
Definition dict_fixup.c:358
dict_fixup_ctx_t::pool
TALLOC_CTX * pool
Temporary pool for fixups, reduces holes.
Definition dict_fixup_priv.h:33
dict_fixup_ctx_t
Definition dict_fixup_priv.h:32
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 replace, fr_dict_attr_t const *child_struct)
Definition dict_util.c:2012
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:588
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:682
dict_attr_alloc
#define dict_attr_alloc(_ctx, _parent, _name, _attr, _type, _args)
Definition dict_priv.h:239
dict_alloc
fr_dict_t * dict_alloc(TALLOC_CTX *ctx)
Allocate a new dictionary.
Definition dict_util.c:4174
INTERNAL_IF_NULL
#define INTERNAL_IF_NULL(_dict, _ret)
Set the internal dictionary if none was provided.
Definition dict_priv.h:45
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:1771
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:3542
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:2783
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:1672
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:1565
dict_attr_alias_add
int dict_attr_alias_add(fr_dict_attr_t const *parent, char const *alias, fr_dict_attr_t const *ref)
Add an alias to an existing attribute.
Definition dict_util.c:1399
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:777
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:733
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:751
dict_dlopen
int dict_dlopen(fr_dict_t *dict, char const *name)
Definition dict_util.c:3857
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:2769
fr_dict_gctx_s::internal
fr_dict_t * internal
Magic internal dictionary.
Definition dict_priv.h:155
dict_attr_alloc_null
fr_dict_attr_t * dict_attr_alloc_null(TALLOC_CTX *ctx, fr_dict_protocol_t const *dict)
Partial initialisation functions.
Definition dict_util.c:985
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:3949
dict_attr_alloc_root
#define dict_attr_alloc_root(_ctx, _dict, _name, _attr, _args)
Definition dict_priv.h:231
dict_protocol_add
int dict_protocol_add(fr_dict_t *dict)
Add a protocol to the global protocol table.
Definition dict_util.c:1492
dict_gctx
fr_dict_gctx_t * dict_gctx
Top level structure containing global dictionary state.
Definition dict_util.c:42
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
dict_attr_args_t
Optional arguments for initialising/allocating attributes.
Definition dict_priv.h:175
fr_dict_filename_t
Entry in the filename list of files associated with this dictionary.
Definition dict_priv.h:69
value
Test enumeration values.
Definition dict_test.h:92
dict_tokenize_frame_t::finalise
fr_dict_keyword_finalise_t finalise
function to call when popping
Definition dict_tokenize.c:84
dict_nest_table
static fr_table_num_sorted_t const dict_nest_table[]
Definition dict_tokenize.c:63
dict_read_process_include
static int dict_read_process_include(dict_tokenize_ctx_t *dctx, char **argv, int argc, char const *dir)
Definition dict_tokenize.c:1214
dict_tokenize_frame_t::nest
dict_nest_t nest
for manual vs automatic begin / end things
Definition dict_tokenize.c:82
dict_tokenize_ctx_s::fixup
dict_fixup_ctx_t fixup
Definition dict_tokenize.c:98
dict_read_process_common
static int dict_read_process_common(dict_tokenize_ctx_t *dctx, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, char const *name, char const *type_name, char *flag_name, fr_dict_attr_flags_t const *base_flags)
Definition dict_tokenize.c:1111
NEST_ANY
#define NEST_ANY
Definition dict_tokenize.c:61
dict_read_process_attribute
static int dict_read_process_attribute(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1451
dict_tokenize_frame_t::member_num
int member_num
structure member numbers
Definition dict_tokenize.c:85
dict_filename_add
static int dict_filename_add(char **filename_out, fr_dict_t *dict, char const *filename, char const *src_file, int src_line)
Maintain a linked list of filenames which we've seen loading this dictionary.
Definition dict_tokenize.c:2981
dict_process_type_field
static int dict_process_type_field(dict_tokenize_ctx_t *dctx, char const *name, fr_dict_attr_t **da_p)
Definition dict_tokenize.c:339
dict_read_process_alias
static int dict_read_process_alias(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1374
_dict_from_file
static int _dict_from_file(dict_tokenize_ctx_t *dctx, char const *dir_name, char const *filename, char const *src_file, int src_line)
fr_dict_keyword_parser_t::begin
fr_dict_section_begin_t begin
Can have a BEGIN prefix.
Definition dict_tokenize.c:3080
dict_attr_allow_dup
static int dict_attr_allow_dup(fr_dict_attr_t const *da)
Check if this definition is a duplicate, and if it is, whether we should skip it error out.
Definition dict_tokenize.c:1005
dict_finalise
static int dict_finalise(dict_tokenize_ctx_t *dctx)
Definition dict_tokenize.c:896
dict_read_process_member
static int dict_read_process_member(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2375
fr_dict_alloc
fr_dict_t * fr_dict_alloc(char const *proto_name, unsigned int proto_number)
Definition dict_tokenize.c:3673
dict_flag_ref
static int dict_flag_ref(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:698
dict_flag_precision
static int dict_flag_precision(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:673
dict_read_process_end
static int dict_read_process_end(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2093
dict_tokenize_ctx_s::stack_depth
int stack_depth
points to the last used stack frame
Definition dict_tokenize.c:94
dict_tokenize_frame_t::struct_size
ssize_t struct_size
size of the struct.
Definition dict_tokenize.c:87
dict_tokenize_frame_t::struct_is_closed
fr_dict_attr_t const * struct_is_closed
no more members are allowed
Definition dict_tokenize.c:86
dict_tokenize_ctx_s::filename
char * filename
current filename
Definition dict_tokenize.c:100
fr_dict_keyword_parse_t
int(* fr_dict_keyword_parse_t)(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Keyword parser.
Definition dict_tokenize.c:3058
dict_read_process_vendor
static int dict_read_process_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2754
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:3564
fr_dict_section_begin_t
int(* fr_dict_section_begin_t)(dict_tokenize_ctx_t *dctx)
Pushes a new frame onto the top of the stack based on the current frame.
Definition dict_tokenize.c:3076
fr_dict_str_to_argv
int fr_dict_str_to_argv(char *str, char **argv, int max_argc)
Definition dict_tokenize.c:234
dict_read_sscanf_i
static int dict_read_sscanf_i(unsigned int *pvalue, char const *str)
Definition dict_tokenize.c:271
dict_read_process_define
static int dict_read_process_define(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1969
dict_nest_table_len
static size_t const dict_nest_table_len
Definition dict_tokenize.c:70
dict_read_parse_format
static int dict_read_parse_format(char const *format, int *ptype, int *plength, bool *pcontinuation)
Definition dict_tokenize.c:1303
dict_read_process_begin_vendor
static int dict_read_process_begin_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1830
ASSERT_CURRENT_NEST
#define ASSERT_CURRENT_NEST(_dctx, _nest)
Definition dict_tokenize.c:113
dict_dctx_unwind_until
static dict_tokenize_frame_t const * dict_dctx_unwind_until(dict_tokenize_ctx_t *dctx, dict_nest_t nest)
Unwind the stack until it points to a particular type of stack frame.
Definition dict_tokenize.c:185
dict_from_file
static int dict_from_file(fr_dict_t *dict, char const *dir_name, char const *filename, char const *src_file, int src_line)
Definition dict_tokenize.c:3383
dict_tokenize_frame_t::da
fr_dict_attr_t const * da
the da we care about
Definition dict_tokenize.c:81
dict_tokenize_ctx_s::value_attr
fr_dict_attr_t * value_attr
Cache of last attribute to speed up value processing.
Definition dict_tokenize.c:96
dict_read_process_protocol
static int dict_read_process_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flag)
Register the specified dictionary as a protocol dictionary.
Definition dict_tokenize.c:2810
FLAG_FUNC
#define FLAG_FUNC(_name)
Define a flag setting function, which sets one bit in a fr_dict_attr_flags_t.
Definition dict_tokenize.c:484
CURRENT_LINE
#define CURRENT_LINE(_dctx)
Definition dict_tokenize.c:111
dict_dctx_pop
static dict_tokenize_frame_t const * dict_dctx_pop(dict_tokenize_ctx_t *dctx)
Pop the current stack frame.
Definition dict_tokenize.c:168
dict_tokenize_frame_t::filename
char * filename
name of the file where we read this entry
Definition dict_tokenize.c:79
dict_set_value_attr
static int dict_set_value_attr(dict_tokenize_ctx_t *dctx, fr_dict_attr_t *da)
Definition dict_tokenize.c:1089
dict_read_process_enum
static int dict_read_process_enum(dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2245
dict_tokenize_ctx_s::line
int line
current line
Definition dict_tokenize.c:101
CURRENT_FILENAME
#define CURRENT_FILENAME(_dctx)
Definition dict_tokenize.c:110
dict_struct_finalise
static int dict_struct_finalise(dict_tokenize_ctx_t *dctx)
Definition dict_tokenize.c:1054
dict_flag_offset
static int dict_flag_offset(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:648
dict_read_process_begin_protocol
static int dict_read_process_begin_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1775
dict_flag_key
static int dict_flag_key(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:548
dict_tokenize_ctx_s::dict
fr_dict_t * dict
Protocol dictionary we're inserting attributes into.
Definition dict_tokenize.c:91
dict_begin_protocol
static int dict_begin_protocol(NDEBUG_UNUSED dict_tokenize_ctx_t *dctx)
Process an inline BEGIN PROTOCOL block.
Definition dict_tokenize.c:3034
dict_flag_clone
static int dict_flag_clone(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rules)
Definition dict_tokenize.c:493
dict_tokenize_ctx_s::stack
dict_tokenize_frame_t stack[DICT_MAX_STACK]
stack of attributes to track
Definition dict_tokenize.c:93
dict_tokenize_frame_t::line
int line
line number where we read this entry
Definition dict_tokenize.c:80
dict_filename_loaded
static bool dict_filename_loaded(fr_dict_t *dict, char const *filename, char const *src_file, int src_line)
See if we have already loaded the file,.
Definition dict_tokenize.c:3010
dict_flag_enum
static int dict_flag_enum(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:525
dict_dctx_unwind
static dict_tokenize_frame_t const * dict_dctx_unwind(dict_tokenize_ctx_t *dctx)
Definition dict_tokenize.c:225
CURRENT_DA
#define CURRENT_DA(_dctx)
Definition dict_tokenize.c:109
DICT_MAX_ARGV
#define DICT_MAX_ARGV
Maximum number of arguments.
Definition dict_tokenize.c:39
dict_read_process_value
static int dict_read_process_value(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Process a value alias.
Definition dict_tokenize.c:2624
dict_dctx_find_frame
static dict_tokenize_frame_t const * dict_dctx_find_frame(dict_tokenize_ctx_t *dctx, dict_nest_t nest)
Definition dict_tokenize.c:132
fr_dict_keyword_t::value
fr_dict_keyword_parser_t value
Value to return from lookup.
Definition dict_tokenize.c:3085
dict_flag_length
static int dict_flag_length(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:625
dict_read_process_end_vendor
static int dict_read_process_end_vendor(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2204
fr_dict_read
int fr_dict_read(fr_dict_t *dict, char const *dir, char const *filename)
Read supplementary attribute definitions into an existing dictionary.
Definition dict_tokenize.c:3708
DICT_MAX_STACK
#define DICT_MAX_STACK
Maximum stack size.
Definition dict_tokenize.c:45
fr_dict_parse_str
int fr_dict_parse_str(fr_dict_t *dict, char *buf, fr_dict_attr_t const *parent)
Definition dict_tokenize.c:3730
dict_flag_subtype
static int dict_flag_subtype(fr_dict_attr_t **da_p, char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:732
dict_read_process_begin
static int dict_read_process_begin(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:1720
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:3427
dict_dctx_push
static int dict_dctx_push(dict_tokenize_ctx_t *dctx, fr_dict_attr_t const *da, dict_nest_t nest)
Definition dict_tokenize.c:143
dict_read_process_flags
static int dict_read_process_flags(UNUSED dict_tokenize_ctx_t *dctx, char **argv, int argc, fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2348
dict_attr_add_or_fixup
static int dict_attr_add_or_fixup(dict_fixup_ctx_t *fixup, fr_dict_attr_t **da_p)
Add an attribute to the dictionary, or add it to a list of attributes to clone later.
Definition dict_tokenize.c:922
fr_dict_keyword_finalise_t
int(* fr_dict_keyword_finalise_t)(dict_tokenize_ctx_t *dctx)
Definition dict_tokenize.c:72
CURRENT_FRAME
#define CURRENT_FRAME(_dctx)
Definition dict_tokenize.c:108
dict_attr_location_set
static void dict_attr_location_set(dict_tokenize_ctx_t *dctx, fr_dict_attr_t *da)
Definition dict_tokenize.c:907
dict_tokenize_ctx_s::relative_attr
fr_dict_attr_t const * relative_attr
for ".82" instead of "1.2.3.82". only for parents of type "tlv"
Definition dict_tokenize.c:97
dict_flag_secret
static int dict_flag_secret(fr_dict_attr_t **da_p, UNUSED char const *value, UNUSED fr_dict_flag_parser_rule_t const *rule)
Definition dict_tokenize.c:718
fr_dict_keyword_t::name
fr_table_elem_name_t name
Name of the keyword, e.g. "ATTRIBUTE".
Definition dict_tokenize.c:3084
dict_read_process_end_protocol
static int dict_read_process_end_protocol(dict_tokenize_ctx_t *dctx, char **argv, int argc, UNUSED fr_dict_attr_flags_t *base_flags)
Definition dict_tokenize.c:2147
fr_dict_keyword_parser_t::parse
fr_dict_keyword_parse_t parse
Function to parse the keyword with.
Definition dict_tokenize.c:3079
dict_dctx_debug
void dict_dctx_debug(dict_tokenize_ctx_t *dctx)
Definition dict_tokenize.c:116
dict_nest_t
dict_nest_t
This represents explicit BEGIN/END frames pushed onto the stack.
Definition dict_tokenize.c:52
NEST_TOP
@ NEST_TOP
top of the stack
Definition dict_tokenize.c:54
NEST_VENDOR
@ NEST_VENDOR
BEGIN-VENDOR.
Definition dict_tokenize.c:56
NEST_PROTOCOL
@ NEST_PROTOCOL
BEGIN-PROTOCOL.
Definition dict_tokenize.c:55
NEST_ATTRIBUTE
@ NEST_ATTRIBUTE
BEGIN foo.
Definition dict_tokenize.c:57
NEST_NONE
@ NEST_NONE
Definition dict_tokenize.c:53
dict_root_set
static int dict_root_set(fr_dict_t *dict, char const *name, unsigned int proto_number)
Set a new root dictionary attribute.
Definition dict_tokenize.c:314
dict_tokenize_ctx_s
Definition dict_tokenize.c:90
dict_tokenize_frame_t
Parser context for dict_from_file.
Definition dict_tokenize.c:78
fr_dict_keyword_parser_t
Definition dict_tokenize.c:3078
fr_dict_keyword_t
Definition dict_tokenize.c:3083
fr_dlist_head
static void * fr_dlist_head(fr_dlist_head_t const *list_head)
Return the HEAD item of a list or NULL if the list is empty.
Definition dlist.h:486
fr_dlist_insert_tail
static int fr_dlist_insert_tail(fr_dlist_head_t *list_head, void *ptr)
Insert an item into the tail of a list.
Definition dlist.h:378
fr_dlist_next
static void * fr_dlist_next(fr_dlist_head_t const *list_head, void const *ptr)
Get the next item in a list.
Definition dlist.h:555
fr_globdir_iter_init
int fr_globdir_iter_init(char const **filename, char const *dir, char const *pattern, fr_globdir_iter_t *iter)
Initialize an iterator over filenames.
Definition file.c:694
fr_globdir_iter_next
int fr_globdir_iter_next(char const **filename, fr_globdir_iter_t *iter)
Get the next filename.
Definition file.c:852
fr_cwd_strip
char const * fr_cwd_strip(char const *filename)
Intended to be used in logging functions to make output more readable.
Definition file.c:384
fr_globdir_iter_free
int fr_globdir_iter_free(fr_globdir_iter_t *iter)
Definition file.c:886
fr_globdir_iter_t
Definition file.h:86
talloc_free
talloc_free(reap)
stack_depth
static int stack_depth
Definition radmin.c:157
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_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_MAX
@ FR_TYPE_MAX
Number of defined data types.
Definition merged_model.c:130
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_VALUE_BOX
@ FR_TYPE_VALUE_BOX
A boxed value.
Definition merged_model.c:125
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_BOOL
@ FR_TYPE_BOOL
A truth value.
Definition merged_model.c:95
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
ssize_t
long int ssize_t
Definition merged_model.c:24
uint8_t
unsigned char uint8_t
Definition merged_model.c:30
fr_slen_t
ssize_t fr_slen_t
Definition merged_model.c:35
fr_dict_attr_t
Definition merged_model.c:133
fr_dict_t
Definition merged_model.c:198
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
current
static rc_request_t * current
Definition radclient-ng.c:100
rc_request::name
char const * name
Test name (as specified in the request).
Definition radclient.h:102
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 UINT8_MAX+1], fr_sbuff_term_t const *tt)
Wind position past characters in the allowed set.
Definition sbuff.c:1805
sbuff_char_class_int
bool const sbuff_char_class_int[UINT8_MAX+1]
Definition sbuff.c:68
FR_SBUFF_IN
#define FR_SBUFF_IN(_start, _len_or_end)
FR_SBUFF_IN_STR
#define FR_SBUFF_IN_STR(_start)
snprintf
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
Definition snprintf.c:689
type
fr_aka_sim_id_type_t type
Definition state_machine.c:3654
strlcpy
size_t strlcpy(char *dst, char const *src, size_t siz)
Definition strlcpy.c:34
fr_syserror
char const * fr_syserror(int num)
Guaranteed to be thread-safe version of strerror.
Definition syserror.c:243
fr_table_elem_name_t::str
char const * str
Literal string.
Definition table.h:42
fr_table_value_by_str
#define fr_table_value_by_str(_table, _name, _def)
Convert a string to a value using a sorted or ordered table.
Definition table.h:653
fr_table_str_by_value
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
TABLE_TYPE_NAME_FUNC_RPTR
#define TABLE_TYPE_NAME_FUNC_RPTR(_func, _our_table_type, _our_name, _our_def_type, _our_out_type)
Create a type-specific name-to-value function.
Definition table.h:144
table_sorted_value_by_str
static void const * table_sorted_value_by_str(void const *table, size_t table_len, size_t element_size, char const *name)
Convert a string to a value using a lexicographically sorted table.
Definition table.h:328
fr_table_num_ordered_t::name
fr_table_elem_name_t name
Definition table.h:58
fr_table_elem_name_t
Definition table.h:41
fr_table_num_ordered_t
An element in an arbitrarily ordered array of name to num mappings.
Definition table.h:57
fr_table_num_sorted_t
An element in a lexicographically sorted array of name to num mappings.
Definition table.h:49
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:514
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:467
fr_time_precision_table
fr_table_num_ordered_t const fr_time_precision_table[]
Definition time.c:46
FR_DICTIONARY_FILE
#define FR_DICTIONARY_FILE
Definition conf.h:7
parent
static fr_slen_t parent
Definition pair.h:841
fr_strerror_clear
void fr_strerror_clear(void)
Clears all pending messages from the talloc pools.
Definition strerror.c:576
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_push
#define fr_strerror_const_push(_msg)
Definition strerror.h:227
fr_strerror_const
#define fr_strerror_const(_msg)
Definition strerror.h:223
fr_type_table
fr_table_num_ordered_t const fr_type_table[]
Map data types to names representing those types.
Definition types.c:31
fr_type_table_len
size_t fr_type_table_len
Definition types.c:87
fr_type_is_structural
#define fr_type_is_structural(_x)
Definition types.h:393
FR_TYPE_VALUE_BOX_CURSOR
@ FR_TYPE_VALUE_BOX_CURSOR
cursor over a fr_value_box_t
Definition types.h:89
FR_TYPE_UNION
@ FR_TYPE_UNION
A union of limited children.
Definition types.h:82
FR_TYPE_ATTR
@ FR_TYPE_ATTR
A contains an attribute reference.
Definition types.h:84
FR_TYPE_PAIR_CURSOR
@ FR_TYPE_PAIR_CURSOR
cursor over a fr_pair_t
Definition types.h:91
FR_TYPE_STRUCTURAL
#define FR_TYPE_STRUCTURAL
Definition types.h:317
fr_type_is_null
#define fr_type_is_null(_x)
Definition types.h:348
fr_type_is_tlv
#define fr_type_is_tlv(_x)
Definition types.h:373
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_type_from_str
static fr_type_t fr_type_from_str(char const *type)
Return the constant value representing a type.
Definition types.h:465
FR_TYPE_LEAF
#define FR_TYPE_LEAF
Definition types.h:318
fr_value_box_cast_in_place
int fr_value_box_cast_in_place(TALLOC_CTX *ctx, fr_value_box_t *vb, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv)
Convert one type of fr_value_box_t to another in place.
Definition value.c:3976
fr_value_box_from_str
ssize_t fr_value_box_from_str(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv, char const *in, size_t inlen, fr_sbuff_unescape_rules_t const *erules)
Definition value.c:5780
fr_value_box_clear
void fr_value_box_clear(fr_value_box_t *data)
Clear/free any existing value and metadata.
Definition value.c:4157
FR_VALUE_BOX_INITIALISER_NULL
#define FR_VALUE_BOX_INITIALISER_NULL(_vb)
A static initialiser for stack/globally allocated boxes.
Definition value.h:510
nonnull
int nonnull(2, 5))
fr_value_box_init
#define fr_value_box_init(_vb, _type, _enumv, _tainted)
Initialise a fr_value_box_t.
Definition value.h:609
format
int format(printf, 5, 0))
out
static size_t char ** out
Definition value.h:1023
Generated by   doxygen 1.9.8