rlm_python.c File Reference

Translates requests between the server an a python interpreter. More...

#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>
#include <libgen.h>
#include <dlfcn.h>

Include dependency graph for rlm_python.c:

Go to the source code of this file.

Data Structures
struct	libpython_global_config_t
	Global config for python library. More...
struct	python_func_def_t
	Specifies the module.function to load for processing a section. More...
struct	rlm_python_t
	An instance of the rlm_python module. More...
struct	rlm_python_thread_t
	Tracks a python module inst/thread state pair. More...

Macros
#define	A(x)
#define	A(x)   { #x, x },
#define	LOAD_INFO(_fmt, ...)   fr_log(LOG_DST, L_INFO, __FILE__, __LINE__, "rlm_python - " _fmt, ## __VA_ARGS__)
#define	LOAD_WARN(_fmt, ...)
#define	LOG_PREFIX   mctx->mi->name
#define	MOD_FUNC(x)
#define	PYTHON_FUNC_DESTROY(_x)   python_function_destroy(&inst->_x)
#define	PYTHON_FUNC_LOAD(_x)   if (python_function_load(mctx, &inst->_x) < 0) goto error

Functions
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)
	Thread safe call to a python function.
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)
static void	libpython_free (void)
static int	libpython_init (void)
static int	mod_detach (module_detach_ctx_t const *mctx)
static int	mod_instantiate (module_inst_ctx_t const *mctx)
static PyObject *	mod_log (UNUSED PyObject *module, PyObject *args)
	Allow fr_log to be called from python.
static int	mod_populate_vptuple (module_ctx_t const *mctx, request_t *request, PyObject *pp, fr_pair_t *vp)
static int	mod_thread_detach (module_thread_inst_ctx_t const *mctx)
static int	mod_thread_instantiate (module_thread_inst_ctx_t const *mctx)
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)
static void	python_error_log (module_ctx_t const *mctx, request_t *request)
	Print out the current error.
static void	python_function_destroy (python_func_def_t *def)
static int	python_function_load (module_inst_ctx_t const *mctx, python_func_def_t *def)
	Import a user module and load a function from it.
static void	python_interpreter_free (rlm_python_t *inst, PyThreadState *interp)
static int	python_interpreter_init (module_inst_ctx_t const *mctx)
static int	python_module_import_config (module_inst_ctx_t const *mctx, CONF_SECTION *conf, PyObject *module)
	Make the current instance's config available within the module we're initialising.
static int	python_module_import_constants (module_inst_ctx_t const *mctx, PyObject *module)
	Import integer constants into the module we're initialising.
static PyObject *	python_module_init (void)
static void	python_obj_destroy (PyObject **ob)
static int	python_parse_config (module_inst_ctx_t const *mctx, CONF_SECTION *cs, int lvl, PyObject *dict)

Variables
static CONF_SECTION *	current_conf
	Used for communication with inittab functions.
static module_ctx_t const *	current_mctx
	Used for communication with inittab functions.
struct {
char const *	name
int	value
}	freeradius_constants []
static PyThreadState *	global_interpreter
	Our first interpreter.
static libpython_global_config_t	libpython_global_config
static conf_parser_t	module_config []
static PyMethodDef	module_methods []
static void *	python_dlhandle
static conf_parser_t const	python_global_config []
module_rlm_t	rlm_python
static global_lib_autoinst_t	rlm_python_autoinst
global_lib_autoinst_t const *const	rlm_python_lib []

Detailed Description

Translates requests between the server an a python interpreter.

Id

7400b0fc6e74fe673dfc0d3e3d037ed926b22431

Note

Rewritten by Paul P. Komkoff Jr i@sti.nosp@m.ngr..nosp@m.net.

Copyright

2000,2006,2015-2016 The FreeRADIUS server project

2002 Miguel A.L. Paraz (mpara.nosp@m.z@mp.nosp@m.araz..nosp@m.com)

2002 Imperium Technology, Inc.

Definition in file rlm_python.c.

---

Data Structure Documentation

libpython_global_config_t

struct libpython_global_config_t

Global config for python library.

Definition at line 78 of file rlm_python.c.

Data Fields
char const *	path	Path to search for python files in.
bool	path_include_default	Include the default python path in path

python_func_def_t

struct python_func_def_t

Specifies the module.function to load for processing a section.

Definition at line 46 of file rlm_python.c.

Data Fields
PyObject *PyObject *	function	< Python reference to module. Python reference to function in module.
char const *	function_name	String name of function in module.
char const *	module_name	String name of module.

rlm_python_t

struct rlm_python_t

An instance of the rlm_python module.

Definition at line 57 of file rlm_python.c.

Collaboration diagram for rlm_python_t:

Data Fields
PyObject *python_func_def_t	accounting
PyObject *python_func_def_t	authenticate
PyObject *python_func_def_t	authorize
PyObject *python_func_def_t	detach
PyObject *python_func_def_t	instantiate	< Local, interpreter specific module.
PyThreadState *	interpreter	The interpreter used for this instance of rlm_python.
char const *	name	Name of the module instance.
PyObject *python_func_def_t	post_auth
PyObject *python_func_def_t	preacct
PyObject *	pythonconf_dict	Configuration parameters defined in the module made available to the python script.

rlm_python_thread_t

struct rlm_python_thread_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.

Definition at line 88 of file rlm_python.c.

Data Fields
PyThreadState *	state	Module instance/thread specific state.

Macro Definition Documentation

A [1/2]

#define A

(

x

)

Value:

        { 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 [2/2]

#define A

(

x

)

{ #x, x },

LOAD_INFO

#define LOAD_INFO	(		_fmt,
			...
	)		fr_log(LOG_DST, L_INFO, __FILE__, __LINE__, "rlm_python - " _fmt, ## __VA_ARGS__)

LOAD_WARN

#define LOAD_WARN	(		_fmt,
			...
	)

Value:

                                           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__)

LOG_PREFIX

#define LOG_PREFIX   mctx->mi->name

Definition at line 30 of file rlm_python.c.

MOD_FUNC

#define MOD_FUNC

(

x

)

Value:

static unlang_action_t  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);\
}

Definition at line 659 of file rlm_python.c.

PYTHON_FUNC_DESTROY

#define PYTHON_FUNC_DESTROY

(

_x

)

python_function_destroy(&inst->_x)

PYTHON_FUNC_LOAD

#define PYTHON_FUNC_LOAD

(

_x

)

if (python_function_load(mctx, &inst->_x) < 0) goto error

Function Documentation

do_python()

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  )

static

Thread safe call to a python function.

Will swap in thread state specific to module/thread.

Definition at line 639 of file rlm_python.c.

Here is the call graph for this function:

do_python_single()

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  )

static

Definition at line 508 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

libpython_free()

static void libpython_free ( void  )

static

Definition at line 1172 of file rlm_python.c.

libpython_init()

static int libpython_init ( void  )

static

Definition at line 1088 of file rlm_python.c.

Here is the call graph for this function:

mod_detach()

static int mod_detach ( module_detach_ctx_t const *  mctx )

static

Definition at line 1011 of file rlm_python.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Definition at line 960 of file rlm_python.c.

Here is the call graph for this function:

mod_log()

static PyObject * mod_log ( UNUSED PyObject *  module, PyObject *  args  )

static

Allow fr_log to be called from python.

Definition at line 204 of file rlm_python.c.

Here is the call graph for this function:

mod_populate_vptuple()

static int mod_populate_vptuple ( module_ctx_t const *  mctx, request_t *  request, PyObject *  pp, fr_pair_t *  vp  )

static

Definition at line 373 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_thread_detach()

static int mod_thread_detach ( module_thread_inst_ctx_t const *  mctx )

static

Definition at line 1075 of file rlm_python.c.

mod_thread_instantiate()

static int mod_thread_instantiate ( module_thread_inst_ctx_t const *  mctx )

static

Definition at line 1057 of file rlm_python.c.

mod_vptuple()

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  )

static

Definition at line 281 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

python_error_log()

static void python_error_log ( module_ctx_t const *  mctx, request_t *  request  )

static

Print out the current error.

Must be called with a valid thread state set

Definition at line 231 of file rlm_python.c.

Here is the caller graph for this function:

python_function_destroy()

static void python_function_destroy ( python_func_def_t *  def )

static

Definition at line 680 of file rlm_python.c.

Here is the call graph for this function:

python_function_load()

static int python_function_load ( module_inst_ctx_t const *  mctx, python_func_def_t *  def  )

static

Import a user module and load a function from it.

Definition at line 689 of file rlm_python.c.

Here is the call graph for this function:

python_interpreter_free()

static void python_interpreter_free ( rlm_python_t *  inst, PyThreadState *  interp  )

static

Definition at line 935 of file rlm_python.c.

Here is the caller graph for this function:

python_interpreter_init()

static int python_interpreter_init ( module_inst_ctx_t const *  mctx )

static

Definition at line 887 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

python_module_import_config()

static int python_module_import_config ( module_inst_ctx_t const *  mctx, CONF_SECTION *  conf, PyObject *  module  )

static

Make the current instance's config available within the module we're initialising.

Definition at line 810 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

python_module_import_constants()

static int python_module_import_constants ( module_inst_ctx_t const *  mctx, PyObject *  module  )

static

Import integer constants into the module we're initialising.

Definition at line 846 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

python_module_init()

static PyObject * python_module_init ( void  )

static

Definition at line 864 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

python_obj_destroy()

static void python_obj_destroy ( PyObject **  ob )

static

Definition at line 672 of file rlm_python.c.

Here is the caller graph for this function:

python_parse_config()

static int python_parse_config ( module_inst_ctx_t const *  mctx, CONF_SECTION *  cs, int  lvl, PyObject *  dict  )

static

Definition at line 727 of file rlm_python.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

current_conf

CONF_SECTION* current_conf

static

Used for communication with inittab functions.

Definition at line 96 of file rlm_python.c.

current_mctx

module_ctx_t const* current_mctx

static

Used for communication with inittab functions.

Definition at line 95 of file rlm_python.c.

[struct]

struct { ... } freeradius_constants[]

Initial value:

= {
 
#define A(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)
 
 
 
        { NULL, 0 },
}

global_interpreter

PyThreadState* global_interpreter

static

Our first interpreter.

Definition at line 93 of file rlm_python.c.

libpython_global_config

libpython_global_config_t libpython_global_config

static

Initial value:

= {
        .path = NULL,
        .path_include_default = true
}

Definition at line 98 of file rlm_python.c.

module_config

conf_parser_t module_config[]

static

Initial value:

= {
 
#define A(x)                                                                                   
                                                                      
 
        A(instantiate)
        A(authorize)
        A(authenticate)
        A(preacct)
        A(accounting)
        A(post_auth)
        A(detach)
 
 
 
        CONF_PARSER_TERMINATOR
}

Definition at line 147 of file rlm_python.c.

module_methods

PyMethodDef module_methods[]

static

Initial value:

= {
        { "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 },
}

Definition at line 218 of file rlm_python.c.

python_dlhandle

void* python_dlhandle

static

Definition at line 92 of file rlm_python.c.

python_global_config

conf_parser_t const python_global_config[]

static

Initial value:

= {
        { 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
}

Definition at line 103 of file rlm_python.c.

rlm_python

module_rlm_t rlm_python

Definition at line 1195 of file rlm_python.c.

rlm_python_autoinst

global_lib_autoinst_t rlm_python_autoinst

static

Initial value:

= {
        .name = "python",
        .config = python_global_config,
        .init = libpython_init,
        .free = libpython_free,
        .inst = &libpython_global_config
}

Definition at line 112 of file rlm_python.c.

rlm_python_lib

global_lib_autoinst_t const *const rlm_python_lib

Initial value:

= {
        &rlm_python_autoinst,
        GLOBAL_LIB_TERMINATOR
}

Definition at line 121 of file rlm_python.c.