rlm_exec.c File Reference

Execute commands and parse the results. More...

#include <stdint.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/tmpl.h>
#include <freeradius-devel/server/exec.h>
#include <freeradius-devel/server/main_config.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/unlang/call_env.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/token.h>
#include <freeradius-devel/server/pairmove.h>
#include <freeradius-devel/unlang/xlat_func.h>
#include <freeradius-devel/unlang/xlat.h>
#include <freeradius-devel/unlang/module.h>

Include dependency graph for rlm_exec.c:

Go to the source code of this file.

Data Structures
struct	exec_call_env_t
struct	rlm_exec_ctx_t
struct	rlm_exec_t

Macros
#define	LOG_PREFIX   mctx->inst->name

Functions
static xlat_action_t	exec_xlat_oneshot (TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
	Exec programs from an xlat. More...
static xlat_action_t	exec_xlat_oneshot_wait_resume (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
static unlang_action_t	mod_exec_dispatch_oneshot (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Dispatch one request using a short lived process. More...
static unlang_action_t	mod_exec_oneshot_nowait_resume (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Resume a request after xlat expansion. More...
static unlang_action_t	mod_exec_oneshot_wait_resume (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Process the exit code and output of a short lived process. More...
static rlm_rcode_t	rlm_exec_status2rcode (request_t *request, fr_value_box_t *box, int status)
	Process the exit code returned by one of the exec functions. More...

Variables
static const call_env_method_t	exec_method_env
static xlat_arg_parser_t const	exec_xlat_args []
static const conf_parser_t	module_config []
static fr_sbuff_parse_rules_t const	rhs_term
module_rlm_t	rlm_exec
static const rlm_rcode_t	status2rcode []

Detailed Description

Execute commands and parse the results.

Id

df686ac20dd52cb713408744c3b9b5792302c7e4

Copyright

2002,2006 The FreeRADIUS server project

2002 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file rlm_exec.c.

---

Data Structure Documentation

exec_call_env_t

struct exec_call_env_t

Definition at line 68 of file rlm_exec.c.

Collaboration diagram for exec_call_env_t:

Data Fields
tmpl_t *	program

rlm_exec_ctx_t

struct rlm_exec_ctx_t

Definition at line 176 of file rlm_exec.c.

Data Fields
fr_value_box_list_t	box
int	status

rlm_exec_t

struct rlm_exec_t

Definition at line 48 of file rlm_exec.c.

Collaboration diagram for rlm_exec_t:

Data Fields
bool	env_inherit
tmpl_t *	input_list
tmpl_t *	output_list
bool	shell_escape
fr_time_delta_t	timeout
bool	timeout_is_set
bool	wait

Macro Definition Documentation

LOG_PREFIX

#define LOG_PREFIX   mctx->inst->name

Definition at line 27 of file rlm_exec.c.

Function Documentation

exec_xlat_oneshot_wait_resume()

static xlat_action_t exec_xlat_oneshot_wait_resume ( TALLOC_CTX *  ctx, fr_dcursor_t *  out, xlat_ctx_t const *  xctx, request_t *  request, UNUSED fr_value_box_list_t *  in  )

static

Definition at line 80 of file rlm_exec.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_bootstrap()

static int mod_bootstrap ( module_inst_ctx_t const *  mctx )

static

Definition at line 455 of file rlm_exec.c.

Here is the call graph for this function:

mod_exec_dispatch_oneshot()

static unlang_action_t mod_exec_dispatch_oneshot ( rlm_rcode_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Dispatch one request using a short lived process.

Definition at line 385 of file rlm_exec.c.

Here is the call graph for this function:

mod_exec_oneshot_nowait_resume()

static unlang_action_t mod_exec_oneshot_nowait_resume ( rlm_rcode_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Resume a request after xlat expansion.

Definition at line 240 of file rlm_exec.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_exec_oneshot_wait_resume()

static unlang_action_t mod_exec_oneshot_wait_resume ( rlm_rcode_t *  p_result, module_ctx_t const *  mctx, request_t *  request  )

static

Process the exit code and output of a short lived process.

Definition at line 282 of file rlm_exec.c.

Here is the call graph for this function:

Here is the caller graph for this function:

rlm_exec_status2rcode()

static rlm_rcode_t rlm_exec_status2rcode ( request_t *  request, fr_value_box_t *  box, int  status  )

static

Process the exit code returned by one of the exec functions.

Parameters

request	Current request.
box	Output string from exec call.
status	code returned by exec call.

Returns

One of the RLM_MODULE_* values.

Definition at line 202 of file rlm_exec.c.

Here is the caller graph for this function:

Variable Documentation

exec_method_env

const call_env_method_t exec_method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(exec_call_env_t),
        .env = (call_env_parser_t[]){
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("program", FR_TYPE_STRING, CALL_ENV_FLAG_FORCE_QUOTE, exec_call_env_t, program), .pair.dflt_quote = T_BACK_QUOTED_STRING },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 72 of file rlm_exec.c.

exec_xlat_args

xlat_arg_parser_t const exec_xlat_args[]

static

Initial value:

= {
        { .required = true, .type = FR_TYPE_STRING },
        { .variadic = XLAT_ARG_VARIADIC_EMPTY_KEEP, .type = FR_TYPE_VOID},
        XLAT_ARG_PARSER_TERMINATOR
}

Definition at line 119 of file rlm_exec.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("wait", rlm_exec_t, wait), .dflt = "yes" },
        { FR_CONF_OFFSET("input_pairs", rlm_exec_t, input_list) },
        { FR_CONF_OFFSET("output_pairs", rlm_exec_t, output_list) },
        { FR_CONF_OFFSET("shell_escape", rlm_exec_t, shell_escape), .dflt = "yes" },
        { FR_CONF_OFFSET("env_inherit", rlm_exec_t, env_inherit), .dflt = "no" },
        { FR_CONF_OFFSET_IS_SET("timeout", FR_TYPE_TIME_DELTA, 0, rlm_exec_t, timeout) },
        CONF_PARSER_TERMINATOR
}

Definition at line 58 of file rlm_exec.c.

rhs_term

fr_sbuff_parse_rules_t const rhs_term

static

Initial value:

= {
        .escapes = &(fr_sbuff_unescape_rules_t){
                .chr = '\\',
                .do_hex = true,
                .do_oct = false
        },
        .terminals = &FR_SBUFF_TERMS(
                L(""),
                L("\t"),
                L("\n"),
                L(","),
        )
}

Definition at line 265 of file rlm_exec.c.

rlm_exec

module_rlm_t rlm_exec

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "exec",
                .flags          = MODULE_TYPE_THREAD_SAFE,
                .inst_size      = sizeof(rlm_exec_t),
                .config         = module_config,
                .bootstrap      = mod_bootstrap,
        },
        .method_names = (module_method_name_t[]){
                { .name1 = CF_IDENT_ANY,        .name2 = CF_IDENT_ANY,          .method = mod_exec_dispatch_oneshot,
                  .method_env = &exec_method_env },
                MODULE_NAME_TERMINATOR
        }
}

Definition at line 520 of file rlm_exec.c.

status2rcode

const rlm_rcode_t status2rcode[]

static

Initial value:

= {
        [0] = RLM_MODULE_OK,
        [1] = RLM_MODULE_REJECT,
        [2] = RLM_MODULE_FAIL,
        [3] = RLM_MODULE_OK,
        [4] = RLM_MODULE_HANDLED,
        [5] = RLM_MODULE_INVALID,
        [6] = RLM_MODULE_DISALLOW,
        [7] = RLM_MODULE_NOTFOUND,
        [8] = RLM_MODULE_NOOP,
        [9] = RLM_MODULE_UPDATED,
}

Definition at line 181 of file rlm_exec.c.