Detail master protocol handler. More...

#include <freeradius-devel/io/application.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/radius/radius.h>
#include <freeradius-devel/util/pair_legacy.h>
#include "proto_detail.h"

Include dependency graph for proto_detail.c:

Go to the source code of this file.

Macros
#define	MPRINT(x, ...)

Functions
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
	Bootstrap the application. More...

static int	mod_decode (void const instance, request_t request, uint8_t *const data, size_t data_len)
	Decode the packet, and set the request->process function. More...

static ssize_t	mod_encode (UNUSED void const instance, request_t request, uint8_t *buffer, size_t buffer_len)

static int	mod_instantiate (module_inst_ctx_t const *mctx)
	Instantiate the application. More...

static int	mod_open (void instance, fr_schedule_t sc, CONF_SECTION *conf)
	Open listen sockets/connect to external event source. More...

static int	mod_priority_set (void const instance, UNUSED uint8_t const buffer, UNUSED size_t buflen)

static int	transport_parse (TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, conf_parser_t const *rule)

static int	transport_parse (TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, UNUSED conf_parser_t const *rule)
	Wrapper around dl_instance. More...

static int	type_parse (TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, conf_parser_t const *rule)

static int	type_parse (UNUSED TALLOC_CTX ctx, void out, void parent, CONF_ITEM ci, UNUSED conf_parser_t const *rule)
	Wrapper around dl_instance which translates the packet-type into a submodule name. More...

Variables
static fr_dict_attr_t const *	attr_packet_dst_ip_address

static fr_dict_attr_t const *	attr_packet_dst_port

static fr_dict_attr_t const *	attr_packet_original_timestamp

static fr_dict_attr_t const *	attr_packet_src_ip_address

static fr_dict_attr_t const *	attr_packet_src_port

static fr_dict_attr_t const *	attr_protocol

static fr_dict_t const *	dict_freeradius

fr_app_t	proto_detail

static conf_parser_t const	proto_detail_config []
	How to parse a Detail listen section. More...

fr_dict_autoload_t	proto_detail_dict []

fr_dict_attr_autoload_t	proto_detail_dict_attr []

Detailed Description

Detail master protocol handler.

Id: 35600925791b9762b8468c22bf7c595ec1afebd0

Copyright: 2017 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg); 2016 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file proto_detail.c.

Macro Definition Documentation

◆ MPRINT

#define MPRINT	(	x,
		...
	)

Definition at line 44 of file proto_detail.c.

Function Documentation

◆ mod_bootstrap()

static int mod_bootstrap ( module_inst_ctx_t const * mctx )

static

Bootstrap the application.

Bootstrap I/O and type submodules.

Returns

0 on success.
-1 on failure.

Definition at line 552 of file proto_detail.c.

Here is the call graph for this function:

◆ mod_decode()

static int mod_decode	(	void const *	instance,
		request_t *	request,
		uint8_t *const	data,
		size_t	data_len
	)

static

Decode the packet, and set the request->process function.

Definition at line 194 of file proto_detail.c.

Here is the call graph for this function:

◆ mod_encode()

static ssize_t mod_encode	(	UNUSED void const *	instance,
		request_t *	request,
		uint8_t *	buffer,
		size_t	buffer_len
	)

static

Definition at line 381 of file proto_detail.c.

◆ mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const * mctx )

static

Instantiate the application.

Instantiate I/O and type submodules.

Returns

0 on success.
-1 on failure.

Definition at line 499 of file proto_detail.c.

◆ mod_open()

static int mod_open	(	void *	instance,
		fr_schedule_t *	sc,
		CONF_SECTION *	conf
	)

static

Open listen sockets/connect to external event source.

Parameters

[in]	instance	Ctx data for this application.
[in]	sc	to add our file descriptor to.
[in]	conf	Listen section parsed to give us instance.

Returns

0 on success.
-1 on failure.

Definition at line 409 of file proto_detail.c.

Here is the call graph for this function:

◆ mod_priority_set()

static int mod_priority_set	(	void const *	instance,
		UNUSED uint8_t const *	buffer,
		UNUSED size_t	buflen
	)

static

Definition at line 389 of file proto_detail.c.

◆ transport_parse() [1/2]

static int transport_parse	(	TALLOC_CTX *	ctx,
		void *	out,
		UNUSED void *	parent,
		CONF_ITEM *	ci,
		conf_parser_t const *	rule
	)

static

◆ transport_parse() [2/2]

static int transport_parse	(	TALLOC_CTX *	ctx,
		void *	out,
		UNUSED void *	parent,
		CONF_ITEM *	ci,
		UNUSED conf_parser_t const *	rule
	)

static

Wrapper around dl_instance.

Parameters

[in]	ctx	to allocate data in (instance of proto_detail).
[out]	out	Where to write a dl_module_inst_t containing the module handle and instance.
[in]	parent	Base structure address.
[in]	ci	CONF_PAIR specifying the name of the type module.
[in]	rule	unused.

Returns

0 on success.
-1 on failure.

Definition at line 160 of file proto_detail.c.

Here is the call graph for this function:

◆ type_parse() [1/2]

static int type_parse	(	TALLOC_CTX *	ctx,
		void *	out,
		UNUSED void *	parent,
		CONF_ITEM *	ci,
		conf_parser_t const *	rule
	)

static

◆ type_parse() [2/2]

static int type_parse	(	UNUSED TALLOC_CTX *	ctx,
		void *	out,
		void *	parent,
		CONF_ITEM *	ci,
		UNUSED conf_parser_t const *	rule
	)

static

Wrapper around dl_instance which translates the packet-type into a submodule name.

Parameters

[in]	ctx	to allocate data in (instance of proto_detail).
[out]	out	Where to write a dl_module_inst_t containing the module handle and instance.
[in]	parent	Base structure address.
[in]	ci	CONF_PAIR specifying the name of the type module.
[in]	rule	unused.

Returns

0 on success.
-1 on failure.

Definition at line 113 of file proto_detail.c.

Here is the call graph for this function:

Variable Documentation

◆ attr_packet_dst_ip_address

fr_dict_attr_t const* attr_packet_dst_ip_address

static

Definition at line 83 of file proto_detail.c.

◆ attr_packet_dst_port

fr_dict_attr_t const* attr_packet_dst_port

static

Definition at line 84 of file proto_detail.c.

◆ attr_packet_original_timestamp

fr_dict_attr_t const* attr_packet_original_timestamp

static

Definition at line 85 of file proto_detail.c.

◆ attr_packet_src_ip_address

fr_dict_attr_t const* attr_packet_src_ip_address

static

Definition at line 86 of file proto_detail.c.

◆ attr_packet_src_port

fr_dict_attr_t const* attr_packet_src_port

static

Definition at line 87 of file proto_detail.c.

◆ attr_protocol

fr_dict_attr_t const* attr_protocol

static

Definition at line 88 of file proto_detail.c.

◆ dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 74 of file proto_detail.c.

◆ proto_detail

fr_app_t proto_detail

Initial value:

= {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "detail",
                .config                 = proto_detail_config,
                .inst_size              = sizeof(proto_detail_t),
 
                .bootstrap              = mod_bootstrap,
                .instantiate            = mod_instantiate,
        },
        .open                   = mod_open,
        .decode                 = mod_decode,
        .encode                 = mod_encode,
        .priority               = mod_priority_set
}

Definition at line 638 of file proto_detail.c.

◆ proto_detail_config

conf_parser_t const proto_detail_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_TYPE_FLAGS("type", FR_TYPE_VOID, CONF_FLAG_NOT_EMPTY | CONF_FLAG_REQUIRED, proto_detail_t,
                          type), .func = type_parse },
        { FR_CONF_OFFSET_TYPE_FLAGS("transport", FR_TYPE_VOID, 0, proto_detail_t, io_submodule),
          .func = transport_parse, .dflt = "file" },
 
        
        { FR_CONF_OFFSET("max_entry_size", proto_detail_t, max_packet_size) } ,
 
        
        { FR_CONF_OFFSET("max_packet_size", proto_detail_t, max_packet_size) } ,
        { FR_CONF_OFFSET("num_messages", proto_detail_t, num_messages) } ,
 
        { FR_CONF_OFFSET("exit_when_done", proto_detail_t, exit_when_done) },
 
        { FR_CONF_OFFSET("priority", proto_detail_t, priority) },
 
        CONF_PARSER_TERMINATOR
}

How to parse a Detail listen section.

Definition at line 50 of file proto_detail.c.

◆ proto_detail_dict

fr_dict_autoload_t proto_detail_dict

Initial value:

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

Definition at line 77 of file proto_detail.c.

◆ proto_detail_dict_attr

fr_dict_attr_autoload_t proto_detail_dict_attr

Initial value:

= {
        { .out = &attr_packet_dst_ip_address, .name = "Net.Dst.IP", .type = FR_TYPE_COMBO_IP_ADDR, .dict = &dict_freeradius },
        { .out = &attr_packet_dst_port, .name = "Net.Dst.Port", .type = FR_TYPE_UINT16, .dict = &dict_freeradius },
        { .out = &attr_packet_original_timestamp, .name = "Packet-Original-Timestamp", .type = FR_TYPE_DATE, .dict = &dict_freeradius },
        { .out = &attr_packet_src_ip_address, .name = "Net.Src.IP", .type = FR_TYPE_COMBO_IP_ADDR, .dict = &dict_freeradius },
        { .out = &attr_packet_src_port, .name = "Net.Src.Port", .type = FR_TYPE_UINT16, .dict = &dict_freeradius },
        { .out = &attr_protocol, .name = "Protocol", .type = FR_TYPE_UINT32, .dict = &dict_freeradius },
 
        { NULL }
}

Definition at line 91 of file proto_detail.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MPRINT

Function Documentation

◆ mod_bootstrap()

◆ mod_decode()

◆ mod_encode()

◆ mod_instantiate()

◆ mod_open()

◆ mod_priority_set()

◆ transport_parse() [1/2]

◆ transport_parse() [2/2]

◆ type_parse() [1/2]

◆ type_parse() [2/2]

Variable Documentation

◆ attr_packet_dst_ip_address

◆ attr_packet_dst_port

◆ attr_packet_original_timestamp

◆ attr_packet_src_ip_address

◆ attr_packet_src_port

◆ attr_protocol

◆ dict_freeradius

◆ proto_detail

◆ proto_detail_config

◆ proto_detail_dict

◆ proto_detail_dict_attr