suricata
util-var.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2024 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  */
23 
24 #ifndef SURICATA_UTIL_VAR_H
25 #define SURICATA_UTIL_VAR_H
26 
27 /** variable types: these are used to track variable names */
28 enum VarTypes {
30 
34  VAR_TYPE_PKT_VAR_KV, // key-value
35 
40 
44 
48 
51 };
52 
53 typedef struct GenericVar_ {
54  uint16_t type; /**< variable type, uses detection sm_type */
55  uint8_t pad[2];
56  uint32_t idx;
57  struct GenericVar_ *next;
59 
60 typedef struct XBit_ {
61  uint16_t type; /* type, DETECT_XBITS in this case */
62  uint8_t pad[2];
63  uint32_t idx; /* name idx */
66 } XBit;
67 
68 void XBitFree(XBit *);
69 
70 // A list of variables we try to resolve while parsing configuration file.
71 // Helps to detect recursive declarations.
72 typedef struct ResolvedVariable_ {
73  char var_name[256];
76 
77 typedef TAILQ_HEAD(, ResolvedVariable_) ResolvedVariablesList;
78 
82 
83 int AddVariableToResolveList(ResolvedVariablesList *list, const char *var);
84 void CleanVariableResolveList(ResolvedVariablesList *var_list);
85 
86 #endif /* SURICATA_UTIL_VAR_H */
XBit_::next
GenericVar * next
Definition: util-var.h:64
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
VAR_TYPE_IPPAIR_VAR
@ VAR_TYPE_IPPAIR_VAR
Definition: util-var.h:47
ResolvedVariable_
Definition: util-var.h:72
XBit_::expire
SCTime_t expire
Definition: util-var.h:65
GenericVarFree
void GenericVarFree(GenericVar *)
Definition: util-var.c:48
GenericVarAppend
void GenericVarAppend(GenericVar **, GenericVar *)
Definition: util-var.c:98
VAR_TYPE_HOST_VAR
@ VAR_TYPE_HOST_VAR
Definition: util-var.h:43
VAR_TYPE_PKT_INT
@ VAR_TYPE_PKT_INT
Definition: util-var.h:32
VAR_TYPE_PKT_VAR_KV
@ VAR_TYPE_PKT_VAR_KV
Definition: util-var.h:34
VAR_TYPE_NOT_SET
@ VAR_TYPE_NOT_SET
Definition: util-var.h:29
GenericVar_::next
struct GenericVar_ * next
Definition: util-var.h:57
AddVariableToResolveList
int AddVariableToResolveList(ResolvedVariablesList *list, const char *var)
Definition: util-var.c:139
TAILQ_HEAD
typedef TAILQ_HEAD(, ResolvedVariable_) ResolvedVariablesList
XBit
struct XBit_ XBit
ResolvedVariable_::var_name
char var_name[256]
Definition: util-var.h:73
VAR_TYPE_ALERT_VAR
@ VAR_TYPE_ALERT_VAR
Definition: util-var.h:50
GenericVar_::idx
uint32_t idx
Definition: util-var.h:56
VAR_TYPE_PKT_BIT
@ VAR_TYPE_PKT_BIT
Definition: util-var.h:31
SCTime_t
Definition: util-time.h:40
ResolvedVariable
struct ResolvedVariable_ ResolvedVariable
GenericVarRemove
void GenericVarRemove(GenericVar **, GenericVar *)
Definition: util-var.c:117
VAR_TYPE_FLOW_FLOAT
@ VAR_TYPE_FLOW_FLOAT
Definition: util-var.h:38
XBit_::type
uint16_t type
Definition: util-var.h:61
VAR_TYPE_FLOW_BIT
@ VAR_TYPE_FLOW_BIT
Definition: util-var.h:36
GenericVar_
Definition: util-var.h:53
CleanVariableResolveList
void CleanVariableResolveList(ResolvedVariablesList *var_list)
Definition: util-var.c:168
ResolvedVariable_::TAILQ_ENTRY
TAILQ_ENTRY(ResolvedVariable_) next
XBitFree
void XBitFree(XBit *)
Definition: util-var.c:40
VAR_TYPE_HOST_BIT
@ VAR_TYPE_HOST_BIT
Definition: util-var.h:41
VAR_TYPE_IPPAIR_INT
@ VAR_TYPE_IPPAIR_INT
Definition: util-var.h:46
VAR_TYPE_FLOW_VAR
@ VAR_TYPE_FLOW_VAR
Definition: util-var.h:39
VAR_TYPE_FLOW_INT
@ VAR_TYPE_FLOW_INT
Definition: util-var.h:37
GenericVar_::type
uint16_t type
Definition: util-var.h:54
VarTypes
VarTypes
Definition: util-var.h:28
VAR_TYPE_HOST_INT
@ VAR_TYPE_HOST_INT
Definition: util-var.h:42
VAR_TYPE_TX_BIT
@ VAR_TYPE_TX_BIT
Definition: util-var.h:49
XBit_::idx
uint32_t idx
Definition: util-var.h:63
GenericVar_::pad
uint8_t pad[2]
Definition: util-var.h:55
GenericVar
struct GenericVar_ GenericVar
XBit_
Definition: util-var.h:60
VAR_TYPE_IPPAIR_BIT
@ VAR_TYPE_IPPAIR_BIT
Definition: util-var.h:45
VAR_TYPE_PKT_VAR
@ VAR_TYPE_PKT_VAR
Definition: util-var.h:33
XBit_::pad
uint8_t pad[2]
Definition: util-var.h:62