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->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->vp_length > 8) {
 149                         break;
 150                 }
 151
 152                 if (vp->vp_length > 4) {
 153                         memcpy(&int64, vp->vp_octets, vp->vp_length);
 154                         return snprintf(out, outlen, "%" PRIu64, htonll(int64));
 155                 }
 156
 157                 memcpy(&int32, vp->vp_octets, vp->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->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->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->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->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->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->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_prints((char const *) p, vp->vp_length, out, outlen, '"');
 494                 break;
 495
 496         case PW_TYPE_STRING:
 497                 len = strlcpy(out, vp->vp_strvalue, outlen);
 498                 break;
 499
 500         default:
 501                 len = fr_prints((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  *      Internal redundant handler for xlats
 751  */
 752 typedef enum xlat_redundant_type_t {
 753         XLAT_INVALID = 0,
 754         XLAT_REDUNDANT,
 755         XLAT_LOAD_BALANCE,
 756         XLAT_REDUNDANT_LOAD_BALANCE,
 757 } xlat_redundant_type_t;
 758
 759 typedef struct xlat_redundant_t {
 760         xlat_redundant_type_t type;
 761         uint32_t        count;
 762         CONF_SECTION *cs;
 763 } xlat_redundant_t;
 764
 765
 766 static ssize_t xlat_redundant(void *instance, REQUEST *request,
 767                               char const *fmt, char *out, size_t outlen)
 768 {
 769         xlat_redundant_t *xr = instance;
 770         CONF_ITEM *ci;
 771         char const *name;
 772         xlat_t *xlat;
 773
 774         rad_assert(xr->type == XLAT_REDUNDANT);
 775
 776         /*
 777          *      Pick the first xlat which succeeds
 778          */
 779         for (ci = cf_item_find_next(xr->cs, NULL);
 780              ci != NULL;
 781              ci = cf_item_find_next(xr->cs, ci)) {
 782                 ssize_t rcode;
 783
 784                 if (!cf_item_is_pair(ci)) continue;
 785
 786                 name = cf_pair_attr(cf_itemtopair(ci));
 787                 rad_assert(name != NULL);
 788
 789                 xlat = xlat_find(name);
 790                 if (!xlat) continue;
 791
 792                 rcode = xlat->func(xlat->instance, request, fmt, out, outlen);
 793                 if (rcode <= 0) continue;
 794                 return rcode;
 795         }
 796
 797         /*
 798          *      Everything failed.  Oh well.
 799          */
 800         *out  = 0;
 801         return 0;
 802 }
 803
 804
 805 static ssize_t xlat_load_balance(void *instance, REQUEST *request,
 806                               char const *fmt, char *out, size_t outlen)
 807 {
 808         uint32_t count = 0;
 809         xlat_redundant_t *xr = instance;
 810         CONF_ITEM *ci;
 811         CONF_ITEM *found = NULL;
 812         char const *name;
 813         xlat_t *xlat;
 814
 815         /*
 816          *      Choose a child at random.
 817          */
 818         for (ci = cf_item_find_next(xr->cs, NULL);
 819              ci != NULL;
 820              ci = cf_item_find_next(xr->cs, ci)) {
 821                 if (!cf_item_is_pair(ci)) continue;
 822                 count++;
 823
 824                 /*
 825                  *      Replace the previously found one with a random
 826                  *      new one.
 827                  */
 828                 if ((count * (fr_rand() & 0xffff)) < (uint32_t) 0x10000) {
 829                         found = ci;
 830                 }
 831         }
 832
 833         /*
 834          *      Plain load balancing: do one child, and only one child.
 835          */
 836         if (xr->type == XLAT_LOAD_BALANCE) {
 837                 name = cf_pair_attr(cf_itemtopair(found));
 838                 rad_assert(name != NULL);
 839
 840                 xlat = xlat_find(name);
 841                 if (!xlat) return -1;
 842
 843                 return xlat->func(xlat->instance, request, fmt, out, outlen);
 844         }
 845
 846         rad_assert(xr->type == XLAT_REDUNDANT_LOAD_BALANCE);
 847
 848         /*
 849          *      Try the random one we found.  If it fails, keep going
 850          *      through the rest of the children.
 851          */
 852         ci = found;
 853         do {
 854                 name = cf_pair_attr(cf_itemtopair(ci));
 855                 rad_assert(name != NULL);
 856
 857                 xlat = xlat_find(name);
 858                 if (xlat) {
 859                         ssize_t rcode;
 860
 861                         rcode = xlat->func(xlat->instance, request, fmt, out, outlen);
 862                         if (rcode > 0) return rcode;
 863                 }
 864
 865                 /*
 866                  *      Go to the next one, wrapping around at the end.
 867                  */
 868                 ci = cf_item_find_next(xr->cs, ci);
 869                 if (!ci) ci = cf_item_find_next(xr->cs, NULL);
 870         } while (ci != found);
 871
 872         return -1;
 873 }
 874
 875
 876 bool xlat_register_redundant(CONF_SECTION *cs)
 877 {
 878         char const *name1, *name2;
 879         xlat_redundant_t *xr;
 880
 881         name1 = cf_section_name1(cs);
 882         name2 = cf_section_name2(cs);
 883
 884         if (xlat_find(name2)) {
 885                 cf_log_err_cs(cs, "An expansion is already registered for this name");
 886                 return false;
 887         }
 888
 889         xr = talloc_zero(cs, xlat_redundant_t);
 890         if (!xr) return false;
 891
 892         if (strcmp(name1, "redundant") == 0) {
 893                 xr->type = XLAT_REDUNDANT;
 894
 895         } else if (strcmp(name1, "redundant-load-balance") == 0) {
 896                 xr->type = XLAT_REDUNDANT_LOAD_BALANCE;
 897
 898         } else if (strcmp(name1, "load-balance") == 0) {
 899                 xr->type = XLAT_LOAD_BALANCE;
 900
 901         } else {
 902                 return false;
 903         }
 904
 905         xr->cs = cs;
 906
 907         /*
 908          *      Get the number of children for load balancing.
 909          */
 910         if (xr->type == XLAT_REDUNDANT) {
 911                 if (xlat_register(name2, xlat_redundant, NULL, xr) < 0) {
 912                         talloc_free(xr);
 913                         return false;
 914                 }
 915
 916         } else {
 917                 CONF_ITEM *ci;
 918
 919                 for (ci = cf_item_find_next(cs, NULL);
 920                      ci != NULL;
 921                      ci = cf_item_find_next(cs, ci)) {
 922                         if (!cf_item_is_pair(ci)) continue;
 923
 924                         if (!xlat_find(cf_pair_attr(cf_itemtopair(ci)))) {
 925                                 talloc_free(xr);
 926                                 return false;
 927                         }
 928
 929                         xr->count++;
 930                 }
 931
 932                 if (xlat_register(name2, xlat_load_balance, NULL, xr) < 0) {
 933                         talloc_free(xr);
 934                         return false;
 935                 }
 936         }
 937
 938         return true;
 939 }
 940
 941
 942 /** Crappy temporary function to add attribute ref support to xlats
 943  *
 944  * This needs to die, and hopefully will die, when xlat functions accept
 945  * xlat node structures.
 946  *
 947  * Provides either a pointer to a buffer which contains the value of the reference VALUE_PAIR
 948  * in an architecture independent format. Or a pointer to the start of the fmt string.
 949  *
 950  * The pointer is only guaranteed to be valid between calls to xlat_fmt_to_ref,
 951  * and so long as the source VALUE_PAIR is not freed.
 952  *
 953  * @param out where to write a pointer to the buffer to the data the xlat function needs to work on.
 954  * @param request current request.
 955  * @param fmt string.
 956  * @returns the length of the data or -1 on error.
 957  */
 958 ssize_t xlat_fmt_to_ref(uint8_t const **out, REQUEST *request, char const *fmt)
 959 {
 960         VALUE_PAIR *vp;
 961
 962         while (isspace((int) *fmt)) fmt++;
 963
 964         if (fmt[0] == '&') {
 965                 if ((radius_get_vp(&vp, request, fmt) < 0) || !vp) {
 966                         *out = NULL;
 967                         return -1;
 968                 }
 969
 970                 return rad_vp2data(out, vp);
 971         }
 972
 973         *out = (uint8_t const *)fmt;
 974         return strlen(fmt);
 975 }
 976
 977 /** De-register all xlat functions, used mainly for debugging.
 978  *
 979  */
 980 void xlat_free(void)
 981 {
 982         rbtree_free(xlat_root);
 983 }
 984
 985
 986 #ifdef DEBUG_XLAT
 987 #  define XLAT_DEBUG DEBUG3
 988 #else
 989 #  define XLAT_DEBUG(...)
 990 #endif
 991
 992 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 993                                        char const **error);
 994 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
 995                                      bool brace, char const **error);
 996 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
 997                            RADIUS_ESCAPE_STRING escape, void *escape_ctx);
 998
 999 static ssize_t xlat_tokenize_alternation(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1000                                          char const **error)
1001 {
1002         ssize_t slen;
1003         char *p;
1004         xlat_exp_t *node;
1005
1006         rad_assert(fmt[0] == '%');
1007         rad_assert(fmt[1] == '{');
1008         rad_assert(fmt[2] == '%');
1009         rad_assert(fmt[3] == '{');
1010
1011         XLAT_DEBUG("ALTERNATE <-- %s", fmt);
1012
1013         node = talloc_zero(ctx, xlat_exp_t);
1014         node->type = XLAT_ALTERNATE;
1015
1016         p = fmt + 2;
1017         slen = xlat_tokenize_expansion(node, p, &node->child, error);
1018         if (slen <= 0) {
1019                 talloc_free(node);
1020                 return slen - (p - fmt);
1021         }
1022         p += slen;
1023
1024         if (p[0] != ':') {
1025                 talloc_free(node);
1026                 *error = "Expected ':' after first expansion";
1027                 return -(p - fmt);
1028         }
1029         p++;
1030
1031         if (p[0] != '-') {
1032                 talloc_free(node);
1033                 *error = "Expected '-' after ':'";
1034                 return -(p - fmt);
1035         }
1036         p++;
1037
1038         /*
1039          *      Allow the RHS to be empty as a special case.
1040          */
1041         if (*p == '}') {
1042                 /*
1043                  *      Hack up an empty string.
1044                  */
1045                 node->alternate = talloc_zero(node, xlat_exp_t);
1046                 node->alternate->type = XLAT_LITERAL;
1047                 node->alternate->fmt = talloc_typed_strdup(node->alternate, "");
1048                 *(p++) = '\0';
1049
1050         } else {
1051                 slen = xlat_tokenize_literal(node, p,  &node->alternate, true, error);
1052                 if (slen <= 0) {
1053                         talloc_free(node);
1054                         return slen - (p - fmt);
1055                 }
1056
1057                 if (!node->alternate) {
1058                         talloc_free(node);
1059                         *error = "Empty expansion is invalid";
1060                         return -(p - fmt);
1061                 }
1062                 p += slen;
1063         }
1064
1065         *head = node;
1066         return p - fmt;
1067 }
1068
1069 static ssize_t xlat_tokenize_expansion(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1070                                        char const **error)
1071 {
1072         ssize_t slen;
1073         char *p, *q;
1074         xlat_exp_t *node;
1075
1076         rad_assert(fmt[0] == '%');
1077         rad_assert(fmt[1] == '{');
1078
1079         /*
1080          *      %{%{...}:-bar}
1081          */
1082         if ((fmt[2] == '%') && (fmt[3] == '{')) return xlat_tokenize_alternation(ctx, fmt, head, error);
1083
1084         XLAT_DEBUG("EXPANSION <-- %s", fmt);
1085         node = talloc_zero(ctx, xlat_exp_t);
1086         node->fmt = fmt + 2;
1087         node->len = 0;
1088
1089 #ifdef HAVE_REGEX
1090         /*
1091          *      Handle regex's specially.
1092          */
1093         if (isdigit((int) fmt[2]) && (fmt[3] == '}')) {
1094                 if (fmt[2] == '9') {
1095                         talloc_free(node);
1096                         *error = "Invalid regex reference";
1097                         return -2;
1098                 }
1099
1100                 XLAT_DEBUG("REGEX <-- %s", fmt);
1101                 fmt[3] = '\0';
1102                 node->attr.tmpl_num = fmt[2] - '0'; /* ASCII */
1103
1104                 node->type = XLAT_REGEX;
1105                 *head = node;
1106                 return 4;
1107         }
1108 #endif /* HAVE_REGEX */
1109
1110         /*
1111          *      %{Attr-Name}
1112          *      %{Attr-Name[#]}
1113          *      %{Tunnel-Password:1}
1114          *      %{Tunnel-Password:1[#]}
1115          *      %{request:Attr-Name}
1116          *      %{request:Tunnel-Password:1}
1117          *      %{request:Tunnel-Password:1[#]}
1118          *      %{mod:foo}
1119          */
1120
1121         /*
1122          *      This is for efficiency, so we don't search for an xlat,
1123          *      when what's being referenced is obviously an attribute.
1124          */
1125         p = fmt + 2;
1126         for (q = p; *q != '\0'; q++) {
1127                 if (*q == ':') break;
1128
1129                 if (isspace((int) *q)) break;
1130
1131                 if (*q == '[') continue;
1132
1133                 if (*q == '}') break;
1134         }
1135
1136         /*
1137          *      Check for empty expressions %{}
1138          */
1139         if ((*q == '}') && (q == p)) {
1140                 *error = "Empty expression is invalid";
1141                 return -(p - fmt);
1142         }
1143
1144         /*
1145          *      Might be a module name reference.
1146          *
1147          *      If it's not, it's an attribute or parse error.
1148          */
1149         if (*q == ':') {
1150                 *q = '\0';
1151                 node->xlat = xlat_find(node->fmt);
1152                 if (node->xlat) {
1153                         /*
1154                          *      %{mod:foo}
1155                          */
1156                         node->type = XLAT_MODULE;
1157
1158                         p = q + 1;
1159                         XLAT_DEBUG("MOD <-- %s ... %s", node->fmt, p);
1160
1161                         slen = xlat_tokenize_literal(node, p, &node->child, true, error);
1162                         if (slen <= 0) {
1163                                 talloc_free(node);
1164                                 return slen - (p - fmt);
1165                         }
1166                         p += slen;
1167
1168                         *head = node;
1169                         rad_assert(node->next == NULL);
1170
1171                         return p - fmt;
1172                 }
1173                 *q = ':';       /* Avoids a strdup */
1174         }
1175
1176         /*
1177          *      The first token ends with:
1178          *      - '[' - Which is an attribute index, so it must be an attribute.
1179          *      - '}' - The end of the expansion, which means it was a bareword.
1180          */
1181         slen = tmpl_from_attr_substr(&node->attr, p, REQUEST_CURRENT, PAIR_LIST_REQUEST, true);
1182         if (slen <= 0) {
1183                 /*
1184                  *      If the parse error occurred before the ':'
1185                  *      then the error is changed to 'Unknown module',
1186                  *      as it was more likely to be a bad module name,
1187                  *      than a request qualifier.
1188                  */
1189                 if ((*q == ':') && ((p + (slen * -1)) < q)) {
1190                         *error = "Unknown module";
1191                 } else {
1192                         *error = fr_strerror();
1193                 }
1194                 return slen - (p - fmt);
1195         }
1196
1197         /*
1198          *      Might be a virtual XLAT attribute
1199          */
1200         if (node->attr.type == TMPL_TYPE_ATTR_UNDEFINED) {
1201                 node->xlat = xlat_find(node->attr.tmpl_unknown_name);
1202                 if (node->xlat) {
1203                         node->type = XLAT_VIRTUAL;
1204                         node->fmt = node->attr.tmpl_unknown_name;
1205
1206                         XLAT_DEBUG("VIRTUAL <-- %s", node->fmt);
1207                         *head = node;
1208                         rad_assert(node->next == NULL);
1209                         q++;
1210                         return q - fmt;
1211                 }
1212
1213                 talloc_free(node);
1214                 *error = "Unknown attribute";
1215                 return -(p - fmt);
1216         }
1217
1218         node->type = XLAT_ATTRIBUTE;
1219         p += slen;
1220         if (*p != '}') {
1221                 talloc_free(node);
1222                 *error = "No matching closing brace";
1223                 return -1;      /* second character of format string */
1224         }
1225         p++;
1226         *head = node;
1227         rad_assert(node->next == NULL);
1228
1229         return p - fmt;
1230 }
1231
1232
1233 static ssize_t xlat_tokenize_literal(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1234                                      bool brace, char const **error)
1235 {
1236         char *p;
1237         xlat_exp_t *node;
1238
1239         if (!*fmt) return 0;
1240
1241         XLAT_DEBUG("LITERAL <-- %s", fmt);
1242
1243         node = talloc_zero(ctx, xlat_exp_t);
1244         node->fmt = fmt;
1245         node->len = 0;
1246         node->type = XLAT_LITERAL;
1247
1248         p = fmt;
1249
1250         while (*p) {
1251                 if (*p == '\\') {
1252                         if (!p[1]) {
1253                                 talloc_free(node);
1254                                 *error = "Invalid escape at end of string";
1255                                 return -(p - fmt);
1256                         }
1257                         p += 2;
1258                         continue;
1259                 }
1260
1261                 /*
1262                  *      Process the expansion.
1263                  */
1264                 if ((p[0] == '%') && (p[1] == '{')) {
1265                         ssize_t slen;
1266
1267                         XLAT_DEBUG("LITERAL <-- %s", node->fmt);
1268
1269                         slen = xlat_tokenize_expansion(node, p, &node->next, error);
1270                         if (slen <= 0) {
1271                                 talloc_free(node);
1272                                 return slen - (p - fmt);
1273                         }
1274                         *p = '\0'; /* end the literal */
1275                         p += slen;
1276
1277                         rad_assert(node->next != NULL);
1278
1279                         /*
1280                          *      Short-circuit the recursive call.
1281                          *      This saves another function call and
1282                          *      memory allocation.
1283                          */
1284                         if (!*p) break;
1285
1286                         /*
1287                          *      "foo %{User-Name} bar"
1288                          *      LITERAL         "foo "
1289                          *      EXPANSION       User-Name
1290                          *      LITERAL         " bar"
1291                          */
1292                         slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1293                         rad_assert(slen != 0);
1294                         if (slen < 0) {
1295                                 talloc_free(node);
1296                                 return slen - (p - fmt);
1297                         }
1298
1299                         p += slen;
1300                         break;  /* stop processing the string */
1301                 }
1302
1303                 /*
1304                  *      Check for valid single-character expansions.
1305                  */
1306                 if (p[0] == '%') {
1307                         ssize_t slen;
1308                         xlat_exp_t *next;
1309
1310                         if (!p[1] || !strchr("%dlmntDGHISTYv", p[1])) {
1311                                         talloc_free(node);
1312                                         *error = "Invalid variable expansion";
1313                                         p++;
1314                                         return - (p - fmt);
1315                         }
1316
1317                         next = talloc_zero(node, xlat_exp_t);
1318                         next->len = 1;
1319
1320                         if (p[1] == '%') {
1321                                 next->fmt = talloc_typed_strdup(next, "%");
1322
1323                                 XLAT_DEBUG("LITERAL <-- %s", next->fmt);
1324                                 next->type = XLAT_LITERAL;
1325
1326                         } else {
1327                                 next->fmt = p + 1;
1328
1329                                 XLAT_DEBUG("PERCENT <-- %c", *next->fmt);
1330                                 next->type = XLAT_PERCENT;
1331                         }
1332
1333                         node->next = next;
1334                         *p = '\0';
1335                         p += 2;
1336
1337                         if (!*p) break;
1338
1339                         /*
1340                          *      And recurse.
1341                          */
1342                         slen = xlat_tokenize_literal(node->next, p, &(node->next->next), brace, error);
1343                         rad_assert(slen != 0);
1344                         if (slen < 0) {
1345                                 talloc_free(node);
1346                                 return slen - (p - fmt);
1347                         }
1348
1349                         p += slen;
1350                         break;  /* stop processing the string */
1351                 }
1352
1353                 /*
1354                  *      If required, eat the brace.
1355                  */
1356                 if (brace && (*p == '}')) {
1357                         *p = '\0';
1358                         p++;
1359                         break;
1360                 }
1361
1362                 p++;
1363                 node->len++;
1364         }
1365
1366         /*
1367          *      Squash zero-width literals
1368          */
1369         if (node->len > 0) {
1370                 *head = node;
1371
1372         } else {
1373                 (void) talloc_steal(ctx, node->next);
1374                 *head = node->next;
1375                 talloc_free(node);
1376         }
1377
1378         return p - fmt;
1379 }
1380
1381
1382 static char const xlat_tabs[] = "                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ";
1383
1384 static void xlat_tokenize_debug(xlat_exp_t const *node, int lvl)
1385 {
1386         rad_assert(node != NULL);
1387
1388         if (lvl >= (int) sizeof(xlat_tabs)) lvl = sizeof(xlat_tabs);
1389
1390         while (node) {
1391                 switch (node->type) {
1392                 case XLAT_LITERAL:
1393                         DEBUG("%.*sliteral --> %s", lvl, xlat_tabs, node->fmt);
1394                         break;
1395
1396                 case XLAT_PERCENT:
1397                         DEBUG("%.*spercent --> %c", lvl, xlat_tabs, node->fmt[0]);
1398                         break;
1399
1400                 case XLAT_ATTRIBUTE:
1401                         rad_assert(node->attr.tmpl_da != NULL);
1402                         DEBUG("%.*sattribute --> %s", lvl, xlat_tabs, node->attr.tmpl_da->name);
1403                         rad_assert(node->child == NULL);
1404                         if ((node->attr.tmpl_tag != TAG_ANY) || (node->attr.tmpl_num != NUM_ANY)) {
1405                                 DEBUG("%.*s{", lvl, xlat_tabs);
1406
1407                                 DEBUG("%.*sref  %d", lvl + 1, xlat_tabs, node->attr.tmpl_request);
1408                                 DEBUG("%.*slist %d", lvl + 1, xlat_tabs, node->attr.tmpl_list);
1409
1410                                 if (node->attr.tmpl_tag != TAG_ANY) {
1411                                         DEBUG("%.*stag %d", lvl + 1, xlat_tabs, node->attr.tmpl_tag);
1412                                 }
1413                                 if (node->attr.tmpl_num != NUM_ANY) {
1414                                         if (node->attr.tmpl_num == NUM_COUNT) {
1415                                                 DEBUG("%.*s[#]", lvl + 1, xlat_tabs);
1416                                         } else if (node->attr.tmpl_num == NUM_ALL) {
1417                                                 DEBUG("%.*s[*]", lvl + 1, xlat_tabs);
1418                                         } else {
1419                                                 DEBUG("%.*s[%d]", lvl + 1, xlat_tabs, node->attr.tmpl_num);
1420                                         }
1421                                 }
1422
1423                                 DEBUG("%.*s}", lvl, xlat_tabs);
1424                         }
1425                         break;
1426
1427                 case XLAT_VIRTUAL:
1428                         rad_assert(node->fmt != NULL);
1429                         DEBUG("%.*svirtual --> %s", lvl, xlat_tabs, node->fmt);
1430                         break;
1431
1432                 case XLAT_MODULE:
1433                         rad_assert(node->xlat != NULL);
1434                         DEBUG("%.*sxlat --> %s", lvl, xlat_tabs, node->xlat->name);
1435                         if (node->child) {
1436                                 DEBUG("%.*s{", lvl, xlat_tabs);
1437                                 xlat_tokenize_debug(node->child, lvl + 1);
1438                                 DEBUG("%.*s}", lvl, xlat_tabs);
1439                         }
1440                         break;
1441
1442 #ifdef HAVE_REGEX
1443                 case XLAT_REGEX:
1444                         DEBUG("%.*sregex-var --> %d", lvl, xlat_tabs, node->attr.tmpl_num);
1445                         break;
1446 #endif
1447
1448                 case XLAT_ALTERNATE:
1449                         DEBUG("%.*sif {", lvl, xlat_tabs);
1450                         xlat_tokenize_debug(node->child, lvl + 1);
1451                         DEBUG("%.*s}", lvl, xlat_tabs);
1452                         DEBUG("%.*selse {", lvl, xlat_tabs);
1453                         xlat_tokenize_debug(node->alternate, lvl + 1);
1454                         DEBUG("%.*s}", lvl, xlat_tabs);
1455                         break;
1456                 }
1457                 node = node->next;
1458         }
1459 }
1460
1461 size_t xlat_sprint(char *buffer, size_t bufsize, xlat_exp_t const *node)
1462 {
1463         size_t len;
1464         char *p, *end;
1465
1466         if (!node) {
1467                 *buffer = '\0';
1468                 return 0;
1469         }
1470
1471         p = buffer;
1472         end = buffer + bufsize;
1473
1474         while (node) {
1475                 switch (node->type) {
1476                 case XLAT_LITERAL:
1477                         strlcpy(p, node->fmt, end - p);
1478                         p += strlen(p);
1479                         break;
1480
1481                 case XLAT_PERCENT:
1482                         p[0] = '%';
1483                         p[1] = node->fmt[0];
1484                         p += 2;
1485                         break;
1486
1487                 case XLAT_ATTRIBUTE:
1488                         *(p++) = '%';
1489                         *(p++) = '{';
1490
1491                         if (node->attr.tmpl_request != REQUEST_CURRENT) {
1492                                 strlcpy(p, fr_int2str(request_refs, node->attr.tmpl_request, "??"), end - p);
1493                                 p += strlen(p);
1494                                 *(p++) = '.';
1495                         }
1496
1497                         if ((node->attr.tmpl_request != REQUEST_CURRENT) ||
1498                             (node->attr.tmpl_list != PAIR_LIST_REQUEST)) {
1499                                 strlcpy(p, fr_int2str(pair_lists, node->attr.tmpl_list, "??"), end - p);
1500                                 p += strlen(p);
1501                                 *(p++) = ':';
1502                         }
1503
1504                         strlcpy(p, node->attr.tmpl_da->name, end - p);
1505                         p += strlen(p);
1506
1507                         if (node->attr.tmpl_tag != TAG_ANY) {
1508                                 *(p++) = ':';
1509                                 snprintf(p, end - p, "%u", node->attr.tmpl_tag);
1510                                 p += strlen(p);
1511                         }
1512
1513                         if (node->attr.tmpl_num != NUM_ANY) {
1514                                 *(p++) = '[';
1515                                 switch (node->attr.tmpl_num) {
1516                                 case NUM_COUNT:
1517                                         *(p++) = '#';
1518                                         break;
1519
1520                                 case NUM_ALL:
1521                                         *(p++) = '*';
1522                                         break;
1523
1524                                 default:
1525                                         snprintf(p, end - p, "%i", node->attr.tmpl_num);
1526                                         p += strlen(p);
1527                                 }
1528                                 *(p++) = ']';
1529                         }
1530                         *(p++) = '}';
1531                         break;
1532 #ifdef HAVE_REGEX
1533                 case XLAT_REGEX:
1534                         snprintf(p, end - p, "%%{%i}", node->attr.tmpl_num);
1535                         p += strlen(p);
1536                         break;
1537 #endif
1538                 case XLAT_VIRTUAL:
1539                         *(p++) = '%';
1540                         *(p++) = '{';
1541                         strlcpy(p, node->fmt, end - p);
1542                         p += strlen(p);
1543                         *(p++) = '}';
1544                         break;
1545
1546                 case XLAT_MODULE:
1547                         *(p++) = '%';
1548                         *(p++) = '{';
1549                         strlcpy(p, node->xlat->name, end - p);
1550                         p += strlen(p);
1551                         *(p++) = ':';
1552                         rad_assert(node->child != NULL);
1553                         len = xlat_sprint(p, end - p, node->child);
1554                         p += len;
1555                         *(p++) = '}';
1556                         break;
1557
1558                 case XLAT_ALTERNATE:
1559                         *(p++) = '%';
1560                         *(p++) = '{';
1561
1562                         len = xlat_sprint(p, end - p, node->child);
1563                         p += len;
1564
1565                         *(p++) = ':';
1566                         *(p++) = '-';
1567
1568                         len = xlat_sprint(p, end - p, node->alternate);
1569                         p += len;
1570
1571                         *(p++) = '}';
1572                         break;
1573                 }
1574
1575
1576                 if (p == end) break;
1577
1578                 node = node->next;
1579         }
1580
1581         *p = '\0';
1582
1583         return p - buffer;
1584 }
1585
1586 ssize_t xlat_tokenize(TALLOC_CTX *ctx, char *fmt, xlat_exp_t **head,
1587                       char const **error)
1588 {
1589         return xlat_tokenize_literal(ctx, fmt, head, false, error);
1590 }
1591
1592
1593 /** Tokenize an xlat expansion
1594  *
1595  * @param[in] request the input request.  Memory will be attached here.
1596  * @param[in] fmt the format string to expand
1597  * @param[out] head the head of the xlat list / tree structure.
1598  */
1599 static ssize_t xlat_tokenize_request(REQUEST *request, char const *fmt, xlat_exp_t **head)
1600 {
1601         ssize_t slen;
1602         char *tokens;
1603         char const *error = NULL;
1604
1605         *head = NULL;
1606
1607         /*
1608          *      Copy the original format string to a buffer so that
1609          *      the later functions can mangle it in-place, which is
1610          *      much faster.
1611          */
1612         tokens = talloc_typed_strdup(request, fmt);
1613         if (!tokens) return -1;
1614
1615         slen = xlat_tokenize_literal(request, tokens, head, false, &error);
1616
1617         /*
1618          *      Zero length expansion, return a zero length node.
1619          */
1620         if (slen == 0) {
1621                 *head = talloc_zero(request, xlat_exp_t);
1622         }
1623
1624         /*
1625          *      Output something like:
1626          *
1627          *      "format string"
1628          *      "       ^ error was here"
1629          */
1630         if (slen < 0) {
1631                 talloc_free(tokens);
1632                 rad_assert(error != NULL);
1633
1634                 REMARKER(fmt, -slen, error);
1635                 return slen;
1636         }
1637
1638         if (*head && (debug_flag > 2)) {
1639                 DEBUG("%s", fmt);
1640                 DEBUG("Parsed xlat tree:");
1641                 xlat_tokenize_debug(*head, 0);
1642         }
1643
1644         /*
1645          *      All of the nodes point to offsets in the "tokens"
1646          *      string.  Let's ensure that free'ing head will free
1647          *      "tokens", too.
1648          */
1649         (void) talloc_steal(*head, tokens);
1650
1651         return slen;
1652 }
1653
1654
1655 static char *xlat_getvp(TALLOC_CTX *ctx, REQUEST *request, value_pair_tmpl_t const *vpt,
1656                         bool escape, bool return_null)
1657 {
1658         VALUE_PAIR *vp = NULL, *virtual = NULL;
1659         RADIUS_PACKET *packet = NULL;
1660         DICT_VALUE *dv;
1661         char *ret = NULL;
1662         int err;
1663
1664         char quote = escape ? '"' : '\0';
1665
1666         vp_cursor_t cursor;
1667
1668         /*
1669          *      See if we're dealing with an attribute in the request
1670          *
1671          *      This allows users to manipulate virtual attributes as if
1672          *      they were real ones.
1673          */
1674         vp = tmpl_cursor_init(&err, &cursor, request, vpt);
1675         if (vp) goto do_print;
1676
1677         /*
1678          *      We didn't find the VP in a list.
1679          *      If it's not a virtual one, and we're not meant to
1680          *      be counting it, return.
1681          */
1682         if (!vpt->tmpl_da->flags.virtual) {
1683                 if (vpt->tmpl_num == NUM_COUNT) goto do_print;
1684                 return NULL;
1685         }
1686
1687         /*
1688          *      Switch out the request to the one specified by the template
1689          */
1690         if (radius_request(&request, vpt->tmpl_request) < 0) return NULL;
1691
1692         /*
1693          *      Some non-packet expansions
1694          */
1695         switch (vpt->tmpl_da->attr) {
1696         default:
1697                 break;          /* ignore them */
1698
1699         case PW_CLIENT_SHORTNAME:
1700                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1701                 if (request->client && request->client->shortname) {
1702                         return talloc_typed_strdup(ctx, request->client->shortname);
1703                 }
1704                 return talloc_typed_strdup(ctx, "<UNKNOWN-CLIENT>");
1705
1706         case PW_REQUEST_PROCESSING_STAGE:
1707                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1708                 if (request->component) {
1709                         return talloc_typed_strdup(ctx, request->component);
1710                 }
1711                 return talloc_typed_strdup(ctx, "server_core");
1712
1713         case PW_VIRTUAL_SERVER:
1714                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1715                 if (!request->server) return NULL;
1716                 return talloc_typed_strdup(ctx, request->server);
1717
1718         case PW_MODULE_RETURN_CODE:
1719                 if (vpt->tmpl_num == NUM_COUNT) goto count_virtual;
1720                 if (!request->rcode) return NULL;
1721                 return talloc_typed_strdup(ctx, fr_int2str(modreturn_table, request->rcode, ""));
1722         }
1723
1724         /*
1725          *      All of the attributes must now refer to a packet.
1726          *      If there's no packet, we can't print any attribute
1727          *      referencing it.
1728          */
1729         packet = radius_packet(request, vpt->tmpl_list);
1730         if (!packet) {
1731                 if (return_null) return NULL;
1732                 return vp_aprints_type(ctx, vpt->tmpl_da->type);
1733         }
1734
1735         vp = NULL;
1736         switch (vpt->tmpl_da->attr) {
1737         default:
1738                 break;
1739
1740         case PW_PACKET_TYPE:
1741                 dv = dict_valbyattr(PW_PACKET_TYPE, 0, packet->code);
1742                 if (dv) return talloc_typed_strdup(ctx, dv->name);
1743                 return talloc_typed_asprintf(ctx, "%d", packet->code);
1744
1745         case PW_RESPONSE_PACKET_TYPE:
1746         {
1747                 int code = 0;
1748
1749 #ifdef WITH_PROXY
1750                 if (request->proxy_reply && (!request->reply || !request->reply->code)) {
1751                         code = request->proxy_reply->code;
1752                 } else
1753 #endif
1754                         if (request->reply) {
1755                                 code = request->reply->code;
1756                         }
1757
1758                 return talloc_typed_strdup(ctx, fr_packet_codes[code]);
1759         }
1760
1761         /*
1762          *      Virtual attributes which require a temporary VALUE_PAIR
1763          *      to be allocated. We can't use stack allocated memory
1764          *      because of the talloc checks sprinkled throughout the
1765          *      various VP functions.
1766          */
1767         case PW_PACKET_AUTHENTICATION_VECTOR:
1768                 virtual = pairalloc(ctx, vpt->tmpl_da);
1769                 pairmemcpy(virtual, packet->vector, sizeof(packet->vector));
1770                 vp = virtual;
1771                 break;
1772
1773         case PW_CLIENT_IP_ADDRESS:
1774         case PW_PACKET_SRC_IP_ADDRESS:
1775                 if (packet->src_ipaddr.af == AF_INET) {
1776                         virtual = pairalloc(ctx, vpt->tmpl_da);
1777                         virtual->vp_ipaddr = packet->src_ipaddr.ipaddr.ip4addr.s_addr;
1778                         vp = virtual;
1779                 }
1780                 break;
1781
1782         case PW_PACKET_DST_IP_ADDRESS:
1783                 if (packet->dst_ipaddr.af == AF_INET) {
1784                         virtual = pairalloc(ctx, vpt->tmpl_da);
1785                         virtual->vp_ipaddr = packet->dst_ipaddr.ipaddr.ip4addr.s_addr;
1786                         vp = virtual;
1787                 }
1788                 break;
1789
1790         case PW_PACKET_SRC_IPV6_ADDRESS:
1791                 if (packet->src_ipaddr.af == AF_INET6) {
1792                         virtual = pairalloc(ctx, vpt->tmpl_da);
1793                         memcpy(&virtual->vp_ipv6addr,
1794                                &packet->src_ipaddr.ipaddr.ip6addr,
1795                                sizeof(packet->src_ipaddr.ipaddr.ip6addr));
1796                         vp = virtual;
1797                 }
1798                 break;
1799
1800         case PW_PACKET_DST_IPV6_ADDRESS:
1801                 if (packet->dst_ipaddr.af == AF_INET6) {
1802                         virtual = pairalloc(ctx, vpt->tmpl_da);
1803                         memcpy(&virtual->vp_ipv6addr,
1804                                &packet->dst_ipaddr.ipaddr.ip6addr,
1805                                sizeof(packet->dst_ipaddr.ipaddr.ip6addr));
1806                         vp = virtual;
1807                 }
1808                 break;
1809
1810         case PW_PACKET_SRC_PORT:
1811                 virtual = pairalloc(ctx, vpt->tmpl_da);
1812                 virtual->vp_integer = packet->src_port;
1813                 vp = virtual;
1814                 break;
1815
1816         case PW_PACKET_DST_PORT:
1817                 virtual = pairalloc(ctx, vpt->tmpl_da);
1818                 virtual->vp_integer = packet->dst_port;
1819                 vp = virtual;
1820                 break;
1821         }
1822
1823         /*
1824          *      Fake various operations for virtual attributes.
1825          */
1826         if (virtual) {
1827                 if (vpt->tmpl_num != NUM_ANY) switch (vpt->tmpl_num) {
1828                 /*
1829                  *      [n] is NULL (we only have [0])
1830                  */
1831                 default:
1832                         goto finish;
1833                 /*
1834                  *      [*] means only one.
1835                  */
1836                 case NUM_ALL:
1837                         break;
1838
1839                 /*
1840                  *      [#] means 1 (as there's only one)
1841                  */
1842                 case NUM_COUNT:
1843                 count_virtual:
1844                         ret = talloc_strdup(ctx, "1");
1845                         goto finish;
1846
1847                 /*
1848                  *      [0] is fine (get the first instance)
1849                  */
1850                 case 0:
1851                         break;
1852                 }
1853                 goto print;
1854         }
1855
1856 do_print:
1857         switch (vpt->tmpl_num) {
1858         /*
1859          *      Return a count of the VPs.
1860          */
1861         case NUM_COUNT:
1862         {
1863                 int count = 0;
1864
1865                 fr_cursor_first(&cursor);
1866                 while (fr_cursor_next_by_da(&cursor, vpt->tmpl_da, vpt->tmpl_tag)) count++;
1867
1868                 return talloc_typed_asprintf(ctx, "%d", count);
1869         }
1870
1871
1872         /*
1873          *      Concatenate all values together,
1874          *      separated by commas.
1875          */
1876         case NUM_ALL:
1877         {
1878                 char *p, *q;
1879
1880                 if (!fr_cursor_current(&cursor)) return NULL;
1881                 p = vp_aprints_value(ctx, vp, quote);
1882                 if (!p) return NULL;
1883
1884                 while ((vp = tmpl_cursor_next(&cursor, vpt)) != NULL) {
1885                         q = vp_aprints_value(ctx, vp, quote);
1886                         if (!q) return NULL;
1887                         p = talloc_strdup_append(p, ",");
1888                         p = talloc_strdup_append(p, q);
1889                 }
1890
1891                 return p;
1892         }
1893
1894         default:
1895                 /*
1896                  *      The cursor was set to the correct
1897                  *      position above by tmpl_cursor_init.
1898                  */
1899                 vp = fr_cursor_current(&cursor);
1900                 break;
1901         }
1902
1903         if (!vp) {
1904                 if (return_null) return NULL;
1905                 return vp_aprints_type(ctx, vpt->tmpl_da->type);
1906         }
1907
1908 print:
1909         ret = vp_aprints_value(ctx, vp, quote);
1910
1911 finish:
1912         talloc_free(virtual);
1913         return ret;
1914 }
1915
1916 #ifdef DEBUG_XLAT
1917 static const char xlat_spaces[] = "                                                                                                                                                                                                                                                                ";
1918 #endif
1919
1920 static char *xlat_aprint(TALLOC_CTX *ctx, REQUEST *request, xlat_exp_t const * const node,
1921                          RADIUS_ESCAPE_STRING escape, void *escape_ctx, int lvl)
1922 {
1923         ssize_t rcode;
1924         char *str = NULL, *child;
1925         char const *p;
1926
1927         XLAT_DEBUG("%.*sxlat aprint %d", lvl, xlat_spaces, node->type);
1928
1929         switch (node->type) {
1930                 /*
1931                  *      Don't escape this.
1932                  */
1933         case XLAT_LITERAL:
1934                 XLAT_DEBUG("xlat_aprint LITERAL");
1935                 return talloc_typed_strdup(ctx, node->fmt);
1936
1937                 /*
1938                  *      Do a one-character expansion.
1939                  */
1940         case XLAT_PERCENT:
1941         {
1942                 char *nl;
1943                 size_t freespace = 256;
1944                 struct tm ts;
1945                 time_t when;
1946
1947                 XLAT_DEBUG("xlat_aprint PERCENT");
1948
1949                 str = talloc_array(ctx, char, freespace); /* @todo do better allocation */
1950                 p = node->fmt;
1951
1952                 when = request->timestamp;
1953                 if (request->packet) {
1954                         when = request->packet->timestamp.tv_sec;
1955                 }
1956
1957                 switch (*p) {
1958                 case '%':
1959                         str[0] = '%';
1960                         str[1] = '\0';
1961                         break;
1962
1963                 case 'd': /* request day */
1964                         if (!localtime_r(&when, &ts)) goto error;
1965                         strftime(str, freespace, "%d", &ts);
1966                         break;
1967
1968                 case 'l': /* request timestamp */
1969                         snprintf(str, freespace, "%lu",
1970                                  (unsigned long) when);
1971                         break;
1972
1973                 case 'm': /* request month */
1974                         if (!localtime_r(&when, &ts)) goto error;
1975                         strftime(str, freespace, "%m", &ts);
1976                         break;
1977
1978                 case 'n': /* Request Number*/
1979                         snprintf(str, freespace, "%u", request->number);
1980                         break;
1981
1982                 case 't': /* request timestamp */
1983                         CTIME_R(&when, str, freespace);
1984                         nl = strchr(str, '\n');
1985                         if (nl) *nl = '\0';
1986                         break;
1987
1988                 case 'D': /* request date */
1989                         if (!localtime_r(&when, &ts)) goto error;
1990                         strftime(str, freespace, "%Y%m%d", &ts);
1991                         break;
1992
1993                 case 'G': /* request minute */
1994                         if (!localtime_r(&when, &ts)) goto error;
1995                         strftime(str, freespace, "%M", &ts);
1996                         break;
1997
1998                 case 'H': /* request hour */
1999                         if (!localtime_r(&when, &ts)) goto error;
2000                         strftime(str, freespace, "%H", &ts);
2001                         break;
2002
2003                 case 'I': /* Request ID */
2004                         if (request->packet) {
2005                                 snprintf(str, freespace, "%i", request->packet->id);
2006                         }
2007                         break;
2008
2009                 case 'S': /* request timestamp in SQL format*/
2010                         if (!localtime_r(&when, &ts)) goto error;
2011                         strftime(str, freespace, "%Y-%m-%d %H:%M:%S", &ts);
2012                         break;
2013
2014                 case 'T': /* request timestamp */
2015                         if (!localtime_r(&when, &ts)) goto error;
2016                         strftime(str, freespace, "%Y-%m-%d-%H.%M.%S.000000", &ts);
2017                         break;
2018
2019                 case 'Y': /* request year */
2020                         if (!localtime_r(&when, &ts)) {
2021                                 error:
2022                                 REDEBUG("Failed converting packet timestamp to localtime: %s", fr_syserror(errno));
2023                                 talloc_free(str);
2024                                 return NULL;
2025                         }
2026                         strftime(str, freespace, "%Y", &ts);
2027                         break;
2028
2029                 case 'v': /* Version of code */
2030                         snprintf(str, freespace, "%s", radiusd_short_version);
2031                         break;
2032
2033                 default:
2034                         rad_assert(0 == 1);
2035                         break;
2036                 }
2037         }
2038                 break;
2039
2040         case XLAT_ATTRIBUTE:
2041                 XLAT_DEBUG("xlat_aprint ATTRIBUTE");
2042
2043                 /*
2044                  *      Some attributes are virtual <sigh>
2045                  */
2046                 str = xlat_getvp(ctx, request, &node->attr, escape ? false : true, true);
2047                 if (str) {
2048                         XLAT_DEBUG("EXPAND attr %s", node->attr.tmpl_da->name);
2049                         XLAT_DEBUG("       ---> %s", str);
2050                 }
2051                 break;
2052
2053         case XLAT_VIRTUAL:
2054                 XLAT_DEBUG("xlat_aprint VIRTUAL");
2055                 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
2056                 rcode = node->xlat->func(node->xlat->instance, request, NULL, str, 2048);
2057                 if (rcode < 0) {
2058                         talloc_free(str);
2059                         return NULL;
2060                 }
2061                 break;
2062
2063         case XLAT_MODULE:
2064                 XLAT_DEBUG("xlat_aprint MODULE");
2065                 if (xlat_process(&child, request, node->child, node->xlat->escape, node->xlat->instance) == 0) {
2066                         return NULL;
2067                 }
2068
2069                 XLAT_DEBUG("%.*sEXPAND mod %s %s", lvl, xlat_spaces, node->fmt, node->child->fmt);
2070                 XLAT_DEBUG("%.*s      ---> %s", lvl, xlat_spaces, child);
2071
2072                 /*
2073                  *      Smash \n --> CR.
2074                  *
2075                  *      The OUTPUT of xlat is a printable string.  The INPUT might not be...
2076                  *
2077                  *      This is really the reverse of fr_prints().
2078                  */
2079                 if (cf_new_escape && *child) {
2080                         ssize_t slen;
2081                         PW_TYPE type;
2082                         value_data_t data;
2083
2084                         type = PW_TYPE_STRING;
2085                         slen = value_data_from_str(request, &data, &type, NULL, child, talloc_array_length(child) - 1, '"');
2086                         rad_assert(slen > 0);
2087
2088                         talloc_free(child);
2089                         child = data.ptr;
2090
2091                 } else {
2092                         char *q;
2093
2094                         p = q = child;
2095                         while (*p) {
2096                                 if (*p == '\\') switch (p[1]) {
2097                                         default:
2098                                                 *(q++) = p[1];
2099                                                 p += 2;
2100                                                 continue;
2101
2102                                         case 'n':
2103                                                 *(q++) = '\n';
2104                                                 p += 2;
2105                                                 continue;
2106
2107                                         case 't':
2108                                                 *(q++) = '\t';
2109                                                 p += 2;
2110                                                 continue;
2111                                         }
2112
2113                                 *(q++) = *(p++);
2114                         }
2115                         *q = '\0';
2116                 }
2117
2118                 str = talloc_array(ctx, char, 2048); /* FIXME: have the module call talloc_typed_asprintf */
2119                 *str = '\0';    /* Be sure the string is NULL terminated, we now only free on error */
2120
2121                 rcode = node->xlat->func(node->xlat->instance, request, child, str, 2048);
2122                 talloc_free(child);
2123                 if (rcode < 0) {
2124                         talloc_free(str);
2125                         return NULL;
2126                 }
2127                 break;
2128
2129 #ifdef HAVE_REGEX
2130         case XLAT_REGEX:
2131                 XLAT_DEBUG("xlat_aprint REGEX");
2132                 child = request_data_reference(request, request,
2133                                                REQUEST_DATA_REGEX | node->attr.tmpl_num);
2134                 if (!child) return NULL;
2135
2136                 str = talloc_typed_strdup(ctx, child);
2137                 break;
2138 #endif
2139
2140         case XLAT_ALTERNATE:
2141                 XLAT_DEBUG("xlat_aprint ALTERNATE");
2142                 rad_assert(node->child != NULL);
2143                 rad_assert(node->alternate != NULL);
2144
2145                 str = xlat_aprint(ctx, request, node->child, escape, escape_ctx, lvl);
2146                 if (str) break;
2147
2148                 str = xlat_aprint(ctx, request, node->alternate, escape, escape_ctx, lvl);
2149                 break;
2150
2151         }
2152
2153         /*
2154          *      Escape the non-literals we found above.
2155          */
2156         if (str && escape) {
2157                 char *escaped;
2158
2159                 escaped = talloc_array(ctx, char, 2048); /* FIXME: do something intelligent */
2160                 escape(request, escaped, 2038, str, escape_ctx);
2161                 talloc_free(str);
2162                 str = escaped;
2163         }
2164
2165         return str;
2166 }
2167
2168
2169 static size_t xlat_process(char **out, REQUEST *request, xlat_exp_t const * const head,
2170                            RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2171 {
2172         int i, list;
2173         size_t total;
2174         char **array, *answer;
2175         xlat_exp_t const *node;
2176
2177         *out = NULL;
2178
2179         /*
2180          *      There are no nodes to process, so the result is a zero
2181          *      length string.
2182          */
2183         if (!head) {
2184                 *out = talloc_zero_array(request, char, 1);
2185                 return 0;
2186         }
2187
2188         /*
2189          *      Hack for speed.  If it's one expansion, just allocate
2190          *      that and return, instead of allocating an intermediary
2191          *      array.
2192          */
2193         if (!head->next) {
2194                 /*
2195                  *      Pass the MAIN escape function.  Recursive
2196                  *      calls will call node-specific escape
2197                  *      functions.
2198                  */
2199                 answer = xlat_aprint(request, request, head, escape, escape_ctx, 0);
2200                 if (!answer) {
2201                         *out = talloc_zero_array(request, char, 1);
2202                         return 0;
2203                 }
2204                 *out = answer;
2205                 return strlen(answer);
2206         }
2207
2208         list = 0;               /* FIXME: calculate this once */
2209         for (node = head; node != NULL; node = node->next) {
2210                 list++;
2211         }
2212
2213         array = talloc_array(request, char *, list);
2214         if (!array) return -1;
2215
2216         for (node = head, i = 0; node != NULL; node = node->next, i++) {
2217                 array[i] = xlat_aprint(array, request, node, escape, escape_ctx, 0); /* may be NULL */
2218         }
2219
2220         total = 0;
2221         for (i = 0; i < list; i++) {
2222                 if (array[i]) total += strlen(array[i]); /* FIXME: calculate strlen once */
2223         }
2224
2225         if (!total) {
2226                 talloc_free(array);
2227                 *out = talloc_zero_array(request, char, 1);
2228                 return 0;
2229         }
2230
2231         answer = talloc_array(request, char, total + 1);
2232
2233         total = 0;
2234         for (i = 0; i < list; i++) {
2235                 size_t len;
2236
2237                 if (array[i]) {
2238                         len = strlen(array[i]);
2239                         memcpy(answer + total, array[i], len);
2240                         total += len;
2241                 }
2242         }
2243         answer[total] = '\0';
2244         talloc_free(array);     /* and child entries */
2245
2246         *out = answer;
2247         return total;
2248 }
2249
2250
2251 /** Replace %whatever in a string.
2252  *
2253  * See 'doc/variables.txt' for more information.
2254  *
2255  * @param[out] out Where to write pointer to output buffer.
2256  * @param[in] outlen Size of out.
2257  * @param[in] request current request.
2258  * @param[in] node the xlat structure to expand
2259  * @param[in] escape function to escape final value e.g. SQL quoting.
2260  * @param[in] escape_ctx pointer to pass to escape function.
2261  * @return length of string written @bug should really have -1 for failure
2262  */
2263 static ssize_t xlat_expand_struct(char **out, size_t outlen, REQUEST *request, xlat_exp_t const *node,
2264                                   RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2265 {
2266         char *buff;
2267         ssize_t len;
2268
2269         rad_assert(node != NULL);
2270
2271         len = xlat_process(&buff, request, node, escape, escape_ctx);
2272         if ((len < 0) || !buff) {
2273                 rad_assert(buff == NULL);
2274                 if (*out) *out[0] = '\0';
2275                 return len;
2276         }
2277
2278         if (!*out) {
2279                 *out = buff;
2280         } else {
2281                 strlcpy(*out, buff, outlen);
2282                 talloc_free(buff);
2283         }
2284
2285         return strlen(*out);
2286 }
2287
2288 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2289                            RADIUS_ESCAPE_STRING escape, void *escape_ctx) CC_HINT(nonnull (1, 3, 4));
2290
2291 /** Replace %whatever in a string.
2292  *
2293  * See 'doc/variables.txt' for more information.
2294  *
2295  * @param[out] out Where to write pointer to output buffer.
2296  * @param[in] outlen Size of out.
2297  * @param[in] request current request.
2298  * @param[in] fmt string to expand.
2299  * @param[in] escape function to escape final value e.g. SQL quoting.
2300  * @param[in] escape_ctx pointer to pass to escape function.
2301  * @return length of string written @bug should really have -1 for failure
2302  */
2303 static ssize_t xlat_expand(char **out, size_t outlen, REQUEST *request, char const *fmt,
2304                            RADIUS_ESCAPE_STRING escape, void *escape_ctx)
2305 {
2306         ssize_t len;
2307         xlat_exp_t *node;
2308
2309         /*
2310          *      Give better errors than the old code.
2311          */
2312         len = xlat_tokenize_request(request, fmt, &node);
2313         if (len == 0) {
2314                 if (*out) {
2315                         *out[0] = '\0';
2316                 } else {
2317                         *out = talloc_zero_array(request, char, 1);
2318                 }
2319                 return 0;
2320         }
2321
2322         if (len < 0) {
2323                 if (*out) *out[0] = '\0';
2324                 return -1;
2325         }
2326
2327         len = xlat_expand_struct(out, outlen, request, node, escape, escape_ctx);
2328         talloc_free(node);
2329
2330         RDEBUG2("EXPAND %s", fmt);
2331         RDEBUG2("   --> %s", *out);
2332
2333         return len;
2334 }
2335
2336 /** Try to convert an xlat to a tmpl for efficiency
2337  *
2338  * @param ctx to allocate new value_pair_tmpl_t in.
2339  * @param node to convert.
2340  * @return NULL if unable to convert (not necessarily error), or a new value_pair_tmpl_t.
2341  */
2342 value_pair_tmpl_t *xlat_to_tmpl_attr(TALLOC_CTX *ctx, xlat_exp_t *node)
2343 {
2344         value_pair_tmpl_t *vpt;
2345
2346         if (node->next || (node->type != XLAT_ATTRIBUTE)) return NULL;
2347
2348         /*
2349          *   Concat means something completely different as an attribute reference
2350          *   Count isn't implemented.
2351          */
2352         if ((node->attr.tmpl_num == NUM_COUNT) || (node->attr.tmpl_num == NUM_ALL)) return NULL;
2353
2354         vpt = tmpl_alloc(ctx, TMPL_TYPE_ATTR, node->fmt, -1);
2355         if (!vpt) return NULL;
2356         memcpy(&vpt->data, &node->attr.data, sizeof(vpt->data));
2357
2358         VERIFY_TMPL(vpt);
2359
2360         return vpt;
2361 }
2362
2363 /** Try to convert attr tmpl to an xlat for &attr[*] and artificially constructing expansions
2364  *
2365  * @param ctx to allocate new xlat_expt_t in.
2366  * @param vpt to convert.
2367  * @return NULL if unable to convert (not necessarily error), or a new value_pair_tmpl_t.
2368  */
2369 xlat_exp_t *xlat_from_tmpl_attr(TALLOC_CTX *ctx, value_pair_tmpl_t *vpt)
2370 {
2371         xlat_exp_t *node;
2372
2373         if (vpt->type != TMPL_TYPE_ATTR) return NULL;
2374
2375         node = talloc_zero(ctx, xlat_exp_t);
2376         node->fmt = talloc_memdup(node, vpt->name, vpt->len);
2377         tmpl_init(&node->attr, TMPL_TYPE_ATTR, node->fmt, talloc_array_length(node->fmt) - 1);
2378         memcpy(&node->attr.data, &vpt->data, sizeof(vpt->data));
2379
2380         return node;
2381 }
2382
2383 ssize_t radius_xlat(char *out, size_t outlen, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2384 {
2385         return xlat_expand(&out, outlen, request, fmt, escape, ctx);
2386 }
2387
2388 ssize_t radius_axlat(char **out, REQUEST *request, char const *fmt, RADIUS_ESCAPE_STRING escape, void *ctx)
2389 {
2390         return xlat_expand(out, 0, request, fmt, escape, ctx);
2391 }
2392
2393 ssize_t radius_axlat_struct(char **out, REQUEST *request, xlat_exp_t const *xlat, RADIUS_ESCAPE_STRING escape, void *ctx)
2394 {
2395         return xlat_expand_struct(out, 0, request, xlat, escape, ctx);
2396 }