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 The FreeRADIUS server project
23 static const char rcsid[] = "$Id$";
35 #ifdef HAVE_SYS_STAT_H
42 #include "libradius.h"
44 #define DICT_VALUE_MAX_NAME_LEN (128)
45 #define DICT_VENDOR_MAX_NAME_LEN (128)
47 static lrad_hash_table_t *vendors_byname = NULL;
48 static lrad_hash_table_t *vendors_byvalue = NULL;
50 static lrad_hash_table_t *attributes_byname = NULL;
51 static lrad_hash_table_t *attributes_byvalue = NULL;
53 static lrad_hash_table_t *values_byvalue = NULL;
54 static lrad_hash_table_t *values_byname = NULL;
57 * For faster HUP's, we cache the stat information for
58 * files we've $INCLUDEd
60 typedef struct dict_stat_t {
61 struct dict_stat_t *next;
66 static char *stat_root_dir = NULL;
67 static char *stat_root_file = NULL;
69 static dict_stat_t *stat_head = NULL;
70 static dict_stat_t *stat_tail = NULL;
72 typedef struct value_fixup_t {
76 struct value_fixup_t *next;
81 * So VALUEs in the dictionary can have forward references.
83 static value_fixup_t *value_fixup = NULL;
85 static const LRAD_NAME_NUMBER type_table[] = {
86 { "string", PW_TYPE_STRING },
87 { "integer", PW_TYPE_INTEGER },
88 { "ipaddr", PW_TYPE_IPADDR },
89 { "date", PW_TYPE_DATE },
90 { "abinary", PW_TYPE_ABINARY },
91 { "octets", PW_TYPE_OCTETS },
92 { "ifid", PW_TYPE_IFID },
93 { "ipv6addr", PW_TYPE_IPV6ADDR },
94 { "ipv6prefix", PW_TYPE_IPV6PREFIX },
99 * Create the hash of the name.
101 static uint32_t dict_hashname(const char *name)
110 while (*p && (len < sizeof(buffer))) {
112 *(q++) = tolower((int) *(p++));
118 return lrad_hash(buffer, len);
123 * Free the list of stat buffers
125 static void dict_stat_free(void)
127 dict_stat_t *this, *next;
130 stat_root_dir = NULL;
131 free(stat_root_file);
132 stat_root_file = NULL;
139 for (this = stat_head; this != NULL; this = next) {
145 stat_head = stat_tail = NULL;
150 * Add an entry to the list of stat buffers.
152 static void dict_stat_add(const char *name, const struct stat *stat_buf)
156 this = malloc(sizeof(*this));
157 memset(this, 0, sizeof(*this));
159 this->name = strdup(name);
160 this->mtime = stat_buf->st_mtime;
163 stat_head = stat_tail = this;
165 stat_tail->next = this;
172 * See if any dictionaries have changed. If not, don't
175 static int dict_stat_check(const char *root_dir, const char *root_file)
180 if (!stat_root_dir) return 0;
181 if (!stat_root_file) return 0;
183 if (strcmp(root_dir, stat_root_dir) != 0) return 0;
184 if (strcmp(root_file, stat_root_file) != 0) return 0;
186 if (!stat_head) return 0; /* changed, reload */
188 for (this = stat_head; this != NULL; this = this->next) {
189 if (stat(this->name, &buf) < 0) return 0;
191 if (buf.st_mtime != this->mtime) return 0;
199 * Free the dictionary_attributes and dictionary_values lists.
206 lrad_hash_table_free(vendors_byname);
207 lrad_hash_table_free(vendors_byvalue);
208 vendors_byname = NULL;
209 vendors_byvalue = NULL;
211 lrad_hash_table_free(attributes_byname);
212 lrad_hash_table_free(attributes_byvalue);
213 attributes_byname = NULL;
214 attributes_byvalue = NULL;
216 lrad_hash_table_free(values_byname);
217 lrad_hash_table_free(values_byvalue);
218 values_byname = NULL;
219 values_byvalue = NULL;
226 * Add vendor to the list.
228 int dict_addvendor(const char *name, int value)
234 if (value >= (1 << 16)) {
235 librad_log("dict_addvendor: Cannot handle vendor ID larger than 65535");
239 if ((length = strlen(name)) >= DICT_VENDOR_MAX_NAME_LEN) {
240 librad_log("dict_addvendor: vendor name too long");
244 if ((dv = malloc(sizeof(*dv) + length)) == NULL) {
245 librad_log("dict_addvendor: out of memory");
249 hash = dict_hashname(name);
250 strcpy(dv->name, name);
251 dv->vendorpec = value;
252 dv->type = dv->length = 1; /* defaults */
254 if (!lrad_hash_table_insert(vendors_byname, hash, dv)) {
257 old_dv = lrad_hash_table_finddata(vendors_byname, hash);
259 librad_log("dict_addvendor: Failed inserting vendor name %s", name);
262 if (old_dv->vendorpec != dv->vendorpec) {
263 librad_log("dict_addvendor: Duplicate vendor name %s", name);
268 * Already inserted. Discard the duplicate entry.
275 * Insert the SAME pointer (not free'd when this tree is
276 * deleted), into another tree.
278 * If the newly inserted entry is a duplicate of an existing
279 * entry, then the old entry is tossed, and the new one
280 * replaces it. This behaviour is configured in the
281 * lrad_hash_table_create() function.
283 * We want this behaviour because we want OLD names for
284 * the attributes to be read from the configuration
285 * files, but when we're printing them, (and looking up
286 * by value) we want to use the NEW name.
288 if (!lrad_hash_table_insert(vendors_byvalue,
289 lrad_hash(&dv->vendorpec,
290 sizeof(dv->vendorpec)),
292 librad_log("dict_addvendor: Failed inserting vendor %s",
301 * Add an attribute to the dictionary.
303 int dict_addattr(const char *name, int vendor, int type, int value,
306 static int max_attr = 0;
310 if (strlen(name) > (sizeof(attr->name) -1)) {
311 librad_log("dict_addattr: attribute name too long");
316 * If the value is '-1', that means use a pre-existing
317 * one (if it already exists). If one does NOT already exist,
318 * then create a new attribute, with a non-conflicting value,
322 if (dict_attrbyname(name)) {
323 return 0; /* exists, don't add it again */
328 } else if (vendor == 0) {
332 if (value > max_attr) {
338 librad_log("dict_addattr: ATTRIBUTE has invalid number (less than zero)");
342 if (value >= 65536) {
343 librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 65535).");
348 DICT_VENDOR *dv = dict_vendorbyvalue(vendor);
351 * If the vendor isn't defined, die/
354 librad_log("dict_addattr: Unknown vendor");
359 * With a few exceptions, attributes can only be
360 * 1..255. The check above catches the less than
363 if ((dv->type == 1) && (value >= 256)) {
364 librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 255).");
366 } /* else 256..65535 are allowed */
370 * Create a new attribute for the list
372 if ((attr = malloc(sizeof(*attr))) == NULL) {
373 librad_log("dict_addattr: out of memory");
377 hash = dict_hashname(name);
378 strcpy(attr->name, name);
380 attr->attr |= (vendor << 16); /* FIXME: hack */
383 attr->vendor = vendor;
387 * Insert the attribute, only if it's not a duplicate.
389 if (!lrad_hash_table_insert(attributes_byname, hash, attr)) {
393 * If the attribute has identical number, then
394 * ignore the duplicate.
396 a = lrad_hash_table_finddata(attributes_byname, hash);
397 if (a && (strcasecmp(a->name, attr->name) == 0)) {
398 if (a->attr != attr->attr) {
399 librad_log("dict_addattr: Duplicate attribute name %s", name);
404 * Same name, same vendor, same attr,
405 * maybe the flags and/or type is
406 * different. Let the new value
407 * over-ride the old one.
413 * Insert the SAME pointer (not free'd when this tree is
414 * deleted), into another tree.
416 * If the newly inserted entry is a duplicate of an existing
417 * entry, then the old entry is tossed, and the new one
418 * replaces it. This behaviour is configured in the
419 * lrad_hash_table_create() function.
421 * We want this behaviour because we want OLD names for
422 * the attributes to be read from the configuration
423 * files, but when we're printing them, (and looking up
424 * by value) we want to use the NEW name.
426 if (!lrad_hash_table_insert(attributes_byvalue,
427 lrad_hash(&attr->attr, sizeof(attr->attr)),
429 librad_log("dict_addattr: Failed inserting attribute attribute name %s", name);
438 * Add a value for an attribute to the dictionary.
440 int dict_addvalue(const char *namestr, const char *attrstr, int value)
447 if ((length = strlen(namestr)) >= DICT_VALUE_MAX_NAME_LEN) {
448 librad_log("dict_addvalue: value name too long");
452 if ((dval = malloc(sizeof(*dval) + length)) == NULL) {
453 librad_log("dict_addvalue: out of memory");
456 memset(dval, 0, sizeof(*dval));
458 hash = dict_hashname(namestr);
459 strcpy(dval->name, namestr);
463 * Remember which attribute is associated with this
464 * value, if possible.
466 dattr = dict_attrbyname(attrstr);
468 dval->attr = dattr->attr;
469 hash = lrad_hash_update(&dval->attr, sizeof(dval->attr), hash);
471 value_fixup_t *fixup;
473 fixup = (value_fixup_t *) malloc(sizeof(*fixup));
475 librad_log("dict_addvalue: out of memory");
478 memset(fixup, 0, sizeof(*fixup));
480 strNcpy(fixup->attrstr, attrstr, sizeof(fixup->attrstr));
485 * Insert to the head of the list.
487 fixup->next = value_fixup;
494 * Add the value into the dictionary.
496 if (!lrad_hash_table_insert(values_byname, hash, dval)) {
501 * Suppress duplicates with the same
502 * name and value. There are lots in
505 old = dict_valbyname(dattr->attr, namestr);
506 if (old && (old->value == dval->value)) {
512 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", namestr, attrstr);
517 * There are multiple VALUE's, keyed by attribute, so we
518 * take care of that here.
521 hash = lrad_hash_update(&dval->value, sizeof(dval->value), hash);
522 if (!lrad_hash_table_insert(values_byvalue, hash, dval)) {
523 librad_log("dict_addvalue: Failed inserting value %s",
532 * Process the ATTRIBUTE command
534 static int process_attribute(const char* fn, const int line,
535 const int block_vendor, char **argv,
544 if ((argc < 3) || (argc > 4)) {
545 librad_log("dict_init: %s[%d]: invalid ATTRIBUTE line",
551 * Validate all entries
553 if (!isdigit((int) argv[1][0])) {
554 librad_log("dict_init: %s[%d]: invalid value", fn, line);
557 sscanf(argv[1], "%i", &value);
560 * find the type of the attribute.
562 type = lrad_str2int(type_table, argv[2], -1);
564 librad_log("dict_init: %s[%d]: invalid type \"%s\"",
570 * Only look up the vendor if the string
573 memset(&flags, 0, sizeof(flags));
575 s = strtok(argv[3], ",");
577 if (strcmp(s, "has_tag") == 0 ||
578 strcmp(s, "has_tag=1") == 0) {
579 /* Boolean flag, means this is a
583 } else if (strncmp(s, "encrypt=", 8) == 0) {
584 /* Encryption method, defaults to 0 (none).
585 Currently valid is just type 2,
586 Tunnel-Password style, which can only
587 be applied to strings. */
588 flags.encrypt = strtol(s + 8, &c, 0);
590 librad_log( "dict_init: %s[%d] invalid option %s",
595 /* Must be a vendor 'flag'... */
596 if (strncmp(s, "vendor=", 7) == 0) {
601 vendor = dict_vendorbyname(s);
603 librad_log( "dict_init: %s[%d]: unknown vendor %s",
607 if (block_vendor && argv[3][0] &&
608 (block_vendor != vendor)) {
609 librad_log("dict_init: %s[%d]: mismatched vendor %s within BEGIN-VENDOR/END-VENDOR block",
614 s = strtok(NULL, ",");
618 if (block_vendor) vendor = block_vendor;
621 * Special checks for tags, they make our life much more
626 * VSA's can't be tagged.
629 librad_log("dict_init: %s[%d]: Vendor attributes cannot be tagged.",
635 * Only string, octets, and integer can be tagged.
639 case PW_TYPE_INTEGER:
643 librad_log("dict_init: %s[%d]: Attributes of type %s cannot be tagged.",
645 lrad_int2str(type_table, type, "?Unknown?"));
654 if (dict_addattr(argv[0], vendor, type, value, flags) < 0) {
655 librad_log("dict_init: %s[%d]: %s",
656 fn, line, librad_errstr);
665 * Process the VALUE command
667 static int process_value(const char* fn, const int line, char **argv,
673 librad_log("dict_init: %s[%d]: invalid VALUE line",
678 * For Compatibility, skip "Server-Config"
680 if (strcasecmp(argv[0], "Server-Config") == 0)
684 * Validate all entries
686 if (!isdigit((int) argv[2][0])) {
687 librad_log("dict_init: %s[%d]: invalid value",
691 sscanf(argv[2], "%i", &value);
694 * valuepair.c will get excited when creating attributes,
695 * if it sees values which look like integers, so we can't
698 if (isdigit(argv[1][0])) {
699 librad_log("dict_init: %s[%d]: Names for VALUEs cannot start with a digit.",
703 if (dict_addvalue(argv[1], argv[0], value) < 0) {
704 librad_log("dict_init: %s[%d]: %s",
705 fn, line, librad_errstr);
714 * Process the VENDOR command
716 static int process_vendor(const char* fn, const int line, char **argv,
720 const char *format = NULL;
722 if ((argc < 2) || (argc > 3)) {
723 librad_log( "dict_init: %s[%d] invalid VENDOR entry",
729 * Validate all entries
731 if (!isdigit((int) argv[1][0])) {
732 librad_log("dict_init: %s[%d]: invalid value",
736 value = atoi(argv[1]);
738 /* Create a new VENDOR entry for the list */
739 if (dict_addvendor(argv[0], value) < 0) {
740 librad_log("dict_init: %s[%d]: %s",
741 fn, line, librad_errstr);
746 * Look for a format statement
751 } else if (value == VENDORPEC_USR) { /* catch dictionary screw-ups */
752 format = "format=4,0";
754 } else if (value == VENDORPEC_LUCENT) {
755 format = "format=2,1";
757 } else if (value == VENDORPEC_STARENT) {
758 format = "format=2,2";
760 } /* else no fixups to do */
767 if (strncasecmp(format, "format=", 7) != 0) {
768 librad_log("dict_init: %s[%d]: Invalid format for VENDOR. Expected \"format=\", got \"%s\"",
774 if ((strlen(p) != 3) ||
775 !isdigit((int) p[0]) ||
777 !isdigit((int) p[2])) {
778 librad_log("dict_init: %s[%d]: Invalid format for VENDOR. Expected text like \"1,1\", got \"%s\"",
783 type = (int) (p[0] - '0');
784 length = (int) (p[2] - '0');
786 dv = dict_vendorbyvalue(value);
788 librad_log("dict_init: %s[%d]: Failed adding format for VENDOR",
793 if ((type != 1) && (type != 2) && (type != 4)) {
794 librad_log("dict_init: %s[%d]: invalid type value %d for VENDOR",
799 if ((length != 0) && (length != 1) && (length != 2)) {
800 librad_log("dict_init: %s[%d]: invalid length value %d for VENDOR",
813 * String split routine. Splits an input string IN PLACE
814 * into pieces, based on spaces.
816 static int str2argv(char *str, char **argv, int max_argc)
821 if (argc >= max_argc) return argc;
824 * Chop out comments early.
831 while ((*str == ' ') ||
834 (*str == '\n')) *(str++) = '\0';
836 if (!*str) return argc;
845 (*str != '\n')) str++;
851 #define MAX_ARGV (16)
854 * Initialize the dictionary.
856 static int my_dict_init(const char *dir, const char *fn,
857 const char *src_file, int src_line)
867 char *argv[MAX_ARGV];
870 if (strlen(fn) >= sizeof(dirtmp) / 2 ||
871 strlen(dir) >= sizeof(dirtmp) / 2) {
872 librad_log("dict_init: filename name too long");
877 * First see if fn is relative to dir. If so, create
878 * new filename. If not, remember the absolute dir.
880 if ((p = strrchr(fn, '/')) != NULL) {
884 } else if (dir && dir[0] && strcmp(dir, ".") != 0) {
885 snprintf(dirtmp, sizeof(dirtmp), "%s/%s", dir, fn);
889 if ((fp = fopen(fn, "r")) == NULL) {
891 librad_log("dict_init: Couldn't open dictionary \"%s\": %s",
892 fn, strerror(errno));
894 librad_log("dict_init: %s[%d]: Couldn't open dictionary \"%s\": %s",
895 src_file, src_line, fn, strerror(errno));
900 stat(fn, &statbuf); /* fopen() guarantees this will succeed */
901 if (!S_ISREG(statbuf.st_mode)) {
903 librad_log("dict_init: Dictionary \"%s\" is not a regular file",
907 dict_stat_add(fn, &statbuf);
910 * Seed the random pool with data.
912 lrad_rand_seed(&statbuf, sizeof(statbuf));
916 while (fgets(buf, sizeof(buf), fp) != NULL) {
918 if (buf[0] == '#' || buf[0] == 0 ||
919 buf[0] == '\n' || buf[0] == '\r')
923 * Comment characters should NOT be appearing anywhere but
924 * as start of a comment;
926 p = strchr(buf, '#');
929 argc = str2argv(buf, argv, MAX_ARGV);
930 if (argc == 0) continue;
933 librad_log( "dict_init: %s[%d] invalid entry",
942 fprintf(stderr, "ARGC = %d\n",argc);
943 for (i = 0; i < argc; i++) {
944 fprintf(stderr, "\t%s\n", argv[i]);
949 * See if we need to import another dictionary.
951 if (strcasecmp(argv[0], "$INCLUDE") == 0) {
952 if (my_dict_init(dir, argv[1], fn, line) < 0) {
960 * Perhaps this is an attribute.
962 if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
963 if (process_attribute(fn, line, block_vendor,
964 argv + 1, argc - 1) == -1) {
972 * Process VALUE lines.
974 if (strcasecmp(argv[0], "VALUE") == 0) {
975 if (process_value(fn, line,
976 argv + 1, argc - 1) == -1) {
984 * Process VENDOR lines.
986 if (strcasecmp(argv[0], "VENDOR") == 0) {
987 if (process_vendor(fn, line,
988 argv + 1, argc - 1) == -1) {
995 if (strcasecmp(argv[0], "BEGIN-VENDOR") == 0) {
998 "dict_init: %s[%d] invalid BEGIN-VENDOR entry",
1004 vendor = dict_vendorbyname(argv[1]);
1007 "dict_init: %s[%d]: unknown vendor %s",
1012 block_vendor = vendor;
1014 } /* BEGIN-VENDOR */
1016 if (strcasecmp(argv[0], "END-VENDOR") == 0) {
1019 "dict_init: %s[%d] invalid END-VENDOR entry",
1025 vendor = dict_vendorbyname(argv[1]);
1028 "dict_init: %s[%d]: unknown vendor %s",
1034 if (vendor != block_vendor) {
1036 "dict_init: %s[%d]: END-VENDOR %s does not match any previous BEGIN-VENDOR",
1046 * Any other string: We don't recognize it.
1049 "dict_init: %s[%d] invalid keyword \"%s\"",
1059 * Initialize the directory, then fix the attr member of
1062 int dict_init(const char *dir, const char *fn)
1065 * Check if we need to change anything. If not, don't do
1068 if (dict_stat_check(dir, fn)) {
1073 * Free the dictionaries, and the stat cache.
1076 stat_root_dir = strdup(dir);
1077 stat_root_file = strdup(fn);
1080 * Create the tree of vendor by name. There MAY NOT
1081 * be multiple vendors of the same name.
1083 * Each vendor is malloc'd, so the free function is free.
1085 vendors_byname = lrad_hash_table_create(free);
1086 if (!vendors_byname) {
1091 * Create the tree of vendors by value. There MAY
1092 * be vendors of the same value. If there are, we
1093 * pick the latest one.
1095 vendors_byvalue = lrad_hash_table_create(NULL);
1096 if (!vendors_byvalue) {
1101 * Create the tree of attributes by name. There MAY NOT
1102 * be multiple attributes of the same name.
1104 * Each attribute is malloc'd, so the free function is free.
1106 attributes_byname = lrad_hash_table_create(free);
1107 if (!attributes_byname) {
1112 * Create the tree of attributes by value. There MAY
1113 * be attributes of the same value. If there are, we
1114 * pick the latest one.
1116 attributes_byvalue = lrad_hash_table_create(NULL);
1117 if (!attributes_byvalue) {
1121 values_byname = lrad_hash_table_create(free);
1122 if (!values_byname) {
1126 values_byvalue = lrad_hash_table_create(NULL);
1127 if (!values_byvalue) {
1131 value_fixup = NULL; /* just to be safe. */
1133 if (my_dict_init(dir, fn, NULL, 0) < 0)
1139 value_fixup_t *this, *next;
1141 for (this = value_fixup; this != NULL; this = next) {
1144 a = dict_attrbyname(this->attrstr);
1147 "dict_init: No ATTRIBUTE \"%s\" defined for VALUE \"%s\"",
1148 this->attrstr, this->dval->name);
1149 return -1; /* leak, but they should die... */
1152 this->dval->attr = a->attr;
1155 * Add the value into the dictionary.
1157 hash = lrad_hash_update(&this->dval->attr,
1158 sizeof(this->dval->attr),
1160 if (!lrad_hash_table_insert(values_byname,
1161 hash, this->dval)) {
1162 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", this->dval->name, a->name);
1167 * Allow them to use the old name, but
1168 * prefer the new name when printing
1171 hash = lrad_hash(&this->dval->attr,
1172 sizeof(this->dval->attr));
1173 hash = lrad_hash_update(&this->dval->value,
1174 sizeof(this->dval->value),
1176 if (!lrad_hash_table_finddata(values_byvalue, hash)) {
1177 lrad_hash_table_insert(values_byvalue,
1183 * Just so we don't lose track of things.
1193 * Get an attribute by its numerical value.
1195 DICT_ATTR *dict_attrbyvalue(int val)
1197 return lrad_hash_table_finddata(attributes_byvalue,
1198 lrad_hash(&val, sizeof(val)));
1202 * Get an attribute by its name.
1204 DICT_ATTR *dict_attrbyname(const char *name)
1206 if (!name) return NULL;
1208 return lrad_hash_table_finddata(attributes_byname,
1209 dict_hashname(name));
1213 * Associate a value with an attribute and return it.
1215 DICT_VALUE *dict_valbyattr(int attr, int val)
1217 uint32_t hash = attr;
1219 hash = lrad_hash_update(&val, sizeof(val), hash);
1221 return lrad_hash_table_finddata(values_byvalue, hash);
1225 * Get a value by its name, keyed off of an attribute.
1227 DICT_VALUE *dict_valbyname(int attr, const char *name)
1231 if (!name) return NULL;
1233 hash = dict_hashname(name);
1234 hash = lrad_hash_update(&attr, sizeof(attr), hash);
1236 return lrad_hash_table_finddata(values_byname, hash);
1240 * Get the vendor PEC based on the vendor name
1242 * This is efficient only for small numbers of vendors.
1244 int dict_vendorbyname(const char *name)
1249 if (!name) return 0;
1251 hash = dict_hashname(name);
1253 dv = lrad_hash_table_finddata(vendors_byname, hash);
1256 return dv->vendorpec;
1260 * Return the vendor struct based on the PEC.
1262 DICT_VENDOR *dict_vendorbyvalue(int vendor)
1264 return lrad_hash_table_finddata(vendors_byvalue,
1265 lrad_hash(&vendor, sizeof(vendor)));