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