src/modules/rlm_exec/rlm_exec.c

   1 /*
   2  * rlm_exec.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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * Copyright 2002,2006  The FreeRADIUS server project
  21  * Copyright 2002  Alan DeKok <aland@ox.org>
  22  */
  23
  24 #include <freeradius-devel/ident.h>
  25 RCSID("$Id$")
  26
  27 #include <freeradius-devel/radiusd.h>
  28 #include <freeradius-devel/modules.h>
  29
  30 /*
  31  *      Define a structure for our module configuration.
  32  */
  33 typedef struct rlm_exec_t {
  34         char    *xlat_name;
  35         int     bare;
  36         int     wait;
  37         char    *program;
  38         char    *input;
  39         char    *output;
  40         char    *packet_type;
  41         unsigned int    packet_code;
  42         int     shell_escape;
  43 } rlm_exec_t;
  44
  45 /*
  46  *      A mapping of configuration file names to internal variables.
  47  *
  48  *      Note that the string is dynamically allocated, so it MUST
  49  *      be freed.  When the configuration file parse re-reads the string,
  50  *      it free's the old one, and strdup's the new one, placing the pointer
  51  *      to the strdup'd string into 'config.string'.  This gets around
  52  *      buffer over-flows.
  53  */
  54 static const CONF_PARSER module_config[] = {
  55         { "wait", PW_TYPE_BOOLEAN,  offsetof(rlm_exec_t,wait), NULL, "yes" },
  56         { "program",  PW_TYPE_STRING_PTR,
  57           offsetof(rlm_exec_t,program), NULL, NULL },
  58         { "input_pairs", PW_TYPE_STRING_PTR,
  59           offsetof(rlm_exec_t,input), NULL, "request" },
  60         { "output_pairs",  PW_TYPE_STRING_PTR,
  61           offsetof(rlm_exec_t,output), NULL, NULL },
  62         { "packet_type", PW_TYPE_STRING_PTR,
  63           offsetof(rlm_exec_t,packet_type), NULL, NULL },
  64         { "shell_escape", PW_TYPE_BOOLEAN,  offsetof(rlm_exec_t,shell_escape), NULL, "yes" },
  65         { NULL, -1, 0, NULL, NULL }             /* end the list */
  66 };
  67
  68
  69 /*
  70  *      Decode the configuration file string to a pointer to
  71  *      a value-pair list in the REQUEST data structure.
  72  */
  73 static VALUE_PAIR **decode_string(REQUEST *request, const char *string)
  74 {
  75         if (!string) return NULL;
  76
  77         /*
  78          *      Yuck.  We need a 'switch' over character strings
  79          *      in C.
  80          */
  81         if (strcmp(string, "request") == 0) {
  82                 return &request->packet->vps;
  83         }
  84
  85         if (strcmp(string, "reply") == 0) {
  86                 if (!request->reply) return NULL;
  87
  88                 return &request->reply->vps;
  89         }
  90
  91 #ifdef WITH_PROXY
  92         if (strcmp(string, "proxy-request") == 0) {
  93                 if (!request->proxy) return NULL;
  94
  95                 return &request->proxy->vps;
  96         }
  97
  98         if (strcmp(string, "proxy-reply") == 0) {
  99                 if (!request->proxy_reply) return NULL;
 100
 101                 return &request->proxy_reply->vps;
 102         }
 103 #endif
 104
 105         if (strcmp(string, "config") == 0) {
 106                 return &request->config_items;
 107         }
 108
 109         if (strcmp(string, "none") == 0) {
 110                 return NULL;
 111         }
 112
 113         return NULL;
 114 }
 115
 116
 117 /*
 118  *      Do xlat of strings.
 119  */
 120 static size_t exec_xlat(void *instance, REQUEST *request,
 121                      char *fmt, char *out, size_t outlen,
 122                      UNUSED RADIUS_ESCAPE_STRING func)
 123 {
 124         int             result;
 125         rlm_exec_t      *inst = instance;
 126         VALUE_PAIR      **input_pairs;
 127         char *p;
 128
 129         input_pairs = decode_string(request, inst->input);
 130         if (!input_pairs) {
 131                 radlog(L_ERR, "rlm_exec (%s): Failed to find input pairs for xlat",
 132                        inst->xlat_name);
 133                 out[0] = '\0';
 134                 return 0;
 135         }
 136
 137         /*
 138          *      FIXME: Do xlat of program name?
 139          */
 140         RDEBUG2("Executing %s", fmt);
 141         result = radius_exec_program(fmt, request, inst->wait,
 142                                      out, outlen, *input_pairs, NULL, inst->shell_escape);
 143         RDEBUG2("result %d", result);
 144         if (result != 0) {
 145                 out[0] = '\0';
 146                 return 0;
 147         }
 148
 149         for (p = out; *p != '\0'; p++) {
 150                 if (*p < ' ') *p = ' ';
 151         }
 152
 153         return strlen(out);
 154 }
 155
 156
 157 /*
 158  *      Detach an instance and free it's data.
 159  */
 160 static int exec_detach(void *instance)
 161 {
 162         rlm_exec_t      *inst = instance;
 163
 164         if (inst->xlat_name) {
 165                 xlat_unregister(inst->xlat_name, exec_xlat);
 166                 free(inst->xlat_name);
 167         }
 168
 169         free(inst);
 170         return 0;
 171 }
 172
 173
 174 /*
 175  *      Do any per-module initialization that is separate to each
 176  *      configured instance of the module.  e.g. set up connections
 177  *      to external databases, read configuration files, set up
 178  *      dictionary entries, etc.
 179  *
 180  *      If configuration information is given in the config section
 181  *      that must be referenced in later calls, store a handle to it
 182  *      in *instance otherwise put a null pointer there.
 183  */
 184 static int exec_instantiate(CONF_SECTION *conf, void **instance)
 185 {
 186         rlm_exec_t      *inst;
 187         const char      *xlat_name;
 188
 189         /*
 190          *      Set up a storage area for instance data
 191          */
 192
 193         inst = rad_malloc(sizeof(rlm_exec_t));
 194         if (!inst)
 195                 return -1;
 196         memset(inst, 0, sizeof(rlm_exec_t));
 197
 198         /*
 199          *      If the configuration parameters can't be parsed, then
 200          *      fail.
 201          */
 202         if (cf_section_parse(conf, inst, module_config) < 0) {
 203                 radlog(L_ERR, "rlm_exec: Failed parsing the configuration");
 204                 exec_detach(inst);
 205                 return -1;
 206         }
 207
 208         /*
 209          *      No input pairs defined.  Why are we executing a program?
 210          */
 211         if (!inst->input) {
 212                 radlog(L_ERR, "rlm_exec: Must define input pairs for external program.");
 213                 exec_detach(inst);
 214                 return -1;
 215         }
 216
 217         /*
 218          *      Sanity check the config.  If we're told to NOT wait,
 219          *      then the output pairs must not be defined.
 220          */
 221         if (!inst->wait &&
 222             (inst->output != NULL)) {
 223                 radlog(L_ERR, "rlm_exec: Cannot read output pairs if wait=no");
 224                 exec_detach(inst);
 225                 return -1;
 226         }
 227
 228         /*
 229          *      Get the packet type on which to execute
 230          */
 231         if (!inst->packet_type) {
 232                 inst->packet_code = 0;
 233         } else {
 234                 DICT_VALUE      *dval;
 235
 236                 dval = dict_valbyname(PW_PACKET_TYPE, 0, inst->packet_type);
 237                 if (!dval) {
 238                         radlog(L_ERR, "rlm_exec: Unknown packet type %s: See list of VALUEs for Packet-Type in share/dictionary", inst->packet_type);
 239                         exec_detach(inst);
 240                         return -1;
 241                 }
 242                 inst->packet_code = dval->value;
 243         }
 244
 245         xlat_name = cf_section_name2(conf);
 246         if (xlat_name == NULL) {
 247                 xlat_name = cf_section_name1(conf);
 248                 inst->bare = 1;
 249         }
 250         if (xlat_name){
 251                 inst->xlat_name = strdup(xlat_name);
 252                 xlat_register(xlat_name, exec_xlat, inst);
 253         }
 254
 255         *instance = inst;
 256
 257         return 0;
 258 }
 259
 260
 261 /*
 262  *  Dispatch an exec method
 263  */
 264 static int exec_dispatch(void *instance, REQUEST *request)
 265 {
 266         int result;
 267         VALUE_PAIR **input_pairs, **output_pairs;
 268         VALUE_PAIR *answer;
 269         rlm_exec_t *inst = (rlm_exec_t *) instance;
 270
 271         /*
 272          *      We need a program to execute.
 273          */
 274         if (!inst->program) {
 275                 radlog(L_ERR, "rlm_exec (%s): We require a program to execute",
 276                        inst->xlat_name);
 277                 return RLM_MODULE_FAIL;
 278         }
 279
 280         /*
 281          *      See if we're supposed to execute it now.
 282          */
 283         if (!((inst->packet_code == 0) ||
 284               (request->packet->code == inst->packet_code) ||
 285               (request->reply->code == inst->packet_code)
 286 #ifdef WITH_PROXY
 287               || (request->proxy &&
 288                (request->proxy->code == inst->packet_code)) ||
 289               (request->proxy_reply &&
 290                (request->proxy_reply->code == inst->packet_code))
 291 #endif
 292                     )) {
 293                 RDEBUG2("Packet type is not %s.  Not executing.",
 294                        inst->packet_type);
 295                 return RLM_MODULE_NOOP;
 296         }
 297
 298         /*
 299          *      Decide what input/output the program takes.
 300          */
 301         input_pairs = decode_string(request, inst->input);
 302         output_pairs = decode_string(request, inst->output);
 303
 304         if (!input_pairs) {
 305                 RDEBUG2("WARNING: Possible parse error in %s",
 306                         inst->input);
 307                 return RLM_MODULE_NOOP;
 308         }
 309
 310         /*
 311          *      It points to the attribute list, but the attribute
 312          *      list is empty.
 313          */
 314         if (!*input_pairs) {
 315                 RDEBUG2("WARNING! Input pairs are empty.  No attributes will be passed to the script");
 316         }
 317
 318         /*
 319          *      This function does it's own xlat of the input program
 320          *      to execute.
 321          *
 322          *      FIXME: if inst->program starts with %{, then
 323          *      do an xlat ourselves.  This will allow us to do
 324          *      program = %{Exec-Program}, which this module
 325          *      xlat's into it's string value, and then the
 326          *      exec program function xlat's it's string value
 327          *      into something else.
 328          */
 329         result = radius_exec_program(inst->program, request,
 330                                      inst->wait, NULL, 0,
 331                                      *input_pairs, &answer, inst->shell_escape);
 332         if (result < 0) {
 333                 radlog(L_ERR, "rlm_exec (%s): External script failed",
 334                        inst->xlat_name);
 335                 return RLM_MODULE_FAIL;
 336         }
 337
 338         /*
 339          *      Move the answer over to the output pairs.
 340          *
 341          *      If we're not waiting, then there are no output pairs.
 342          */
 343         if (output_pairs) pairmove(output_pairs, &answer);
 344
 345         pairfree(&answer);
 346
 347         if (result == 0) {
 348                 return RLM_MODULE_OK;
 349         }
 350         if (result > RLM_MODULE_NUMCODES) {
 351                 return RLM_MODULE_FAIL;
 352         }
 353         return result-1;
 354 }
 355
 356
 357 /*
 358  *      First, look for Exec-Program && Exec-Program-Wait.
 359  *
 360  *      Then, call exec_dispatch.
 361  */
 362 static int exec_postauth(void *instance, REQUEST *request)
 363 {
 364         int result;
 365         int exec_wait = 0;
 366         VALUE_PAIR *vp, *tmp;
 367         rlm_exec_t *inst = (rlm_exec_t *) instance;
 368
 369         vp = pairfind(request->reply->vps, PW_EXEC_PROGRAM, 0);
 370         if (vp) {
 371                 exec_wait = 0;
 372
 373         } else if ((vp = pairfind(request->reply->vps, PW_EXEC_PROGRAM_WAIT, 0)) != NULL) {
 374                 exec_wait = 1;
 375         }
 376         if (!vp) {
 377                 if (!inst->program) return RLM_MODULE_NOOP;
 378
 379                 return exec_dispatch(instance, request);
 380         }
 381
 382         tmp = NULL;
 383         result = radius_exec_program(vp->vp_strvalue, request, exec_wait,
 384                                      NULL, 0, request->packet->vps, &tmp,
 385                                      inst->shell_escape);
 386
 387         /*
 388          *      Always add the value-pairs to the reply.
 389          */
 390         pairmove(&request->reply->vps, &tmp);
 391         pairfree(&tmp);
 392
 393         if (result < 0) {
 394                 /*
 395                  *      Error. radius_exec_program() returns -1 on
 396                  *      fork/exec errors.
 397                  */
 398                 tmp = pairmake("Reply-Message", "Access denied (external check failed)", T_OP_SET);
 399                 pairadd(&request->reply->vps, tmp);
 400
 401                 RDEBUG2("Login incorrect (external check failed)");
 402
 403                 request->reply->code = PW_AUTHENTICATION_REJECT;
 404                 return RLM_MODULE_REJECT;
 405         }
 406         if (result > 0) {
 407                 /*
 408                  *      Reject. radius_exec_program() returns >0
 409                  *      if the exec'ed program had a non-zero
 410                  *      exit status.
 411                  */
 412                 request->reply->code = PW_AUTHENTICATION_REJECT;
 413                 RDEBUG2("Login incorrect (external check said so)");
 414                 return RLM_MODULE_REJECT;
 415         }
 416
 417         return RLM_MODULE_OK;
 418 }
 419
 420 /*
 421  *      First, look for Exec-Program && Exec-Program-Wait.
 422  *
 423  *      Then, call exec_dispatch.
 424  */
 425 static int exec_accounting(void *instance, REQUEST *request)
 426 {
 427         int result;
 428         int exec_wait = 0;
 429         VALUE_PAIR *vp;
 430         rlm_exec_t *inst = (rlm_exec_t *) instance;
 431
 432         /*
 433          *      The "bare" exec module takes care of handling
 434          *      Exec-Program and Exec-Program-Wait.
 435          */
 436         if (!inst->bare) return exec_dispatch(instance, request);
 437
 438         vp = pairfind(request->reply->vps, PW_EXEC_PROGRAM, 0);
 439         if (vp) {
 440                 exec_wait = 0;
 441
 442         } else if ((vp = pairfind(request->reply->vps, PW_EXEC_PROGRAM_WAIT, 0)) != NULL) {
 443                 exec_wait = 1;
 444         }
 445         if (!vp) return RLM_MODULE_NOOP;
 446
 447         result = radius_exec_program(vp->vp_strvalue, request, exec_wait,
 448                                      NULL, 0, request->packet->vps, NULL,
 449                                      inst->shell_escape);
 450         if (result != 0) {
 451                 return RLM_MODULE_REJECT;
 452         }
 453
 454         return RLM_MODULE_OK;
 455 }
 456
 457 /*
 458  *      The module name should be the only globally exported symbol.
 459  *      That is, everything else should be 'static'.
 460  *
 461  *      If the module needs to temporarily modify it's instantiation
 462  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
 463  *      The server will then take care of ensuring that the module
 464  *      is single-threaded.
 465  */
 466 module_t rlm_exec = {
 467         RLM_MODULE_INIT,
 468         "exec",                         /* Name */
 469         RLM_TYPE_CHECK_CONFIG_SAFE,     /* type */
 470         exec_instantiate,               /* instantiation */
 471         exec_detach,                    /* detach */
 472         {
 473                 exec_dispatch,          /* authentication */
 474                 exec_dispatch,          /* authorization */
 475                 exec_dispatch,          /* pre-accounting */
 476                 exec_accounting,        /* accounting */
 477                 NULL,                   /* check simul */
 478                 exec_dispatch,          /* pre-proxy */
 479                 exec_dispatch,          /* post-proxy */
 480                 exec_postauth           /* post-auth */
 481 #ifdef WITH_COA
 482                 , exec_dispatch,
 483                 exec_dispatch
 484 #endif
 485         },
 486 };