rlm_sqlcounter.c File Reference

Tracks data usage and other counters using SQL. More...

#include <rlm_sql.h>
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/dict.h>
#include <freeradius-devel/unlang/function.h>
#include <ctype.h>

Include dependency graph for rlm_sqlcounter.c:

Go to the source code of this file.

Data Structures
struct	rlm_sqlcounter_t
struct	sqlcounter_call_env_t
struct	sqlcounter_rctx_t

Macros
#define	LOG_PREFIX   "sqlcounter"

Functions
static int	attr_check (CONF_SECTION *conf, tmpl_t *tmpl, char const *name, fr_dict_attr_flags_t *flags)
static int	call_env_query_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)
	Custom call_env parser to tokenize the SQL query xlat used for counter retrieval.
static int	find_next_reset (rlm_sqlcounter_t *inst, fr_time_t now)
static int	find_prev_reset (rlm_sqlcounter_t *inst, fr_time_t now)
static unlang_action_t	mod_authorize (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Check the value of a counter retrieved from an SQL query with a limit
static unlang_action_t	mod_authorize_resume (rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
	Handle the result of calling the SQL query to retrieve the counter value.
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
static int	mod_instantiate (module_inst_ctx_t const *mctx)

Variables
static fr_dict_t const *	dict_freeradius
static const conf_parser_t	module_config []
module_rlm_t	rlm_sqlcounter
fr_dict_autoload_t	rlm_sqlcounter_dict []
static const call_env_method_t	sqlcounter_call_env

Detailed Description

Tracks data usage and other counters using SQL.

Id

9a4601ab53f90cce896ccff69b2b894c4ddef30c

Copyright

2001,2006 The FreeRADIUS server project

2001 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file rlm_sqlcounter.c.

---

Data Structure Documentation

rlm_sqlcounter_t

struct rlm_sqlcounter_t

Definition at line 63 of file rlm_sqlcounter.c.

Collaboration diagram for rlm_sqlcounter_t:

Data Fields
bool	auto_extend	If the remaining allowance is sufficient to reach the next period allow for that in setting the reply attribute.
tmpl_t *	counter_attr	Daily-Session-Time.
tmpl_t *	end_attr	control.${.:instance}-End
tmpl_t *	key	User-Name.
fr_time_t	last_reset
tmpl_t *	limit_attr	Max-Daily-Session.
char const *	query	SQL query to retrieve current session time.
char const *	reset	Daily, weekly, monthly, never or user defined.
fr_time_t	reset_time
char const *	sql_name	Instance of SQL module to use, usually just 'sql'.
tmpl_t *	start_attr	control.${.:instance}-Start
bool	utc	Use UTC time.

sqlcounter_call_env_t

struct sqlcounter_call_env_t

Definition at line 105 of file rlm_sqlcounter.c.

Collaboration diagram for sqlcounter_call_env_t:

Data Fields
xlat_exp_head_t *	query_xlat	Tokenized xlat to run query.
tmpl_t *	reply_attr	Attribute to write timeout to.
tmpl_t *	reply_msg_attr	Attribute to write reply message to.

sqlcounter_rctx_t

struct sqlcounter_rctx_t

Definition at line 251 of file rlm_sqlcounter.c.

Collaboration diagram for sqlcounter_rctx_t:

Data Fields
sqlcounter_call_env_t *	env
rlm_sqlcounter_t *	inst
bool	last_success
fr_pair_t *	limit
fr_value_box_list_t	result

Macro Definition Documentation

LOG_PREFIX

#define LOG_PREFIX   "sqlcounter"

Definition at line 27 of file rlm_sqlcounter.c.

Function Documentation

attr_check()

static int attr_check ( CONF_SECTION *  conf, tmpl_t *  tmpl, char const *  name, fr_dict_attr_flags_t *  flags  )

inlinestatic

Definition at line 542 of file rlm_sqlcounter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

call_env_query_parse()

static int call_env_query_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

Custom call_env parser to tokenize the SQL query xlat used for counter retrieval.

Definition at line 446 of file rlm_sqlcounter.c.

Here is the call graph for this function:

find_next_reset()

static int find_next_reset ( rlm_sqlcounter_t *  inst, fr_time_t  now  )

static

Definition at line 119 of file rlm_sqlcounter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

find_prev_reset()

static int find_prev_reset ( rlm_sqlcounter_t *  inst, fr_time_t  now  )

static

Definition at line 187 of file rlm_sqlcounter.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_authorize()

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

static

Check the value of a counter retrieved from an SQL query with a limit

Module specific attributes containing the start / end times are created / updated, the query is tokenized as an xlat call to the relevant SQL module and then pushed on the stack for evaluation.

Definition at line 385 of file rlm_sqlcounter.c.

Here is the call graph for this function:

mod_authorize_resume()

static unlang_action_t mod_authorize_resume ( rlm_rcode_t *  p_result, UNUSED int *  priority, request_t *  request, void *  uctx  )

static

Handle the result of calling the SQL query to retrieve the counter value.

Create / update the counter attribute in the control list If counter > limit, optionally populate a reply message and return RLM_MODULE_REJECT. Otherwise, optionally populate a reply attribute with the value of limit - counter and return RLM_MODULE_UPDATED. If no reply attribute is set, return RLM_MODULE_OK.

Definition at line 266 of file rlm_sqlcounter.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 560 of file rlm_sqlcounter.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 504 of file rlm_sqlcounter.c.

Here is the call graph for this function:

Variable Documentation

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 111 of file rlm_sqlcounter.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("sql_module_instance", CONF_FLAG_REQUIRED, rlm_sqlcounter_t, sql_name) },
 
 
        { FR_CONF_OFFSET_FLAGS("query", CONF_FLAG_XLAT | CONF_FLAG_REQUIRED, rlm_sqlcounter_t, query) },
        { FR_CONF_OFFSET_FLAGS("reset", CONF_FLAG_REQUIRED, rlm_sqlcounter_t, reset) },
        { FR_CONF_OFFSET_FLAGS("auto_extend", CONF_FLAG_OK_MISSING, rlm_sqlcounter_t, auto_extend) },
        { FR_CONF_OFFSET_FLAGS("utc", CONF_FLAG_OK_MISSING, rlm_sqlcounter_t, utc) },
 
        { FR_CONF_OFFSET_FLAGS("key", CONF_FLAG_NOT_EMPTY, rlm_sqlcounter_t, key), .dflt = "%{Stripped-User-Name || User-Name}", .quote = T_DOUBLE_QUOTED_STRING },
 
        { FR_CONF_OFFSET_FLAGS("reset_period_start_name", CONF_FLAG_ATTRIBUTE, rlm_sqlcounter_t, start_attr),
          .dflt = "control.${.:instance}-Reset-Start", .quote = T_BARE_WORD },
        { FR_CONF_OFFSET_FLAGS("reset_period_end_name", CONF_FLAG_ATTRIBUTE, rlm_sqlcounter_t, end_attr),
          .dflt = "control.${.:instance}-Reset-End", .quote = T_BARE_WORD },
 
        
        { FR_CONF_OFFSET_FLAGS("counter_name", CONF_FLAG_ATTRIBUTE | CONF_FLAG_REQUIRED, rlm_sqlcounter_t, counter_attr) },
        { FR_CONF_OFFSET_FLAGS("check_name", CONF_FLAG_ATTRIBUTE | CONF_FLAG_REQUIRED, rlm_sqlcounter_t, limit_attr) },
 
        CONF_PARSER_TERMINATOR
}

Definition at line 82 of file rlm_sqlcounter.c.

rlm_sqlcounter

module_rlm_t rlm_sqlcounter

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "sqlcounter",
                .inst_size      = sizeof(rlm_sqlcounter_t),
                .config         = module_config,
                .bootstrap      = mod_bootstrap,
                .instantiate    = mod_instantiate,
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        { .section = SECTION_NAME(CF_IDENT_ANY, CF_IDENT_ANY), .method = mod_authorize, .method_env = &sqlcounter_call_env },
                        MODULE_BINDING_TERMINATOR
                }
        }
}

Definition at line 584 of file rlm_sqlcounter.c.

rlm_sqlcounter_dict

fr_dict_autoload_t rlm_sqlcounter_dict

Initial value:

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

Definition at line 114 of file rlm_sqlcounter.c.

sqlcounter_call_env

const call_env_method_t sqlcounter_call_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(sqlcounter_call_env_t),
        .env = (call_env_parser_t[]){
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("query", FR_TYPE_VOID, CALL_ENV_FLAG_REQUIRED | CALL_ENV_FLAG_PARSE_ONLY, sqlcounter_call_env_t, query_xlat),
                  .pair.func = call_env_query_parse },
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("reply_name", FR_TYPE_VOID, CALL_ENV_FLAG_PARSE_ONLY, sqlcounter_call_env_t, reply_attr) },
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("reply_message_name", FR_TYPE_VOID, CALL_ENV_FLAG_PARSE_ONLY, sqlcounter_call_env_t, reply_msg_attr) },
                CALL_ENV_TERMINATOR
        }
}

Definition at line 482 of file rlm_sqlcounter.c.