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.
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.
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
20 * Copyright 2002,2006 The FreeRADIUS server project
21 * Copyright 2002 Boian Jordanov <bjordanov@orbitel.bg>
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
42 #include <semaphore.h>
45 extern char **environ;
49 * Define a structure for our module configuration.
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.
55 typedef struct perl_inst {
56 /* Name of the perl module */
59 /* Name of the functions for each module method */
61 char *func_authenticate;
62 char *func_accounting;
63 char *func_start_accounting;
64 char *func_stop_accounting;
66 char *func_checksimul;
70 char *func_post_proxy;
78 PerlInterpreter *perl;
79 pthread_key_t *thread_key;
82 * A mapping of configuration file names to internal variables.
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
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"},
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"},
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},
126 { NULL, -1, 0, NULL, NULL } /* end the list */
132 EXTERN_C void boot_DynaLoader(pTHX_ CV* cv);
135 #define dl_librefs "DynaLoader::dl_librefs"
136 #define dl_modules "DynaLoader::dl_modules"
137 static void rlm_perl_clear_handles(pTHX)
139 AV *librefs = get_av(dl_librefs, FALSE);
145 static void **rlm_perl_get_handles(pTHX)
148 AV *librefs = get_av(dl_librefs, FALSE);
149 AV *modules = get_av(dl_modules, FALSE);
154 "Could not get @%s for unloading.\n",
159 if (!(AvFILL(librefs) >= 0)) {
163 handles = (void **)rad_malloc(sizeof(void *) * (AvFILL(librefs)+2));
165 for (i=0; i<=AvFILL(librefs); i++) {
167 SV *handle_sv = *av_fetch(librefs, i, FALSE);
171 "Could not fetch $%s[%d]!\n",
175 handle = (void *)SvIV(handle_sv);
185 handles[i] = (void *)0;
190 static void rlm_perl_close_handles(void **handles)
198 for (i=0; handles[i]; i++) {
199 radlog(L_DBG, "close %p\n", handles[i]);
206 static void rlm_perl_destruct(PerlInterpreter *perl)
210 PERL_SET_CONTEXT(perl);
212 PL_perl_destruct_level = 2;
214 PL_origenviron = environ;
220 * FIXME: This shouldn't happen
223 while (PL_scopestack_ix > 1 ){
231 static void rlm_destroy_perl(PerlInterpreter *perl)
236 PERL_SET_CONTEXT(perl);
238 handles = rlm_perl_get_handles(aTHX);
239 rlm_perl_destruct(perl);
240 rlm_perl_close_handles(handles);
244 static void rlm_perl_make_key(pthread_key_t *key)
246 pthread_key_create(key, rlm_destroy_perl);
249 static PerlInterpreter *rlm_perl_clone(PerlInterpreter *perl, pthread_key_t *key)
251 PerlInterpreter *interp;
254 PERL_SET_CONTEXT(perl);
256 interp = pthread_getspecific(*key);
257 if (interp) return interp;
259 interp = perl_clone(perl, clone_flags);
263 #if PERL_REVISION >= 5 && PERL_VERSION <8
266 ptr_table_free(PL_ptr_table);
269 PERL_SET_CONTEXT(aTHX);
270 rlm_perl_clear_handles(aTHX);
272 pthread_setspecific(*key, interp);
274 fprintf(stderr, "GOT CLONE %d %p\n", pthread_self(), interp);
280 static void xs_init(pTHX)
282 char *file = __FILE__;
284 /* DynaLoader is a special case */
285 newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
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.
295 static XS(XS_radiusd_radlog)
299 croak("Usage: radiusd::radlog(level, message)");
304 level = (int) SvIV(ST(0));
305 msg = (char *) SvPV(ST(1), PL_na);
308 * Because 'msg' is a 'char *', we don't want '%s', etc.
309 * in it to give us printf-style vulnerabilities.
311 radlog(level, "rlm_perl: %s", msg);
319 static size_t perl_xlat(void *instance, REQUEST *request, char *fmt, char *out,
320 size_t freespace, RADIUS_ESCAPE_STRING func)
323 PERL_INST *inst= (PERL_INST *) instance;
324 PerlInterpreter *perl;
325 char params[1024], *ptr, *tmp;
331 * Do an xlat on the provided string (nice recursive operation).
333 if (!radius_xlat(params, sizeof(params), fmt, request, func)) {
334 radlog(L_ERR, "rlm_perl: xlat failed.");
338 #ifndef WITH_ITHREADS
341 perl = rlm_perl_clone(inst->perl,inst->thread_key);
346 PERL_SET_CONTEXT(perl);
351 ptr = strtok(params, " ");
355 while (ptr != NULL) {
356 XPUSHs(sv_2mortal(newSVpv(ptr,0)));
357 ptr = strtok(NULL, " ");
362 count = call_pv(inst->func_xlat, G_SCALAR | G_EVAL);
366 radlog(L_ERR, "rlm_perl: perl_xlat exit %s\n",
369 } else if (count > 0) {
371 strlcpy(out, tmp, freespace);
374 radlog(L_DBG,"rlm_perl: Len is %d , out is %s freespace is %d",
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.
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.
396 * Setup a hashes wich we will use later
397 * parse a module and give him a chance to live
400 static int perl_instantiate(CONF_SECTION *conf, void **instance)
402 PERL_INST *inst = (PERL_INST *) instance;
407 HV *rad_request_proxy_hv;
408 HV *rad_request_proxy_reply_hv;
413 const char *xlat_name;
414 int exitstatus = 0, argc=0;
416 embed = rad_malloc(4*(sizeof(char *)));
417 memset(embed, 0, sizeof(4*(sizeof(char *))));
419 * Set up a storage area for instance data
421 inst = rad_malloc(sizeof(PERL_INST));
422 memset(inst, 0, sizeof(PERL_INST));
425 * If the configuration parameters can't be parsed, then
428 if (cf_section_parse(conf, inst, module_config) < 0) {
434 * Create pthread key. This key will be stored in instance
438 inst->thread_key = rad_malloc(sizeof(*inst->thread_key));
439 memset(inst->thread_key,0,sizeof(*inst->thread_key));
441 rlm_perl_make_key(inst->thread_key);
444 if (inst->perl_flags) {
445 embed[1] = inst->perl_flags;
446 embed[2] = inst->module;
450 embed[1] = inst->module;
455 PERL_SYS_INIT3(&argc, &embed, &envp);
457 if ((inst->perl = perl_alloc()) == NULL) {
458 radlog(L_DBG, "rlm_perl: No memory for allocating new perl !");
462 perl_construct(inst->perl);
463 PL_perl_destruct_level = 2;
468 PERL_SET_CONTEXT(inst->perl);
470 if ((inst->perl = perl_alloc()) == NULL) {
471 radlog(L_ERR, "rlm_perl: No memory for allocating new perl !");
475 perl_construct(inst->perl);
478 #if PERL_REVISION >= 5 && PERL_VERSION >=8
479 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
482 exitstatus = perl_parse(inst->perl, xs_init, argc, embed, NULL);
488 exitstatus = perl_run(inst->perl);
490 radlog(L_ERR,"rlm_perl: perl_parse failed: %s not found or has syntax errors. \n", inst->module);
496 newXS("radiusd::radlog",XS_radiusd_radlog, "rlm_perl.c");
498 rad_reply_hv = newHV();
499 rad_check_hv = newHV();
500 rad_config_hv = newHV();
501 rad_request_hv = newHV();
502 rad_request_proxy_hv = newHV();
503 rad_request_proxy_reply_hv = newHV();
505 rad_reply_hv = get_hv("RAD_REPLY",1);
506 rad_check_hv = get_hv("RAD_CHECK",1);
507 rad_config_hv = get_hv("RAD_CONFIG",1);
508 rad_request_hv = get_hv("RAD_REQUEST",1);
509 rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
510 rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
512 xlat_name = cf_section_name2(conf);
513 if (xlat_name == NULL)
514 xlat_name = cf_section_name1(conf);
516 inst->xlat_name = strdup(xlat_name);
517 xlat_register(xlat_name, perl_xlat, inst);
526 * get the vps and put them in perl hash
527 * If one VP have multiple values it is added as array_ref
528 * Example for this is Cisco-AVPair that holds multiple values.
529 * Which will be available as array_ref in $RAD_REQUEST{'Cisco-AVPair'}
531 static void perl_store_vps(VALUE_PAIR *vp, HV *rad_hv)
533 VALUE_PAIR *nvp, *vpa, *vpn;
535 char namebuf[256], *name;
537 int attr, vendor, len;
542 while (nvp != NULL) {
544 attr = nvp->attribute;
545 vendor = nvp->vendor;
546 vpa = paircopy2(nvp, attr, vendor);
552 len = vp_prints_value(buffer, sizeof(buffer),
554 av_push(av, newSVpv(buffer, len));
557 hv_store(rad_hv, nvp->name, strlen(nvp->name),
558 newRV_noinc((SV *) av), 0);
560 if ((vpa->flags.has_tag) &&
561 (vpa->flags.tag != 0)) {
562 snprintf(namebuf, sizeof(namebuf), "%s:%d",
563 nvp->name, nvp->flags.tag);
567 len = vp_prints_value(buffer, sizeof(buffer),
569 hv_store(rad_hv, name, strlen(name),
570 newSVpv(buffer, len), 0);
574 vpa = nvp; while ((vpa != NULL) && (vpa->attribute == attr) && (vpa->vendor == vendor))
576 pairdelete(&nvp, attr, vendor);
583 * Verify that a Perl SV is a string and save it in FreeRadius
587 static int pairadd_sv(VALUE_PAIR **vp, char *key, SV *sv, int operator) {
592 val = SvPV_nolen(sv);
593 vpp = pairmake(key, val, operator);
597 "rlm_perl: Added pair %s = %s", key, val);
601 "rlm_perl: ERROR: Failed to create pair %s = %s",
610 * Gets the content from hashes
612 static int get_hv_content(HV *my_hv, VALUE_PAIR **vp)
617 I32 key_len, len, i, j;
621 for (i = hv_iterinit(my_hv); i > 0; i--) {
622 res_sv = hv_iternextsv(my_hv,&key,&key_len);
623 if (SvROK(res_sv) && (SvTYPE(SvRV(res_sv)) == SVt_PVAV)) {
624 av = (AV*)SvRV(res_sv);
626 for (j = 0; j <= len; j++) {
627 av_sv = av_fetch(av, j, 0);
628 ret = pairadd_sv(vp, key, *av_sv, T_OP_ADD) + ret;
630 } else ret = pairadd_sv(vp, key, res_sv, T_OP_EQ) + ret;
637 * Call the function_name inside the module
638 * Store all vps in hashes %RAD_CHECK %RAD_REPLY %RAD_REQUEST
641 static int rlmperl_call(void *instance, REQUEST *request, char *function_name)
644 PERL_INST *inst = instance;
646 int exitstatus=0, count;
653 HV *rad_request_proxy_hv;
654 HV *rad_request_proxy_reply_hv;
657 PerlInterpreter *interp;
659 interp = rlm_perl_clone(inst->perl,inst->thread_key);
662 PERL_SET_CONTEXT(interp);
665 PERL_SET_CONTEXT(inst->perl);
675 * Radius has told us to call this function, but none
678 if (!function_name) {
679 return RLM_MODULE_FAIL;
682 rad_reply_hv = get_hv("RAD_REPLY",1);
683 rad_check_hv = get_hv("RAD_CHECK",1);
684 rad_config_hv = get_hv("RAD_CONFIG",1);
685 rad_request_hv = get_hv("RAD_REQUEST",1);
686 rad_request_proxy_hv = get_hv("RAD_REQUEST_PROXY",1);
687 rad_request_proxy_reply_hv = get_hv("RAD_REQUEST_PROXY_REPLY",1);
690 perl_store_vps(request->reply->vps, rad_reply_hv);
691 perl_store_vps(request->config_items, rad_check_hv);
692 perl_store_vps(request->packet->vps, rad_request_hv);
693 perl_store_vps(request->config_items, rad_config_hv);
695 if (request->proxy != NULL) {
696 perl_store_vps(request->proxy->vps, rad_request_proxy_hv);
698 hv_undef(rad_request_proxy_hv);
701 if (request->proxy_reply !=NULL) {
702 perl_store_vps(request->proxy_reply->vps, rad_request_proxy_reply_hv);
704 hv_undef(rad_request_proxy_reply_hv);
709 * This way %RAD_xx can be pushed onto stack as sub parameters.
710 * XPUSHs( newRV_noinc((SV *)rad_request_hv) );
711 * XPUSHs( newRV_noinc((SV *)rad_reply_hv) );
712 * XPUSHs( newRV_noinc((SV *)rad_check_hv) );
716 count = call_pv(function_name, G_SCALAR | G_EVAL | G_NOARGS);
721 radlog(L_ERR, "rlm_perl: perl_embed:: module = %s , func = %s exit status= %s\n",
723 function_name, SvPV(ERRSV,n_a));
729 if (exitstatus >= 100 || exitstatus < 0) {
730 exitstatus = RLM_MODULE_FAIL;
740 if ((get_hv_content(rad_request_hv, &vp)) > 0 ) {
741 pairfree(&request->packet->vps);
742 request->packet->vps = vp;
746 * Update cached copies
748 request->username = pairfind(request->packet->vps,
750 request->password = pairfind(request->packet->vps,
751 PW_USER_PASSWORD, 0);
752 if (!request->password)
753 request->password = pairfind(request->packet->vps,
754 PW_CHAP_PASSWORD, 0);
757 if ((get_hv_content(rad_reply_hv, &vp)) > 0 ) {
758 pairfree(&request->reply->vps);
759 request->reply->vps = vp;
763 if ((get_hv_content(rad_check_hv, &vp)) > 0 ) {
764 pairfree(&request->config_items);
765 request->config_items = vp;
769 if (request->proxy &&
770 (get_hv_content(rad_request_proxy_hv, &vp) > 0)) {
771 pairfree(&request->proxy->vps);
772 request->proxy->vps = vp;
776 if (request->proxy_reply &&
777 (get_hv_content(rad_request_proxy_reply_hv, &vp) > 0)) {
778 pairfree(&request->proxy_reply->vps);
779 request->proxy_reply->vps = vp;
788 * Find the named user in this modules database. Create the set
789 * of attribute-value pairs to check and reply with for this user
790 * from the database. The authentication code only needs to check
791 * the password, the rest is done here.
793 static int perl_authorize(void *instance, REQUEST *request)
795 return rlmperl_call(instance, request,
796 ((PERL_INST *)instance)->func_authorize);
800 * Authenticate the user with the given password.
802 static int perl_authenticate(void *instance, REQUEST *request)
804 return rlmperl_call(instance, request,
805 ((PERL_INST *)instance)->func_authenticate);
808 * Massage the request before recording it or proxying it
810 static int perl_preacct(void *instance, REQUEST *request)
812 return rlmperl_call(instance, request,
813 ((PERL_INST *)instance)->func_preacct);
816 * Write accounting information to this modules database.
818 static int perl_accounting(void *instance, REQUEST *request)
821 int acctstatustype=0;
823 if ((pair = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE, 0)) != NULL) {
824 acctstatustype = pair->vp_integer;
826 radlog(L_ERR, "Invalid Accounting Packet");
827 return RLM_MODULE_INVALID;
830 switch (acctstatustype) {
832 case PW_STATUS_START:
834 if (((PERL_INST *)instance)->func_start_accounting) {
835 return rlmperl_call(instance, request,
836 ((PERL_INST *)instance)->func_start_accounting);
838 return rlmperl_call(instance, request,
839 ((PERL_INST *)instance)->func_accounting);
845 if (((PERL_INST *)instance)->func_stop_accounting) {
846 return rlmperl_call(instance, request,
847 ((PERL_INST *)instance)->func_stop_accounting);
849 return rlmperl_call(instance, request,
850 ((PERL_INST *)instance)->func_accounting);
854 return rlmperl_call(instance, request,
855 ((PERL_INST *)instance)->func_accounting);
860 * Check for simultaneouse-use
862 static int perl_checksimul(void *instance, REQUEST *request)
864 return rlmperl_call(instance, request,
865 ((PERL_INST *)instance)->func_checksimul);
870 static int perl_pre_proxy(void *instance, REQUEST *request)
872 return rlmperl_call(instance, request,
873 ((PERL_INST *)instance)->func_pre_proxy);
878 static int perl_post_proxy(void *instance, REQUEST *request)
880 return rlmperl_call(instance, request,
881 ((PERL_INST *)instance)->func_post_proxy);
886 static int perl_post_auth(void *instance, REQUEST *request)
888 return rlmperl_call(instance, request,
889 ((PERL_INST *)instance)->func_post_auth);
895 static int perl_recv_coa(void *instance, REQUEST *request)
897 return rlmperl_call(instance, request,
898 ((PERL_INST *)instance)->func_recv_coa);
903 static int perl_send_coa(void *instance, REQUEST *request)
905 return rlmperl_call(instance, request,
906 ((PERL_INST *)instance)->func_send_coa);
910 * Detach a instance give a chance to a module to make some internal setup ...
912 static int perl_detach(void *instance)
914 PERL_INST *inst = (PERL_INST *) instance;
915 int exitstatus = 0, count = 0;
919 * FIXME: Call this in the destruct function?
922 dTHXa(handle->clone);
923 PERL_SET_CONTEXT(handle->clone);
925 dSP; ENTER; SAVETMPS; PUSHMARK(SP);
926 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
935 if (exitstatus >= 100 || exitstatus < 0) {
936 exitstatus = RLM_MODULE_FAIL;
946 if (inst->func_detach) {
948 PERL_SET_CONTEXT(inst->perl);
950 dSP; ENTER; SAVETMPS;
953 count = call_pv(inst->func_detach, G_SCALAR | G_EVAL );
958 if (exitstatus >= 100 || exitstatus < 0) {
959 exitstatus = RLM_MODULE_FAIL;
968 xlat_unregister(inst->xlat_name, perl_xlat);
969 free(inst->xlat_name);
972 rlm_perl_destruct(inst->perl);
974 perl_destruct(inst->perl);
975 perl_free(inst->perl);
985 * The module name should be the only globally exported symbol.
986 * That is, everything else should be 'static'.
988 * If the module needs to temporarily modify it's instantiation
989 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
990 * The server will then take care of ensuring that the module
991 * is single-threaded.
993 module_t rlm_perl = {
997 RLM_TYPE_THREAD_SAFE, /* type */
999 RLM_TYPE_THREAD_UNSAFE,
1001 perl_instantiate, /* instantiation */
1002 perl_detach, /* detach */
1004 perl_authenticate, /* authenticate */
1005 perl_authorize, /* authorize */
1006 perl_preacct, /* preacct */
1007 perl_accounting, /* accounting */
1008 perl_checksimul, /* check simul */
1009 perl_pre_proxy, /* pre-proxy */
1010 perl_post_proxy, /* post-proxy */
1011 perl_post_auth /* post-auth */