1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/* Copyright (C) 2007-2020 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 XXX
*
*/
#include "suricata-common.h"
#include "util-byte.h"
#include "detect.h"
#include "detect-parse.h"
#include "detect-engine-prefilter-common.h"
#include "detect-engine-uint.h"
#include "detect-template2.h"
/* prototypes */
static int DetectTemplate2Match (DetectEngineThreadCtx *, Packet *,
const Signature *, const SigMatchCtx *);
static int DetectTemplate2Setup (DetectEngineCtx *, Signature *, const char *);
void DetectTemplate2Free (DetectEngineCtx *, void *);
#ifdef UNITTESTS
void DetectTemplate2RegisterTests (void);
#endif
static int PrefilterSetupTemplate2(DetectEngineCtx *de_ctx, SigGroupHead *sgh);
static bool PrefilterTemplate2IsPrefilterable(const Signature *s);
/**
* \brief Registration function for template2: keyword
*/
void DetectTemplate2Register(void)
{
sigmatch_table[DETECT_TEMPLATE2].name = "template2";
sigmatch_table[DETECT_TEMPLATE2].desc = "TODO describe the keyword";
sigmatch_table[DETECT_TEMPLATE2].url = "/rules/header-keywords.html#template2";
sigmatch_table[DETECT_TEMPLATE2].Match = DetectTemplate2Match;
sigmatch_table[DETECT_TEMPLATE2].Setup = DetectTemplate2Setup;
sigmatch_table[DETECT_TEMPLATE2].Free = DetectTemplate2Free;
sigmatch_table[DETECT_TEMPLATE2].SupportsPrefilter = PrefilterTemplate2IsPrefilterable;
sigmatch_table[DETECT_TEMPLATE2].SetupPrefilter = PrefilterSetupTemplate2;
return;
}
/**
* \brief This function is used to match TEMPLATE2 rule option on a packet with those passed via
* template2:
*
* \param t pointer to thread vars
* \param det_ctx pointer to the pattern matcher thread
* \param p pointer to the current packet
* \param m pointer to the sigmatch that we will cast into DetectU8Data
*
* \retval 0 no match
* \retval 1 match
*/
static int DetectTemplate2Match (DetectEngineThreadCtx *det_ctx, Packet *p,
const Signature *s, const SigMatchCtx *ctx)
{
if (PKT_IS_PSEUDOPKT(p))
return 0;
/* TODO replace this */
uint8_t ptemplate2;
if (PKT_IS_IPV4(p)) {
ptemplate2 = IPV4_GET_IPTTL(p);
} else if (PKT_IS_IPV6(p)) {
ptemplate2 = IPV6_GET_HLIM(p);
} else {
SCLogDebug("Packet is of not IPv4 or IPv6");
return 0;
}
const DetectU8Data *template2d = (const DetectU8Data *)ctx;
return DetectU8Match(ptemplate2, template2d);
}
/**
* \brief this function is used to add the parsed template2 data into the current signature
*
* \param de_ctx pointer to the Detection Engine Context
* \param s pointer to the Current Signature
* \param template2str pointer to the user provided template2 options
*
* \retval 0 on Success
* \retval -1 on Failure
*/
static int DetectTemplate2Setup (DetectEngineCtx *de_ctx, Signature *s, const char *template2str)
{
DetectU8Data *template2d = DetectU8Parse(template2str);
if (template2d == NULL)
return -1;
SigMatch *sm = SigMatchAlloc();
if (sm == NULL) {
DetectTemplate2Free(de_ctx, template2d);
return -1;
}
sm->type = DETECT_TEMPLATE2;
sm->ctx = (SigMatchCtx *)template2d;
SigMatchAppendSMToList(s, sm, DETECT_SM_LIST_MATCH);
s->flags |= SIG_FLAG_REQUIRE_PACKET;
return 0;
}
/**
* \brief this function will free memory associated with DetectU8Data
*
* \param ptr pointer to DetectU8Data
*/
void DetectTemplate2Free(DetectEngineCtx *de_ctx, void *ptr)
{
rs_detect_u8_free(ptr);
}
/* prefilter code */
static void
PrefilterPacketTemplate2Match(DetectEngineThreadCtx *det_ctx, Packet *p, const void *pectx)
{
if (PKT_IS_PSEUDOPKT(p)) {
SCReturn;
}
uint8_t ptemplate2;
/* TODO update */
if (PKT_IS_IPV4(p)) {
ptemplate2 = IPV4_GET_IPTTL(p);
} else if (PKT_IS_IPV6(p)) {
ptemplate2 = IPV6_GET_HLIM(p);
} else {
SCLogDebug("Packet is of not IPv4 or IPv6");
return;
}
/* during setup Suricata will automatically see if there is another
* check that can be added: alproto, sport or dport */
const PrefilterPacketHeaderCtx *ctx = pectx;
if (!PrefilterPacketHeaderExtraMatch(ctx, p))
return;
DetectU8Data du8;
du8.mode = ctx->v1.u8[0];
du8.arg1 = ctx->v1.u8[1];
du8.arg2 = ctx->v1.u8[2];
/* if we match, add all the sigs that use this prefilter. This means
* that these will be inspected further */
if (DetectU8Match(ptemplate2, &du8)) {
SCLogDebug("packet matches template2/hl %u", ptemplate2);
PrefilterAddSids(&det_ctx->pmq, ctx->sigs_array, ctx->sigs_cnt);
}
}
static int PrefilterSetupTemplate2(DetectEngineCtx *de_ctx, SigGroupHead *sgh)
{
return PrefilterSetupPacketHeader(de_ctx, sgh, DETECT_TEMPLATE2, PrefilterPacketU8Set,
PrefilterPacketU8Compare, PrefilterPacketTemplate2Match);
}
static bool PrefilterTemplate2IsPrefilterable(const Signature *s)
{
const SigMatch *sm;
for (sm = s->init_data->smlists[DETECT_SM_LIST_MATCH] ; sm != NULL; sm = sm->next) {
switch (sm->type) {
case DETECT_TEMPLATE2:
return true;
}
}
return false;
}
|
