suricata
detect-filemagic.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 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 #include "detect-content.h"
32 
33 #include "detect-engine.h"
34 #include "detect-engine-mpm.h"
37 #include "detect-engine-file.h"
38 
39 #include "flow.h"
40 #include "flow-var.h"
41 #include "flow-util.h"
42 
43 #include "util-debug.h"
44 #include "util-spm-bm.h"
45 #include "util-magic.h"
46 #include "util-print.h"
47 
48 #include "util-unittest.h"
49 #include "util-unittest-helper.h"
50 #include "util-profiling.h"
51 
52 #include "app-layer.h"
53 #include "app-layer-parser.h"
54 
55 #include "stream-tcp.h"
56 
57 #include "detect-file-data.h"
58 #include "detect-filemagic.h"
59 
60 #include "conf.h"
61 
62 #ifndef HAVE_MAGIC
63 
64 static int DetectFilemagicSetupNoSupport (DetectEngineCtx *de_ctx, Signature *s, const char *str)
65 {
66  SCLogError("no libmagic support built in, needed for filemagic keyword");
67  return -1;
68 }
69 
70 /**
71  * \brief Registration function for keyword: filemagic
72  */
74 {
75  sigmatch_table[DETECT_FILEMAGIC].name = "filemagic";
76  sigmatch_table[DETECT_FILEMAGIC].desc = "match on the information libmagic returns about a file";
77  sigmatch_table[DETECT_FILEMAGIC].url = "/rules/file-keywords.html#filemagic";
78  sigmatch_table[DETECT_FILEMAGIC].Setup = DetectFilemagicSetupNoSupport;
80 }
81 
82 #else /* HAVE_MAGIC */
83 
84 typedef struct DetectFilemagicThreadData {
85  magic_t ctx;
86 } DetectFilemagicThreadData;
87 
88 static int DetectFilemagicSetup(DetectEngineCtx *, Signature *, const char *);
89 static int g_file_match_list_id = 0;
90 
91 static int DetectFilemagicSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str);
92 static int g_file_magic_buffer_id = 0;
93 
94 static int PrefilterMpmFilemagicRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh,
95  MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id);
96 static uint8_t DetectEngineInspectFilemagic(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx,
97  const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags,
98  void *alstate, void *txv, uint64_t tx_id);
99 
100 /**
101  * \brief Registration function for keyword: filemagic
102  */
103 void DetectFilemagicRegister(void)
104 {
105  sigmatch_table[DETECT_FILEMAGIC].name = "filemagic";
106  sigmatch_table[DETECT_FILEMAGIC].desc = "match on the information libmagic returns about a file";
107  sigmatch_table[DETECT_FILEMAGIC].url = "/rules/file-keywords.html#filemagic";
108  sigmatch_table[DETECT_FILEMAGIC].Setup = DetectFilemagicSetup;
111 
112  sigmatch_table[DETECT_FILE_MAGIC].name = "file.magic";
113  sigmatch_table[DETECT_FILE_MAGIC].desc = "sticky buffer to match on the file magic";
114  sigmatch_table[DETECT_FILE_MAGIC].url = "/rules/file-keywords.html#filemagic";
115  sigmatch_table[DETECT_FILE_MAGIC].Setup = DetectFilemagicSetupSticky;
117 
118  filehandler_table[DETECT_FILE_MAGIC].name = "file.magic",
120  filehandler_table[DETECT_FILE_MAGIC].PrefilterFn = PrefilterMpmFilemagicRegister;
121  filehandler_table[DETECT_FILE_MAGIC].Callback = DetectEngineInspectFilemagic;
122 
123  g_file_match_list_id = DetectBufferTypeRegister("files");
124 
125  DetectBufferTypeSetDescriptionByName("file.magic", "file magic");
127 
128  g_file_magic_buffer_id = DetectBufferTypeGetByName("file.magic");
129  SCLogDebug("registering filemagic rule option");
130 }
131 
132 #define FILEMAGIC_MIN_SIZE 512
133 
134 /**
135  * \brief run the magic check
136  *
137  * \param file the file
138  *
139  * \retval -1 error
140  * \retval 0 ok
141  */
142 int FilemagicThreadLookup(magic_t *ctx, File *file)
143 {
144  if (ctx == NULL || file == NULL || FileDataSize(file) == 0) {
145  SCReturnInt(-1);
146  }
147 
148  const uint8_t *data = NULL;
149  uint32_t data_len = 0;
150  uint64_t offset = 0;
151 
153  &data, &data_len, &offset);
154  if (offset == 0) {
155  if (FileDataSize(file) >= FILEMAGIC_MIN_SIZE) {
156  file->magic = MagicThreadLookup(ctx, data, data_len);
157  } else if (file->state >= FILE_STATE_CLOSED) {
158  file->magic = MagicThreadLookup(ctx, data, data_len);
159  }
160  }
161  SCReturnInt(0);
162 }
163 
164 static void *DetectFilemagicThreadInit(void *data /*@unused@*/)
165 {
166  DetectFilemagicThreadData *t = SCCalloc(1, sizeof(DetectFilemagicThreadData));
167  if (unlikely(t == NULL)) {
168  SCLogError("couldn't alloc ctx memory");
169  return NULL;
170  }
171 
172  t->ctx = MagicInitContext();
173  if (t->ctx == NULL)
174  goto error;
175 
176  return (void *)t;
177 
178 error:
179  if (t->ctx)
180  magic_close(t->ctx);
181  SCFree(t);
182  return NULL;
183 }
184 
185 static void DetectFilemagicThreadFree(void *ctx)
186 {
187  if (ctx != NULL) {
188  DetectFilemagicThreadData *t = (DetectFilemagicThreadData *)ctx;
189  if (t->ctx)
190  magic_close(t->ctx);
191  SCFree(t);
192  }
193 }
194 
195 /**
196  * \brief this function is used to parse filemagic options
197  * \brief into the current signature
198  *
199  * \param de_ctx pointer to the Detection Engine Context
200  * \param s pointer to the Current Signature
201  * \param str pointer to the user provided "filemagic" option
202  *
203  * \retval 0 on Success
204  * \retval -1 on Failure
205  */
206 static int DetectFilemagicSetup (DetectEngineCtx *de_ctx, Signature *s, const char *str)
207 {
208  if (s->init_data->transforms.cnt) {
209  SCLogError("previous transforms not consumed before 'filemagic'");
210  SCReturnInt(-1);
211  }
214 
215  if (DetectContentSetup(de_ctx, s, str) < 0) {
216  return -1;
217  }
218 
220  if (sm == NULL)
221  return -1;
222 
224  if (DetectContentConvertToNocase(de_ctx, cd) != 0)
225  return -1;
227  de_ctx, s, NULL, DETECT_FILE_MAGIC, g_file_magic_buffer_id, s->alproto) < 0)
228  return -1;
229 
230  if (de_ctx->filemagic_thread_ctx_id == -1) {
232  de_ctx, "filemagic", DetectFilemagicThreadInit, NULL, DetectFilemagicThreadFree, 1);
233  if (de_ctx->filemagic_thread_ctx_id == -1)
234  return -1;
235  }
236  return 0;
237 }
238 
239 /* file.magic implementation */
240 
241 /**
242  * \brief this function setup the file.magic keyword used in the rule
243  *
244  * \param de_ctx Pointer to the Detection Engine Context
245  * \param s Pointer to the Signature to which the current keyword belongs
246  * \param str Should hold an empty string always
247  *
248  * \retval 0 On success
249  */
250 static int DetectFilemagicSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
251 {
252  if (DetectSetupDirection(s, str) < 0) {
253  SCLogError("file.magic failed to setup direction");
254  return -1;
255  }
256  if (DetectBufferSetActiveList(de_ctx, s, g_file_magic_buffer_id) < 0)
257  return -1;
258 
259  if (de_ctx->filemagic_thread_ctx_id == -1) {
261  de_ctx, "filemagic", DetectFilemagicThreadInit, NULL, DetectFilemagicThreadFree, 1);
262  if (de_ctx->filemagic_thread_ctx_id == -1)
263  return -1;
264  }
265  return 0;
266 }
267 
268 static InspectionBuffer *FilemagicGetDataCallback(DetectEngineThreadCtx *det_ctx,
269  const DetectEngineTransforms *transforms, Flow *f, uint8_t flow_flags, File *cur_file,
270  int list_id, int local_file_id)
271 {
272  SCEnter();
273 
274  InspectionBuffer *buffer = InspectionBufferMultipleForListGet(det_ctx, list_id, local_file_id);
275  if (buffer == NULL)
276  return NULL;
277  if (buffer->initialized)
278  return buffer;
279 
280  if (cur_file->magic == NULL) {
281  DetectFilemagicThreadData *tfilemagic =
282  (DetectFilemagicThreadData *)DetectThreadCtxGetKeywordThreadCtx(
283  det_ctx, det_ctx->de_ctx->filemagic_thread_ctx_id);
284  if (tfilemagic == NULL) {
286  return NULL;
287  }
288 
289  FilemagicThreadLookup(&tfilemagic->ctx, cur_file);
290  }
291  if (cur_file->magic == NULL) {
292  return NULL;
293  }
294 
295  const uint8_t *data = (const uint8_t *)cur_file->magic;
296  uint32_t data_len = (uint32_t)strlen(cur_file->magic);
297 
298  InspectionBufferSetupMulti(det_ctx, buffer, transforms, data, data_len);
299 
300  SCReturnPtr(buffer, "InspectionBuffer");
301 }
302 
303 static uint8_t DetectEngineInspectFilemagic(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx,
304  const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags,
305  void *alstate, void *txv, uint64_t tx_id)
306 {
307  const DetectEngineTransforms *transforms = NULL;
308  if (!engine->mpm) {
309  transforms = engine->v2.transforms;
310  }
311 
312  AppLayerGetFileState files = AppLayerParserGetTxFiles(f, txv, flags);
313  FileContainer *ffc = files.fc;
314  if (ffc == NULL || ffc->head == NULL) {
315  const bool eof = (AppLayerParserGetStateProgress(f->proto, f->alproto, txv, flags) >
316  engine->progress);
317  if (eof && engine->match_on_null) {
319  }
320  if (ffc != NULL) {
322  }
324  }
325 
327  int local_file_id = 0;
328  for (File *file = ffc->head; file != NULL; file = file->next) {
329  InspectionBuffer *buffer = FilemagicGetDataCallback(
330  det_ctx, transforms, f, flags, file, engine->sm_list, local_file_id);
331  if (buffer == NULL)
332  continue;
333 
334  const bool match = DetectEngineContentInspection(de_ctx, det_ctx, s, engine->smd, NULL, f,
335  buffer->inspect, buffer->inspect_len, buffer->inspect_offset,
337  if (match) {
339  } else {
341  }
342  local_file_id++;
343  }
344  return r;
345 }
346 
347 typedef struct PrefilterMpmFilemagic {
348  int list_id;
349  const MpmCtx *mpm_ctx;
350  const DetectEngineTransforms *transforms;
351 } PrefilterMpmFilemagic;
352 
353 /** \brief Filedata Filedata Mpm prefilter callback
354  *
355  * \param det_ctx detection engine thread ctx
356  * \param p packet to inspect
357  * \param f flow to inspect
358  * \param txv tx to inspect
359  * \param pectx inspection context
360  */
361 static void PrefilterTxFilemagic(DetectEngineThreadCtx *det_ctx, const void *pectx, Packet *p,
362  Flow *f, void *txv, const uint64_t idx, const AppLayerTxData *txd, const uint8_t flags)
363 {
364  SCEnter();
365 
366  if (!AppLayerParserHasFilesInDir(txd, flags))
367  return;
368 
369  const PrefilterMpmFilemagic *ctx = (const PrefilterMpmFilemagic *)pectx;
370  const MpmCtx *mpm_ctx = ctx->mpm_ctx;
371  const int list_id = ctx->list_id;
372 
373  AppLayerGetFileState files = AppLayerParserGetTxFiles(f, txv, flags);
374  FileContainer *ffc = files.fc;
375  if (ffc != NULL) {
376  int local_file_id = 0;
377  for (File *file = ffc->head; file != NULL; file = file->next) {
378  InspectionBuffer *buffer = FilemagicGetDataCallback(
379  det_ctx, ctx->transforms, f, flags, file, list_id, local_file_id);
380  if (buffer == NULL)
381  continue;
382 
383  if (buffer->inspect_len >= mpm_ctx->minlen) {
384  (void)mpm_table[mpm_ctx->mpm_type].Search(mpm_ctx, &det_ctx->mtc, &det_ctx->pmq,
385  buffer->inspect, buffer->inspect_len);
386  PREFILTER_PROFILING_ADD_BYTES(det_ctx, buffer->inspect_len);
387  }
388  local_file_id++;
389  }
390  }
391 }
392 
393 static void PrefilterMpmFilemagicFree(void *ptr)
394 {
395  SCFree(ptr);
396 }
397 
398 static int PrefilterMpmFilemagicRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh,
399  MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
400 {
401  PrefilterMpmFilemagic *pectx = SCCalloc(1, sizeof(*pectx));
402  if (pectx == NULL)
403  return -1;
404  pectx->list_id = list_id;
405  pectx->mpm_ctx = mpm_ctx;
406  pectx->transforms = &mpm_reg->transforms;
407 
408  return PrefilterAppendTxEngine(de_ctx, sgh, PrefilterTxFilemagic,
409  mpm_reg->app_v2.alproto, mpm_reg->app_v2.tx_min_progress,
410  pectx, PrefilterMpmFilemagicFree, mpm_reg->pname);
411 }
412 
413 #endif /* HAVE_MAGIC */
DetectEngineAppInspectionEngine_
Definition: detect.h:436
SigTableElmt_::url
const char * url
Definition: detect.h:1405
DetectEngineAppInspectionEngine_::mpm
bool mpm
Definition: detect.h:440
detect-content.h
FileContainer_
Definition: util-file.h:113
MpmCtx_::mpm_type
uint8_t mpm_type
Definition: util-mpm.h:95
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1616
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
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1402
InspectionBuffer::initialized
bool initialized
Definition: detect.h:384
stream-tcp.h
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1570
DetectThreadCtxGetKeywordThreadCtx
void * DetectThreadCtxGetKeywordThreadCtx(DetectEngineThreadCtx *det_ctx, int id)
Retrieve thread local keyword ctx by id.
Definition: detect-engine.c:3878
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
DetectEngineTransforms
Definition: detect.h:415
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:69
Signature_::alproto
AppProto alproto
Definition: detect.h:674
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
Flow_::proto
uint8_t proto
Definition: flow.h:378
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1422
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
InspectionBuffer
Definition: detect.h:380
threads.h
Flow_
Flow data structure.
Definition: flow.h:356
File_::state
FileState state
Definition: util-file.h:82
DetectEngineThreadCtx_::pmq
PrefilterRuleStore pmq
Definition: detect.h:1298
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1396
ctx
struct Thresholds ctx
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:920
DetectBufferTypeSupportsMultiInstance
void DetectBufferTypeSupportsMultiInstance(const char *name)
Definition: detect-engine.c:1107
DetectEngineAppInspectionEngine_::v2
struct DetectEngineAppInspectionEngine_::@79 v2
DetectContentConvertToNocase
int DetectContentConvertToNocase(DetectEngineCtx *de_ctx, DetectContentData *cd)
Definition: detect-content.c:766
StreamingBufferGetData
int StreamingBufferGetData(const StreamingBuffer *sb, const uint8_t **data, uint32_t *data_len, uint64_t *stream_offset)
Definition: util-streaming-buffer.c:1813
DetectBufferMpmRegistry_
one time registration of keywords at start up
Definition: detect.h:763
detect-file-data.h
DetectContentData_
Definition: detect-content.h:93
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
DetectFilemagicRegister
void DetectFilemagicRegister(void)
Registration function for keyword: filemagic.
Definition: detect-filemagic.c:73
util-unittest.h
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
DetectEngineAppInspectionEngine_::sm_list
uint16_t sm_list
Definition: detect.h:444
SIGMATCH_QUOTES_MANDATORY
#define SIGMATCH_QUOTES_MANDATORY
Definition: detect.h:1608
DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
#define DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
Definition: detect-engine-state.h:43
InspectionBufferSetupMultiEmpty
void InspectionBufferSetupMultiEmpty(InspectionBuffer *buffer)
setup the buffer empty
Definition: detect-engine.c:1666
decode.h
util-debug.h
DetectSetupDirection
int DetectSetupDirection(Signature *s, const char *str)
Parse and setup a direction.
Definition: detect-parse.c:3539
DETECT_FILE_MAGIC
@ DETECT_FILE_MAGIC
Definition: detect-engine-register.h:236
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectContentSetup
int DetectContentSetup(DetectEngineCtx *de_ctx, Signature *s, const char *contentstr)
Function to setup a content pattern.
Definition: detect-content.c:329
DetectEngineThreadCtx_
Definition: detect.h:1197
FILE_SIG_NEED_MAGIC
#define FILE_SIG_NEED_MAGIC
Definition: detect.h:321
detect-engine-file.h
SignatureInitData_::list
int list
Definition: detect.h:629
util-print.h
detect-filemagic.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect-engine-mpm.h
FileContainer_::head
File * head
Definition: util-file.h:114
detect.h
DETECT_ENGINE_INSPECT_SIG_MATCH
#define DETECT_ENGINE_INSPECT_SIG_MATCH
Definition: detect-engine-state.h:38
DETECT_FILEMAGIC
@ DETECT_FILEMAGIC
Definition: detect-engine-register.h:235
DetectBufferMpmRegistry_::app_v2
struct DetectBufferMpmRegistry_::@87::@89 app_v2
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
SigTableElmt_::alternative
uint16_t alternative
Definition: detect.h:1400
app-layer-parser.h
MpmCtx_::minlen
uint16_t minlen
Definition: util-mpm.h:104
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:359
util-profiling.h
DetectEngineContentModifierBufferSetup
int DetectEngineContentModifierBufferSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg, int sm_type, int sm_list, AppProto alproto)
Definition: detect-parse.c:222
Packet_
Definition: decode.h:484
conf.h
DetectEngineAppInspectionEngine_::match_on_null
bool match_on_null
Definition: detect.h:443
util-magic.h
SIGMATCH_HANDLE_NEGATION
#define SIGMATCH_HANDLE_NEGATION
Definition: detect.h:1612
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:748
SCReturnPtr
#define SCReturnPtr(x, type)
Definition: util-debug.h:287
DetectFileHandlerTableElmt_::priority
int priority
Definition: detect-parse.h:34
MpmTableElmt_::Search
uint32_t(* Search)(const struct MpmCtx_ *, struct MpmThreadCtx_ *, PrefilterRuleStore *, const uint8_t *, uint32_t)
Definition: util-mpm.h:177
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
DETECT_SM_LIST_NOTSET
#define DETECT_SM_LIST_NOTSET
Definition: detect.h:143
DetectEngineAppInspectionEngine_::smd
SigMatchData * smd
Definition: detect.h:458
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
DETECT_CI_FLAGS_SINGLE
#define DETECT_CI_FLAGS_SINGLE
Definition: detect-engine-content-inspection.h:49
DetectBufferTypeRegister
int DetectBufferTypeRegister(const char *name)
Definition: detect-engine.c:1093
flags
uint8_t flags
Definition: decode-gre.h:0
DetectRegisterThreadCtxFuncs
int DetectRegisterThreadCtxFuncs(DetectEngineCtx *de_ctx, const char *name, void *(*InitFunc)(void *), void *data, void(*FreeFunc)(void *), int mode)
Register Thread keyword context Funcs.
Definition: detect-engine.c:3808
suricata-common.h
Signature_::file_flags
uint8_t file_flags
Definition: detect.h:685
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
InspectionBuffer::inspect_len
uint32_t inspect_len
Definition: detect.h:383
DetectEngineCtx_::filemagic_thread_ctx_id
int filemagic_thread_ctx_id
Definition: detect.h:970
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
detect-parse.h
Signature_
Signature container.
Definition: detect.h:669
SigMatch_
a single match condition for a signature
Definition: detect.h:356
DetectEngineAppInspectionEngine_::transforms
const DetectEngineTransforms * transforms
Definition: detect.h:455
mpm_table
MpmTableElmt mpm_table[MPM_TABLE_SIZE]
Definition: util-mpm.c:47
DetectEngineTransforms::cnt
int cnt
Definition: detect.h:417
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
FILE_SIG_NEED_FILE
#define FILE_SIG_NEED_FILE
Definition: detect.h:319
DetectGetLastSMFromLists
SigMatch * DetectGetLastSMFromLists(const Signature *s,...)
Returns the sm with the largest index (added latest) from the lists passed to us.
Definition: detect-parse.c:634
DetectFileHandlerTableElmt_::name
const char * name
Definition: detect-parse.h:33
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1254
SignatureInitData_::transforms
DetectEngineTransforms transforms
Definition: detect.h:632
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
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:450
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
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
app-layer.h
DetectBufferMpmRegistry_::pname
char pname[32]
Definition: detect.h:765