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.
233 * FIXME: Add SRC/DST IP address!
241 dval = dict_valbyattr(da->attr, packet->code);
243 snprintf(out, outlen, "%s", dval->name);
245 snprintf(out, outlen, "%d", packet->code);
262 if (!vps) return 0; /* silently fail */
265 * Convert the VP to a string, and return it.
267 return valuepair2str(out, outlen, vp, da->type, func);
272 * Pull %{0} to %{8} out of the packet.
274 static int xlat_regex(void *instance, REQUEST *request,
275 char *fmt, char *out, size_t outlen,
276 RADIUS_ESCAPE_STRING func)
281 * We cheat: fmt is "0" to "8", but those numbers
282 * are already in the "instance".
284 fmt = fmt; /* -Wunused */
285 func = func; /* -Wunused FIXME: do escaping? */
287 regex = request_data_get(request, request,
288 REQUEST_DATA_REGEX | *(int *)instance);
289 if (!regex) return 0;
292 * Copy UP TO "freespace" bytes, including
295 strNcpy(out, regex, outlen);
296 free(regex); /* was strdup'd */
299 #endif /* HAVE_REGEX_H */
302 * Compare two xlat_t structs, based ONLY on the module name.
304 static int xlat_cmp(const void *a, const void *b)
306 if (((const xlat_t *)a)->length != ((const xlat_t *)b)->length) {
307 return ((const xlat_t *)a)->length - ((const xlat_t *)b)->length;
310 return memcmp(((const xlat_t *)a)->module,
311 ((const xlat_t *)b)->module,
312 ((const xlat_t *)a)->length);
317 * find the appropriate registered xlat function.
319 static xlat_t *xlat_find(const char *module)
324 strNcpy(my_xlat.module, module, sizeof(my_xlat.module));
327 * We get passed the WHOLE string, and all we want here
328 * is the first piece.
330 p = strchr(my_xlat.module, ':');
333 my_xlat.length = strlen(my_xlat.module);
335 return rbtree_finddata(xlat_root, &my_xlat);
340 * Register an xlat function.
342 int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance)
347 if ((module == NULL) || (strlen(module) == 0)) {
348 DEBUG("xlat_register: Invalid module name");
353 * First time around, build up the tree...
355 * FIXME: This code should be hoisted out of this function,
356 * and into a global "initialization". But it isn't critical...
364 xlat_root = rbtree_create(xlat_cmp, free, 0);
366 DEBUG("xlat_register: Failed to create tree.");
371 * Register the internal packet xlat's.
373 for (i = 0; internal_xlat[i] != NULL; i++) {
374 xlat_register(internal_xlat[i], xlat_packet, &xlat_inst[i]);
375 c = xlat_find(internal_xlat[i]);
376 rad_assert(c != NULL);
382 * Register xlat's for regexes.
385 for (i = 0; i <= REQUEST_MAX_REGEX; i++) {
387 xlat_register(buffer, xlat_regex, &xlat_inst[i]);
388 c = xlat_find(buffer);
389 rad_assert(c != NULL);
392 #endif /* HAVE_REGEX_H */
396 * If it already exists, replace the instance.
398 strNcpy(my_xlat.module, module, sizeof(my_xlat.module));
399 my_xlat.length = strlen(my_xlat.module);
400 c = rbtree_finddata(xlat_root, &my_xlat);
403 DEBUG("xlat_register: Cannot re-define internal xlat");
408 c->instance = instance;
413 * Doesn't exist. Create it.
415 c = rad_malloc(sizeof(xlat_t));
416 memset(c, 0, sizeof(*c));
419 strNcpy(c->module, module, sizeof(c->module));
420 c->length = strlen(c->module);
421 c->instance = instance;
423 rbtree_insert(xlat_root, c);
429 * Unregister an xlat function.
431 * We can only have one function to call per name, so the
432 * passing of "func" here is extraneous.
434 void xlat_unregister(const char *module, RAD_XLAT_FUNC func)
439 func = func; /* -Wunused */
441 strNcpy(my_xlat.module, module, sizeof(my_xlat.module));
442 my_xlat.length = strlen(my_xlat.module);
444 node = rbtree_find(xlat_root, &my_xlat);
447 rbtree_delete(xlat_root, node);
451 * De-register all xlat functions,
452 * used mainly for debugging.
456 rbtree_free(xlat_root);
461 * Decode an attribute name into a string.
463 static void decode_attribute(const char **from, char **to, int freespace,
464 int *open, REQUEST *request,
465 RADIUS_ESCAPE_STRING func)
471 int stop=0, found=0, retlen=0;
472 int openbraces = *open;
482 * Skip the '{' at the front of 'p'
483 * Increment open braces
494 * Copy over the rest of the string.
496 while ((*p) && (!stop)) {
499 * Allow braces inside things, too.
513 if (openbraces == *open) {
522 * Attr-Name1:-Attr-Name2
524 * Use Attr-Name1, and if not found,
533 /* else FALL-THROUGH */
543 * Look up almost everything in the new tree of xlat
544 * functions. this makes it a little quicker...
546 if ((c = xlat_find(attrname)) != NULL) {
547 if (!c->internal) DEBUG("radius_xlat: Running registered xlat function of module %s for string \'%s\'",
548 c->module, attrname+ c->length + 1);
549 retlen = c->do_xlat(c->instance, request, attrname+(c->length+1), q, freespace, func);
550 /* If retlen is 0, treat it as not found */
551 if (retlen > 0) found = 1;
554 * Not in the default xlat database. Must be
555 * a bare attribute number.
557 } else if ((retlen = xlat_packet(&xlat_inst[1], request, attrname,
558 q, freespace, func)) > 0) {
562 * Look up the name, in order to get the correct
566 } else if (dict_attrbyname(attrname) == NULL) {
568 * No attribute by that name, return an error.
570 DEBUG2("WARNING: Attempt to use unknown xlat function, or non-existent attribute in string %%{%s}", attrname);
572 } /* else the attribute is known, but not in the request */
575 * Skip to last '}' if attr is found
576 * The rest of the stuff within the braces is
577 * useless if we found what we need
581 snprintf(q, freespace, "%d", retlen);
587 while((*p != '\0') && (openbraces > 0)) {
589 * Handle escapes outside of the loop.
594 p++; /* get & ignore next character */
613 p++; /* skip the character */
623 * If the caller doesn't pass xlat an escape function, then
624 * we use this one. It simplifies the coding, as the check for
625 * func == NULL only happens once.
627 static int xlat_copy(char *out, int outlen, const char *in)
633 * Truncate, if too much.
642 * FIXME: Do escaping of bad stuff!
656 * Replace %<whatever> in a string.
658 * See 'doc/variables.txt' for more information.
660 int radius_xlat(char *out, int outlen, const char *fmt,
661 REQUEST *request, RADIUS_ESCAPE_STRING func)
668 char tmpdt[40]; /* For temporary storing of dates */
674 if (!fmt || !out || !request) return 0;
677 * Ensure that we always have an escaping function.
686 /* Calculate freespace in output */
687 freespace = outlen - (q - out);
692 if ((c != '%') && (c != '$') && (c != '\\')) {
694 * We check if we're inside an open brace. If we are
695 * then we assume this brace is NOT literal, but is
696 * a closing brace and apply it
698 if ((c == '}') && openbraces) {
708 * There's nothing after this character, copy
709 * the last '%' or "$' or '\\' over to the output
736 * Hmmm... ${User-Name} is a synonym for
741 } else if (c == '$') switch(*p) {
742 case '{': /* Attribute by Name */
743 decode_attribute(&p, &q, freespace, &openbraces, request, func);
750 } else if (c == '%') switch(*p) {
752 decode_attribute(&p, &q, freespace, &openbraces, request, func);
758 case 'a': /* Protocol: */
759 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_PROTOCOL),PW_TYPE_INTEGER, func);
762 case 'c': /* Callback-Number */
763 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_CALLBACK_NUMBER),PW_TYPE_STRING, func);
766 case 'd': /* request day */
767 TM = localtime_r(&request->timestamp, &s_TM);
768 strftime(tmpdt,sizeof(tmpdt),"%d",TM);
769 strNcpy(q,tmpdt,freespace);
773 case 'f': /* Framed IP address */
774 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_IP_ADDRESS),PW_TYPE_IPADDR, func);
777 case 'i': /* Calling station ID */
778 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CALLING_STATION_ID),PW_TYPE_STRING, func);
781 case 'l': /* request timestamp */
782 snprintf(tmpdt, sizeof(tmpdt), "%lu",
783 (unsigned long) request->timestamp);
784 strNcpy(q,tmpdt,freespace);
788 case 'm': /* request month */
789 TM = localtime_r(&request->timestamp, &s_TM);
790 strftime(tmpdt,sizeof(tmpdt),"%m",TM);
791 strNcpy(q,tmpdt,freespace);
795 case 'n': /* NAS IP address */
796 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_IP_ADDRESS),PW_TYPE_IPADDR, func);
799 case 'p': /* Port number */
800 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_NAS_PORT),PW_TYPE_INTEGER, func);
803 case 's': /* Speed */
804 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_CONNECT_INFO),PW_TYPE_STRING, func);
807 case 't': /* request timestamp */
808 CTIME_R(&request->timestamp, q, freespace);
812 case 'u': /* User name */
813 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_USER_NAME),PW_TYPE_STRING, func);
816 case 'A': /* radacct_dir */
817 strNcpy(q,radacct_dir,freespace-1);
821 case 'C': /* ClientName */
822 strNcpy(q,client_name(request->packet->src_ipaddr),freespace-1);
826 case 'D': /* request date */
827 TM = localtime_r(&request->timestamp, &s_TM);
828 strftime(tmpdt,sizeof(tmpdt),"%Y%m%d",TM);
829 strNcpy(q,tmpdt,freespace);
833 case 'H': /* request hour */
834 TM = localtime_r(&request->timestamp, &s_TM);
835 strftime(tmpdt,sizeof(tmpdt),"%H",TM);
836 strNcpy(q,tmpdt,freespace);
840 case 'L': /* radlog_dir */
841 strNcpy(q,radlog_dir,freespace-1);
846 q += valuepair2str(q,freespace,pairfind(request->reply->vps,PW_FRAMED_MTU),PW_TYPE_INTEGER, func);
849 case 'R': /* radius_dir */
850 strNcpy(q,radius_dir,freespace-1);
854 case 'S': /* request timestamp in SQL format*/
855 TM = localtime_r(&request->timestamp, &s_TM);
856 strftime(tmpdt,sizeof(tmpdt),"%Y-%m-%d %H:%M:%S",TM);
857 strNcpy(q,tmpdt,freespace);
861 case 'T': /* request timestamp */
862 TM = localtime_r(&request->timestamp, &s_TM);
863 strftime(tmpdt,sizeof(tmpdt),"%Y-%m-%d-%H.%M.%S.000000",TM);
864 strNcpy(q,tmpdt,freespace);
868 case 'U': /* Stripped User name */
869 q += valuepair2str(q,freespace,pairfind(request->packet->vps,PW_STRIPPED_USER_NAME),PW_TYPE_STRING, func);
872 case 'V': /* Request-Authenticator */
873 if (request->packet->verified)
874 strNcpy(q,"Verified",freespace-1);
876 strNcpy(q,"None",freespace-1);
880 case 'Y': /* request year */
881 TM = localtime_r(&request->timestamp, &s_TM);
882 strftime(tmpdt,sizeof(tmpdt),"%Y",TM);
883 strNcpy(q,tmpdt,freespace);
887 case 'Z': /* Full request pairs except password */
888 tmp = request->packet->vps;
889 while (tmp && (freespace > 3)) {
890 if (tmp->attribute != PW_PASSWORD) {
892 i = vp_prints(q,freespace-2,tmp);
902 DEBUG2("WARNING: Unknown variable '%%%c': See 'doc/variables.txt'", *p);
912 DEBUG2("radius_xlat: '%s'", out);