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 int 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 * Bamboo skewers under the fingernails in 5, 4, 3, 2, ...
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".
654 if (!vendor) return NULL;
656 base_vendor = vendor & (FR_MAX_VENDOR - 1);
659 * It's a real vendor.
661 if (base_vendor != 0) {
662 DICT_VENDOR const *dv;
664 dv = dict_vendorbyvalue(base_vendor);
665 if (!dv) return NULL;
668 * Only standard format attributes can be of type "tlv",
669 * Except for DHCP. <sigh>
671 if ((vendor != 54) && ((dv->type != 1) || (dv->length != 1))) return NULL;
673 for (i = MAX_TLV_NEST; i > 0; i--) {
676 parent = attr & fr_attr_parent_mask[i];
678 if (parent != attr) return dict_attrbyvalue(parent, vendor); /* not base_vendor */
682 * It was a top-level VSA. There's no parent.
683 * We COULD return the appropriate enclosing VSA
684 * (26, or 241.26, etc.) but that's not what we
691 * It's an extended attribute. Return the base Extended-Attr-X
693 if (attr < 256) return dict_attrbyvalue((vendor / FR_MAX_VENDOR) & 0xff, 0);
696 * Figure out which attribute it is.
698 for (i = MAX_TLV_NEST; i > 0; i--) {
701 parent = attr & fr_attr_parent_mask[i];
702 if (parent != attr) return dict_attrbyvalue(parent, vendor); /* not base_vendor */
709 /** Add an attribute to the dictionary
711 * @return 0 on success -1 on failure.
713 int dict_addattr(char const *name, int attr, unsigned int vendor, PW_TYPE type,
717 DICT_ATTR const *parent;
719 static int max_attr = 0;
721 namelen = strlen(name);
722 if (namelen >= DICT_ATTR_MAX_NAME_LEN) {
723 fr_strerror_printf("dict_addattr: attribute name too long");
727 if (dict_valid_name(name) < 0) return -1;
730 !((type == PW_TYPE_INTEGER) || (type == PW_TYPE_STRING))) {
731 fr_strerror_printf("dict_addattr: Only 'integer' and 'string' attributes can have tags");
736 * Disallow attributes of type zero.
738 if (!attr && !vendor) {
739 fr_strerror_printf("dict_addattr: Attribute 0 is invalid and cannot be used");
744 * If the attr is '-1', that means use a pre-existing
745 * one (if it already exists). If one does NOT already exist,
746 * then create a new attribute, with a non-conflicting value,
750 if (dict_attrbyname(name)) {
751 return 0; /* exists, don't add it again */
756 } else if (vendor == 0) {
760 if (attr > max_attr) {
766 * Check the parent attribute, and set the various flags
767 * based on the parents values. It's OK for the caller
768 * to not set them, as we'll set them. But if the caller
769 * sets them when he's not supposed to set them, that's
772 parent = dict_parent(attr, vendor);
775 * We're still in the same space and the parent isn't a TLV. That's an error.
777 * Otherwise, dict_parent() has taken us from an Extended sub-attribute to
778 * a *the* Extended attribute, whish isn't what we want here.
780 if ((vendor == parent->vendor) && (parent->type != PW_TYPE_TLV)) {
781 fr_strerror_printf("dict_addattr: Attribute %s has parent attribute %s which is not of type 'tlv'",
786 flags.extended |= parent->flags.extended;
787 flags.long_extended |= parent->flags.long_extended;
788 flags.evs |= parent->flags.evs;
792 * Additional checks for extended attributes.
794 if (flags.extended || flags.long_extended || flags.evs) {
795 if (vendor && (vendor < FR_MAX_VENDOR)) {
796 fr_strerror_printf("dict_addattr: VSAs cannot use the \"extended\" or \"evs\" attribute formats");
803 || (flags.encrypt != FLAG_ENCRYPT_NONE)) {
804 fr_strerror_printf("dict_addattr: The \"extended\" attributes MUST NOT have any flags set");
810 if (!(flags.extended || flags.long_extended)) {
811 fr_strerror_printf("dict_addattr: Attributes of type \"evs\" MUST have a parent of type \"extended\"");
815 /* VSAs cannot be of format EVS */
816 if ((vendor & (FR_MAX_VENDOR - 1)) != 0) {
817 fr_strerror_printf("dict_addattr: Attribute of type \"evs\" fails internal sanity check");
823 * Do various sanity checks.
826 fr_strerror_printf("dict_addattr: ATTRIBUTE has invalid number (less than zero)");
830 if (flags.has_tlv && flags.length) {
831 fr_strerror_printf("TLVs cannot have a fixed length");
835 if (vendor && flags.concat) {
836 fr_strerror_printf("VSAs cannot have the \"concat\" flag set");
840 if (flags.concat && (type != PW_TYPE_OCTETS)) {
841 fr_strerror_printf("The \"concat\" flag can only be set for attributes of type \"octets\"");
845 if (flags.concat && (flags.has_tag || flags.array || flags.is_tlv || flags.has_tlv ||
846 flags.length || flags.evs || flags.extended || flags.long_extended ||
847 (flags.encrypt != FLAG_ENCRYPT_NONE))) {
848 fr_strerror_printf("The \"concat\" flag cannot be used with any other flag");
852 if (flags.length && (type != PW_TYPE_OCTETS)) {
853 fr_strerror_printf("The \"length\" flag can only be set for attributes of type \"octets\"");
857 if (flags.length && (flags.has_tag || flags.array || flags.is_tlv || flags.has_tlv ||
858 flags.concat || flags.evs || flags.extended || flags.long_extended ||
859 (flags.encrypt > FLAG_ENCRYPT_USER_PASSWORD))) {
860 fr_strerror_printf("The \"length\" flag cannot be used with any other flag");
865 * Force "length" for data types of fixed length;
877 case PW_TYPE_IPV4_ADDR:
878 case PW_TYPE_INTEGER:
883 case PW_TYPE_INTEGER64:
887 case PW_TYPE_ETHERNET:
895 case PW_TYPE_IPV6_ADDR:
899 case PW_TYPE_EXTENDED:
900 if ((vendor != 0) || (attr < 241)) {
901 fr_strerror_printf("Attributes of type \"extended\" MUST be "
902 "RFC attributes with value >= 241.");
910 case PW_TYPE_LONG_EXTENDED:
911 if ((vendor != 0) || (attr < 241)) {
912 fr_strerror_printf("Attributes of type \"long-extended\" MUST "
913 "be RFC attributes with value >= 241.");
919 flags.long_extended = 1;
923 if (attr != PW_VENDOR_SPECIFIC) {
924 fr_strerror_printf("Attributes of type \"evs\" MUST have "
925 "attribute code 26.");
937 flags.is_pointer = true;
945 * Stupid hacks for MS-CHAP-MPPE-Keys. The User-Password
946 * encryption method has no provisions for encoding the
947 * length of the data. For User-Password, the data is
948 * (presumably) all printable non-zero data. For
949 * MS-CHAP-MPPE-Keys, the data is binary crap. So... we
950 * MUST specify a length in the dictionary.
952 if ((flags.encrypt == FLAG_ENCRYPT_USER_PASSWORD) && (type != PW_TYPE_STRING)) {
953 if (type != PW_TYPE_OCTETS) {
954 fr_strerror_printf("The \"encrypt=1\" flag cannot be used with non-string data types");
958 if (flags.length == 0) {
959 fr_strerror_printf("The \"encrypt=1\" flag MUST be used with an explicit length for 'octets' data types");
964 if ((vendor & (FR_MAX_VENDOR -1)) != 0) {
966 static DICT_VENDOR *last_vendor = NULL;
968 if (flags.has_tlv && (flags.encrypt != FLAG_ENCRYPT_NONE)) {
969 fr_strerror_printf("TLV's cannot be encrypted");
973 if (flags.is_tlv && flags.has_tag) {
974 fr_strerror_printf("Sub-TLV's cannot have a tag");
978 if (flags.has_tlv && flags.has_tag) {
979 fr_strerror_printf("TLV's cannot have a tag");
984 * Most ATTRIBUTEs are bunched together by
985 * VENDOR. We can save a lot of lookups on
986 * dictionary initialization by caching the last
990 ((vendor & (FR_MAX_VENDOR - 1)) == last_vendor->vendorpec)) {
994 * Ignore the high byte (sigh)
996 dv = dict_vendorbyvalue(vendor & (FR_MAX_VENDOR - 1));
1001 * If the vendor isn't defined, die.
1004 fr_strerror_printf("dict_addattr: Unknown vendor %u",
1005 vendor & (FR_MAX_VENDOR - 1));
1009 if (!attr && dv->type != 1) {
1010 fr_strerror_printf("dict_addattr: Attribute %s cannot have value zero",
1016 * FIXME: Switch over dv->type, and limit things
1019 if ((dv->type == 1) && (attr >= 256) && !flags.is_tlv) {
1020 fr_strerror_printf("dict_addattr: ATTRIBUTE has invalid number (larger than 255)");
1022 } /* else 256..65535 are allowed */
1025 * If the attribute is in the standard space, AND
1026 * has a sub-type (e.g. 241.1 or 255.3), then its
1027 * number is placed into the upper 8 bits of the
1030 * This also happens for the new VSAs.
1032 * If we find it, then set the various flags
1033 * based on what we see.
1035 if (vendor >= FR_MAX_VENDOR) {
1037 fr_strerror_printf("dict_addattr: ATTRIBUTE refers to unknown parent attribute");
1042 * Non-extended attributes can't have VSAs.
1044 if (!flags.extended &&
1045 ((vendor & (FR_MAX_VENDOR - 1)) != 0)) {
1046 fr_strerror_printf("dict_addattr: ATTRIBUTE cannot be a VSA");
1050 if ((vendor & (FR_MAX_VENDOR - 1)) != 0) {
1056 * <sigh> Alvarion, being *again* a horribly
1057 * broken vendor, has re-used the WiMAX format in
1058 * their proprietary vendor space. This re-use
1059 * means that there are *multiple* conflicting
1060 * Alvarion dictionaries.
1062 flags.wimax = dv->flags;
1066 * Create a new attribute for the list
1068 if ((n = fr_pool_alloc(sizeof(*n) + namelen)) == NULL) {
1070 fr_strerror_printf("dict_addattr: out of memory");
1074 memcpy(n->name, name, namelen);
1075 n->name[namelen] = '\0';
1082 * Insert the attribute, only if it's not a duplicate.
1084 if (!fr_hash_table_insert(attributes_byname, n)) {
1088 * If the attribute has identical number, then
1089 * ignore the duplicate.
1091 a = fr_hash_table_finddata(attributes_byname, n);
1092 if (a && (strcasecmp(a->name, n->name) == 0)) {
1093 if (a->attr != n->attr) {
1094 fr_strerror_printf("dict_addattr: Duplicate attribute name %s", name);
1100 * Same name, same vendor, same attr,
1101 * maybe the flags and/or type is
1102 * different. Let the new value
1103 * over-ride the old one.
1108 fr_hash_table_delete(attributes_byvalue, a);
1110 if (!fr_hash_table_replace(attributes_byname, n)) {
1111 fr_strerror_printf("dict_addattr: Internal error storing attribute %s", name);
1118 * Insert the SAME pointer (not free'd when this entry is
1119 * deleted), into another table.
1121 * We want this behaviour because we want OLD names for
1122 * the attributes to be read from the configuration
1123 * files, but when we're printing them, (and looking up
1124 * by value) we want to use the NEW name.
1126 if (!fr_hash_table_replace(attributes_byvalue, n)) {
1127 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s", name);
1132 * Hacks for combo-IP
1134 if (n->type == PW_TYPE_COMBO_IP_ADDR) {
1137 v4 = fr_pool_alloc(sizeof(*v4) + namelen);
1140 v6 = fr_pool_alloc(sizeof(*v6) + namelen);
1143 memcpy(v4, n, sizeof(*v4) + namelen);
1144 v4->type = PW_TYPE_IPV4_ADDR;
1146 memcpy(v6, n, sizeof(*v6) + namelen);
1147 v6->type = PW_TYPE_IPV6_ADDR;
1148 if (!fr_hash_table_replace(attributes_combo, v4)) {
1149 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s - IPv4", name);
1153 if (!fr_hash_table_replace(attributes_combo, v6)) {
1154 fr_strerror_printf("dict_addattr: Failed inserting attribute name %s - IPv6", name);
1159 if (!vendor && (attr > 0) && (attr < 256)) {
1160 dict_base_attrs[attr] = n;
1168 * Add a value for an attribute to the dictionary.
1170 int dict_addvalue(char const *namestr, char const *attrstr, int value)
1173 DICT_ATTR const *da;
1176 static DICT_ATTR const *last_attr = NULL;
1179 fr_strerror_printf("dict_addvalue: empty names are not permitted");
1183 if ((length = strlen(namestr)) >= DICT_VALUE_MAX_NAME_LEN) {
1184 fr_strerror_printf("dict_addvalue: value name too long");
1188 if ((dval = fr_pool_alloc(sizeof(*dval) + length)) == NULL) {
1189 fr_strerror_printf("dict_addvalue: out of memory");
1192 memset(dval, 0, sizeof(*dval));
1194 strcpy(dval->name, namestr);
1195 dval->value = value;
1198 * Most VALUEs are bunched together by ATTRIBUTE. We can
1199 * save a lot of lookups on dictionary initialization by
1200 * caching the last attribute.
1202 if (last_attr && (strcasecmp(attrstr, last_attr->name) == 0)) {
1205 da = dict_attrbyname(attrstr);
1210 * Remember which attribute is associated with this
1211 * value, if possible.
1214 if (da->flags.has_value_alias) {
1215 fr_strerror_printf("dict_addvalue: Cannot add VALUE for ATTRIBUTE \"%s\": It already has a VALUE-ALIAS", attrstr);
1219 dval->attr = da->attr;
1220 dval->vendor = da->vendor;
1223 * Enforce valid values
1225 * Don't worry about fixups...
1231 fr_strerror_printf("dict_addvalue: ATTRIBUTEs of type 'byte' cannot have VALUEs larger than 255");
1236 if (value > 65535) {
1238 fr_strerror_printf("dict_addvalue: ATTRIBUTEs of type 'short' cannot have VALUEs larger than 65535");
1244 * Allow octets for now, because
1245 * of dictionary.cablelabs
1247 case PW_TYPE_OCTETS:
1249 case PW_TYPE_INTEGER:
1252 case PW_TYPE_INTEGER64:
1255 fr_strerror_printf("dict_addvalue: VALUEs cannot be defined for attributes of type '%s'",
1256 fr_int2str(dict_attr_types, da->type, "?Unknown?"));
1260 value_fixup_t *fixup;
1262 fixup = (value_fixup_t *) malloc(sizeof(*fixup));
1265 fr_strerror_printf("dict_addvalue: out of memory");
1268 memset(fixup, 0, sizeof(*fixup));
1270 strlcpy(fixup->attrstr, attrstr, sizeof(fixup->attrstr));
1274 * Insert to the head of the list.
1276 fixup->next = value_fixup;
1277 value_fixup = fixup;
1283 * Add the value into the dictionary.
1287 memcpy(&tmp, &dval, sizeof(tmp));
1289 if (!fr_hash_table_insert(values_byname, tmp)) {
1294 * Suppress duplicates with the same
1295 * name and value. There are lots in
1296 * dictionary.ascend.
1298 old = dict_valbyname(da->attr, da->vendor, namestr);
1299 if (old && (old->value == dval->value)) {
1306 fr_strerror_printf("dict_addvalue: Duplicate value name %s for attribute %s", namestr, attrstr);
1312 * There are multiple VALUE's, keyed by attribute, so we
1313 * take care of that here.
1315 if (!fr_hash_table_replace(values_byvalue, dval)) {
1316 fr_strerror_printf("dict_addvalue: Failed inserting value %s",
1324 static int sscanf_i(char const *str, unsigned int *pvalue)
1328 static char const *tab = "0123456789";
1330 if ((str[0] == '0') &&
1331 ((str[1] == 'x') || (str[1] == 'X'))) {
1332 tab = "0123456789abcdef";
1341 if (*str == '.') break;
1343 c = memchr(tab, tolower((int) *str), base);
1357 * Get the OID based on various pieces of information.
1359 * Remember, the packing format is weird.
1361 * 00VID 000000AA normal VSA for vendor VID
1362 * 00VID AABBCCDD normal VSAs with TLVs
1363 * EE000 000000AA extended attr (241.1)
1364 * EE000 AABBCCDD extended attr with TLVs
1365 * EEVID 000000AA EVS with vendor VID, attr AAA
1366 * EEVID AABBCCDD EVS with TLVs
1368 * <whew>! Are we crazy, or what?
1370 int dict_str2oid(char const *ptr, unsigned int *pvalue, unsigned int *pvendor,
1375 DICT_ATTR const *da = NULL;
1377 if (tlv_depth > fr_attr_max_tlv) {
1378 fr_strerror_printf("Too many sub-attributes");
1383 * If *pvalue is set, check if the attribute exists.
1384 * Otherwise, check that the vendor exists.
1387 da = dict_attrbyvalue(*pvalue, *pvendor);
1389 fr_strerror_printf("Parent attribute is undefined");
1393 if (!da->flags.has_tlv && !da->flags.extended) {
1394 fr_strerror_printf("Parent attribute %s cannot have sub-attributes",
1399 } else if ((*pvendor & (FR_MAX_VENDOR - 1)) != 0) {
1400 if (!dict_vendorbyvalue(*pvendor & (FR_MAX_VENDOR - 1))) {
1401 fr_strerror_printf("Unknown vendor %u",
1402 *pvendor & (FR_MAX_VENDOR - 1));
1407 p = strchr(ptr, '.');
1410 * Look for 26.VID.x.y
1412 * If we find it, re-write the parameters, and recurse.
1414 if (!*pvendor && (tlv_depth == 0) && (*pvalue == PW_VENDOR_SPECIFIC)) {
1415 DICT_VENDOR const *dv;
1418 fr_strerror_printf("VSA needs to have sub-attribute");
1422 if (!sscanf_i(ptr, pvendor)) {
1423 fr_strerror_printf("Invalid number in attribute");
1427 if (*pvendor >= FR_MAX_VENDOR) {
1428 fr_strerror_printf("Cannot handle vendor ID larger than 2^24");
1433 dv = dict_vendorbyvalue(*pvendor & (FR_MAX_VENDOR - 1));
1435 fr_strerror_printf("Unknown vendor \"%u\" ",
1436 *pvendor & (FR_MAX_VENDOR - 1));
1441 * Start off with (attr=0, vendor=VID), and
1442 * recurse. This causes the various checks above
1446 return dict_str2oid(p + 1, pvalue, pvendor, 0);
1449 if (!sscanf_i(ptr, &value)) {
1450 fr_strerror_printf("Invalid number in attribute");
1454 if (!*pvendor && (tlv_depth == 1) && da &&
1455 (da->flags.has_tlv || da->flags.extended)) {
1458 *pvendor = *pvalue * FR_MAX_VENDOR;
1462 return dict_str2oid(p + 1, pvalue, pvendor, 1);
1466 * And pack the data according to the scheme described in
1467 * the comments at the start of this function.
1470 *pvalue |= (value & fr_attr_mask[tlv_depth]) << fr_attr_shift[tlv_depth];
1476 return dict_str2oid(p + 1, pvalue, pvendor, tlv_depth + 1);
1484 * Process the ATTRIBUTE command
1486 static int process_attribute(char const* fn, int const line,
1487 unsigned int block_vendor,
1488 DICT_ATTR const *block_tlv, int tlv_depth,
1489 char **argv, int argc)
1492 unsigned int vendor = 0;
1495 unsigned int length;
1499 if ((argc < 3) || (argc > 4)) {
1500 fr_strerror_printf("dict_init: %s[%d]: invalid ATTRIBUTE line",
1506 * Dictionaries need to have real names, not shitty ones.
1508 if (strncmp(argv[1], "Attr-", 5) == 0) {
1509 fr_strerror_printf("dict_init: %s[%d]: Invalid attribute name",
1514 memset(&flags, 0, sizeof(flags));
1517 * Look for OIDs before doing anything else.
1519 p = strchr(argv[1], '.');
1523 * Validate all entries
1525 if (!sscanf_i(argv[1], &value)) {
1526 fr_strerror_printf("dict_init: %s[%d]: invalid value", fn, line);
1531 DICT_ATTR const *da;
1533 vendor = block_vendor;
1536 * Parse the rest of the OID.
1538 if (dict_str2oid(p + 1, &value, &vendor, tlv_depth + 1) < 0) {
1541 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1543 fr_strerror_printf("dict_init: %s[%d]: Invalid attribute identifier: %s", fn, line, buffer);
1546 block_vendor = vendor;
1549 * Set the flags based on the parents flags.
1551 da = dict_parent(value, vendor);
1553 fr_strerror_printf("dict_init: %s[%d]: Parent attribute is undefined.", fn, line);
1557 flags.extended = da->flags.extended;
1558 flags.long_extended = da->flags.long_extended;
1559 flags.evs = da->flags.evs;
1560 if (da->flags.has_tlv) flags.is_tlv = 1;
1563 if (strncmp(argv[2], "octets[", 7) != 0) {
1565 * find the type of the attribute.
1567 type = fr_str2int(dict_attr_types, argv[2], -1);
1569 fr_strerror_printf("dict_init: %s[%d]: invalid type \"%s\"",
1575 type = PW_TYPE_OCTETS;
1577 p = strchr(argv[2] + 7, ']');
1579 fr_strerror_printf("dict_init: %s[%d]: Invalid format for octets", fn, line);
1585 if (!sscanf_i(argv[1], &length)) {
1586 fr_strerror_printf("dict_init: %s[%d]: invalid length", fn, line);
1590 if ((length == 0) || (length > 253)) {
1591 fr_strerror_printf("dict_init: %s[%d]: invalid length", fn, line);
1595 flags.length = length;
1602 char *key, *next, *last;
1607 if (flags.extended) {
1608 fr_strerror_printf("dict_init: %s[%d]: Extended attributes cannot use flags", fn, line);
1614 next = strchr(key, ',');
1615 if (next) *(next++) = '\0';
1618 * Boolean flag, means this is a tagged
1621 if ((strcmp(key, "has_tag") == 0) || (strcmp(key, "has_tag=1") == 0)) {
1625 * Encryption method, defaults to 0 (none).
1626 * Currently valid is just type 2,
1627 * Tunnel-Password style, which can only
1628 * be applied to strings.
1630 } else if (strncmp(key, "encrypt=", 8) == 0) {
1631 flags.encrypt = strtol(key + 8, &last, 0);
1633 fr_strerror_printf("dict_init: %s[%d] invalid option %s",
1638 if ((flags.encrypt == FLAG_ENCRYPT_ASCEND_SECRET) &&
1639 (type != PW_TYPE_STRING)) {
1640 fr_strerror_printf("dict_init: %s[%d] Only \"string\" types can have the "
1641 "\"encrypt=3\" flag set", fn, line);
1645 } else if (strncmp(key, "array", 6) == 0) {
1649 case PW_TYPE_IPV4_ADDR:
1650 case PW_TYPE_IPV6_ADDR:
1653 case PW_TYPE_INTEGER:
1655 case PW_TYPE_STRING:
1659 fr_strerror_printf("dict_init: %s[%d] \"%s\" type cannot have the "
1660 "\"array\" flag set",
1662 fr_int2str(dict_attr_types, type, "<UNKNOWN>"));
1666 } else if (strncmp(key, "concat", 7) == 0) {
1669 if (type != PW_TYPE_OCTETS) {
1670 fr_strerror_printf("dict_init: %s[%d] Only \"octets\" type can have the "
1671 "\"concat\" flag set", fn, line);
1675 } else if (strncmp(key, "virtual", 8) == 0) {
1679 fr_strerror_printf("dict_init: %s[%d] VSAs cannot have the \"virtual\" "
1680 "flag set", fn, line);
1685 fr_strerror_printf("dict_init: %s[%d] Standard attributes cannot "
1686 "have the \"virtual\" flag set", fn, line);
1691 * The only thing is the vendor name,
1692 * and it's a known name: allow it.
1694 } else if ((key == argv[3]) && !next) {
1696 fr_strerror_printf("dict_init: %s[%d] New-style attributes cannot use "
1697 "a vendor flag", fn, line);
1702 fr_strerror_printf("dict_init: %s[%d] Vendor flag inside of \"BEGIN-VENDOR\" "
1703 "is not allowed", fn, line);
1707 vendor = dict_vendorbyname(key);
1708 if (!vendor) goto unknown;
1713 fr_strerror_printf("dict_init: %s[%d]: unknown option \"%s\"", fn, line, key);
1718 if (key && !*key) break;
1722 if (block_vendor) vendor = block_vendor;
1725 * Special checks for tags, they make our life much more
1728 if (flags.has_tag) {
1730 * Only string, octets, and integer can be tagged.
1733 case PW_TYPE_STRING:
1734 case PW_TYPE_INTEGER:
1738 fr_strerror_printf("dict_init: %s[%d]: Attributes of type %s cannot be tagged.",
1740 fr_int2str(dict_attr_types, type, "?Unknown?"));
1745 if (type == PW_TYPE_TLV) {
1746 if (vendor && (vendor < FR_MAX_VENDOR)
1748 && (vendor != DHCP_MAGIC_VENDOR)
1753 dv = dict_vendorbyvalue(vendor);
1754 if (!dv || (dv->type != 1) || (dv->length != 1)) {
1755 fr_strerror_printf("dict_init: %s[%d]: Type \"tlv\" can only be for \"format=1,1\".",
1766 * TLV's can be only one octet.
1768 if ((value == 0) || ((value & ~fr_attr_mask[tlv_depth]) != 0)) {
1769 fr_strerror_printf( "dict_init: %s[%d]: sub-tlv has invalid attribute number",
1775 * Shift the value left.
1777 value <<= fr_attr_shift[tlv_depth];
1778 value |= block_tlv->attr;
1782 #ifdef WITH_DICTIONARY_WARNINGS
1784 * Hack to help us discover which vendors have illegal
1787 if (!vendor && (value < 256) &&
1788 !strstr(fn, "rfc") && !strstr(fn, "illegal")) {
1789 fprintf(stderr, "WARNING: Illegal Attribute %s in %s\n",
1797 if (dict_addattr(argv[0], value, vendor, type, flags) < 0) {
1800 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1802 fr_strerror_printf("dict_init: %s[%d]: %s",
1812 * Process the VALUE command
1814 static int process_value(char const* fn, int const line, char **argv,
1820 fr_strerror_printf("dict_init: %s[%d]: invalid VALUE line",
1825 * For Compatibility, skip "Server-Config"
1827 if (strcasecmp(argv[0], "Server-Config") == 0)
1831 * Validate all entries
1833 if (!sscanf_i(argv[2], &value)) {
1834 fr_strerror_printf("dict_init: %s[%d]: invalid value",
1839 if (dict_addvalue(argv[1], argv[0], value) < 0) {
1842 strlcpy(buffer, fr_strerror(), sizeof(buffer));
1844 fr_strerror_printf("dict_init: %s[%d]: %s",
1854 * Process the VALUE-ALIAS command
1856 * This allows VALUE mappings to be shared among multiple
1859 static int process_value_alias(char const* fn, int const line, char **argv,
1862 DICT_ATTR const *my_da, *da;
1866 fr_strerror_printf("dict_init: %s[%d]: invalid VALUE-ALIAS line",
1871 my_da = dict_attrbyname(argv[0]);
1873 fr_strerror_printf("dict_init: %s[%d]: ATTRIBUTE \"%s\" does not exist",
1878 if (my_da->flags.has_value_alias) {
1879 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" with pre-existing VALUE-ALIAS",
1884 da = dict_attrbyname(argv[1]);
1886 fr_strerror_printf("dict_init: %s[%d]: Cannot find ATTRIBUTE \"%s\" for alias",
1891 if (da->flags.has_value_alias) {
1892 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" which itself has a VALUE-ALIAS",
1897 if (my_da->type != da->type) {
1898 fr_strerror_printf("dict_init: %s[%d]: Cannot add VALUE-ALIAS between attributes of differing type",
1903 if ((dval = fr_pool_alloc(sizeof(*dval))) == NULL) {
1904 fr_strerror_printf("dict_addvalue: out of memory");
1908 dval->name[0] = '\0'; /* empty name */
1909 dval->attr = my_da->attr;
1910 dval->vendor = my_da->vendor;
1911 dval->value = da->attr;
1913 if (!fr_hash_table_insert(values_byname, dval)) {
1914 fr_strerror_printf("dict_init: %s[%d]: Error create alias",
1924 static int parse_format(char const *fn, int line, char const *format, int *pvalue, int *ptype, int *plength, bool *pcontinuation)
1928 bool continuation = false;
1930 if (strncasecmp(format, "format=", 7) != 0) {
1931 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected \"format=\", got \"%s\"",
1937 if ((strlen(p) < 3) ||
1938 !isdigit((int) p[0]) ||
1940 !isdigit((int) p[2]) ||
1941 (p[3] && (p[3] != ','))) {
1942 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
1947 type = (int) (p[0] - '0');
1948 length = (int) (p[2] - '0');
1950 if ((type != 1) && (type != 2) && (type != 4)) {
1951 fr_strerror_printf("dict_init: %s[%d]: invalid type value %d for VENDOR",
1956 if ((length != 0) && (length != 1) && (length != 2)) {
1957 fr_strerror_printf("dict_init: %s[%d]: invalid length value %d for VENDOR",
1964 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
1969 if ((p[4] != 'c') ||
1971 fr_strerror_printf("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
1975 continuation = true;
1977 if ((*pvalue != VENDORPEC_WIMAX) ||
1978 (type != 1) || (length != 1)) {
1979 fr_strerror_printf("dict_init: %s[%d]: Only WiMAX VSAs can have continuations",
1987 *pcontinuation = continuation;
1993 * Process the VENDOR command
1995 static int process_vendor(char const* fn, int const line, char **argv,
2000 bool continuation = false;
2003 if ((argc < 2) || (argc > 3)) {
2004 fr_strerror_printf( "dict_init: %s[%d] invalid VENDOR entry",
2010 * Validate all entries
2012 if (!isdigit((int) argv[1][0])) {
2013 fr_strerror_printf("dict_init: %s[%d]: invalid value",
2017 value = atoi(argv[1]);
2019 /* Create a new VENDOR entry for the list */
2020 if (dict_addvendor(argv[0], value) < 0) {
2023 strlcpy(buffer, fr_strerror(), sizeof(buffer));
2025 fr_strerror_printf("dict_init: %s[%d]: %s",
2031 * Look for a format statement. Allow it to over-ride the hard-coded formats below.
2034 if (parse_format(fn, line, argv[2], &value, &type, &length, &continuation) < 0) {
2038 } else if (value == VENDORPEC_USR) { /* catch dictionary screw-ups */
2042 } else if (value == VENDORPEC_LUCENT) {
2046 } else if (value == VENDORPEC_STARENT) {
2054 dv = dict_vendorbyvalue(value);
2056 fr_strerror_printf("dict_init: %s[%d]: Failed adding format for VENDOR",
2062 dv->length = length;
2063 dv->flags = continuation;
2069 * String split routine. Splits an input string IN PLACE
2070 * into pieces, based on spaces.
2072 int str2argv(char *str, char **argv, int max_argc)
2077 if (argc >= max_argc) break;
2080 * Chop out comments early.
2087 while ((*str == ' ') ||
2090 (*str == '\n')) *(str++) = '\0';
2101 (*str != '\n')) str++;
2107 static int my_dict_init(char const *parent, char const *filename,
2108 char const *src_file, int src_line);
2110 int dict_read(char const *dir, char const *filename)
2112 if (!attributes_byname) {
2113 fr_strerror_printf("Must call dict_init() before dict_read()");
2117 return my_dict_init(dir, filename, NULL, 0);
2121 #define MAX_ARGV (16)
2124 * Initialize the dictionary.
2126 static int my_dict_init(char const *parent, char const *filename,
2127 char const *src_file, int src_line)
2130 char dir[256], fn[256];
2134 unsigned int vendor;
2135 unsigned int block_vendor;
2136 struct stat statbuf;
2137 char *argv[MAX_ARGV];
2139 DICT_ATTR const *da, *block_tlv[MAX_TLV_NEST + 1];
2140 int which_block_tlv = 0;
2142 block_tlv[0] = NULL;
2143 block_tlv[1] = NULL;
2144 block_tlv[2] = NULL;
2145 block_tlv[3] = NULL;
2147 if ((strlen(parent) + 3 + strlen(filename)) > sizeof(dir)) {
2148 fr_strerror_printf("dict_init: filename name too long");
2153 * If it's an absolute dir, forget the parent dir,
2154 * and remember the new one.
2156 * If it's a relative dir, tack on the current filename
2157 * to the parent dir. And use that.
2159 if (!FR_DIR_IS_RELATIVE(filename)) {
2160 strlcpy(dir, filename, sizeof(dir));
2161 p = strrchr(dir, FR_DIR_SEP);
2165 strlcat(dir, "/", sizeof(dir));
2168 strlcpy(fn, filename, sizeof(fn));
2170 strlcpy(dir, parent, sizeof(dir));
2171 p = strrchr(dir, FR_DIR_SEP);
2173 if (p[1]) strlcat(dir, "/", sizeof(dir));
2175 strlcat(dir, "/", sizeof(dir));
2177 strlcat(dir, filename, sizeof(dir));
2178 p = strrchr(dir, FR_DIR_SEP);
2182 strlcat(dir, "/", sizeof(dir));
2185 p = strrchr(filename, FR_DIR_SEP);
2187 snprintf(fn, sizeof(fn), "%s%s", dir, p);
2189 snprintf(fn, sizeof(fn), "%s%s", dir, filename);
2195 * Check if we've loaded this file before. If so, ignore it.
2197 p = strrchr(fn, FR_DIR_SEP);
2200 if (dict_stat_check(fn, p + 1)) {
2207 if ((fp = fopen(fn, "r")) == NULL) {
2209 fr_strerror_printf("dict_init: Couldn't open dictionary \"%s\": %s",
2210 fn, fr_syserror(errno));
2212 fr_strerror_printf("dict_init: %s[%d]: Couldn't open dictionary \"%s\": %s",
2213 src_file, src_line, fn, fr_syserror(errno));
2218 stat(fn, &statbuf); /* fopen() guarantees this will succeed */
2219 if (!S_ISREG(statbuf.st_mode)) {
2221 fr_strerror_printf("dict_init: Dictionary \"%s\" is not a regular file",
2227 * Globally writable dictionaries means that users can control
2228 * the server configuration with little difficulty.
2231 if ((statbuf.st_mode & S_IWOTH) != 0) {
2233 fr_strerror_printf("dict_init: Dictionary \"%s\" is globally writable. Refusing to start due to insecure configuration.",
2239 dict_stat_add(&statbuf);
2242 * Seed the random pool with data.
2244 fr_rand_seed(&statbuf, sizeof(statbuf));
2248 while (fgets(buf, sizeof(buf), fp) != NULL) {
2250 if (buf[0] == '#' || buf[0] == 0 ||
2251 buf[0] == '\n' || buf[0] == '\r')
2255 * Comment characters should NOT be appearing anywhere but
2256 * as start of a comment;
2258 p = strchr(buf, '#');
2261 argc = str2argv(buf, argv, MAX_ARGV);
2262 if (argc == 0) continue;
2265 fr_strerror_printf( "dict_init: %s[%d] invalid entry",
2272 * Process VALUE lines.
2274 if (strcasecmp(argv[0], "VALUE") == 0) {
2275 if (process_value(fn, line,
2276 argv + 1, argc - 1) == -1) {
2284 * Perhaps this is an attribute.
2286 if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
2287 if (process_attribute(fn, line, block_vendor,
2288 block_tlv[which_block_tlv],
2290 argv + 1, argc - 1) == -1) {
2298 * See if we need to import another dictionary.
2300 if (strcasecmp(argv[0], "$INCLUDE") == 0) {
2301 if (my_dict_init(dir, argv[1], fn, line) < 0) {
2309 * Optionally include a dictionary
2311 if (strcasecmp(argv[0], "$INCLUDE-") == 0) {
2312 int rcode = my_dict_init(dir, argv[1], fn, line);
2314 if (rcode == -2) continue;
2323 if (strcasecmp(argv[0], "VALUE-ALIAS") == 0) {
2324 if (process_value_alias(fn, line,
2325 argv + 1, argc - 1) == -1) {
2333 * Process VENDOR lines.
2335 if (strcasecmp(argv[0], "VENDOR") == 0) {
2336 if (process_vendor(fn, line,
2337 argv + 1, argc - 1) == -1) {
2344 if (strcasecmp(argv[0], "BEGIN-TLV") == 0) {
2347 "dict_init: %s[%d] invalid BEGIN-TLV entry",
2353 da = dict_attrbyname(argv[1]);
2356 "dict_init: %s[%d]: unknown attribute %s",
2362 if (da->type != PW_TYPE_TLV) {
2364 "dict_init: %s[%d]: attribute %s is not of type tlv",
2370 if (which_block_tlv >= MAX_TLV_NEST) {
2372 "dict_init: %s[%d]: TLVs are nested too deep",
2379 block_tlv[++which_block_tlv] = da;
2383 if (strcasecmp(argv[0], "END-TLV") == 0) {
2386 "dict_init: %s[%d] invalid END-TLV entry",
2392 da = dict_attrbyname(argv[1]);
2395 "dict_init: %s[%d]: unknown attribute %s",
2401 if (da != block_tlv[which_block_tlv]) {
2403 "dict_init: %s[%d]: END-TLV %s does not match any previous BEGIN-TLV",
2408 block_tlv[which_block_tlv--] = NULL;
2412 if (strcasecmp(argv[0], "BEGIN-VENDOR") == 0) {
2415 "dict_init: %s[%d] invalid BEGIN-VENDOR entry",
2421 vendor = dict_vendorbyname(argv[1]);
2424 "dict_init: %s[%d]: unknown vendor %s",
2430 block_vendor = vendor;
2433 * Check for extended attr VSAs
2435 * BEGIN-VENDOR foo format=Foo-Encapsulation-Attr
2438 if (strncmp(argv[2], "format=", 7) != 0) {
2440 "dict_init: %s[%d]: Invalid format %s",
2447 da = dict_attrbyname(p);
2449 fr_strerror_printf("dict_init: %s[%d]: Invalid format for BEGIN-VENDOR: unknown attribute \"%s\"",
2455 if (!da->flags.evs) {
2456 fr_strerror_printf("dict_init: %s[%d]: Invalid format for BEGIN-VENDOR. Attribute \"%s\" is not of \"evs\" data type",
2463 * Pack the encapsulating
2464 * attribute into the upper 8
2465 * bits of the vendor ID
2467 block_vendor |= da->vendor;
2471 } /* BEGIN-VENDOR */
2473 if (strcasecmp(argv[0], "END-VENDOR") == 0) {
2476 "dict_init: %s[%d] invalid END-VENDOR entry",
2482 vendor = dict_vendorbyname(argv[1]);
2485 "dict_init: %s[%d]: unknown vendor %s",
2491 if (vendor != (block_vendor & (FR_MAX_VENDOR - 1))) {
2493 "dict_init: %s[%d]: END-VENDOR %s does not match any previous BEGIN-VENDOR",
2503 * Any other string: We don't recognize it.
2505 fr_strerror_printf("dict_init: %s[%d] invalid keyword \"%s\"",
2516 * Empty callback for hash table initialization.
2518 static int null_callback(UNUSED void *ctx, UNUSED void *data)
2525 * Initialize the directory, then fix the attr member of
2528 int dict_init(char const *dir, char const *fn)
2531 * Check if we need to change anything. If not, don't do
2534 if (dict_stat_check(dir, fn)) {
2539 * Free the dictionaries, and the stat cache.
2544 * Create the table of vendor by name. There MAY NOT
2545 * be multiple vendors of the same name.
2547 * Each vendor is malloc'd, so the free function is free.
2549 vendors_byname = fr_hash_table_create(dict_vendor_name_hash,
2550 dict_vendor_name_cmp,
2552 if (!vendors_byname) {
2557 * Create the table of vendors by value. There MAY
2558 * be vendors of the same value. If there are, we
2559 * pick the latest one.
2561 vendors_byvalue = fr_hash_table_create(dict_vendor_value_hash,
2562 dict_vendor_value_cmp,
2564 if (!vendors_byvalue) {
2569 * Create the table of attributes by name. There MAY NOT
2570 * be multiple attributes of the same name.
2572 * Each attribute is malloc'd, so the free function is free.
2574 attributes_byname = fr_hash_table_create(dict_attr_name_hash,
2577 if (!attributes_byname) {
2582 * Create the table of attributes by value. There MAY
2583 * be attributes of the same value. If there are, we
2584 * pick the latest one.
2586 attributes_byvalue = fr_hash_table_create(dict_attr_value_hash,
2587 dict_attr_value_cmp,
2589 if (!attributes_byvalue) {
2594 * Horrible hacks for combo-IP.
2596 attributes_combo = fr_hash_table_create(dict_attr_combo_hash,
2597 dict_attr_combo_cmp,
2599 if (!attributes_combo) {
2603 values_byname = fr_hash_table_create(dict_value_name_hash,
2604 dict_value_name_cmp,
2606 if (!values_byname) {
2610 values_byvalue = fr_hash_table_create(dict_value_value_hash,
2611 dict_value_value_cmp,
2613 if (!values_byvalue) {
2617 value_fixup = NULL; /* just to be safe. */
2619 if (my_dict_init(dir, fn, NULL, 0) < 0)
2624 value_fixup_t *this, *next;
2626 for (this = value_fixup; this != NULL; this = next) {
2629 a = dict_attrbyname(this->attrstr);
2632 "dict_init: No ATTRIBUTE \"%s\" defined for VALUE \"%s\"",
2633 this->attrstr, this->dval->name);
2634 return -1; /* leak, but they should die... */
2637 this->dval->attr = a->attr;
2640 * Add the value into the dictionary.
2642 if (!fr_hash_table_replace(values_byname,
2644 fr_strerror_printf("dict_addvalue: Duplicate value name %s for attribute %s", this->dval->name, a->name);
2649 * Allow them to use the old name, but
2650 * prefer the new name when printing
2653 if (!fr_hash_table_finddata(values_byvalue, this->dval)) {
2654 fr_hash_table_replace(values_byvalue,
2660 * Just so we don't lose track of things.
2667 * Walk over all of the hash tables to ensure they're
2668 * initialized. We do this because the threads may perform
2669 * lookups, and we don't want multi-threaded re-ordering
2670 * of the table entries. That would be bad.
2672 fr_hash_table_walk(vendors_byname, null_callback, NULL);
2673 fr_hash_table_walk(vendors_byvalue, null_callback, NULL);
2675 fr_hash_table_walk(attributes_byname, null_callback, NULL);
2676 fr_hash_table_walk(attributes_byvalue, null_callback, NULL);
2678 fr_hash_table_walk(values_byvalue, null_callback, NULL);
2679 fr_hash_table_walk(values_byname, null_callback, NULL);
2684 static size_t print_attr_oid(char *buffer, size_t size, unsigned int attr,
2694 len = snprintf(buffer, size, "%u", attr & 0xff);
2698 return snprintf(buffer, size, "%u", attr);
2701 return snprintf(buffer, size, "%u", attr & 0xffff);
2705 if ((attr >> 8) == 0) return len;
2711 for (nest = 1; nest <= fr_attr_max_tlv; nest++) {
2712 if (((attr >> fr_attr_shift[nest]) & fr_attr_mask[nest]) == 0) break;
2714 len = snprintf(buffer, size, ".%u",
2715 (attr >> fr_attr_shift[nest]) & fr_attr_mask[nest]);
2725 /** Free dynamically allocated (unknown attributes)
2727 * If the da was dynamically allocated it will be freed, else the function
2728 * will return without doing anything.
2730 * @param da to free.
2732 void dict_attr_free(DICT_ATTR const **da)
2736 if (!da || !*da) return;
2738 /* Don't free real DAs */
2739 if (!(*da)->flags.is_unknown) {
2743 memcpy(&tmp, &da, sizeof(*tmp));
2750 /** Initialises a dictionary attr for unknown attributes
2752 * Initialises a dict attr for an unknown attribute/vendor/type without adding
2753 * it to dictionary pools/hashes.
2755 * @param[in,out] da struct to initialise, must be at least DICT_ATTR_SIZE bytes.
2756 * @param[in] attr number.
2757 * @param[in] vendor number.
2758 * @return 0 on success.
2760 int dict_unknown_from_fields(DICT_ATTR *da, unsigned int attr, unsigned int vendor)
2765 size_t bufsize = DICT_ATTR_MAX_NAME_LEN;
2767 memset(da, 0, DICT_ATTR_SIZE);
2770 da->vendor = vendor;
2771 da->type = PW_TYPE_OCTETS;
2772 da->flags.is_unknown = true;
2773 da->flags.is_pointer = true;
2776 * Unknown attributes of the "WiMAX" vendor get marked up
2777 * as being for WiMAX.
2779 if (vendor == VENDORPEC_WIMAX) {
2780 da->flags.wimax = 1;
2785 len = snprintf(p, bufsize, "Attr-");
2789 if (vendor > FR_MAX_VENDOR) {
2790 len = snprintf(p, bufsize, "%u.", vendor / FR_MAX_VENDOR);
2793 vendor &= (FR_MAX_VENDOR) - 1;
2800 * dv_type is the length of the vendor's type field
2801 * RFC 2865 never defined a mandatory length, so
2802 * different vendors have different length type fields.
2804 dv = dict_vendorbyvalue(vendor);
2808 len = snprintf(p, bufsize, "26.%u.", vendor);
2814 print_attr_oid(p, bufsize , attr, dv_type);
2819 /** Allocs a dictionary attr for unknown attributes
2821 * Allocs a dict attr for an unknown attribute/vendor/type without adding
2822 * it to dictionary pools/hashes.
2824 * @param[in] ctx to allocate DA in.
2825 * @param[in] attr number.
2826 * @param[in] vendor number.
2827 * @return 0 on success.
2829 DICT_ATTR const *dict_unknown_afrom_fields(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor)
2834 p = talloc_zero_array(ctx, uint8_t, DICT_ATTR_SIZE);
2836 fr_strerror_printf("Out of memory");
2839 da = (DICT_ATTR *) p;
2840 talloc_set_type(da, DICT_ATTR);
2842 if (dict_unknown_from_fields(da, attr, vendor) < 0) {
2850 /** Create a DICT_ATTR from an ASCII attribute and value
2852 * Where the attribute name is in the form:
2854 * - Attr-%d.%d.%d...
2855 * - Vendor-%d-Attr-%d
2856 * - VendorName-Attr-%d
2858 * @param[in] da to initialise.
2859 * @param[in] name of attribute.
2860 * @return 0 on success -1 on failure.
2862 int dict_unknown_from_str(DICT_ATTR *da, char const *name)
2864 unsigned int attr, vendor = 0;
2865 unsigned int dv_type = 1; /* The type of vendor field */
2867 char const *p = name;
2871 DICT_ATTR const *found;
2873 if (dict_valid_name(name) < 0) return -1;
2876 * Pull off vendor prefix first.
2878 if (strncasecmp(p, "Attr-", 5) != 0) {
2879 if (strncasecmp(p, "Vendor-", 7) == 0) {
2880 vendor = (int) strtol(p + 7, &q, 10);
2881 if ((vendor == 0) || (vendor > FR_MAX_VENDOR)) {
2882 fr_strerror_printf("Invalid vendor value in attribute name \"%s\"", name);
2889 /* must be vendor name */
2896 fr_strerror_printf("Invalid vendor name in attribute name \"%s\"", name);
2900 if ((size_t) (q - p) >= sizeof(buffer)) {
2901 fr_strerror_printf("Vendor name too long in attribute name \"%s\"", name);
2906 memcpy(buffer, p, (q - p));
2907 buffer[q - p] = '\0';
2909 vendor = dict_vendorbyname(buffer);
2911 fr_strerror_printf("Unknown name \"%s\"", name);
2920 fr_strerror_printf("Invalid text following vendor definition in attribute name \"%s\"", name);
2930 if (strncasecmp(p, "Attr-", 5) != 0) {
2931 fr_strerror_printf("Unknown attribute \"%s\"", name);
2936 attr = strtol(p + 5, &q, 10);
2942 fr_strerror_printf("Invalid value in attribute name \"%s\"", name);
2951 * VendorName-Attr-%d
2955 * Anything else is invalid.
2957 if (((vendor != 0) && (*p != '\0')) ||
2958 ((vendor == 0) && *p && (*p != '.'))) {
2960 fr_strerror_printf("Invalid OID");
2965 * Look for OIDs. Require the "Attr-26.Vendor-Id.type"
2966 * format, and disallow "Vendor-%d-Attr-%d" and
2967 * "VendorName-Attr-%d"
2969 * This section parses the Vendor-Id portion of
2970 * Attr-%d.%d. where the first number is 26, *or* an
2971 * extended name of the "evs" foundta type.
2974 found = dict_attrbyvalue(attr, 0);
2976 fr_strerror_printf("Cannot parse names without dictionaries");
2981 if ((attr != PW_VENDOR_SPECIFIC) &&
2982 !(found->flags.extended || found->flags.long_extended)) {
2983 fr_strerror_printf("Standard attributes cannot use OIDs");
2988 if ((attr == PW_VENDOR_SPECIFIC) || found->flags.evs) {
2989 vendor = strtol(p + 1, &q, 10);
2990 if ((vendor == 0) || (vendor > FR_MAX_VENDOR)) {
2991 fr_strerror_printf("Invalid vendor");
2996 if (*q != '.') goto invalid;
3000 if (found->flags.evs) vendor |= attr * FR_MAX_VENDOR;
3002 } /* else the second number is a TLV number */
3006 * Get the expected maximum size of the name.
3009 dv = dict_vendorbyvalue(vendor & (FR_MAX_VENDOR - 1));
3012 if (dv_type > 3) dv_type = 3; /* hack */
3017 * Parse the next number. It could be a Vendor-Type
3018 * of 1..2^24, or it could be a TLV.
3021 attr = strtol(p + 1, &q, 10);
3023 fr_strerror_printf("Invalid name number");
3041 * Enforce a maximum value on the attribute number.
3043 if ((vendor > 0) && (attr >= (unsigned) (1 << (dv_type << 3)))) goto invalid;
3046 if (dict_str2oid(p + 1, &attr, &vendor, 1) < 0) {
3052 * If the caller doesn't provide a DICT_ATTR
3053 * we can't call dict_unknown_from_fields.
3056 fr_strerror_printf("Unknown attributes disallowed");
3060 return dict_unknown_from_fields(da, attr, vendor);
3063 /** Create a DICT_ATTR from an ASCII attribute and value
3065 * Where the attribute name is in the form:
3067 * - Attr-%d.%d.%d...
3068 * - Vendor-%d-Attr-%d
3069 * - VendorName-Attr-%d
3071 * @param[in] ctx to alloc new attribute in.
3072 * @param[in] name of attribute.
3073 * @return 0 on success -1 on failure.
3075 DICT_ATTR const *dict_unknown_afrom_str(TALLOC_CTX *ctx, char const *name)
3080 p = talloc_zero_array(ctx, uint8_t, DICT_ATTR_SIZE);
3082 fr_strerror_printf("Out of memory");
3085 da = (DICT_ATTR *) p;
3086 talloc_set_type(da, DICT_ATTR);
3088 if (dict_unknown_from_str(da, name) < 0) {
3096 /** Create a dictionary attribute by name embedded in another string
3098 * Find the first invalid attribute name char in the string pointed
3101 * Copy the characters between the start of the name string and the first
3102 * none dict_attr_allowed_char to a buffer and initialise da as an
3103 * unknown attribute.
3105 * @param[out] da to initialise.
3106 * @param[in,out] name string start.
3107 * @return 0 on success or -1 on error;
3109 int dict_unknown_from_substr(DICT_ATTR *da, char const **name)
3113 char buffer[DICT_ATTR_MAX_NAME_LEN + 1];
3115 if (!name || !*name) return -1;
3118 * Advance p until we get something that's not part of
3119 * the dictionary attribute name.
3121 for (p = *name; dict_attr_allowed_chars[(int) *p] || (*p == '.' ) || (*p == '-'); p++);
3124 if (len > DICT_ATTR_MAX_NAME_LEN) {
3125 fr_strerror_printf("Attribute name too long");
3130 fr_strerror_printf("Invalid attribute name");
3133 strlcpy(buffer, *name, len + 1);
3135 if (dict_unknown_from_str(da, buffer) < 0) return -1;
3143 * Get an attribute by its numerical value.
3145 DICT_ATTR const *dict_attrbyvalue(unsigned int attr, unsigned int vendor)
3149 if ((attr > 0) && (attr < 256) && !vendor) return dict_base_attrs[attr];
3154 return fr_hash_table_finddata(attributes_byvalue, &da);
3158 /** Get an attribute by its numerical value and data type
3160 * Used only for COMBO_IP
3162 * @return The attribute, or NULL if not found
3164 DICT_ATTR const *dict_attrbytype(unsigned int attr, unsigned int vendor,
3173 return fr_hash_table_finddata(attributes_combo, &da);
3176 /** Using a parent and attr/vendor, find a child attr/vendor
3179 int dict_attr_child(DICT_ATTR const *parent,
3180 unsigned int *pattr, unsigned int *pvendor)
3182 unsigned int attr, vendor;
3185 if (!parent || !pattr || !pvendor) return false;
3191 * Only some types can have children
3193 switch (parent->type) {
3194 default: return false;
3199 case PW_TYPE_EXTENDED:
3200 case PW_TYPE_LONG_EXTENDED:
3204 if ((vendor == 0) && (parent->vendor != 0)) return false;
3207 * Bootstrap by starting off with the parents values.
3209 da.attr = parent->attr;
3210 da.vendor = parent->vendor;
3213 * Do various butchery to insert the "attr" value.
3215 * 00VID 000000AA normal VSA for vendor VID
3216 * 00VID DDCCBBAA normal VSAs with TLVs
3217 * EE000 000000AA extended attr (241.1)
3218 * EE000 DDCCBBAA extended attr with TLVs
3219 * EEVID 000000AA EVS with vendor VID, attr AAA
3220 * EEVID DDCCBBAA EVS with TLVs
3223 da.vendor = parent->attr * FR_MAX_VENDOR;
3224 da.vendor |= vendor;
3231 * Trying to nest too deep. It's an error
3233 if (parent->attr & (fr_attr_mask[MAX_TLV_NEST] << fr_attr_shift[MAX_TLV_NEST])) {
3237 for (i = MAX_TLV_NEST - 1; i >= 0; i--) {
3238 if ((parent->attr & (fr_attr_mask[i] << fr_attr_shift[i]))) {
3239 da.attr |= (attr & fr_attr_mask[i + 1]) << fr_attr_shift[i + 1];
3249 fprintf(stderr, "LOOKING FOR %08x %08x + %08x %08x --> %08x %08x\n",
3250 parent->vendor, parent->attr, attr, vendor,
3251 da.vendor, da.attr);
3255 *pvendor = da.vendor;
3260 * Get an attribute by it's numerical value, and the parent
3262 DICT_ATTR const *dict_attrbyparent(DICT_ATTR const *parent, unsigned int attr, unsigned int vendor)
3264 unsigned int my_attr, my_vendor;
3270 if (!dict_attr_child(parent, &my_attr, &my_vendor)) return NULL;
3273 da.vendor = my_vendor;
3275 return fr_hash_table_finddata(attributes_byvalue, &da);
3280 * Get an attribute by its name.
3282 DICT_ATTR const *dict_attrbyname(char const *name)
3285 uint32_t buffer[(sizeof(*da) + DICT_ATTR_MAX_NAME_LEN + 3)/4];
3287 if (!name) return NULL;
3289 da = (DICT_ATTR *) buffer;
3290 strlcpy(da->name, name, DICT_ATTR_MAX_NAME_LEN + 1);
3292 return fr_hash_table_finddata(attributes_byname, da);
3295 /** Look up a dictionary attribute by name embedded in another string
3297 * Find the first invalid attribute name char in the string pointed
3300 * Copy the characters between the start of the name string and the first
3301 * none dict_attr_allowed_char to a buffer and perform a dictionary lookup
3304 * If the attribute exists, advance the pointer pointed to by name
3305 * to the first none dict_attr_allowed_char char, and return the DA.
3307 * If the attribute does not exist, don't advance the pointer and return
3310 * @param[in,out] name string start.
3311 * @return NULL if no attributes matching the name could be found, else
3313 DICT_ATTR const *dict_attrbyname_substr(char const **name)
3316 DICT_ATTR const *da;
3319 uint32_t buffer[(sizeof(*find) + DICT_ATTR_MAX_NAME_LEN + 3)/4];
3321 if (!name || !*name) return NULL;
3323 find = (DICT_ATTR *) buffer;
3326 * Advance p until we get something that's not part of
3327 * the dictionary attribute name.
3329 for (p = *name; dict_attr_allowed_chars[(int) *p]; p++);
3332 if (len > DICT_ATTR_MAX_NAME_LEN) {
3333 fr_strerror_printf("Attribute name too long");
3337 strlcpy(find->name, *name, len + 1);
3339 da = fr_hash_table_finddata(attributes_byname, find);
3341 fr_strerror_printf("Unknown attribute \"%s\"", find->name);
3350 * Associate a value with an attribute and return it.
3352 DICT_VALUE *dict_valbyattr(unsigned int attr, unsigned int vendor, int value)
3354 DICT_VALUE dval, *dv;
3357 * First, look up aliases.
3360 dval.vendor = vendor;
3361 dval.name[0] = '\0';
3364 * Look up the attribute alias target, and use
3365 * the correct attribute number if found.
3367 dv = fr_hash_table_finddata(values_byname, &dval);
3368 if (dv) dval.attr = dv->value;
3372 return fr_hash_table_finddata(values_byvalue, &dval);
3376 * Associate a value with an attribute and return it.
3378 char const *dict_valnamebyattr(unsigned int attr, unsigned int vendor, int value)
3382 dv = dict_valbyattr(attr, vendor, value);
3389 * Get a value by its name, keyed off of an attribute.
3391 DICT_VALUE *dict_valbyname(unsigned int attr, unsigned int vendor, char const *name)
3393 DICT_VALUE *my_dv, *dv;
3394 uint32_t buffer[(sizeof(*my_dv) + DICT_VALUE_MAX_NAME_LEN + 3)/4];
3396 if (!name) return NULL;
3398 my_dv = (DICT_VALUE *) buffer;
3400 my_dv->vendor = vendor;
3401 my_dv->name[0] = '\0';
3404 * Look up the attribute alias target, and use
3405 * the correct attribute number if found.
3407 dv = fr_hash_table_finddata(values_byname, my_dv);
3408 if (dv) my_dv->attr = dv->value;
3410 strlcpy(my_dv->name, name, DICT_VALUE_MAX_NAME_LEN + 1);
3412 return fr_hash_table_finddata(values_byname, my_dv);
3416 * Get the vendor PEC based on the vendor name
3418 * This is efficient only for small numbers of vendors.
3420 int dict_vendorbyname(char const *name)
3423 size_t buffer[(sizeof(*dv) + DICT_VENDOR_MAX_NAME_LEN + sizeof(size_t) - 1) / sizeof(size_t)];
3425 if (!name) return 0;
3427 dv = (DICT_VENDOR *) buffer;
3428 strlcpy(dv->name, name, DICT_VENDOR_MAX_NAME_LEN + 1);
3430 dv = fr_hash_table_finddata(vendors_byname, dv);
3433 return dv->vendorpec;
3437 * Return the vendor struct based on the PEC.
3439 DICT_VENDOR *dict_vendorbyvalue(int vendorpec)
3443 dv.vendorpec = vendorpec;
3445 return fr_hash_table_finddata(vendors_byvalue, &dv);
3448 /** Converts an unknown to a known by adding it to the internal dictionaries.
3450 * Does not free old DICT_ATTR, that is left up to the caller.
3452 * @param old unknown attribute to add.
3453 * @return existing DICT_ATTR if old was found in a dictionary, else the new entry in the dictionary
3456 DICT_ATTR const *dict_unknown_add(DICT_ATTR const *old)
3458 DICT_ATTR const *da, *parent;
3461 if (!old) return NULL;
3463 if (!old->flags.is_unknown) return old;
3465 da = dict_attrbyvalue(old->attr, old->vendor);
3468 memcpy(&flags, &old->flags, sizeof(flags));
3469 flags.is_unknown = false;
3471 parent = dict_parent(old->attr, old->vendor);
3473 if (parent->flags.has_tlv) flags.is_tlv = true;
3474 flags.evs = parent->flags.evs;
3475 flags.extended = parent->flags.extended;
3476 flags.long_extended = parent->flags.long_extended;
3479 if (dict_addattr(old->name, old->attr, old->vendor, old->type, flags) < 0) {
3483 da = dict_attrbyvalue(old->attr, old->vendor);