rlm_python.c

Go to the documentation of this file.

/*
 *   This program is is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or (at
 *   your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: 764dbff74487a6f02aafdeddd95805617881da3b $
 * @file rlm_python.c
 * @brief Translates requests between the server an a python interpreter.
 *
 * @note Rewritten by Paul P. Komkoff Jr <i@stingr.net>.
 *
 * @copyright 2000,2006,2015-2016 The FreeRADIUS server project
 * @copyright 2002 Miguel A.L. Paraz (mparaz@mparaz.com)
 * @copyright 2002 Imperium Technology, Inc.
 */
RCSID("$Id: 764dbff74487a6f02aafdeddd95805617881da3b $")
 
#define LOG_PREFIX mctx->mi->name
 
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/pairmove.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/lsan.h>
 
#include <Python.h>
#include <frameobject.h> /* Python header not pulled in by default. */
#include <libgen.h>
#include <dlfcn.h>
 
/** Specifies the module.function to load for processing a section
 *
 */
typedef struct {
        PyObject        *module;                //!< Python reference to module.
        PyObject        *function;              //!< Python reference to function in module.
 
        char const      *module_name;           //!< String name of module.
        char const      *function_name;         //!< String name of function in module.
} python_func_def_t;
 
/** An instance of the rlm_python module
 *
 */
typedef struct {
        char const      *name;                  //!< Name of the module instance
        PyThreadState   *interpreter;           //!< The interpreter used for this instance of rlm_python.
        PyObject        *module;                //!< Local, interpreter specific module.
 
        python_func_def_t
        instantiate,
        authorize,
        authenticate,
        preacct,
        accounting,
        post_auth,
        detach;
 
        PyObject        *pythonconf_dict;       //!< Configuration parameters defined in the module
                                                //!< made available to the python script.
} rlm_python_t;
 
/** Global config for python library
 *
 */
typedef struct {
        char const      *path;                  //!< Path to search for python files in.
        bool            path_include_default;   //!< Include the default python path in `path`
} libpython_global_config_t;
 
/** Tracks a python module inst/thread state pair
 *
 * Multiple instances of python create multiple interpreters and each
 * thread must have a PyThreadState per interpreter, to track execution.
 */
typedef struct {
        PyThreadState   *state;                 //!< Module instance/thread specific state.
} rlm_python_thread_t;
 
static void                     *python_dlhandle;
static PyThreadState            *global_interpreter;    //!< Our first interpreter.
 
static module_ctx_t const       *current_mctx;          //!< Used for communication with inittab functions.
static CONF_SECTION             *current_conf;          //!< Used for communication with inittab functions.
 
static libpython_global_config_t libpython_global_config = {
        .path = NULL,
        .path_include_default = true
};
 
static conf_parser_t const python_global_config[] = {
        { FR_CONF_OFFSET("path", libpython_global_config_t, path) },
        { FR_CONF_OFFSET("path_include_default", libpython_global_config_t, path_include_default) },
        CONF_PARSER_TERMINATOR
};
 
static int libpython_init(void);
static void libpython_free(void);
 
static global_lib_autoinst_t rlm_python_autoinst = {
        .name = "python",
        .config = python_global_config,
        .init = libpython_init,
        .free = libpython_free,
        .inst = &libpython_global_config
};
 
extern global_lib_autoinst_t const * const rlm_python_lib[];
global_lib_autoinst_t const * const rlm_python_lib[] = {
        &rlm_python_autoinst,
        GLOBAL_LIB_TERMINATOR
};
 
/*
 *      As of Python 3.8 the GIL will be per-interpreter
 *      If there are still issues with CEXTs,
 *      multiple interpreters and the GIL at that point
 *      users can build rlm_python against Python 3.8
 *      and the horrible hack of using a single interpreter
 *      for all instances of rlm_python will no longer be
 *      required.
 *
 *      As Python 3.x module initialisation is significantly
 *      different than Python 2.x initialisation,
 *      it'd be a pain to retain the cext_compat for
 *      Python 3 and as Python 3 users have the option of
 *      using as version of Python which fixes the underlying
 *      issue, we only support using a global interpreter
 *      for Python 2.7 and below.
 */
 
/*
 *      A mapping of configuration file names to internal variables.
 */
static conf_parser_t module_config[] = {
 
#define A(x) { FR_CONF_OFFSET("mod_" #x, rlm_python_t, x.module_name), .dflt = "${.module}" }, \
        { FR_CONF_OFFSET("func_" #x, rlm_python_t, x.function_name) },
 
        A(instantiate)
        A(authorize)
        A(authenticate)
        A(preacct)
        A(accounting)
        A(post_auth)
        A(detach)
 
#undef A
 
        CONF_PARSER_TERMINATOR
};
 
static struct {
        char const *name;
        int  value;
} freeradius_constants[] = {
 
#define A(x) { #x, x },
 
        A(L_DBG)
        A(L_WARN)
        A(L_INFO)
        A(L_ERR)
        A(L_WARN)
        A(L_DBG_WARN)
        A(L_DBG_ERR)
        A(L_DBG_WARN_REQ)
        A(L_DBG_ERR_REQ)
        A(RLM_MODULE_REJECT)
        A(RLM_MODULE_FAIL)
        A(RLM_MODULE_OK)
        A(RLM_MODULE_HANDLED)
        A(RLM_MODULE_INVALID)
        A(RLM_MODULE_DISALLOW)
        A(RLM_MODULE_NOTFOUND)
        A(RLM_MODULE_NOOP)
        A(RLM_MODULE_UPDATED)
        A(RLM_MODULE_NUMCODES)
 
#undef A
 
        { NULL, 0 },
};
 
/*
 *      radiusd Python functions
 */
 
/** Allow fr_log to be called from python
 *
 */
static PyObject *mod_log(UNUSED PyObject *module, PyObject *args)
{
        int status;
        char *msg;
 
        if (!PyArg_ParseTuple(args, "is", &status, &msg)) {
                Py_RETURN_NONE;
        }
 
        fr_log(&default_log, status, __FILE__, __LINE__, "%s", msg);
 
        Py_RETURN_NONE;
}
 
static PyMethodDef module_methods[] = {
        { "log", &mod_log, METH_VARARGS,
          "freeradius.log(level, msg)\n\n" \
          "Print a message using the freeradius daemon's logging system. level should be one of the\n" \
          "following constants L_DBG, L_WARN, L_INFO, L_ERR, L_DBG_WARN, L_DBG_ERR, L_DBG_WARN_REQ, L_DBG_ERR_REQ\n"
        },
        { NULL, NULL, 0, NULL },
};
 
/** Print out the current error
 *
 * Must be called with a valid thread state set
 */
static void python_error_log(module_ctx_t const *mctx, request_t *request)
{
        PyObject *p_type = NULL, *p_value = NULL, *p_traceback = NULL, *p_str_1 = NULL, *p_str_2 = NULL;
 
        PyErr_Fetch(&p_type, &p_value, &p_traceback);
        PyErr_NormalizeException(&p_type, &p_value, &p_traceback);
        if (!p_type || !p_value) goto failed;
 
        if (((p_str_1 = PyObject_Str(p_type)) == NULL) || ((p_str_2 = PyObject_Str(p_value)) == NULL)) goto failed;
 
        ROPTIONAL(RERROR, ERROR, "%s (%s)", PyUnicode_AsUTF8(p_str_1), PyUnicode_AsUTF8(p_str_2));
 
        if (p_traceback != Py_None) {
                PyTracebackObject *ptb = (PyTracebackObject*)p_traceback;
                size_t fnum = 0;
 
                while (ptb != NULL) {
                        PyFrameObject *cur_frame = ptb->tb_frame;
#if PY_VERSION_HEX >= 0x030A0000
                        PyCodeObject *code = PyFrame_GetCode(cur_frame);
 
                        ROPTIONAL(RERROR, ERROR, "[%ld] %s:%d at %s()",
                                fnum,
                                PyUnicode_AsUTF8(code->co_filename),
                                PyFrame_GetLineNumber(cur_frame),
                                PyUnicode_AsUTF8(code->co_name)
                        );
                        Py_XDECREF(code);
#else
                        ROPTIONAL(RERROR, ERROR, "[%ld] %s:%d at %s()",
                                  fnum,
                                  PyUnicode_AsUTF8(cur_frame->f_code->co_filename),
                                  PyFrame_GetLineNumber(cur_frame),
                                  PyUnicode_AsUTF8(cur_frame->f_code->co_name)
                        );
#endif
 
                        ptb = ptb->tb_next;
                        fnum++;
                }
        }
 
failed:
        Py_XDECREF(p_str_1);
        Py_XDECREF(p_str_2);
        Py_XDECREF(p_type);
        Py_XDECREF(p_value);
        Py_XDECREF(p_traceback);
}
 
static void mod_vptuple(TALLOC_CTX *ctx, module_ctx_t const *mctx, request_t *request,
                        fr_pair_list_t *vps, PyObject *p_value, char const *funcname, char const *list_name)
{
        int             i;
        Py_ssize_t      tuple_len;
        tmpl_t          *dst;
        fr_pair_t       *vp;
        request_t       *current = request;
        fr_pair_list_t  tmp_list;
 
        fr_pair_list_init(&tmp_list);
        /*
         *      If the Python function gave us None for the tuple,
         *      then just return.
         */
        if (p_value == Py_None) return;
 
        if (!PyTuple_CheckExact(p_value)) {
                ERROR("%s - non-tuple passed to %s", funcname, list_name);
                return;
        }
        /* Get the tuple tuple_len. */
        tuple_len = PyTuple_GET_SIZE(p_value);
        for (i = 0; i < tuple_len; i++) {
                PyObject        *p_tuple_element = PyTuple_GET_ITEM(p_value, i);
                PyObject        *p_str_1;
                PyObject        *p_str_2;
                Py_ssize_t      pair_len;
                char const      *s1;
                char const      *s2;
 
                if (!PyTuple_CheckExact(p_tuple_element)) {
                        ERROR("%s - Tuple element %d of %s is not a tuple", funcname, i, list_name);
                        continue;
                }
                /* Check if it's a pair */
 
                pair_len = PyTuple_GET_SIZE(p_tuple_element);
                if ((pair_len < 2) || (pair_len > 3)) {
                        ERROR("%s - Tuple element %d of %s is a tuple of size %zu. Must be 2 or 3",
                              funcname, i, list_name, pair_len);
                        continue;
                }
 
                p_str_1 = PyTuple_GET_ITEM(p_tuple_element, 0);
                p_str_2 = PyTuple_GET_ITEM(p_tuple_element, pair_len - 1);
 
                if ((!PyUnicode_CheckExact(p_str_1)) || (!PyUnicode_CheckExact(p_str_2))) {
                        ERROR("%s - Tuple element %d of %s must be as (str, str)",
                              funcname, i, list_name);
                        continue;
                }
                s1 = PyUnicode_AsUTF8(p_str_1);
                s2 = PyUnicode_AsUTF8(p_str_2);
 
                if (tmpl_afrom_attr_str(ctx, NULL, &dst, s1,
                                        &(tmpl_rules_t){
                                                .attr = {
                                                        .dict_def = request->dict,
                                                        .list_def = request_attr_reply,
                                                        .prefix = TMPL_ATTR_REF_PREFIX_AUTO,
                                                }
                                        }) <= 0) {
                        PERROR("%s - Failed to find attribute %s.%s", funcname, list_name, s1);
                        continue;
                }
 
                if (tmpl_request_ptr(&current, tmpl_request(dst)) < 0) {
                        ERROR("%s - Attribute name %s.%s refers to outer request but not in a tunnel, skipping...",
                              funcname, list_name, s1);
                        talloc_free(dst);
                        continue;
                }
 
                MEM(vp = fr_pair_afrom_da(ctx, tmpl_attr_tail_da(dst)));
                talloc_free(dst);
 
                if (fr_pair_value_from_str(vp, s2, strlen(s2), NULL, false) < 0) {
                        DEBUG("%s - Failed: '%s.%s' = '%s'", funcname, list_name, s1, s2);
                } else {
                        DEBUG("%s - '%s.%s' = '%s'", funcname, list_name, s1, s2);
                }
 
                fr_pair_append(&tmp_list, vp);
        }
        radius_pairmove(request, vps, &tmp_list);
}
 
 
/*
 *      This is the core Python function that the others wrap around.
 *      Pass the value-pair print strings in a tuple.
 */
static int mod_populate_vptuple(module_ctx_t const *mctx, request_t *request, PyObject *pp, fr_pair_t *vp)
{
        PyObject *attribute = NULL;
        PyObject *value = NULL;
 
        attribute = PyUnicode_FromString(vp->da->name);
        if (!attribute) return -1;
 
        switch (vp->vp_type) {
        case FR_TYPE_STRING:
                value = PyUnicode_FromStringAndSize(vp->vp_strvalue, vp->vp_length);
                break;
 
        case FR_TYPE_OCTETS:
                value = PyBytes_FromStringAndSize((char const *)vp->vp_octets, vp->vp_length);
                break;
 
        case FR_TYPE_BOOL:
                value = PyBool_FromLong(vp->vp_bool);
                break;
 
        case FR_TYPE_UINT8:
                value = PyLong_FromUnsignedLong(vp->vp_uint8);
                break;
 
        case FR_TYPE_UINT16:
                value = PyLong_FromUnsignedLong(vp->vp_uint16);
                break;
 
        case FR_TYPE_UINT32:
                value = PyLong_FromUnsignedLong(vp->vp_uint32);
                break;
 
        case FR_TYPE_UINT64:
                value = PyLong_FromUnsignedLongLong(vp->vp_uint64);
                break;
 
        case FR_TYPE_INT8:
                value = PyLong_FromLong(vp->vp_int8);
                break;
 
        case FR_TYPE_INT16:
                value = PyLong_FromLong(vp->vp_int16);
                break;
 
        case FR_TYPE_INT32:
                value = PyLong_FromLong(vp->vp_int32);
                break;
 
        case FR_TYPE_INT64:
                value = PyLong_FromLongLong(vp->vp_int64);
                break;
 
        case FR_TYPE_FLOAT32:
                value = PyFloat_FromDouble((double) vp->vp_float32);
                break;
 
        case FR_TYPE_FLOAT64:
                value = PyFloat_FromDouble(vp->vp_float64);
                break;
 
        case FR_TYPE_SIZE:
                value = PyLong_FromSize_t(vp->vp_size);
                break;
 
        case FR_TYPE_TIME_DELTA:
        case FR_TYPE_DATE:
        case FR_TYPE_IFID:
        case FR_TYPE_IPV6_ADDR:
        case FR_TYPE_IPV6_PREFIX:
        case FR_TYPE_IPV4_ADDR:
        case FR_TYPE_IPV4_PREFIX:
        case FR_TYPE_COMBO_IP_ADDR:
        case FR_TYPE_COMBO_IP_PREFIX:
        case FR_TYPE_ETHERNET:
        {
                ssize_t slen;
                char buffer[256];
 
                slen = fr_value_box_print(&FR_SBUFF_OUT(buffer, sizeof(buffer)), &vp->data, NULL);
                if (slen < 0) {
                error:
                        ROPTIONAL(REDEBUG, ERROR, "Failed marshalling %pP to Python value", vp);
                        python_error_log(mctx, request);
                        Py_XDECREF(attribute);
                        return -1;
                }
                value = PyUnicode_FromStringAndSize(buffer, (size_t)slen);
        }
                break;
 
        case FR_TYPE_NON_LEAF:
        {
                fr_pair_t       *child_vp;
                int             child_len, i = 0;
 
                child_len = fr_pair_list_num_elements(&vp->vp_group);
                if (child_len == 0) {
                        Py_INCREF(Py_None);
                        value = Py_None;
                        break;
                }
 
                if ((value = PyTuple_New(child_len)) == NULL) goto error;
 
                for (child_vp = fr_pair_list_head(&vp->vp_group);
                     child_vp;
                     child_vp = fr_pair_list_next(&vp->vp_group, child_vp), i++) {
                        PyObject *child_pp;
 
                        if ((child_pp = PyTuple_New(2)) == NULL) {
                                Py_DECREF(value);
                                goto error;
                        }
 
                        if (mod_populate_vptuple(mctx, request, child_pp, child_vp) == 0) {
                                PyTuple_SET_ITEM(value, i, child_pp);
                        } else {
                                Py_INCREF(Py_None);
                                PyTuple_SET_ITEM(value, i, Py_None);
                                Py_DECREF(child_pp);
                        }
                }
        }
                break;
        }
 
        if (value == NULL) goto error;
 
        PyTuple_SET_ITEM(pp, 0, attribute);
        PyTuple_SET_ITEM(pp, 1, value);
 
        return 0;
}
 
static unlang_action_t do_python_single(rlm_rcode_t *p_result, module_ctx_t const *mctx,
                                        request_t *request, PyObject *p_func, char const *funcname)
{
        fr_pair_t       *vp;
        PyObject        *p_ret = NULL;
        PyObject        *p_arg = NULL;
        int             tuple_len;
        rlm_rcode_t     rcode = RLM_MODULE_OK;
 
        /*
         *      We will pass a tuple containing (name, value) tuples
         *      We can safely use the Python function to build up a
         *      tuple, since the tuple is not used elsewhere.
         *
         *      Determine the size of our tuple by walking through the packet.
         *      If request is NULL, pass None.
         */
        tuple_len = 0;
        if (request != NULL) {
                tuple_len = fr_pair_list_num_elements(&request->request_pairs);
        }
 
        if (tuple_len == 0) {
                Py_INCREF(Py_None);
                p_arg = Py_None;
        } else {
                int i = 0;
                if ((p_arg = PyTuple_New(tuple_len)) == NULL) {
                        rcode = RLM_MODULE_FAIL;
                        goto finish;
                }
 
                for (vp = fr_pair_list_head(&request->request_pairs);
                     vp;
                     vp = fr_pair_list_next(&request->request_pairs, vp), i++) {
                        PyObject *pp;
 
                        /* The inside tuple has two only: */
                        if ((pp = PyTuple_New(2)) == NULL) {
                                rcode = RLM_MODULE_FAIL;
                                goto finish;
                        }
 
                        if (mod_populate_vptuple(mctx, request, pp, vp) == 0) {
                                /* Put the tuple inside the container */
                                PyTuple_SET_ITEM(p_arg, i, pp);
                        } else {
                                Py_INCREF(Py_None);
                                PyTuple_SET_ITEM(p_arg, i, Py_None);
                                Py_DECREF(pp);
                        }
                }
        }
 
        /* Call Python function. */
        p_ret = PyObject_CallFunctionObjArgs(p_func, p_arg, NULL);
        if (!p_ret) {
                python_error_log(mctx, request); /* Needs valid thread with GIL */
                rcode = RLM_MODULE_FAIL;
                goto finish;
        }
 
        if (!request) {
                // check return code at module instantiation time
                if (PyNumber_Check(p_ret)) rcode = PyLong_AsLong(p_ret);
                goto finish;
        }
 
        /*
         *      The function returns either:
         *  1. (returnvalue, replyTuple, configTuple), where
         *   - returnvalue is one of the constants RLM_*
         *   - replyTuple and configTuple are tuples of string
         *      tuples of size 2
         *
         *  2. the function return value alone
         *
         *  3. None - default return value is set
         *
         * xxx This code is messy!
         */
        if (PyTuple_CheckExact(p_ret)) {
                PyObject *p_tuple_int;
 
                if (PyTuple_GET_SIZE(p_ret) != 3) {
                        ERROR("%s - Tuple must be (return, replyTuple, configTuple)", funcname);
                        rcode = RLM_MODULE_FAIL;
                        goto finish;
                }
 
                p_tuple_int = PyTuple_GET_ITEM(p_ret, 0);
                if (!PyNumber_Check(p_tuple_int)) {
                        ERROR("%s - First tuple element not an integer", funcname);
                        rcode = RLM_MODULE_FAIL;
                        goto finish;
                }
                /* Now have the return value */
                rcode = PyLong_AsLong(p_tuple_int);
                /* Reply item tuple */
                mod_vptuple(request->reply_ctx, mctx, request, &request->reply_pairs,
                            PyTuple_GET_ITEM(p_ret, 1), funcname, "reply");
                /* Config item tuple */
                mod_vptuple(request->control_ctx, mctx, request, &request->control_pairs,
                            PyTuple_GET_ITEM(p_ret, 2), funcname, "config");
 
        } else if (PyNumber_Check(p_ret)) {
                /* Just an integer */
                rcode = PyLong_AsLong(p_ret);
 
        } else if (p_ret == Py_None) {
                /* returned 'None', return value defaults to "OK, continue." */
                rcode = RLM_MODULE_OK;
        } else {
                /* Not tuple or None */
                ERROR("%s - Function did not return a tuple or None", funcname);
                rcode = RLM_MODULE_FAIL;
                goto finish;
        }
 
finish:
        if (rcode == RLM_MODULE_FAIL) python_error_log(mctx, request);
        Py_XDECREF(p_arg);
        Py_XDECREF(p_ret);
 
        RETURN_MODULE_RCODE(rcode);
}
 
/** Thread safe call to a python function
 *
 * Will swap in thread state specific to module/thread.
 */
static unlang_action_t do_python(rlm_rcode_t *p_result, module_ctx_t const *mctx,
                                 request_t *request, PyObject *p_func, char const *funcname)
{
        rlm_python_thread_t     *t = talloc_get_type_abort(mctx->thread, rlm_python_thread_t);
        rlm_rcode_t             rcode;
 
        /*
         *      It's a NOOP if the function wasn't defined
         */
        if (!p_func) RETURN_MODULE_NOOP;
 
        RDEBUG3("Using thread state %p/%p", mctx->mi->data, t->state);
 
        PyEval_RestoreThread(t->state); /* Swap in our local thread state */
        do_python_single(&rcode, mctx, request, p_func, funcname);
        (void)fr_cond_assert(PyEval_SaveThread() == t->state);
 
        RETURN_MODULE_RCODE(rcode);
}
 
#define MOD_FUNC(x) \
static unlang_action_t CC_HINT(nonnull) mod_##x(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request) \
{ \
        rlm_python_t const *inst = talloc_get_type_abort_const(mctx->mi->data, rlm_python_t); \
        return do_python(p_result, mctx, request, inst->x.function, #x);\
}
 
MOD_FUNC(authenticate)
MOD_FUNC(authorize)
MOD_FUNC(preacct)
MOD_FUNC(accounting)
MOD_FUNC(post_auth)
 
static void python_obj_destroy(PyObject **ob)
{
        if (*ob != NULL) {
                Py_DECREF(*ob);
                *ob = NULL;
        }
}
 
static void python_function_destroy(python_func_def_t *def)
{
        python_obj_destroy(&def->function);
        python_obj_destroy(&def->module);
}
 
/** Import a user module and load a function from it
 *
 */
static int python_function_load(module_inst_ctx_t const *mctx, python_func_def_t *def)
{
        char const *funcname = "python_function_load";
 
        if (def->module_name == NULL || def->function_name == NULL) return 0;
 
        LSAN_DISABLE(def->module = PyImport_ImportModule(def->module_name));
        if (!def->module) {
                ERROR("%s - Module '%s' load failed", funcname, def->module_name);
        error:
                python_error_log(MODULE_CTX_FROM_INST(mctx), NULL);
                Py_XDECREF(def->function);
                def->function = NULL;
                Py_XDECREF(def->module);
                def->module = NULL;
 
                return -1;
        }
 
        def->function = PyObject_GetAttrString(def->module, def->function_name);
        if (!def->function) {
                ERROR("%s - Function '%s.%s' is not found", funcname, def->module_name, def->function_name);
                goto error;
        }
 
        if (!PyCallable_Check(def->function)) {
                ERROR("%s - Function '%s.%s' is not callable", funcname, def->module_name, def->function_name);
                goto error;
        }
 
        DEBUG2("Loaded function '%s.%s'", def->module_name, def->function_name);
        return 0;
}
 
/*
 *      Parse a configuration section, and populate a dict.
 *      This function is recursively called (allows to have nested dicts.)
 */
static int python_parse_config(module_inst_ctx_t const *mctx, CONF_SECTION *cs, int lvl, PyObject *dict)
{
        int             indent_section = (lvl * 4);
        int             indent_item = (lvl + 1) * 4;
        int             ret = 0;
        CONF_ITEM       *ci = NULL;
 
        if (!cs || !dict) return -1;
 
        DEBUG("%*s%s {", indent_section, " ", cf_section_name1(cs));
 
        while ((ci = cf_item_next(cs, ci))) {
                /*
                 *  This is a section.
                 *  Create a new dict, store it in current dict,
                 *  Then recursively call python_parse_config with this section and the new dict.
                 */
                if (cf_item_is_section(ci)) {
                        CONF_SECTION    *sub_cs = cf_item_to_section(ci);
                        char const      *key = cf_section_name1(sub_cs); /* dict key */
                        PyObject        *sub_dict, *p_key;
 
                        p_key = PyUnicode_FromString(key);
                        if (!p_key) {
                                ERROR("Failed converting config key \"%s\" to python string", key);
                                return -1;
                        }
 
                        if (PyDict_Contains(dict, p_key)) {
                                WARN("Ignoring duplicate config section '%s'", key);
                                continue;
                        }
 
                        MEM(sub_dict = PyDict_New());
                        (void)PyDict_SetItem(dict, p_key, sub_dict);
 
                        ret = python_parse_config(mctx, sub_cs, lvl + 1, sub_dict);
                        if (ret < 0) break;
                } else if (cf_item_is_pair(ci)) {
                        CONF_PAIR       *cp = cf_item_to_pair(ci);
                        char const      *key = cf_pair_attr(cp); /* dict key */
                        char const      *value = cf_pair_value(cp); /* dict value */
                        PyObject        *p_key, *p_value;
 
                        if (!value) {
                                WARN("Skipping \"%s\" as it has no value", key);
                                continue;
                        }
 
                        p_key = PyUnicode_FromString(key);
                        p_value = PyUnicode_FromString(value);
                        if (!p_key) {
                                ERROR("Failed converting config key \"%s\" to python string", key);
                                return -1;
                        }
                        if (!p_value) {
                                ERROR("Failed converting config value \"%s\" to python string", value);
                                return -1;
                        }
 
                        /*
                         *  This is an item.
                         *  Store item attr / value in current dict.
                         */
                        if (PyDict_Contains(dict, p_key)) {
                                WARN("Ignoring duplicate config item '%s'", key);
                                continue;
                        }
 
                        (void)PyDict_SetItem(dict, p_key, p_value);
 
                        DEBUG("%*s%s = \"%s\"", indent_item, " ", key, value);
                }
        }
 
        DEBUG("%*s}", indent_section, " ");
 
        return ret;
}
 
/** Make the current instance's config available within the module we're initialising
 *
 */
static int python_module_import_config(module_inst_ctx_t const *mctx, CONF_SECTION *conf, PyObject *module)
{
        rlm_python_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_python_t);
        CONF_SECTION *cs;
 
        /*
         *      Convert a FreeRADIUS config structure into a python
         *      dictionary.
         */
        inst->pythonconf_dict = PyDict_New();
        if (!inst->pythonconf_dict) {
                ERROR("Unable to create python dict for config");
        error:
                Py_XDECREF(inst->pythonconf_dict);
                inst->pythonconf_dict = NULL;
                python_error_log(MODULE_CTX_FROM_INST(mctx), NULL);
                return -1;
        }
 
        cs = cf_section_find(conf, "config", NULL);
        if (cs) {
                DEBUG("Inserting \"config\" section into python environment as radiusd.config");
                if (python_parse_config(mctx, cs, 0, inst->pythonconf_dict) < 0) goto error;
        }
 
        /*
         *      Add module configuration as a dict
         */
        if (PyModule_AddObject(module, "config", inst->pythonconf_dict) < 0) goto error;
 
        return 0;
}
 
/** Import integer constants into the module we're initialising
 *
 */
static int python_module_import_constants(module_inst_ctx_t const *mctx, PyObject *module)
{
        size_t i;
 
        for (i = 0; freeradius_constants[i].name; i++) {
                if ((PyModule_AddIntConstant(module, freeradius_constants[i].name, freeradius_constants[i].value)) < 0) {
                        ERROR("Failed adding constant to module");
                        python_error_log(MODULE_CTX_FROM_INST(mctx), NULL);
                        return -1;
                }
        }
 
        return 0;
}
 
/*
 *      Python 3 interpreter initialisation and destruction
 */
static PyObject *python_module_init(void)
{
        PyObject                *module;
 
        static struct PyModuleDef py_module_def = {
                PyModuleDef_HEAD_INIT,
                .m_name = "freeradius",
                .m_doc = "freeRADIUS python module",
                .m_size = -1,
                .m_methods = module_methods
        };
 
        fr_assert(current_mctx);
 
        module = PyModule_Create(&py_module_def);
        if (!module) {
                python_error_log(current_mctx, NULL);
                Py_RETURN_NONE;
        }
 
        return module;
}
 
static int python_interpreter_init(module_inst_ctx_t const *mctx)
{
        rlm_python_t    *inst = talloc_get_type_abort(mctx->mi->data, rlm_python_t);
        CONF_SECTION    *conf = mctx->mi->conf;
        PyObject        *module;
 
        /*
         *      python_module_init takes no args, so we need
         *      to set these globals so that when it's
         *      called during interpreter initialisation
         *      it can get at the current instance config.
         */
        current_mctx = MODULE_CTX_FROM_INST(mctx);
        current_conf = conf;
 
        PyEval_RestoreThread(global_interpreter);
        LSAN_DISABLE(inst->interpreter = Py_NewInterpreter());
        if (!inst->interpreter) {
                ERROR("Failed creating new interpreter");
                return -1;
        }
        DEBUG3("Created new interpreter %p", inst->interpreter);
        PyEval_SaveThread();            /* Unlock GIL */
 
        PyEval_RestoreThread(inst->interpreter);
 
        /*
         *      Import the radiusd module into this python
         *      environment.  Each interpreter gets its
         *      own copy which it can mutate as much as
         *      it wants.
         */
        module = PyImport_ImportModule("freeradius");
        if (!module) {
                ERROR("Failed importing \"freeradius\" module into interpreter %p", inst->interpreter);
                return -1;
        }
        if ((python_module_import_config(mctx, conf, module) < 0) ||
            (python_module_import_constants(mctx, module) < 0)) {
                Py_DECREF(module);
                return -1;
        }
        inst->module = module;
        PyEval_SaveThread();
 
        return 0;
}
 
static void python_interpreter_free(rlm_python_t *inst, PyThreadState *interp)
{
        /*
         *      We incremented the reference count earlier
         *      during module initialisation.
         */
        Py_XDECREF(inst->module);
 
        PyEval_RestoreThread(interp);   /* Switches thread state and locks GIL */
        Py_EndInterpreter(interp);      /* Destroys interpreter (GIL still locked) - sets thread state to NULL */
        PyThreadState_Swap(global_interpreter); /* Get a none-null thread state */
        PyEval_SaveThread();            /* Unlock GIL */
}
 
/*
 *      Do any per-module initialization that is separate to each
 *      configured instance of the module.  e.g. set up connections
 *      to external databases, read configuration files, set up
 *      dictionary entries, etc.
 *
 *      If configuration information is given in the config section
 *      that must be referenced in later calls, store a handle to it
 *      in *instance otherwise put a null pointer there.
 *
 */
static int mod_instantiate(module_inst_ctx_t const *mctx)
{
        rlm_python_t    *inst = talloc_get_type_abort(mctx->mi->data, rlm_python_t);
 
        if (python_interpreter_init(mctx) < 0) return -1;
 
        /*
         *      Switch to our module specific interpreter
         */
        PyEval_RestoreThread(inst->interpreter);
 
        /*
         *      Process the various sections
         */
#define PYTHON_FUNC_LOAD(_x) if (python_function_load(mctx, &inst->_x) < 0) goto error
        PYTHON_FUNC_LOAD(instantiate);
        PYTHON_FUNC_LOAD(authenticate);
        PYTHON_FUNC_LOAD(authorize);
        PYTHON_FUNC_LOAD(preacct);
        PYTHON_FUNC_LOAD(accounting);
        PYTHON_FUNC_LOAD(post_auth);
        PYTHON_FUNC_LOAD(detach);
 
        /*
         *      Call the instantiate function.
         */
        if (inst->instantiate.function) {
                rlm_rcode_t rcode;
 
                do_python_single(&rcode, MODULE_CTX_FROM_INST(mctx), NULL, inst->instantiate.function, "instantiate");
                switch (rcode) {
                case RLM_MODULE_FAIL:
                case RLM_MODULE_REJECT:
                error:
                        fr_cond_assert(PyEval_SaveThread() == inst->interpreter);
                        python_interpreter_free(inst, inst->interpreter);
                        return -1;
 
                default:
                        break;
                }
        }
 
        /*
         *      Switch back to the global interpreter
         */
        if (!fr_cond_assert(PyEval_SaveThread() == inst->interpreter)) goto error;
 
        return 0;
}
 
static int mod_detach(module_detach_ctx_t const *mctx)
{
        rlm_python_t    *inst = talloc_get_type_abort(mctx->mi->data, rlm_python_t);
 
        /*
         *      If we don't have a interpreter
         *      we didn't get far enough into
         *      instantiation to generate things
         *      we need to clean up...
         */
        if (!inst->interpreter) return 0;
 
        /*
         *      Call module destructor
         */
        PyEval_RestoreThread(inst->interpreter);
 
        /*
         *      We don't care if this fails.
         */
        if (inst->detach.function) {
                rlm_rcode_t rcode;
 
                (void)do_python_single(&rcode, MODULE_CTX_FROM_INST(mctx), NULL, inst->detach.function, "detach");
        }
 
#define PYTHON_FUNC_DESTROY(_x) python_function_destroy(&inst->_x)
        PYTHON_FUNC_DESTROY(instantiate);
        PYTHON_FUNC_DESTROY(authorize);
        PYTHON_FUNC_DESTROY(authenticate);
        PYTHON_FUNC_DESTROY(preacct);
        PYTHON_FUNC_DESTROY(accounting);
        PYTHON_FUNC_DESTROY(post_auth);
        PYTHON_FUNC_DESTROY(detach);
 
        Py_XDECREF(inst->pythonconf_dict);
        PyEval_SaveThread();
 
        /*
         *      Free the module specific interpreter
         */
        python_interpreter_free(inst, inst->interpreter);
 
        return 0;
}
 
static int mod_thread_instantiate(module_thread_inst_ctx_t const *mctx)
{
        PyThreadState           *state;
        rlm_python_t            *inst = talloc_get_type_abort(mctx->mi->data, rlm_python_t);
        rlm_python_thread_t     *t = talloc_get_type_abort(mctx->thread, rlm_python_thread_t);
 
        state = PyThreadState_New(inst->interpreter->interp);
        if (!state) {
                ERROR("Failed initialising local PyThreadState");
                return -1;
        }
 
        DEBUG3("Initialised new thread state %p", state);
        t->state = state;
 
        return 0;
}
 
static int mod_thread_detach(module_thread_inst_ctx_t const *mctx)
{
        rlm_python_thread_t     *t = talloc_get_type_abort(mctx->thread, rlm_python_thread_t);
 
        PyEval_RestoreThread(t->state); /* Swap in our local thread state */
        PyThreadState_Clear(t->state);
        PyEval_SaveThread();
 
        PyThreadState_Delete(t->state); /* Don't need to hold lock for this */
 
        return 0;
}
 
static int libpython_init(void)
{
#define LOAD_INFO(_fmt, ...) fr_log(LOG_DST, L_INFO, __FILE__, __LINE__, "rlm_python - " _fmt,  ## __VA_ARGS__)
#define LOAD_WARN(_fmt, ...) fr_log_perror(LOG_DST, L_WARN, __FILE__, __LINE__, \
                                           &(fr_log_perror_format_t){ \
                                                .first_prefix = "rlm_python - ", \
                                                .subsq_prefix = "rlm_python - ", \
                                           }, \
                                           _fmt,  ## __VA_ARGS__)
        PyConfig        config;
        PyStatus        status;
        wchar_t         *wide_name;
        char            *path;
 
        fr_assert(!Py_IsInitialized());
 
        LOAD_INFO("Python version: %s", Py_GetVersion());
        dependency_version_number_add(NULL, "python", Py_GetVersion());
 
        /*
         *      Load python using RTLD_GLOBAL and dlopen.
         *      This fixes issues where python C extensions
         *      can't find the symbols they need.
         */
        python_dlhandle = dl_open_by_sym("Py_IsInitialized", RTLD_NOW | RTLD_GLOBAL);
        if (!python_dlhandle) LOAD_WARN("Failed loading libpython symbols into global symbol table");
 
        PyConfig_InitPythonConfig(&config);
 
        /*
         *      Set program name (i.e. the software calling the interpreter)
         *      The value of argv[0] as a wide char string
         */
        wide_name = Py_DecodeLocale(main_config->name, NULL);
        status = PyConfig_SetString(&config, &config.program_name, wide_name);
        PyMem_RawFree(wide_name);
 
        if (PyStatus_Exception(status)) {
        fail:
                LOAD_WARN("%s", status.err_msg);
                PyConfig_Clear(&config);
                return -1;
        }
 
        /*
         *      Python 3 introduces the concept of a
         *      "inittab", i.e. a list of modules which
         *      are automatically created when the first
         *      interpreter is spawned.
         */
        PyImport_AppendInittab("freeradius", python_module_init);
 
        if (libpython_global_config.path) {
                wchar_t *wide_path = Py_DecodeLocale(libpython_global_config.path, NULL);
 
                if (libpython_global_config.path_include_default) {
                        /*
                         *      The path from config is to be used in addition to the default.
                         *      Set it in the pythonpath_env.
                         */
                        status = PyConfig_SetString(&config, &config.pythonpath_env, wide_path);
                } else {
                        /*
                         *      Only the path from config is to be used.
                         *      Setting module_search_paths_set to 1 disables any automatic paths.
                         */
                        config.module_search_paths_set = 1;
                        status = PyWideStringList_Append(&config.module_search_paths, wide_path);
                }
                PyMem_RawFree(wide_path);
                if (PyStatus_Exception(status)) goto fail;
        }
 
        config.install_signal_handlers = 0;     /* Don't override signal handlers - noop on subs calls */
 
        LSAN_DISABLE(status = Py_InitializeFromConfig(&config));
        if (PyStatus_Exception(status)) goto fail;
 
        PyConfig_Clear(&config);
 
        /*
         *      Report the path
         */
        path = Py_EncodeLocale(Py_GetPath(), NULL);
        LOAD_INFO("Python path set to \"%s\"", path);
        PyMem_Free(path);
 
        global_interpreter = PyEval_SaveThread();       /* Store reference to the main interpreter and release the GIL */
 
        return 0;
}
 
static void libpython_free(void)
{
        PyThreadState_Swap(global_interpreter); /* Swap to the main thread */
 
        /*
         *      PyImport_Cleanup - Leaks memory in python 3.6
         *      should check once we require 3.8 that this is
         *      still needed.
         */
        LSAN_DISABLE(Py_Finalize());                    /* Ignore leaks on exit, we don't reload modules so we don't care */
        if (python_dlhandle) dlclose(python_dlhandle);  /* dlclose will SEGV on null handle */
}
 
/*
 *      The module name should be the only globally exported symbol.
 *      That is, everything else should be 'static'.
 *
 *      If the module needs to temporarily modify it's instantiation
 *      data, the type should be changed to MODULE_TYPE_THREAD_UNSAFE.
 *      The server will then take care of ensuring that the module
 *      is single-threaded.
 */
extern module_rlm_t rlm_python;
module_rlm_t rlm_python = {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "python",
 
                .inst_size              = sizeof(rlm_python_t),
                .thread_inst_size       = sizeof(rlm_python_thread_t),
 
                .config                 = module_config,
 
                .instantiate            = mod_instantiate,
                .detach                 = mod_detach,
 
                .thread_instantiate     = mod_thread_instantiate,
                .thread_detach          = mod_thread_detach
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        /*
                         *      Hack to support old configurations
                         */
                        { .section = SECTION_NAME("accounting", CF_IDENT_ANY), .method = mod_accounting },
                        { .section = SECTION_NAME("authenticate", CF_IDENT_ANY), .method = mod_authenticate },
                        { .section = SECTION_NAME("authorize", CF_IDENT_ANY), .method = mod_authorize },
 
                        { .section = SECTION_NAME("recv", "accounting-request"), .method = mod_preacct },
                        { .section = SECTION_NAME("recv", CF_IDENT_ANY), .method = mod_authorize },
 
                        { .section = SECTION_NAME("send", CF_IDENT_ANY), .method = mod_post_auth },
                        MODULE_BINDING_TERMINATOR
                }
        }
};