suricata
detect-file-data.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  */
24 
25 #include "suricata-common.h"
26 #include "threads.h"
27 #include "decode.h"
28 
29 #include "detect.h"
30 #include "detect-parse.h"
31 
32 #include "detect-engine.h"
33 #include "detect-engine-mpm.h"
34 #include "detect-engine-state.h"
37 #include "detect-engine-file.h"
38 #include "detect-file-data.h"
39 
40 #include "app-layer.h"
41 #include "app-layer-parser.h"
42 #include "app-layer-htp.h"
43 #include "app-layer-smtp.h"
44 
45 #include "flow.h"
46 #include "flow-var.h"
47 #include "flow-util.h"
48 
49 #include "util-debug.h"
50 #include "util-spm-bm.h"
51 #include "util-unittest.h"
52 #include "util-unittest-helper.h"
54 #include "util-profiling.h"
55 
56 static int DetectFiledataSetup (DetectEngineCtx *, Signature *, const char *);
57 #ifdef UNITTESTS
58 static void DetectFiledataRegisterTests(void);
59 #endif
60 static void DetectFiledataSetupCallback(const DetectEngineCtx *de_ctx,
61  Signature *s);
62 static int g_file_data_buffer_id = 0;
63 
64 /* file API */
66  const DetectBufferMpmRegistry *mpm_reg, int list_id);
67 
68 /**
69  * \brief Registration function for keyword: file_data
70  */
72 {
73  sigmatch_table[DETECT_FILE_DATA].name = "file.data";
74  sigmatch_table[DETECT_FILE_DATA].alias = "file_data";
75  sigmatch_table[DETECT_FILE_DATA].desc = "make content keywords match on file data";
76  sigmatch_table[DETECT_FILE_DATA].url = "/rules/file-keywords.html#file-data";
77  sigmatch_table[DETECT_FILE_DATA].Setup = DetectFiledataSetup;
78 #ifdef UNITTESTS
80 #endif
82 
87 
88  DetectBufferTypeRegisterSetupCallback("file_data", DetectFiledataSetupCallback);
89 
90  DetectBufferTypeSetDescriptionByName("file_data", "data from tracked files");
92 
93  g_file_data_buffer_id = DetectBufferTypeGetByName("file_data");
94 }
95 
96 static void SetupDetectEngineConfig(DetectEngineCtx *de_ctx) {
98  return;
99 
101  if (unlikely(de_ctx->filedata_config == NULL))
102  return;
103  /* initialize default */
104  for (AppProto i = 0; i < g_alproto_max; i++) {
107  }
108 
109  /* add protocol specific settings here */
110 
111  /* SMTP */
115 }
116 
117 /**
118  * \brief this function is used to parse filedata options
119  * \brief into the current signature
120  *
121  * \param de_ctx pointer to the Detection Engine Context
122  * \param s pointer to the Current Signature
123  * \param str pointer to the user provided "filestore" option
124  *
125  * \retval 0 on Success
126  * \retval -1 on Failure
127  */
128 static int DetectFiledataSetup (DetectEngineCtx *de_ctx, Signature *s, const char *str)
129 {
130  SCEnter();
131 
132  if (!DetectProtoContainsProto(&s->proto, IPPROTO_TCP)) {
133  SCLogError("The 'file_data' keyword cannot be used with non-TCP protocols");
134  return -1;
135  }
136 
137  if (s->alproto != ALPROTO_UNKNOWN && !AppLayerParserSupportsFiles(IPPROTO_TCP, s->alproto)) {
138  SCLogError("The 'file_data' keyword cannot be used with TCP protocol %s",
140  return -1;
141  }
142 
143  if (DetectSetupDirection(s, str) < 0) {
144  SCLogError("file.data failed to setup direction");
145  return -1;
146  }
147 
149  !(s->flags & SIG_FLAG_TOSERVER) && (s->flags & SIG_FLAG_TOCLIENT)) {
150  SCLogError("The 'file-data' keyword cannot be used with SMTP flow:to_client or "
151  "flow:from_server.");
152  return -1;
153  }
154 
156  return -1;
157 
160  // we cannot use a transactional rule with a fast pattern to client and this
162  SCLogError("fast_pattern cannot be used on to_client keyword for "
163  "transactional rule with a streaming buffer to server %u",
164  s->id);
165  return -1;
166  }
168  }
171 
172  SetupDetectEngineConfig(de_ctx);
173  return 0;
174 }
175 
176 static void DetectFiledataSetupCallback(const DetectEngineCtx *de_ctx,
177  Signature *s)
178 {
179  if (s->alproto == ALPROTO_HTTP1 || s->alproto == ALPROTO_UNKNOWN ||
180  s->alproto == ALPROTO_HTTP) {
182  }
183 
184  /* server body needs to be inspected in sync with stream if possible */
186 
187  SCLogDebug("callback invoked by %u", s->id);
188 }
189 
190 /* common */
191 
192 static void PrefilterMpmFiledataFree(void *ptr)
193 {
194  SCFree(ptr);
195 }
196 
197 /* file API based inspection */
198 
199 static inline InspectionBuffer *FiledataWithXformsGetDataCallback(DetectEngineThreadCtx *det_ctx,
200  const DetectEngineTransforms *transforms, const int list_id, int local_file_id,
201  InspectionBuffer *base_buffer)
202 {
203  InspectionBuffer *buffer = InspectionBufferMultipleForListGet(det_ctx, list_id, local_file_id);
204  if (buffer == NULL) {
205  SCLogDebug("list_id: %d: no buffer", list_id);
206  return NULL;
207  }
208  if (buffer->initialized) {
209  SCLogDebug("list_id: %d: returning %p", list_id, buffer);
210  return buffer;
211  }
212 
214  det_ctx, buffer, transforms, base_buffer->inspect, base_buffer->inspect_len);
215  buffer->inspect_offset = base_buffer->inspect_offset;
216  SCLogDebug("xformed buffer %p size %u", buffer, buffer->inspect_len);
217  SCReturnPtr(buffer, "InspectionBuffer");
218 }
219 
220 static InspectionBuffer *FiledataGetDataCallback(DetectEngineThreadCtx *det_ctx,
221  const DetectEngineTransforms *transforms, Flow *f, uint8_t flow_flags, File *cur_file,
222  const int list_id, const int base_id, int local_file_id, void *txv)
223 {
224  SCEnter();
225  SCLogDebug("starting: list_id %d base_id %d", list_id, base_id);
226 
227  InspectionBuffer *buffer = InspectionBufferMultipleForListGet(det_ctx, base_id, local_file_id);
228  SCLogDebug("base: buffer %p", buffer);
229  if (buffer == NULL)
230  return NULL;
231  if (base_id != list_id && buffer->inspect != NULL) {
232  SCLogDebug("handle xform %s", (list_id != base_id) ? "true" : "false");
233  return FiledataWithXformsGetDataCallback(
234  det_ctx, transforms, list_id, local_file_id, buffer);
235  }
236  if (buffer->initialized) {
237  SCLogDebug("base_id: %d, not first: use %p", base_id, buffer);
238  return buffer;
239  }
240 
241  const uint64_t file_size = FileDataSize(cur_file);
242  const DetectEngineCtx *de_ctx = det_ctx->de_ctx;
243  uint32_t content_limit = FILEDATA_CONTENT_LIMIT;
244  uint32_t content_inspect_min_size = FILEDATA_CONTENT_INSPECT_MIN_SIZE;
245  if (de_ctx->filedata_config) {
246  content_limit = de_ctx->filedata_config[f->alproto].content_limit;
247  content_inspect_min_size = de_ctx->filedata_config[f->alproto].content_inspect_min_size;
248  }
249 
250  SCLogDebug("[list %d] content_limit %u, content_inspect_min_size %u", list_id, content_limit,
251  content_inspect_min_size);
252 
253  SCLogDebug("[list %d] file %p size %" PRIu64 ", state %d", list_id, cur_file, file_size,
254  cur_file->state);
255 
256  /* no new data */
257  if (cur_file->content_inspected == file_size) {
258  SCLogDebug("no new data");
259  goto empty_return;
260  }
261 
262  if (file_size == 0) {
263  SCLogDebug("no data to inspect for this transaction");
264  goto empty_return;
265  }
266 
267  SCLogDebug("offset %" PRIu64, StreamingBufferGetOffset(cur_file->sb));
268  SCLogDebug("size %" PRIu64, cur_file->size);
269  SCLogDebug("content_inspected %" PRIu64, cur_file->content_inspected);
270  SCLogDebug("inspect_window %" PRIu32, cur_file->inspect_window);
271  SCLogDebug("inspect_min_size %" PRIu32, cur_file->inspect_min_size);
272 
273  bool ips = false;
274  uint64_t offset = 0;
275  if (f->alproto == ALPROTO_HTTP1) {
276 
277  htp_tx_t *tx = txv;
278  HtpState *htp_state = f->alstate;
279  ips = htp_state->cfg->http_body_inline;
280 
281  const bool body_done = AppLayerParserGetStateProgress(IPPROTO_TCP, ALPROTO_HTTP1, tx,
282  flow_flags) > HTP_RESPONSE_PROGRESS_BODY;
283 
284  SCLogDebug("response.body_limit %u file_size %" PRIu64
285  ", cur_file->inspect_min_size %" PRIu32 ", EOF %s, progress > body? %s",
286  htp_state->cfg->response.body_limit, file_size, cur_file->inspect_min_size,
287  flow_flags & STREAM_EOF ? "true" : "false", BOOL2STR(body_done));
288 
289  if (!htp_state->cfg->http_body_inline) {
290  /* inspect the body if the transfer is complete or we have hit
291  * our body size limit */
292  if ((htp_state->cfg->response.body_limit == 0 ||
293  file_size < htp_state->cfg->response.body_limit) &&
294  file_size < cur_file->inspect_min_size && !body_done &&
295  !(flow_flags & STREAM_EOF)) {
296  SCLogDebug("we still haven't seen the entire response body. "
297  "Let's defer body inspection till we see the "
298  "entire body.");
299  goto empty_return;
300  }
301  SCLogDebug("inline and we're continuing");
302  }
303 
304  bool force = (flow_flags & STREAM_EOF) || (cur_file->state > FILE_STATE_OPENED) ||
305  body_done || htp_state->cfg->http_body_inline;
306  /* get the inspect buffer
307  *
308  * make sure that we have at least the configured inspect_win size.
309  * If we have more, take at least 1/4 of the inspect win size before
310  * the new data.
311  */
312  if (cur_file->content_inspected == 0) {
313  if (!force && file_size < cur_file->inspect_min_size) {
314  SCLogDebug("skip as file_size %" PRIu64 " < inspect_min_size %u", file_size,
315  cur_file->inspect_min_size);
316  goto empty_return;
317  }
318  } else {
319  uint64_t new_data = file_size - cur_file->content_inspected;
320  BUG_ON(new_data == 0);
321  if (new_data < cur_file->inspect_window) {
322  uint64_t inspect_short = cur_file->inspect_window - new_data;
323  if (cur_file->content_inspected < inspect_short) {
324  offset = 0;
325  SCLogDebug("offset %" PRIu64, offset);
326  } else {
327  offset = cur_file->content_inspected - inspect_short;
328  SCLogDebug("offset %" PRIu64, offset);
329  }
330  } else {
331  BUG_ON(cur_file->content_inspected == 0);
332  uint32_t margin = cur_file->inspect_window / 4;
333  if ((uint64_t)margin <= cur_file->content_inspected) {
334  offset = cur_file->content_inspected - (cur_file->inspect_window / 4);
335  } else {
336  offset = 0;
337  }
338  SCLogDebug("offset %" PRIu64 " (data from offset %" PRIu64 ")", offset,
339  file_size - offset);
340  }
341  }
342 
343  } else {
344  if ((content_limit == 0 || file_size < content_limit) &&
345  file_size < content_inspect_min_size && !(flow_flags & STREAM_EOF) &&
346  !(cur_file->state > FILE_STATE_OPENED)) {
347  SCLogDebug("we still haven't seen the entire content. "
348  "Let's defer content inspection till we see the "
349  "entire content. We've seen %ld and need at least %d",
350  file_size, content_inspect_min_size);
351  goto empty_return;
352  }
353  offset = cur_file->content_inspected;
354  }
355 
356  const uint8_t *data;
357  uint32_t data_len;
358 
359  SCLogDebug("Fetching data at offset: %ld", offset);
360  StreamingBufferGetDataAtOffset(cur_file->sb, &data, &data_len, offset);
361  SCLogDebug("data_len %u", data_len);
362  /* update inspected tracker */
363  buffer->inspect_offset = offset;
364 
365  if (ips && file_size < cur_file->inspect_min_size) {
366  // don't update content_inspected yet
367  } else {
368  SCLogDebug("content inspected: %" PRIu64, cur_file->content_inspected);
369  cur_file->content_inspected = MAX(cur_file->content_inspected, offset + data_len);
370  SCLogDebug("content inspected: %" PRIu64, cur_file->content_inspected);
371  }
372 
373  InspectionBufferSetupMulti(det_ctx, buffer, NULL, data, data_len);
374  SCLogDebug("[list %d] [before] buffer offset %" PRIu64 "; buffer len %" PRIu32
375  "; data_len %" PRIu32 "; file_size %" PRIu64,
376  list_id, buffer->inspect_offset, buffer->inspect_len, data_len, file_size);
377 
378  if (f->alproto == ALPROTO_HTTP1 && flow_flags & STREAM_TOCLIENT) {
379  HtpState *htp_state = f->alstate;
380  /* built-in 'transformation' */
381  if (htp_state->cfg->swf_decompression_enabled) {
382  int swf_file_type = FileIsSwfFile(data, data_len);
383  if (swf_file_type == FILE_SWF_ZLIB_COMPRESSION ||
384  swf_file_type == FILE_SWF_LZMA_COMPRESSION) {
385  SCLogDebug("decompressing ...");
386  (void)FileSwfDecompression(data, data_len, det_ctx, buffer,
387  htp_state->cfg->swf_compression_type, htp_state->cfg->swf_decompress_depth,
388  htp_state->cfg->swf_compress_depth);
389  SCLogDebug("uncompressed buffer %p size %u; buf: \"%s\"", buffer,
390  buffer->inspect_len, (char *)buffer->inspect);
391  }
392  }
393  }
394 
395  SCLogDebug("content inspected: %" PRIu64, cur_file->content_inspected);
396 
397  /* get buffer for the list id if it is different from the base id */
398  if (list_id != base_id) {
399  SCLogDebug("regular %d has been set up: now handle xforms id %d", base_id, list_id);
400  InspectionBuffer *tbuffer = FiledataWithXformsGetDataCallback(
401  det_ctx, transforms, list_id, local_file_id, buffer);
402  SCReturnPtr(tbuffer, "InspectionBuffer");
403  }
404  SCReturnPtr(buffer, "InspectionBuffer");
405 
406 empty_return:
408  return NULL;
409 }
410 
412  const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags,
413  void *alstate, void *txv, uint64_t tx_id)
414 {
415  const DetectEngineTransforms *transforms = NULL;
416  if (!engine->mpm) {
417  transforms = engine->v2.transforms;
418  }
419 
420  AppLayerGetFileState files = AppLayerParserGetTxFiles(f, txv, flags);
421  FileContainer *ffc = files.fc;
422  if (ffc == NULL) {
424  }
425  if (ffc->head == NULL) {
426  const bool eof = (AppLayerParserGetStateProgress(f->proto, f->alproto, txv, flags) >
427  engine->progress);
428  if (eof && engine->match_on_null) {
430  }
432  }
433 
434  int local_file_id = 0;
435  File *file = ffc->head;
436  for (; file != NULL; file = file->next) {
437  InspectionBuffer *buffer = FiledataGetDataCallback(det_ctx, transforms, f, flags, file,
438  engine->sm_list, engine->sm_list_base, local_file_id, txv);
439  if (buffer == NULL)
440  continue;
441 
442  bool eof = (file->state == FILE_STATE_CLOSED);
443  uint8_t ciflags = eof ? DETECT_CI_FLAGS_END : 0;
444  if (buffer->inspect_offset == 0)
445  ciflags |= DETECT_CI_FLAGS_START;
446 
447  const bool match = DetectEngineContentInspection(de_ctx, det_ctx, s, engine->smd, NULL, f,
448  buffer->inspect, buffer->inspect_len, buffer->inspect_offset, ciflags,
450  if (match) {
452  }
453  local_file_id++;
454  }
455 
457 }
458 
459 /** \brief Filedata Filedata Mpm prefilter callback
460  *
461  * \param det_ctx detection engine thread ctx
462  * \param pectx inspection context
463  * \param p packet to inspect
464  * \param f flow to inspect
465  * \param txv tx to inspect
466  * \param idx transaction id
467  * \param flags STREAM_* flags including direction
468  */
469 static void PrefilterTxFiledata(DetectEngineThreadCtx *det_ctx, const void *pectx, Packet *p,
470  Flow *f, void *txv, const uint64_t idx, const AppLayerTxData *txd, const uint8_t flags)
471 {
472  SCEnter();
473 
474  if (!AppLayerParserHasFilesInDir(txd, flags))
475  return;
476 
477  const PrefilterMpmFiledata *ctx = (const PrefilterMpmFiledata *)pectx;
478  const MpmCtx *mpm_ctx = ctx->mpm_ctx;
479  const int list_id = ctx->list_id;
480 
481  AppLayerGetFileState files = AppLayerParserGetTxFiles(f, txv, flags);
482  FileContainer *ffc = files.fc;
483  if (ffc != NULL) {
484  int local_file_id = 0;
485  for (File *file = ffc->head; file != NULL; file = file->next) {
486  InspectionBuffer *buffer = FiledataGetDataCallback(det_ctx, ctx->transforms, f, flags,
487  file, list_id, ctx->base_list_id, local_file_id, txv);
488  if (buffer == NULL)
489  continue;
490  SCLogDebug("[%" PRIu64 "] buffer size %u", p->pcap_cnt, buffer->inspect_len);
491 
492  if (buffer->inspect_len >= mpm_ctx->minlen) {
493  uint32_t prev_rule_id_array_cnt = det_ctx->pmq.rule_id_array_cnt;
494  (void)mpm_table[mpm_ctx->mpm_type].Search(mpm_ctx, &det_ctx->mtc, &det_ctx->pmq,
495  buffer->inspect, buffer->inspect_len);
496  PREFILTER_PROFILING_ADD_BYTES(det_ctx, buffer->inspect_len);
497 
498  if (det_ctx->pmq.rule_id_array_cnt > prev_rule_id_array_cnt) {
499  SCLogDebug(
500  "%u matches", det_ctx->pmq.rule_id_array_cnt - prev_rule_id_array_cnt);
501  }
502  }
503  local_file_id++;
504  }
505  }
506 }
507 
509  const DetectBufferMpmRegistry *mpm_reg, int list_id)
510 {
511  PrefilterMpmFiledata *pectx = SCCalloc(1, sizeof(*pectx));
512  if (pectx == NULL)
513  return -1;
514  pectx->list_id = list_id;
515  pectx->base_list_id = mpm_reg->sm_list_base;
516  pectx->mpm_ctx = mpm_ctx;
517  pectx->transforms = &mpm_reg->transforms;
518 
519  return PrefilterAppendTxEngine(de_ctx, sgh, PrefilterTxFiledata,
520  mpm_reg->app_v2.alproto, mpm_reg->app_v2.tx_min_progress,
521  pectx, PrefilterMpmFiledataFree, mpm_reg->pname);
522 }
523 
524 #ifdef UNITTESTS
525 #include "tests/detect-file-data.c"
526 #endif
HtpState_::cfg
const struct HTPCfgRec_ * cfg
Definition: app-layer-htp.h:188
SMTPConfig::content_limit
uint32_t content_limit
Definition: app-layer-smtp.h:106
DetectEngineAppInspectionEngine_
Definition: detect.h:436
SigTableElmt_::url
const char * url
Definition: detect.h:1405
DetectEngineAppInspectionEngine_::mpm
bool mpm
Definition: detect.h:440
FileContainer_
Definition: util-file.h:113
MpmCtx_::mpm_type
uint8_t mpm_type
Definition: util-mpm.h:95
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1404
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:155
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
DETECT_CI_FLAGS_START
#define DETECT_CI_FLAGS_START
Definition: detect-engine-content-inspection.h:40
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1402
InspectionBuffer::initialized
bool initialized
Definition: detect.h:384
PrefilterRuleStore_::rule_id_array_cnt
uint32_t rule_id_array_cnt
Definition: util-prefilter.h:40
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1570
SIG_FLAG_INIT_FLOW
#define SIG_FLAG_INIT_FLOW
Definition: detect.h:291
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
DetectEngineTransforms
Definition: detect.h:415
DetectBufferMpmRegistry_::sm_list_base
int16_t sm_list_base
Definition: detect.h:768
HTPCfgRec_::response
HTPCfgDir response
Definition: app-layer-htp.h:116
File_::inspect_min_size
uint32_t inspect_min_size
Definition: util-file.h:104
SIG_FLAG_INIT_NEED_FLUSH
#define SIG_FLAG_INIT_NEED_FLUSH
Definition: detect.h:296
File_::size
uint64_t size
Definition: util-file.h:102
Signature_::alproto
AppProto alproto
Definition: detect.h:674
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
SIG_FLAG_INIT_FILEDATA
#define SIG_FLAG_INIT_FILEDATA
Definition: detect.h:299
Packet_::pcap_cnt
uint64_t pcap_cnt
Definition: decode.h:609
DetectEngineCtx_::filedata_config
DetectFileDataCfg * filedata_config
Definition: detect.h:1027
HTPCfgDir_::body_limit
uint32_t body_limit
Definition: app-layer-htp.h:95
SIG_FLAG_INIT_TXDIR_FAST_TOCLIENT
#define SIG_FLAG_INIT_TXDIR_FAST_TOCLIENT
Definition: detect.h:305
Flow_::proto
uint8_t proto
Definition: flow.h:378
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:85
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1422
DetectFileDataCfg
Definition: detect.h:914
AppLayerParserGetStateProgress
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *alstate, uint8_t flags)
get the progress value for a tx/protocol
Definition: app-layer-parser.c:1096
FileSwfDecompression
int FileSwfDecompression(const uint8_t *buffer, uint32_t buffer_len, DetectEngineThreadCtx *det_ctx, InspectionBuffer *out_buffer, int swf_type, uint32_t decompress_depth, uint32_t compress_depth)
This function decompresses a buffer with zlib/lzma algorithm.
Definition: util-file-decompression.c:71
InspectionBuffer
Definition: detect.h:380
threads.h
FILE_STATE_OPENED
@ FILE_STATE_OPENED
Definition: util-file.h:70
Flow_
Flow data structure.
Definition: flow.h:356
File_::state
FileState state
Definition: util-file.h:82
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:1351
DetectEngineThreadCtx_::pmq
PrefilterRuleStore pmq
Definition: detect.h:1298
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1396
ctx
struct Thresholds ctx
AppLayerParserSupportsFiles
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1182
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:920
PrefilterMpmFiledataRegister
int PrefilterMpmFiledataRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-file-data.c:508
DetectBufferTypeSupportsMultiInstance
void DetectBufferTypeSupportsMultiInstance(const char *name)
Definition: detect-engine.c:1107
SIG_FLAG_INIT_FORCE_TOCLIENT
#define SIG_FLAG_INIT_FORCE_TOCLIENT
Definition: detect.h:300
DetectEngineAppInspectionEngine_::v2
struct DetectEngineAppInspectionEngine_::@79 v2
DetectBufferMpmRegistry_
one time registration of keywords at start up
Definition: detect.h:763
detect-file-data.h
DetectEngineAppInspectionEngine_::sm_list_base
uint16_t sm_list_base
Definition: detect.h:445
FILEDATA_CONTENT_LIMIT
#define FILEDATA_CONTENT_LIMIT
Definition: app-layer-smtp.c:58
SignatureInitData_::init_flags
uint32_t init_flags
Definition: detect.h:609
HTPCfgRec_::swf_compress_depth
uint32_t swf_compress_depth
Definition: app-layer-htp.h:113
StreamingBufferGetDataAtOffset
int StreamingBufferGetDataAtOffset(const StreamingBuffer *sb, const uint8_t **data, uint32_t *data_len, uint64_t offset)
Definition: util-streaming-buffer.c:1830
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:271
MAX
#define MAX(x, y)
Definition: suricata-common.h:404
filehandler_table
DetectFileHandlerTableElmt filehandler_table[DETECT_TBLSIZE_STATIC]
Definition: detect-parse.c:87
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1387
DetectBufferMpmRegistry_::transforms
DetectEngineTransforms transforms
Definition: detect.h:776
detect-engine-prefilter.h
util-unittest.h
HtpState_
Definition: app-layer-htp.h:181
SMTPConfig::content_inspect_min_size
uint32_t content_inspect_min_size
Definition: app-layer-smtp.h:107
util-unittest-helper.h
AppLayerParserGetTxFiles
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
Definition: app-layer-parser.c:878
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1157
File_::sb
StreamingBuffer * sb
Definition: util-file.h:83
FILE_SWF_LZMA_COMPRESSION
@ FILE_SWF_LZMA_COMPRESSION
Definition: util-file-decompression.h:34
DetectEngineAppInspectionEngine_::sm_list
uint16_t sm_list
Definition: detect.h:444
DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
#define DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
Definition: detect-engine-state.h:43
PrefilterMpmFiledata::transforms
const DetectEngineTransforms * transforms
Definition: detect-file-data.h:34
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
app-layer-htp.h
InspectionBufferSetupMultiEmpty
void InspectionBufferSetupMultiEmpty(InspectionBuffer *buffer)
setup the buffer empty
Definition: detect-engine.c:1666
DetectFileDataCfg::content_inspect_min_size
uint32_t content_inspect_min_size
Definition: detect.h:916
decode.h
util-debug.h
DetectSetupDirection
int DetectSetupDirection(Signature *s, const char *str)
Parse and setup a direction.
Definition: detect-parse.c:3539
HTPCfgRec_::http_body_inline
int http_body_inline
Definition: app-layer-htp.h:108
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
g_alproto_max
AppProto g_alproto_max
Definition: app-layer-protos.c:29
DetectEngineThreadCtx_
Definition: detect.h:1197
ALPROTO_SMTP
@ ALPROTO_SMTP
Definition: app-layer-protos.h:38
detect-engine-file.h
BOOL2STR
#define BOOL2STR(b)
Definition: util-debug.h:527
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect-engine-mpm.h
FileContainer_::head
File * head
Definition: util-file.h:114
detect.h
HTPCfgRec_::swf_decompress_depth
uint32_t swf_decompress_depth
Definition: app-layer-htp.h:112
DETECT_ENGINE_INSPECT_SIG_MATCH
#define DETECT_ENGINE_INSPECT_SIG_MATCH
Definition: detect-engine-state.h:38
PrefilterMpmFiledata::mpm_ctx
const MpmCtx * mpm_ctx
Definition: detect-file-data.h:33
DetectFiledataRegister
void DetectFiledataRegister(void)
Registration function for keyword: file_data.
Definition: detect-file-data.c:71
DetectBufferMpmRegistry_::app_v2
struct DetectBufferMpmRegistry_::@87::@89 app_v2
HTPCfgRec_::swf_decompression_enabled
int swf_decompression_enabled
Definition: app-layer-htp.h:110
FILEDATA_CONTENT_INSPECT_MIN_SIZE
#define FILEDATA_CONTENT_INSPECT_MIN_SIZE
Definition: app-layer-smtp.c:60
InspectionBuffer::inspect_offset
uint64_t inspect_offset
Definition: detect.h:382
DETECT_ENGINE_CONTENT_INSPECTION_MODE_STATE
@ DETECT_ENGINE_CONTENT_INSPECTION_MODE_STATE
Definition: detect-engine-content-inspection.h:36
app-layer-parser.h
MpmCtx_::minlen
uint16_t minlen
Definition: util-mpm.h:104
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:309
smtp_config
SMTPConfig smtp_config
Definition: app-layer-smtp.c:292
util-profiling.h
PrefilterMpmFiledata::base_list_id
int base_list_id
Definition: detect-file-data.h:32
Signature_::flags
uint32_t flags
Definition: detect.h:670
Packet_
Definition: decode.h:484
DETECT_CI_FLAGS_END
#define DETECT_CI_FLAGS_END
Definition: detect-engine-content-inspection.h:42
DetectEngineAppInspectionEngine_::match_on_null
bool match_on_null
Definition: detect.h:443
DetectFileDataCfg::content_limit
uint32_t content_limit
Definition: detect.h:915
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:748
SCReturnPtr
#define SCReturnPtr(x, type)
Definition: util-debug.h:287
FileIsSwfFile
int FileIsSwfFile(const uint8_t *buffer, uint32_t buffer_len)
Definition: util-file-decompression.c:41
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
AppLayerHtpEnableResponseBodyCallback
void AppLayerHtpEnableResponseBodyCallback(void)
Sets a flag that informs the HTP app layer that some module in the engine needs the http request body...
Definition: app-layer-htp.c:583
DetectFileHandlerTableElmt_::priority
int priority
Definition: detect-parse.h:34
HTPCfgRec_::swf_compression_type
HtpSwfCompressType swf_compression_type
Definition: app-layer-htp.h:111
MpmTableElmt_::Search
uint32_t(* Search)(const struct MpmCtx_ *, struct MpmThreadCtx_ *, PrefilterRuleStore *, const uint8_t *, uint32_t)
Definition: util-mpm.h:177
DETECT_FILE_DATA
@ DETECT_FILE_DATA
Definition: detect-engine-register.h:201
DetectEngineThreadCtx_::mtc
MpmThreadCtx mtc
Definition: detect.h:1294
FileDataSize
uint64_t FileDataSize(const File *file)
get the size of the file data
Definition: util-file.c:326
detect-engine-content-inspection.h
DetectEngineAppInspectionEngine_::smd
SigMatchData * smd
Definition: detect.h:458
File_::content_inspected
uint64_t content_inspected
Definition: util-file.h:99
FILE_STATE_CLOSED
@ FILE_STATE_CLOSED
Definition: util-file.h:71
File_
Definition: util-file.h:79
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1466
PREFILTER_PROFILING_ADD_BYTES
#define PREFILTER_PROFILING_ADD_BYTES(det_ctx, bytes)
Definition: util-profiling.h:286
flags
uint8_t flags
Definition: decode-gre.h:0
Signature_::proto
DetectProto proto
Definition: detect.h:688
SigTableElmt_::alias
const char * alias
Definition: detect.h:1403
suricata-common.h
SIG_FLAG_INIT_FORCE_TOSERVER
#define SIG_FLAG_INIT_FORCE_TOSERVER
Definition: detect.h:301
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:36
File_::next
struct File_ * next
Definition: util-file.h:92
DetectFileHandlerTableElmt_::PrefilterFn
PrefilterRegisterFunc PrefilterFn
Definition: detect-parse.h:35
util-spm-bm.h
PrefilterAppendTxEngine
int PrefilterAppendTxEngine(DetectEngineCtx *de_ctx, SigGroupHead *sgh, PrefilterTxFn PrefilterTxFunc, AppProto alproto, int tx_min_progress, void *pectx, void(*FreeFunc)(void *pectx), const char *name)
Definition: detect-engine-prefilter.c:352
DETECT_ENGINE_INSPECT_SIG_NO_MATCH
#define DETECT_ENGINE_INSPECT_SIG_NO_MATCH
Definition: detect-engine-state.h:37
DetectEngineAppInspectionEngine_::progress
int16_t progress
Definition: detect.h:446
SIGMATCH_OPTIONAL_OPT
#define SIGMATCH_OPTIONAL_OPT
Definition: detect.h:1601
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
SIG_FLAG_INIT_TXDIR_STREAMING_TOSERVER
#define SIG_FLAG_INIT_TXDIR_STREAMING_TOSERVER
Definition: detect.h:303
InspectionBuffer::inspect_len
uint32_t inspect_len
Definition: detect.h:383
DetectFiledataRegisterTests
void DetectFiledataRegisterTests(void)
Definition: detect-file-data.c:64
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:381
str
#define str(s)
Definition: suricata-common.h:300
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SCFree
#define SCFree(p)
Definition: util-mem.h:61
Flow_::alstate
void * alstate
Definition: flow.h:479
Signature_::id
uint32_t id
Definition: detect.h:714
FILE_SWF_ZLIB_COMPRESSION
@ FILE_SWF_ZLIB_COMPRESSION
Definition: util-file-decompression.h:33
detect-parse.h
Signature_
Signature container.
Definition: detect.h:669
AppLayerGetProtoName
const char * AppLayerGetProtoName(AppProto alproto)
Given the internal protocol id, returns a string representation of the protocol.
Definition: app-layer.c:1008
DetectEngineAppInspectionEngine_::transforms
const DetectEngineTransforms * transforms
Definition: detect.h:455
util-file-decompression.h
ALPROTO_HTTP
@ ALPROTO_HTTP
Definition: app-layer-protos.h:75
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
File_::inspect_window
uint32_t inspect_window
Definition: util-file.h:103
mpm_table
MpmTableElmt mpm_table[MPM_TABLE_SIZE]
Definition: util-mpm.c:47
DetectFileHandlerTableElmt_::Callback
InspectEngineFuncPtr Callback
Definition: detect-parse.h:36
DetectEngineThreadCtx_::de_ctx
DetectEngineCtx * de_ctx
Definition: detect.h:1313
InspectionBufferMultipleForListGet
InspectionBuffer * InspectionBufferMultipleForListGet(DetectEngineThreadCtx *det_ctx, const int list_id, const uint32_t local_id)
for a InspectionBufferMultipleForList get a InspectionBuffer
Definition: detect-engine.c:1598
DetectFileHandlerTableElmt_::name
const char * name
Definition: detect-parse.h:33
app-layer-smtp.h
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1254
PrefilterMpmFiledata
Definition: detect-file-data.h:30
MpmCtx_
Definition: util-mpm.h:93
flow.h
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:733
detect-file-data.c
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:450
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
PrefilterMpmFiledata::list_id
int list_id
Definition: detect-file-data.h:31
flow-var.h
InspectionBufferSetupMulti
void InspectionBufferSetupMulti(DetectEngineThreadCtx *det_ctx, InspectionBuffer *buffer, const DetectEngineTransforms *transforms, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1679
DetectEngineInspectFiledata
uint8_t DetectEngineInspectFiledata(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags, void *alstate, void *txv, uint64_t tx_id)
Definition: detect-file-data.c:411
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1394
app-layer.h
DetectProtoContainsProto
int DetectProtoContainsProto(const DetectProto *dp, int proto)
see if a DetectProto contains a certain proto
Definition: detect-engine-proto.c:135
DetectBufferMpmRegistry_::pname
char pname[32]
Definition: detect.h:765