2 * dict.c Routines to read the dictionary file.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2000,2006 The FreeRADIUS server project
24 #include <freeradius-devel/libradius.h>
27 #include <freeradius-devel/dhcp.h>
36 #ifdef HAVE_SYS_STAT_H
40 static fr_hash_table_t *vendors_byname = NULL;
41 static fr_hash_table_t *vendors_byvalue = NULL;
43 static fr_hash_table_t *attributes_byname = NULL;
44 static fr_hash_table_t *attributes_byvalue = NULL;
46 static fr_hash_table_t *attributes_combo = NULL;
48 static fr_hash_table_t *values_byvalue = NULL;
49 static fr_hash_table_t *values_byname = NULL;
51 static DICT_ATTR *dict_base_attrs[256];
54 * For faster HUP's, we cache the stat information for
55 * files we've $INCLUDEd
57 typedef struct dict_stat_t {
58 struct dict_stat_t *next;
62 static dict_stat_t *stat_head = NULL;
63 static dict_stat_t *stat_tail = NULL;
65 typedef struct value_fixup_t {
66 char attrstr[DICT_ATTR_MAX_NAME_LEN];
68 struct value_fixup_t *next;
73 * So VALUEs in the dictionary can have forward references.
75 static value_fixup_t *value_fixup = NULL;
77 const FR_NAME_NUMBER dict_attr_types[] = {
78 { "integer", PW_TYPE_INTEGER },
79 { "string", PW_TYPE_STRING },
80 { "ipaddr", PW_TYPE_IPV4_ADDR },
81 { "date", PW_TYPE_DATE },
82 { "abinary", PW_TYPE_ABINARY },
83 { "octets", PW_TYPE_OCTETS },
84 { "ifid", PW_TYPE_IFID },
85 { "ipv6addr", PW_TYPE_IPV6_ADDR },
86 { "ipv6prefix", PW_TYPE_IPV6_PREFIX },
87 { "byte", PW_TYPE_BYTE },
88 { "short", PW_TYPE_SHORT },
89 { "ether", PW_TYPE_ETHERNET },
90 { "combo-ip", PW_TYPE_COMBO_IP_ADDR },
91 { "tlv", PW_TYPE_TLV },
92 { "signed", PW_TYPE_SIGNED },
93 { "extended", PW_TYPE_EXTENDED },
94 { "long-extended", PW_TYPE_LONG_EXTENDED },
95 { "evs", PW_TYPE_EVS },
96 { "uint8", PW_TYPE_BYTE },
97 { "uint16", PW_TYPE_SHORT },
98 { "uint32", PW_TYPE_INTEGER },
99 { "int32", PW_TYPE_SIGNED },
100 { "integer64", PW_TYPE_INTEGER64 },
101 { "uint64", PW_TYPE_INTEGER64 },
102 { "ipv4prefix", PW_TYPE_IPV4_PREFIX },
103 { "cidr", PW_TYPE_IPV4_PREFIX },
104 { "vsa", PW_TYPE_VSA },
109 * Map data types to min / max data sizes.
111 const size_t dict_attr_sizes[PW_TYPE_MAX][2] = {
112 [PW_TYPE_INVALID] = {~0, 0},
113 [PW_TYPE_STRING] = {0, ~0},
114 [PW_TYPE_INTEGER] = {4, 4 },
115 [PW_TYPE_IPV4_ADDR] = {4, 4},
116 [PW_TYPE_DATE] = {4, 4},
117 [PW_TYPE_ABINARY] = {32, ~0},
118 [PW_TYPE_OCTETS] = {0, ~0},
119 [PW_TYPE_IFID] = {8, 8},
120 [PW_TYPE_IPV6_ADDR] = {16, 16},
121 [PW_TYPE_IPV6_PREFIX] = {2, 18},
122 [PW_TYPE_BYTE] = {1, 1},
123 [PW_TYPE_SHORT] = {2, 2},
124 [PW_TYPE_ETHERNET] = {6, 6},
125 [PW_TYPE_SIGNED] = {4, 4},
126 [PW_TYPE_COMBO_IP_ADDR] = {4, 16},
127 [PW_TYPE_TLV] = {2, ~0},
128 [PW_TYPE_EXTENDED] = {2, ~0},
129 [PW_TYPE_LONG_EXTENDED] = {3, ~0},
130 [PW_TYPE_EVS] = {6, ~0},
131 [PW_TYPE_INTEGER64] = {8, 8},
132 [PW_TYPE_IPV4_PREFIX] = {6, 6},
133 [PW_TYPE_VSA] = {4, ~0}
137 * For packing multiple TLV numbers into one 32-bit integer. The
138 * first 3 bytes are just the 8-bit number. The next two are
139 * more limited. We only allow 31 attributes nested 3 layers
140 * deep, and only 7 nested 4 layers deep. This should be
141 * sufficient for most purposes.
143 * For TLVs and extended attributes, we packet the base attribute
144 * number into the upper 8 bits of the "vendor" field.
146 * e.g. OID attribute vendor
147 * 241.1 1 (241 << 24)
148 * 241.26.9.1 1 (241 << 24) | (9)
149 * 241.1.2 1 | (2 << 8) (241 << 24)
151 #define MAX_TLV_NEST (4)
154 * 8 bits of base attribute
155 * 8 bits for nested TLV 1
156 * 8 bits for nested TLV 2
157 * 5 bits for nested TLV 3
158 * 3 bits for nested TLV 4
160 int const fr_attr_max_tlv = MAX_TLV_NEST;
161 int const fr_attr_shift[MAX_TLV_NEST + 1] = { 0, 8, 16, 24, 29 };
163 unsigned const fr_attr_mask[MAX_TLV_NEST + 1] = { 0xff, 0xff, 0xff, 0x1f, 0x07 };
166 * attr & fr_attr_parent_mask[i] == Nth parent of attr
168 static unsigned int const fr_attr_parent_mask[MAX_TLV_NEST + 1] = { 0, 0x000000ff, 0x0000ffff, 0x00ffffff, 0x1fffffff };
171 * Create the hash of the name.
173 * We copy the hash function here because it's substantially faster.
175 #define FNV_MAGIC_INIT (0x811c9dc5)
176 #define FNV_MAGIC_PRIME (0x01000193)
178 static uint32_t dict_hashname(char const *name)
180 uint32_t hash = FNV_MAGIC_INIT;
183 for (p = name; *p != '\0'; p++) {
184 int c = *(unsigned char const *) p;
185 if (isalpha(c)) c = tolower(c);
187 hash *= FNV_MAGIC_PRIME;
188 hash ^= (uint32_t ) (c & 0xff);
196 * Hash callback functions.
198 static uint32_t dict_attr_name_hash(void const *data)
200 return dict_hashname(((DICT_ATTR const *)data)->name);
203 static int dict_attr_name_cmp(void const *one, void const *two)
205 DICT_ATTR const *a = one;
206 DICT_ATTR const *b = two;
208 return strcasecmp(a->name, b->name);
211 static uint32_t dict_attr_value_hash(void const *data)
214 DICT_ATTR const *attr = data;
216 hash = fr_hash(&attr->vendor, sizeof(attr->vendor));
217 return fr_hash_update(&attr->attr, sizeof(attr->attr), hash);
220 static int dict_attr_value_cmp(void const *one, void const *two)
222 DICT_ATTR const *a = one;
223 DICT_ATTR const *b = two;
225 if (a->vendor < b->vendor) return -1;
226 if (a->vendor > b->vendor) return +1;
228 return a->attr - b->attr;
231 static uint32_t dict_attr_combo_hash(void const *data)
234 DICT_ATTR const *attr = data;
236 hash = fr_hash(&attr->vendor, sizeof(attr->vendor));
237 hash = fr_hash_update(&attr->type, sizeof(attr->type), hash);
238 return fr_hash_update(&attr->attr, sizeof(attr->attr), hash);
241 static int dict_attr_combo_cmp(void const *one, void const *two)
243 DICT_ATTR const *a = one;
244 DICT_ATTR const *b = two;
246 if (a->type < b->type) return -1;
247 if (a->type > b->type) return +1;
249 if (a->vendor < b->vendor) return -1;
250 if (a->vendor > b->vendor) return +1;
252 return a->attr - b->attr;
255 static uint32_t dict_vendor_name_hash(void const *data)
257 return dict_hashname(((DICT_VENDOR const *)data)->name);
260 static int dict_vendor_name_cmp(void const *one, void const *two)
262 DICT_VENDOR const *a = one;
263 DICT_VENDOR const *b = two;
265 return strcasecmp(a->name, b->name);
268 static uint32_t dict_vendor_value_hash(void const *data)
270 return fr_hash(&(((DICT_VENDOR const *)data)->vendorpec),
271 sizeof(((DICT_VENDOR const *)data)->vendorpec));
274 static int dict_vendor_value_cmp(void const *one, void const *two)
276 DICT_VENDOR const *a = one;
277 DICT_VENDOR const *b = two;
279 return a->vendorpec - b->vendorpec;
282 static uint32_t dict_value_name_hash(void const *data)
285 DICT_VALUE const *dval = data;
287 hash = dict_hashname(dval->name);
288 hash = fr_hash_update(&dval->vendor, sizeof(dval->vendor), hash);
289 return fr_hash_update(&dval->attr, sizeof(dval->attr), hash);
292 static int dict_value_name_cmp(void const *one, void const *two)
295 DICT_VALUE const *a = one;
296 DICT_VALUE const *b = two;
298 rcode = a->attr - b->attr;
299 if (rcode != 0) return rcode;
301 rcode = a->vendor - b->vendor;
302 if (rcode != 0) return rcode;
304 return strcasecmp(a->name, b->name);
307 static uint32_t dict_value_value_hash(void const *data)
310 DICT_VALUE const *dval = data;
312 hash = fr_hash(&dval->attr, sizeof(dval->attr));
313 hash = fr_hash_update(&dval->vendor, sizeof(dval->vendor), hash);
314 return fr_hash_update(&dval->value, sizeof(dval->value), hash);
317 static int dict_value_value_cmp(void const *one, void const *two)
320 DICT_VALUE const *a = one;
321 DICT_VALUE const *b = two;
323 if (a->vendor < b->vendor) return -1;
324 if (a->vendor > b->vendor) return +1;
326 rcode = a->attr - b->attr;
327 if (rcode != 0) return rcode;
329 return a->value - b->value;
334 * Free the list of stat buffers
336 static void dict_stat_free(void)
338 dict_stat_t *this, *next;
345 for (this = stat_head; this != NULL; this = next) {
350 stat_head = stat_tail = NULL;
355 * Add an entry to the list of stat buffers.
357 static void dict_stat_add(struct stat const *stat_buf)
361 this = malloc(sizeof(*this));
363 memset(this, 0, sizeof(*this));
365 memcpy(&(this->stat_buf), stat_buf, sizeof(this->stat_buf));
368 stat_head = stat_tail = this;
370 stat_tail->next = this;
377 * See if any dictionaries have changed. If not, don't
380 static int dict_stat_check(char const *dir, char const *file)
382 struct stat stat_buf;
387 * Nothing cached, all files are new.
389 if (!stat_head) return 0;
394 snprintf(buffer, sizeof(buffer), "%s/%s", dir, file);
395 if (stat(buffer, &stat_buf) < 0) return 0;
398 * Find the cache entry.
399 * FIXME: use a hash table.
400 * FIXME: check dependencies, via children.
401 * if A loads B and B changes, we probably want
402 * to reload B at the minimum.
404 for (this = stat_head; this != NULL; this = this->next) {
405 if (this->stat_buf.st_dev != stat_buf.st_dev) continue;
406 if (this->stat_buf.st_ino != stat_buf.st_ino) continue;
409 * The file has changed. Re-read it.
411 if (this->stat_buf.st_mtime < stat_buf.st_mtime) return 0;
414 * The file is the same. Ignore it.
425 typedef struct fr_pool_t {
428 struct fr_pool_t *page_free;
429 struct fr_pool_t *page_next;
432 #define FR_POOL_SIZE (32768)
433 #define FR_ALLOC_ALIGN (8)
435 static fr_pool_t *dict_pool = NULL;
437 static fr_pool_t *fr_pool_create(void)
439 fr_pool_t *fp = malloc(FR_POOL_SIZE);
441 if (!fp) return NULL;
443 memset(fp, 0, FR_POOL_SIZE);
445 fp->page_end = ((uint8_t *) fp) + FR_POOL_SIZE;
446 fp->free_ptr = ((uint8_t *) fp) + sizeof(*fp);
448 fp->page_next = NULL;
452 static void fr_pool_delete(fr_pool_t **pfp)
454 fr_pool_t *fp, *next;
456 if (!pfp || !*pfp) return;
458 for (fp = *pfp; fp != NULL; fp = next) {
459 next = fp->page_next;
460 fp->page_next = NULL;
467 static void *fr_pool_alloc(size_t size)
471 if (size == 0) return NULL;
473 if (size > 256) return NULL; /* shouldn't happen */
476 dict_pool = fr_pool_create();
477 if (!dict_pool) return NULL;
480 if ((size & (FR_ALLOC_ALIGN - 1)) != 0) {
481 size += FR_ALLOC_ALIGN - (size & (FR_ALLOC_ALIGN - 1));
484 if ((((uint8_t *) dict_pool->page_free->free_ptr) + size) > (uint8_t *) dict_pool->page_free->page_end) {
485 dict_pool->page_free->page_next = fr_pool_create();
486 if (!dict_pool->page_free->page_next) return NULL;
487 dict_pool->page_free = dict_pool->page_free->page_next;
490 ptr = dict_pool->page_free->free_ptr;
491 dict_pool->page_free->free_ptr = ((uint8_t *) dict_pool->page_free->free_ptr) + size;
497 static void fr_pool_free(UNUSED void *ptr)
500 * Place-holder for later code.
505 * Free the dictionary_attributes and dictionary_values lists.
512 fr_hash_table_free(vendors_byname);
513 fr_hash_table_free(vendors_byvalue);
514 vendors_byname = NULL;
515 vendors_byvalue = NULL;
517 fr_hash_table_free(attributes_byname);
518 fr_hash_table_free(attributes_byvalue);
519 fr_hash_table_free(attributes_combo);
520 attributes_byname = NULL;
521 attributes_byvalue = NULL;
522 attributes_combo = NULL;
524 fr_hash_table_free(values_byname);
525 fr_hash_table_free(values_byvalue);
526 values_byname = NULL;
527 values_byvalue = NULL;
529 memset(dict_base_attrs, 0, sizeof(dict_base_attrs));
531 fr_pool_delete(&dict_pool);
537 * Add vendor to the list.
539 int dict_addvendor(char const *name, unsigned int value)
544 if (value >= FR_MAX_VENDOR) {
545 fr_strerror_printf("dict_addvendor: Cannot handle vendor ID larger than 2^24");
549 if ((length = strlen(name)) >= DICT_VENDOR_MAX_NAME_LEN) {
550 fr_strerror_printf("dict_addvendor: vendor name too long");
554 if ((dv = fr_pool_alloc(sizeof(*dv) + length)) == NULL) {
555 fr_strerror_printf("dict_addvendor: out of memory");
559 strcpy(dv->name, name);
560 dv->vendorpec = value;
561 dv->type = dv->length = 1; /* defaults */
563 if (!fr_hash_table_insert(vendors_byname, dv)) {
566 old_dv = fr_hash_table_finddata(vendors_byname, dv);
568 fr_strerror_printf("dict_addvendor: Failed inserting vendor name %s", name);
571 if (old_dv->vendorpec != dv->vendorpec) {
572 fr_strerror_printf("dict_addvendor: Duplicate vendor name %s", name);
577 * Already inserted. Discard the duplicate entry.
584 * Insert the SAME pointer (not free'd when this table is
585 * deleted), into another table.
587 * We want this behaviour because we want OLD names for
588 * the attributes to be read from the configuration
589 * files, but when we're printing them, (and looking up
590 * by value) we want to use the NEW name.
592 if (!fr_hash_table_replace(vendors_byvalue, dv)) {
593 fr_strerror_printf("dict_addvendor: Failed inserting vendor %s",
601 const int dict_attr_allowed_chars[256] = {
602 /* 0x 0 1 2 3 4 5 6 7 8 9 a b c d e f */
603 /* 0 */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
604 /* 1 */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
605 /* 2 */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1,
606 /* 3 */ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0,
607 /* 4 */ 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
608 /* 5 */ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1,
609 /* 6 */ 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
610 /* 7 */ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0,
611 /* 8 */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
612 /* 9 */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
613 /* a */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
614 /* b */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
615 /* c */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
616 /* d */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
617 /* e */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
618 /* f */ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
624 int dict_valid_name(char const *name)
628 for (p = (uint8_t const *) name; *p != '\0'; p++) {
629 if (!dict_attr_allowed_chars[*p]) {
632 fr_prints(buff, sizeof(buff), (char const *)p, 1, '\'');
633 fr_strerror_printf("Invalid character '%s' in attribute", buff);
635 return -(p - (uint8_t const *)name);
644 * Find the parent of the attr/vendor.
646 static DICT_ATTR const *dict_parent(unsigned int attr, unsigned int vendor)
649 unsigned int base_vendor;
652 * RFC attributes can't be of type "tlv", except for dictionary.rfc6930
655 #ifdef PW_IPV6_6RD_CONFIGURATION
656 if (attr == PW_IPV6_6RD_CONFIGURATION) return NULL;
658 if (((attr & 0xff) == PW_IPV6_6RD_CONFIGURATION) &&
660 return dict_attrbyvalue(PW_IPV6_6RD_CONFIGURATION, 0);
666 base_vendor = vendor & (FR_MAX_VENDOR - 1);
669 * It's a real vendor.
671 if (base_vendor != 0) {
672 DICT_VENDOR const *dv;
674 dv = dict_vendorbyvalue(base_vendor);
675 if (!dv) return NULL;
678 * Only standard format attributes can be of type "tlv",
679 * Except for DHCP. <sigh>
681 if ((vendor != 54) && ((dv->type != 1) || (dv->length != 1))) return NULL;
683 for (i = MAX_TLV_NEST; i > 0; i--) {
686 parent = attr & fr_attr_parent_mask[i];
688 if (parent != attr) return dict_attrbyvalue(parent, vendor); /* not base_vendor */
692 * It was a top-level VSA. There's no parent.
693 * We COULD return the appropriate enclosing VSA
694 * (26, or 241.26, etc.) but that's not what we
701 * It's an extended attribute. Return the base Extended-Attr-X
703 if (attr < 256) return dict_attrbyvalue((vendor / FR_MAX_VENDOR) & 0xff, 0);
706 * Figure out which attribute it is.
708 for (i = MAX_TLV_NEST; i > 0; i--) {
711 parent = attr & fr_attr_parent_mask[i];
712 if (parent != attr) return dict_attrbyvalue(parent, vendor); /* not base_vendor */
719 /** Add an attribute to the dictionary
721 * @return 0 on success -1 on failure.
723 int dict_addattr(char const *name, int attr, unsigned int vendor, PW_TYPE type,
727 DICT_ATTR const *parent;
729 static int max_attr = 0;
731 namelen = strlen(name);
732 if (namelen >= DICT_ATTR_MAX_NAME_LEN) {
733 fr_strerror_printf("dict_addattr: attribute name too long");
737 if (dict_valid_name(name) < 0) return -1;
740 !((type == PW_TYPE_INTEGER) || (type == PW_TYPE_STRING))) {
741 fr_strerror_printf("dict_addattr: Only 'integer' and 'string' attributes can have tags");
746 * Disallow attributes of type zero.
748 if (!attr && !vendor) {
749 fr_strerror_printf("dict_addattr: Attribute 0 is invalid and cannot be used");
754 * If the attr is '-1', that means use a pre-existing
755 * one (if it already exists). If one does NOT already exist,
756 * then create a new attribute, with a non-conflicting value,
760 if (dict_attrbyname(name)) {
761 return 0; /* exists, don't add it again */
766 } else if (vendor == 0) {
770 if (attr > max_attr) {
776 * Check the parent attribute, and set the various flags
777 * based on the parents values. It's OK for the caller
778 * to not set them, as we'll set them. But if the caller
779 * sets them when he's not supposed to set them, that's
782 parent = dict_parent(attr, vendor);
785 * We're still in the same space and the parent isn't a TLV. That's an error.
787 * Otherwise, dict_parent() has taken us from an Extended sub-attribute to
788 * a *the* Extended attribute, whish isn't what we want here.
790 if ((vendor == parent->vendor) && (parent->type != PW_TYPE_TLV)) {
791 fr_strerror_printf("dict_addattr: Attribute %s has parent attribute %s which is not of type 'tlv'",
796 flags.extended |= parent->flags.extended;
797 flags.long_extended |= parent->flags.long_extended;
798 flags.evs |= parent->flags.evs;
802 * Manually extended flags for extended attributes. We
803 * can't expect the caller to know all of the details of the flags.
805 if (vendor >= FR_MAX_VENDOR) {
809 * Trying to manually create an extended
810 * attribute, but the parent extended attribute
811 * doesn't exist? That's an error.
813 da = dict_attrbyvalue(vendor / FR_MAX_VENDOR, 0);
815 fr_strerror_printf("Extended attributes must be defined from the extended space");
819 flags.extended |= da->flags.extended;
820 flags.long_extended |= da->flags.long_extended;
821 flags.evs |= da->flags.evs;
824 * There's still a real vendor. Since it's an
825 * extended attribute, set the EVS flag.
827 if ((vendor & (FR_MAX_VENDOR -1)) != 0) flags.evs = 1;
831 * Additional checks for extended attributes.
833 if (flags.extended || flags.long_extended || flags.evs) {
834 if (vendor && (vendor < FR_MAX_VENDOR)) {
835 fr_strerror_printf("dict_addattr: VSAs cannot use the \"extended\" or \"evs\" attribute formats");
842 || ((flags.encrypt != FLAG_ENCRYPT_NONE) && (flags.encrypt != FLAG_ENCRYPT_TUNNEL_PASSWORD))) {
843 fr_strerror_printf("dict_addattr: The \"extended\" attributes MUST NOT have any flags set");
849 if (!(flags.extended || flags.long_extended)) {
850 fr_strerror_printf("dict_addattr: Attributes of type \"evs\" MUST have a parent of type \"extended\"");
856 * Do various sanity checks.
859 fr_strerror_printf("dict_addattr: ATTRIBUTE has invalid number (less than zero)");
863 if (flags.has_tlv && flags.length) {
864 fr_strerror_printf("TLVs cannot have a fixed length");
868 if (vendor && flags.concat) {
869 fr_strerror_printf("VSAs cannot have the \"concat\" flag set");
873 if (flags.concat && (type != PW_TYPE_OCTETS)) {
874 fr_strerror_printf("The \"concat\" flag can only be set for attributes of type \"octets\"");
878 if (flags.concat && (flags.has_tag || flags.array || flags.is_tlv || flags.has_tlv ||
879 flags.length || flags.evs || flags.extended || flags.long_extended ||
880 (flags.encrypt != FLAG_ENCRYPT_NONE))) {
881 fr_strerror_printf("The \"concat\" flag cannot be used with any other flag");
885 if (flags.length && (type != PW_TYPE_OCTETS)) {
886 fr_strerror_printf("The \"length\" flag can only be set for attributes of type \"octets\"");
890 if (flags.length && (flags.has_tag || flags.array || flags.is_tlv || flags.has_tlv ||
891 flags.concat || flags.evs || flags.extended || flags.long_extended ||
892 (flags.encrypt > FLAG_ENCRYPT_USER_PASSWORD))) {
893 fr_strerror_printf("The \"length\" flag cannot be used with any other flag");
898 * Force "length" for data types of fixed length;
910 case PW_TYPE_IPV4_ADDR:
911 case PW_TYPE_INTEGER:
916 case PW_TYPE_INTEGER64:
920 case PW_TYPE_ETHERNET:
928 case PW_TYPE_IPV6_ADDR:
932 case PW_TYPE_EXTENDED:
933 if ((vendor != 0) || (attr < 241)) {
934 fr_strerror_printf("Attributes of type \"extended\" MUST be "
935 "RFC attributes with value >= 241.");
943 case PW_TYPE_LONG_EXTENDED:
944 if ((vendor != 0) || (attr < 241)) {
945 fr_strerror_printf("Attributes of type \"long-extended\" MUST "
946 "be RFC attributes with value >= 241.");
952 flags.long_extended = 1;
956 if (attr != PW_VENDOR_SPECIFIC) {
957 fr_strerror_printf("Attributes of type \"evs\" MUST have "
958 "attribute code 26.");
970 flags.is_pointer = true;
978 * Stupid hacks for MS-CHAP-MPPE-Keys. The User-Password
979 * encryption method has no provisions for encoding the
980 * length of the data. For User-Password, the data is
981 * (presumably) all printable non-zero data. For
982 * MS-CHAP-MPPE-Keys, the data is binary crap. So... we
983 * MUST specify a length in the dictionary.
985 if ((flags.encrypt == FLAG_ENCRYPT_USER_PASSWORD) && (type != PW_TYPE_STRING)) {
986 if (type != PW_TYPE_OCTETS) {
987 fr_strerror_printf("The \"encrypt=1\" flag cannot be used with non-string data types");
991 if (flags.length == 0) {
992 fr_strerror_printf("The \"encrypt=1\" flag MUST be used with an explicit length for 'octets' data types");
997 if ((vendor & (FR_MAX_VENDOR -1)) != 0) {
999 static DICT_VENDOR *last_vendor = NULL;
1001 if (flags.has_tlv && (flags.encrypt != FLAG_ENCRYPT_NONE)) {
1002 fr_strerror_printf("TLV's cannot be encrypted");
1006 if (flags.is_tlv && flags.has_tag) {
1007 fr_strerror_printf("Sub-TLV's cannot have a tag");
1011 if (flags.has_tlv && flags.has_tag) {
1012 fr_strerror_printf("TLV's cannot have a tag");
1017 * Most ATTRIBUTEs are bunched together by
1018 * VENDOR. We can save a lot of lookups on
1019 * dictionary initialization by caching the last
1023 ((vendor & (FR_MAX_VENDOR - 1)) == last_vendor->vendorpec)) {
1027 * Ignore the high byte (sigh)
1029 dv = dict_vendorbyvalue(vendor & (FR_MAX_VENDOR - 1));
1034 * If the vendor isn't defined, die.
1037 fr_strerror_printf("dict_addattr: Unknown vendor %u",
1038 vendor & (FR_MAX_VENDOR - 1));
1042 if (!attr && dv->type != 1) {
1043 fr_strerror_printf("dict_addattr: Attribute %s cannot have value zero",
1049 * FIXME: Switch over dv->type, and limit things
1052 if ((dv->type == 1) && (attr >= 256) && !flags.is_tlv) {
1053 fr_strerror_printf("dict_addattr: ATTRIBUTE has invalid number (larger than 255)");
1055 } /* else 256..65535 are allowed */
1058 * <sigh> Alvarion, being *again* a horribly
1059 * broken vendor, has re-used the WiMAX format in
1060 * their proprietary vendor space. This re-use
1061 * means that there are *multiple* conflicting
1062 * Alvarion dictionaries.
1064 flags.wimax = dv->flags;
1065 } /* it's a VSA of some kind */
1068 * Create a new attribute for the list
1070 if ((n = fr_pool_alloc(sizeof(*n) + namelen)) == NULL) {
1072 fr_strerror_printf("dict_addattr: out of memory");
1076 memcpy(n->name, name, namelen);
1077 n->name[namelen] = '\0';
1084 * Insert the attribute, only if it's not a duplicate.
1086 if (!fr_hash_table_insert(attributes_byname, n)) {
1090 * If the attribute has identical number, then
1091 * ignore the duplicate.
1093 a = fr_hash_table_finddata(attributes_byname, n);
1094 if (a && (strcasecmp(a->name, n->name) == 0)) {
1095 if (a->attr != n->attr) {
1096 fr_strerror_printf("dict_addattr: Duplicate attribute name %s", name);
1102 * Same name, same vendor, same attr,
1103 * maybe the flags and/or type is
1104 * different. Let the new value
1105 * over-ride the old one.
1110 fr_hash_table_delete(attributes_byvalue, a);
1112 if (!fr_hash_table_replace(attributes_byname, n)) {
1113 fr_strerror_printf("dict_addattr: Internal error storing attribute %s", name);
1120 * Insert the SAME pointer (not free'd when this entry is
1121 * deleted), into another table.
1123 * We want this behaviour because we want OLD names for
1124 * the attributes to be read from the configuration
1125 * files, but when we're printing them, (and looking up
1126 * by value) we want to use the NEW name.
1128 if (!fr_hash_table_replace(attributes_byvalue, n)) {
1129 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s", name);
1134 * Hacks for combo-IP
1136 if (n->type == PW_TYPE_COMBO_IP_ADDR) {
1139 v4 = fr_pool_alloc(sizeof(*v4) + namelen);
1142 v6 = fr_pool_alloc(sizeof(*v6) + namelen);
1145 memcpy(v4, n, sizeof(*v4) + namelen);
1146 v4->type = PW_TYPE_IPV4_ADDR;
1148 memcpy(v6, n, sizeof(*v6) + namelen);
1149 v6->type = PW_TYPE_IPV6_ADDR;
1150 if (!fr_hash_table_replace(attributes_combo, v4)) {
1151 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s - IPv4", name);
1155 if (!fr_hash_table_replace(attributes_combo, v6)) {
1156 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s - IPv6", name);
1161 if (!vendor && (attr > 0) && (attr < 256)) {
1162 dict_base_attrs[attr] = n;
1170 * Add a value for an attribute to the dictionary.
1172 int dict_addvalue(char const *namestr, char const *attrstr, int value)
1175 DICT_ATTR const *da;
1178 static DICT_ATTR const *last_attr = NULL;
1181 fr_strerror_printf("dict_addvalue: empty names are not permitted");
1185 if ((length = strlen(namestr)) >= DICT_VALUE_MAX_NAME_LEN) {
1186 fr_strerror_printf("dict_addvalue: value name too long");
1190 if ((dval = fr_pool_alloc(sizeof(*dval) + length)) == NULL) {
1191 fr_strerror_printf("dict_addvalue: out of memory");
1194 memset(dval, 0, sizeof(*dval));
1196 strcpy(dval->name, namestr);
1197 dval->value = value;
1200 * Most VALUEs are bunched together by ATTRIBUTE. We can
1201 * save a lot of lookups on dictionary initialization by
1202 * caching the last attribute.
1204 if (last_attr && (strcasecmp(attrstr, last_attr->name) == 0)) {
1207 da = dict_attrbyname(attrstr);
1212 * Remember which attribute is associated with this
1213 * value, if possible.
1216 if (da->flags.has_value_alias) {
1217 fr_strerror_printf("dict_addvalue: Cannot add VALUE for ATTRIBUTE \"%s\": It already has a VALUE-ALIAS", attrstr);
1221 dval->attr = da->attr;
1222 dval->vendor = da->vendor;
1225 * Enforce valid values
1227 * Don't worry about fixups...
1233 fr_strerror_printf("dict_addvalue: ATTRIBUTEs of type 'byte' cannot have VALUEs larger than 255");
1238 if (value > 65535) {
1240 fr_strerror_printf("dict_addvalue: ATTRIBUTEs of type 'short' cannot have VALUEs larger than 65535");
1246 * Allow octets for now, because
1247 * of dictionary.cablelabs
1249 case PW_TYPE_OCTETS:
1251 case PW_TYPE_INTEGER:
1254 case PW_TYPE_INTEGER64:
1257 fr_strerror_printf("dict_addvalue: VALUEs cannot be defined for attributes of type '%s'",
1258 fr_int2str(dict_attr_types, da->type, "?Unknown?"));
1262 value_fixup_t *fixup;
1264 fixup = (value_fixup_t *) malloc(sizeof(*fixup));
1267 fr_strerror_printf("dict_addvalue: out of memory");
1270 memset(fixup, 0, sizeof(*fixup));
1272 strlcpy(fixup->attrstr, attrstr, sizeof(fixup->attrstr));
1276 * Insert to the head of the list.
1278 fixup->next = value_fixup;
1279 value_fixup = fixup;
1285 * Add the value into the dictionary.
1289 memcpy(&tmp, &dval, sizeof(tmp));
1291 if (!fr_hash_table_insert(values_byname, tmp)) {
1296 * Suppress duplicates with the same
1297 * name and value. There are lots in
1298 * dictionary.ascend.
1300 old = dict_valbyname(da->attr, da->vendor, namestr);
1301 if (old && (old->value == dval->value)) {
1308 fr_strerror_printf("dict_addvalue: Duplicate value name %s for attribute %s", namestr, attrstr);
1314 * There are multiple VALUE's, keyed by attribute, so we
1315 * take care of that here.
1317 if (!fr_hash_table_replace(values_byvalue, dval)) {
1318 fr_strerror_printf("dict_addvalue: Failed inserting value %s",
1326 static int sscanf_i(char const *str, unsigned int *pvalue)
1330 static char const *tab = "0123456789";
1332 if ((str[0] == '0') &&
1333 ((str[1] == 'x') || (str[1] == 'X'))) {
1334 tab = "0123456789abcdef";
1343 if (*str == '.') break;
1345 c = memchr(tab, tolower((int) *str), base);
1359 * Get the OID based on various pieces of information.
1361 * Remember, the packing format is weird.
1365 * 00VID 000000AA normal VSA for vendor VID
1366 * 00VID AABBCCDD normal VSAs with TLVs
1367 * EE000 000000AA extended attr (241.1)
1368 * EE000 AABBCCDD extended attr with TLVs
1369 * EEVID 000000AA EVS with vendor VID, attr AAA
1370 * EEVID AABBCCDD EVS with TLVs
1372 * <whew>! Are we crazy, or what?
1374 int dict_str2oid(char const *ptr, unsigned int *pvalue, unsigned int *pvendor,
1380 #ifdef WITH_DICT_OID_DEBUG
1381 fprintf(stderr, "PARSING %s tlv_depth %d pvalue %08x pvendor %08x\n", ptr,
1382 tlv_depth, *pvalue, *pvendor);
1385 if (tlv_depth > fr_attr_max_tlv) {
1386 fr_strerror_printf("Too many sub-attributes");
1391 * No vendor, try to do basic parsing.
1393 if (!*pvendor && !*pvalue) {
1395 * Can't call us with a pre-parsed value and no vendor.
1397 if (tlv_depth != 0) {
1398 fr_strerror_printf("Invalid call with wrong TLV depth %d", tlv_depth);
1402 p = strchr(ptr, '.');
1403 if (!sscanf_i(ptr, &attr)) {
1404 fr_strerror_printf("Invalid data '%s' in attribute identifier", ptr);
1409 * Normal attribute with no OID. Return it.
1417 * We have an OID, look up the attribute to see what it is.
1419 if (attr != PW_VENDOR_SPECIFIC) {
1420 DICT_ATTR const *da;
1422 da = dict_attrbyvalue(attr, 0);
1429 * Standard attributes (including internal
1430 * ones) can have TLVs, but only for some
1433 if (!da->flags.extended) {
1434 #ifdef PW_IPV6_6RD_CONFIGURATION
1435 if (attr == PW_IPV6_6RD_CONFIGURATION) {
1442 fr_strerror_printf("Standard attributes cannot use OIDs");
1446 *pvendor = attr * FR_MAX_VENDOR;
1448 } /* and fall through to re-parsing the VSA */
1451 * Look for the attribute number.
1453 if (!sscanf_i(ptr, &attr)) {
1454 fr_strerror_printf("Invalid data '%s' in attribute identifier", ptr);
1458 p = strchr(ptr, '.');
1461 * Handle VSAs. Either in the normal space, or in the extended space.
1463 if (attr == PW_VENDOR_SPECIFIC) {
1470 if (!sscanf_i(ptr, &attr)) {
1471 fr_strerror_printf("Invalid data '%s' in vendor identifier", ptr);
1475 p = strchr(ptr, '.');
1477 fr_strerror_printf("Cannot define VENDOR in an ATTRIBUTE");
1486 } /* fall through to processing an OID with pre-defined *pvendor and *pvalue */
1489 #ifdef WITH_DICT_OID_DEBUG
1490 fprintf(stderr, "KEEP PARSING %s tlv_depth %d pvalue %08x pvendor %08x\n", ptr,
1491 tlv_depth, *pvalue, *pvendor);
1495 * Check the vendor. Only RFC format attributes can have TLVs.
1498 DICT_VENDOR const *dv = NULL;
1500 dv = dict_vendorbyvalue(*pvendor);
1501 if (dv && (dv->type != 1)) {
1502 if (*pvalue || (tlv_depth != 0)) {
1503 fr_strerror_printf("Attribute cannot have TLVs");
1507 if (!sscanf_i(ptr, &attr)) {
1508 fr_strerror_printf("Invalid data '%s' in attribute identifier", ptr);
1512 if ((dv->type < 3) && (attr > (unsigned int) (1 << (8 * dv->type)))) {
1513 fr_strerror_printf("Number '%s' out of allowed range in attribute identifier", ptr);
1521 * DHCP attributes can have TLVs. <sigh>
1523 if (*pvendor == 54) goto dhcp_skip;
1530 * Parse the rest of the TLVs.
1532 while (tlv_depth <= fr_attr_max_tlv) {
1533 #ifdef WITH_DICT_OID_DEBUG
1534 fprintf(stderr, "TLV PARSING %s tlv_depth %d pvalue %08x pvendor %08x\n", ptr,
1535 tlv_depth, *pvalue, *pvendor);
1538 if (!sscanf_i(ptr, &attr)) {
1539 fr_strerror_printf("Invalid data '%s' in attribute identifier", ptr);
1543 if (attr > fr_attr_mask[tlv_depth]) {
1544 fr_strerror_printf("Number '%s' out of allowed range in attribute identifier", ptr);
1548 attr <<= fr_attr_shift[tlv_depth];
1550 #ifdef WITH_DICT_OID_DEBUG
1552 DICT_ATTR const *da;
1554 da = dict_parent(*pvalue | attr, *pvendor);
1556 fprintf(stderr, "STR2OID FAILED PARENT %08x | %08x, %08x\n",
1557 *pvalue, attr, *pvendor);
1558 } else if ((da->attr != *pvalue) || (da->vendor != *pvendor)) {
1559 fprintf(stderr, "STR2OID DISAGREEMENT WITH PARENT %08x, %08x\t%08x, %08x\n",
1560 *pvalue, *pvendor, da->attr, da->vendor);
1570 p = strchr(ptr, '.');
1578 #ifdef WITH_DICT_OID_DEBUG
1579 fprintf(stderr, "RETURNING %08x %08x\n", *pvalue, *pvendor);
1586 * Process the ATTRIBUTE command
1588 static int process_attribute(char const* fn, int const line,
1589 unsigned int block_vendor,
1590 DICT_ATTR const *block_tlv, int tlv_depth,
1591 char **argv, int argc)
1594 unsigned int vendor = 0;
1597 unsigned int length;
1601 if ((argc < 3) || (argc > 4)) {
1602 fr_strerror_printf("dict_init: %s[%d]: invalid ATTRIBUTE line",
1608 * Dictionaries need to have real names, not shitty ones.
1610 if (strncmp(argv[0], "Attr-", 5) == 0) {
1611 fr_strerror_printf("dict_init: %s[%d]: Invalid attribute name",
1616 memset(&flags, 0, sizeof(flags));
1619 * Look for OIDs before doing anything else.
1621 if (strchr(argv[1], '.') != NULL) oid = 1;
1624 DICT_ATTR const *da;
1626 vendor = block_vendor;
1631 value = block_tlv->attr;
1637 if (dict_str2oid(argv[1], &value, &vendor, tlv_depth) < 0) {
1640 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1642 fr_strerror_printf("dict_init: %s[%d]: Invalid attribute identifier: %s", fn, line, buffer);
1645 block_vendor = vendor;
1649 * Set the flags based on the parents flags.
1651 da = dict_parent(value, vendor);
1653 fr_strerror_printf("dict_init: %s[%d]: Parent attribute for %08x,%08x is undefined.", fn, line, value, vendor);
1657 flags.extended = da->flags.extended;
1658 flags.long_extended = da->flags.long_extended;
1659 flags.evs = da->flags.evs;
1660 if (da->flags.has_tlv) flags.is_tlv = 1;
1664 if (strncmp(argv[2], "octets[", 7) != 0) {
1666 * find the type of the attribute.
1668 type = fr_str2int(dict_attr_types, argv[2], -1);
1670 fr_strerror_printf("dict_init: %s[%d]: invalid type \"%s\"",
1676 type = PW_TYPE_OCTETS;
1678 p = strchr(argv[2] + 7, ']');
1680 fr_strerror_printf("dict_init: %s[%d]: Invalid format for octets", fn, line);
1686 if (!sscanf_i(argv[2] + 7, &length)) {
1687 fr_strerror_printf("dict_init: %s[%d]: invalid length", fn, line);
1691 if ((length == 0) || (length > 253)) {
1692 fr_strerror_printf("dict_init: %s[%d]: invalid length", fn, line);
1696 flags.length = length;
1703 char *key, *next, *last;
1708 if (flags.extended) {
1709 fr_strerror_printf("dict_init: %s[%d]: Extended attributes cannot use flags", fn, line);
1715 next = strchr(key, ',');
1716 if (next) *(next++) = '\0';
1719 * Boolean flag, means this is a tagged
1722 if ((strcmp(key, "has_tag") == 0) || (strcmp(key, "has_tag=1") == 0)) {
1726 * Encryption method, defaults to 0 (none).
1727 * Currently valid is just type 2,
1728 * Tunnel-Password style, which can only
1729 * be applied to strings.
1731 } else if (strncmp(key, "encrypt=", 8) == 0) {
1732 flags.encrypt = strtol(key + 8, &last, 0);
1734 fr_strerror_printf("dict_init: %s[%d] invalid option %s",
1739 if ((flags.encrypt == FLAG_ENCRYPT_ASCEND_SECRET) &&
1740 (type != PW_TYPE_STRING)) {
1741 fr_strerror_printf("dict_init: %s[%d] Only \"string\" types can have the "
1742 "\"encrypt=3\" flag set", fn, line);
1746 } else if (strncmp(key, "array", 6) == 0) {
1750 case PW_TYPE_IPV4_ADDR:
1751 case PW_TYPE_IPV6_ADDR:
1754 case PW_TYPE_INTEGER:
1756 case PW_TYPE_STRING:
1760 fr_strerror_printf("dict_init: %s[%d] \"%s\" type cannot have the "
1761 "\"array\" flag set",
1763 fr_int2str(dict_attr_types, type, "<UNKNOWN>"));
1767 } else if (strncmp(key, "concat", 7) == 0) {
1770 if (type != PW_TYPE_OCTETS) {
1771 fr_strerror_printf("dict_init: %s[%d] Only \"octets\" type can have the "
1772 "\"concat\" flag set", fn, line);
1776 } else if (strncmp(key, "virtual", 8) == 0) {
1780 fr_strerror_printf("dict_init: %s[%d] VSAs cannot have the \"virtual\" "
1781 "flag set", fn, line);
1786 fr_strerror_printf("dict_init: %s[%d] Standard attributes cannot "
1787 "have the \"virtual\" flag set", fn, line);
1792 * The only thing is the vendor name,
1793 * and it's a known name: allow it.
1795 } else if ((key == argv[3]) && !next) {
1797 fr_strerror_printf("dict_init: %s[%d] New-style attributes cannot use "
1798 "a vendor flag", fn, line);
1803 fr_strerror_printf("dict_init: %s[%d] Vendor flag inside of \"BEGIN-VENDOR\" "
1804 "is not allowed", fn, line);
1808 vendor = dict_vendorbyname(key);
1809 if (!vendor) goto unknown;
1814 fr_strerror_printf("dict_init: %s[%d]: unknown option \"%s\"", fn, line, key);
1819 if (key && !*key) break;
1823 if (block_vendor) vendor = block_vendor;
1826 * Special checks for tags, they make our life much more
1829 if (flags.has_tag) {
1831 * Only string, octets, and integer can be tagged.
1834 case PW_TYPE_STRING:
1835 case PW_TYPE_INTEGER:
1839 fr_strerror_printf("dict_init: %s[%d]: Attributes of type %s cannot be tagged.",
1841 fr_int2str(dict_attr_types, type, "?Unknown?"));
1846 if (type == PW_TYPE_TLV) {
1847 if (vendor && (vendor < FR_MAX_VENDOR)
1849 && (vendor != DHCP_MAGIC_VENDOR)
1854 dv = dict_vendorbyvalue(vendor);
1855 if (!dv || (dv->type != 1) || (dv->length != 1)) {
1856 fr_strerror_printf("dict_init: %s[%d]: Type \"tlv\" can only be for \"format=1,1\".",
1867 * TLV's can be only one octet.
1869 if ((value == 0) || ((value & ~fr_attr_mask[tlv_depth]) != 0)) {
1870 fr_strerror_printf( "dict_init: %s[%d]: sub-tlv has invalid attribute number",
1876 * Shift the value left.
1878 value <<= fr_attr_shift[tlv_depth];
1879 value |= block_tlv->attr;
1883 #ifdef WITH_DICTIONARY_WARNINGS
1885 * Hack to help us discover which vendors have illegal
1888 if (!vendor && (value < 256) &&
1889 !strstr(fn, "rfc") && !strstr(fn, "illegal")) {
1890 fprintf(stderr, "WARNING: Illegal Attribute %s in %s\n",
1898 if (dict_addattr(argv[0], value, vendor, type, flags) < 0) {
1901 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1903 fr_strerror_printf("dict_init: %s[%d]: %s",
1913 * Process the VALUE command
1915 static int process_value(char const* fn, int const line, char **argv,
1921 fr_strerror_printf("dict_init: %s[%d]: invalid VALUE line",
1926 * For Compatibility, skip "Server-Config"
1928 if (strcasecmp(argv[0], "Server-Config") == 0)
1932 * Validate all entries
1934 if (!sscanf_i(argv[2], &value)) {
1935 fr_strerror_printf("dict_init: %s[%d]: invalid value",
1940 if (dict_addvalue(argv[1], argv[0], value) < 0) {
1943 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1945 fr_strerror_printf("dict_init: %s[%d]: %s",
1955 * Process the VALUE-ALIAS command
1957 * This allows VALUE mappings to be shared among multiple
1960 static int process_value_alias(char const* fn, int const line, char **argv,
1963 DICT_ATTR const *my_da, *da;
1967 fr_strerror_printf("dict_init: %s[%d]: invalid VALUE-ALIAS line",
1972 my_da = dict_attrbyname(argv[0]);
1974 fr_strerror_printf("dict_init: %s[%d]: ATTRIBUTE \"%s\" does not exist",
1979 if (my_da->flags.has_value_alias) {
1980 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" with pre-existing VALUE-ALIAS",
1985 da = dict_attrbyname(argv[1]);
1987 fr_strerror_printf("dict_init: %s[%d]: Cannot find ATTRIBUTE \"%s\" for alias",
1992 if (da->flags.has_value_alias) {
1993 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" which itself has a VALUE-ALIAS",
1998 if (my_da->type != da->type) {
1999 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS between attributes of differing type",
2004 if ((dval = fr_pool_alloc(sizeof(*dval))) == NULL) {
2005 fr_strerror_printf("dict_addvalue: out of memory");
2009 dval->name[0] = '\0'; /* empty name */
2010 dval->attr = my_da->attr;
2011 dval->vendor = my_da->vendor;
2012 dval->value = da->attr;
2014 if (!fr_hash_table_insert(values_byname, dval)) {
2015 fr_strerror_printf("dict_init: %s[%d]: Error create alias",
2025 static int parse_format(char const *fn, int line, char const *format, int *pvalue, int *ptype, int *plength, bool *pcontinuation)
2029 bool continuation = false;
2031 if (strncasecmp(format, "format=", 7) != 0) {
2032 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected \"format=\", got \"%s\"",
2038 if ((strlen(p) < 3) ||
2039 !isdigit((int) p[0]) ||
2041 !isdigit((int) p[2]) ||
2042 (p[3] && (p[3] != ','))) {
2043 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
2048 type = (int) (p[0] - '0');
2049 length = (int) (p[2] - '0');
2051 if ((type != 1) && (type != 2) && (type != 4)) {
2052 fr_strerror_printf("dict_init: %s[%d]: invalid type value %d for VENDOR",
2057 if ((length != 0) && (length != 1) && (length != 2)) {
2058 fr_strerror_printf("dict_init: %s[%d]: invalid length value %d for VENDOR",
2065 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
2070 if ((p[4] != 'c') ||
2072 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
2076 continuation = true;
2078 if ((*pvalue != VENDORPEC_WIMAX) ||
2079 (type != 1) || (length != 1)) {
2080 fr_strerror_printf("dict_init: %s[%d]: Only WiMAX VSAs can have continuations",
2088 *pcontinuation = continuation;
2094 * Process the VENDOR command
2096 static int process_vendor(char const* fn, int const line, char **argv,
2101 bool continuation = false;
2104 if ((argc < 2) || (argc > 3)) {
2105 fr_strerror_printf( "dict_init: %s[%d] invalid VENDOR entry",
2111 * Validate all entries
2113 if (!isdigit((int) argv[1][0])) {
2114 fr_strerror_printf("dict_init: %s[%d]: invalid value",
2118 value = atoi(argv[1]);
2120 /* Create a new VENDOR entry for the list */
2121 if (dict_addvendor(argv[0], value) < 0) {
2124 strlcpy(buffer, fr_strerror(), sizeof(buffer));
2126 fr_strerror_printf("dict_init: %s[%d]: %s",
2132 * Look for a format statement. Allow it to over-ride the hard-coded formats below.
2135 if (parse_format(fn, line, argv[2], &value, &type, &length, &continuation) < 0) {
2139 } else if (value == VENDORPEC_USR) { /* catch dictionary screw-ups */
2143 } else if (value == VENDORPEC_LUCENT) {
2147 } else if (value == VENDORPEC_STARENT) {
2155 dv = dict_vendorbyvalue(value);
2157 fr_strerror_printf("dict_init: %s[%d]: Failed adding format for VENDOR",
2163 dv->length = length;
2164 dv->flags = continuation;
2170 * String split routine. Splits an input string IN PLACE
2171 * into pieces, based on spaces.
2173 int str2argv(char *str, char **argv, int max_argc)
2178 if (argc >= max_argc) break;
2181 * Chop out comments early.
2188 while ((*str == ' ') ||
2191 (*str == '\n')) *(str++) = '\0';
2202 (*str != '\n')) str++;
2208 static int my_dict_init(char const *parent, char const *filename,
2209 char const *src_file, int src_line);
2211 int dict_read(char const *dir, char const *filename)
2213 if (!attributes_byname) {
2214 fr_strerror_printf("Must call dict_init() before dict_read()");
2218 return my_dict_init(dir, filename, NULL, 0);
2222 #define MAX_ARGV (16)
2225 * Initialize the dictionary.
2227 static int my_dict_init(char const *parent, char const *filename,
2228 char const *src_file, int src_line)
2231 char dir[256], fn[256];
2235 unsigned int vendor;
2236 unsigned int block_vendor;
2237 struct stat statbuf;
2238 char *argv[MAX_ARGV];
2240 DICT_ATTR const *da, *block_tlv[MAX_TLV_NEST + 1];
2241 int which_block_tlv = 0;
2243 block_tlv[0] = NULL;
2244 block_tlv[1] = NULL;
2245 block_tlv[2] = NULL;
2246 block_tlv[3] = NULL;
2248 if ((strlen(parent) + 3 + strlen(filename)) > sizeof(dir)) {
2249 fr_strerror_printf("dict_init: filename name too long");
2254 * If it's an absolute dir, forget the parent dir,
2255 * and remember the new one.
2257 * If it's a relative dir, tack on the current filename
2258 * to the parent dir. And use that.
2260 if (!FR_DIR_IS_RELATIVE(filename)) {
2261 strlcpy(dir, filename, sizeof(dir));
2262 p = strrchr(dir, FR_DIR_SEP);
2266 strlcat(dir, "/", sizeof(dir));
2269 strlcpy(fn, filename, sizeof(fn));
2271 strlcpy(dir, parent, sizeof(dir));
2272 p = strrchr(dir, FR_DIR_SEP);
2274 if (p[1]) strlcat(dir, "/", sizeof(dir));
2276 strlcat(dir, "/", sizeof(dir));
2278 strlcat(dir, filename, sizeof(dir));
2279 p = strrchr(dir, FR_DIR_SEP);
2283 strlcat(dir, "/", sizeof(dir));
2286 p = strrchr(filename, FR_DIR_SEP);
2288 snprintf(fn, sizeof(fn), "%s%s", dir, p);
2290 snprintf(fn, sizeof(fn), "%s%s", dir, filename);
2296 * Check if we've loaded this file before. If so, ignore it.
2298 p = strrchr(fn, FR_DIR_SEP);
2301 if (dict_stat_check(fn, p + 1)) {
2308 if ((fp = fopen(fn, "r")) == NULL) {
2310 fr_strerror_printf("dict_init: Couldn't open dictionary \"%s\": %s",
2311 fn, fr_syserror(errno));
2313 fr_strerror_printf("dict_init: %s[%d]: Couldn't open dictionary \"%s\": %s",
2314 src_file, src_line, fn, fr_syserror(errno));
2319 stat(fn, &statbuf); /* fopen() guarantees this will succeed */
2320 if (!S_ISREG(statbuf.st_mode)) {
2322 fr_strerror_printf("dict_init: Dictionary \"%s\" is not a regular file",
2328 * Globally writable dictionaries means that users can control
2329 * the server configuration with little difficulty.
2332 if ((statbuf.st_mode & S_IWOTH) != 0) {
2334 fr_strerror_printf("dict_init: Dictionary \"%s\" is globally writable. Refusing to start due to insecure configuration.",
2340 dict_stat_add(&statbuf);
2343 * Seed the random pool with data.
2345 fr_rand_seed(&statbuf, sizeof(statbuf));
2349 while (fgets(buf, sizeof(buf), fp) != NULL) {
2351 if (buf[0] == '#' || buf[0] == 0 ||
2352 buf[0] == '\n' || buf[0] == '\r')
2356 * Comment characters should NOT be appearing anywhere but
2357 * as start of a comment;
2359 p = strchr(buf, '#');
2362 argc = str2argv(buf, argv, MAX_ARGV);
2363 if (argc == 0) continue;
2366 fr_strerror_printf( "dict_init: %s[%d] invalid entry",
2373 * Process VALUE lines.
2375 if (strcasecmp(argv[0], "VALUE") == 0) {
2376 if (process_value(fn, line,
2377 argv + 1, argc - 1) == -1) {
2385 * Perhaps this is an attribute.
2387 if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
2388 if (process_attribute(fn, line, block_vendor,
2389 block_tlv[which_block_tlv],
2391 argv + 1, argc - 1) == -1) {
2399 * See if we need to import another dictionary.
2401 if (strcasecmp(argv[0], "$INCLUDE") == 0) {
2402 if (my_dict_init(dir, argv[1], fn, line) < 0) {
2410 * Optionally include a dictionary
2412 if (strcasecmp(argv[0], "$INCLUDE-") == 0) {
2413 int rcode = my_dict_init(dir, argv[1], fn, line);
2415 if (rcode == -2) continue;
2424 if (strcasecmp(argv[0], "VALUE-ALIAS") == 0) {
2425 if (process_value_alias(fn, line,
2426 argv + 1, argc - 1) == -1) {
2434 * Process VENDOR lines.
2436 if (strcasecmp(argv[0], "VENDOR") == 0) {
2437 if (process_vendor(fn, line,
2438 argv + 1, argc - 1) == -1) {
2445 if (strcasecmp(argv[0], "BEGIN-TLV") == 0) {
2448 "dict_init: %s[%d] invalid BEGIN-TLV entry",
2454 da = dict_attrbyname(argv[1]);
2457 "dict_init: %s[%d]: unknown attribute %s",
2463 if (da->type != PW_TYPE_TLV) {
2465 "dict_init: %s[%d]: attribute %s is not of type tlv",
2471 if (which_block_tlv >= MAX_TLV_NEST) {
2473 "dict_init: %s[%d]: TLVs are nested too deep",
2480 block_tlv[++which_block_tlv] = da;
2484 if (strcasecmp(argv[0], "END-TLV") == 0) {
2487 "dict_init: %s[%d] invalid END-TLV entry",
2493 da = dict_attrbyname(argv[1]);
2496 "dict_init: %s[%d]: unknown attribute %s",
2502 if (da != block_tlv[which_block_tlv]) {
2504 "dict_init: %s[%d]: END-TLV %s does not match any previous BEGIN-TLV",
2509 block_tlv[which_block_tlv--] = NULL;
2513 if (strcasecmp(argv[0], "BEGIN-VENDOR") == 0) {
2516 "dict_init: %s[%d] invalid BEGIN-VENDOR entry",
2522 vendor = dict_vendorbyname(argv[1]);
2525 "dict_init: %s[%d]: unknown vendor %s",
2531 block_vendor = vendor;
2534 * Check for extended attr VSAs
2536 * BEGIN-VENDOR foo format=Foo-Encapsulation-Attr
2539 if (strncmp(argv[2], "format=", 7) != 0) {
2541 "dict_init: %s[%d]: Invalid format %s",
2548 da = dict_attrbyname(p);
2550 fr_strerror_printf("dict_init: %s[%d]: Invalid format for BEGIN-VENDOR: unknown attribute \"%s\"",
2556 if (!da->flags.evs) {
2557 fr_strerror_printf("dict_init: %s[%d]: Invalid format for BEGIN-VENDOR. Attribute \"%s\" is not of \"evs\" data type",
2564 * Pack the encapsulating
2565 * attribute into the upper 8
2566 * bits of the vendor ID
2568 block_vendor |= da->vendor;
2572 } /* BEGIN-VENDOR */
2574 if (strcasecmp(argv[0], "END-VENDOR") == 0) {
2577 "dict_init: %s[%d] invalid END-VENDOR entry",
2583 vendor = dict_vendorbyname(argv[1]);
2586 "dict_init: %s[%d]: unknown vendor %s",
2592 if (vendor != (block_vendor & (FR_MAX_VENDOR - 1))) {
2594 "dict_init: %s[%d]: END-VENDOR %s does not match any previous BEGIN-VENDOR",
2604 * Any other string: We don't recognize it.
2606 fr_strerror_printf("dict_init: %s[%d] invalid keyword \"%s\"",
2617 * Empty callback for hash table initialization.
2619 static int null_callback(UNUSED void *ctx, UNUSED void *data)
2626 * Initialize the directory, then fix the attr member of
2629 int dict_init(char const *dir, char const *fn)
2632 * Check if we need to change anything. If not, don't do
2635 if (dict_stat_check(dir, fn)) {
2640 * Free the dictionaries, and the stat cache.
2645 * Create the table of vendor by name. There MAY NOT
2646 * be multiple vendors of the same name.
2648 * Each vendor is malloc'd, so the free function is free.
2650 vendors_byname = fr_hash_table_create(dict_vendor_name_hash,
2651 dict_vendor_name_cmp,
2653 if (!vendors_byname) {
2658 * Create the table of vendors by value. There MAY
2659 * be vendors of the same value. If there are, we
2660 * pick the latest one.
2662 vendors_byvalue = fr_hash_table_create(dict_vendor_value_hash,
2663 dict_vendor_value_cmp,
2665 if (!vendors_byvalue) {
2670 * Create the table of attributes by name. There MAY NOT
2671 * be multiple attributes of the same name.
2673 * Each attribute is malloc'd, so the free function is free.
2675 attributes_byname = fr_hash_table_create(dict_attr_name_hash,
2678 if (!attributes_byname) {
2683 * Create the table of attributes by value. There MAY
2684 * be attributes of the same value. If there are, we
2685 * pick the latest one.
2687 attributes_byvalue = fr_hash_table_create(dict_attr_value_hash,
2688 dict_attr_value_cmp,
2690 if (!attributes_byvalue) {
2695 * Horrible hacks for combo-IP.
2697 attributes_combo = fr_hash_table_create(dict_attr_combo_hash,
2698 dict_attr_combo_cmp,
2700 if (!attributes_combo) {
2704 values_byname = fr_hash_table_create(dict_value_name_hash,
2705 dict_value_name_cmp,
2707 if (!values_byname) {
2711 values_byvalue = fr_hash_table_create(dict_value_value_hash,
2712 dict_value_value_cmp,
2714 if (!values_byvalue) {
2718 value_fixup = NULL; /* just to be safe. */
2720 if (my_dict_init(dir, fn, NULL, 0) < 0)
2725 value_fixup_t *this, *next;
2727 for (this = value_fixup; this != NULL; this = next) {
2730 a = dict_attrbyname(this->attrstr);
2733 "dict_init: No ATTRIBUTE \"%s\" defined for VALUE \"%s\"",
2734 this->attrstr, this->dval->name);
2735 return -1; /* leak, but they should die... */
2738 this->dval->attr = a->attr;
2741 * Add the value into the dictionary.
2743 if (!fr_hash_table_replace(values_byname,
2745 fr_strerror_printf("dict_addvalue: Duplicate value name %s for attribute %s", this->dval->name, a->name);
2750 * Allow them to use the old name, but
2751 * prefer the new name when printing
2754 if (!fr_hash_table_finddata(values_byvalue, this->dval)) {
2755 fr_hash_table_replace(values_byvalue,
2761 * Just so we don't lose track of things.
2768 * Walk over all of the hash tables to ensure they're
2769 * initialized. We do this because the threads may perform
2770 * lookups, and we don't want multi-threaded re-ordering
2771 * of the table entries. That would be bad.
2773 fr_hash_table_walk(vendors_byname, null_callback, NULL);
2774 fr_hash_table_walk(vendors_byvalue, null_callback, NULL);
2776 fr_hash_table_walk(attributes_byname, null_callback, NULL);
2777 fr_hash_table_walk(attributes_byvalue, null_callback, NULL);
2779 fr_hash_table_walk(values_byvalue, null_callback, NULL);
2780 fr_hash_table_walk(values_byname, null_callback, NULL);
2785 static size_t print_attr_oid(char *buffer, size_t size, unsigned int attr,
2795 len = snprintf(buffer, size, "%u", attr & 0xff);
2799 return snprintf(buffer, size, "%u", attr);
2802 return snprintf(buffer, size, "%u", attr & 0xffff);
2806 if ((attr >> 8) == 0) return len;
2812 for (nest = 1; nest <= fr_attr_max_tlv; nest++) {
2813 if (((attr >> fr_attr_shift[nest]) & fr_attr_mask[nest]) == 0) break;
2815 len = snprintf(buffer, size, ".%u",
2816 (attr >> fr_attr_shift[nest]) & fr_attr_mask[nest]);
2826 /** Free dynamically allocated (unknown attributes)
2828 * If the da was dynamically allocated it will be freed, else the function
2829 * will return without doing anything.
2831 * @param da to free.
2833 void dict_attr_free(DICT_ATTR const **da)
2837 if (!da || !*da) return;
2839 /* Don't free real DAs */
2840 if (!(*da)->flags.is_unknown) {
2844 memcpy(&tmp, &da, sizeof(*tmp));
2851 /** Initialises a dictionary attr for unknown attributes
2853 * Initialises a dict attr for an unknown attribute/vendor/type without adding
2854 * it to dictionary pools/hashes.
2856 * @param[in,out] da struct to initialise, must be at least DICT_ATTR_SIZE bytes.
2857 * @param[in] attr number.
2858 * @param[in] vendor number.
2859 * @return 0 on success.
2861 int dict_unknown_from_fields(DICT_ATTR *da, unsigned int attr, unsigned int vendor)
2866 size_t bufsize = DICT_ATTR_MAX_NAME_LEN;
2868 memset(da, 0, DICT_ATTR_SIZE);
2871 da->vendor = vendor;
2872 da->type = PW_TYPE_OCTETS;
2873 da->flags.is_unknown = true;
2874 da->flags.is_pointer = true;
2877 * Unknown attributes of the "WiMAX" vendor get marked up
2878 * as being for WiMAX.
2880 if (vendor == VENDORPEC_WIMAX) {
2881 da->flags.wimax = 1;
2886 len = snprintf(p, bufsize, "Attr-");
2890 if (vendor > FR_MAX_VENDOR) {
2891 len = snprintf(p, bufsize, "%u.", vendor / FR_MAX_VENDOR);
2894 vendor &= (FR_MAX_VENDOR) - 1;
2901 * dv_type is the length of the vendor's type field
2902 * RFC 2865 never defined a mandatory length, so
2903 * different vendors have different length type fields.
2905 dv = dict_vendorbyvalue(vendor);
2909 len = snprintf(p, bufsize, "26.%u.", vendor);
2915 print_attr_oid(p, bufsize , attr, dv_type);
2920 /** Allocs a dictionary attr for unknown attributes
2922 * Allocs a dict attr for an unknown attribute/vendor/type without adding
2923 * it to dictionary pools/hashes.
2925 * @param[in] ctx to allocate DA in.
2926 * @param[in] attr number.
2927 * @param[in] vendor number.
2928 * @return 0 on success.
2930 DICT_ATTR const *dict_unknown_afrom_fields(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor)
2935 p = talloc_zero_array(ctx, uint8_t, DICT_ATTR_SIZE);
2937 fr_strerror_printf("Out of memory");
2940 da = (DICT_ATTR *) p;
2941 talloc_set_type(da, DICT_ATTR);
2943 if (dict_unknown_from_fields(da, attr, vendor) < 0) {
2951 /** Create a DICT_ATTR from an ASCII attribute and value
2953 * Where the attribute name is in the form:
2955 * - Attr-%d.%d.%d...
2956 * - Vendor-%d-Attr-%d
2957 * - VendorName-Attr-%d
2959 * @param[in] da to initialise.
2960 * @param[in] name of attribute.
2961 * @return 0 on success -1 on failure.
2963 int dict_unknown_from_str(DICT_ATTR *da, char const *name)
2965 unsigned int attr = 0, vendor = 0;
2967 char const *p = name;
2970 if (dict_valid_name(name) < 0) return -1;
2973 * Pull off vendor prefix first.
2975 if (strncasecmp(p, "Attr-", 5) != 0) {
2976 if (strncasecmp(p, "Vendor-", 7) == 0) {
2977 vendor = (int) strtol(p + 7, &q, 10);
2978 if ((vendor == 0) || (vendor > FR_MAX_VENDOR)) {
2979 fr_strerror_printf("Invalid vendor value in attribute name \"%s\"", name);
2986 /* must be vendor name */
2993 fr_strerror_printf("Invalid vendor name in attribute name \"%s\"", name);
2997 if ((size_t) (q - p) >= sizeof(buffer)) {
2998 fr_strerror_printf("Vendor name too long in attribute name \"%s\"", name);
3003 memcpy(buffer, p, (q - p));
3004 buffer[q - p] = '\0';
3006 vendor = dict_vendorbyname(buffer);
3008 fr_strerror_printf("Unknown name \"%s\"", name);
3017 fr_strerror_printf("Invalid text following vendor definition in attribute name \"%s\"", name);
3027 if (strncasecmp(p, "Attr-", 5) != 0) {
3028 fr_strerror_printf("Unknown attribute \"%s\"", name);
3034 * Parse the OID, with a (possibly) pre-defined vendor.
3036 if (dict_str2oid(p + 5, &attr, &vendor, 0) < 0) {
3040 return dict_unknown_from_fields(da, attr, vendor);
3043 /** Create a DICT_ATTR from an ASCII attribute and value
3045 * Where the attribute name is in the form:
3047 * - Attr-%d.%d.%d...
3048 * - Vendor-%d-Attr-%d
3049 * - VendorName-Attr-%d
3051 * @param[in] ctx to alloc new attribute in.
3052 * @param[in] name of attribute.
3053 * @return 0 on success -1 on failure.
3055 DICT_ATTR const *dict_unknown_afrom_str(TALLOC_CTX *ctx, char const *name)
3060 p = talloc_zero_array(ctx, uint8_t, DICT_ATTR_SIZE);
3062 fr_strerror_printf("Out of memory");
3065 da = (DICT_ATTR *) p;
3066 talloc_set_type(da, DICT_ATTR);
3068 if (dict_unknown_from_str(da, name) < 0) {
3076 /** Create a dictionary attribute by name embedded in another string
3078 * Find the first invalid attribute name char in the string pointed
3081 * Copy the characters between the start of the name string and the first
3082 * none dict_attr_allowed_char to a buffer and initialise da as an
3083 * unknown attribute.
3085 * @param[out] da to initialise.
3086 * @param[in,out] name string start.
3087 * @return 0 on success or -1 on error;
3089 int dict_unknown_from_substr(DICT_ATTR *da, char const **name)
3093 char buffer[DICT_ATTR_MAX_NAME_LEN + 1];
3095 if (!name || !*name) return -1;
3098 * Advance p until we get something that's not part of
3099 * the dictionary attribute name.
3101 for (p = *name; dict_attr_allowed_chars[(int) *p] || (*p == '.' ) || (*p == '-'); p++);
3104 if (len > DICT_ATTR_MAX_NAME_LEN) {
3105 fr_strerror_printf("Attribute name too long");
3110 fr_strerror_printf("Invalid attribute name");
3113 strlcpy(buffer, *name, len + 1);
3115 if (dict_unknown_from_str(da, buffer) < 0) return -1;
3123 * Get an attribute by its numerical value.
3125 DICT_ATTR const *dict_attrbyvalue(unsigned int attr, unsigned int vendor)
3129 if ((attr > 0) && (attr < 256) && !vendor) return dict_base_attrs[attr];
3134 return fr_hash_table_finddata(attributes_byvalue, &da);
3138 /** Get an attribute by its numerical value and data type
3140 * Used only for COMBO_IP
3142 * @return The attribute, or NULL if not found
3144 DICT_ATTR const *dict_attrbytype(unsigned int attr, unsigned int vendor,
3153 return fr_hash_table_finddata(attributes_combo, &da);
3156 /** Using a parent and attr/vendor, find a child attr/vendor
3159 int dict_attr_child(DICT_ATTR const *parent,
3160 unsigned int *pattr, unsigned int *pvendor)
3162 unsigned int attr, vendor;
3165 if (!parent || !pattr || !pvendor) return false;
3171 * Only some types can have children
3173 switch (parent->type) {
3174 default: return false;
3179 case PW_TYPE_EXTENDED:
3180 case PW_TYPE_LONG_EXTENDED:
3184 if ((vendor == 0) && (parent->vendor != 0)) return false;
3187 * Bootstrap by starting off with the parents values.
3189 da.attr = parent->attr;
3190 da.vendor = parent->vendor;
3193 * Do various butchery to insert the "attr" value.
3195 * 00VID 000000AA normal VSA for vendor VID
3196 * 00VID DDCCBBAA normal VSAs with TLVs
3197 * EE000 000000AA extended attr (241.1)
3198 * EE000 DDCCBBAA extended attr with TLVs
3199 * EEVID 000000AA EVS with vendor VID, attr AAA
3200 * EEVID DDCCBBAA EVS with TLVs
3203 da.vendor = parent->attr * FR_MAX_VENDOR;
3204 da.vendor |= vendor;
3211 * Trying to nest too deep. It's an error
3213 if (parent->attr & (fr_attr_mask[MAX_TLV_NEST] << fr_attr_shift[MAX_TLV_NEST])) {
3217 for (i = MAX_TLV_NEST - 1; i >= 0; i--) {
3218 if ((parent->attr & (fr_attr_mask[i] << fr_attr_shift[i]))) {
3219 da.attr |= (attr & fr_attr_mask[i + 1]) << fr_attr_shift[i + 1];
3229 fprintf(stderr, "LOOKING FOR %08x %08x + %08x %08x --> %08x %08x\n",
3230 parent->vendor, parent->attr, attr, vendor,
3231 da.vendor, da.attr);
3235 *pvendor = da.vendor;
3240 * Get an attribute by it's numerical value, and the parent
3242 DICT_ATTR const *dict_attrbyparent(DICT_ATTR const *parent, unsigned int attr, unsigned int vendor)
3244 unsigned int my_attr, my_vendor;
3250 if (!dict_attr_child(parent, &my_attr, &my_vendor)) return NULL;
3253 da.vendor = my_vendor;
3255 return fr_hash_table_finddata(attributes_byvalue, &da);
3260 * Get an attribute by its name.
3262 DICT_ATTR const *dict_attrbyname(char const *name)
3265 uint32_t buffer[(sizeof(*da) + DICT_ATTR_MAX_NAME_LEN + 3)/4];
3267 if (!name) return NULL;
3269 da = (DICT_ATTR *) buffer;
3270 strlcpy(da->name, name, DICT_ATTR_MAX_NAME_LEN + 1);
3272 return fr_hash_table_finddata(attributes_byname, da);
3275 /** Look up a dictionary attribute by name embedded in another string
3277 * Find the first invalid attribute name char in the string pointed
3280 * Copy the characters between the start of the name string and the first
3281 * none dict_attr_allowed_char to a buffer and perform a dictionary lookup
3284 * If the attribute exists, advance the pointer pointed to by name
3285 * to the first none dict_attr_allowed_char char, and return the DA.
3287 * If the attribute does not exist, don't advance the pointer and return
3290 * @param[in,out] name string start.
3291 * @return NULL if no attributes matching the name could be found, else
3293 DICT_ATTR const *dict_attrbyname_substr(char const **name)
3296 DICT_ATTR const *da;
3299 uint32_t buffer[(sizeof(*find) + DICT_ATTR_MAX_NAME_LEN + 3)/4];
3301 if (!name || !*name) return NULL;
3303 find = (DICT_ATTR *) buffer;
3306 * Advance p until we get something that's not part of
3307 * the dictionary attribute name.
3309 for (p = *name; dict_attr_allowed_chars[(int) *p]; p++);
3312 if (len > DICT_ATTR_MAX_NAME_LEN) {
3313 fr_strerror_printf("Attribute name too long");
3317 strlcpy(find->name, *name, len + 1);
3319 da = fr_hash_table_finddata(attributes_byname, find);
3321 fr_strerror_printf("Unknown attribute \"%s\"", find->name);
3330 * Associate a value with an attribute and return it.
3332 DICT_VALUE *dict_valbyattr(unsigned int attr, unsigned int vendor, int value)
3334 DICT_VALUE dval, *dv;
3337 * First, look up aliases.
3340 dval.vendor = vendor;
3341 dval.name[0] = '\0';
3344 * Look up the attribute alias target, and use
3345 * the correct attribute number if found.
3347 dv = fr_hash_table_finddata(values_byname, &dval);
3348 if (dv) dval.attr = dv->value;
3352 return fr_hash_table_finddata(values_byvalue, &dval);
3356 * Associate a value with an attribute and return it.
3358 char const *dict_valnamebyattr(unsigned int attr, unsigned int vendor, int value)
3362 dv = dict_valbyattr(attr, vendor, value);
3369 * Get a value by its name, keyed off of an attribute.
3371 DICT_VALUE *dict_valbyname(unsigned int attr, unsigned int vendor, char const *name)
3373 DICT_VALUE *my_dv, *dv;
3374 uint32_t buffer[(sizeof(*my_dv) + DICT_VALUE_MAX_NAME_LEN + 3)/4];
3376 if (!name) return NULL;
3378 my_dv = (DICT_VALUE *) buffer;
3380 my_dv->vendor = vendor;
3381 my_dv->name[0] = '\0';
3384 * Look up the attribute alias target, and use
3385 * the correct attribute number if found.
3387 dv = fr_hash_table_finddata(values_byname, my_dv);
3388 if (dv) my_dv->attr = dv->value;
3390 strlcpy(my_dv->name, name, DICT_VALUE_MAX_NAME_LEN + 1);
3392 return fr_hash_table_finddata(values_byname, my_dv);
3396 * Get the vendor PEC based on the vendor name
3398 * This is efficient only for small numbers of vendors.
3400 int dict_vendorbyname(char const *name)
3403 size_t buffer[(sizeof(*dv) + DICT_VENDOR_MAX_NAME_LEN + sizeof(size_t) - 1) / sizeof(size_t)];
3405 if (!name) return 0;
3407 dv = (DICT_VENDOR *) buffer;
3408 strlcpy(dv->name, name, DICT_VENDOR_MAX_NAME_LEN + 1);
3410 dv = fr_hash_table_finddata(vendors_byname, dv);
3413 return dv->vendorpec;
3417 * Return the vendor struct based on the PEC.
3419 DICT_VENDOR *dict_vendorbyvalue(int vendorpec)
3423 dv.vendorpec = vendorpec;
3425 return fr_hash_table_finddata(vendors_byvalue, &dv);
3428 /** Converts an unknown to a known by adding it to the internal dictionaries.
3430 * Does not free old DICT_ATTR, that is left up to the caller.
3432 * @param old unknown attribute to add.
3433 * @return existing DICT_ATTR if old was found in a dictionary, else the new entry in the dictionary
3436 DICT_ATTR const *dict_unknown_add(DICT_ATTR const *old)
3438 DICT_ATTR const *da, *parent;
3441 if (!old) return NULL;
3443 if (!old->flags.is_unknown) return old;
3445 da = dict_attrbyvalue(old->attr, old->vendor);
3448 memcpy(&flags, &old->flags, sizeof(flags));
3449 flags.is_unknown = false;
3451 parent = dict_parent(old->attr, old->vendor);
3453 if (parent->flags.has_tlv) flags.is_tlv = true;
3454 flags.evs = parent->flags.evs;
3455 flags.extended = parent->flags.extended;
3456 flags.long_extended = parent->flags.long_extended;
3459 if (dict_addattr(old->name, old->attr, old->vendor, old->type, flags) < 0) {
3463 da = dict_attrbyvalue(old->attr, old->vendor);