2 * valuepair.c Functions to handle VALUE_PAIRs
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
25 #include <freeradius-devel/libradius.h>
29 #ifdef HAVE_PCREPOSIX_H
31 # include <pcreposix.h>
32 #elif defined(HAVE_REGEX_H)
37 * For POSIX Regular expressions.
38 * (0) Means no extended regular expressions.
39 * REG_EXTENDED means use extended regular expressions.
42 # define REG_EXTENDED (0)
46 # define REG_NOSUB (0)
50 #define attribute_eq(_x, _y) ((_x && _y) && (_x->da == _y->da) && (_x->tag == _y->tag))
54 * @note Do not call directly, use talloc_free instead.
59 static int _pairfree(VALUE_PAIR *vp) {
61 * The lack of DA means something has gone wrong
64 fr_strerror_printf("VALUE_PAIR has NULL DICT_ATTR pointer (probably already freed)");
66 * Only free the DICT_ATTR if it was dynamically allocated
67 * and was marked for free when the VALUE_PAIR is freed.
69 * @fixme This is an awful hack and needs to be removed once DICT_ATTRs are allocated by talloc.
71 } else if (vp->da->flags.vp_free) {
72 dict_attr_free(&(vp->da));
76 vp->vp_integer = 0xf4eef4ee;
80 talloc_report_depth_cb(NULL, 0, -1, fr_talloc_verify_cb, NULL);
85 /** Dynamically allocate a new attribute
87 * Allocates a new attribute and a new dictionary attr if no DA is provided.
89 * @param[in] ctx for allocated memory, usually a pointer to a RADIUS_PACKET
90 * @param[in] da Specifies the dictionary attribute to build the VP from.
91 * @return a new value pair or NULL if an error occurred.
93 VALUE_PAIR *pairalloc(TALLOC_CTX *ctx, DICT_ATTR const *da)
98 * Caller must specify a da else we don't know what the attribute type is.
101 fr_strerror_printf("Invalid arguments");
105 vp = talloc_zero(ctx, VALUE_PAIR);
107 fr_strerror_printf("Out of memory");
116 vp->length = da->flags.length;
118 talloc_set_destructor(vp, _pairfree);
123 /** Create a new valuepair
125 * If attr and vendor match a dictionary entry then a VP with that DICT_ATTR
128 * If attr or vendor are uknown will call dict_attruknown to create a dynamic
129 * DICT_ATTR of PW_TYPE_OCTETS.
131 * Which type of DICT_ATTR the VALUE_PAIR was created with can be determined by
132 * checking @verbatim vp->da->flags.is_unknown @endverbatim.
134 * @param[in] ctx for allocated memory, usually a pointer to a RADIUS_PACKET
135 * @param[in] attr number.
136 * @param[in] vendor number.
137 * @return the new valuepair or NULL on error.
139 VALUE_PAIR *paircreate(TALLOC_CTX *ctx, unsigned int attr, unsigned int vendor)
143 da = dict_attrbyvalue(attr, vendor);
145 da = dict_attrunknown(attr, vendor, true);
151 return pairalloc(ctx, da);
154 /** Free memory used by a valuepair list.
156 * @todo TLV: needs to free all dependents of each VP freed.
158 void pairfree(VALUE_PAIR **vps)
167 for (vp = fr_cursor_init(&cursor, vps);
169 vp = fr_cursor_next(&cursor)) {
177 /** Mark malformed or unrecognised attributed as unknown
179 * @param vp to change DICT_ATTR of.
180 * @return 0 on success (or if already unknown) else -1 on error.
182 int pair2unknown(VALUE_PAIR *vp)
187 if (vp->da->flags.is_unknown) {
191 da = dict_attrunknown(vp->da->attr, vp->da->vendor, true);
201 /** Find the pair with the matching DAs
204 VALUE_PAIR *pairfind_da(VALUE_PAIR *vp, DICT_ATTR const *da, int8_t tag)
213 for (i = fr_cursor_init(&cursor, &vp);
215 i = fr_cursor_next(&cursor)) {
217 if ((i->da == da) && (!i->da->flags.has_tag || TAG_EQ(tag, i->tag))) {
226 /** Find the pair with the matching attribute
228 * @todo should take DAs and do a pointer comparison.
230 VALUE_PAIR *pairfind(VALUE_PAIR *vp, unsigned int attr, unsigned int vendor, int8_t tag)
237 for (i = fr_cursor_init(&cursor, &vp);
239 i = fr_cursor_next(&cursor)) {
240 if ((i->da->attr == attr) && (i->da->vendor == vendor) && \
241 (!i->da->flags.has_tag || TAG_EQ(tag, i->tag))) {
249 /** Delete matching pairs
251 * Delete matching pairs from the attribute list.
253 * @param[in,out] first VP in list.
254 * @param[in] attr to match.
255 * @param[in] vendor to match.
256 * @param[in] tag to match. TAG_ANY matches any tag, TAG_NONE matches tagless VPs.
258 * @todo should take DAs and do a point comparison.
260 void pairdelete(VALUE_PAIR **first, unsigned int attr, unsigned int vendor,
263 VALUE_PAIR *i, *next;
264 VALUE_PAIR **last = first;
266 for(i = *first; i; i = next) {
269 if ((i->da->attr == attr) && (i->da->vendor == vendor) &&
270 (!i->da->flags.has_tag || TAG_EQ(tag, i->tag))) {
279 /** Add a VP to the end of the list.
281 * Locates the end of 'first', and links an additional VP 'add' at the end.
283 * @param[in] first VP in linked list. Will add new VP to the end of this list.
284 * @param[in] add VP to add to list.
286 void pairadd(VALUE_PAIR **first, VALUE_PAIR *add)
294 if (*first == NULL) {
298 for(i = *first; i->next; i = i->next)
303 /** Replace all matching VPs
305 * Walks over 'first', and replaces the first VP that matches 'replace'.
307 * @note Memory used by the VP being replaced will be freed.
308 * @note Will not work with unknown attributes.
310 * @param[in,out] first VP in linked list. Will search and replace in this list.
311 * @param[in] replace VP to replace.
313 void pairreplace(VALUE_PAIR **first, VALUE_PAIR *replace)
315 VALUE_PAIR *i, *next;
316 VALUE_PAIR **prev = first;
320 if (*first == NULL) {
326 * Not an empty list, so find item if it is there, and
327 * replace it. Note, we always replace the first one, and
328 * we ignore any others that might exist.
330 for(i = *first; i; i = next) {
335 * Found the first attribute, replace it,
338 if ((i->da == replace->da) && (!i->da->flags.has_tag || TAG_EQ(replace->tag, i->tag))) {
342 * Should really assert that replace->next == NULL
344 replace->next = next;
350 * Point to where the attribute should go.
356 * If we got here, we didn't find anything to replace, so
357 * stopped at the last item, which we just append to.
362 int8_t attrtagcmp(void const *a, void const *b)
364 VALUE_PAIR const *my_a = a;
365 VALUE_PAIR const *my_b = b;
372 cmp = fr_pointer_cmp(my_a->da, my_b->da);
374 if (cmp != 0) return cmp;
376 if (my_a->tag < my_b->tag) {
380 if (my_a->tag > my_b->tag) {
387 static void pairsort_split(VALUE_PAIR *source, VALUE_PAIR **front, VALUE_PAIR **back)
393 * Stopping condition - no more elements left to split
395 if (!source || !source->next) {
403 * Fast advances twice as fast as slow, so when it gets to the end,
404 * slow will point to the middle of the linked list.
422 static VALUE_PAIR *pairsort_merge(VALUE_PAIR *a, VALUE_PAIR *b, fr_cmp_t cmp)
424 VALUE_PAIR *result = NULL;
430 * Compare the DICT_ATTRs and tags
432 if (cmp(a, b) <= 0) {
434 result->next = pairsort_merge(a->next, b, cmp);
437 result->next = pairsort_merge(a, b->next, cmp);
443 /** Sort a linked list of VALUE_PAIRs using merge sort
445 * @param[in,out] vps List of VALUE_PAIRs to sort.
446 * @param[in] cmp to sort with
448 void pairsort(VALUE_PAIR **vps, fr_cmp_t cmp)
450 VALUE_PAIR *head = *vps;
455 * If there's 0-1 elements it must already be sorted.
457 if (!head || !head->next) {
461 pairsort_split(head, &a, &b); /* Split into sublists */
462 pairsort(&a, cmp); /* Traverse left */
463 pairsort(&b, cmp); /* Traverse right */
466 * merge the two sorted lists together
468 *vps = pairsort_merge(a, b, cmp);
471 /** Write an error to the library errorbuff detailing the mismatch
473 * Retrieve output with fr_strerror();
475 * @todo add thread specific talloc contexts.
477 * @param ctx a hack until we have thread specific talloc contexts.
478 * @param failed pair of attributes which didn't match.
480 void pairvalidate_debug(TALLOC_CTX *ctx, VALUE_PAIR const *failed[2])
482 VALUE_PAIR const *filter = failed[0];
483 VALUE_PAIR const *list = failed[1];
487 (void) fr_strerror(); /* Clear any existing messages */
489 if (!fr_assert(!(!filter && !list))) return;
493 fr_strerror_printf("Attribute \"%s\" not found in list", filter->da->name);
497 if (!filter || (filter->da != list->da)) {
498 fr_strerror_printf("Attribute \"%s\" not found in filter", list->da->name);
502 if (TAG_EQ(filter->tag, list->tag)) {
503 fr_strerror_printf("Attribute \"%s\" tag \"%i\" didn't match filter tag \"%i\"",
504 list->da->name, list->tag, filter->tag);
508 pair = vp_aprint(ctx, filter);
509 value = vp_aprint_value(ctx, list);
511 fr_strerror_printf("Attribute value \"%s\" didn't match filter \"%s\"", value, pair);
519 /** Uses paircmp to verify all VALUE_PAIRs in list match the filter defined by check
521 * @note will sort both filter and list in place.
523 * @param failed pointer to an array to write the pointers of the filter/list attributes that didn't match.
525 * @param filter attributes to check list against.
526 * @param list attributes, probably a request or reply
528 bool pairvalidate(VALUE_PAIR const *failed[2], VALUE_PAIR *filter, VALUE_PAIR *list)
530 vp_cursor_t filter_cursor;
531 vp_cursor_t list_cursor;
533 VALUE_PAIR *check, *match;
535 if (!filter && !list) {
540 * This allows us to verify the sets of validate and reply are equal
541 * i.e. we have a validate rule which matches every reply attribute.
543 * @todo this should be removed one we have sets and lists
545 pairsort(&filter, attrtagcmp);
546 pairsort(&list, attrtagcmp);
548 check = fr_cursor_init(&filter_cursor, &filter);
549 match = fr_cursor_init(&list_cursor, &list);
552 if (!match && !check) goto mismatch;
555 * The lists are sorted, so if the first
556 * attributes aren't of the same type, then we're
559 if (!attribute_eq(check, match)) goto mismatch;
562 * They're of the same type, but don't have the
563 * same values. This is a problem.
565 * Note that the RFCs say that for attributes of
566 * the same type, order is important.
568 if (!paircmp(check, match)) goto mismatch;
570 check = fr_cursor_next(&filter_cursor);
571 match = fr_cursor_next(&list_cursor);
574 * One list ended earlier than the others, they
577 if (!match || !check) break;
590 /** Uses paircmp to verify all VALUE_PAIRs in list match the filter defined by check
592 * @note will sort both filter and list in place.
594 * @param failed pointer to an array to write the pointers of the filter/list attributes that didn't match.
596 * @param filter attributes to check list against.
597 * @param list attributes, probably a request or reply
599 bool pairvalidate_relaxed(VALUE_PAIR const *failed[2], VALUE_PAIR *filter, VALUE_PAIR *list)
601 vp_cursor_t filter_cursor;
602 vp_cursor_t list_cursor;
604 VALUE_PAIR *check, *last_check = NULL, *match = NULL;
606 if (!filter && !list) {
611 * This allows us to verify the sets of validate and reply are equal
612 * i.e. we have a validate rule which matches every reply attribute.
614 * @todo this should be removed one we have sets and lists
616 pairsort(&filter, attrtagcmp);
617 pairsort(&list, attrtagcmp);
619 fr_cursor_init(&list_cursor, &list);
620 for (check = fr_cursor_init(&filter_cursor, &filter);
622 check = fr_cursor_next(&filter_cursor)) {
624 * Were processing check attributes of a new type.
626 if (!attribute_eq(last_check, check)) {
628 * Record the start of the matching attributes in the pair list
629 * For every other operator we require the match to be present
631 match = fr_cursor_next_by_da(&list_cursor, check->da, check->tag);
633 if (check->op == T_OP_CMP_FALSE) continue;
637 fr_cursor_init(&list_cursor, &match);
642 * Now iterate over all attributes of the same type.
644 for (match = fr_cursor_first(&list_cursor);
645 attribute_eq(match, check);
646 match = fr_cursor_next(&list_cursor)) {
648 * This attribute passed the filter
650 if (!paircmp(check, match)) goto mismatch;
664 /** Copy a single valuepair
666 * Allocate a new valuepair and copy the da from the old vp.
668 * @param[in] ctx for talloc
669 * @param[in] vp to copy.
670 * @return a copy of the input VP or NULL on error.
672 VALUE_PAIR *paircopyvp(TALLOC_CTX *ctx, VALUE_PAIR const *vp)
676 if (!vp) return NULL;
680 n = pairalloc(ctx, vp->da);
683 memcpy(n, vp, sizeof(*n));
688 if (vp->type == VT_XLAT) {
689 n->value.xlat = talloc_typed_strdup(n, n->value.xlat);
692 n->da = dict_attr_copy(vp->da, true);
700 switch (vp->da->type) {
703 n->vp_octets = NULL; /* else pairmemcpy will free vp's value */
704 pairmemcpy(n, vp->vp_octets, n->length);
708 n->vp_strvalue = NULL; /* else pairstrnpy will free vp's value */
709 pairstrncpy(n, vp->vp_strvalue, n->length);
719 /** Copy data from one VP to another
721 * Allocate a new pair using da, and copy over the value from the specified
724 * @todo Should be able to do type conversions.
726 * @param[in] ctx for talloc
727 * @param[in] da of new attribute to alloc.
728 * @param[in] vp to copy data from.
729 * @return the new valuepair.
731 VALUE_PAIR *paircopyvpdata(TALLOC_CTX *ctx, DICT_ATTR const *da, VALUE_PAIR const *vp)
735 if (!vp) return NULL;
740 * The types have to be identical, OR the "from" VP has
743 if (da->type != vp->da->type) {
746 VALUE_PAIR const **pvp;
748 if (vp->da->type == PW_TYPE_OCTETS) {
750 * Decode the data. It may be wrong!
752 if (rad_data2vp(da->attr, da->vendor, vp->vp_octets, vp->length, &n) < 0) {
761 * Else the destination type is octets
763 switch (vp->da->type) {
765 return NULL; /* can't do it */
767 case PW_TYPE_INTEGER:
771 case PW_TYPE_IPV6ADDR:
772 case PW_TYPE_IPV6PREFIX:
775 case PW_TYPE_ETHERNET:
777 case PW_TYPE_INTEGER64:
778 case PW_TYPE_IPV4PREFIX:
782 n = pairalloc(ctx, da);
785 p = talloc_array(n, uint8_t, dict_attr_sizes[vp->da->type][1] + 2);
788 length = rad_vp2attr(NULL, NULL, NULL, pvp, p, dict_attr_sizes[vp->da->type][1]);
794 pairmemcpy(n, p + 2, length - 2);
799 n = pairalloc(ctx, da);
802 memcpy(n, vp, sizeof(*n));
805 if (n->type == VT_XLAT) {
806 n->value.xlat = talloc_typed_strdup(n, n->value.xlat);
809 if (n->data.ptr) switch (n->da->type) {
812 n->vp_octets = talloc_memdup(n, vp->vp_octets, n->length);
813 talloc_set_type(n->vp_octets, uint8_t);
817 n->vp_strvalue = talloc_memdup(n, vp->vp_strvalue, n->length + 1); /* NULL byte */
818 talloc_set_type(n->vp_strvalue, char);
833 * Copy all pairs from 'from' regardless of tag, attribute or vendor.
835 * @param[in] ctx for new VALUE_PAIRs to be allocated in.
836 * @param[in] from whence to copy VALUE_PAIRs.
837 * @return the head of the new VALUE_PAIR list or NULL on error.
839 VALUE_PAIR *paircopy(TALLOC_CTX *ctx, VALUE_PAIR *from)
841 vp_cursor_t src, dst;
843 VALUE_PAIR *out = NULL, *vp;
845 fr_cursor_init(&dst, &out);
846 for (vp = fr_cursor_init(&src, &from);
848 vp = fr_cursor_next(&src)) {
850 vp = paircopyvp(ctx, vp);
855 fr_cursor_insert(&dst, vp); /* paircopy sets next pointer to NULL */
861 /** Copy matching pairs
863 * Copy pairs of a matching attribute number, vendor number and tag from the
864 * the input list to a new list, and returns the head of this list.
866 * @param[in] ctx for talloc
867 * @param[in] from whence to copy VALUE_PAIRs.
868 * @param[in] attr to match, if 0 input list will not be filtered by attr.
869 * @param[in] vendor to match.
870 * @param[in] tag to match, TAG_ANY matches any tag, TAG_NONE matches tagless VPs.
871 * @return the head of the new VALUE_PAIR list or NULL on error.
873 VALUE_PAIR *paircopy2(TALLOC_CTX *ctx, VALUE_PAIR *from,
874 unsigned int attr, unsigned int vendor, int8_t tag)
876 vp_cursor_t src, dst;
878 VALUE_PAIR *out = NULL, *vp;
880 fr_cursor_init(&dst, &out);
881 for (vp = fr_cursor_init(&src, &from);
883 vp = fr_cursor_next(&src)) {
886 if ((vp->da->attr != attr) || (vp->da->vendor != vendor)) {
890 if (vp->da->flags.has_tag && TAG_EQ(tag, vp->tag)) {
894 vp = paircopyvp(ctx, vp);
899 fr_cursor_insert(&dst, vp);
905 /** Steal all members of a VALUE_PAIR list
907 * @param[in] ctx to move VALUE_PAIRs into
908 * @param[in] from VALUE_PAIRs to move into the new context.
910 VALUE_PAIR *pairsteal(TALLOC_CTX *ctx, VALUE_PAIR *from)
915 for (vp = fr_cursor_init(&cursor, &from);
917 vp = fr_cursor_next(&cursor)) {
918 (void) talloc_steal(ctx, vp);
924 /** Move pairs from source list to destination list respecting operator
926 * @note This function does some additional magic that's probably not needed
927 * in most places. Consider using radius_pairmove in server code.
929 * @note pairfree should be called on the head of the source list to free
930 * unmoved attributes (if they're no longer needed).
932 * @note Does not respect tags when matching.
934 * @param[in] ctx for talloc
935 * @param[in,out] to destination list.
936 * @param[in,out] from source list.
938 * @see radius_pairmove
940 void pairmove(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from)
942 VALUE_PAIR *i, *found;
943 VALUE_PAIR *head_new, **tail_new;
944 VALUE_PAIR **tail_from;
946 if (!to || !from || !*from) return;
949 * We're editing the "to" list while we're adding new
950 * attributes to it. We don't want the new attributes to
951 * be edited, so we create an intermediate list to hold
952 * them during the editing process.
955 tail_new = &head_new;
958 * We're looping over the "from" list, moving some
959 * attributes out, but leaving others in place.
962 while ((i = *tail_from) != NULL) {
966 * We never move Fall-Through.
968 if (!i->da->vendor && i->da->attr == PW_FALL_THROUGH) {
969 tail_from = &(i->next);
974 * Unlike previous versions, we treat all other
975 * attributes as normal. i.e. there's no special
976 * treatment for passwords or Hint.
981 * Anything else are operators which
982 * shouldn't occur. We ignore them, and
983 * leave them in place.
986 tail_from = &(i->next);
990 * Add it to the "to" list, but only if
991 * it doesn't already exist.
994 found = pairfind(*to, i->da->attr, i->da->vendor, TAG_ANY);
995 if (!found) goto do_add;
997 tail_from = &(i->next);
1001 * Add it to the "to" list, and delete any attribute
1002 * of the same vendor/attr which already exists.
1005 found = pairfind(*to, i->da->attr, i->da->vendor, TAG_ANY);
1006 if (!found) goto do_add;
1009 * Do NOT call pairdelete() here,
1010 * due to issues with re-writing
1011 * "request->username".
1013 * Everybody calls pairmove, and
1014 * expects it to work. We can't
1015 * update request->username here,
1016 * so instead we over-write the
1017 * vp that it's pointing to.
1019 switch (found->da->type) {
1024 memcpy(found, i, sizeof(*found));
1029 pairmemsteal(found, i->vp_tlv);
1033 case PW_TYPE_OCTETS:
1034 pairmemsteal(found, i->vp_octets);
1035 i->vp_octets = NULL;
1038 case PW_TYPE_STRING:
1039 pairstrsteal(found, i->vp_strvalue);
1040 i->vp_strvalue = NULL;
1041 found->tag = i->tag;
1046 * Delete *all* of the attributes
1047 * of the same number.
1049 pairdelete(&found->next,
1051 found->da->vendor, TAG_ANY);
1054 * Remove this attribute from the
1057 *tail_from = i->next;
1063 * Move it from the old list and add it
1068 *tail_from = i->next;
1070 *tail_new = talloc_steal(ctx, i);
1071 tail_new = &(i->next);
1074 } /* loop over the "from" list. */
1077 * Take the "new" list, and append it to the "to" list.
1079 pairadd(to, head_new);
1082 /** Move matching pairs between VALUE_PAIR lists
1084 * Move pairs of a matching attribute number, vendor number and tag from the
1085 * the input list to the output list.
1087 * @note pairfree should be called on the head of the old list to free unmoved
1088 attributes (if they're no longer needed).
1090 * @param[in] ctx for talloc
1091 * @param[in,out] to destination list.
1092 * @param[in,out] from source list.
1093 * @param[in] attr to match, if PW_VENDOR_SPECIFIC and vendor 0, only VSAs will
1094 * be copied. If 0 and 0, all attributes will match
1095 * @param[in] vendor to match.
1096 * @param[in] tag to match, TAG_ANY matches any tag, TAG_NONE matches tagless VPs.
1098 void pairfilter(TALLOC_CTX *ctx, VALUE_PAIR **to, VALUE_PAIR **from, unsigned int attr, unsigned int vendor, int8_t tag)
1100 VALUE_PAIR *to_tail, *i, *next;
1101 VALUE_PAIR *iprev = NULL;
1104 * Find the last pair in the "to" list and put it in "to_tail".
1106 * @todo: replace the "if" with "VALUE_PAIR **tail"
1110 for(i = *to; i; i = i->next) {
1118 * Attr/vendor of 0 means "move them all".
1119 * It's better than "pairadd(foo,bar);bar=NULL"
1121 if ((vendor == 0) && (attr == 0)) {
1123 to_tail->next = *from;
1128 for (i = *from; i; i = i->next) {
1129 (void) talloc_steal(ctx, i);
1136 for(i = *from; i; i = next) {
1140 if (i->da->flags.has_tag && TAG_EQ(tag, i->tag)) {
1145 * vendor=0, attr = PW_VENDOR_SPECIFIC means
1146 * "match any vendor attribute".
1148 if ((vendor == 0) && (attr == PW_VENDOR_SPECIFIC)) {
1150 * It's a VSA: move it over.
1152 if (i->da->vendor != 0) goto move;
1155 * It's Vendor-Specific: move it over.
1157 if (i->da->attr == attr) goto move;
1160 * It's not a VSA: ignore it.
1167 * If it isn't an exact match, ignore it.
1169 if (!((i->da->vendor == vendor) && (i->da->attr == attr))) {
1176 * Remove the attribute from the "from" list.
1184 * Add the attribute to the "to" list.
1192 (void) talloc_steal(ctx, i);
1196 static char const *hextab = "0123456789abcdef";
1198 /** Convert string value to native attribute value
1200 * @param vp to assign value to.
1201 * @param value string to convert. Binary safe for variable length values if len is provided.
1202 * @param inlen may be 0 in which case strlen(len) is used to determine length, else inline
1203 * should be the length of the string or sub string to parse.
1204 * @return true on success, else false.
1206 int pairparsevalue(VALUE_PAIR *vp, char const *value, size_t inlen)
1213 if (!value) return -1;
1217 * It's a comparison, not a real VALUE_PAIR, copy the string over verbatim
1219 if ((vp->op == T_OP_REG_EQ) || (vp->op == T_OP_REG_NE)) {
1220 pairstrcpy(vp, value); /* Icky hacky ewww */
1224 len = (inlen == 0) ? strlen(value) : inlen;
1227 * It's a variable length type so we just alloc a new buffer
1228 * of size len and copy.
1230 switch(vp->da->type) {
1231 case PW_TYPE_STRING:
1241 vp->vp_strvalue = p = talloc_memdup(vp, value, len + 1);
1243 talloc_set_type(p, char);
1250 if (c == '\\') switch (*cp) {
1280 c = '\\'; /* no cp++ */
1283 if ((cp[0] >= '0') &&
1289 (sscanf(cp, "%3o", &x) == 1)) {
1298 } /* else at EOL \ --> \ */
1304 vp->length = vp_len;
1308 /* raw octets: 0x01020304... */
1310 if (strcmp(value, "ANY") == 0) {
1313 } /* else it's hex */
1315 case PW_TYPE_OCTETS:
1320 * No 0x prefix, just copy verbatim.
1322 if ((len < 2) || (strncasecmp(value, "0x", 2) != 0)) {
1323 pairmemcpy(vp, (uint8_t const *) value, len);
1328 #ifdef WITH_ASCEND_BINARY
1336 if ((len & 0x01) != 0) {
1337 fr_strerror_printf("Length of Hex String is not even, got %zu bytes", vp->length);
1341 vp->length = len >> 1;
1342 p = talloc_array(vp, uint8_t, vp->length);
1343 if (fr_hex2bin(p, value + 2, len) != vp->length) {
1345 fr_strerror_printf("Invalid hex data");
1353 case PW_TYPE_ABINARY:
1354 #ifdef WITH_ASCEND_BINARY
1355 if ((len > 1) && (strncasecmp(value, "0x", 2) == 0)) goto do_octets;
1357 if (ascend_parse_filter(vp, value, len) < 0 ) {
1358 /* Allow ascend_parse_filter's strerror to bubble up */
1364 * If Ascend binary is NOT defined,
1365 * then fall through to raw octets, so that
1366 * the user can at least make them by hand...
1371 /* don't use this! */
1376 if ((len < 2) || (len & 0x01) || (strncasecmp(value, "0x", 2) != 0)) {
1377 fr_strerror_printf("Invalid TLV specification");
1382 vp->length = len >> 1;
1383 p = talloc_array(vp, uint8_t, vp->length);
1385 fr_strerror_printf("No memory");
1388 if (fr_hex2bin(p, value + 2, len) != vp->length) {
1389 fr_strerror_printf("Invalid hex data in TLV");
1402 * It's a fixed size type, copy to a temporary buffer and
1403 * \0 terminate if insize >= 0.
1406 if (len >= sizeof(buffer)) {
1407 fr_strerror_printf("Temporary buffer too small");
1411 memcpy(buffer, value, inlen);
1412 buffer[inlen] = '\0';
1416 switch(vp->da->type) {
1417 case PW_TYPE_IPADDR:
1423 * FIXME: complain if hostname
1424 * cannot be resolved, or resolve later!
1429 * Convert things which are obviously integers to IP addresses
1431 * We assume the number is the bigendian representation of the
1434 if (is_integer(value)) {
1435 vp->vp_ipaddr = htonl(atol(value));
1440 * Certain applications/databases print IPv4 addresses with a
1441 * /32 suffix. Strip it off if the mask is 32, else error out.
1443 p = strchr(value, '/');
1445 if ((p[1] != '3') || (p[2] != '2') || (p[3] != '\0')) {
1446 fr_strerror_printf("Invalid IP address suffix \"%s\". Only '/32' permitted "
1447 "for non-prefix types", p);
1451 strlcpy(ipv4, value, sizeof(ipv4));
1452 ipv4[p - value] = '\0';
1458 if (ip_hton(cs, AF_INET, &ipaddr) < 0) {
1459 fr_strerror_printf("Failed to find IP address for %s", cs);
1463 vp->vp_ipaddr = ipaddr.ipaddr.ip4addr.s_addr;
1474 * Note that ALL integers are unsigned!
1476 vp->vp_integer = fr_strtoul(value, &p);
1478 if (vp->vp_integer > 255) {
1479 fr_strerror_printf("Byte value \"%s\" is larger than 255", value);
1484 if (is_whitespace(p)) break;
1486 goto check_for_value;
1493 * Note that ALL integers are unsigned!
1495 vp->vp_integer = fr_strtoul(value, &p);
1498 if (vp->vp_integer > 65535) {
1499 fr_strerror_printf("Byte value \"%s\" is larger than 65535", value);
1504 if (is_whitespace(p)) break;
1506 goto check_for_value;
1508 case PW_TYPE_INTEGER:
1513 * Note that ALL integers are unsigned!
1515 vp->vp_integer = fr_strtoul(value, &p);
1518 if (is_whitespace(p)) break;
1522 * Look for the named value for the given
1525 if ((dval = dict_valbyname(vp->da->attr, vp->da->vendor, value)) == NULL) {
1526 fr_strerror_printf("Unknown value '%s' for attribute '%s'", value, vp->da->name);
1529 vp->vp_integer = dval->value;
1533 case PW_TYPE_INTEGER64:
1538 * Note that ALL integers are unsigned!
1540 if (sscanf(value, "%" PRIu64, &y) != 1) {
1541 fr_strerror_printf("Invalid value '%s' for attribute '%s'",
1542 value, vp->da->name);
1545 vp->vp_integer64 = y;
1553 * time_t may be 64 bits, whule vp_date
1554 * MUST be 32-bits. We need an
1555 * intermediary variable to handle
1560 if (fr_get_time(value, &date) < 0) {
1561 fr_strerror_printf("failed to parse time string "
1573 if (ifid_aton(value, (void *) &vp->vp_ifid) == NULL) {
1574 fr_strerror_printf("Failed to parse interface-id string \"%s\"", value);
1580 case PW_TYPE_IPV6ADDR:
1584 if (ip_hton(value, AF_INET6, &ipaddr) < 0) {
1585 fr_strerror_printf("failed to parse IPv6 address "
1586 "string \"%s\": %s", value, fr_strerror());
1589 vp->vp_ipv6addr = ipaddr.ipaddr.ip6addr;
1590 vp->length = 16; /* length of IPv6 address */
1594 case PW_TYPE_IPV6PREFIX:
1597 unsigned int prefix;
1600 p = strchr(value, '/');
1601 if (!p || ((p - value) >= 256)) {
1602 fr_strerror_printf("invalid IPv6 prefix string \"%s\"", value);
1607 * Copy string to temporary buffer if we didn't do it earlier
1609 if (inlen == 0) memcpy(buffer, value, p - value);
1610 buffer[p - value] = '\0';
1612 if (inet_pton(AF_INET6, buffer, vp->vp_ipv6prefix + 2) <= 0) {
1613 fr_strerror_printf("failed to parse IPv6 address string \"%s\"", value);
1617 prefix = strtoul(p + 1, &eptr, 10);
1618 if ((prefix > 128) || *eptr) {
1619 fr_strerror_printf("failed to parse IPv6 address string \"%s\"", value);
1622 vp->vp_ipv6prefix[1] = prefix;
1625 struct in6_addr addr;
1627 addr = fr_ipaddr_mask6((struct in6_addr *)(&vp->vp_ipv6prefix[2]), prefix);
1628 memcpy(vp->vp_ipv6prefix + 2, &addr, sizeof(addr));
1630 vp->length = 16 + 2;
1634 case PW_TYPE_IPV4PREFIX:
1637 unsigned int prefix;
1640 p = strchr(value, '/');
1643 * 192.0.2.2 is parsed as if it was /32
1646 vp->vp_ipv4prefix[1] = 32;
1648 if (inet_pton(AF_INET, value, vp->vp_ipv4prefix + 2) <= 0) {
1649 fr_strerror_printf("failed to parse IPv4 address string \"%s\"", value);
1652 vp->length = sizeof(vp->vp_ipv4prefix);
1657 * Otherwise parse the prefix
1659 if ((size_t)(p - value) >= sizeof(buffer)) {
1660 fr_strerror_printf("invalid IPv4 prefix string \"%s\"", value);
1665 * Copy string to temporary buffer if we didn't do it earlier
1667 if (inlen == 0) memcpy(buffer, value, p - value);
1668 buffer[p - value] = '\0';
1670 if (inet_pton(AF_INET, buffer, vp->vp_ipv4prefix + 2) <= 0) {
1671 fr_strerror_printf("failed to parse IPv4 address string \"%s\"", value);
1675 prefix = strtoul(p + 1, &eptr, 10);
1676 if ((prefix > 32) || *eptr) {
1677 fr_strerror_printf("failed to parse IPv4 address string \"%s\"", value);
1680 vp->vp_ipv4prefix[1] = prefix;
1683 struct in_addr addr;
1685 addr = fr_ipaddr_mask((struct in_addr *)(&vp->vp_ipv4prefix[2]), prefix);
1686 memcpy(vp->vp_ipv4prefix + 2, &addr, sizeof(addr));
1689 vp->length = sizeof(vp->vp_ipv4prefix);
1693 case PW_TYPE_ETHERNET:
1695 char const *c1, *c2, *cp;
1699 * Convert things which are obviously integers to Ethernet addresses
1701 * We assume the number is the bigendian representation of the
1704 if (is_integer(value)) {
1705 uint64_t integer = htonll(atoll(value));
1707 memcpy(&vp->vp_ether, &integer, sizeof(vp->vp_ether));
1715 c2 = memchr(hextab, tolower((int) cp[0]), 16);
1717 } else if ((cp[1] != '\0') && ((cp[2] == ':') || (cp[2] == '\0'))) {
1718 c1 = memchr(hextab, tolower((int) cp[0]), 16);
1719 c2 = memchr(hextab, tolower((int) cp[1]), 16);
1721 if (*cp == ':') cp++;
1725 if (!c1 || !c2 || (vp_len >= sizeof(vp->vp_ether))) {
1726 fr_strerror_printf("failed to parse Ethernet address \"%s\"", value);
1729 vp->vp_ether[vp_len] = ((c1-hextab)<<4) + (c2-hextab);
1738 * Crazy polymorphic (IPv4/IPv6) attribute type for WiMAX.
1740 * We try and make is saner by replacing the original
1741 * da, with either an IPv4 or IPv6 da type.
1743 * These are not dynamic da, and will have the same vendor
1744 * and attribute as the original.
1746 case PW_TYPE_COMBO_IP:
1748 DICT_ATTR const *da;
1750 if (inet_pton(AF_INET6, value, &vp->vp_ipv6addr) > 0) {
1751 da = dict_attrbytype(vp->da->attr, vp->da->vendor, PW_TYPE_IPV6ADDR);
1753 fr_strerror_printf("Cannot find ipv6addr for %s", vp->da->name);
1757 vp->length = 16; /* length of IPv6 address */
1761 da = dict_attrbytype(vp->da->attr, vp->da->vendor,
1764 fr_strerror_printf("Cannot find ipaddr for %s", vp->da->name);
1768 if (ip_hton(value, AF_INET, &ipaddr) < 0) {
1769 fr_strerror_printf("Failed to find IPv4 address for %s", value);
1773 vp->vp_ipaddr = ipaddr.ipaddr.ip4addr.s_addr;
1781 case PW_TYPE_SIGNED:
1782 /* Damned code for 1 WiMAX attribute */
1783 vp->vp_signed = (int32_t) strtol(value, NULL, 10);
1791 fr_strerror_printf("unknown attribute type %d", vp->da->type);
1800 /** Use simple heuristics to create an VALUE_PAIR from an unknown address string
1802 * If a DICT_ATTR is not provided for the address type, parsing will fail with
1805 * @param ctx to allocate VP in.
1806 * @param value IPv4/IPv6 address/prefix string.
1807 * @param ipv4 dictionary attribute to use for an IPv4 address.
1808 * @param ipv6 dictionary attribute to use for an IPv6 address.
1809 * @param ipv4_prefix dictionary attribute to use for an IPv4 prefix.
1810 * @param ipv6_prefix dictionary attribute to use for an IPv6 prefix.
1811 * @return NULL on error, or new VALUE_PAIR.
1813 VALUE_PAIR *pairmake_ip(TALLOC_CTX *ctx, char const *value, DICT_ATTR *ipv4, DICT_ATTR *ipv6,
1814 DICT_ATTR *ipv4_prefix, DICT_ATTR *ipv6_prefix)
1817 DICT_ATTR *da = NULL;
1819 if (!fr_assert(ipv4 || ipv6 || ipv4_prefix || ipv6_prefix)) {
1823 /* No point in repeating the work of pairparsevalue */
1824 if (strchr(value, ':')) {
1825 if (strchr(value, '/')) {
1834 if (strchr(value, '/')) {
1844 fr_strerror_printf("Invalid IP value specified, allowed types are %s%s%s%s",
1845 ipv4 ? "ipaddr " : "", ipv6 ? "ipv6addr " : "",
1846 ipv4_prefix ? "ipv4prefix " : "", ipv6_prefix ? "ipv6prefix" : "");
1849 vp = pairalloc(ctx, da);
1850 if (!vp) return NULL;
1851 if (pairparsevalue(vp, value, 0) < 0) {
1860 /** Create a valuepair from an ASCII attribute and value
1862 * Where the attribute name is in the form:
1864 * - Attr-%d.%d.%d...
1865 * - Vendor-%d-Attr-%d
1866 * - VendorName-Attr-%d
1868 * @param ctx for talloc
1869 * @param attribute name to parse.
1870 * @param value to parse (must be a hex string).
1871 * @param op to assign to new valuepair.
1872 * @return new valuepair or NULL on error.
1874 static VALUE_PAIR *pairmake_any(TALLOC_CTX *ctx,
1875 char const *attribute, char const *value,
1879 DICT_ATTR const *da;
1884 da = dict_attrunknownbyname(attribute, true);
1885 if (!da) return NULL;
1888 * Unknown attributes MUST be of type 'octets'
1890 if (value && (strncasecmp(value, "0x", 2) != 0)) {
1891 fr_strerror_printf("Unknown attribute \"%s\" requires a hex "
1892 "string, not \"%s\"", attribute, value);
1894 dict_attr_free(&da);
1899 * We've now parsed the attribute properly, Let's create
1900 * it. This next stop also looks the attribute up in the
1901 * dictionary, and creates the appropriate type for it.
1903 vp = pairalloc(ctx, da);
1905 dict_attr_free(&da);
1909 vp->op = (op == 0) ? T_OP_EQ : op;
1911 if (!value) return vp;
1913 size = strlen(value + 2);
1914 vp->length = size >> 1;
1915 data = talloc_array(vp, uint8_t, vp->length);
1917 if (fr_hex2bin(data, value + 2, size) != vp->length) {
1918 fr_strerror_printf("Invalid hex string");
1923 vp->vp_octets = data;
1929 /** Create a VALUE_PAIR from ASCII strings
1931 * Converts an attribute string identifier (with an optional tag qualifier)
1932 * and value string into a VALUE_PAIR.
1934 * The string value is parsed according to the type of VALUE_PAIR being created.
1936 * @param[in] ctx for talloc
1937 * @param[in] vps list where the attribute will be added (optional)
1938 * @param[in] attribute name.
1939 * @param[in] value attribute value (may be NULL if value will be set later).
1940 * @param[in] op to assign to new VALUE_PAIR.
1941 * @return a new VALUE_PAIR.
1943 VALUE_PAIR *pairmake(TALLOC_CTX *ctx, VALUE_PAIR **vps,
1944 char const *attribute, char const *value, FR_TOKEN op)
1946 DICT_ATTR const *da;
1952 char const *attrname = attribute;
1955 * Check for tags in 'Attribute:Tag' format.
1960 ts = strrchr(attribute, ':');
1962 fr_strerror_printf("Invalid tag for attribute %s", attribute);
1967 strlcpy(buffer, attribute, sizeof(buffer));
1969 ts = strrchr(attrname, ':');
1970 if (!ts) return NULL;
1972 /* Colon found with something behind it */
1973 if (ts[1] == '*' && ts[2] == 0) {
1974 /* Wildcard tag for check items */
1977 } else if ((ts[1] >= '0') && (ts[1] <= '9')) {
1978 /* It's not a wild card tag */
1979 tag = strtol(ts + 1, &tc, 0);
1980 if (tc && !*tc && TAG_VALID_ZERO(tag))
1984 fr_strerror_printf("Invalid tag for attribute %s", attribute);
1991 * It's not found in the dictionary, so we use
1992 * another method to create the attribute.
1994 da = dict_attrbyname(attrname);
1996 vp = pairmake_any(ctx, attrname, value, op);
1997 if (vp && vps) pairadd(vps, vp);
2001 /* Check for a tag in the 'Merit' format of:
2002 * :Tag:Value. Print an error if we already found
2003 * a tag in the Attribute.
2006 if (value && (*value == ':' && da->flags.has_tag)) {
2007 /* If we already found a tag, this is invalid */
2009 fr_strerror_printf("Duplicate tag %s for attribute %s",
2011 DEBUG("Duplicate tag %s for attribute %s\n",
2015 /* Colon found and attribute allows a tag */
2016 if (value[1] == '*' && value[2] == ':') {
2017 /* Wildcard tag for check items */
2022 tag = strtol(value + 1, &tc, 0);
2023 if (tc && *tc==':' && TAG_VALID_ZERO(tag))
2029 vp = pairalloc(ctx, da);
2030 if (!vp) return NULL;
2031 vp->op = (op == 0) ? T_OP_EQ : op;
2036 case T_OP_CMP_FALSE:
2037 vp->vp_strvalue = NULL;
2039 value = NULL; /* ignore it! */
2043 * Regular expression comparison of integer attributes
2044 * does a STRING comparison of the names of their
2045 * integer attributes.
2047 case T_OP_REG_EQ: /* =~ */
2048 case T_OP_REG_NE: /* !~ */
2054 fr_strerror_printf("Regular expressions are not supported");
2060 * Someone else will fill in the value.
2066 compare = regcomp(®, value, REG_EXTENDED);
2068 regerror(compare, ®, buffer, sizeof(buffer));
2069 fr_strerror_printf("Illegal regular expression in attribute: %s: %s",
2075 vp = pairmake(ctx, NULL, attribute, NULL, op);
2076 if (!vp) return NULL;
2078 if (pairmark_xlat(vp, value) < 0) {
2083 value = NULL; /* ignore it */
2092 * FIXME: if (strcasecmp(attribute, vp->da->name) != 0)
2093 * then the user MAY have typed in the attribute name
2094 * as Vendor-%d-Attr-%d, and the value MAY be octets.
2096 * We probably want to fix pairparsevalue to accept
2097 * octets as values for any attribute.
2099 if (value && (pairparsevalue(vp, value, 0) < 0)) {
2104 if (vps) pairadd(vps, vp);
2108 /** Mark a valuepair for xlat expansion
2110 * Copies xlat source (unprocessed) string to valuepair value,
2111 * and sets value type.
2113 * @param vp to mark for expansion.
2114 * @param value to expand.
2115 * @return 0 if marking succeeded or -1 if vp already had a value, or OOM.
2117 int pairmark_xlat(VALUE_PAIR *vp, char const *value)
2122 * valuepair should not already have a value.
2124 if (vp->type != VT_NONE) {
2128 raw = talloc_typed_strdup(vp, value);
2134 vp->value.xlat = raw;
2140 /** Read a single valuepair from a buffer, and advance the pointer
2142 * Sets *eol to T_EOL if end of line was encountered.
2144 * @param[in,out] ptr to read from and update.
2145 * @param[out] raw The struct to write the raw VALUE_PAIR to.
2146 * @return the last token read.
2148 FR_TOKEN pairread(char const **ptr, VALUE_PAIR_RAW *raw)
2152 FR_TOKEN ret = T_OP_INVALID, next, quote;
2155 if (!ptr || !*ptr || !raw) {
2156 fr_strerror_printf("Invalid arguments");
2157 return T_OP_INVALID;
2161 * Skip leading spaces
2164 while ((*p == ' ') || (*p == '\t')) p++;
2167 fr_strerror_printf("No token read where we expected "
2168 "an attribute name");
2169 return T_OP_INVALID;
2173 fr_strerror_printf("Read a comment instead of a token");
2179 * Try to get the attribute name.
2184 uint8_t const *t = (uint8_t const *) p;
2186 if (q >= (raw->l_opand + sizeof(raw->l_opand))) {
2188 fr_strerror_printf("Attribute name too long");
2189 return T_OP_INVALID;
2193 * Only ASCII is allowed, and only a subset of that.
2195 if ((*t < 32) || (*t >= 128)) {
2197 fr_strerror_printf("Invalid attribute name");
2198 return T_OP_INVALID;
2202 * This is arguably easier than trying to figure
2203 * out which operators come after the attribute
2204 * name. Yes, our "lexer" is bad.
2206 if (!dict_attr_allowed_chars[(int) *t]) {
2214 * ASCII, but not a valid attribute name.
2216 if (!*raw->l_opand) goto invalid;
2219 * Look for tag (:#). This is different from :=, which
2222 if ((*p == ':') && (isdigit((int) p[1]))) {
2223 if (q >= (raw->l_opand + sizeof(raw->l_opand))) {
2228 while (isdigit((int) *p)) {
2229 if (q >= (raw->l_opand + sizeof(raw->l_opand))) {
2239 /* Now we should have an operator here. */
2240 raw->op = gettoken(ptr, buf, sizeof(buf), false);
2241 if (raw->op < T_EQSTART || raw->op > T_EQEND) {
2242 fr_strerror_printf("Expecting operator");
2244 return T_OP_INVALID;
2248 * Read value. Note that empty string values are allowed
2250 quote = gettoken(ptr, raw->r_opand, sizeof(raw->r_opand), false);
2251 if (quote == T_EOL) {
2252 fr_strerror_printf("Failed to get value");
2254 return T_OP_INVALID;
2258 * Peek at the next token. Must be T_EOL, T_COMMA, or T_HASH
2262 next = gettoken(&p, buf, sizeof(buf), false);
2273 fr_strerror_printf("Expected end of line or comma");
2274 return T_OP_INVALID;
2282 case T_DOUBLE_QUOTED_STRING:
2284 * Only report as double quoted if it contained valid
2285 * a valid xlat expansion.
2287 p = strchr(raw->r_opand, '%');
2288 if (p && (p[1] == '{')) {
2291 raw->quote = T_SINGLE_QUOTED_STRING;
2304 /** Read one line of attribute/value pairs into a list.
2306 * The line may specify multiple attributes separated by commas.
2308 * @note If the function returns T_OP_INVALID, an error has occurred and
2309 * @note the valuepair list should probably be freed.
2311 * @param ctx for talloc
2312 * @param buffer to read valuepairs from.
2313 * @param list where the parsed VALUE_PAIRs will be appended.
2314 * @return the last token parsed, or T_OP_INVALID
2316 FR_TOKEN userparse(TALLOC_CTX *ctx, char const *buffer, VALUE_PAIR **list)
2318 VALUE_PAIR *vp, *head, **tail;
2320 FR_TOKEN last_token = T_OP_INVALID;
2321 FR_TOKEN previous_token;
2325 * We allow an empty line.
2327 if (buffer[0] == 0) {
2336 raw.l_opand[0] = '\0';
2337 raw.r_opand[0] = '\0';
2339 previous_token = last_token;
2341 last_token = pairread(&p, &raw);
2342 if (last_token == T_OP_INVALID) break;
2344 if (raw.quote == T_DOUBLE_QUOTED_STRING) {
2345 vp = pairmake(ctx, NULL, raw.l_opand, NULL, raw.op);
2347 last_token = T_OP_INVALID;
2350 if (pairmark_xlat(vp, raw.r_opand) < 0) {
2352 last_token = T_OP_INVALID;
2356 vp = pairmake(ctx, NULL, raw.l_opand, raw.r_opand, raw.op);
2358 last_token = T_OP_INVALID;
2364 tail = &((*tail)->next);
2365 } while (*p && (last_token == T_COMMA));
2368 * Don't tell the caller that there was a comment.
2370 if (last_token == T_HASH) {
2371 last_token = previous_token;
2374 if (last_token == T_OP_INVALID) {
2377 pairadd(list, head);
2381 * And return the last token which we read.
2387 * Read valuepairs from the fp up to End-Of-File.
2389 int readvp2(VALUE_PAIR **out, TALLOC_CTX *ctx, FILE *fp, bool *pfiledone)
2392 FR_TOKEN last_token = T_EOL;
2396 VALUE_PAIR *vp = NULL;
2398 fr_cursor_init(&cursor, out);
2400 while (fgets(buf, sizeof(buf), fp) != NULL) {
2402 * If we get a '\n' by itself, we assume that's
2403 * the end of that VP
2405 if (buf[0] == '\n') {
2411 * Comments get ignored
2413 if (buf[0] == '#') continue;
2416 * Read all of the attributes on the current line.
2419 last_token = userparse(ctx, buf, &vp);
2421 if (last_token != T_EOL) goto error;
2425 fr_cursor_insert(&cursor, vp);
2434 vp = fr_cursor_first(&cursor);
2435 if (vp) pairfree(&vp);
2440 /** Compare two attribute values
2442 * @param[in] one the first attribute.
2443 * @param[in] two the second attribute.
2444 * @return -1 if one is less than two, 0 if both are equal, 1 if one is more than two, < -1 on error.
2446 int8_t paircmp_value(VALUE_PAIR const *one, VALUE_PAIR const *two)
2448 int64_t compare = 0;
2453 if (one->da->type != two->da->type) {
2454 fr_strerror_printf("Can't compare attribute values of different types");
2459 * After doing the previous check for special comparisons,
2460 * do the per-type comparison here.
2462 switch (one->da->type) {
2463 case PW_TYPE_ABINARY:
2464 case PW_TYPE_OCTETS:
2468 if (one->length > two->length) {
2469 length = one->length;
2471 length = two->length;
2475 compare = memcmp(one->vp_octets, two->vp_octets, length);
2476 if (compare != 0) break;
2480 * Contents are the same. The return code
2481 * is therefore the difference in lengths.
2483 * i.e. "0x00" is smaller than "0x0000"
2485 compare = one->length - two->length;
2489 case PW_TYPE_STRING:
2490 fr_assert(one->vp_strvalue);
2491 fr_assert(two->vp_strvalue);
2492 compare = strcmp(one->vp_strvalue, two->vp_strvalue);
2495 case PW_TYPE_BOOLEAN:
2498 case PW_TYPE_INTEGER:
2500 compare = (int64_t) one->vp_integer - (int64_t) two->vp_integer;
2503 case PW_TYPE_SIGNED:
2504 compare = one->vp_signed - two->vp_signed;
2507 case PW_TYPE_INTEGER64:
2509 * Don't want integer overflow!
2511 if (one->vp_integer64 < two->vp_integer64) {
2513 } else if (one->vp_integer64 > two->vp_integer64) {
2518 case PW_TYPE_ETHERNET:
2519 compare = memcmp(&one->vp_ether, &two->vp_ether, sizeof(one->vp_ether));
2522 case PW_TYPE_IPADDR:
2523 compare = (int64_t) ntohl(one->vp_ipaddr) - (int64_t) ntohl(two->vp_ipaddr);
2526 case PW_TYPE_IPV6ADDR:
2527 compare = memcmp(&one->vp_ipv6addr, &two->vp_ipv6addr, sizeof(one->vp_ipv6addr));
2530 case PW_TYPE_IPV6PREFIX:
2531 compare = memcmp(&one->vp_ipv6prefix, &two->vp_ipv6prefix, sizeof(one->vp_ipv6prefix));
2534 case PW_TYPE_IPV4PREFIX:
2535 compare = memcmp(&one->vp_ipv4prefix, &two->vp_ipv4prefix, sizeof(one->vp_ipv4prefix));
2539 compare = memcmp(&one->vp_ifid, &two->vp_ifid, sizeof(one->vp_ifid));
2543 * None of the types below should be in the REQUEST
2545 case PW_TYPE_INVALID: /* We should never see these */
2546 case PW_TYPE_COMBO_IP: /* This should of been converted into IPADDR/IPV6ADDR */
2548 case PW_TYPE_EXTENDED:
2549 case PW_TYPE_LONG_EXTENDED:
2552 case PW_TYPE_TIMEVAL:
2554 fr_assert(0); /* unknown type */
2558 * Do NOT add a default here, as new types are added
2559 * static analysis will warn us they're not handled
2565 } else if (compare < 0) {
2572 * We leverage the fact that IPv4 and IPv6 prefixes both
2573 * have the same format:
2575 * reserved, prefix-len, data...
2577 static int paircmp_op_cidr(FR_TOKEN op, int bytes,
2578 uint8_t one_net, uint8_t const *one,
2579 uint8_t two_net, uint8_t const *two)
2585 * Handle the case of netmasks being identical.
2587 if (one_net == two_net) {
2590 compare = memcmp(one, two, bytes);
2593 * If they're identical return true for
2596 if ((compare == 0) &&
2597 ((op == T_OP_CMP_EQ) ||
2604 * Everything else returns false.
2606 * 10/8 == 24/8 --> false
2607 * 10/8 <= 24/8 --> false
2608 * 10/8 >= 24/8 --> false
2614 * Netmasks are different. That limits the
2615 * possible results, based on the operator.
2625 case T_OP_LT: /* 192/8 < 192.168/16 --> false */
2626 if (one_net < two_net) {
2632 case T_OP_GT: /* 192/16 > 192.168/8 --> false */
2633 if (one_net > two_net) {
2642 if (one_net < two_net) {
2649 * Do the check byte by byte. If the bytes are
2650 * identical, it MAY be a match. If they're different,
2651 * it is NOT a match.
2656 * All leading bytes are identical.
2658 if (common == 0) return true;
2661 * Doing bitmasks takes more work.
2663 if (common < 8) break;
2665 if (one[i] != two[i]) return false;
2673 mask <<= (8 - common);
2677 if ((one[i] & mask) == ((two[i] & mask))) {
2684 /** Compare two attributes using an operator
2686 * @param[in] a the first attribute
2687 * @param[in] op the operator for comparison.
2688 * @param[in] b the second attribute
2689 * @return 1 if true, 0 if false, -1 on error.
2691 int8_t paircmp_op(VALUE_PAIR const *a, FR_TOKEN op, VALUE_PAIR const *b)
2695 if (!a || !b) return -1;
2697 switch (a->da->type) {
2698 case PW_TYPE_IPADDR:
2699 switch (b->da->type) {
2700 case PW_TYPE_IPADDR: /* IPv4 and IPv4 */
2703 case PW_TYPE_IPV4PREFIX: /* IPv4 and IPv4 Prefix */
2704 return paircmp_op_cidr(op, 4, 32, (uint8_t const *) &a->vp_ipaddr,
2705 b->vp_ipv4prefix[1], (uint8_t const *) &b->vp_ipv4prefix + 2);
2708 fr_strerror_printf("Cannot compare IPv4 with IPv6 address");
2713 case PW_TYPE_IPV4PREFIX: /* IPv4 and IPv4 Prefix */
2714 switch (b->da->type) {
2715 case PW_TYPE_IPADDR:
2716 return paircmp_op_cidr(op, 4, a->vp_ipv4prefix[1],
2717 (uint8_t const *) &a->vp_ipv4prefix + 2,
2718 32, (uint8_t const *) &b->vp_ipaddr);
2720 case PW_TYPE_IPV4PREFIX: /* IPv4 Prefix and IPv4 Prefix */
2721 return paircmp_op_cidr(op, 4, a->vp_ipv4prefix[1],
2722 (uint8_t const *) &a->vp_ipv4prefix + 2,
2723 b->vp_ipv4prefix[1], (uint8_t const *) &b->vp_ipv4prefix + 2);
2726 fr_strerror_printf("Cannot compare IPv4 with IPv6 address");
2731 case PW_TYPE_IPV6ADDR:
2732 switch (b->da->type) {
2733 case PW_TYPE_IPV6ADDR: /* IPv6 and IPv6 */
2736 case PW_TYPE_IPV6PREFIX: /* IPv6 and IPv6 Preifx */
2737 return paircmp_op_cidr(op, 16, 128, (uint8_t const *) &a->vp_ipv6addr,
2738 b->vp_ipv6prefix[1], (uint8_t const *) &b->vp_ipv6prefix + 2);
2742 fr_strerror_printf("Cannot compare IPv6 with IPv4 address");
2747 case PW_TYPE_IPV6PREFIX:
2748 switch (b->da->type) {
2749 case PW_TYPE_IPV6ADDR: /* IPv6 Prefix and IPv6 */
2750 return paircmp_op_cidr(op, 16, a->vp_ipv6prefix[1],
2751 (uint8_t const *) &a->vp_ipv6prefix + 2,
2752 128, (uint8_t const *) &b->vp_ipv6addr);
2754 case PW_TYPE_IPV6PREFIX: /* IPv6 Prefix and IPv6 */
2755 return paircmp_op_cidr(op, 16, a->vp_ipv6prefix[1],
2756 (uint8_t const *) &a->vp_ipv6prefix + 2,
2757 b->vp_ipv6prefix[1], (uint8_t const *) &b->vp_ipv6prefix + 2);
2760 fr_strerror_printf("Cannot compare IPv6 with IPv4 address");
2767 compare = paircmp_value(a, b);
2768 if (compare < -1) { /* comparison error */
2774 * Now do the operator comparison.
2778 return (compare == 0);
2781 return (compare != 0);
2784 return (compare < 0);
2787 return (compare > 0);
2790 return (compare <= 0);
2793 return (compare >= 0);
2800 /** Compare two pairs, using the operator from "a"
2802 * i.e. given two attributes, it does:
2804 * (b->data) (a->operator) (a->data)
2806 * e.g. "foo" != "bar"
2808 * @param[in] a the first attribute
2809 * @param[in] b the second attribute
2810 * @return 1 if true, 0 if false, -1 on error.
2812 int8_t paircmp(VALUE_PAIR *a, VALUE_PAIR *b)
2817 if (b) VERIFY_VP(b);
2823 case T_OP_CMP_FALSE:
2827 * a is a regex, compile it, print b to a string,
2828 * and then do string comparisons.
2838 char buffer[MAX_STRING_LEN * 4 + 1];
2840 compare = regcomp(®, a->vp_strvalue, REG_EXTENDED);
2842 regerror(compare, ®, buffer, sizeof(buffer));
2843 fr_strerror_printf("Illegal regular expression in attribute: %s: %s",
2844 a->da->name, buffer);
2853 vp_prints_value(buffer, sizeof(buffer), b, 0);
2856 * Don't care about substring matches,
2859 compare = regexec(®, buffer, 0, NULL, 0);
2862 if (a->op == T_OP_REG_EQ) {
2863 return (compare == 0);
2866 return (compare != 0);
2870 default: /* we're OK */
2874 return paircmp_op(b, a->op, a);
2877 /** Determine equality of two lists
2879 * This is useful for comparing lists of attributes inserted into a binary tree.
2881 * @param a first list of VALUE_PAIRs.
2882 * @param b second list of VALUE_PAIRs.
2883 * @return -1 if a < b, 0 if the two lists are equal, 1 if a > b, -2 on error.
2885 int8_t pairlistcmp(VALUE_PAIR *a, VALUE_PAIR *b)
2887 vp_cursor_t a_cursor, b_cursor;
2888 VALUE_PAIR *a_p, *b_p;
2891 for (a_p = fr_cursor_init(&a_cursor, &a), b_p = fr_cursor_init(&b_cursor, &b);
2893 a_p = fr_cursor_next(&a_cursor), b_p = fr_cursor_next(&b_cursor)) {
2894 /* Same VP, no point doing expensive checks */
2899 if (a_p->da < b_p->da) {
2902 if (a_p->da > b_p->da) {
2906 if (a_p->tag < b_p->tag) {
2909 if (a_p->tag > b_p->tag) {
2913 ret = paircmp_value(a_p, b_p);
2915 fr_assert(ret >= -1); /* Comparison error */
2932 /** Set the type of the VALUE_PAIR value buffer to match it's DICT_ATTR
2934 * @param vp to fixup.
2936 static void pairtypeset(VALUE_PAIR *vp)
2938 if (!vp->data.ptr) return;
2940 switch(vp->da->type) {
2941 case PW_TYPE_OCTETS:
2943 talloc_set_type(vp->data.ptr, uint8_t);
2946 case PW_TYPE_STRING:
2947 talloc_set_type(vp->data.ptr, char);
2955 /** Copy data into an "octets" data type.
2957 * @param[in,out] vp to update
2958 * @param[in] src data to copy
2959 * @param[in] size of the data, may be 0 in which case previous value will be freed.
2961 void pairmemcpy(VALUE_PAIR *vp, uint8_t const *src, size_t size)
2963 uint8_t *p = NULL, *q;
2968 p = talloc_memdup(vp, src, size);
2970 talloc_set_type(p, uint8_t);
2973 memcpy(&q, &vp->vp_octets, sizeof(q));
2979 if (size > 0) pairtypeset(vp);
2982 /** Reparent an allocated octet buffer to a VALUE_PAIR
2984 * @param[in,out] vp to update
2985 * @param[in] src buffer to steal.
2987 void pairmemsteal(VALUE_PAIR *vp, uint8_t const *src)
2993 memcpy(&q, &vp->vp_octets, sizeof(q));
2996 vp->vp_octets = talloc_steal(vp, src);
2998 vp->length = talloc_array_length(vp->vp_strvalue);
3002 /** Reparent an allocated char buffer to a VALUE_PAIR
3004 * @param[in,out] vp to update
3005 * @param[in] src buffer to steal.
3007 void pairstrsteal(VALUE_PAIR *vp, char const *src)
3013 memcpy(&q, &vp->vp_octets, sizeof(q));
3016 vp->vp_strvalue = talloc_steal(vp, src);
3018 vp->length = talloc_array_length(vp->vp_strvalue) - 1;
3022 /** Copy data into an "string" data type.
3024 * @param[in,out] vp to update
3025 * @param[in] src data to copy
3027 void pairstrcpy(VALUE_PAIR *vp, char const *src)
3033 p = talloc_strdup(vp, src);
3037 memcpy(&q, &vp->vp_strvalue, sizeof(q));
3040 vp->vp_strvalue = p;
3042 vp->length = talloc_array_length(vp->vp_strvalue) - 1;
3046 /** Copy data into an "string" data type.
3048 * @param[in,out] vp to update.
3049 * @param[in] src data to copy.
3050 * @param[in] len of data to copy.
3052 void pairstrncpy(VALUE_PAIR *vp, char const *src, size_t len)
3058 p = talloc_array(vp, char, len + 1);
3061 memcpy(p, src, len); /* embdedded \0 safe */
3064 memcpy(&q, &vp->vp_strvalue, sizeof(q));
3067 vp->vp_strvalue = p;
3073 /** Print data into an "string" data type.
3075 * @param[in,out] vp to update
3076 * @param[in] fmt the format string
3078 void pairsprintf(VALUE_PAIR *vp, char const *fmt, ...)
3086 p = talloc_vasprintf(vp, fmt, ap);
3091 memcpy(&q, &vp->vp_strvalue, sizeof(q));
3094 vp->vp_strvalue = p;
3097 vp->length = talloc_array_length(vp->vp_strvalue) - 1;