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