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
23 #include <freeradius-devel/ident.h>
26 #include <freeradius-devel/libradius.h>
34 #ifdef HAVE_SYS_STAT_H
38 #define DICT_VALUE_MAX_NAME_LEN (128)
39 #define DICT_VENDOR_MAX_NAME_LEN (128)
40 #define DICT_ATTR_MAX_NAME_LEN (128)
42 static fr_hash_table_t *vendors_byname = NULL;
43 static fr_hash_table_t *vendors_byvalue = NULL;
45 static fr_hash_table_t *attributes_byname = NULL;
46 static fr_hash_table_t *attributes_byvalue = 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;
63 static char *stat_root_dir = NULL;
64 static char *stat_root_file = NULL;
66 static dict_stat_t *stat_head = NULL;
67 static dict_stat_t *stat_tail = NULL;
69 typedef struct value_fixup_t {
70 char attrstr[DICT_ATTR_MAX_NAME_LEN];
72 struct value_fixup_t *next;
77 * So VALUEs in the dictionary can have forward references.
79 static value_fixup_t *value_fixup = NULL;
81 static const FR_NAME_NUMBER type_table[] = {
82 { "integer", PW_TYPE_INTEGER },
83 { "string", PW_TYPE_STRING },
84 { "ipaddr", PW_TYPE_IPADDR },
85 { "date", PW_TYPE_DATE },
86 { "abinary", PW_TYPE_ABINARY },
87 { "octets", PW_TYPE_OCTETS },
88 { "ifid", PW_TYPE_IFID },
89 { "ipv6addr", PW_TYPE_IPV6ADDR },
90 { "ipv6prefix", PW_TYPE_IPV6PREFIX },
91 { "byte", PW_TYPE_BYTE },
92 { "short", PW_TYPE_SHORT },
93 { "ether", PW_TYPE_ETHERNET },
94 { "combo-ip", PW_TYPE_COMBO_IP },
95 { "tlv", PW_TYPE_TLV },
96 { "signed", PW_TYPE_SIGNED },
102 * Create the hash of the name.
104 * We copy the hash function here because it's substantially faster.
106 #define FNV_MAGIC_INIT (0x811c9dc5)
107 #define FNV_MAGIC_PRIME (0x01000193)
109 static uint32_t dict_hashname(const char *name)
111 uint32_t hash = FNV_MAGIC_INIT;
114 for (p = name; *p != '\0'; p++) {
115 int c = *(const unsigned char *) p;
116 if (isalpha(c)) c = tolower(c);
118 hash *= FNV_MAGIC_PRIME;
119 hash ^= (uint32_t ) (c & 0xff);
127 * Hash callback functions.
129 static uint32_t dict_attr_name_hash(const void *data)
131 return dict_hashname(((const DICT_ATTR *)data)->name);
134 static int dict_attr_name_cmp(const void *one, const void *two)
136 const DICT_ATTR *a = one;
137 const DICT_ATTR *b = two;
139 return strcasecmp(a->name, b->name);
142 static uint32_t dict_attr_value_hash(const void *data)
145 const DICT_ATTR *attr = data;
147 hash = fr_hash(&attr->vendor, sizeof(attr->vendor));
148 return fr_hash_update(&attr->attr, sizeof(attr->attr), hash);
151 static int dict_attr_value_cmp(const void *one, const void *two)
153 const DICT_ATTR *a = one;
154 const DICT_ATTR *b = two;
156 if (a->vendor < b->vendor) return -1;
157 if (a->vendor > b->vendor) return +1;
159 return a->attr - b->attr;
162 static uint32_t dict_vendor_name_hash(const void *data)
164 return dict_hashname(((const DICT_VENDOR *)data)->name);
167 static int dict_vendor_name_cmp(const void *one, const void *two)
169 const DICT_VENDOR *a = one;
170 const DICT_VENDOR *b = two;
172 return strcasecmp(a->name, b->name);
175 static uint32_t dict_vendor_value_hash(const void *data)
177 return fr_hash(&(((const DICT_VENDOR *)data)->vendorpec),
178 sizeof(((const DICT_VENDOR *)data)->vendorpec));
181 static int dict_vendor_value_cmp(const void *one, const void *two)
183 const DICT_VENDOR *a = one;
184 const DICT_VENDOR *b = two;
186 return a->vendorpec - b->vendorpec;
189 static uint32_t dict_value_name_hash(const void *data)
192 const DICT_VALUE *dval = data;
194 hash = dict_hashname(dval->name);
195 return fr_hash_update(&dval->attr, sizeof(dval->attr), hash);
198 static int dict_value_name_cmp(const void *one, const void *two)
201 const DICT_VALUE *a = one;
202 const DICT_VALUE *b = two;
204 rcode = a->attr - b->attr;
205 if (rcode != 0) return rcode;
207 return strcasecmp(a->name, b->name);
210 static uint32_t dict_value_value_hash(const void *data)
213 const DICT_VALUE *dval = data;
215 hash = fr_hash(&dval->attr, sizeof(dval->attr));
216 return fr_hash_update(&dval->value, sizeof(dval->value), hash);
219 static int dict_value_value_cmp(const void *one, const void *two)
222 const DICT_VALUE *a = one;
223 const DICT_VALUE *b = two;
225 rcode = a->attr - b->attr;
226 if (rcode != 0) return rcode;
228 return a->value - b->value;
233 * Free the list of stat buffers
235 static void dict_stat_free(void)
237 dict_stat_t *this, *next;
240 stat_root_dir = NULL;
241 free(stat_root_file);
242 stat_root_file = NULL;
249 for (this = stat_head; this != NULL; this = next) {
255 stat_head = stat_tail = NULL;
260 * Add an entry to the list of stat buffers.
262 static void dict_stat_add(const char *name, const struct stat *stat_buf)
266 this = malloc(sizeof(*this));
268 memset(this, 0, sizeof(*this));
270 this->name = strdup(name);
271 this->mtime = stat_buf->st_mtime;
274 stat_head = stat_tail = this;
276 stat_tail->next = this;
283 * See if any dictionaries have changed. If not, don't
286 static int dict_stat_check(const char *root_dir, const char *root_file)
291 if (!stat_root_dir) return 0;
292 if (!stat_root_file) return 0;
294 if (strcmp(root_dir, stat_root_dir) != 0) return 0;
295 if (strcmp(root_file, stat_root_file) != 0) return 0;
297 if (!stat_head) return 0; /* changed, reload */
299 for (this = stat_head; this != NULL; this = this->next) {
300 if (stat(this->name, &buf) < 0) return 0;
302 if (buf.st_mtime != this->mtime) return 0;
308 typedef struct fr_pool_t {
311 struct fr_pool_t *page_free;
312 struct fr_pool_t *page_next;
315 #define FR_POOL_SIZE (32768)
316 #define FR_ALLOC_ALIGN (8)
318 static fr_pool_t *dict_pool = NULL;
320 static fr_pool_t *fr_pool_create(void)
322 fr_pool_t *fp = malloc(FR_POOL_SIZE);
324 if (!fp) return NULL;
326 fp->page_end = ((uint8_t *) fp) + FR_POOL_SIZE;
327 fp->free_ptr = ((uint8_t *) fp) + sizeof(*fp);
329 fp->page_next = NULL;
333 static void fr_pool_delete(fr_pool_t **pfp)
335 fr_pool_t *fp, *next;
337 if (!pfp || !*pfp) return;
339 for (fp = *pfp; fp != NULL; fp = next) {
340 next = fp->page_next;
346 static void *fr_pool_alloc(size_t size)
350 if (size == 0) return NULL;
352 if (size > 256) return NULL; /* shouldn't happen */
355 dict_pool = fr_pool_create();
356 if (!dict_pool) return NULL;
359 if ((size & (FR_ALLOC_ALIGN - 1)) != 0) {
360 size += FR_ALLOC_ALIGN - (size & (FR_ALLOC_ALIGN - 1));
363 if ((((uint8_t *) dict_pool->page_free->free_ptr) + size) > (uint8_t *) dict_pool->page_free->page_end) {
364 dict_pool->page_free->page_next = fr_pool_create();
365 if (!dict_pool->page_free->page_next) return NULL;
366 dict_pool->page_free = dict_pool->page_free->page_next;
369 ptr = dict_pool->page_free->free_ptr;
370 dict_pool->page_free->free_ptr = ((uint8_t *) dict_pool->page_free->free_ptr) + size;
376 static void fr_pool_free(UNUSED void *ptr)
379 * Place-holder for later code.
384 * Free the dictionary_attributes and dictionary_values lists.
391 fr_hash_table_free(vendors_byname);
392 fr_hash_table_free(vendors_byvalue);
393 vendors_byname = NULL;
394 vendors_byvalue = NULL;
396 fr_hash_table_free(attributes_byname);
397 fr_hash_table_free(attributes_byvalue);
398 attributes_byname = NULL;
399 attributes_byvalue = NULL;
401 fr_hash_table_free(values_byname);
402 fr_hash_table_free(values_byvalue);
403 values_byname = NULL;
404 values_byvalue = NULL;
406 memset(dict_base_attrs, 0, sizeof(dict_base_attrs));
408 fr_pool_delete(&dict_pool);
415 * Add vendor to the list.
417 int dict_addvendor(const char *name, int value)
422 if (value >= 32767) {
423 librad_log("dict_addvendor: Cannot handle vendor ID larger than 65535");
427 if ((length = strlen(name)) >= DICT_VENDOR_MAX_NAME_LEN) {
428 librad_log("dict_addvendor: vendor name too long");
432 if ((dv = fr_pool_alloc(sizeof(*dv) + length)) == NULL) {
433 librad_log("dict_addvendor: out of memory");
437 strcpy(dv->name, name);
438 dv->vendorpec = value;
439 dv->type = dv->length = 1; /* defaults */
441 if (!fr_hash_table_insert(vendors_byname, dv)) {
444 old_dv = fr_hash_table_finddata(vendors_byname, dv);
446 librad_log("dict_addvendor: Failed inserting vendor name %s", name);
449 if (old_dv->vendorpec != dv->vendorpec) {
450 librad_log("dict_addvendor: Duplicate vendor name %s", name);
455 * Already inserted. Discard the duplicate entry.
462 * Insert the SAME pointer (not free'd when this table is
463 * deleted), into another table.
465 * We want this behaviour because we want OLD names for
466 * the attributes to be read from the configuration
467 * files, but when we're printing them, (and looking up
468 * by value) we want to use the NEW name.
470 if (!fr_hash_table_replace(vendors_byvalue, dv)) {
471 librad_log("dict_addvendor: Failed inserting vendor %s",
480 * Add an attribute to the dictionary.
482 int dict_addattr(const char *name, int vendor, int type, int value,
486 static int max_attr = 0;
489 namelen = strlen(name);
490 if (namelen >= DICT_ATTR_MAX_NAME_LEN) {
491 librad_log("dict_addattr: attribute name too long");
496 * If the value is '-1', that means use a pre-existing
497 * one (if it already exists). If one does NOT already exist,
498 * then create a new attribute, with a non-conflicting value,
502 if (dict_attrbyname(name)) {
503 return 0; /* exists, don't add it again */
508 } else if (vendor == 0) {
512 if (value > max_attr) {
518 librad_log("dict_addattr: ATTRIBUTE has invalid number (less than zero)");
522 if (value >= 65536) {
523 librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 65535).");
529 static DICT_VENDOR *last_vendor = NULL;
531 if (flags.is_tlv && (flags.encrypt != FLAG_ENCRYPT_NONE)) {
532 librad_log("Sub-TLV's cannot be encrypted");
536 if (flags.has_tlv && (flags.encrypt != FLAG_ENCRYPT_NONE)) {
537 librad_log("TLV's cannot be encrypted");
541 if (flags.is_tlv && flags.has_tag) {
542 librad_log("Sub-TLV's cannot have a tag");
546 if (flags.has_tlv && flags.has_tag) {
547 librad_log("TLV's cannot have a tag");
552 * Most ATTRIBUTEs are bunched together by
553 * VENDOR. We can save a lot of lookups on
554 * dictionary initialization by caching the last
557 if (last_vendor && (vendor == last_vendor->vendorpec)) {
560 dv = dict_vendorbyvalue(vendor);
565 * If the vendor isn't defined, die.
568 librad_log("dict_addattr: Unknown vendor");
573 * FIXME: Switch over dv->type, and limit things
576 if ((dv->type == 1) && (value >= 256) && !flags.is_tlv) {
577 librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 255).");
579 } /* else 256..65535 are allowed */
583 * Create a new attribute for the list
585 if ((attr = fr_pool_alloc(sizeof(*attr) + namelen)) == NULL) {
586 librad_log("dict_addattr: out of memory");
590 memcpy(attr->name, name, namelen);
591 attr->name[namelen] = '\0';
593 attr->attr |= (vendor << 16); /* FIXME: hack */
594 attr->vendor = vendor;
597 attr->vendor = vendor;
600 * Insert the attribute, only if it's not a duplicate.
602 if (!fr_hash_table_insert(attributes_byname, attr)) {
606 * If the attribute has identical number, then
607 * ignore the duplicate.
609 a = fr_hash_table_finddata(attributes_byname, attr);
610 if (a && (strcasecmp(a->name, attr->name) == 0)) {
611 if (a->attr != attr->attr) {
612 librad_log("dict_addattr: Duplicate attribute name %s", name);
618 * Same name, same vendor, same attr,
619 * maybe the flags and/or type is
620 * different. Let the new value
621 * over-ride the old one.
626 fr_hash_table_delete(attributes_byvalue, a);
628 if (!fr_hash_table_replace(attributes_byname, attr)) {
629 librad_log("dict_addattr: Internal error storing attribute %s", name);
636 * Insert the SAME pointer (not free'd when this entry is
637 * deleted), into another table.
639 * We want this behaviour because we want OLD names for
640 * the attributes to be read from the configuration
641 * files, but when we're printing them, (and looking up
642 * by value) we want to use the NEW name.
644 if (!fr_hash_table_replace(attributes_byvalue, attr)) {
645 librad_log("dict_addattr: Failed inserting attribute name %s", name);
649 if (!vendor && (value > 0) && (value < 256)) {
650 dict_base_attrs[value] = attr;
658 * Add a value for an attribute to the dictionary.
660 int dict_addvalue(const char *namestr, const char *attrstr, int value)
666 static DICT_ATTR *last_attr = NULL;
669 librad_log("dict_addvalue: empty names are not permitted");
673 if ((length = strlen(namestr)) >= DICT_VALUE_MAX_NAME_LEN) {
674 librad_log("dict_addvalue: value name too long");
678 if ((dval = fr_pool_alloc(sizeof(*dval) + length)) == NULL) {
679 librad_log("dict_addvalue: out of memory");
682 memset(dval, 0, sizeof(*dval));
684 strcpy(dval->name, namestr);
688 * Most VALUEs are bunched together by ATTRIBUTE. We can
689 * save a lot of lookups on dictionary initialization by
690 * caching the last attribute.
692 if (last_attr && (strcasecmp(attrstr, last_attr->name) == 0)) {
695 dattr = dict_attrbyname(attrstr);
700 * Remember which attribute is associated with this
701 * value, if possible.
704 if (dattr->flags.has_value_alias) {
705 librad_log("dict_addvalue: Cannot add VALUE for ATTRIBUTE \"%s\": It already has a VALUE-ALIAS", attrstr);
709 dval->attr = dattr->attr;
712 * Enforce valid values
714 * Don't worry about fixups...
716 switch (dattr->type) {
720 librad_log("dict_addvalue: ATTRIBUTEs of type 'byte' cannot have VALUEs larger than 255");
727 librad_log("dict_addvalue: ATTRIBUTEs of type 'short' cannot have VALUEs larger than 65535");
733 * Allow octets for now, because
734 * of dictionary.cablelabs
738 case PW_TYPE_INTEGER:
743 librad_log("dict_addvalue: VALUEs cannot be defined for attributes of type '%s'",
744 fr_int2str(type_table, dattr->type, "?Unknown?"));
748 dattr->flags.has_value = 1;
750 value_fixup_t *fixup;
752 fixup = (value_fixup_t *) malloc(sizeof(*fixup));
755 librad_log("dict_addvalue: out of memory");
758 memset(fixup, 0, sizeof(*fixup));
760 strlcpy(fixup->attrstr, attrstr, sizeof(fixup->attrstr));
764 * Insert to the head of the list.
766 fixup->next = value_fixup;
773 * Add the value into the dictionary.
775 if (!fr_hash_table_insert(values_byname, dval)) {
780 * Suppress duplicates with the same
781 * name and value. There are lots in
784 old = dict_valbyname(dattr->attr, namestr);
785 if (old && (old->value == dval->value)) {
792 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", namestr, attrstr);
797 * There are multiple VALUE's, keyed by attribute, so we
798 * take care of that here.
800 if (!fr_hash_table_replace(values_byvalue, dval)) {
801 librad_log("dict_addvalue: Failed inserting value %s",
809 static int sscanf_i(const char *str, int *pvalue)
813 const char *tab = "0123456789";
815 if ((str[0] == '0') &&
816 ((str[1] == 'x') || (str[1] == 'X'))) {
817 tab = "0123456789abcdef";
826 c = memchr(tab, tolower((int) *str), base);
840 * Process the ATTRIBUTE command
842 static int process_attribute(const char* fn, const int line,
843 const int block_vendor, DICT_ATTR *block_tlv,
844 char **argv, int argc)
851 if ((argc < 3) || (argc > 4)) {
852 librad_log("dict_init: %s[%d]: invalid ATTRIBUTE line",
858 * Validate all entries
860 if (!sscanf_i(argv[1], &value)) {
861 librad_log("dict_init: %s[%d]: invalid value", fn, line);
866 * find the type of the attribute.
868 type = fr_str2int(type_table, argv[2], -1);
870 librad_log("dict_init: %s[%d]: invalid type \"%s\"",
876 * Only look up the vendor if the string
879 memset(&flags, 0, sizeof(flags));
881 char *key, *next, *last;
885 next = strchr(key, ',');
886 if (next) *(next++) = '\0';
888 if (strcmp(key, "has_tag") == 0 ||
889 strcmp(key, "has_tag=1") == 0) {
890 /* Boolean flag, means this is a
894 } else if (strncmp(key, "encrypt=", 8) == 0) {
895 /* Encryption method, defaults to 0 (none).
896 Currently valid is just type 2,
897 Tunnel-Password style, which can only
898 be applied to strings. */
899 flags.encrypt = strtol(key + 8, &last, 0);
901 librad_log( "dict_init: %s[%d] invalid option %s",
906 } else if (strncmp(key, "array", 8) == 0) {
913 case PW_TYPE_INTEGER:
918 librad_log( "dict_init: %s[%d] Only IP addresses can have the \"array\" flag set.",
923 } else if (block_vendor) {
924 librad_log( "dict_init: %s[%d]: unknown option \"%s\"",
929 /* Must be a vendor 'flag'... */
930 if (strncmp(key, "vendor=", 7) == 0) {
935 vendor = dict_vendorbyname(key);
937 librad_log( "dict_init: %s[%d]: unknown vendor \"%s\"",
941 if (block_vendor && argv[3][0] &&
942 (block_vendor != vendor)) {
943 librad_log("dict_init: %s[%d]: mismatched vendor %s within BEGIN-VENDOR/END-VENDOR block",
950 if (key && !*key) break;
954 if (block_vendor) vendor = block_vendor;
957 * Special checks for tags, they make our life much more
962 * Only string, octets, and integer can be tagged.
966 case PW_TYPE_INTEGER:
970 librad_log("dict_init: %s[%d]: Attributes of type %s cannot be tagged.",
972 fr_int2str(type_table, type, "?Unknown?"));
978 if (type == PW_TYPE_TLV) {
984 * TLV's can be only one octet.
986 if ((value <= 0) || (value > 255)) {
987 librad_log( "dict_init: %s[%d]: sub-tlv's cannot have value > 255",
992 if (flags.encrypt != FLAG_ENCRYPT_NONE) {
993 librad_log( "dict_init: %s[%d]: sub-tlv's cannot be encrypted",
1002 value |= (block_tlv->attr & 0xffff);
1009 if (dict_addattr(argv[0], vendor, type, value, flags) < 0) {
1010 librad_log("dict_init: %s[%d]: %s",
1011 fn, line, librad_errstr);
1020 * Process the VALUE command
1022 static int process_value(const char* fn, const int line, char **argv,
1028 librad_log("dict_init: %s[%d]: invalid VALUE line",
1033 * For Compatibility, skip "Server-Config"
1035 if (strcasecmp(argv[0], "Server-Config") == 0)
1039 * Validate all entries
1041 if (!sscanf_i(argv[2], &value)) {
1042 librad_log("dict_init: %s[%d]: invalid value",
1047 if (dict_addvalue(argv[1], argv[0], value) < 0) {
1048 librad_log("dict_init: %s[%d]: %s",
1049 fn, line, librad_errstr);
1058 * Process the VALUE-ALIAS command
1060 * This allows VALUE mappings to be shared among multiple
1063 static int process_value_alias(const char* fn, const int line, char **argv,
1066 DICT_ATTR *my_da, *da;
1070 librad_log("dict_init: %s[%d]: invalid VALUE-ALIAS line",
1075 my_da = dict_attrbyname(argv[0]);
1077 librad_log("dict_init: %s[%d]: ATTRIBUTE \"%s\" does not exist",
1082 if (my_da->flags.has_value) {
1083 librad_log("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" with pre-existing VALUE",
1088 if (my_da->flags.has_value_alias) {
1089 librad_log("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" with pre-existing VALUE-ALIAS",
1094 da = dict_attrbyname(argv[1]);
1096 librad_log("dict_init: %s[%d]: Cannot find ATTRIBUTE \"%s\" for alias",
1101 if (!da->flags.has_value) {
1102 librad_log("dict_init: %s[%d]: VALUE-ALIAS cannot refer to ATTRIBUTE %s: It has no values",
1107 if (da->flags.has_value_alias) {
1108 librad_log("dict_init: %s[%d]: Cannot add VALUE-ALIAS to ATTRIBUTE \"%s\" which itself has a VALUE-ALIAS",
1113 if (my_da->type != da->type) {
1114 librad_log("dict_init: %s[%d]: Cannot add VALUE-ALIAS between attributes of differing type",
1119 if ((dval = fr_pool_alloc(sizeof(*dval))) == NULL) {
1120 librad_log("dict_addvalue: out of memory");
1123 memset(dval, 0, sizeof(*dval));
1125 dval->name[0] = '\0'; /* empty name */
1126 dval->attr = my_da->attr;
1127 dval->value = da->attr;
1129 if (!fr_hash_table_insert(values_byname, dval)) {
1130 librad_log("dict_init: %s[%d]: Error create alias",
1141 * Process the VENDOR command
1143 static int process_vendor(const char* fn, const int line, char **argv,
1147 int continuation = 0;
1148 const char *format = NULL;
1150 if ((argc < 2) || (argc > 3)) {
1151 librad_log( "dict_init: %s[%d] invalid VENDOR entry",
1157 * Validate all entries
1159 if (!isdigit((int) argv[1][0])) {
1160 librad_log("dict_init: %s[%d]: invalid value",
1164 value = atoi(argv[1]);
1166 /* Create a new VENDOR entry for the list */
1167 if (dict_addvendor(argv[0], value) < 0) {
1168 librad_log("dict_init: %s[%d]: %s",
1169 fn, line, librad_errstr);
1174 * Look for a format statement
1179 } else if (value == VENDORPEC_USR) { /* catch dictionary screw-ups */
1180 format = "format=4,0";
1182 } else if (value == VENDORPEC_LUCENT) {
1183 format = "format=2,1";
1185 } else if (value == VENDORPEC_STARENT) {
1186 format = "format=2,2";
1188 } /* else no fixups to do */
1195 if (strncasecmp(format, "format=", 7) != 0) {
1196 librad_log("dict_init: %s[%d]: Invalid format for VENDOR. Expected \"format=\", got \"%s\"",
1202 if ((strlen(p) < 3) ||
1203 !isdigit((int) p[0]) ||
1205 !isdigit((int) p[2]) ||
1206 (p[3] && (p[3] != ','))) {
1207 librad_log("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
1212 type = (int) (p[0] - '0');
1213 length = (int) (p[2] - '0');
1216 if ((p[4] != 'c') ||
1218 librad_log("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
1225 dv = dict_vendorbyvalue(value);
1227 librad_log("dict_init: %s[%d]: Failed adding format for VENDOR",
1232 if ((type != 1) && (type != 2) && (type != 4)) {
1233 librad_log("dict_init: %s[%d]: invalid type value %d for VENDOR",
1238 if ((length != 0) && (length != 1) && (length != 2)) {
1239 librad_log("dict_init: %s[%d]: invalid length value %d for VENDOR",
1245 dv->length = length;
1246 dv->flags = continuation;
1253 * String split routine. Splits an input string IN PLACE
1254 * into pieces, based on spaces.
1256 static int str2argv(char *str, char **argv, int max_argc)
1261 if (argc >= max_argc) return argc;
1264 * Chop out comments early.
1271 while ((*str == ' ') ||
1274 (*str == '\n')) *(str++) = '\0';
1276 if (!*str) return argc;
1285 (*str != '\n')) str++;
1291 #define MAX_ARGV (16)
1294 * Initialize the dictionary.
1296 static int my_dict_init(const char *dir, const char *fn,
1297 const char *src_file, int src_line)
1306 struct stat statbuf;
1307 char *argv[MAX_ARGV];
1309 DICT_ATTR *da, *block_tlv = NULL;
1311 if (strlen(fn) >= sizeof(dirtmp) / 2 ||
1312 strlen(dir) >= sizeof(dirtmp) / 2) {
1313 librad_log("dict_init: filename name too long");
1318 * First see if fn is relative to dir. If so, create
1319 * new filename. If not, remember the absolute dir.
1321 if ((p = strrchr(fn, FR_DIR_SEP)) != NULL) {
1325 } else if (dir && dir[0] && strcmp(dir, ".") != 0) {
1326 snprintf(dirtmp, sizeof(dirtmp), "%s/%s", dir, fn);
1330 if ((fp = fopen(fn, "r")) == NULL) {
1332 librad_log("dict_init: Couldn't open dictionary \"%s\": %s",
1333 fn, strerror(errno));
1335 librad_log("dict_init: %s[%d]: Couldn't open dictionary \"%s\": %s",
1336 src_file, src_line, fn, strerror(errno));
1341 stat(fn, &statbuf); /* fopen() guarantees this will succeed */
1342 if (!S_ISREG(statbuf.st_mode)) {
1344 librad_log("dict_init: Dictionary \"%s\" is not a regular file",
1350 * Globally writable dictionaries means that users can control
1351 * the server configuration with little difficulty.
1354 if ((statbuf.st_mode & S_IWOTH) != 0) {
1356 librad_log("dict_init: Dictionary \"%s\" is globally writable. Refusing to start due to insecure configuration.",
1362 dict_stat_add(fn, &statbuf);
1365 * Seed the random pool with data.
1367 fr_rand_seed(&statbuf, sizeof(statbuf));
1371 while (fgets(buf, sizeof(buf), fp) != NULL) {
1373 if (buf[0] == '#' || buf[0] == 0 ||
1374 buf[0] == '\n' || buf[0] == '\r')
1378 * Comment characters should NOT be appearing anywhere but
1379 * as start of a comment;
1381 p = strchr(buf, '#');
1384 argc = str2argv(buf, argv, MAX_ARGV);
1385 if (argc == 0) continue;
1388 librad_log( "dict_init: %s[%d] invalid entry",
1395 * Process VALUE lines.
1397 if (strcasecmp(argv[0], "VALUE") == 0) {
1398 if (process_value(fn, line,
1399 argv + 1, argc - 1) == -1) {
1407 * Perhaps this is an attribute.
1409 if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
1410 if (process_attribute(fn, line, block_vendor,
1412 argv + 1, argc - 1) == -1) {
1420 * See if we need to import another dictionary.
1422 if (strcasecmp(argv[0], "$INCLUDE") == 0) {
1423 if (my_dict_init(dir, argv[1], fn, line) < 0) {
1430 if (strcasecmp(argv[0], "VALUE-ALIAS") == 0) {
1431 if (process_value_alias(fn, line,
1432 argv + 1, argc - 1) == -1) {
1440 * Process VENDOR lines.
1442 if (strcasecmp(argv[0], "VENDOR") == 0) {
1443 if (process_vendor(fn, line,
1444 argv + 1, argc - 1) == -1) {
1451 if (strcasecmp(argv[0], "BEGIN-TLV") == 0) {
1454 "dict_init: %s[%d] invalid BEGIN-TLV entry",
1460 da = dict_attrbyname(argv[1]);
1463 "dict_init: %s[%d]: unknown attribute %s",
1469 if (da->type != PW_TYPE_TLV) {
1471 "dict_init: %s[%d]: attribute %s is not of type tlv",
1481 if (strcasecmp(argv[0], "END-TLV") == 0) {
1484 "dict_init: %s[%d] invalid END-TLV entry",
1490 da = dict_attrbyname(argv[1]);
1493 "dict_init: %s[%d]: unknown attribute %s",
1499 if (da != block_tlv) {
1501 "dict_init: %s[%d]: END-TLV %s does not match any previous BEGIN-TLV",
1510 if (strcasecmp(argv[0], "BEGIN-VENDOR") == 0) {
1513 "dict_init: %s[%d] invalid BEGIN-VENDOR entry",
1519 vendor = dict_vendorbyname(argv[1]);
1522 "dict_init: %s[%d]: unknown vendor %s",
1527 block_vendor = vendor;
1529 } /* BEGIN-VENDOR */
1531 if (strcasecmp(argv[0], "END-VENDOR") == 0) {
1534 "dict_init: %s[%d] invalid END-VENDOR entry",
1540 vendor = dict_vendorbyname(argv[1]);
1543 "dict_init: %s[%d]: unknown vendor %s",
1549 if (vendor != block_vendor) {
1551 "dict_init: %s[%d]: END-VENDOR %s does not match any previous BEGIN-VENDOR",
1561 * Any other string: We don't recognize it.
1563 librad_log("dict_init: %s[%d] invalid keyword \"%s\"",
1574 * Empty callback for hash table initialization.
1576 static int null_callback(void *ctx, void *data)
1578 ctx = ctx; /* -Wunused */
1579 data = data; /* -Wunused */
1586 * Initialize the directory, then fix the attr member of
1589 int dict_init(const char *dir, const char *fn)
1592 * Check if we need to change anything. If not, don't do
1595 if (dict_stat_check(dir, fn)) {
1600 * Free the dictionaries, and the stat cache.
1603 stat_root_dir = strdup(dir);
1604 stat_root_file = strdup(fn);
1607 * Create the table of vendor by name. There MAY NOT
1608 * be multiple vendors of the same name.
1610 * Each vendor is malloc'd, so the free function is free.
1612 vendors_byname = fr_hash_table_create(dict_vendor_name_hash,
1613 dict_vendor_name_cmp,
1615 if (!vendors_byname) {
1620 * Create the table of vendors by value. There MAY
1621 * be vendors of the same value. If there are, we
1622 * pick the latest one.
1624 vendors_byvalue = fr_hash_table_create(dict_vendor_value_hash,
1625 dict_vendor_value_cmp,
1627 if (!vendors_byvalue) {
1632 * Create the table of attributes by name. There MAY NOT
1633 * be multiple attributes of the same name.
1635 * Each attribute is malloc'd, so the free function is free.
1637 attributes_byname = fr_hash_table_create(dict_attr_name_hash,
1640 if (!attributes_byname) {
1645 * Create the table of attributes by value. There MAY
1646 * be attributes of the same value. If there are, we
1647 * pick the latest one.
1649 attributes_byvalue = fr_hash_table_create(dict_attr_value_hash,
1650 dict_attr_value_cmp,
1652 if (!attributes_byvalue) {
1656 values_byname = fr_hash_table_create(dict_value_name_hash,
1657 dict_value_name_cmp,
1659 if (!values_byname) {
1663 values_byvalue = fr_hash_table_create(dict_value_value_hash,
1664 dict_value_value_cmp,
1666 if (!values_byvalue) {
1670 value_fixup = NULL; /* just to be safe. */
1672 if (my_dict_init(dir, fn, NULL, 0) < 0)
1677 value_fixup_t *this, *next;
1679 for (this = value_fixup; this != NULL; this = next) {
1682 a = dict_attrbyname(this->attrstr);
1685 "dict_init: No ATTRIBUTE \"%s\" defined for VALUE \"%s\"",
1686 this->attrstr, this->dval->name);
1687 return -1; /* leak, but they should die... */
1690 this->dval->attr = a->attr;
1693 * Add the value into the dictionary.
1695 if (!fr_hash_table_replace(values_byname,
1697 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", this->dval->name, a->name);
1702 * Allow them to use the old name, but
1703 * prefer the new name when printing
1706 if (!fr_hash_table_finddata(values_byvalue, this->dval)) {
1707 fr_hash_table_replace(values_byvalue,
1713 * Just so we don't lose track of things.
1720 * Walk over all of the hash tables to ensure they're
1721 * initialized. We do this because the threads may perform
1722 * lookups, and we don't want multi-threaded re-ordering
1723 * of the table entries. That would be bad.
1725 fr_hash_table_walk(vendors_byname, null_callback, NULL);
1726 fr_hash_table_walk(vendors_byvalue, null_callback, NULL);
1728 fr_hash_table_walk(attributes_byname, null_callback, NULL);
1729 fr_hash_table_walk(attributes_byvalue, null_callback, NULL);
1731 fr_hash_table_walk(values_byvalue, null_callback, NULL);
1732 fr_hash_table_walk(values_byname, null_callback, NULL);
1738 * Get an attribute by its numerical value.
1740 DICT_ATTR *dict_attrbyvalue(int attr)
1744 if ((attr > 0) && (attr < 256)) return dict_base_attrs[attr];
1747 dattr.vendor = VENDOR(attr) & 0x7fff;
1749 return fr_hash_table_finddata(attributes_byvalue, &dattr);
1753 * Get an attribute by its name.
1755 DICT_ATTR *dict_attrbyname(const char *name)
1758 uint32_t buffer[(sizeof(*da) + DICT_ATTR_MAX_NAME_LEN + 3)/4];
1760 if (!name) return NULL;
1762 da = (DICT_ATTR *) buffer;
1763 strlcpy(da->name, name, DICT_ATTR_MAX_NAME_LEN + 1);
1765 return fr_hash_table_finddata(attributes_byname, da);
1769 * Associate a value with an attribute and return it.
1771 DICT_VALUE *dict_valbyattr(int attr, int value)
1773 DICT_VALUE dval, *dv;
1776 * First, look up aliases.
1779 dval.name[0] = '\0';
1782 * Look up the attribute alias target, and use
1783 * the correct attribute number if found.
1785 dv = fr_hash_table_finddata(values_byname, &dval);
1786 if (dv) dval.attr = dv->value;
1790 return fr_hash_table_finddata(values_byvalue, &dval);
1794 * Get a value by its name, keyed off of an attribute.
1796 DICT_VALUE *dict_valbyname(int attr, const char *name)
1798 DICT_VALUE *my_dv, *dv;
1799 uint32_t buffer[(sizeof(*my_dv) + DICT_VALUE_MAX_NAME_LEN + 3)/4];
1801 if (!name) return NULL;
1803 my_dv = (DICT_VALUE *) buffer;
1805 my_dv->name[0] = '\0';
1808 * Look up the attribute alias target, and use
1809 * the correct attribute number if found.
1811 dv = fr_hash_table_finddata(values_byname, my_dv);
1812 if (dv) my_dv->attr = dv->value;
1814 strlcpy(my_dv->name, name, DICT_VALUE_MAX_NAME_LEN + 1);
1816 return fr_hash_table_finddata(values_byname, my_dv);
1820 * Get the vendor PEC based on the vendor name
1822 * This is efficient only for small numbers of vendors.
1824 int dict_vendorbyname(const char *name)
1827 uint32_t buffer[(sizeof(*dv) + DICT_VENDOR_MAX_NAME_LEN + 3)/4];
1829 if (!name) return 0;
1831 dv = (DICT_VENDOR *) buffer;
1832 strlcpy(dv->name, name, DICT_VENDOR_MAX_NAME_LEN + 1);
1834 dv = fr_hash_table_finddata(vendors_byname, dv);
1837 return dv->vendorpec;
1841 * Return the vendor struct based on the PEC.
1843 DICT_VENDOR *dict_vendorbyvalue(int vendorpec)
1847 dv.vendorpec = vendorpec;
1849 return fr_hash_table_finddata(vendors_byvalue, &dv);