src/main/xlat.c

   1 /*
   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.
   6  *
   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.
  11  *
  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
  15  */
  16
  17 /**
  18  * $Id$
  19  *
  20  * @file xlat.c
  21  * @brief String expansion ("translation"). Implements %Attribute -> value
  22  *
  23  * @copyright 2000,2006  The FreeRADIUS server project
  24  * @copyright 2000  Alan DeKok <aland@ox.org>
  25  */
  26
  27 RCSID("$Id$")
  28
  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>
  33
  34 #include <ctype.h>
  35
  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.
  43 } xlat_t;
  44
  45 typedef enum {
  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
  51 #ifdef HAVE_REGEX
  52         XLAT_REGEX,             //!< regex reference
  53 #endif
  54         XLAT_ALTERNATE          //!< xlat conditional syntax :-
  55 } xlat_state_t;
  56
  57 struct xlat_exp {
  58         char const *fmt;        //!< The format string.
  59         size_t len;             //!< Length of the format string.
  60
  61         xlat_state_t type;      //!< type of this expansion.
  62         xlat_exp_t *next;       //!< Next in the list.
  63
  64         xlat_exp_t *child;      //!< Nested expansion.
  65         xlat_exp_t *alternate;  //!< Alternative expansion if this one expanded to a zero length string.
  66
  67         value_pair_tmpl_t attr; //!< An attribute template.
  68         xlat_t const *xlat;     //!< The xlat expansion to expand format with.
  69 };
  70
  71 typedef struct xlat_out {
  72         char const *out;        //!< Output data.
  73         size_t len;             //!< Length of the output string.
  74 } xlat_out_t;
  75
  76 static rbtree_t *xlat_root = NULL;
  77
  78 #ifdef WITH_UNLANG
  79 static char const * const xlat_foreach_names[] = {"Foreach-Variable-0",
  80                                                   "Foreach-Variable-1",
  81                                                   "Foreach-Variable-2",
  82                                                   "Foreach-Variable-3",
  83                                                   "Foreach-Variable-4",
  84                                                   "Foreach-Variable-5",
  85                                                   "Foreach-Variable-6",
  86                                                   "Foreach-Variable-7",
  87                                                   "Foreach-Variable-8",
  88                                                   "Foreach-Variable-9",
  89                                                   NULL};
  90 #endif
  91
  92 #if REQUEST_MAX_REGEX > 8
  93 #  error Please fix the following line
  94 #endif
  95 static int xlat_inst[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; /* up to 8 for regex */
  96
  97 char const *radiusd_short_version = RADIUSD_VERSION_STRING;
  98
  99 /** Print length of its RHS.
 100  *
 101  */
 102 static ssize_t xlat_strlen(UNUSED void *instance, UNUSED REQUEST *request,
 103                            char const *fmt, char *out, size_t outlen)
 104 {
 105         snprintf(out, outlen, "%u", (unsigned int) strlen(fmt));
 106         return strlen(out);
 107 }
 108
 109 /** Print the size of the attribute in bytes.
 110  *
 111  */
 112 static ssize_t xlat_length(UNUSED void *instance, UNUSED REQUEST *request,
 113                            char const *fmt, char *out, size_t outlen)
 114 {
 115         VALUE_PAIR *vp;
 116         while (isspace((int) *fmt)) fmt++;
 117
 118         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 119                 *out = '\0';
 120                 return 0;
 121         }
 122
 123         snprintf(out, outlen, "%zu", vp->length);
 124         return strlen(out);
 125 }
 126
 127 /** Print data as integer, not as VALUE.
 128  *
 129  */
 130 static ssize_t xlat_integer(UNUSED void *instance, REQUEST *request,
 131                             char const *fmt, char *out, size_t outlen)
 132 {
 133         VALUE_PAIR      *vp;
 134
 135         uint64_t        int64 = 0;      /* Needs to be initialised to zero */
 136         uint32_t        int32 = 0;      /* Needs to be initialised to zero */
 137
 138         while (isspace((int) *fmt)) fmt++;
 139
 140         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 141                 *out = '\0';
 142                 return 0;
 143         }
 144
 145         switch (vp->da->type) {
 146         case PW_TYPE_OCTETS:
 147         case PW_TYPE_STRING:
 148                 if (vp->length > 8) {
 149                         break;
 150                 }
 151
 152                 if (vp->length > 4) {
 153                         memcpy(&int64, vp->vp_octets, vp->length);
 154                         return snprintf(out, outlen, "%" PRIu64, htonll(int64));
 155                 }
 156
 157                 memcpy(&int32, vp->vp_octets, vp->length);
 158                 return snprintf(out, outlen, "%i", htonl(int32));
 159
 160         case PW_TYPE_INTEGER64:
 161                 return snprintf(out, outlen, "%" PRIu64, vp->vp_integer64);
 162
 163         /*
 164          *      IP addresses are treated specially, as parsing functions assume the value
 165          *      is bigendian and will convert it for us.
 166          */
 167         case PW_TYPE_IPV4_ADDR:
 168                 return snprintf(out, outlen, "%u", htonl(vp->vp_ipaddr));
 169
 170         case PW_TYPE_IPV4_PREFIX:
 171                 return snprintf(out, outlen, "%u", htonl((*(uint32_t *)(vp->vp_ipv4prefix + 2))));
 172
 173         case PW_TYPE_INTEGER:
 174         case PW_TYPE_DATE:
 175                 return snprintf(out, outlen, "%u", vp->vp_integer);
 176         case PW_TYPE_BYTE:
 177                 return snprintf(out, outlen, "%u", (unsigned int) vp->vp_byte);
 178         case PW_TYPE_SHORT:
 179                 return snprintf(out, outlen, "%u", (unsigned int) vp->vp_short);
 180
 181         /*
 182          *      Ethernet is weird... It's network related, so we assume to it should be
 183          *      bigendian.
 184          */
 185         case PW_TYPE_ETHERNET:
 186                 memcpy(&int64, &vp->vp_ether, vp->length);
 187                 return snprintf(out, outlen, "%" PRIu64, htonll(int64));
 188
 189         case PW_TYPE_SIGNED:
 190                 return snprintf(out, outlen, "%i", vp->vp_signed);
 191
 192         case PW_TYPE_IPV6_ADDR:
 193                 return fr_prints_uint128(out, outlen, ntohlll(*(uint128_t const *) &vp->vp_ipv6addr));
 194
 195         case PW_TYPE_IPV6_PREFIX:
 196                 return fr_prints_uint128(out, outlen, ntohlll(*(uint128_t const *) &(vp->vp_ipv6prefix[2])));
 197
 198         default:
 199                 break;
 200         }
 201
 202         REDEBUG("Type '%s' of length %zu cannot be converted to integer",
 203                 fr_int2str(dict_attr_types, vp->da->type, "???"), vp->length);
 204         *out = '\0';
 205
 206         return -1;
 207 }
 208
 209 /** Print data as hex, not as VALUE.
 210  *
 211  */
 212 static ssize_t xlat_hex(UNUSED void *instance, REQUEST *request,
 213                         char const *fmt, char *out, size_t outlen)
 214 {
 215         size_t i;
 216         VALUE_PAIR *vp;
 217         uint8_t const *p;
 218         ssize_t ret;
 219         size_t  len;
 220         value_data_t dst;
 221         uint8_t const *buff = NULL;
 222
 223         while (isspace((int) *fmt)) fmt++;
 224
 225         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 226         error:
 227                 *out = '\0';
 228                 return -1;
 229         }
 230
 231         /*
 232          *      The easy case.
 233          */
 234         if (vp->da->type == PW_TYPE_OCTETS) {
 235                 p = vp->vp_octets;
 236                 len = vp->length;
 237         /*
 238          *      Cast the value_data_t of the VP to an octets string and
 239          *      print that as hex.
 240          */
 241         } else {
 242                 ret = value_data_cast(request, &dst, PW_TYPE_OCTETS, NULL, vp->da->type,
 243                                       NULL, &vp->data, vp->length);
 244                 if (ret < 0) {
 245                         REDEBUG("%s", fr_strerror());
 246                         goto error;
 247                 }
 248                 len = (size_t) ret;
 249                 p = buff = dst.octets;
 250         }
 251
 252         rad_assert(p);
 253
 254         /*
 255          *      Don't truncate the data.
 256          */
 257         if (outlen < (len * 2)) {
 258                 rad_const_free(buff);
 259                 goto error;
 260         }
 261
 262         for (i = 0; i < len; i++) {
 263                 snprintf(out + 2*i, 3, "%02x", p[i]);
 264         }
 265         rad_const_free(buff);
 266
 267         return len * 2;
 268 }
 269
 270 /** Return the tag of an attribute reference
 271  *
 272  */
 273 static ssize_t xlat_tag(UNUSED void *instance, REQUEST *request,
 274                         char const *fmt, char *out, size_t outlen)
 275 {
 276         VALUE_PAIR *vp;
 277
 278         while (isspace((int) *fmt)) fmt++;
 279
 280         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 281                 *out = '\0';
 282                 return 0;
 283         }
 284
 285         if (!vp->da->flags.has_tag || !TAG_VALID(vp->tag)) {
 286                 *out = '\0';
 287                 return 0;
 288         }
 289
 290         return snprintf(out, outlen, "%u", vp->tag);
 291 }
 292
 293 /** Print out attribute info
 294  *
 295  * Prints out all instances of a current attribute, or all attributes in a list.
 296  *
 297  * At higher debugging levels, also prints out alternative decodings of the same
 298  * value. This is helpful to determine types for unknown attributes of long
 299  * passed vendors, or just crazy/broken NAS.
 300  *
 301  * It's also useful for exposing issues in the packet decoding functions, as in
 302  * some cases they get fed random garbage data.
 303  *
 304  * This expands to a zero length string.
 305  */
 306 static ssize_t xlat_debug_attr(UNUSED void *instance, REQUEST *request, char const *fmt,
 307                                char *out, UNUSED size_t outlen)
 308 {
 309         VALUE_PAIR *vp;
 310         vp_cursor_t cursor;
 311
 312         value_pair_tmpl_t vpt;
 313
 314         if (!RDEBUG_ENABLED2) {
 315                 *out = '\0';
 316                 return -1;
 317         }
 318
 319         while (isspace((int) *fmt)) fmt++;
 320
 321         if (tmpl_from_attr_str(&vpt, fmt, REQUEST_CURRENT, PAIR_LIST_REQUEST, false) <= 0) {
 322                 RDEBUG("%s", fr_strerror());
 323                 return -1;
 324         }
 325
 326         RIDEBUG("Attributes matching \"%s\"", fmt);
 327
 328         RINDENT();
 329         for (vp = tmpl_cursor_init(NULL, &cursor, request, &vpt);
 330              vp;
 331              vp = tmpl_cursor_next(&cursor, &vpt)) {
 332                 FR_NAME_NUMBER const *type;
 333                 char *value;
 334
 335                 value = vp_aprints_value(vp, vp, '\'');
 336                 if (vp->da->flags.has_tag) {
 337                         RIDEBUG2("&%s:%s:%i %s %s",
 338                                 fr_int2str(pair_lists, vpt.tmpl_list, "<INVALID>"),
 339                                 vp->da->name,
 340                                 vp->tag,
 341                                 fr_int2str(fr_tokens, vp->op, "<INVALID>"),
 342                                 value);
 343                 } else {
 344                         RIDEBUG2("&%s:%s %s %s",
 345                                 fr_int2str(pair_lists, vpt.tmpl_list, "<INVALID>"),
 346                                 vp->da->name,
 347                                 fr_int2str(fr_tokens, vp->op, "<INVALID>"),
 348                                 value);
 349                 }
 350                 talloc_free(value);
 351
 352                 if (!RDEBUG_ENABLED3) continue;
 353
 354                 if (vp->da->vendor) {
 355                         DICT_VENDOR *dv;
 356
 357                         dv = dict_vendorbyvalue(vp->da->vendor);
 358                         RIDEBUG2("Vendor : %i (%s)", vp->da->vendor, dv ? dv->name : "unknown");
 359                 }
 360                 RIDEBUG2("Type   : %s", fr_int2str(dict_attr_types, vp->da->type, "<INVALID>"));
 361                 RIDEBUG2("Length : %zu", vp->length);
 362
 363                 if (!RDEBUG_ENABLED4) continue;
 364
 365                 type = dict_attr_types;
 366                 while (type->name) {
 367                         int pad;
 368
 369                         value_data_t *dst = NULL;
 370
 371                         ssize_t ret;
 372
 373                         if ((PW_TYPE) type->number == vp->da->type) {
 374                                 goto next_type;
 375                         }
 376
 377                         switch (type->number) {
 378                         case PW_TYPE_INVALID:           /* Not real type */
 379                         case PW_TYPE_MAX:               /* Not real type */
 380                         case PW_TYPE_EXTENDED:          /* Not safe/appropriate */
 381                         case PW_TYPE_LONG_EXTENDED:     /* Not safe/appropriate */
 382                         case PW_TYPE_TLV:               /* Not safe/appropriate */
 383                         case PW_TYPE_EVS:               /* Not safe/appropriate */
 384                         case PW_TYPE_VSA:               /* @fixme We need special behaviour for these */
 385                         case PW_TYPE_COMBO_IP_ADDR:     /* Covered by IPv4 address IPv6 address */
 386                         case PW_TYPE_COMBO_IP_PREFIX:   /* Covered by IPv4 address IPv6 address */
 387                         case PW_TYPE_TIMEVAL:           /* Not a VALUE_PAIR type */
 388
 389                                 goto next_type;
 390
 391                         default:
 392                                 break;
 393                         }
 394
 395                         dst = talloc_zero(vp, value_data_t);
 396                         ret = value_data_cast(dst, dst, type->number, NULL, vp->da->type, vp->da,
 397                                               &vp->data, vp->length);
 398                         if (ret < 0) goto next_type;    /* We expect some to fail */
 399
 400                         value = vp_data_aprints_value(dst, type->number, NULL, dst, (size_t)ret, '\'');
 401                         if (!value) goto next_type;
 402
 403                         if ((pad = (11 - strlen(type->name))) < 0) {
 404                                 pad = 0;
 405                         }
 406
 407                         RINDENT();
 408                         RDEBUG2("as %s%*s: %s", type->name, pad, " ", value);
 409                         REXDENT();
 410
 411                 next_type:
 412                         talloc_free(dst);
 413                         type++;
 414                 }
 415         }
 416
 417         *out = '\0';
 418         return 0;
 419 }
 420
 421 /** Prints the current module processing the request
 422  *
 423  */
 424 static ssize_t xlat_module(UNUSED void *instance, REQUEST *request,
 425                            UNUSED char const *fmt, char *out, size_t outlen)
 426 {
 427         strlcpy(out, request->module, outlen);
 428
 429         return strlen(out);
 430 }
 431
 432 #ifdef WITH_UNLANG
 433 /** Implements the Foreach-Variable-X
 434  *
 435  * @see modcall()
 436  */
 437 static ssize_t xlat_foreach(void *instance, REQUEST *request,
 438                             UNUSED char const *fmt, char *out, size_t outlen)
 439 {
 440         VALUE_PAIR      **pvp;
 441         size_t          len;
 442
 443         /*
 444          *      See modcall, "FOREACH" for how this works.
 445          */
 446         pvp = (VALUE_PAIR **) request_data_reference(request, radius_get_vp, *(int*) instance);
 447         if (!pvp || !*pvp) {
 448                 *out = '\0';
 449                 return 0;
 450         }
 451
 452         len = vp_prints_value(out, outlen, *pvp, 0);
 453         if (is_truncated(len, outlen)) {
 454                 RDEBUG("Insufficient buffer space to write foreach value");
 455                 return -1;
 456         }
 457
 458         return len;
 459 }
 460 #endif
 461
 462 /** Print data as string, if possible.
 463  *
 464  * If attribute "Foo" is defined as "octets" it will normally
 465  * be printed as 0x0a0a0a. The xlat "%{string:Foo}" will instead
 466  * expand to "\n\n\n"
 467  */
 468 static ssize_t xlat_string(UNUSED void *instance, REQUEST *request,
 469                            char const *fmt, char *out, size_t outlen)
 470 {
 471         size_t len;
 472         ssize_t ret;
 473         VALUE_PAIR *vp;
 474         uint8_t const *p;
 475
 476         while (isspace((int) *fmt)) fmt++;
 477
 478         if (outlen < 3) {
 479         nothing:
 480                 *out = '\0';
 481                 return 0;
 482         }
 483
 484         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) goto nothing;
 485
 486         ret = rad_vp2data(&p, vp);
 487         if (ret < 0) {
 488                 return ret;
 489         }
 490
 491         switch (vp->da->type) {
 492         case PW_TYPE_OCTETS:
 493                 len = fr_print_string((char const *) p, vp->length, out, outlen, '\0');
 494                 break;
 495
 496         case PW_TYPE_STRING:
 497                 len = strlcpy(out, vp->vp_strvalue, outlen);
 498                 break;
 499
 500         default:
 501                 len = fr_print_string((char const *) p, ret, out, outlen, '\0');
 502                 break;
 503         }
 504
 505         return len;
 506 }
 507
 508 /** xlat expand string attribute value
 509  *
 510  */
 511 static ssize_t xlat_xlat(UNUSED void *instance, REQUEST *request,
 512                         char const *fmt, char *out, size_t outlen)
 513 {
 514         VALUE_PAIR *vp;
 515
 516         while (isspace((int) *fmt)) fmt++;
 517
 518         if (outlen < 3) {
 519         nothing:
 520                 *out = '\0';
 521                 return 0;
 522         }
 523
 524         if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) goto nothing;
 525
 526         return radius_xlat(out, outlen, request, vp->vp_strvalue, NULL, NULL);
 527 }
 528
 529 /** Dynamically change the debugging level for the current request
 530  *
 531  * Example %{debug:3}
 532  */
 533 static ssize_t xlat_debug(UNUSED void *instance, REQUEST *request,
 534                           char const *fmt, char *out, size_t outlen)
 535 {
 536         int level = 0;
 537
 538         /*
 539          *  Expand to previous (or current) level
 540          */
 541         snprintf(out, outlen, "%d", request->log.lvl & RAD_REQUEST_OPTION_DEBUG4);
 542
 543         /*
 544          *  Assume we just want to get the current value and NOT set it to 0
 545          */
 546         if (!*fmt)
 547                 goto done;
 548
 549         level = atoi(fmt);
 550         if (level == 0) {
 551                 request->log.lvl = RAD_REQUEST_OPTION_NONE;
 552                 request->log.func = NULL;
 553         } else {
 554                 if (level > 4) level = 4;
 555
 556                 request->log.lvl = level;
 557                 request->log.func = vradlog_request;
 558         }
 559
 560         done:
 561         return strlen(out);
 562 }
 563
 564 /*
 565  *      Compare two xlat_t structs, based ONLY on the module name.
 566  */
 567 static int xlat_cmp(void const *one, void const *two)
 568 {
 569         xlat_t const *a = one;
 570         xlat_t const *b = two;
 571
 572         if (a->length != b->length) {
 573                 return a->length - b->length;
 574         }
 575
 576         return memcmp(a->name, b->name, a->length);
 577 }
 578
 579
 580 /*
 581  *      find the appropriate registered xlat function.
 582  */
 583 static xlat_t *xlat_find(char const *name)
 584 {
 585         xlat_t my_xlat;
 586
 587         strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
 588         my_xlat.length = strlen(my_xlat.name);
 589
 590         return rbtree_finddata(xlat_root, &my_xlat);
 591 }
 592
 593
 594 /** Register an xlat function.
 595  *
 596  * @param[in] name xlat name.
 597  * @param[in] func xlat function to be called.
 598  * @param[in] escape function to sanitize any sub expansions passed to the xlat function.
 599  * @param[in] instance of module that's registering the xlat function.
 600  * @return 0 on success, -1 on failure
 601  */
 602 int xlat_register(char const *name, RAD_XLAT_FUNC func, RADIUS_ESCAPE_STRING escape, void *instance)
 603 {
 604         xlat_t  *c;
 605         xlat_t  my_xlat;
 606         rbnode_t *node;
 607
 608         if (!name || !*name) {
 609                 DEBUG("xlat_register: Invalid xlat name");
 610                 return -1;
 611         }
 612
 613         /*
 614          *      First time around, build up the tree...
 615          *
 616          *      FIXME: This code should be hoisted out of this function,
 617          *      and into a global "initialization".  But it isn't critical...
 618          */
 619         if (!xlat_root) {
 620 #ifdef WITH_UNLANG
 621                 int i;
 622 #endif
 623
 624                 xlat_root = rbtree_create(NULL, xlat_cmp, NULL, RBTREE_FLAG_REPLACE);
 625                 if (!xlat_root) {
 626                         DEBUG("xlat_register: Failed to create tree");
 627                         return -1;
 628                 }
 629
 630 #ifdef WITH_UNLANG
 631                 for (i = 0; xlat_foreach_names[i] != NULL; i++) {
 632                         xlat_register(xlat_foreach_names[i],
 633                                       xlat_foreach, NULL, &xlat_inst[i]);
 634                         c = xlat_find(xlat_foreach_names[i]);
 635                         rad_assert(c != NULL);
 636                         c->internal = true;
 637                 }
 638 #endif
 639
 640 #define XLAT_REGISTER(_x) xlat_register(STRINGIFY(_x), xlat_ ## _x, NULL, NULL); \
 641                 c = xlat_find(STRINGIFY(_x)); \
 642                 rad_assert(c != NULL); \
 643                 c->internal = true
 644
 645                 XLAT_REGISTER(integer);
 646                 XLAT_REGISTER(strlen);
 647                 XLAT_REGISTER(length);
 648                 XLAT_REGISTER(hex);
 649                 XLAT_REGISTER(tag);
 650                 XLAT_REGISTER(string);
 651                 XLAT_REGISTER(xlat);
 652                 XLAT_REGISTER(module);
 653                 XLAT_REGISTER(debug_attr);
 654
 655                 xlat_register("debug", xlat_debug, NULL, &xlat_inst[0]);
 656                 c = xlat_find("debug");
 657                 rad_assert(c != NULL);
 658                 c->internal = true;
 659         }
 660
 661         /*
 662          *      If it already exists, replace the instance.
 663          */
 664         strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
 665         my_xlat.length = strlen(my_xlat.name);
 666         c = rbtree_finddata(xlat_root, &my_xlat);
 667         if (c) {
 668                 if (c->internal) {
 669                         DEBUG("xlat_register: Cannot re-define internal xlat");
 670                         return -1;
 671                 }
 672
 673                 c->func = func;
 674                 c->escape = escape;
 675                 c->instance = instance;
 676                 return 0;
 677         }
 678
 679         /*
 680          *      Doesn't exist.  Create it.
 681          */
 682         c = talloc_zero(xlat_root, xlat_t);
 683
 684         c->func = func;
 685         c->escape = escape;
 686         strlcpy(c->name, name, sizeof(c->name));
 687         c->length = strlen(c->name);
 688         c->instance = instance;
 689
 690         node = rbtree_insert_node(xlat_root, c);
 691         if (!node) {
 692                 talloc_free(c);
 693                 return -1;
 694         }
 695
 696         /*
 697          *      Ensure that the data is deleted when the node is
 698          *      deleted.
 699          *
 700          *      @todo: Maybe this should be the other way around...
 701          *      when a thing IN the tree is deleted, it's automatically
 702          *      removed from the tree.  But for now, this works.
 703          */
 704         (void) talloc_steal(node, c);
 705         return 0;
 706 }
 707
 708 /** Unregister an xlat function
 709  *
 710  * We can only have one function to call per name, so the passing of "func"
 711  * here is extraneous.
 712  *
 713  * @param[in] name xlat to unregister.
 714  * @param[in] func unused.
 715  * @param[in] instance data.
 716  */
 717 void xlat_unregister(char const *name, UNUSED RAD_XLAT_FUNC func, void *instance)
 718 {
 719         xlat_t  *c;
 720         xlat_t          my_xlat;
 721
 722         if (!name) return;
 723
 724         strlcpy(my_xlat.name, name, sizeof(my_xlat.name));
 725         my_xlat.length = strlen(my_xlat.name);
 726
 727         c = rbtree_finddata(xlat_root, &my_xlat);
 728         if (!c) return;
 729
 730         if (c->instance != instance) return;
 731
 732         rbtree_deletebydata(xlat_root, c);
 733 }
 734
 735 static int xlat_unregister_callback(void *instance, void *data)
 736 {
 737         xlat_t *c = (xlat_t *) data;
 738
 739         if (c->instance != instance) return 0; /* keep walking */
 740
 741         return 2;               /* delete it */
 742 }
 743
 744 void xlat_unregister_module(void *instance)
 745 {
 746         rbtree_walk(xlat_root, RBTREE_DELETE_ORDER, xlat_unregister_callback, instance);
 747 }
 748
 749
 750 /** Crappy temporary function to add attribute ref support to xlats
 751  *
 752  * This needs to die, and hopefully will die, when xlat functions accept
 753  * xlat node structures.
 754  *
 755  * Provides either a pointer to a buffer which contains the value of the reference VALUE_PAIR
 756  * in an architecture independent format. Or a pointer to the start of the fmt string.
 757  *
 758  * The pointer is only guaranteed to be valid between calls to xlat_fmt_to_ref,
 759  * and so long as the source VALUE_PAIR is not freed.
 760  *
 761  * @param out where to write a pointer to the buffer to the data the xlat function needs to work on.
 762  * @param request current request.
 763  * @param fmt string.
 764  * @returns the length of the data or -1 on error.
 765  */
 766 ssize_t xlat_fmt_to_ref(uint8_t const **out, REQUEST *request, char const *fmt)
 767 {
 768         VALUE_PAIR *vp;
 769
 770         while (isspace((int) *fmt)) fmt++;
 771
 772         if (fmt[0] == '&') {
 773                 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 774                         *out = NULL;
 775                         return -1;
 776                 }
 777
 778                 return rad_vp2data(out, vp);
 779         }
 780
 781         *out = (uint8_t const *)fmt;
 782         return strlen(fmt);
 783 }
 784
 785 /** De-register all xlat functions, used mainly for debugging.
 786  *
 787  */
 788 void xlat_free(void)
 789 {
 790         rbtree_free(xlat_root);
 791 }
 792
 793
 794 #ifdef DEBUG_XLAT
 795 #  define XLAT_DEBUG DEBUG3
 796 #else
 797 #  define XLAT_DEBUG(...)
 798 #endif
 799
 800 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 801                                        char const **error);
 802 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 803                                      bool brace, char const **error);
 804 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
 805                            RADIUS_ESCAPE_STRING escape, void *escape_ctx);
 806
 807 static ssize_t xlat_tokenize_alternation(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 808                                          char const **error)
 809 {
 810         ssize_t slen;
 811         char *p;
 812         xlat_exp_t *node;
 813
 814         rad_assert(fmt[0] == '%');
 815         rad_assert(fmt[1] == '{');
 816         rad_assert(fmt[2] == '%');
 817         rad_assert(fmt[3] == '{');
 818
 819         XLAT_DEBUG("ALTERNATE <-- %s", fmt);
 820
 821         node = talloc_zero(ctx, xlat_exp_t);
 822         node->type = XLAT_ALTERNATE;
 823
 824         p = fmt + 2;
 825         slen = xlat_tokenize_expansion(node, p, &node->child, error);
 826         if (slen <= 0) {
 827                 talloc_free(node);
 828                 return slen - (p - fmt);
 829         }
 830         p += slen;
 831
 832         if (p[0] != ':') {
 833                 talloc_free(node);
 834                 *error = "Expected ':' after first expansion";
 835                 return -(p - fmt);
 836         }
 837         p++;
 838
 839         if (p[0] != '-') {
 840                 talloc_free(node);
 841                 *error = "Expected '-' after ':'";
 842                 return -(p - fmt);
 843         }
 844         p++;
 845
 846         /*
 847          *      Allow the RHS to be empty as a special case.
 848          */
 849         if (*p == '}') {
 850                 /*
 851                  *      Hack up an empty string.
 852                  */
 853                 node->alternate = talloc_zero(node, xlat_exp_t);
 854                 node->alternate->type = XLAT_LITERAL;
 855                 node->alternate->fmt = talloc_typed_strdup(node->alternate, "");
 856                 *(p++) = '\0';
 857
 858         } else {
 859                 slen = xlat_tokenize_literal(node, p,  &node->alternate, true, error);
 860                 if (slen <= 0) {
 861                         talloc_free(node);
 862                         return slen - (p - fmt);
 863                 }
 864
 865                 if (!node->alternate) {
 866                         talloc_free(node);
 867                         *error = "Empty expansion is invalid";
 868                         return -(p - fmt);
 869                 }
 870                 p += slen;
 871         }
 872
 873         *head = node;
 874         return p - fmt;
 875 }
 876
 877 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 878                                        char const **error)
 879 {
 880         ssize_t slen;
 881         char *p, *q;
 882         xlat_exp_t *node;
 883
 884         rad_assert(fmt[0] == '%');
 885         rad_assert(fmt[1] == '{');
 886
 887         /*
 888          *      %{%{...}:-bar}
 889          */
 890         if ((fmt[2] == '%') && (fmt[3] == '{')) return xlat_tokenize_alternation(ctx, fmt, head, error);
 891
 892         XLAT_DEBUG("EXPANSION <-- %s", fmt);
 893         node = talloc_zero(ctx, xlat_exp_t);
 894         node->fmt = fmt + 2;
 895         node->len = 0;
 896
 897 #ifdef HAVE_REGEX
 898         /*
 899          *      Handle regex's specially.
 900          */
 901         if (isdigit((int) fmt[2]) && (fmt[3] == '}')) {
 902                 if (fmt[2] == '9') {
 903                         talloc_free(node);
 904                         *error = "Invalid regex reference";
 905                         return -2;
 906                 }
 907
 908                 XLAT_DEBUG("REGEX <-- %s", fmt);
 909                 fmt[3] = '\0';
 910                 node->attr.tmpl_num = fmt[2] - '0'; /* ASCII */
 911
 912                 node->type = XLAT_REGEX;
 913                 *head = node;
 914                 return 4;
 915         }
 916 #endif /* HAVE_REGEX */
 917
 918         /*
 919          *      %{Attr-Name}
 920          *      %{Attr-Name[#]}
 921          *      %{Tunnel-Password:1}
 922          *      %{Tunnel-Password:1[#]}
 923          *      %{request:Attr-Name}
 924          *      %{request:Tunnel-Password:1}
 925          *      %{request:Tunnel-Password:1[#]}
 926          *      %{mod:foo}
 927          */
 928
 929         /*
 930          *      This is for efficiency, so we don't search for an xlat,
 931          *      when what's being referenced is obviously an attribute.
 932          */
 933         p = fmt + 2;
 934         for (q = p; *q != '\0'; q++) {
 935                 if (*q == ':') break;
 936
 937                 if (isspace((int) *q)) break;
 938
 939                 if (*q == '[') continue;
 940
 941                 if (*q == '}') break;
 942         }
 943
 944         /*
 945          *      Check for empty expressions %{}
 946          */
 947         if ((*q == '}') && (q == p)) {
 948                 *error = "Empty expression is invalid";
 949                 return -(p - fmt);
 950         }
 951
 952         /*
 953          *      Might be a module name reference.
 954          *
 955          *      If it's not, it's an attribute or parse error.
 956          */
 957         if (*q == ':') {
 958                 *q = '\0';
 959                 node->xlat = xlat_find(node->fmt);
 960                 if (node->xlat) {
 961                         /*
 962                          *      %{mod:foo}
 963                          */
 964                         node->type = XLAT_MODULE;
 965
 966                         p = q + 1;
 967                         XLAT_DEBUG("MOD <-- %s ... %s", node->fmt, p);
 968
 969                         slen = xlat_tokenize_literal(node, p, &node->child, true, error);
 970                         if (slen <= 0) {
 971                                 talloc_free(node);
 972                                 return slen - (p - fmt);
 973                         }
 974                         p += slen;
 975
 976                         *head = node;
 977                         rad_assert(node->next == NULL);
 978
 979                         return p - fmt;
 980                 }
 981                 *q = ':';       /* Avoids a strdup */
 982         }
 983
 984         /*
 985          *      The first token ends with:
 986          *      - '[' - Which is an attribute index, so it must be an attribute.
 987          *      - '}' - The end of the expansion, which means it was a bareword.
 988          */
 989         slen = tmpl_from_attr_substr(&node->attr, p, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
 990         if (slen <= 0) {
 991                 /*
 992                  *      If the parse error occurred before the ':'
 993                  *      then the error is changed to 'Unknown module',
 994                  *      as it was more likely to be a bad module name,
 995                  *      than a request qualifier.
 996                  */
 997                 if ((*q == ':') && ((p + (slen * -1)) < q)) {
 998                         *error = "Unknown module";
 999                 } else {
1000                         *error = fr_strerror();
1001                 }
1002                 return slen - (p - fmt);
1003         }
1004
1005         /*
1006          *      Might be a virtual XLAT attribute
1007          */
1008         if (node->attr.type == TMPL_TYPE_ATTR_UNKNOWN) {
1009                 node->xlat = xlat_find(node->attr.tmpl_unknown_name);
1010                 if (node->xlat) {
1011                         node->type = XLAT_VIRTUAL;
1012                         node->fmt = node->attr.tmpl_unknown_name;
1013
1014                         XLAT_DEBUG("VIRTUAL <-- %s", node->fmt);
1015                         *head = node;
1016                         rad_assert(node->next == NULL);
1017                         q++;
1018                         return q - fmt;
1019                 }
1020
1021                 talloc_free(node);
1022                 *error = "Unknown attribute";
1023                 return -(p - fmt);
1024         }
1025
1026         node->type = XLAT_ATTRIBUTE;
1027         p += slen;
1028         if (*p != '}') {
1029                 talloc_free(node);
1030                 *error = "No matching closing brace";
1031                 return -1;      /* second character of format string */
1032         }
1033         p++;
1034         *head = node;
1035         rad_assert(node->next == NULL);
1036
1037         return p - fmt;
1038 }
1039
1040
1041 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1042                                      bool brace, char const **error)
1043 {
1044         char *p;
1045         xlat_exp_t *node;
1046
1047         if (!*fmt) return 0;
1048
1049         XLAT_DEBUG("LITERAL <-- %s", fmt);
1050
1051         node = talloc_zero(ctx, xlat_exp_t);
1052         node->fmt = fmt;
1053         node->len = 0;
1054         node->type = XLAT_LITERAL;
1055
1056         p = fmt;
1057
1058         while (*p) {
1059                 if (*p == '\\') {
1060                         if (!p[1]) {
1061                                 talloc_free(node);
1062                                 *error = "Invalid escape at end of string";
1063                                 return -(p - fmt);
1064                         }
1065                         p += 2;
1066                         continue;
1067                 }
1068
1069                 /*
1070                  *      Process the expansion.
1071                  */
1072                 if ((p[0] == '%') && (p[1] == '{')) {
1073                         ssize_t slen;
1074
1075                         XLAT_DEBUG("LITERAL <-- %s", node->fmt);
1076
1077                         slen = xlat_tokenize_expansion(node, p, &node->next, error);
1078                         if (slen <= 0) {
1079                                 talloc_free(node);
1080                                 return slen - (p - fmt);
1081                         }
1082                         *p = '\0'; /* end the literal */
1083                         p += slen;
1084
1085                         rad_assert(node->next != NULL);
1086
1087                         /*
1088                          *      Short-circuit the recursive call.
1089                          *      This saves another function call and
1090                          *      memory allocation.
1091                          */
1092                         if (!*p) break;
1093
1094                         /*
1095                          *      "foo %{User-Name} bar"
1096                          *      LITERAL         "foo "
1097                          *      EXPANSION       User-Name
1098                          *      LITERAL         " bar"
1099                          */
1100                         slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1101                         rad_assert(slen != 0);
1102                         if (slen < 0) {
1103                                 talloc_free(node);
1104                                 return slen - (p - fmt);
1105                         }
1106
1107                         p += slen;
1108                         break;  /* stop processing the string */
1109                 }
1110
1111                 /*
1112                  *      Check for valid single-character expansions.
1113                  */
1114                 if (p[0] == '%') {
1115                         ssize_t slen;
1116                         xlat_exp_t *next;
1117
1118                         if (!p[1] || !strchr("%dlmtDGHISTYv", p[1])) {
1119                                         talloc_free(node);
1120                                         *error = "Invalid variable expansion";
1121                                         p++;
1122                                         return - (p - fmt);
1123                         }
1124
1125                         next = talloc_zero(node, xlat_exp_t);
1126                         next->len = 1;
1127
1128                         if (p[1] == '%') {
1129                                 next->fmt = talloc_typed_strdup(next, "%");
1130
1131                                 XLAT_DEBUG("LITERAL <-- %s", next->fmt);
1132                                 next->type = XLAT_LITERAL;
1133
1134                         } else {
1135                                 next->fmt = p + 1;
1136
1137                                 XLAT_DEBUG("PERCENT <-- %c", *next->fmt);
1138                                 next->type = XLAT_PERCENT;
1139                         }
1140
1141                         node->next = next;
1142                         *p = '\0';
1143                         p += 2;
1144
1145                         if (!*p) break;
1146
1147                         /*
1148                          *      And recurse.
1149                          */
1150                         slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1151                         rad_assert(slen != 0);
1152                         if (slen < 0) {
1153                                 talloc_free(node);
1154                                 return slen - (p - fmt);
1155                         }
1156
1157                         p += slen;
1158                         break;  /* stop processing the string */
1159                 }
1160
1161                 /*
1162                  *      If required, eat the brace.
1163                  */
1164                 if (brace && (*p == '}')) {
1165                         *p = '\0';
1166                         p++;
1167                         break;
1168                 }
1169
1170                 p++;
1171                 node->len++;
1172         }
1173
1174         /*
1175          *      Squash zero-width literals
1176          */
1177         if (node->len > 0) {
1178                 *head = node;
1179
1180         } else {
1181                 (void) talloc_steal(ctx, node->next);
1182                 *head = node->next;
1183                 talloc_free(node);
1184         }
1185
1186         return p - fmt;
1187 }
1188
1189
1190 static char const xlat_tabs[] = "                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ";
1191
1192 static void xlat_tokenize_debug(xlat_exp_t const *node, int lvl)
1193 {
1194         rad_assert(node != NULL);
1195
1196         if (lvl >= (int) sizeof(xlat_tabs)) lvl = sizeof(xlat_tabs);
1197
1198         while (node) {
1199                 switch (node->type) {
1200                 case XLAT_LITERAL:
1201                         DEBUG("%.*sliteral --> %s", lvl, xlat_tabs, node->fmt);
1202                         break;
1203
1204                 case XLAT_PERCENT:
1205                         DEBUG("%.*spercent --> %c", lvl, xlat_tabs, node->fmt[0]);
1206                         break;
1207
1208                 case XLAT_ATTRIBUTE:
1209                         rad_assert(node->attr.tmpl_da != NULL);
1210                         DEBUG("%.*sattribute --> %s", lvl, xlat_tabs, node->attr.tmpl_da->name);
1211                         rad_assert(node->child == NULL);
1212                         if ((node->attr.tmpl_tag != TAG_ANY) || (node->attr.tmpl_num != NUM_ANY)) {
1213                                 DEBUG("%.*s{", lvl, xlat_tabs);
1214
1215                                 DEBUG("%.*sref  %d", lvl + 1, xlat_tabs, node->attr.tmpl_request);
1216                                 DEBUG("%.*slist %d", lvl + 1, xlat_tabs, node->attr.tmpl_list);
1217
1218                                 if (node->attr.tmpl_tag != TAG_ANY) {
1219                                         DEBUG("%.*stag %d", lvl + 1, xlat_tabs, node->attr.tmpl_tag);
1220                                 }
1221                                 if (node->attr.tmpl_num != NUM_ANY) {
1222                                         if (node->attr.tmpl_num == NUM_COUNT) {
1223                                                 DEBUG("%.*s[#]", lvl + 1, xlat_tabs);
1224                                         } else if (node->attr.tmpl_num == NUM_ALL) {
1225                                                 DEBUG("%.*s[*]", lvl + 1, xlat_tabs);
1226                                         } else {
1227                                                 DEBUG("%.*s[%d]", lvl + 1, xlat_tabs, node->attr.tmpl_num);
1228                                         }
1229                                 }
1230
1231                                 DEBUG("%.*s}", lvl, xlat_tabs);
1232                         }
1233                         break;
1234
1235                 case XLAT_VIRTUAL:
1236                         rad_assert(node->fmt != NULL);
1237                         DEBUG("%.*svirtual --> %s", lvl, xlat_tabs, node->fmt);
1238                         break;
1239
1240                 case XLAT_MODULE:
1241                         rad_assert(node->xlat != NULL);
1242                         DEBUG("%.*sxlat --> %s", lvl, xlat_tabs, node->xlat->name);
1243                         if (node->child) {
1244                                 DEBUG("%.*s{", lvl, xlat_tabs);
1245                                 xlat_tokenize_debug(node->child, lvl + 1);
1246                                 DEBUG("%.*s}", lvl, xlat_tabs);
1247                         }
1248                         break;
1249
1250 #ifdef HAVE_REGEX
1251                 case XLAT_REGEX:
1252                         DEBUG("%.*sregex-var --> %d", lvl, xlat_tabs, node->attr.tmpl_num);
1253                         break;
1254 #endif
1255
1256                 case XLAT_ALTERNATE:
1257                         DEBUG("%.*sif {", lvl, xlat_tabs);
1258                         xlat_tokenize_debug(node->child, lvl + 1);
1259                         DEBUG("%.*s}", lvl, xlat_tabs);
1260                         DEBUG("%.*selse {", lvl, xlat_tabs);
1261                         xlat_tokenize_debug(node->alternate, lvl + 1);
1262                         DEBUG("%.*s}", lvl, xlat_tabs);
1263                         break;
1264                 }
1265                 node = node->next;
1266         }
1267 }
1268
1269 size_t xlat_sprint(char *buffer, size_t bufsize, xlat_exp_t const *node)
1270 {
1271         size_t len;
1272         char *p, *end;
1273
1274         if (!node) {
1275                 *buffer = '\0';
1276                 return 0;
1277         }
1278
1279         p = buffer;
1280         end = buffer + bufsize;
1281
1282         while (node) {
1283                 switch (node->type) {
1284                 case XLAT_LITERAL:
1285                         strlcpy(p, node->fmt, end - p);
1286                         p += strlen(p);
1287                         break;
1288
1289                 case XLAT_PERCENT:
1290                         p[0] = '%';
1291                         p[1] = node->fmt[0];
1292                         p += 2;
1293                         break;
1294
1295                 case XLAT_ATTRIBUTE:
1296                         *(p++) = '%';
1297                         *(p++) = '{';
1298
1299                         if (node->attr.tmpl_request != REQUEST_CURRENT) {
1300                                 strlcpy(p, fr_int2str(request_refs, node->attr.tmpl_request, "??"), end - p);
1301                                 p += strlen(p);
1302                                 *(p++) = '.';
1303                         }
1304
1305                         if ((node->attr.tmpl_request != REQUEST_CURRENT) ||
1306                             (node->attr.tmpl_list != PAIR_LIST_REQUEST)) {
1307                                 strlcpy(p, fr_int2str(pair_lists, node->attr.tmpl_list, "??"), end - p);
1308                                 p += strlen(p);
1309                                 *(p++) = ':';
1310                         }
1311
1312                         strlcpy(p, node->attr.tmpl_da->name, end - p);
1313                         p += strlen(p);
1314
1315                         if (node->attr.tmpl_tag != TAG_ANY) {
1316                                 *(p++) = ':';
1317                                 snprintf(p, end - p, "%u", node->attr.tmpl_tag);
1318                                 p += strlen(p);
1319                         }
1320
1321                         if (node->attr.tmpl_num != NUM_ANY) {
1322                                 *(p++) = '[';
1323                                 switch (node->attr.tmpl_num) {
1324                                 case NUM_COUNT:
1325                                         *(p++) = '#';
1326                                         break;
1327
1328                                 case NUM_ALL:
1329                                         *(p++) = '*';
1330                                         break;
1331
1332                                 default:
1333                                         snprintf(p, end - p, "%i", node->attr.tmpl_num);
1334                                         p += strlen(p);
1335                                 }
1336                                 *(p++) = ']';
1337                         }
1338                         *(p++) = '}';
1339                         break;
1340 #ifdef HAVE_REGEX
1341                 case XLAT_REGEX:
1342                         snprintf(p, end - p, "%%{%i}", node->attr.tmpl_num);
1343                         p += strlen(p);
1344                         break;
1345 #endif
1346                 case XLAT_VIRTUAL:
1347                         *(p++) = '%';
1348                         *(p++) = '{';
1349                         strlcpy(p, node->fmt, end - p);
1350                         p += strlen(p);
1351                         *(p++) = '}';
1352                         break;
1353
1354                 case XLAT_MODULE:
1355                         *(p++) = '%';
1356                         *(p++) = '{';
1357                         strlcpy(p, node->xlat->name, end - p);
1358                         p += strlen(p);
1359                         *(p++) = ':';
1360                         rad_assert(node->child != NULL);
1361                         len = xlat_sprint(p, end - p, node->child);
1362                         p += len;
1363                         *(p++) = '}';
1364                         break;
1365
1366                 case XLAT_ALTERNATE:
1367                         *(p++) = '%';
1368                         *(p++) = '{';
1369
1370                         len = xlat_sprint(p, end - p, node->child);
1371                         p += len;
1372
1373                         *(p++) = ':';
1374                         *(p++) = '-';
1375
1376                         len = xlat_sprint(p, end - p, node->alternate);
1377                         p += len;
1378
1379                         *(p++) = '}';
1380                         break;
1381                 }
1382
1383
1384                 if (p == end) break;
1385
1386                 node = node->next;
1387         }
1388
1389         *p = '\0';
1390
1391         return p - buffer;
1392 }
1393
1394 ssize_t xlat_tokenize(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1395                       char const **error)
1396 {
1397         return xlat_tokenize_literal(ctx, fmt, head, false, error);
1398 }
1399
1400
1401 /** Tokenize an xlat expansion
1402  *
1403  * @param[in] request the input request.  Memory will be attached here.
1404  * @param[in] fmt the format string to expand
1405  * @param[out] head the head of the xlat list / tree structure.
1406  */
1407 static ssize_t xlat_tokenize_request(REQUEST *request, char const *fmt, xlat_exp_t **head)
1408 {
1409         ssize_t slen;
1410         char *tokens;
1411         char const *error = NULL;
1412
1413         *head = NULL;
1414
1415         /*
1416          *      Copy the original format string to a buffer so that
1417          *      the later functions can mangle it in-place, which is
1418          *      much faster.
1419          */
1420         tokens = talloc_typed_strdup(request, fmt);
1421         if (!tokens) return -1;
1422
1423         slen = xlat_tokenize_literal(request, tokens, head, false, &error);
1424
1425         /*
1426          *      Zero length expansion, return a zero length node.
1427          */
1428         if (slen == 0) {
1429                 *head = talloc_zero(request, xlat_exp_t);
1430         }
1431
1432         /*
1433          *      Output something like:
1434          *
1435          *      "format string"
1436          *      "       ^ error was here"
1437          */
1438         if (slen < 0) {
1439                 talloc_free(tokens);
1440                 rad_assert(error != NULL);
1441
1442                 REMARKER(fmt, -slen, error);
1443                 return slen;
1444         }
1445
1446         if (*head && (debug_flag > 2)) {
1447                 DEBUG("%s", fmt);
1448                 DEBUG("Parsed xlat tree:");
1449                 xlat_tokenize_debug(*head, 0);
1450         }
1451
1452         /*
1453          *      All of the nodes point to offsets in the "tokens"
1454          *      string.  Let's ensure that free'ing head will free
1455          *      "tokens", too.
1456          */
1457         (void) talloc_steal(*head, tokens);
1458
1459         return slen;
1460 }
1461
1462
1463 static char *xlat_getvp(TALLOC_CTX *ctx, REQUEST *request, value_pair_tmpl_t const *vpt,
1464                         bool escape, bool return_null)
1465 {
1466         VALUE_PAIR *vp = NULL, *virtual = NULL;
1467         RADIUS_PACKET *packet = NULL;
1468         DICT_VALUE *dv;
1469         char *ret = NULL;
1470         int err;
1471
1472         char quote = escape ? '"' : '\0';
1473
1474         vp_cursor_t cursor;
1475
1476         /*
1477          *      See if we're dealing with an attribute in the request
1478          *
1479          *      This allows users to manipulate virtual attributes as if
1480          *      they were real ones.
1481          */
1482         vp = tmpl_cursor_init(&err, &cursor, request, vpt);
1483         if (vp) goto do_print;
1484
1485         /*
1486          *      We didn't find the VP in a list.
1487          *      If it's not a virtual one, and we're not meant to
1488          *      be counting it, return.
1489          */
1490         if (!vpt->tmpl_da->flags.virtual) {
1491                 if (vpt->tmpl_num == NUM_COUNT) goto do_print;
1492                 return NULL;
1493         }
1494
1495         /*
1496          *      Switch out the request to the one specified by the template
1497          */
1498         if (radius_request(&request, vpt->tmpl_request) < 0) return NULL;
1499
1500         /*
1501          *      Some non-packet expansions
1502          */
1503         switch (vpt->tmpl_da->attr) {
1504         default:
1505                 break;          /* ignore them */
1506
1507         case PW_CLIENT_SHORTNAME:
1508                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1509                 if (request->client && request->client->shortname) {
1510                         return talloc_typed_strdup(ctx, request->client->shortname);
1511                 }
1512                 return talloc_typed_strdup(ctx, "<UNKNOWN-CLIENT>");
1513
1514         case PW_REQUEST_PROCESSING_STAGE:
1515                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1516                 if (request->component) {
1517                         return talloc_typed_strdup(ctx, request->component);
1518                 }
1519                 return talloc_typed_strdup(ctx, "server_core");
1520
1521         case PW_VIRTUAL_SERVER:
1522                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1523                 if (!request->server) return NULL;
1524                 return talloc_typed_strdup(ctx, request->server);
1525
1526         case PW_MODULE_RETURN_CODE:
1527                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1528                 if (!request->rcode) return NULL;
1529                 return talloc_typed_strdup(ctx, fr_int2str(modreturn_table, request->rcode, ""));
1530         }
1531
1532         /*
1533          *      All of the attributes must now refer to a packet.
1534          *      If there's no packet, we can't print any attribute
1535          *      referencing it.
1536          */
1537         packet = radius_packet(request, vpt->tmpl_list);
1538         if (!packet) {
1539                 if (return_null) return NULL;
1540                 return vp_aprints_type(ctx, vpt->tmpl_da->type);
1541         }
1542
1543         vp = NULL;
1544         switch (vpt->tmpl_da->attr) {
1545         default:
1546                 break;
1547
1548         case PW_PACKET_TYPE:
1549                 dv = dict_valbyattr(PW_PACKET_TYPE, 0, packet->code);
1550                 if (dv) return talloc_typed_strdup(ctx, dv->name);
1551                 return talloc_typed_asprintf(ctx, "%d", packet->code);
1552
1553         case PW_RESPONSE_PACKET_TYPE:
1554         {
1555                 int code = 0;
1556
1557 #ifdef WITH_PROXY
1558                 if (request->proxy_reply && (!request->reply || !request->reply->code)) {
1559                         code = request->proxy_reply->code;
1560                 } else
1561 #endif
1562                         if (request->reply) {
1563                                 code = request->reply->code;
1564                         }
1565
1566                 return talloc_typed_strdup(ctx, fr_packet_codes[code]);
1567         }
1568
1569         /*
1570          *      Virtual attributes which require a temporary VALUE_PAIR
1571          *      to be allocated. We can't use stack allocated memory
1572          *      because of the talloc checks sprinkled throughout the
1573          *      various VP functions.
1574          */
1575         case PW_PACKET_AUTHENTICATION_VECTOR:
1576                 virtual = pairalloc(ctx, vpt->tmpl_da);
1577                 pairmemcpy(virtual, packet->vector, sizeof(packet->vector));
1578                 vp = virtual;
1579                 break;
1580
1581         case PW_CLIENT_IP_ADDRESS:
1582         case PW_PACKET_SRC_IP_ADDRESS:
1583                 if (packet->src_ipaddr.af == AF_INET) {
1584                         virtual = pairalloc(ctx, vpt->tmpl_da);
1585                         virtual->vp_ipaddr = packet->src_ipaddr.ipaddr.ip4addr.s_addr;
1586                         vp = virtual;
1587                 }
1588                 break;
1589
1590         case PW_PACKET_DST_IP_ADDRESS:
1591                 if (packet->dst_ipaddr.af == AF_INET) {
1592                         virtual = pairalloc(ctx, vpt->tmpl_da);
1593                         virtual->vp_ipaddr = packet->dst_ipaddr.ipaddr.ip4addr.s_addr;
1594                         vp = virtual;
1595                 }
1596                 break;
1597
1598         case PW_PACKET_SRC_IPV6_ADDRESS:
1599                 if (packet->src_ipaddr.af == AF_INET6) {
1600                         virtual = pairalloc(ctx, vpt->tmpl_da);
1601                         memcpy(&virtual->vp_ipv6addr,
1602                                &packet->src_ipaddr.ipaddr.ip6addr,
1603                                sizeof(packet->src_ipaddr.ipaddr.ip6addr));
1604                         vp = virtual;
1605                 }
1606                 break;
1607
1608         case PW_PACKET_DST_IPV6_ADDRESS:
1609                 if (packet->dst_ipaddr.af == AF_INET6) {
1610                         virtual = pairalloc(ctx, vpt->tmpl_da);
1611                         memcpy(&virtual->vp_ipv6addr,
1612                                &packet->dst_ipaddr.ipaddr.ip6addr,
1613                                sizeof(packet->dst_ipaddr.ipaddr.ip6addr));
1614                         vp = virtual;
1615                 }
1616                 break;
1617
1618         case PW_PACKET_SRC_PORT:
1619                 virtual = pairalloc(ctx, vpt->tmpl_da);
1620                 virtual->vp_integer = packet->src_port;
1621                 vp = virtual;
1622                 break;
1623
1624         case PW_PACKET_DST_PORT:
1625                 virtual = pairalloc(ctx, vpt->tmpl_da);
1626                 virtual->vp_integer = packet->dst_port;
1627                 vp = virtual;
1628                 break;
1629         }
1630
1631         /*
1632          *      Fake various operations for virtual attributes.
1633          */
1634         if (virtual) {
1635                 if (vpt->tmpl_num != NUM_ANY) switch (vpt->tmpl_num) {
1636                 /*
1637                  *      [n] is NULL (we only have [0])
1638                  */
1639                 default:
1640                         goto finish;
1641                 /*
1642                  *      [*] means only one.
1643                  */
1644                 case NUM_ALL:
1645                         break;
1646
1647                 /*
1648                  *      [#] means 1 (as there's only one)
1649                  */
1650                 case NUM_COUNT:
1651                 count_virtual:
1652                         ret = talloc_strdup(ctx, "1");
1653                         goto finish;
1654
1655                 /*
1656                  *      [0] is fine (get the first instance)
1657                  */
1658                 case 0:
1659                         break;
1660                 }
1661                 goto print;
1662         }
1663
1664 do_print:
1665         switch (vpt->tmpl_num) {
1666         /*
1667          *      Return a count of the VPs.
1668          */
1669         case NUM_COUNT:
1670         {
1671                 int count = 0;
1672
1673                 fr_cursor_first(&cursor);
1674                 while (fr_cursor_next_by_da(&cursor, vpt->tmpl_da, vpt->tmpl_tag)) count++;
1675
1676                 return talloc_typed_asprintf(ctx, "%d", count);
1677         }
1678
1679
1680         /*
1681          *      Concatenate all values together,
1682          *      separated by commas.
1683          */
1684         case NUM_ALL:
1685         {
1686                 char *p, *q;
1687
1688                 if (!fr_cursor_current(&cursor)) return NULL;
1689                 p = vp_aprints_value(ctx, vp, quote);
1690                 if (!p) return NULL;
1691
1692                 while ((vp = tmpl_cursor_next(&cursor, vpt)) != NULL) {
1693                         q = vp_aprints_value(ctx, vp, quote);
1694                         if (!q) return NULL;
1695                         p = talloc_strdup_append(p, ",");
1696                         p = talloc_strdup_append(p, q);
1697                 }
1698
1699                 return p;
1700         }
1701
1702         default:
1703                 /*
1704                  *      The cursor was set to the correct
1705                  *      position above by tmpl_cursor_init.
1706                  */
1707                 vp = fr_cursor_current(&cursor);
1708                 break;
1709         }
1710
1711         if (!vp) {
1712                 if (return_null) return NULL;
1713                 return vp_aprints_type(ctx, vpt->tmpl_da->type);
1714         }
1715
1716 print:
1717         ret = vp_aprints_value(ctx, vp, quote);
1718
1719 finish:
1720         talloc_free(virtual);
1721         return ret;
1722 }
1723
1724 #ifdef DEBUG_XLAT
1725 static const char xlat_spaces[] = "                                                                                                                                                                                                                                                                ";
1726 #endif
1727
1728 static char *xlat_aprint(TALLOC_CTX *ctx, REQUEST *request, xlat_exp_t const * const node,
1729                          RADIUS_ESCAPE_STRING escape, void *escape_ctx, int lvl)
1730 {
1731         ssize_t rcode;
1732         char *str = NULL, *child;
1733         char *q;
1734         char const *p;
1735
1736         XLAT_DEBUG("%.*sxlat aprint %d", lvl, xlat_spaces, node->type);
1737
1738         switch (node->type) {
1739                 /*
1740                  *      Don't escape this.
1741                  */
1742         case XLAT_LITERAL:
1743                 XLAT_DEBUG("xlat_aprint LITERAL");
1744                 return talloc_typed_strdup(ctx, node->fmt);
1745
1746                 /*
1747                  *      Do a one-character expansion.
1748                  */
1749         case XLAT_PERCENT:
1750         {
1751                 char *nl;
1752                 size_t freespace = 256;
1753                 struct tm ts;
1754                 time_t when;
1755
1756                 XLAT_DEBUG("xlat_aprint PERCENT");
1757
1758                 str = talloc_array(ctx, char, freespace); /* @todo do better allocation */
1759                 p = node->fmt;
1760
1761                 when = request->timestamp;
1762                 if (request->packet) {
1763                         when = request->packet->timestamp.tv_sec;
1764                 }
1765
1766                 switch (*p) {
1767                 case '%':
1768                         str[0] = '%';
1769                         str[1] = '\0';
1770                         break;
1771
1772                 case 'd': /* request day */
1773                         if (!localtime_r(&when, &ts)) goto error;
1774                         strftime(str, freespace, "%d", &ts);
1775                         break;
1776
1777                 case 'l': /* request timestamp */
1778                         snprintf(str, freespace, "%lu",
1779                                  (unsigned long) when);
1780                         break;
1781
1782                 case 'm': /* request month */
1783                         if (!localtime_r(&when, &ts)) goto error;
1784                         strftime(str, freespace, "%m", &ts);
1785                         break;
1786
1787                 case 'n': /* Request Number*/
1788                         snprintf(str, freespace, "%u", request->number);
1789                         break;
1790
1791                 case 't': /* request timestamp */
1792                         CTIME_R(&when, str, freespace);
1793                         nl = strchr(str, '\n');
1794                         if (nl) *nl = '\0';
1795                         break;
1796
1797                 case 'D': /* request date */
1798                         if (!localtime_r(&when, &ts)) goto error;
1799                         strftime(str, freespace, "%Y%m%d", &ts);
1800                         break;
1801
1802                 case 'G': /* request minute */
1803                         if (!localtime_r(&when, &ts)) goto error;
1804                         strftime(str, freespace, "%M", &ts);
1805                         break;
1806
1807                 case 'H': /* request hour */
1808                         if (!localtime_r(&when, &ts)) goto error;
1809                         strftime(str, freespace, "%H", &ts);
1810                         break;
1811
1812                 case 'I': /* Request ID */
1813                         if (request->packet) {
1814                                 snprintf(str, freespace, "%i", request->packet->id);
1815                         }
1816                         break;
1817
1818                 case 'S': /* request timestamp in SQL format*/
1819                         if (!localtime_r(&when, &ts)) goto error;
1820                         strftime(str, freespace, "%Y-%m-%d %H:%M:%S", &ts);
1821                         break;
1822
1823                 case 'T': /* request timestamp */
1824                         if (!localtime_r(&when, &ts)) goto error;
1825                         strftime(str, freespace, "%Y-%m-%d-%H.%M.%S.000000", &ts);
1826                         break;
1827
1828                 case 'Y': /* request year */
1829                         if (!localtime_r(&when, &ts)) {
1830                                 error:
1831                                 REDEBUG("Failed converting packet timestamp to localtime: %s", fr_syserror(errno));
1832                                 talloc_free(str);
1833                                 return NULL;
1834                         }
1835                         strftime(str, freespace, "%Y", &ts);
1836                         break;
1837
1838                 case 'v': /* Version of code */
1839                         snprintf(str, freespace, "%s", radiusd_short_version);
1840                         break;
1841
1842                 default:
1843                         rad_assert(0 == 1);
1844                         break;
1845                 }
1846         }
1847                 break;
1848
1849         case XLAT_ATTRIBUTE:
1850                 XLAT_DEBUG("xlat_aprint ATTRIBUTE");
1851
1852                 /*
1853                  *      Some attributes are virtual <sigh>
1854                  */
1855                 str = xlat_getvp(ctx, request, &node->attr, escape ? false : true, true);
1856                 if (str) {
1857                         XLAT_DEBUG("EXPAND attr %s", node->attr.tmpl_da->name);
1858                         XLAT_DEBUG("       ---> %s", str);
1859                 }
1860                 break;
1861
1862         case XLAT_VIRTUAL:
1863                 XLAT_DEBUG("xlat_aprint VIRTUAL");
1864                 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
1865                 rcode = node->xlat->func(node->xlat->instance, request, NULL, str, 2048);
1866                 if (rcode < 0) {
1867                         talloc_free(str);
1868                         return NULL;
1869                 }
1870                 break;
1871
1872         case XLAT_MODULE:
1873                 XLAT_DEBUG("xlat_aprint MODULE");
1874                 if (xlat_process(&child, request, node->child, node->xlat->escape, node->xlat->instance) == 0) {
1875                         return NULL;
1876                 }
1877
1878                 XLAT_DEBUG("%.*sEXPAND mod %s %s", lvl, xlat_spaces, node->fmt, node->child->fmt);
1879                 XLAT_DEBUG("%.*s      ---> %s", lvl, xlat_spaces, child);
1880
1881                 /*
1882                  *      Smash \n --> CR.
1883                  *
1884                  *      The OUTPUT of xlat is a printable string.  The INPUT might not be...
1885                  *
1886                  *      This is really the reverse of fr_print_string().
1887                  */
1888                 p = q = child;
1889                 while (*p) {
1890                         if (*p == '\\') switch (p[1]) {
1891                                 default:
1892                                         *(q++) = p[1];
1893                                         p += 2;
1894                                         continue;
1895
1896                                 case 'n':
1897                                         *(q++) = '\n';
1898                                         p += 2;
1899                                         continue;
1900
1901                                 case 't':
1902                                         *(q++) = '\t';
1903                                         p += 2;
1904                                         continue;
1905                         }
1906
1907                         *(q++) = *(p++);
1908                 }
1909                 *q = '\0';
1910
1911                 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
1912                 *str = '\0';    /* Be sure the string is NULL terminated, we now only free on error */
1913
1914                 rcode = node->xlat->func(node->xlat->instance, request, child, str, 2048);
1915                 talloc_free(child);
1916                 if (rcode < 0) {
1917                         talloc_free(str);
1918                         return NULL;
1919                 }
1920                 break;
1921
1922 #ifdef HAVE_REGEX
1923         case XLAT_REGEX:
1924                 XLAT_DEBUG("xlat_aprint REGEX");
1925                 child = request_data_reference(request, request,
1926                                                REQUEST_DATA_REGEX | node->attr.tmpl_num);
1927                 if (!child) return NULL;
1928
1929                 str = talloc_typed_strdup(ctx, child);
1930                 break;
1931 #endif
1932
1933         case XLAT_ALTERNATE:
1934                 XLAT_DEBUG("xlat_aprint ALTERNATE");
1935                 rad_assert(node->child != NULL);
1936                 rad_assert(node->alternate != NULL);
1937
1938                 str = xlat_aprint(ctx, request, node->child, escape, escape_ctx, lvl);
1939                 if (str) break;
1940
1941                 str = xlat_aprint(ctx, request, node->alternate, escape, escape_ctx, lvl);
1942                 break;
1943
1944         }
1945
1946         /*
1947          *      Escape the non-literals we found above.
1948          */
1949         if (str && escape) {
1950                 char *escaped;
1951
1952                 escaped = talloc_array(ctx, char, 2048); /* FIXME: do something intelligent */
1953                 escape(request, escaped, 2038, str, escape_ctx);
1954                 talloc_free(str);
1955                 str = escaped;
1956         }
1957
1958         return str;
1959 }
1960
1961
1962 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
1963                            RADIUS_ESCAPE_STRING escape, void *escape_ctx)
1964 {
1965         int i, list;
1966         size_t total;
1967         char **array, *answer;
1968         xlat_exp_t const *node;
1969
1970         *out = NULL;
1971
1972         /*
1973          *      There are no nodes to process, so the result is a zero
1974          *      length string.
1975          */
1976         if (!head) {
1977                 *out = talloc_zero_array(request, char, 1);
1978                 return 0;
1979         }
1980
1981         /*
1982          *      Hack for speed.  If it's one expansion, just allocate
1983          *      that and return, instead of allocating an intermediary
1984          *      array.
1985          */
1986         if (!head->next) {
1987                 /*
1988                  *      Pass the MAIN escape function.  Recursive
1989                  *      calls will call node-specific escape
1990                  *      functions.
1991                  */
1992                 answer = xlat_aprint(request, request, head, escape, escape_ctx, 0);
1993                 if (!answer) {
1994                         *out = talloc_zero_array(request, char, 1);
1995                         return 0;
1996                 }
1997                 *out = answer;
1998                 return strlen(answer);
1999         }
2000
2001         list = 0;               /* FIXME: calculate this once */
2002         for (node = head; node != NULL; node = node->next) {
2003                 list++;
2004         }
2005
2006         array = talloc_array(request, char *, list);
2007         if (!array) return -1;
2008
2009         for (node = head, i = 0; node != NULL; node = node->next, i++) {
2010                 array[i] = xlat_aprint(array, request, node, escape, escape_ctx, 0); /* may be NULL */
2011         }
2012
2013         total = 0;
2014         for (i = 0; i < list; i++) {
2015                 if (array[i]) total += strlen(array[i]); /* FIXME: calculate strlen once */
2016         }
2017
2018         if (!total) {
2019                 talloc_free(array);
2020                 *out = talloc_zero_array(request, char, 1);
2021                 return 0;
2022         }
2023
2024         answer = talloc_array(request, char, total + 1);
2025
2026         total = 0;
2027         for (i = 0; i < list; i++) {
2028                 size_t len;
2029
2030                 if (array[i]) {
2031                         len = strlen(array[i]);
2032                         memcpy(answer + total, array[i], len);
2033                         total += len;
2034                 }
2035         }
2036         answer[total] = '\0';
2037         talloc_free(array);     /* and child entries */
2038
2039         *out = answer;
2040         return total;
2041 }
2042
2043
2044 /** Replace %whatever in a string.
2045  *
2046  * See 'doc/variables.txt' for more information.
2047  *
2048  * @param[out] out Where to write pointer to output buffer.
2049  * @param[in] outlen Size of out.
2050  * @param[in] request current request.
2051  * @param[in] node the xlat structure to expand
2052  * @param[in] escape function to escape final value e.g. SQL quoting.
2053  * @param[in] escape_ctx pointer to pass to escape function.
2054  * @return length of string written @bug should really have -1 for failure
2055  */
2056 static ssize_t xlat_expand_struct(char **out, size_t outlen, REQUEST *request, xlat_exp_t const *node,
2057                                   RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2058 {
2059         char *buff;
2060         ssize_t len;
2061
2062         rad_assert(node != NULL);
2063
2064         len = xlat_process(&buff, request, node, escape, escape_ctx);
2065         if ((len < 0) || !buff) {
2066                 rad_assert(buff == NULL);
2067                 if (*out) *out[0] = '\0';
2068                 return len;
2069         }
2070
2071         if (!*out) {
2072                 *out = buff;
2073         } else {
2074                 strlcpy(*out, buff, outlen);
2075                 talloc_free(buff);
2076         }
2077
2078         return strlen(*out);
2079 }
2080
2081 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2082                            RADIUS_ESCAPE_STRING escape, void *escape_ctx) CC_HINT(nonnull (1, 3, 4));
2083
2084 /** Replace %whatever in a string.
2085  *
2086  * See 'doc/variables.txt' for more information.
2087  *
2088  * @param[out] out Where to write pointer to output buffer.
2089  * @param[in] outlen Size of out.
2090  * @param[in] request current request.
2091  * @param[in] fmt string to expand.
2092  * @param[in] escape function to escape final value e.g. SQL quoting.
2093  * @param[in] escape_ctx pointer to pass to escape function.
2094  * @return length of string written @bug should really have -1 for failure
2095  */
2096 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2097                            RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2098 {
2099         ssize_t len;
2100         xlat_exp_t *node;
2101
2102         /*
2103          *      Give better errors than the old code.
2104          */
2105         len = xlat_tokenize_request(request, fmt, &node);
2106         if (len == 0) {
2107                 if (*out) {
2108                         *out[0] = '\0';
2109                 } else {
2110                         *out = talloc_zero_array(request, char, 1);
2111                 }
2112                 return 0;
2113         }
2114
2115         if (len < 0) {
2116                 if (*out) *out[0] = '\0';
2117                 return -1;
2118         }
2119
2120         len = xlat_expand_struct(out, outlen, request, node, escape, escape_ctx);
2121         talloc_free(node);
2122
2123         RDEBUG2("EXPAND %s", fmt);
2124         RDEBUG2("   --> %s", *out);
2125
2126         return len;
2127 }
2128
2129 /*
2130  *      Try to convert an xlat to a tmpl for efficiency
2131  */
2132 value_pair_tmpl_t *radius_xlat2tmpl(TALLOC_CTX *ctx, xlat_exp_t *node)
2133 {
2134         value_pair_tmpl_t *vpt;
2135
2136         if (node->next || (node->type != XLAT_ATTRIBUTE)) return NULL;
2137
2138         /*
2139          * @todo it should be possible to emulate the concat and count operations in the
2140          * map code.
2141          */
2142         if ((node->attr.tmpl_num == NUM_COUNT) || (node->attr.tmpl_num == NUM_ALL)) return NULL;
2143
2144         vpt = tmpl_alloc(ctx, TMPL_TYPE_ATTR, node->fmt, -1);
2145         if (!vpt) return NULL;
2146         vpt->tmpl_request = node->attr.tmpl_request;
2147         vpt->tmpl_list = node->attr.tmpl_list;
2148         vpt->tmpl_da = node->attr.tmpl_da;
2149         vpt->tmpl_num = node->attr.tmpl_num;
2150         vpt->tmpl_tag = node->attr.tmpl_tag;
2151
2152         VERIFY_TMPL(vpt);
2153
2154         return vpt;
2155 }
2156
2157 ssize_t radius_xlat(char *out, size_t outlen, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2158 {
2159         return xlat_expand(&out, outlen, request, fmt, escape, ctx);
2160 }
2161
2162 ssize_t radius_axlat(char **out, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2163 {
2164         return xlat_expand(out, 0, request, fmt, escape, ctx);
2165 }
2166
2167 ssize_t radius_axlat_struct(char **out, REQUEST *request, xlat_exp_t const *xlat, RADIUS_ESCAPE_STRING escape, void *ctx)
2168 {
2169         return xlat_expand_struct(out, 0, request, xlat, escape, ctx);
2170 }