xlat_eval.c File Reference

String expansion ("translation"). More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/unlang/xlat.h>
#include <freeradius-devel/unlang/xlat_priv.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/types.h>
#include <freeradius-devel/util/sbuff.h>
#include <freeradius-devel/util/value.h>
#include <freeradius-devel/unlang/unlang_priv.h>

Include dependency graph for xlat_eval.c:

Go to the source code of this file.

Data Structures
struct	xlat_exec_rctx_t

Macros
#define	ESCAPE(_arg, _vb, _arg_num)

Functions
static ssize_t	_xlat_eval (TALLOC_CTX *ctx, char **out, size_t outlen, request_t *request, char const *fmt, xlat_escape_legacy_t escape, void const *escape_ctx)
	Replace whatever in a string. More...
static ssize_t	_xlat_eval_compiled (TALLOC_CTX *ctx, char **out, size_t outlen, request_t *request, xlat_exp_head_t const *head, xlat_escape_legacy_t escape, void const *escape_ctx)
	Replace whatever in a string. More...
ssize_t	xlat_aeval (TALLOC_CTX *ctx, char **out, request_t *request, char const *fmt, xlat_escape_legacy_t escape, void const *escape_ctx)
ssize_t	xlat_aeval_compiled (TALLOC_CTX *ctx, char **out, request_t *request, xlat_exp_head_t const *xlat, xlat_escape_legacy_t escape, void const *escape_ctx)
int	xlat_aeval_compiled_argv (TALLOC_CTX *ctx, char ***argv, request_t *request, xlat_exp_head_t const *head, xlat_escape_legacy_t escape, void const *escape_ctx)
	Synchronous compile xlat_tokenize_argv() into argv[] array. More...
static void	xlat_debug_log_expansion (request_t *request, xlat_exp_t const *node, fr_value_box_list_t const *args, UNUSED int line)
	Output what we're currently expanding. More...
static void	xlat_debug_log_list_result (request_t *request, xlat_exp_t const *node, fr_value_box_list_t const *result)
	Output the list result of an expansion. More...
static void	xlat_debug_log_result (request_t *request, xlat_exp_t const *node, fr_value_box_t const *result)
	Output the result of an expansion. More...
ssize_t	xlat_eval (char *out, size_t outlen, request_t *request, char const *fmt, xlat_escape_legacy_t escape, void const *escape_ctx)
ssize_t	xlat_eval_compiled (char *out, size_t outlen, request_t *request, xlat_exp_head_t const *xlat, xlat_escape_legacy_t escape, void const *escape_ctx)
void	xlat_eval_free (void)
int	xlat_eval_init (void)
static xlat_action_t	xlat_eval_one_letter (TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, char letter)
	One letter expansions. More...
static ssize_t	xlat_eval_sync (TALLOC_CTX *ctx, char **out, request_t *request, xlat_exp_head_t const *const head, xlat_escape_legacy_t escape, void const *escape_ctx)
int	xlat_eval_walk (xlat_exp_head_t *head, xlat_walker_t walker, xlat_type_t type, void *uctx)
	Walk over all xlat nodes (depth first) in a xlat expansion, calling a callback. More...
static xlat_action_t	xlat_exec_resume (UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
int	xlat_flatten_compiled_argv (TALLOC_CTX *ctx, xlat_exp_head_t ***argv, xlat_exp_head_t *head)
	Turn xlat_tokenize_argv() into an argv[] array, and nuke the input list. More...
static fr_slen_t	xlat_fmt_print (fr_sbuff_t *out, xlat_exp_t const *node)
	Reconstruct the original expansion string from an xlat tree. More...
xlat_action_t	xlat_frame_eval (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_exp_head_t const **child, request_t *request, xlat_exp_head_t const *head, xlat_exp_t const **in)
	Converts xlat nodes to value boxes. More...
xlat_action_t	xlat_frame_eval_repeat (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_exp_head_t const **child, request_t *request, xlat_exp_head_t const *head, xlat_exp_t const **in, void *env_data, fr_value_box_list_t *result)
	Process the result of a previous nested expansion. More...
xlat_action_t	xlat_frame_eval_resume (TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_exp_head_t const **child, request_t *request, xlat_exp_head_t const *head, xlat_exp_t const **in, fr_value_box_list_t *result, xlat_func_t resume, void *rctx)
	Call an xlat's resumption method. More...
static xlat_action_t	xlat_null_resume (UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
static xlat_action_t	xlat_process_arg_list (TALLOC_CTX *ctx, fr_value_box_list_t *list, request_t *request, char const *name, xlat_arg_parser_t const *arg, unsigned int arg_num)
	Process an individual xlat argument value box group. More...
static xlat_action_t	xlat_process_args (TALLOC_CTX *ctx, fr_value_box_list_t *list, request_t *request, xlat_t const *func)
	Process list of boxed values provided as input to an xlat. More...
static bool	xlat_process_return (request_t *request, xlat_t const *func, fr_value_box_list_t const *returned, fr_value_box_t *pos)
	Validate that the return values from an xlat function match what it registered. More...
void	xlat_signal (xlat_func_signal_t signal, xlat_exp_t const *exp, request_t *request, void *rctx, fr_signal_t action)
	Signal an xlat function. More...

Variables
fr_dict_attr_t const *	attr_cast_base
fr_dict_attr_t const *	attr_expr_bool_enum
static fr_dict_t const *	dict_freeradius
static fr_dict_t const *	dict_radius
static int	instance_count = 0
fr_table_num_sorted_t const	xlat_action_table []
size_t	xlat_action_table_len = NUM_ELEMENTS(xlat_action_table)
static fr_dict_autoload_t	xlat_eval_dict []
static fr_dict_attr_autoload_t	xlat_eval_dict_attr []

Detailed Description

String expansion ("translation").

Id

91ac371a2266df042c545e2df2bd04011b3e0afe

Evaluation of pre-parsed xlat expansions.

Copyright

2018-2021 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

2000,2006 The FreeRADIUS server project

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

Definition in file xlat_eval.c.

---

Data Structure Documentation

xlat_exec_rctx_t

struct xlat_exec_rctx_t

Definition at line 730 of file xlat_eval.c.

Data Fields
fr_value_box_list_t	list
int	status

Macro Definition Documentation

ESCAPE

#define ESCAPE	(		_arg,
			_vb,
			_arg_num
	)

Value:

do { \
        if ((_arg)->func && (!(_vb)->safe_for || !fr_value_box_is_safe_for((_vb), (_arg)->safe_for) || (_arg)->always_escape)) { \
                if ((_arg)->func(request, _vb, (_arg)->uctx) < 0) { \
                        RPEDEBUG("Function \"%s\" failed escaping argument %u", name, _arg_num); \
                        return XLAT_ACTION_FAIL; \
                } \
                fr_value_box_mark_safe_for((_vb), (_arg)->safe_for); \
        } \
} while (0)

Function Documentation

_xlat_eval()

static ssize_t _xlat_eval ( TALLOC_CTX *  ctx, char **  out, size_t  outlen, request_t *  request, char const *  fmt, xlat_escape_legacy_t  escape, void const *  escape_ctx  )

static

Replace whatever in a string.

See 'doc/unlang/xlat.adoc' for more information.

Parameters

[in]	ctx	to allocate expansion buffers in.
[out]	out	Where to write pointer to output buffer.
[in]	outlen	Size of out.
[in]	request	current request.
[in]	fmt	string to expand.
[in]	escape	function to escape final value e.g. SQL quoting.
[in]	escape_ctx	pointer to pass to escape function.

Returns

length of string written

Bug:

should really have -1 for failure.

Definition at line 1405 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_xlat_eval_compiled()

static ssize_t _xlat_eval_compiled ( TALLOC_CTX *  ctx, char **  out, size_t  outlen, request_t *  request, xlat_exp_head_t const *  head, xlat_escape_legacy_t  escape, void const *  escape_ctx  )

static

Replace whatever in a string.

See 'doc/unlang/xlat.adoc' for more information.

Parameters

[in]	ctx	to allocate expansion buffers in.
[out]	out	Where to write pointer to output buffer.
[in]	outlen	Size of out.
[in]	request	current request.
[in]	head	the xlat structure to expand
[in]	escape	function to escape final value e.g. SQL quoting.
[in]	escape_ctx	pointer to pass to escape function.

Returns

length of string written

Bug:

should really have -1 for failure.

Definition at line 1352 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_aeval()

ssize_t xlat_aeval	(	TALLOC_CTX *	ctx,
		char **	out,
		request_t *	request,
		char const *	fmt,
		xlat_escape_legacy_t	escape,
		void const *	escape_ctx
	)

Definition at line 1470 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_aeval_compiled()

ssize_t xlat_aeval_compiled	(	TALLOC_CTX *	ctx,
		char **	out,
		request_t *	request,
		xlat_exp_head_t const *	xlat,
		xlat_escape_legacy_t	escape,
		void const *	escape_ctx
	)

Definition at line 1479 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_aeval_compiled_argv()

int xlat_aeval_compiled_argv	(	TALLOC_CTX *	ctx,
		char ***	argv,
		request_t *	request,
		xlat_exp_head_t const *	head,
		xlat_escape_legacy_t	escape,
		void const *	escape_ctx
	)

Synchronous compile xlat_tokenize_argv() into argv[] array.

This is mostly for synchronous evaluation.

Parameters

	ctx	The talloc_ctx
[out]	argv	the argv array of resulting strings, size is argc + 1
	request	the request
	head	from xlat_tokenize_argv()
	escape	escape function
	escape_ctx	context for escape function

Returns

• <=0 on error number indicates which argument caused the problem
• >0 on success which is argc to the corresponding argv

Definition at line 1503 of file xlat_eval.c.

Here is the call graph for this function:

xlat_debug_log_expansion()

static void xlat_debug_log_expansion ( request_t *  request, xlat_exp_t const *  node, fr_value_box_list_t const *  args, UNUSED int  line  )

inlinestatic

Output what we're currently expanding.

Parameters

[in]	request	The current request.
[in]	node	Being processed.
[in]	args	from previous expansion.
[in]	line	Unused

Definition at line 148 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_debug_log_list_result()

static void xlat_debug_log_list_result ( request_t *  request, xlat_exp_t const *  node, fr_value_box_list_t const *  result  )

inlinestatic

Output the list result of an expansion.

Parameters

[in]	request	The current request.
[in]	node	which was expanded.
[in]	result	of the expansion.

Definition at line 181 of file xlat_eval.c.

Here is the caller graph for this function:

xlat_debug_log_result()

static void xlat_debug_log_result ( request_t *  request, xlat_exp_t const *  node, fr_value_box_t const *  result  )

inlinestatic

Output the result of an expansion.

Parameters

[in]	request	The current request.
[in]	node	which was expanded.
[in]	result	of the expansion.

Definition at line 196 of file xlat_eval.c.

Here is the caller graph for this function:

xlat_eval()

ssize_t xlat_eval	(	char *	out,
		size_t	outlen,
		request_t *	request,
		char const *	fmt,
		xlat_escape_legacy_t	escape,
		void const *	escape_ctx
	)

Definition at line 1454 of file xlat_eval.c.

Here is the call graph for this function:

xlat_eval_compiled()

ssize_t xlat_eval_compiled	(	char *	out,
		size_t	outlen,
		request_t *	request,
		xlat_exp_head_t const *	xlat,
		xlat_escape_legacy_t	escape,
		void const *	escape_ctx
	)

Definition at line 1462 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_eval_free()

void xlat_eval_free

(

void

)

Definition at line 1664 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_eval_init()

int xlat_eval_init

(

void

)

Definition at line 1639 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_eval_one_letter()

static xlat_action_t xlat_eval_one_letter ( TALLOC_CTX *  ctx, fr_value_box_list_t *  out, request_t *  request, char  letter  )

inlinestatic

One letter expansions.

Parameters

[in]	ctx	to allocate boxed value, and buffers in.
[out]	out	Where to write the boxed value.
[in]	request	The current request.
[in]	letter	to expand.

Returns

• XLAT_ACTION_FAIL on memory allocation errors.
• XLAT_ACTION_DONE if we're done processing this node.

Definition at line 544 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_eval_sync()

static ssize_t xlat_eval_sync ( TALLOC_CTX *  ctx, char **  out, request_t *  request, xlat_exp_head_t const *const  head, xlat_escape_legacy_t  escape, void const *  escape_ctx  )

static

Definition at line 1253 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_eval_walk()

int xlat_eval_walk	(	xlat_exp_head_t *	head,
		xlat_walker_t	walker,
		xlat_type_t	type,
		void *	uctx
	)

Walk over all xlat nodes (depth first) in a xlat expansion, calling a callback.

Parameters

[in]	head	to evaluate.
[in]	walker	callback to pass nodes to.
[in]	type	if > 0 a mask of types to call walker for.
[in]	uctx	to pass to walker.

Returns

• 0 on success (walker always returned 0).
• <0 if walker returned <0.

Definition at line 1575 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_exec_resume()

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

static

Definition at line 735 of file xlat_eval.c.

Here is the caller graph for this function:

xlat_flatten_compiled_argv()

int xlat_flatten_compiled_argv	(	TALLOC_CTX *	ctx,
		xlat_exp_head_t ***	argv,
		xlat_exp_head_t *	head
	)

Turn xlat_tokenize_argv() into an argv[] array, and nuke the input list.

This is mostly for async use.

Definition at line 1538 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_fmt_print()

static fr_slen_t xlat_fmt_print ( fr_sbuff_t *  out, xlat_exp_t const *  node  )

static

Reconstruct the original expansion string from an xlat tree.

Parameters

[in]	out	sbuff to print result in.
[in]	node	in the tree to start printing.

Returns

• The original expansion string on success.
• NULL on error.

Definition at line 79 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_frame_eval()

xlat_action_t xlat_frame_eval	(	TALLOC_CTX *	ctx,
		fr_dcursor_t *	out,
		xlat_exp_head_t const **	child,
		request_t *	request,
		xlat_exp_head_t const *	head,
		xlat_exp_t const **	in
	)

Converts xlat nodes to value boxes.

Evaluates a single level of expansions.

Parameters

[in]	ctx	to allocate value boxes in.
[out]	out	a list of fr_value_box_t to append to.
[out]	child	to evaluate. If a child needs to be evaluated by the caller, we return XLAT_ACTION_PUSH_CHILD and place the child to be evaluated here. Once evaluation is complete, the caller should call us with the same xlat_exp_t and the result of the nested evaluation in result.
[in]	request	the current request.
[in]	head	of the list to evaluate
[in,out]	in	xlat node to evaluate. Advanced as we process additional xlat_exp_t.

Returns

• XLAT_ACTION_PUSH_CHILD if we need to evaluate a deeper level of nested. child will be filled with the node that needs to be evaluated. call xlat_frame_eval_repeat on this node, once there are results from the nested expansion.
• XLAT_ACTION_YIELD a resumption frame was pushed onto the stack by an xlat function and we need to wait for the request to be resumed before continuing.
• XLAT_ACTION_DONE we're done, pop the frame.
• XLAT_ACTION_FAIL an xlat module failed.

Definition at line 1035 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_frame_eval_repeat()

xlat_action_t xlat_frame_eval_repeat	(	TALLOC_CTX *	ctx,
		fr_dcursor_t *	out,
		xlat_exp_head_t const **	child,
		request_t *	request,
		xlat_exp_head_t const *	head,
		xlat_exp_t const **	in,
		void *	env_data,
		fr_value_box_list_t *	result
	)

Process the result of a previous nested expansion.

Parameters

[in]	ctx	to allocate value boxes in.
[out]	out	a list of fr_value_box_t to append to.
[out]	child	to evaluate. If a child needs to be evaluated by the caller, we return XLAT_ACTION_PUSH_CHILD and place the child to be evaluated here. Once evaluation is complete, the caller should call us with the same xlat_exp_t and the result of the nested evaluation in result.
[in]	request	the current request.
[in]	head	of the list to evaluate
[in,out]	in	xlat node to evaluate. Advanced as we process additional xlat_exp_t.
[in]	env_data	Expanded call env.
[in]	result	of a previous nested evaluation.

Definition at line 869 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_frame_eval_resume()

xlat_action_t xlat_frame_eval_resume	(	TALLOC_CTX *	ctx,
		fr_dcursor_t *	out,
		xlat_exp_head_t const **	child,
		request_t *	request,
		xlat_exp_head_t const *	head,
		xlat_exp_t const **	in,
		fr_value_box_list_t *	result,
		xlat_func_t	resume,
		void *	rctx
	)

Call an xlat's resumption method.

Parameters

[in]	ctx	to allocate value boxes in.
[out]	out	a list of fr_value_box_t to append to.
[out]	child	to evaluate. If a child needs to be evaluated by the caller, we return XLAT_ACTION_PUSH_CHILD and place the child to be evaluated here. Once evaluation is complete, the caller should call us with the same xlat_exp_t and the result of the nested evaluation in result.
[in]	request	the current request.
[in]	head	of the list to evaluate
[in,out]	in	xlat node to evaluate. Advanced as we process additional xlat_exp_t.
[in]	result	Previously expanded arguments to this xlat function.
[in]	resume	function to call.
[in]	rctx	Opaque (to us), resume ctx provided by xlat function when it yielded.

Definition at line 795 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_null_resume()

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

static

Definition at line 769 of file xlat_eval.c.

Here is the caller graph for this function:

xlat_process_arg_list()

static xlat_action_t xlat_process_arg_list ( TALLOC_CTX *  ctx, fr_value_box_list_t *  list, request_t *  request, char const *  name, xlat_arg_parser_t const *  arg, unsigned int  arg_num  )

static

Process an individual xlat argument value box group.

Parameters

[in]	ctx	to allocate any additional buffers in
[in,out]	list	of value boxes representing one argument
[in]	request	currently being processed
[in]	name	of the function being called
[in]	arg	specification of current argument
[in]	arg_num	number of current argument in the argument specifications

Returns

• XLAT_ACTION_DONE on success.
• XLAT_ACTION_FAIL on failure.

Definition at line 217 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_process_args()

static xlat_action_t xlat_process_args ( TALLOC_CTX *  ctx, fr_value_box_list_t *  list, request_t *  request, xlat_t const *  func  )

inlinestatic

Process list of boxed values provided as input to an xlat.

Ensures that the value boxes passed to an xlat function match the requirements listed in its "args", and escapes any tainted boxes using the specified escaping routine.

Parameters

[in]	ctx	in which to allocate any buffers.
[in,out]	list	value boxes provided as input. List will be modified in accordance to rules provided in the args array.
[in]	request	being processed.
[in]	func	to call

Definition at line 333 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_process_return()

static bool xlat_process_return ( request_t *  request, xlat_t const *  func, fr_value_box_list_t const *  returned, fr_value_box_t *  pos  )

inlinestatic

Validate that the return values from an xlat function match what it registered.

Parameters

[in]	request	The current request.
[in]	func	that was called.
[in]	returned	the output list of the function.
[in]	pos	current position in the output list.

Returns

• true - If return values were correct.
• false - If the return values were incorrect.

Definition at line 496 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xlat_signal()

void xlat_signal	(	xlat_func_signal_t	signal,
		xlat_exp_t const *	exp,
		request_t *	request,
		void *	rctx,
		fr_signal_t	action
	)

Signal an xlat function.

Parameters

[in]	signal	function to call.
[in]	exp	Xlat node that previously yielded.
[in]	request	The current request.
[in]	rctx	Opaque (to us), resume ctx provided by the xlat function when it yielded.
[in]	action	What the request should do (the type of signal).

Definition at line 761 of file xlat_eval.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

attr_cast_base

fr_dict_attr_t const* attr_cast_base

Definition at line 52 of file xlat_eval.c.

attr_expr_bool_enum

fr_dict_attr_t const* attr_expr_bool_enum

Definition at line 51 of file xlat_eval.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 42 of file xlat_eval.c.

dict_radius

fr_dict_t const* dict_radius

static

Definition at line 43 of file xlat_eval.c.

instance_count

int instance_count = 0

static

Definition at line 40 of file xlat_eval.c.

xlat_action_table

fr_table_num_sorted_t const xlat_action_table[]

Initial value:

= {
        { L("done"),            XLAT_ACTION_DONE        },
        { L("fail"),            XLAT_ACTION_FAIL        },
        { L("push-child"),      XLAT_ACTION_PUSH_CHILD  },
        { L("yield"),           XLAT_ACTION_YIELD       }
}

Definition at line 60 of file xlat_eval.c.

xlat_action_table_len

size_t xlat_action_table_len = NUM_ELEMENTS(xlat_action_table)

Definition at line 66 of file xlat_eval.c.

xlat_eval_dict

fr_dict_autoload_t xlat_eval_dict[]

static

Initial value:

= {
        { .out = &dict_freeradius, .proto = "freeradius" },
        { .out = &dict_radius, .proto = "radius" },
        { NULL }
}

Definition at line 45 of file xlat_eval.c.

xlat_eval_dict_attr

fr_dict_attr_autoload_t xlat_eval_dict_attr[]

static

Initial value:

= {
        { .out = &attr_expr_bool_enum, .name = "Expr-Bool-Enum", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_cast_base, .name = "Cast-Base", .type = FR_TYPE_UINT8, .dict = &dict_freeradius },
        { NULL }
}

Definition at line 54 of file xlat_eval.c.