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 2000,2006 The FreeRADIUS server project
21 * FIXME add copyrights
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
30 #define REALM_FORMAT_PREFIX 0
31 #define REALM_FORMAT_SUFFIX 1
33 typedef struct realm_config_t {
41 static CONF_PARSER module_config[] = {
42 { "format", PW_TYPE_STRING_PTR,
43 offsetof(realm_config_t,formatstring), NULL, "suffix" },
44 { "delimiter", PW_TYPE_STRING_PTR,
45 offsetof(realm_config_t,delim), NULL, "@" },
46 { "ignore_default", PW_TYPE_BOOLEAN,
47 offsetof(realm_config_t,ignore_default), NULL, "no" },
48 { "ignore_null", PW_TYPE_BOOLEAN,
49 offsetof(realm_config_t,ignore_null), NULL, "no" },
50 { NULL, -1, 0, NULL, NULL } /* end the list */
54 * Internal function to cut down on duplicated code.
56 * Returns -1 on failure, 0 on no failure. returnrealm
57 * is NULL on don't proxy, realm otherwise.
59 static int check_for_realm(void *instance, REQUEST *request, REALM **returnrealm)
61 char namebuf[MAX_STRING_LEN];
63 char *realmname = NULL;
68 struct realm_config_t *inst = instance;
70 /* initiate returnrealm */
74 * If the request has a proxy entry, then it's a proxy
75 * reply, and we're walking through the module list again.
77 * In that case, don't bother trying to proxy the request
80 * Also, if there's no User-Name attribute, we can't
83 if ((request->proxy != NULL) ||
84 (request->username == NULL)) {
85 DEBUG2(" rlm_realm: Proxy reply, or no User-Name. Ignoring.");
90 * Check for 'Realm' attribute. If it exists, then we've proxied
91 * it already ( via another rlm_realm instance ) and should return.
94 if ( (vp = pairfind(request->packet->vps, PW_REALM)) != NULL ) {
95 DEBUG2(" rlm_realm: Request already proxied. Ignoring.");
100 * We will be modifing this later, so we want our own copy
103 strlcpy(namebuf, (char *)request->username->vp_strvalue, sizeof(namebuf));
109 case REALM_FORMAT_SUFFIX:
111 /* DEBUG2(" rlm_realm: Checking for suffix after \"%c\"", inst->delim[0]); */
112 realmname = strrchr(username, inst->delim[0]);
119 case REALM_FORMAT_PREFIX:
121 /* DEBUG2(" rlm_realm: Checking for prefix before \"%c\"", inst->delim[0]); */
123 ptr = strchr(username, inst->delim[0]);
127 realmname = username;
138 * Print out excruciatingly descriptive debugging messages
139 * for the people who find it too difficult to think about
143 DEBUG2(" rlm_realm: Looking up realm \"%s\" for User-Name = \"%s\"",
144 realmname, request->username->vp_strvalue);
146 if( inst->ignore_null ) {
147 DEBUG2(" rlm_realm: No '%c' in User-Name = \"%s\", skipping NULL due to config.",
148 inst->delim[0], request->username->vp_strvalue);
151 DEBUG2(" rlm_realm: No '%c' in User-Name = \"%s\", looking up realm NULL",
152 inst->delim[0], request->username->vp_strvalue);
156 * Allow DEFAULT realms unless told not to.
158 realm = realm_find(realmname);
160 DEBUG2(" rlm_realm: No such realm \"%s\"",
161 (realmname == NULL) ? "NULL" : realmname);
164 if( inst->ignore_default &&
165 (strcmp(realm->name, "DEFAULT")) == 0) {
166 DEBUG2(" rlm_realm: Found DEFAULT, but skipping due to config.");
170 DEBUG2(" rlm_realm: Found realm \"%s\"", realm->name);
173 * If we've been told to strip the realm off, then do so.
175 if (realm->striprealm) {
177 * Create the Stripped-User-Name attribute, if it
181 if (request->username->attribute != PW_STRIPPED_USER_NAME) {
182 vp = radius_paircreate(request, &request->packet->vps,
183 PW_STRIPPED_USER_NAME,
185 DEBUG2(" rlm_realm: Adding Stripped-User-Name = \"%s\"", username);
187 vp = request->username;
188 DEBUG2(" rlm_realm: Setting Stripped-User-Name = \"%s\"", username);
191 strcpy(vp->vp_strvalue, username);
192 vp->length = strlen((char *)vp->vp_strvalue);
193 request->username = vp;
196 DEBUG2(" rlm_realm: Proxying request from user %s to realm %s",
197 username, realm->name);
200 * Add the realm name to the request.
202 pairadd(&request->packet->vps, pairmake("Realm", realm->name,
204 DEBUG2(" rlm_realm: Adding Realm = \"%s\"", realm->name);
207 * Figure out what to do with the request.
209 switch (request->packet->code) {
211 DEBUG2(" rlm_realm: Unknown packet code %d\n",
212 request->packet->code);
213 return 0; /* don't do anything */
216 * Perhaps accounting proxying was turned off.
218 case PW_ACCOUNTING_REQUEST:
219 if (!realm->acct_pool) {
220 DEBUG2(" rlm_realm: Accounting realm is LOCAL.");
226 * Perhaps authentication proxying was turned off.
228 case PW_AUTHENTICATION_REQUEST:
229 if (!realm->auth_pool) {
230 DEBUG2(" rlm_realm: Authentication realm is LOCAL.");
237 * Skip additional checks if it's not an accounting
240 if (request->packet->code != PW_ACCOUNTING_REQUEST) {
241 *returnrealm = realm;
246 * FIXME: Each server should have a unique server key,
247 * and put it in the accounting packet. Every server
248 * should know about the keys, and NOT proxy requests to
249 * a server with key X if the packet already contains key
254 * If this request has arrived from another freeradius server
255 * that has already proxied the request, we don't need to do
258 vp = pairfind(request->packet->vps, PW_FREERADIUS_PROXIED_TO);
259 if (vp && (request->packet->src_ipaddr.af == AF_INET)) {
261 lrad_ipaddr_t my_ipaddr;
263 my_ipaddr.af = AF_INET;
264 my_ipaddr.ipaddr.ip4addr.s_addr = vp->vp_ipaddr;
267 * Loop over the home accounting servers for this
268 * realm. If one of them has the same IP as the
269 * FreeRADIUS-Proxied-To attribute, then the
270 * packet has already been sent there. Don't
271 * send it there again.
273 for (i = 0; i < realm->acct_pool->num_home_servers; i++) {
274 if (lrad_ipaddr_cmp(&realm->acct_pool->servers[i]->ipaddr,
276 DEBUG2("Suppressing proxy due to FreeRADIUS-Proxied-To");
282 * See detail_recv() in src/main/listen.c for the
285 } else if ((request->listener->type == RAD_LISTEN_DETAIL) &&
286 ((request->packet->src_ipaddr.af == AF_INET6) ||
287 (request->packet->src_ipaddr.ipaddr.ip4addr.s_addr != htonl(INADDR_NONE)))) {
291 * Loop over the home accounting servers for this
292 * realm. If one of them has the same IP as the
293 * FreeRADIUS-Proxied-To attribute, then the
294 * packet has already been sent there. Don't
295 * send it there again.
297 for (i = 0; i < realm->acct_pool->num_home_servers; i++) {
298 if ((lrad_ipaddr_cmp(&realm->acct_pool->servers[i]->ipaddr,
299 &request->packet->src_ipaddr) == 0) &&
300 (realm->acct_pool->servers[i]->port == request->packet->src_port)) {
301 DEBUG2("Suppressing proxy because packet was already sent to a server in that realm");
309 * We got this far, which means we have a realm, set returnrealm
311 *returnrealm = realm;
316 * Add a "Proxy-To-Realm" attribute to the request.
318 static void add_proxy_to_realm(VALUE_PAIR **vps, REALM *realm)
323 * Tell the server to proxy this request to another
326 vp = pairmake("Proxy-To-Realm", realm->name, T_OP_EQ);
328 radlog(L_ERR|L_CONS, "no memory");
333 * Add it, even if it's already present.
339 * Perform the realm module instantiation. Configuration info is
340 * stored in *instance for later use.
343 static int realm_instantiate(CONF_SECTION *conf, void **instance)
345 struct realm_config_t *inst;
347 /* setup a storage area for instance data */
348 inst = rad_malloc(sizeof(*inst));
352 memset(inst, 0, sizeof(*inst));
354 if(cf_section_parse(conf, inst, module_config) < 0) {
359 if(strcasecmp(inst->formatstring, "suffix") == 0) {
360 inst->format = REALM_FORMAT_SUFFIX;
361 } else if(strcasecmp(inst->formatstring, "prefix") == 0) {
362 inst->format = REALM_FORMAT_PREFIX;
364 radlog(L_ERR, "Bad value \"%s\" for realm format value", inst->formatstring);
368 if(strlen(inst->delim) != 1) {
369 radlog(L_ERR, "Bad value \"%s\" for realm delimiter value", inst->delim);
384 * Examine a request for a username with an realm, and if it
385 * corresponds to something in the realms file, set that realm as
388 * This should very nearly duplicate the old proxy_send() code
390 static int realm_authorize(void *instance, REQUEST *request)
395 * Check if we've got to proxy the request.
396 * If not, return without adding a Proxy-To-Realm
399 if (check_for_realm(instance, request, &realm) < 0) {
400 return RLM_MODULE_FAIL;
403 return RLM_MODULE_NOOP;
407 * Maybe add a Proxy-To-Realm attribute to the request.
409 DEBUG2(" rlm_realm: Preparing to proxy authentication request to realm \"%s\"\n",
411 add_proxy_to_realm(&request->config_items, realm);
413 return RLM_MODULE_UPDATED; /* try the next module */
417 * This does the exact same thing as the realm_authorize, it's just called
420 static int realm_preacct(void *instance, REQUEST *request)
422 const char *name = (char *)request->username->vp_strvalue;
426 return RLM_MODULE_OK;
430 * Check if we've got to proxy the request.
431 * If not, return without adding a Proxy-To-Realm
434 if (check_for_realm(instance, request, &realm) < 0) {
435 return RLM_MODULE_FAIL;
438 return RLM_MODULE_NOOP;
443 * Maybe add a Proxy-To-Realm attribute to the request.
445 DEBUG2(" rlm_realm: Preparing to proxy accounting request to realm \"%s\"\n",
447 add_proxy_to_realm(&request->config_items, realm);
449 return RLM_MODULE_UPDATED; /* try the next module */
452 static int realm_detach(void *instance)
458 /* globally exported name */
459 module_t rlm_realm = {
462 0, /* type: reserved */
463 realm_instantiate, /* instantiation */
464 realm_detach, /* detach */
466 NULL, /* authentication */
467 realm_authorize, /* authorization */
468 realm_preacct, /* preaccounting */
469 NULL, /* accounting */
470 NULL, /* checksimul */
471 NULL, /* pre-proxy */
472 NULL, /* post-proxy */