suricata
detect-tos.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2020 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 Anoop Saldanha <anoopsaldanha@gmail.com>
22  */
23 
24 #include "suricata-common.h"
25 #include "threads.h"
26 #include "decode.h"
27 
28 #include "detect.h"
29 #include "detect-parse.h"
30 #include "detect-engine.h"
31 #include "detect-engine-mpm.h"
32 #include "detect-engine-state.h"
33 #include "detect-tos.h"
34 
35 #include "app-layer-protos.h"
36 
37 #include "flow.h"
38 #include "flow-var.h"
39 #include "flow-util.h"
40 
41 #include "util-byte.h"
42 #include "util-debug.h"
43 #include "util-unittest.h"
44 #include "util-unittest-helper.h"
45 
46 #define PARSE_REGEX "^\\s*(!?\\s*[0-9]{1,3}|!?\\s*[xX][0-9a-fA-F]{1,2})\\s*$"
47 
48 static DetectParseRegex parse_regex;
49 
50 static int DetectTosSetup(DetectEngineCtx *, Signature *, const char *);
51 static int DetectTosMatch(DetectEngineThreadCtx *, Packet *,
52  const Signature *, const SigMatchCtx *);
53 #ifdef UNITTESTS
54 static void DetectTosRegisterTests(void);
55 #endif
56 static void DetectTosFree(DetectEngineCtx *, void *);
57 
58 #define DETECT_IPTOS_MIN 0
59 #define DETECT_IPTOS_MAX 255
60 
61 /**
62  * \brief Register Tos keyword.
63  */
65 {
67  sigmatch_table[DETECT_TOS].desc = "match on specific decimal values of the IP header TOS field";
68  sigmatch_table[DETECT_TOS].Match = DetectTosMatch;
69  sigmatch_table[DETECT_TOS].Setup = DetectTosSetup;
70  sigmatch_table[DETECT_TOS].Free = DetectTosFree;
71 #ifdef UNITTESTS
72  sigmatch_table[DETECT_TOS].RegisterTests = DetectTosRegisterTests;
73 #endif
77  "/rules/header-keywords.html#tos";
78 
79  DetectSetupParseRegexes(PARSE_REGEX, &parse_regex);
80 }
81 
82 /**
83  * \brief Match function for tos keyword.
84  *
85  * \param tv ThreadVars instance.
86  * \param det_ctx Pointer to the detection thread ctx.
87  * \param p Pointer to the packet.
88  * \param m Pointer to the SigMatch containing the tos data.
89  *
90  * \retval 0 no match
91  * \retval 1 match
92  */
93 static int DetectTosMatch(DetectEngineThreadCtx *det_ctx, Packet *p,
94  const Signature *s, const SigMatchCtx *ctx)
95 {
96  const DetectTosData *tosd = (const DetectTosData *)ctx;
97  int result = 0;
98 
99  if (!PKT_IS_IPV4(p) || PKT_IS_PSEUDOPKT(p)) {
100  return 0;
101  }
102 
103  if (tosd->tos == IPV4_GET_IPTOS(p)) {
104  SCLogDebug("tos match found for %d\n", tosd->tos);
105  result = 1;
106  }
107 
108  return (tosd->negated ^ result);
109 }
110 
111 static DetectTosData *DetectTosParse(const char *arg, bool negate)
112 {
113  DetectTosData *tosd = NULL;
114  int ret = 0, res = 0;
115  size_t pcre2len;
116 
117  ret = DetectParsePcreExec(&parse_regex, arg, 0, 0);
118  if (ret != 2) {
119  SCLogError(SC_ERR_PCRE_MATCH, "invalid tos option - %s. "
120  "The tos option value must be in the range "
121  "%u - %u", arg, DETECT_IPTOS_MIN, DETECT_IPTOS_MAX);
122  goto error;
123  }
124 
125  /* For TOS value */
126  char tosbytes_str[64] = "";
127  pcre2len = sizeof(tosbytes_str);
128  res = pcre2_substring_copy_bynumber(
129  parse_regex.match, 1, (PCRE2_UCHAR8 *)tosbytes_str, &pcre2len);
130  if (res < 0) {
131  SCLogError(SC_ERR_PCRE_GET_SUBSTRING, "pcre2_substring_copy_bynumber failed");
132  goto error;
133  }
134 
135  int64_t tos = 0;
136 
137  if (tosbytes_str[0] == 'x' || tosbytes_str[0] == 'X') {
138  if (StringParseInt64(&tos, 16, 0, &tosbytes_str[1]) < 0) {
139  goto error;
140  }
141  } else {
142  if (StringParseInt64(&tos, 10, 0, &tosbytes_str[0]) < 0) {
143  goto error;
144  }
145  }
146 
147  if (!(tos >= DETECT_IPTOS_MIN && tos <= DETECT_IPTOS_MAX)) {
148  SCLogError(SC_ERR_INVALID_SIGNATURE, "Invalid tos argument - "
149  "%s. The tos option value must be in the range "
150  "%u - %u", tosbytes_str, DETECT_IPTOS_MIN, DETECT_IPTOS_MAX);
151  goto error;
152  }
153 
154  tosd = SCMalloc(sizeof(DetectTosData));
155  if (unlikely(tosd == NULL))
156  goto error;
157  tosd->tos = (uint8_t)tos;
158  tosd->negated = negate;
159 
160  return tosd;
161 
162 error:
163  return NULL;
164 }
165 
166 /**
167  * \brief Setup function for tos argument. Parse the argument and
168  * add it into the sig.
169  *
170  * \param de_ctx Detection Engine Context instance.
171  * \param s Pointer to the signature.
172  * \param arg Argument to be parsed.
173  *
174  * \retval 0 on Success.
175  * \retval -1 on Failure.
176  */
177 static int DetectTosSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)
178 {
179  DetectTosData *tosd = DetectTosParse(arg, s->init_data->negated);
180  if (tosd == NULL)
181  return -1;
182 
183  SigMatch *sm = SigMatchAlloc();
184  if (sm == NULL) {
185  DetectTosFree(de_ctx, tosd);
186  return -1;
187  }
188 
189  sm->type = DETECT_TOS;
190  sm->ctx = (SigMatchCtx *)tosd;
191 
194  return 0;
195 }
196 
197 /**
198  * \brief Free data allocated by the tos keyword.
199  *
200  * \param tosd Data to be freed.
201  */
202 static void DetectTosFree(DetectEngineCtx *de_ctx, void *tosd)
203 {
204  SCFree(tosd);
205 }
206 
207 /********************************Unittests***********************************/
208 
209 #ifdef UNITTESTS
210 
211 static int DetectTosTest01(void)
212 {
213  DetectTosData *tosd = NULL;
214  tosd = DetectTosParse("12", false);
215  if (tosd != NULL && tosd->tos == 12 && !tosd->negated) {
216  DetectTosFree(NULL, tosd);
217  return 1;
218  }
219 
220  return 0;
221 }
222 
223 static int DetectTosTest02(void)
224 {
225  DetectTosData *tosd = NULL;
226  tosd = DetectTosParse("123", false);
227  if (tosd != NULL && tosd->tos == 123 && !tosd->negated) {
228  DetectTosFree(NULL, tosd);
229  return 1;
230  }
231 
232  return 0;
233 }
234 
235 static int DetectTosTest04(void)
236 {
237  DetectTosData *tosd = NULL;
238  tosd = DetectTosParse("256", false);
239  if (tosd != NULL) {
240  DetectTosFree(NULL, tosd);
241  return 0;
242  }
243 
244  return 1;
245 }
246 
247 static int DetectTosTest05(void)
248 {
249  DetectTosData *tosd = NULL;
250  tosd = DetectTosParse("boom", false);
251  if (tosd != NULL) {
252  DetectTosFree(NULL, tosd);
253  return 0;
254  }
255 
256  return 1;
257 }
258 
259 static int DetectTosTest06(void)
260 {
261  DetectTosData *tosd = NULL;
262  tosd = DetectTosParse("x12", false);
263  if (tosd != NULL && tosd->tos == 0x12 && !tosd->negated) {
264  DetectTosFree(NULL, tosd);
265  return 1;
266  }
267 
268  return 0;
269 }
270 
271 static int DetectTosTest07(void)
272 {
273  DetectTosData *tosd = NULL;
274  tosd = DetectTosParse("X12", false);
275  if (tosd != NULL && tosd->tos == 0x12 && !tosd->negated) {
276  DetectTosFree(NULL, tosd);
277  return 1;
278  }
279 
280  return 0;
281 }
282 
283 static int DetectTosTest08(void)
284 {
285  DetectTosData *tosd = NULL;
286  tosd = DetectTosParse("x121", false);
287  if (tosd != NULL) {
288  DetectTosFree(NULL, tosd);
289  return 0;
290  }
291 
292  return 1;
293 }
294 
295 static int DetectTosTest09(void)
296 {
297  DetectTosData *tosd = NULL;
298  tosd = DetectTosParse("12", true);
299  if (tosd != NULL && tosd->tos == 12 && tosd->negated) {
300  DetectTosFree(NULL, tosd);
301  return 1;
302  }
303 
304  return 0;
305 }
306 
307 static int DetectTosTest10(void)
308 {
309  DetectTosData *tosd = NULL;
310  tosd = DetectTosParse("x12", true);
311  if (tosd != NULL && tosd->tos == 0x12 && tosd->negated) {
312  DetectTosFree(NULL, tosd);
313  return 1;
314  }
315 
316  return 0;
317 }
318 
319 static int DetectTosTest12(void)
320 {
321  int result = 0;
322  uint8_t *buf = (uint8_t *)"Hi all!";
323  uint16_t buflen = strlen((char *)buf);
324  Packet *p;
325 
326  p = UTHBuildPacket((uint8_t *)buf, buflen, IPPROTO_TCP);
327 
328  if (p == NULL)
329  goto end;
330 
331  IPV4_SET_RAW_IPTOS(p->ip4h, 10);
332 
333  const char *sigs[4];
334  sigs[0]= "alert ip any any -> any any (msg:\"Testing id 1\"; tos: 10 ; sid:1;)";
335  sigs[1]= "alert ip any any -> any any (msg:\"Testing id 2\"; tos: ! 10; sid:2;)";
336  sigs[2]= "alert ip any any -> any any (msg:\"Testing id 3\"; tos:20 ; sid:3;)";
337  sigs[3]= "alert ip any any -> any any (msg:\"Testing id 3\"; tos:! 20; sid:4;)";
338 
339  uint32_t sid[4] = {1, 2, 3, 4};
340 
341  uint32_t results[1][4] =
342  {
343  {1, 0, 0, 1},
344  };
345 
346  result = UTHGenericTest(&p, 1, sigs, sid, (uint32_t *) results, 4);
347 
348  UTHFreePackets(&p, 1);
349 
350 end:
351  return result;
352 }
353 
354 void DetectTosRegisterTests(void)
355 {
356  UtRegisterTest("DetectTosTest01", DetectTosTest01);
357  UtRegisterTest("DetectTosTest02", DetectTosTest02);
358  UtRegisterTest("DetectTosTest04", DetectTosTest04);
359  UtRegisterTest("DetectTosTest05", DetectTosTest05);
360  UtRegisterTest("DetectTosTest06", DetectTosTest06);
361  UtRegisterTest("DetectTosTest07", DetectTosTest07);
362  UtRegisterTest("DetectTosTest08", DetectTosTest08);
363  UtRegisterTest("DetectTosTest09", DetectTosTest09);
364  UtRegisterTest("DetectTosTest10", DetectTosTest10);
365  UtRegisterTest("DetectTosTest12", DetectTosTest12);
366  return;
367 }
368 #endif
util-byte.h
DetectParseRegex::match
pcre2_match_data * match
Definition: detect-parse.h:45
SigTableElmt_::url
const char * url
Definition: detect.h:1248
detect-engine.h
PARSE_REGEX
#define PARSE_REGEX
Definition: detect-tos.c:46
SigTableElmt_::desc
const char * desc
Definition: detect.h:1247
DetectParsePcreExec
int DetectParsePcreExec(DetectParseRegex *parse_regex, const char *str, int start_offset, int options)
Definition: detect-parse.c:2475
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1235
flow-util.h
DetectParseRegex
Definition: detect-parse.h:42
SigTableElmt_::name
const char * name
Definition: detect.h:1245
PKT_IS_PSEUDOPKT
#define PKT_IS_PSEUDOPKT(p)
return 1 if the packet is a pseudo packet
Definition: decode.h:1222
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:296
SIGMATCH_QUOTES_OPTIONAL
#define SIGMATCH_QUOTES_OPTIONAL
Definition: detect.h:1443
threads.h
results
struct DetectRfbSecresult_ results[]
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1239
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:785
SC_ERR_INVALID_SIGNATURE
@ SC_ERR_INVALID_SIGNATURE
Definition: util-error.h:69
DETECT_IPTOS_MAX
#define DETECT_IPTOS_MAX
Definition: detect-tos.c:59
UTHBuildPacket
Packet * UTHBuildPacket(uint8_t *payload, uint16_t payload_len, uint8_t ipproto)
UTHBuildPacket is a wrapper that build packets with default ip and port fields.
Definition: util-unittest-helper.c:338
SC_ERR_PCRE_GET_SUBSTRING
@ SC_ERR_PCRE_GET_SUBSTRING
Definition: util-error.h:34
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1230
util-unittest.h
util-unittest-helper.h
decode.h
util-debug.h
SC_ERR_PCRE_MATCH
@ SC_ERR_PCRE_MATCH
Definition: util-error.h:32
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1034
res
PoolThreadReserved res
Definition: stream-tcp-private.h:0
DetectSetupParseRegexes
void DetectSetupParseRegexes(const char *parse_str, DetectParseRegex *detect_parse)
Definition: detect-parse.c:2598
detect-tos.h
detect-engine-mpm.h
detect.h
DETECT_SM_LIST_MATCH
@ DETECT_SM_LIST_MATCH
Definition: detect.h:80
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:317
Signature_::flags
uint32_t flags
Definition: detect.h:541
Packet_
Definition: decode.h:434
DETECT_IPTOS_MIN
#define DETECT_IPTOS_MIN
Definition: detect-tos.c:58
Packet_::ip4h
IPV4Hdr * ip4h
Definition: decode.h:532
SIGMATCH_HANDLE_NEGATION
#define SIGMATCH_HANDLE_NEGATION
Definition: detect.h:1451
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:611
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
StringParseInt64
int StringParseInt64(int64_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:608
SignatureInitData_::negated
bool negated
Definition: detect.h:495
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1213
SigMatchAlloc
SigMatch * SigMatchAlloc(void)
Definition: detect-parse.c:235
IPV4_SET_RAW_IPTOS
#define IPV4_SET_RAW_IPTOS(ip4h, value)
Definition: decode-ipv4.h:113
SigMatchCtx_
Used to start a pointer to SigMatch context Should never be dereferenced without casting to something...
Definition: detect.h:309
DetectTosData_::negated
uint8_t negated
Definition: detect-tos.h:28
suricata-common.h
SigMatch_::type
uint16_t type
Definition: detect.h:315
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:255
UTHGenericTest
int UTHGenericTest(Packet **pkt, int numpkts, const char *sigs[], uint32_t sids[], uint32_t *results, int numsigs)
UTHGenericTest: function that perfom a generic check taking care of as maximum common unittest elemen...
Definition: util-unittest-helper.c:605
DetectTosRegister
void DetectTosRegister(void)
Register Tos keyword.
Definition: detect-tos.c:64
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
IPV4_GET_IPTOS
#define IPV4_GET_IPTOS(p)
Definition: decode-ipv4.h:124
SCFree
#define SCFree(p)
Definition: util-mem.h:61
detect-parse.h
Signature_
Signature container.
Definition: detect.h:540
SigMatch_
a single match condition for a signature
Definition: detect.h:314
DETECT_TOS
@ DETECT_TOS
Definition: detect-engine-register.h:44
app-layer-protos.h
flow.h
flow-var.h
PKT_IS_IPV4
#define PKT_IS_IPV4(p)
Definition: decode.h:253
SigMatchAppendSMToList
void SigMatchAppendSMToList(Signature *s, SigMatch *new, int list)
Append a SigMatch to the list type.
Definition: detect-parse.c:349
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1237
DetectTosData_::tos
uint8_t tos
Definition: detect-tos.h:29
DetectTosData_
Definition: detect-tos.h:27
SIG_FLAG_REQUIRE_PACKET
#define SIG_FLAG_REQUIRE_PACKET
Definition: detect.h:217
UTHFreePackets
void UTHFreePackets(Packet **p, int numpkts)
UTHFreePackets: function to release the allocated data from UTHBuildPacket and the packet itself.
Definition: util-unittest-helper.c:469