Python

Due to limitations in Python, the search path for modules can only be set globally, rather than per module instance.

This is set in the Python global config.

Each rlm_python module instance should set a module option which is the default Python module from which functions will be called.

An instantiate and detach function can be defined to run code during server start up and shutdown.

When rlm_python is called in a processing section, by default the function called is based on the section name. e.g. if the call is made in recv Access-Request then, recv_access_request will be called if it exists, otherwise recv will be called.

In order to override the function being called, configuration options such as func_recv_access_request or func_recv can be used. e.g.

could be used to use previous function names.

In addition, the Python module can be changed on a per function basis with configuration options such as mod_recv_access_request or mod_recv.

If rlm_python is called with a suffix, e.g.

then, by default my_function will be called in the default module. As with other calls the module can be specified with mod_my_function and the actual function with func_my_function.

Each function is called with an object representing the request, which contains objects representing the attribute lists.

Attributes can be accessed using Python dict syntax, e.g. p.request['User-Name'] which is an object representing that attribute.

When an attribute is referenced in string context (e.g. wrapped in str()) then the string representation of the attribute value will be returned.

Each attribute object has a value which can be used to get or set its value in the appropriate native Python type based on the type of the attribute in the dictionary e.g.

Nested attributes are accessed with syntax of the form

Where there are multiple instances of an attribute, as with unlang, by default the first instance is returned.

To access other instances of an attribute add a numeric key e.g.

are the equivalent of request.foo[2] and reply.baa[1].baz in unlang.

If functions returns None (plain return' no return), this is treated as `ok.

Specific return codes can be accessed with pre-defined constants in the freeradius module. e.g.

The Python instantiation function can return -1 to signal failure and abort startup.

FreeRADIUS provides a module, freeradius, which can be used by any Python scripts used by rlm_python.

This module provides: