rlm_logtee.c File Reference

Add an additional log destination for any given request. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/server/connection.h>
#include <sys/uio.h>

Include dependency graph for rlm_logtee.c:

Go to the source code of this file.

Data Structures
struct	logtee_net_t
struct	rlm_logtee_t
	logtee module instance More...
struct	rlm_logtee_t.file
struct	rlm_logtee_t.unix_sock
struct	rlm_logtee_thread_t
	Per-thread instance data. More...

Enumerations
enum	logtee_dst_t {   LOGTEE_DST_INVALID = 0 ,   LOGTEE_DST_FILE ,   LOGTEE_DST_UNIX ,   LOGTEE_DST_UDP ,   LOGTEE_DST_TCP }

Functions
static void	_logtee_conn_close (UNUSED fr_event_list_t *el, void *h, UNUSED void *uctx)
	Shutdown/close a file descriptor. More...
static void	_logtee_conn_error (UNUSED fr_event_list_t *el, int sock, UNUSED int flags, int fd_errno, void *uctx)
	Connection errored. More...
static fr_connection_state_t	_logtee_conn_init (void **h_out, fr_connection_t *conn, void *uctx)
	Initialise a new outbound connection. More...
static fr_connection_state_t	_logtee_conn_open (UNUSED fr_event_list_t *el, UNUSED void *h, void *uctx)
	Process notification that fd is open. More...
static void	_logtee_conn_read (UNUSED fr_event_list_t *el, int sock, UNUSED int flags, void *uctx)
	Drain any data we received. More...
static void	_logtee_conn_writable (UNUSED fr_event_list_t *el, int sock, UNUSED int flags, void *uctx)
	There's space available to write data, so do that... More...
static void	logtee_fd_active (rlm_logtee_thread_t *t)
	Set the socket to active. More...
static void	logtee_fd_idle (rlm_logtee_thread_t *t)
	Set the socket to idle. More...
static void	logtee_it (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt, va_list ap, void *uctx))
static void	logtee_it (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, UNUSED char const *file, UNUSED int line, char const *fmt, va_list ap, void *uctx)
	Logging callback to write log messages to a destination. More...
static unlang_action_t	mod_insert_logtee (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Add our logging destination to the linked list of logging destinations (if it doesn't already exist) More...
static int	mod_instantiate (module_inst_ctx_t const *mctx)
static int	mod_thread_instantiate (module_thread_inst_ctx_t const *mctx)
	Create thread-specific connections and buffers. More...

Variables
static fr_dict_attr_t const *	attr_log_level
static fr_dict_attr_t const *	attr_log_message
static fr_dict_attr_t const *	attr_log_type
static fr_dict_t const *	dict_freeradius
static const conf_parser_t	file_config []
static fr_table_num_sorted_t const	logtee_dst_table []
static size_t	logtee_dst_table_len = NUM_ELEMENTS(logtee_dst_table)
static const conf_parser_t	module_config []
module_rlm_t	rlm_logtee
fr_dict_autoload_t	rlm_logtee_dict []
fr_dict_attr_autoload_t	rlm_logtee_dict_attr []
static const conf_parser_t	tcp_config []
static const conf_parser_t	udp_config []
static const conf_parser_t	unix_config []

Detailed Description

Add an additional log destination for any given request.

Id

1c373916d2d1fc60836177b635694370b12e7f44

Author

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

Copyright

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

Definition in file rlm_logtee.c.

---

Data Structure Documentation

logtee_net_t

struct logtee_net_t

Definition at line 70 of file rlm_logtee.c.

Collaboration diagram for logtee_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.

rlm_logtee_t

struct rlm_logtee_t

logtee module instance

Definition at line 78 of file rlm_logtee.c.

Collaboration diagram for rlm_logtee_t:

Data Fields
size_t	buffer_depth	How big our circular buffer should be.
fr_time_delta_t	connection_timeout	How long to wait to open a socket.
char const *	delimiter	Line termination string (usually ).
size_t	delimiter_len	Length of line termination string.
struct rlm_logtee_t	file
logtee_dst_t	log_dst	Logging destination.
char const *	log_dst_str	Logging destination string.
tmpl_t *	log_fmt	Source of log messages.
char const *	name	Module instance name.
fr_time_delta_t	reconnection_delay	How long to wait to retry.
logtee_net_t	tcp	TCP server.
logtee_net_t	udp	UDP server.
struct rlm_logtee_t	unix_sock

rlm_logtee_t.file

struct rlm_logtee_t.file

Definition at line 91 of file rlm_logtee.c.

Data Fields
bool	escape	Do filename escaping, yes / no.
xlat_escape_legacy_t	escape_func	Escape function.
gid_t	group	Resolved gid.
char const *	group_str	Group to set on new files.
char const *	name	File to write to.
uint32_t	permissions	Permissions to use when creating new files.

rlm_logtee_t.unix_sock

struct rlm_logtee_t.unix_sock

Definition at line 100 of file rlm_logtee.c.

Data Fields
char const *	path	Where the UNIX socket lives.

rlm_logtee_thread_t

struct rlm_logtee_thread_t

Per-thread instance data.

Contains buffers and connection handles specific to the thread.

Definition at line 115 of file rlm_logtee.c.

Collaboration diagram for rlm_logtee_thread_t:

Data Fields
fr_connection_t *	conn	Connection to our log destination.
fr_event_list_t *	el	This thread's event list.
fr_fring_t *	fring	Circular buffer used to batch up messages.
rlm_logtee_t const *	inst	Instance of logtee.
fr_pair_t *	lvl	Temporary value pair holding the log lvl.
fr_pair_t *	msg	Temporary value pair holding the message value.
TALLOC_CTX *	msg_pool	A 1k talloc pool to hold the log message whilst it's being expanded.
bool	pending	We have pending messages to write.
fr_pair_t *	type	Temporary value pair holding the message type.

Enumeration Type Documentation

logtee_dst_t

enum logtee_dst_t

Enumerator
LOGTEE_DST_INVALID
LOGTEE_DST_FILE	Log to a file.
LOGTEE_DST_UNIX	Log via Unix socket.
LOGTEE_DST_UDP	Log via UDP.
LOGTEE_DST_TCP	Log via TCP.

Definition at line 54 of file rlm_logtee.c.

Function Documentation

_logtee_conn_close()

static void _logtee_conn_close ( UNUSED fr_event_list_t *  el, void *  h, UNUSED void *  uctx  )

static

Shutdown/close a file descriptor.

Definition at line 354 of file rlm_logtee.c.

Here is the call graph for this function:

_logtee_conn_error()

static void _logtee_conn_error ( UNUSED fr_event_list_t *  el, int  sock, UNUSED int  flags, int  fd_errno, void *  uctx  )

static

Connection errored.

Definition at line 213 of file rlm_logtee.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_logtee_conn_init()

static fr_connection_state_t _logtee_conn_init ( void **  h_out, fr_connection_t *  conn, void *  uctx  )

static

Initialise a new outbound connection.

Parameters

[out]	h_out	Where to write the new file descriptor.
[in]	conn	being initialised.
[in]	uctx	A rlm_logtee_thread_t.

Definition at line 390 of file rlm_logtee.c.

Here is the call graph for this function:

_logtee_conn_open()

static fr_connection_state_t _logtee_conn_open ( UNUSED fr_event_list_t *  el, UNUSED void *  h, void *  uctx  )

static

Process notification that fd is open.

Definition at line 366 of file rlm_logtee.c.

Here is the call graph for this function:

_logtee_conn_read()

static void _logtee_conn_read ( UNUSED fr_event_list_t *  el, int  sock, UNUSED int  flags, void *  uctx  )

static

Drain any data we received.

We don't care about this data, we just don't want the kernel to signal the other side that our read buffer's full.

Definition at line 230 of file rlm_logtee.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_logtee_conn_writable()

static void _logtee_conn_writable ( UNUSED fr_event_list_t *  el, int  sock, UNUSED int  flags, void *  uctx  )

static

There's space available to write data, so do that...

Definition at line 263 of file rlm_logtee.c.

Here is the call graph for this function:

Here is the caller graph for this function:

logtee_fd_active()

static void logtee_fd_active ( rlm_logtee_thread_t *  t )

static

Set the socket to active.

We have messages we want to send, so need to know when the socket is writable.

Parameters

[in]

t

Thread instance containing the connection.

Definition at line 337 of file rlm_logtee.c.

Here is the call graph for this function:

Here is the caller graph for this function:

logtee_fd_idle()

static void logtee_fd_idle ( rlm_logtee_thread_t *  t )

static

Set the socket to idle.

If the other side is sending back garbage, we want to drain it so our buffer doesn't fill up.

Parameters

[in]

t

Thread instance containing the connection.

Definition at line 317 of file rlm_logtee.c.

Here is the call graph for this function:

Here is the caller graph for this function:

logtee_it() [1/2]

static void logtee_it ( fr_log_type_t  type, fr_log_lvl_t  lvl, request_t *  request, char const *  file, int  line, char const *  fmt, va_list  ap, void *  uctx  )

static

Here is the caller graph for this function:

logtee_it() [2/2]

static void logtee_it ( fr_log_type_t  type, fr_log_lvl_t  lvl, request_t *  request, UNUSED char const *  file, UNUSED int  line, char const *  fmt, va_list  ap, void *  uctx  )

static

Logging callback to write log messages to a destination.

This allows the logging destination to be customised on a per request basis.

Note

Function does not write log output immediately

Parameters

[in]	type	What type of message this is (error, warn, info, debug).
[in]	lvl	At what logging level this message should be output.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	sprintf style fmt string.
[in]	ap	Arguments for the fmt string.
[in]	uctx	Context data for the log function.

Definition at line 454 of file rlm_logtee.c.

Here is the call graph for this function:

mod_insert_logtee()

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

static

Add our logging destination to the linked list of logging destinations (if it doesn't already exist)

Parameters

[in]	p_result	the result of the module call: RLM_MODULE_NOOP if log destination already exists. RLM_MODULE_OK if we added a new destination.
[in]	mctx	Module calling ctx.
[in]	request	request to add our log destination to.

Definition at line 525 of file rlm_logtee.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Definition at line 597 of file rlm_logtee.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

Create thread-specific connections and buffers.

Parameters

[in]

mctx

specific data.

Returns

• 0 on success.
• -1 on failure.

Definition at line 555 of file rlm_logtee.c.

Here is the call graph for this function:

Variable Documentation

attr_log_level

fr_dict_attr_t const* attr_log_level

static

Definition at line 187 of file rlm_logtee.c.

attr_log_message

fr_dict_attr_t const* attr_log_message

static

Definition at line 188 of file rlm_logtee.c.

attr_log_type

fr_dict_attr_t const* attr_log_type

static

Definition at line 189 of file rlm_logtee.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 179 of file rlm_logtee.c.

file_config

const conf_parser_t file_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_OUTPUT | CONF_FLAG_XLAT, rlm_logtee_t, file.name) },
        { FR_CONF_OFFSET("permissions", rlm_logtee_t, file.permissions), .dflt = "0600" },
        { FR_CONF_OFFSET("group", rlm_logtee_t, file.group_str) },
        { FR_CONF_OFFSET("escape_filenames", rlm_logtee_t, file.escape), .dflt = "no" },
        CONF_PARSER_TERMINATOR
}

Definition at line 132 of file rlm_logtee.c.

logtee_dst_table

fr_table_num_sorted_t const logtee_dst_table[]

static

Initial value:

= {
        { L("file"),            LOGTEE_DST_FILE },
        { L("tcp"),             LOGTEE_DST_TCP  },
        { L("udp"),             LOGTEE_DST_UDP  },
        { L("unix"),            LOGTEE_DST_UNIX }
}

Definition at line 62 of file rlm_logtee.c.

logtee_dst_table_len

size_t logtee_dst_table_len = NUM_ELEMENTS(logtee_dst_table)

static

Definition at line 68 of file rlm_logtee.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("destination", CONF_FLAG_REQUIRED, rlm_logtee_t, log_dst_str) },
        { FR_CONF_OFFSET_TYPE_FLAGS("buffer_depth", FR_TYPE_SIZE, 0, rlm_logtee_t, buffer_depth), .dflt = "10000" },
 
        { FR_CONF_OFFSET("delimiter", rlm_logtee_t, delimiter), .dflt = "\n" },
        { FR_CONF_OFFSET("format", rlm_logtee_t, log_fmt), .dflt = "%n - %s", .quote = T_DOUBLE_QUOTED_STRING },
 
        
        { FR_CONF_POINTER("file", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) file_config },
        { FR_CONF_POINTER("unix", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) unix_config },
        { FR_CONF_OFFSET_SUBSECTION("tcp", 0, rlm_logtee_t, tcp, tcp_config) },
        { FR_CONF_OFFSET_SUBSECTION("udp", 0, rlm_logtee_t, udp, udp_config) },
 
        { FR_CONF_OFFSET("connection_timeout", rlm_logtee_t, connection_timeout), .dflt = "1.0" },
        { FR_CONF_OFFSET("reconnection_delay", rlm_logtee_t, reconnection_delay), .dflt = "1.0" },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 158 of file rlm_logtee.c.

rlm_logtee

module_rlm_t rlm_logtee

Initial value:

= {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "logtee",
                .inst_size              = sizeof(rlm_logtee_t),
                .thread_inst_size       = sizeof(rlm_logtee_thread_t),
                .config                 = module_config,
                .instantiate            = mod_instantiate,
                .thread_instantiate     = mod_thread_instantiate,
        },
        .method_names = (module_method_name_t[]){
                { .name1 = CF_IDENT_ANY,        .name2 = CF_IDENT_ANY,          .method = mod_insert_logtee },
                MODULE_NAME_TERMINATOR
        }
}

Definition at line 658 of file rlm_logtee.c.

rlm_logtee_dict

fr_dict_autoload_t rlm_logtee_dict

Initial value:

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

Definition at line 182 of file rlm_logtee.c.

rlm_logtee_dict_attr

fr_dict_attr_autoload_t rlm_logtee_dict_attr

Initial value:

= {
        { .out = &attr_log_level, .name = "Log-Level", .type = FR_TYPE_UINT32, .dict = &dict_freeradius },
        { .out = &attr_log_message, .name = "Log-Message", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
        { .out = &attr_log_type, .name = "Log-Type", .type = FR_TYPE_UINT32, .dict = &dict_freeradius },
        { NULL }
}

Definition at line 192 of file rlm_logtee.c.

tcp_config

const conf_parser_t tcp_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("server", FR_TYPE_COMBO_IP_ADDR, 0, logtee_net_t, dst_ipaddr) },
        { FR_CONF_OFFSET("port", logtee_net_t, port) },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 151 of file rlm_logtee.c.

udp_config

const conf_parser_t udp_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("server", FR_TYPE_COMBO_IP_ADDR, 0, logtee_net_t, dst_ipaddr) },
        { FR_CONF_OFFSET("port", logtee_net_t, port) },
        CONF_PARSER_TERMINATOR
}

Definition at line 145 of file rlm_logtee.c.

unix_config

const conf_parser_t unix_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_INPUT, rlm_logtee_t, unix_sock.path) },
        CONF_PARSER_TERMINATOR
}

Definition at line 140 of file rlm_logtee.c.