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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2000 The FreeRADIUS server project
21 * FIXME add copyrights
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
34 #ifdef HAVE_NETINET_IN_H
35 #include <netinet/in.h>
38 #include "libradius.h"
42 static const char rcsid[] = "$Id$";
44 #define REALM_FORMAT_PREFIX 0
45 #define REALM_FORMAT_SUFFIX 1
47 typedef struct realm_config_t {
53 static CONF_PARSER module_config[] = {
54 { "format", PW_TYPE_STRING_PTR,
55 offsetof(realm_config_t,formatstring), NULL, "suffix" },
56 { "delimiter", PW_TYPE_STRING_PTR,
57 offsetof(realm_config_t,delim), NULL, "@" },
58 { NULL, -1, 0, NULL, NULL } /* end the list */
62 * Internal function to cut down on duplicated code.
64 * Returns NULL on don't proxy, realm otherwise.
66 static REALM *check_for_realm(void *instance, REQUEST *request)
69 char namebuf[MAX_STRING_LEN];
71 char *realmname = NULL;
76 struct realm_config_t *inst = instance;
79 * If the request has a proxy entry, then it's a proxy
80 * reply, and we're walking through the module list again.
82 * In that case, don't bother trying to proxy the request
85 * Also, if there's no User-Name attribute, we can't
88 if ((request->proxy != NULL) ||
89 (request->username == NULL)) {
90 DEBUG2(" rlm_realm: Proxy reply, or no user name. Ignoring.");
95 * Check for 'Realm' attribute. If it exists, then we've proxied
96 * it already ( via another rlm_realm instance ) and should return.
99 if ( (vp = pairfind(request->packet->vps, PW_REALM)) != NULL ) {
100 DEBUG2(" rlm_realm: Request already proxied. Ignoring.");
105 * We will be modifing this later, so we want our own copy
108 strNcpy(namebuf, (char *)request->username->strvalue, sizeof(namebuf));
114 case REALM_FORMAT_SUFFIX:
116 /* DEBUG2(" rlm_realm: Checking for suffix after \"%c\"", inst->delim[0]); */
117 realmname = strrchr(username, inst->delim[0]);
124 case REALM_FORMAT_PREFIX:
126 /* DEBUG2(" rlm_realm: Checking for prefix before \"%c\"", inst->delim[0]); */
128 ptr = strchr(username, inst->delim[0]);
132 realmname = username;
143 * Print out excruciatingly descriptive debugging messages
144 * for the people who find it too difficult to think about
148 DEBUG2(" rlm_realm: Looking up realm %s for User-Name = \"%s\"",
149 realmname, request->username->strvalue);
151 DEBUG2(" rlm_realm: No '%c' in User-Name = \"%s\", looking up realm NULL",
152 inst->delim[0], request->username->strvalue);
158 realm = realm_find(realmname, (request->packet->code == PW_ACCOUNTING_REQUEST));
160 DEBUG2(" rlm_realm: No such realm %s",
161 (realmname == NULL) ? "NULL" : realmname);
164 DEBUG2(" rlm_realm: Found realm %s", realm->realm);
167 * If we've been told to strip the realm off, then do so.
169 if (realm->striprealm) {
171 * Create the Stripped-User-Name attribute, if it
175 if (request->username->attribute != PW_STRIPPED_USER_NAME) {
176 vp = paircreate(PW_STRIPPED_USER_NAME, PW_TYPE_STRING);
178 radlog(L_ERR|L_CONS, "no memory");
181 pairadd(&request->packet->vps, vp);
182 DEBUG2(" rlm_realm: Adding Stripped-User-Name = \"%s\"", username);
184 vp = request->username;
185 DEBUG2(" rlm_realm: Setting Stripped-User-Name = \"%s\"", username);
188 strcpy(vp->strvalue, username);
189 vp->length = strlen((char *)vp->strvalue);
190 request->username = vp;
193 DEBUG2(" rlm_realm: Proxying request from user %s to realm %s",
194 username, realm->realm);
197 * Add the realm name to the request.
199 pairadd(&request->packet->vps, pairmake("Realm", realm->realm,
201 DEBUG2(" rlm_realm: Adding Realm = \"%s\"", realm->realm);
204 * Figure out what to do with the request.
207 switch (request->packet->code) {
209 DEBUG2("rlm_realm: Unknown packet code %d\n",
210 request->packet->code);
211 return NULL; /* don't do anything */
214 * Perhaps accounting proxying was turned off.
216 case PW_ACCOUNTING_REQUEST:
217 if (realm->acct_ipaddr == htonl(INADDR_NONE)) {
218 DEBUG2("rlm_realm: Accounting realm is LOCAL.");
222 if (realm->acct_port == 0) {
223 DEBUG2("rlm_realm: acct_port is not set. proxy cancelled");
229 * Perhaps authentication proxying was turned off.
231 case PW_AUTHENTICATION_REQUEST:
232 if (realm->ipaddr == htonl(INADDR_NONE)) {
233 DEBUG2("rlm_realm: Authentication realm is LOCAL.");
237 if (realm->auth_port == 0) {
238 DEBUG2("rlm_realm: auth_port is not set. proxy cancelled");
245 * Local realm, don't proxy it.
252 * If this request has arrived from another freeradius server
253 * that has already proxied the request, we don't need to do
256 for (vp = request->packet->vps; vp; vp = vp->next) {
257 if (vp->attribute == PW_FREERADIUS_PROXIED_TO) {
258 if (request->packet->code == PW_AUTHENTICATION_REQUEST &&
259 vp->lvalue == realm->ipaddr) {
260 DEBUG2("rlm_realm: Request not proxied due to Freeradius-Proxied-To");
263 if (request->packet->code == PW_ACCOUNTING_REQUEST &&
264 vp->lvalue == realm->acct_ipaddr) {
265 DEBUG2("rlm_realm: Request not proxied due to Freeradius-Proxied-To");
275 * Add a "Proxy-To-Realm" attribute to the request.
277 static void add_proxy_to_realm(VALUE_PAIR **vps, REALM *realm)
282 * Tell the server to proxy this request to another
285 vp = pairmake("Proxy-To-Realm", realm->realm, T_OP_EQ);
287 radlog(L_ERR|L_CONS, "no memory");
292 * Add it, even if it's already present.
298 * Perform the realm module instantiation. Configuration info is
299 * stored in *instance for later use.
302 static int realm_instantiate(CONF_SECTION *conf, void **instance)
304 struct realm_config_t *inst;
306 /* setup a storage area for instance data */
307 inst = rad_malloc(sizeof(struct realm_config_t));
309 if(cf_section_parse(conf, inst, module_config) < 0) {
314 if(strcasecmp(inst->formatstring, "suffix") == 0) {
315 inst->format = REALM_FORMAT_SUFFIX;
316 } else if(strcasecmp(inst->formatstring, "prefix") == 0) {
317 inst->format = REALM_FORMAT_PREFIX;
319 radlog(L_ERR, "Bad value \"%s\" for realm format value", inst->formatstring);
323 free(inst->formatstring);
324 if(strlen(inst->delim) != 1) {
325 radlog(L_ERR, "Bad value \"%s\" for realm delimiter value", inst->delim);
340 * Examine a request for a username with an realm, and if it
341 * corresponds to something in the realms file, set that realm as
344 * This should very nearly duplicate the old proxy_send() code
346 static int realm_authorize(void *instance, REQUEST *request)
351 * Check if we've got to proxy the request.
352 * If not, return without adding a Proxy-To-Realm
355 realm = check_for_realm(instance, request);
357 return RLM_MODULE_NOOP;
361 * Maybe add a Proxy-To-Realm attribute to the request.
363 DEBUG2("rlm_realm: Preparing to proxy authentication request to realm %s\n",
365 add_proxy_to_realm(&request->config_items, realm);
367 return RLM_MODULE_UPDATED; /* try the next module */
371 * This does the exact same thing as the realm_authorize, it's just called
374 static int realm_preacct(void *instance, REQUEST *request)
376 const char *name = (char *)request->username->strvalue;
380 return RLM_MODULE_OK;
384 * Check if we've got to proxy the request.
385 * If not, return without adding a Proxy-To-Realm
388 realm = check_for_realm(instance, request);
390 return RLM_MODULE_NOOP;
395 * Maybe add a Proxy-To-Realm attribute to the request.
397 DEBUG2("rlm_realm: Preparing to proxy accounting request to realm %s\n",
399 add_proxy_to_realm(&request->config_items, realm);
401 return RLM_MODULE_OK; /* try the next module */
404 static int realm_detach(void *instance)
406 struct realm_config_t *inst = instance;
412 /* globally exported name */
413 module_t rlm_realm = {
415 0, /* type: reserved */
416 NULL, /* initialization */
417 realm_instantiate, /* instantiation */
419 NULL, /* authentication */
420 realm_authorize, /* authorization */
421 realm_preacct, /* preaccounting */
422 NULL, /* accounting */
423 NULL, /* checksimul */
424 NULL, /* pre-proxy */
425 NULL, /* post-proxy */
428 realm_detach, /* detach */