src/modules/rlm_realm/rlm_realm.c

   1 /*
   2  * rlm_realm.c
   3  *
   4  * Version:     $Id$
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Copyright 2000  The FreeRADIUS server project
  21  * FIXME add copyrights
  22  */
  23
  24 #include "autoconf.h"
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #ifdef HAVE_SYS_TYPES_H
  31 #include <sys/types.h>
  32 #endif
  33
  34 #ifdef HAVE_NETINET_IN_H
  35 #include <netinet/in.h>
  36 #endif
  37
  38 #include "libradius.h"
  39 #include "radiusd.h"
  40 #include "modules.h"
  41
  42 static const char rcsid[] = "$Id$";
  43
  44 #define  REALM_FORMAT_PREFIX   0
  45 #define  REALM_FORMAT_SUFFIX   1
  46
  47 typedef struct realm_config_t {
  48         int        format;
  49         char       *formatstring;
  50         char       *delim;
  51 } realm_config_t;
  52
  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 */
  59 };
  60
  61 /*
  62  *      Internal function to cut down on duplicated code.
  63  *
  64  *      Returns NULL on don't proxy, realm otherwise.
  65  */
  66 static REALM *check_for_realm(void *instance, REQUEST *request)
  67 {
  68         int is_local;
  69         char namebuf[MAX_STRING_LEN];
  70         char *username;
  71         char *realmname = NULL;
  72         char *ptr;
  73         VALUE_PAIR *vp;
  74         REALM *realm;
  75
  76         struct realm_config_t *inst = instance;
  77
  78         /*
  79          *      If the request has a proxy entry, then it's a proxy
  80          *      reply, and we're walking through the module list again.
  81          *
  82          *      In that case, don't bother trying to proxy the request
  83          *      again.
  84          *
  85          *      Also, if there's no User-Name attribute, we can't
  86          *      proxy it, either.
  87          */
  88         if ((request->proxy != NULL) ||
  89             (request->username == NULL)) {
  90                 DEBUG2("    rlm_realm: Proxy reply, or no user name.  Ignoring.");
  91                 return NULL;
  92         }
  93
  94         /*
  95          *      Check for 'Realm' attribute.  If it exists, then we've proxied
  96          *      it already ( via another rlm_realm instance ) and should return.
  97          */
  98
  99         if ( (vp = pairfind(request->packet->vps, PW_REALM)) != NULL ) {
 100                 DEBUG2("    rlm_realm: Request already proxied.  Ignoring.");
 101                 return NULL;
 102         }
 103
 104         /*
 105          *      We will be modifing this later, so we want our own copy
 106          *      of it.
 107          */
 108         strNcpy(namebuf, (char *)request->username->strvalue, sizeof(namebuf));
 109         username = namebuf;
 110
 111         switch(inst->format)
 112         {
 113
 114         case REALM_FORMAT_SUFFIX:
 115
 116           /* DEBUG2("  rlm_realm: Checking for suffix after \"%c\"", inst->delim[0]); */
 117                 realmname = strrchr(username, inst->delim[0]);
 118                 if (realmname) {
 119                         *realmname = '\0';
 120                         realmname++;
 121                 }
 122                 break;
 123
 124         case REALM_FORMAT_PREFIX:
 125
 126                 /* DEBUG2("  rlm_realm: Checking for prefix before \"%c\"", inst->delim[0]); */
 127
 128                 ptr = strchr(username, inst->delim[0]);
 129                 if (ptr) {
 130                         *ptr = '\0';
 131                      ptr++;
 132                      realmname = username;
 133                      username = ptr;
 134                 }
 135                 break;
 136
 137         default:
 138                 realmname = NULL;
 139                 break;
 140         }
 141
 142         DEBUG2("    rlm_realm: Looking up realm %s for User-Name = \"%s\"",
 143                (realmname == NULL) ? "NULL" : realmname,
 144                request->username->strvalue);
 145
 146         /*
 147          *      Allow NULL realms.
 148          */
 149         realm = realm_find(realmname, (request->packet->code == PW_ACCOUNTING_REQUEST));
 150         if (!realm) {
 151                 DEBUG2("    rlm_realm: No such realm %s",
 152                        (realmname == NULL) ? "NULL" : realmname);
 153                 return NULL;
 154         }
 155         DEBUG2("    rlm_realm: Found realm %s", realm->realm);
 156
 157         /*
 158          *      If we've been told to strip the realm off, then do so.
 159          */
 160         if (realm->striprealm) {
 161                 /*
 162                  *      Create the Stripped-User-Name attribute, if it
 163                  *      doesn't exist.
 164                  *
 165                  */
 166                 if (request->username->attribute != PW_STRIPPED_USER_NAME) {
 167                         vp = paircreate(PW_STRIPPED_USER_NAME, PW_TYPE_STRING);
 168                         if (!vp) {
 169                                 radlog(L_ERR|L_CONS, "no memory");
 170                                 exit(1);
 171                         }
 172                         pairadd(&request->packet->vps, vp);
 173                         DEBUG2("    rlm_realm: Adding Stripped-User-Name = \"%s\"", username);
 174                 } else {
 175                         vp = request->username;
 176                         DEBUG2("    rlm_realm: Setting Stripped-User-Name = \"%s\"", username);
 177                 }
 178
 179                 strcpy(vp->strvalue, username);
 180                 vp->length = strlen((char *)vp->strvalue);
 181                 request->username = vp;
 182         }
 183
 184         DEBUG2("  rlm_realm: Proxying request from user %s to realm %s",
 185                username, realm->realm);
 186
 187         /*
 188          *      Figure out what to do with the request.
 189          */
 190         is_local = FALSE;
 191         switch (request->packet->code) {
 192         default:
 193                 DEBUG2("rlm_realm: Unknown packet code %d\n",
 194                        request->packet->code);
 195                 return NULL;            /* don't do anything */
 196
 197                 /*
 198                  *      Perhaps accounting proxying was turned off.
 199                  */
 200         case PW_ACCOUNTING_REQUEST:
 201                 if (realm->acct_ipaddr == htonl(INADDR_NONE)) {
 202                         DEBUG2("rlm_realm:  Accounting realm is LOCAL.");
 203                         is_local = TRUE;
 204                 }
 205
 206                 if (realm->acct_port == 0) {
 207                         DEBUG2("rlm_realm:  acct_port is not set.  proxy cancelled");
 208                         return NULL;
 209                 }
 210                 break;
 211
 212                 /*
 213                  *      Perhaps authentication proxying was turned off.
 214                  */
 215         case PW_AUTHENTICATION_REQUEST:
 216                 if (realm->ipaddr == htonl(INADDR_NONE)) {
 217                         DEBUG2("rlm_realm:  Authentication realm is LOCAL.");
 218                         is_local = TRUE;
 219                 }
 220
 221                 if (realm->auth_port == 0) {
 222                         DEBUG2("rlm_realm:  auth_port is not set.  proxy cancelled");
 223                         return NULL;
 224                 }
 225                 break;
 226         }
 227
 228         /*
 229          *      Add the realm name to the request.
 230          */
 231         pairadd(&request->packet->vps, pairmake("Realm", realm->realm,
 232                                                 T_OP_EQ));
 233         DEBUG2("    rlm_realm: Adding Realm = \"%s\"", realm->realm);
 234
 235         /*
 236          *      Local realm, don't proxy it.
 237          */
 238         if (is_local) {
 239                 return NULL;
 240         }
 241
 242         /*
 243          *      If this request has arrived from another freeradius server
 244          *      that has already proxied the request, we don't need to do
 245          *      it again.
 246          */
 247         for (vp = request->packet->vps; vp; vp = vp->next) {
 248                 if (vp->attribute == PW_FREERADIUS_PROXIED_TO) {
 249                         if (request->packet->code == PW_AUTHENTICATION_REQUEST &&
 250                             vp->lvalue == realm->ipaddr) {
 251                                 DEBUG2("rlm_realm: Request not proxied due to Freeradius-Proxied-To");
 252                                 return NULL;
 253                         }
 254                         if (request->packet->code == PW_ACCOUNTING_REQUEST &&
 255                             vp->lvalue == realm->acct_ipaddr) {
 256                                 DEBUG2("rlm_realm: Request not proxied due to Freeradius-Proxied-To");
 257                                 return NULL;
 258                         }
 259                 }
 260         }
 261
 262         return realm;
 263 }
 264
 265 /*
 266  *      Add a "Proxy-To-Realm" attribute to the request.
 267  */
 268 static void add_proxy_to_realm(VALUE_PAIR **vps, REALM *realm)
 269 {
 270         VALUE_PAIR *vp;
 271
 272         /*
 273          *      Tell the server to proxy this request to another
 274          *      realm.
 275          */
 276         vp = pairmake("Proxy-To-Realm", realm->realm, T_OP_EQ);
 277         if (!vp) {
 278                 radlog(L_ERR|L_CONS, "no memory");
 279                 exit(1);
 280         }
 281
 282         /*
 283          *  Add it, even if it's already present.
 284          */
 285         pairadd(vps, vp);
 286 }
 287
 288 /*
 289  *  Perform the realm module instantiation.  Configuration info is
 290  *  stored in *instance for later use.
 291  */
 292
 293 static int realm_instantiate(CONF_SECTION *conf, void **instance)
 294 {
 295         struct realm_config_t *inst;
 296
 297         /* setup a storage area for instance data */
 298         inst = rad_malloc(sizeof(struct realm_config_t));
 299
 300         if(cf_section_parse(conf, inst, module_config) < 0) {
 301                free(inst);
 302                return -1;
 303         }
 304
 305         if(strcasecmp(inst->formatstring, "suffix") == 0) {
 306              inst->format = REALM_FORMAT_SUFFIX;
 307         } else if(strcasecmp(inst->formatstring, "prefix") == 0) {
 308              inst->format = REALM_FORMAT_PREFIX;
 309         } else {
 310              radlog(L_ERR, "Bad value \"%s\" for realm format value", inst->formatstring);
 311              free(inst);
 312              return -1;
 313         }
 314         free(inst->formatstring);
 315         if(strlen(inst->delim) != 1) {
 316              radlog(L_ERR, "Bad value \"%s\" for realm delimiter value", inst->delim);
 317              free(inst);
 318              return -1;
 319         }
 320
 321         *instance = inst;
 322         return 0;
 323
 324 }
 325
 326
 327
 328
 329
 330 /*
 331  *  Examine a request for a username with an realm, and if it
 332  *  corresponds to something in the realms file, set that realm as
 333  *  Proxy-To.
 334  *
 335  *  This should very nearly duplicate the old proxy_send() code
 336  */
 337 static int realm_authorize(void *instance, REQUEST *request)
 338 {
 339         REALM *realm;
 340
 341         /*
 342          *      Check if we've got to proxy the request.
 343          *      If not, return without adding a Proxy-To-Realm
 344          *      attribute.
 345          */
 346         realm = check_for_realm(instance, request);
 347         if (!realm) {
 348                 return RLM_MODULE_NOOP;
 349         }
 350
 351         /*
 352          *      Maybe add a Proxy-To-Realm attribute to the request.
 353          */
 354         DEBUG2("rlm_realm:  Preparing to proxy authentication request to realm %s\n",
 355                realm->realm);
 356         add_proxy_to_realm(&request->config_items, realm);
 357
 358         return RLM_MODULE_UPDATED; /* try the next module */
 359 }
 360
 361 /*
 362  * This does the exact same thing as the realm_authorize, it's just called
 363  * differently.
 364  */
 365 static int realm_preacct(void *instance, REQUEST *request)
 366 {
 367         const char *name = (char *)request->username->strvalue;
 368         REALM *realm;
 369
 370         if (!name)
 371           return RLM_MODULE_OK;
 372
 373
 374         /*
 375          *      Check if we've got to proxy the request.
 376          *      If not, return without adding a Proxy-To-Realm
 377          *      attribute.
 378          */
 379         realm = check_for_realm(instance, request);
 380         if (!realm) {
 381                 return RLM_MODULE_NOOP;
 382         }
 383
 384
 385         /*
 386          *      Maybe add a Proxy-To-Realm attribute to the request.
 387          */
 388         DEBUG2("rlm_realm:  Preparing to proxy accounting request to realm %s\n",
 389                realm->realm);
 390         add_proxy_to_realm(&request->config_items, realm);
 391
 392         return RLM_MODULE_OK; /* try the next module */
 393 }
 394
 395 static int realm_detach(void *instance)
 396 {
 397         struct realm_config_t *inst = instance;
 398         free(inst->delim);
 399         free(instance);
 400         return 0;
 401 }
 402
 403 /* globally exported name */
 404 module_t rlm_realm = {
 405   "realm",
 406   0,                            /* type: reserved */
 407   NULL,                         /* initialization */
 408   realm_instantiate,            /* instantiation */
 409   {
 410           NULL,                 /* authentication */
 411           realm_authorize,      /* authorization */
 412           realm_preacct,        /* preaccounting */
 413           NULL,                 /* accounting */
 414           NULL                  /* checksimul */
 415   },
 416   realm_detach,                 /* detach */
 417   NULL,                         /* destroy */
 418 };