suricata
|
#include "suricata-common.h"
#include "conf.h"
#include "util-unittest.h"
#include "util-debug.h"
#include "util-path.h"
#include "util-conf.h"
Go to the source code of this file.
Macros | |
#define | NODE_NAME_MAX 1024 |
Functions | |
ConfNode * | ConfNodeGetNodeOrCreate (ConfNode *parent, const char *name, int final) |
Helper function to get a node, creating it if it does not exist. More... | |
void | ConfInit (void) |
Initialize the configuration system. More... | |
ConfNode * | ConfNodeNew (void) |
Allocate a new configuration node. More... | |
void | ConfNodeFree (ConfNode *node) |
Free a ConfNode and all of its children. More... | |
ConfNode * | ConfGetNode (const char *name) |
Get a ConfNode by name. More... | |
ConfNode * | ConfGetRootNode (void) |
Get the root configuration node. 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... | |
int | ConfGet (const char *name, const char **vptr) |
Retrieve the value of a configuration node. More... | |
int | ConfGetChildValue (const ConfNode *base, const char *name, const char **vptr) |
ConfNode * | ConfGetChildWithDefault (const ConfNode *base, const ConfNode *dflt, const char *name) |
int | ConfGetChildValueWithDefault (const ConfNode *base, const ConfNode *dflt, const char *name, const char **vptr) |
int | ConfGetInt (const char *name, intmax_t *val) |
Retrieve a configuration value as an integer. More... | |
int | ConfGetChildValueInt (const ConfNode *base, const char *name, intmax_t *val) |
int | ConfGetChildValueIntWithDefault (const ConfNode *base, const ConfNode *dflt, const char *name, intmax_t *val) |
int | ConfGetBool (const char *name, int *val) |
Retrieve a configuration value as a boolean. More... | |
int | ConfGetChildValueBool (const ConfNode *base, const char *name, int *val) |
int | ConfGetChildValueBoolWithDefault (const ConfNode *base, const ConfNode *dflt, const char *name, int *val) |
int | ConfValIsTrue (const char *val) |
Check if a value is true. More... | |
int | ConfValIsFalse (const char *val) |
Check if a value is false. 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... | |
void | ConfNodeRemove (ConfNode *node) |
Remove (and SCFree) the provided configuration node. More... | |
int | ConfRemove (const char *name) |
Remove a configuration parameter from the configuration db. 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... | |
void | ConfDeInit (void) |
De-initializes the configuration system. More... | |
void | ConfNodeDump (const ConfNode *node, const char *prefix) |
Dump a configuration node and all its children. More... | |
void | ConfDump (void) |
Dump configuration to stdout. More... | |
bool | ConfNodeHasChildren (const ConfNode *node) |
Check if a node has any children. More... | |
ConfNode * | ConfNodeLookupChild (const ConfNode *node, const char *name) |
Lookup a child configuration node by name. More... | |
const char * | ConfNodeLookupChildValue (const ConfNode *node, const char *name) |
Lookup the value of a child configuration node by name. More... | |
ConfNode * | ConfNodeLookupKeyValue (const ConfNode *base, const char *key, const char *value) |
Lookup for a key value under a specific node. More... | |
int | ConfNodeChildValueIsTrue (const ConfNode *node, const char *key) |
Test if a configuration node has a true value. More... | |
void | ConfNodePrune (ConfNode *node) |
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... | |
void | ConfRegisterTests (void) |
This file provides a basic configuration system for the IDPS engine.
NOTE: Setting values should only be done from one thread during engine initialization. Multiple threads should be able access read configuration data. Allowing run time changes to the configuration will require some locks.
Definition in file conf.c.
#define NODE_NAME_MAX 1024 |
void ConfCreateContextBackup | ( | void | ) |
void ConfDeInit | ( | void | ) |
De-initializes the configuration system.
Definition at line 688 of file conf.c.
Referenced by GlobalsDestroy().
void ConfDump | ( | void | ) |
Dump configuration to stdout.
Definition at line 746 of file conf.c.
References ConfNodeDump().
Referenced by SuricataInit().
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.
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. |
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(), ConfSetBPFFilter(), ConfUnixSocketIsEnable(), CoredumpLoadConfig(), FlowInitConfig(), HTPParseMemcap(), HttpRangeContainersInit(), NFQInitConfig(), OutputJsonInitCtx(), PatternMatchDefaultMatcher(), PcapFileGlobalInit(), PostConfLoadedSetup(), RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeIdsAFPAutoFp(), RunModeIdsAFPSingle(), RunModeIdsAFPWorkers(), RunModeIdsAFXDPSingle(), RunModeIdsAFXDPWorkers(), RunModeIdsPcapAutoFp(), RunModeIdsPcapSingle(), RunModeIdsPcapWorkers(), RunModeInitializeThreadSettings(), SCLogLoadConfig(), SCRuleVarsGetConfVar(), SinglePatternMatchDefaultMatcher(), StreamTcpInitConfig(), and TmqhFlowRegister().
int ConfGetBool | ( | const char * | name, |
int * | val | ||
) |
Retrieve a configuration value as a boolean.
name | Name of configuration parameter to get. |
val | Pointer to an int that will be set to 1 for true, or 0 for false. |
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(), NFQInitConfig(), PostConfLoadedSetup(), RunModeInitializeThreadSettings(), SigPrepareStage4(), StreamTcpInitConfig(), SuricataInit(), and SuricataPostInit().
int ConfGetChildValue | ( | const ConfNode * | base, |
const char * | name, | ||
const char ** | vptr | ||
) |
int ConfGetChildValueBool | ( | const ConfNode * | base, |
const char * | name, | ||
int * | val | ||
) |
int ConfGetChildValueInt | ( | const ConfNode * | base, |
const char * | name, | ||
intmax_t * | val | ||
) |
int ConfGetChildValueWithDefault | ( | const ConfNode * | base, |
const ConfNode * | dflt, | ||
const char * | name, | ||
const char ** | vptr | ||
) |
Definition at line 378 of file conf.c.
Referenced by ConfSetBPFFilter().
int ConfGetDouble | ( | const char * | name, |
double * | val | ||
) |
Retrieve a configuration value as a double.
name | Name of configuration parameter to get. |
val | Pointer to an double that will be set the configuration value. |
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().
int ConfGetFloat | ( | const char * | name, |
float * | val | ||
) |
Retrieve a configuration value as a float.
name | Name of configuration parameter to get. |
val | Pointer to an float that will be set the configuration value. |
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 RunModeInitializeThreadSettings().
int ConfGetInt | ( | const char * | name, |
intmax_t * | val | ||
) |
Retrieve a configuration value as an integer.
name | Name of configuration parameter to get. |
val | Pointer to an intmax_t that will be set the configuration value. |
1 | will be returned if the name is found and was properly converted to an integer, otherwise 0 will be returned. |
Definition at line 399 of file conf.c.
References ConfGet(), and SCLogError.
Referenced by DecodeGlobalConfig(), DefragInit(), DetectLoadersInit(), FlowInitConfig(), FlowManagerThreadSpawn(), FlowRecyclerThreadSpawn(), NFQInitConfig(), PacketAlertGetMaxConfig(), SCProfilingInit(), and StreamTcpInitConfig().
ConfNode* ConfGetNode | ( | const char * | name | ) |
Get a ConfNode by name.
name | The full name of the configuration node to lookup. |
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(), FlowInitFlowProto(), JsonPgsqlLogRegister(), PcapLogProfileSetup(), PostConfLoadedSetup(), RunModeInitializeOutputs(), RunModeInitializeThreadSettings(), SCLogLoadConfig(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingSghsGlobalInit(), and StreamTcpInitConfig().
ConfNode* ConfGetRootNode | ( | void | ) |
Get the root configuration node.
Definition at line 207 of file conf.c.
Referenced by SCLoadYamlConfig().
void ConfInit | ( | void | ) |
Initialize the configuration system.
Definition at line 120 of file conf.c.
Referenced by InitGlobal().
int ConfNodeChildValueIsTrue | ( | const ConfNode * | node, |
const char * | key | ||
) |
Test if a configuration node has a true value.
node | The parent configuration node. |
name | The name of the child node to test. |
1 | if the child node has a true value, otherwise 0 is returned, even if the child node does not exist. |
Definition at line 854 of file conf.c.
References ConfNodeLookupChildValue(), and ConfValIsTrue().
Referenced by HttpXFFGetCfg(), PcapLogProfileSetup(), PostConfLoadedSetup(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), and SCProfilingSghsGlobalInit().
void ConfNodeDump | ( | const ConfNode * | node, |
const char * | prefix | ||
) |
Dump a configuration node and all its children.
Definition at line 716 of file conf.c.
References ConfNode_::name, next, SCStrdup, TAILQ_FOREACH, and unlikely.
Referenced by ConfDump().
void ConfNodeFree | ( | ConfNode * | node | ) |
Free a ConfNode and all of its children.
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().
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.
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. |
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.
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.
node | The node to check. |
true | if node has children |
false | if node does not have children |
Definition at line 762 of file conf.c.
References TAILQ_EMPTY.
int ConfNodeIsSequence | ( | const ConfNode * | node | ) |
Check if a node is a sequence or node.
node | the node to check. |
Definition at line 911 of file conf.c.
References ConfNode_::is_seq.
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.
node | The parent configuration node. |
name | The name of the child node to lookup. |
A | pointer the child ConfNode if found otherwise NULL. |
Definition at line 781 of file conf.c.
References ConfNode_::name, next, and TAILQ_FOREACH.
Referenced by AppLayerProtoDetectPPParseConfPorts(), ConfNodeGetNodeOrCreate(), ConfNodeLookupChildValue(), FileForceHashParseCfg(), FlowInitFlowProto(), HttpXFFGetCfg(), OutputEmailInitConf(), RunModeInitializeOutputs(), and SCConfLogOpenGeneric().
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.
node | The parent configuration node. |
name | The name of the child node to lookup. |
A | pointer the child ConfNodes value if found otherwise NULL. |
Definition at line 809 of file conf.c.
References ConfNodeLookupChild(), and ConfNode_::val.
Referenced by ConfNodeChildValueIsTrue(), FileForceHashParseCfg(), FlowInitFlowProto(), HttpXFFGetCfg(), LogHttpLogInitCtx(), LogTcpDataLogInitCtx(), OutputEmailInitConf(), OutputJsonInitCtx(), RunModeInitializeOutputs(), SCConfLogOpenGeneric(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), and SCProfilingSghsGlobalInit().
ConfNode* ConfNodeNew | ( | void | ) |
Allocate a new configuration node.
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().
void ConfNodePrune | ( | ConfNode * | node | ) |
Create the path for an include entry.
file | The name of the file |
str | Pointer to the string path + sig_file |
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.
node | The configuration node to prune. |
Definition at line 879 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().
void ConfNodeRemove | ( | ConfNode * | node | ) |
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().
void ConfRegisterTests | ( | void | ) |
Definition at line 1457 of file conf.c.
References UtRegisterTest().
int ConfRemove | ( | const char * | name | ) |
Remove a configuration parameter from the configuration db.
name | The name of the configuration parameter to remove. |
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().
void ConfRestoreContextBackup | ( | void | ) |
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.
name | The name of the configuration parameter to set. |
val | The value of the configuration parameter. |
1 | if the value was set otherwise 0. |
Definition at line 224 of file conf.c.
Referenced by ConfSetFromString(), and PostConfLoadedSetup().
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.
name | The name of the configuration parameter to set. |
val | The value of the configuration parameter. |
1 | if the value was set otherwise 0. |
Definition at line 303 of file conf.c.
Referenced by ConfigSetDataDirectory(), ConfigSetLogDirectory(), ConfSetFromString(), and SCParseCommandLine().
int ConfSetFromString | ( | const char * | input, |
int | final | ||
) |
Set a configuration parameter from a string.
Where the input string is something like: stream.midstream=true
input | the input string to be parsed. |
1 | if the value of set, otherwise 0. |
Definition at line 249 of file conf.c.
References ConfSet(), ConfSetFinal(), SCFree, SCStrdup, and unlikely.
ConfNode* ConfSetIfaceNode | ( | const char * | ifaces_node_name, |
const char * | iface | ||
) |
Finds an interface from the list of interfaces.
ifaces_node_name | - name of the node which holds a list of interfaces |
iface | - interfaces name |
Definition at line 922 of file conf.c.
References ConfFindDeviceConfig(), ConfGetNode(), SCLogError, and SCLogNotice.
Referenced by 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.
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 |
Definition at line 948 of file conf.c.
References ConfSetIfaceNode(), and SCLogError.
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.
val | The string to test for a false value. |
1 | If the value is false, 0 if not. |
Definition at line 561 of file conf.c.
Referenced by AppLayerParserConfParserEnabled(), AppLayerProtoDetectConfProtoDetectionEnabledDefault(), and SCConfLogOpenGeneric().
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.
val | The string to test for a true value. |
1 | If the value is true, 0 if not. |
Definition at line 536 of file conf.c.
Referenced by AppLayerParserConfParserEnabled(), AppLayerProtoDetectConfProtoDetectionEnabledDefault(), ConfGetBool(), ConfNodeChildValueIsTrue(), ConfUnixSocketIsEnable(), FileForceHashParseCfg(), LogHttpLogInitCtx(), OutputEmailInitConf(), and RunModeInitializeOutputs().