Session tracking using redis. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/modpriv.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/redis/base.h>
#include <freeradius-devel/redis/cluster_async.h>

Include dependency graph for rlm_rediswho.c:

Go to the source code of this file.

Data Structures
struct	rediswho_call_env_t

struct	rediswho_rctx_t
	Resume context for rediswho module calls. More...

struct	rlm_rediswho_t

struct	rlm_rediswho_thread_t

Functions
static int	_rediswho_rctx_free (rediswho_rctx_t *rctx)

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

static void	mod_accounting_cancel (module_ctx_t const mctx, request_t request, UNUSED fr_signal_t action)

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

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

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

static int	mod_coord_attach (module_thread_inst_ctx_t const *mctx)

static int	mod_detach (module_detach_ctx_t const *mctx)

static int	mod_instantiate (module_inst_ctx_t const *mctx)

static int	mod_load (void)

static int	mod_thread_detach (module_thread_inst_ctx_t const *mctx)

static int	mod_thread_instantiate (module_thread_inst_ctx_t const *mctx)

	REDIS_ASYNC_COORD_CALLBACKS (rlm_rediswho_thread_t)

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

static fr_redis_async_rcode_t	rediswho_command (rlm_rediswho_thread_t thread, request_t request, fr_value_box_t key, rediswho_rctx_t rctx, char const *fmt,...)

static unlang_action_t	rediswho_rcode_check (request_t request, fr_redis_command_set_t cmds, fr_redis_async_cmd_t cmd, module_ctx_t const mctx, module_method_t resume, unlang_module_signal_t cancel)

static void	rediswho_results (request_t request, UNUSED fr_redis_command_t cmd, redisReply reply, void rctx)
	Process redisReply from rediswho command.

Variables
static fr_dict_attr_t const *	attr_acct_status_type

static fr_dict_t const *	dict_radius

static fr_dict_t const *	dict_redis

static const call_env_method_t	method_env

static conf_parser_t	module_config []

static conf_parser_t	redis_config []

static call_env_parser_t const	rediswho_env_parser []

module_rlm_t	rlm_rediswho

fr_dict_autoload_t	rlm_rediswho_dict []

fr_dict_attr_autoload_t	rlm_rediswho_dict_attr []

Detailed Description

Session tracking using redis.

Id: 50bd6cacb724a2dc7d475ea4d275fb903c11f23f

Author: Gabriel Blanchard

Copyright: 2015 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg); 2011 TekSavvy Solutions (gabe@.nosp@m.teks.nosp@m.avvy..nosp@m.com); 2000,2006 The FreeRADIUS server project

Definition in file rlm_rediswho.c.

Data Structure Documentation

◆ rediswho_call_env_t

struct rediswho_call_env_t

Definition at line 68 of file rlm_rediswho.c.

Collaboration diagram for rediswho_call_env_t:

Data Fields
fr_value_box_t	insert_arg	Argument to append to insert command.
fr_value_box_t	insert_cmd	Command to run for insert stage, defaults to LPUSH.
fr_value_box_t	key	Key value for redis commands.
fr_value_box_t	trim_cmd	Command to run for trim stage, defaults to LTRIM.

◆ rediswho_rctx_t

struct rediswho_rctx_t

Resume context for rediswho module calls.

Definition at line 61 of file rlm_rediswho.c.

Collaboration diagram for rediswho_rctx_t:

Data Fields
fr_redis_async_cmd_t *	cmd	Async command context.
char *	cmd_str	Formatted command currently being run.
fr_redis_command_set_t *	cmds	Command set for module call.
int	ret	Value returned in Redis reply.

◆ rlm_rediswho_t

struct rlm_rediswho_t

Definition at line 39 of file rlm_rediswho.c.

Collaboration diagram for rlm_rediswho_t:

Data Fields
fr_redis_conf_t	conf	Connection parameters for the Redis server. Must be first field in this struct.
fr_coord_pair_reg_t *	coord_pair_reg	Coord pair registration.
fr_coord_reg_t *	coord_reg	Coordinator registration.
int	expiry_time	Expiry time in seconds if no updates are received for a user.
CONF_SECTION *	tls_conf	TLS CONF_SECTION.
int	trim_count	How many session updates to keep track of per user.

◆ rlm_rediswho_thread_t

struct rlm_rediswho_thread_t

Definition at line 53 of file rlm_rediswho.c.

Collaboration diagram for rlm_rediswho_thread_t:

Data Fields
fr_coord_worker_t *	cw	Coord-worker for fetching cluster map.
rlm_rediswho_t *	inst	Module instance.
fr_redis_ct_t *	rtcluster	Per thread Redis cluster.

Function Documentation

◆ _rediswho_rctx_free()

static int _rediswho_rctx_free ( rediswho_rctx_t * rctx )

static

Definition at line 296 of file rlm_rediswho.c.

Here is the caller graph for this function:

◆ mod_accounting()

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

static

Definition at line 302 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ mod_accounting_cancel()

static void mod_accounting_cancel	(	module_ctx_t const *	mctx,
		request_t *	request,
		UNUSED fr_signal_t	action
	)

static

Definition at line 177 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_accounting_expire()

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

static

Definition at line 231 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_accounting_resume()

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

static

Definition at line 215 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_accounting_trim()

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

static

Definition at line 258 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mod_coord_attach()

static int mod_coord_attach ( module_thread_inst_ctx_t const * mctx )

static

Definition at line 349 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ mod_detach()

static int mod_detach ( module_detach_ctx_t const * mctx )

static

Definition at line 428 of file rlm_rediswho.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 368 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ mod_load()

static int mod_load ( void )

static

Definition at line 437 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ mod_thread_detach()

static int mod_thread_detach ( module_thread_inst_ctx_t const * mctx )

static

Definition at line 417 of file rlm_rediswho.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

Definition at line 336 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ REDIS_ASYNC_COORD_CALLBACKS()

REDIS_ASYNC_COORD_CALLBACKS ( rlm_rediswho_thread_t )

◆ redis_command_call_env_parse()

static int redis_command_call_env_parse	(	TALLOC_CTX *	ctx,
		call_env_parsed_head_t *	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 452 of file rlm_rediswho.c.

Here is the call graph for this function:

◆ rediswho_command()

static fr_redis_async_rcode_t rediswho_command	(	rlm_rediswho_thread_t *	thread,
		request_t *	request,
		fr_value_box_t *	key,
		rediswho_rctx_t *	rctx,
		char const *	fmt,
			...
	)

static

Definition at line 142 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rediswho_rcode_check()

static unlang_action_t rediswho_rcode_check	(	request_t *	request,
		fr_redis_command_set_t *	cmds,
		fr_redis_async_cmd_t *	cmd,
		module_ctx_t const *	mctx,
		module_method_t	resume,
		unlang_module_signal_t	cancel
	)

inlinestatic

Definition at line 186 of file rlm_rediswho.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rediswho_results()

static void rediswho_results	(	request_t *	request,
		UNUSED fr_redis_command_t *	cmd,
		redisReply *	reply,
		void *	rctx
	)

static

Process redisReply from rediswho command.

The reply is expected to either be an integer or status.

Definition at line 111 of file rlm_rediswho.c.

Here is the caller graph for this function:

Variable Documentation

◆ attr_acct_status_type

fr_dict_attr_t const* attr_acct_status_type

static

Definition at line 99 of file rlm_rediswho.c.

◆ dict_radius

fr_dict_t const* dict_radius

static

Definition at line 89 of file rlm_rediswho.c.

◆ dict_redis

fr_dict_t const* dict_redis

static

Definition at line 90 of file rlm_rediswho.c.

◆ method_env

const call_env_method_t method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(rediswho_call_env_t),
        .env = (call_env_parser_t[]) {
                { FR_CALL_ENV_SUBSECTION_FUNC(CF_IDENT_ANY, CF_IDENT_ANY, CALL_ENV_FLAG_SUBSECTION, redis_command_call_env_parse) },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 476 of file rlm_rediswho.c.

◆ module_config

conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET("trim_count", rlm_rediswho_t, trim_count), .dflt = "-1" },
        { FR_CONF_OFFSET_FLAGS("expiry_time", CONF_FLAG_REQUIRED, rlm_rediswho_t, expiry_time) },
 
        { FR_CONF_POINTER("redis", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = redis_config },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 80 of file rlm_rediswho.c.

◆ redis_config

conf_parser_t redis_config[]

static

Initial value:

= {
        REDIS_COMMON_CONFIG,
        CONF_PARSER_TERMINATOR
}

Definition at line 75 of file rlm_rediswho.c.

◆ rediswho_env_parser

call_env_parser_t const rediswho_env_parser[]

static

Initial value:

= {
        { FR_CALL_ENV_OFFSET("key", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT | CALL_ENV_FLAG_REQUIRED | CALL_ENV_FLAG_BARE_WORD_ATTRIBUTE , rediswho_call_env_t, key) },
        { FR_CALL_ENV_OFFSET("insert_cmd", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT, rediswho_call_env_t, insert_cmd), .pair.dflt = "LPUSH", .pair.dflt_quote = T_SINGLE_QUOTED_STRING },
        { FR_CALL_ENV_OFFSET("insert_arg", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT | CALL_ENV_FLAG_REQUIRED , rediswho_call_env_t, insert_arg) },
        { FR_CALL_ENV_OFFSET("trim_cmd", FR_TYPE_STRING, CALL_ENV_FLAG_CONCAT , rediswho_call_env_t, trim_cmd), .pair.dflt = "LTRIM", .pair.dflt_quote = T_SINGLE_QUOTED_STRING },
        CALL_ENV_TERMINATOR
}

Definition at line 444 of file rlm_rediswho.c.

◆ rlm_rediswho

module_rlm_t rlm_rediswho

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "rediswho",
                .inst_size      = sizeof(rlm_rediswho_t),
                .config         = module_config,
                .onload         = mod_load,
                .instantiate    = mod_instantiate,
                .coord_attach   = mod_coord_attach,
                .detach         = mod_detach,
                MODULE_THREAD_INST(rlm_rediswho_thread_t),
                .thread_instantiate     = mod_thread_instantiate,
                .thread_detach          = mod_thread_detach,
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        { .section = SECTION_NAME("accounting", CF_IDENT_ANY), .method = mod_accounting, .method_env = &method_env },
                        MODULE_BINDING_TERMINATOR
                }
        }
}

Definition at line 485 of file rlm_rediswho.c.

◆ rlm_rediswho_dict

fr_dict_autoload_t rlm_rediswho_dict

Initial value:

= {
        { .out = &dict_radius, .proto = "radius" },
        { .out = &dict_redis, .proto = "redis" },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 93 of file rlm_rediswho.c.

◆ rlm_rediswho_dict_attr

fr_dict_attr_autoload_t rlm_rediswho_dict_attr

Initial value:

= {
        { .out = &attr_acct_status_type, .name = "Acct-Status-Type", .type = FR_TYPE_UINT32, .dict = &dict_radius },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 102 of file rlm_rediswho.c.

Data Structures

Functions

Variables

Detailed Description

Data Structure Documentation

◆ rediswho_call_env_t

◆ rediswho_rctx_t

◆ rlm_rediswho_t

◆ rlm_rediswho_thread_t

Function Documentation

◆ _rediswho_rctx_free()

◆ mod_accounting()

◆ mod_accounting_cancel()

◆ mod_accounting_expire()

◆ mod_accounting_resume()

◆ mod_accounting_trim()

◆ mod_coord_attach()

◆ mod_detach()

◆ mod_instantiate()

◆ mod_load()

◆ mod_thread_detach()

◆ mod_thread_instantiate()

◆ REDIS_ASYNC_COORD_CALLBACKS()

◆ redis_command_call_env_parse()

◆ rediswho_command()

◆ rediswho_rcode_check()

◆ rediswho_results()

Variable Documentation

◆ attr_acct_status_type

◆ dict_radius

◆ dict_redis

◆ method_env

◆ module_config

◆ redis_config

◆ rediswho_env_parser

◆ rlm_rediswho

◆ rlm_rediswho_dict

◆ rlm_rediswho_dict_attr