src/modules/rlm_perl/rlm_perl.c

   1  /*
   2  * rlm_perl.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  The FreeRADIUS server project
  21  * Copyright 2002  Boian Jordanov <bjordanov@orbitel.bg>
  22  */
  23
  24 #include <freeradius-devel/autoconf.h>
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include <freeradius-devel/radiusd.h>
  31 #include <freeradius-devel/modules.h>
  32 #include <freeradius-devel/conffile.h>
  33
  34 #ifdef DEBUG
  35 #undef DEBUG
  36 #endif
  37
  38 #ifdef INADDR_ANY
  39 #undef INADDR_ANY
  40 #endif
  41
  42 #include <EXTERN.h>
  43 #include <perl.h>
  44 #include <XSUB.h>
  45 #include <dlfcn.h>
  46 #include <semaphore.h>
  47
  48 #ifdef __APPLE__
  49 extern char **environ;
  50 #endif
  51
  52 static const char rcsid[] = "$Id$";
  53
  54 #ifdef USE_ITHREADS
  55
  56 /*
  57  * Pool of Perl's clones (genetically cloned) ;)
  58  *
  59  */
  60 typedef struct pool_handle {
  61         struct pool_handle      *next;
  62         struct pool_handle      *prev;
  63         enum {busy, idle}       status;
  64         unsigned int            request_count;
  65         PerlInterpreter         *clone;
  66         perl_mutex              lock;
  67 } POOL_HANDLE;
  68
  69 typedef struct PERL_POOL {
  70         POOL_HANDLE     *head;
  71         POOL_HANDLE     *tail;
  72
  73         int             current_clones;
  74         int             active_clones;
  75         int             max_clones;
  76         int             start_clones;
  77         int             min_spare_clones;
  78         int             max_spare_clones;
  79         int             max_request_per_clone;
  80         int             cleanup_delay;
  81         enum {yes,no}   detach;
  82         perl_mutex      mutex;
  83         time_t          time_when_last_added;
  84 } PERL_POOL;
  85
  86 #endif
  87
  88 /*
  89  *      Define a structure for our module configuration.
  90  *
  91  *      These variables do not need to be in a structure, but it's
  92  *      a lot cleaner to do so, and a pointer to the structure can
  93  *      be used as the instance handle.
  94  */
  95 typedef struct perl_inst {
  96         /* Name of the perl module */
  97         char    *module;
  98
  99         /* Name of the functions for each module method */
 100         char    *func_authorize;
 101         char    *func_authenticate;
 102         char    *func_accounting;
 103         char    *func_start_accounting;
 104         char    *func_stop_accounting;
 105         char    *func_preacct;
 106         char    *func_checksimul;
 107         char    *func_detach;
 108         char    *func_xlat;
 109         char    *func_pre_proxy;
 110         char    *func_post_proxy;
 111         char    *func_post_auth;
 112         char    *xlat_name;
 113         char    *perl_flags;
 114         PerlInterpreter *perl;
 115 #ifdef USE_ITHREADS
 116         PERL_POOL       *perl_pool;
 117 #endif
 118 } PERL_INST;
 119 /*
 120  *      A mapping of configuration file names to internal variables.
 121  *
 122  *      Note that the string is dynamically allocated, so it MUST
 123  *      be freed.  When the configuration file parse re-reads the string,
 124  *      it free's the old one, and strdup's the new one, placing the pointer
 125  *      to the strdup'd string into 'config.string'.  This gets around
 126  *      buffer over-flows.
 127  */
 128 static const CONF_PARSER module_config[] = {
 129         { "module",  PW_TYPE_FILENAME,
 130           offsetof(PERL_INST,module), NULL,  "module"},
 131         { "func_authorize", PW_TYPE_STRING_PTR,
 132           offsetof(PERL_INST,func_authorize), NULL, "authorize"},
 133         { "func_authenticate", PW_TYPE_STRING_PTR,
 134           offsetof(PERL_INST,func_authenticate), NULL, "authenticate"},
 135         { "func_accounting", PW_TYPE_STRING_PTR,
 136           offsetof(PERL_INST,func_accounting), NULL, "accounting"},
 137         { "func_preacct", PW_TYPE_STRING_PTR,
 138           offsetof(PERL_INST,func_preacct), NULL, "preacct"},
 139         { "func_checksimul", PW_TYPE_STRING_PTR,
 140           offsetof(PERL_INST,func_checksimul), NULL, "checksimul"},
 141         { "func_detach", PW_TYPE_STRING_PTR,
 142           offsetof(PERL_INST,func_detach), NULL, "detach"},
 143         { "func_xlat", PW_TYPE_STRING_PTR,
 144           offsetof(PERL_INST,func_xlat), NULL, "xlat"},
 145         { "func_pre_proxy", PW_TYPE_STRING_PTR,
 146           offsetof(PERL_INST,func_pre_proxy), NULL, "pre_proxy"},
 147         { "func_post_proxy", PW_TYPE_STRING_PTR,
 148           offsetof(PERL_INST,func_post_proxy), NULL, "post_proxy"},
 149         { "func_post_auth", PW_TYPE_STRING_PTR,
 150           offsetof(PERL_INST,func_post_auth), NULL, "post_auth"},
 151         { "perl_flags", PW_TYPE_STRING_PTR,
 152           offsetof(PERL_INST,perl_flags), NULL, NULL},
 153         { "func_start_accounting", PW_TYPE_STRING_PTR,
 154           offsetof(PERL_INST,func_start_accounting), NULL, NULL},
 155         { "func_stop_accounting", PW_TYPE_STRING_PTR,
 156           offsetof(PERL_INST,func_stop_accounting), NULL, NULL},
 157
 158         { NULL, -1, 0, NULL, NULL }             /* end the list */
 159 };
 160
 161 /*
 162  * man perlembed
 163  */
 164 EXTERN_C void boot_DynaLoader(pTHX_ CV* cv);
 165
 166 #ifdef USE_ITHREADS
 167 /*
 168  *      We use one perl to clone from it i.e. main boss
 169  *      We clone it for every instance if we have perl
 170  *      with -Duseithreads compiled in
 171  */
 172 static PerlInterpreter  *interp = NULL;
 173
 174 static const CONF_PARSER pool_conf[] = {
 175         { "max_clones", PW_TYPE_INTEGER, offsetof(PERL_POOL, max_clones), NULL,         "32"},
 176         { "start_clones",PW_TYPE_INTEGER, offsetof(PERL_POOL, start_clones), NULL,              "32"},
 177         { "min_spare_clones",PW_TYPE_INTEGER, offsetof(PERL_POOL, min_spare_clones),NULL,       "0"},
 178         { "max_spare_clones",PW_TYPE_INTEGER, offsetof(PERL_POOL,max_spare_clones),NULL,        "32"},
 179         { "cleanup_delay",PW_TYPE_INTEGER, offsetof(PERL_POOL,cleanup_delay),NULL,              "5"},
 180         { "max_request_per_clone",PW_TYPE_INTEGER, offsetof(PERL_POOL,max_request_per_clone),NULL,      "0"},
 181         { NULL, -1, 0, NULL, NULL }             /* end the list */
 182 };
 183
 184
 185 #define dl_librefs "DynaLoader::dl_librefs"
 186 #define dl_modules "DynaLoader::dl_modules"
 187 static void rlm_perl_clear_handles(pTHX)
 188 {
 189         AV *librefs = get_av(dl_librefs, FALSE);
 190         if (librefs) {
 191                 av_clear(librefs);
 192         }
 193 }
 194
 195 static void **rlm_perl_get_handles(pTHX)
 196 {
 197         I32 i;
 198         AV *librefs = get_av(dl_librefs, FALSE);
 199         AV *modules = get_av(dl_modules, FALSE);
 200         void **handles;
 201
 202         if (!librefs) {
 203                 radlog(L_ERR,
 204                    "Could not get @%s for unloading.\n",
 205                    dl_librefs);
 206                 return NULL;
 207         }
 208
 209         if (!(AvFILL(librefs) >= 0)) {
 210                 return NULL;
 211         }
 212
 213         handles = (void **)rad_malloc(sizeof(void *) * (AvFILL(librefs)+2));
 214
 215         for (i=0; i<=AvFILL(librefs); i++) {
 216                 void *handle;
 217                 SV *handle_sv = *av_fetch(librefs, i, FALSE);
 218
 219                 if(!handle_sv) {
 220                     radlog(L_ERR,
 221                                "Could not fetch $%s[%d]!\n",
 222                                dl_librefs, (int)i);
 223                     continue;
 224                 }
 225                 handle = (void *)SvIV(handle_sv);
 226
 227                 if (handle) {
 228                     handles[i] = handle;
 229                 }
 230         }
 231
 232         av_clear(modules);
 233         av_clear(librefs);
 234
 235         handles[i] = (void *)0;
 236
 237         return handles;
 238 }
 239
 240 static void rlm_perl_close_handles(void **handles)
 241 {
 242         int i;
 243
 244         if (!handles) {
 245                 return;
 246         }
 247
 248         for (i=0; handles[i]; i++) {
 249                 radlog(L_DBG, "close 0x%lx\n", (unsigned long)handles[i]);
 250                 dlclose(handles[i]);
 251         }
 252
 253         free(handles);
 254 }
 255
 256 static PerlInterpreter *rlm_perl_clone(PerlInterpreter *perl)
 257 {
 258         PerlInterpreter *clone;
 259         UV clone_flags = 0;
 260
 261         PERL_SET_CONTEXT(perl);
 262
 263         clone = perl_clone(perl, clone_flags);
 264         {
 265                 dTHXa(clone);
 266         }
 267 #if PERL_REVISION >= 5 && PERL_VERSION <8
 268         call_pv("CLONE",0);
 269 #endif
 270         ptr_table_free(PL_ptr_table);
 271         PL_ptr_table = NULL;
 272
 273         PERL_SET_CONTEXT(aTHX);
 274         rlm_perl_clear_handles(aTHX);
 275
 276         return clone;
 277 }
 278
 279 static void rlm_perl_destruct(PerlInterpreter *perl)
 280 {
 281         char **orig_environ = NULL;
 282         dTHXa(perl);
 283
 284         PERL_SET_CONTEXT(perl);
 285
 286         PL_perl_destruct_level = 2;
 287
 288         PL_origenviron = environ;
 289
 290         {
 291                 dTHXa(perl);
 292         }
 293         /*
 294          * FIXME: This shouldn't happen
 295          *
 296          */
 297         while (PL_scopestack_ix > 1 ){
 298                 LEAVE;
 299         }
 300
 301         perl_destruct(perl);
 302         perl_free(perl);
 303
 304         if (orig_environ) {
 305                 environ = orig_environ;
 306         }
 307 }
 308
 309 static void rlm_destroy_perl(PerlInterpreter *perl)
 310 {
 311         void    **handles;
 312
 313         dTHXa(perl);
 314         PERL_SET_CONTEXT(perl);
 315
 316         handles = rlm_perl_get_handles(aTHX);
 317         rlm_perl_destruct(perl);
 318         rlm_perl_close_handles(handles);
 319 }
 320
 321 static void delete_pool_handle(POOL_HANDLE *handle, PERL_INST *inst)
 322 {
 323         POOL_HANDLE *prev;
 324         POOL_HANDLE *next;
 325
 326         prev = handle->prev;
 327         next = handle->next;
 328
 329         if (prev == NULL) {
 330                 inst->perl_pool->head = next;
 331         } else {
 332                 prev->next = next;
 333         }
 334
 335         if (next == NULL) {
 336                 inst->perl_pool->tail = prev;
 337         } else {
 338                 next->prev = prev;
 339         }
 340         inst->perl_pool->current_clones--;
 341         MUTEX_DESTROY(&handle->lock);
 342         free(handle);
 343 }
 344
 345 static void move2tail(POOL_HANDLE *handle, PERL_INST *inst)
 346 {
 347         POOL_HANDLE *prev;
 348         POOL_HANDLE *next;
 349
 350         if (inst->perl_pool->head == NULL) {
 351
 352                 handle->prev = NULL;
 353                 handle->next = NULL;
 354                 inst->perl_pool->head = handle;
 355                 inst->perl_pool->tail = handle;
 356                 return;
 357         }
 358
 359         if (inst->perl_pool->tail == handle) {
 360                 return;
 361         }
 362
 363         prev = handle->prev;
 364         next = handle->next;
 365
 366         if ((next != NULL) ||
 367                         (prev != NULL)) {
 368                 if (next == NULL) {
 369                         return;
 370                 }
 371
 372                 if (prev == NULL) {
 373                         inst->perl_pool->head = next;
 374                         next->prev = NULL;
 375
 376                 } else {
 377
 378                         prev->next = next;
 379                         next->prev = prev;
 380                 }
 381         }
 382
 383         handle->next = NULL;
 384         prev = inst->perl_pool->tail;
 385
 386         inst->perl_pool->tail = handle;
 387         handle->prev = prev;
 388         prev->next = handle;
 389 }
 390
 391
 392 static POOL_HANDLE *pool_grow (PERL_INST *inst) {
 393         POOL_HANDLE *handle;
 394         time_t  now;
 395
 396         if (inst->perl_pool->max_clones == inst->perl_pool->current_clones) {
 397                 return NULL;
 398         }
 399         if (inst->perl_pool->detach == yes ) {
 400                 return NULL;
 401         }
 402
 403         handle = (POOL_HANDLE *)rad_malloc(sizeof(POOL_HANDLE));
 404
 405         if (!handle) {
 406                 radlog(L_ERR,"Could not find free memory for pool. Aborting");
 407                 return NULL;
 408         }
 409
 410         handle->prev = NULL;
 411         handle->next = NULL;
 412         handle->status = idle;
 413         handle->clone = rlm_perl_clone(inst->perl);
 414         handle->request_count = 0;
 415         MUTEX_INIT(&handle->lock);
 416         inst->perl_pool->current_clones++;
 417         move2tail(handle, inst);
 418
 419         now = time(NULL);
 420         inst->perl_pool->time_when_last_added = now;
 421
 422         return handle;
 423 }
 424
 425 static POOL_HANDLE *pool_pop(PERL_INST *inst)
 426 {
 427         POOL_HANDLE     *handle;
 428         POOL_HANDLE     *found;
 429         POOL_HANDLE     *tmp;
 430         /*
 431          * Lock the pool and be fast other thread maybe
 432          * waiting for us to finish
 433          */
 434         MUTEX_LOCK(&inst->perl_pool->mutex);
 435
 436         found = NULL;
 437
 438         for (handle = inst->perl_pool->head; handle ; handle = tmp) {
 439                 tmp = handle->next;
 440
 441                 if (handle->status == idle){
 442                         found = handle;
 443                         break;
 444                 }
 445         }
 446
 447         if (found == NULL) {
 448                 if (inst->perl_pool->current_clones < inst->perl_pool->max_clones ) {
 449
 450                         found = pool_grow(inst);
 451
 452                         if (found == NULL) {
 453                                 radlog(L_ERR,"Cannot grow pool returning");
 454                                 MUTEX_UNLOCK(&inst->perl_pool->mutex);
 455                                 return NULL;
 456                         }
 457                 } else {
 458                         radlog(L_ERR,"rlm_perl:: reached maximum clones %d cannot grow",
 459                                         inst->perl_pool->current_clones);
 460                         MUTEX_UNLOCK(&inst->perl_pool->mutex);
 461                         return NULL;
 462                 }
 463         }
 464
 465         move2tail(found, inst);
 466         found->status = busy;
 467         MUTEX_LOCK(&found->lock);
 468         inst->perl_pool->active_clones++;
 469         found->request_count++;
 470         /*
 471          * Hurry Up
 472          */
 473         MUTEX_UNLOCK(&inst->perl_pool->mutex);
 474         radlog(L_DBG,"perl_pool: item 0x%lx asigned new request. Handled so far: %d",
 475                         (unsigned long) found->clone, found->request_count);
 476         return found;
 477 }
 478 static int pool_release(POOL_HANDLE *handle, PERL_INST *inst) {
 479
 480         POOL_HANDLE *tmp, *tmp2;
 481         int spare, i, t;
 482         time_t  now;
 483         /*
 484          * Lock it
 485          */
 486         MUTEX_LOCK(&inst->perl_pool->mutex);
 487
 488         /*
 489          * If detach is set then just release the mutex
 490          */
 491         if (inst->perl_pool->detach == yes ) {
 492         handle->status = idle;
 493                 MUTEX_UNLOCK(&handle->lock);
 494                 MUTEX_UNLOCK(&inst->perl_pool->mutex);
 495                 return 0;
 496         }
 497
 498         MUTEX_UNLOCK(&handle->lock);
 499         handle->status = idle;
 500         inst->perl_pool->active_clones--;
 501
 502         spare = inst->perl_pool->current_clones - inst->perl_pool->active_clones;
 503
 504         radlog(L_DBG,"perl_pool total/active/spare [%d/%d/%d]"
 505                         , inst->perl_pool->current_clones, inst->perl_pool->active_clones, spare);
 506
 507         if (spare < inst->perl_pool->min_spare_clones) {
 508                 t = inst->perl_pool->min_spare_clones - spare;
 509                 for (i=0;i<t; i++) {
 510                         if ((tmp = pool_grow(inst)) == NULL) {
 511                                 MUTEX_UNLOCK(&inst->perl_pool->mutex);
 512                                 return -1;
 513                         }
 514                 }
 515                 MUTEX_UNLOCK(&inst->perl_pool->mutex);
 516                 return 0;
 517         }
 518         now = time(NULL);
 519         if ((now - inst->perl_pool->time_when_last_added) < inst->perl_pool->cleanup_delay) {
 520                 MUTEX_UNLOCK(&inst->perl_pool->mutex);
 521                 return 0;
 522         }
 523         if (spare > inst->perl_pool->max_spare_clones) {
 524                 spare -= inst->perl_pool->max_spare_clones;
 525                 for (tmp = inst->perl_pool->head; (tmp !=NULL ) && (spare > 0) ; tmp = tmp2) {
 526                         tmp2 = tmp->next;
 527
 528                         if(tmp->status == idle) {
 529                                 rlm_destroy_perl(tmp->clone);
 530                                 delete_pool_handle(tmp,inst);
 531                                 spare--;
 532                                 break;
 533                         }
 534                 }
 535         }
 536         /*
 537          * If the clone have reached max_request_per_clone clean it.
 538          */
 539         if (inst->perl_pool->max_request_per_clone > 0 ) {
 540                         if (handle->request_count > inst->perl_pool->max_request_per_clone) {
 541                                 rlm_destroy_perl(handle->clone);
 542                                 delete_pool_handle(handle,inst);
 543                 }
 544         }
 545         /*
 546          * Hurry Up :)
 547          */
 548         MUTEX_UNLOCK(&inst->perl_pool->mutex);
 549         return 0;
 550 }
 551 static int init_pool (CONF_SECTION *conf, PERL_INST *inst) {
 552         POOL_HANDLE     *handle;
 553         int t;
 554         PERL_POOL       *pool;
 555
 556
 557         pool = rad_malloc(sizeof(PERL_POOL));
 558         memset(pool,0,sizeof(PERL_POOL));
 559
 560         inst->perl_pool = pool;
 561
 562         MUTEX_INIT(&pool->mutex);
 563
 564         /*
 565          * Read The Config
 566          *
 567          */
 568
 569         cf_section_parse(conf,pool,pool_conf);
 570         inst->perl_pool = pool;
 571         inst->perl_pool->detach = no;
 572
 573         for(t = 0;t < inst->perl_pool->start_clones ;t++){
 574                 if ((handle = pool_grow(inst)) == NULL) {
 575                         return -1;
 576                 }
 577
 578         }
 579
 580         return 1;
 581 }
 582 #endif
 583
 584 static void xs_init(pTHX)
 585 {
 586         char *file = __FILE__;
 587
 588         /* DynaLoader is a special case */
 589         newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
 590
 591 }
 592 /*
 593  *
 594  * This is wrapper for radlog
 595  * Now users can call radiusd::radlog(level,msg) wich is the same
 596  * calling radlog from C code.
 597  * Boyan
 598  */
 599 static XS(XS_radiusd_radlog)
 600 {
 601        dXSARGS;
 602        if (items !=2)
 603                croak("Usage: radiusd::radlog(level, message)");
 604        {
 605                int     level;
 606                char    *msg;
 607
 608                level = (int) SvIV(ST(0));
 609                msg   = (char *) SvPV(ST(1), PL_na);
 610
 611                /*
 612                 *       Because 'msg' is a 'char *', we don't want '%s', etc.
 613                 *       in it to give us printf-style vulnerabilities.
 614                 */
 615                radlog(level, "rlm_perl: %s", msg);
 616         }
 617        XSRETURN_NO;
 618 }
 619
 620 /*
 621  * The xlat function
 622  */
 623 static int perl_xlat(void *instance, REQUEST *request, char *fmt, char * out,
 624                      size_t freespace, RADIUS_ESCAPE_STRING func)
 625 {
 626
 627         PERL_INST       *inst= (PERL_INST *) instance;
 628         PerlInterpreter *perl;
 629         char            params[1024], *ptr, *tmp;
 630         int             count, ret=0;
 631         STRLEN          n_a;
 632
 633         /*
 634          * Do an xlat on the provided string (nice recursive operation).
 635         */
 636         if (!radius_xlat(params, sizeof(params), fmt, request, func)) {
 637                 radlog(L_ERR, "rlm_perl: xlat failed.");
 638                 return 0;
 639         }
 640 #ifndef USE_ITHREADS
 641         perl = inst->perl;
 642 #endif
 643 #ifdef USE_ITHREADS
 644         POOL_HANDLE     *handle;
 645
 646         if ((handle = pool_pop(instance)) == NULL) {
 647                 return 0;
 648         }
 649
 650         perl = handle->clone;
 651
 652         radlog(L_DBG,"Found a interpetator 0x%lx",(unsigned long) perl);
 653         {
 654         dTHXa(perl);
 655         }
 656 #endif
 657         PERL_SET_CONTEXT(perl);
 658         {
 659         dSP;
 660         ENTER;SAVETMPS;
 661
 662         ptr = strtok(params, " ");
 663
 664         PUSHMARK(SP);
 665
 666         while (ptr != NULL) {
 667                 XPUSHs(sv_2mortal(newSVpv(ptr,0)));
 668                 ptr = strtok(NULL, " ");
 669         }
 670
 671         PUTBACK;
 672
 673         count = call_pv(inst->func_xlat, G_SCALAR | G_EVAL);
 674
 675         SPAGAIN;
 676         if (SvTRUE(ERRSV)) {
 677                 radlog(L_ERR, "rlm_perl: perl_xlat exit %s\n",
 678                        SvPV(ERRSV,n_a));
 679                 POPs ;
 680         } else if (count > 0) {
 681                 tmp = POPp;
 682                 ret = strlen(tmp);
 683                 strncpy(out,tmp,ret);
 684
 685                 radlog(L_DBG,"rlm_perl: Len is %d , out is %s freespace is %d",
 686                        ret, out,freespace);
 687         }
 688
 689         PUTBACK ;
 690         FREETMPS ;
 691         LEAVE ;
 692
 693         }
 694 #ifdef USE_ITHREADS
 695         pool_release(handle, instance);
 696 #endif
 697         return ret;
 698 }
 699 /*
 700  *      Do any per-module initialization that is separate to each
 701  *      configured instance of the module.  e.g. set up connections
 702  *      to external databases, read configuration files, set up
 703  *      dictionary entries, etc.
 704  *
 705  *      If configuration information is given in the config section
 706  *      that must be referenced in later calls, store a handle to it
 707  *      in *instance otherwise put a null pointer there.
 708  *
 709  *      Boyan:
 710  *      Setup a hashes wich we will use later
 711  *      parse a module and give him a chance to live
 712  *
 713  */
 714 static int perl_instantiate(CONF_SECTION *conf, void **instance)
 715 {
 716         PERL_INST       *inst = (PERL_INST *) instance;
 717         HV              *rad_reply_hv;
 718         HV              *rad_check_hv;
 719         HV              *rad_request_hv;
 720         HV              *rad_request_proxy_hv;
 721         HV              *rad_request_proxy_reply_hv;
 722         AV              *end_AV;
 723
 724         char *embed[4];
 725         const char *xlat_name;
 726         int exitstatus = 0, argc=0;
 727
 728         /*
 729          *      Set up a storage area for instance data
 730          */
 731         inst = rad_malloc(sizeof(PERL_INST));
 732         memset(inst, 0, sizeof(PERL_INST));
 733
 734         /*
 735          *      If the configuration parameters can't be parsed, then
 736          *      fail.
 737          */
 738         if (cf_section_parse(conf, inst, module_config) < 0) {
 739                 free(inst);
 740                 return -1;
 741         }
 742
 743
 744         embed[0] = NULL;
 745         if (inst->perl_flags) {
 746                 embed[1] = inst->perl_flags;
 747                 embed[2] = inst->module;
 748                 embed[3] = "0";
 749                 argc = 4;
 750         } else {
 751                 embed[1] = inst->module;
 752                 embed[2] = "0";
 753                 argc = 3;
 754         }
 755
 756 #ifdef USE_ITHREADS
 757         inst->perl = interp;
 758
 759         if ((inst->perl = perl_alloc()) == NULL) {
 760                 radlog(L_DBG, "rlm_perl: No memory for allocating new perl !");
 761                 return (-1);
 762         }
 763
 764         perl_construct(inst->perl);
 765         PL_perl_destruct_level = 2;
 766
 767         {
 768         dTHXa(inst->perl);
 769         }
 770         PERL_SET_CONTEXT(inst->perl);
 771 #else
 772         if ((inst->perl = perl_alloc()) == NULL) {
 773                 radlog(L_ERR, "rlm_perl: No memory for allocating new perl !");
 774                 return -1;
 775         }
 776
 777         perl_construct(inst->perl);
 778 #endif
 779
 780 #if PERL_REVISION >= 5 && PERL_VERSION >=8
 781         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
 782 #endif
 783
 784         exitstatus = perl_parse(inst->perl, xs_init, argc, embed, NULL);
 785
 786         end_AV = PL_endav;
 787         PL_endav = Nullav;
 788
 789         if(!exitstatus) {
 790                 exitstatus = perl_run(inst->perl);
 791         } else {
 792                 radlog(L_ERR,"rlm_perl: perl_parse failed: %s not found or has syntax errors. \n", inst->module);
 793                 return (-1);
 794         }
 795
 796         PL_endav = end_AV;
 797
 798         newXS("radiusd::radlog",XS_radiusd_radlog, "rlm_perl.c");
 799
 800         rad_reply_hv = newHV();
 801         rad_check_hv = newHV();
 802         rad_request_hv = newHV();
 803         rad_request_proxy_hv = newHV();
 804         rad_request_proxy_reply_hv = newHV();
 805
 806         rad_reply_hv = get_hv("RAD_REPLY",1);
 807         rad_check_hv = get_hv("RAD_CHECK",1);
 808         rad_request_hv = get_hv("RAD_REQUEST",1);
 809         rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
 810         rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
 811
 812         xlat_name = cf_section_name2(conf);
 813         if (xlat_name == NULL)
 814                 xlat_name = cf_section_name1(conf);
 815         if (xlat_name){
 816                 inst->xlat_name = strdup(xlat_name);
 817                 xlat_register(xlat_name, perl_xlat, inst);
 818         }
 819
 820 #ifdef USE_ITHREADS
 821         if ((init_pool(conf, inst)) == -1) {
 822                 radlog(L_ERR,"Couldn't init a pool of perl clones. Exiting");
 823                 return -1;
 824         }
 825
 826 #endif
 827         *instance = inst;
 828
 829         return 0;
 830 }
 831
 832 /*
 833  *      get the vps and put them in perl hash
 834  *      If one VP have multiple values it is added as array_ref
 835  *      Example for this is Cisco-AVPair that holds multiple values.
 836  *      Which will be available as array_ref in $RAD_REQUEST{'Cisco-AVPair'}
 837  */
 838 static void perl_store_vps(VALUE_PAIR *vp, HV *rad_hv)
 839 {
 840         VALUE_PAIR      *nvp, *vpa, *vpn;
 841         AV              *av;
 842         char            buffer[1024];
 843         int             attr, len;
 844
 845         hv_undef(rad_hv);
 846         nvp = paircopy(vp);
 847
 848         while (nvp != NULL) {
 849                 attr = nvp->attribute;
 850                 vpa = paircopy2(nvp,attr);
 851                 if (vpa->next) {
 852                         av = newAV();
 853                         vpn = vpa;
 854                         while (vpn) {
 855                                 len = vp_prints_value(buffer, sizeof(buffer),
 856                                                 vpn, FALSE);
 857                                 av_push(av, newSVpv(buffer, len));
 858                                 vpn = vpn->next;
 859                         }
 860                         hv_store(rad_hv, nvp->name, strlen(nvp->name),
 861                                         newRV_noinc((SV *) av), 0);
 862                 } else {
 863                         len = vp_prints_value(buffer, sizeof(buffer),
 864                                         vpa, FALSE);
 865                         hv_store(rad_hv, vpa->name, strlen(vpa->name),
 866                                         newSVpv(buffer, len), 0);
 867                 }
 868
 869                 pairfree(&vpa);
 870                 vpa = nvp; while ((vpa != NULL) && (vpa->attribute == attr))
 871                         vpa = vpa->next;
 872                 pairdelete(&nvp, attr);
 873                 nvp = vpa;
 874         }
 875 }
 876
 877 /*
 878  *
 879  *     Verify that a Perl SV is a string and save it in FreeRadius
 880  *     Value Pair Format
 881  *
 882  */
 883 static int pairadd_sv(VALUE_PAIR **vp, char *key, SV *sv, int operator) {
 884        char            *val;
 885        VALUE_PAIR      *vpp;
 886
 887        if (SvOK(sv)) {
 888                val = SvPV_nolen(sv);
 889                vpp = pairmake(key, val, operator);
 890                if (vpp != NULL) {
 891                        pairadd(vp, vpp);
 892                        radlog(L_DBG,
 893                          "rlm_perl: Added pair %s = %s", key, val);
 894                        return 1;
 895                } else {
 896                        radlog(L_DBG,
 897                          "rlm_perl: ERROR: Failed to create pair %s = %s",
 898                          key, val);
 899                }
 900         }
 901        return 0;
 902 }
 903
 904 /*
 905   *     Boyan :
 906   *     Gets the content from hashes
 907   */
 908 static int get_hv_content(HV *my_hv, VALUE_PAIR **vp)
 909 {
 910        SV               *res_sv, **av_sv;
 911        AV               *av;
 912        char             *key;
 913        I32              key_len, len, i, j;
 914        int              ret=0;
 915
 916        *vp = NULL;
 917        for (i = hv_iterinit(my_hv); i > 0; i--) {
 918                res_sv = hv_iternextsv(my_hv,&key,&key_len);
 919                if (SvROK(res_sv) && (SvTYPE(SvRV(res_sv)) == SVt_PVAV)) {
 920                        av = (AV*)SvRV(res_sv);
 921                        len = av_len(av);
 922                        for (j = 0; j <= len; j++) {
 923                                av_sv = av_fetch(av, j, 0);
 924                                ret = pairadd_sv(vp, key, *av_sv, T_OP_ADD) + ret;
 925                        }
 926                } else ret = pairadd_sv(vp, key, res_sv, T_OP_EQ) + ret;
 927         }
 928
 929         return ret;
 930 }
 931
 932 /*
 933  *      Call the function_name inside the module
 934  *      Store all vps in hashes %RAD_CHECK %RAD_REPLY %RAD_REQUEST
 935  *
 936  */
 937 static int rlmperl_call(void *instance, REQUEST *request, char *function_name)
 938 {
 939
 940         PERL_INST       *inst = instance;
 941         VALUE_PAIR      *vp;
 942         int             exitstatus=0, count;
 943         STRLEN          n_a;
 944
 945         HV              *rad_reply_hv;
 946         HV              *rad_check_hv;
 947         HV              *rad_request_hv;
 948         HV              *rad_request_proxy_hv;
 949         HV              *rad_request_proxy_reply_hv;
 950
 951 #ifdef USE_ITHREADS
 952         POOL_HANDLE     *handle;
 953
 954         if ((handle = pool_pop(instance)) == NULL) {
 955                 return RLM_MODULE_FAIL;
 956         }
 957
 958         radlog(L_DBG,"found interpetator at address 0x%lx",(unsigned long) handle->clone);
 959         {
 960         dTHXa(handle->clone);
 961         PERL_SET_CONTEXT(handle->clone);
 962         }
 963 #else
 964         PERL_SET_CONTEXT(inst->perl);
 965         radlog(L_DBG,"Using perl at 0x%lx",(unsigned long) inst->perl);
 966 #endif
 967         {
 968         dSP;
 969
 970         ENTER;
 971         SAVETMPS;
 972
 973
 974         /*
 975          *      Radius has told us to call this function, but none
 976          *      is defined.
 977          */
 978         if (!function_name) {
 979                 return RLM_MODULE_FAIL;
 980         }
 981
 982         rad_reply_hv = get_hv("RAD_REPLY",1);
 983         rad_check_hv = get_hv("RAD_CHECK",1);
 984         rad_request_hv = get_hv("RAD_REQUEST",1);
 985         rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
 986         rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
 987
 988
 989         perl_store_vps(request->reply->vps, rad_reply_hv);
 990         perl_store_vps(request->config_items, rad_check_hv);
 991         perl_store_vps(request->packet->vps, rad_request_hv);
 992
 993         if (request->proxy != NULL) {
 994                 perl_store_vps(request->proxy->vps, rad_request_proxy_hv);
 995         } else {
 996                 hv_undef(rad_request_proxy_hv);
 997         }
 998
 999         if (request->proxy_reply !=NULL) {
1000                 perl_store_vps(request->proxy_reply->vps, rad_request_proxy_reply_hv);
1001         } else {
1002                 hv_undef(rad_request_proxy_reply_hv);
1003         }
1004
1005         PUSHMARK(SP);
1006         /*
1007         * This way %RAD_xx can be pushed onto stack as sub parameters.
1008         * XPUSHs( newRV_noinc((SV *)rad_request_hv) );
1009         * XPUSHs( newRV_noinc((SV *)rad_reply_hv) );
1010         * XPUSHs( newRV_noinc((SV *)rad_check_hv) );
1011         * PUTBACK;
1012         */
1013
1014         count = call_pv(function_name, G_SCALAR | G_EVAL | G_NOARGS);
1015
1016         SPAGAIN;
1017
1018         if (SvTRUE(ERRSV)) {
1019                 radlog(L_ERR, "rlm_perl: perl_embed:: module = %s , func = %s exit status= %s\n",
1020                        inst->module,
1021                        function_name, SvPV(ERRSV,n_a));
1022                 POPs;
1023         }
1024
1025         if (count == 1) {
1026                 exitstatus = POPi;
1027                 if (exitstatus >= 100 || exitstatus < 0) {
1028                         exitstatus = RLM_MODULE_FAIL;
1029                 }
1030         }
1031
1032
1033         PUTBACK;
1034         FREETMPS;
1035         LEAVE;
1036
1037         vp = NULL;
1038         if ((get_hv_content(rad_request_hv, &vp)) > 0 ) {
1039                 pairfree(&request->packet->vps);
1040                 request->packet->vps = vp;
1041                 vp = NULL;
1042
1043                 /*
1044                  *      Update cached copies
1045                  */
1046                 request->username = pairfind(request->packet->vps,
1047                                              PW_USER_NAME);
1048                 request->password = pairfind(request->packet->vps,
1049                                              PW_USER_PASSWORD);
1050         }
1051
1052         if ((get_hv_content(rad_reply_hv, &vp)) > 0 ) {
1053                 pairfree(&request->reply->vps);
1054                 request->reply->vps = vp;
1055                 vp = NULL;
1056         }
1057
1058         if ((get_hv_content(rad_check_hv, &vp)) > 0 ) {
1059                 pairfree(&request->config_items);
1060                 request->config_items = vp;
1061                 vp = NULL;
1062         }
1063
1064         if (request->proxy &&
1065             (get_hv_content(rad_request_proxy_hv, &vp) > 0)) {
1066                 pairfree(&request->proxy->vps);
1067                 request->proxy->vps = vp;
1068                 vp = NULL;
1069         }
1070
1071         if (request->proxy_reply &&
1072             (get_hv_content(rad_request_proxy_reply_hv, &vp) > 0)) {
1073                 pairfree(&request->proxy_reply->vps);
1074                 request->proxy_reply->vps = vp;
1075                 vp = NULL;
1076         }
1077
1078         }
1079 #ifdef USE_ITHREADS
1080         pool_release(handle,instance);
1081         radlog(L_DBG,"Unreserve perl at address 0x%lx", (unsigned long) handle->clone);
1082 #endif
1083
1084         return exitstatus;
1085 }
1086
1087 /*
1088  *      Find the named user in this modules database.  Create the set
1089  *      of attribute-value pairs to check and reply with for this user
1090  *      from the database. The authentication code only needs to check
1091  *      the password, the rest is done here.
1092  */
1093 static int perl_authorize(void *instance, REQUEST *request)
1094 {
1095         return rlmperl_call(instance, request,
1096                             ((PERL_INST *)instance)->func_authorize);
1097 }
1098
1099 /*
1100  *      Authenticate the user with the given password.
1101  */
1102 static int perl_authenticate(void *instance, REQUEST *request)
1103 {
1104         return rlmperl_call(instance, request,
1105                             ((PERL_INST *)instance)->func_authenticate);
1106 }
1107 /*
1108  *      Massage the request before recording it or proxying it
1109  */
1110 static int perl_preacct(void *instance, REQUEST *request)
1111 {
1112         return rlmperl_call(instance, request,
1113                             ((PERL_INST *)instance)->func_preacct);
1114 }
1115 /*
1116  *      Write accounting information to this modules database.
1117  */
1118 static int perl_accounting(void *instance, REQUEST *request)
1119 {
1120         VALUE_PAIR      *pair;
1121         int             acctstatustype=0;
1122
1123         if ((pair = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE)) != NULL) {
1124                 acctstatustype = pair->lvalue;
1125         } else {
1126                 radlog(L_ERR, "Invalid Accounting Packet");
1127                 return RLM_MODULE_INVALID;
1128         }
1129
1130         switch (acctstatustype) {
1131
1132                 case PW_STATUS_START:
1133
1134                         if (((PERL_INST *)instance)->func_start_accounting) {
1135                                 return rlmperl_call(instance, request,
1136                                             ((PERL_INST *)instance)->func_start_accounting);
1137                         } else {
1138                                 return rlmperl_call(instance, request,
1139                                             ((PERL_INST *)instance)->func_accounting);
1140                         }
1141                         break;
1142
1143                 case PW_STATUS_STOP:
1144
1145                         if (((PERL_INST *)instance)->func_stop_accounting) {
1146                                 return rlmperl_call(instance, request,
1147                                             ((PERL_INST *)instance)->func_stop_accounting);
1148                         } else {
1149                                 return rlmperl_call(instance, request,
1150                                             ((PERL_INST *)instance)->func_accounting);
1151                         }
1152                         break;
1153                 default:
1154                         return rlmperl_call(instance, request,
1155                                             ((PERL_INST *)instance)->func_accounting);
1156
1157         }
1158 }
1159 /*
1160  *      Check for simultaneouse-use
1161  */
1162 static int perl_checksimul(void *instance, REQUEST *request)
1163 {
1164         return rlmperl_call(instance, request,
1165                         ((PERL_INST *)instance)->func_checksimul);
1166 }
1167 /*
1168  *      Pre-Proxy request
1169  */
1170 static int perl_pre_proxy(void *instance, REQUEST *request)
1171 {
1172         return rlmperl_call(instance, request,
1173                         ((PERL_INST *)instance)->func_pre_proxy);
1174 }
1175 /*
1176  *      Post-Proxy request
1177  */
1178 static int perl_post_proxy(void *instance, REQUEST *request)
1179 {
1180         return rlmperl_call(instance, request,
1181                         ((PERL_INST *)instance)->func_post_proxy);
1182 }
1183 /*
1184  *      Pre-Auth request
1185  */
1186 static int perl_post_auth(void *instance, REQUEST *request)
1187 {
1188         return rlmperl_call(instance, request,
1189                         ((PERL_INST *)instance)->func_post_auth);
1190 }
1191 /*
1192  * Detach a instance give a chance to a module to make some internal setup ...
1193  */
1194 static int perl_detach(void *instance)
1195 {
1196         PERL_INST       *inst = (PERL_INST *) instance;
1197         int             exitstatus = 0, count = 0;
1198
1199 #ifdef USE_ITHREADS
1200         POOL_HANDLE     *handle, *tmp, *tmp2;
1201
1202         MUTEX_LOCK(&inst->perl_pool->mutex);
1203         inst->perl_pool->detach = yes;
1204         MUTEX_UNLOCK(&inst->perl_pool->mutex);
1205
1206         for (handle = inst->perl_pool->head; handle != NULL; handle = handle->next) {
1207
1208                 radlog(L_DBG,"Detach perl 0x%lx", (unsigned long) handle->clone);
1209                 /*
1210                  * Wait until clone becomes idle
1211                  */
1212                 MUTEX_LOCK(&handle->lock);
1213
1214                 /*
1215                  * Give a clones chance to run detach function
1216                  */
1217                 {
1218                 dTHXa(handle->clone);
1219                 PERL_SET_CONTEXT(handle->clone);
1220                 {
1221                 dSP; ENTER; SAVETMPS; PUSHMARK(SP);
1222                 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
1223                 SPAGAIN;
1224
1225                 if (count == 1) {
1226                         exitstatus = POPi;
1227                         /*
1228                          * FIXME: bug in perl
1229                          *
1230                          */
1231                         if (exitstatus >= 100 || exitstatus < 0) {
1232                                 exitstatus = RLM_MODULE_FAIL;
1233                         }
1234                 }
1235                 PUTBACK;
1236                 FREETMPS;
1237                 LEAVE;
1238                 radlog(L_DBG,"detach at 0x%lx returned status %d",
1239                                 (unsigned long) handle->clone, exitstatus);
1240                 }
1241                 }
1242                 MUTEX_UNLOCK(&handle->lock);
1243         }
1244         /*
1245          * Free handles
1246          */
1247
1248         for (tmp = inst->perl_pool->head; tmp !=NULL  ; tmp = tmp2) {
1249                 tmp2 = tmp->next;
1250                 radlog(L_DBG,"rlm_perl:: Destroy perl");
1251                 rlm_perl_destruct(tmp->clone);
1252                 delete_pool_handle(tmp,inst);
1253         }
1254
1255         {
1256         dTHXa(inst->perl);
1257 #endif /* USE_ITHREADS */
1258         PERL_SET_CONTEXT(inst->perl);
1259         {
1260         dSP; ENTER; SAVETMPS;
1261         PUSHMARK(SP);
1262
1263         count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
1264         SPAGAIN;
1265
1266         if (count == 1) {
1267                 exitstatus = POPi;
1268                 if (exitstatus >= 100 || exitstatus < 0) {
1269                         exitstatus = RLM_MODULE_FAIL;
1270                 }
1271         }
1272         PUTBACK;
1273         FREETMPS;
1274         LEAVE;
1275         }
1276 #ifdef USE_ITHREADS
1277         }
1278 #endif
1279
1280         xlat_unregister(inst->xlat_name, perl_xlat);
1281         free(inst->xlat_name);
1282
1283         if (inst->func_authorize) free(inst->func_authorize);
1284         if (inst->func_authenticate) free(inst->func_authenticate);
1285         if (inst->func_accounting) free(inst->func_accounting);
1286         if (inst->func_preacct) free(inst->func_preacct);
1287         if (inst->func_checksimul) free(inst->func_checksimul);
1288         if (inst->func_pre_proxy) free(inst->func_pre_proxy);
1289         if (inst->func_post_proxy) free(inst->func_post_proxy);
1290         if (inst->func_post_auth) free(inst->func_post_auth);
1291         if (inst->func_detach) free(inst->func_detach);
1292
1293 #ifdef USE_ITHREADS
1294         free(inst->perl_pool->head);
1295         free(inst->perl_pool->tail);
1296         MUTEX_DESTROY(&inst->perl_pool->mutex);
1297         free(inst->perl_pool);
1298         rlm_perl_destruct(inst->perl);
1299 #else
1300         perl_destruct(inst->perl);
1301         perl_free(inst->perl);
1302 #endif
1303
1304         free(inst);
1305         return exitstatus;
1306 }
1307 /*
1308  *      The module name should be the only globally exported symbol.
1309  *      That is, everything else should be 'static'.
1310  *
1311  *      If the module needs to temporarily modify it's instantiation
1312  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
1313  *      The server will then take care of ensuring that the module
1314  *      is single-threaded.
1315  */
1316 module_t rlm_perl = {
1317         RLM_MODULE_INIT,
1318         "perl",                         /* Name */
1319 #ifdef USE_ITHREADS
1320         RLM_TYPE_THREAD_SAFE,           /* type */
1321 #else
1322         RLM_TYPE_THREAD_UNSAFE,
1323 #endif
1324         perl_instantiate,               /* instantiation */
1325         perl_detach,                    /* detach */
1326         {
1327                 perl_authenticate,      /* authenticate */
1328                 perl_authorize,         /* authorize */
1329                 perl_preacct,           /* preacct */
1330                 perl_accounting,        /* accounting */
1331                 perl_checksimul,        /* check simul */
1332                 perl_pre_proxy,         /* pre-proxy */
1333                 perl_post_proxy,        /* post-proxy */
1334                 perl_post_auth          /* post-auth */
1335         },
1336 };