rlm_linelog.c File Reference

#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 dependency graph for rlm_linelog.c:

Go to the source code of this file.

Data Structures
struct	linelog_call_env_t
struct	linelog_conn_t
struct	linelog_net_t
struct	rlm_linelog_rctx_t
struct	rlm_linelog_t
	linelog module instance More...
struct	rlm_linelog_t.file
struct	rlm_linelog_t.syslog
struct	rlm_linelog_t.unix_sock

Macros
#define	LINELOG_BOX_ESCAPE
#define	VECTOR_INCREMENT   20

Enumerations
enum	linefr_log_dst_t {   LINELOG_DST_INVALID = 0 ,   LINELOG_DST_FILE ,   LINELOG_DST_REQUEST ,   LINELOG_DST_SYSLOG ,   LINELOG_DST_UNIX ,   LINELOG_DST_UDP ,   LINELOG_DST_TCP ,   LINELOG_DST_STDOUT ,   LINELOG_DST_STDERR }

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)

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_call_env_t

struct linelog_call_env_t

Definition at line 205 of file rlm_linelog.c.

Collaboration diagram for linelog_call_env_t:

Data Fields
fr_value_box_t *	filename	File name, if output is to a file.
fr_value_box_t *	log_head	Header to add to each new log file.
fr_value_box_t *	log_ref	Path to a CONF_PAIR (to use as the source of log messages).
tmpl_t *	log_src	Source of log messages.

linelog_conn_t

struct linelog_conn_t

Definition at line 140 of file rlm_linelog.c.

Data Fields
int	sockfd	File descriptor associated with socket.

linelog_net_t

struct linelog_net_t

Definition at line 94 of file rlm_linelog.c.

Collaboration diagram for linelog_net_t:

Data Fields
fr_ipaddr_t	dst_ipaddr	Network server.
uint16_t	port	Network port.
fr_ipaddr_t	src_ipaddr	Send requests from a given src_ipaddr.
fr_time_delta_t	timeout	How long to wait for read/write operations.

rlm_linelog_rctx_t

struct rlm_linelog_rctx_t

Definition at line 624 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.

rlm_linelog_t

struct rlm_linelog_t

linelog module instance

Definition at line 103 of file rlm_linelog.c.

Collaboration diagram for rlm_linelog_t:

Data Fields
CONF_SECTION *	cs	CONF_SECTION to use as the root for #log_ref lookups.
char const *	delimiter	Line termination string (usually ).
size_t	delimiter_len	Length of line termination string.
struct rlm_linelog_t.file	file
linefr_log_dst_t	log_dst	Logging destination.
char const *	log_dst_str	Logging destination string.
fr_pool_t *	pool	Connection pool instance.
struct rlm_linelog_t.syslog	syslog
linelog_net_t	tcp	TCP server.
bool	triggers	Do we do triggers.
linelog_net_t	udp	UDP server.
struct rlm_linelog_t.unix_sock	unix_sock

rlm_linelog_t.file

struct rlm_linelog_t.file

Definition at line 118 of file rlm_linelog.c.

Data Fields
exfile_t *	ef	Exclusive file access handle.
bool	escape	Do filename escaping, yes / no.
bool	fsync	fsync after each write.
gid_t	group	Resolved gid.
char const *	group_str	Group to set on new files.
mode_t	permissions	Permissions to use when creating new files.

rlm_linelog_t.syslog

struct rlm_linelog_t.syslog

Definition at line 112 of file rlm_linelog.c.

Data Fields
char const *	facility	Syslog facility string.
int	priority	Bitwise | of severity and facility.
char const *	severity	Syslog severity string.

rlm_linelog_t.unix_sock

struct rlm_linelog_t.unix_sock

Definition at line 127 of file rlm_linelog.c.

Data Fields
char const *	path	Where the UNIX socket lives.
fr_time_delta_t	timeout	How long to wait for read/write operations.

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 216 of file rlm_linelog.c.

VECTOR_INCREMENT

#define VECTOR_INCREMENT   20

Enumeration Type Documentation

linefr_log_dst_t

enum linefr_log_dst_t

Enumerator
LINELOG_DST_INVALID
LINELOG_DST_FILE	Log to a file.
LINELOG_DST_REQUEST	Log to the request->log.
LINELOG_DST_SYSLOG	Log to syslog.
LINELOG_DST_UNIX	Log via Unix socket.
LINELOG_DST_UDP	Log via UDP.
LINELOG_DST_TCP	Log via TCP.
LINELOG_DST_STDOUT	Log to stdout.
LINELOG_DST_STDERR	Log to stderr.

Definition at line 69 of file rlm_linelog.c.

Function Documentation

_mod_conn_free()

static int _mod_conn_free ( linelog_conn_t *  conn )

static

Definition at line 252 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 897 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 351 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 363 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 373 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 588 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 1057 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 260 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 929 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 696 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 629 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 941 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" },
        CONF_PARSER_TERMINATOR
}

Definition at line 145 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 81 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 92 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 222 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 238 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 178 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
        },
        .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 1077 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 153 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 = "1000" },
        CONF_PARSER_TERMINATOR
}

Definition at line 171 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 = "1000" },
        CONF_PARSER_TERMINATOR
}

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