6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2002,2006 The FreeRADIUS server project
21 * Copyright 2002 Kostas Kalevras <kkalev@noc.ntua.gr>
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
34 #define RLM_REGEX_INPACKET 0
35 #define RLM_REGEX_INCONFIG 1
36 #define RLM_REGEX_INREPLY 2
37 #define RLM_REGEX_INPROXY 3
38 #define RLM_REGEX_INPROXYREPLY 4
40 typedef struct rlm_attr_rewrite_t {
41 char *attribute; /* The attribute to search for */
42 DICT_ATTR *da; /* The attribute definition */
43 char *search; /* The pattern to search for */
44 int search_len; /* The length of the search pattern */
45 char *searchin_str; /* The VALUE_PAIR list to search in. Can be either packet,reply,proxy,proxy_reply or control (plus it's alias 'config') */
46 char searchin; /* The same as above just coded as a number for speed */
47 char *replace; /* The replacement */
48 int replace_len; /* The length of the replacement string */
49 int append; /* Switch to control append mode (1,0) */
50 int nocase; /* Ignore case */
51 int new_attr; /* Boolean. Do we create a new attribute or not? */
52 int num_matches; /* Maximum number of matches */
53 const char *name; /* The module name */
56 static const CONF_PARSER module_config[] = {
57 { "attribute", PW_TYPE_STRING_PTR, offsetof(rlm_attr_rewrite_t,attribute), NULL, NULL },
58 { "searchfor", PW_TYPE_STRING_PTR, offsetof(rlm_attr_rewrite_t,search), NULL, NULL },
59 { "searchin", PW_TYPE_STRING_PTR, offsetof(rlm_attr_rewrite_t,searchin_str), NULL, "packet" },
60 { "replacewith", PW_TYPE_STRING_PTR, offsetof(rlm_attr_rewrite_t,replace), NULL, NULL },
61 { "append", PW_TYPE_BOOLEAN, offsetof(rlm_attr_rewrite_t,append),NULL, "no" },
62 { "ignore_case", PW_TYPE_BOOLEAN, offsetof(rlm_attr_rewrite_t,nocase), NULL, "yes" },
63 { "new_attribute", PW_TYPE_BOOLEAN, offsetof(rlm_attr_rewrite_t,new_attr), NULL, "no" },
64 { "max_matches", PW_TYPE_INTEGER, offsetof(rlm_attr_rewrite_t,num_matches), NULL, "10" },
65 { NULL, -1, 0, NULL, NULL }
68 static int attr_rewrite_instantiate(CONF_SECTION *conf, void **instance)
70 rlm_attr_rewrite_t *data;
74 * Set up a storage area for instance data
76 data = rad_malloc(sizeof(*data));
80 memset(data, 0, sizeof(*data));
83 * If the configuration parameters can't be parsed, then
86 if (cf_section_parse(conf, data, module_config) < 0) {
92 * Discover the attribute number of the key.
94 if (data->attribute == NULL) {
95 radlog(L_ERR, "rlm_attr_rewrite: 'attribute' must be set.");
98 if (data->search == NULL || data->replace == NULL) {
99 radlog(L_ERR, "rlm_attr_rewrite: search/replace strings must be set.");
102 data->search_len = strlen(data->search);
103 data->replace_len = strlen(data->replace);
105 if (data->replace_len == 0 && data->new_attr){
106 radlog(L_ERR, "rlm_attr_rewrite: replace string must not be zero length in order to create new attribute.");
110 if (data->num_matches < 1 || data->num_matches > MAX_STRING_LEN) {
111 radlog(L_ERR, "rlm_attr_rewrite: Illegal range for match number.");
114 if (data->searchin_str == NULL) {
115 radlog(L_ERR, "rlm_attr_rewrite: Illegal searchin directive given. Assuming packet.");
116 data->searchin = RLM_REGEX_INPACKET;
119 if (strcmp(data->searchin_str, "packet") == 0)
120 data->searchin = RLM_REGEX_INPACKET;
121 else if (strcmp(data->searchin_str, "config") == 0)
122 data->searchin = RLM_REGEX_INCONFIG;
123 else if (strcmp(data->searchin_str, "control") == 0)
124 data->searchin = RLM_REGEX_INCONFIG;
125 else if (strcmp(data->searchin_str, "reply") == 0)
126 data->searchin = RLM_REGEX_INREPLY;
127 else if (strcmp(data->searchin_str, "proxy") == 0)
128 data->searchin = RLM_REGEX_INPROXY;
129 else if (strcmp(data->searchin_str, "proxy_reply") == 0)
130 data->searchin = RLM_REGEX_INPROXYREPLY;
132 radlog(L_ERR, "rlm_attr_rewrite: Illegal searchin directive given. Assuming packet.");
133 data->searchin = RLM_REGEX_INPACKET;
136 dattr = dict_attrbyname(data->attribute);
138 radlog(L_ERR, "rlm_attr_rewrite: No such attribute %s",
143 /* Add the module instance name */
144 data->name = cf_section_name2(conf); /* may be NULL */
151 static int do_attr_rewrite(void *instance, REQUEST *request)
153 rlm_attr_rewrite_t *data = (rlm_attr_rewrite_t *) instance;
154 int ret = RLM_MODULE_NOOP;
155 VALUE_PAIR *attr_vp = NULL;
156 VALUE_PAIR *tmp = NULL;
158 regmatch_t pmatch[9];
162 unsigned int len = 0;
163 char err_msg[MAX_STRING_LEN];
166 unsigned int counter = 0;
167 char new_str[MAX_STRING_LEN];
169 char search_STR[MAX_STRING_LEN];
170 char replace_STR[MAX_STRING_LEN];
172 if ((attr_vp = pairfind(request->config_items, PW_REWRITE_RULE, 0)) != NULL){
173 if (data->name == NULL || strcmp(data->name,attr_vp->vp_strvalue))
174 return RLM_MODULE_NOOP;
178 /* new_attribute = yes */
179 if (!radius_xlat(replace_STR, sizeof(replace_STR), data->replace, request, NULL)) {
180 DEBUG2("%s: xlat on replace string failed.", data->name);
183 attr_vp = pairmake(data->attribute,replace_STR,0);
184 if (attr_vp == NULL){
185 DEBUG2("%s: Could not add new attribute %s with value '%s'", data->name,
186 data->attribute,replace_STR);
189 switch(data->searchin){
190 case RLM_REGEX_INPACKET:
191 pairadd(&request->packet->vps,attr_vp);
193 case RLM_REGEX_INCONFIG:
194 pairadd(&request->config_items,attr_vp);
196 case RLM_REGEX_INREPLY:
197 pairadd(&request->reply->vps,attr_vp);
199 case RLM_REGEX_INPROXY:
200 if (!request->proxy) {
201 pairbasicfree(attr_vp);
202 return RLM_MODULE_NOOP;
204 pairadd(&request->proxy->vps, attr_vp);
206 case RLM_REGEX_INPROXYREPLY:
207 if (!request->proxy_reply) {
208 pairbasicfree(attr_vp);
209 return RLM_MODULE_NOOP;
211 pairadd(&request->proxy_reply->vps, attr_vp);
214 radlog(L_ERR, "%s: Illegal value for searchin. Changing to packet.", data->name);
215 data->searchin = RLM_REGEX_INPACKET;
216 pairadd(&request->packet->vps,attr_vp);
219 DEBUG2("%s: Added attribute %s with value '%s'", data->name,data->attribute,replace_STR);
224 /* new_attribute = no */
225 switch (data->searchin) {
226 case RLM_REGEX_INPACKET:
227 if (!data->da->vendor && (data->da->attr == PW_USER_NAME))
228 attr_vp = request->username;
229 else if (!data->da->vendor && (data->da->attr == PW_USER_PASSWORD))
230 attr_vp = request->password;
232 tmp = request->packet->vps;
234 case RLM_REGEX_INCONFIG:
235 tmp = request->config_items;
237 case RLM_REGEX_INREPLY:
238 tmp = request->reply->vps;
240 case RLM_REGEX_INPROXYREPLY:
241 if (!request->proxy_reply)
242 return RLM_MODULE_NOOP;
243 tmp = request->proxy_reply->vps;
245 case RLM_REGEX_INPROXY:
247 return RLM_MODULE_NOOP;
248 tmp = request->proxy->vps;
251 radlog(L_ERR, "%s: Illegal value for searchin. Changing to packet.", data->name);
252 data->searchin = RLM_REGEX_INPACKET;
253 attr_vp = pairfind(request->packet->vps, data->da->attr, data->da->vendor);
258 attr_vp = pairfind(tmp, data->da->attr, data->da->vendor);
259 if (attr_vp == NULL) {
260 DEBUG2("%s: Could not find value pair for attribute %s", data->name,data->attribute);
263 if (attr_vp->vp_strvalue == NULL || attr_vp->length == 0){
264 DEBUG2("%s: Attribute %s string value NULL or of zero length", data->name,data->attribute);
267 cflags |= REG_EXTENDED;
271 if (!radius_xlat(search_STR, sizeof(search_STR), data->search, request, NULL) && data->search_len != 0) {
272 DEBUG2("%s: xlat on search string failed.", data->name);
276 if ((err = regcomp(&preg,search_STR,cflags))) {
277 regerror(err, &preg, err_msg, MAX_STRING_LEN);
278 DEBUG2("%s: regcomp() returned error: %s", data->name,err_msg);
282 if ((attr_vp->type == PW_TYPE_IPADDR) &&
283 (attr_vp->vp_strvalue[0] == '\0')) {
284 inet_ntop(AF_INET, &(attr_vp->vp_ipaddr),
285 attr_vp->vp_strvalue,
286 sizeof(attr_vp->vp_strvalue));
290 ptr2 = attr_vp->vp_strvalue;
293 for ( i = 0 ;i < (unsigned)data->num_matches; i++) {
294 err = regexec(&preg, ptr2, REQUEST_MAX_REGEX, pmatch, 0);
295 if (err == REG_NOMATCH) {
297 DEBUG2("%s: Does not match: %s = %s", data->name,
298 data->attribute, attr_vp->vp_strvalue);
306 radlog(L_ERR, "%s: match failure for attribute %s with value '%s'", data->name,
307 data->attribute, attr_vp->vp_strvalue);
310 if (pmatch[0].rm_so == -1)
312 len = pmatch[0].rm_so;
314 len = len + (pmatch[0].rm_eo - pmatch[0].rm_so);
317 if (counter >= MAX_STRING_LEN) {
319 DEBUG2("%s: Replacement out of limits for attribute %s with value '%s'", data->name,
320 data->attribute, attr_vp->vp_strvalue);
324 memcpy(ptr, ptr2,len);
327 ptr2 += pmatch[0].rm_eo;
331 * We only run on the first match, sorry
333 for(j = 0; j <= REQUEST_MAX_REGEX; j++){
335 char buffer[sizeof(attr_vp->vp_strvalue)];
338 * Stolen from src/main/valuepair.c, paircompare()
342 * Delete old matches if the corresponding match does not
343 * exist in the current regex
345 if (pmatch[j].rm_so == -1){
346 p = request_data_get(request,request,REQUEST_DATA_REGEX | j);
354 attr_vp->vp_strvalue + pmatch[j].rm_so,
355 pmatch[j].rm_eo - pmatch[j].rm_so);
356 buffer[pmatch[j].rm_eo - pmatch[j].rm_so] = '\0';
358 request_data_add(request,request,REQUEST_DATA_REGEX | j,p,free);
363 if (data->replace_len != 0 &&
364 radius_xlat(replace_STR, sizeof(replace_STR), data->replace, request, NULL) == 0) {
365 DEBUG2("%s: xlat on replace string failed.", data->name);
368 replace_len = (data->replace_len != 0) ? strlen(replace_STR) : 0;
372 counter += replace_len;
373 if (counter >= MAX_STRING_LEN) {
375 DEBUG2("%s: Replacement out of limits for attribute %s with value '%s'", data->name,
376 data->attribute, attr_vp->vp_strvalue);
380 memcpy(ptr, replace_STR, replace_len);
386 len = strlen(ptr2) + 1; /* We add the ending NULL */
388 if (counter >= MAX_STRING_LEN){
389 DEBUG2("%s: Replacement out of limits for attribute %s with value '%s'", data->name,
390 data->attribute, attr_vp->vp_strvalue);
393 memcpy(ptr, ptr2, len);
396 DEBUG2("%s: Changed value for attribute %s from '%s' to '%s'", data->name,
397 data->attribute, attr_vp->vp_strvalue, new_str);
398 if (pairparsevalue(attr_vp, new_str) == NULL) {
399 DEBUG2("%s: Could not write value '%s' into attribute %s: %s", data->name, new_str, data->attribute, fr_strerror());
416 static int attr_rewrite_accounting(void *instance, REQUEST *request)
418 return do_attr_rewrite(instance, request);
421 static int attr_rewrite_authorize(void *instance, REQUEST *request)
423 return do_attr_rewrite(instance, request);
426 static int attr_rewrite_authenticate(void *instance, REQUEST *request)
428 return do_attr_rewrite(instance, request);
431 static int attr_rewrite_preacct(void *instance, REQUEST *request)
433 return do_attr_rewrite(instance, request);
436 static int attr_rewrite_checksimul(void *instance, REQUEST *request)
438 return do_attr_rewrite(instance, request);
441 static int attr_rewrite_preproxy(void *instance, REQUEST *request)
443 return do_attr_rewrite(instance, request);
446 static int attr_rewrite_postproxy(void *instance, REQUEST *request)
448 return do_attr_rewrite(instance, request);
451 static int attr_rewrite_postauth(void *instance, REQUEST *request)
453 return do_attr_rewrite(instance, request);
456 static int attr_rewrite_detach(void *instance)
463 * The module name should be the only globally exported symbol.
464 * That is, everything else should be 'static'.
466 * If the module needs to temporarily modify it's instantiation
467 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
468 * The server will then take care of ensuring that the module
469 * is single-threaded.
471 module_t rlm_attr_rewrite = {
474 RLM_TYPE_THREAD_UNSAFE, /* type */
475 attr_rewrite_instantiate, /* instantiation */
476 attr_rewrite_detach, /* detach */
478 attr_rewrite_authenticate, /* authentication */
479 attr_rewrite_authorize, /* authorization */
480 attr_rewrite_preacct, /* preaccounting */
481 attr_rewrite_accounting, /* accounting */
482 attr_rewrite_checksimul, /* checksimul */
483 attr_rewrite_preproxy, /* pre-proxy */
484 attr_rewrite_postproxy, /* post-proxy */
485 attr_rewrite_postauth /* post-auth */