Parser for hooks library list. More...

#include <hooks_parser.h>

Inheritance diagram for isc::hooks::HooksLibrariesParser:

Public Member Functions
void	parse (HooksConfig &libraries, isc::data::ConstElementPtr value)
	Parses parameters value.

Public Member Functions inherited from isc::data::SimpleParser
uint16_t	getUint16 (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a value converted to uint16_t.

uint32_t	getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a value converted to uint32_t.

uint8_t	getUint8 (ConstElementPtr scope, const std::string &name)
	Get an uint8_t value.

const isc::util::Triplet< uint32_t >	parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
	Parses an integer triplet.

Static Public Member Functions
static std::string	getHooksPath (bool reset=false, const std::string explicit_path="")
	Fetches the supported Hooks path.

static std::string	validatePath (const std::string libpath)
	Validates a library path against the supported path for hooks libraries.

Static Public Member Functions inherited from isc::data::SimpleParser
static void	checkKeywords (const SimpleKeywords &keywords, isc::data::ConstElementPtr scope)
	Checks acceptable keywords with their expected type.

static void	checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
	Checks that all required keywords are present.

static size_t	deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
	Derives (inherits) parameters from parent scope to a child.

static isc::asiolink::IOAddress	getAddress (const ConstElementPtr &scope, const std::string &name)
	Returns a IOAddress parameter from a scope.

static bool	getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a boolean parameter from a scope.

static double	getDouble (const ConstElementPtr &scope, const std::string &name)
	Returns a floating point parameter from a scope.

static int64_t	getInteger (isc::data::ConstElementPtr scope, const std::string &name)
	Returns an integer parameter from a scope.

static int64_t	getInteger (isc::data::ConstElementPtr scope, const std::string &name, int64_t min, int64_t max)
	Returns an integer parameter from a scope and checks its range.

static const data::Element::Position &	getPosition (const std::string &name, const data::ConstElementPtr parent)
	Utility method that returns position of an element.

static std::string	getString (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a string parameter from a scope.

static size_t	setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
	Sets the default values.

static size_t	setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
	Sets the default values for all entries in a list.

Additional Inherited Members
Protected Member Functions inherited from isc::data::SimpleParser
template<typename target_type, target_type convert>
target_type	getAndConvert (isc::data::ConstElementPtr scope, const std::string &name, const std::string &type_name)
	Returns a converted value from a scope.

template<typename int_type>
int_type	getIntType (isc::data::ConstElementPtr scope, const std::string &name)
	Returns an integer value with range checking from a scope.

Detailed Description

Parser for hooks library list.

This parser handles the list of hooks libraries. This is an optional list, which may be empty, and is encapsulated into a HooksConfig object.

Definition at line 22 of file hooks_parser.h.

Member Function Documentation

◆ getHooksPath()

std::string isc::hooks::HooksLibrariesParser::getHooksPath	(	bool	reset = false,
		const std::string	explicit_path = "" )

static

Fetches the supported Hooks path.

The first call to this function with no arguments will set the default hooks path to either the value of DEFAULT_HOOKS_PATH or the environment variable KEA_HOOKS_PATH if it is defined. Subsequent calls with no arguments will simply return this value.

Parameters

reset	recalculate when true, defaults to false. This is for testing purposes only.
explicit_path	set default hooks path to this value. This is for testing purposes only.

Returns: String containing the default hooks path.

Definition at line 58 of file hooks_parser.cc.

Referenced by validatePath().

◆ parse()

void isc::hooks::HooksLibrariesParser::parse	(	HooksConfig &	libraries,
		isc::data::ConstElementPtr	value )

Parses parameters value.

Parses configuration entry (list of parameters) and adds each element to the hooks libraries list. The method also checks whether the list of libraries is the same as that already loaded. If not, it checks each of the libraries in the list for validity (they exist and have a "version" function that returns the correct value).

The syntax for specifying hooks libraries allow for library-specific parameters to be specified along with the library, e.g.

"hooks-libraries": [
    {
        "library": "hook-lib-1.so",
        "parameters": {
            "alpha": "a string",
            "beta": 42
        }
    },
    :
]

The parsing code only checks that:

Each element in the hooks-libraries list is a map
The map contains an element "library" whose value is a not blank string
That there is an optional 'parameters' element.
That there are no other element.

This method stores parsed libraries in libraries.

Parameters

libraries	parsed libraries information will be stored here
value	pointer to the content to be parsed

Definition at line 87 of file hooks_parser.cc.

References isc::hooks::HooksConfig::add(), isc::hooks::HooksConfig::clear(), isc_throw, Element::map, Element::string, and validatePath().

Referenced by isc::agent::AgentSimpleParser::parse(), isc::d2::D2SimpleParser::parse(), isc::netconf::NetconfSimpleParser::parse(), isc::dhcp::processDhcp4Config(), and isc::dhcp::processDhcp6Config().

Here is the call graph for this function:

◆ validatePath()

std::string isc::hooks::HooksLibrariesParser::validatePath ( const std::string libpath )

static

Validates a library path against the supported path for hooks libraries.

Parameters

libpath library path to validate.

Returns: validated path

Definition at line 70 of file hooks_parser.cc.

References getHooksPath(), isc::hooks::HOOKS_LIBPATH_SECURITY_WARNING, isc::hooks::hooks_logger, LOG_WARN, and isc::Exception::what().

Referenced by parse().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getHooksPath()

◆ parse()

◆ validatePath()