rlm_csv.c File Reference

Read and map CSV files. More...

#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/module_rlm.h>
#include <freeradius-devel/util/htrie.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/server/map_proc.h>

Include dependency graph for rlm_csv.c:

Go to the source code of this file.

Data Structures
struct	rlm_csv_entry_s
struct	rlm_csv_t

Macros
#define	CSV_MAX_ATTRMAP   (128)

Typedefs
typedef struct rlm_csv_entry_s	rlm_csv_entry_t

Functions
static bool	buf2entry (rlm_csv_t *inst, char *buf, char **out)
static int8_t	csv_cmp (void const *one, void const *two)
static uint32_t	csv_hash (void const *data)
static int	csv_map_getvalue (TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, map_t const *map, void *uctx)
static int	csv_map_verify (map_t *map, void *instance)
static int	csv_maps_verify (CONF_SECTION *cs, void *mod_inst, UNUSED void *proc_inst, tmpl_t const *src, map_list_t const *maps)
static int	csv_to_key (uint8_t **out, size_t *outlen, void const *data)
static bool	duplicate_entry (CONF_SECTION *conf, rlm_csv_t *inst, rlm_csv_entry_t *old, char *p, int lineno)
static int	fieldname2offset (rlm_csv_t const *inst, char const *field_name, int *array_offset)
static bool	file2csv (CONF_SECTION *conf, rlm_csv_t *inst, int lineno, char *buffer)
static bool	insert_entry (CONF_SECTION *conf, rlm_csv_t *inst, rlm_csv_entry_t *e, int lineno)
static int	mod_bootstrap (module_inst_ctx_t const *mctx)
static int	mod_instantiate (module_inst_ctx_t const *mctx)
	Instantiate the module. More...
static rlm_rcode_t	mod_map_apply (rlm_csv_t const *inst, request_t *request, fr_value_box_t const *key, map_list_t const *maps)
	Perform a search and map the result of the search to server attributes. More...
static unlang_action_t	mod_map_proc (rlm_rcode_t *p_result, void *mod_inst, UNUSED void *proc_inst, request_t *request, fr_value_box_list_t *key, map_list_t const *maps)
	Perform a search and map the result of the search to server attributes. More...
static unlang_action_t	mod_process (rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)

Variables
static const conf_parser_t	module_config []
module_rlm_t	rlm_csv

Detailed Description

Read and map CSV files.

Id

063ba4291c2c838cc11c0fc335f71050196c3b5c

Copyright

2019 The FreeRADIUS server project

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

Definition in file rlm_csv.c.

---

Data Structure Documentation

rlm_csv_entry_s

struct rlm_csv_entry_s

Definition at line 71 of file rlm_csv.c.

Collaboration diagram for rlm_csv_entry_s:

Data Fields
char *	data[]
fr_value_box_t *	key
rlm_csv_entry_t *	next
fr_rb_node_t	node

rlm_csv_t

struct rlm_csv_t

Definition at line 44 of file rlm_csv.c.

Collaboration diagram for rlm_csv_t:

Data Fields
bool	allow_multiple_keys
char const *	delimiter
char const **	field_names
int *	field_offsets
fr_type_t *	field_types
char const *	fields
char const *	filename
bool	header
int	index_field
char const *	index_field_name
tmpl_t *	key
fr_type_t	key_data_type
map_list_t	map	if there is an "update" section in the configuration.
bool	multiple_index_fields
int	num_fields
fr_rb_tree_t *	tree
fr_htrie_t *	trie
int	used_fields

Macro Definition Documentation

CSV_MAX_ATTRMAP

#define CSV_MAX_ATTRMAP   (128)

Definition at line 386 of file rlm_csv.c.

Typedef Documentation

rlm_csv_entry_t

typedef struct rlm_csv_entry_s rlm_csv_entry_t

Definition at line 34 of file rlm_csv.c.

Function Documentation

buf2entry()

static bool buf2entry ( rlm_csv_t *  inst, char *  buf, char **  out  )

static

Definition at line 95 of file rlm_csv.c.

Here is the caller graph for this function:

csv_cmp()

static int8_t csv_cmp ( void const *  one, void const *  two  )

static

Definition at line 164 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

csv_hash()

static uint32_t csv_hash ( void const *  data )

static

Definition at line 172 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

csv_map_getvalue()

static int csv_map_getvalue ( TALLOC_CTX *  ctx, fr_pair_list_t *  out, request_t *  request, map_t const *  map, void *  uctx  )

static

Definition at line 840 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

csv_map_verify()

static int csv_map_verify ( map_t *  map, void *  instance  )

static

Definition at line 391 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

csv_maps_verify()

static int csv_maps_verify ( CONF_SECTION *  cs, void *  mod_inst, UNUSED void *  proc_inst, tmpl_t const *  src, map_list_t const *  maps  )

static

Definition at line 484 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

csv_to_key()

static int csv_to_key ( uint8_t **  out, size_t *  outlen, void const *  data  )

static

Definition at line 179 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

duplicate_entry()

static bool duplicate_entry ( CONF_SECTION *  conf, rlm_csv_t *  inst, rlm_csv_entry_t *  old, char *  p, int  lineno  )

static

Definition at line 222 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fieldname2offset()

static int fieldname2offset ( rlm_csv_t const *  inst, char const *  field_name, int *  array_offset  )

static

Definition at line 366 of file rlm_csv.c.

Here is the caller graph for this function:

file2csv()

static bool file2csv ( CONF_SECTION *  conf, rlm_csv_t *  inst, int  lineno, char *  buffer  )

static

Definition at line 256 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

insert_entry()

static bool insert_entry ( CONF_SECTION *  conf, rlm_csv_t *  inst, rlm_csv_entry_t *  e, int  lineno  )

static

Definition at line 188 of file rlm_csv.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 515 of file rlm_csv.c.

Here is the call graph for this function:

mod_instantiate()

static int mod_instantiate ( module_inst_ctx_t const *  mctx )

static

Instantiate the module.

Creates a new instance of the module reading parameters from a configuration section.

Parameters

[in]

mctx

configuration data.

Returns

• 0 on success.
• < 0 on failure.

Definition at line 754 of file rlm_csv.c.

Here is the call graph for this function:

mod_map_apply()

static rlm_rcode_t mod_map_apply ( rlm_csv_t const *  inst, request_t *  request, fr_value_box_t const *  key, map_list_t const *  maps  )

static

Perform a search and map the result of the search to server attributes.

Parameters

[in]	inst	rlm_csv_t.
[in,out]	request	The current request.
[in]	key	key to look for
[in]	maps	Head of the map list.

Returns

• RLM_MODULE_NOOP no rows were returned.
• RLM_MODULE_UPDATED if one or more fr_pair_t were added to the request_t.
• RLM_MODULE_FAIL if an error occurred.

Definition at line 898 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_map_proc()

static unlang_action_t mod_map_proc ( rlm_rcode_t *  p_result, void *  mod_inst, UNUSED void *  proc_inst, request_t *  request, fr_value_box_list_t *  key, map_list_t const *  maps  )

static

Perform a search and map the result of the search to server attributes.

Parameters

[out]	p_result	Result of applying map: RLM_MODULE_NOOP no rows were returned. RLM_MODULE_UPDATED if one or more fr_pair_t were added to the request_t. RLM_MODULE_FAIL if an error occurred.
[in]	mod_inst	rlm_csv_t.
[in]	proc_inst	mapping map entries to field numbers.
[in,out]	request	The current request.
[in]	key	key to look for
[in]	maps	Head of the map list.

Returns

UNLANG_ACTION_CALCULATE_RESULT

Definition at line 978 of file rlm_csv.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mod_process()

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

static

Definition at line 1003 of file rlm_csv.c.

Here is the call graph for this function:

Variable Documentation

module_config

const conf_parser_t module_config[]

static

Initial value:

= {
        { FR_CONF_OFFSET_FLAGS("filename", CONF_FLAG_FILE_INPUT | CONF_FLAG_REQUIRED | CONF_FLAG_NOT_EMPTY, rlm_csv_t, filename) },
        { FR_CONF_OFFSET_FLAGS("delimiter", CONF_FLAG_NOT_EMPTY, rlm_csv_t, delimiter), .dflt = "," },
        { FR_CONF_OFFSET("fields", rlm_csv_t, fields) },
        { FR_CONF_OFFSET("header", rlm_csv_t, header) },
        { FR_CONF_OFFSET("allow_multiple_keys", rlm_csv_t, allow_multiple_keys) },
        { FR_CONF_OFFSET_FLAGS("index_field", CONF_FLAG_REQUIRED | CONF_FLAG_NOT_EMPTY, rlm_csv_t, index_field_name) },
        { FR_CONF_OFFSET("key", rlm_csv_t, key) },
        CONF_PARSER_TERMINATOR
}

Definition at line 81 of file rlm_csv.c.

rlm_csv

module_rlm_t rlm_csv

Initial value:

= {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "csv",
                .flags          = 0,
                .inst_size      = sizeof(rlm_csv_t),
                .config         = module_config,
                .bootstrap      = mod_bootstrap,
                .instantiate    = mod_instantiate,
        },
        .method_names = (module_method_name_t[]){
                { .name1 = CF_IDENT_ANY,        .name2 = CF_IDENT_ANY,  .method = mod_process },
                MODULE_NAME_TERMINATOR
        }
}

Definition at line 1051 of file rlm_csv.c.