corrected typo
[freeradius.git] / src / lib / dict.c
1 /*
2  * dict.c       Routines to read the dictionary file.
3  *
4  * Version:     $Id$
5  *
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.
10  *
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.
15  *
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
19  *
20  * Copyright 2000  The FreeRADIUS server project
21  */
22
23 static const char rcsid[] = "$Id$";
24
25 #include        "autoconf.h"
26
27 #include        <stdlib.h>
28 #include        <ctype.h>
29 #include        <string.h>
30
31 #ifdef HAVE_MALLOC_H
32 #include        <malloc.h>
33 #endif
34
35 #ifdef HAVE_SYS_STAT_H
36 #include        <sys/stat.h>
37 #endif
38
39 #include        <unistd.h>
40
41 #include        "missing.h"
42 #include        "libradius.h"
43
44 #define DICT_VALUE_MAX_NAME_LEN (128)
45 #define DICT_VENDOR_MAX_NAME_LEN (128)
46
47 static lrad_hash_table_t *vendors_byname = NULL;
48 static lrad_hash_table_t *vendors_byvalue = NULL;
49
50 static lrad_hash_table_t *attributes_byname = NULL;
51 static lrad_hash_table_t *attributes_byvalue = NULL;
52
53 static lrad_hash_table_t *values_byvalue = NULL;
54 static lrad_hash_table_t *values_byname = NULL;
55
56 /*
57  *      For faster HUP's, we cache the stat information for
58  *      files we've $INCLUDEd
59  */
60 typedef struct dict_stat_t {
61         struct dict_stat_t *next;
62         char               *name;
63         time_t             mtime;
64 } dict_stat_t;
65
66 static char *stat_root_dir = NULL;
67 static char *stat_root_file = NULL;
68
69 static dict_stat_t *stat_head = NULL;
70 static dict_stat_t *stat_tail = NULL;
71
72 typedef struct value_fixup_t {
73         char            attrstr[40];
74         DICT_VALUE      *dval;
75         struct value_fixup_t *next;
76 } value_fixup_t;
77
78
79 /*
80  *      So VALUEs in the dictionary can have forward references.
81  */
82 static value_fixup_t *value_fixup = NULL;
83
84 static const LRAD_NAME_NUMBER type_table[] = {
85         { "string",     PW_TYPE_STRING },
86         { "integer",    PW_TYPE_INTEGER },
87         { "ipaddr",     PW_TYPE_IPADDR },
88         { "date",       PW_TYPE_DATE },
89         { "abinary",    PW_TYPE_ABINARY },
90         { "octets",     PW_TYPE_OCTETS },
91         { "ifid",       PW_TYPE_IFID },
92         { "ipv6addr",   PW_TYPE_IPV6ADDR },
93         { "ipv6prefix", PW_TYPE_IPV6PREFIX },
94         { NULL, 0 }
95 };
96
97
98 /*
99  *      Create the hash of the name.
100  *
101  *      We copy the hash function here because it's substantially faster.
102  */
103 #define FNV_MAGIC_INIT (0x811c9dc5)
104 #define FNV_MAGIC_PRIME (0x01000193)
105
106 static uint32_t dict_hashname(const char *name)
107 {
108         uint32_t hash = FNV_MAGIC_INIT;
109         const char *p;
110
111         for (p = name; *p != '\0'; p++) {
112                 int c = *(const unsigned char *) p;
113                 if (isalpha(c)) c = tolower(c);
114
115                 hash *= FNV_MAGIC_PRIME;
116                 hash ^= (uint32_t ) (c & 0xff);
117         }
118         
119         return hash;
120 }
121
122
123 /*
124  *      Hash callback functions.
125  */
126 static uint32_t dict_attr_name_hash(const void *data)
127 {
128         return dict_hashname(((const DICT_ATTR *)data)->name);
129 }
130
131 static int dict_attr_name_cmp(const void *one, const void *two)
132 {
133         const DICT_ATTR *a = one;
134         const DICT_ATTR *b = two;
135
136         return strcasecmp(a->name, b->name);
137 }
138
139 static uint32_t dict_attr_value_hash(const void *data)
140 {
141         return lrad_hash(&((const DICT_ATTR *)data)->attr,
142                          sizeof(((const DICT_ATTR *)data)->attr));
143 }
144
145 static int dict_attr_value_cmp(const void *one, const void *two)
146 {
147         const DICT_ATTR *a = one;
148         const DICT_ATTR *b = two;
149
150         return a->attr - b->attr;
151 }
152
153 static uint32_t dict_vendor_name_hash(const void *data)
154 {
155         return dict_hashname(((const DICT_VENDOR *)data)->name);
156 }
157
158 static int dict_vendor_name_cmp(const void *one, const void *two)
159 {
160         const DICT_VENDOR *a = one;
161         const DICT_VENDOR *b = two;
162
163         return strcasecmp(a->name, b->name);
164 }
165
166 static uint32_t dict_vendor_value_hash(const void *data)
167 {
168         return lrad_hash(&(((const DICT_VENDOR *)data)->vendorpec),
169                          sizeof(((const DICT_VENDOR *)data)->vendorpec));
170 }
171
172 static int dict_vendor_value_cmp(const void *one, const void *two)
173 {
174         const DICT_VENDOR *a = one;
175         const DICT_VENDOR *b = two;
176
177         return a->vendorpec - b->vendorpec;
178 }
179
180 static uint32_t dict_value_name_hash(const void *data)
181 {
182         uint32_t hash;
183         const DICT_VALUE *dval = data;
184
185         hash = dict_hashname(dval->name);
186         return lrad_hash_update(&dval->attr, sizeof(dval->attr), hash);
187 }
188
189 static int dict_value_name_cmp(const void *one, const void *two)
190 {
191         int rcode;
192         const DICT_VALUE *a = one;
193         const DICT_VALUE *b = two;
194
195         rcode = a->attr - b->attr;
196         if (rcode != 0) return rcode;
197
198         return strcasecmp(a->name, b->name);
199 }
200
201 static uint32_t dict_value_value_hash(const void *data)
202 {
203         uint32_t hash;
204         const DICT_VALUE *dval = data;
205
206         hash = lrad_hash(&dval->attr, sizeof(dval->attr));
207         return lrad_hash_update(&dval->value, sizeof(dval->value), hash);
208 }
209
210 static int dict_value_value_cmp(const void *one, const void *two)
211 {
212         int rcode;
213         const DICT_VALUE *a = one;
214         const DICT_VALUE *b = two;
215
216         rcode = a->attr - b->attr;
217         if (rcode != 0) return rcode;
218
219         return a->value - b->value;
220 }
221
222
223 /*
224  *      Free the list of stat buffers
225  */
226 static void dict_stat_free(void)
227 {
228         dict_stat_t *this, *next;
229
230         free(stat_root_dir);
231         stat_root_dir = NULL;
232         free(stat_root_file);
233         stat_root_file = NULL;
234
235         if (!stat_head) {
236                 stat_tail = NULL;
237                 return;
238         }
239
240         for (this = stat_head; this != NULL; this = next) {
241                 next = this->next;
242                 free(this->name);
243                 free(this);
244         }
245
246         stat_head = stat_tail = NULL;
247 }
248
249
250 /*
251  *      Add an entry to the list of stat buffers.
252  */
253 static void dict_stat_add(const char *name, const struct stat *stat_buf)
254 {
255         dict_stat_t *this;
256
257         this = malloc(sizeof(*this));
258         if (!this) return;
259         memset(this, 0, sizeof(*this));
260
261         this->name = strdup(name);
262         this->mtime = stat_buf->st_mtime;
263
264         if (!stat_head) {
265                 stat_head = stat_tail = this;
266         } else {
267                 stat_tail->next = this;
268                 stat_tail = this;
269         }
270 }
271
272
273 /*
274  *      See if any dictionaries have changed.  If not, don't
275  *      do anything.
276  */
277 static int dict_stat_check(const char *root_dir, const char *root_file)
278 {
279         struct stat buf;
280         dict_stat_t *this;
281
282         if (!stat_root_dir) return 0;
283         if (!stat_root_file) return 0;
284
285         if (strcmp(root_dir, stat_root_dir) != 0) return 0;
286         if (strcmp(root_file, stat_root_file) != 0) return 0;
287
288         if (!stat_head) return 0; /* changed, reload */
289
290         for (this = stat_head; this != NULL; this = this->next) {
291                 if (stat(this->name, &buf) < 0) return 0;
292
293                 if (buf.st_mtime != this->mtime) return 0;
294         }
295
296         return 1;
297 }
298
299
300 /*
301  *      Free the dictionary_attributes and dictionary_values lists.
302  */
303 void dict_free(void)
304 {
305         /*
306          *      Free the tables
307          */
308         lrad_hash_table_free(vendors_byname);
309         lrad_hash_table_free(vendors_byvalue);
310         vendors_byname = NULL;
311         vendors_byvalue = NULL;
312
313         lrad_hash_table_free(attributes_byname);
314         lrad_hash_table_free(attributes_byvalue);
315         attributes_byname = NULL;
316         attributes_byvalue = NULL;
317
318         lrad_hash_table_free(values_byname);
319         lrad_hash_table_free(values_byvalue);
320         values_byname = NULL;
321         values_byvalue = NULL;
322
323         dict_stat_free();
324 }
325
326
327 /*
328  *      Add vendor to the list.
329  */
330 int dict_addvendor(const char *name, int value)
331 {
332         size_t length;
333         DICT_VENDOR *dv;
334
335         if (value >= (1 << 16)) {
336                 librad_log("dict_addvendor: Cannot handle vendor ID larger than 65535");
337                 return -1;
338         }
339
340         if ((length = strlen(name)) >= DICT_VENDOR_MAX_NAME_LEN) {
341                 librad_log("dict_addvendor: vendor name too long");
342                 return -1;
343         }
344         
345         if ((dv = malloc(sizeof(*dv) + length)) == NULL) {
346                 librad_log("dict_addvendor: out of memory");
347                 return -1;
348         }
349
350         strcpy(dv->name, name);
351         dv->vendorpec  = value;
352         dv->type = dv->length = 1; /* defaults */
353
354         if (!lrad_hash_table_insert(vendors_byname, dv)) {
355                 DICT_VENDOR *old_dv;
356
357                 old_dv = lrad_hash_table_finddata(vendors_byname, dv);
358                 if (!old_dv) {
359                         librad_log("dict_addvendor: Failed inserting vendor name %s", name);
360                         return -1;
361                 }
362                 if (old_dv->vendorpec != dv->vendorpec) {
363                         librad_log("dict_addvendor: Duplicate vendor name %s", name);
364                         return -1;
365                 }
366
367                 /*
368                  *      Already inserted.  Discard the duplicate entry.
369                  */
370                 free(dv);
371                 return 0;
372         }
373
374         /*
375          *      Insert the SAME pointer (not free'd when this table is
376          *      deleted), into another table.
377          *
378          *      We want this behaviour because we want OLD names for
379          *      the attributes to be read from the configuration
380          *      files, but when we're printing them, (and looking up
381          *      by value) we want to use the NEW name.
382          */
383         if (!lrad_hash_table_replace(vendors_byvalue, dv)) {
384                 librad_log("dict_addvendor: Failed inserting vendor %s",
385                            name);
386                 return -1;
387         }
388
389         return 0;
390 }
391
392 /*
393  *      Add an attribute to the dictionary.
394  */
395 int dict_addattr(const char *name, int vendor, int type, int value,
396                  ATTR_FLAGS flags)
397 {
398         static int      max_attr = 0;
399         DICT_ATTR       *attr;
400
401         if (strlen(name) > (sizeof(attr->name) -1)) {
402                 librad_log("dict_addattr: attribute name too long");
403                 return -1;
404         }
405
406         /*
407          *      If the value is '-1', that means use a pre-existing
408          *      one (if it already exists).  If one does NOT already exist,
409          *      then create a new attribute, with a non-conflicting value,
410          *      and use that.
411          */
412         if (value == -1) {
413                 if (dict_attrbyname(name)) {
414                         return 0; /* exists, don't add it again */
415                 }
416
417                 value = ++max_attr;
418
419         } else if (vendor == 0) {
420                 /*
421                  *  Update 'max_attr'
422                  */
423                 if (value > max_attr) {
424                         max_attr = value;
425                 }
426         }
427
428         if (value < 0) {
429                 librad_log("dict_addattr: ATTRIBUTE has invalid number (less than zero)");
430                 return -1;
431         }
432
433         if (value >= 65536) {
434                 librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 65535).");
435                 return -1;
436         }
437
438         if (vendor) {
439                 DICT_VENDOR *dv = dict_vendorbyvalue(vendor);
440
441                 /*
442                  *      If the vendor isn't defined, die/
443                  */
444                 if (!dv) {
445                         librad_log("dict_addattr: Unknown vendor");
446                         return -1;
447                 }
448
449                 /*
450                  *      With a few exceptions, attributes can only be
451                  *      1..255.  The check above catches the less than
452                  *      zero case.
453                  */
454                 if ((dv->type == 1) && (value >= 256)) {
455                         librad_log("dict_addattr: ATTRIBUTE has invalid number (larger than 255).");
456                         return -1;
457                 } /* else 256..65535 are allowed */
458         }
459
460         /*
461          *      Create a new attribute for the list
462          */
463         if ((attr = malloc(sizeof(*attr))) == NULL) {
464                 librad_log("dict_addattr: out of memory");
465                 return -1;
466         }
467
468         strcpy(attr->name, name);
469         attr->attr = value;
470         attr->attr |= (vendor << 16); /* FIXME: hack */
471         attr->type = type;
472         attr->flags = flags;
473         attr->vendor = vendor;
474
475         /*
476          *      Insert the attribute, only if it's not a duplicate.
477          */
478         if (!lrad_hash_table_insert(attributes_byname, attr)) {
479                 DICT_ATTR       *a;
480
481                 /*
482                  *      If the attribute has identical number, then
483                  *      ignore the duplicate.
484                  */
485                 a = lrad_hash_table_finddata(attributes_byname, attr);
486                 if (a && (strcasecmp(a->name, attr->name) == 0)) {
487                         if (a->attr != attr->attr) {
488                                 librad_log("dict_addattr: Duplicate attribute name %s", name);
489                                 free(attr);
490                                 return -1;
491                         }
492
493                         /*
494                          *      Same name, same vendor, same attr,
495                          *      maybe the flags and/or type is
496                          *      different.  Let the new value
497                          *      over-ride the old one.
498                          */
499                 }
500
501                 lrad_hash_table_delete(attributes_byvalue, a);
502
503                 if (!lrad_hash_table_replace(attributes_byname, attr)) {
504                         librad_log("dict_addattr: Internal error storing attribute %s", name);
505                         free(attr);
506                         return -1;
507                 }
508         }
509
510         /*
511          *      Insert the SAME pointer (not free'd when this entry is
512          *      deleted), into another table.
513          *
514          *      We want this behaviour because we want OLD names for
515          *      the attributes to be read from the configuration
516          *      files, but when we're printing them, (and looking up
517          *      by value) we want to use the NEW name.
518          */
519         if (!lrad_hash_table_replace(attributes_byvalue, attr)) {
520                 librad_log("dict_addattr: Failed inserting attribute name %s", name);
521                 return -1;
522         }
523
524         return 0;
525 }
526
527
528 /*
529  *      Add a value for an attribute to the dictionary.
530  */
531 int dict_addvalue(const char *namestr, const char *attrstr, int value)
532 {
533         size_t          length;
534         DICT_ATTR       *dattr;
535         DICT_VALUE      *dval;
536
537         if ((length = strlen(namestr)) >= DICT_VALUE_MAX_NAME_LEN) {
538                 librad_log("dict_addvalue: value name too long");
539                 return -1;
540         }
541
542         if ((dval = malloc(sizeof(*dval) + length)) == NULL) {
543                 librad_log("dict_addvalue: out of memory");
544                 return -1;
545         }
546         memset(dval, 0, sizeof(*dval));
547
548         strcpy(dval->name, namestr);
549         dval->value = value;
550
551         /*
552          *      Remember which attribute is associated with this
553          *      value, if possible.
554          */
555         dattr = dict_attrbyname(attrstr);
556         if (dattr) {
557                 dval->attr = dattr->attr;
558
559                 /*
560                  *      Octets is allowed as a work-around for the
561                  *      fact that branch_1_1 doesn't have BYTE or SHORT
562                  */
563                 if ((dattr->type != PW_TYPE_INTEGER) &&
564                     (dattr->type != PW_TYPE_OCTETS)) {
565                         librad_log("dict_addvalue: VALUEs can only be defined for'integer' types");
566                         return -1;
567                 }
568
569         } else {
570                 value_fixup_t *fixup;
571                 
572                 fixup = (value_fixup_t *) malloc(sizeof(*fixup));
573                 if (!fixup) {
574                         librad_log("dict_addvalue: out of memory");
575                         return -1;
576                 }
577                 memset(fixup, 0, sizeof(*fixup));
578
579                 strNcpy(fixup->attrstr, attrstr, sizeof(fixup->attrstr));
580                 fixup->dval = dval;
581                 
582                 /*
583                  *      Insert to the head of the list.
584                  */
585                 fixup->next = value_fixup;
586                 value_fixup = fixup;
587
588                 return 0;
589         }
590
591         /*
592          *      Add the value into the dictionary.
593          */
594         if (!lrad_hash_table_insert(values_byname, dval)) {
595                 if (dattr) {
596                         DICT_VALUE *old;
597                         
598                         /*
599                          *      Suppress duplicates with the same
600                          *      name and value.  There are lots in
601                          *      dictionary.ascend.
602                          */
603                         old = dict_valbyname(dattr->attr, namestr);
604                         if (old && (old->value == dval->value)) {
605                                 free(dval);
606                                 return 0;
607                         }
608                 }
609
610                 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", namestr, attrstr);
611                 return -1;
612         }
613
614         /*
615          *      There are multiple VALUE's, keyed by attribute, so we
616          *      take care of that here.
617          */
618         if (!lrad_hash_table_replace(values_byvalue, dval)) {
619                 librad_log("dict_addvalue: Failed inserting value %s",
620                            namestr);
621                 return -1;
622         }
623
624         return 0;
625 }
626
627 /*
628  *      Process the ATTRIBUTE command
629  */
630 static int process_attribute(const char* fn, const int line,
631                              const int block_vendor, char **argv,
632                              int argc)
633 {
634         int             vendor = 0;
635         int             value;
636         int             type;
637         char            *s, *c;
638         ATTR_FLAGS      flags;
639
640         if ((argc < 3) || (argc > 4)) {
641                 librad_log("dict_init: %s[%d]: invalid ATTRIBUTE line",
642                         fn, line);
643                 return -1;
644         }
645
646         /*
647          *      Validate all entries
648          */
649         if (!isdigit((int) argv[1][0])) {
650                 librad_log("dict_init: %s[%d]: invalid value", fn, line);
651                 return -1;
652         }
653         sscanf(argv[1], "%i", &value);
654
655         /*
656          *      find the type of the attribute.
657          */
658         type = lrad_str2int(type_table, argv[2], -1);
659         if (type < 0) {
660                 librad_log("dict_init: %s[%d]: invalid type \"%s\"",
661                         fn, line, argv[2]);
662                 return -1;
663         }
664
665         /*
666          *      Only look up the vendor if the string
667          *      is non-empty.
668          */
669         memset(&flags, 0, sizeof(flags));
670         if (argc == 4) {
671                 s = strtok(argv[3], ",");
672                 while (s) {
673                         if (strcmp(s, "has_tag") == 0 ||
674                             strcmp(s, "has_tag=1") == 0) {
675                                 /* Boolean flag, means this is a
676                                    tagged attribute */
677                                 flags.has_tag = 1;
678                                 
679                         } else if (strncmp(s, "encrypt=", 8) == 0) {
680                                 /* Encryption method, defaults to 0 (none).
681                                    Currently valid is just type 2,
682                                    Tunnel-Password style, which can only
683                                    be applied to strings. */
684                                 flags.encrypt = strtol(s + 8, &c, 0);
685                                 if (*c) {
686                                         librad_log( "dict_init: %s[%d] invalid option %s",
687                                                     fn, line, s);
688                                         return -1;
689                                 }
690                         } else {
691                                 /* Must be a vendor 'flag'... */
692                                 if (strncmp(s, "vendor=", 7) == 0) {
693                                         /* New format */
694                                         s += 7;
695                                 }
696                                 
697                                 vendor = dict_vendorbyname(s);
698                                 if (!vendor) {
699                                         librad_log( "dict_init: %s[%d]: unknown vendor %s",
700                                                     fn, line, s);
701                                         return -1;
702                                 }
703                                 if (block_vendor && argv[3][0] &&
704                                     (block_vendor != vendor)) {
705                                         librad_log("dict_init: %s[%d]: mismatched vendor %s within BEGIN-VENDOR/END-VENDOR block",
706                                                    fn, line, argv[3]);
707                                         return -1;
708                                 }
709                         }
710                         s = strtok(NULL, ",");
711                 }
712         }
713
714         if (block_vendor) vendor = block_vendor;
715
716         /*
717          *      Special checks for tags, they make our life much more
718          *      difficult.
719          */
720         if (flags.has_tag) {
721                 /*
722                  *      Only string, octets, and integer can be tagged.
723                  */
724                 switch (type) {
725                 case PW_TYPE_STRING:
726                 case PW_TYPE_INTEGER:
727                         break;
728
729                 default:
730                         librad_log("dict_init: %s[%d]: Attributes of type %s cannot be tagged.",
731                                    fn, line,
732                                    lrad_int2str(type_table, type, "?Unknown?"));
733                         return -1;
734                         
735                 }
736         }
737
738         /*
739          *      Add it in.
740          */
741         if (dict_addattr(argv[0], vendor, type, value, flags) < 0) {
742                 librad_log("dict_init: %s[%d]: %s",
743                            fn, line, librad_errstr);
744                 return -1;
745         }
746
747         return 0;
748 }
749
750
751 /*
752  *      Process the VALUE command
753  */
754 static int process_value(const char* fn, const int line, char **argv,
755                          int argc)
756 {
757         int     value;
758
759         if (argc != 3) {
760                 librad_log("dict_init: %s[%d]: invalid VALUE line",
761                         fn, line);
762                 return -1;
763         }
764         /*
765          *      For Compatibility, skip "Server-Config"
766          */
767         if (strcasecmp(argv[0], "Server-Config") == 0)
768                 return 0;
769
770         /*
771          *      Validate all entries
772          */
773         if (!isdigit((int) argv[2][0])) {
774                 librad_log("dict_init: %s[%d]: invalid value",
775                         fn, line);
776                 return -1;
777         }
778         sscanf(argv[2], "%i", &value);
779
780         if (dict_addvalue(argv[1], argv[0], value) < 0) {
781                 librad_log("dict_init: %s[%d]: %s",
782                            fn, line, librad_errstr);
783                 return -1;
784         }
785
786         return 0;
787 }
788
789
790 /*
791  *      Process the VENDOR command
792  */
793 static int process_vendor(const char* fn, const int line, char **argv,
794                           int argc)
795 {
796         int     value;
797         const   char *format = NULL;
798
799         if ((argc < 2) || (argc > 3)) {
800                 librad_log( "dict_init: %s[%d] invalid VENDOR entry",
801                             fn, line);
802                 return -1;
803         }
804
805         /*
806          *       Validate all entries
807          */
808         if (!isdigit((int) argv[1][0])) {
809                 librad_log("dict_init: %s[%d]: invalid value",
810                         fn, line);
811                 return -1;
812         }
813         value = atoi(argv[1]);
814
815         /* Create a new VENDOR entry for the list */
816         if (dict_addvendor(argv[0], value) < 0) {
817                 librad_log("dict_init: %s[%d]: %s",
818                            fn, line, librad_errstr);
819                 return -1;
820         }
821
822         /*
823          *      Look for a format statement
824          */
825         if (argc == 3) {
826                 format = argv[2];
827
828         } else if (value == VENDORPEC_USR) { /* catch dictionary screw-ups */
829                 format = "format=4,0";
830
831         } else if (value == VENDORPEC_LUCENT) {
832                 format = "format=2,1";
833
834         } else if (value == VENDORPEC_STARENT) {
835                 format = "format=2,2";
836
837         } /* else no fixups to do */
838
839         if (format) {
840                 int type, length;
841                 const char *p;
842                 DICT_VENDOR *dv;
843
844                 if (strncasecmp(format, "format=", 7) != 0) {
845                         librad_log("dict_init: %s[%d]: Invalid format for VENDOR.  Expected \"format=\", got \"%s\"",
846                                    fn, line, format);
847                         return -1;
848                 }
849
850                 p = format + 7;
851                 if ((strlen(p) != 3) || 
852                     !isdigit((int) p[0]) ||
853                     (p[1] != ',') ||
854                     !isdigit((int) p[2])) {
855                         librad_log("dict_init: %s[%d]: Invalid format for VENDOR.  Expected text like \"1,1\", got \"%s\"",
856                                    fn, line, p);
857                         return -1;
858                 }
859
860                 type = (int) (p[0] - '0');
861                 length = (int) (p[2] - '0');
862
863                 dv = dict_vendorbyvalue(value);
864                 if (!dv) {
865                         librad_log("dict_init: %s[%d]: Failed adding format for VENDOR",
866                                    fn, line);
867                         return -1;
868                 }
869
870                 if ((type != 1) && (type != 2) && (type != 4)) {
871                         librad_log("dict_init: %s[%d]: invalid type value %d for VENDOR",
872                                    fn, line, type);
873                         return -1;
874                 }
875
876                 if ((length != 0) && (length != 1) && (length != 2)) {
877                         librad_log("dict_init: %s[%d]: invalid length value %d for VENDOR",
878                                    fn, line, length);
879                         return -1;
880                 }
881
882                 dv->type = type;
883                 dv->length = length;
884         }
885
886         return 0;
887 }
888
889 /*
890  *      String split routine.  Splits an input string IN PLACE
891  *      into pieces, based on spaces.
892  */
893 static int str2argv(char *str, char **argv, int max_argc)
894 {
895         int argc = 0;
896
897         while (*str) {
898                 if (argc >= max_argc) return argc;
899
900                 /*
901                  *      Chop out comments early.
902                  */
903                 if (*str == '#') {
904                         *str = '\0';
905                         break;
906                 }
907
908                 while ((*str == ' ') ||
909                        (*str == '\t') ||
910                        (*str == '\r') ||
911                        (*str == '\n')) *(str++) = '\0';
912
913                 if (!*str) return argc;
914
915                 argv[argc] = str;
916                 argc++;
917
918                 while (*str &&
919                        (*str != ' ') &&
920                        (*str != '\t') &&
921                        (*str != '\r') &&
922                        (*str != '\n')) str++;
923         }
924
925         return argc;
926 }
927
928 #define MAX_ARGV (16)
929
930 /*
931  *      Initialize the dictionary.
932  */
933 static int my_dict_init(const char *dir, const char *fn,
934                         const char *src_file, int src_line)
935 {
936         FILE    *fp;
937         char    dirtmp[256];
938         char    buf[256];
939         char    *p;
940         int     line = 0;
941         int     vendor;
942         int     block_vendor;
943         struct stat statbuf;
944         char    *argv[MAX_ARGV];
945         int     argc;
946
947         if (strlen(fn) >= sizeof(dirtmp) / 2 ||
948             strlen(dir) >= sizeof(dirtmp) / 2) {
949                 librad_log("dict_init: filename name too long");
950                 return -1;
951         }
952
953         /*
954          *      First see if fn is relative to dir. If so, create
955          *      new filename. If not, remember the absolute dir.
956          */
957         if ((p = strrchr(fn, '/')) != NULL) {
958                 strcpy(dirtmp, fn);
959                 dirtmp[p - fn] = 0;
960                 dir = dirtmp;
961         } else if (dir && dir[0] && strcmp(dir, ".") != 0) {
962                 snprintf(dirtmp, sizeof(dirtmp), "%s/%s", dir, fn);
963                 fn = dirtmp;
964         }
965
966         if ((fp = fopen(fn, "r")) == NULL) {
967                 if (!src_file) {
968                         librad_log("dict_init: Couldn't open dictionary \"%s\": %s",
969                                    fn, strerror(errno));
970                 } else {
971                         librad_log("dict_init: %s[%d]: Couldn't open dictionary \"%s\": %s",
972                                    src_file, src_line, fn, strerror(errno));
973                 }
974                 return -1;
975         }
976
977         stat(fn, &statbuf); /* fopen() guarantees this will succeed */
978         if (!S_ISREG(statbuf.st_mode)) {
979                 fclose(fp);
980                 librad_log("dict_init: Dictionary \"%s\" is not a regular file",
981                            fn);
982                 return -1;        
983         }
984
985         /*
986          *      Globally writable dictionaries means that users can control
987          *      the server configuration with little difficulty.
988          */
989         if ((statbuf.st_mode & S_IWOTH) != 0) {
990                 fclose(fp);
991                 librad_log("dict_init: Dictionary \"%s\" is globally writable.  Refusing to start due to insecure configuration.",
992                            fn);
993                 return -1;
994         }
995
996         dict_stat_add(fn, &statbuf);
997
998         /*
999          *      Seed the random pool with data.
1000          */
1001         lrad_rand_seed(&statbuf, sizeof(statbuf));
1002
1003         block_vendor = 0;
1004
1005         while (fgets(buf, sizeof(buf), fp) != NULL) {
1006                 line++;
1007                 if (buf[0] == '#' || buf[0] == 0 ||
1008                     buf[0] == '\n' || buf[0] == '\r')
1009                         continue;
1010
1011                 /*
1012                  *  Comment characters should NOT be appearing anywhere but
1013                  *  as start of a comment;
1014                  */
1015                 p = strchr(buf, '#');
1016                 if (p) *p = '\0';
1017
1018                 argc = str2argv(buf, argv, MAX_ARGV);
1019                 if (argc == 0) continue;
1020
1021                 if (argc == 1) {
1022                         librad_log( "dict_init: %s[%d] invalid entry",
1023                                     fn, line);
1024                         fclose(fp);
1025                         return -1;
1026                 }
1027
1028                 if (0) {
1029                         int i;
1030
1031                         fprintf(stderr, "ARGC = %d\n",argc);
1032                         for (i = 0; i < argc; i++) {
1033                                 fprintf(stderr, "\t%s\n", argv[i]);
1034                         }
1035                 }
1036
1037                 /*
1038                  *      See if we need to import another dictionary.
1039                  */
1040                 if (strcasecmp(argv[0], "$INCLUDE") == 0) {
1041                         if (my_dict_init(dir, argv[1], fn, line) < 0) {
1042                                 fclose(fp);
1043                                 return -1;
1044                         }
1045                         continue;
1046                 } /* $INCLUDE */
1047
1048                 /*
1049                  *      Perhaps this is an attribute.
1050                  */
1051                 if (strcasecmp(argv[0], "ATTRIBUTE") == 0) {
1052                         if (process_attribute(fn, line, block_vendor,
1053                                               argv + 1, argc - 1) == -1) {
1054                                 fclose(fp);
1055                                 return -1;
1056                         }
1057                         continue;
1058                 }
1059
1060                 /*
1061                  *      Process VALUE lines.
1062                  */
1063                 if (strcasecmp(argv[0], "VALUE") == 0) {
1064                         if (process_value(fn, line,
1065                                           argv + 1, argc - 1) == -1) {
1066                                 fclose(fp);
1067                                 return -1;
1068                         }
1069                         continue;
1070                 }
1071
1072                 /*
1073                  *      Process VENDOR lines.
1074                  */
1075                 if (strcasecmp(argv[0], "VENDOR") == 0) {
1076                         if (process_vendor(fn, line,
1077                                            argv + 1, argc - 1) == -1) {
1078                                 fclose(fp);
1079                                 return -1;
1080                         }
1081                         continue;
1082                 }
1083
1084                 if (strcasecmp(argv[0], "BEGIN-VENDOR") == 0) {
1085                         if (argc != 2) {
1086                                 librad_log(
1087                                 "dict_init: %s[%d] invalid BEGIN-VENDOR entry",
1088                                         fn, line);
1089                                 fclose(fp);
1090                                 return -1;
1091                         }
1092
1093                         vendor = dict_vendorbyname(argv[1]);
1094                         if (!vendor) {
1095                                 librad_log(
1096                                         "dict_init: %s[%d]: unknown vendor %s",
1097                                         fn, line, argv[1]);
1098                                 fclose(fp);
1099                                 return -1;
1100                         }
1101                         block_vendor = vendor;
1102                         continue;
1103                 } /* BEGIN-VENDOR */
1104
1105                 if (strcasecmp(argv[0], "END-VENDOR") == 0) {
1106                         if (argc != 2) {
1107                                 librad_log(
1108                                 "dict_init: %s[%d] invalid END-VENDOR entry",
1109                                         fn, line);
1110                                 fclose(fp);
1111                                 return -1;
1112                         }
1113
1114                         vendor = dict_vendorbyname(argv[1]);
1115                         if (!vendor) {
1116                                 librad_log(
1117                                         "dict_init: %s[%d]: unknown vendor %s",
1118                                         fn, line, argv[1]);
1119                                 fclose(fp);
1120                                 return -1;
1121                         }
1122
1123                         if (vendor != block_vendor) {
1124                                 librad_log(
1125                                         "dict_init: %s[%d]: END-VENDOR %s does not match any previous BEGIN-VENDOR",
1126                                         fn, line, argv[1]);
1127                                 fclose(fp);
1128                                 return -1;
1129                         }
1130                         block_vendor = 0;
1131                         continue;
1132                 } /* END-VENDOR */
1133
1134                 /*
1135                  *      Any other string: We don't recognize it.
1136                  */
1137                 librad_log(
1138                         "dict_init: %s[%d] invalid keyword \"%s\"",
1139                         fn, line, argv[0]);
1140                 fclose(fp);
1141                 return -1;
1142         }
1143         fclose(fp);
1144         return 0;
1145 }
1146
1147
1148 /*
1149  *      Empty callback for hash table initialization.
1150  */
1151 static int null_callback(void *ctx, void *data)
1152 {
1153         ctx = ctx;              /* -Wunused */
1154         data = data;            /* -Wunused */
1155
1156         return 0;
1157 }
1158
1159
1160 /*
1161  *      Initialize the directory, then fix the attr member of
1162  *      all attributes.
1163  */
1164 int dict_init(const char *dir, const char *fn)
1165 {
1166         /*
1167          *      Check if we need to change anything.  If not, don't do
1168          *      anything.
1169          */
1170         if (dict_stat_check(dir, fn)) {
1171                 return 0;
1172         }
1173
1174         /*
1175          *      Free the dictionaries, and the stat cache.
1176          */
1177         dict_free();
1178         stat_root_dir = strdup(dir);
1179         stat_root_file = strdup(fn);
1180
1181         /*
1182          *      Create the table of vendor by name.   There MAY NOT
1183          *      be multiple vendors of the same name.
1184          *
1185          *      Each vendor is malloc'd, so the free function is free.
1186          */
1187         vendors_byname = lrad_hash_table_create(dict_vendor_name_hash,
1188                                                 dict_vendor_name_cmp,
1189                                                 free);
1190         if (!vendors_byname) {
1191                 return -1;
1192         }
1193
1194         /*
1195          *      Create the table of vendors by value.  There MAY
1196          *      be vendors of the same value.  If there are, we
1197          *      pick the latest one.
1198          */
1199         vendors_byvalue = lrad_hash_table_create(dict_vendor_value_hash,
1200                                                  dict_vendor_value_cmp,
1201                                                  NULL);
1202         if (!vendors_byvalue) {
1203                 return -1;
1204         }
1205
1206         /*
1207          *      Create the table of attributes by name.   There MAY NOT
1208          *      be multiple attributes of the same name.
1209          *
1210          *      Each attribute is malloc'd, so the free function is free.
1211          */
1212         attributes_byname = lrad_hash_table_create(dict_attr_name_hash,
1213                                                    dict_attr_name_cmp,
1214                                                    free);
1215         if (!attributes_byname) {
1216                 return -1;
1217         }
1218
1219         /*
1220          *      Create the table of attributes by value.  There MAY
1221          *      be attributes of the same value.  If there are, we
1222          *      pick the latest one.
1223          */
1224         attributes_byvalue = lrad_hash_table_create(dict_attr_value_hash,
1225                                                     dict_attr_value_cmp,
1226                                                     NULL);
1227         if (!attributes_byvalue) {
1228                 return -1;
1229         }
1230
1231         values_byname = lrad_hash_table_create(dict_value_name_hash,
1232                                                dict_value_name_cmp,
1233                                                free);
1234         if (!values_byname) {
1235                 return -1;
1236         }
1237
1238         values_byvalue = lrad_hash_table_create(dict_value_value_hash,
1239                                                 dict_value_value_cmp,
1240                                                 NULL);
1241         if (!values_byvalue) {
1242                 return -1;
1243         }
1244
1245         value_fixup = NULL;     /* just to be safe. */
1246
1247         if (my_dict_init(dir, fn, NULL, 0) < 0)
1248                 return -1;
1249
1250         if (value_fixup) {
1251                 DICT_ATTR *a;
1252                 value_fixup_t *this, *next;
1253
1254                 for (this = value_fixup; this != NULL; this = next) {
1255                         next = this->next;
1256
1257                         a = dict_attrbyname(this->attrstr);
1258                         if (!a) {
1259                                 librad_log(
1260                                         "dict_init: No ATTRIBUTE \"%s\" defined for VALUE \"%s\"",
1261                                         this->attrstr, this->dval->name);
1262                                 return -1; /* leak, but they should die... */
1263                         }
1264
1265                         this->dval->attr = a->attr;
1266
1267                         /*
1268                          *      Add the value into the dictionary.
1269                          */
1270                         if (!lrad_hash_table_replace(values_byname,
1271                                                      this->dval)) {
1272                                 librad_log("dict_addvalue: Duplicate value name %s for attribute %s", this->dval->name, a->name);
1273                                 return -1;
1274                         }
1275                         
1276                         /*
1277                          *      Allow them to use the old name, but
1278                          *      prefer the new name when printing
1279                          *      values.
1280                          */
1281                         if (!lrad_hash_table_finddata(values_byvalue, this->dval)) {
1282                                 lrad_hash_table_replace(values_byvalue,
1283                                                         this->dval);
1284                         }
1285                         free(this);
1286
1287                         /*
1288                          *      Just so we don't lose track of things.
1289                          */
1290                         value_fixup = next;
1291                 }
1292         }
1293
1294         /*
1295          *      Walk over all of the hash tables to ensure they're
1296          *      initialized.  We do this because the threads may perform
1297          *      lookups, and we don't want multi-threaded re-ordering
1298          *      of the table entries.  That would be bad.
1299          */
1300         lrad_hash_table_walk(vendors_byname, null_callback, NULL);
1301         lrad_hash_table_walk(vendors_byvalue, null_callback, NULL);
1302
1303         lrad_hash_table_walk(attributes_byname, null_callback, NULL);
1304         lrad_hash_table_walk(attributes_byvalue, null_callback, NULL);
1305         
1306         lrad_hash_table_walk(values_byvalue, null_callback, NULL);
1307         lrad_hash_table_walk(values_byname, null_callback, NULL);
1308
1309         return 0;
1310 }
1311
1312 /*
1313  *      Get an attribute by its numerical value.
1314  */
1315 DICT_ATTR *dict_attrbyvalue(int attr)
1316 {
1317         DICT_ATTR dattr;
1318
1319         dattr.attr = attr;
1320
1321         return lrad_hash_table_finddata(attributes_byvalue, &dattr);
1322 }
1323
1324 /*
1325  *      Get an attribute by its name.
1326  */
1327 DICT_ATTR *dict_attrbyname(const char *name)
1328 {
1329         DICT_ATTR dattr;
1330
1331         if (!name) return NULL;
1332
1333         strNcpy(dattr.name, name, sizeof(dattr.name));
1334
1335         return lrad_hash_table_finddata(attributes_byname, &dattr);
1336 }
1337
1338 /*
1339  *      Associate a value with an attribute and return it.
1340  */
1341 DICT_VALUE *dict_valbyattr(int attr, int value)
1342 {
1343         DICT_VALUE dval;
1344
1345         dval.attr = attr;
1346         dval.value = value;
1347         
1348         return lrad_hash_table_finddata(values_byvalue, &dval);
1349 }
1350
1351 /*
1352  *      Get a value by its name, keyed off of an attribute.
1353  */
1354 DICT_VALUE *dict_valbyname(int attr, const char *name)
1355 {
1356         DICT_VALUE *dv;
1357         uint32_t buffer[(sizeof(*dv) + DICT_VALUE_MAX_NAME_LEN + 3)/4];
1358
1359         if (!name) return NULL;
1360
1361         dv = (DICT_VALUE *) buffer;
1362         dv->attr = attr;
1363         strNcpy(dv->name, name, DICT_VALUE_MAX_NAME_LEN);
1364
1365         return lrad_hash_table_finddata(values_byname, dv);
1366 }
1367
1368 /*
1369  *      Get the vendor PEC based on the vendor name
1370  *
1371  *      This is efficient only for small numbers of vendors.
1372  */
1373 int dict_vendorbyname(const char *name)
1374 {
1375         DICT_VENDOR *dv;
1376         uint32_t buffer[(sizeof(*dv) + DICT_VENDOR_MAX_NAME_LEN + 3)/4];
1377
1378         if (!name) return 0;
1379
1380         dv = (DICT_VENDOR *) buffer;
1381         strNcpy(dv->name, name, DICT_VENDOR_MAX_NAME_LEN);
1382         
1383         dv = lrad_hash_table_finddata(vendors_byname, dv);
1384         if (!dv) return 0;
1385
1386         return dv->vendorpec;
1387 }
1388
1389 /*
1390  *      Return the vendor struct based on the PEC.
1391  */
1392 DICT_VENDOR *dict_vendorbyvalue(int vendorpec)
1393 {
1394         DICT_VENDOR dv;
1395
1396         dv.vendorpec = vendorpec;
1397
1398         return lrad_hash_table_finddata(vendors_byvalue, &dv);
1399 }