suricata
detect-engine-content-inspection.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2023 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Anoop Saldanha <anoopsaldanha@gmail.com>
22  *
23  * Performs content inspection on any buffer supplied.
24  */
25 
26 #include "suricata-common.h"
27 #include "suricata.h"
28 #include "decode.h"
29 
30 #include "detect.h"
31 #include "detect-engine.h"
32 #include "detect-parse.h"
33 
34 #include "rust.h"
35 
36 #include "detect-asn1.h"
37 #include "detect-content.h"
38 #include "detect-pcre.h"
39 #include "detect-isdataat.h"
40 #include "detect-bytetest.h"
41 #include "detect-bytemath.h"
42 #include "detect-bytejump.h"
43 #include "detect-byte-extract.h"
44 #include "detect-replace.h"
46 #include "detect-uricontent.h"
47 #include "detect-urilen.h"
48 #include "detect-engine-uint.h"
49 #include "detect-bsize.h"
50 #include "detect-lua.h"
51 #include "detect-base64-decode.h"
52 #include "detect-base64-data.h"
53 #include "detect-dataset.h"
54 #include "detect-datarep.h"
55 
56 #include "util-spm.h"
57 #include "util-debug.h"
58 #include "util-print.h"
59 #include "util-validate.h"
60 
61 #include "util-unittest.h"
62 #include "util-unittest-helper.h"
63 #include "util-profiling.h"
64 
65 #include "util-lua.h"
66 
67 #ifdef UNITTESTS
68 thread_local uint32_t ut_inspection_recursion_counter = 0;
69 #endif
70 
72  struct {
73  uint32_t count;
74  const uint32_t limit;
76 };
77 
78 /**
79  * \brief Run the actual payload match functions
80  *
81  * All keywords are evaluated against the buffer with buffer_len.
82  *
83  * For accounting the last match in relative matching the
84  * det_ctx->buffer_offset int is used.
85  *
86  * \param det_ctx Detection engine thread context
87  * \param s Signature to inspect
88  * \param sm SigMatch to inspect
89  * \param p Packet. Can be NULL.
90  * \param f Flow (for pcre flowvar storage)
91  * \param buffer Ptr to the buffer to inspect
92  * \param buffer_len Length of the payload
93  * \param stream_start_offset Indicates the start of the current buffer in
94  * the whole buffer stream inspected. This
95  * applies if the current buffer is inspected
96  * in chunks.
97  * \param inspection_mode Refers to the engine inspection mode we are currently
98  * inspecting. Can be payload, stream, one of the http
99  * buffer inspection modes or dce inspection mode.
100  * \param flags DETECT_CI_FLAG_*
101  *
102  * \retval -1 no match and give up (discontinue matching)
103  * \retval 0 no match
104  * \retval 1 match
105  */
106 static int DetectEngineContentInspectionInternal(DetectEngineThreadCtx *det_ctx,
107  struct DetectEngineContentInspectionCtx *ctx, const Signature *s, const SigMatchData *smd,
108  Packet *p, Flow *f, const uint8_t *buffer, const uint32_t buffer_len,
109  const uint32_t stream_start_offset, const uint8_t flags,
110  const enum DetectContentInspectionType inspection_mode)
111 {
112  SCEnter();
114 
115  ctx->recursion.count++;
116  if (unlikely(ctx->recursion.count == ctx->recursion.limit)) {
117  KEYWORD_PROFILING_END(det_ctx, smd->type, 0);
118  SCReturnInt(-1);
119  }
120 
121  // we want the ability to match on bsize: 0
122  if (smd == NULL || buffer == NULL) {
123  KEYWORD_PROFILING_END(det_ctx, smd->type, 0);
124  SCReturnInt(0);
125  }
126 
127  if (smd->type == DETECT_CONTENT) {
128  const DetectContentData *cd = (const DetectContentData *)smd->ctx;
129  SCLogDebug("inspecting content %"PRIu32" buffer_len %"PRIu32, cd->id, buffer_len);
130 
131  /* we might have already have this content matched by the mpm.
132  * (if there is any other reason why we'd want to avoid checking
133  * it here, please fill it in) */
134  //if (cd->flags & DETECT_CONTENT_NO_DOUBLE_INSPECTION_REQUIRED) {
135  // goto match;
136  //}
137 
138  /* rule parsers should take care of this */
139 #ifdef DEBUG
140  BUG_ON(cd->depth != 0 && cd->depth <= cd->offset);
141 #endif
142 
143  /* search for our pattern, checking the matches recursively.
144  * if we match we look for the next SigMatch as well */
145  uint32_t prev_offset = 0; /**< used in recursive searching */
146  uint32_t prev_buffer_offset = det_ctx->buffer_offset;
147 
148  do {
149  uint32_t depth = buffer_len;
150  uint32_t offset = 0;
151  if ((cd->flags & DETECT_CONTENT_DISTANCE) ||
152  (cd->flags & DETECT_CONTENT_WITHIN)) {
153  SCLogDebug("det_ctx->buffer_offset %" PRIu32, det_ctx->buffer_offset);
154  offset = prev_buffer_offset;
155 
156  int distance = cd->distance;
157  if (cd->flags & DETECT_CONTENT_DISTANCE) {
159  distance = det_ctx->byte_values[cd->distance];
160  }
161  if (distance < 0 && (uint32_t)(abs(distance)) > offset)
162  offset = 0;
163  else
164  offset += distance;
165 
166  SCLogDebug("cd->distance %"PRIi32", offset %"PRIu32", depth %"PRIu32,
167  distance, offset, depth);
168  }
169 
170  if (cd->flags & DETECT_CONTENT_WITHIN) {
171  if (cd->flags & DETECT_CONTENT_WITHIN_VAR) {
172  if ((int32_t)depth > (int32_t)(prev_buffer_offset + det_ctx->byte_values[cd->within] + distance)) {
173  depth = prev_buffer_offset + det_ctx->byte_values[cd->within] + distance;
174  }
175  } else {
176  if ((int32_t)depth > (int32_t)(prev_buffer_offset + cd->within + distance)) {
177  depth = prev_buffer_offset + cd->within + distance;
178  }
179 
180  SCLogDebug("cd->within %"PRIi32", det_ctx->buffer_offset %"PRIu32", depth %"PRIu32,
181  cd->within, prev_buffer_offset, depth);
182  }
183 
184  if (stream_start_offset != 0 && prev_buffer_offset == 0) {
185  if (depth <= stream_start_offset) {
186  goto no_match;
187  } else if (depth >= (stream_start_offset + buffer_len)) {
188  ;
189  } else {
190  depth = depth - stream_start_offset;
191  }
192  }
193  }
194 
195  if (cd->flags & DETECT_CONTENT_DEPTH_VAR) {
196  if ((det_ctx->byte_values[cd->depth] + prev_buffer_offset) < depth) {
197  depth = prev_buffer_offset + det_ctx->byte_values[cd->depth];
198  }
199  } else {
200  if (cd->depth != 0) {
201  if ((cd->depth + prev_buffer_offset) < depth) {
202  depth = prev_buffer_offset + cd->depth;
203  }
204 
205  SCLogDebug("cd->depth %"PRIu32", depth %"PRIu32, cd->depth, depth);
206  }
207  }
208 
209  if (cd->flags & DETECT_CONTENT_OFFSET_VAR) {
210  if (det_ctx->byte_values[cd->offset] > offset)
211  offset = det_ctx->byte_values[cd->offset];
212  } else {
213  if (cd->offset > offset) {
214  offset = cd->offset;
215  SCLogDebug("setting offset %"PRIu32, offset);
216  }
217  }
218  } else { /* implied no relative matches */
219  /* set depth */
220  if (cd->flags & DETECT_CONTENT_DEPTH_VAR) {
221  depth = det_ctx->byte_values[cd->depth];
222  } else {
223  if (cd->depth != 0) {
224  depth = cd->depth;
225  }
226  }
227 
228  if (stream_start_offset != 0 && cd->flags & DETECT_CONTENT_DEPTH) {
229  if (depth <= stream_start_offset) {
230  goto no_match;
231  } else if (depth >= (stream_start_offset + buffer_len)) {
232  ;
233  } else {
234  depth = depth - stream_start_offset;
235  }
236  }
237 
238  /* set offset */
240  offset = det_ctx->byte_values[cd->offset];
241  else
242  offset = cd->offset;
243  prev_buffer_offset = 0;
244  }
245 
246  /* If the value came from a variable, make sure to adjust the depth so it's relative
247  * to the offset value.
248  */
250  depth += offset;
251  }
252 
253  /* update offset with prev_offset if we're searching for
254  * matches after the first occurrence. */
255  SCLogDebug("offset %"PRIu32", prev_offset %"PRIu32, offset, prev_offset);
256  if (prev_offset != 0)
257  offset = prev_offset;
258 
259  SCLogDebug("offset %"PRIu32", depth %"PRIu32, offset, depth);
260 
261  if (depth > buffer_len)
262  depth = buffer_len;
263 
264  /* if offset is bigger than depth we can never match on a pattern.
265  * We can however, "match" on a negated pattern. */
266  if (offset > depth || depth == 0) {
267  if (cd->flags & DETECT_CONTENT_NEGATED) {
268  goto match;
269  } else {
270  goto no_match;
271  }
272  }
273 
274  const uint8_t *sbuffer = buffer + offset;
275  uint32_t sbuffer_len = depth - offset;
276  SCLogDebug("sbuffer_len %" PRIu32 " depth: %" PRIu32 ", buffer_len: %" PRIu32,
277  sbuffer_len, depth, buffer_len);
278 #ifdef DEBUG
279  BUG_ON(sbuffer_len > buffer_len);
280 #endif
281  const uint8_t *found;
282  if (cd->flags & DETECT_CONTENT_ENDS_WITH && depth < buffer_len) {
283  SCLogDebug("depth < buffer_len while DETECT_CONTENT_ENDS_WITH is set. Can't possibly match.");
284  found = NULL;
285  } else if (cd->content_len > sbuffer_len) {
286  found = NULL;
287  } else {
288  /* do the actual search */
289  found = SpmScan(cd->spm_ctx, det_ctx->spm_thread_ctx, sbuffer,
290  sbuffer_len);
291  }
292 
293  /* next we evaluate the result in combination with the
294  * negation flag. */
295  SCLogDebug("found %p cd negated %s", found, cd->flags & DETECT_CONTENT_NEGATED ? "true" : "false");
296 
297  if (found == NULL) {
298  if (!(cd->flags & DETECT_CONTENT_NEGATED)) {
299  if ((cd->flags & (DETECT_CONTENT_DISTANCE | DETECT_CONTENT_WITHIN)) == 0) {
300  /* independent match from previous matches, so failure is fatal */
301  goto no_match_discontinue;
302  }
303 
304  goto no_match;
305  } else {
306  goto match;
307  }
308  }
309 
310  uint32_t match_offset = (uint32_t)((found - buffer) + cd->content_len);
311  if (cd->flags & DETECT_CONTENT_NEGATED) {
312  SCLogDebug("content %" PRIu32 " matched at offset %" PRIu32
313  ", but negated so no match",
314  cd->id, match_offset);
315  /* don't bother carrying recursive matches now, for preceding
316  * relative keywords */
317 
318  /* found a match but not at the end of the buffer */
319  if (cd->flags & DETECT_CONTENT_ENDS_WITH) {
320  if (sbuffer_len != match_offset) {
321  SCLogDebug("content \"%s\" %" PRIu32 " matched at offset %" PRIu32
322  ", but not at end of buffer so match",
323  cd->content, cd->id, match_offset);
324  goto match;
325  }
326  }
327  if (DETECT_CONTENT_IS_SINGLE(cd)) {
328  goto no_match_discontinue;
329  }
330  goto no_match;
331  }
332 
333  SCLogDebug("content %" PRIu32 " matched at offset %" PRIu32 "", cd->id, match_offset);
334  det_ctx->buffer_offset = match_offset;
335 
336  if ((cd->flags & DETECT_CONTENT_ENDS_WITH) == 0 || match_offset == buffer_len) {
337  /* Match branch, add replace to the list if needed */
339  if (inspection_mode == DETECT_ENGINE_CONTENT_INSPECTION_MODE_PAYLOAD) {
340  /* we will need to replace content if match is confirmed
341  * cast to non-const as replace writes to it. */
342  det_ctx->replist =
343  DetectReplaceAddToList(det_ctx->replist, (uint8_t *)found, cd);
344  } else {
345  SCLogWarning("Can't modify payload without packet");
346  }
347  }
348 
349  /* if this is the last match we're done */
350  if (smd->is_last) {
351  goto match;
352  }
353 
354  SCLogDebug("content %" PRIu32, cd->id);
355  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
356 
357  /* see if the next buffer keywords match. If not, we will
358  * search for another occurrence of this content and see
359  * if the others match then until we run out of matches */
360  int r = DetectEngineContentInspectionInternal(det_ctx, ctx, s, smd + 1, p, f,
361  buffer, buffer_len, stream_start_offset, flags, inspection_mode);
362  if (r == 1) {
363  SCReturnInt(1);
364  } else if (r == -1) {
365  SCLogDebug("'next sm' said to discontinue this right now");
366  SCReturnInt(-1);
367  }
368  SCLogDebug("no match for 'next sm'");
369 
370  /* no match and no reason to look for another instance */
371  if ((cd->flags & DETECT_CONTENT_WITHIN_NEXT) == 0) {
372  SCLogDebug("'next sm' does not depend on me, so we can give up");
373  SCReturnInt(-1);
374  }
375 
376  SCLogDebug("'next sm' depends on me %p, lets see what we can do (flags %u)", cd,
377  cd->flags);
378  }
379  /* set the previous match offset to the start of this match + 1 */
380  prev_offset = (match_offset - (cd->content_len - 1));
381  SCLogDebug("trying to see if there is another match after prev_offset %" PRIu32,
382  prev_offset);
383  } while(1);
384 
385  } else if (smd->type == DETECT_ISDATAAT) {
386  SCLogDebug("inspecting isdataat");
387 
388  const DetectIsdataatData *id = (DetectIsdataatData *)smd->ctx;
389  uint32_t dataat = id->dataat;
390  if (id->flags & ISDATAAT_OFFSET_VAR) {
391  uint64_t be_value = det_ctx->byte_values[dataat];
392  if (be_value >= 100000000) {
393  if ((id->flags & ISDATAAT_NEGATED) == 0) {
394  SCLogDebug("extracted value %"PRIu64" very big: no match", be_value);
395  goto no_match;
396  }
397  SCLogDebug("extracted value way %"PRIu64" very big: match", be_value);
398  goto match;
399  }
400  dataat = (uint32_t)be_value;
401  SCLogDebug("isdataat: using value %u from byte_extract local_id %u", dataat, id->dataat);
402  }
403 
404  if (id->flags & ISDATAAT_RELATIVE) {
405  if (det_ctx->buffer_offset + dataat > buffer_len) {
406  SCLogDebug("det_ctx->buffer_offset + dataat %"PRIu32" > %"PRIu32, det_ctx->buffer_offset + dataat, buffer_len);
407  if (id->flags & ISDATAAT_NEGATED)
408  goto match;
409  if ((id->flags & ISDATAAT_OFFSET_VAR) == 0) {
410  goto no_match_discontinue;
411  }
412  goto no_match;
413  } else {
414  SCLogDebug("relative isdataat match");
415  if (id->flags & ISDATAAT_NEGATED) {
416  goto no_match;
417  }
418  goto match;
419  }
420  } else {
421  if (dataat < buffer_len) {
422  SCLogDebug("absolute isdataat match");
423  if (id->flags & ISDATAAT_NEGATED) {
424  if ((id->flags & ISDATAAT_OFFSET_VAR) == 0) {
425  goto no_match_discontinue;
426  }
427  goto no_match;
428  }
429  goto match;
430  } else {
431  SCLogDebug("absolute isdataat mismatch, id->isdataat %"PRIu32", buffer_len %"PRIu32"", dataat, buffer_len);
432  if (id->flags & ISDATAAT_NEGATED)
433  goto match;
434  if ((id->flags & ISDATAAT_OFFSET_VAR) == 0) {
435  goto no_match_discontinue;
436  }
437  goto no_match;
438  }
439  }
440 
441  } else if (smd->type == DETECT_PCRE) {
442  SCLogDebug("inspecting pcre");
443  const DetectPcreData *pe = (const DetectPcreData *)smd->ctx;
444  uint32_t prev_buffer_offset = det_ctx->buffer_offset;
445  uint32_t prev_offset = 0;
446 
447  det_ctx->pcre_match_start_offset = 0;
448  do {
449  int r = DetectPcrePayloadMatch(det_ctx, s, smd, p, f, buffer, buffer_len);
450  if (r == 0) {
451  goto no_match;
452  }
453 
454  if (!(pe->flags & DETECT_PCRE_RELATIVE_NEXT)) {
455  SCLogDebug("no relative match coming up, so this is a match");
456  goto match;
457  }
458  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
459 
460  /* save it, in case we need to do a pcre match once again */
461  prev_offset = det_ctx->pcre_match_start_offset;
462 
463  /* see if the next payload keywords match. If not, we will
464  * search for another occurrence of this pcre and see
465  * if the others match, until we run out of matches */
466  r = DetectEngineContentInspectionInternal(det_ctx, ctx, s, smd + 1, p, f, buffer,
467  buffer_len, stream_start_offset, flags, inspection_mode);
468  if (r == 1) {
469  SCReturnInt(1);
470  } else if (r == -1) {
471  SCReturnInt(-1);
472  }
473 
474  det_ctx->buffer_offset = prev_buffer_offset;
475  det_ctx->pcre_match_start_offset = prev_offset;
476  } while (1);
477 
478  } else if (smd->type == DETECT_BYTETEST) {
479  const DetectBytetestData *btd = (const DetectBytetestData *)smd->ctx;
480  uint16_t btflags = btd->flags;
481  int32_t offset = btd->offset;
482  uint64_t value = btd->value;
483  int32_t nbytes = btd->nbytes;
484  if (btflags & DETECT_BYTETEST_OFFSET_VAR) {
485  offset = det_ctx->byte_values[offset];
486  }
487  if (btflags & DETECT_BYTETEST_VALUE_VAR) {
488  value = det_ctx->byte_values[value];
489  }
490  if (btflags & DETECT_BYTETEST_NBYTES_VAR) {
491  nbytes = det_ctx->byte_values[nbytes];
492  }
493 
494  /* if we have dce enabled we will have to use the endianness
495  * specified by the dce header */
496  if (btflags & DETECT_BYTETEST_DCE) {
497  /* enable the endianness flag temporarily. once we are done
498  * processing we reset the flags to the original value*/
499  btflags |= ((flags & DETECT_CI_FLAGS_DCE_LE) ?
501  }
502 
503  if (DetectBytetestDoMatch(det_ctx, s, smd->ctx, buffer, buffer_len, btflags, offset, nbytes,
504  value) != 1) {
505  goto no_match;
506  }
507 
508  goto match;
509 
510  } else if (smd->type == DETECT_BYTEJUMP) {
511  const DetectBytejumpData *bjd = (const DetectBytejumpData *)smd->ctx;
512  uint16_t bjflags = bjd->flags;
513  int32_t offset = bjd->offset;
514  int32_t nbytes;
515 
516  if (bjflags & DETECT_BYTEJUMP_OFFSET_VAR) {
517  offset = det_ctx->byte_values[offset];
518  }
519 
520  if (bjflags & DETECT_BYTEJUMP_NBYTES_VAR) {
521  nbytes = det_ctx->byte_values[bjd->nbytes];
522  } else {
523  nbytes = bjd->nbytes;
524  }
525 
526  /* if we have dce enabled we will have to use the endianness
527  * specified by the dce header */
528  if (bjflags & DETECT_BYTEJUMP_DCE) {
529  /* enable the endianness flag temporarily. once we are done
530  * processing we reset the flags to the original value*/
531  bjflags |= ((flags & DETECT_CI_FLAGS_DCE_LE) ?
533  }
534 
536  det_ctx, s, smd->ctx, buffer, buffer_len, bjflags, nbytes, offset)) {
537  goto no_match;
538  }
539 
540  goto match;
541 
542  } else if (smd->type == DETECT_BYTE_EXTRACT) {
543 
544  const SCDetectByteExtractData *bed = (const SCDetectByteExtractData *)smd->ctx;
545  uint8_t endian = bed->endian;
546 
547  /* if we have dce enabled we will have to use the endianness
548  * specified by the dce header */
549  if ((bed->flags & DETECT_BYTE_EXTRACT_FLAG_ENDIAN) && endian == EndianDCE &&
551 
552  /* enable the endianness flag temporarily. once we are done
553  * processing we reset the flags to the original value*/
554  endian |= ((flags & DETECT_CI_FLAGS_DCE_LE) ? LittleEndian : BigEndian);
555  }
556 
557  if (DetectByteExtractDoMatch(det_ctx, smd, s, buffer, buffer_len,
558  &det_ctx->byte_values[bed->local_id], endian) != 1) {
559  goto no_match;
560  }
561 
562  SCLogDebug("[BE] Fetched value for index %d: %"PRIu64,
563  bed->local_id, det_ctx->byte_values[bed->local_id]);
564  goto match;
565 
566  } else if (smd->type == DETECT_BYTEMATH) {
567 
568  const DetectByteMathData *bmd = (const DetectByteMathData *)smd->ctx;
569  uint8_t endian = bmd->endian;
570 
571  /* if we have dce enabled we will have to use the endianness
572  * specified by the dce header */
573  if ((bmd->flags & DETECT_BYTEMATH_FLAG_ENDIAN) && endian == (int)EndianDCE &&
575  /* enable the endianness flag temporarily. once we are done
576  * processing we reset the flags to the original value*/
577  endian = (uint8_t)((flags & DETECT_CI_FLAGS_DCE_LE) ? LittleEndian : BigEndian);
578  }
579  uint64_t rvalue;
580  if (bmd->flags & DETECT_BYTEMATH_FLAG_RVALUE_VAR) {
581  rvalue = det_ctx->byte_values[bmd->rvalue];
582  } else {
583  rvalue = bmd->rvalue;
584  }
585 
586  uint8_t nbytes;
587  if (bmd->flags & DETECT_BYTEMATH_FLAG_NBYTES_VAR) {
588  nbytes = (uint8_t)det_ctx->byte_values[bmd->nbytes];
589  } else {
590  nbytes = bmd->nbytes;
591  }
592 
593  if (DetectByteMathDoMatch(det_ctx, bmd, s, buffer, buffer_len, nbytes, rvalue,
594  &det_ctx->byte_values[bmd->local_id], endian) != 1) {
595  goto no_match;
596  }
597 
598  SCLogDebug("[BM] Fetched value for index %d: %"PRIu64,
599  bmd->local_id, det_ctx->byte_values[bmd->local_id]);
600  goto match;
601 
602  } else if (smd->type == DETECT_BSIZE) {
603 
604  const bool eof = (flags & DETECT_CI_FLAGS_END);
605  const uint64_t data_size = buffer_len + stream_start_offset;
606  int r = DetectBsizeMatch(smd->ctx, data_size, eof);
607  if (r < 0) {
608  goto no_match_discontinue;
609  } else if (r == 0) {
610  goto no_match;
611  }
612  goto match;
613 
614  } else if (smd->type == DETECT_DATASET) {
615 
616  //PrintRawDataFp(stdout, buffer, buffer_len);
617  const DetectDatasetData *sd = (const DetectDatasetData *) smd->ctx;
618  int r = DetectDatasetBufferMatch(det_ctx, sd, buffer, buffer_len); //TODO buffer offset?
619  if (r == 1) {
620  goto match;
621  }
622  goto no_match_discontinue;
623 
624  } else if (smd->type == DETECT_DATAREP) {
625 
626  //PrintRawDataFp(stdout, buffer, buffer_len);
627  const DetectDatarepData *sd = (const DetectDatarepData *) smd->ctx;
628  int r = DetectDatarepBufferMatch(det_ctx, sd, buffer, buffer_len); //TODO buffer offset?
629  if (r == 1) {
630  goto match;
631  }
632  goto no_match_discontinue;
633 
634  } else if (smd->type == DETECT_AL_URILEN) {
635  SCLogDebug("inspecting uri len");
636 
637  int r;
638  const DetectUrilenData *urilend = (const DetectUrilenData *)smd->ctx;
639  if (buffer_len > UINT16_MAX) {
640  r = DetectU16Match(UINT16_MAX, &urilend->du16);
641  } else {
642  r = DetectU16Match((uint16_t)buffer_len, &urilend->du16);
643  }
644 
645  if (r == 1) {
646  goto match;
647  }
648  goto no_match_discontinue;
649  }
650  else if (smd->type == DETECT_LUA) {
651  SCLogDebug("lua starting");
652 
653  if (DetectLuaMatchBuffer(det_ctx, s, smd, buffer, buffer_len,
654  det_ctx->buffer_offset, f) != 1)
655  {
656  SCLogDebug("lua no_match");
657  goto no_match;
658  }
659  SCLogDebug("lua match");
660  goto match;
661  } else if (smd->type == DETECT_BASE64_DECODE) {
662  if (DetectBase64DecodeDoMatch(det_ctx, s, smd, buffer, buffer_len)) {
663  if (s->sm_arrays[DETECT_SM_LIST_BASE64_DATA] != NULL) {
664  if (det_ctx->base64_decoded_len) {
665  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
666  int r = DetectEngineContentInspectionInternal(det_ctx, ctx, s,
668  det_ctx->base64_decoded, det_ctx->base64_decoded_len, 0,
670  if (r == 1) {
671  /* Base64 is a terminal list. */
672  goto final_match;
673  }
674  }
675  }
676  }
677  } else if (smd->type == DETECT_ASN1) {
678  if (!DetectAsn1Match(smd, buffer, buffer_len, det_ctx->buffer_offset)) {
679  SCLogDebug("asn1 no_match");
680  goto no_match;
681  }
682  SCLogDebug("asn1 match");
683  goto match;
684  } else {
685  SCLogDebug("sm->type %u", smd->type);
686 #ifdef DEBUG
687  BUG_ON(1);
688 #endif
689  }
690 
691 no_match:
692  KEYWORD_PROFILING_END(det_ctx, smd->type, 0);
693  SCReturnInt(0);
694 
695 no_match_discontinue:
696  KEYWORD_PROFILING_END(det_ctx, smd->type, 0);
697  SCReturnInt(-1);
698 
699 match:
700  /* this sigmatch matched, inspect the next one. If it was the last,
701  * the buffer portion of the signature matched. */
702  if (!smd->is_last) {
703  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
704  int r = DetectEngineContentInspectionInternal(det_ctx, ctx, s, smd + 1, p, f, buffer,
705  buffer_len, stream_start_offset, flags, inspection_mode);
706  SCReturnInt(r);
707  }
708 final_match:
709  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
710  SCReturnInt(1);
711 }
712 
713 /** \brief wrapper around DetectEngineContentInspectionInternal to return true/false only
714  *
715  * \param smd sigmatches to evaluate
716  */
718  const Signature *s, const SigMatchData *smd, Packet *p, Flow *f, const uint8_t *buffer,
719  const uint32_t buffer_len, const uint32_t stream_start_offset, const uint8_t flags,
720  const enum DetectContentInspectionType inspection_mode)
721 {
722  struct DetectEngineContentInspectionCtx ctx = { .recursion.count = 0,
723  .recursion.limit = de_ctx->inspection_recursion_limit };
724  det_ctx->buffer_offset = 0;
725 
726  int r = DetectEngineContentInspectionInternal(det_ctx, &ctx, s, smd, p, f, buffer, buffer_len,
727  stream_start_offset, flags, inspection_mode);
728 #ifdef UNITTESTS
729  ut_inspection_recursion_counter = ctx.recursion.count;
730 #endif
731  if (r == 1)
732  return true;
733  else
734  return false;
735 }
736 
737 /** \brief wrapper around DetectEngineContentInspectionInternal to return true/false only
738  *
739  * \param smd sigmatches to evaluate
740  */
742  const Signature *s, const SigMatchData *smd, Packet *p, Flow *f, const InspectionBuffer *b,
743  const enum DetectContentInspectionType inspection_mode)
744 {
745  struct DetectEngineContentInspectionCtx ctx = { .recursion.count = 0,
746  .recursion.limit = de_ctx->inspection_recursion_limit };
747 
748  det_ctx->buffer_offset = 0;
749 
750  int r = DetectEngineContentInspectionInternal(det_ctx, &ctx, s, smd, p, f, b->inspect,
751  b->inspect_len, b->inspect_offset, b->flags, inspection_mode);
752 #ifdef UNITTESTS
753  ut_inspection_recursion_counter = ctx.recursion.count;
754 #endif
755  if (r == 1)
756  return true;
757  else
758  return false;
759 }
760 
761 #ifdef UNITTESTS
763 #endif
DetectEngineContentInspectionCtx
Definition: detect-engine-content-inspection.c:71
DetectEngineThreadCtx_::byte_values
uint64_t * byte_values
Definition: detect.h:1130
DetectAsn1Match
bool DetectAsn1Match(const SigMatchData *smd, const uint8_t *buffer, const uint32_t buffer_len, const uint32_t offset)
Definition: detect-asn1.c:58
DetectContentData_::offset
uint16_t offset
Definition: detect-content.h:107
DetectBytetestData_::flags
uint16_t flags
Definition: detect-bytetest.h:58
DetectDatasetData_
Definition: detect-dataset.h:34
detect-engine-uint.h
DETECT_BYTETEST_VALUE_VAR
#define DETECT_BYTETEST_VALUE_VAR
Definition: detect-bytetest.h:49
detect-content.h
DetectEngineThreadCtx_::buffer_offset
uint32_t buffer_offset
Definition: detect.h:1119
detect-engine.h
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
DETECT_CONTENT_DISTANCE_VAR
#define DETECT_CONTENT_DISTANCE_VAR
Definition: detect-content.h:47
DetectPcrePayloadMatch
int DetectPcrePayloadMatch(DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchData *smd, Packet *p, Flow *f, const uint8_t *payload, uint32_t payload_len)
Match a regex on a single payload.
Definition: detect-pcre.c:173
DETECT_BYTEJUMP
@ DETECT_BYTEJUMP
Definition: detect-engine-register.h:84
ISDATAAT_OFFSET_VAR
#define ISDATAAT_OFFSET_VAR
Definition: detect-isdataat.h:30
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
DetectContentData_::within
int32_t within
Definition: detect-content.h:109
DetectBase64DecodeDoMatch
int DetectBase64DecodeDoMatch(DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchData *smd, const uint8_t *payload, uint32_t payload_len)
Definition: detect-base64-decode.c:66
DetectBytetestDoMatch
int DetectBytetestDoMatch(DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchCtx *ctx, const uint8_t *payload, uint32_t payload_len, uint16_t flags, int32_t offset, int32_t nbytes, uint64_t value)
Bytetest detection code.
Definition: detect-bytetest.c:154
DetectIsdataatData_::flags
uint8_t flags
Definition: detect-isdataat.h:34
DETECT_BYTEJUMP_LITTLE
#define DETECT_BYTEJUMP_LITTLE
Definition: detect-bytejump.h:35
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:70
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
detect-isdataat.h
DETECT_BYTEJUMP_NBYTES_VAR
#define DETECT_BYTEJUMP_NBYTES_VAR
Definition: detect-bytejump.h:43
SigMatchData_::is_last
bool is_last
Definition: detect.h:360
util-lua.h
DetectDatarepData_
Definition: detect-datarep.h:36
SigMatchData_::ctx
SigMatchCtx * ctx
Definition: detect.h:361
detect-bsize.h
InspectionBuffer
Definition: detect.h:373
Flow_
Flow data structure.
Definition: flow.h:360
ctx
struct Thresholds ctx
DetectEngineCtx_::inspection_recursion_limit
int inspection_recursion_limit
Definition: detect.h:885
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:841
DETECT_DATAREP
@ DETECT_DATAREP
Definition: detect-engine-register.h:88
DETECT_BYTETEST_DCE
#define DETECT_BYTETEST_DCE
Definition: detect-bytetest.h:47
DETECT_CONTENT_DEPTH_VAR
#define DETECT_CONTENT_DEPTH_VAR
Definition: detect-content.h:46
detect-lua.h
rust.h
DETECT_BYTEJUMP_DCE
#define DETECT_BYTEJUMP_DCE
Definition: detect-bytejump.h:40
DetectEngineThreadCtx_::spm_thread_ctx
SpmThreadCtx * spm_thread_ctx
Definition: detect.h:1127
InspectionBuffer::flags
uint8_t flags
Definition: detect.h:378
DetectContentInspectionType
DetectContentInspectionType
Definition: detect-engine-content-inspection.h:31
Signature_::sm_arrays
SigMatchData * sm_arrays[DETECT_SM_LIST_MAX]
Definition: detect.h:654
DetectIsdataatData_
Definition: detect-isdataat.h:32
DetectContentData_
Definition: detect-content.h:93
DetectPcreData_::flags
uint16_t flags
Definition: detect-pcre.h:46
DetectBytetestData_::nbytes
uint8_t nbytes
Definition: detect-bytetest.h:54
DetectBytetestData_
Definition: detect-bytetest.h:53
SigMatchData_
Data needed for Match()
Definition: detect.h:358
detect-pcre.h
KEYWORD_PROFILING_START
#define KEYWORD_PROFILING_START
Definition: util-profiling.h:50
DETECT_CI_FLAGS_DCE_BE
#define DETECT_CI_FLAGS_DCE_BE
Definition: detect-engine-content-inspection.h:45
SigMatchData_::type
uint16_t type
Definition: detect.h:359
DetectBytejumpData_
Definition: detect-bytejump.h:46
DETECT_ENGINE_CONTENT_INSPECTION_MODE_PAYLOAD
@ DETECT_ENGINE_CONTENT_INSPECTION_MODE_PAYLOAD
Definition: detect-engine-content-inspection.h:32
util-unittest.h
DETECT_ASN1
@ DETECT_ASN1
Definition: detect-engine-register.h:92
DetectBytejumpData_::offset
int32_t offset
Definition: detect-bytejump.h:50
util-unittest-helper.h
detect-asn1.h
KEYWORD_PROFILING_END
#define KEYWORD_PROFILING_END(ctx, type, m)
Definition: util-profiling.h:64
detect-base64-data.h
DetectByteExtractDoMatch
int DetectByteExtractDoMatch(DetectEngineThreadCtx *det_ctx, const SigMatchData *smd, const Signature *s, const uint8_t *payload, uint32_t payload_len, uint64_t *value, uint8_t endian)
Definition: detect-byte-extract.c:82
DetectReplaceAddToList
DetectReplaceList * DetectReplaceAddToList(DetectReplaceList *replist, uint8_t *found, const DetectContentData *cd)
Definition: detect-replace.c:167
decode.h
util-debug.h
DETECT_CONTENT_ENDS_WITH
#define DETECT_CONTENT_ENDS_WITH
Definition: detect-content.h:42
DETECT_CONTENT_DISTANCE
#define DETECT_CONTENT_DISTANCE
Definition: detect-content.h:30
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectBsizeMatch
int DetectBsizeMatch(const SigMatchCtx *ctx, const uint64_t buffer_size, bool eof)
bsize match function
Definition: detect-bsize.c:119
DetectEngineThreadCtx_
Definition: detect.h:1090
DetectEngineContentInspectionCtx::recursion
struct DetectEngineContentInspectionCtx::@55 recursion
DETECT_BSIZE
@ DETECT_BSIZE
Definition: detect-engine-register.h:91
DETECT_SM_LIST_BASE64_DATA
@ DETECT_SM_LIST_BASE64_DATA
Definition: detect.h:121
DETECT_LUA
@ DETECT_LUA
Definition: detect-engine-register.h:93
DETECT_CONTENT_DEPTH
#define DETECT_CONTENT_DEPTH
Definition: detect-content.h:33
util-print.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect.h
DETECT_CONTENT_IS_SINGLE
#define DETECT_CONTENT_IS_SINGLE(c)
Definition: detect-content.h:68
DETECT_CONTENT_NEGATED
#define DETECT_CONTENT_NEGATED
Definition: detect-content.h:40
InspectionBuffer::inspect_offset
uint64_t inspect_offset
Definition: detect.h:375
DETECT_ENGINE_CONTENT_INSPECTION_MODE_STATE
@ DETECT_ENGINE_CONTENT_INSPECTION_MODE_STATE
Definition: detect-engine-content-inspection.h:36
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
DetectContentData_::id
PatIntId id
Definition: detect-content.h:105
DetectLuaMatchBuffer
int DetectLuaMatchBuffer(DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchData *smd, const uint8_t *buffer, uint32_t buffer_len, uint32_t offset, Flow *f)
Definition: detect-lua.c:273
DetectBytejumpDoMatch
bool DetectBytejumpDoMatch(DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchCtx *ctx, const uint8_t *payload, uint32_t payload_len, uint16_t flags, int32_t nbytes, int32_t offset)
Byte jump match function.
Definition: detect-bytejump.c:136
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:300
DetectEngineThreadCtx_::base64_decoded_len
int base64_decoded_len
Definition: detect.h:1133
util-profiling.h
DETECT_BYTETEST_OFFSET_VAR
#define DETECT_BYTETEST_OFFSET_VAR
Definition: detect-bytetest.h:50
DetectContentData_::depth
uint16_t depth
Definition: detect-content.h:106
SpmScan
uint8_t * SpmScan(const SpmCtx *ctx, SpmThreadCtx *thread_ctx, const uint8_t *haystack, uint32_t haystack_len)
Definition: util-spm.c:193
Packet_
Definition: decode.h:479
ISDATAAT_RELATIVE
#define ISDATAAT_RELATIVE
Definition: detect-isdataat.h:27
detect-bytejump.h
DETECT_BYTETEST_NBYTES_VAR
#define DETECT_BYTETEST_NBYTES_VAR
Definition: detect-bytetest.h:51
DETECT_CI_FLAGS_END
#define DETECT_CI_FLAGS_END
Definition: detect-engine-content-inspection.h:42
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:104
detect-replace.h
DETECT_PCRE
@ DETECT_PCRE
Definition: detect-engine-register.h:72
detect-engine-content-inspection.h
DETECT_CONTENT_WITHIN_VAR
#define DETECT_CONTENT_WITHIN_VAR
Definition: detect-content.h:48
DetectDatasetBufferMatch
int DetectDatasetBufferMatch(DetectEngineThreadCtx *det_ctx, const DetectDatasetData *sd, const uint8_t *data, const uint32_t data_len)
Definition: detect-dataset.c:63
DetectDatarepBufferMatch
int DetectDatarepBufferMatch(DetectEngineThreadCtx *det_ctx, const DetectDatarepData *sd, const uint8_t *data, const uint32_t data_len)
Definition: detect-datarep.c:68
DETECT_BYTETEST
@ DETECT_BYTETEST
Definition: detect-engine-register.h:83
DetectByteMathDoMatch
int DetectByteMathDoMatch(DetectEngineThreadCtx *det_ctx, const DetectByteMathData *data, const Signature *s, const uint8_t *payload, const uint32_t payload_len, uint8_t nbytes, uint64_t rvalue, uint64_t *value, uint8_t endian)
Definition: detect-bytemath.c:88
DETECT_CI_FLAGS_SINGLE
#define DETECT_CI_FLAGS_SINGLE
Definition: detect-engine-content-inspection.h:49
DetectU16Match
int DetectU16Match(const uint16_t parg, const DetectUintData_u16 *du16)
Definition: detect-engine-uint.c:107
flags
uint8_t flags
Definition: decode-gre.h:0
suricata-common.h
detect-byte-extract.h
DetectContentData_::distance
int32_t distance
Definition: detect-content.h:108
DetectBytejumpData_::nbytes
uint8_t nbytes
Definition: detect-bytejump.h:47
ut_inspection_recursion_counter
thread_local uint32_t ut_inspection_recursion_counter
Definition: detect-engine-content-inspection.c:68
DETECT_CONTENT_WITHIN_NEXT
#define DETECT_CONTENT_WITHIN_NEXT
Definition: detect-content.h:57
util-spm.h
DetectContentData_::content
uint8_t * content
Definition: detect-content.h:94
detect-dataset.h
DetectEngineContentInspectionCtx::limit
const uint32_t limit
Definition: detect-engine-content-inspection.c:74
util-validate.h
detect-base64-decode.h
ISDATAAT_NEGATED
#define ISDATAAT_NEGATED
Definition: detect-isdataat.h:29
DetectContentData_::spm_ctx
SpmCtx * spm_ctx
Definition: detect-content.h:111
InspectionBuffer::inspect_len
uint32_t inspect_len
Definition: detect.h:376
DetectEngineThreadCtx_::pcre_match_start_offset
uint32_t pcre_match_start_offset
Definition: detect.h:1123
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:374
detect-datarep.h
DETECT_BYTE_EXTRACT
@ DETECT_BYTE_EXTRACT
Definition: detect-engine-register.h:86
detect-parse.h
Signature_
Signature container.
Definition: detect.h:601
DETECT_ISDATAAT
@ DETECT_ISDATAAT
Definition: detect-engine-register.h:94
DetectBytetestData_::offset
int32_t offset
Definition: detect-bytetest.h:60
DetectIsdataatData_::dataat
uint16_t dataat
Definition: detect-isdataat.h:33
DetectEngineThreadCtx_::base64_decoded
uint8_t * base64_decoded
Definition: detect.h:1132
DETECT_PCRE_RELATIVE_NEXT
#define DETECT_PCRE_RELATIVE_NEXT
Definition: detect-pcre.h:34
detect-urilen.h
suricata.h
DetectPcreData_
Definition: detect-pcre.h:42
DetectContentData_::content_len
uint16_t content_len
Definition: detect-content.h:95
DETECT_BYTEMATH
@ DETECT_BYTEMATH
Definition: detect-engine-register.h:85
DETECT_BASE64_DECODE
@ DETECT_BASE64_DECODE
Definition: detect-engine-register.h:89
detect-uricontent.h
DetectEngineContentInspectionBuffer
bool DetectEngineContentInspectionBuffer(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchData *smd, Packet *p, Flow *f, const InspectionBuffer *b, const enum DetectContentInspectionType inspection_mode)
wrapper around DetectEngineContentInspectionInternal to return true/false only
Definition: detect-engine-content-inspection.c:741
DetectEngineThreadCtx_::replist
DetectReplaceList * replist
Definition: detect.h:1200
DetectEngineContentInspectionCtx::count
uint32_t count
Definition: detect-engine-content-inspection.c:73
DETECT_CONTENT_REPLACE
#define DETECT_CONTENT_REPLACE
Definition: detect-content.h:51
DetectEngineContentInspection
bool DetectEngineContentInspection(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const Signature *s, const SigMatchData *smd, Packet *p, Flow *f, const uint8_t *buffer, const uint32_t buffer_len, const uint32_t stream_start_offset, const uint8_t flags, const enum DetectContentInspectionType inspection_mode)
wrapper around DetectEngineContentInspectionInternal to return true/false only
Definition: detect-engine-content-inspection.c:717
detect-engine-content-inspection.c
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
DETECT_BYTETEST_LITTLE
#define DETECT_BYTETEST_LITTLE
Definition: detect-bytetest.h:43
DETECT_AL_URILEN
@ DETECT_AL_URILEN
Definition: detect-engine-register.h:95
DETECT_DATASET
@ DETECT_DATASET
Definition: detect-engine-register.h:87
DetectBytetestData_::value
uint64_t value
Definition: detect-bytetest.h:62
DETECT_CONTENT_WITHIN
#define DETECT_CONTENT_WITHIN
Definition: detect-content.h:31
DETECT_CI_FLAGS_DCE_LE
#define DETECT_CI_FLAGS_DCE_LE
Definition: detect-engine-content-inspection.h:44
DETECT_BYTEJUMP_OFFSET_VAR
#define DETECT_BYTEJUMP_OFFSET_VAR
Definition: detect-bytejump.h:44
DetectBytejumpData_::flags
uint16_t flags
Definition: detect-bytejump.h:49
detect-bytemath.h
DETECT_CONTENT_OFFSET_VAR
#define DETECT_CONTENT_OFFSET_VAR
Definition: detect-content.h:45
detect-bytetest.h