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