rlm_files.c File Reference

Process simple 'users' policy files. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/server/pairmove.h>
#include <freeradius-devel/server/users_file.h>
#include <freeradius-devel/util/htrie.h>
#include <freeradius-devel/unlang/call_env.h>
#include <freeradius-devel/unlang/function.h>
#include <freeradius-devel/unlang/transaction.h>
#include <ctype.h>
#include <fcntl.h>

Include dependency graph for rlm_files.c:

Go to the source code of this file.

Data Structures
struct	rlm_files_data_t
	Structure produced by custom call_env parser. More...
struct	rlm_files_env_t
	Call_env structure. More...
struct	rlm_files_t

Functions
static int	call_env_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 for loading files data.
static int	getrecv_filename (TALLOC_CTX *ctx, char const *filename, fr_htrie_t **ptree, PAIR_LIST_LIST **pdefault, fr_type_t data_type, fr_dict_attr_t const *key_enum, fr_dict_t const *dict, bool v3_compat)
static unlang_action_t	mod_files (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
	Initiate a files data lookup.
static unlang_action_t	mod_files_resume (rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
	Lookup the expanded key value in files data.
static int8_t	pairlist_cmp (void const *a, void const *b)
static uint32_t	pairlist_hash (void const *a)
static int	pairlist_to_key (uint8_t **out, size_t *outlen, void const *a)

Variables
static fr_dict_attr_t const *	attr_fall_through
static fr_dict_attr_t const *	attr_next_shortest_prefix
static fr_dict_t const *	dict_freeradius
static const call_env_method_t	method_env
static const conf_parser_t	module_config []
module_rlm_t	rlm_files
fr_dict_autoload_t	rlm_files_dict []
fr_dict_attr_autoload_t	rlm_files_dict_attr []

Detailed Description

Process simple 'users' policy files.

Id

dede2b04a68dfe0ece10862e6a90b253c8a80503

Copyright

2000,2006 The FreeRADIUS server project

2000 Jeff Carneal (jeff@.nosp@m.apex.nosp@m..net)

Definition in file rlm_files.c.

---

Data Structure Documentation

rlm_files_data_t

struct rlm_files_data_t

Structure produced by custom call_env parser.

Definition at line 46 of file rlm_files.c.

Collaboration diagram for rlm_files_data_t:

Data Fields
PAIR_LIST_LIST *	def	parsed files DEFAULT data.
fr_htrie_t *	htrie	parsed files "user" data.
tmpl_t *	key_tmpl	tmpl used to evaluate lookup key.

rlm_files_env_t

struct rlm_files_env_t

Call_env structure.

Definition at line 54 of file rlm_files.c.

Collaboration diagram for rlm_files_env_t:

Data Fields
rlm_files_data_t *	data	Data from parsed call_env.
tmpl_t *	match_attr	Attribute to populate with matched key value.
char const *	name	Name of module instance - for debug output.
fr_value_box_list_t	values	Where the expanded tmpl value will be written.

rlm_files_t

struct rlm_files_t

Definition at line 39 of file rlm_files.c.

Data Fields
char const *	filename
bool	v3_compat

Function Documentation

call_env_parse()

static int call_env_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 for loading files data.

Definition at line 654 of file rlm_files.c.

Here is the call graph for this function:

getrecv_filename()

static int getrecv_filename ( TALLOC_CTX *  ctx, char const *  filename, fr_htrie_t **  ptree, PAIR_LIST_LIST **  pdefault, fr_type_t  data_type, fr_dict_attr_t const *  key_enum, fr_dict_t const *  dict, bool  v3_compat  )

static

Definition at line 105 of file rlm_files.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_files()

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

static

Initiate a files data lookup.

The results of call_env parsing are a structure containing the tmpl_t representing the key and the parsed files data, meaning tmpl expansion does not happen by default. First we push the tmpl onto the stack for evaluation, then the lookup is done in mod_files_resume.

Definition at line 632 of file rlm_files.c.

Here is the call graph for this function:

mod_files_resume()

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

static

Lookup the expanded key value in files data.

Definition at line 401 of file rlm_files.c.

Here is the call graph for this function:

Here is the caller graph for this function:

pairlist_cmp()

static int8_t pairlist_cmp ( void const *  a, void const *  b  )

static

Definition at line 92 of file rlm_files.c.

Here is the call graph for this function:

Here is the caller graph for this function:

pairlist_hash()

static uint32_t pairlist_hash ( void const *  a )

static

Definition at line 87 of file rlm_files.c.

Here is the call graph for this function:

Here is the caller graph for this function:

pairlist_to_key()

static int pairlist_to_key ( uint8_t **  out, size_t *  outlen, void const *  a  )

static

Definition at line 100 of file rlm_files.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

attr_fall_through

fr_dict_attr_t const* attr_fall_through

static

Definition at line 69 of file rlm_files.c.

attr_next_shortest_prefix

fr_dict_attr_t const* attr_next_shortest_prefix

static

Definition at line 70 of file rlm_files.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 61 of file rlm_files.c.

method_env

const call_env_method_t method_env

static

Initial value:

= {
        FR_CALL_ENV_METHOD_OUT(rlm_files_env_t),
        .env = (call_env_parser_t[]){
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("key", FR_TYPE_VOID, CALL_ENV_FLAG_PARSE_ONLY, rlm_files_env_t, data),
                                     .pair.dflt = "%{Stripped-User-Name || User-Name}", .pair.dflt_quote = T_DOUBLE_QUOTED_STRING,
                                     .pair.func = call_env_parse },
                { FR_CALL_ENV_PARSE_ONLY_OFFSET("match_attr", FR_TYPE_VOID, CALL_ENV_FLAG_ATTRIBUTE, rlm_files_env_t, match_attr) },
                CALL_ENV_TERMINATOR
        },
}

Definition at line 689 of file rlm_files.c.

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_REQUIRED | CONF_FLAG_FILE_INPUT, rlm_files_t, filename) },
        { FR_CONF_OFFSET("v3_compat", rlm_files_t, v3_compat) },
        CONF_PARSER_TERMINATOR
}

Definition at line 80 of file rlm_files.c.

rlm_files

module_rlm_t rlm_files

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "files",
                .inst_size      = sizeof(rlm_files_t),
                .config         = module_config,
        },
        .method_group = {
                .bindings = (module_method_binding_t[]){
                        { .section = SECTION_NAME(CF_IDENT_ANY, CF_IDENT_ANY), .method = mod_files, .method_env = &method_env },
                        MODULE_BINDING_TERMINATOR
                }
        }
}

Definition at line 702 of file rlm_files.c.

rlm_files_dict

fr_dict_autoload_t rlm_files_dict

Initial value:

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

Definition at line 64 of file rlm_files.c.

rlm_files_dict_attr

fr_dict_attr_autoload_t rlm_files_dict_attr

Initial value:

= {
        { .out = &attr_fall_through, .name = "Fall-Through", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
        { .out = &attr_next_shortest_prefix, .name = "Next-Shortest-Prefix", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
 
        { NULL }
}

Definition at line 73 of file rlm_files.c.