suricata
detect-flow.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 Victor Julien <victor@inliniac.net>
22  *
23  * FLOW part of the detection engine.
24  */
25 
26 #include "suricata-common.h"
27 #include "decode.h"
28 
29 #include "detect.h"
30 #include "detect-parse.h"
31 #include "detect-engine.h"
33 #include "detect-engine-build.h"
34 
35 #include "flow.h"
36 #include "flow-var.h"
37 
38 #include "detect-flow.h"
39 
40 #include "util-unittest.h"
41 #include "util-unittest-helper.h"
42 #include "util-debug.h"
43 
44 /**
45  * \brief Regex for parsing our flow options
46  */
47 #define PARSE_REGEX "^\\s*([A-z_]+)\\s*(?:,\\s*([A-z_]+))?\\s*(?:,\\s*([A-z_]+))?\\s*$"
48 
49 static DetectParseRegex parse_regex;
50 
52  const Signature *, const SigMatchCtx *);
53 static int DetectFlowSetup (DetectEngineCtx *, Signature *, const char *);
54 #ifdef UNITTESTS
55 static void DetectFlowRegisterTests(void);
56 #endif
57 void DetectFlowFree(DetectEngineCtx *, void *);
58 
59 static int PrefilterSetupFlow(DetectEngineCtx *de_ctx, SigGroupHead *sgh);
60 static bool PrefilterFlowIsPrefilterable(const Signature *s);
61 
62 /**
63  * \brief Registration function for flow: keyword
64  */
65 void DetectFlowRegister (void)
66 {
68  sigmatch_table[DETECT_FLOW].desc = "match on direction and state of the flow";
69  sigmatch_table[DETECT_FLOW].url = "/rules/flow-keywords.html#flow";
71  sigmatch_table[DETECT_FLOW].Setup = DetectFlowSetup;
74 #ifdef UNITTESTS
75  sigmatch_table[DETECT_FLOW].RegisterTests = DetectFlowRegisterTests;
76 #endif
77  sigmatch_table[DETECT_FLOW].SupportsPrefilter = PrefilterFlowIsPrefilterable;
78  sigmatch_table[DETECT_FLOW].SetupPrefilter = PrefilterSetupFlow;
79  /* all but pre_flow */
83 
84  DetectSetupParseRegexes(PARSE_REGEX, &parse_regex);
85 }
86 
87 /**
88  * \param pflags packet flags (p->flags)
89  * \param pflowflags packet flow flags (p->flowflags)
90  * \param dflags detect flow flags
91  * \param match_cnt number of matches to trigger
92  */
93 static inline int FlowMatch(const uint32_t pflags, const uint8_t pflowflags, const uint16_t dflags,
94  const uint16_t match_cnt)
95 {
96  uint8_t cnt = 0;
97 
98  if ((dflags & DETECT_FLOW_FLAG_NO_FRAG) &&
99  (!(pflags & PKT_REBUILT_FRAGMENT))) {
100  cnt++;
101  } else if ((dflags & DETECT_FLOW_FLAG_ONLY_FRAG) &&
102  (pflags & PKT_REBUILT_FRAGMENT)) {
103  cnt++;
104  }
105 
106  if ((dflags & DETECT_FLOW_FLAG_TOSERVER) && (pflowflags & FLOW_PKT_TOSERVER)) {
107  cnt++;
108  } else if ((dflags & DETECT_FLOW_FLAG_TOCLIENT) && (pflowflags & FLOW_PKT_TOCLIENT)) {
109  cnt++;
110  }
111 
112  if ((dflags & DETECT_FLOW_FLAG_ESTABLISHED) && (pflowflags & FLOW_PKT_ESTABLISHED)) {
113  cnt++;
114  } else if (dflags & DETECT_FLOW_FLAG_NOT_ESTABLISHED && (!(pflowflags & FLOW_PKT_ESTABLISHED))) {
115  cnt++;
116  } else if (dflags & DETECT_FLOW_FLAG_STATELESS) {
117  cnt++;
118  }
119 
120  return (match_cnt == cnt) ? 1 : 0;
121 }
122 
123 /**
124  * \brief This function is used to match flow flags set on a packet with those passed via flow:
125  *
126  * \param t pointer to thread vars
127  * \param det_ctx pointer to the pattern matcher thread
128  * \param p pointer to the current packet
129  * \param m pointer to the sigmatch that we will cast into DetectFlowData
130  *
131  * \retval 0 no match
132  * \retval 1 match
133  */
135  const Signature *s, const SigMatchCtx *ctx)
136 {
137  SCEnter();
138 
139  SCLogDebug("pkt %p", p);
140 
141  if (p->flowflags & FLOW_PKT_TOSERVER) {
142  SCLogDebug("FLOW_PKT_TOSERVER");
143  } else if (p->flowflags & FLOW_PKT_TOCLIENT) {
144  SCLogDebug("FLOW_PKT_TOCLIENT");
145  }
146 
147  if (p->flowflags & FLOW_PKT_ESTABLISHED) {
148  SCLogDebug("FLOW_PKT_ESTABLISHED");
149  }
150 
151  const DetectFlowData *fd = (const DetectFlowData *)ctx;
152 
153  const int ret = FlowMatch(p->flags, p->flowflags, fd->flags, fd->match_cnt);
154  SCLogDebug("returning %" PRId32 " fd->match_cnt %" PRId32 " fd->flags 0x%02X p->flowflags 0x%02X",
155  ret, fd->match_cnt, fd->flags, p->flowflags);
156  SCReturnInt(ret);
157 }
158 
159 /**
160  * \brief This function is used to parse flow options passed via flow: keyword
161  *
162  * \param de_ctx Pointer to the detection engine context
163  * \param flowstr Pointer to the user provided flow options
164  * \param[out] parse_flags keyword flags only used during parsing
165  *
166  * \retval fd pointer to DetectFlowData on success
167  * \retval NULL on failure
168  */
169 static DetectFlowData *DetectFlowParse(
170  DetectEngineCtx *de_ctx, const char *flowstr, uint16_t *parse_flags)
171 {
172  DetectFlowData *fd = NULL;
173  char *args[3] = {NULL,NULL,NULL};
174  int res = 0;
175  size_t pcre2len;
176  char str1[16] = "", str2[16] = "", str3[16] = "";
177  pcre2_match_data *match = NULL;
178 
179  int ret = DetectParsePcreExec(&parse_regex, &match, flowstr, 0, 0);
180  if (ret < 1 || ret > 4) {
181  SCLogError("parse error, ret %" PRId32 ", string %s", ret, flowstr);
182  goto error;
183  }
184 
185  if (ret > 1) {
186  pcre2len = sizeof(str1);
187  res = SC_Pcre2SubstringCopy(match, 1, (PCRE2_UCHAR8 *)str1, &pcre2len);
188  if (res < 0) {
189  SCLogError("pcre2_substring_copy_bynumber failed");
190  goto error;
191  }
192  args[0] = (char *)str1;
193 
194  if (ret > 2) {
195  pcre2len = sizeof(str2);
196  res = pcre2_substring_copy_bynumber(match, 2, (PCRE2_UCHAR8 *)str2, &pcre2len);
197  if (res < 0) {
198  SCLogError("pcre2_substring_copy_bynumber failed");
199  goto error;
200  }
201  args[1] = (char *)str2;
202  }
203  if (ret > 3) {
204  pcre2len = sizeof(str3);
205  res = pcre2_substring_copy_bynumber(match, 3, (PCRE2_UCHAR8 *)str3, &pcre2len);
206  if (res < 0) {
207  SCLogError("pcre2_substring_copy_bynumber failed");
208  goto error;
209  }
210  args[2] = (char *)str3;
211  }
212  }
213 
214  fd = SCMalloc(sizeof(DetectFlowData));
215  if (unlikely(fd == NULL))
216  goto error;
217  fd->flags = 0;
218  fd->match_cnt = 0;
219 
220  for (int i = 0; i < (ret - 1); i++) {
221  if (args[i]) {
222  /* inspect our options and set the flags */
223  if (strcasecmp(args[i], "established") == 0) {
225  SCLogError("DETECT_FLOW_FLAG_ESTABLISHED flag is already set");
226  goto error;
227  } else if (fd->flags & DETECT_FLOW_FLAG_NOT_ESTABLISHED) {
228  SCLogError("cannot set DETECT_FLOW_FLAG_ESTABLISHED, "
229  "DETECT_FLOW_FLAG_NOT_ESTABLISHED already set");
230  goto error;
231  } else if (fd->flags & DETECT_FLOW_FLAG_STATELESS) {
232  SCLogError("DETECT_FLOW_FLAG_STATELESS already set");
233  goto error;
234  }
236  fd->match_cnt++;
237  } else if (strcasecmp(args[i], "not_established") == 0) {
239  SCLogError("DETECT_FLOW_FLAG_NOT_ESTABLISHED flag is already set");
240  goto error;
241  } else if (fd->flags & DETECT_FLOW_FLAG_ESTABLISHED) {
242  SCLogError("cannot set DETECT_FLOW_FLAG_NOT_ESTABLISHED, "
243  "DETECT_FLOW_FLAG_ESTABLISHED already set");
244  goto error;
245  }
247  fd->match_cnt++;
248  } else if (strcasecmp(args[i], "stateless") == 0) {
249  if (fd->flags & DETECT_FLOW_FLAG_STATELESS) {
250  SCLogError("DETECT_FLOW_FLAG_STATELESS flag is already set");
251  goto error;
252  } else if (fd->flags & DETECT_FLOW_FLAG_ESTABLISHED) {
253  SCLogError("cannot set DETECT_FLOW_FLAG_STATELESS, "
254  "DETECT_FLOW_FLAG_ESTABLISHED already set");
255  goto error;
256  }
258  fd->match_cnt++;
259  } else if (strcasecmp(args[i], "to_client") == 0 || strcasecmp(args[i], "from_server") == 0) {
260  if (fd->flags & DETECT_FLOW_FLAG_TOCLIENT) {
261  SCLogError("cannot set DETECT_FLOW_FLAG_TOCLIENT flag is already set");
262  goto error;
263  } else if (fd->flags & DETECT_FLOW_FLAG_TOSERVER) {
264  SCLogError("cannot set to_client, DETECT_FLOW_FLAG_TOSERVER already set");
265  goto error;
266  }
268  fd->match_cnt++;
269  } else if (strcasecmp(args[i], "to_server") == 0 || strcasecmp(args[i], "from_client") == 0){
270  if (fd->flags & DETECT_FLOW_FLAG_TOSERVER) {
271  SCLogError("cannot set DETECT_FLOW_FLAG_TOSERVER flag is already set");
272  goto error;
273  } else if (fd->flags & DETECT_FLOW_FLAG_TOCLIENT) {
274  SCLogError("cannot set to_server, DETECT_FLOW_FLAG_TO_CLIENT flag already set");
275  goto error;
276  }
278  fd->match_cnt++;
279  } else if (strcasecmp(args[i], "no_frag") == 0) {
280  if (fd->flags & DETECT_FLOW_FLAG_NO_FRAG) {
281  SCLogError("cannot set no_frag flag is already set");
282  goto error;
283  } else if (fd->flags & DETECT_FLOW_FLAG_ONLY_FRAG) {
284  SCLogError("cannot set no_frag flag, only_frag already set");
285  goto error;
286  }
288  fd->match_cnt++;
289  } else if (strcasecmp(args[i], "only_frag") == 0) {
290  if (fd->flags & DETECT_FLOW_FLAG_ONLY_FRAG) {
291  SCLogError("cannot set only_frag flag is already set");
292  goto error;
293  } else if (fd->flags & DETECT_FLOW_FLAG_NO_FRAG) {
294  SCLogError("cannot set only_frag flag, no_frag already set");
295  goto error;
296  }
298  fd->match_cnt++;
299 
300  /* special case: these only affect parsing, not matching */
301 
302  } else if (strcasecmp(args[i], "only_stream") == 0) {
303  if (*parse_flags & DETECT_FLOW_FLAG_ONLYSTREAM) {
304  SCLogError("cannot set only_stream flag is already set");
305  goto error;
306  } else if (*parse_flags & DETECT_FLOW_FLAG_NOSTREAM) {
307  SCLogError(
308  "cannot set only_stream flag, DETECT_FLOW_FLAG_NOSTREAM already set");
309  goto error;
310  }
311  *parse_flags |= DETECT_FLOW_FLAG_ONLYSTREAM;
312  } else if (strcasecmp(args[i], "no_stream") == 0) {
313  if (*parse_flags & DETECT_FLOW_FLAG_NOSTREAM) {
314  SCLogError("cannot set no_stream flag is already set");
315  goto error;
316  } else if (*parse_flags & DETECT_FLOW_FLAG_ONLYSTREAM) {
317  SCLogError(
318  "cannot set no_stream flag, DETECT_FLOW_FLAG_ONLYSTREAM already set");
319  goto error;
320  }
321  *parse_flags |= DETECT_FLOW_FLAG_NOSTREAM;
322  } else {
323  SCLogError("invalid flow option \"%s\"", args[i]);
324  goto error;
325  }
326  }
327  }
328  pcre2_match_data_free(match);
329  return fd;
330 
331 error:
332  if (match) {
333  pcre2_match_data_free(match);
334  }
335  if (fd != NULL)
336  DetectFlowFree(de_ctx, fd);
337  return NULL;
338 
339 }
340 
342 {
343 #define SIG_FLAG_BOTH (SIG_FLAG_TOSERVER|SIG_FLAG_TOCLIENT)
344  BUG_ON(flags == 0);
347 
348  SCLogDebug("want %08x", flags & SIG_FLAG_BOTH);
349  SCLogDebug("have %08x", s->flags & SIG_FLAG_BOTH);
350 
351  if (flags & SIG_FLAG_TOSERVER) {
352  if ((s->flags & SIG_FLAG_BOTH) == SIG_FLAG_BOTH) {
353  /* both is set if we just have 'flow:established' */
354  s->flags &= ~SIG_FLAG_TOCLIENT;
355  } else if (s->flags & SIG_FLAG_TOCLIENT) {
356  return -1;
357  }
358  s->flags |= SIG_FLAG_TOSERVER;
359  } else {
360  if ((s->flags & SIG_FLAG_BOTH) == SIG_FLAG_BOTH) {
361  /* both is set if we just have 'flow:established' */
362  s->flags &= ~SIG_FLAG_TOSERVER;
363  } else if (s->flags & SIG_FLAG_TOSERVER) {
364  return -1;
365  }
366  s->flags |= SIG_FLAG_TOCLIENT;
367  }
368  return 0;
369 #undef SIG_FLAG_BOTH
370 }
371 
372 /**
373  * \brief this function is used to add the parsed flowdata into the current signature
374  *
375  * \param de_ctx pointer to the Detection Engine Context
376  * \param s pointer to the Current Signature
377  * \param flowstr pointer to the user provided flow options
378  *
379  * \retval 0 on Success
380  * \retval -1 on Failure
381  */
382 int DetectFlowSetup (DetectEngineCtx *de_ctx, Signature *s, const char *flowstr)
383 {
384  uint16_t parse_flags = 0;
385 
386  /* ensure only one flow option */
388  SCLogError("A signature may have only one flow option.");
389  return -1;
390  }
391 
392  DetectFlowData *fd = DetectFlowParse(de_ctx, flowstr, &parse_flags);
393  if (fd == NULL)
394  return -1;
395 
396  bool appendsm = true;
397  /* set the signature direction flags */
398  if (fd->flags & DETECT_FLOW_FLAG_TOSERVER) {
399  if (s->flags & SIG_FLAG_TXBOTHDIR) {
400  SCLogError(
401  "rule %u means to use both directions, cannot specify a flow direction", s->id);
402  goto error;
403  }
404  if (s->flags & SIG_FLAG_TOCLIENT) {
405  SCLogError("rule %u has flow to_server but a hook to_client", s->id);
406  goto error;
407  }
408  s->flags |= SIG_FLAG_TOSERVER;
409  } else if (fd->flags & DETECT_FLOW_FLAG_TOCLIENT) {
410  if (s->flags & SIG_FLAG_TXBOTHDIR) {
411  SCLogError(
412  "rule %u means to use both directions, cannot specify a flow direction", s->id);
413  goto error;
414  }
415  if (s->flags & SIG_FLAG_TOSERVER) {
416  SCLogError("rule %u has flow to_client but a hook to_server", s->id);
417  goto error;
418  }
419  s->flags |= SIG_FLAG_TOCLIENT;
420  } else {
421  /* if direction wasn't already set, e.g. by rule hook, assume both */
422  if ((s->flags & (SIG_FLAG_TOSERVER | SIG_FLAG_TOCLIENT)) == 0) {
423  s->flags |= SIG_FLAG_TOSERVER;
424  s->flags |= SIG_FLAG_TOCLIENT;
425  }
426  }
427  if (fd->flags == 0 || fd->flags == DETECT_FLOW_FLAG_TOSERVER ||
429  /* no direct flow is needed for just direction,
430  * no sigmatch is needed either. */
431  appendsm = false;
432  } else {
434  }
435 
436  if (appendsm) {
438  de_ctx, s, DETECT_FLOW, (SigMatchCtx *)fd, DETECT_SM_LIST_MATCH) == NULL) {
439  goto error;
440  }
441  } else {
442  DetectFlowFree(de_ctx, fd);
443  }
444 
445  if (parse_flags & DETECT_FLOW_FLAG_ONLYSTREAM) {
447  }
448  if (parse_flags & DETECT_FLOW_FLAG_NOSTREAM) {
450  }
451  return 0;
452 
453 error:
454  if (fd != NULL)
455  DetectFlowFree(de_ctx, fd);
456  return -1;
457 
458 }
459 
460 /**
461  * \brief this function will free memory associated with DetectFlowData
462  *
463  * \param fd pointer to DetectFlowData
464  */
466 {
467  DetectFlowData *fd = (DetectFlowData *)ptr;
468  SCFree(fd);
469 }
470 
471 static void
472 PrefilterPacketFlowMatch(DetectEngineThreadCtx *det_ctx, Packet *p, const void *pectx)
473 {
474  SCEnter();
475 
476  const PrefilterPacketHeaderCtx *ctx = pectx;
477 
478  if (!PrefilterPacketHeaderExtraMatch(ctx, p))
479  return;
480 
481  if (FlowMatch(p->flags, p->flowflags, ctx->v1.u16[0], ctx->v1.u16[1])) {
482  SCLogDebug("match: adding sids");
483  PrefilterAddSids(&det_ctx->pmq, ctx->sigs_array, ctx->sigs_cnt);
484  }
485  SCReturn;
486 }
487 
488 static void
489 PrefilterPacketFlowSet(PrefilterPacketHeaderValue *v, void *smctx)
490 {
491  const DetectFlowData *fb = smctx;
492  v->u16[0] = fb->flags;
493  v->u16[1] = fb->match_cnt;
494 }
495 
496 static bool
497 PrefilterPacketFlowCompare(PrefilterPacketHeaderValue v, void *smctx)
498 {
499  const DetectFlowData *fb = smctx;
500  if (v.u16[0] == fb->flags && v.u16[1] == fb->match_cnt) {
501  return true;
502  }
503  return false;
504 }
505 
506 static int PrefilterSetupFlow(DetectEngineCtx *de_ctx, SigGroupHead *sgh)
507 {
508  return PrefilterSetupPacketHeader(de_ctx, sgh, DETECT_FLOW, 0, PrefilterPacketFlowSet,
509  PrefilterPacketFlowCompare, PrefilterPacketFlowMatch);
510 }
511 
512 static bool PrefilterFlowIsPrefilterable(const Signature *s)
513 {
514  const SigMatch *sm;
515  for (sm = s->init_data->smlists[DETECT_SM_LIST_MATCH] ; sm != NULL; sm = sm->next) {
516  switch (sm->type) {
517  case DETECT_FLOW:
518  return true;
519  }
520  }
521  return false;
522 }
523 
524 #ifdef UNITTESTS
525 #include "detect-engine-alert.h"
526 
527 /**
528  * \test DetectFlowTestParse01 is a test to make sure that we return "something"
529  * when given valid flow opt
530  */
531 static int DetectFlowTestParse01 (void)
532 {
533  uint16_t parsed_flags = 0;
534  DetectFlowData *fd = DetectFlowParse(NULL, "established", &parsed_flags);
535  FAIL_IF_NULL(fd);
536  FAIL_IF_NOT(parsed_flags == 0);
537  DetectFlowFree(NULL, fd);
538  PASS;
539 }
540 
541 /**
542  * \test DetectFlowTestParse02 is a test for setting the established flow opt
543  */
544 static int DetectFlowTestParse02 (void)
545 {
546  uint16_t parsed_flags = 0;
547  DetectFlowData *fd = DetectFlowParse(NULL, "established", &parsed_flags);
548  FAIL_IF_NULL(fd);
550  fd->match_cnt == 1);
551  DetectFlowFree(NULL, fd);
552  PASS;
553 }
554 
555 /**
556  * \test DetectFlowTestParse03 is a test for setting the stateless flow opt
557  */
558 static int DetectFlowTestParse03 (void)
559 {
560  uint16_t parsed_flags = 0;
561  DetectFlowData *fd = DetectFlowParse(NULL, "stateless", &parsed_flags);
562  FAIL_IF_NULL(fd);
564  DetectFlowFree(NULL, fd);
565  PASS;
566 }
567 
568 /**
569  * \test DetectFlowTestParse04 is a test for setting the to_client flow opt
570  */
571 static int DetectFlowTestParse04 (void)
572 {
573  uint16_t parsed_flags = 0;
574  DetectFlowData *fd = DetectFlowParse(NULL, "to_client", &parsed_flags);
575  FAIL_IF_NULL(fd);
577  DetectFlowFree(NULL, fd);
578  PASS;
579 }
580 
581 /**
582  * \test DetectFlowTestParse05 is a test for setting the to_server flow opt
583  */
584 static int DetectFlowTestParse05 (void)
585 {
586  uint16_t parsed_flags = 0;
587  DetectFlowData *fd = DetectFlowParse(NULL, "to_server", &parsed_flags);
588  FAIL_IF_NULL(fd);
590  DetectFlowFree(NULL, fd);
591  PASS;
592 }
593 
594 /**
595  * \test DetectFlowTestParse06 is a test for setting the from_server flow opt
596  */
597 static int DetectFlowTestParse06 (void)
598 {
599  uint16_t parsed_flags = 0;
600  DetectFlowData *fd = DetectFlowParse(NULL, "from_server", &parsed_flags);
601  FAIL_IF_NULL(fd);
603  DetectFlowFree(NULL, fd);
604  PASS;
605 }
606 
607 /**
608  * \test DetectFlowTestParse07 is a test for setting the from_client flow opt
609  */
610 static int DetectFlowTestParse07 (void)
611 {
612  uint16_t parsed_flags = 0;
613  DetectFlowData *fd = DetectFlowParse(NULL, "from_client", &parsed_flags);
614  FAIL_IF_NULL(fd);
616  DetectFlowFree(NULL, fd);
617  PASS;
618 }
619 
620 /**
621  * \test DetectFlowTestParse08 is a test for setting the established,to_client flow opts
622  */
623 static int DetectFlowTestParse08 (void)
624 {
625  uint16_t parsed_flags = 0;
626  DetectFlowData *fd = DetectFlowParse(NULL, "established,to_client", &parsed_flags);
627  FAIL_IF_NULL(fd);
629  DetectFlowFree(NULL, fd);
630  PASS;
631 }
632 
633 /**
634  * \test DetectFlowTestParse09 is a test for setting the to_client,stateless flow opts (order of state,dir reversed)
635  */
636 static int DetectFlowTestParse09 (void)
637 {
638  uint16_t parsed_flags = 0;
639  DetectFlowData *fd = DetectFlowParse(NULL, "to_client,stateless", &parsed_flags);
640  FAIL_IF_NULL(fd);
643  fd->match_cnt == 2);
644  DetectFlowFree(NULL, fd);
645  PASS;
646 }
647 
648 /**
649  * \test DetectFlowTestParse10 is a test for setting the from_server,stateless flow opts (order of state,dir reversed)
650  */
651 static int DetectFlowTestParse10 (void)
652 {
653  uint16_t parsed_flags = 0;
654  DetectFlowData *fd = DetectFlowParse(NULL, "from_server,stateless", &parsed_flags);
655  FAIL_IF_NULL(fd);
658  fd->match_cnt == 2);
659  DetectFlowFree(NULL, fd);
660  PASS;
661 }
662 
663 /**
664  * \test DetectFlowTestParse11 is a test for setting the from_server,stateless flow opts with spaces all around
665  */
666 static int DetectFlowTestParse11 (void)
667 {
668  uint16_t parsed_flags = 0;
669  DetectFlowData *fd = DetectFlowParse(NULL, " from_server , stateless ", &parsed_flags);
670  FAIL_IF_NULL(fd);
673  fd->match_cnt == 2);
674  DetectFlowFree(NULL, fd);
675  PASS;
676 }
677 
678 /**
679  * \test DetectFlowTestParseNocase01 is a test to make sure that we return "something"
680  * when given valid flow opt
681  */
682 static int DetectFlowTestParseNocase01 (void)
683 {
684  uint16_t parsed_flags = 0;
685  DetectFlowData *fd = DetectFlowParse(NULL, "ESTABLISHED", &parsed_flags);
686  FAIL_IF_NULL(fd);
687  DetectFlowFree(NULL, fd);
688  PASS;
689 }
690 
691 /**
692  * \test DetectFlowTestParseNocase02 is a test for setting the established flow opt
693  */
694 static int DetectFlowTestParseNocase02 (void)
695 {
696  uint16_t parsed_flags = 0;
697  DetectFlowData *fd = DetectFlowParse(NULL, "ESTABLISHED", &parsed_flags);
698  FAIL_IF_NULL(fd);
700  fd->match_cnt == 1);
701  DetectFlowFree(NULL, fd);
702  PASS;
703 }
704 
705 /**
706  * \test DetectFlowTestParseNocase03 is a test for setting the stateless flow opt
707  */
708 static int DetectFlowTestParseNocase03 (void)
709 {
710  uint16_t parsed_flags = 0;
711  DetectFlowData *fd = DetectFlowParse(NULL, "STATELESS", &parsed_flags);
712  FAIL_IF_NULL(fd);
714  DetectFlowFree(NULL, fd);
715  PASS;
716 }
717 
718 /**
719  * \test DetectFlowTestParseNocase04 is a test for setting the to_client flow opt
720  */
721 static int DetectFlowTestParseNocase04 (void)
722 {
723  uint16_t parsed_flags = 0;
724  DetectFlowData *fd = DetectFlowParse(NULL, "TO_CLIENT", &parsed_flags);
725  FAIL_IF_NULL(fd);
727  DetectFlowFree(NULL, fd);
728  PASS;
729 }
730 
731 /**
732  * \test DetectFlowTestParseNocase05 is a test for setting the to_server flow opt
733  */
734 static int DetectFlowTestParseNocase05 (void)
735 {
736  uint16_t parsed_flags = 0;
737  DetectFlowData *fd = DetectFlowParse(NULL, "TO_SERVER", &parsed_flags);
738  FAIL_IF_NULL(fd);
740  DetectFlowFree(NULL, fd);
741  PASS;
742 }
743 
744 /**
745  * \test DetectFlowTestParseNocase06 is a test for setting the from_server flow opt
746  */
747 static int DetectFlowTestParseNocase06 (void)
748 {
749  uint16_t parsed_flags = 0;
750  DetectFlowData *fd = DetectFlowParse(NULL, "FROM_SERVER", &parsed_flags);
751  FAIL_IF_NULL(fd);
753  DetectFlowFree(NULL, fd);
754  PASS;
755 }
756 
757 /**
758  * \test DetectFlowTestParseNocase07 is a test for setting the from_client flow opt
759  */
760 static int DetectFlowTestParseNocase07 (void)
761 {
762  uint16_t parsed_flags = 0;
763  DetectFlowData *fd = DetectFlowParse(NULL, "FROM_CLIENT", &parsed_flags);
764  FAIL_IF_NULL(fd);
766  DetectFlowFree(NULL, fd);
767  PASS;
768 }
769 
770 /**
771  * \test DetectFlowTestParseNocase08 is a test for setting the established,to_client flow opts
772  */
773 static int DetectFlowTestParseNocase08 (void)
774 {
775  uint16_t parsed_flags = 0;
776  DetectFlowData *fd = DetectFlowParse(NULL, "ESTABLISHED,TO_CLIENT", &parsed_flags);
777  FAIL_IF_NULL(fd);
780  fd->match_cnt == 2);
781  DetectFlowFree(NULL, fd);
782  PASS;
783 }
784 
785 /**
786  * \test DetectFlowTestParseNocase09 is a test for setting the to_client,stateless flow opts (order of state,dir reversed)
787  */
788 static int DetectFlowTestParseNocase09 (void)
789 {
790  uint16_t parsed_flags = 0;
791  DetectFlowData *fd = DetectFlowParse(NULL, "TO_CLIENT,STATELESS", &parsed_flags);
792  FAIL_IF_NULL(fd);
795  fd->match_cnt == 2);
796  DetectFlowFree(NULL, fd);
797  PASS;
798 }
799 
800 /**
801  * \test DetectFlowTestParseNocase10 is a test for setting the from_server,stateless flow opts (order of state,dir reversed)
802  */
803 static int DetectFlowTestParseNocase10 (void)
804 {
805  uint16_t parsed_flags = 0;
806  DetectFlowData *fd = DetectFlowParse(NULL, "FROM_SERVER,STATELESS", &parsed_flags);
807  FAIL_IF_NULL(fd);
810  fd->match_cnt == 2);
811  DetectFlowFree(NULL, fd);
812  PASS;
813 }
814 
815 /**
816  * \test DetectFlowTestParseNocase11 is a test for setting the from_server,stateless flow opts with spaces all around
817  */
818 static int DetectFlowTestParseNocase11 (void)
819 {
820  uint16_t parsed_flags = 0;
821  DetectFlowData *fd = DetectFlowParse(NULL, " FROM_SERVER , STATELESS ", &parsed_flags);
822  FAIL_IF_NULL(fd);
825  fd->match_cnt == 2);
826  DetectFlowFree(NULL, fd);
827  PASS;
828 }
829 
830 /**
831  * \test DetectFlowTestParse12 is a test for setting an invalid separator :
832  */
833 static int DetectFlowTestParse12 (void)
834 {
835  uint16_t parsed_flags = 0;
836  DetectFlowData *fd = DetectFlowParse(NULL, "from_server:stateless", &parsed_flags);
837  FAIL_IF_NOT_NULL(fd);
838  PASS;
839 }
840 
841 /**
842  * \test DetectFlowTestParse13 is a test for an invalid option
843  */
844 static int DetectFlowTestParse13 (void)
845 {
846  uint16_t parsed_flags = 0;
847  DetectFlowData *fd = DetectFlowParse(NULL, "invalidoptiontest", &parsed_flags);
848  FAIL_IF_NOT_NULL(fd);
849  PASS;
850 }
851 
852 /**
853  * \test DetectFlowTestParse14 is a test for a empty option
854  */
855 static int DetectFlowTestParse14 (void)
856 {
857  uint16_t parsed_flags = 0;
858  DetectFlowData *fd = DetectFlowParse(NULL, "", &parsed_flags);
859  FAIL_IF_NOT_NULL(fd);
860  PASS;
861 }
862 
863 /**
864  * \test DetectFlowTestParse15 is a test for an invalid combo of options established,stateless
865  */
866 static int DetectFlowTestParse15 (void)
867 {
868  uint16_t parsed_flags = 0;
869  DetectFlowData *fd = DetectFlowParse(NULL, "established,stateless", &parsed_flags);
870  FAIL_IF_NOT_NULL(fd);
871  PASS;
872 }
873 
874 /**
875  * \test DetectFlowTestParse16 is a test for an invalid combo of options to_client,to_server
876  */
877 static int DetectFlowTestParse16 (void)
878 {
879  uint16_t parsed_flags = 0;
880  DetectFlowData *fd = DetectFlowParse(NULL, "to_client,to_server", &parsed_flags);
881  FAIL_IF_NOT_NULL(fd);
882  PASS;
883 }
884 
885 /**
886  * \test DetectFlowTestParse16 is a test for an invalid combo of options to_client,from_server
887  * flowbit flags are the same
888  */
889 static int DetectFlowTestParse17 (void)
890 {
891  uint16_t parsed_flags = 0;
892  DetectFlowData *fd = DetectFlowParse(NULL, "to_client,from_server", &parsed_flags);
893  FAIL_IF_NOT_NULL(fd);
894  PASS;
895 }
896 
897 /**
898  * \test DetectFlowTestParse18 is a test for setting the from_server,stateless,only_stream flow opts (order of state,dir reversed)
899  */
900 static int DetectFlowTestParse18 (void)
901 {
902  uint16_t parsed_flags = 0;
903  DetectFlowData *fd =
904  DetectFlowParse(NULL, "from_server,established,only_stream", &parsed_flags);
905  FAIL_IF_NULL(fd);
907  FAIL_IF_NOT(parsed_flags == DETECT_FLOW_FLAG_ONLYSTREAM);
908  FAIL_IF_NOT(fd->match_cnt == 2);
909  DetectFlowFree(NULL, fd);
910  PASS;
911 }
912 
913 /**
914  * \test DetectFlowTestParseNocase18 is a test for setting the from_server,stateless,only_stream flow opts (order of state,dir reversed)
915  */
916 static int DetectFlowTestParseNocase18 (void)
917 {
918  uint16_t parsed_flags = 0;
919  DetectFlowData *fd =
920  DetectFlowParse(NULL, "FROM_SERVER,ESTABLISHED,ONLY_STREAM", &parsed_flags);
921  FAIL_IF_NULL(fd);
923  FAIL_IF_NOT(parsed_flags == DETECT_FLOW_FLAG_ONLYSTREAM);
924  FAIL_IF_NOT(fd->match_cnt == 2);
925  DetectFlowFree(NULL, fd);
926  PASS;
927 }
928 
929 
930 /**
931  * \test DetectFlowTestParse19 is a test for one to many options passed to DetectFlowParse
932  */
933 static int DetectFlowTestParse19 (void)
934 {
935  uint16_t parsed_flags = 0;
936  DetectFlowData *fd =
937  DetectFlowParse(NULL, "from_server,established,only_stream,a", &parsed_flags);
938  FAIL_IF_NOT_NULL(fd);
939  PASS;
940 }
941 
942 /**
943  * \test DetectFlowTestParse20 is a test for setting from_server, established, no_stream
944  */
945 static int DetectFlowTestParse20 (void)
946 {
947  uint16_t parsed_flags = 0;
948  DetectFlowData *fd = DetectFlowParse(NULL, "from_server,established,no_stream", &parsed_flags);
949  FAIL_IF_NULL(fd);
951  FAIL_IF_NOT(parsed_flags == DETECT_FLOW_FLAG_NOSTREAM);
952  FAIL_IF_NOT(fd->match_cnt == 2);
953  DetectFlowFree(NULL, fd);
954  PASS;
955 }
956 
957 /**
958  * \test DetectFlowTestParse20 is a test for setting from_server, established, no_stream
959  */
960 static int DetectFlowTestParseNocase20 (void)
961 {
962  uint16_t parsed_flags = 0;
963  DetectFlowData *fd = DetectFlowParse(NULL, "FROM_SERVER,ESTABLISHED,NO_STREAM", &parsed_flags);
964  FAIL_IF_NULL(fd);
966  FAIL_IF_NOT(parsed_flags == DETECT_FLOW_FLAG_NOSTREAM);
967  FAIL_IF_NOT(fd->match_cnt == 2);
968  DetectFlowFree(NULL, fd);
969  PASS;
970 }
971 
972 /**
973  * \test DetectFlowTestParse21 is a test for an invalid opt between to valid opts
974  */
975 static int DetectFlowTestParse21 (void)
976 {
977  uint16_t parsed_flags = 0;
978  DetectFlowData *fd = DetectFlowParse(NULL, "from_server,a,no_stream", &parsed_flags);
979  FAIL_IF_NOT_NULL(fd);
980  PASS;
981 }
982 
983 /**
984  * \test DetectFlowTestParse22 is a test for setting the established,not_established flow opts both
985  */
986 static int DetectFlowTestParse22(void)
987 {
988  uint16_t parsed_flags = 0;
989  DetectFlowData *fd = DetectFlowParse(NULL, "established,not_established", &parsed_flags);
990  FAIL_IF_NOT_NULL(fd);
991  fd = DetectFlowParse(NULL, "not_established,established", &parsed_flags);
992  FAIL_IF_NOT_NULL(fd);
993  PASS;
994 }
995 
996 static int DetectFlowSigTest01(void)
997 {
998  uint8_t *buf = (uint8_t *)"supernovaduper";
999  uint16_t buflen = strlen((char *)buf);
1000  ThreadVars th_v;
1002  memset(&dtv, 0, sizeof(DecodeThreadVars));
1003  memset(&th_v, 0, sizeof(th_v));
1004 
1005  Packet *p = UTHBuildPacket(buf, buflen, IPPROTO_TCP);
1006  FAIL_IF_NULL(p);
1007 
1008  const char *sig1 = "alert tcp any any -> any any (msg:\"dummy\"; "
1009  "content:\"nova\"; flow:no_stream; sid:1;)";
1010 
1013  de_ctx->flags |= DE_QUIET;
1014 
1015  de_ctx->sig_list = SigInit(de_ctx, sig1);
1017 
1019  DetectEngineThreadCtx *det_ctx = NULL;
1020  DetectEngineThreadCtxInit(&th_v, (void *)de_ctx, (void *)&det_ctx);
1021  FAIL_IF_NULL(det_ctx);
1022 
1023  SigMatchSignatures(&th_v, de_ctx, det_ctx, p);
1024  FAIL_IF(PacketAlertCheck(p, 1) != 1);
1025 
1026  DetectEngineThreadCtxDeinit(&th_v, (void *)det_ctx);
1028  UTHFreePacket(p);
1029 
1030  StatsThreadCleanup(&th_v);
1031  PASS;
1032 }
1033 
1034 /**
1035  * \test Test parsing of the not_established keyword.
1036  */
1037 static int DetectFlowTestParseNotEstablished(void)
1038 {
1039  uint16_t parsed_flags = 0;
1040  DetectFlowData *fd = DetectFlowParse(NULL, "not_established", &parsed_flags);
1041  FAIL_IF_NULL(fd);
1043  DetectFlowFree(NULL, fd);
1044  PASS;
1045 }
1046 
1047 /**
1048  * \test Test parsing of the "no_frag" flow argument.
1049  */
1050 static int DetectFlowTestParseNoFrag(void)
1051 {
1052  uint16_t parsed_flags = 0;
1053  DetectFlowData *fd = DetectFlowParse(NULL, "no_frag", &parsed_flags);
1054  FAIL_IF_NULL(fd);
1056  DetectFlowFree(NULL, fd);
1057  PASS;
1058 }
1059 
1060 /**
1061  * \test Test parsing of the "only_frag" flow argument.
1062  */
1063 static int DetectFlowTestParseOnlyFrag(void)
1064 {
1065  uint16_t parsed_flags = 0;
1066  DetectFlowData *fd = DetectFlowParse(NULL, "only_frag", &parsed_flags);
1067  FAIL_IF_NULL(fd);
1069  DetectFlowFree(NULL, fd);
1070  PASS;
1071 }
1072 
1073 /**
1074  * \test Test that parsing of only_frag and no_frag together fails.
1075  */
1076 static int DetectFlowTestParseNoFragOnlyFrag(void)
1077 {
1078  uint16_t parsed_flags = 0;
1079  DetectFlowData *fd = DetectFlowParse(NULL, "no_frag,only_frag", &parsed_flags);
1080  FAIL_IF_NOT_NULL(fd);
1081  PASS;
1082 }
1083 
1084 /**
1085  * \test Test no_frag matching.
1086  */
1087 static int DetectFlowTestNoFragMatch(void)
1088 {
1089  uint16_t parsed_flags = 0;
1090  uint32_t pflags = 0;
1091  DetectFlowData *fd = DetectFlowParse(NULL, "no_frag", &parsed_flags);
1092  FAIL_IF_NULL(fd);
1094  FAIL_IF_NOT(fd->match_cnt == 1);
1095  FAIL_IF_NOT(FlowMatch(pflags, 0, fd->flags, fd->match_cnt));
1096  pflags |= PKT_REBUILT_FRAGMENT;
1097  FAIL_IF(FlowMatch(pflags, 0, fd->flags, fd->match_cnt));
1098  DetectFlowFree(NULL, fd);
1099  PASS;
1100 }
1101 
1102 /**
1103  * \test Test only_frag matching.
1104  */
1105 static int DetectFlowTestOnlyFragMatch(void)
1106 {
1107  uint16_t parsed_flags = 0;
1108  uint32_t pflags = 0;
1109  DetectFlowData *fd = DetectFlowParse(NULL, "only_frag", &parsed_flags);
1110  FAIL_IF_NULL(fd);
1112  FAIL_IF_NOT(fd->match_cnt == 1);
1113  FAIL_IF(FlowMatch(pflags, 0, fd->flags, fd->match_cnt));
1114  pflags |= PKT_REBUILT_FRAGMENT;
1115  FAIL_IF_NOT(FlowMatch(pflags, 0, fd->flags, fd->match_cnt));
1116  DetectFlowFree(NULL, fd);
1117  PASS;
1118 }
1119 
1120 /**
1121  * \brief this function registers unit tests for DetectFlow
1122  */
1123 static void DetectFlowRegisterTests(void)
1124 {
1125  UtRegisterTest("DetectFlowTestParse01", DetectFlowTestParse01);
1126  UtRegisterTest("DetectFlowTestParse02", DetectFlowTestParse02);
1127  UtRegisterTest("DetectFlowTestParse03", DetectFlowTestParse03);
1128  UtRegisterTest("DetectFlowTestParse04", DetectFlowTestParse04);
1129  UtRegisterTest("DetectFlowTestParse05", DetectFlowTestParse05);
1130  UtRegisterTest("DetectFlowTestParse06", DetectFlowTestParse06);
1131  UtRegisterTest("DetectFlowTestParse07", DetectFlowTestParse07);
1132  UtRegisterTest("DetectFlowTestParse08", DetectFlowTestParse08);
1133  UtRegisterTest("DetectFlowTestParse09", DetectFlowTestParse09);
1134  UtRegisterTest("DetectFlowTestParse10", DetectFlowTestParse10);
1135  UtRegisterTest("DetectFlowTestParse11", DetectFlowTestParse11);
1136  UtRegisterTest("DetectFlowTestParseNocase01", DetectFlowTestParseNocase01);
1137  UtRegisterTest("DetectFlowTestParseNocase02", DetectFlowTestParseNocase02);
1138  UtRegisterTest("DetectFlowTestParseNocase03", DetectFlowTestParseNocase03);
1139  UtRegisterTest("DetectFlowTestParseNocase04", DetectFlowTestParseNocase04);
1140  UtRegisterTest("DetectFlowTestParseNocase05", DetectFlowTestParseNocase05);
1141  UtRegisterTest("DetectFlowTestParseNocase06", DetectFlowTestParseNocase06);
1142  UtRegisterTest("DetectFlowTestParseNocase07", DetectFlowTestParseNocase07);
1143  UtRegisterTest("DetectFlowTestParseNocase08", DetectFlowTestParseNocase08);
1144  UtRegisterTest("DetectFlowTestParseNocase09", DetectFlowTestParseNocase09);
1145  UtRegisterTest("DetectFlowTestParseNocase10", DetectFlowTestParseNocase10);
1146  UtRegisterTest("DetectFlowTestParseNocase11", DetectFlowTestParseNocase11);
1147  UtRegisterTest("DetectFlowTestParse12", DetectFlowTestParse12);
1148  UtRegisterTest("DetectFlowTestParse13", DetectFlowTestParse13);
1149  UtRegisterTest("DetectFlowTestParse14", DetectFlowTestParse14);
1150  UtRegisterTest("DetectFlowTestParse15", DetectFlowTestParse15);
1151  UtRegisterTest("DetectFlowTestParse16", DetectFlowTestParse16);
1152  UtRegisterTest("DetectFlowTestParse17", DetectFlowTestParse17);
1153  UtRegisterTest("DetectFlowTestParse18", DetectFlowTestParse18);
1154  UtRegisterTest("DetectFlowTestParseNocase18", DetectFlowTestParseNocase18);
1155  UtRegisterTest("DetectFlowTestParse19", DetectFlowTestParse19);
1156  UtRegisterTest("DetectFlowTestParse20", DetectFlowTestParse20);
1157  UtRegisterTest("DetectFlowTestParseNocase20", DetectFlowTestParseNocase20);
1158  UtRegisterTest("DetectFlowTestParse21", DetectFlowTestParse21);
1159  UtRegisterTest("DetectFlowTestParse22", DetectFlowTestParse22);
1160  UtRegisterTest("DetectFlowTestParseNotEstablished",
1161  DetectFlowTestParseNotEstablished);
1162  UtRegisterTest("DetectFlowTestParseNoFrag", DetectFlowTestParseNoFrag);
1163  UtRegisterTest("DetectFlowTestParseOnlyFrag",
1164  DetectFlowTestParseOnlyFrag);
1165  UtRegisterTest("DetectFlowTestParseNoFragOnlyFrag",
1166  DetectFlowTestParseNoFragOnlyFrag);
1167  UtRegisterTest("DetectFlowTestNoFragMatch", DetectFlowTestNoFragMatch);
1168  UtRegisterTest("DetectFlowTestOnlyFragMatch", DetectFlowTestOnlyFragMatch);
1169 
1170  UtRegisterTest("DetectFlowSigTest01", DetectFlowSigTest01);
1171 }
1172 #endif /* UNITTESTS */
DETECT_FLOW_FLAG_TOCLIENT
#define DETECT_FLOW_FLAG_TOCLIENT
Definition: detect-flow.h:28
DETECT_FLOW_FLAG_STATELESS
#define DETECT_FLOW_FLAG_STATELESS
Definition: detect-flow.h:31
SigTableElmt_::url
const char * url
Definition: detect.h:1460
detect-engine.h
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
SignatureInitData_::smlists
struct SigMatch_ * smlists[DETECT_SM_LIST_MAX]
Definition: detect.h:642
SigTableElmt_::desc
const char * desc
Definition: detect.h:1459
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1444
DetectFlowData_
Definition: detect-flow.h:37
DetectParseRegex
Definition: detect-parse.h:93
DETECT_FLOW_FLAG_NOSTREAM
#define DETECT_FLOW_FLAG_NOSTREAM
Definition: detect-flow.h:33
SigTableElmt_::name
const char * name
Definition: detect.h:1457
DETECT_TABLE_PACKET_FILTER_FLAG
#define DETECT_TABLE_PACKET_FILTER_FLAG
Definition: detect.h:563
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1627
SIG_FLAG_INIT_FLOW
#define SIG_FLAG_INIT_FLOW
Definition: detect.h:292
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
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1448
DETECT_FLOW
@ DETECT_FLOW
Definition: detect-engine-register.h:54
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:279
PacketAlertCheck
int PacketAlertCheck(Packet *p, uint32_t sid)
Check if a certain sid alerted, this is used in the test functions.
Definition: detect-engine-alert.c:142
Packet_::flags
uint32_t flags
Definition: decode.h:544
DetectFlowData_::match_cnt
uint8_t match_cnt
Definition: detect-flow.h:39
DetectEngineThreadCtx_::pmq
PrefilterRuleStore pmq
Definition: detect.h:1347
ctx
struct Thresholds ctx
DetectFlowData_::flags
uint16_t flags
Definition: detect-flow.h:38
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:932
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2634
FLOW_PKT_TOSERVER
#define FLOW_PKT_TOSERVER
Definition: flow.h:225
SIG_FLAG_REQUIRE_STREAM
#define SIG_FLAG_REQUIRE_STREAM
Definition: detect.h:255
SIG_FLAG_TXBOTHDIR
#define SIG_FLAG_TXBOTHDIR
Definition: detect.h:250
DE_QUIET
#define DE_QUIET
Definition: detect.h:330
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:365
DETECT_TABLE_APP_TD_FLAG
#define DETECT_TABLE_APP_TD_FLAG
Definition: detect.h:566
SigMatchSignatures
void SigMatchSignatures(ThreadVars *tv, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p)
wrapper for old tests
Definition: detect.c:2416
SignatureInitData_::init_flags
uint32_t init_flags
Definition: detect.h:608
DetectParsePcreExec
int DetectParsePcreExec(DetectParseRegex *parse_regex, pcre2_match_data **match, const char *str, int start_offset, int options)
Definition: detect-parse.c:3493
SIGMATCH_SUPPORT_FIREWALL
#define SIGMATCH_SUPPORT_FIREWALL
Definition: detect.h:1680
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:532
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:272
DETECT_TABLE_APP_FILTER_FLAG
#define DETECT_TABLE_APP_FILTER_FLAG
Definition: detect.h:565
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1439
DetectFlowSetupImplicit
int DetectFlowSetupImplicit(Signature *s, uint32_t flags)
Definition: detect-flow.c:341
PrefilterPacketHeaderValue::u16
uint16_t u16[8]
Definition: detect-engine-prefilter-common.h:25
util-unittest.h
util-unittest-helper.h
FAIL_IF_NOT
#define FAIL_IF_NOT(expr)
Fail a test if expression evaluates to false.
Definition: util-unittest.h:82
DETECT_TABLE_PACKET_TD_FLAG
#define DETECT_TABLE_PACKET_TD_FLAG
Definition: detect.h:564
SigTableElmt_::SetupPrefilter
int(* SetupPrefilter)(DetectEngineCtx *de_ctx, struct SigGroupHead_ *sgh)
Definition: detect.h:1442
DETECT_FLOW_FLAG_ONLYSTREAM
#define DETECT_FLOW_FLAG_ONLYSTREAM
Definition: detect-flow.h:32
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:271
PrefilterPacketHeaderCtx_
Definition: detect-engine-prefilter-common.h:35
decode.h
FAIL_IF_NOT_NULL
#define FAIL_IF_NOT_NULL(expr)
Fail a test if expression evaluates to non-NULL.
Definition: util-unittest.h:96
util-debug.h
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEngineThreadCtx_
Definition: detect.h:1244
PARSE_REGEX
#define PARSE_REGEX
Regex for parsing our flow options.
Definition: detect-flow.c:47
DETECT_FLOW_FLAG_TOSERVER
#define DETECT_FLOW_FLAG_TOSERVER
Definition: detect-flow.h:27
DetectSetupParseRegexes
void DetectSetupParseRegexes(const char *parse_str, DetectParseRegex *detect_parse)
Definition: detect-parse.c:3619
SCEnter
#define SCEnter(...)
Definition: util-debug.h:281
SigTableElmt_::tables
uint8_t tables
Definition: detect.h:1452
SCSigMatchAppendSMToList
SigMatch * SCSigMatchAppendSMToList(DetectEngineCtx *de_ctx, Signature *s, uint16_t type, SigMatchCtx *ctx, const int list)
Append a SigMatch to the list type.
Definition: detect-parse.c:388
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
DetectEngineThreadCtxInit
TmEcode DetectEngineThreadCtxInit(ThreadVars *tv, void *initdata, void **data)
initialize thread specific detection engine context
Definition: detect-engine.c:3364
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:360
DETECT_SM_LIST_MATCH
@ DETECT_SM_LIST_MATCH
Definition: detect.h:117
SigInit
Signature * SigInit(DetectEngineCtx *de_ctx, const char *sigstr)
Parses a signature and adds it to the Detection Engine Context.
Definition: detect-parse.c:3097
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:317
SCReturn
#define SCReturn
Definition: util-debug.h:283
Signature_::flags
uint32_t flags
Definition: detect.h:669
Packet_
Definition: decode.h:501
detect-engine-build.h
detect-engine-alert.h
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:747
PrefilterSetupPacketHeader
int PrefilterSetupPacketHeader(DetectEngineCtx *de_ctx, SigGroupHead *sgh, int sm_type, SignatureMask mask, void(*Set)(PrefilterPacketHeaderValue *v, void *), bool(*Compare)(PrefilterPacketHeaderValue v, void *), void(*Match)(DetectEngineThreadCtx *det_ctx, Packet *p, const void *pectx))
Definition: detect-engine-prefilter-common.c:470
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1419
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:226
SIG_FLAG_REQUIRE_STREAM_ONLY
#define SIG_FLAG_REQUIRE_STREAM_ONLY
Definition: detect.h:261
SigGroupBuild
int SigGroupBuild(DetectEngineCtx *de_ctx)
Convert the signature list into the runtime match structure.
Definition: detect-engine-build.c:2194
dtv
DecodeThreadVars * dtv
Definition: fuzz_decodepcapfile.c:33
SigMatchCtx_
Used to start a pointer to SigMatch context Should never be dereferenced without casting to something...
Definition: detect.h:351
cnt
uint32_t cnt
Definition: tmqh-packetpool.h:7
FAIL_IF
#define FAIL_IF(expr)
Fail a test if expression evaluates to true.
Definition: util-unittest.h:71
flags
uint8_t flags
Definition: decode-gre.h:0
suricata-common.h
SigMatch_::type
uint16_t type
Definition: detect.h:357
DetectEngineThreadCtxDeinit
TmEcode DetectEngineThreadCtxDeinit(ThreadVars *tv, void *data)
Definition: detect-engine.c:3596
DetectEngineCtx_::sig_list
Signature * sig_list
Definition: detect.h:941
DetectFlowRegister
void DetectFlowRegister(void)
Registration function for flow: keyword.
Definition: detect-flow.c:65
SIG_FLAG_BOTH
#define SIG_FLAG_BOTH
DETECT_FLOW_FLAG_NOT_ESTABLISHED
#define DETECT_FLOW_FLAG_NOT_ESTABLISHED
Definition: detect-flow.h:30
detect-flow.h
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
DETECT_FLOW_FLAG_ONLY_FRAG
#define DETECT_FLOW_FLAG_ONLY_FRAG
Definition: detect-flow.h:35
PKT_REBUILT_FRAGMENT
#define PKT_REBUILT_FRAGMENT
Definition: decode.h:1304
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:271
DETECT_TABLE_PACKET_PRE_STREAM_FLAG
#define DETECT_TABLE_PACKET_PRE_STREAM_FLAG
Definition: detect.h:562
SCFree
#define SCFree(p)
Definition: util-mem.h:61
DecodeThreadVars_
Structure to hold thread specific data for all decode modules.
Definition: decode.h:963
SigTableElmt_::SupportsPrefilter
bool(* SupportsPrefilter)(const Signature *s)
Definition: detect.h:1441
UTHFreePacket
void UTHFreePacket(Packet *p)
UTHFreePacket: function to release the allocated data from UTHBuildPacket and the packet itself.
Definition: util-unittest-helper.c:473
Signature_::id
uint32_t id
Definition: detect.h:713
DETECT_FLOW_FLAG_ESTABLISHED
#define DETECT_FLOW_FLAG_ESTABLISHED
Definition: detect-flow.h:29
detect-parse.h
DetectFlowFree
void DetectFlowFree(DetectEngineCtx *, void *)
this function will free memory associated with DetectFlowData
Definition: detect-flow.c:465
Signature_
Signature container.
Definition: detect.h:668
SigMatch_
a single match condition for a signature
Definition: detect.h:356
FLOW_PKT_ESTABLISHED
#define FLOW_PKT_ESTABLISHED
Definition: flow.h:227
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2595
SC_Pcre2SubstringCopy
int SC_Pcre2SubstringCopy(pcre2_match_data *match_data, uint32_t number, PCRE2_UCHAR *buffer, PCRE2_SIZE *bufflen)
Definition: detect-parse.c:3595
DetectFlowMatch
int DetectFlowMatch(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
This function is used to match flow flags set on a packet with those passed via flow:
Definition: detect-flow.c:134
PrefilterPacketHeaderValue
Definition: detect-engine-prefilter-common.h:23
DetectEngineCtx_::flags
uint8_t flags
Definition: detect.h:934
detect-engine-prefilter-common.h
flow.h
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:285
StatsThreadCleanup
void StatsThreadCleanup(ThreadVars *tv)
Definition: counters.c:1324
flow-var.h
DETECT_FLOW_FLAG_NO_FRAG
#define DETECT_FLOW_FLAG_NO_FRAG
Definition: detect-flow.h:34
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1446
SIG_FLAG_REQUIRE_PACKET
#define SIG_FLAG_REQUIRE_PACKET
Definition: detect.h:254