suricata.8.0.0/conf_8h_source.html

/* Copyright (C) 2007-2023 Open Information Security Foundation

 *

 * You can copy, redistribute or modify this Program under the terms of

 * the GNU General Public License version 2 as published by the Free

 * Software Foundation.

 *

 * 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

 * version 2 along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

 * 02110-1301, USA.

 */


/**

 * \file

 *

 * \author Endace Technology Limited - Jason Ish <jason.ish@endace.com>

 */


#ifndef SURICATA_CONF_H

#define SURICATA_CONF_H


#ifdef __cplusplus

extern "C"

{

#endif


#include "queue.h"


/**

 * Structure of a configuration parameter.

 */


typedef struct SCConfNode_ {

    char *name;

    char *val;


    int is_seq;


    /**< Flag that sets this nodes value as final. */

    int final;


    struct SCConfNode_ *parent;

    TAILQ_HEAD(, SCConfNode_) head;

    TAILQ_ENTRY(SCConfNode_) next;

} SCConfNode;


/**

 * The default log directory.

 */

#ifdef OS_WIN32

#define DEFAULT_LOG_DIR "C:\\WINDOWS\\Temp"

#define DEFAULT_DATA_DIR "C:\\WINDOWS\\Temp"

#else

#define DEFAULT_LOG_DIR "/var/log/suricata"

#define DEFAULT_DATA_DIR DATA_DIR

#endif /* OS_WIN32 */


void SCConfInit(void);

void SCConfDeInit(void);

SCConfNode *SCConfGetRootNode(void);

int SCConfGet(const char *name, const char **vptr);

int SCConfGetInt(const char *name, intmax_t *val);

int SCConfGetBool(const char *name, int *val);

int SCConfGetDouble(const char *name, double *val);

int SCConfGetFloat(const char *name, float *val);

int SCConfSet(const char *name, const char *val);

int SCConfSetFromString(const char *input, int final);

int SCConfSetFinal(const char *name, const char *val);

void SCConfDump(void);

void SCConfNodeDump(const SCConfNode *node, const char *prefix);

SCConfNode *SCConfNodeNew(void);

void SCConfNodeFree(SCConfNode *);

SCConfNode *SCConfGetNode(const char *key);

void SCConfCreateContextBackup(void);

void SCConfRestoreContextBackup(void);

SCConfNode *SCConfNodeLookupChild(const SCConfNode *node, const char *key);

const char *SCConfNodeLookupChildValue(const SCConfNode *node, const char *key);

void SCConfNodeRemove(SCConfNode *);

void SCConfRegisterTests(void);

int SCConfNodeChildValueIsTrue(const SCConfNode *node, const char *key);

int SCConfValIsTrue(const char *val);

int SCConfValIsFalse(const char *val);

void SCConfNodePrune(SCConfNode *node);

int SCConfRemove(const char *name);

bool SCConfNodeHasChildren(const SCConfNode *node);


SCConfNode *SCConfGetChildWithDefault(

        const SCConfNode *base, const SCConfNode *dflt, const char *name);

SCConfNode *SCConfNodeLookupKeyValue(const SCConfNode *base, const char *key, const char *value);

int SCConfGetChildValue(const SCConfNode *base, const char *name, const char **vptr);

int SCConfGetChildValueInt(const SCConfNode *base, const char *name, intmax_t *val);

int SCConfGetChildValueBool(const SCConfNode *base, const char *name, int *val);

int SCConfGetChildValueWithDefault(

        const SCConfNode *base, const SCConfNode *dflt, const char *name, const char **vptr);

int SCConfGetChildValueIntWithDefault(

        const SCConfNode *base, const SCConfNode *dflt, const char *name, intmax_t *val);

int SCConfGetChildValueBoolWithDefault(

        const SCConfNode *base, const SCConfNode *dflt, const char *name, int *val);

int SCConfNodeIsSequence(const SCConfNode *node);

SCConfNode *SCConfSetIfaceNode(const char *ifaces_node_name, const char *iface);

int SCConfSetRootAndDefaultNodes(const char *ifaces_node_name, const char *iface,

        SCConfNode **if_root, SCConfNode **if_default);

SCConfNode *SCConfNodeGetNodeOrCreate(SCConfNode *parent, const char *name, int final);


SCConfNode *SCConfGetFirstNode(const SCConfNode *parent);

SCConfNode *SCConfGetNextNode(const SCConfNode *node);

const char *SCConfGetValueNode(const SCConfNode *node);


#ifdef __cplusplus

}

#endif


#endif /* ! SURICATA_CONF_H */

next
struct HtpBodyChunk_ * next
Definition app-layer-htp.h:0

SCConfInit
void SCConfInit(void)
Initialize the configuration system.
Definition conf.c:120

SCConfNodeHasChildren
bool SCConfNodeHasChildren(const SCConfNode *node)
Check if a node has any children.
Definition conf.c:777

SCConfNodeChildValueIsTrue
int SCConfNodeChildValueIsTrue(const SCConfNode *node, const char *key)
Test if a configuration node has a true value.
Definition conf.c:868

SCConfSetRootAndDefaultNodes
int SCConfSetRootAndDefaultNodes(const char *ifaces_node_name, const char *iface, SCConfNode **if_root, SCConfNode **if_default)
Finds and sets root and default node of the interface.
Definition conf.c:962

SCConfRegisterTests
void SCConfRegisterTests(void)
Definition conf.c:1471

SCConfGetChildWithDefault
SCConfNode * SCConfGetChildWithDefault(const SCConfNode *base, const SCConfNode *dflt, const char *name)
Definition conf.c:379

SCConfGetFirstNode
SCConfNode * SCConfGetFirstNode(const SCConfNode *parent)
Definition conf.c:204

SCConfNodeRemove
void SCConfNodeRemove(SCConfNode *)
Remove (and SCFree) the provided configuration node.
Definition conf.c:653

SCConfValIsTrue
int SCConfValIsTrue(const char *val)
Check if a value is true.
Definition conf.c:551

SCConfDeInit
void SCConfDeInit(void)
De-initializes the configuration system.
Definition conf.c:703

SCConfGetNextNode
SCConfNode * SCConfGetNextNode(const SCConfNode *node)
Definition conf.c:209

SCConfGetNode
SCConfNode * SCConfGetNode(const char *key)
Get a SCConfNode by name.
Definition conf.c:181

SCConfDump
void SCConfDump(void)
Dump configuration to stdout.
Definition conf.c:761

SCConfGetChildValueWithDefault
int SCConfGetChildValueWithDefault(const SCConfNode *base, const SCConfNode *dflt, const char *name, const char **vptr)
Definition conf.c:393

SCConfGetInt
int SCConfGetInt(const char *name, intmax_t *val)
Retrieve a configuration value as an integer.
Definition conf.c:414

SCConfNodeIsSequence
int SCConfNodeIsSequence(const SCConfNode *node)
Check if a node is a sequence or node.
Definition conf.c:925

SCConfRemove
int SCConfRemove(const char *name)
Remove a configuration parameter from the configuration db.
Definition conf.c:668

SCConfSetFinal
int SCConfSetFinal(const char *name, const char *val)
Set a final configuration value.
Definition conf.c:318

SCConfGetFloat
int SCConfGetFloat(const char *name, float *val)
Retrieve a configuration value as a float.
Definition conf.c:630

SCConfGetChildValueInt
int SCConfGetChildValueInt(const SCConfNode *base, const char *name, intmax_t *val)
Definition conf.c:449

SCConfGetBool
int SCConfGetBool(const char *name, int *val)
Retrieve a configuration value as a boolean.
Definition conf.c:497

SCConfGetChildValueBool
int SCConfGetChildValueBool(const SCConfNode *base, const char *name, int *val)
Definition conf.c:515

SCConfSetIfaceNode
SCConfNode * SCConfSetIfaceNode(const char *ifaces_node_name, const char *iface)
Finds an interface from the list of interfaces.
Definition conf.c:936

SCConfSet
int SCConfSet(const char *name, const char *val)
Set a configuration value.
Definition conf.c:239

SCConfGetRootNode
SCConfNode * SCConfGetRootNode(void)
Get the root configuration node.
Definition conf.c:222

SCConfNodeLookupChild
SCConfNode * SCConfNodeLookupChild(const SCConfNode *node, const char *key)
Lookup a child configuration node by name.
Definition conf.c:796

SCConfNodeLookupKeyValue
SCConfNode * SCConfNodeLookupKeyValue(const SCConfNode *base, const char *key, const char *value)
Lookup for a key value under a specific node.
Definition conf.c:841

SCConfNodeLookupChildValue
const char * SCConfNodeLookupChildValue(const SCConfNode *node, const char *key)
Lookup the value of a child configuration node by name.
Definition conf.c:824

SCConfSetFromString
int SCConfSetFromString(const char *input, int final)
Set a configuration parameter from a string.
Definition conf.c:264

SCConfValIsFalse
int SCConfValIsFalse(const char *val)
Check if a value is false.
Definition conf.c:576

SCConfGet
int SCConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition conf.c:350

SCConfGetChildValueBoolWithDefault
int SCConfGetChildValueBoolWithDefault(const SCConfNode *base, const SCConfNode *dflt, const char *name, int *val)
Definition conf.c:528

SCConfGetValueNode
const char * SCConfGetValueNode(const SCConfNode *node)
Definition conf.c:214

SCConfNodeDump
void SCConfNodeDump(const SCConfNode *node, const char *prefix)
Dump a configuration node and all its children.
Definition conf.c:731

SCConfNodeGetNodeOrCreate
SCConfNode * SCConfNodeGetNodeOrCreate(SCConfNode *parent, const char *name, int final)
Helper function to get a node, creating it if it does not exist.
Definition conf.c:66

SCConfCreateContextBackup
void SCConfCreateContextBackup(void)
Creates a backup of the conf_hash hash_table used by the conf API.
Definition conf.c:684

SCConfGetChildValueIntWithDefault
int SCConfGetChildValueIntWithDefault(const SCConfNode *base, const SCConfNode *dflt, const char *name, intmax_t *val)
Definition conf.c:476

SCConfNode
struct SCConfNode_ SCConfNode

SCConfGetDouble
int SCConfGetDouble(const char *name, double *val)
Retrieve a configuration value as a double.
Definition conf.c:600

SCConfNodeNew
SCConfNode * SCConfNodeNew(void)
Allocate a new configuration node.
Definition conf.c:139

SCConfNodePrune
void SCConfNodePrune(SCConfNode *node)
Create the path for an include entry.
Definition conf.c:893

SCConfRestoreContextBackup
void SCConfRestoreContextBackup(void)
Restores the backup of the hash_table present in backup_conf_hash back to conf_hash.
Definition conf.c:694

SCConfNodeFree
void SCConfNodeFree(SCConfNode *)
Free a SCConfNode and all of its children.
Definition conf.c:157

SCConfGetChildValue
int SCConfGetChildValue(const SCConfNode *base, const char *name, const char **vptr)
Definition conf.c:363

head
Flow * head
Definition flow-hash.h:1

queue.h

SCConfNode_
Definition conf.h:37

SCConfNode_::TAILQ_HEAD
TAILQ_HEAD(, SCConfNode_) head

SCConfNode_::is_seq
int is_seq
Definition conf.h:41

SCConfNode_::name
char * name
Definition conf.h:38

SCConfNode_::val
char * val
Definition conf.h:39

SCConfNode_::parent
struct SCConfNode_ * parent
Definition conf.h:46

SCConfNode_::TAILQ_ENTRY
TAILQ_ENTRY(SCConfNode_) next

name
const char * name
Definition tm-threads.c:2163