suricata
detect-engine-analyzer.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2025 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 Eileen Donlon <emdonlo@gmail.com>
22  * \author Victor Julien <victor@inliniac.net>
23  *
24  * Rule analyzers for the detection engine
25  */
26 
27 #include "suricata-common.h"
28 #include "suricata.h"
29 #include "rust.h"
30 #include "action-globals.h"
31 #include "detect.h"
32 #include "detect-parse.h"
33 #include "detect-engine.h"
34 #include "detect-engine-analyzer.h"
35 #include "detect-engine-mpm.h"
36 #include "detect-engine-uint.h"
37 #include "conf.h"
38 #include "detect-content.h"
39 #include "detect-pcre.h"
40 #include "detect-bytejump.h"
41 #include "detect-bytetest.h"
42 #include "detect-isdataat.h"
43 #include "detect-flow.h"
44 #include "detect-tcp-flags.h"
45 #include "detect-tcp-ack.h"
46 #include "detect-ipopts.h"
47 #include "detect-tcp-seq.h"
48 #include "feature.h"
49 #include "util-print.h"
50 #include "util-time.h"
51 #include "util-validate.h"
52 #include "util-conf.h"
53 #include "detect-flowbits.h"
54 #include "util-var-name.h"
55 #include "detect-icmp-id.h"
56 #include "detect-tcp-window.h"
57 
58 static int rule_warnings_only = 0;
59 
60 /* Details for each buffer being tracked */
61 typedef struct DetectEngineAnalyzerItems {
62  int16_t item_id;
63  bool item_seen;
66  const char *item_name;
67  const char *display_name;
69 
70 typedef struct FpPatternStats_ {
71  uint16_t min;
72  uint16_t max;
73  uint32_t cnt;
74  uint64_t tot;
76 
77 /* Track which items require the item_seen value to be exposed */
79  const char *bufname;
81 };
82 
83 typedef struct EngineAnalysisCtx_ {
84 
87 
89  char *file_prefix;
90  pcre2_code *percent_re;
91 
92  /*
93  * This array contains the map between the `analyzer_items` array listed above and
94  * the item ids returned by DetectBufferTypeGetByName. Iterating signature's sigmatch
95  * array provides list_ids. The map converts those ids into elements of the
96  * analyzer items array.
97  *
98  * Ultimately, the g_buffer_type_hash is searched for each buffer name. The size of that
99  * hashlist is 256, so that's the value we use here.
100  */
101  int16_t analyzer_item_map[256];
103  /*
104  * Certain values must be directly accessible. This array contains items that are directly
105  * accessed when checking if they've been seen or not.
106  */
108 
111 
113  /* request keywords */
114  { 0, false, false, true, "http_uri", "http uri" },
115  { 0, false, false, false, "http_raw_uri", "http raw uri" },
116  { 0, false, true, false, "http_method", "http method" },
117  { 0, false, false, false, "http_request_line", "http request line" },
118  { 0, false, false, false, "http_client_body", "http client body" },
119  { 0, false, false, true, "http_header", "http header" },
120  { 0, false, false, false, "http_raw_header", "http raw header" },
121  { 0, false, false, true, "http_cookie", "http cookie" },
122  { 0, false, false, false, "http_user_agent", "http user agent" },
123  { 0, false, false, false, "http_host", "http host" },
124  { 0, false, false, false, "http_raw_host", "http raw host" },
125  { 0, false, false, false, "http_accept_enc", "http accept enc" },
126  { 0, false, false, false, "http_referer", "http referer" },
127  { 0, false, false, false, "http_content_type", "http content type" },
128  { 0, false, false, false, "http_header_names", "http header names" },
129 
130  /* response keywords not listed above */
131  { 0, false, false, false, "http_stat_msg", "http stat msg" },
132  { 0, false, false, false, "http_stat_code", "http stat code" },
133  { 0, false, true, false, "file_data", "http server body" },
134 
135  /* missing request keywords */
136  { 0, false, false, false, "http_request_line", "http request line" },
137  { 0, false, false, false, "http_accept", "http accept" },
138  { 0, false, false, false, "http_accept_lang", "http accept lang" },
139  { 0, false, false, false, "http_connection", "http connection" },
140  { 0, false, false, false, "http_content_len", "http content len" },
141  { 0, false, false, false, "http_protocol", "http protocol" },
142  { 0, false, false, false, "http_start", "http start" },
143 
144  /* missing response keywords; some of the missing are listed above*/
145  { 0, false, false, false, "http_response_line", "http response line" },
146  { 0, false, false, false, "http.server", "http server" },
147  { 0, false, false, false, "http.location", "http location" },
148 };
149 
150 static void FpPatternStatsAdd(FpPatternStats *fp, int list, uint16_t patlen)
151 {
152  if (list < 0 || list >= DETECT_SM_LIST_MAX)
153  return;
154 
155  FpPatternStats *f = &fp[list];
156 
157  if (f->min == 0)
158  f->min = patlen;
159  else if (patlen < f->min)
160  f->min = patlen;
161 
162  if (patlen > f->max)
163  f->max = patlen;
164 
165  f->cnt++;
166  f->tot += patlen;
167 }
168 
169 void EngineAnalysisFP(const DetectEngineCtx *de_ctx, const Signature *s, const char *line)
170 {
171  int fast_pattern_set = 0;
172  int fast_pattern_only_set = 0;
173  int fast_pattern_chop_set = 0;
174  const DetectContentData *fp_cd = NULL;
175  const SigMatch *mpm_sm = s->init_data->mpm_sm;
176  const int mpm_sm_list = s->init_data->mpm_sm_list;
177 
178  if (mpm_sm != NULL) {
179  fp_cd = (DetectContentData *)mpm_sm->ctx;
180  if (fp_cd->flags & DETECT_CONTENT_FAST_PATTERN) {
181  fast_pattern_set = 1;
183  fast_pattern_only_set = 1;
184  } else if (fp_cd->flags & DETECT_CONTENT_FAST_PATTERN_CHOP) {
185  fast_pattern_chop_set = 1;
186  }
187  }
188  }
189 
190  FILE *fp = de_ctx->ea->rule_engine_analysis_fp;
191  fprintf(fp, "== Sid: %u ==\n", s->id);
192  fprintf(fp, "%s\n", line);
193 
194  fprintf(fp, " Fast Pattern analysis:\n");
195  if (s->init_data->prefilter_sm != NULL) {
196  fprintf(fp, " Prefilter on: %s\n",
198  fprintf(fp, "\n");
199  return;
200  }
201 
202  if (fp_cd == NULL) {
203  fprintf(fp, " No content present\n");
204  fprintf(fp, "\n");
205  return;
206  }
207 
208  fprintf(fp, " Fast pattern matcher: ");
209  int list_type = mpm_sm_list;
210  if (list_type == DETECT_SM_LIST_PMATCH)
211  fprintf(fp, "content\n");
212  else {
213  const char *desc = DetectEngineBufferTypeGetDescriptionById(de_ctx, list_type);
214  const char *name = DetectEngineBufferTypeGetNameById(de_ctx, list_type);
215  if (desc && name) {
216  fprintf(fp, "%s (%s)\n", desc, name);
217  }
218  }
219 
220  int flags_set = 0;
221  fprintf(fp, " Flags:");
222  if (fp_cd->flags & DETECT_CONTENT_OFFSET) {
223  fprintf(fp, " Offset");
224  flags_set = 1;
225  } if (fp_cd->flags & DETECT_CONTENT_DEPTH) {
226  fprintf(fp, " Depth");
227  flags_set = 1;
228  }
229  if (fp_cd->flags & DETECT_CONTENT_WITHIN) {
230  fprintf(fp, " Within");
231  flags_set = 1;
232  }
233  if (fp_cd->flags & DETECT_CONTENT_DISTANCE) {
234  fprintf(fp, " Distance");
235  flags_set = 1;
236  }
237  if (fp_cd->flags & DETECT_CONTENT_NOCASE) {
238  fprintf(fp, " Nocase");
239  flags_set = 1;
240  }
241  if (fp_cd->flags & DETECT_CONTENT_NEGATED) {
242  fprintf(fp, " Negated");
243  flags_set = 1;
244  }
245  if (flags_set == 0)
246  fprintf(fp, " None");
247  fprintf(fp, "\n");
248 
249  fprintf(fp, " Fast pattern set: %s\n", fast_pattern_set ? "yes" : "no");
250  fprintf(fp, " Fast pattern only set: %s\n", fast_pattern_only_set ? "yes" : "no");
251  fprintf(fp, " Fast pattern chop set: %s\n", fast_pattern_chop_set ? "yes" : "no");
252  if (fast_pattern_chop_set) {
253  fprintf(fp, " Fast pattern offset, length: %u, %u\n", fp_cd->fp_chop_offset,
254  fp_cd->fp_chop_len);
255  }
256 
257  uint16_t patlen = fp_cd->content_len;
258  uint8_t *pat = SCMalloc(fp_cd->content_len + 1);
259  if (unlikely(pat == NULL)) {
260  FatalError("Error allocating memory");
261  }
262  memcpy(pat, fp_cd->content, fp_cd->content_len);
263  pat[fp_cd->content_len] = '\0';
264  fprintf(fp, " Original content: ");
265  PrintRawUriFp(fp, pat, patlen);
266  fprintf(fp, "\n");
267 
268  if (fast_pattern_chop_set) {
269  SCFree(pat);
270  patlen = fp_cd->fp_chop_len;
271  pat = SCMalloc(fp_cd->fp_chop_len + 1);
272  if (unlikely(pat == NULL)) {
273  exit(EXIT_FAILURE);
274  }
275  memcpy(pat, fp_cd->content + fp_cd->fp_chop_offset, fp_cd->fp_chop_len);
276  pat[fp_cd->fp_chop_len] = '\0';
277  fprintf(fp, " Final content: ");
278  PrintRawUriFp(fp, pat, patlen);
279  fprintf(fp, "\n");
280 
281  FpPatternStatsAdd(&de_ctx->ea->fp_pattern_stats[0], list_type, patlen);
282  } else {
283  fprintf(fp, " Final content: ");
284  PrintRawUriFp(fp, pat, patlen);
285  fprintf(fp, "\n");
286 
287  FpPatternStatsAdd(&de_ctx->ea->fp_pattern_stats[0], list_type, patlen);
288  }
289  SCFree(pat);
290 
291  fprintf(fp, "\n");
292 }
293 
294 /**
295  * \brief Sets up the fast pattern analyzer according to the config.
296  *
297  * \retval 1 If rule analyzer successfully enabled.
298  * \retval 0 If not enabled.
299  */
300 static int SetupFPAnalyzer(DetectEngineCtx *de_ctx)
301 {
302  int fp_engine_analysis_set = 0;
303 
304  if ((SCConfGetBool("engine-analysis.rules-fast-pattern", &fp_engine_analysis_set)) == 0) {
305  return false;
306  }
307 
308  if (fp_engine_analysis_set == 0)
309  return false;
310 
311  const char *log_dir = SCConfigGetLogDirectory();
312  char *log_path = SCMalloc(PATH_MAX);
313  if (log_path == NULL) {
314  FatalError("Unable to allocate scratch memory for rule filename");
315  }
316  snprintf(log_path, PATH_MAX, "%s/%s%s", log_dir,
317  de_ctx->ea->file_prefix ? de_ctx->ea->file_prefix : "", "rules_fast_pattern.txt");
318 
319  FILE *fp = fopen(log_path, "w");
320  if (fp == NULL) {
321  SCLogError("failed to open %s: %s", log_path, strerror(errno));
322  SCFree(log_path);
323  return false;
324  }
325 
327 
328  SCLogInfo("Engine-Analysis for fast_pattern printed to file - %s",
329  log_path);
330  SCFree(log_path);
331 
332  struct timeval tval;
333  gettimeofday(&tval, NULL);
334  struct tm local_tm;
335  struct tm *tms = SCLocalTime(tval.tv_sec, &local_tm);
336  fprintf(fp, "----------------------------------------------"
337  "---------------------\n");
338  fprintf(fp,
339  "Date: %" PRId32 "/%" PRId32 "/%04d -- "
340  "%02d:%02d:%02d\n",
341  tms->tm_mday, tms->tm_mon + 1, tms->tm_year + 1900, tms->tm_hour, tms->tm_min,
342  tms->tm_sec);
343  fprintf(fp, "----------------------------------------------"
344  "---------------------\n");
345 
346  memset(&de_ctx->ea->fp_pattern_stats[0], 0, sizeof(de_ctx->ea->fp_pattern_stats));
347  return true;
348 }
349 
350 /**
351  * \brief Compiles regex for rule analysis
352  * \retval 1 if successful
353  * \retval 0 if on error
354  */
355 static bool PerCentEncodingSetup(EngineAnalysisCtx *ea_ctx)
356 {
357 #define DETECT_PERCENT_ENCODING_REGEX "%[0-9|a-f|A-F]{2}"
358  int en;
359  PCRE2_SIZE eo = 0;
360  int opts = 0; // PCRE2_NEWLINE_ANY??
361 
362  ea_ctx->percent_re = pcre2_compile((PCRE2_SPTR8)DETECT_PERCENT_ENCODING_REGEX,
363  PCRE2_ZERO_TERMINATED, opts, &en, &eo, NULL);
364  if (ea_ctx->percent_re == NULL) {
365  PCRE2_UCHAR errbuffer[256];
366  pcre2_get_error_message(en, errbuffer, sizeof(errbuffer));
367  SCLogError("Compile of \"%s\" failed at offset %d: %s", DETECT_PERCENT_ENCODING_REGEX,
368  (int)eo, errbuffer);
369  return false;
370  }
371 
372  return true;
373 }
374 /**
375  * \brief Sets up the rule analyzer according to the config
376  * \retval 1 if rule analyzer successfully enabled
377  * \retval 0 if not enabled
378  */
379 static int SetupRuleAnalyzer(DetectEngineCtx *de_ctx)
380 {
381  SCConfNode *conf = SCConfGetNode("engine-analysis");
382  int enabled = 0;
383  if (conf != NULL) {
384  const char *value = SCConfNodeLookupChildValue(conf, "rules");
385  if (value && SCConfValIsTrue(value)) {
386  enabled = 1;
387  } else if (value && strcasecmp(value, "warnings-only") == 0) {
388  enabled = 1;
389  rule_warnings_only = 1;
390  }
391  if (enabled) {
392  const char *log_dir;
393  log_dir = SCConfigGetLogDirectory();
394  char log_path[PATH_MAX];
395  snprintf(log_path, sizeof(log_path), "%s/%s%s", log_dir,
396  de_ctx->ea->file_prefix ? de_ctx->ea->file_prefix : "", "rules_analysis.txt");
397  de_ctx->ea->rule_engine_analysis_fp = fopen(log_path, "w");
398  if (de_ctx->ea->rule_engine_analysis_fp == NULL) {
399  SCLogError("failed to open %s: %s", log_path, strerror(errno));
400  return 0;
401  }
402 
403  SCLogInfo("Engine-Analysis for rules printed to file - %s",
404  log_path);
405 
406  struct timeval tval;
407  gettimeofday(&tval, NULL);
408  struct tm local_tm;
409  struct tm *tms = SCLocalTime(tval.tv_sec, &local_tm);
411  "----------------------------------------------"
412  "---------------------\n");
414  "Date: %" PRId32 "/%" PRId32 "/%04d -- "
415  "%02d:%02d:%02d\n",
416  tms->tm_mday, tms->tm_mon + 1, tms->tm_year + 1900, tms->tm_hour, tms->tm_min,
417  tms->tm_sec);
419  "----------------------------------------------"
420  "---------------------\n");
421 
422  /*compile regex's for rule analysis*/
423  if (!PerCentEncodingSetup(de_ctx->ea)) {
425  "Error compiling regex; can't check for percent encoding in normalized "
426  "http content.\n");
427  }
428  }
429  }
430  else {
431  SCLogInfo("Conf parameter \"engine-analysis.rules\" not found. "
432  "Defaulting to not printing the rules analysis report.");
433  }
434  if (!enabled) {
435  SCLogInfo("Engine-Analysis for rules disabled in conf file.");
436  return 0;
437  }
438  return 1;
439 }
440 
441 static void CleanupFPAnalyzer(DetectEngineCtx *de_ctx)
442 {
443  FILE *fp = de_ctx->ea->rule_engine_analysis_fp;
444  fprintf(fp, "============\n"
445  "Summary:\n============\n");
446 
447  for (int i = 0; i < DETECT_SM_LIST_MAX; i++) {
449  if (f->cnt == 0)
450  continue;
451 
452  fprintf(fp,
453  "%s, smallest pattern %u byte(s), longest pattern %u byte(s), number of patterns "
454  "%u, avg pattern len %.2f byte(s)\n",
455  DetectSigmatchListEnumToString(i), f->min, f->max, f->cnt,
456  (float)((double)f->tot / (float)f->cnt));
457  }
458 
461 }
462 
463 static void CleanupRuleAnalyzer(DetectEngineCtx *de_ctx)
464 {
465  if (de_ctx->ea->fp_engine_analysis_fp != NULL) {
466  fclose(de_ctx->ea->fp_engine_analysis_fp);
468  }
469  if (de_ctx->ea->percent_re != NULL) {
470  pcre2_code_free(de_ctx->ea->percent_re);
471  }
472 }
473 
474 void SetupEngineAnalysis(DetectEngineCtx *de_ctx, bool *fp_analysis, bool *rule_analysis)
475 {
476  *fp_analysis = false;
477  *rule_analysis = false;
478 
479  EngineAnalysisCtx *ea = SCCalloc(1, sizeof(EngineAnalysisCtx));
480  if (ea == NULL) {
481  FatalError("Unable to allocate per-engine analysis context");
482  }
483 
484  ea->file_prefix = NULL;
485  int cfg_prefix_len = strlen(de_ctx->config_prefix);
486  if (cfg_prefix_len > 0) {
487  /* length of prefix + NULL + "." */
488  ea->file_prefix = SCCalloc(1, cfg_prefix_len + 1 + 1);
489  if (ea->file_prefix == NULL) {
490  FatalError("Unable to allocate per-engine analysis context name buffer");
491  }
492 
493  snprintf(ea->file_prefix, cfg_prefix_len + 1 + 1, "%s.", de_ctx->config_prefix);
494  }
495 
496  de_ctx->ea = ea;
497 
498  *fp_analysis = SetupFPAnalyzer(de_ctx);
499  *rule_analysis = SetupRuleAnalyzer(de_ctx);
500 
501  if (!(*fp_analysis || *rule_analysis)) {
502  if (ea->file_prefix)
503  SCFree(ea->file_prefix);
504  if (ea->analyzer_items)
505  SCFree(ea->analyzer_items);
506  SCFree(ea);
507  }
508 }
509 
511 {
512  if (de_ctx->ea) {
513  CleanupRuleAnalyzer(de_ctx);
514  CleanupFPAnalyzer(de_ctx);
515  if (de_ctx->ea->file_prefix)
517  if (de_ctx->ea->analyzer_items)
519  SCFree(de_ctx->ea);
520  de_ctx->ea = NULL;
521  }
522 }
523 
524 /**
525  * \brief Checks for % encoding in content.
526  * \param Pointer to content
527  * \retval number of matches if content has % encoding
528  * \retval 0 if it doesn't have % encoding
529  * \retval -1 on error
530  */
531 static int PerCentEncodingMatch(EngineAnalysisCtx *ea_ctx, uint8_t *content, uint16_t content_len)
532 {
533  int ret = 0;
534 
535  pcre2_match_data *match = pcre2_match_data_create_from_pattern(ea_ctx->percent_re, NULL);
536  ret = pcre2_match(ea_ctx->percent_re, (PCRE2_SPTR8)content, content_len, 0, 0, match, NULL);
537  if (ret == -1) {
538  return 0;
539  } else if (ret < -1) {
540  SCLogError("Error parsing content - %s; error code is %d", content, ret);
541  ret = -1;
542  }
543  pcre2_match_data_free(match);
544  return ret;
545 }
546 
547 static void EngineAnalysisRulesPrintFP(const DetectEngineCtx *de_ctx, const Signature *s)
548 {
549  const DetectContentData *fp_cd = NULL;
550  const SigMatch *mpm_sm = s->init_data->mpm_sm;
551  const int mpm_sm_list = s->init_data->mpm_sm_list;
552 
553  if (mpm_sm != NULL) {
554  fp_cd = (DetectContentData *)mpm_sm->ctx;
555  }
556 
557  if (fp_cd == NULL) {
558  return;
559  }
560 
561  uint16_t patlen = fp_cd->content_len;
562  uint8_t *pat = SCMalloc(fp_cd->content_len + 1);
563  if (unlikely(pat == NULL)) {
564  FatalError("Error allocating memory");
565  }
566 
567  EngineAnalysisCtx *ea_ctx = de_ctx->ea;
568 
569  memcpy(pat, fp_cd->content, fp_cd->content_len);
570  pat[fp_cd->content_len] = '\0';
571 
573  SCFree(pat);
574  patlen = fp_cd->fp_chop_len;
575  pat = SCMalloc(fp_cd->fp_chop_len + 1);
576  if (unlikely(pat == NULL)) {
577  exit(EXIT_FAILURE);
578  }
579  memcpy(pat, fp_cd->content + fp_cd->fp_chop_offset, fp_cd->fp_chop_len);
580  pat[fp_cd->fp_chop_len] = '\0';
581  fprintf(ea_ctx->rule_engine_analysis_fp, " Fast Pattern \"");
582  PrintRawUriFp(ea_ctx->rule_engine_analysis_fp, pat, patlen);
583  } else {
584  fprintf(ea_ctx->rule_engine_analysis_fp, " Fast Pattern \"");
585  PrintRawUriFp(ea_ctx->rule_engine_analysis_fp, pat, patlen);
586  }
587  SCFree(pat);
588 
589  fprintf(ea_ctx->rule_engine_analysis_fp, "\" on \"");
590 
591  const int list_type = mpm_sm_list;
592  if (list_type == DETECT_SM_LIST_PMATCH) {
593  int payload = 0;
594  int stream = 0;
596  payload = 1;
598  stream = 1;
599  fprintf(ea_ctx->rule_engine_analysis_fp, "%s",
600  payload ? (stream ? "payload and reassembled stream" : "payload")
601  : "reassembled stream");
602  }
603  else {
604  const char *desc = DetectEngineBufferTypeGetDescriptionById(de_ctx, list_type);
605  const char *name = DetectEngineBufferTypeGetNameById(de_ctx, list_type);
606  if (desc && name) {
607  fprintf(ea_ctx->rule_engine_analysis_fp, "%s (%s)", desc, name);
608  } else if (desc || name) {
609  fprintf(ea_ctx->rule_engine_analysis_fp, "%s", desc ? desc : name);
610  }
611 
612  }
613 
614  fprintf(ea_ctx->rule_engine_analysis_fp, "\" ");
615  const DetectBufferType *bt = DetectEngineBufferTypeGetById(de_ctx, list_type);
616  if (bt && bt->transforms.cnt) {
617  fprintf(ea_ctx->rule_engine_analysis_fp, "(with %d transform(s)) ", bt->transforms.cnt);
618  }
619  fprintf(ea_ctx->rule_engine_analysis_fp, "buffer.\n");
620 }
621 
623  const DetectEngineCtx *de_ctx, const char *line, const char *file, int lineno)
624 {
625  fprintf(de_ctx->ea->fp_engine_analysis_fp, "== Sid: UNKNOWN ==\n");
626  fprintf(de_ctx->ea->fp_engine_analysis_fp, "%s\n", line);
627  fprintf(de_ctx->ea->fp_engine_analysis_fp, " FAILURE: invalid rule.\n");
628  fprintf(de_ctx->ea->fp_engine_analysis_fp, " File: %s.\n", file);
629  fprintf(de_ctx->ea->fp_engine_analysis_fp, " Line: %d.\n", lineno);
630  fprintf(de_ctx->ea->fp_engine_analysis_fp, "\n");
631 }
632 
633 typedef struct RuleAnalyzer {
634  SCJsonBuilder *js; /* document root */
635 
636  SCJsonBuilder *js_warnings;
637  SCJsonBuilder *js_notes;
639 
640 static void ATTR_FMT_PRINTF(2, 3) AnalyzerNote(RuleAnalyzer *ctx, char *fmt, ...)
641 {
642  va_list ap;
643  char str[1024];
644 
645  va_start(ap, fmt);
646  vsnprintf(str, sizeof(str), fmt, ap);
647  va_end(ap);
648 
649  if (!ctx->js_notes)
650  ctx->js_notes = SCJbNewArray();
651  if (ctx->js_notes)
652  SCJbAppendString(ctx->js_notes, str);
653 }
654 
655 static void ATTR_FMT_PRINTF(2, 3) AnalyzerWarning(RuleAnalyzer *ctx, char *fmt, ...)
656 {
657  va_list ap;
658  char str[1024];
659 
660  va_start(ap, fmt);
661  vsnprintf(str, sizeof(str), fmt, ap);
662  va_end(ap);
663 
664  if (!ctx->js_warnings)
665  ctx->js_warnings = SCJbNewArray();
666  if (ctx->js_warnings)
667  SCJbAppendString(ctx->js_warnings, str);
668 }
669 
670 #define CHECK(pat) if (strlen((pat)) <= len && memcmp((pat), buf, MIN(len, strlen((pat)))) == 0) return true;
671 
672 static bool LooksLikeHTTPMethod(const uint8_t *buf, uint16_t len)
673 {
674  CHECK("GET /");
675  CHECK("POST /");
676  CHECK("HEAD /");
677  CHECK("PUT /");
678  return false;
679 }
680 
681 static bool LooksLikeHTTPUA(const uint8_t *buf, uint16_t len)
682 {
683  CHECK("User-Agent: ");
684  CHECK("\nUser-Agent: ");
685  return false;
686 }
687 
688 static void DumpContent(SCJsonBuilder *js, const DetectContentData *cd)
689 {
690  char pattern_str[1024] = "";
691  DetectContentPatternPrettyPrint(cd, pattern_str, sizeof(pattern_str));
692 
693  SCJbSetString(js, "pattern", pattern_str);
694  SCJbSetUint(js, "length", cd->content_len);
695  SCJbSetBool(js, "nocase", cd->flags & DETECT_CONTENT_NOCASE);
696  SCJbSetBool(js, "negated", cd->flags & DETECT_CONTENT_NEGATED);
697  SCJbSetBool(js, "starts_with", cd->flags & DETECT_CONTENT_STARTS_WITH);
698  SCJbSetBool(js, "ends_with", cd->flags & DETECT_CONTENT_ENDS_WITH);
699  SCJbSetBool(js, "is_mpm", cd->flags & DETECT_CONTENT_MPM);
700  SCJbSetBool(js, "no_double_inspect", cd->flags & DETECT_CONTENT_NO_DOUBLE_INSPECTION_REQUIRED);
701  if (cd->flags & DETECT_CONTENT_OFFSET) {
702  SCJbSetUint(js, "offset", cd->offset);
703  }
704  if (cd->flags & DETECT_CONTENT_DEPTH) {
705  SCJbSetUint(js, "depth", cd->depth);
706  }
707  if (cd->flags & DETECT_CONTENT_DISTANCE) {
708  SCJbSetInt(js, "distance", cd->distance);
709  }
710  if (cd->flags & DETECT_CONTENT_WITHIN) {
711  SCJbSetInt(js, "within", cd->within);
712  }
713  SCJbSetBool(js, "fast_pattern", cd->flags & DETECT_CONTENT_FAST_PATTERN);
714  SCJbSetBool(js, "relative_next", cd->flags & DETECT_CONTENT_RELATIVE_NEXT);
715 }
716 
717 static void DumpPcre(SCJsonBuilder *js, const DetectPcreData *cd)
718 {
719  SCJbSetBool(js, "relative", cd->flags & DETECT_PCRE_RELATIVE);
720  SCJbSetBool(js, "relative_next", cd->flags & DETECT_PCRE_RELATIVE_NEXT);
721  SCJbSetBool(js, "nocase", cd->flags & DETECT_PCRE_CASELESS);
722  SCJbSetBool(js, "negated", cd->flags & DETECT_PCRE_NEGATE);
723 }
724 
725 static void DumpMatches(RuleAnalyzer *ctx, SCJsonBuilder *js, const SigMatchData *smd)
726 {
727  if (smd == NULL)
728  return;
729 
730  SCJbOpenArray(js, "matches");
731  do {
732  SCJbStartObject(js);
733  const char *mname = sigmatch_table[smd->type].name;
734  SCJbSetString(js, "name", mname);
735 
736  switch (smd->type) {
737  case DETECT_CONTENT: {
738  const DetectContentData *cd = (const DetectContentData *)smd->ctx;
739 
740  SCJbOpenObject(js, "content");
741  DumpContent(js, cd);
743  AnalyzerNote(ctx, (char *)"'fast_pattern:only' option is silently ignored and "
744  "is interpreted as regular 'fast_pattern'");
745  }
746  if (LooksLikeHTTPMethod(cd->content, cd->content_len)) {
747  AnalyzerWarning(ctx,
748  (char *)"pattern looks like it inspects HTTP, use http.request_line or "
749  "http.method and http.uri instead for improved performance");
750  }
751  if (LooksLikeHTTPUA(cd->content, cd->content_len)) {
752  AnalyzerWarning(ctx,
753  (char *)"pattern looks like it inspects HTTP, use http.user_agent "
754  "or http.header for improved performance");
755  }
757  AnalyzerNote(ctx, (char *)"'within' option for pattern w/o previous content "
758  "was converted to 'depth'");
759  }
761  AnalyzerNote(ctx, (char *)"'distance' option for pattern w/o previous content "
762  "was converted to 'offset'");
763  }
764  SCJbClose(js);
765  break;
766  }
767  case DETECT_PCRE: {
768  const DetectPcreData *cd = (const DetectPcreData *)smd->ctx;
769 
770  SCJbOpenObject(js, "pcre");
771  DumpPcre(js, cd);
772  SCJbClose(js);
773  if (cd->flags & DETECT_PCRE_RAWBYTES) {
774  AnalyzerNote(ctx,
775  (char *)"'/B' (rawbytes) option is a no-op and is silently ignored");
776  }
777  break;
778  }
779  case DETECT_BYTEJUMP: {
780  const DetectBytejumpData *cd = (const DetectBytejumpData *)smd->ctx;
781 
782  SCJbOpenObject(js, "byte_jump");
783  SCJbSetUint(js, "nbytes", cd->nbytes);
784  SCJbSetInt(js, "offset", cd->offset);
785  SCJbSetUint(js, "multiplier", cd->multiplier);
786  SCJbSetInt(js, "post_offset", cd->post_offset);
787  switch (cd->base) {
789  SCJbSetString(js, "base", "unset");
790  break;
792  SCJbSetString(js, "base", "oct");
793  break;
795  SCJbSetString(js, "base", "dec");
796  break;
798  SCJbSetString(js, "base", "hex");
799  break;
800  }
801  SCJbOpenArray(js, "flags");
802  if (cd->flags & DETECT_BYTEJUMP_BEGIN)
803  SCJbAppendString(js, "from_beginning");
804  if (cd->flags & DETECT_BYTEJUMP_LITTLE)
805  SCJbAppendString(js, "little_endian");
806  if (cd->flags & DETECT_BYTEJUMP_BIG)
807  SCJbAppendString(js, "big_endian");
808  if (cd->flags & DETECT_BYTEJUMP_STRING)
809  SCJbAppendString(js, "string");
811  SCJbAppendString(js, "relative");
812  if (cd->flags & DETECT_BYTEJUMP_ALIGN)
813  SCJbAppendString(js, "align");
814  if (cd->flags & DETECT_BYTEJUMP_DCE)
815  SCJbAppendString(js, "dce");
817  SCJbAppendString(js, "offset_be");
818  if (cd->flags & DETECT_BYTEJUMP_END)
819  SCJbAppendString(js, "from_end");
820  SCJbClose(js);
821  SCJbClose(js);
822  break;
823  }
824  case DETECT_BYTETEST: {
825  const DetectBytetestData *cd = (const DetectBytetestData *)smd->ctx;
826 
827  SCJbOpenObject(js, "byte_test");
828  SCJbSetUint(js, "nbytes", cd->nbytes);
829  SCJbSetInt(js, "offset", cd->offset);
830  switch (cd->base) {
832  SCJbSetString(js, "base", "unset");
833  break;
835  SCJbSetString(js, "base", "oct");
836  break;
838  SCJbSetString(js, "base", "dec");
839  break;
841  SCJbSetString(js, "base", "hex");
842  break;
843  }
844  SCJbOpenArray(js, "flags");
845  if (cd->flags & DETECT_BYTETEST_LITTLE)
846  SCJbAppendString(js, "little_endian");
847  if (cd->flags & DETECT_BYTETEST_BIG)
848  SCJbAppendString(js, "big_endian");
849  if (cd->flags & DETECT_BYTETEST_STRING)
850  SCJbAppendString(js, "string");
852  SCJbAppendString(js, "relative");
853  if (cd->flags & DETECT_BYTETEST_DCE)
854  SCJbAppendString(js, "dce");
855  SCJbClose(js);
856  SCJbClose(js);
857  break;
858  }
859  case DETECT_ABSENT: {
860  const DetectAbsentData *dad = (const DetectAbsentData *)smd->ctx;
861  SCJbOpenObject(js, "absent");
862  SCJbSetBool(js, "or_else", dad->or_else);
863  SCJbClose(js);
864  break;
865  }
866 
867  case DETECT_IPOPTS: {
868  const DetectIpOptsData *cd = (const DetectIpOptsData *)smd->ctx;
869 
870  SCJbOpenObject(js, "ipopts");
871  const char *flag = IpOptsFlagToString(cd->ipopt);
872  SCJbSetString(js, "option", flag);
873  SCJbClose(js);
874  break;
875  }
876  case DETECT_FLOWBITS: {
877  const DetectFlowbitsData *cd = (const DetectFlowbitsData *)smd->ctx;
878 
879  SCJbOpenObject(js, "flowbits");
880  switch (cd->cmd) {
882  SCJbSetString(js, "cmd", "isset");
883  break;
885  SCJbSetString(js, "cmd", "isnotset");
886  break;
888  SCJbSetString(js, "cmd", "set");
889  break;
891  SCJbSetString(js, "cmd", "unset");
892  break;
894  SCJbSetString(js, "cmd", "toggle");
895  break;
896  }
897  bool is_or = false;
898  SCJbOpenArray(js, "names");
899  if (cd->or_list_size == 0) {
900  SCJbAppendString(js, VarNameStoreSetupLookup(cd->idx, VAR_TYPE_FLOW_BIT));
901  } else if (cd->or_list_size > 0) {
902  is_or = true;
903  for (uint8_t i = 0; i < cd->or_list_size; i++) {
904  const char *varname =
906  SCJbAppendString(js, varname);
907  }
908  }
909  SCJbClose(js); // array
910  if (is_or) {
911  SCJbSetString(js, "operator", "or");
912  }
913  SCJbClose(js); // object
914  break;
915  }
916  case DETECT_ACK: {
917  const DetectAckData *cd = (const DetectAckData *)smd->ctx;
918 
919  SCJbOpenObject(js, "ack");
920  SCJbSetUint(js, "number", cd->ack);
921  SCJbClose(js);
922  break;
923  }
924  case DETECT_SEQ: {
925  const DetectSeqData *cd = (const DetectSeqData *)smd->ctx;
926  SCJbOpenObject(js, "seq");
927  SCJbSetUint(js, "number", cd->seq);
928  SCJbClose(js);
929  break;
930  }
931  case DETECT_TCPMSS: {
932  const DetectU16Data *cd = (const DetectU16Data *)smd->ctx;
933  SCJbOpenObject(js, "tcp_mss");
934  SCDetectU16ToJson(js, cd);
935  SCJbClose(js);
936  break;
937  }
938  case DETECT_ICMP_ID: {
939  const DetectIcmpIdData *cd = (const DetectIcmpIdData *)smd->ctx;
940  SCJbOpenObject(js, "id");
941  SCJbSetUint(js, "number", SCNtohs(cd->id));
942  SCJbClose(js);
943  break;
944  }
945  case DETECT_WINDOW: {
946  const DetectWindowData *wd = (const DetectWindowData *)smd->ctx;
947  SCJbOpenObject(js, "window");
948  SCJbSetUint(js, "size", wd->size);
949  SCJbSetBool(js, "negated", wd->negated);
950  SCJbClose(js);
951  break;
952  }
953  case DETECT_FLOW_AGE: {
954  const DetectU32Data *cd = (const DetectU32Data *)smd->ctx;
955  SCJbOpenObject(js, "flow_age");
956  SCDetectU32ToJson(js, cd);
957  SCJbClose(js);
958  break;
959  }
960  }
961  SCJbClose(js);
962 
963  if (smd->is_last)
964  break;
965  smd++;
966  } while (1);
967  SCJbClose(js);
968 }
969 
972 {
973  SCEnter();
974 
975  RuleAnalyzer ctx = { NULL, NULL, NULL };
976 
977  ctx.js = SCJbNewObject();
978  if (ctx.js == NULL)
979  SCReturn;
980 
981  if (s->init_data->firewall_rule) {
982  JB_SET_STRING(ctx.js, "class", "firewall");
983  } else {
984  JB_SET_STRING(ctx.js, "class", "threat detection");
985  }
986 
987  SCJbSetString(ctx.js, "raw", s->sig_str);
988  SCJbSetUint(ctx.js, "id", s->id);
989  SCJbSetUint(ctx.js, "gid", s->gid);
990  SCJbSetUint(ctx.js, "rev", s->rev);
991  SCJbSetString(ctx.js, "msg", s->msg);
992 
993  const char *alproto = AppProtoToString(s->alproto);
994  SCJbSetString(ctx.js, "app_proto", alproto);
995 
996  SCJbOpenArray(ctx.js, "requirements");
997  if (s->mask & SIG_MASK_REQUIRE_PAYLOAD) {
998  SCJbAppendString(ctx.js, "payload");
999  }
1000  if (s->mask & SIG_MASK_REQUIRE_NO_PAYLOAD) {
1001  SCJbAppendString(ctx.js, "no_payload");
1002  }
1003  if (s->mask & SIG_MASK_REQUIRE_FLOW) {
1004  SCJbAppendString(ctx.js, "flow");
1005  }
1007  SCJbAppendString(ctx.js, "tcp_flags_init_deinit");
1008  }
1010  SCJbAppendString(ctx.js, "tcp_flags_unusual");
1011  }
1013  SCJbAppendString(ctx.js, "engine_event");
1014  }
1015  if (s->mask & SIG_MASK_REQUIRE_REAL_PKT) {
1016  SCJbAppendString(ctx.js, "real_pkt");
1017  }
1018  SCJbClose(ctx.js);
1019 
1020  SCJbOpenObject(ctx.js, "match_policy");
1021  SCJbOpenArray(ctx.js, "actions");
1022  if (s->action & ACTION_ALERT) {
1023  SCJbAppendString(ctx.js, "alert");
1024  }
1025  if (s->action & ACTION_DROP) {
1026  SCJbAppendString(ctx.js, "drop");
1027  }
1028  if (s->action & ACTION_REJECT) {
1029  SCJbAppendString(ctx.js, "reject");
1030  }
1031  if (s->action & ACTION_REJECT_DST) {
1032  SCJbAppendString(ctx.js, "reject_dst");
1033  }
1034  if (s->action & ACTION_REJECT_BOTH) {
1035  SCJbAppendString(ctx.js, "reject_both");
1036  }
1037  if (s->action & ACTION_CONFIG) {
1038  SCJbAppendString(ctx.js, "config");
1039  }
1040  if (s->action & ACTION_PASS) {
1041  SCJbAppendString(ctx.js, "pass");
1042  }
1043  if (s->action & ACTION_ACCEPT) {
1044  SCJbAppendString(ctx.js, "accept");
1045  }
1046  SCJbClose(ctx.js);
1047 
1048  if (s->action_scope == ACTION_SCOPE_AUTO) {
1050  switch (flow_action) {
1052  SCJbSetString(ctx.js, "scope", "packet");
1053  break;
1055  SCJbSetString(ctx.js, "scope", "flow");
1056  break;
1058  SCJbSetString(ctx.js, "scope", "flow_if_stateful");
1059  break;
1060  }
1061  } else {
1062  enum ActionScope as = s->action_scope;
1063  switch (as) {
1064  case ACTION_SCOPE_PACKET:
1065  SCJbSetString(ctx.js, "scope", "packet");
1066  break;
1067  case ACTION_SCOPE_FLOW:
1068  SCJbSetString(ctx.js, "scope", "flow");
1069  break;
1070  case ACTION_SCOPE_HOOK:
1071  SCJbSetString(ctx.js, "scope", "hook");
1072  break;
1073  case ACTION_SCOPE_TX:
1074  SCJbSetString(ctx.js, "scope", "tx");
1075  break;
1076  case ACTION_SCOPE_AUTO: /* should be unreachable */
1077  break;
1078  }
1079  }
1080  SCJbClose(ctx.js);
1081 
1082  switch (s->type) {
1083  case SIG_TYPE_NOT_SET:
1084  SCJbSetString(ctx.js, "type", "unset");
1085  break;
1086  case SIG_TYPE_IPONLY:
1087  SCJbSetString(ctx.js, "type", "ip_only");
1088  break;
1089  case SIG_TYPE_LIKE_IPONLY:
1090  SCJbSetString(ctx.js, "type", "like_ip_only");
1091  break;
1092  case SIG_TYPE_PDONLY:
1093  SCJbSetString(ctx.js, "type", "pd_only");
1094  break;
1095  case SIG_TYPE_DEONLY:
1096  SCJbSetString(ctx.js, "type", "de_only");
1097  break;
1098  case SIG_TYPE_PKT:
1099  SCJbSetString(ctx.js, "type", "pkt");
1100  break;
1101  case SIG_TYPE_PKT_STREAM:
1102  SCJbSetString(ctx.js, "type", "pkt_stream");
1103  break;
1104  case SIG_TYPE_STREAM:
1105  SCJbSetString(ctx.js, "type", "stream");
1106  break;
1107  case SIG_TYPE_APPLAYER:
1108  SCJbSetString(ctx.js, "type", "app_layer");
1109  break;
1110  case SIG_TYPE_APP_TX:
1111  SCJbSetString(ctx.js, "type", "app_tx");
1112  break;
1113  case SIG_TYPE_MAX:
1114  SCJbSetString(ctx.js, "type", "error");
1115  break;
1116  }
1117 
1118  // dependencies object and its subfields only logged if we have values
1120  SCJbOpenObject(ctx.js, "dependencies");
1121  SCJbOpenObject(ctx.js, "flowbits");
1122  SCJbOpenObject(ctx.js, "upstream");
1124  SCJbOpenObject(ctx.js, "state_modifying_rules");
1125  SCJbOpenArray(ctx.js, "sids");
1126  for (uint32_t i = 0; i < s->init_data->rule_state_dependant_sids_idx; i++) {
1127  SCJbAppendUint(ctx.js, s->init_data->rule_state_dependant_sids_array[i]);
1128  }
1129  SCJbClose(ctx.js); // sids
1130  SCJbOpenArray(ctx.js, "names");
1131  for (uint32_t i = 0; i < s->init_data->rule_state_flowbits_ids_size - 1; i++) {
1132  if (s->init_data->rule_state_flowbits_ids_array[i] != 0) {
1133  SCJbAppendString(ctx.js,
1136  }
1137  }
1138  SCJbClose(ctx.js); // names
1139  SCJbClose(ctx.js); // state_modifying_rules
1140  }
1141  SCJbClose(ctx.js); // upstream
1142  SCJbClose(ctx.js); // flowbits
1143  SCJbClose(ctx.js); // dependencies
1144  }
1145 
1146  SCJbOpenArray(ctx.js, "flags");
1147  if (s->flags & SIG_FLAG_SRC_ANY) {
1148  SCJbAppendString(ctx.js, "src_any");
1149  }
1150  if (s->flags & SIG_FLAG_DST_ANY) {
1151  SCJbAppendString(ctx.js, "dst_any");
1152  }
1153  if (s->flags & SIG_FLAG_SP_ANY) {
1154  SCJbAppendString(ctx.js, "sp_any");
1155  }
1156  if (s->flags & SIG_FLAG_DP_ANY) {
1157  SCJbAppendString(ctx.js, "dp_any");
1158  }
1159  if ((s->action & ACTION_ALERT) == 0) {
1160  SCJbAppendString(ctx.js, "noalert");
1161  }
1162  if (s->flags & SIG_FLAG_DSIZE) {
1163  SCJbAppendString(ctx.js, "dsize");
1164  }
1165  if (s->flags & SIG_FLAG_APPLAYER) {
1166  SCJbAppendString(ctx.js, "applayer");
1167  }
1168  if (s->flags & SIG_FLAG_REQUIRE_PACKET) {
1169  SCJbAppendString(ctx.js, "need_packet");
1170  }
1171  if (s->flags & SIG_FLAG_REQUIRE_STREAM) {
1172  SCJbAppendString(ctx.js, "need_stream");
1173  }
1174  if (s->flags & SIG_FLAG_MPM_NEG) {
1175  SCJbAppendString(ctx.js, "negated_mpm");
1176  }
1177  if (s->flags & SIG_FLAG_FLUSH) {
1178  SCJbAppendString(ctx.js, "flush");
1179  }
1180  if (s->flags & SIG_FLAG_REQUIRE_FLOWVAR) {
1181  SCJbAppendString(ctx.js, "need_flowvar");
1182  }
1183  if (s->flags & SIG_FLAG_FILESTORE) {
1184  SCJbAppendString(ctx.js, "filestore");
1185  }
1186  if (s->flags & SIG_FLAG_TOSERVER) {
1187  SCJbAppendString(ctx.js, "toserver");
1188  }
1189  if (s->flags & SIG_FLAG_TOCLIENT) {
1190  SCJbAppendString(ctx.js, "toclient");
1191  }
1192  if (s->flags & SIG_FLAG_TLSSTORE) {
1193  SCJbAppendString(ctx.js, "tlsstore");
1194  }
1195  if (s->flags & SIG_FLAG_BYPASS) {
1196  SCJbAppendString(ctx.js, "bypass");
1197  }
1198  if (s->flags & SIG_FLAG_PREFILTER) {
1199  SCJbAppendString(ctx.js, "prefilter");
1200  }
1201  if (s->flags & SIG_FLAG_SRC_IS_TARGET) {
1202  SCJbAppendString(ctx.js, "src_is_target");
1203  }
1204  if (s->flags & SIG_FLAG_DEST_IS_TARGET) {
1205  SCJbAppendString(ctx.js, "dst_is_target");
1206  }
1207  SCJbClose(ctx.js);
1208 
1209  const DetectEnginePktInspectionEngine *pkt_mpm = NULL;
1210  const DetectEngineAppInspectionEngine *app_mpm = NULL;
1211 
1212  SCJbOpenArray(ctx.js, "pkt_engines");
1214  for ( ; pkt != NULL; pkt = pkt->next) {
1216  if (name == NULL) {
1217  switch (pkt->sm_list) {
1218  case DETECT_SM_LIST_PMATCH:
1219  name = "payload";
1220  break;
1221  case DETECT_SM_LIST_MATCH:
1222  name = "packet";
1223  break;
1224  default:
1225  name = "unknown";
1226  break;
1227  }
1228  }
1229  SCJbStartObject(ctx.js);
1230  SCJbSetString(ctx.js, "name", name);
1231  SCJbSetBool(ctx.js, "is_mpm", pkt->mpm);
1232  if (pkt->v1.transforms != NULL) {
1233  SCJbOpenArray(ctx.js, "transforms");
1234  for (int t = 0; t < pkt->v1.transforms->cnt; t++) {
1235  SCJbStartObject(ctx.js);
1236  SCJbSetString(ctx.js, "name",
1238  SCJbClose(ctx.js);
1239  }
1240  SCJbClose(ctx.js);
1241  }
1242  DumpMatches(&ctx, ctx.js, pkt->smd);
1243  SCJbClose(ctx.js);
1244  if (pkt->mpm) {
1245  pkt_mpm = pkt;
1246  }
1247  }
1248  SCJbClose(ctx.js);
1249  SCJbOpenArray(ctx.js, "frame_engines");
1251  for (; frame != NULL; frame = frame->next) {
1252  const char *name = DetectEngineBufferTypeGetNameById(de_ctx, frame->sm_list);
1253  SCJbStartObject(ctx.js);
1254  SCJbSetString(ctx.js, "name", name);
1255  SCJbSetBool(ctx.js, "is_mpm", frame->mpm);
1256  if (frame->v1.transforms != NULL) {
1257  SCJbOpenArray(ctx.js, "transforms");
1258  for (int t = 0; t < frame->v1.transforms->cnt; t++) {
1259  SCJbStartObject(ctx.js);
1260  SCJbSetString(ctx.js, "name",
1262  SCJbClose(ctx.js);
1263  }
1264  SCJbClose(ctx.js);
1265  }
1266  DumpMatches(&ctx, ctx.js, frame->smd);
1267  SCJbClose(ctx.js);
1268  }
1269  SCJbClose(ctx.js);
1270 
1272  bool has_stream = false;
1273  bool has_client_body_mpm = false;
1274  bool has_file_data_mpm = false;
1275 
1276  SCJbOpenArray(ctx.js, "engines");
1278  for ( ; app != NULL; app = app->next) {
1280  if (name == NULL) {
1281  switch (app->sm_list) {
1282  case DETECT_SM_LIST_PMATCH:
1283  name = "stream";
1284  break;
1285  default:
1286  name = "unknown";
1287  break;
1288  }
1289  }
1290 
1291  if (app->sm_list == DETECT_SM_LIST_PMATCH && !app->mpm) {
1292  has_stream = true;
1293  } else if (app->mpm && strcmp(name, "http_client_body") == 0) {
1294  has_client_body_mpm = true;
1295  } else if (app->mpm && strcmp(name, "file_data") == 0) {
1296  has_file_data_mpm = true;
1297  }
1298 
1299  SCJbStartObject(ctx.js);
1300  SCJbSetString(ctx.js, "name", name);
1301  const char *direction = app->dir == 0 ? "toserver" : "toclient";
1302  SCJbSetString(ctx.js, "direction", direction);
1303  SCJbSetBool(ctx.js, "is_mpm", app->mpm);
1304  SCJbSetString(ctx.js, "app_proto", AppProtoToString(app->alproto));
1305  SCJbSetUint(ctx.js, "progress", app->progress);
1306 
1307  if (app->v2.transforms != NULL) {
1308  SCJbOpenArray(ctx.js, "transforms");
1309  for (int t = 0; t < app->v2.transforms->cnt; t++) {
1310  SCJbStartObject(ctx.js);
1311  SCJbSetString(ctx.js, "name",
1313  SCJbClose(ctx.js);
1314  }
1315  SCJbClose(ctx.js);
1316  }
1317  DumpMatches(&ctx, ctx.js, app->smd);
1318  SCJbClose(ctx.js);
1319  if (app->mpm) {
1320  app_mpm = app;
1321  }
1322  }
1323  SCJbClose(ctx.js);
1324 
1325  if (has_stream && has_client_body_mpm)
1326  AnalyzerNote(&ctx, (char *)"mpm in http_client_body combined with stream match leads to stream buffering");
1327  if (has_stream && has_file_data_mpm)
1328  AnalyzerNote(&ctx, (char *)"mpm in file_data combined with stream match leads to stream buffering");
1329  }
1330 
1331  SCJbOpenObject(ctx.js, "lists");
1332  for (int i = 0; i < DETECT_SM_LIST_MAX; i++) {
1333  if (s->sm_arrays[i] != NULL) {
1334  SCJbOpenObject(ctx.js, DetectListToHumanString(i));
1335  DumpMatches(&ctx, ctx.js, s->sm_arrays[i]);
1336  SCJbClose(ctx.js);
1337  }
1338  }
1339  SCJbClose(ctx.js);
1340 
1341  if (pkt_mpm || app_mpm) {
1342  SCJbOpenObject(ctx.js, "mpm");
1343 
1344  int mpm_list = pkt_mpm ? DETECT_SM_LIST_PMATCH : app_mpm->sm_list;
1345  const char *name;
1346  if (mpm_list < DETECT_SM_LIST_DYNAMIC_START)
1347  name = DetectListToHumanString(mpm_list);
1348  else
1350  SCJbSetString(ctx.js, "buffer", name);
1351 
1352  SigMatchData *smd = pkt_mpm ? pkt_mpm->smd : app_mpm->smd;
1353  if (smd == NULL && mpm_list == DETECT_SM_LIST_PMATCH) {
1354  smd = s->sm_arrays[mpm_list];
1355  }
1356  do {
1357  switch (smd->type) {
1358  case DETECT_CONTENT: {
1359  const DetectContentData *cd = (const DetectContentData *)smd->ctx;
1360  if (cd->flags & DETECT_CONTENT_MPM) {
1361  DumpContent(ctx.js, cd);
1362  }
1363  break;
1364  }
1365  }
1366 
1367  if (smd->is_last)
1368  break;
1369  smd++;
1370  } while (1);
1371  SCJbClose(ctx.js);
1372  } else if (s->init_data->prefilter_sm) {
1373  SCJbOpenObject(ctx.js, "prefilter");
1374  int prefilter_list = SigMatchListSMBelongsTo(s, s->init_data->prefilter_sm);
1375  const char *name;
1376  if (prefilter_list < DETECT_SM_LIST_DYNAMIC_START)
1377  name = DetectListToHumanString(prefilter_list);
1378  else
1379  name = DetectEngineBufferTypeGetNameById(de_ctx, prefilter_list);
1380  SCJbSetString(ctx.js, "buffer", name);
1381  const char *mname = sigmatch_table[s->init_data->prefilter_sm->type].name;
1382  SCJbSetString(ctx.js, "name", mname);
1383  SCJbClose(ctx.js);
1384  }
1385 
1386  if (ctx.js_warnings) {
1387  SCJbClose(ctx.js_warnings);
1388  SCJbSetObject(ctx.js, "warnings", ctx.js_warnings);
1389  SCJbFree(ctx.js_warnings);
1390  ctx.js_warnings = NULL;
1391  }
1392  if (ctx.js_notes) {
1393  SCJbClose(ctx.js_notes);
1394  SCJbSetObject(ctx.js, "notes", ctx.js_notes);
1395  SCJbFree(ctx.js_notes);
1396  ctx.js_notes = NULL;
1397  }
1398  SCJbClose(ctx.js);
1399 
1400  const char *filename = "rules.json";
1401  const char *log_dir = SCConfigGetLogDirectory();
1402  char json_path[PATH_MAX] = "";
1403  snprintf(json_path, sizeof(json_path), "%s/%s%s", log_dir,
1404  de_ctx->ea->file_prefix ? de_ctx->ea->file_prefix : "", filename);
1405 
1407  FILE *fp = fopen(json_path, "a");
1408  if (fp != NULL) {
1409  fwrite(SCJbPtr(ctx.js), SCJbLen(ctx.js), 1, fp);
1410  fprintf(fp, "\n");
1411  fclose(fp);
1412  }
1414  SCJbFree(ctx.js);
1415  SCReturn;
1416 }
1417 
1419 {
1420  if (de_ctx->pattern_hash_table == NULL)
1421  return;
1422 
1423  SCJsonBuilder *root_jb = SCJbNewObject();
1424  SCJsonBuilder *arrays[de_ctx->buffer_type_id];
1425  memset(&arrays, 0, sizeof(SCJsonBuilder *) * de_ctx->buffer_type_id);
1426 
1427  SCJbOpenArray(root_jb, "buffers");
1428 
1430  htb != NULL; htb = HashListTableGetListNext(htb)) {
1431  char str[1024] = "";
1433  DetectContentPatternPrettyPrint(p->cd, str, sizeof(str));
1434 
1435  SCJsonBuilder *jb = arrays[p->sm_list];
1436  if (arrays[p->sm_list] == NULL) {
1437  jb = arrays[p->sm_list] = SCJbNewObject();
1438  const char *name;
1441  else
1443  SCJbSetString(jb, "name", name);
1444  SCJbSetUint(jb, "list_id", p->sm_list);
1445 
1446  SCJbOpenArray(jb, "patterns");
1447  }
1448 
1449  SCJbStartObject(jb);
1450  SCJbSetString(jb, "pattern", str);
1451  SCJbSetUint(jb, "patlen", p->cd->content_len);
1452  SCJbSetUint(jb, "cnt", p->cnt);
1453  SCJbSetUint(jb, "mpm", p->mpm);
1454  SCJbOpenObject(jb, "flags");
1455  SCJbSetBool(jb, "nocase", p->cd->flags & DETECT_CONTENT_NOCASE);
1456  SCJbSetBool(jb, "negated", p->cd->flags & DETECT_CONTENT_NEGATED);
1457  SCJbSetBool(jb, "depth", p->cd->flags & DETECT_CONTENT_DEPTH);
1458  SCJbSetBool(jb, "offset", p->cd->flags & DETECT_CONTENT_OFFSET);
1459  SCJbSetBool(jb, "endswith", p->cd->flags & DETECT_CONTENT_ENDS_WITH);
1460  SCJbClose(jb);
1461  SCJbClose(jb);
1462  }
1463 
1464  for (uint32_t i = 0; i < de_ctx->buffer_type_id; i++) {
1465  SCJsonBuilder *jb = arrays[i];
1466  if (jb == NULL)
1467  continue;
1468 
1469  SCJbClose(jb); // array
1470  SCJbClose(jb); // object
1471 
1472  SCJbAppendObject(root_jb, jb);
1473  SCJbFree(jb);
1474  }
1475  SCJbClose(root_jb);
1476  SCJbClose(root_jb);
1477 
1478  const char *filename = "patterns.json";
1479  const char *log_dir = SCConfigGetLogDirectory();
1480  char json_path[PATH_MAX] = "";
1481  snprintf(json_path, sizeof(json_path), "%s/%s%s", log_dir,
1482  de_ctx->ea->file_prefix ? de_ctx->ea->file_prefix : "", filename);
1483 
1485  FILE *fp = fopen(json_path, "a");
1486  if (fp != NULL) {
1487  fwrite(SCJbPtr(root_jb), SCJbLen(root_jb), 1, fp);
1488  fprintf(fp, "\n");
1489  fclose(fp);
1490  }
1492  SCJbFree(root_jb);
1493 
1495  de_ctx->pattern_hash_table = NULL;
1496 }
1497 
1498 static void EngineAnalysisItemsReset(EngineAnalysisCtx *ea_ctx)
1499 {
1500  for (size_t i = 0; i < ARRAY_SIZE(analyzer_items); i++) {
1501  ea_ctx->analyzer_items[i].item_seen = false;
1502  }
1503 }
1504 
1505 static void EngineAnalysisItemsInit(EngineAnalysisCtx *ea_ctx)
1506 {
1507  if (ea_ctx->analyzer_initialized) {
1508  EngineAnalysisItemsReset(ea_ctx);
1509  return;
1510  }
1511 
1512  ea_ctx->exposed_item_seen_list[0].bufname = "http_method";
1513  ea_ctx->exposed_item_seen_list[1].bufname = "file_data";
1514  ea_ctx->analyzer_items = SCCalloc(1, sizeof(analyzer_items));
1515  if (!ea_ctx->analyzer_items) {
1516  FatalError("Unable to allocate analysis scratch pad");
1517  }
1518  memset(ea_ctx->analyzer_item_map, -1, sizeof(ea_ctx->analyzer_item_map));
1519 
1520  for (size_t i = 0; i < ARRAY_SIZE(analyzer_items); i++) {
1521  ea_ctx->analyzer_items[i] = analyzer_items[i];
1522  DetectEngineAnalyzerItems *analyzer_item = &ea_ctx->analyzer_items[i];
1523 
1524  int item_id = DetectBufferTypeGetByName(analyzer_item->item_name);
1525  DEBUG_VALIDATE_BUG_ON(item_id < 0 || item_id > UINT16_MAX);
1526  analyzer_item->item_id = (uint16_t)item_id;
1527  if (analyzer_item->item_id == -1) {
1528  /* Mismatch between the analyzer_items array and what's supported */
1529  FatalError("unable to initialize engine-analysis table: detect buffer \"%s\" not "
1530  "recognized.",
1531  analyzer_item->item_name);
1532  }
1533  analyzer_item->item_seen = false;
1534 
1535  if (analyzer_item->export_item_seen) {
1536  for (size_t k = 0; k < ARRAY_SIZE(ea_ctx->exposed_item_seen_list); k++) {
1537  if (0 ==
1538  strcmp(ea_ctx->exposed_item_seen_list[k].bufname, analyzer_item->item_name))
1539  ea_ctx->exposed_item_seen_list[k].item_seen_ptr = &analyzer_item->item_seen;
1540  }
1541  }
1542  ea_ctx->analyzer_item_map[analyzer_item->item_id] = (int16_t)i;
1543  }
1544 
1545  ea_ctx->analyzer_initialized = true;
1546 }
1547 
1548 /**
1549  * \brief Prints analysis of loaded rules.
1550  *
1551  * Warns if potential rule issues are detected. For example,
1552  * warns if a rule uses a construct that may perform poorly,
1553  * e.g. pcre without content or with http_method content only;
1554  * warns if a rule uses a construct that may not be consistent with intent,
1555  * e.g. client side ports only, http and content without any http_* modifiers, etc.
1556  *
1557  * \param s Pointer to the signature.
1558  */
1560  const Signature *s, const char *line)
1561 {
1562  uint32_t rule_bidirectional = 0;
1563  uint32_t rule_pcre = 0;
1564  uint32_t rule_pcre_http = 0;
1565  uint32_t rule_content = 0;
1566  uint32_t rule_flow = 0;
1567  uint32_t rule_flags = 0;
1568  uint32_t rule_flow_toserver = 0;
1569  uint32_t rule_flow_toclient = 0;
1570  uint32_t rule_flow_nostream = 0;
1571  uint32_t rule_ipv4_only = 0;
1572  uint32_t rule_ipv6_only = 0;
1573  uint32_t rule_flowbits = 0;
1574  uint32_t rule_flowint = 0;
1575  uint32_t rule_content_http = 0;
1576  uint32_t rule_content_offset_depth = 0;
1577  int32_t list_id = 0;
1578  uint32_t rule_warning = 0;
1579  uint32_t stream_buf = 0;
1580  uint32_t packet_buf = 0;
1581  uint32_t file_store = 0;
1582  uint32_t warn_pcre_no_content = 0;
1583  uint32_t warn_pcre_http_content = 0;
1584  uint32_t warn_pcre_http = 0;
1585  uint32_t warn_content_http_content = 0;
1586  uint32_t warn_content_http = 0;
1587  uint32_t warn_tcp_no_flow = 0;
1588  uint32_t warn_client_ports = 0;
1589  uint32_t warn_direction = 0;
1590  uint32_t warn_method_toclient = 0;
1591  uint32_t warn_method_serverbody = 0;
1592  uint32_t warn_pcre_method = 0;
1593  uint32_t warn_encoding_norm_http_buf = 0;
1594  uint32_t warn_file_store_not_present = 0;
1595  uint32_t warn_offset_depth_pkt_stream = 0;
1596  uint32_t warn_offset_depth_alproto = 0;
1597  uint32_t warn_non_alproto_fp_for_alproto_sig = 0;
1598  uint32_t warn_no_direction = 0;
1599  uint32_t warn_both_direction = 0;
1600 
1601  EngineAnalysisItemsInit(de_ctx->ea);
1602 
1603  bool *http_method_item_seen_ptr = de_ctx->ea->exposed_item_seen_list[0].item_seen_ptr;
1604  bool *http_server_body_item_seen_ptr = de_ctx->ea->exposed_item_seen_list[1].item_seen_ptr;
1605 
1607  rule_bidirectional = 1;
1608  }
1609 
1610  if (s->flags & SIG_FLAG_REQUIRE_PACKET) {
1611  packet_buf += 1;
1612  }
1613  if (s->flags & SIG_FLAG_FILESTORE) {
1614  file_store += 1;
1615  }
1616  if (s->flags & SIG_FLAG_REQUIRE_STREAM) {
1617  stream_buf += 1;
1618  }
1619 
1620  if (s->proto.flags & DETECT_PROTO_IPV4) {
1621  rule_ipv4_only += 1;
1622  }
1623  if (s->proto.flags & DETECT_PROTO_IPV6) {
1624  rule_ipv6_only += 1;
1625  }
1626 
1627  for (list_id = 0; list_id < DETECT_SM_LIST_MAX; list_id++) {
1628  SigMatch *sm = NULL;
1629  for (sm = s->init_data->smlists[list_id]; sm != NULL; sm = sm->next) {
1630  int16_t item_slot = de_ctx->ea->analyzer_item_map[list_id];
1631  if (sm->type == DETECT_PCRE) {
1632  if (item_slot == -1) {
1633  rule_pcre++;
1634  continue;
1635  }
1636 
1637  rule_pcre_http++;
1638  de_ctx->ea->analyzer_items[item_slot].item_seen = true;
1639  } else if (sm->type == DETECT_CONTENT) {
1640  if (item_slot == -1) {
1641  rule_content++;
1642  if (list_id == DETECT_SM_LIST_PMATCH) {
1645  rule_content_offset_depth++;
1646  }
1647  }
1648  continue;
1649  }
1650 
1651  rule_content_http++;
1652  de_ctx->ea->analyzer_items[item_slot].item_seen = true;
1653 
1654  if (de_ctx->ea->analyzer_items[item_slot].check_encoding_match) {
1656  if (cd != NULL &&
1657  PerCentEncodingMatch(de_ctx->ea, cd->content, cd->content_len) > 0) {
1658  warn_encoding_norm_http_buf += 1;
1659  }
1660  }
1661  }
1662  else if (sm->type == DETECT_FLOW) {
1663  rule_flow += 1;
1664  if ((s->flags & SIG_FLAG_TOSERVER) && !(s->flags & SIG_FLAG_TOCLIENT)) {
1665  rule_flow_toserver = 1;
1666  }
1667  else if ((s->flags & SIG_FLAG_TOCLIENT) && !(s->flags & SIG_FLAG_TOSERVER)) {
1668  rule_flow_toclient = 1;
1669  }
1670  DetectFlowData *fd = (DetectFlowData *)sm->ctx;
1671  if (fd != NULL) {
1672  if (fd->flags & DETECT_FLOW_FLAG_NOSTREAM)
1673  rule_flow_nostream = 1;
1674  }
1675  }
1676  else if (sm->type == DETECT_FLOWBITS) {
1677  if (list_id == DETECT_SM_LIST_MATCH) {
1678  rule_flowbits += 1;
1679  }
1680  }
1681  else if (sm->type == DETECT_FLOWINT) {
1682  if (list_id == DETECT_SM_LIST_MATCH) {
1683  rule_flowint += 1;
1684  }
1685  }
1686  else if (sm->type == DETECT_FLAGS) {
1687  DetectFlagsData *fd = (DetectFlagsData *)sm->ctx;
1688  if (fd != NULL) {
1689  rule_flags = 1;
1690  }
1691  }
1692  } /* for (sm = s->init_data->smlists[list_id]; sm != NULL; sm = sm->next) */
1693 
1694  } /* for ( ; list_id < DETECT_SM_LIST_MAX; list_id++) */
1695 
1696  if (file_store && !RequiresFeature("output::file-store")) {
1697  rule_warning += 1;
1698  warn_file_store_not_present = 1;
1699  }
1700 
1701  if (rule_pcre > 0 && rule_content == 0 && rule_content_http == 0) {
1702  rule_warning += 1;
1703  warn_pcre_no_content = 1;
1704  }
1705 
1706  if (rule_content_http > 0 && rule_pcre > 0 && rule_pcre_http == 0) {
1707  rule_warning += 1;
1708  warn_pcre_http_content = 1;
1709  } else if (s->alproto == ALPROTO_HTTP1 && rule_pcre > 0 && rule_pcre_http == 0) {
1710  rule_warning += 1;
1711  warn_pcre_http = 1;
1712  }
1713 
1714  if (rule_content > 0 && rule_content_http > 0) {
1715  rule_warning += 1;
1716  warn_content_http_content = 1;
1717  }
1718  if (s->alproto == ALPROTO_HTTP1 && rule_content > 0 && rule_content_http == 0) {
1719  rule_warning += 1;
1720  warn_content_http = 1;
1721  }
1722  if (rule_content == 1) {
1723  //todo: warning if content is weak, separate warning for pcre + weak content
1724  }
1725  if (rule_flow == 0 && rule_flags == 0 && !(s->proto.flags & DETECT_PROTO_ANY) &&
1726  DetectProtoContainsProto(&s->proto, IPPROTO_TCP) &&
1727  (rule_content || rule_content_http || rule_pcre || rule_pcre_http || rule_flowbits ||
1728  rule_flowint)) {
1729  rule_warning += 1;
1730  warn_tcp_no_flow = 1;
1731  }
1732  if (rule_flow && !rule_bidirectional && (rule_flow_toserver || rule_flow_toclient)
1733  && !((s->flags & SIG_FLAG_SP_ANY) && (s->flags & SIG_FLAG_DP_ANY))) {
1734  if (((s->flags & SIG_FLAG_TOSERVER) && !(s->flags & SIG_FLAG_SP_ANY) && (s->flags & SIG_FLAG_DP_ANY))
1735  || ((s->flags & SIG_FLAG_TOCLIENT) && !(s->flags & SIG_FLAG_DP_ANY) && (s->flags & SIG_FLAG_SP_ANY))) {
1736  rule_warning += 1;
1737  warn_client_ports = 1;
1738  }
1739  }
1740  if (rule_flow && rule_bidirectional && (rule_flow_toserver || rule_flow_toclient)) {
1741  rule_warning += 1;
1742  warn_direction = 1;
1743  }
1744 
1745  if (*http_method_item_seen_ptr) {
1746  if (rule_flow && rule_flow_toclient) {
1747  rule_warning += 1;
1748  warn_method_toclient = 1;
1749  }
1750  if (*http_server_body_item_seen_ptr) {
1751  rule_warning += 1;
1752  warn_method_serverbody = 1;
1753  }
1754  if (rule_content == 0 && rule_content_http == 0 && (rule_pcre > 0 || rule_pcre_http > 0)) {
1755  rule_warning += 1;
1756  warn_pcre_method = 1;
1757  }
1758  }
1759  if (rule_content_offset_depth > 0 && stream_buf && packet_buf) {
1760  rule_warning += 1;
1761  warn_offset_depth_pkt_stream = 1;
1762  }
1763  if (rule_content_offset_depth > 0 && !stream_buf && packet_buf && s->alproto != ALPROTO_UNKNOWN) {
1764  rule_warning += 1;
1765  warn_offset_depth_alproto = 1;
1766  }
1767  if (s->init_data->mpm_sm != NULL && s->alproto == ALPROTO_HTTP1 &&
1769  rule_warning += 1;
1770  warn_non_alproto_fp_for_alproto_sig = 1;
1771  }
1772 
1773  if ((s->flags & (SIG_FLAG_TOSERVER|SIG_FLAG_TOCLIENT)) == 0) {
1774  warn_no_direction += 1;
1775  rule_warning += 1;
1776  }
1777 
1778  /* No warning about direction for ICMP protos */
1779  if (!(DetectProtoContainsProto(&s->proto, IPPROTO_ICMPV6) && DetectProtoContainsProto(&s->proto, IPPROTO_ICMP))) {
1781  warn_both_direction += 1;
1782  rule_warning += 1;
1783  }
1784  }
1785 
1786  if (!rule_warnings_only || (rule_warnings_only && rule_warning > 0)) {
1787  FILE *fp = de_ctx->ea->rule_engine_analysis_fp;
1788  fprintf(fp, "== Sid: %u ==\n", s->id);
1789  fprintf(fp, "%s\n", line);
1790 
1791  switch (s->type) {
1792  case SIG_TYPE_NOT_SET:
1793  break;
1794  case SIG_TYPE_IPONLY:
1795  fprintf(fp, " Rule is ip only.\n");
1796  break;
1797  case SIG_TYPE_LIKE_IPONLY:
1798  fprintf(fp, " Rule is like ip only.\n");
1799  break;
1800  case SIG_TYPE_PDONLY:
1801  fprintf(fp, " Rule is PD only.\n");
1802  break;
1803  case SIG_TYPE_DEONLY:
1804  fprintf(fp, " Rule is DE only.\n");
1805  break;
1806  case SIG_TYPE_PKT:
1807  fprintf(fp, " Rule is packet inspecting.\n");
1808  break;
1809  case SIG_TYPE_PKT_STREAM:
1810  fprintf(fp, " Rule is packet and stream inspecting.\n");
1811  break;
1812  case SIG_TYPE_STREAM:
1813  fprintf(fp, " Rule is stream inspecting.\n");
1814  break;
1815  case SIG_TYPE_APPLAYER:
1816  fprintf(fp, " Rule is app-layer inspecting.\n");
1817  break;
1818  case SIG_TYPE_APP_TX:
1819  fprintf(fp, " Rule is App-layer TX inspecting.\n");
1820  break;
1821  case SIG_TYPE_MAX:
1822  break;
1823  }
1824  if (rule_ipv6_only)
1825  fprintf(fp, " Rule is IPv6 only.\n");
1826  if (rule_ipv4_only)
1827  fprintf(fp, " Rule is IPv4 only.\n");
1828  if (packet_buf)
1829  fprintf(fp, " Rule matches on packets.\n");
1830  if (!rule_flow_nostream && stream_buf &&
1831  (rule_flow || rule_flowbits || rule_flowint || rule_content || rule_pcre)) {
1832  fprintf(fp, " Rule matches on reassembled stream.\n");
1833  }
1834  for(size_t i = 0; i < ARRAY_SIZE(analyzer_items); i++) {
1836  if (ai->item_seen) {
1837  fprintf(fp, " Rule matches on %s buffer.\n", ai->display_name);
1838  }
1839  }
1840  if (s->alproto != ALPROTO_UNKNOWN) {
1841  fprintf(fp, " App layer protocol is %s.\n", AppProtoToString(s->alproto));
1842  }
1843  if (rule_content || rule_content_http || rule_pcre || rule_pcre_http) {
1844  fprintf(fp,
1845  " Rule contains %u content options, %u http content options, %u pcre "
1846  "options, and %u pcre options with http modifiers.\n",
1847  rule_content, rule_content_http, rule_pcre, rule_pcre_http);
1848  }
1849 
1850  /* print fast pattern info */
1851  if (s->init_data->prefilter_sm) {
1852  fprintf(fp, " Prefilter on: %s.\n",
1854  } else {
1855  EngineAnalysisRulesPrintFP(de_ctx, s);
1856  }
1857 
1858  /* this is where the warnings start */
1859  if (warn_pcre_no_content /*rule_pcre > 0 && rule_content == 0 && rule_content_http == 0*/) {
1860  fprintf(fp, " Warning: Rule uses pcre without a content option present.\n"
1861  " -Consider adding a content to improve performance of this "
1862  "rule.\n");
1863  }
1864  if (warn_pcre_http_content /*rule_content_http > 0 && rule_pcre > 0 && rule_pcre_http == 0*/) {
1865  fprintf(fp, " Warning: Rule uses content options with http_* and pcre options "
1866  "without http modifiers.\n"
1867  " -Consider adding http pcre modifier.\n");
1868  }
1869  else if (warn_pcre_http /*s->alproto == ALPROTO_HTTP1 && rule_pcre > 0 && rule_pcre_http == 0*/) {
1870  fprintf(fp, " Warning: Rule app layer protocol is http, but pcre options do not "
1871  "have http modifiers.\n"
1872  " -Consider adding http pcre modifiers.\n");
1873  }
1874  if (warn_content_http_content /*rule_content > 0 && rule_content_http > 0*/) {
1875  fprintf(fp,
1876  " Warning: Rule contains content with http_* and content without http_*.\n"
1877  " -Consider adding http content modifiers.\n");
1878  }
1879  if (warn_content_http /*s->alproto == ALPROTO_HTTP1 && rule_content > 0 && rule_content_http == 0*/) {
1880  fprintf(fp, " Warning: Rule app layer protocol is http, but content options do not "
1881  "have http_* modifiers.\n"
1882  " -Consider adding http content modifiers.\n");
1883  }
1884  if (rule_content == 1) {
1885  //todo: warning if content is weak, separate warning for pcre + weak content
1886  }
1887  if (warn_encoding_norm_http_buf) {
1888  fprintf(fp, " Warning: Rule may contain percent encoded content for a normalized "
1889  "http buffer match.\n");
1890  }
1891  if (warn_tcp_no_flow /*rule_flow == 0 && rule_flags == 0
1892  && !(s->proto.flags & DETECT_PROTO_ANY) && DetectProtoContainsProto(&s->proto, IPPROTO_TCP)*/) {
1893  fprintf(fp, " Warning: TCP rule without a flow or flags option.\n"
1894  " -Consider adding flow or flags to improve performance of "
1895  "this rule.\n");
1896  }
1897  if (warn_client_ports /*rule_flow && !rule_bidirectional && (rule_flow_toserver || rule_flow_toclient)
1898  && !((s->flags & SIG_FLAG_SP_ANY) && (s->flags & SIG_FLAG_DP_ANY)))
1899  if (((s->flags & SIG_FLAG_TOSERVER) && !(s->flags & SIG_FLAG_SP_ANY) && (s->flags & SIG_FLAG_DP_ANY))
1900  || ((s->flags & SIG_FLAG_TOCLIENT) && !(s->flags & SIG_FLAG_DP_ANY) && (s->flags & SIG_FLAG_SP_ANY))*/) {
1901  fprintf(fp,
1902  " Warning: Rule contains ports or port variables only on the client side.\n"
1903  " -Flow direction possibly inconsistent with rule.\n");
1904  }
1905  if (warn_direction /*rule_flow && rule_bidirectional && (rule_flow_toserver || rule_flow_toclient)*/) {
1906  fprintf(fp, " Warning: Rule is bidirectional and has a flow option with a specific "
1907  "direction.\n");
1908  }
1909  if (warn_method_toclient /*http_method_buf && rule_flow && rule_flow_toclient*/) {
1910  fprintf(fp, " Warning: Rule uses content or pcre for http_method with "
1911  "flow:to_client or from_server\n");
1912  }
1913  if (warn_method_serverbody /*http_method_buf && http_server_body_buf*/) {
1914  fprintf(fp, " Warning: Rule uses content or pcre for http_method with content or "
1915  "pcre for http_server_body.\n");
1916  }
1917  if (warn_pcre_method /*http_method_buf && rule_content == 0 && rule_content_http == 0
1918  && (rule_pcre > 0 || rule_pcre_http > 0)*/) {
1919  fprintf(fp, " Warning: Rule uses pcre with only a http_method content; possible "
1920  "performance issue.\n");
1921  }
1922  if (warn_offset_depth_pkt_stream) {
1923  fprintf(fp, " Warning: Rule has depth"
1924  "/offset with raw content keywords. Please note the "
1925  "offset/depth will be checked against both packet "
1926  "payloads and stream. If you meant to have the offset/"
1927  "depth checked against just the payload, you can update "
1928  "the signature as \"alert tcp-pkt...\"\n");
1929  }
1930  if (warn_offset_depth_alproto) {
1931  fprintf(fp,
1932  " Warning: Rule has "
1933  "offset/depth set along with a match on a specific "
1934  "app layer protocol - %d. This can lead to FNs if we "
1935  "have a offset/depth content match on a packet payload "
1936  "before we can detect the app layer protocol for the "
1937  "flow.\n",
1938  s->alproto);
1939  }
1940  if (warn_non_alproto_fp_for_alproto_sig) {
1941  fprintf(fp, " Warning: Rule app layer "
1942  "protocol is http, but the fast_pattern is set on the raw "
1943  "stream. Consider adding fast_pattern over a http "
1944  "buffer for increased performance.");
1945  }
1946  if (warn_no_direction) {
1947  fprintf(fp, " Warning: Rule has no direction indicator.\n");
1948  }
1949  if (warn_both_direction) {
1950  fprintf(fp, " Warning: Rule is inspecting both the request and the response.\n");
1951  }
1952  if (warn_file_store_not_present) {
1953  fprintf(fp, " Warning: Rule requires file-store but the output file-store is not "
1954  "enabled.\n");
1955  }
1956  if (rule_warning == 0) {
1957  fprintf(fp, " No warnings for this rule.\n");
1958  }
1959  fprintf(fp, "\n");
1960  }
1961 }
1962 
1963 #include "app-layer-parser.h"
1964 
1965 static void FirewallAddRulesForState(const DetectEngineCtx *de_ctx, const AppProto a,
1966  const uint8_t state, const uint8_t direction, RuleAnalyzer *ctx)
1967 {
1968  uint32_t accept_rules = 0;
1969  SCJbSetString(ctx->js, "policy", "drop:flow");
1970  SCJbOpenArray(ctx->js, "rules");
1971  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
1972  if ((s->flags & SIG_FLAG_FIREWALL) == 0)
1973  break;
1974  if (s->type != SIG_TYPE_APP_TX)
1975  continue;
1976  if (s->alproto != a)
1977  continue;
1978 
1979  if (direction == STREAM_TOSERVER) {
1980  if (s->flags & SIG_FLAG_TOCLIENT) {
1981  continue;
1982  }
1983  } else {
1984  if (s->flags & SIG_FLAG_TOSERVER) {
1985  continue;
1986  }
1987  }
1988 
1989  if (s->app_progress_hook == state) {
1990  SCJbAppendString(ctx->js, s->sig_str);
1991  accept_rules += ((s->action & ACTION_ACCEPT) != 0);
1992  }
1993  }
1994  SCJbClose(ctx->js);
1995 
1996  if (accept_rules == 0) {
1997  AnalyzerWarning(ctx, (char *)"no accept rules for state, default policy will be applied");
1998  }
1999 }
2000 
2002 {
2003  RuleAnalyzer ctx = { NULL, NULL, NULL };
2004  ctx.js = SCJbNewObject();
2005  if (ctx.js == NULL)
2006  return -1;
2007 
2008  SCJbOpenObject(ctx.js, "tables");
2009  SCJbOpenObject(ctx.js, "packet:filter");
2010  SCJbSetString(ctx.js, "policy", "drop:packet");
2011  SCJbOpenArray(ctx.js, "rules");
2012  uint32_t accept_rules = 0;
2013  uint32_t last_sid = 0;
2014  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2015  if ((s->flags & SIG_FLAG_FIREWALL) == 0)
2016  break;
2017  if (s->type != SIG_TYPE_PKT)
2018  continue;
2019  /* don't double list <> sigs */
2020  if (last_sid == s->id)
2021  continue;
2022  last_sid = s->id;
2023  SCJbAppendString(ctx.js, s->sig_str);
2024  accept_rules += ((s->action & ACTION_ACCEPT) != 0);
2025  }
2026  SCJbClose(ctx.js);
2027  if (accept_rules == 0) {
2028  AnalyzerWarning(&ctx,
2029  (char *)"no accept rules for \'packet:filter\', default policy will be applied");
2030  }
2031  if (ctx.js_warnings) {
2032  SCJbClose(ctx.js_warnings);
2033  SCJbSetObject(ctx.js, "warnings", ctx.js_warnings);
2034  SCJbFree(ctx.js_warnings);
2035  ctx.js_warnings = NULL;
2036  }
2037  SCJbClose(ctx.js); // packet_filter
2038 
2039  for (AppProto a = 0; a < g_alproto_max; a++) {
2040  if (!AppProtoIsValid(a))
2041  continue;
2042 
2043  // HACK not all protocols have named states yet
2044  const char *hack = AppLayerParserGetStateNameById(IPPROTO_TCP, a, 0, STREAM_TOSERVER);
2045  if (!hack)
2046  continue;
2047 
2048  SCJbOpenObject(ctx.js, AppProtoToString(a));
2049  const uint8_t complete_state_ts =
2050  (const uint8_t)AppLayerParserGetStateProgressCompletionStatus(a, STREAM_TOSERVER);
2051  for (uint8_t state = 0; state < complete_state_ts; state++) {
2052  const char *name =
2053  AppLayerParserGetStateNameById(IPPROTO_TCP, a, state, STREAM_TOSERVER);
2054  char table_name[128];
2055  snprintf(table_name, sizeof(table_name), "app:%s:%s", AppProtoToString(a), name);
2056  SCJbOpenObject(ctx.js, table_name);
2057  FirewallAddRulesForState(de_ctx, a, state, STREAM_TOSERVER, &ctx);
2058  if (ctx.js_warnings) {
2059  SCJbClose(ctx.js_warnings);
2060  SCJbSetObject(ctx.js, "warnings", ctx.js_warnings);
2061  SCJbFree(ctx.js_warnings);
2062  ctx.js_warnings = NULL;
2063  }
2064  SCJbClose(ctx.js);
2065  }
2066  const uint8_t complete_state_tc =
2067  (const uint8_t)AppLayerParserGetStateProgressCompletionStatus(a, STREAM_TOCLIENT);
2068  for (uint8_t state = 0; state < complete_state_tc; state++) {
2069  const char *name =
2070  AppLayerParserGetStateNameById(IPPROTO_TCP, a, state, STREAM_TOCLIENT);
2071  char table_name[128];
2072  snprintf(table_name, sizeof(table_name), "app:%s:%s", AppProtoToString(a), name);
2073  SCJbOpenObject(ctx.js, table_name);
2074  FirewallAddRulesForState(de_ctx, a, state, STREAM_TOCLIENT, &ctx);
2075  if (ctx.js_warnings) {
2076  SCJbClose(ctx.js_warnings);
2077  SCJbSetObject(ctx.js, "warnings", ctx.js_warnings);
2078  SCJbFree(ctx.js_warnings);
2079  ctx.js_warnings = NULL;
2080  }
2081  SCJbClose(ctx.js);
2082  }
2083  SCJbClose(ctx.js); // app layer
2084  }
2085  SCJbOpenObject(ctx.js, "packet:td");
2086  SCJbSetString(ctx.js, "policy", "accept:hook");
2087  last_sid = 0;
2088  SCJbOpenArray(ctx.js, "rules");
2089  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2090  if ((s->flags & SIG_FLAG_FIREWALL) != 0)
2091  continue;
2092  if (s->type == SIG_TYPE_APP_TX)
2093  continue;
2094  if (last_sid == s->id)
2095  continue;
2096  last_sid = s->id;
2097  SCJbAppendString(ctx.js, s->sig_str);
2098  }
2099  SCJbClose(ctx.js); // rules
2100  SCJbClose(ctx.js); // packet:td
2101  SCJbOpenObject(ctx.js, "app:td");
2102  SCJbSetString(ctx.js, "policy", "accept:hook");
2103  last_sid = 0;
2104  SCJbOpenArray(ctx.js, "rules");
2105  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2106  if ((s->flags & SIG_FLAG_FIREWALL) != 0)
2107  continue;
2108  if (s->type != SIG_TYPE_APP_TX)
2109  continue;
2110  if (last_sid == s->id)
2111  continue;
2112  last_sid = s->id;
2113  SCJbAppendString(ctx.js, s->sig_str);
2114  }
2115  SCJbClose(ctx.js); // rules
2116  SCJbClose(ctx.js); // app:td
2117  SCJbClose(ctx.js); // tables
2118 
2119  SCJbOpenObject(ctx.js, "lists");
2120  SCJbOpenObject(ctx.js, "firewall");
2121  last_sid = 0;
2122  SCJbOpenArray(ctx.js, "rules");
2123  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2124  if ((s->flags & SIG_FLAG_FIREWALL) == 0)
2125  continue;
2126  if (last_sid == s->id)
2127  continue;
2128  last_sid = s->id;
2129  SCJbAppendString(ctx.js, s->sig_str);
2130  }
2131  SCJbClose(ctx.js); // rules
2132  SCJbClose(ctx.js); // firewall
2133 
2134  SCJbOpenObject(ctx.js, "td");
2135  last_sid = 0;
2136  SCJbOpenArray(ctx.js, "rules");
2137  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2138  if ((s->flags & SIG_FLAG_FIREWALL) != 0)
2139  continue;
2140  if (last_sid == s->id)
2141  continue;
2142  last_sid = s->id;
2143  SCJbAppendString(ctx.js, s->sig_str);
2144  }
2145  SCJbClose(ctx.js); // rules
2146  SCJbClose(ctx.js); // td
2147 
2148  SCJbOpenObject(ctx.js, "all");
2149  last_sid = 0;
2150  SCJbOpenArray(ctx.js, "rules");
2151  for (Signature *s = de_ctx->sig_list; s != NULL; s = s->next) {
2152  if (last_sid == s->id)
2153  continue;
2154  last_sid = s->id;
2155  SCJbAppendString(ctx.js, s->sig_str);
2156  }
2157  SCJbClose(ctx.js); // rules
2158  SCJbClose(ctx.js); // all
2159 
2160  SCJbClose(ctx.js); // lists
2161 
2162  SCJbClose(ctx.js); // top level object
2163 
2164  const char *filename = "firewall.json";
2165  const char *log_dir = SCConfigGetLogDirectory();
2166  char json_path[PATH_MAX] = "";
2167  snprintf(json_path, sizeof(json_path), "%s/%s", log_dir, filename);
2168 
2170  FILE *fp = fopen(json_path, "w");
2171  if (fp != NULL) {
2172  fwrite(SCJbPtr(ctx.js), SCJbLen(ctx.js), 1, fp);
2173  fprintf(fp, "\n");
2174  fclose(fp);
2175  }
2177  SCJbFree(ctx.js);
2178  return 0;
2179 }
detect-tcp-flags.h
DETECT_PCRE_CASELESS
#define DETECT_PCRE_CASELESS
Definition: detect-pcre.h:32
DETECT_CONTENT_NOCASE
#define DETECT_CONTENT_NOCASE
Definition: detect-content.h:29
SignatureHasPacketContent
int SignatureHasPacketContent(const Signature *s)
check if a signature has patterns that are to be inspected against a packets payload (as opposed to t...
Definition: detect-engine-mpm.c:796
DetectBytejumpData_::post_offset
int32_t post_offset
Definition: detect-bytejump.h:51
HashListTableGetListData
#define HashListTableGetListData(hb)
Definition: util-hashlist.h:56
SIG_TYPE_STREAM
@ SIG_TYPE_STREAM
Definition: detect.h:73
DetectContentData_::offset
uint16_t offset
Definition: detect-content.h:107
DetectBytetestData_::flags
uint16_t flags
Definition: detect-bytetest.h:58
detect-engine-uint.h
DetectPatternTracker
Definition: detect.h:808
SignatureInitData_::rule_state_dependant_sids_idx
uint32_t rule_state_dependant_sids_idx
Definition: detect.h:660
DetectEngineAppInspectionEngine_
Definition: detect.h:436
DETECT_CONTENT_RELATIVE_NEXT
#define DETECT_CONTENT_RELATIVE_NEXT
Definition: detect-content.h:66
DetectEngineAppInspectionEngine_::mpm
bool mpm
Definition: detect.h:440
detect-content.h
DetectFlowbitsData_::or_list_size
uint8_t or_list_size
Definition: detect-flowbits.h:38
len
uint8_t len
Definition: app-layer-dnp3.h:2
SCConfValIsTrue
int SCConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:551
detect-engine.h
DETECT_SM_LIST_PMATCH
@ DETECT_SM_LIST_PMATCH
Definition: detect.h:118
SIG_MASK_REQUIRE_REAL_PKT
#define SIG_MASK_REQUIRE_REAL_PKT
Definition: detect.h:315
DETECT_CONTENT_FAST_PATTERN_CHOP
#define DETECT_CONTENT_FAST_PATTERN_CHOP
Definition: detect-content.h:36
SignatureInitData_::smlists
struct SigMatch_ * smlists[DETECT_SM_LIST_MAX]
Definition: detect.h:643
DetectContentData_::fp_chop_len
uint16_t fp_chop_len
Definition: detect-content.h:98
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:155
Signature_::sig_str
char * sig_str
Definition: detect.h:746
SIG_TYPE_APP_TX
@ SIG_TYPE_APP_TX
Definition: detect.h:76
DetectSeqData_::seq
uint32_t seq
Definition: detect-tcp-seq.h:31
AppLayerParserGetStateNameById
const char * AppLayerParserGetStateNameById(uint8_t ipproto, AppProto alproto, const int id, const uint8_t direction)
Definition: app-layer-parser.c:1626
DetectIcmpIdData_
Definition: detect-icmp-id.h:27
DetectEnginePktInspectionEngine
Definition: detect.h:496
DetectEngineAppInspectionEngine_::next
struct DetectEngineAppInspectionEngine_ * next
Definition: detect.h:460
DETECT_PROTO_IPV6
#define DETECT_PROTO_IPV6
Definition: detect-engine-proto.h:32
DetectFlowData_
Definition: detect-flow.h:37
DETECT_FLOW_FLAG_NOSTREAM
#define DETECT_FLOW_FLAG_NOSTREAM
Definition: detect-flow.h:33
SigTableElmt_::name
const char * name
Definition: detect.h:1402
DETECT_BYTEJUMP
@ DETECT_BYTEJUMP
Definition: detect-engine-register.h:83
DetectPatternTracker::mpm
uint32_t mpm
Definition: detect.h:812
DETECT_ABSENT
@ DETECT_ABSENT
Definition: detect-engine-register.h:95
DetectListToHumanString
const char * DetectListToHumanString(int list)
Definition: detect-parse.c:188
DetectEngineCtx_::pattern_hash_table
HashListTable * pattern_hash_table
Definition: detect.h:953
DumpPatterns
void DumpPatterns(DetectEngineCtx *de_ctx)
Definition: detect-engine-analyzer.c:1418
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
DetectContentData_::within
int32_t within
Definition: detect-content.h:109
ACTION_PASS
#define ACTION_PASS
Definition: action-globals.h:34
ACTION_REJECT
#define ACTION_REJECT
Definition: action-globals.h:31
DETECT_BYTEJUMP_LITTLE
#define DETECT_BYTEJUMP_LITTLE
Definition: detect-bytejump.h:35
SetupEngineAnalysis
void SetupEngineAnalysis(DetectEngineCtx *de_ctx, bool *fp_analysis, bool *rule_analysis)
Definition: detect-engine-analyzer.c:474
Signature_::app_progress_hook
uint8_t app_progress_hook
Definition: detect.h:706
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:69
SignatureInitData_::prefilter_sm
SigMatch * prefilter_sm
Definition: detect.h:626
EngineAnalysisCtx_::rule_engine_analysis_fp
FILE * rule_engine_analysis_fp
Definition: detect-engine-analyzer.c:85
DETECT_FLOW
@ DETECT_FLOW
Definition: detect-engine-register.h:54
Signature_::alproto
AppProto alproto
Definition: detect.h:674
SignatureInitData_::is_rule_state_dependant
bool is_rule_state_dependant
Definition: detect.h:657
detect-isdataat.h
DETECT_BYTETEST_BASE_HEX
#define DETECT_BYTETEST_BASE_HEX
Definition: detect-bytetest.h:40
SigMatchData_::is_last
bool is_last
Definition: detect.h:367
g_rules_analyzer_write_m
SCMutex g_rules_analyzer_write_m
Definition: detect-engine-analyzer.c:970
DetectEngineAnalyzerItems::display_name
const char * display_name
Definition: detect-engine-analyzer.c:67
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:85
DETECT_CONTENT_WITHIN2DEPTH
#define DETECT_CONTENT_WITHIN2DEPTH
Definition: detect-content.h:62
EngineAnalysisCtx_::percent_re
pcre2_code * percent_re
Definition: detect-engine-analyzer.c:90
DETECT_SM_LIST_DYNAMIC_START
@ DETECT_SM_LIST_DYNAMIC_START
Definition: detect.h:137
DETECT_FLOWBITS_CMD_ISNOTSET
#define DETECT_FLOWBITS_CMD_ISNOTSET
Definition: detect-flowbits.h:31
SIG_FLAG_DEST_IS_TARGET
#define SIG_FLAG_DEST_IS_TARGET
Definition: detect.h:284
SigMatchData_::ctx
SigMatchCtx * ctx
Definition: detect.h:368
DETECT_CONTENT_NO_DOUBLE_INSPECTION_REQUIRED
#define DETECT_CONTENT_NO_DOUBLE_INSPECTION_REQUIRED
Definition: detect-content.h:55
action-globals.h
EngineAnalysisCtx_
Definition: detect-engine-analyzer.c:83
DETECT_IPOPTS
@ DETECT_IPOPTS
Definition: detect-engine-register.h:39
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
Definition: app-layer-protos.c:40
ctx
struct Thresholds ctx
DETECT_BYTEJUMP_BASE_OCT
#define DETECT_BYTEJUMP_BASE_OCT
Definition: detect-bytejump.h:29
DetectEngineFrameInspectionEngine::transforms
const DetectEngineTransforms * transforms
Definition: detect.h:531
DetectFlowData_::flags
uint16_t flags
Definition: detect-flow.h:38
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:920
DETECT_PROTO_ANY
#define DETECT_PROTO_ANY
Definition: detect-engine-proto.h:28
DetectEnginePktInspectionEngine::smd
SigMatchData * smd
Definition: detect.h:497
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1125
SIG_TYPE_PKT_STREAM
@ SIG_TYPE_PKT_STREAM
Definition: detect.h:72
DetectFlowbitsData_::cmd
uint8_t cmd
Definition: detect-flowbits.h:37
DetectEngineFrameInspectionEngine::mpm
bool mpm
Definition: detect.h:525
DETECT_BYTETEST_DCE
#define DETECT_BYTETEST_DCE
Definition: detect-bytetest.h:47
HashListTableGetListHead
HashListTableBucket * HashListTableGetListHead(HashListTable *ht)
Definition: util-hashlist.c:287
detect-tcp-seq.h
DetectEngineAppInspectionEngine_::v2
struct DetectEngineAppInspectionEngine_::@79 v2
EngineAnalysisCtx_::fp_pattern_stats
FpPatternStats fp_pattern_stats[DETECT_SM_LIST_MAX]
Definition: detect-engine-analyzer.c:102
DetectEngineBufferTypeGetNameById
const char * DetectEngineBufferTypeGetNameById(const DetectEngineCtx *de_ctx, const int id)
Definition: detect-engine.c:1187
SIG_FLAG_DST_ANY
#define SIG_FLAG_DST_ANY
Definition: detect.h:241
ACTION_SCOPE_FLOW
@ ACTION_SCOPE_FLOW
Definition: action-globals.h:45
SCMutexLock
#define SCMutexLock(mut)
Definition: threads-debug.h:117
util-var-name.h
SIG_FLAG_REQUIRE_STREAM
#define SIG_FLAG_REQUIRE_STREAM
Definition: detect.h:254
DetectPatternTracker::cnt
uint32_t cnt
Definition: detect.h:811
rust.h
EngineAnalysisCtx_::fp_engine_analysis_fp
FILE * fp_engine_analysis_fp
Definition: detect-engine-analyzer.c:86
SCConfGetBool
int SCConfGetBool(const char *name, int *val)
Retrieve a configuration value as a boolean.
Definition: conf.c:497
EngineAnalysisCtx_::analyzer_initialized
bool analyzer_initialized
Definition: detect-engine-analyzer.c:109
DetectEngineAnalyzerItems
Definition: detect-engine-analyzer.c:61
DETECT_BYTEJUMP_DCE
#define DETECT_BYTEJUMP_DCE
Definition: detect-bytejump.h:40
DetectPatternTracker::cd
const struct DetectContentData_ * cd
Definition: detect.h:809
VarNameStoreSetupLookup
const char * VarNameStoreSetupLookup(const uint32_t id, const enum VarTypes type)
Definition: util-var-name.c:188
SCMUTEX_INITIALIZER
#define SCMUTEX_INITIALIZER
Definition: threads-debug.h:121
Signature_::sm_arrays
SigMatchData * sm_arrays[DETECT_SM_LIST_MAX]
Definition: detect.h:732
FpPatternStats_::max
uint16_t max
Definition: detect-engine-analyzer.c:72
SignatureInitData_::init_flags
uint32_t init_flags
Definition: detect.h:609
DetectBufferType_
Definition: detect.h:463
DETECT_FLOWBITS_CMD_TOGGLE
#define DETECT_FLOWBITS_CMD_TOGGLE
Definition: detect-flowbits.h:29
DetectContentData_
Definition: detect-content.h:93
DETECT_FLOWBITS_CMD_ISSET
#define DETECT_FLOWBITS_CMD_ISSET
Definition: detect-flowbits.h:32
DetectPcreData_::flags
uint16_t flags
Definition: detect-pcre.h:51
SCConfNodeLookupChildValue
const char * SCConfNodeLookupChildValue(const SCConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:824
DetectContentData_::fp_chop_offset
uint16_t fp_chop_offset
Definition: detect-content.h:100
DetectBytetestData_::nbytes
uint8_t nbytes
Definition: detect-bytetest.h:54
DetectBytetestData_
Definition: detect-bytetest.h:53
EngineAnalysisCtx_::analyzer_item_map
int16_t analyzer_item_map[256]
Definition: detect-engine-analyzer.c:101
DetectWindowData_
Definition: detect-tcp-window.h:21
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:271
DETECT_BYTEJUMP_BIG
#define DETECT_BYTEJUMP_BIG
Definition: detect-bytejump.h:36
SIG_FLAG_SRC_ANY
#define SIG_FLAG_SRC_ANY
Definition: detect.h:240
EngineAnalysisRulesFailure
void EngineAnalysisRulesFailure(const DetectEngineCtx *de_ctx, const char *line, const char *file, int lineno)
Definition: detect-engine-analyzer.c:622
SigMatchData_
Data needed for Match()
Definition: detect.h:365
DetectBytejumpData_::base
uint8_t base
Definition: detect-bytejump.h:48
detect-pcre.h
SIG_TYPE_APPLAYER
@ SIG_TYPE_APPLAYER
Definition: detect.h:75
SigMatchData_::type
uint16_t type
Definition: detect.h:366
DetectBytejumpData_
Definition: detect-bytejump.h:46
Signature_::frame_inspect
DetectEngineFrameInspectionEngine * frame_inspect
Definition: detect.h:728
DetectBytejumpData_::offset
int32_t offset
Definition: detect-bytejump.h:50
DetectEnginePktInspectionEngine::transforms
const DetectEngineTransforms * transforms
Definition: detect.h:505
EngineAnalysisCtx_::analyzer_items
DetectEngineAnalyzerItems * analyzer_items
Definition: detect-engine-analyzer.c:88
DETECT_PERCENT_ENCODING_REGEX
#define DETECT_PERCENT_ENCODING_REGEX
FirewallAnalyzer
int FirewallAnalyzer(const DetectEngineCtx *de_ctx)
Definition: detect-engine-analyzer.c:2001
DetectBytejumpData_::multiplier
uint16_t multiplier
Definition: detect-bytejump.h:52
SIG_FLAG_APPLAYER
#define SIG_FLAG_APPLAYER
Definition: detect.h:248
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1157
SIG_FLAG_FIREWALL
#define SIG_FLAG_FIREWALL
Definition: detect.h:245
Signature_::gid
uint32_t gid
Definition: detect.h:715
Signature_::next
struct Signature_ * next
Definition: detect.h:751
ACTION_REJECT_DST
#define ACTION_REJECT_DST
Definition: action-globals.h:32
DetectEngineAppInspectionEngine_::sm_list
uint16_t sm_list
Definition: detect.h:444
ATTR_FMT_PRINTF
#define ATTR_FMT_PRINTF(x, y)
Definition: suricata-common.h:419
DetectFlowbitsData_
Definition: detect-flowbits.h:35
HashListTableGetListNext
#define HashListTableGetListNext(hb)
Definition: util-hashlist.h:55
DetectEngineAnalyzerItems::export_item_seen
bool export_item_seen
Definition: detect-engine-analyzer.c:64
SignaturePropertyFlowAction
SignaturePropertyFlowAction
Definition: detect.h:82
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
RequiresFeature
bool RequiresFeature(const char *feature_name)
Definition: feature.c:126
DETECT_BYTETEST_RELATIVE
#define DETECT_BYTETEST_RELATIVE
Definition: detect-bytetest.h:46
SIG_TYPE_PKT
@ SIG_TYPE_PKT
Definition: detect.h:71
DetectSeqData_
seq data
Definition: detect-tcp-seq.h:30
feature.h
RuleAnalyzer::js
SCJsonBuilder * js
Definition: detect-engine-analyzer.c:634
IpOptsFlagToString
const char * IpOptsFlagToString(uint16_t flag)
Return human readable value for ipopts flag.
Definition: detect-ipopts.c:117
JB_SET_STRING
#define JB_SET_STRING(jb, key, val)
Definition: rust.h:26
EngineAnalysisCtx
struct EngineAnalysisCtx_ EngineAnalysisCtx
DETECT_CONTENT_ENDS_WITH
#define DETECT_CONTENT_ENDS_WITH
Definition: detect-content.h:42
DETECT_PCRE_RAWBYTES
#define DETECT_PCRE_RAWBYTES
Definition: detect-pcre.h:31
DETECT_CONTENT_DISTANCE
#define DETECT_CONTENT_DISTANCE
Definition: detect-content.h:30
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEnginePktInspectionEngine::sm_list
uint16_t sm_list
Definition: detect.h:499
SIG_FLAG_INIT_BIDIREC
#define SIG_FLAG_INIT_BIDIREC
Definition: detect.h:292
g_alproto_max
AppProto g_alproto_max
Definition: app-layer-protos.c:29
DETECT_FLOWINT
@ DETECT_FLOWINT
Definition: detect-engine-register.h:62
SIG_MASK_REQUIRE_ENGINE_EVENT
#define SIG_MASK_REQUIRE_ENGINE_EVENT
Definition: detect.h:317
DETECT_FLOW_AGE
@ DETECT_FLOW_AGE
Definition: detect-engine-register.h:127
DETECT_BYTETEST_BASE_UNSET
#define DETECT_BYTETEST_BASE_UNSET
Definition: detect-bytetest.h:37
SIG_TYPE_IPONLY
@ SIG_TYPE_IPONLY
Definition: detect.h:65
DETECT_BYTEJUMP_ALIGN
#define DETECT_BYTEJUMP_ALIGN
Definition: detect-bytejump.h:39
SignatureInitData_::mpm_sm
SigMatch * mpm_sm
Definition: detect.h:624
DetectEngineBufferTypeGetDescriptionById
const char * DetectEngineBufferTypeGetDescriptionById(const DetectEngineCtx *de_ctx, const int id)
Definition: detect-engine.c:1265
SCMutexUnlock
#define SCMutexUnlock(mut)
Definition: threads-debug.h:119
SIG_FLAG_FLUSH
#define SIG_FLAG_FLUSH
Definition: detect.h:258
DetectIpOptsData_::ipopt
uint16_t ipopt
Definition: detect-ipopts.h:38
SignatureInitData_::mpm_sm_list
int mpm_sm_list
Definition: detect.h:622
DETECT_BYTETEST_BASE_DEC
#define DETECT_BYTETEST_BASE_DEC
Definition: detect-bytetest.h:39
SIG_MASK_REQUIRE_FLOW
#define SIG_MASK_REQUIRE_FLOW
Definition: detect.h:311
SIG_FLAG_BYPASS
#define SIG_FLAG_BYPASS
Definition: detect.h:275
DETECT_CONTENT_DEPTH
#define DETECT_CONTENT_DEPTH
Definition: detect-content.h:33
DETECT_CONTENT_DISTANCE2OFFSET
#define DETECT_CONTENT_DISTANCE2OFFSET
Definition: detect-content.h:63
RuleAnalyzer
Definition: detect-engine-analyzer.c:633
DETECT_BYTEJUMP_END
#define DETECT_BYTEJUMP_END
Definition: detect-bytejump.h:42
Signature_::pkt_inspect
DetectEnginePktInspectionEngine * pkt_inspect
Definition: detect.h:727
DetectEngineAnalyzerItems
struct DetectEngineAnalyzerItems DetectEngineAnalyzerItems
util-print.h
DetectWindowData_::negated
uint8_t negated
Definition: detect-tcp-window.h:22
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect-engine-mpm.h
detect.h
SIG_MASK_REQUIRE_FLAGS_INITDEINIT
#define SIG_MASK_REQUIRE_FLAGS_INITDEINIT
Definition: detect.h:312
SignatureInitData_::rule_state_flowbits_ids_size
uint32_t rule_state_flowbits_ids_size
Definition: detect.h:662
DetectEngineFrameInspectionEngine::sm_list
uint16_t sm_list
Definition: detect.h:526
detect-tcp-window.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:360
DetectEngineAnalyzerItems::item_seen
bool item_seen
Definition: detect-engine-analyzer.c:63
DETECT_CONTENT_NEGATED
#define DETECT_CONTENT_NEGATED
Definition: detect-content.h:40
util-time.h
DETECT_ICMP_ID
@ DETECT_ICMP_ID
Definition: detect-engine-register.h:49
DETECT_SM_LIST_MATCH
@ DETECT_SM_LIST_MATCH
Definition: detect.h:116
DetectAckData_::ack
uint32_t ack
Definition: detect-tcp-ack.h:31
EngineAnalysisRules
void EngineAnalysisRules(const DetectEngineCtx *de_ctx, const Signature *s, const char *line)
Prints analysis of loaded rules.
Definition: detect-engine-analyzer.c:1559
app-layer-parser.h
Signature_::app_inspect
DetectEngineAppInspectionEngine * app_inspect
Definition: detect.h:726
DETECT_SEQ
@ DETECT_SEQ
Definition: detect-engine-register.h:37
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:359
DETECT_ACK
@ DETECT_ACK
Definition: detect-engine-register.h:36
RuleAnalyzer::js_warnings
SCJsonBuilder * js_warnings
Definition: detect-engine-analyzer.c:636
SIG_FLAG_REQUIRE_FLOWVAR
#define SIG_FLAG_REQUIRE_FLOWVAR
Definition: detect.h:266
Signature_::action
uint8_t action
Definition: detect.h:684
FpPatternStats_::cnt
uint32_t cnt
Definition: detect-engine-analyzer.c:73
SCReturn
#define SCReturn
Definition: util-debug.h:273
Signature_::flags
uint32_t flags
Definition: detect.h:670
DetectContentData_::depth
uint16_t depth
Definition: detect-content.h:106
ACTION_ALERT
#define ACTION_ALERT
Definition: action-globals.h:29
DETECT_BYTETEST_BIG
#define DETECT_BYTETEST_BIG
Definition: detect-bytetest.h:44
SCLocalTime
struct tm * SCLocalTime(time_t timep, struct tm *result)
Definition: util-time.c:267
detect-bytejump.h
ACTION_SCOPE_TX
@ ACTION_SCOPE_TX
Definition: action-globals.h:47
SCConfigGetLogDirectory
const char * SCConfigGetLogDirectory(void)
Definition: util-conf.c:38
ACTION_SCOPE_AUTO
@ ACTION_SCOPE_AUTO
Definition: action-globals.h:43
conf.h
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:104
CHECK
#define CHECK(pat)
Definition: detect-engine-analyzer.c:670
DetectEngineFrameInspectionEngine
Definition: detect.h:521
DetectFlowbitsData_::idx
uint32_t idx
Definition: detect-flowbits.h:36
DetectEngineBufferTypeGetById
const DetectBufferType * DetectEngineBufferTypeGetById(const DetectEngineCtx *de_ctx, const int id)
Definition: detect-engine.c:1177
DETECT_BYTEJUMP_BASE_UNSET
#define DETECT_BYTEJUMP_BASE_UNSET
Definition: detect-bytejump.h:28
name
const char * name
Definition: tm-threads.c:2135
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:748
SIG_FLAG_SRC_IS_TARGET
#define SIG_FLAG_SRC_IS_TARGET
Definition: detect.h:282
SignatureInitData_::rule_state_dependant_sids_array
uint32_t * rule_state_dependant_sids_array
Definition: detect.h:658
DetectContentPatternPrettyPrint
void DetectContentPatternPrettyPrint(const DetectContentData *cd, char *str, size_t str_len)
Definition: detect-content.c:745
SignatureInitData_::rule_state_dependant_sids_size
uint32_t rule_state_dependant_sids_size
Definition: detect.h:659
DetectIcmpIdData_::id
uint16_t id
Definition: detect-icmp-id.h:28
DetectEngineTransforms::transforms
TransformData transforms[DETECT_TRANSFORMS_MAX]
Definition: detect.h:416
DETECT_BYTEJUMP_BASE_HEX
#define DETECT_BYTEJUMP_BASE_HEX
Definition: detect-bytejump.h:31
SIG_TYPE_DEONLY
@ SIG_TYPE_DEONLY
Definition: detect.h:70
SIG_PROP_FLOW_ACTION_PACKET
@ SIG_PROP_FLOW_ACTION_PACKET
Definition: detect.h:83
signature_properties
const struct SignatureProperties signature_properties[SIG_TYPE_MAX]
Definition: detect-engine.c:117
detect-flowbits.h
SIG_MASK_REQUIRE_PAYLOAD
#define SIG_MASK_REQUIRE_PAYLOAD
Definition: detect.h:310
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:224
DETECT_PCRE
@ DETECT_PCRE
Definition: detect-engine-register.h:71
DetectWindowData_::size
uint16_t size
Definition: detect-tcp-window.h:23
SIG_TYPE_NOT_SET
@ SIG_TYPE_NOT_SET
Definition: detect.h:64
ExposedItemSeen::bufname
const char * bufname
Definition: detect-engine-analyzer.c:79
DETECT_BYTEJUMP_OFFSET_BE
#define DETECT_BYTEJUMP_OFFSET_BE
Definition: detect-bytejump.h:41
DetectEngineCtx_::config_prefix
char config_prefix[64]
Definition: detect.h:1039
DetectSigmatchListEnumToString
const char * DetectSigmatchListEnumToString(enum DetectSigmatchListEnum type)
Definition: detect-engine.c:5121
analyzer_items
const DetectEngineAnalyzerItems analyzer_items[]
Definition: detect-engine-analyzer.c:112
DetectEngineAppInspectionEngine_::alproto
AppProto alproto
Definition: detect.h:437
SIG_FLAG_MPM_NEG
#define SIG_FLAG_MPM_NEG
Definition: detect.h:256
detect-engine-analyzer.h
SIG_FLAG_INIT_STATE_MATCH
#define SIG_FLAG_INIT_STATE_MATCH
Definition: detect.h:295
DetectEngineAnalyzerItems::item_id
int16_t item_id
Definition: detect-engine-analyzer.c:62
DetectPatternTracker::sm_list
int sm_list
Definition: detect.h:810
DetectEngineAppInspectionEngine_::smd
SigMatchData * smd
Definition: detect.h:458
EngineAnalysisRules2
void EngineAnalysisRules2(const DetectEngineCtx *de_ctx, const Signature *s)
Definition: detect-engine-analyzer.c:971
ACTION_REJECT_BOTH
#define ACTION_REJECT_BOTH
Definition: action-globals.h:33
ARRAY_SIZE
#define ARRAY_SIZE(arr)
Definition: suricata-common.h:554
DETECT_CONTENT_STARTS_WITH
#define DETECT_CONTENT_STARTS_WITH
Definition: detect-content.h:59
DetectProto_::flags
uint8_t flags
Definition: detect-engine-proto.h:37
DETECT_BYTETEST
@ DETECT_BYTETEST
Definition: detect-engine-register.h:82
DETECT_PROTO_IPV4
#define DETECT_PROTO_IPV4
Definition: detect-engine-proto.h:31
util-conf.h
SignatureHasStreamContent
int SignatureHasStreamContent(const Signature *s)
check if a signature has patterns that are to be inspected against the stream payload (as opposed to ...
Definition: detect-engine-mpm.c:826
FpPatternStats_::min
uint16_t min
Definition: detect-engine-analyzer.c:71
VAR_TYPE_FLOW_BIT
@ VAR_TYPE_FLOW_BIT
Definition: util-var.h:36
Signature_::proto
DetectProto proto
Definition: detect.h:688
SCNtohs
#define SCNtohs(x)
Definition: suricata-common.h:423
suricata-common.h
SIG_MASK_REQUIRE_NO_PAYLOAD
#define SIG_MASK_REQUIRE_NO_PAYLOAD
Definition: detect.h:314
SIG_FLAG_SP_ANY
#define SIG_FLAG_SP_ANY
Definition: detect.h:242
SIG_PROP_FLOW_ACTION_FLOW_IF_STATEFUL
@ SIG_PROP_FLOW_ACTION_FLOW_IF_STATEFUL
Definition: detect.h:85
ActionScope
ActionScope
Definition: action-globals.h:42
DetectAbsentData_
Definition: detect-isdataat.h:37
ExposedItemSeen
Definition: detect-engine-analyzer.c:78
SigMatch_::type
uint16_t type
Definition: detect.h:357
HashListTableFree
void HashListTableFree(HashListTable *ht)
Definition: util-hashlist.c:88
DetectEngineAnalyzerItems::check_encoding_match
bool check_encoding_match
Definition: detect-engine-analyzer.c:65
DetectContentData_::distance
int32_t distance
Definition: detect-content.h:108
ACTION_SCOPE_HOOK
@ ACTION_SCOPE_HOOK
Definition: action-globals.h:46
CleanupEngineAnalysis
void CleanupEngineAnalysis(DetectEngineCtx *de_ctx)
Definition: detect-engine-analyzer.c:510
DetectBytejumpData_::nbytes
uint8_t nbytes
Definition: detect-bytejump.h:47
Signature_::action_scope
uint8_t action_scope
Definition: detect.h:691
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:36
DetectEngineFrameInspectionEngine::next
struct DetectEngineFrameInspectionEngine * next
Definition: detect.h:534
DetectU32Data
DetectUintData_u32 DetectU32Data
Definition: detect-engine-uint.h:41
ACTION_DROP
#define ACTION_DROP
Definition: action-globals.h:30
DetectEnginePktInspectionEngine::next
struct DetectEnginePktInspectionEngine * next
Definition: detect.h:507
DetectContentData_::content
uint8_t * content
Definition: detect-content.h:94
Signature_::rev
uint32_t rev
Definition: detect.h:716
DetectEngineFrameInspectionEngine::v1
struct DetectEngineFrameInspectionEngine::@83 v1
FatalError
#define FatalError(...)
Definition: util-debug.h:502
DetectEngineCtx_::sig_list
Signature * sig_list
Definition: detect.h:929
DETECT_BYTEJUMP_BASE_DEC
#define DETECT_BYTEJUMP_BASE_DEC
Definition: detect-bytejump.h:30
DetectIpOptsData_
Definition: detect-ipopts.h:37
ACTION_CONFIG
#define ACTION_CONFIG
Definition: action-globals.h:35
PrintRawUriFp
void PrintRawUriFp(FILE *fp, const uint8_t *buf, uint32_t buflen)
Definition: util-print.c:69
SIG_MASK_REQUIRE_FLAGS_UNUSUAL
#define SIG_MASK_REQUIRE_FLAGS_UNUSUAL
Definition: detect.h:313
TransformData_::transform
int transform
Definition: detect.h:411
DETECT_FLOWBITS
@ DETECT_FLOWBITS
Definition: detect-engine-register.h:59
SIG_TYPE_MAX
@ SIG_TYPE_MAX
Definition: detect.h:78
DetectEngineCtx_::ea
struct EngineAnalysisCtx_ * ea
Definition: detect.h:1117
DetectEngineAppInspectionEngine_::progress
int16_t progress
Definition: detect.h:446
DETECT_BYTETEST_BASE_OCT
#define DETECT_BYTETEST_BASE_OCT
Definition: detect-bytetest.h:38
util-validate.h
detect-flow.h
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
EngineAnalysisFP
void EngineAnalysisFP(const DetectEngineCtx *de_ctx, const Signature *s, const char *line)
Definition: detect-engine-analyzer.c:169
SignatureInitData_::firewall_rule
bool firewall_rule
Definition: detect.h:665
FpPatternStats
struct FpPatternStats_ FpPatternStats
detect-tcp-ack.h
str
#define str(s)
Definition: suricata-common.h:300
SCConfGetNode
SCConfNode * SCConfGetNode(const char *name)
Get a SCConfNode by name.
Definition: conf.c:181
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SigMatchListSMBelongsTo
int SigMatchListSMBelongsTo(const Signature *s, const SigMatch *key_sm)
Definition: detect-parse.c:833
SCFree
#define SCFree(p)
Definition: util-mem.h:61
DetectFlowbitsData_::or_list
uint32_t * or_list
Definition: detect-flowbits.h:42
Signature_::id
uint32_t id
Definition: detect.h:714
DETECT_CONTENT_OFFSET
#define DETECT_CONTENT_OFFSET
Definition: detect-content.h:32
HashListTableBucket_
Definition: util-hashlist.h:28
DETECT_FLOWBITS_CMD_UNSET
#define DETECT_FLOWBITS_CMD_UNSET
Definition: detect-flowbits.h:30
DETECT_CONTENT_FAST_PATTERN_ONLY
#define DETECT_CONTENT_FAST_PATTERN_ONLY
Definition: detect-content.h:35
DETECT_CONTENT_MPM
#define DETECT_CONTENT_MPM
Definition: detect-content.h:61
ACTION_SCOPE_PACKET
@ ACTION_SCOPE_PACKET
Definition: action-globals.h:44
DetectBufferType_::transforms
DetectEngineTransforms transforms
Definition: detect.h:476
DetectEnginePktInspectionEngine::v1
struct DetectEnginePktInspectionEngine::@82 v1
detect-parse.h
Signature_
Signature container.
Definition: detect.h:669
SigMatch_
a single match condition for a signature
Definition: detect.h:356
DetectEngineAppInspectionEngine_::transforms
const DetectEngineTransforms * transforms
Definition: detect.h:455
DETECT_SM_LIST_MAX
@ DETECT_SM_LIST_MAX
Definition: detect.h:134
FpPatternStats_::tot
uint64_t tot
Definition: detect-engine-analyzer.c:74
DETECT_BYTETEST_STRING
#define DETECT_BYTETEST_STRING
Definition: detect-bytetest.h:45
DetectBytetestData_::offset
int32_t offset
Definition: detect-bytetest.h:60
DetectFlagsData_
Definition: detect-tcp-flags.h:37
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
DETECT_PCRE_RELATIVE_NEXT
#define DETECT_PCRE_RELATIVE_NEXT
Definition: detect-pcre.h:34
detect-icmp-id.h
ACTION_ACCEPT
#define ACTION_ACCEPT
Definition: action-globals.h:36
detect-ipopts.h
DetectEngineTransforms::cnt
int cnt
Definition: detect.h:417
suricata.h
DetectPcreData_
Definition: detect-pcre.h:47
DetectEngineAppInspectionEngine_::dir
uint8_t dir
Definition: detect.h:438
DetectEngineAnalyzerItems::item_name
const char * item_name
Definition: detect-engine-analyzer.c:66
DetectContentData_::content_len
uint16_t content_len
Definition: detect-content.h:95
ExposedItemSeen::item_seen_ptr
bool * item_seen_ptr
Definition: detect-engine-analyzer.c:80
DETECT_BYTEJUMP_STRING
#define DETECT_BYTEJUMP_STRING
Definition: detect-bytejump.h:37
DetectEngineCtx_::buffer_type_id
uint32_t buffer_type_id
Definition: detect.h:1069
EngineAnalysisCtx_::file_prefix
char * file_prefix
Definition: detect-engine-analyzer.c:89
DetectEnginePktInspectionEngine::mpm
bool mpm
Definition: detect.h:498
DETECT_BYTEJUMP_BEGIN
#define DETECT_BYTEJUMP_BEGIN
Definition: detect-bytejump.h:34
SignatureInitData_::rule_state_flowbits_ids_array
uint32_t * rule_state_flowbits_ids_array
Definition: detect.h:661
SIG_PROP_FLOW_ACTION_FLOW
@ SIG_PROP_FLOW_ACTION_FLOW
Definition: detect.h:84
DETECT_PCRE_RELATIVE
#define DETECT_PCRE_RELATIVE
Definition: detect-pcre.h:29
RuleAnalyzer
struct RuleAnalyzer RuleAnalyzer
DETECT_WINDOW
@ DETECT_WINDOW
Definition: detect-engine-register.h:38
SIG_FLAG_TLSSTORE
#define SIG_FLAG_TLSSTORE
Definition: detect.h:273
DetectU16Data
DetectUintData_u16 DetectU16Data
Definition: detect-engine-uint.h:42
Signature_::msg
char * msg
Definition: detect.h:737
DETECT_CONTENT_FAST_PATTERN
#define DETECT_CONTENT_FAST_PATTERN
Definition: detect-content.h:34
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
DetectAbsentData_::or_else
bool or_else
Definition: detect-isdataat.h:39
RuleAnalyzer::js_notes
SCJsonBuilder * js_notes
Definition: detect-engine-analyzer.c:637
DETECT_FLAGS
@ DETECT_FLAGS
Definition: detect-engine-register.h:42
DETECT_PCRE_NEGATE
#define DETECT_PCRE_NEGATE
Definition: detect-pcre.h:35
EngineAnalysisCtx_::exposed_item_seen_list
struct ExposedItemSeen exposed_item_seen_list[2]
Definition: detect-engine-analyzer.c:107
Signature_::type
enum SignatureType type
Definition: detect.h:672
SCConfNode_
Definition: conf.h:32
FpPatternStats_
Definition: detect-engine-analyzer.c:70
DetectBytetestData_::base
uint8_t base
Definition: detect-bytetest.h:56
DETECT_BYTETEST_LITTLE
#define DETECT_BYTETEST_LITTLE
Definition: detect-bytetest.h:43
SCMutex
#define SCMutex
Definition: threads-debug.h:114
SIG_TYPE_PDONLY
@ SIG_TYPE_PDONLY
Definition: detect.h:69
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:102
SIG_FLAG_PREFILTER
#define SIG_FLAG_PREFILTER
Definition: detect.h:277
SignatureProperties::flow_action
enum SignaturePropertyFlowAction flow_action
Definition: detect.h:89
DETECT_TCPMSS
@ DETECT_TCPMSS
Definition: detect-engine-register.h:294
DetectAckData_
ack data
Definition: detect-tcp-ack.h:30
SIG_FLAG_FILESTORE
#define SIG_FLAG_FILESTORE
Definition: detect.h:268
DETECT_CONTENT_WITHIN
#define DETECT_CONTENT_WITHIN
Definition: detect-content.h:31
DETECT_BYTEJUMP_RELATIVE
#define DETECT_BYTEJUMP_RELATIVE
Definition: detect-bytejump.h:38
SIG_FLAG_DP_ANY
#define SIG_FLAG_DP_ANY
Definition: detect.h:243
DETECT_FLOWBITS_CMD_SET
#define DETECT_FLOWBITS_CMD_SET
Definition: detect-flowbits.h:28
SIG_FLAG_DSIZE
#define SIG_FLAG_DSIZE
Definition: detect.h:247
DetectBytejumpData_::flags
uint16_t flags
Definition: detect-bytejump.h:49
Signature_::mask
SignatureMask mask
Definition: detect.h:680
SIG_TYPE_LIKE_IPONLY
@ SIG_TYPE_LIKE_IPONLY
Definition: detect.h:66
detect-bytetest.h
DetectProtoContainsProto
int DetectProtoContainsProto(const DetectProto *dp, int proto)
see if a DetectProto contains a certain proto
Definition: detect-engine-proto.c:135
SIG_FLAG_REQUIRE_PACKET
#define SIG_FLAG_REQUIRE_PACKET
Definition: detect.h:253
DetectEngineFrameInspectionEngine::smd
SigMatchData * smd
Definition: detect.h:533