2 * xlat.c Translate strings. This is the first version of xlat
3 * incorporated to RADIUS
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * Copyright 2000 The FreeRADIUS server project
22 * Copyright 2000 Alan DeKok <aland@ox.org>
25 static const char rcsid[] =
29 #include "libradius.h"
38 #include "rad_assert.h"
40 typedef struct xlat_t {
41 char module[MAX_STRING_LEN];
44 RAD_XLAT_FUNC do_xlat;
45 int internal; /* not allowed to re-define these */
48 static rbtree_t *xlat_root = NULL;
51 * Define all xlat's in the structure.
53 static const char *internal_xlat[] = {"check",
60 #if REQUEST_MAX_REGEX > 8
61 #error Please fix the following line
63 static int xlat_inst[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; /* up to 8 for regex */
67 * Convert the value on a VALUE_PAIR to string
69 static int valuepair2str(char * out,int outlen,VALUE_PAIR * pair,
70 int type, RADIUS_ESCAPE_STRING func)
72 char buffer[MAX_STRING_LEN * 4];
75 vp_prints_value(buffer, sizeof(buffer), pair, -1);
76 return func(out, outlen, buffer);
81 strNcpy(out,"_",outlen);
83 case PW_TYPE_INTEGER :
84 strNcpy(out,"0",outlen);
87 strNcpy(out,"?.?.?.?",outlen);
90 strNcpy(out,"0",outlen);
93 strNcpy(out,"unknown_type",outlen);
100 * Dynamically translate for check:, request:, reply:, etc.
102 static int xlat_packet(void *instance, REQUEST *request,
103 char *fmt, char *out, size_t outlen,
104 RADIUS_ESCAPE_STRING func)
108 VALUE_PAIR *vps = NULL;
109 RADIUS_PACKET *packet = NULL;
111 switch (*(int*) instance) {
113 vps = request->config_items;
117 vps = request->packet->vps;
118 packet = request->packet;
122 vps = request->reply->vps;
123 packet = request->reply;
127 if (request->proxy) vps = request->proxy->vps;
128 packet = request->proxy;
132 if (request->proxy_reply) vps = request->proxy_reply->vps;
133 packet = request->proxy_reply;
141 * The "format" string is the attribute name.
143 da = dict_attrbyname(fmt);
146 const char *p = strchr(fmt, '[');
150 if (strlen(fmt) > sizeof(buffer)) return 0;
152 strNcpy(buffer, fmt, p - fmt + 1);
154 da = dict_attrbyname(buffer);
158 * %{Attribute-Name[#]} returns the count of
159 * attributes of that name in the list.
161 if ((p[1] == '#') && (p[2] == ']')) {
164 for (vp = pairfind(vps, da->attr);
166 vp = pairfind(vp->next, da->attr)) {
169 snprintf(out, outlen, "%d", index);
174 * %{Attribute-Name[*]} returns ALL of the
175 * the attributes, separated by a newline.
177 if ((p[1] == '*') && (p[2] == ']')) {
180 for (vp = pairfind(vps, da->attr);
182 vp = pairfind(vp->next, da->attr)) {
183 index = valuepair2str(out, outlen - 1, vp, da->type, func);
184 rad_assert(index <= outlen);
186 outlen -= (index + 1);
191 if (outlen == 0) break;
202 p += 1 + strspn(p + 1, "0123456789");
204 DEBUG2("xlat: Invalid array reference in string at %s %s",
210 * Find the N'th value.
212 for (vp = pairfind(vps, da->attr);
214 vp = pairfind(vp->next, da->attr)) {
215 if (index == 0) break;
220 * Non-existent array reference.
224 return valuepair2str(out, outlen, vp, da->type, func);
227 vp = pairfind(vps, da->attr);
230 * Some "magic" handlers, which are never in VP's, but
231 * which are in the packet.
236 localvp.strvalue[0] = 0;
243 dval = dict_valbyattr(da->attr, packet->code);
245 snprintf(out, outlen, "%s", dval->name);
247 snprintf(out, outlen, "%d", packet->code);
253 case PW_PACKET_SRC_IP_ADDRESS:
254 localvp.attribute = da->attr;
255 localvp.lvalue = packet->src_ipaddr;
258 case PW_PACKET_DST_IP_ADDRESS:
259 localvp.attribute = da->attr;
260 localvp.lvalue = packet->dst_ipaddr;
263 case PW_PACKET_SRC_PORT:
264 localvp.attribute = da->attr;
265 localvp.lvalue = packet->src_port;
268 case PW_PACKET_DST_PORT:
269 localvp.attribute = da->attr;
270 localvp.lvalue = packet->dst_port;
273 case PW_PACKET_AUTHENTICATION_VECTOR:
274 localvp.attribute = da->attr;
275 memcpy(localvp.strvalue, packet->vector,
276 sizeof(packet->vector));
277 localvp.length = sizeof(packet->vector);
281 * Authorization, accounting, etc.
283 case PW_REQUEST_PROCESSING_STAGE:
284 if (request->component) {
285 strNcpy(out, request->component, outlen);
287 strNcpy(out, "server_core", outlen);
292 return 0; /* not found */
296 localvp.type = da->type;
297 return valuepair2str(out, outlen, &localvp,
307 if (!vps) return 0; /* silently fail */
310 * Convert the VP to a string, and return it.
312 return valuepair2str(out, outlen, vp, da->type, func);
317 * Pull %{0} to %{8} out of the packet.
319 static int xlat_regex(void *instance, REQUEST *request,
320 char *fmt, char *out, size_t outlen,
321 RADIUS_ESCAPE_STRING func)
326 * We cheat: fmt is "0" to "8", but those numbers
327 * are already in the "instance".
329 fmt = fmt; /* -Wunused */
330 func = func; /* -Wunused FIXME: do escaping? */
332 regex = request_data_get(request, request,
333 REQUEST_DATA_REGEX | *(int *)instance);
334 if (!regex) return 0;
337 * Copy UP TO "freespace" bytes, including
340 strNcpy(out, regex, outlen);
341 free(regex); /* was strdup'd */
344 #endif /* HAVE_REGEX_H */
347 * Compare two xlat_t structs, based ONLY on the module name.
349 static int xlat_cmp(const void *a, const void *b)
351 if (((const xlat_t *)a)->length != ((const xlat_t *)b)->length) {
352 return ((const xlat_t *)a)->length - ((const xlat_t *)b)->length;
355 return memcmp(((const xlat_t *)a)->module,
356 ((const xlat_t *)b)->module,
357 ((const xlat_t *)a)->length);
362 * find the appropriate registered xlat function.
364 static xlat_t *xlat_find(const char *module)
371 while (*module && (*module != ':')) {
372 *(p++) = *(module++);
377 return rbtree_finddata(xlat_root, &my_xlat);
382 * Register an xlat function.
384 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance)
389 if ((module == NULL) || (strlen(module) == 0)) {
390 DEBUG("xlat_register: Invalid module name");
395 * First time around, build up the tree...
397 * FIXME: This code should be hoisted out of this function,
398 * and into a global "initialization". But it isn't critical...
406 xlat_root = rbtree_create(xlat_cmp, free, 0);
408 DEBUG("xlat_register: Failed to create tree.");
413 * Register the internal packet xlat's.
415 for (i = 0; internal_xlat[i] != NULL; i++) {
416 xlat_register(internal_xlat[i], xlat_packet, &xlat_inst[i]);
417 c = xlat_find(internal_xlat[i]);
418 rad_assert(c != NULL);
424 * Register xlat's for regexes.
427 for (i = 0; i <= REQUEST_MAX_REGEX; i++) {
429 xlat_register(buffer, xlat_regex, &xlat_inst[i]);
430 c = xlat_find(buffer);
431 rad_assert(c != NULL);
434 #endif /* HAVE_REGEX_H */
438 * If it already exists, replace the instance.
440 strNcpy(my_xlat.module, module, sizeof(my_xlat.module));
441 my_xlat.length = strlen(my_xlat.module);
442 c = rbtree_finddata(xlat_root, &my_xlat);
445 DEBUG("xlat_register: Cannot re-define internal xlat");
450 c->instance = instance;
455 * Doesn't exist. Create it.
457 c = rad_malloc(sizeof(xlat_t));
458 memset(c, 0, sizeof(*c));
461 strNcpy(c->module, module, sizeof(c->module));
462 c->length = strlen(c->module);
463 c->instance = instance;
465 rbtree_insert(xlat_root, c);
471 * Unregister an xlat function.
473 * We can only have one function to call per name, so the
474 * passing of "func" here is extraneous.
476 void xlat_unregister(const char *module, RAD_XLAT_FUNC func)
481 func = func; /* -Wunused */
483 strNcpy(my_xlat.module, module, sizeof(my_xlat.module));
484 my_xlat.length = strlen(my_xlat.module);
486 node = rbtree_find(xlat_root, &my_xlat);
489 rbtree_delete(xlat_root, node);
493 * De-register all xlat functions,
494 * used mainly for debugging.
498 rbtree_free(xlat_root);
503 * Decode an attribute name into a string.
505 static void decode_attribute(const char **from, char **to, int freespace,
506 int *open, REQUEST *request,
507 RADIUS_ESCAPE_STRING func)
513 int stop=0, found=0, retlen=0;
514 int openbraces = *open;
524 * Skip the '{' at the front of 'p'
525 * Increment open braces
536 * Copy over the rest of the string.
538 while ((*p) && (!stop)) {
541 * Allow braces inside things, too.
555 if (openbraces == *open) {
564 * Attr-Name1:-Attr-Name2
566 * Use Attr-Name1, and if not found,
575 /* else FALL-THROUGH */
585 * Look up almost everything in the new tree of xlat
586 * functions. this makes it a little quicker...
588 if ((c = xlat_find(attrname)) != NULL) {
589 if (!c->internal) DEBUG("radius_xlat: Running registered xlat function of module %s for string \'%s\'",
590 c->module, attrname+ c->length + 1);
591 retlen = c->do_xlat(c->instance, request, attrname+(c->length+1), q, freespace, func);
592 /* If retlen is 0, treat it as not found */
593 if (retlen > 0) found = 1;
596 * Not in the default xlat database. Must be
597 * a bare attribute number.
599 } else if ((retlen = xlat_packet(&xlat_inst[1], request, attrname,
600 q, freespace, func)) > 0) {
604 * Look up the name, in order to get the correct
608 } else if (dict_attrbyname(attrname) == NULL) {
610 * No attribute by that name, return an error.
612 DEBUG2("WARNING: Attempt to use unknown xlat function, or non-existent attribute in string %%{%s}", attrname);
614 } /* else the attribute is known, but not in the request */
617 * Skip to last '}' if attr is found
618 * The rest of the stuff within the braces is
619 * useless if we found what we need
623 snprintf(q, freespace, "%d", retlen);
629 while((*p != '\0') && (openbraces > 0)) {
631 * Handle escapes outside of the loop.
636 p++; /* get & ignore next character */
655 p++; /* skip the character */
665 * If the caller doesn't pass xlat an escape function, then
666 * we use this one. It simplifies the coding, as the check for
667 * func == NULL only happens once.
669 static int xlat_copy(char *out, int outlen, const char *in)
675 * Truncate, if too much.
684 * FIXME: Do escaping of bad stuff!
698 * Replace %<whatever> in a string.
700 * See 'doc/variables.txt' for more information.
702 int radius_xlat(char *out, int outlen, const char *fmt,
703 REQUEST *request, RADIUS_ESCAPE_STRING func)
710 char tmpdt[40]; /* For temporary storing of dates */
716 if (!fmt || !out || !request) return 0;
719 * Ensure that we always have an escaping function.
728 /* Calculate freespace in output */
729 freespace = outlen - (q - out);
734 if ((c != '%') && (c != '$') && (c != '\\')) {
736 * We check if we're inside an open brace. If we are
737 * then we assume this brace is NOT literal, but is
738 * a closing brace and apply it
740 if ((c == '}') && openbraces) {
750 * There's nothing after this character, copy
751 * the last '%' or "$' or '\\' over to the output
778 * Hmmm... ${User-Name} is a synonym for
783 } else if (c == '$') switch(*p) {
784 case '{': /* Attribute by Name */
785 decode_attribute(&p, &q, freespace, &openbraces, request, func);
792 } else if (c == '%') switch(*p) {
794 decode_attribute(&p, &q, freespace, &openbraces, request, func);
800 case 'a': /* Protocol: */
801 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_PROTOCOL),PW_TYPE_INTEGER, func);
804 case 'c': /* Callback-Number */
805 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_CALLBACK_NUMBER),PW_TYPE_STRING, func);
808 case 'd': /* request day */
809 TM = localtime_r(&request->timestamp, &s_TM);
810 strftime(tmpdt,sizeof(tmpdt),"%d",TM);
811 strNcpy(q,tmpdt,freespace);
815 case 'f': /* Framed IP address */
816 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_IP_ADDRESS),PW_TYPE_IPADDR, func);
819 case 'i': /* Calling station ID */
820 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CALLING_STATION_ID),PW_TYPE_STRING, func);
823 case 'l': /* request timestamp */
824 snprintf(tmpdt, sizeof(tmpdt), "%lu",
825 (unsigned long) request->timestamp);
826 strNcpy(q,tmpdt,freespace);
830 case 'm': /* request month */
831 TM = localtime_r(&request->timestamp, &s_TM);
832 strftime(tmpdt,sizeof(tmpdt),"%m",TM);
833 strNcpy(q,tmpdt,freespace);
837 case 'n': /* NAS IP address */
838 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_IP_ADDRESS),PW_TYPE_IPADDR, func);
841 case 'p': /* Port number */
842 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_PORT),PW_TYPE_INTEGER, func);
845 case 's': /* Speed */
846 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CONNECT_INFO),PW_TYPE_STRING, func);
849 case 't': /* request timestamp */
850 CTIME_R(&request->timestamp, q, freespace);
854 case 'u': /* User name */
855 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_USER_NAME),PW_TYPE_STRING, func);
858 case 'A': /* radacct_dir */
859 strNcpy(q,radacct_dir,freespace-1);
863 case 'C': /* ClientName */
864 strNcpy(q,client_name(request->packet->src_ipaddr),freespace-1);
868 case 'D': /* request date */
869 TM = localtime_r(&request->timestamp, &s_TM);
870 strftime(tmpdt,sizeof(tmpdt),"%Y%m%d",TM);
871 strNcpy(q,tmpdt,freespace);
875 case 'H': /* request hour */
876 TM = localtime_r(&request->timestamp, &s_TM);
877 strftime(tmpdt,sizeof(tmpdt),"%H",TM);
878 strNcpy(q,tmpdt,freespace);
882 case 'L': /* radlog_dir */
883 strNcpy(q,radlog_dir,freespace-1);
888 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_MTU),PW_TYPE_INTEGER, func);
891 case 'R': /* radius_dir */
892 strNcpy(q,radius_dir,freespace-1);
896 case 'S': /* request timestamp in SQL format*/
897 TM = localtime_r(&request->timestamp, &s_TM);
898 strftime(tmpdt,sizeof(tmpdt),"%Y-%m-%d %H:%M:%S",TM);
899 strNcpy(q,tmpdt,freespace);
903 case 'T': /* request timestamp */
904 TM = localtime_r(&request->timestamp, &s_TM);
905 strftime(tmpdt,sizeof(tmpdt),"%Y-%m-%d-%H.%M.%S.000000",TM);
906 strNcpy(q,tmpdt,freespace);
910 case 'U': /* Stripped User name */
911 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_STRIPPED_USER_NAME),PW_TYPE_STRING, func);
914 case 'V': /* Request-Authenticator */
915 if (request->packet->verified)
916 strNcpy(q,"Verified",freespace-1);
918 strNcpy(q,"None",freespace-1);
922 case 'Y': /* request year */
923 TM = localtime_r(&request->timestamp, &s_TM);
924 strftime(tmpdt,sizeof(tmpdt),"%Y",TM);
925 strNcpy(q,tmpdt,freespace);
929 case 'Z': /* Full request pairs except password */
930 tmp = request->packet->vps;
931 while (tmp && (freespace > 3)) {
932 if (tmp->attribute != PW_PASSWORD) {
934 i = vp_prints(q,freespace-2,tmp);
944 DEBUG2("WARNING: Unknown variable '%%%c': See 'doc/variables.txt'", *p);
954 DEBUG2("radius_xlat: '%s'", out);