src/main/xlat.c

   1 /*
   2  * xlat.c       Translate strings.  This is the first version of xlat
   3  *              incorporated to RADIUS
   4  *
   5  * Version:     $Id$
   6  *
   7  *   This program is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License as published by
   9  *   the Free Software Foundation; either version 2 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This program is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with this program; if not, write to the Free Software
  19  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  *
  21  * Copyright 2000,2006  The FreeRADIUS server project
  22  * Copyright 2000  Alan DeKok <aland@ox.org>
  23  */
  24
  25 #include <freeradius-devel/ident.h>
  26 RCSID("$Id$")
  27
  28 #include        <freeradius-devel/radiusd.h>
  29 #include        <freeradius-devel/md5.h>
  30 #include        <freeradius-devel/rad_assert.h>
  31
  32 #include        <ctype.h>
  33
  34 typedef struct xlat_t {
  35         char            module[MAX_STRING_LEN];
  36         int             length;
  37         void            *instance;
  38         RAD_XLAT_FUNC   do_xlat;
  39         int             internal;       /* not allowed to re-define these */
  40 } xlat_t;
  41
  42 static rbtree_t *xlat_root = NULL;
  43
  44 /*
  45  *      Define all xlat's in the structure.
  46  */
  47 static const char * const internal_xlat[] = {"check",
  48                                              "request",
  49                                              "reply",
  50                                              "proxy-request",
  51                                              "proxy-reply",
  52                                              "outer.request",
  53                                              "outer.reply",
  54                                              NULL};
  55
  56 #if REQUEST_MAX_REGEX > 8
  57 #error Please fix the following line
  58 #endif
  59 static const int xlat_inst[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };   /* up to 8 for regex */
  60
  61
  62 /*
  63  *      Convert the value on a VALUE_PAIR to string
  64  */
  65 static int valuepair2str(char * out,int outlen,VALUE_PAIR * pair,
  66                          int type, RADIUS_ESCAPE_STRING func)
  67 {
  68         char buffer[MAX_STRING_LEN * 4];
  69
  70         if (pair != NULL) {
  71                 vp_prints_value(buffer, sizeof(buffer), pair, -1);
  72                 return func(out, outlen, buffer);
  73         }
  74
  75         switch (type) {
  76         case PW_TYPE_STRING :
  77                 strlcpy(out,"_",outlen);
  78                 break;
  79         case PW_TYPE_INTEGER :
  80                 strlcpy(out,"0",outlen);
  81                 break;
  82         case PW_TYPE_IPADDR :
  83                 strlcpy(out,"?.?.?.?",outlen);
  84                 break;
  85         case PW_TYPE_IPV6ADDR :
  86                 strlcpy(out,":?:",outlen);
  87                 break;
  88         case PW_TYPE_DATE :
  89                 strlcpy(out,"0",outlen);
  90                 break;
  91         default :
  92                 strlcpy(out,"unknown_type",outlen);
  93         }
  94         return strlen(out);
  95 }
  96
  97
  98 /*
  99  *      Dynamically translate for check:, request:, reply:, etc.
 100  */
 101 static size_t xlat_packet(void *instance, REQUEST *request,
 102                           char *fmt, char *out, size_t outlen,
 103                           RADIUS_ESCAPE_STRING func)
 104 {
 105         DICT_ATTR       *da;
 106         VALUE_PAIR      *vp;
 107         VALUE_PAIR      *vps = NULL;
 108         RADIUS_PACKET   *packet = NULL;
 109
 110         switch (*(int*) instance) {
 111         case 0:
 112                 vps = request->config_items;
 113                 break;
 114
 115         case 1:
 116                 vps = request->packet->vps;
 117                 packet = request->packet;
 118                 break;
 119
 120         case 2:
 121                 vps = request->reply->vps;
 122                 packet = request->reply;
 123                 break;
 124
 125         case 3:
 126 #ifdef WITH_PROXY
 127                 if (request->proxy) vps = request->proxy->vps;
 128                 packet = request->proxy;
 129 #endif
 130                 break;
 131
 132         case 4:
 133 #ifdef WITH_PROXY
 134                 if (request->proxy_reply) vps = request->proxy_reply->vps;
 135                 packet = request->proxy_reply;
 136 #endif
 137                 break;
 138
 139         case 5:
 140                 if (request->parent) {
 141                         vps = request->parent->packet->vps;
 142                         packet = request->parent->packet;
 143                 }
 144                 break;
 145
 146         case 6:
 147                 if (request->parent && request->parent->reply) {
 148                         vps = request->parent->reply->vps;
 149                         packet = request->parent->reply;
 150                 }
 151                 break;
 152
 153         default:                /* WTF? */
 154                 return 0;
 155         }
 156
 157         /*
 158          *      The "format" string is the attribute name.
 159          */
 160         da = dict_attrbyname(fmt);
 161         if (!da) {
 162                 int do_number = FALSE;
 163                 size_t count;
 164                 const char *p;
 165                 char buffer[256];
 166
 167                 if (strlen(fmt) > sizeof(buffer)) return 0;
 168
 169                 p = strchr(fmt, '[');
 170                 if (!p) {
 171                         p = strchr(fmt, '#');
 172                         if (!p) return 0;
 173                         do_number = TRUE;
 174                 }
 175
 176                 strlcpy(buffer, fmt, p - fmt + 1);
 177
 178                 da = dict_attrbyname(buffer);
 179                 if (!da) return 0;
 180
 181                 if (do_number) {
 182                         vp = pairfind(vps, da->attr, 0);
 183                         if (!vp) return 0;
 184
 185                         switch (da->type) {
 186                         default:
 187                                 break;
 188
 189                         case PW_TYPE_INTEGER:
 190                         case PW_TYPE_DATE:
 191                         case PW_TYPE_SHORT:
 192                         case PW_TYPE_BYTE:
 193                                 snprintf(out, outlen, "%u", vp->lvalue);
 194                                 return strlen(out);
 195                         }
 196
 197                         goto just_print;
 198                 }
 199
 200                 /*
 201                  *      %{Attribute-Name[#]} returns the count of
 202                  *      attributes of that name in the list.
 203                  */
 204                 if ((p[1] == '#') && (p[2] == ']')) {
 205                         count = 0;
 206
 207                         for (vp = pairfind(vps, da->attr, da->vendor);
 208                              vp != NULL;
 209                              vp = pairfind(vp->next, da->attr, da->vendor)) {
 210                                 count++;
 211                         }
 212                         snprintf(out, outlen, "%d", (int) count);
 213                         return strlen(out);
 214                 }
 215
 216                 /*
 217                  *      %{Attribute-Name[*]} returns ALL of the
 218                  *      the attributes, separated by a newline.
 219                  */
 220                 if ((p[1] == '*') && (p[2] == ']')) {
 221                         int total = 0;
 222
 223                         for (vp = pairfind(vps, da->attr, da->vendor);
 224                              vp != NULL;
 225                              vp = pairfind(vp->next, da->attr, da->vendor)) {
 226                                 count = valuepair2str(out, outlen - 1, vp, da->type, func);
 227                                 rad_assert(count <= outlen);
 228                                 total += count + 1;
 229                                 outlen -= (count + 1);
 230                                 out += count;
 231
 232                                 *(out++) = '\n';
 233
 234                                 if (outlen == 0) break;
 235                         }
 236
 237                         return total;
 238                 }
 239
 240                 count = atoi(p + 1);
 241
 242                 /*
 243                  *      Skip the numbers.
 244                  */
 245                 p += 1 + strspn(p + 1, "0123456789");
 246                 if (*p != ']') {
 247                         RDEBUG2("xlat: Invalid array reference in string at %s %s",
 248                                fmt, p);
 249                         return 0;
 250                 }
 251
 252                 /*
 253                  *      Find the N'th value.
 254                  */
 255                 for (vp = pairfind(vps, da->attr, da->vendor);
 256                      vp != NULL;
 257                      vp = pairfind(vp->next, da->attr, da->vendor)) {
 258                         if (count == 0) break;
 259                         count--;
 260                 }
 261
 262                 /*
 263                  *      Non-existent array reference.
 264                  */
 265                 if (!vp) return 0;
 266         just_print:
 267                 return valuepair2str(out, outlen, vp, da->type, func);
 268         }
 269
 270         vp = pairfind(vps, da->attr, da->vendor);
 271         if (!vp) {
 272                 /*
 273                  *      Some "magic" handlers, which are never in VP's, but
 274                  *      which are in the packet.
 275                  *
 276                  *      FIXME: We should really do this in a more
 277                  *      intelligent way...
 278                  */
 279                 if (packet) {
 280                         VALUE_PAIR localvp;
 281
 282                         memset(&localvp, 0, sizeof(localvp));
 283
 284                         switch (da->attr) {
 285                         case PW_PACKET_TYPE:
 286                         {
 287                                 DICT_VALUE *dval;
 288
 289                                 dval = dict_valbyattr(da->attr, da->vendor, packet->code);
 290                                 if (dval) {
 291                                         snprintf(out, outlen, "%s", dval->name);
 292                                 } else {
 293                                         snprintf(out, outlen, "%d", packet->code);
 294                                 }
 295                                 return strlen(out);
 296                         }
 297                         break;
 298
 299                         case PW_CLIENT_SHORTNAME:
 300                                 if (request->client && request->client->shortname) {
 301                                         strlcpy(out, request->client->shortname, outlen);
 302                                 } else {
 303                                         strlcpy(out, "<UNKNOWN-CLIENT>", outlen);
 304                                 }
 305                                 return strlen(out);
 306
 307                         case PW_CLIENT_IP_ADDRESS: /* the same as below */
 308                         case PW_PACKET_SRC_IP_ADDRESS:
 309                                 if (packet->src_ipaddr.af != AF_INET) {
 310                                         return 0;
 311                                 }
 312                                 localvp.attribute = da->attr;
 313                                 localvp.vp_ipaddr = packet->src_ipaddr.ipaddr.ip4addr.s_addr;
 314                                 break;
 315
 316                         case PW_PACKET_DST_IP_ADDRESS:
 317                                 if (packet->dst_ipaddr.af != AF_INET) {
 318                                         return 0;
 319                                 }
 320                                 localvp.attribute = da->attr;
 321                                 localvp.vp_ipaddr = packet->dst_ipaddr.ipaddr.ip4addr.s_addr;
 322                                 break;
 323
 324                         case PW_PACKET_SRC_PORT:
 325                                 localvp.attribute = da->attr;
 326                                 localvp.vp_integer = packet->src_port;
 327                                 break;
 328
 329                         case PW_PACKET_DST_PORT:
 330                                 localvp.attribute = da->attr;
 331                                 localvp.vp_integer = packet->dst_port;
 332                                 break;
 333
 334                         case PW_PACKET_AUTHENTICATION_VECTOR:
 335                                 localvp.attribute = da->attr;
 336                                 memcpy(localvp.vp_strvalue, packet->vector,
 337                                        sizeof(packet->vector));
 338                                 localvp.length = sizeof(packet->vector);
 339                                 break;
 340
 341                                 /*
 342                                  *      Authorization, accounting, etc.
 343                                  */
 344                         case PW_REQUEST_PROCESSING_STAGE:
 345                                 if (request->component) {
 346                                         strlcpy(out, request->component, outlen);
 347                                 } else {
 348                                         strlcpy(out, "server_core", outlen);
 349                                 }
 350                                 return strlen(out);
 351
 352                         case PW_PACKET_SRC_IPV6_ADDRESS:
 353                                 if (packet->src_ipaddr.af != AF_INET6) {
 354                                         return 0;
 355                                 }
 356                                 localvp.attribute = da->attr;
 357                                 memcpy(localvp.vp_strvalue,
 358                                        &packet->src_ipaddr.ipaddr.ip6addr,
 359                                        sizeof(packet->src_ipaddr.ipaddr.ip6addr));
 360                                 break;
 361
 362                         case PW_PACKET_DST_IPV6_ADDRESS:
 363                                 if (packet->dst_ipaddr.af != AF_INET6) {
 364                                         return 0;
 365                                 }
 366                                 localvp.attribute = da->attr;
 367                                 memcpy(localvp.vp_strvalue,
 368                                        &packet->dst_ipaddr.ipaddr.ip6addr,
 369                                        sizeof(packet->dst_ipaddr.ipaddr.ip6addr));
 370                                 break;
 371
 372                         case PW_VIRTUAL_SERVER:
 373                                 if (!request->server) return 0;
 374
 375                                 snprintf(out, outlen, "%s", request->server);
 376                                 return strlen(out);
 377                                 break;
 378
 379                         case PW_MODULE_RETURN_CODE:
 380                                 localvp.attribute = da->attr;
 381
 382                                 /*
 383                                  *      See modcall.c for a bit of a hack.
 384                                  */
 385                                 localvp.vp_integer = request->simul_max;
 386                                 break;
 387
 388                         default:
 389                                 return 0; /* not found */
 390                                 break;
 391                         }
 392
 393                         localvp.type = da->type;
 394                         return valuepair2str(out, outlen, &localvp,
 395                                              da->type, func);
 396                 }
 397
 398                 /*
 399                  *      Not found, die.
 400                  */
 401                 return 0;
 402         }
 403
 404         if (!vps) return 0;     /* silently fail */
 405
 406         /*
 407          *      Convert the VP to a string, and return it.
 408          */
 409         return valuepair2str(out, outlen, vp, da->type, func);
 410 }
 411
 412 #ifdef HAVE_REGEX_H
 413 /*
 414  *      Pull %{0} to %{8} out of the packet.
 415  */
 416 static size_t xlat_regex(void *instance, REQUEST *request,
 417                          char *fmt, char *out, size_t outlen,
 418                          RADIUS_ESCAPE_STRING func)
 419 {
 420         char *regex;
 421
 422         /*
 423          *      We cheat: fmt is "0" to "8", but those numbers
 424          *      are already in the "instance".
 425          */
 426         fmt = fmt;              /* -Wunused */
 427         func = func;            /* -Wunused FIXME: do escaping? */
 428
 429         regex = request_data_reference(request, request,
 430                                  REQUEST_DATA_REGEX | *(int *)instance);
 431         if (!regex) return 0;
 432
 433         /*
 434          *      Copy UP TO "freespace" bytes, including
 435          *      a zero byte.
 436          */
 437         strlcpy(out, regex, outlen);
 438         return strlen(out);
 439 }
 440 #endif                          /* HAVE_REGEX_H */
 441
 442
 443 /*
 444  *      Change the debugging level.
 445  */
 446 static size_t xlat_debug(UNUSED void *instance, REQUEST *request,
 447                           char *fmt, char *out, size_t outlen,
 448                           UNUSED RADIUS_ESCAPE_STRING func)
 449 {
 450         int level = 0;
 451
 452         if (*fmt) level = atoi(fmt);
 453
 454         if (level == 0) {
 455                 request->options = RAD_REQUEST_OPTION_NONE;
 456                 request->radlog = NULL;
 457         } else {
 458                 if (level > 4) level = 4;
 459
 460                 request->options = level;
 461                 request->radlog = radlog_request;
 462         }
 463
 464         snprintf(out, outlen, "%d", level);
 465         return strlen(out);
 466 }
 467
 468
 469 /*
 470  *      Calculate the MD5 hash of a string.
 471  */
 472 static size_t xlat_md5(UNUSED void *instance, REQUEST *request,
 473                        char *fmt, char *out, size_t outlen,
 474                        UNUSED RADIUS_ESCAPE_STRING func)
 475 {
 476         int i;
 477         uint8_t digest[16];
 478         FR_MD5_CTX ctx;
 479         char buffer[1024];
 480
 481         if (!radius_xlat(buffer, sizeof(buffer), fmt, request, func)) {
 482                 *out = '\0';
 483                 return 0;
 484         }
 485
 486         fr_MD5Init(&ctx);
 487         fr_MD5Update(&ctx, (void *) buffer, strlen(buffer));
 488         fr_MD5Final(digest, &ctx);
 489
 490         if (outlen < 33) {
 491                 snprintf(out, outlen, "md5_overflow");
 492                 return strlen(out);
 493         }
 494
 495         for (i = 0; i < 16; i++) {
 496                 snprintf(out + i * 2, 3, "%02x", digest[i]);
 497         }
 498
 499         return strlen(out);
 500 }
 501
 502
 503 /*
 504  *      Convert a string to lowercase
 505  */
 506 static size_t xlat_lc(UNUSED void *instance, REQUEST *request,
 507                        char *fmt, char *out, size_t outlen,
 508                        UNUSED RADIUS_ESCAPE_STRING func)
 509 {
 510         char *p, *q;
 511         char buffer[1024];
 512
 513         if (!radius_xlat(buffer, sizeof(buffer), fmt, request, func)) {
 514                 *out = '\0';
 515                 return 0;
 516         }
 517
 518         for (p = buffer, q = out; *p != '\0'; p++, outlen--) {
 519                 if (outlen <= 1) break;
 520
 521                 *(q++) = tolower((int) *p);
 522         }
 523
 524         *q = '\0';
 525
 526         return strlen(out);
 527 }
 528
 529
 530
 531 /*
 532  *      Compare two xlat_t structs, based ONLY on the module name.
 533  */
 534 static int xlat_cmp(const void *a, const void *b)
 535 {
 536         if (((const xlat_t *)a)->length != ((const xlat_t *)b)->length) {
 537                 return ((const xlat_t *)a)->length - ((const xlat_t *)b)->length;
 538         }
 539
 540         return memcmp(((const xlat_t *)a)->module,
 541                       ((const xlat_t *)b)->module,
 542                       ((const xlat_t *)a)->length);
 543 }
 544
 545 /*
 546  *      find the appropriate registered xlat function.
 547  */
 548 static xlat_t *xlat_find(const char *module)
 549 {
 550         xlat_t my_xlat;
 551
 552         /*
 553          *      Look for dictionary attributes first.
 554          */
 555         if ((dict_attrbyname(module) != NULL) ||
 556             (strchr(module, '[') != NULL) ||
 557             (strchr(module, '#') != NULL)) {
 558                 module = "request";
 559         }
 560
 561         strlcpy(my_xlat.module, module, sizeof(my_xlat.module));
 562         my_xlat.length = strlen(my_xlat.module);
 563
 564         return rbtree_finddata(xlat_root, &my_xlat);
 565 }
 566
 567
 568 /*
 569  *      Register an xlat function.
 570  */
 571 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance)
 572 {
 573         xlat_t  *c;
 574         xlat_t  my_xlat;
 575
 576         if ((module == NULL) || (strlen(module) == 0)) {
 577                 DEBUG("xlat_register: Invalid module name");
 578                 return -1;
 579         }
 580
 581         /*
 582          *      First time around, build up the tree...
 583          *
 584          *      FIXME: This code should be hoisted out of this function,
 585          *      and into a global "initialization".  But it isn't critical...
 586          */
 587         if (!xlat_root) {
 588                 int i;
 589 #ifdef HAVE_REGEX_H
 590                 char buffer[2];
 591 #endif
 592
 593                 xlat_root = rbtree_create(xlat_cmp, free, 0);
 594                 if (!xlat_root) {
 595                         DEBUG("xlat_register: Failed to create tree.");
 596                         return -1;
 597                 }
 598
 599                 /*
 600                  *      Register the internal packet xlat's.
 601                  */
 602                 for (i = 0; internal_xlat[i] != NULL; i++) {
 603                         xlat_register(internal_xlat[i], xlat_packet, &xlat_inst[i]);
 604                         c = xlat_find(internal_xlat[i]);
 605                         rad_assert(c != NULL);
 606                         c->internal = TRUE;
 607                 }
 608
 609                 /*
 610                  *      New name: "control"
 611                  */
 612                 xlat_register("control", xlat_packet, &xlat_inst[0]);
 613                 c = xlat_find("control");
 614                 rad_assert(c != NULL);
 615                 c->internal = TRUE;
 616
 617 #ifdef HAVE_REGEX_H
 618                 /*
 619                  *      Register xlat's for regexes.
 620                  */
 621                 buffer[1] = '\0';
 622                 for (i = 0; i <= REQUEST_MAX_REGEX; i++) {
 623                         buffer[0] = '0' + i;
 624                         xlat_register(buffer, xlat_regex, &xlat_inst[i]);
 625                         c = xlat_find(buffer);
 626                         rad_assert(c != NULL);
 627                         c->internal = TRUE;
 628                 }
 629 #endif /* HAVE_REGEX_H */
 630
 631
 632                 xlat_register("debug", xlat_debug, &xlat_inst[0]);
 633                 c = xlat_find("debug");
 634                 rad_assert(c != NULL);
 635                 c->internal = TRUE;
 636
 637                 xlat_register("md5", xlat_md5, &xlat_inst[0]);
 638                 c = xlat_find("md5");
 639                 rad_assert(c != NULL);
 640                 c->internal = TRUE;
 641
 642                 xlat_register("tolower", xlat_lc, &xlat_inst[0]);
 643                 c = xlat_find("tolower");
 644                 rad_assert(c != NULL);
 645                 c->internal = TRUE;
 646         }
 647
 648         /*
 649          *      If it already exists, replace the instance.
 650          */
 651         strlcpy(my_xlat.module, module, sizeof(my_xlat.module));
 652         my_xlat.length = strlen(my_xlat.module);
 653         c = rbtree_finddata(xlat_root, &my_xlat);
 654         if (c) {
 655                 if (c->internal) {
 656                         DEBUG("xlat_register: Cannot re-define internal xlat");
 657                         return -1;
 658                 }
 659
 660                 c->do_xlat = func;
 661                 c->instance = instance;
 662                 return 0;
 663         }
 664
 665         /*
 666          *      Doesn't exist.  Create it.
 667          */
 668         c = rad_malloc(sizeof(*c));
 669         memset(c, 0, sizeof(*c));
 670
 671         c->do_xlat = func;
 672         strlcpy(c->module, module, sizeof(c->module));
 673         c->length = strlen(c->module);
 674         c->instance = instance;
 675
 676         rbtree_insert(xlat_root, c);
 677
 678         return 0;
 679 }
 680
 681 /*
 682  *      Unregister an xlat function.
 683  *
 684  *      We can only have one function to call per name, so the
 685  *      passing of "func" here is extraneous.
 686  */
 687 void xlat_unregister(const char *module, RAD_XLAT_FUNC func)
 688 {
 689         rbnode_t        *node;
 690         xlat_t          my_xlat;
 691
 692         func = func;            /* -Wunused */
 693
 694         if (!module) return;
 695
 696         strlcpy(my_xlat.module, module, sizeof(my_xlat.module));
 697         my_xlat.length = strlen(my_xlat.module);
 698
 699         node = rbtree_find(xlat_root, &my_xlat);
 700         if (!node) return;
 701
 702         rbtree_delete(xlat_root, node);
 703 }
 704
 705 /*
 706  *      De-register all xlat functions,
 707  *      used mainly for debugging.
 708  */
 709 void xlat_free(void)
 710 {
 711         rbtree_free(xlat_root);
 712 }
 713
 714
 715 /*
 716  *      Decode an attribute name into a string.
 717  */
 718 static int decode_attribute(const char **from, char **to, int freespace,
 719                              REQUEST *request,
 720                              RADIUS_ESCAPE_STRING func)
 721 {
 722         int     do_length = 0;
 723         char    *xlat_name, *xlat_string;
 724         char *p, *q, *l, *next = NULL;
 725         int retlen=0;
 726         const xlat_t *c;
 727         int varlen;
 728         char buffer[8192];
 729
 730         q = *to;
 731
 732         *q = '\0';
 733
 734         /*
 735          *      Copy the input string to an intermediate buffer where
 736          *      we can mangle it.
 737          */
 738         varlen = rad_copy_variable(buffer, *from);
 739         if (varlen < 0) {
 740                 RDEBUG2("Badly formatted variable: %s", *from);
 741                 return -1;
 742         }
 743         *from += varlen;
 744
 745         /*
 746          *      Kill the %{} around the data we are looking for.
 747          */
 748         p = buffer;
 749         p[varlen - 1] = '\0';   /*  */
 750         p += 2;
 751         if (*p == '#') {
 752                 p++;
 753                 do_length = 1;
 754         }
 755
 756         /*
 757          *      Handle %{%{foo}:-%{bar}}, which is useful, too.
 758          *
 759          *      Did I mention that this parser is garbage?
 760          */
 761         if ((p[0] == '%') && (p[1] == '{')) {
 762                 int len1, len2;
 763                 int expand2 = FALSE;
 764
 765                 /*
 766                  *      'p' is after the start of 'buffer', so we can
 767                  *      safely do this.
 768                  */
 769                 len1 = rad_copy_variable(buffer, p);
 770                 if (len1 < 0) {
 771                         RDEBUG2("Badly formatted variable: %s", p);
 772                         return -1;
 773                 }
 774
 775                 /*
 776                  *      They did %{%{foo}}, which is stupid, but allowed.
 777                  */
 778                 if (!p[len1]) {
 779                         RDEBUG2("Improperly nested variable; %%{%s}", p);
 780                         return -1;
 781                 }
 782
 783                 /*
 784                  *      It SHOULD be %{%{foo}:-%{bar}}.  If not, it's
 785                  *      an error.
 786                  */
 787                 if ((p[len1] != ':') || (p[len1 + 1] != '-')) {
 788                         RDEBUG2("No trailing :- after variable at %s", p);
 789                         return -1;
 790                 }
 791
 792                 /*
 793                  *      Parse the second bit.  The second bit can be
 794                  *      either %{foo}, or a string "foo", or a string
 795                  *      'foo', or just a bare word: foo
 796                  */
 797                 p += len1 + 2;
 798                 l = buffer + len1 + 1;
 799
 800                 if ((p[0] == '%') && (p[1] == '{')) {
 801                         len2 = rad_copy_variable(l, p);
 802
 803                         if (len2 < 0) {
 804                                 RDEBUG2("Invalid text after :- at %s", p);
 805                                 return -1;
 806                         }
 807                         p += len2;
 808                         expand2 = TRUE;
 809
 810                 } else if ((p[0] == '"') || p[0] == '\'') {
 811                         getstring(&p, l, strlen(l));
 812
 813                 } else {
 814                         l = p;
 815                 }
 816
 817                 /*
 818                  *      Expand the first one.  If we did, exit the
 819                  *      conditional.
 820                  */
 821                 retlen = radius_xlat(q, freespace, buffer, request, func);
 822                 if (retlen) {
 823                         q += retlen;
 824                         goto done;
 825                 }
 826
 827                 RDEBUG2("\t... expanding second conditional");
 828                 /*
 829                  *      Expand / copy the second string if required.
 830                  */
 831                 if (expand2) {
 832                         retlen = radius_xlat(q, freespace, l,
 833                                             request, func);
 834                         if (retlen) {
 835                                 q += retlen;
 836                         }
 837                 } else {
 838                         strlcpy(q, l, freespace);
 839                         q += strlen(q);
 840                 }
 841
 842                 /*
 843                  *      Else the output is an empty string.
 844                  */
 845                 goto done;
 846         }
 847
 848         /*
 849          *      See if we're supposed to expand a module name.
 850          */
 851         xlat_name = NULL;
 852         for (l = p; *l != '\0'; l++) {
 853                 if (*l == '\\') {
 854                         l++;
 855                         continue;
 856                 }
 857
 858                 if (*l == ':') {
 859                         xlat_name = p; /* start of name */
 860                         *l = '\0';
 861                         p = l + 1;
 862                         break;
 863                 }
 864
 865                 /*
 866                  *      Module names can't have spaces.
 867                  */
 868                 if ((*l == ' ') || (*l == '\t')) break;
 869         }
 870
 871         /*
 872          *      %{name} is a simple attribute reference,
 873          *      or regex reference.
 874          */
 875         if (!xlat_name) {
 876                 xlat_name = xlat_string = p;
 877                 goto do_xlat;
 878         }
 879
 880         /*
 881          *      Maybe it's the old-style %{foo:-bar}
 882          */
 883         if (*p == '-') {
 884                 RDEBUG2("WARNING: Deprecated conditional expansion \":-\".  See \"man unlang\" for details");
 885                 p++;
 886
 887                 xlat_string = xlat_name;
 888                 next = p;
 889                 goto do_xlat;
 890         }
 891
 892         /*
 893          *      FIXME: For backwards "WTF" compatibility, check for
 894          *      {...}, (after the :), and copy that, too.
 895          */
 896
 897         /* module name, followed by (possibly) per-module string */
 898         xlat_string = p;
 899
 900 do_xlat:
 901         if ((c = xlat_find(xlat_name)) != NULL) {
 902                 if (!c->internal) RDEBUG3("radius_xlat: Running registered xlat function of module %s for string \'%s\'",
 903                                           c->module, xlat_string);
 904                 retlen = c->do_xlat(c->instance, request, xlat_string,
 905                                     q, freespace, func);
 906                 if (retlen > 0) {
 907                         if (do_length) {
 908                                 snprintf(q, freespace, "%d", retlen);
 909                                 retlen = strlen(q);
 910                         }
 911
 912                 } else if (next) {
 913                         /*
 914                          *      Expand the second bit.
 915                          */
 916                         RDEBUG2("\t... expanding second conditional");
 917                         retlen = radius_xlat(q, freespace, next, request, func);
 918                 }
 919                 q += retlen;
 920
 921         } else {
 922                 /*
 923                  *      No attribute by that name, return an error.
 924                  */
 925                 RDEBUG2("WARNING: Unknown module \"%s\" in string expansion \"%%%s\"", xlat_name, *from);
 926                 return -1;
 927         }
 928
 929 done:
 930         *to = q;
 931         return 0;
 932 }
 933
 934 /*
 935  *  If the caller doesn't pass xlat an escape function, then
 936  *  we use this one.  It simplifies the coding, as the check for
 937  *  func == NULL only happens once.
 938  */
 939 static size_t xlat_copy(char *out, size_t outlen, const char *in)
 940 {
 941         int freespace = outlen;
 942
 943         rad_assert(outlen > 0);
 944
 945         while ((*in) && (freespace > 1)) {
 946                 /*
 947                  *  Copy data.
 948                  *
 949                  *  FIXME: Do escaping of bad stuff!
 950                  */
 951                 *(out++) = *(in++);
 952
 953                 freespace--;
 954         }
 955         *out = '\0';
 956
 957         return (outlen - freespace); /* count does not include NUL */
 958 }
 959
 960 /*
 961  *      Replace %<whatever> in a string.
 962  *
 963  *      See 'doc/variables.txt' for more information.
 964  */
 965 int radius_xlat(char *out, int outlen, const char *fmt,
 966                 REQUEST *request, RADIUS_ESCAPE_STRING func)
 967 {
 968         int c, len, freespace;
 969         const char *p;
 970         char *q;
 971         char *nl;
 972         VALUE_PAIR *tmp;
 973         struct tm *TM, s_TM;
 974         char tmpdt[40]; /* For temporary storing of dates */
 975         int openbraces=0;
 976
 977         /*
 978          *      Catch bad modules.
 979          */
 980         if (!fmt || !out || !request) return 0;
 981
 982         /*
 983          *  Ensure that we always have an escaping function.
 984          */
 985         if (func == NULL) {
 986                 func = xlat_copy;
 987         }
 988
 989         q = out;
 990         p = fmt;
 991         while (*p) {
 992                 /* Calculate freespace in output */
 993                 freespace = outlen - (q - out);
 994                 if (freespace <= 1)
 995                         break;
 996                 c = *p;
 997
 998                 if ((c != '%') && (c != '$') && (c != '\\')) {
 999                         /*
1000                          * We check if we're inside an open brace.  If we are
1001                          * then we assume this brace is NOT literal, but is
1002                          * a closing brace and apply it
1003                          */
1004                         if ((c == '}') && openbraces) {
1005                                 openbraces--;
1006                                 p++; /* skip it */
1007                                 continue;
1008                         }
1009                         *q++ = *p++;
1010                         continue;
1011                 }
1012
1013                 /*
1014                  *      There's nothing after this character, copy
1015                  *      the last '%' or "$' or '\\' over to the output
1016                  *      buffer, and exit.
1017                  */
1018                 if (*++p == '\0') {
1019                         *q++ = c;
1020                         break;
1021                 }
1022
1023                 if (c == '\\') {
1024                         switch(*p) {
1025                         case '\\':
1026                                 *q++ = *p;
1027                                 break;
1028                         case 't':
1029                                 *q++ = '\t';
1030                                 break;
1031                         case 'n':
1032                                 *q++ = '\n';
1033                                 break;
1034                         default:
1035                                 *q++ = c;
1036                                 *q++ = *p;
1037                                 break;
1038                         }
1039                         p++;
1040
1041                 } else if (c == '%') switch(*p) {
1042                         case '{':
1043                                 p--;
1044                                 if (decode_attribute(&p, &q, freespace, request, func) < 0) return 0;
1045                                 break;
1046
1047                         case '%':
1048                                 *q++ = *p++;
1049                                 break;
1050                         case 'a': /* Protocol: */
1051                                 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_PROTOCOL, 0),PW_TYPE_INTEGER, func);
1052                                 p++;
1053                                 break;
1054                         case 'c': /* Callback-Number */
1055                                 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_CALLBACK_NUMBER, 0),PW_TYPE_STRING, func);
1056                                 p++;
1057                                 break;
1058                         case 'd': /* request day */
1059                                 TM = localtime_r(&request->timestamp, &s_TM);
1060                                 len = strftime(tmpdt, sizeof(tmpdt), "%d", TM);
1061                                 if (len > 0) {
1062                                         strlcpy(q, tmpdt, freespace);
1063                                         q += strlen(q);
1064                                 }
1065                                 p++;
1066                                 break;
1067                         case 'f': /* Framed IP address */
1068                                 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_IP_ADDRESS, 0),PW_TYPE_IPADDR, func);
1069                                 p++;
1070                                 break;
1071                         case 'i': /* Calling station ID */
1072                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CALLING_STATION_ID, 0),PW_TYPE_STRING, func);
1073                                 p++;
1074                                 break;
1075                         case 'l': /* request timestamp */
1076                                 snprintf(tmpdt, sizeof(tmpdt), "%lu",
1077                                          (unsigned long) request->timestamp);
1078                                 strlcpy(q,tmpdt,freespace);
1079                                 q += strlen(q);
1080                                 p++;
1081                                 break;
1082                         case 'm': /* request month */
1083                                 TM = localtime_r(&request->timestamp, &s_TM);
1084                                 len = strftime(tmpdt, sizeof(tmpdt), "%m", TM);
1085                                 if (len > 0) {
1086                                         strlcpy(q, tmpdt, freespace);
1087                                         q += strlen(q);
1088                                 }
1089                                 p++;
1090                                 break;
1091                         case 'n': /* NAS IP address */
1092                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_IP_ADDRESS, 0),PW_TYPE_IPADDR, func);
1093                                 p++;
1094                                 break;
1095                         case 'p': /* Port number */
1096                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_PORT, 0),PW_TYPE_INTEGER, func);
1097                                 p++;
1098                                 break;
1099                         case 's': /* Speed */
1100                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CONNECT_INFO, 0),PW_TYPE_STRING, func);
1101                                 p++;
1102                                 break;
1103                         case 't': /* request timestamp */
1104                                 CTIME_R(&request->timestamp, tmpdt, sizeof(tmpdt));
1105                                 nl = strchr(tmpdt, '\n');
1106                                 if (nl) *nl = '\0';
1107                                 strlcpy(q, tmpdt, freespace);
1108                                 q += strlen(q);
1109                                 p++;
1110                                 break;
1111                         case 'u': /* User name */
1112                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_USER_NAME, 0),PW_TYPE_STRING, func);
1113                                 p++;
1114                                 break;
1115                         case 'A': /* radacct_dir */
1116                                 strlcpy(q,radacct_dir,freespace);
1117                                 q += strlen(q);
1118                                 p++;
1119                                 break;
1120                         case 'C': /* ClientName */
1121                                 strlcpy(q,request->client->shortname,freespace);
1122                                 q += strlen(q);
1123                                 p++;
1124                                 break;
1125                         case 'D': /* request date */
1126                                 TM = localtime_r(&request->timestamp, &s_TM);
1127                                 len = strftime(tmpdt, sizeof(tmpdt), "%Y%m%d", TM);
1128                                 if (len > 0) {
1129                                         strlcpy(q, tmpdt, freespace);
1130                                         q += strlen(q);
1131                                 }
1132                                 p++;
1133                                 break;
1134                         case 'H': /* request hour */
1135                                 TM = localtime_r(&request->timestamp, &s_TM);
1136                                 len = strftime(tmpdt, sizeof(tmpdt), "%H", TM);
1137                                 if (len > 0) {
1138                                         strlcpy(q, tmpdt, freespace);
1139                                         q += strlen(q);
1140                                 }
1141                                 p++;
1142                                 break;
1143                         case 'L': /* radlog_dir */
1144                                 strlcpy(q,radlog_dir,freespace);
1145                                 q += strlen(q);
1146                                 p++;
1147                                 break;
1148                         case 'M': /* MTU */
1149                                 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_MTU, 0),PW_TYPE_INTEGER, func);
1150                                 p++;
1151                                 break;
1152                         case 'R': /* radius_dir */
1153                                 strlcpy(q,radius_dir,freespace);
1154                                 q += strlen(q);
1155                                 p++;
1156                                 break;
1157                         case 'S': /* request timestamp in SQL format*/
1158                                 TM = localtime_r(&request->timestamp, &s_TM);
1159                                 len = strftime(tmpdt, sizeof(tmpdt), "%Y-%m-%d %H:%M:%S", TM);
1160                                 if (len > 0) {
1161                                         strlcpy(q, tmpdt, freespace);
1162                                         q += strlen(q);
1163                                 }
1164                                 p++;
1165                                 break;
1166                         case 'T': /* request timestamp */
1167                                 TM = localtime_r(&request->timestamp, &s_TM);
1168                                 len = strftime(tmpdt, sizeof(tmpdt), "%Y-%m-%d-%H.%M.%S.000000", TM);
1169                                 if (len > 0) {
1170                                         strlcpy(q, tmpdt, freespace);
1171                                         q += strlen(q);
1172                                 }
1173                                 p++;
1174                                 break;
1175                         case 'U': /* Stripped User name */
1176                                 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_STRIPPED_USER_NAME, 0),PW_TYPE_STRING, func);
1177                                 p++;
1178                                 break;
1179                         case 'V': /* Request-Authenticator */
1180                                 strlcpy(q,"Verified",freespace);
1181                                 q += strlen(q);
1182                                 p++;
1183                                 break;
1184                         case 'Y': /* request year */
1185                                 TM = localtime_r(&request->timestamp, &s_TM);
1186                                 len = strftime(tmpdt, sizeof(tmpdt), "%Y", TM);
1187                                 if (len > 0) {
1188                                         strlcpy(q, tmpdt, freespace);
1189                                         q += strlen(q);
1190                                 }
1191                                 p++;
1192                                 break;
1193                         case 'Z': /* Full request pairs except password */
1194                                 tmp = request->packet->vps;
1195                                 while (tmp && (freespace > 3)) {
1196                                         if (tmp->attribute != PW_USER_PASSWORD) {
1197                                                 *q++ = '\t';
1198                                                 len = vp_prints(q, freespace - 2, tmp);
1199                                                 q += len;
1200                                                 freespace -= (len + 2);
1201                                                 *q++ = '\n';
1202                                         }
1203                                         tmp = tmp->next;
1204                                 }
1205                                 p++;
1206                                 break;
1207                         default:
1208                                 RDEBUG2("WARNING: Unknown variable '%%%c': See 'doc/variables.txt'", *p);
1209                                 if (freespace > 2) {
1210                                         *q++ = '%';
1211                                         *q++ = *p++;
1212                                 }
1213                                 break;
1214                 }
1215         }
1216         *q = '\0';
1217
1218         RDEBUG2("\texpand: %s -> %s", fmt, out);
1219
1220         return strlen(out);
1221 }