2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * @brief String expansion ("translation"). Implements %Attribute -> value
23 * @copyright 2000,2006 The FreeRADIUS server project
24 * @copyright 2000 Alan DeKok <aland@ox.org>
29 #include <freeradius-devel/radiusd.h>
30 #include <freeradius-devel/parser.h>
31 #include <freeradius-devel/rad_assert.h>
32 #include <freeradius-devel/base64.h>
36 typedef struct xlat_t {
37 char name[MAX_STRING_LEN]; //!< Name of the xlat expansion.
38 int length; //!< Length of name.
39 void *instance; //!< Module instance passed to xlat and escape functions.
40 RAD_XLAT_FUNC func; //!< xlat function.
41 RADIUS_ESCAPE_STRING escape; //!< Escape function to apply to dynamic input to func.
42 bool internal; //!< If true, cannot be redefined.
46 XLAT_LITERAL, //!< Literal string
47 XLAT_PERCENT, //!< Literal string with %v
48 XLAT_MODULE, //!< xlat module
49 XLAT_VIRTUAL, //!< virtual attribute
50 XLAT_ATTRIBUTE, //!< xlat attribute
52 XLAT_REGEX, //!< regex reference
54 XLAT_ALTERNATE //!< xlat conditional syntax :-
58 char const *fmt; //!< The format string.
59 size_t len; //!< Length of the format string.
61 xlat_state_t type; //!< type of this expansion.
62 xlat_exp_t *next; //!< Next in the list.
64 xlat_exp_t *child; //!< Nested expansion.
65 xlat_exp_t *alternate; //!< Alternative expansion if this one expanded to a zero length string.
67 value_pair_tmpl_t attr; //!< An attribute template.
68 xlat_t const *xlat; //!< The xlat expansion to expand format with.
71 typedef struct xlat_out {
72 char const *out; //!< Output data.
73 size_t len; //!< Length of the output string.
76 static rbtree_t *xlat_root = NULL;
79 static char const * const xlat_foreach_names[] = {"Foreach-Variable-0",
93 static int xlat_inst[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 }; /* up to 10 for foreach */
95 /** Print length of its RHS.
98 static ssize_t xlat_strlen(UNUSED void *instance, UNUSED REQUEST *request,
99 char const *fmt, char *out, size_t outlen)
101 snprintf(out, outlen, "%u", (unsigned int) strlen(fmt));
105 /** Print the size of the attribute in bytes.
108 static ssize_t xlat_length(UNUSED void *instance, REQUEST *request,
109 char const *fmt, char *out, size_t outlen)
112 while (isspace((int) *fmt)) fmt++;
114 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
119 snprintf(out, outlen, "%zu", vp->vp_length);
123 /** Print data as integer, not as VALUE.
126 static ssize_t xlat_integer(UNUSED void *instance, REQUEST *request,
127 char const *fmt, char *out, size_t outlen)
131 uint64_t int64 = 0; /* Needs to be initialised to zero */
132 uint32_t int32 = 0; /* Needs to be initialised to zero */
134 while (isspace((int) *fmt)) fmt++;
136 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
141 switch (vp->da->type) {
144 if (vp->vp_length > 8) {
148 if (vp->vp_length > 4) {
149 memcpy(&int64, vp->vp_octets, vp->vp_length);
150 return snprintf(out, outlen, "%" PRIu64, htonll(int64));
153 memcpy(&int32, vp->vp_octets, vp->vp_length);
154 return snprintf(out, outlen, "%i", htonl(int32));
156 case PW_TYPE_INTEGER64:
157 return snprintf(out, outlen, "%" PRIu64, vp->vp_integer64);
160 * IP addresses are treated specially, as parsing functions assume the value
161 * is bigendian and will convert it for us.
163 case PW_TYPE_IPV4_ADDR:
164 return snprintf(out, outlen, "%u", htonl(vp->vp_ipaddr));
166 case PW_TYPE_IPV4_PREFIX:
167 return snprintf(out, outlen, "%u", htonl((*(uint32_t *)(vp->vp_ipv4prefix + 2))));
169 case PW_TYPE_INTEGER:
171 return snprintf(out, outlen, "%u", vp->vp_integer);
173 return snprintf(out, outlen, "%u", (unsigned int) vp->vp_byte);
175 return snprintf(out, outlen, "%u", (unsigned int) vp->vp_short);
178 * Ethernet is weird... It's network related, so we assume to it should be
181 case PW_TYPE_ETHERNET:
182 memcpy(&int64, vp->vp_ether, vp->vp_length);
183 return snprintf(out, outlen, "%" PRIu64, htonll(int64));
186 return snprintf(out, outlen, "%i", vp->vp_signed);
188 case PW_TYPE_IPV6_ADDR:
189 return fr_prints_uint128(out, outlen, ntohlll(*(uint128_t const *) &vp->vp_ipv6addr));
191 case PW_TYPE_IPV6_PREFIX:
192 return fr_prints_uint128(out, outlen, ntohlll(*(uint128_t const *) &vp->vp_ipv6prefix[2]));
198 REDEBUG("Type '%s' of length %zu cannot be converted to integer",
199 fr_int2str(dict_attr_types, vp->da->type, "???"), vp->vp_length);
205 /** Print data as hex, not as VALUE.
208 static ssize_t xlat_hex(UNUSED void *instance, REQUEST *request,
209 char const *fmt, char *out, size_t outlen)
217 uint8_t const *buff = NULL;
219 while (isspace((int) *fmt)) fmt++;
221 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
230 if (vp->da->type == PW_TYPE_OCTETS) {
234 * Cast the value_data_t of the VP to an octets string and
238 ret = value_data_cast(request, &dst, PW_TYPE_OCTETS, NULL, vp->da->type,
239 NULL, &vp->data, vp->vp_length);
241 REDEBUG("%s", fr_strerror());
245 p = buff = dst.octets;
251 * Don't truncate the data.
253 if (outlen < (len * 2)) {
254 rad_const_free(buff);
258 for (i = 0; i < len; i++) {
259 snprintf(out + 2*i, 3, "%02x", p[i]);
261 rad_const_free(buff);
266 /** Return the tag of an attribute reference
269 static ssize_t xlat_tag(UNUSED void *instance, REQUEST *request,
270 char const *fmt, char *out, size_t outlen)
274 while (isspace((int) *fmt)) fmt++;
276 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
281 if (!vp->da->flags.has_tag || !TAG_VALID(vp->tag)) {
286 return snprintf(out, outlen, "%u", vp->tag);
289 /** Return the vendor of an attribute reference
292 static ssize_t xlat_vendor(UNUSED void *instance, REQUEST *request,
293 char const *fmt, char *out, size_t outlen)
298 while (isspace((int) *fmt)) fmt++;
300 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
305 vendor = dict_vendorbyvalue(vp->da->vendor);
310 strlcpy(out, vendor->name, outlen);
312 return vendor->length;
315 /** Return the vendor number of an attribute reference
318 static ssize_t xlat_vendor_num(UNUSED void *instance, REQUEST *request,
319 char const *fmt, char *out, size_t outlen)
323 while (isspace((int) *fmt)) fmt++;
325 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
330 return snprintf(out, outlen, "%u", vp->da->vendor);
333 /** Return the attribute name of an attribute reference
336 static ssize_t xlat_attr(UNUSED void *instance, REQUEST *request,
337 char const *fmt, char *out, size_t outlen)
341 while (isspace((int) *fmt)) fmt++;
343 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
347 strlcpy(out, vp->da->name, outlen);
349 return strlen(vp->da->name);
352 /** Return the attribute number of an attribute reference
355 static ssize_t xlat_attr_num(UNUSED void *instance, REQUEST *request,
356 char const *fmt, char *out, size_t outlen)
360 while (isspace((int) *fmt)) fmt++;
362 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
367 return snprintf(out, outlen, "%u", vp->da->attr);
370 /** Print out attribute info
372 * Prints out all instances of a current attribute, or all attributes in a list.
374 * At higher debugging levels, also prints out alternative decodings of the same
375 * value. This is helpful to determine types for unknown attributes of long
376 * passed vendors, or just crazy/broken NAS.
378 * This expands to a zero length string.
380 static ssize_t xlat_debug_attr(UNUSED void *instance, REQUEST *request, char const *fmt,
381 char *out, UNUSED size_t outlen)
386 value_pair_tmpl_t vpt;
388 if (!RDEBUG_ENABLED2) {
393 while (isspace((int) *fmt)) fmt++;
395 if (tmpl_from_attr_str(&vpt, fmt, REQUEST_CURRENT, PAIR_LIST_REQUEST, false, false) <= 0) {
396 RDEBUG("%s", fr_strerror());
400 RIDEBUG("Attributes matching \"%s\"", fmt);
403 for (vp = tmpl_cursor_init(NULL, &cursor, request, &vpt);
405 vp = tmpl_cursor_next(&cursor, &vpt)) {
406 FR_NAME_NUMBER const *type;
409 value = vp_aprints_value(vp, vp, '\'');
410 if (vp->da->flags.has_tag) {
411 RIDEBUG2("&%s:%s:%i %s %s",
412 fr_int2str(pair_lists, vpt.tmpl_list, "<INVALID>"),
415 fr_int2str(fr_tokens, vp->op, "<INVALID>"),
418 RIDEBUG2("&%s:%s %s %s",
419 fr_int2str(pair_lists, vpt.tmpl_list, "<INVALID>"),
421 fr_int2str(fr_tokens, vp->op, "<INVALID>"),
426 if (!RDEBUG_ENABLED3) continue;
428 if (vp->da->vendor) {
431 dv = dict_vendorbyvalue(vp->da->vendor);
432 RIDEBUG2("Vendor : %i (%s)", vp->da->vendor, dv ? dv->name : "unknown");
434 RIDEBUG2("Type : %s", fr_int2str(dict_attr_types, vp->da->type, "<INVALID>"));
435 RIDEBUG2("Length : %zu", vp->vp_length);
437 if (!RDEBUG_ENABLED4) continue;
439 type = dict_attr_types;
443 value_data_t *dst = NULL;
447 if ((PW_TYPE) type->number == vp->da->type) {
451 switch (type->number) {
452 case PW_TYPE_INVALID: /* Not real type */
453 case PW_TYPE_MAX: /* Not real type */
454 case PW_TYPE_EXTENDED: /* Not safe/appropriate */
455 case PW_TYPE_LONG_EXTENDED: /* Not safe/appropriate */
456 case PW_TYPE_TLV: /* Not safe/appropriate */
457 case PW_TYPE_EVS: /* Not safe/appropriate */
458 case PW_TYPE_VSA: /* @fixme We need special behaviour for these */
459 case PW_TYPE_COMBO_IP_ADDR: /* Covered by IPv4 address IPv6 address */
460 case PW_TYPE_COMBO_IP_PREFIX: /* Covered by IPv4 address IPv6 address */
461 case PW_TYPE_TIMEVAL: /* Not a VALUE_PAIR type */
468 dst = talloc_zero(vp, value_data_t);
469 ret = value_data_cast(dst, dst, type->number, NULL, vp->da->type, vp->da,
470 &vp->data, vp->vp_length);
471 if (ret < 0) goto next_type; /* We expect some to fail */
473 value = vp_data_aprints_value(dst, type->number, NULL, dst, (size_t)ret, '\'');
474 if (!value) goto next_type;
476 if ((pad = (11 - strlen(type->name))) < 0) {
481 RDEBUG2("as %s%*s: %s", type->name, pad, " ", value);
494 /** Prints the current module processing the request
497 static ssize_t xlat_module(UNUSED void *instance, REQUEST *request,
498 UNUSED char const *fmt, char *out, size_t outlen)
500 strlcpy(out, request->module, outlen);
505 #if defined(HAVE_REGEX) && defined(HAVE_PCRE)
506 static ssize_t xlat_regex(UNUSED void *instance, REQUEST *request,
507 char const *fmt, char *out, size_t outlen)
512 if (regex_request_to_sub_named(request, &p, request, fmt) < 0) {
517 len = talloc_array_length(p);
519 RDEBUG("Insufficient buffer space to write subcapture value, needed %zu bytes, have %zu bytes",
523 strlcpy(out, p, outlen);
525 return len - 1; /* - \0 */
530 /** Implements the Foreach-Variable-X
534 static ssize_t xlat_foreach(void *instance, REQUEST *request,
535 UNUSED char const *fmt, char *out, size_t outlen)
541 * See modcall, "FOREACH" for how this works.
543 pvp = (VALUE_PAIR **) request_data_reference(request, (void *)radius_get_vp, *(int*) instance);
549 len = vp_prints_value(out, outlen, *pvp, 0);
550 if (is_truncated(len, outlen)) {
551 RDEBUG("Insufficient buffer space to write foreach value");
559 /** Print data as string, if possible.
561 * If attribute "Foo" is defined as "octets" it will normally
562 * be printed as 0x0a0a0a. The xlat "%{string:Foo}" will instead
565 static ssize_t xlat_string(UNUSED void *instance, REQUEST *request,
566 char const *fmt, char *out, size_t outlen)
573 while (isspace((int) *fmt)) fmt++;
581 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) goto nothing;
583 ret = rad_vp2data(&p, vp);
588 switch (vp->da->type) {
590 len = fr_prints(out, outlen, (char const *) p, vp->vp_length, '"');
594 len = strlcpy(out, vp->vp_strvalue, outlen);
598 len = fr_prints(out, outlen, (char const *) p, ret, '\0');
605 /** xlat expand string attribute value
608 static ssize_t xlat_xlat(UNUSED void *instance, REQUEST *request,
609 char const *fmt, char *out, size_t outlen)
613 while (isspace((int) *fmt)) fmt++;
621 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) goto nothing;
623 return radius_xlat(out, outlen, request, vp->vp_strvalue, NULL, NULL);
626 /** Dynamically change the debugging level for the current request
630 static ssize_t xlat_debug(UNUSED void *instance, REQUEST *request,
631 char const *fmt, char *out, size_t outlen)
636 * Expand to previous (or current) level
638 snprintf(out, outlen, "%d", request->log.lvl & RAD_REQUEST_LVL_DEBUG4);
641 * Assume we just want to get the current value and NOT set it to 0
648 request->log.lvl = RAD_REQUEST_LVL_NONE;
649 request->log.func = NULL;
651 if (level > 4) level = 4;
653 request->log.lvl = level;
654 request->log.func = vradlog_request;
662 * Compare two xlat_t structs, based ONLY on the module name.
664 static int xlat_cmp(void const *one, void const *two)
666 xlat_t const *a = one;
667 xlat_t const *b = two;
669 if (a->length != b->length) {
670 return a->length - b->length;
673 return memcmp(a->name, b->name, a->length);
678 * find the appropriate registered xlat function.
680 static xlat_t *xlat_find(char const *name)
684 strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
685 my_xlat.length = strlen(my_xlat.name);
687 return rbtree_finddata(xlat_root, &my_xlat);
691 /** Register an xlat function.
693 * @param[in] name xlat name.
694 * @param[in] func xlat function to be called.
695 * @param[in] escape function to sanitize any sub expansions passed to the xlat function.
696 * @param[in] instance of module that's registering the xlat function.
697 * @return 0 on success, -1 on failure
699 int xlat_register(char const *name, RAD_XLAT_FUNC func, RADIUS_ESCAPE_STRING escape, void *instance)
705 if (!name || !*name) {
706 DEBUG("xlat_register: Invalid xlat name");
711 * First time around, build up the tree...
713 * FIXME: This code should be hoisted out of this function,
714 * and into a global "initialization". But it isn't critical...
721 xlat_root = rbtree_create(NULL, xlat_cmp, NULL, RBTREE_FLAG_REPLACE);
723 DEBUG("xlat_register: Failed to create tree");
728 for (i = 0; xlat_foreach_names[i] != NULL; i++) {
729 xlat_register(xlat_foreach_names[i],
730 xlat_foreach, NULL, &xlat_inst[i]);
731 c = xlat_find(xlat_foreach_names[i]);
732 rad_assert(c != NULL);
737 #define XLAT_REGISTER(_x) xlat_register(STRINGIFY(_x), xlat_ ## _x, NULL, NULL); \
738 c = xlat_find(STRINGIFY(_x)); \
739 rad_assert(c != NULL); \
742 XLAT_REGISTER(integer);
743 XLAT_REGISTER(strlen);
744 XLAT_REGISTER(length);
747 XLAT_REGISTER(vendor);
748 XLAT_REGISTER(vendor_num);
750 XLAT_REGISTER(attr_num);
751 XLAT_REGISTER(string);
753 XLAT_REGISTER(module);
754 XLAT_REGISTER(debug_attr);
755 #if defined(HAVE_REGEX) && defined(HAVE_PCRE)
756 XLAT_REGISTER(regex);
759 xlat_register("debug", xlat_debug, NULL, &xlat_inst[0]);
760 c = xlat_find("debug");
761 rad_assert(c != NULL);
766 * If it already exists, replace the instance.
768 strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
769 my_xlat.length = strlen(my_xlat.name);
770 c = rbtree_finddata(xlat_root, &my_xlat);
773 DEBUG("xlat_register: Cannot re-define internal xlat");
779 c->instance = instance;
784 * Doesn't exist. Create it.
786 c = talloc_zero(xlat_root, xlat_t);
790 strlcpy(c->name, name, sizeof(c->name));
791 c->length = strlen(c->name);
792 c->instance = instance;
794 node = rbtree_insert_node(xlat_root, c);
801 * Ensure that the data is deleted when the node is
804 * @todo: Maybe this should be the other way around...
805 * when a thing IN the tree is deleted, it's automatically
806 * removed from the tree. But for now, this works.
808 (void) talloc_steal(node, c);
812 /** Unregister an xlat function
814 * We can only have one function to call per name, so the passing of "func"
815 * here is extraneous.
817 * @param[in] name xlat to unregister.
818 * @param[in] func unused.
819 * @param[in] instance data.
821 void xlat_unregister(char const *name, UNUSED RAD_XLAT_FUNC func, void *instance)
826 if (!name || !xlat_root) return;
828 strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
829 my_xlat.length = strlen(my_xlat.name);
831 c = rbtree_finddata(xlat_root, &my_xlat);
834 if (c->instance != instance) return;
836 rbtree_deletebydata(xlat_root, c);
839 static int xlat_unregister_callback(void *instance, void *data)
841 xlat_t *c = (xlat_t *) data;
843 if (c->instance != instance) return 0; /* keep walking */
845 return 2; /* delete it */
848 void xlat_unregister_module(void *instance)
850 rbtree_walk(xlat_root, RBTREE_DELETE_ORDER, xlat_unregister_callback, instance);
854 * Internal redundant handler for xlats
856 typedef enum xlat_redundant_type_t {
860 XLAT_REDUNDANT_LOAD_BALANCE,
861 } xlat_redundant_type_t;
863 typedef struct xlat_redundant_t {
864 xlat_redundant_type_t type;
870 static ssize_t xlat_redundant(void *instance, REQUEST *request,
871 char const *fmt, char *out, size_t outlen)
873 xlat_redundant_t *xr = instance;
878 rad_assert(xr->type == XLAT_REDUNDANT);
881 * Pick the first xlat which succeeds
883 for (ci = cf_item_find_next(xr->cs, NULL);
885 ci = cf_item_find_next(xr->cs, ci)) {
888 if (!cf_item_is_pair(ci)) continue;
890 name = cf_pair_attr(cf_item_to_pair(ci));
891 rad_assert(name != NULL);
893 xlat = xlat_find(name);
896 rcode = xlat->func(xlat->instance, request, fmt, out, outlen);
897 if (rcode <= 0) continue;
902 * Everything failed. Oh well.
909 static ssize_t xlat_load_balance(void *instance, REQUEST *request,
910 char const *fmt, char *out, size_t outlen)
913 xlat_redundant_t *xr = instance;
915 CONF_ITEM *found = NULL;
920 * Choose a child at random.
922 for (ci = cf_item_find_next(xr->cs, NULL);
924 ci = cf_item_find_next(xr->cs, ci)) {
925 if (!cf_item_is_pair(ci)) continue;
929 * Replace the previously found one with a random
932 if ((count * (fr_rand() & 0xffff)) < (uint32_t) 0x10000) {
938 * Plain load balancing: do one child, and only one child.
940 if (xr->type == XLAT_LOAD_BALANCE) {
941 name = cf_pair_attr(cf_item_to_pair(found));
942 rad_assert(name != NULL);
944 xlat = xlat_find(name);
945 if (!xlat) return -1;
947 return xlat->func(xlat->instance, request, fmt, out, outlen);
950 rad_assert(xr->type == XLAT_REDUNDANT_LOAD_BALANCE);
953 * Try the random one we found. If it fails, keep going
954 * through the rest of the children.
958 name = cf_pair_attr(cf_item_to_pair(ci));
959 rad_assert(name != NULL);
961 xlat = xlat_find(name);
965 rcode = xlat->func(xlat->instance, request, fmt, out, outlen);
966 if (rcode > 0) return rcode;
970 * Go to the next one, wrapping around at the end.
972 ci = cf_item_find_next(xr->cs, ci);
973 if (!ci) ci = cf_item_find_next(xr->cs, NULL);
974 } while (ci != found);
980 bool xlat_register_redundant(CONF_SECTION *cs)
982 char const *name1, *name2;
983 xlat_redundant_t *xr;
985 name1 = cf_section_name1(cs);
986 name2 = cf_section_name2(cs);
988 if (!name2) return false;
990 if (xlat_find(name2)) {
991 cf_log_err_cs(cs, "An expansion is already registered for this name");
995 xr = talloc_zero(cs, xlat_redundant_t);
996 if (!xr) return false;
998 if (strcmp(name1, "redundant") == 0) {
999 xr->type = XLAT_REDUNDANT;
1001 } else if (strcmp(name1, "redundant-load-balance") == 0) {
1002 xr->type = XLAT_REDUNDANT_LOAD_BALANCE;
1004 } else if (strcmp(name1, "load-balance") == 0) {
1005 xr->type = XLAT_LOAD_BALANCE;
1014 * Get the number of children for load balancing.
1016 if (xr->type == XLAT_REDUNDANT) {
1017 if (xlat_register(name2, xlat_redundant, NULL, xr) < 0) {
1025 for (ci = cf_item_find_next(cs, NULL);
1027 ci = cf_item_find_next(cs, ci)) {
1028 if (!cf_item_is_pair(ci)) continue;
1030 if (!xlat_find(cf_pair_attr(cf_item_to_pair(ci)))) {
1038 if (xlat_register(name2, xlat_load_balance, NULL, xr) < 0) {
1048 /** Crappy temporary function to add attribute ref support to xlats
1050 * This needs to die, and hopefully will die, when xlat functions accept
1051 * xlat node structures.
1053 * Provides either a pointer to a buffer which contains the value of the reference VALUE_PAIR
1054 * in an architecture independent format. Or a pointer to the start of the fmt string.
1056 * The pointer is only guaranteed to be valid between calls to xlat_fmt_to_ref,
1057 * and so long as the source VALUE_PAIR is not freed.
1059 * @param out where to write a pointer to the buffer to the data the xlat function needs to work on.
1060 * @param request current request.
1061 * @param fmt string.
1062 * @returns the length of the data or -1 on error.
1064 ssize_t xlat_fmt_to_ref(uint8_t const **out, REQUEST *request, char const *fmt)
1068 while (isspace((int) *fmt)) fmt++;
1070 if (fmt[0] == '&') {
1071 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
1076 return rad_vp2data(out, vp);
1079 *out = (uint8_t const *)fmt;
1083 /** De-register all xlat functions, used mainly for debugging.
1086 void xlat_free(void)
1088 rbtree_free(xlat_root);
1092 # define XLAT_DEBUG DEBUG3
1094 # define XLAT_DEBUG(...)
1097 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1098 char const **error);
1099 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1100 bool brace, char const **error);
1101 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
1102 RADIUS_ESCAPE_STRING escape, void *escape_ctx);
1104 static ssize_t xlat_tokenize_alternation(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1111 rad_assert(fmt[0] == '%');
1112 rad_assert(fmt[1] == '{');
1113 rad_assert(fmt[2] == '%');
1114 rad_assert(fmt[3] == '{');
1116 XLAT_DEBUG("ALTERNATE <-- %s", fmt);
1118 node = talloc_zero(ctx, xlat_exp_t);
1119 node->type = XLAT_ALTERNATE;
1122 slen = xlat_tokenize_expansion(node, p, &node->child, error);
1125 return slen - (p - fmt);
1131 *error = "Expected ':' after first expansion";
1138 *error = "Expected '-' after ':'";
1144 * Allow the RHS to be empty as a special case.
1148 * Hack up an empty string.
1150 node->alternate = talloc_zero(node, xlat_exp_t);
1151 node->alternate->type = XLAT_LITERAL;
1152 node->alternate->fmt = talloc_typed_strdup(node->alternate, "");
1156 slen = xlat_tokenize_literal(node, p, &node->alternate, true, error);
1159 return slen - (p - fmt);
1162 if (!node->alternate) {
1164 *error = "Empty expansion is invalid";
1174 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1182 rad_assert(fmt[0] == '%');
1183 rad_assert(fmt[1] == '{');
1188 if ((fmt[2] == '%') && (fmt[3] == '{')) return xlat_tokenize_alternation(ctx, fmt, head, error);
1190 XLAT_DEBUG("EXPANSION <-- %s", fmt);
1191 node = talloc_zero(ctx, xlat_exp_t);
1192 node->fmt = fmt + 2;
1197 * Handle regex's specially.
1200 num = strtol(p, &q, 10);
1201 if (p != q && (*q == '}')) {
1202 XLAT_DEBUG("REGEX <-- %s", fmt);
1205 if ((num > REQUEST_MAX_REGEX) || (num < 0)) {
1207 *error = "Invalid regex reference. Must be in range 0-" STRINGIFY(REQUEST_MAX_REGEX);
1210 node->attr.tmpl_num = num;
1212 node->type = XLAT_REGEX;
1215 return (q - fmt) + 1;
1217 #endif /* HAVE_REGEX */
1222 * %{Tunnel-Password:1}
1223 * %{Tunnel-Password:1[#]}
1224 * %{request:Attr-Name}
1225 * %{request:Tunnel-Password:1}
1226 * %{request:Tunnel-Password:1[#]}
1231 * This is for efficiency, so we don't search for an xlat,
1232 * when what's being referenced is obviously an attribute.
1235 for (q = p; *q != '\0'; q++) {
1236 if (*q == ':') break;
1238 if (isspace((int) *q)) break;
1240 if (*q == '[') continue;
1242 if (*q == '}') break;
1246 * Check for empty expressions %{}
1248 if ((*q == '}') && (q == p)) {
1249 *error = "Empty expression is invalid";
1254 * Might be a module name reference.
1256 * If it's not, it's an attribute or parse error.
1260 node->xlat = xlat_find(node->fmt);
1265 node->type = XLAT_MODULE;
1268 XLAT_DEBUG("MOD <-- %s ... %s", node->fmt, p);
1270 slen = xlat_tokenize_literal(node, p, &node->child, true, error);
1273 return slen - (p - fmt);
1278 rad_assert(node->next == NULL);
1282 *q = ':'; /* Avoids a strdup */
1286 * The first token ends with:
1287 * - '[' - Which is an attribute index, so it must be an attribute.
1288 * - '}' - The end of the expansion, which means it was a bareword.
1290 slen = tmpl_from_attr_substr(&node->attr, p, REQUEST_CURRENT, PAIR_LIST_REQUEST, true, true);
1293 * If the parse error occurred before the ':'
1294 * then the error is changed to 'Unknown module',
1295 * as it was more likely to be a bad module name,
1296 * than a request qualifier.
1298 if ((*q == ':') && ((p + (slen * -1)) < q)) {
1299 *error = "Unknown module";
1301 *error = fr_strerror();
1303 return slen - (p - fmt);
1307 * Might be a virtual XLAT attribute
1309 if (node->attr.type == TMPL_TYPE_ATTR_UNDEFINED) {
1310 node->xlat = xlat_find(node->attr.tmpl_unknown_name);
1312 node->type = XLAT_VIRTUAL;
1313 node->fmt = node->attr.tmpl_unknown_name;
1315 XLAT_DEBUG("VIRTUAL <-- %s", node->fmt);
1317 rad_assert(node->next == NULL);
1323 *error = "Unknown attribute";
1327 node->type = XLAT_ATTRIBUTE;
1332 *error = "No matching closing brace";
1333 return -1; /* second character of format string */
1337 rad_assert(node->next == NULL);
1343 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1344 bool brace, char const **error)
1349 if (!*fmt) return 0;
1351 XLAT_DEBUG("LITERAL <-- %s", fmt);
1353 node = talloc_zero(ctx, xlat_exp_t);
1356 node->type = XLAT_LITERAL;
1364 *error = "Invalid escape at end of string";
1372 * Process the expansion.
1374 if ((p[0] == '%') && (p[1] == '{')) {
1377 XLAT_DEBUG("EXPANSION-2 <-- %s", node->fmt);
1379 slen = xlat_tokenize_expansion(node, p, &node->next, error);
1382 return slen - (p - fmt);
1384 *p = '\0'; /* end the literal */
1387 rad_assert(node->next != NULL);
1390 * Short-circuit the recursive call.
1391 * This saves another function call and
1392 * memory allocation.
1397 * "foo %{User-Name} bar"
1399 * EXPANSION User-Name
1402 slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1403 rad_assert(slen != 0);
1406 return slen - (p - fmt);
1409 brace = false; /* it was found above, or else the above code errored out */
1411 break; /* stop processing the string */
1415 * Check for valid single-character expansions.
1421 if (!p[1] || !strchr("%dlmntDGHISTYv", p[1])) {
1423 *error = "Invalid variable expansion";
1428 next = talloc_zero(node, xlat_exp_t);
1432 next->fmt = talloc_typed_strdup(next, "%");
1434 XLAT_DEBUG("LITERAL-PERCENT <-- %s", next->fmt);
1435 next->type = XLAT_LITERAL;
1440 XLAT_DEBUG("PERCENT <-- %c", *next->fmt);
1441 next->type = XLAT_PERCENT;
1453 slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1454 rad_assert(slen != 0);
1457 return slen - (p - fmt);
1460 brace = false; /* it was found above, or else the above code errored out */
1462 break; /* stop processing the string */
1466 * If required, eat the brace.
1468 if (brace && (*p == '}')) {
1480 * We were told to look for a brace, but we ran off of
1481 * the end of the string before we found one.
1484 *error = "Missing closing brace at end of string";
1489 * Squash zero-width literals
1491 if (node->len > 0) {
1495 (void) talloc_steal(ctx, node->next);
1504 static char const xlat_tabs[] = " ";
1506 static void xlat_tokenize_debug(xlat_exp_t const *node, int lvl)
1508 rad_assert(node != NULL);
1510 if (lvl >= (int) sizeof(xlat_tabs)) lvl = sizeof(xlat_tabs);
1513 switch (node->type) {
1515 DEBUG("%.*sliteral --> %s", lvl, xlat_tabs, node->fmt);
1519 DEBUG("%.*spercent --> %c", lvl, xlat_tabs, node->fmt[0]);
1522 case XLAT_ATTRIBUTE:
1523 rad_assert(node->attr.tmpl_da != NULL);
1524 DEBUG("%.*sattribute --> %s", lvl, xlat_tabs, node->attr.tmpl_da->name);
1525 rad_assert(node->child == NULL);
1526 if ((node->attr.tmpl_tag != TAG_ANY) || (node->attr.tmpl_num != NUM_ANY)) {
1527 DEBUG("%.*s{", lvl, xlat_tabs);
1529 DEBUG("%.*sref %d", lvl + 1, xlat_tabs, node->attr.tmpl_request);
1530 DEBUG("%.*slist %d", lvl + 1, xlat_tabs, node->attr.tmpl_list);
1532 if (node->attr.tmpl_tag != TAG_ANY) {
1533 DEBUG("%.*stag %d", lvl + 1, xlat_tabs, node->attr.tmpl_tag);
1535 if (node->attr.tmpl_num != NUM_ANY) {
1536 if (node->attr.tmpl_num == NUM_COUNT) {
1537 DEBUG("%.*s[#]", lvl + 1, xlat_tabs);
1538 } else if (node->attr.tmpl_num == NUM_ALL) {
1539 DEBUG("%.*s[*]", lvl + 1, xlat_tabs);
1541 DEBUG("%.*s[%d]", lvl + 1, xlat_tabs, node->attr.tmpl_num);
1545 DEBUG("%.*s}", lvl, xlat_tabs);
1550 rad_assert(node->fmt != NULL);
1551 DEBUG("%.*svirtual --> %s", lvl, xlat_tabs, node->fmt);
1555 rad_assert(node->xlat != NULL);
1556 DEBUG("%.*sxlat --> %s", lvl, xlat_tabs, node->xlat->name);
1558 DEBUG("%.*s{", lvl, xlat_tabs);
1559 xlat_tokenize_debug(node->child, lvl + 1);
1560 DEBUG("%.*s}", lvl, xlat_tabs);
1566 DEBUG("%.*sregex-var --> %d", lvl, xlat_tabs, node->attr.tmpl_num);
1570 case XLAT_ALTERNATE:
1571 DEBUG("%.*sif {", lvl, xlat_tabs);
1572 xlat_tokenize_debug(node->child, lvl + 1);
1573 DEBUG("%.*s}", lvl, xlat_tabs);
1574 DEBUG("%.*selse {", lvl, xlat_tabs);
1575 xlat_tokenize_debug(node->alternate, lvl + 1);
1576 DEBUG("%.*s}", lvl, xlat_tabs);
1583 size_t xlat_sprint(char *buffer, size_t bufsize, xlat_exp_t const *node)
1594 end = buffer + bufsize;
1597 switch (node->type) {
1599 strlcpy(p, node->fmt, end - p);
1605 p[1] = node->fmt[0];
1609 case XLAT_ATTRIBUTE:
1613 if (node->attr.tmpl_request != REQUEST_CURRENT) {
1614 strlcpy(p, fr_int2str(request_refs, node->attr.tmpl_request, "??"), end - p);
1619 if ((node->attr.tmpl_request != REQUEST_CURRENT) ||
1620 (node->attr.tmpl_list != PAIR_LIST_REQUEST)) {
1621 strlcpy(p, fr_int2str(pair_lists, node->attr.tmpl_list, "??"), end - p);
1626 strlcpy(p, node->attr.tmpl_da->name, end - p);
1629 if (node->attr.tmpl_tag != TAG_ANY) {
1631 snprintf(p, end - p, "%u", node->attr.tmpl_tag);
1635 if (node->attr.tmpl_num != NUM_ANY) {
1637 switch (node->attr.tmpl_num) {
1647 snprintf(p, end - p, "%i", node->attr.tmpl_num);
1656 snprintf(p, end - p, "%%{%i}", node->attr.tmpl_num);
1663 strlcpy(p, node->fmt, end - p);
1671 strlcpy(p, node->xlat->name, end - p);
1674 rad_assert(node->child != NULL);
1675 len = xlat_sprint(p, end - p, node->child);
1680 case XLAT_ALTERNATE:
1684 len = xlat_sprint(p, end - p, node->child);
1690 len = xlat_sprint(p, end - p, node->alternate);
1698 if (p == end) break;
1708 ssize_t xlat_tokenize(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1711 return xlat_tokenize_literal(ctx, fmt, head, false, error);
1715 /** Tokenize an xlat expansion
1717 * @param[in] request the input request. Memory will be attached here.
1718 * @param[in] fmt the format string to expand
1719 * @param[out] head the head of the xlat list / tree structure.
1721 static ssize_t xlat_tokenize_request(REQUEST *request, char const *fmt, xlat_exp_t **head)
1725 char const *error = NULL;
1730 * Copy the original format string to a buffer so that
1731 * the later functions can mangle it in-place, which is
1734 tokens = talloc_typed_strdup(request, fmt);
1735 if (!tokens) return -1;
1737 slen = xlat_tokenize_literal(request, tokens, head, false, &error);
1740 * Zero length expansion, return a zero length node.
1743 *head = talloc_zero(request, xlat_exp_t);
1747 * Output something like:
1750 * " ^ error was here"
1753 talloc_free(tokens);
1754 rad_assert(error != NULL);
1756 REMARKER(fmt, -slen, error);
1760 if (*head && (debug_flag > 2)) {
1762 DEBUG("Parsed xlat tree:");
1763 xlat_tokenize_debug(*head, 0);
1767 * All of the nodes point to offsets in the "tokens"
1768 * string. Let's ensure that free'ing head will free
1771 (void) talloc_steal(*head, tokens);
1777 static char *xlat_getvp(TALLOC_CTX *ctx, REQUEST *request, value_pair_tmpl_t const *vpt,
1778 bool escape, bool return_null)
1780 VALUE_PAIR *vp = NULL, *virtual = NULL;
1781 RADIUS_PACKET *packet = NULL;
1786 char quote = escape ? '"' : '\0';
1791 * See if we're dealing with an attribute in the request
1793 * This allows users to manipulate virtual attributes as if
1794 * they were real ones.
1796 vp = tmpl_cursor_init(&err, &cursor, request, vpt);
1797 if (vp) goto do_print;
1800 * We didn't find the VP in a list.
1801 * If it's not a virtual one, and we're not meant to
1802 * be counting it, return.
1804 if (!vpt->tmpl_da->flags.virtual) {
1805 if (vpt->tmpl_num == NUM_COUNT) goto do_print;
1810 * Switch out the request to the one specified by the template
1812 if (radius_request(&request, vpt->tmpl_request) < 0) return NULL;
1815 * Some non-packet expansions
1817 switch (vpt->tmpl_da->attr) {
1819 break; /* ignore them */
1821 case PW_CLIENT_SHORTNAME:
1822 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1823 if (request->client && request->client->shortname) {
1824 return talloc_typed_strdup(ctx, request->client->shortname);
1826 return talloc_typed_strdup(ctx, "<UNKNOWN-CLIENT>");
1828 case PW_REQUEST_PROCESSING_STAGE:
1829 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1830 if (request->component) {
1831 return talloc_typed_strdup(ctx, request->component);
1833 return talloc_typed_strdup(ctx, "server_core");
1835 case PW_VIRTUAL_SERVER:
1836 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1837 if (!request->server) return NULL;
1838 return talloc_typed_strdup(ctx, request->server);
1840 case PW_MODULE_RETURN_CODE:
1841 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1842 if (!request->rcode) return NULL;
1843 return talloc_typed_strdup(ctx, fr_int2str(modreturn_table, request->rcode, ""));
1847 * All of the attributes must now refer to a packet.
1848 * If there's no packet, we can't print any attribute
1851 packet = radius_packet(request, vpt->tmpl_list);
1853 if (return_null) return NULL;
1854 return vp_aprints_type(ctx, vpt->tmpl_da->type);
1858 switch (vpt->tmpl_da->attr) {
1862 case PW_PACKET_TYPE:
1863 dv = dict_valbyattr(PW_PACKET_TYPE, 0, packet->code);
1864 if (dv) return talloc_typed_strdup(ctx, dv->name);
1865 return talloc_typed_asprintf(ctx, "%d", packet->code);
1867 case PW_RESPONSE_PACKET_TYPE:
1872 if (request->proxy_reply && (!request->reply || !request->reply->code)) {
1873 code = request->proxy_reply->code;
1876 if (request->reply) {
1877 code = request->reply->code;
1880 return talloc_typed_strdup(ctx, fr_packet_codes[code]);
1884 * Virtual attributes which require a temporary VALUE_PAIR
1885 * to be allocated. We can't use stack allocated memory
1886 * because of the talloc checks sprinkled throughout the
1887 * various VP functions.
1889 case PW_PACKET_AUTHENTICATION_VECTOR:
1890 virtual = pairalloc(ctx, vpt->tmpl_da);
1891 pairmemcpy(virtual, packet->vector, sizeof(packet->vector));
1895 case PW_CLIENT_IP_ADDRESS:
1896 case PW_PACKET_SRC_IP_ADDRESS:
1897 if (packet->src_ipaddr.af == AF_INET) {
1898 virtual = pairalloc(ctx, vpt->tmpl_da);
1899 virtual->vp_ipaddr = packet->src_ipaddr.ipaddr.ip4addr.s_addr;
1904 case PW_PACKET_DST_IP_ADDRESS:
1905 if (packet->dst_ipaddr.af == AF_INET) {
1906 virtual = pairalloc(ctx, vpt->tmpl_da);
1907 virtual->vp_ipaddr = packet->dst_ipaddr.ipaddr.ip4addr.s_addr;
1912 case PW_PACKET_SRC_IPV6_ADDRESS:
1913 if (packet->src_ipaddr.af == AF_INET6) {
1914 virtual = pairalloc(ctx, vpt->tmpl_da);
1915 memcpy(&virtual->vp_ipv6addr,
1916 &packet->src_ipaddr.ipaddr.ip6addr,
1917 sizeof(packet->src_ipaddr.ipaddr.ip6addr));
1922 case PW_PACKET_DST_IPV6_ADDRESS:
1923 if (packet->dst_ipaddr.af == AF_INET6) {
1924 virtual = pairalloc(ctx, vpt->tmpl_da);
1925 memcpy(&virtual->vp_ipv6addr,
1926 &packet->dst_ipaddr.ipaddr.ip6addr,
1927 sizeof(packet->dst_ipaddr.ipaddr.ip6addr));
1932 case PW_PACKET_SRC_PORT:
1933 virtual = pairalloc(ctx, vpt->tmpl_da);
1934 virtual->vp_integer = packet->src_port;
1938 case PW_PACKET_DST_PORT:
1939 virtual = pairalloc(ctx, vpt->tmpl_da);
1940 virtual->vp_integer = packet->dst_port;
1946 * Fake various operations for virtual attributes.
1949 if (vpt->tmpl_num != NUM_ANY) switch (vpt->tmpl_num) {
1951 * [n] is NULL (we only have [0])
1956 * [*] means only one.
1962 * [#] means 1 (as there's only one)
1966 ret = talloc_strdup(ctx, "1");
1970 * [0] is fine (get the first instance)
1979 switch (vpt->tmpl_num) {
1981 * Return a count of the VPs.
1987 fr_cursor_first(&cursor);
1988 while (fr_cursor_next_by_da(&cursor, vpt->tmpl_da, vpt->tmpl_tag)) count++;
1990 return talloc_typed_asprintf(ctx, "%d", count);
1995 * Concatenate all values together,
1996 * separated by commas.
2002 if (!fr_cursor_current(&cursor)) return NULL;
2003 p = vp_aprints_value(ctx, vp, quote);
2004 if (!p) return NULL;
2006 while ((vp = tmpl_cursor_next(&cursor, vpt)) != NULL) {
2007 q = vp_aprints_value(ctx, vp, quote);
2008 if (!q) return NULL;
2009 p = talloc_strdup_append(p, ",");
2010 p = talloc_strdup_append(p, q);
2018 * The cursor was set to the correct
2019 * position above by tmpl_cursor_init.
2021 vp = fr_cursor_current(&cursor);
2026 if (return_null) return NULL;
2027 return vp_aprints_type(ctx, vpt->tmpl_da->type);
2031 ret = vp_aprints_value(ctx, vp, quote);
2034 talloc_free(virtual);
2039 static const char xlat_spaces[] = " ";
2042 static char *xlat_aprint(TALLOC_CTX *ctx, REQUEST *request, xlat_exp_t const * const node,
2043 RADIUS_ESCAPE_STRING escape, void *escape_ctx, int lvl)
2046 char *str = NULL, *child;
2049 XLAT_DEBUG("%.*sxlat aprint %d", lvl, xlat_spaces, node->type);
2051 switch (node->type) {
2053 * Don't escape this.
2056 XLAT_DEBUG("xlat_aprint LITERAL");
2057 return talloc_typed_strdup(ctx, node->fmt);
2060 * Do a one-character expansion.
2065 size_t freespace = 256;
2069 XLAT_DEBUG("xlat_aprint PERCENT");
2071 str = talloc_array(ctx, char, freespace); /* @todo do better allocation */
2074 when = request->timestamp;
2075 if (request->packet) {
2076 when = request->packet->timestamp.tv_sec;
2085 case 'd': /* request day */
2086 if (!localtime_r(&when, &ts)) goto error;
2087 strftime(str, freespace, "%d", &ts);
2090 case 'l': /* request timestamp */
2091 snprintf(str, freespace, "%lu",
2092 (unsigned long) when);
2095 case 'm': /* request month */
2096 if (!localtime_r(&when, &ts)) goto error;
2097 strftime(str, freespace, "%m", &ts);
2100 case 'n': /* Request Number*/
2101 snprintf(str, freespace, "%u", request->number);
2104 case 't': /* request timestamp */
2105 CTIME_R(&when, str, freespace);
2106 nl = strchr(str, '\n');
2110 case 'D': /* request date */
2111 if (!localtime_r(&when, &ts)) goto error;
2112 strftime(str, freespace, "%Y%m%d", &ts);
2115 case 'G': /* request minute */
2116 if (!localtime_r(&when, &ts)) goto error;
2117 strftime(str, freespace, "%M", &ts);
2120 case 'H': /* request hour */
2121 if (!localtime_r(&when, &ts)) goto error;
2122 strftime(str, freespace, "%H", &ts);
2125 case 'I': /* Request ID */
2126 if (request->packet) {
2127 snprintf(str, freespace, "%i", request->packet->id);
2131 case 'S': /* request timestamp in SQL format*/
2132 if (!localtime_r(&when, &ts)) goto error;
2133 strftime(str, freespace, "%Y-%m-%d %H:%M:%S", &ts);
2136 case 'T': /* request timestamp */
2137 if (!localtime_r(&when, &ts)) goto error;
2138 strftime(str, freespace, "%Y-%m-%d-%H.%M.%S.000000", &ts);
2141 case 'Y': /* request year */
2142 if (!localtime_r(&when, &ts)) {
2144 REDEBUG("Failed converting packet timestamp to localtime: %s", fr_syserror(errno));
2148 strftime(str, freespace, "%Y", &ts);
2151 case 'v': /* Version of code */
2152 RWDEBUG("%%v is deprecated and will be removed. Use ${version.freeradius-server}");
2153 snprintf(str, freespace, "%s", radiusd_version_short);
2163 case XLAT_ATTRIBUTE:
2164 XLAT_DEBUG("xlat_aprint ATTRIBUTE");
2167 * Some attributes are virtual <sigh>
2169 str = xlat_getvp(ctx, request, &node->attr, escape ? false : true, true);
2171 XLAT_DEBUG("EXPAND attr %s", node->attr.tmpl_da->name);
2172 XLAT_DEBUG(" ---> %s", str);
2177 XLAT_DEBUG("xlat_aprint VIRTUAL");
2178 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
2179 rcode = node->xlat->func(node->xlat->instance, request, NULL, str, 2048);
2184 RDEBUG2("EXPAND %s", node->xlat->name);
2185 RDEBUG2(" --> %s", str);
2189 XLAT_DEBUG("xlat_aprint MODULE");
2190 if (xlat_process(&child, request, node->child, node->xlat->escape, node->xlat->instance) == 0) {
2194 XLAT_DEBUG("%.*sEXPAND mod %s %s", lvl, xlat_spaces, node->fmt, node->child->fmt);
2195 XLAT_DEBUG("%.*s ---> %s", lvl, xlat_spaces, child);
2200 * The OUTPUT of xlat is a printable string. The INPUT might not be...
2202 * This is really the reverse of fr_prints().
2204 if (cf_new_escape && *child) {
2209 type = PW_TYPE_STRING;
2210 slen = value_data_from_str(request, &data, &type, NULL, child, talloc_array_length(child) - 1, '"');
2224 if (*p == '\\') switch (p[1]) {
2246 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
2247 *str = '\0'; /* Be sure the string is NULL terminated, we now only free on error */
2249 rcode = node->xlat->func(node->xlat->instance, request, child, str, 2048);
2259 XLAT_DEBUG("xlat_aprint REGEX");
2260 if (regex_request_to_sub(ctx, &str, request, node->attr.tmpl_num) < 0) return NULL;
2265 case XLAT_ALTERNATE:
2266 XLAT_DEBUG("xlat_aprint ALTERNATE");
2267 rad_assert(node->child != NULL);
2268 rad_assert(node->alternate != NULL);
2270 str = xlat_aprint(ctx, request, node->child, escape, escape_ctx, lvl);
2273 str = xlat_aprint(ctx, request, node->alternate, escape, escape_ctx, lvl);
2279 * Escape the non-literals we found above.
2281 if (str && escape) {
2284 escaped = talloc_array(ctx, char, 2048); /* FIXME: do something intelligent */
2285 escape(request, escaped, 2038, str, escape_ctx);
2294 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
2295 RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2299 char **array, *answer;
2300 xlat_exp_t const *node;
2305 * There are no nodes to process, so the result is a zero
2309 *out = talloc_zero_array(request, char, 1);
2314 * Hack for speed. If it's one expansion, just allocate
2315 * that and return, instead of allocating an intermediary
2320 * Pass the MAIN escape function. Recursive
2321 * calls will call node-specific escape
2324 answer = xlat_aprint(request, request, head, escape, escape_ctx, 0);
2326 *out = talloc_zero_array(request, char, 1);
2330 return strlen(answer);
2333 list = 0; /* FIXME: calculate this once */
2334 for (node = head; node != NULL; node = node->next) {
2338 array = talloc_array(request, char *, list);
2339 if (!array) return -1;
2341 for (node = head, i = 0; node != NULL; node = node->next, i++) {
2342 array[i] = xlat_aprint(array, request, node, escape, escape_ctx, 0); /* may be NULL */
2346 for (i = 0; i < list; i++) {
2347 if (array[i]) total += strlen(array[i]); /* FIXME: calculate strlen once */
2352 *out = talloc_zero_array(request, char, 1);
2356 answer = talloc_array(request, char, total + 1);
2359 for (i = 0; i < list; i++) {
2363 len = strlen(array[i]);
2364 memcpy(answer + total, array[i], len);
2368 answer[total] = '\0';
2369 talloc_free(array); /* and child entries */
2376 /** Replace %whatever in a string.
2378 * See 'doc/variables.txt' for more information.
2380 * @param[out] out Where to write pointer to output buffer.
2381 * @param[in] outlen Size of out.
2382 * @param[in] request current request.
2383 * @param[in] node the xlat structure to expand
2384 * @param[in] escape function to escape final value e.g. SQL quoting.
2385 * @param[in] escape_ctx pointer to pass to escape function.
2386 * @return length of string written @bug should really have -1 for failure
2388 static ssize_t xlat_expand_struct(char **out, size_t outlen, REQUEST *request, xlat_exp_t const *node,
2389 RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2394 rad_assert(node != NULL);
2396 len = xlat_process(&buff, request, node, escape, escape_ctx);
2397 if ((len < 0) || !buff) {
2398 rad_assert(buff == NULL);
2399 if (*out) *out[0] = '\0';
2405 * If out doesn't point to an existing buffer
2406 * copy the pointer to our buffer over.
2414 * Otherwise copy the malloced buffer to the fixed one.
2416 strlcpy(*out, buff, outlen);
2421 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2422 RADIUS_ESCAPE_STRING escape, void *escape_ctx) CC_HINT(nonnull (1, 3, 4));
2424 /** Replace %whatever in a string.
2426 * See 'doc/variables.txt' for more information.
2428 * @param[out] out Where to write pointer to output buffer.
2429 * @param[in] outlen Size of out.
2430 * @param[in] request current request.
2431 * @param[in] fmt string to expand.
2432 * @param[in] escape function to escape final value e.g. SQL quoting.
2433 * @param[in] escape_ctx pointer to pass to escape function.
2434 * @return length of string written @bug should really have -1 for failure
2436 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2437 RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2443 * Give better errors than the old code.
2445 len = xlat_tokenize_request(request, fmt, &node);
2450 *out = talloc_zero_array(request, char, 1);
2456 if (*out) *out[0] = '\0';
2460 len = xlat_expand_struct(out, outlen, request, node, escape, escape_ctx);
2463 RDEBUG2("EXPAND %s", fmt);
2464 RDEBUG2(" --> %s", *out);
2469 /** Try to convert an xlat to a tmpl for efficiency
2471 * @param ctx to allocate new value_pair_tmpl_t in.
2472 * @param node to convert.
2473 * @return NULL if unable to convert (not necessarily error), or a new value_pair_tmpl_t.
2475 value_pair_tmpl_t *xlat_to_tmpl_attr(TALLOC_CTX *ctx, xlat_exp_t *node)
2477 value_pair_tmpl_t *vpt;
2479 if (node->next || (node->type != XLAT_ATTRIBUTE)) return NULL;
2482 * Concat means something completely different as an attribute reference
2483 * Count isn't implemented.
2485 if ((node->attr.tmpl_num == NUM_COUNT) || (node->attr.tmpl_num == NUM_ALL)) return NULL;
2487 vpt = tmpl_alloc(ctx, TMPL_TYPE_ATTR, node->fmt, -1);
2488 if (!vpt) return NULL;
2489 memcpy(&vpt->data, &node->attr.data, sizeof(vpt->data));
2496 /** Try to convert attr tmpl to an xlat for &attr[*] and artificially constructing expansions
2498 * @param ctx to allocate new xlat_expt_t in.
2499 * @param vpt to convert.
2500 * @return NULL if unable to convert (not necessarily error), or a new value_pair_tmpl_t.
2502 xlat_exp_t *xlat_from_tmpl_attr(TALLOC_CTX *ctx, value_pair_tmpl_t *vpt)
2506 if (vpt->type != TMPL_TYPE_ATTR) return NULL;
2508 node = talloc_zero(ctx, xlat_exp_t);
2509 node->fmt = talloc_memdup(node, vpt->name, vpt->len);
2510 tmpl_init(&node->attr, TMPL_TYPE_ATTR, node->fmt, talloc_array_length(node->fmt) - 1);
2511 memcpy(&node->attr.data, &vpt->data, sizeof(vpt->data));
2516 ssize_t radius_xlat(char *out, size_t outlen, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2518 return xlat_expand(&out, outlen, request, fmt, escape, ctx);
2521 ssize_t radius_xlat_struct(char *out, size_t outlen, REQUEST *request, xlat_exp_t const *xlat, RADIUS_ESCAPE_STRING escape, void *ctx)
2523 return xlat_expand_struct(&out, outlen, request, xlat, escape, ctx);
2526 ssize_t radius_axlat(char **out, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2528 return xlat_expand(out, 0, request, fmt, escape, ctx);
2531 ssize_t radius_axlat_struct(char **out, REQUEST *request, xlat_exp_t const *xlat, RADIUS_ESCAPE_STRING escape, void *ctx)
2533 return xlat_expand_struct(out, 0, request, xlat, escape, ctx);