#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/exfile.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/tmpl_dcursor.h>
#include <freeradius-devel/server/rcode.h>
#include <freeradius-devel/server/tmpl.h>
#include <freeradius-devel/unlang/call_env.h>
#include <freeradius-devel/unlang/tmpl.h>
#include <freeradius-devel/unlang/module.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/iovec.h>
#include <freeradius-devel/util/perm.h>
#include <freeradius-devel/util/print.h>
#include <freeradius-devel/util/value.h>
#include <freeradius-devel/util/types.h>
#include <freeradius-devel/unlang/xlat_func.h>
#include <sys/uio.h>
#include "file.h"

Include dependency graph for rlm_linelog.c:

Data Structures
struct	linelog_conn_t

struct	rlm_linelog_rctx_t

Macros
#define	LINELOG_BOX_ESCAPE

#define	VECTOR_INCREMENT 20

Functions
static int	_mod_conn_free (linelog_conn_t *conn)

static int	call_env_filename_parse (TALLOC_CTX ctx, void out, tmpl_rules_t const t_rules, CONF_ITEM ci, call_env_ctx_t const cec, UNUSED call_env_parser_t const rule)

static int	linelog_escape_func (fr_value_box_t vb, UNUSED void uctx)
	Escape unprintable characters.

static void	linelog_hexdump (request_t request, struct iovec vector_p, size_t vector_len, char const *msg)

static int	linelog_write (rlm_linelog_t const inst, linelog_call_env_t const call_env, request_t request, struct iovec vector_p, size_t vector_len, bool with_delim)

static xlat_action_t	linelog_xlat (TALLOC_CTX ctx, fr_dcursor_t out, xlat_ctx_t const xctx, request_t request, fr_value_box_list_t *args)

static int	mod_bootstrap (module_inst_ctx_t const *mctx)

static void *	mod_conn_create (TALLOC_CTX ctx, void instance, fr_time_delta_t timeout)

static int	mod_detach (module_detach_ctx_t const *mctx)

static unlang_action_t	mod_do_linelog (unlang_result_t p_result, module_ctx_t const mctx, request_t *request)
	Write a linelog message.

static unlang_action_t	mod_do_linelog_resume (unlang_result_t p_result, module_ctx_t const mctx, request_t *request)

static int	mod_instantiate (module_inst_ctx_t const *mctx)

static int	mod_thread_instantiate (module_thread_inst_ctx_t const *mctx)
	Initialise thread specific data strcuture.

Variables
static const conf_parser_t	file_config []

static fr_table_num_sorted_t const	linefr_log_dst_table []

static size_t	linefr_log_dst_table_len = NUM_ELEMENTS(linefr_log_dst_table)

static const call_env_method_t	linelog_method_env

static const call_env_method_t	linelog_xlat_method_env

static const conf_parser_t	module_config []

module_rlm_t	rlm_linelog

static const conf_parser_t	syslog_config []

static const conf_parser_t	tcp_config []

static const conf_parser_t	udp_config []

static const conf_parser_t	unix_config []

Data Structure Documentation

◆ linelog_conn_t

struct linelog_conn_t

Definition at line 84 of file rlm_linelog.c.

Data Fields
int	sockfd	File descriptor associated with socket.

◆ rlm_linelog_rctx_t

struct rlm_linelog_rctx_t

Definition at line 579 of file rlm_linelog.c.

Data Fields
fr_value_box_list_t	expanded	The result of expanding the fmt tmpl.
bool	with_delim	Whether to add a delimiter.

Macro Definition Documentation

◆ LINELOG_BOX_ESCAPE

#define LINELOG_BOX_ESCAPE

Value:

                          { \
                          .func = linelog_escape_func, \
                          .safe_for = (fr_value_box_safe_for_t) linelog_escape_func, \
                          .always_escape = false, \
                  }

Definition at line 153 of file rlm_linelog.c.

◆ VECTOR_INCREMENT

#define VECTOR_INCREMENT 20

Function Documentation

◆ _mod_conn_free()

static int _mod_conn_free ( linelog_conn_t * conn )

static

Definition at line 189 of file rlm_linelog.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ call_env_filename_parse()

static int call_env_filename_parse	(	TALLOC_CTX *	ctx,
		void *	out,
		tmpl_rules_t const *	t_rules,
		CONF_ITEM *	ci,
		call_env_ctx_t const *	cec,
		UNUSED call_env_parser_t const *	rule
	)

static

Definition at line 887 of file rlm_linelog.c.

Here is the call graph for this function:

◆ linelog_escape_func()

static int linelog_escape_func	(	fr_value_box_t *	vb,
		UNUSED void *	uctx
	)

static

Escape unprintable characters.

Newline is escaped as \\n.
Return is escaped as \\r.
All other unprintables are escaped as
```
\<oct><oct><oct> 
```
.

Parameters

vb	Value box to escape.
uctx	unused.

Definition at line 288 of file rlm_linelog.c.

Here is the call graph for this function:

◆ linelog_hexdump()

static void linelog_hexdump	(	request_t *	request,
		struct iovec *	vector_p,
		size_t	vector_len,
		char const *	msg
	)

static

Definition at line 300 of file rlm_linelog.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ linelog_write()

static int linelog_write	(	rlm_linelog_t const *	inst,
		linelog_call_env_t const *	call_env,
		request_t *	request,
		struct iovec *	vector_p,
		size_t	vector_len,
		bool	with_delim
	)

static

Definition at line 310 of file rlm_linelog.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ linelog_xlat()

static xlat_action_t linelog_xlat	(	TALLOC_CTX *	ctx,
		fr_dcursor_t *	out,
		xlat_ctx_t const *	xctx,
		request_t *	request,
		fr_value_box_list_t *	args
	)

static

Definition at line 525 of file rlm_linelog.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 1060 of file rlm_linelog.c.

Here is the call graph for this function:

◆ mod_conn_create()

static void * mod_conn_create	(	TALLOC_CTX *	ctx,
		void *	instance,
		fr_time_delta_t	timeout
	)

static

Definition at line 197 of file rlm_linelog.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_detach()

static int mod_detach ( module_detach_ctx_t const * mctx )

static

Definition at line 919 of file rlm_linelog.c.

Here is the call graph for this function:

◆ mod_do_linelog()

static unlang_action_t mod_do_linelog	(	unlang_result_t *	p_result,
		module_ctx_t const *	mctx,
		request_t *	request
	)

static

Write a linelog message.

Write a log message to syslog or a flat file.

Parameters

[in]	p_result	the result of the module call: RLM_MODULE_NOOP if no message to log. RLM_MODULE_FAIL if we failed writing the message. RLM_MODULE_OK on success.
[in]	mctx	module calling context.
[in]	request	The current request.

Definition at line 666 of file rlm_linelog.c.

Here is the call graph for this function:

◆ mod_do_linelog_resume()

static unlang_action_t mod_do_linelog_resume	(	unlang_result_t *	p_result,
		module_ctx_t const *	mctx,
		request_t *	request
	)

static

Definition at line 584 of file rlm_linelog.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const * mctx )

static

Definition at line 931 of file rlm_linelog.c.

Here is the call graph for this function:

◆ mod_thread_instantiate()

static int mod_thread_instantiate ( module_thread_inst_ctx_t const * mctx )

static

Initialise thread specific data strcuture.

Definition at line 1078 of file rlm_linelog.c.

Here is the call graph for this function:

Variable Documentation

◆ file_config

const conf_parser_t file_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("permissions", rlm_linelog_t, file.permissions), .dflt = "0600", .func = cf_parse_permissions },
        { FR_CONF_OFFSET("group", rlm_linelog_t, file.group_str) },
        { FR_CONF_OFFSET("escape_filenames", rlm_linelog_t, file.escape), .dflt = "no" },
        { FR_CONF_OFFSET("fsync", rlm_linelog_t, file.fsync), .dflt = "no" },
        { FR_CONF_OFFSET("max_idle", rlm_linelog_t, file.max_idle), .dflt = "30s" },
        { FR_CONF_OFFSET("buffer_count", rlm_linelog_t, file.buffer_count), .dflt = "1000" },
        { FR_CONF_OFFSET_IS_SET("buffer_delay", FR_TYPE_TIME_DELTA, 0, rlm_linelog_t, file.buffer_delay), .dflt = "1s" },
        { FR_CONF_OFFSET_IS_SET("buffer_expiry", FR_TYPE_TIME_DELTA, CONF_FLAG_HIDDEN, rlm_linelog_t, file.buffer_expiry), .dflt = "30s" },
        CONF_PARSER_TERMINATOR
}

Definition at line 89 of file rlm_linelog.c.

◆ linefr_log_dst_table

fr_table_num_sorted_t const linefr_log_dst_table[]

static

Initial value:

= {
        { L("file"),    LINELOG_DST_FILE        },
        { L("files"),   LINELOG_DST_FILE        },
        { L("request"), LINELOG_DST_REQUEST     },
        { L("stderr"),  LINELOG_DST_STDERR      },
        { L("stdout"),  LINELOG_DST_STDOUT      },
        { L("syslog"),  LINELOG_DST_SYSLOG      },
        { L("tcp"),     LINELOG_DST_TCP         },
        { L("udp"),     LINELOG_DST_UDP         },
        { L("unix"),    LINELOG_DST_UNIX        }
}

Definition at line 71 of file rlm_linelog.c.

◆ linefr_log_dst_table_len

size_t linefr_log_dst_table_len = NUM_ELEMENTS(linefr_log_dst_table)

static

Definition at line 82 of file rlm_linelog.c.

◆ linelog_method_env

const call_env_method_t linelog_method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(linelog_call_env_t),
        .env = (call_env_parser_t[]) {
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("format", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT | CALL_ENV_FLAG_PARSE_ONLY| CALL_ENV_FLAG_BARE_WORD_ATTRIBUTE, linelog_call_env_t, log_src), .pair.escape = { .box_escape = LINELOG_BOX_ESCAPE } },
                { FR_CALL_ENV_OFFSET("reference",FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT | CALL_ENV_FLAG_BARE_WORD_ATTRIBUTE, linelog_call_env_t, log_ref), .pair.escape = { .box_escape = LINELOG_BOX_ESCAPE } },
                { FR_CALL_ENV_OFFSET("header", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT, linelog_call_env_t, log_head), .pair.escape = { .box_escape = LINELOG_BOX_ESCAPE } },
                { FR_CALL_ENV_SUBSECTION("file", NULL, CALL_ENV_FLAG_NONE,
                        ((call_env_parser_t[]) {
                                { FR_CALL_ENV_OFFSET("filename", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT, linelog_call_env_t, filename),
                                  .pair.func = call_env_filename_parse },
                                CALL_ENV_TERMINATOR
                        })) },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 159 of file rlm_linelog.c.

◆ linelog_xlat_method_env

const call_env_method_t linelog_xlat_method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(linelog_call_env_t),
        .env = (call_env_parser_t[]) {
                { FR_CALL_ENV_OFFSET("header", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT, linelog_call_env_t, log_head), .pair.escape = { .box_escape = LINELOG_BOX_ESCAPE } },
                { FR_CALL_ENV_SUBSECTION("file", NULL, CALL_ENV_FLAG_NONE,
                        ((call_env_parser_t[]) {
                                { FR_CALL_ENV_OFFSET("filename", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT, linelog_call_env_t, filename),
                                  .pair.func = call_env_filename_parse },
                                CALL_ENV_TERMINATOR
                        })) },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 175 of file rlm_linelog.c.

◆ module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("destination", CONF_FLAG_REQUIRED, rlm_linelog_t, log_dst_str) },
 
        { FR_CONF_OFFSET("delimiter", rlm_linelog_t, delimiter), .dflt = "\n" },
 
        { FR_CONF_OFFSET("triggers", rlm_linelog_t, triggers) },
 
        
        { FR_CONF_POINTER("file", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) file_config },
        { FR_CONF_POINTER("syslog", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) syslog_config },
        { FR_CONF_POINTER("unix", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) unix_config },
        { FR_CONF_OFFSET_SUBSECTION("tcp", 0, rlm_linelog_t, tcp, tcp_config) },
        { FR_CONF_OFFSET_SUBSECTION("udp", 0, rlm_linelog_t, udp, udp_config) },
 
        
        { FR_CONF_DEPRECATED("permissions", rlm_linelog_t, file.permissions) },
        { FR_CONF_DEPRECATED("group", rlm_linelog_t, file.group_str) },
 
        { FR_CONF_DEPRECATED("syslog_facility", rlm_linelog_t, syslog.facility) },
        { FR_CONF_DEPRECATED("syslog_severity", rlm_linelog_t, syslog.severity) },
        CONF_PARSER_TERMINATOR
}

Definition at line 126 of file rlm_linelog.c.

◆ rlm_linelog

module_rlm_t rlm_linelog

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "linelog",
                .inst_size      = sizeof(rlm_linelog_t),
                .config         = module_config,
                .bootstrap      = mod_bootstrap,
                .instantiate    = mod_instantiate,
                .detach         = mod_detach,
                MODULE_THREAD_INST(rlm_linelog_thread_t),
                .thread_instantiate = mod_thread_instantiate,
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        { .section = SECTION_NAME(CF_IDENT_ANY, CF_IDENT_ANY), .method = mod_do_linelog, .method_env = &linelog_method_env },
                        MODULE_BINDING_TERMINATOR
                }
        }
}

Definition at line 1094 of file rlm_linelog.c.

◆ syslog_config

const conf_parser_t syslog_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("facility", rlm_linelog_t, syslog.facility) },
        { FR_CONF_OFFSET("severity", rlm_linelog_t, syslog.severity), .dflt = "info" },
        CONF_PARSER_TERMINATOR
}

Definition at line 101 of file rlm_linelog.c.

◆ tcp_config

const conf_parser_t tcp_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("server", FR_TYPE_COMBO_IP_ADDR, 0, linelog_net_t, dst_ipaddr) },
        { FR_CONF_OFFSET("port", linelog_net_t, port) },
        { FR_CONF_OFFSET("timeout", linelog_net_t, timeout), .dflt = "1s" },
        CONF_PARSER_TERMINATOR
}

Definition at line 119 of file rlm_linelog.c.

◆ udp_config

const conf_parser_t udp_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("server", FR_TYPE_COMBO_IP_ADDR, 0, linelog_net_t, dst_ipaddr) },
        { FR_CONF_OFFSET("port", linelog_net_t, port) },
        { FR_CONF_OFFSET("timeout", linelog_net_t, timeout), .dflt = "1s" },
        CONF_PARSER_TERMINATOR
}

Definition at line 112 of file rlm_linelog.c.

◆ unix_config

const conf_parser_t unix_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_SOCKET, rlm_linelog_t, unix_sock.path) },
        CONF_PARSER_TERMINATOR
}

Definition at line 107 of file rlm_linelog.c.

Data Structures

Macros

Functions

Variables

Data Structure Documentation

◆ linelog_conn_t

◆ rlm_linelog_rctx_t

Macro Definition Documentation

◆ LINELOG_BOX_ESCAPE

◆ VECTOR_INCREMENT

Function Documentation

◆ _mod_conn_free()

◆ call_env_filename_parse()

◆ linelog_escape_func()

◆ linelog_hexdump()

◆ linelog_write()

◆ linelog_xlat()

◆ mod_bootstrap()

◆ mod_conn_create()

◆ mod_detach()

◆ mod_do_linelog()

◆ mod_do_linelog_resume()

◆ mod_instantiate()

◆ mod_thread_instantiate()

Variable Documentation

◆ file_config

◆ linefr_log_dst_table

◆ linefr_log_dst_table_len

◆ linelog_method_env

◆ linelog_xlat_method_env

◆ module_config

◆ rlm_linelog

◆ syslog_config

◆ tcp_config

◆ udp_config

◆ unix_config