2 * This program is is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License, version 2 if the
4 * License as published by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
11 * You should have received a copy of the GNU General Public License
12 * along with this program; if not, write to the Free Software
13 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 * @brief Translates requests between the server an a perl interpreter.
21 * @copyright 2002,2006 The FreeRADIUS server project
22 * @copyright 2002 Boian Jordanov <bjordanov@orbitel.bg>
26 #include <freeradius-devel/radiusd.h>
27 #include <freeradius-devel/modules.h>
28 #include <freeradius-devel/rad_assert.h>
37 #include <semaphore.h>
40 extern char **environ;
44 * Define a structure for our module configuration.
46 * These variables do not need to be in a structure, but it's
47 * a lot cleaner to do so, and a pointer to the structure can
48 * be used as the instance handle.
50 typedef struct rlm_perl_t {
51 /* Name of the perl module */
54 /* Name of the functions for each module method */
56 char *func_authenticate;
57 char *func_accounting;
58 char *func_start_accounting;
59 char *func_stop_accounting;
61 char *func_checksimul;
66 char *func_post_proxy;
75 PerlInterpreter *perl;
76 pthread_key_t *thread_key;
78 pthread_mutex_t clone_mutex;
81 * A mapping of configuration file names to internal variables.
83 #define RLM_PERL_CONF(_x) { "func_" Stringify(_x), PW_TYPE_STRING_PTR, \
84 offsetof(rlm_perl_t,func_##_x), NULL, Stringify(_x)}
86 static const CONF_PARSER module_config[] = {
87 { "module", PW_TYPE_FILENAME,
88 offsetof(rlm_perl_t,module), NULL, "module"},
90 RLM_PERL_CONF(authorize),
91 RLM_PERL_CONF(authenticate),
92 RLM_PERL_CONF(post_auth),
93 RLM_PERL_CONF(accounting),
94 RLM_PERL_CONF(preacct),
95 RLM_PERL_CONF(checksimul),
96 RLM_PERL_CONF(detach),
100 RLM_PERL_CONF(pre_proxy),
101 RLM_PERL_CONF(post_proxy),
104 RLM_PERL_CONF(recv_coa),
105 RLM_PERL_CONF(send_coa),
107 { "perl_flags", PW_TYPE_STRING_PTR,
108 offsetof(rlm_perl_t,perl_flags), NULL, NULL},
110 { "func_start_accounting", PW_TYPE_STRING_PTR,
111 offsetof(rlm_perl_t,func_start_accounting), NULL, NULL},
113 { "func_stop_accounting", PW_TYPE_STRING_PTR,
114 offsetof(rlm_perl_t,func_stop_accounting), NULL, NULL},
116 { NULL, -1, 0, NULL, NULL } /* end the list */
122 EXTERN_C void boot_DynaLoader(pTHX_ CV* cv);
125 #define dl_librefs "DynaLoader::dl_librefs"
126 #define dl_modules "DynaLoader::dl_modules"
127 static void rlm_perl_clear_handles(pTHX)
129 AV *librefs = get_av(dl_librefs, false);
135 static void **rlm_perl_get_handles(pTHX)
138 AV *librefs = get_av(dl_librefs, false);
139 AV *modules = get_av(dl_modules, false);
142 if (!librefs) return NULL;
144 if (!(AvFILL(librefs) >= 0)) {
148 handles = (void **)rad_malloc(sizeof(void *) * (AvFILL(librefs)+2));
150 for (i=0; i<=AvFILL(librefs); i++) {
152 SV *handle_sv = *av_fetch(librefs, i, false);
155 ERROR("Could not fetch $%s[%d]!\n",
159 handle = (void *)SvIV(handle_sv);
169 handles[i] = (void *)0;
174 static void rlm_perl_close_handles(void **handles)
182 for (i=0; handles[i]; i++) {
183 DEBUG("close %p\n", handles[i]);
191 static void rlm_perl_destruct(PerlInterpreter *perl)
195 PERL_SET_CONTEXT(perl);
197 PL_perl_destruct_level = 2;
199 PL_origenviron = environ;
206 * FIXME: This shouldn't happen
209 while (PL_scopestack_ix > 1 ){
218 static void rlm_destroy_perl(PerlInterpreter *perl)
223 PERL_SET_CONTEXT(perl);
225 handles = rlm_perl_get_handles(aTHX);
226 if (handles) rlm_perl_close_handles(handles);
227 rlm_perl_destruct(perl);
231 static void rlm_perl_make_key(pthread_key_t *key)
233 pthread_key_create(key, (void*)rlm_destroy_perl);
236 static PerlInterpreter *rlm_perl_clone(PerlInterpreter *perl, pthread_key_t *key)
240 PerlInterpreter *interp;
243 PERL_SET_CONTEXT(perl);
245 interp = pthread_getspecific(*key);
246 if (interp) return interp;
248 interp = perl_clone(perl, clone_flags);
252 #if PERL_REVISION >= 5 && PERL_VERSION <8
255 ptr_table_free(PL_ptr_table);
258 PERL_SET_CONTEXT(aTHX);
259 rlm_perl_clear_handles(aTHX);
261 ret = pthread_setspecific(*key, interp);
263 DEBUG("rlm_perl: Failed associating interpretor with thread %s", strerror(ret));
265 rlm_perl_destruct(interp);
273 static void xs_init(pTHX)
275 char const *file = __FILE__;
277 /* DynaLoader is a special case */
278 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
283 * This is wrapper for radlog
284 * Now users can call radiusd::radlog(level,msg) wich is the same
285 * calling radlog from C code.
288 static XS(XS_radiusd_radlog)
292 croak("Usage: radiusd::radlog(level, message)");
297 level = (int) SvIV(ST(0));
298 msg = (char *) SvPV(ST(1), PL_na);
301 * Because 'msg' is a 'char *', we don't want '%s', etc.
302 * in it to give us printf-style vulnerabilities.
304 radlog(level, "rlm_perl: %s", msg);
312 static size_t perl_xlat(void *instance, REQUEST *request, char const *fmt, char *out, size_t freespace)
315 rlm_perl_t *inst= (rlm_perl_t *) instance;
316 PerlInterpreter *perl;
323 #ifndef WITH_ITHREADS
326 perl = rlm_perl_clone(inst->perl,inst->thread_key);
331 PERL_SET_CONTEXT(perl);
339 while ((q = strchr(p, ' '))) {
340 XPUSHs(sv_2mortal(newSVpv(p, p - q)));
347 count = call_pv(inst->func_xlat, G_SCALAR | G_EVAL);
351 REDEBUG("Exit %s", SvPV(ERRSV,n_a));
353 } else if (count > 0) {
355 strlcpy(out, tmp, freespace);
358 RDEBUG("Len is %zu , out is %s freespace is %zu", ret, out, freespace);
370 * Do any per-module initialization that is separate to each
371 * configured instance of the module. e.g. set up connections
372 * to external databases, read configuration files, set up
373 * dictionary entries, etc.
375 * If configuration information is given in the config section
376 * that must be referenced in later calls, store a handle to it
377 * in *instance otherwise put a null pointer there.
380 * Setup a hashes wich we will use later
381 * parse a module and give him a chance to live
384 static int mod_instantiate(CONF_SECTION *conf, void *instance)
386 rlm_perl_t *inst = instance;
391 char const *xlat_name;
392 int exitstatus = 0, argc=0;
394 MEM(embed = talloc_zero_array(inst, char *, 4));
397 * Create pthread key. This key will be stored in instance
401 pthread_mutex_init(&inst->clone_mutex, NULL);
403 inst->thread_key = rad_malloc(sizeof(*inst->thread_key));
404 memset(inst->thread_key,0,sizeof(*inst->thread_key));
406 rlm_perl_make_key(inst->thread_key);
412 if (inst->perl_flags) {
413 embed[1] = inst->perl_flags;
414 embed[2] = inst->module;
418 embed[1] = inst->module;
423 PERL_SYS_INIT3(&argc, &embed, &envp);
425 if ((inst->perl = perl_alloc()) == NULL) {
426 ERROR("rlm_perl: No memory for allocating new perl !");
430 perl_construct(inst->perl);
433 PL_perl_destruct_level = 2;
438 PERL_SET_CONTEXT(inst->perl);
441 #if PERL_REVISION >= 5 && PERL_VERSION >=8
442 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
445 exitstatus = perl_parse(inst->perl, xs_init, argc, embed, NULL);
450 newXS("radiusd::radlog",XS_radiusd_radlog, "rlm_perl");
453 exitstatus = perl_run(inst->perl);
455 ERROR("rlm_perl: perl_parse failed: %s not found or has syntax errors. \n", inst->module);
461 xlat_name = cf_section_name2(conf);
463 xlat_name = cf_section_name1(conf);
465 xlat_register(xlat_name, perl_xlat, NULL, inst);
472 * get the vps and put them in perl hash
473 * If one VP have multiple values it is added as array_ref
474 * Example for this is Cisco-AVPair that holds multiple values.
475 * Which will be available as array_ref in $RAD_REQUEST{'Cisco-AVPair'}
477 static void perl_store_vps(TALLOC_CTX *ctx, VALUE_PAIR *vps, HV *rad_hv)
479 VALUE_PAIR *head, *sublist;
489 * Copy the valuepair list so we can remove attributes
490 * we've already processed. This is a horrible hack to
491 * get around various other stupidity.
493 head = paircopy(ctx, vps);
497 * Tagged attributes are added to the hash with name
498 * <attribute>:<tag>, others just use the normal attribute
501 if (head->da->flags.has_tag && (head->tag != 0)) {
502 snprintf(namebuf, sizeof(namebuf), "%s:%d",
503 head->da->name, head->tag);
506 name = head->da->name;
510 * Create a new list with all the attributes like this one
511 * which are in the same tag group.
514 pairfilter(ctx, &sublist, &head, head->da->attr, head->da->vendor, head->tag);
517 * Attribute has multiple values
523 for (vp = sublist; vp; vp = vp->next) {
524 len = vp_prints_value(buffer, sizeof(buffer), vp, false);
525 av_push(av, newSVpv(buffer, len));
527 (void)hv_store(rad_hv, name, strlen(name), newRV_noinc((SV *)av), 0);
530 * Attribute has a single value, so its value just gets
534 len = vp_prints_value(buffer, sizeof(buffer), sublist, false);
535 (void)hv_store(rad_hv, name, strlen(name), newSVpv(buffer, len), 0);
546 * Verify that a Perl SV is a string and save it in FreeRadius
550 static int pairadd_sv(TALLOC_CTX *ctx, VALUE_PAIR **vps, char *key, SV *sv, FR_TOKEN op)
556 val = SvPV_nolen(sv);
557 vp = pairmake(ctx, vps, key, val, op);
559 DEBUG("rlm_perl: Added pair %s = %s", key, val);
562 DEBUG("rlm_perl: ERROR: Failed to create pair %s = %s", key, val);
570 * Gets the content from hashes
572 static int get_hv_content(TALLOC_CTX *ctx, HV *my_hv, VALUE_PAIR **vps)
577 I32 key_len, len, i, j;
581 for (i = hv_iterinit(my_hv); i > 0; i--) {
582 res_sv = hv_iternextsv(my_hv,&key,&key_len);
583 if (SvROK(res_sv) && (SvTYPE(SvRV(res_sv)) == SVt_PVAV)) {
584 av = (AV*)SvRV(res_sv);
586 for (j = 0; j <= len; j++) {
587 av_sv = av_fetch(av, j, 0);
588 ret = pairadd_sv(ctx, vps, key, *av_sv, T_OP_ADD) + ret;
590 } else ret = pairadd_sv(ctx, vps, key, res_sv, T_OP_EQ) + ret;
597 * Call the function_name inside the module
598 * Store all vps in hashes %RAD_CHECK %RAD_REPLY %RAD_REQUEST
601 static int do_perl(void *instance, REQUEST *request, char *function_name)
604 rlm_perl_t *inst = instance;
606 int exitstatus=0, count;
614 HV *rad_request_proxy_hv;
615 HV *rad_request_proxy_reply_hv;
619 * Radius has told us to call this function, but none
622 if (!function_name) return RLM_MODULE_FAIL;
625 pthread_mutex_lock(&inst->clone_mutex);
627 PerlInterpreter *interp;
629 interp = rlm_perl_clone(inst->perl,inst->thread_key);
632 PERL_SET_CONTEXT(interp);
635 pthread_mutex_unlock(&inst->clone_mutex);
637 PERL_SET_CONTEXT(inst->perl);
646 rad_reply_hv = get_hv("RAD_REPLY",1);
647 rad_check_hv = get_hv("RAD_CHECK",1);
648 rad_config_hv = get_hv("RAD_CONFIG",1);
649 rad_request_hv = get_hv("RAD_REQUEST",1);
651 perl_store_vps(request->reply, request->reply->vps, rad_reply_hv);
652 perl_store_vps(request, request->config_items, rad_check_hv);
653 perl_store_vps(request->packet, request->packet->vps, rad_request_hv);
654 perl_store_vps(request, request->config_items, rad_config_hv);
657 rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
658 rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
660 if (request->proxy != NULL) {
661 perl_store_vps(request->proxy, request->proxy->vps, rad_request_proxy_hv);
663 hv_undef(rad_request_proxy_hv);
666 if (request->proxy_reply !=NULL) {
667 perl_store_vps(request->proxy_reply, request->proxy_reply->vps, rad_request_proxy_reply_hv);
669 hv_undef(rad_request_proxy_reply_hv);
675 * This way %RAD_xx can be pushed onto stack as sub parameters.
676 * XPUSHs( newRV_noinc((SV *)rad_request_hv) );
677 * XPUSHs( newRV_noinc((SV *)rad_reply_hv) );
678 * XPUSHs( newRV_noinc((SV *)rad_check_hv) );
682 count = call_pv(function_name, G_SCALAR | G_EVAL | G_NOARGS);
687 ERROR("rlm_perl: perl_embed:: module = %s , func = %s exit status= %s\n",
689 function_name, SvPV(ERRSV,n_a));
695 if (exitstatus >= 100 || exitstatus < 0) {
696 exitstatus = RLM_MODULE_FAIL;
706 if ((get_hv_content(request->packet, rad_request_hv, &vp)) > 0 ) {
707 pairfree(&request->packet->vps);
708 request->packet->vps = vp;
712 * Update cached copies
714 request->username = pairfind(request->packet->vps, PW_USER_NAME, 0, TAG_ANY);
715 request->password = pairfind(request->packet->vps, PW_USER_PASSWORD, 0, TAG_ANY);
716 if (!request->password)
717 request->password = pairfind(request->packet->vps, PW_CHAP_PASSWORD, 0, TAG_ANY);
720 if ((get_hv_content(request->reply, rad_reply_hv, &vp)) > 0 ) {
721 pairfree(&request->reply->vps);
722 request->reply->vps = vp;
726 if ((get_hv_content(request, rad_check_hv, &vp)) > 0 ) {
727 pairfree(&request->config_items);
728 request->config_items = vp;
733 if (request->proxy &&
734 (get_hv_content(request->proxy, rad_request_proxy_hv, &vp) > 0)) {
735 pairfree(&request->proxy->vps);
736 request->proxy->vps = vp;
740 if (request->proxy_reply &&
741 (get_hv_content(request->proxy_reply, rad_request_proxy_reply_hv, &vp) > 0)) {
742 pairfree(&request->proxy_reply->vps);
743 request->proxy_reply->vps = vp;
752 #define RLM_PERL_FUNC(_x) static rlm_rcode_t mod_##_x(void *instance, REQUEST *request) \
754 return do_perl(instance, request, \
755 ((rlm_perl_t *)instance)->func_##_x); \
758 RLM_PERL_FUNC(authorize)
759 RLM_PERL_FUNC(authenticate)
760 RLM_PERL_FUNC(post_auth)
762 RLM_PERL_FUNC(checksimul)
765 RLM_PERL_FUNC(pre_proxy)
766 RLM_PERL_FUNC(post_proxy)
770 RLM_PERL_FUNC(recv_coa)
771 RLM_PERL_FUNC(send_coa)
774 RLM_PERL_FUNC(preacct)
777 * Write accounting information to this modules database.
779 static rlm_rcode_t mod_accounting(void *instance, REQUEST *request)
782 int acctstatustype=0;
784 if ((pair = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE, 0, TAG_ANY)) != NULL) {
785 acctstatustype = pair->vp_integer;
787 ERROR("Invalid Accounting Packet");
788 return RLM_MODULE_INVALID;
791 switch (acctstatustype) {
793 case PW_STATUS_START:
795 if (((rlm_perl_t *)instance)->func_start_accounting) {
796 return do_perl(instance, request,
797 ((rlm_perl_t *)instance)->func_start_accounting);
799 return do_perl(instance, request,
800 ((rlm_perl_t *)instance)->func_accounting);
806 if (((rlm_perl_t *)instance)->func_stop_accounting) {
807 return do_perl(instance, request,
808 ((rlm_perl_t *)instance)->func_stop_accounting);
810 return do_perl(instance, request,
811 ((rlm_perl_t *)instance)->func_accounting);
815 return do_perl(instance, request,
816 ((rlm_perl_t *)instance)->func_accounting);
823 * Detach a instance give a chance to a module to make some internal setup ...
825 static int mod_detach(void *instance)
827 rlm_perl_t *inst = (rlm_perl_t *) instance;
828 int exitstatus = 0, count = 0;
832 * FIXME: Call this in the destruct function?
835 dTHXa(handle->clone);
836 PERL_SET_CONTEXT(handle->clone);
838 dSP; ENTER; SAVETMPS; PUSHMARK(SP);
839 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
848 if (exitstatus >= 100 || exitstatus < 0) {
849 exitstatus = RLM_MODULE_FAIL;
859 if (inst->func_detach) {
861 PERL_SET_CONTEXT(inst->perl);
863 dSP; ENTER; SAVETMPS;
866 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
871 if (exitstatus >= 100 || exitstatus < 0) {
872 exitstatus = RLM_MODULE_FAIL;
882 rlm_perl_destruct(inst->perl);
883 pthread_mutex_destroy(&inst->clone_mutex);
885 perl_destruct(inst->perl);
886 perl_free(inst->perl);
895 * The module name should be the only globally exported symbol.
896 * That is, everything else should be 'static'.
898 * If the module needs to temporarily modify it's instantiation
899 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
900 * The server will then take care of ensuring that the module
901 * is single-threaded.
903 module_t rlm_perl = {
907 RLM_TYPE_THREAD_SAFE, /* type */
909 RLM_TYPE_THREAD_UNSAFE,
913 mod_instantiate, /* instantiation */
914 mod_detach, /* detach */
916 mod_authenticate, /* authenticate */
917 mod_authorize, /* authorize */
918 mod_preacct, /* preacct */
919 mod_accounting, /* accounting */
920 mod_checksimul, /* check simul */
922 mod_pre_proxy, /* pre-proxy */
923 mod_post_proxy, /* post-proxy */
927 mod_post_auth /* post-auth */