#include "queue.h"

Include dependency graph for conf.h:

Data Structures
struct	ConfNode_

Macros
#define	DEFAULT_LOG_DIR "/var/log/suricata"

#define	DEFAULT_DATA_DIR DATA_DIR

Typedefs
typedef struct ConfNode_	ConfNode

Functions
void	ConfInit (void)
	Initialize the configuration system. More...

void	ConfDeInit (void)
	De-initializes the configuration system. More...

ConfNode *	ConfGetRootNode (void)
	Get the root configuration node. More...

int	ConfGet (const char name, const char *vptr)
	Retrieve the value of a configuration node. More...

int	ConfGetInt (const char name, intmax_t val)
	Retrieve a configuration value as an integer. More...

int	ConfGetBool (const char name, int val)
	Retrieve a configuration value as an boolen. More...

int	ConfGetDouble (const char name, double val)
	Retrieve a configuration value as a double. More...

int	ConfGetFloat (const char name, float val)
	Retrieve a configuration value as a float. More...

int	ConfSet (const char name, const char val)
	Set a configuration value. More...

int	ConfSetFromString (const char *input, int final)
	Set a configuration parameter from a string. More...

int	ConfSetFinal (const char name, const char val)
	Set a final configuration value. More...

void	ConfDump (void)
	Dump configuration to stdout. More...

void	ConfNodeDump (const ConfNode node, const char prefix)
	Dump a configuration node and all its children. More...

ConfNode *	ConfNodeNew (void)
	Allocate a new configuration node. More...

void	ConfNodeFree (ConfNode *)
	Free a ConfNode and all of its children. More...

ConfNode *	ConfGetNode (const char *key)
	Get a ConfNode by name. More...

void	ConfCreateContextBackup (void)
	Creates a backup of the conf_hash hash_table used by the conf API. More...

void	ConfRestoreContextBackup (void)
	Restores the backup of the hash_table present in backup_conf_hash back to conf_hash. More...

ConfNode *	ConfNodeLookupChild (const ConfNode node, const char key)
	Lookup a child configuration node by name. More...

const char *	ConfNodeLookupChildValue (const ConfNode node, const char key)
	Lookup the value of a child configuration node by name. More...

void	ConfNodeRemove (ConfNode *)
	Remove (and SCFree) the provided configuration node. More...

void	ConfRegisterTests (void)

int	ConfNodeChildValueIsTrue (const ConfNode node, const char key)
	Test if a configuration node has a true value. More...

int	ConfValIsTrue (const char *val)
	Check if a value is true. More...

int	ConfValIsFalse (const char *val)
	Check if a value is false. More...

void	ConfNodePrune (ConfNode *node)
	Prune a configuration node. More...

int	ConfRemove (const char *name)
	Remove a configuration parameter from the configuration db. More...

bool	ConfNodeHasChildren (const ConfNode *node)
	Check if a node has any children. More...

ConfNode *	ConfGetChildWithDefault (const ConfNode base, const ConfNode dflt, const char *name)

ConfNode *	ConfNodeLookupKeyValue (const ConfNode base, const char key, const char *value)
	Lookup for a key value under a specific node. More...

int	ConfGetChildValue (const ConfNode base, const char name, const char **vptr)

int	ConfGetChildValueInt (const ConfNode base, const char name, intmax_t *val)

int	ConfGetChildValueBool (const ConfNode base, const char name, int *val)

int	ConfGetChildValueWithDefault (const ConfNode base, const ConfNode dflt, const char name, const char *vptr)

int	ConfGetChildValueIntWithDefault (const ConfNode base, const ConfNode dflt, const char name, intmax_t val)

int	ConfGetChildValueBoolWithDefault (const ConfNode base, const ConfNode dflt, const char name, int val)

char *	ConfLoadCompleteIncludePath (const char *)
	Create the path for an include entry. More...

int	ConfNodeIsSequence (const ConfNode *node)
	Check if a node is a sequence or node. More...

ConfNode *	ConfSetIfaceNode (const char ifaces_node_name, const char iface)
	Finds an interface from the list of interfaces. More...

int	ConfSetRootAndDefaultNodes (const char ifaces_node_name, const char iface, ConfNode if_root, ConfNode if_default)
	Finds and sets root and default node of the interface. More...

ConfNode *	ConfNodeGetNodeOrCreate (ConfNode parent, const char name, int final)
	Helper function to get a node, creating it if it does not exist. More...

Detailed Description

Author: Endace Technology Limited - Jason Ish jason.nosp@m..ish.nosp@m.@enda.nosp@m.ce.c.nosp@m.om

Definition in file conf.h.

Macro Definition Documentation

◆ DEFAULT_DATA_DIR

#define DEFAULT_DATA_DIR DATA_DIR

Definition at line 56 of file conf.h.

◆ DEFAULT_LOG_DIR

#define DEFAULT_LOG_DIR "/var/log/suricata"

The default log directory.

Definition at line 55 of file conf.h.

Typedef Documentation

◆ ConfNode

typedef struct ConfNode_ ConfNode

Structure of a configuration parameter.

Function Documentation

◆ ConfCreateContextBackup()

void ConfCreateContextBackup ( void )

Creates a backup of the conf_hash hash_table used by the conf API.

Definition at line 669 of file conf.c.

◆ ConfDeInit()

void ConfDeInit ( void )

De-initializes the configuration system.

Definition at line 692 of file conf.c.

◆ ConfDump()

void ConfDump ( void )

Dump configuration to stdout.

Definition at line 750 of file conf.c.

References ConfNodeDump().

Here is the call graph for this function:

◆ ConfGet()

int ConfGet	(	const char *	name,
		const char **	vptr
	)

Retrieve the value of a configuration node.

This function will return the value for a configuration node based on the full name of the node. It is possible that the value returned could be NULL, this could happen if the requested node does exist but is not a node that contains a value, but contains children ConfNodes instead.

Parameters

name	Name of configuration parameter to get.
vptr	Pointer that will be set to the configuration value parameter. Note that this is just a reference to the actual value, not a copy.

Return values

1	will be returned if the name is found, otherwise 0 will be returned.

Definition at line 335 of file conf.c.

References ConfGetNode(), SCLogDebug, and ConfNode_::val.

Referenced by ConfGetBool(), ConfGetDouble(), ConfGetFloat(), ConfGetInt(), ConfigGetDataDirectory(), ConfigGetLogDirectory(), ConfLoadCompleteIncludePath(), ConfUnixSocketIsEnable(), CoredumpLoadConfig(), FlowInitConfig(), HTPParseMemcap(), HttpRangeContainersInit(), NFQInitConfig(), OutputJsonInitCtx(), PatternMatchDefaultMatcher(), PostConfLoadedSetup(), RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeIdsAFPAutoFp(), RunModeIdsAFPSingle(), RunModeIdsAFPWorkers(), RunModeIdsAFXDPSingle(), RunModeIdsAFXDPWorkers(), RunModeIdsPcapAutoFp(), RunModeIdsPcapSingle(), RunModeIdsPcapWorkers(), RunModeInitialize(), SCLogLoadConfig(), SCRuleVarsGetConfVar(), SinglePatternMatchDefaultMatcher(), StreamTcpInitConfig(), and TmqhFlowRegister().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetBool()

int ConfGetBool	(	const char *	name,
		int *	val
	)

Retrieve a configuration value as an boolen.

Parameters

name	Name of configuration parameter to get.
val	Pointer to an int that will be set to 1 for true, or 0 for false.

Return values

1	will be returned if the name is found and was properly converted to a boolean, otherwise 0 will be returned.

Definition at line 482 of file conf.c.

References ConfGet(), and ConfValIsTrue().

Referenced by DecodeERSPANConfig(), DecodeGeneveConfig(), DecodeTeredoConfig(), DecodeVXLANConfig(), DetectEngineFrameMpmRegister(), NapatechGetStreamConfig(), NapatechPacketLoop(), NFQInitConfig(), PostConfLoadedSetup(), RunModeInitialize(), and StreamTcpInitConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetChildValue()

int ConfGetChildValue	(	const ConfNode *	base,
		const char *	name,
		const char **	vptr
	)

Definition at line 348 of file conf.c.

References ConfNodeLookupChild(), SCLogDebug, and ConfNode_::val.

Referenced by ConfGetChildValueBool(), ConfGetChildValueInt(), and ConfGetChildValueWithDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetChildValueBool()

int ConfGetChildValueBool	(	const ConfNode *	base,
		const char *	name,
		int *	val
	)

Get a boolean value from the provided ConfNode.

Return values

1	If the value exists, 0 if not.

Definition at line 500 of file conf.c.

References ConfGetChildValue(), and ConfValIsTrue().

Referenced by ConfGetChildValueBoolWithDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetChildValueBoolWithDefault()

int ConfGetChildValueBoolWithDefault	(	const ConfNode *	base,
		const ConfNode *	dflt,
		const char *	name,
		int *	val
	)

Definition at line 513 of file conf.c.

References ConfGetChildValueBool().

Here is the call graph for this function:

◆ ConfGetChildValueInt()

int ConfGetChildValueInt	(	const ConfNode *	base,
		const char *	name,
		intmax_t *	val
	)

Definition at line 432 of file conf.c.

References ConfGetChildValue(), ConfNode_::name, and SCLogError.

Referenced by ConfGetChildValueIntWithDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetChildValueIntWithDefault()

int ConfGetChildValueIntWithDefault	(	const ConfNode *	base,
		const ConfNode *	dflt,
		const char *	name,
		intmax_t *	val
	)

Definition at line 460 of file conf.c.

References ConfGetChildValueInt().

Here is the call graph for this function:

◆ ConfGetChildValueWithDefault()

int ConfGetChildValueWithDefault	(	const ConfNode *	base,
		const ConfNode *	dflt,
		const char *	name,
		const char **	vptr
	)

Definition at line 376 of file conf.c.

References ConfGetChildValue().

Here is the call graph for this function:

◆ ConfGetChildWithDefault()

ConfNode* ConfGetChildWithDefault	(	const ConfNode *	base,
		const ConfNode *	dflt,
		const char *	name
	)

Definition at line 362 of file conf.c.

References ConfNodeLookupChild().

Here is the call graph for this function:

◆ ConfGetDouble()

int ConfGetDouble	(	const char *	name,
		double *	val
	)

Retrieve a configuration value as a double.

Parameters

name	Name of configuration parameter to get.
val	Pointer to an double that will be set the configuration value.

Return values

1	will be returned if the name is found and was properly converted to a double, otherwise 0 will be returned.

Definition at line 585 of file conf.c.

References ConfGet().

Here is the call graph for this function:

◆ ConfGetFloat()

int ConfGetFloat	(	const char *	name,
		float *	val
	)

Retrieve a configuration value as a float.

Parameters

name	Name of configuration parameter to get.
val	Pointer to an float that will be set the configuration value.

Return values

1	will be returned if the name is found and was properly converted to a double, otherwise 0 will be returned.

Definition at line 615 of file conf.c.

References ConfGet().

Referenced by RunModeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetInt()

int ConfGetInt	(	const char *	name,
		intmax_t *	val
	)

Retrieve a configuration value as an integer.

Parameters

name	Name of configuration parameter to get.
val	Pointer to an intmax_t that will be set the configuration value.

Return values

1	will be returned if the name is found and was properly converted to an interger, otherwise 0 will be returned.

Definition at line 397 of file conf.c.

References ConfGet(), and SCLogError.

Referenced by DecodeGlobalConfig(), DefragInit(), DetectLoadersInit(), FlowInitConfig(), FlowManagerThreadSpawn(), FlowRecyclerThreadSpawn(), NFQInitConfig(), PacketAlertGetMaxConfig(), SCProfilingInit(), and StreamTcpInitConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfGetNode()

ConfNode* ConfGetNode ( const char * name )

Get a ConfNode by name.

Parameters

name	The full name of the configuration node to lookup.

Return values

A	pointer to ConfNode is found or NULL if the configuration node does not exist.

Definition at line 181 of file conf.c.

Referenced by ActionInitConfig(), AppLayerParserConfParserEnabled(), AppLayerProtoDetectConfProtoDetectionEnabledDefault(), AppLayerProtoDetectPPParseConfPorts(), ConfGet(), ConfRemove(), ConfSetIfaceNode(), DatasetsInit(), DetectAddressTestConfVars(), DetectLoadCompleteSigPath(), DetectPortTestConfVars(), DetectTemplateRustBufferRegister(), FlowInitFlowProto(), JsonBitTorrentDHTLogRegister(), JsonPgsqlLogRegister(), JsonTemplateLogRegister(), JsonTemplateRustLogRegister(), LiveBuildDeviceListCustom(), PcapLogProfileSetup(), RegisterMQTTParsers(), RunModeInitialize(), RunModeInitializeOutputs(), SCLogLoadConfig(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingRulesGlobalInit(), SCProfilingSghsGlobalInit(), SetupRuleAnalyzer(), and StreamTcpInitConfig().

Here is the caller graph for this function:

◆ ConfGetRootNode()

ConfNode* ConfGetRootNode ( void )

Get the root configuration node.

Definition at line 207 of file conf.c.

◆ ConfInit()

void ConfInit ( void )

Initialize the configuration system.

Definition at line 120 of file conf.c.

Referenced by InitGlobal().

Here is the caller graph for this function:

◆ ConfLoadCompleteIncludePath()

char* ConfLoadCompleteIncludePath ( const char * file )

Create the path for an include entry.

Parameters

file	The name of the file

Return values

str	Pointer to the string path + sig_file

Definition at line 872 of file conf.c.

References ConfGet(), PathIsRelative(), SCLogDebug, SCMalloc, SCStrdup, strlcat(), strlcpy(), and unlikely.

Here is the call graph for this function:

◆ ConfNodeChildValueIsTrue()

int ConfNodeChildValueIsTrue	(	const ConfNode *	node,
		const char *	key
	)

Test if a configuration node has a true value.

Parameters

node	The parent configuration node.
name	The name of the child node to test.

Return values

1	if the child node has a true value, otherwise 0 is returned, even if the child node does not exist.

Definition at line 858 of file conf.c.

References ConfNodeLookupChildValue(), and ConfValIsTrue().

Referenced by HttpXFFGetCfg(), PcapLogProfileSetup(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingRulesGlobalInit(), and SCProfilingSghsGlobalInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfNodeDump()

void ConfNodeDump	(	const ConfNode *	node,
		const char *	prefix
	)

Dump a configuration node and all its children.

Definition at line 720 of file conf.c.

References ConfNode_::name, next, SCStrdup, TAILQ_FOREACH, and unlikely.

Referenced by ConfDump().

Here is the caller graph for this function:

◆ ConfNodeFree()

void ConfNodeFree ( ConfNode * node )

Free a ConfNode and all of its children.

Parameters

node	The configuration node to SCFree.

Definition at line 157 of file conf.c.

References ConfNodeFree(), ConfNode_::name, next, SCFree, TAILQ_FIRST, TAILQ_REMOVE, and ConfNode_::val.

Referenced by ConfNodeFree(), ConfNodeGetNodeOrCreate(), and ConfNodeRemove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfNodeGetNodeOrCreate()

ConfNode* ConfNodeGetNodeOrCreate	(	ConfNode *	parent,
		const char *	name,
		int	final
	)

Helper function to get a node, creating it if it does not exist.

This function exits on memory failure as creating configuration nodes is usually part of application initialization.

Parameters

parent	The node to use as the parent
name	The name of the configuration node to get.
final	Flag to set created nodes as final or not.

Return values

The	existing configuration node if it exists, or a newly created node for the provided name. On error, NULL will be returned.

Definition at line 66 of file conf.c.

References ConfNodeFree(), ConfNodeLookupChild(), ConfNodeNew(), ConfNode_::final, ConfNode_::name, next, NODE_NAME_MAX, ConfNode_::parent, SCLogError, SCLogWarning, SCStrdup, strlcpy(), TAILQ_INSERT_TAIL, and unlikely.

Here is the call graph for this function:

◆ ConfNodeHasChildren()

bool ConfNodeHasChildren ( const ConfNode * node )

Check if a node has any children.

Checks if the provided node has any children. Any node that is a YAML map or array will have children.

Parameters

node	The node to check.

Return values

true	if node has children
false	if node does not have children

Definition at line 766 of file conf.c.

References TAILQ_EMPTY.

◆ ConfNodeIsSequence()

int ConfNodeIsSequence ( const ConfNode * node )

Check if a node is a sequence or node.

Parameters

node	the node to check.

Returns: 1 if node is a seuence, otherwise 0.

Definition at line 945 of file conf.c.

References ConfNode_::is_seq.

◆ ConfNodeLookupChild()

ConfNode* ConfNodeLookupChild	(	const ConfNode *	node,
		const char *	name
	)

Lookup a child configuration node by name.

Given a ConfNode this function will lookup an immediate child ConfNode by name and return the child ConfNode.

Parameters

node	The parent configuration node.
name	The name of the child node to lookup.

Return values

A	pointer the child ConfNode if found otherwise NULL.

Definition at line 785 of file conf.c.

References ConfNode_::name, next, and TAILQ_FOREACH.

Referenced by AppLayerProtoDetectPPParseConfPorts(), ConfGetChildValue(), ConfGetChildWithDefault(), ConfNodeGetNodeOrCreate(), ConfNodeLookupChildValue(), FileForceHashParseCfg(), FlowInitFlowProto(), HttpXFFGetCfg(), and OutputEmailInitConf().

Here is the caller graph for this function:

◆ ConfNodeLookupChildValue()

const char* ConfNodeLookupChildValue	(	const ConfNode *	node,
		const char *	name
	)

Lookup the value of a child configuration node by name.

Given a parent ConfNode this function will return the value of a child configuration node by name returning a reference to that value.

Parameters

node	The parent configuration node.
name	The name of the child node to lookup.

Return values

A	pointer the child ConfNodes value if found otherwise NULL.

Definition at line 813 of file conf.c.

References ConfNodeLookupChild(), and ConfNode_::val.

Referenced by ConfNodeChildValueIsTrue(), FileForceHashParseCfg(), FlowInitFlowProto(), HttpXFFGetCfg(), LogHttpLogInitCtx(), LogTcpDataLogInitCtx(), OutputEmailInitConf(), OutputJsonInitCtx(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingRulesGlobalInit(), SCProfilingSghsGlobalInit(), and SetupRuleAnalyzer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfNodeLookupKeyValue()

ConfNode* ConfNodeLookupKeyValue	(	const ConfNode *	base,
		const char *	key,
		const char *	value
	)

Lookup for a key value under a specific node.

Returns: the ConfNode matching or NULL

Definition at line 830 of file conf.c.

References ConfNode_::name, next, TAILQ_FOREACH, and ConfNode_::val.

◆ ConfNodeNew()

ConfNode* ConfNodeNew ( void )

Allocate a new configuration node.

Return values

An	allocated configuration node on success, NULL on failure.

Definition at line 139 of file conf.c.

References SCCalloc, TAILQ_INIT, and unlikely.

Referenced by ConfNodeGetNodeOrCreate().

Here is the caller graph for this function:

◆ ConfNodePrune()

void ConfNodePrune ( ConfNode * node )

Prune a configuration node.

Pruning a configuration is similar to freeing, but only fields that may be overridden are, leaving final type parameters. Additional the value of the provided node is also free'd, but the node itself is left.

Parameters

node	The configuration node to prune.

Definition at line 913 of file conf.c.

References ConfNodePrune(), ConfNode_::final, ConfNode_::name, next, SCFree, TAILQ_EMPTY, TAILQ_FIRST, TAILQ_NEXT, TAILQ_REMOVE, and ConfNode_::val.

Referenced by ConfNodePrune().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfNodeRemove()

void ConfNodeRemove ( ConfNode * )

Remove (and SCFree) the provided configuration node.

Definition at line 638 of file conf.c.

References ConfNodeFree(), next, ConfNode_::parent, and TAILQ_REMOVE.

Referenced by ConfRemove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfRegisterTests()

void ConfRegisterTests ( void )

Definition at line 1491 of file conf.c.

References UtRegisterTest().

Here is the call graph for this function:

◆ ConfRemove()

int ConfRemove ( const char * name )

Remove a configuration parameter from the configuration db.

Parameters

name	The name of the configuration parameter to remove.

Return values

Returns 1 if the parameter was removed, otherwise 0 is returned most likely indicating the parameter was not set.

Definition at line 653 of file conf.c.

References ConfGetNode(), and ConfNodeRemove().

Here is the call graph for this function:

◆ ConfRestoreContextBackup()

void ConfRestoreContextBackup ( void )

Restores the backup of the hash_table present in backup_conf_hash back to conf_hash.

Definition at line 681 of file conf.c.

◆ ConfSet()

int ConfSet	(	const char *	name,
		const char *	val
	)

Set a configuration value.

Configuration values set with this function may be overridden by subsequent calls, or if the value appears multiple times in a configuration file.

Parameters

name	The name of the configuration parameter to set.
val	The value of the configuration parameter.

Return values

1	if the value was set otherwise 0.

Definition at line 224 of file conf.c.

Referenced by ConfSetFromString(), and PostConfLoadedSetup().

Here is the caller graph for this function:

◆ ConfSetFinal()

int ConfSetFinal	(	const char *	name,
		const char *	val
	)

Set a final configuration value.

A final configuration value is a value that cannot be overridden by the configuration file. Its mainly useful for setting values that are supplied on the command line prior to the configuration file being loaded. However, a subsequent call to this function can override a previously set value.

Parameters

name	The name of the configuration parameter to set.
val	The value of the configuration parameter.

Return values

1	if the value was set otherwise 0.

Definition at line 303 of file conf.c.

Referenced by ConfigSetDataDirectory(), ConfigSetLogDirectory(), and ConfSetFromString().

Here is the caller graph for this function:

◆ ConfSetFromString()

int ConfSetFromString	(	const char *	input,
		int	final
	)

Set a configuration parameter from a string.

Where the input string is something like: stream.midstream=true

Parameters

input the input string to be parsed.

Return values

1	if the value of set, otherwise 0.

Definition at line 249 of file conf.c.

References ConfSet(), ConfSetFinal(), SCFree, SCStrdup, and unlikely.

Here is the call graph for this function:

◆ ConfSetIfaceNode()

ConfNode* ConfSetIfaceNode	(	const char *	ifaces_node_name,
		const char *	iface
	)

Finds an interface from the list of interfaces.

Parameters

ifaces_node_name	- name of the node which holds a list of intefaces
iface	- interfaces name

Returns: NULL on failure otherwise a valid pointer

Definition at line 956 of file conf.c.

References ConfFindDeviceConfig(), ConfGetNode(), SCLogError, and SCLogNotice.

Referenced by ConfSetRootAndDefaultNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfSetRootAndDefaultNodes()

int ConfSetRootAndDefaultNodes	(	const char *	ifaces_node_name,
		const char *	iface,
		ConfNode **	if_root,
		ConfNode **	if_default
	)

Finds and sets root and default node of the interface.

Parameters

ifaces_node_name	Node which holds list of interfaces
iface	Name of the interface e.g. eth3
if_root	Node which will hold the interface configuration
if_default	Node which is the default configuration in the given list of interfaces

Returns: 0 on success, -ENODEV when neither the root interface nor the default interface was found

Definition at line 982 of file conf.c.

References ConfSetIfaceNode(), and SCLogError.

Here is the call graph for this function:

◆ ConfValIsFalse()

int ConfValIsFalse ( const char * val )

Check if a value is false.

The value is considered false if it is a string with the value of 0, no, false or off. The test is not case sensitive, any other value is not false.

Parameters

val	The string to test for a false value.

Return values

1	If the value is false, 0 if not.

Definition at line 561 of file conf.c.

Referenced by AppLayerParserConfParserEnabled(), and AppLayerProtoDetectConfProtoDetectionEnabledDefault().

Here is the caller graph for this function:

◆ ConfValIsTrue()

int ConfValIsTrue ( const char * val )

Check if a value is true.

The value is considered true if it is a string with the value of 1, yes, true or on. The test is not case sensitive, any other value is false.

Parameters

val	The string to test for a true value.

Return values

1	If the value is true, 0 if not.

Definition at line 536 of file conf.c.

Referenced by AppLayerParserConfParserEnabled(), AppLayerProtoDetectConfProtoDetectionEnabledDefault(), ConfGetBool(), ConfGetChildValueBool(), ConfNodeChildValueIsTrue(), ConfUnixSocketIsEnable(), FileForceHashParseCfg(), LogHttpLogInitCtx(), OutputEmailInitConf(), and SetupRuleAnalyzer().

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ DEFAULT_DATA_DIR

◆ DEFAULT_LOG_DIR

Typedef Documentation

◆ ConfNode

Function Documentation

◆ ConfCreateContextBackup()

◆ ConfDeInit()

◆ ConfDump()

◆ ConfGet()

◆ ConfGetBool()

◆ ConfGetChildValue()

◆ ConfGetChildValueBool()

◆ ConfGetChildValueBoolWithDefault()

◆ ConfGetChildValueInt()

◆ ConfGetChildValueIntWithDefault()

◆ ConfGetChildValueWithDefault()

◆ ConfGetChildWithDefault()

◆ ConfGetDouble()

◆ ConfGetFloat()

◆ ConfGetInt()

◆ ConfGetNode()

◆ ConfGetRootNode()

◆ ConfInit()

◆ ConfLoadCompleteIncludePath()

◆ ConfNodeChildValueIsTrue()

◆ ConfNodeDump()

◆ ConfNodeFree()

◆ ConfNodeGetNodeOrCreate()

◆ ConfNodeHasChildren()

◆ ConfNodeIsSequence()

◆ ConfNodeLookupChild()

◆ ConfNodeLookupChildValue()

◆ ConfNodeLookupKeyValue()

◆ ConfNodeNew()

◆ ConfNodePrune()

◆ ConfNodeRemove()

◆ ConfRegisterTests()

◆ ConfRemove()

◆ ConfRestoreContextBackup()

◆ ConfSet()

◆ ConfSetFinal()

◆ ConfSetFromString()

◆ ConfSetIfaceNode()

◆ ConfSetRootAndDefaultNodes()

◆ ConfValIsFalse()

◆ ConfValIsTrue()