virtual_servers.h

Go to the documentation of this file.

#pragma once
/*
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/**
 * $Id: 11f219b11058a672e94830f4e15dae24bb59eed5 $
 *
 * @file src/lib/server/virtual_servers.h
 * @brief Declarations for functions that parse and manipulate virtual server sections.
 *
 * @copyright 2019 The FreeRADIUS server project
 */
 
#include <freeradius-devel/server/virtual_servers.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct virtual_server_s virtual_server_t;
typedef struct virtual_server_compile_s virtual_server_compile_t;
 
#include <freeradius-devel/io/schedule.h>
#include <freeradius-devel/server/cf_parse.h>
#include <freeradius-devel/unlang/module.h>
#include <freeradius-devel/unlang/mod_action.h>
#include <freeradius-devel/util/dict.h>
 
extern const conf_parser_t virtual_servers_config[];
extern const conf_parser_t virtual_servers_on_read_config[];
 
/** @name Debug functions
 * @{
 */
void            virtual_server_listen_debug(void);
 
void            virtual_server_process_debug(void);
/** @} */
 
/** @name Resolution functions
 * @{
 */
module_instance_t *virtual_server_listener_by_data(void const *data);
/** @} */
 
/** @name Callbacks for dealing with transports
 *
 * @{
 */
int virtual_server_listen_transport_parse(TALLOC_CTX *ctx, void *out, void *parent,
                                         CONF_ITEM *ci, conf_parser_t const *rule);
/** @} */
 
/** @name Namespace management
 *
 * @{
 */
fr_dict_t const *virtual_server_dict_by_name(char const *virtual_server) CC_HINT(nonnull);
 
fr_dict_t const *virtual_server_dict_by_cs(CONF_SECTION const *server_cs) CC_HINT(nonnull);
 
fr_dict_t const *virtual_server_dict_by_child_ci(CONF_ITEM const *ci) CC_HINT(nonnull);
 
int             virtual_server_has_namespace(CONF_SECTION **out,
                                             char const *virtual_server, fr_dict_t const *namespace,
                                             CONF_ITEM *ci) CC_HINT(nonnull(2,3));
/** @} */
 
/** @name Lookup and namespace management
 *
 * @{
 */
CONF_SECTION            *virtual_server_cs(virtual_server_t const *vs) CC_HINT(nonnull);
 
virtual_server_t const  *virtual_server_from_cs(CONF_SECTION *server_cs);
 
virtual_server_t const  *virtual_server_find(char const *name) CC_HINT(nonnull);
 
virtual_server_t const  *virtual_server_by_child(CONF_ITEM const *ci) CC_HINT(nonnull);
 
/** Additional validation rules for virtual server lookup
 *
 * This is used to ensure that the virtual server we find matches
 * the requirements of the caller.
 *
 * This should be passed in the rule calling this function:
 @code{.c}
 { FR_CONF_OFFSET_TYPE_FLAGS("virtual_server", FR_TYPE_VOID, 0, module_conf_t, virtual_server),
                             .func = virtual_server_cf_parse,
                             .uctx = &(virtual_server_cf_parse_uctx_t){ .process_module_name = "eap_aka"} },
 @endcode
 *
 * @note process_module_name is the name field in the exported symbol of the module.
 *
 * The double dereference is to work around compile time constant issues.
 */
typedef struct {
        char const              *process_module_name;           //!< Virtual server we find must use this
                                                                ///< this process module.  This is a string
                                                                ///< identifier as the process modules are
                                                                ///< often not loaded at the same time as the modules
                                                                ///< and this makes ordering issues easier to deal with.
                                                                ///< Ignored if NULL.
 
        fr_dict_t               **required_dict;                //!< Virtual server we find must have this
                                                                ///< dictionary.  Ignored if NULL
} virtual_server_cf_parse_uctx_t;
 
int                     virtual_server_cf_parse(TALLOC_CTX *ctx, void *out, void *parent,
                                                CONF_ITEM *ci, conf_parser_t const *rule) CC_HINT(nonnull(2,4));
/** @} */
 
fr_listen_t *           listen_find_any(fr_listen_t *li) CC_HINT(nonnull);
bool                    listen_record(fr_listen_t *li) CC_HINT(nonnull);
 
/** Processing sections which are allowed in this virtual server.
 *
 */
struct virtual_server_compile_s {
        section_name_t const                    *section;       //!< Identifier for the section.
        size_t                                  offset;         //!< where the CONF_SECTION pointer is written
        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
        unlang_mod_actions_t const              *actions;       //!< Default actions for this section.
        section_name_t const                    **methods;      //!< list of auxilliary module methods which are allowed in
                                                                ///< if the main name doesn't match.
};
 
#define COMPILE_TERMINATOR { .section = NULL }
 
int             virtual_server_section_register(virtual_server_t *vs, virtual_server_compile_t const *entry) CC_HINT(nonnull);
 
section_name_t const **virtual_server_section_methods(virtual_server_t const *vs, section_name_t const *section) CC_HINT(nonnull);
 
unlang_action_t virtual_server_push(unlang_result_t *p_result, request_t *request, virtual_server_t const *vs, bool top_frame) CC_HINT(nonnull(2,3));
 
/** @name Parsing, bootstrap and instantiation
 *
 * @{
 */
int             virtual_server_section_attribute_define(CONF_SECTION *server_cs, char const *subcs_name,
                                                        fr_dict_attr_t const *da) CC_HINT(nonnull);
 
int             virtual_servers_open(fr_schedule_t *sc);
 
void            virtual_servers_thread_detach(void);
 
int             virtual_servers_thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el) CC_HINT(nonnull);
 
int             virtual_servers_instantiate(void) CC_HINT(nonnull);
 
int             virtual_servers_bootstrap(CONF_SECTION *config) CC_HINT(nonnull);
 
int             virtual_servers_free(void);
 
int             virtual_servers_init(void) CC_HINT(nonnull);
/** @} */
 
#ifdef __cplusplus
}
#endif