API to parse internal format configuration items into native C types. More...

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <unistd.h>
#include <sys/time.h>
#include <freeradius-devel/util/rb.h>
#include <freeradius-devel/util/table.h>
#include <freeradius-devel/util/value.h>
#include <freeradius-devel/server/cf_util.h>

Include dependency graph for cf_parse.h:

Go to the source code of this file.

Data Structures
struct	cf_table_parse_ctx_t

struct	conf_parser_s
	Defines a CONF_PAIR to C data type mapping. More...

union	conf_parser_s.__unnamed53__
	Where to write status if FR_TYPE_IS_DEFAULT is set. More...

union	conf_parser_s.__unnamed55__

struct	conf_parser_s.__unnamed55__.__unnamed57__

struct	conf_parser_s.__unnamed55__.__unnamed59__

Macros
#define	CF_FILE_CONFIG (1 << 2)

#define	CF_FILE_ERROR (1)

#define	CF_FILE_MODULE (1 << 3)

#define	CF_FILE_NONE (0)

#define	cf_section_rule_push(_cs, _rule) _cf_section_rule_push(_cs, _rule, __FILE__, __LINE__)

#define	cf_section_rules_push(_cs, _rule) _cf_section_rules_push(_cs, _rule, __FILE__, __LINE__)

#define	CONF_CTYPE_TO_FLAGS(_ct)

#define	CONF_PARSER_PARTIAL_TERMINATOR

#define	CONF_PARSER_TERMINATOR

#define	FR_CONF_DEPRECATED(_name, _struct, _field)
	conf_parser_t entry which raises an error if a matching CONF_PAIR is found More...

#define	FR_CONF_FLAG_CHECK(_type, _flags, _c_type, _ptr_or_offset) _ptr_or_offset

#define	FR_CONF_FUNC(_name, _type, _flags, _func, _dflt_func)
	conf_parser_t entry which doesn't fill in a pointer or offset, but relies on functions to record values More...

#define	FR_CONF_OFFSET(_name, _struct, _field)
	conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct More...

#define	FR_CONF_OFFSET_FLAGS(_name, _flags, _struct, _field)
	conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct More...

#define	FR_CONF_OFFSET_IS_SET(_name, _type, _flags, _struct, _field)
	conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct, recording if a default was used in `<_field>`_is_set More...

#define	FR_CONF_OFFSET_SUBSECTION(_name, _flags, _struct, _field, _subcs)
	conf_parser_t which populates a sub-struct using a CONF_SECTION More...

#define	FR_CONF_OFFSET_TYPE_FLAGS(_name, _type, _flags, _struct, _field)
	conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct More...

#define	FR_CONF_POINTER(_name, _type, _flags, _res_p)
	conf_parser_t which parses a single CONF_PAIR producing a single global result More...

#define	FR_CONF_POINTER_IS_SET(_name, _type, _flags, _res_p)
	conf_parser_t which parses a single CONF_PAIR producing a single global result, recording if a default was used in `<_res_p>`_is_set More...

#define	FR_CONF_SUBSECTION_ALLOC(_name, _type, _flags, _struct, _field, _subcs)
	A conf_parser_t multi-subsection. More...

#define	FR_CONF_SUBSECTION_GLOBAL(_name, _flags, _subcs)
	conf_parser_t entry which runs conf_parser_t entries for a subsection without any output More...

#define	FR_INTEGER_BOUND_CHECK(_name, _var, _op, _bound) FR_INTEGER_COND_CHECK(_name, _var, (_var _op _bound), _bound)

#define	FR_INTEGER_COND_CHECK(_name, _var, _cond, _new)

#define	FR_ITEM_POINTER(_type, _res_p) _type, FR_CONF_FLAG_CHECK((_type), 0, (_res_p), _res_p)

#define	FR_SIZE_BOUND_CHECK(_name, _var, _op, _bound) FR_SIZE_COND_CHECK(_name, _var, (_var _op _bound), _bound)

#define	FR_SIZE_COND_CHECK(_name, _var, _cond, _new)

#define	FR_TIME_DELTA_BOUND_CHECK(_name, _var, _op, _bound)

#define	FR_TIME_DELTA_COND_CHECK(_name, _var, _cond, _new)

Typedefs
typedef int(*	cf_dflt_t) (CONF_PAIR *out, void parent, CONF_SECTION cs, fr_token_t quote, conf_parser_t const rule)
	Callback for producing dynamic defaults from 3rd party libraries. More...

typedef int(*	cf_parse_t) (TALLOC_CTX ctx, void out, void parent, CONF_ITEM ci, conf_parser_t const *rule)
	Callback for performing custom parsing of a CONF_SECTION or CONF_PAIR. More...

typedef struct conf_parser_s	conf_parser_t

Functions
int	_cf_section_rule_push (CONF_SECTION cs, conf_parser_t const rule, char const *filename, int lineno)
	Add a single rule to a CONF_SECTION. More...

int	_cf_section_rules_push (CONF_SECTION cs, conf_parser_t const rules, char const *filename, int lineno)
	Add an array of parse rules to a CONF_SECTION. More...

void	cf_pair_debug (CONF_SECTION const cs, CONF_PAIR cp, conf_parser_t const *rule)

int	cf_pair_parse (TALLOC_CTX ctx, CONF_SECTION cs, char const name, unsigned int type, void data, char const *dflt, fr_token_t dflt_quote))
	Parses a CONF_PAIR into a C data type, with a default value. More...

int	cf_pair_parse_value (TALLOC_CTX ctx, void out, void base, CONF_ITEM ci, conf_parser_t const *rule))

int	cf_pair_to_value_box (TALLOC_CTX ctx, fr_value_box_t out, CONF_PAIR cp, conf_parser_t const rule))
	Parses a CONF_PAIR into a boxed value. More...

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

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

int	cf_section_parse (TALLOC_CTX ctx, void base, CONF_SECTION *cs)
	Parse a configuration section into user-supplied variables. More...

int	cf_section_parse_pass2 (void base, CONF_SECTION cs)
	Fixup xlat expansions and attributes. More...

int	cf_table_parse_int (UNUSED TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, conf_parser_t const *rule)
	Generic function for parsing conf pair values as int. More...

int	cf_table_parse_int32 (UNUSED TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, conf_parser_t const *rule)
	Generic function for parsing conf pair values as int32_t (FR_TYPE_INT32) More...

int	cf_table_parse_uint32 (UNUSED TALLOC_CTX ctx, void out, UNUSED void parent, CONF_ITEM ci, conf_parser_t const *rule)
	Generic function for parsing conf pair values as int32_t (FR_TYPE_UINT32) More...

Variables
bool	check_config

#conf_parser_t flags checks
#define	fr_rule_deprecated(_rule) ((_rule)->flags & CONF_FLAG_DEPRECATED)

#define	fr_rule_dflt(_rule) ((_rule)->dflt \|\| (_rule)->dflt_func)

#define	fr_rule_file_exists(_rule) ((_rule)->flags & CONF_FLAG_FILE_EXISTS)

#define	fr_rule_file_input(_rule) ((_rule)->flags & CONF_FLAG_FILE_INPUT)

#define	fr_rule_file_output(_rule) ((_rule)->flags & CONF_FLAG_FILE_OUTPUT)

#define	fr_rule_is_attribute(_rule) ((_rule)->flags & CONF_FLAG_ATTRIBUTE)

#define	fr_rule_is_set(_rule) ((_rule)->flags & CONF_FLAG_IS_SET)

#define	fr_rule_is_tmpl(_rule) ((_rule)->flags & CONF_FLAG_TMPL)

#define	fr_rule_is_xlat(_rule) ((_rule)->flags & CONF_FLAG_XLAT)

#define	fr_rule_multi(_rule) ((_rule)->flags & CONF_FLAG_MULTI)

#define	fr_rule_not_empty(_rule) ((_rule)->flags & CONF_FLAG_NOT_EMPTY)

#define	fr_rule_ok_missing(_rule) ((_rule)->flags & CONF_FLAG_OK_MISSING)

#define	fr_rule_required(_rule) ((_rule)->flags & CONF_FLAG_REQUIRED)

#define	fr_rule_secret(_rule) ((_rule)->flags & CONF_FLAG_SECRET)

#conf_parser_t type flags
These flags should be or'd with another FR_TYPE_* value to create validation rules for the cf_pair_parse function.
enum	conf_parser_flags_t { CONF_FLAG_HIDDEN = 0 , CONF_FLAG_SUBSECTION = (1 << 1) , CONF_FLAG_DEPRECATED = (1 << 10) , CONF_FLAG_REQUIRED = (1 << 11) , CONF_FLAG_ATTRIBUTE = (1 << 12) , CONF_FLAG_SECRET = (1 << 13) , CONF_FLAG_FILE_INPUT = (1 << 14) , CONF_FLAG_FILE_OUTPUT = (1 << 15) , CONF_FLAG_XLAT = (1 << 16) , CONF_FLAG_TMPL = (1 << 17) , CONF_FLAG_MULTI = (1 << 18) , CONF_FLAG_NOT_EMPTY = (1 << 19) , CONF_FLAG_FILE_EXISTS = (1 << 20) , CONF_FLAG_IS_SET = (1 << 21) , CONF_FLAG_OK_MISSING = (1 << 22) }

Detailed Description

API to parse internal format configuration items into native C types.

Id: 4f43843c4762c64109a2138cd33d3975ddc4160c

Copyright: 2015 The FreeRADIUS server project

Definition in file cf_parse.h.

Data Structure Documentation

◆ cf_table_parse_ctx_t

struct cf_table_parse_ctx_t

Definition at line 621 of file cf_parse.h.

Collaboration diagram for cf_table_parse_ctx_t:

Data Fields
size_t *	len
fr_table_num_sorted_t const *	table

◆ conf_parser_s

struct conf_parser_s

Defines a CONF_PAIR to C data type mapping.

Is typically used to define mappings between module sections, and module instance structs. May also be used to set global configuration options.

Offset/data values should be set using FR_CONF_OFFSET or FR_CONF_POINTER.

Example with FR_CONF_OFFSET :

static conf_parser_t module_config[] = {
      { FR_CONF_OFFSET_TYPE_FLAGS("example", FR_TYPE_STRING | CONF_FLAG_NOT_EMPTY, 0, 0, example_instance_t, example), .dflt = "default_value" },
      CONF_PARSER_TERMINATOR
}

Example with FR_CONF_POINTER :

static conf_parser_t global_config[] = {
      { FR_CONF_POINTER("example", FR_TYPE_STRING | CONF_FLAG_NOT_EMPTY, 0, 0, 0, &my_global), .dflt = "default_value" },
      CONF_PARSER_TERMINATOR
}

See also: FR_CONF_OFFSET; FR_CONF_POINTER; cf_section_parse; cf_pair_parse

Definition at line 563 of file cf_parse.h.

Collaboration diagram for conf_parser_s:

Data Fields
union conf_parser_s	__unnamed__	Where to write status if FR_TYPE_IS_DEFAULT is set. Note Which field is used, is determined by whether data ptr is set.
union conf_parser_s	__unnamed__
void *	data	Pointer to a static variable to write the parsed value to. Note Must be used exclusively to offset.
conf_parser_flags_t	flags	Flags which control parsing behaviour.
cf_parse_t	func	Override default parsing behaviour for the specified type with a custom parsing function.
char const *	name1	Name of the CONF_ITEM to parse.
char const *	name2	Second identifier for CONF_SECTION.
size_t	offset	Relative offset of field or structure to write the parsed value to. When flags is set to CONF_FLAG_SUBSECTION, may be used to specify a base offset to add to all offsets contained within the subsection. Note Must be used exclusively to data.
cf_parse_t	on_read	Function to call as the item is being read, just after it has been allocated and initialized.
fr_token_t	quote	Quoting around the default value. Only used for templates.
fr_type_t	type	An fr_type_t value, controls the output type.
void const *	uctx	User data accessible by the cf_parse_t func. Useful for building reusable functions.

◆ conf_parser_s.unnamed53

union conf_parser_s.__unnamed53__

Where to write status if FR_TYPE_IS_DEFAULT is set.

Note: Which field is used, is determined by whether data ptr is set.

Definition at line 594 of file cf_parse.h.

Data Fields
size_t	is_set_offset	If type contains FR_TYPE_IS_DEFAULT write status to bool. at this address.
void *	is_set_ptr	If type contains FR_TYPE_IS_DEFAULT write status to ptr at this address.

◆ conf_parser_s.unnamed55

union conf_parser_s.__unnamed55__

Definition at line 601 of file cf_parse.h.

Data Fields
__unnamed55__	__unnamed__
__unnamed55__	__unnamed__

◆ conf_parser_s.unnamed55.unnamed57

struct conf_parser_s.__unnamed55__.__unnamed57__

Definition at line 602 of file cf_parse.h.

Data Fields
char const *	dflt	Default as it would appear in radiusd.conf.
cf_dflt_t	dflt_func	Function to produce dynamic defaults.

◆ conf_parser_s.unnamed55.unnamed59

struct conf_parser_s.__unnamed55__.__unnamed59__

Definition at line 608 of file cf_parse.h.

Data Fields
conf_parser_t const *	subcs	When CONF_FLAG_SUBSECTION is set, should be a pointer to the start of another array of conf_parser_t structs, forming the subsection.
size_t	subcs_size	If non-zero, allocate structs of this size to hold the parsed data.
char const *	subcs_type	Set a specific talloc type for subcs structures.

Macro Definition Documentation

◆ CF_FILE_CONFIG

#define CF_FILE_CONFIG (1 << 2)

Definition at line 634 of file cf_parse.h.

◆ CF_FILE_ERROR

#define CF_FILE_ERROR (1)

Definition at line 633 of file cf_parse.h.

◆ CF_FILE_MODULE

#define CF_FILE_MODULE (1 << 3)

Definition at line 635 of file cf_parse.h.

◆ CF_FILE_NONE

#define CF_FILE_NONE (0)

Definition at line 632 of file cf_parse.h.

◆ cf_section_rule_push

#define cf_section_rule_push	(	_cs,
		_rule
	)	_cf_section_rule_push(_cs, _rule, __FILE__, __LINE__)

Definition at line 656 of file cf_parse.h.

◆ cf_section_rules_push

#define cf_section_rules_push	(	_cs,
		_rule
	)	_cf_section_rules_push(_cs, _rule, __FILE__, __LINE__)

Definition at line 658 of file cf_parse.h.

◆ CONF_CTYPE_TO_FLAGS

#define CONF_CTYPE_TO_FLAGS ( _ct )

Definition at line 190 of file cf_parse.h.

◆ CONF_PARSER_PARTIAL_TERMINATOR

#define CONF_PARSER_PARTIAL_TERMINATOR

Value:

{ .name1 = NULL, .type = ~(UINT32_MAX - 1), \

.offset = 1, .data = NULL, .dflt = NULL, .quote = T_INVALID }

T_INVALID

@ T_INVALID

Definition: token.h:39

data

static fr_slen_t data

Definition: value.h:1259

Definition at line 629 of file cf_parse.h.

◆ CONF_PARSER_TERMINATOR

#define CONF_PARSER_TERMINATOR

Value:

{ .name1 = NULL, .type = ~(UINT32_MAX - 1), \

.offset = 0, .data = NULL, .dflt = NULL, .quote = T_INVALID }

Definition at line 626 of file cf_parse.h.

◆ FR_CONF_DEPRECATED

#define FR_CONF_DEPRECATED	(	_name,
		_struct,
		_field
	)

Value:

.name1 = _name, \

.flags = CONF_FLAG_DEPRECATED

CONF_FLAG_DEPRECATED

@ CONF_FLAG_DEPRECATED

If a matching CONF_PAIR is found, error out with a deprecated message.

Definition: cf_parse.h:404

conf_parser_t entry which raises an error if a matching CONF_PAIR is found

Parameters

[in]	_name	of pair to search for.
[in]	_struct	where the result was previously written.
[in]	_field	in the struct where the result was previously written.

Definition at line 385 of file cf_parse.h.

◆ FR_CONF_FLAG_CHECK

#define FR_CONF_FLAG_CHECK	(	_type,
		_flags,
		_c_type,
		_ptr_or_offset
	)	_ptr_or_offset

Definition at line 187 of file cf_parse.h.

◆ FR_CONF_FUNC

#define FR_CONF_FUNC	(	_name,
		_type,
		_flags,
		_func,
		_dflt_func
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = (_flags), \
        .func = _func, \
        .dflt_func = _dflt_func

conf_parser_t entry which doesn't fill in a pointer or offset, but relies on functions to record values

Parameters

[in]	_name	name of pair to search for.
[in]	_type	base type to parse pair as.
[in]	_flags	f lags controlling parsing behaviour.
[in]	_func	to use to record value.
[in]	_dflt_func	to use to get defaults from a 3rd party library.

Definition at line 361 of file cf_parse.h.

◆ FR_CONF_OFFSET

#define FR_CONF_OFFSET	(	_name,
		_struct,
		_field
	)

Value:

        FR_CONF_OFFSET_TYPE_FLAGS(_name, \
                                  FR_CTYPE_TO_TYPE((((_struct *)NULL)->_field)), \
                                  CONF_CTYPE_TO_FLAGS((((_struct *)NULL)->_field)),\
                                  _struct, _field)

conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_struct	containing the field to write the result to.
[in]	_field	to write the result to.

Definition at line 268 of file cf_parse.h.

◆ FR_CONF_OFFSET_FLAGS

#define FR_CONF_OFFSET_FLAGS	(	_name,
		_flags,
		_struct,
		_field
	)

Value:

        FR_CONF_OFFSET_TYPE_FLAGS(_name, \
                                  FR_CTYPE_TO_TYPE((((_struct *)NULL)->_field)), \
                                  (_flags) | CONF_CTYPE_TO_FLAGS((((_struct *)NULL)->_field)),\
                                  _struct, _field)

conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct

This variant takes additional flags, and will add CONF_FLAG_MULTI automatically if the field is an array.

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_flags	controlling parsing behaviour.
[in]	_struct	containing the field to write the result to.
[in]	_field	to write the result to.

Definition at line 256 of file cf_parse.h.

◆ FR_CONF_OFFSET_IS_SET

#define FR_CONF_OFFSET_IS_SET	(	_name,
		_type,
		_flags,
		_struct,
		_field
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = CONF_FLAG_IS_SET | (_flags), \
        .offset = FR_CONF_FLAG_CHECK((_type), (_flags), &(((_struct *)NULL)->_field), offsetof(_struct, _field)), \
        .is_set_offset = offsetof(_struct, _field ## _is_set)

conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct, recording if a default was used in <_field>_is_set

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_type	to parse the CONF_PAIR as.
[in]	_flags	controlling parsing behaviour.
[in]	_struct	containing the field to write the result to.
[in]	_field	to write the result to.

Definition at line 282 of file cf_parse.h.

◆ FR_CONF_OFFSET_SUBSECTION

#define FR_CONF_OFFSET_SUBSECTION	(	_name,
		_flags,
		_struct,
		_field,
		_subcs
	)

Value:

        .name1 = _name, \
        .flags = CONF_FLAG_SUBSECTION | (_flags), \
        .offset = offsetof(_struct, _field), \
        .subcs = _subcs

conf_parser_t which populates a sub-struct using a CONF_SECTION

Parameters

[in]	_name	of the CONF_SECTION to search for.
[in]	_flags	controlling parsing behaviour.
[in]	_struct	containing the sub-struct to populate.
[in]	_field	containing the sub-struct to populate.
[in]	_subcs	CONF_SECTION to parse.

Definition at line 297 of file cf_parse.h.

◆ FR_CONF_OFFSET_TYPE_FLAGS

#define FR_CONF_OFFSET_TYPE_FLAGS	(	_name,
		_type,
		_flags,
		_struct,
		_field
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = (_flags), \
        .offset = FR_CONF_FLAG_CHECK((_type), (_flags), &(((_struct *)NULL)->_field), offsetof(_struct, _field))

conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct

This variant takes output type and flags manually, instead of determining them automatically.

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_type	to parse the CONF_PAIR as.
[in]	_flags	controlling parsing behaviour.
[in]	_struct	containing the field to write the result to.
[in]	_field	to write the result to.

Definition at line 241 of file cf_parse.h.

◆ FR_CONF_POINTER

#define FR_CONF_POINTER	(	_name,
		_type,
		_flags,
		_res_p
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = (_flags), \
        .data = FR_CONF_FLAG_CHECK((_type), (_flags), (_res_p), _res_p)

conf_parser_t which parses a single CONF_PAIR producing a single global result

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_type	to parse the CONF_PAIR as.
[in]	_flags	controlling parsing behaviour.
[out]	_res_p	pointer to a global var, where the result will be written.

Definition at line 310 of file cf_parse.h.

◆ FR_CONF_POINTER_IS_SET

#define FR_CONF_POINTER_IS_SET	(	_name,
		_type,
		_flags,
		_res_p
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = CONF_FLAG_IS_SET | (_flags), \
        .data = FR_CONF_FLAG_CHECK((_type), (_flags), (_res_p), _res_p), \
        .is_set_ptr = _res_p ## _is_set

conf_parser_t which parses a single CONF_PAIR producing a single global result, recording if a default was used in <_res_p>_is_set

Note: is set state is recorded in variable <_res_p>_is_set.

Parameters

[in]	_name	of the CONF_PAIR to search for.
[in]	_type	to parse the CONF_PAIR as.
[in]	_flags	controlling parsing behaviour.
[out]	_res_p	pointer to a global var, where the result will be written.

Definition at line 325 of file cf_parse.h.

◆ FR_CONF_SUBSECTION_ALLOC

#define FR_CONF_SUBSECTION_ALLOC	(	_name,
		_type,
		_flags,
		_struct,
		_field,
		_subcs
	)

Value:

        .name1 = _name, \
        .type = (_type), \
        .flags = (_flags), \
        .offset = FR_CONF_FLAG_CHECK((_type), (_flags), &(((_struct *)NULL)->_field), offsetof(_struct, _field)), \
        .subcs = _subcs, \
        .subcs_size = sizeof(**(((_struct *)0)->_field))

A conf_parser_t multi-subsection.

Parse multiple instance of a subsection, allocating an array of structs to hold the result.

Parameters

[in]	_name	name of subsection to search for.
[in]	_type	the output type.
[in]	_flags	flags controlling parsing behaviour.
[in]	_struct	instance data struct.
[in]	_field	field in instance data struct.
[in]	_subcs	conf_parser_t array to use to parse subsection data.

Definition at line 345 of file cf_parse.h.

◆ FR_CONF_SUBSECTION_GLOBAL

#define FR_CONF_SUBSECTION_GLOBAL	(	_name,
		_flags,
		_subcs
	)

Value:

        .name1 = _name, \
        .flags = CONF_FLAG_SUBSECTION | (_flags), \
        .subcs = _subcs

conf_parser_t entry which runs conf_parser_t entries for a subsection without any output

Parameters

[in]	_name	of pair to search for.
[in]	_flags	flags controlling parsing behaviour.
[in]	_subcs	to use to get defaults from a 3rd party library.

Definition at line 374 of file cf_parse.h.

◆ FR_INTEGER_BOUND_CHECK

#define FR_INTEGER_BOUND_CHECK	(	_name,
		_var,
		_op,
		_bound
	)	FR_INTEGER_COND_CHECK(_name, _var, (_var _op _bound), _bound)

Definition at line 486 of file cf_parse.h.

◆ FR_INTEGER_COND_CHECK

#define FR_INTEGER_COND_CHECK	(	_name,
		_var,
		_cond,
		_new
	)

Value:

do {\
        if (!(_cond)) {\
                WARN("Ignoring \"" _name " = %i\", forcing to \"" _name " = %i\"", _var, _new);\
                _var = _new;\
        }\
} while (0)

Definition at line 478 of file cf_parse.h.

◆ FR_ITEM_POINTER

#define FR_ITEM_POINTER	(	_type,
		_res_p
	)	_type, FR_CONF_FLAG_CHECK((_type), 0, (_res_p), _res_p)

Definition at line 331 of file cf_parse.h.

◆ fr_rule_deprecated

#define fr_rule_deprecated ( _rule ) ((_rule)->flags & CONF_FLAG_DEPRECATED)

Definition at line 438 of file cf_parse.h.

◆ fr_rule_dflt

#define fr_rule_dflt ( _rule ) ((_rule)->dflt || (_rule)->dflt_func)

Definition at line 459 of file cf_parse.h.

◆ fr_rule_file_exists

#define fr_rule_file_exists ( _rule ) ((_rule)->flags & CONF_FLAG_FILE_EXISTS)

Definition at line 457 of file cf_parse.h.

◆ fr_rule_file_input

#define fr_rule_file_input ( _rule ) ((_rule)->flags & CONF_FLAG_FILE_INPUT)

Definition at line 444 of file cf_parse.h.

◆ fr_rule_file_output

#define fr_rule_file_output ( _rule ) ((_rule)->flags & CONF_FLAG_FILE_OUTPUT)

Definition at line 446 of file cf_parse.h.

◆ fr_rule_is_attribute

#define fr_rule_is_attribute ( _rule ) ((_rule)->flags & CONF_FLAG_ATTRIBUTE)

Definition at line 461 of file cf_parse.h.

◆ fr_rule_is_set

#define fr_rule_is_set ( _rule ) ((_rule)->flags & CONF_FLAG_IS_SET)

Definition at line 453 of file cf_parse.h.

◆ fr_rule_is_tmpl

#define fr_rule_is_tmpl ( _rule ) ((_rule)->flags & CONF_FLAG_TMPL)

Definition at line 465 of file cf_parse.h.

◆ fr_rule_is_xlat

#define fr_rule_is_xlat ( _rule ) ((_rule)->flags & CONF_FLAG_XLAT)

Definition at line 463 of file cf_parse.h.

◆ fr_rule_multi

#define fr_rule_multi ( _rule ) ((_rule)->flags & CONF_FLAG_MULTI)

Definition at line 449 of file cf_parse.h.

◆ fr_rule_not_empty

#define fr_rule_not_empty ( _rule ) ((_rule)->flags & CONF_FLAG_NOT_EMPTY)

Definition at line 451 of file cf_parse.h.

◆ fr_rule_ok_missing

#define fr_rule_ok_missing ( _rule ) ((_rule)->flags & CONF_FLAG_OK_MISSING)

Definition at line 455 of file cf_parse.h.

◆ fr_rule_required

#define fr_rule_required ( _rule ) ((_rule)->flags & CONF_FLAG_REQUIRED)

Definition at line 440 of file cf_parse.h.

◆ fr_rule_secret

#define fr_rule_secret ( _rule ) ((_rule)->flags & CONF_FLAG_SECRET)

Definition at line 442 of file cf_parse.h.

◆ FR_SIZE_BOUND_CHECK

#define FR_SIZE_BOUND_CHECK	(	_name,
		_var,
		_op,
		_bound
	)	FR_SIZE_COND_CHECK(_name, _var, (_var _op _bound), _bound)

Definition at line 476 of file cf_parse.h.

◆ FR_SIZE_COND_CHECK

#define FR_SIZE_COND_CHECK	(	_name,
		_var,
		_cond,
		_new
	)

Value:

do {\
        if (!(_cond)) {\
                WARN("Ignoring \"" _name " = %zu\", forcing to \"" _name " = %zu\"", _var, _new);\
                _var = _new;\
        }\
} while (0)

Definition at line 468 of file cf_parse.h.

◆ FR_TIME_DELTA_BOUND_CHECK

#define FR_TIME_DELTA_BOUND_CHECK	(	_name,
		_var,
		_op,
		_bound
	)

Value:

do {\
        if (!fr_time_delta_cond(_var, _op, _bound)) { \
                WARN("Ignoring \"" _name " = %pV\", forcing to \"" _name " = %pV\"",\
                     fr_box_time_delta(_var),\
                     fr_box_time_delta(_bound));\
                _var = _bound;\
        }\
} while (0)

Definition at line 497 of file cf_parse.h.

◆ FR_TIME_DELTA_COND_CHECK

#define FR_TIME_DELTA_COND_CHECK	(	_name,
		_var,
		_cond,
		_new
	)

Value:

do {\
        if (!(_cond)) {\
                WARN("Ignoring \"" _name " = %pV\", forcing to \"" _name " = %pV\"", \
                     fr_box_time_delta(_var), fr_box_time_delta(_new));\
                _var = _new;\
        }\
} while (0)

Definition at line 488 of file cf_parse.h.

Typedef Documentation

◆ cf_dflt_t

typedef int(* cf_dflt_t) (CONF_PAIR **out, void *parent, CONF_SECTION *cs, fr_token_t quote, conf_parser_t const *rule)

Callback for producing dynamic defaults from 3rd party libraries.

Parameters

[out]	out	Where to write default conf pair.
[in]	parent	being populated.
[in]	cs	to allocate pair in.
[in]	quote	to use when allocing the pair. Provided as a convenience.
[in]	rule	to produce default for.

Returns

0 on success.
-1 on failure.

Definition at line 533 of file cf_parse.h.

◆ cf_parse_t

typedef int(* cf_parse_t) (TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)

Callback for performing custom parsing of a CONF_SECTION or CONF_PAIR.

Parameters

[in]	ctx	to allocate any data in.
[out]	out	Where to write the result of parsing.
[in]	parent	The base address of the structure.
[in]	ci	The CONF_SECTION or CONF_PAIR to parse.
[in]	rule	Parse rules - How the CONF_PAIR or CONF_SECTION should be converted.

Returns

0 on success.
-1 on failure.

Definition at line 520 of file cf_parse.h.

◆ conf_parser_t

typedef struct conf_parser_s conf_parser_t

Definition at line 1 of file cf_parse.h.

Enumeration Type Documentation

◆ conf_parser_flags_t

enum conf_parser_flags_t

Enumerator
CONF_FLAG_HIDDEN	Used by scripts to omit items from the generated documentation.
CONF_FLAG_SUBSECTION	Instead of putting the information into a configuration structure, the configuration file routines MAY just parse it directly into user-supplied variables.
CONF_FLAG_DEPRECATED	If a matching CONF_PAIR is found, error out with a deprecated message.
CONF_FLAG_REQUIRED	Error out if no matching CONF_PAIR is found, and no dflt value is set.
CONF_FLAG_ATTRIBUTE	Value must resolve to attribute in dict (deprecated, use CONF_FLAG_TMPL).
CONF_FLAG_SECRET	Only print value if debug level >= 3.
CONF_FLAG_FILE_INPUT	File matching value must exist, and must be readable.
CONF_FLAG_FILE_OUTPUT	File matching value must exist, and must be writable.
CONF_FLAG_XLAT	string will be dynamically expanded.
CONF_FLAG_TMPL	CONF_PAIR should be parsed as a template.
CONF_FLAG_MULTI	CONF_PAIR can have multiple copies.
CONF_FLAG_NOT_EMPTY	CONF_PAIR is required to have a non zero length value.
CONF_FLAG_FILE_EXISTS	File matching value must exist.
CONF_FLAG_IS_SET	Write whether this config item was left as the default to is_set_offset or is_set_ptr.
CONF_FLAG_OK_MISSING	OK if it's missing.

Definition at line 397 of file cf_parse.h.

Function Documentation

◆ _cf_section_rule_push()

int _cf_section_rule_push	(	CONF_SECTION *	cs,
		conf_parser_t const *	rule,
		char const *	filename,
		int	lineno
	)

Add a single rule to a CONF_SECTION.

Parameters

[in]	cs	to add rules to.
[in]	rule	to add.
[in]	filename	where the rule was pushed.
[in]	lineno	where the rule was pushed.

Returns

0 on success.
-1 if the rules added conflict.

Definition at line 1351 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_section_rules_push()

int _cf_section_rules_push	(	CONF_SECTION *	cs,
		conf_parser_t const *	rules,
		char const *	filename,
		int	lineno
	)

Add an array of parse rules to a CONF_SECTION.

Parameters

[in]	cs	to add rules to.
[in]	rules	to add. Last element should have NULL name field.
[in]	filename	where the rule was pushed.
[in]	lineno	where the rule was pushed.

Returns

0 on success.
-1 on failure.

Definition at line 1448 of file cf_parse.c.

Here is the call graph for this function:

◆ cf_pair_debug()

void cf_pair_debug	(	CONF_SECTION const *	cs,
		CONF_PAIR *	cp,
		conf_parser_t const *	rule
	)

Definition at line 49 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_parse()

int cf_pair_parse	(	TALLOC_CTX *	ctx,
		CONF_SECTION *	cs,
		char const *	name,
		unsigned int	type,
		void *	data,
		char const *	dflt,
		fr_token_t	dflt_quote
	)

Parses a CONF_PAIR into a C data type, with a default value.

Takes fields from a conf_parser_t struct and uses them to parse the string value of a CONF_PAIR into a C data type matching the type argument.

The format of the types are the same as fr_value_box_t types.

Note: The dflt value will only be used if no matching CONF_PAIR is found. Empty strings will not result in the dflt value being used.

fr_type_t to data type mappings

fr_type_t	Data type	Dynamically allocated
FR_TYPE_BOOL	`bool`	No
FR_TYPE_UINT32	`uint32_t`	No
FR_TYPE_UINT16	`uint16_t`	No
FR_TYPE_UINT64	`uint64_t`	No
FR_TYPE_INT32	`int32_t`	No
FR_TYPE_STRING	`char const *`	Yes
FR_TYPE_IPV4_ADDR	`fr_ipaddr_t`	No
FR_TYPE_IPV4_PREFIX	`fr_ipaddr_t`	No
FR_TYPE_IPV6_ADDR	`fr_ipaddr_t`	No
FR_TYPE_IPV6_PREFIX	`fr_ipaddr_t`	No
FR_TYPE_COMBO_IP_ADDR	`fr_ipaddr_t`	No
FR_TYPE_COMBO_IP_PREFIX	`fr_ipaddr_t`	No
FR_TYPE_TIME_DELTA	`fr_time_delta_t`	No

Parameters

[in]	ctx	To allocate arrays and values in.
[in]	cs	to search for matching CONF_PAIR in.
[in]	name	of CONF_PAIR to search for.
[in]	type	Data type to parse CONF_PAIR value as. Should be one of the following `data` types, and one or more of the following `flag` types or'd together:

data FR_TYPE_BOOL - A truth value.
data FR_TYPE_UINT32 - 32 Bit unsigned integer.
data FR_TYPE_UINT16 - 16 Bit unsigned integer.
data FR_TYPE_UINT64 - 64 Bit unsigned integer.
data FR_TYPE_INT32 - 32 Bit signed integer.
data FR_TYPE_STRING - String of printable characters.
data FR_TYPE_IPV4_ADDR - 32 Bit IPv4 Address. (IPv4 address with prefix 32).
data FR_TYPE_IPV4_PREFIX - IPv4 Prefix. (IPv4 address with variable prefix).
data FR_TYPE_IPV6_ADDR - 128 Bit IPv6 Address. (IPv6 address with prefix 128).
data FR_TYPE_IPV6_PREFIX - IPv6 Prefix. (IPv6 address with variable prefix).
data FR_TYPE_COMBO_IP_ADDR - IPv4 or IPv6 address depending on length. (IPv4/IPv6 address with prefix 32/128).
data FR_TYPE_COMBO_IP_PREFIX - IPv4 or IPv6 address prefix depending on length. (IPv4/IPv6 address with variable prefix).
data FR_TYPE_TIME_DELTA - A period of time measured in nanoseconds.
flag CONF_FLAG_TMPL - CONF_PAIR should be parsed as a template. Feeds the value into tmpl_afrom_substr. Value can be obtained when processing requests, with tmpl_expand or tmpl_aexpand.
flag #FR_TYPE_DEPRECATED -
flag CONF_FLAG_REQUIRED - Error out if no matching CONF_PAIR is found, and no dflt value is set.
flag CONF_FLAG_ATTRIBUTE - Value must resolve to attribute in dict (deprecated, use CONF_FLAG_TMPL).
flag CONF_FLAG_SECRET - Only print value if debug level >= 3.
flag CONF_FLAG_FILE_INPUT - File matching value must exist, and must be readable.
flag CONF_FLAG_FILE_OUTPUT - File matching value must exist, and must be writable.
flag CONF_FLAG_NOT_EMPTY - CONF_PAIR is required to have a non zero length value.
flag CONF_FLAG_MULTI - CONF_PAIR can have multiple copies.

flag CONF_FLAG_IS_SET - Write whether this config item was left as the default to is_set_offset or is_set_ptr.

Parameters

[out]	data	Pointer to a global variable, or pointer to a field in the struct being populated with values.
[in]	dflt	value to use, if no CONF_PAIR is found.
[in]	dflt_quote	around the dflt value.

Returns

1 if default value was used, or if there was no CONF_PAIR or dflt.
0 on success.
-1 on error.
-2 if deprecated.

Definition at line 700 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_parse_value()

int cf_pair_parse_value	(	TALLOC_CTX *	ctx,
		void *	out,
		void *	base,
		CONF_ITEM *	ci,
		conf_parser_t const *	rule
	)

◆ cf_pair_to_value_box()

int cf_pair_to_value_box	(	TALLOC_CTX *	ctx,
		fr_value_box_t *	out,
		CONF_PAIR *	cp,
		conf_parser_t const *	rule
	)

Parses a CONF_PAIR into a boxed value.

Return the value of a CONF_PAIR.

See also: cf_pair_value

Parameters

[in]	ctx	to allocate any dynamic buffers in.
[out]	out	Where to write the parsed value.
[in]	cp	to parse.
[in]	rule	to parse to. May contain flags.

Returns

0 on success.
-1 on failure.

Definition at line 126 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_parse_gid()

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

◆ cf_parse_uid()

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

◆ cf_section_parse()

int cf_section_parse	(	TALLOC_CTX *	ctx,
		void *	base,
		CONF_SECTION *	cs
	)

Parse a configuration section into user-supplied variables.

Parameters

[in]	ctx	to allocate any strings, or additional structures in. Usually the same as base, unless base is a nested struct.
[out]	base	pointer to a struct to fill with data.
[in]	cs	to parse.

Returns

0 on success.
-1 on general error.
-2 if a deprecated CONF_ITEM was found.

Definition at line 985 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_parse_pass2()

int cf_section_parse_pass2	(	void *	base,
		CONF_SECTION *	cs
	)

Fixup xlat expansions and attributes.

Parameters

[out]	base	start of structure to write tmpl_t s to.
[in]	cs	CONF_SECTION to fixup.

Returns

0 on success.
-1 on failure (parse errors etc...).

Definition at line 1163 of file cf_parse.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_table_parse_int()

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

Generic function for parsing conf pair values as int.

Note: This should be used for enum types as c99 6.4.4.3 states that the enumeration constants are of type int.

Definition at line 1474 of file cf_parse.c.

Here is the call graph for this function:

◆ cf_table_parse_int32()

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

Generic function for parsing conf pair values as int32_t (FR_TYPE_INT32)

Definition at line 1490 of file cf_parse.c.

Here is the call graph for this function:

◆ cf_table_parse_uint32()

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

Generic function for parsing conf pair values as int32_t (FR_TYPE_UINT32)

Definition at line 1506 of file cf_parse.c.

Here is the call graph for this function:

Variable Documentation

◆ check_config

bool check_config

extern

Definition at line 66 of file cf_file.c.

Data Structures

Macros

Typedefs

Functions

Variables

#conf_parser_t flags checks

#conf_parser_t type flags

Detailed Description

Data Structure Documentation

◆ cf_table_parse_ctx_t

◆ conf_parser_s

◆ conf_parser_s.__unnamed53__

◆ conf_parser_s.__unnamed55__

◆ conf_parser_s.__unnamed55__.__unnamed57__

◆ conf_parser_s.__unnamed55__.__unnamed59__

Macro Definition Documentation

◆ CF_FILE_CONFIG

◆ CF_FILE_ERROR

◆ CF_FILE_MODULE

◆ CF_FILE_NONE

◆ cf_section_rule_push

◆ cf_section_rules_push

◆ CONF_CTYPE_TO_FLAGS

◆ CONF_PARSER_PARTIAL_TERMINATOR

◆ CONF_PARSER_TERMINATOR

◆ FR_CONF_DEPRECATED

◆ FR_CONF_FLAG_CHECK

◆ FR_CONF_FUNC

◆ FR_CONF_OFFSET

◆ FR_CONF_OFFSET_FLAGS

◆ FR_CONF_OFFSET_IS_SET

◆ FR_CONF_OFFSET_SUBSECTION

◆ FR_CONF_OFFSET_TYPE_FLAGS

◆ FR_CONF_POINTER

◆ FR_CONF_POINTER_IS_SET

◆ FR_CONF_SUBSECTION_ALLOC

◆ FR_CONF_SUBSECTION_GLOBAL

◆ FR_INTEGER_BOUND_CHECK

◆ FR_INTEGER_COND_CHECK

◆ FR_ITEM_POINTER

◆ fr_rule_deprecated

◆ fr_rule_dflt

◆ fr_rule_file_exists

◆ fr_rule_file_input

◆ fr_rule_file_output

◆ fr_rule_is_attribute

◆ fr_rule_is_set

◆ fr_rule_is_tmpl

◆ fr_rule_is_xlat

◆ fr_rule_multi

◆ fr_rule_not_empty

◆ fr_rule_ok_missing

◆ fr_rule_required

◆ fr_rule_secret

◆ FR_SIZE_BOUND_CHECK

◆ FR_SIZE_COND_CHECK

◆ FR_TIME_DELTA_BOUND_CHECK

◆ FR_TIME_DELTA_COND_CHECK

Typedef Documentation

◆ cf_dflt_t

◆ cf_parse_t

◆ conf_parser_t

Enumeration Type Documentation

◆ conf_parser_flags_t

Function Documentation

◆ _cf_section_rule_push()

◆ _cf_section_rules_push()

◆ cf_pair_debug()

◆ cf_pair_parse()

◆ cf_pair_parse_value()

◆ cf_pair_to_value_box()

◆ cf_parse_gid()

◆ cf_parse_uid()

◆ cf_section_parse()

◆ cf_section_parse_pass2()

◆ cf_table_parse_int()

◆ cf_table_parse_int32()

◆ cf_table_parse_uint32()

Variable Documentation

◆ check_config

◆ conf_parser_s.unnamed53

◆ conf_parser_s.unnamed55

◆ conf_parser_s.unnamed55.unnamed57

◆ conf_parser_s.unnamed55.unnamed59