Declarations for functions that parse and manipulate virtual server sections. More...

#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/server/cf_parse.h>
#include <freeradius-devel/unlang/module.h>
#include <freeradius-devel/util/dict.h>

Include dependency graph for virtual_servers.h:

Go to the source code of this file.

Data Structures
struct	virtual_server_compile_t
	Processing sections which are allowed in this virtual server. More...

struct	virtual_server_method_t
	Module methods which are allowed in virtual servers. More...

Macros
#define	COMPILE_TERMINATOR { .name = NULL, .name2 = NULL }

Functions
fr_listen_t *	listen_find_any (fr_listen_t *li)
	See if another global listener is using a particular IP / port. More...

bool	listen_record (fr_listen_t *li)
	Record that we're listening on a particular IP / port. More...

int	virtual_server_compile_sections (CONF_SECTION server, virtual_server_compile_t const list, tmpl_rules_t const rules, void instance))
	Compile sections for a virtual server. More...

unlang_action_t	virtual_server_push (request_t request, CONF_SECTION server_cs, bool top_frame)
	Set the request processing function. More...

virtual_server_method_t const *	virtual_server_section_methods (char const name1, char const name2))
	Find the component for a section. More...

int	virtual_server_section_register (virtual_server_compile_t const *entry)
	Register name1 / name2 as allowed processing sections. More...

Variables
const conf_parser_t	virtual_servers_config []

const conf_parser_t	virtual_servers_on_read_config []

Namespace management
fr_dict_t const *	virtual_server_dict_by_child_ci (CONF_ITEM const *ci)
	Return the namespace for a given virtual server specified by a CONF_ITEM within the virtual server. More...

fr_dict_t const *	virtual_server_dict_by_cs (CONF_SECTION const *server_cs)
	Return the namespace for the virtual server specified by a config section. More...

fr_dict_t const *	virtual_server_dict_by_name (char const *virtual_server)
	Return the namespace for the named virtual server. More...

int	virtual_server_has_namespace (CONF_SECTION *out, char const virtual_server, fr_dict_t const namespace, CONF_ITEM ci))
	Verify that a given virtual_server exists and is of a particular namespace. More...

Lookup and namespace management
CONF_SECTION *	virtual_server_by_child (CONF_SECTION *section)
	Find a virtual server using one of its sections. More...

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

CONF_SECTION *	virtual_server_find (char const *name)
	Return virtual server matching the specified name. More...

Parsing, bootstrap and instantiation
int	virtual_server_section_attribute_define (CONF_SECTION server_cs, char const subcs_name, fr_dict_attr_t const *da)
	Define a values for Auth-Type attributes by the sections present in a virtual-server. More...

int	virtual_servers_bootstrap (CONF_SECTION *config)
	Load protocol modules and call their bootstrap methods. More...

int	virtual_servers_free (void)

int	virtual_servers_init (void)
	Performs global initialisation for the virtual server code. More...

int	virtual_servers_instantiate (void)
	Instantiate all the virtual servers. More...

int	virtual_servers_open (fr_schedule_t *sc)
	Open all the listen sockets. More...

void	virtual_servers_thread_detach (void)
	Free thread-specific data for all process modules and listeners. More...

int	virtual_servers_thread_instantiate (TALLOC_CTX ctx, fr_event_list_t el)
	Perform thread instantiation for all process modules and listeners. More...

Detailed Description

Declarations for functions that parse and manipulate virtual server sections.

Id: 7a1cc2d0d5e573daf433a33bee745fd9cf5f9039

Copyright: 2019 The FreeRADIUS server project

Definition in file virtual_servers.h.

Data Structure Documentation

◆ virtual_server_compile_t

struct virtual_server_compile_t

Processing sections which are allowed in this virtual server.

Definition at line 81 of file virtual_servers.h.

Collaboration diagram for virtual_server_compile_t:

Data Fields
rlm_components_t	component	Sets the default list of actions for this section.
bool	dont_cache	If true, the CONF_SECTION pointer won't be written and the offset will be ignored.
size_t	instruction	where the instruction pointer is written
virtual_server_method_t const *	methods	list of module methods which are allowed in this section
char const *	name	Name of the processing section, such as "recv" or "send".
char const *	name2	Second name, such as "Access-Request".
size_t	offset	where the CONF_SECTION pointer is written

◆ virtual_server_method_t

struct virtual_server_method_t

Module methods which are allowed in virtual servers.

Definition at line 73 of file virtual_servers.h.

Data Fields
char const *	name	module method name1 which is allowed in this section
char const *	name2	module method name2 which is allowed in this section

Macro Definition Documentation

◆ COMPILE_TERMINATOR

#define COMPILE_TERMINATOR { .name = NULL, .name2 = NULL }

Definition at line 92 of file virtual_servers.h.

Function Documentation

◆ listen_find_any()

fr_listen_t* listen_find_any ( fr_listen_t * li )

See if another global listener is using a particular IP / port.

Definition at line 735 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listen_record()

bool listen_record ( fr_listen_t * li )

Record that we're listening on a particular IP / port.

Definition at line 746 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_by_child()

CONF_SECTION* virtual_server_by_child ( CONF_SECTION * section )

Find a virtual server using one of its sections.

Parameters

[in] section to find parent virtual server for.

Returns

The virtual server section on success.
NULL if the child isn't associated with any virtual server section.

Definition at line 778 of file virtual_servers.c.

Here is the call graph for this function:

◆ virtual_server_cf_parse()

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

◆ virtual_server_compile_sections()

int virtual_server_compile_sections	(	CONF_SECTION *	server,
		virtual_server_compile_t const *	list,
		tmpl_rules_t const *	rules,
		void *	instance
	)

Compile sections for a virtual server.

When the "proto_foo" module calls fr_app_process_instantiate(), it loads the compile list from the fr_app_worker_t, and calls this function.

This function walks down the registration table, compiling each named section.

Parameters

[in]	server	to search for sections in.
[in]	list	of sections to compiler.
[in]	rules	to apply for pass1.
[in]	instance	module instance data. The offset value in the rules array will be added to this to determine where to write pointers to the various CONF_SECTIONs.

Definition at line 819 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_dict_by_child_ci()

fr_dict_t const* virtual_server_dict_by_child_ci ( CONF_ITEM const * ci )

Return the namespace for a given virtual server specified by a CONF_ITEM within the virtual server.

Parameters

[in] ci to look for namespace in.

Returns

NULL on error.
Namespace on success.

Definition at line 538 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_dict_by_cs()

fr_dict_t const* virtual_server_dict_by_cs ( CONF_SECTION const * server_cs )

Return the namespace for the virtual server specified by a config section.

Parameters

[in] server_cs to look for namespace in.

Returns

NULL on error.
Namespace on success.

Definition at line 517 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_dict_by_name()

fr_dict_t const* virtual_server_dict_by_name ( char const * virtual_server )

Return the namespace for the named virtual server.

Parameters

[in] virtual_server to look for namespace in.

Returns

NULL on error.
Namespace on success.

Definition at line 500 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_find()

CONF_SECTION* virtual_server_find ( char const * name )

Return virtual server matching the specified name.

Note: May be called in bootstrap or instantiate as all servers should be present.

Parameters

[in] name of virtual server.

Returns

NULL if no virtual server was found.
The CONF_SECTION of the named virtual server.

Definition at line 766 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_has_namespace()

int virtual_server_has_namespace	(	CONF_SECTION **	out,
		char const *	virtual_server,
		fr_dict_t const *	namespace,
		CONF_ITEM *	ci
	)

Verify that a given virtual_server exists and is of a particular namespace.

Mostly used by modules to check virtual servers specified by their configs.

Parameters

[out]	out	we found. May be NULL if just checking for existence.
[in]	virtual_server	to check.
[in]	namespace	the virtual server must belong to.
[in]	ci	to log errors against. May be NULL if caller doesn't want errors logged.

Returns

0 on success.
-1 if no virtual server could be found.
-2 if virtual server is not of the correct namespace.

Definition at line 566 of file virtual_servers.c.

Here is the call graph for this function:

◆ virtual_server_push()

unlang_action_t virtual_server_push	(	request_t *	request,
		CONF_SECTION *	server_cs,
		bool	top_frame
	)

Set the request processing function.

Short-term hack

Definition at line 606 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_section_attribute_define()

int virtual_server_section_attribute_define	(	CONF_SECTION *	server_cs,
		char const *	subcs_name,
		fr_dict_attr_t const *	da
	)

Define a values for Auth-Type attributes by the sections present in a virtual-server.

The.name2 value of any sections found will be converted into values of the specified da.

Parameters

[in]	server_cs	The virtual server containing the sections.
[in]	subcs_name	of the subsection to search for.
[in]	da	to add enumeration values for.

Returns

0 all values added successfully.
-1 an error occurred.

Definition at line 1042 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_section_methods()

virtual_server_method_t const* virtual_server_section_methods	(	char const *	name1,
		char const *	name2
	)

Find the component for a section.

Definition at line 999 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_server_section_register()

int virtual_server_section_register ( virtual_server_compile_t const * entry )

Register name1 / name2 as allowed processing sections.

This function is called from the virtual server bootstrap routine, which happens before module_bootstrap();

Definition at line 952 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_bootstrap()

int virtual_servers_bootstrap ( CONF_SECTION * config )

Load protocol modules and call their bootstrap methods.

Parameters

[in] config section containing the virtual servers to bootstrap.

Returns

0 on success.
-1 on failure.

Definition at line 1530 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_free()

int virtual_servers_free ( void )

Definition at line 1545 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_init()

int virtual_servers_init ( void )

Performs global initialisation for the virtual server code.

This has to be done separately and explicitly, because the above code makes use of "onread" callbacks.

Will automatically free module lists on exit, but all modules should have been removed from this list by the point that happens.

Definition at line 1573 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_instantiate()

int virtual_servers_instantiate ( void )

Instantiate all the virtual servers.

Returns

0 on success.
-1 on failure.

Definition at line 1401 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_open()

int virtual_servers_open ( fr_schedule_t * sc )

Open all the listen sockets.

Parameters

[in] sc Scheduler to add I/O paths to.

Returns

0 on success.
-1 on failure.

Definition at line 1319 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_thread_detach()

void virtual_servers_thread_detach ( void )

Free thread-specific data for all process modules and listeners.

Definition at line 1376 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virtual_servers_thread_instantiate()

int virtual_servers_thread_instantiate	(	TALLOC_CTX *	ctx,
		fr_event_list_t *	el
	)

Perform thread instantiation for all process modules and listeners.

Definition at line 1385 of file virtual_servers.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ virtual_servers_config

const conf_parser_t virtual_servers_config[]

extern

Definition at line 152 of file virtual_servers.c.

◆ virtual_servers_on_read_config

const conf_parser_t virtual_servers_on_read_config[]

extern

Definition at line 126 of file virtual_servers.c.

Data Structures

Macros

Functions

Variables

Namespace management

Lookup and namespace management

Parsing, bootstrap and instantiation

Detailed Description

Data Structure Documentation

◆ virtual_server_compile_t

◆ virtual_server_method_t

Macro Definition Documentation

◆ COMPILE_TERMINATOR

Function Documentation

◆ listen_find_any()

◆ listen_record()

◆ virtual_server_by_child()

◆ virtual_server_cf_parse()

◆ virtual_server_compile_sections()

◆ virtual_server_dict_by_child_ci()

◆ virtual_server_dict_by_cs()

◆ virtual_server_dict_by_name()

◆ virtual_server_find()

◆ virtual_server_has_namespace()

◆ virtual_server_push()

◆ virtual_server_section_attribute_define()

◆ virtual_server_section_methods()

◆ virtual_server_section_register()

◆ virtual_servers_bootstrap()

◆ virtual_servers_free()

◆ virtual_servers_init()

◆ virtual_servers_instantiate()

◆ virtual_servers_open()

◆ virtual_servers_thread_detach()

◆ virtual_servers_thread_instantiate()

Variable Documentation

◆ virtual_servers_config

◆ virtual_servers_on_read_config