Call detach only if function exists
[freeradius.git] / 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,2006  The FreeRADIUS server project
21  * Copyright 2002  Boian Jordanov <bjordanov@orbitel.bg>
22  */
23
24 #include <freeradius-devel/ident.h>
25 RCSID("$Id$")
26
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
29
30 #ifdef DEBUG
31 #undef DEBUG
32 #endif
33
34 #ifdef INADDR_ANY
35 #undef INADDR_ANY
36 #endif
37
38 #include <EXTERN.h>
39 #include <perl.h>
40 #include <XSUB.h>
41 #include <dlfcn.h>
42 #include <semaphore.h>
43
44 #ifdef __APPLE__
45 extern char **environ;
46 #endif
47
48 /*
49  *      Define a structure for our module configuration.
50  *
51  *      These variables do not need to be in a structure, but it's
52  *      a lot cleaner to do so, and a pointer to the structure can
53  *      be used as the instance handle.
54  */
55 typedef struct perl_inst {
56         /* Name of the perl module */
57         char    *module;
58
59         /* Name of the functions for each module method */
60         char    *func_authorize;
61         char    *func_authenticate;
62         char    *func_accounting;
63         char    *func_start_accounting;
64         char    *func_stop_accounting;
65         char    *func_preacct;
66         char    *func_checksimul;
67         char    *func_detach;
68         char    *func_xlat;
69         char    *func_pre_proxy;
70         char    *func_post_proxy;
71         char    *func_post_auth;
72 #ifdef WITH_COA
73         char    *func_recv_coa;
74         char    *func_send_coa;
75 #endif
76         char    *xlat_name;
77         char    *perl_flags;
78         PerlInterpreter *perl;
79         pthread_key_t   *thread_key;
80 } PERL_INST;
81 /*
82  *      A mapping of configuration file names to internal variables.
83  *
84  *      Note that the string is dynamically allocated, so it MUST
85  *      be freed.  When the configuration file parse re-reads the string,
86  *      it free's the old one, and strdup's the new one, placing the pointer
87  *      to the strdup'd string into 'config.string'.  This gets around
88  *      buffer over-flows.
89  */
90 static const CONF_PARSER module_config[] = {
91         { "module",  PW_TYPE_FILENAME,
92           offsetof(PERL_INST,module), NULL,  "module"},
93         { "func_authorize", PW_TYPE_STRING_PTR,
94           offsetof(PERL_INST,func_authorize), NULL, "authorize"},
95         { "func_authenticate", PW_TYPE_STRING_PTR,
96           offsetof(PERL_INST,func_authenticate), NULL, "authenticate"},
97         { "func_accounting", PW_TYPE_STRING_PTR,
98           offsetof(PERL_INST,func_accounting), NULL, "accounting"},
99         { "func_preacct", PW_TYPE_STRING_PTR,
100           offsetof(PERL_INST,func_preacct), NULL, "preacct"},
101         { "func_checksimul", PW_TYPE_STRING_PTR,
102           offsetof(PERL_INST,func_checksimul), NULL, "checksimul"},
103         { "func_detach", PW_TYPE_STRING_PTR,
104           offsetof(PERL_INST,func_detach), NULL, "detach"},
105         { "func_xlat", PW_TYPE_STRING_PTR,
106           offsetof(PERL_INST,func_xlat), NULL, "xlat"},
107         { "func_pre_proxy", PW_TYPE_STRING_PTR,
108           offsetof(PERL_INST,func_pre_proxy), NULL, "pre_proxy"},
109         { "func_post_proxy", PW_TYPE_STRING_PTR,
110           offsetof(PERL_INST,func_post_proxy), NULL, "post_proxy"},
111         { "func_post_auth", PW_TYPE_STRING_PTR,
112           offsetof(PERL_INST,func_post_auth), NULL, "post_auth"},
113 #ifdef WITH_COA
114         { "func_recv_coa", PW_TYPE_STRING_PTR,
115           offsetof(PERL_INST,func_recv_coa), NULL, "recv_coa"},
116         { "func_send_coa", PW_TYPE_STRING_PTR,
117           offsetof(PERL_INST,func_send_coa), NULL, "send_coa"},
118 #endif
119         { "perl_flags", PW_TYPE_STRING_PTR,
120           offsetof(PERL_INST,perl_flags), NULL, NULL},
121         { "func_start_accounting", PW_TYPE_STRING_PTR,
122           offsetof(PERL_INST,func_start_accounting), NULL, NULL},
123         { "func_stop_accounting", PW_TYPE_STRING_PTR,
124           offsetof(PERL_INST,func_stop_accounting), NULL, NULL},
125
126         { NULL, -1, 0, NULL, NULL }             /* end the list */
127 };
128
129 /*
130  * man perlembed
131  */
132 EXTERN_C void boot_DynaLoader(pTHX_ CV* cv);
133
134 #ifdef USE_ITHREADS
135 #define dl_librefs "DynaLoader::dl_librefs"
136 #define dl_modules "DynaLoader::dl_modules"
137 static void rlm_perl_clear_handles(pTHX)
138 {
139         AV *librefs = get_av(dl_librefs, FALSE);
140         if (librefs) {
141                 av_clear(librefs);
142         }
143 }
144
145 static void **rlm_perl_get_handles(pTHX)
146 {
147         I32 i;
148         AV *librefs = get_av(dl_librefs, FALSE);
149         AV *modules = get_av(dl_modules, FALSE);
150         void **handles;
151
152         if (!librefs) {
153                 radlog(L_ERR,
154                    "Could not get @%s for unloading.\n",
155                    dl_librefs);
156                 return NULL;
157         }
158
159         if (!(AvFILL(librefs) >= 0)) {
160                 return NULL;
161         }
162
163         handles = (void **)rad_malloc(sizeof(void *) * (AvFILL(librefs)+2));
164
165         for (i=0; i<=AvFILL(librefs); i++) {
166                 void *handle;
167                 SV *handle_sv = *av_fetch(librefs, i, FALSE);
168
169                 if(!handle_sv) {
170                     radlog(L_ERR,
171                                "Could not fetch $%s[%d]!\n",
172                                dl_librefs, (int)i);
173                     continue;
174                 }
175                 handle = (void *)SvIV(handle_sv);
176
177                 if (handle) {
178                     handles[i] = handle;
179                 }
180         }
181
182         av_clear(modules);
183         av_clear(librefs);
184
185         handles[i] = (void *)0;
186
187         return handles;
188 }
189
190 static void rlm_perl_close_handles(void **handles)
191 {
192         int i;
193
194         if (!handles) {
195                 return;
196         }
197
198         for (i=0; handles[i]; i++) {
199                 radlog(L_DBG, "close %p\n", handles[i]);
200                 dlclose(handles[i]);
201         }
202
203         free(handles);
204 }
205
206 static void rlm_perl_destruct(PerlInterpreter *perl)
207 {
208         dTHXa(perl);
209
210         PERL_SET_CONTEXT(perl);
211
212         PL_perl_destruct_level = 2;
213
214         PL_origenviron = environ;
215
216         {
217                 dTHXa(perl);
218         }
219         /*
220          * FIXME: This shouldn't happen
221          *
222          */
223         while (PL_scopestack_ix > 1 ){
224                 LEAVE;
225         }
226
227         perl_destruct(perl);
228         perl_free(perl);
229 }
230
231 static void rlm_destroy_perl(PerlInterpreter *perl)
232 {
233         void    **handles;
234
235         dTHXa(perl);
236         PERL_SET_CONTEXT(perl);
237
238         handles = rlm_perl_get_handles(aTHX);
239         rlm_perl_destruct(perl);
240         rlm_perl_close_handles(handles);
241 }
242
243 /* Create Key */
244 static void rlm_perl_make_key(pthread_key_t *key)
245 {
246         pthread_key_create(key, rlm_destroy_perl);
247 }
248
249 static PerlInterpreter *rlm_perl_clone(PerlInterpreter *perl, pthread_key_t *key)
250 {
251         PerlInterpreter *interp;
252         UV clone_flags = 0;
253
254         PERL_SET_CONTEXT(perl);
255
256         interp = pthread_getspecific(*key);
257         if (interp) return interp;
258
259         interp = perl_clone(perl, clone_flags);
260         {
261                 dTHXa(interp);
262         }
263 #if PERL_REVISION >= 5 && PERL_VERSION <8
264         call_pv("CLONE",0);
265 #endif
266         ptr_table_free(PL_ptr_table);
267         PL_ptr_table = NULL;
268
269         PERL_SET_CONTEXT(aTHX);
270         rlm_perl_clear_handles(aTHX);
271
272         pthread_setspecific(*key, interp);
273
274         fprintf(stderr, "GOT CLONE %d %p\n", pthread_self(), interp);
275
276         return interp;
277 }
278 #endif
279
280 static void xs_init(pTHX)
281 {
282         char *file = __FILE__;
283
284         /* DynaLoader is a special case */
285         newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
286
287 }
288 /*
289  *
290  * This is wrapper for radlog
291  * Now users can call radiusd::radlog(level,msg) wich is the same
292  * calling radlog from C code.
293  * Boyan
294  */
295 static XS(XS_radiusd_radlog)
296 {
297        dXSARGS;
298        if (items !=2)
299                croak("Usage: radiusd::radlog(level, message)");
300        {
301                int     level;
302                char    *msg;
303
304                level = (int) SvIV(ST(0));
305                msg   = (char *) SvPV(ST(1), PL_na);
306
307                /*
308                 *       Because 'msg' is a 'char *', we don't want '%s', etc.
309                 *       in it to give us printf-style vulnerabilities.
310                 */
311                radlog(level, "rlm_perl: %s", msg);
312         }
313        XSRETURN_NO;
314 }
315
316 /*
317  * The xlat function
318  */
319 static size_t perl_xlat(void *instance, REQUEST *request, char *fmt, char *out,
320                         size_t freespace, RADIUS_ESCAPE_STRING func)
321 {
322
323         PERL_INST       *inst= (PERL_INST *) instance;
324         PerlInterpreter *perl;
325         char            params[1024], *ptr, *tmp;
326         int             count;
327         size_t          ret = 0;
328         STRLEN          n_a;
329
330         /*
331          * Do an xlat on the provided string (nice recursive operation).
332         */
333         if (!radius_xlat(params, sizeof(params), fmt, request, func)) {
334                 radlog(L_ERR, "rlm_perl: xlat failed.");
335                 return 0;
336         }
337
338 #ifndef WITH_ITHREADS
339         perl = inst->perl;
340 #else
341         perl = rlm_perl_clone(inst->perl,inst->thread_key);
342         {
343           dTHXa(perl);
344         }
345 #endif
346         PERL_SET_CONTEXT(perl);
347         {
348         dSP;
349         ENTER;SAVETMPS;
350
351         ptr = strtok(params, " ");
352
353         PUSHMARK(SP);
354
355         while (ptr != NULL) {
356                 XPUSHs(sv_2mortal(newSVpv(ptr,0)));
357                 ptr = strtok(NULL, " ");
358         }
359
360         PUTBACK;
361
362         count = call_pv(inst->func_xlat, G_SCALAR | G_EVAL);
363
364         SPAGAIN;
365         if (SvTRUE(ERRSV)) {
366                 radlog(L_ERR, "rlm_perl: perl_xlat exit %s\n",
367                        SvPV(ERRSV,n_a));
368                 POPs ;
369         } else if (count > 0) {
370                 tmp = POPp;
371                 strlcpy(out, tmp, freespace);
372                 ret = strlen(out);
373
374                 radlog(L_DBG,"rlm_perl: Len is %d , out is %s freespace is %d",
375                        ret, out,freespace);
376         }
377
378         PUTBACK ;
379         FREETMPS ;
380         LEAVE ;
381
382         }
383         return ret;
384 }
385 /*
386  *      Do any per-module initialization that is separate to each
387  *      configured instance of the module.  e.g. set up connections
388  *      to external databases, read configuration files, set up
389  *      dictionary entries, etc.
390  *
391  *      If configuration information is given in the config section
392  *      that must be referenced in later calls, store a handle to it
393  *      in *instance otherwise put a null pointer there.
394  *
395  *      Boyan:
396  *      Setup a hashes wich we will use later
397  *      parse a module and give him a chance to live
398  *
399  */
400 static int perl_instantiate(CONF_SECTION *conf, void **instance)
401 {
402         PERL_INST       *inst = (PERL_INST *) instance;
403         HV              *rad_reply_hv;
404         HV              *rad_check_hv;
405         HV              *rad_config_hv;
406         HV              *rad_request_hv;
407         HV              *rad_request_proxy_hv;
408         HV              *rad_request_proxy_reply_hv;
409         AV              *end_AV;
410
411         char *embed[4];
412         const char *xlat_name;
413         int exitstatus = 0, argc=0;
414
415         /*
416          *      Set up a storage area for instance data
417          */
418         inst = rad_malloc(sizeof(PERL_INST));
419         memset(inst, 0, sizeof(PERL_INST));
420
421         /*
422          *      If the configuration parameters can't be parsed, then
423          *      fail.
424          */
425         if (cf_section_parse(conf, inst, module_config) < 0) {
426                 free(inst);
427                 return -1;
428         }
429         
430         /*
431          *      Create pthread key. This key will be stored in instance
432          */
433
434 #ifdef USE_ITHREADS
435         inst->thread_key = rad_malloc(sizeof(*inst->thread_key));
436         memset(inst->thread_key,0,sizeof(*inst->thread_key));
437         
438         rlm_perl_make_key(inst->thread_key);
439 #endif
440         embed[0] = NULL;
441         if (inst->perl_flags) {
442                 embed[1] = inst->perl_flags;
443                 embed[2] = inst->module;
444                 embed[3] = "0";
445                 argc = 4;
446         } else {
447                 embed[1] = inst->module;
448                 embed[2] = "0";
449                 argc = 3;
450         }
451
452 #ifdef USE_ITHREADS
453         if ((inst->perl = perl_alloc()) == NULL) {
454                 radlog(L_DBG, "rlm_perl: No memory for allocating new perl !");
455                 return (-1);
456         }
457
458         perl_construct(inst->perl);
459         PL_perl_destruct_level = 2;
460
461         {
462         dTHXa(inst->perl);
463         }
464         PERL_SET_CONTEXT(inst->perl);
465 #else
466         if ((inst->perl = perl_alloc()) == NULL) {
467                 radlog(L_ERR, "rlm_perl: No memory for allocating new perl !");
468                 return -1;
469         }
470
471         perl_construct(inst->perl);
472 #endif
473
474 #if PERL_REVISION >= 5 && PERL_VERSION >=8
475         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
476 #endif
477
478         exitstatus = perl_parse(inst->perl, xs_init, argc, embed, NULL);
479
480         end_AV = PL_endav;
481         PL_endav = Nullav;
482
483         if(!exitstatus) {
484                 exitstatus = perl_run(inst->perl);
485         } else {
486                 radlog(L_ERR,"rlm_perl: perl_parse failed: %s not found or has syntax errors. \n", inst->module);
487                 return (-1);
488         }
489
490         PL_endav = end_AV;
491
492         newXS("radiusd::radlog",XS_radiusd_radlog, "rlm_perl.c");
493
494         rad_reply_hv = newHV();
495         rad_check_hv = newHV();
496         rad_config_hv = newHV();
497         rad_request_hv = newHV();
498         rad_request_proxy_hv = newHV();
499         rad_request_proxy_reply_hv = newHV();
500
501         rad_reply_hv = get_hv("RAD_REPLY",1);
502         rad_check_hv = get_hv("RAD_CHECK",1);
503         rad_config_hv = get_hv("RAD_CONFIG",1);
504         rad_request_hv = get_hv("RAD_REQUEST",1);
505         rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
506         rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
507
508         xlat_name = cf_section_name2(conf);
509         if (xlat_name == NULL)
510                 xlat_name = cf_section_name1(conf);
511         if (xlat_name){
512                 inst->xlat_name = strdup(xlat_name);
513                 xlat_register(xlat_name, perl_xlat, inst);
514         }
515
516         *instance = inst;
517
518         return 0;
519 }
520
521 /*
522  *      get the vps and put them in perl hash
523  *      If one VP have multiple values it is added as array_ref
524  *      Example for this is Cisco-AVPair that holds multiple values.
525  *      Which will be available as array_ref in $RAD_REQUEST{'Cisco-AVPair'}
526  */
527 static void perl_store_vps(VALUE_PAIR *vp, HV *rad_hv)
528 {
529         VALUE_PAIR      *nvp, *vpa, *vpn;
530         AV              *av;
531         char            namebuf[256], *name;
532         char            buffer[1024];
533         int             attr, len;
534
535         hv_undef(rad_hv);
536         nvp = paircopy(vp);
537
538         while (nvp != NULL) {
539                 name = nvp->name;
540                 attr = nvp->attribute;
541                 vpa = paircopy2(nvp,attr);
542
543                 if (vpa->next) {
544                         av = newAV();
545                         vpn = vpa;
546                         while (vpn) {
547                                 len = vp_prints_value(buffer, sizeof(buffer),
548                                                 vpn, FALSE);
549                                 av_push(av, newSVpv(buffer, len));
550                                 vpn = vpn->next;
551                         }
552                         hv_store(rad_hv, nvp->name, strlen(nvp->name),
553                                         newRV_noinc((SV *) av), 0);
554                 } else {
555                         if ((vpa->flags.has_tag) &&
556                             (vpa->flags.tag != 0)) {
557                                 snprintf(namebuf, sizeof(namebuf), "%s:%d",
558                                          nvp->name, nvp->flags.tag);
559                                 name = namebuf;
560                         }
561
562                         len = vp_prints_value(buffer, sizeof(buffer),
563                                               vpa, FALSE);
564                         hv_store(rad_hv, name, strlen(name),
565                                  newSVpv(buffer, len), 0);
566                 }
567
568                 pairfree(&vpa);
569                 vpa = nvp; while ((vpa != NULL) && (vpa->attribute == attr))
570                         vpa = vpa->next;
571                 pairdelete(&nvp, attr);
572                 nvp = vpa;
573         }
574 }
575
576 /*
577  *
578  *     Verify that a Perl SV is a string and save it in FreeRadius
579  *     Value Pair Format
580  *
581  */
582 static int pairadd_sv(VALUE_PAIR **vp, char *key, SV *sv, int operator) {
583        char            *val;
584        VALUE_PAIR      *vpp;
585
586        if (SvOK(sv)) {
587                val = SvPV_nolen(sv);
588                vpp = pairmake(key, val, operator);
589                if (vpp != NULL) {
590                        pairadd(vp, vpp);
591                        radlog(L_DBG,
592                          "rlm_perl: Added pair %s = %s", key, val);
593                        return 1;
594                } else {
595                        radlog(L_DBG,
596                          "rlm_perl: ERROR: Failed to create pair %s = %s",
597                          key, val);
598                }
599         }
600        return 0;
601 }
602
603 /*
604   *     Boyan :
605   *     Gets the content from hashes
606   */
607 static int get_hv_content(HV *my_hv, VALUE_PAIR **vp)
608 {
609        SV               *res_sv, **av_sv;
610        AV               *av;
611        char             *key;
612        I32              key_len, len, i, j;
613        int              ret=0;
614
615        *vp = NULL;
616        for (i = hv_iterinit(my_hv); i > 0; i--) {
617                res_sv = hv_iternextsv(my_hv,&key,&key_len);
618                if (SvROK(res_sv) && (SvTYPE(SvRV(res_sv)) == SVt_PVAV)) {
619                        av = (AV*)SvRV(res_sv);
620                        len = av_len(av);
621                        for (j = 0; j <= len; j++) {
622                                av_sv = av_fetch(av, j, 0);
623                                ret = pairadd_sv(vp, key, *av_sv, T_OP_ADD) + ret;
624                        }
625                } else ret = pairadd_sv(vp, key, res_sv, T_OP_EQ) + ret;
626         }
627
628         return ret;
629 }
630
631 /*
632  *      Call the function_name inside the module
633  *      Store all vps in hashes %RAD_CHECK %RAD_REPLY %RAD_REQUEST
634  *
635  */
636 static int rlmperl_call(void *instance, REQUEST *request, char *function_name)
637 {
638
639         PERL_INST       *inst = instance;
640         VALUE_PAIR      *vp;
641         int             exitstatus=0, count;
642         STRLEN          n_a;
643
644         HV              *rad_reply_hv;
645         HV              *rad_check_hv;
646         HV              *rad_config_hv;
647         HV              *rad_request_hv;
648         HV              *rad_request_proxy_hv;
649         HV              *rad_request_proxy_reply_hv;
650
651 #ifdef USE_ITHREADS
652         PerlInterpreter *interp;
653
654         interp = rlm_perl_clone(inst->perl,inst->thread_key);
655         {
656           dTHXa(interp);
657           PERL_SET_CONTEXT(interp);
658         }
659 #else
660         PERL_SET_CONTEXT(inst->perl);
661 #endif
662         {
663         dSP;
664
665         ENTER;
666         SAVETMPS;
667
668
669         /*
670          *      Radius has told us to call this function, but none
671          *      is defined.
672          */
673         if (!function_name) {
674                 return RLM_MODULE_FAIL;
675         }
676
677         rad_reply_hv = get_hv("RAD_REPLY",1);
678         rad_check_hv = get_hv("RAD_CHECK",1);
679         rad_config_hv = get_hv("RAD_CONFIG",1);
680         rad_request_hv = get_hv("RAD_REQUEST",1);
681         rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
682         rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
683
684
685         perl_store_vps(request->reply->vps, rad_reply_hv);
686         perl_store_vps(request->config_items, rad_check_hv);
687         perl_store_vps(request->packet->vps, rad_request_hv);
688         perl_store_vps(request->config_items, rad_config_hv);
689
690         if (request->proxy != NULL) {
691                 perl_store_vps(request->proxy->vps, rad_request_proxy_hv);
692         } else {
693                 hv_undef(rad_request_proxy_hv);
694         }
695
696         if (request->proxy_reply !=NULL) {
697                 perl_store_vps(request->proxy_reply->vps, rad_request_proxy_reply_hv);
698         } else {
699                 hv_undef(rad_request_proxy_reply_hv);
700         }
701
702         PUSHMARK(SP);
703         /*
704         * This way %RAD_xx can be pushed onto stack as sub parameters.
705         * XPUSHs( newRV_noinc((SV *)rad_request_hv) );
706         * XPUSHs( newRV_noinc((SV *)rad_reply_hv) );
707         * XPUSHs( newRV_noinc((SV *)rad_check_hv) );
708         * PUTBACK;
709         */
710
711         count = call_pv(function_name, G_SCALAR | G_EVAL | G_NOARGS);
712
713         SPAGAIN;
714
715         if (SvTRUE(ERRSV)) {
716                 radlog(L_ERR, "rlm_perl: perl_embed:: module = %s , func = %s exit status= %s\n",
717                        inst->module,
718                        function_name, SvPV(ERRSV,n_a));
719                 POPs;
720         }
721
722         if (count == 1) {
723                 exitstatus = POPi;
724                 if (exitstatus >= 100 || exitstatus < 0) {
725                         exitstatus = RLM_MODULE_FAIL;
726                 }
727         }
728
729
730         PUTBACK;
731         FREETMPS;
732         LEAVE;
733
734         vp = NULL;
735         if ((get_hv_content(rad_request_hv, &vp)) > 0 ) {
736                 pairfree(&request->packet->vps);
737                 request->packet->vps = vp;
738                 vp = NULL;
739
740                 /*
741                  *      Update cached copies
742                  */
743                 request->username = pairfind(request->packet->vps,
744                                              PW_USER_NAME);
745                 request->password = pairfind(request->packet->vps,
746                                              PW_USER_PASSWORD);
747                 if (!request->password)
748                         request->password = pairfind(request->packet->vps,
749                                                      PW_CHAP_PASSWORD);
750         }
751
752         if ((get_hv_content(rad_reply_hv, &vp)) > 0 ) {
753                 pairfree(&request->reply->vps);
754                 request->reply->vps = vp;
755                 vp = NULL;
756         }
757
758         if ((get_hv_content(rad_check_hv, &vp)) > 0 ) {
759                 pairfree(&request->config_items);
760                 request->config_items = vp;
761                 vp = NULL;
762         }
763
764         if (request->proxy &&
765             (get_hv_content(rad_request_proxy_hv, &vp) > 0)) {
766                 pairfree(&request->proxy->vps);
767                 request->proxy->vps = vp;
768                 vp = NULL;
769         }
770
771         if (request->proxy_reply &&
772             (get_hv_content(rad_request_proxy_reply_hv, &vp) > 0)) {
773                 pairfree(&request->proxy_reply->vps);
774                 request->proxy_reply->vps = vp;
775                 vp = NULL;
776         }
777
778         }
779         return exitstatus;
780 }
781
782 /*
783  *      Find the named user in this modules database.  Create the set
784  *      of attribute-value pairs to check and reply with for this user
785  *      from the database. The authentication code only needs to check
786  *      the password, the rest is done here.
787  */
788 static int perl_authorize(void *instance, REQUEST *request)
789 {
790         return rlmperl_call(instance, request,
791                             ((PERL_INST *)instance)->func_authorize);
792 }
793
794 /*
795  *      Authenticate the user with the given password.
796  */
797 static int perl_authenticate(void *instance, REQUEST *request)
798 {
799         return rlmperl_call(instance, request,
800                             ((PERL_INST *)instance)->func_authenticate);
801 }
802 /*
803  *      Massage the request before recording it or proxying it
804  */
805 static int perl_preacct(void *instance, REQUEST *request)
806 {
807         return rlmperl_call(instance, request,
808                             ((PERL_INST *)instance)->func_preacct);
809 }
810 /*
811  *      Write accounting information to this modules database.
812  */
813 static int perl_accounting(void *instance, REQUEST *request)
814 {
815         VALUE_PAIR      *pair;
816         int             acctstatustype=0;
817
818         if ((pair = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE)) != NULL) {
819                 acctstatustype = pair->vp_integer;
820         } else {
821                 radlog(L_ERR, "Invalid Accounting Packet");
822                 return RLM_MODULE_INVALID;
823         }
824
825         switch (acctstatustype) {
826
827                 case PW_STATUS_START:
828
829                         if (((PERL_INST *)instance)->func_start_accounting) {
830                                 return rlmperl_call(instance, request,
831                                             ((PERL_INST *)instance)->func_start_accounting);
832                         } else {
833                                 return rlmperl_call(instance, request,
834                                             ((PERL_INST *)instance)->func_accounting);
835                         }
836                         break;
837
838                 case PW_STATUS_STOP:
839
840                         if (((PERL_INST *)instance)->func_stop_accounting) {
841                                 return rlmperl_call(instance, request,
842                                             ((PERL_INST *)instance)->func_stop_accounting);
843                         } else {
844                                 return rlmperl_call(instance, request,
845                                             ((PERL_INST *)instance)->func_accounting);
846                         }
847                         break;
848                 default:
849                         return rlmperl_call(instance, request,
850                                             ((PERL_INST *)instance)->func_accounting);
851
852         }
853 }
854 /*
855  *      Check for simultaneouse-use
856  */
857 static int perl_checksimul(void *instance, REQUEST *request)
858 {
859         return rlmperl_call(instance, request,
860                         ((PERL_INST *)instance)->func_checksimul);
861 }
862 /*
863  *      Pre-Proxy request
864  */
865 static int perl_pre_proxy(void *instance, REQUEST *request)
866 {
867         return rlmperl_call(instance, request,
868                         ((PERL_INST *)instance)->func_pre_proxy);
869 }
870 /*
871  *      Post-Proxy request
872  */
873 static int perl_post_proxy(void *instance, REQUEST *request)
874 {
875         return rlmperl_call(instance, request,
876                         ((PERL_INST *)instance)->func_post_proxy);
877 }
878 /*
879  *      Pre-Auth request
880  */
881 static int perl_post_auth(void *instance, REQUEST *request)
882 {
883         return rlmperl_call(instance, request,
884                         ((PERL_INST *)instance)->func_post_auth);
885 }
886 #ifdef WITH_COA
887 /*
888  *      Recv CoA request
889  */
890 static int perl_recv_coa(void *instance, REQUEST *request)
891 {
892         return rlmperl_call(instance, request,
893                         ((PERL_INST *)instance)->func_recv_coa);
894 }
895 /*
896  *      Send CoA request
897  */
898 static int perl_send_coa(void *instance, REQUEST *request)
899 {
900         return rlmperl_call(instance, request,
901                         ((PERL_INST *)instance)->func_send_coa);
902 }
903 #endif
904 /*
905  * Detach a instance give a chance to a module to make some internal setup ...
906  */
907 static int perl_detach(void *instance)
908 {
909         PERL_INST       *inst = (PERL_INST *) instance;
910         int             exitstatus = 0, count = 0;
911
912 #if 0
913         /*
914          *      FIXME: Call this in the destruct function?
915          */
916                 {
917                 dTHXa(handle->clone);
918                 PERL_SET_CONTEXT(handle->clone);
919                 {
920                 dSP; ENTER; SAVETMPS; PUSHMARK(SP);
921                 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
922                 SPAGAIN;
923
924                 if (count == 1) {
925                         exitstatus = POPi;
926                         /*
927                          * FIXME: bug in perl
928                          *
929                          */
930                         if (exitstatus >= 100 || exitstatus < 0) {
931                                 exitstatus = RLM_MODULE_FAIL;
932                         }
933                 }
934                 PUTBACK;
935                 FREETMPS;
936                 LEAVE;
937                 }
938                 }
939 #endif
940
941                 if (inst->func_detach) {
942         dTHXa(inst->perl);
943         PERL_SET_CONTEXT(inst->perl);
944         {
945         dSP; ENTER; SAVETMPS;
946         PUSHMARK(SP);
947
948         count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
949         SPAGAIN;
950
951         if (count == 1) {
952                 exitstatus = POPi;
953                 if (exitstatus >= 100 || exitstatus < 0) {
954                         exitstatus = RLM_MODULE_FAIL;
955                 }
956         }
957         PUTBACK;
958         FREETMPS;
959         LEAVE;
960         }
961         }
962
963         xlat_unregister(inst->xlat_name, perl_xlat);
964         free(inst->xlat_name);
965
966 #ifdef USE_ITHREADS
967         rlm_perl_destruct(inst->perl);
968 #else
969         perl_destruct(inst->perl);
970         perl_free(inst->perl);
971 #endif
972
973         free(inst);
974         return exitstatus;
975 }
976
977
978 /*
979  *      The module name should be the only globally exported symbol.
980  *      That is, everything else should be 'static'.
981  *
982  *      If the module needs to temporarily modify it's instantiation
983  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
984  *      The server will then take care of ensuring that the module
985  *      is single-threaded.
986  */
987 module_t rlm_perl = {
988         RLM_MODULE_INIT,
989         "perl",                         /* Name */
990 #ifdef USE_ITHREADS
991         RLM_TYPE_THREAD_SAFE,           /* type */
992 #else
993         RLM_TYPE_THREAD_UNSAFE,
994 #endif
995         perl_instantiate,               /* instantiation */
996         perl_detach,                    /* detach */
997         {
998                 perl_authenticate,      /* authenticate */
999                 perl_authorize,         /* authorize */
1000                 perl_preacct,           /* preacct */
1001                 perl_accounting,        /* accounting */
1002                 perl_checksimul,        /* check simul */
1003                 perl_pre_proxy,         /* pre-proxy */
1004                 perl_post_proxy,        /* post-proxy */
1005                 perl_post_auth          /* post-auth */
1006 #ifdef WITH_COA
1007                 , perl_recv_coa,
1008                 perl_send_coa
1009 #endif
1010         },
1011 };