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;
79 pthread_mutex_t clone_mutex;
83 * A mapping of configuration file names to internal variables.
85 #define RLM_PERL_CONF(_x) { "func_" STRINGIFY(_x), PW_TYPE_STRING_PTR, \
86 offsetof(rlm_perl_t,func_##_x), NULL, STRINGIFY(_x)}
88 static const CONF_PARSER module_config[] = {
89 { "module", PW_TYPE_FILE_INPUT | PW_TYPE_DEPRECATED,
90 offsetof(rlm_perl_t,module), NULL, NULL},
91 { "filename", PW_TYPE_FILE_INPUT | PW_TYPE_REQUIRED,
92 offsetof(rlm_perl_t,module), NULL, NULL},
94 RLM_PERL_CONF(authorize),
95 RLM_PERL_CONF(authenticate),
96 RLM_PERL_CONF(post_auth),
97 RLM_PERL_CONF(accounting),
98 RLM_PERL_CONF(preacct),
99 RLM_PERL_CONF(checksimul),
100 RLM_PERL_CONF(detach),
104 RLM_PERL_CONF(pre_proxy),
105 RLM_PERL_CONF(post_proxy),
108 RLM_PERL_CONF(recv_coa),
109 RLM_PERL_CONF(send_coa),
111 { "perl_flags", PW_TYPE_STRING_PTR,
112 offsetof(rlm_perl_t,perl_flags), NULL, NULL},
114 { "func_start_accounting", PW_TYPE_STRING_PTR,
115 offsetof(rlm_perl_t,func_start_accounting), NULL, NULL},
117 { "func_stop_accounting", PW_TYPE_STRING_PTR,
118 offsetof(rlm_perl_t,func_stop_accounting), NULL, NULL},
120 { NULL, -1, 0, NULL, NULL } /* end the list */
126 EXTERN_C void boot_DynaLoader(pTHX_ CV* cv);
129 #define dl_librefs "DynaLoader::dl_librefs"
130 #define dl_modules "DynaLoader::dl_modules"
131 static void rlm_perl_clear_handles(pTHX)
133 AV *librefs = get_av(dl_librefs, false);
139 static void **rlm_perl_get_handles(pTHX)
142 AV *librefs = get_av(dl_librefs, false);
143 AV *modules = get_av(dl_modules, false);
146 if (!librefs) return NULL;
148 if (!(AvFILL(librefs) >= 0)) {
152 handles = (void **)rad_malloc(sizeof(void *) * (AvFILL(librefs)+2));
154 for (i=0; i<=AvFILL(librefs); i++) {
156 SV *handle_sv = *av_fetch(librefs, i, false);
159 ERROR("Could not fetch $%s[%d]!\n",
163 handle = (void *)SvIV(handle_sv);
173 handles[i] = (void *)0;
178 static void rlm_perl_close_handles(void **handles)
186 for (i=0; handles[i]; i++) {
187 DEBUG("close %p\n", handles[i]);
195 static void rlm_perl_destruct(PerlInterpreter *perl)
199 PERL_SET_CONTEXT(perl);
201 PL_perl_destruct_level = 2;
203 PL_origenviron = environ;
210 * FIXME: This shouldn't happen
213 while (PL_scopestack_ix > 1 ){
222 static void rlm_destroy_perl(PerlInterpreter *perl)
227 PERL_SET_CONTEXT(perl);
229 handles = rlm_perl_get_handles(aTHX);
230 if (handles) rlm_perl_close_handles(handles);
231 rlm_perl_destruct(perl);
235 static void rlm_perl_make_key(pthread_key_t *key)
237 pthread_key_create(key, (void*)rlm_destroy_perl);
240 static PerlInterpreter *rlm_perl_clone(PerlInterpreter *perl, pthread_key_t *key)
244 PerlInterpreter *interp;
247 PERL_SET_CONTEXT(perl);
249 interp = pthread_getspecific(*key);
250 if (interp) return interp;
252 interp = perl_clone(perl, clone_flags);
256 #if PERL_REVISION >= 5 && PERL_VERSION <8
259 ptr_table_free(PL_ptr_table);
262 PERL_SET_CONTEXT(aTHX);
263 rlm_perl_clear_handles(aTHX);
265 ret = pthread_setspecific(*key, interp);
267 DEBUG("rlm_perl: Failed associating interpretor with thread %s", fr_syserror(ret));
269 rlm_perl_destruct(interp);
279 * This is wrapper for radlog
280 * Now users can call radiusd::radlog(level,msg) wich is the same
281 * calling radlog from C code.
284 static XS(XS_radiusd_radlog)
288 croak("Usage: radiusd::radlog(level, message)");
293 level = (int) SvIV(ST(0));
294 msg = (char *) SvPV(ST(1), PL_na);
297 * Because 'msg' is a 'char *', we don't want '%s', etc.
298 * in it to give us printf-style vulnerabilities.
300 radlog(level, "rlm_perl: %s", msg);
305 static void xs_init(pTHX)
307 char const *file = __FILE__;
309 /* DynaLoader is a special case */
310 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
312 newXS("radiusd::radlog",XS_radiusd_radlog, "rlm_perl");
318 static ssize_t perl_xlat(void *instance, REQUEST *request, char const *fmt, char *out, size_t freespace)
321 rlm_perl_t *inst= (rlm_perl_t *) instance;
329 PerlInterpreter *interp;
331 pthread_mutex_lock(&inst->clone_mutex);
332 interp = rlm_perl_clone(inst->perl, inst->thread_key);
335 PERL_SET_CONTEXT(interp);
337 pthread_mutex_unlock(&inst->clone_mutex);
339 PERL_SET_CONTEXT(inst->perl);
348 while ((q = strchr(p, ' '))) {
349 XPUSHs(sv_2mortal(newSVpv(p, p - q)));
356 count = call_pv(inst->func_xlat, G_SCALAR | G_EVAL);
360 REDEBUG("Exit %s", SvPV(ERRSV,n_a));
362 } else if (count > 0) {
364 strlcpy(out, tmp, freespace);
367 RDEBUG("Len is %zu , out is %s freespace is %zu", ret, out, freespace);
379 * Do any per-module initialization that is separate to each
380 * configured instance of the module. e.g. set up connections
381 * to external databases, read configuration files, set up
382 * dictionary entries, etc.
384 * If configuration information is given in the config section
385 * that must be referenced in later calls, store a handle to it
386 * in *instance otherwise put a null pointer there.
389 * Setup a hashes wich we will use later
390 * parse a module and give him a chance to live
393 static int mod_instantiate(CONF_SECTION *conf, void *instance)
395 rlm_perl_t *inst = instance;
400 char const *xlat_name;
401 int exitstatus = 0, argc=0;
403 MEM(embed = talloc_zero_array(inst, char *, 4));
406 * Create pthread key. This key will be stored in instance
410 pthread_mutex_init(&inst->clone_mutex, NULL);
412 inst->thread_key = rad_malloc(sizeof(*inst->thread_key));
413 memset(inst->thread_key,0,sizeof(*inst->thread_key));
415 rlm_perl_make_key(inst->thread_key);
421 if (inst->perl_flags) {
422 embed[1] = inst->perl_flags;
423 embed[2] = inst->module;
427 embed[1] = inst->module;
432 PERL_SYS_INIT3(&argc, &embed, &envp);
434 if ((inst->perl = perl_alloc()) == NULL) {
435 ERROR("rlm_perl: No memory for allocating new perl !");
439 perl_construct(inst->perl);
442 PL_perl_destruct_level = 2;
447 PERL_SET_CONTEXT(inst->perl);
450 #if PERL_REVISION >= 5 && PERL_VERSION >=8
451 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
454 exitstatus = perl_parse(inst->perl, xs_init, argc, embed, NULL);
460 perl_run(inst->perl);
462 ERROR("rlm_perl: perl_parse failed: %s not found or has syntax errors. \n", inst->module);
468 xlat_name = cf_section_name2(conf);
470 xlat_name = cf_section_name1(conf);
472 xlat_register(xlat_name, perl_xlat, NULL, inst);
479 * get the vps and put them in perl hash
480 * If one VP have multiple values it is added as array_ref
481 * Example for this is Cisco-AVPair that holds multiple values.
482 * Which will be available as array_ref in $RAD_REQUEST{'Cisco-AVPair'}
484 static void perl_store_vps(TALLOC_CTX *ctx, VALUE_PAIR *vps, HV *rad_hv)
486 VALUE_PAIR *head, *sublist;
496 * Copy the valuepair list so we can remove attributes
497 * we've already processed. This is a horrible hack to
498 * get around various other stupidity.
500 head = paircopy(ctx, vps);
505 * Tagged attributes are added to the hash with name
506 * <attribute>:<tag>, others just use the normal attribute
509 if (head->da->flags.has_tag && (head->tag != 0)) {
510 snprintf(namebuf, sizeof(namebuf), "%s:%d",
511 head->da->name, head->tag);
514 name = head->da->name;
518 * Create a new list with all the attributes like this one
519 * which are in the same tag group.
522 pairfilter(ctx, &sublist, &head, head->da->attr, head->da->vendor, head->tag);
524 paircursor(&cursor, &sublist);
526 * Attribute has multiple values
528 if (pairnext(&cursor)) {
532 for (vp = pairfirst(&cursor);
534 vp = pairnext(&cursor)) {
535 len = vp_prints_value(buffer, sizeof(buffer), vp, 0);
536 av_push(av, newSVpv(buffer, len));
538 (void)hv_store(rad_hv, name, strlen(name), newRV_noinc((SV *)av), 0);
541 * Attribute has a single value, so its value just gets
545 len = vp_prints_value(buffer, sizeof(buffer), sublist, 0);
546 (void)hv_store(rad_hv, name, strlen(name), newSVpv(buffer, len), 0);
557 * Verify that a Perl SV is a string and save it in FreeRadius
561 static int pairadd_sv(TALLOC_CTX *ctx, VALUE_PAIR **vps, char *key, SV *sv, FR_TOKEN op)
567 val = SvPV_nolen(sv);
568 vp = pairmake(ctx, vps, key, val, op);
570 DEBUG("rlm_perl: Added pair %s = %s", key, val);
573 EDEBUG("rlm_perl: Failed to create pair %s = %s", key, val);
581 * Gets the content from hashes
583 static int get_hv_content(TALLOC_CTX *ctx, HV *my_hv, VALUE_PAIR **vps)
588 I32 key_len, len, i, j;
592 for (i = hv_iterinit(my_hv); i > 0; i--) {
593 res_sv = hv_iternextsv(my_hv,&key,&key_len);
594 if (SvROK(res_sv) && (SvTYPE(SvRV(res_sv)) == SVt_PVAV)) {
595 av = (AV*)SvRV(res_sv);
597 for (j = 0; j <= len; j++) {
598 av_sv = av_fetch(av, j, 0);
599 ret = pairadd_sv(ctx, vps, key, *av_sv, T_OP_ADD) + ret;
601 } else ret = pairadd_sv(ctx, vps, key, res_sv, T_OP_EQ) + ret;
608 * Call the function_name inside the module
609 * Store all vps in hashes %RAD_CHECK %RAD_REPLY %RAD_REQUEST
612 static int do_perl(void *instance, REQUEST *request, char *function_name)
615 rlm_perl_t *inst = instance;
617 int exitstatus=0, count;
625 HV *rad_request_proxy_hv;
626 HV *rad_request_proxy_reply_hv;
630 * Radius has told us to call this function, but none
633 if (!function_name) return RLM_MODULE_FAIL;
636 pthread_mutex_lock(&inst->clone_mutex);
638 PerlInterpreter *interp;
640 interp = rlm_perl_clone(inst->perl,inst->thread_key);
643 PERL_SET_CONTEXT(interp);
646 pthread_mutex_unlock(&inst->clone_mutex);
648 PERL_SET_CONTEXT(inst->perl);
657 rad_reply_hv = get_hv("RAD_REPLY",1);
658 rad_check_hv = get_hv("RAD_CHECK",1);
659 rad_config_hv = get_hv("RAD_CONFIG",1);
660 rad_request_hv = get_hv("RAD_REQUEST",1);
662 perl_store_vps(request->reply, request->reply->vps, rad_reply_hv);
663 perl_store_vps(request, request->config_items, rad_check_hv);
664 perl_store_vps(request->packet, request->packet->vps, rad_request_hv);
665 perl_store_vps(request, request->config_items, rad_config_hv);
668 rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
669 rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
671 if (request->proxy != NULL) {
672 perl_store_vps(request->proxy, request->proxy->vps, rad_request_proxy_hv);
674 hv_undef(rad_request_proxy_hv);
677 if (request->proxy_reply !=NULL) {
678 perl_store_vps(request->proxy_reply, request->proxy_reply->vps, rad_request_proxy_reply_hv);
680 hv_undef(rad_request_proxy_reply_hv);
686 * This way %RAD_xx can be pushed onto stack as sub parameters.
687 * XPUSHs( newRV_noinc((SV *)rad_request_hv) );
688 * XPUSHs( newRV_noinc((SV *)rad_reply_hv) );
689 * XPUSHs( newRV_noinc((SV *)rad_check_hv) );
693 count = call_pv(function_name, G_SCALAR | G_EVAL | G_NOARGS);
698 ERROR("rlm_perl: perl_embed:: module = %s , func = %s exit status= %s\n",
700 function_name, SvPV(ERRSV,n_a));
706 if (exitstatus >= 100 || exitstatus < 0) {
707 exitstatus = RLM_MODULE_FAIL;
717 if ((get_hv_content(request->packet, rad_request_hv, &vp)) > 0 ) {
718 pairfree(&request->packet->vps);
719 request->packet->vps = vp;
723 * Update cached copies
725 request->username = pairfind(request->packet->vps, PW_USER_NAME, 0, TAG_ANY);
726 request->password = pairfind(request->packet->vps, PW_USER_PASSWORD, 0, TAG_ANY);
727 if (!request->password)
728 request->password = pairfind(request->packet->vps, PW_CHAP_PASSWORD, 0, TAG_ANY);
731 if ((get_hv_content(request->reply, rad_reply_hv, &vp)) > 0 ) {
732 pairfree(&request->reply->vps);
733 request->reply->vps = vp;
737 if ((get_hv_content(request, rad_check_hv, &vp)) > 0 ) {
738 pairfree(&request->config_items);
739 request->config_items = vp;
744 if (request->proxy &&
745 (get_hv_content(request->proxy, rad_request_proxy_hv, &vp) > 0)) {
746 pairfree(&request->proxy->vps);
747 request->proxy->vps = vp;
751 if (request->proxy_reply &&
752 (get_hv_content(request->proxy_reply, rad_request_proxy_reply_hv, &vp) > 0)) {
753 pairfree(&request->proxy_reply->vps);
754 request->proxy_reply->vps = vp;
763 #define RLM_PERL_FUNC(_x) static rlm_rcode_t mod_##_x(void *instance, REQUEST *request) \
765 return do_perl(instance, request, \
766 ((rlm_perl_t *)instance)->func_##_x); \
769 RLM_PERL_FUNC(authorize)
770 RLM_PERL_FUNC(authenticate)
771 RLM_PERL_FUNC(post_auth)
773 RLM_PERL_FUNC(checksimul)
776 RLM_PERL_FUNC(pre_proxy)
777 RLM_PERL_FUNC(post_proxy)
781 RLM_PERL_FUNC(recv_coa)
782 RLM_PERL_FUNC(send_coa)
785 RLM_PERL_FUNC(preacct)
788 * Write accounting information to this modules database.
790 static rlm_rcode_t mod_accounting(void *instance, REQUEST *request)
793 int acctstatustype=0;
795 if ((pair = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE, 0, TAG_ANY)) != NULL) {
796 acctstatustype = pair->vp_integer;
798 ERROR("Invalid Accounting Packet");
799 return RLM_MODULE_INVALID;
802 switch (acctstatustype) {
804 case PW_STATUS_START:
806 if (((rlm_perl_t *)instance)->func_start_accounting) {
807 return do_perl(instance, request,
808 ((rlm_perl_t *)instance)->func_start_accounting);
810 return do_perl(instance, request,
811 ((rlm_perl_t *)instance)->func_accounting);
817 if (((rlm_perl_t *)instance)->func_stop_accounting) {
818 return do_perl(instance, request,
819 ((rlm_perl_t *)instance)->func_stop_accounting);
821 return do_perl(instance, request,
822 ((rlm_perl_t *)instance)->func_accounting);
826 return do_perl(instance, request,
827 ((rlm_perl_t *)instance)->func_accounting);
834 * Detach a instance give a chance to a module to make some internal setup ...
836 DIAG_OFF(nested-externs)
837 static int mod_detach(void *instance)
839 rlm_perl_t *inst = (rlm_perl_t *) instance;
840 int exitstatus = 0, count = 0;
844 * FIXME: Call this in the destruct function?
847 dTHXa(handle->clone);
848 PERL_SET_CONTEXT(handle->clone);
850 dSP; ENTER; SAVETMPS; PUSHMARK(SP);
851 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
860 if (exitstatus >= 100 || exitstatus < 0) {
861 exitstatus = RLM_MODULE_FAIL;
871 if (inst->func_detach) {
873 PERL_SET_CONTEXT(inst->perl);
875 dSP; ENTER; SAVETMPS;
878 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
883 if (exitstatus >= 100 || exitstatus < 0) {
884 exitstatus = RLM_MODULE_FAIL;
894 rlm_perl_destruct(inst->perl);
895 pthread_mutex_destroy(&inst->clone_mutex);
897 perl_destruct(inst->perl);
898 perl_free(inst->perl);
904 DIAG_ON(nested-externs)
907 * The module name should be the only globally exported symbol.
908 * That is, everything else should be 'static'.
910 * If the module needs to temporarily modify it's instantiation
911 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
912 * The server will then take care of ensuring that the module
913 * is single-threaded.
915 module_t rlm_perl = {
919 RLM_TYPE_THREAD_SAFE, /* type */
921 RLM_TYPE_THREAD_UNSAFE,
925 mod_instantiate, /* instantiation */
926 mod_detach, /* detach */
928 mod_authenticate, /* authenticate */
929 mod_authorize, /* authorize */
930 mod_preacct, /* preacct */
931 mod_accounting, /* accounting */
932 mod_checksimul, /* check simul */
934 mod_pre_proxy, /* pre-proxy */
935 mod_post_proxy, /* post-proxy */
939 mod_post_auth /* post-auth */