suricata
detect.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2025 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  * Basic detection engine
24  */
25 
26 #include "suricata-common.h"
27 #include "suricata.h"
28 
29 #include "decode.h"
30 #include "packet.h"
31 #include "flow.h"
32 #include "stream-tcp.h"
33 #include "app-layer.h"
34 #include "app-layer-parser.h"
35 #include "app-layer-frames.h"
36 
37 #include "detect.h"
38 #include "detect-parse.h"
39 #include "detect-dsize.h"
40 #include "detect-engine.h"
41 #include "detect-engine-build.h"
42 #include "detect-engine-frame.h"
43 #include "detect-engine-profile.h"
44 
45 #include "detect-engine-alert.h"
46 #include "detect-engine-siggroup.h"
47 #include "detect-engine-address.h"
48 #include "detect-engine-proto.h"
49 #include "detect-engine-port.h"
50 #include "detect-engine-mpm.h"
51 #include "detect-engine-iponly.h"
54 #include "detect-engine-state.h"
55 #include "detect-engine-analyzer.h"
56 
57 #include "detect-engine-payload.h"
58 #include "detect-engine-event.h"
59 
60 #include "detect-filestore.h"
61 #include "detect-flowvar.h"
62 #include "detect-replace.h"
63 
64 #include "util-validate.h"
65 #include "util-detect.h"
66 #include "util-profiling.h"
67 
68 #include "action-globals.h"
69 
70 typedef struct DetectRunScratchpad {
72  const uint8_t flow_flags; /* flow/state flags: STREAM_* */
73  const bool app_decoder_events;
75  const SigGroupHead *sgh;
77 
78 /* prototypes */
79 static DetectRunScratchpad DetectRunSetup(const DetectEngineCtx *de_ctx,
80  DetectEngineThreadCtx *det_ctx, Packet *const p, Flow *const pflow,
81  const enum DetectFirewallPacketPolicies fw_pkt_policy);
82 static void DetectRunInspectIPOnly(ThreadVars *tv, const DetectEngineCtx *de_ctx,
83  DetectEngineThreadCtx *det_ctx, Flow * const pflow, Packet * const p);
84 static inline void DetectRunGetRuleGroup(const DetectEngineCtx *de_ctx,
85  Packet * const p, Flow * const pflow, DetectRunScratchpad *scratch);
86 static inline void DetectRunPrefilterPkt(ThreadVars *tv, const DetectEngineCtx *de_ctx,
87  DetectEngineThreadCtx *det_ctx, Packet *p, DetectRunScratchpad *scratch);
88 static inline uint8_t DetectRulePacketRules(ThreadVars *const tv,
89  const DetectEngineCtx *const de_ctx, DetectEngineThreadCtx *const det_ctx, Packet *const p,
90  Flow *const pflow, const DetectRunScratchpad *scratch);
91 static void DetectRunTx(ThreadVars *tv, DetectEngineCtx *de_ctx,
92  DetectEngineThreadCtx *det_ctx, Packet *p,
93  Flow *f, DetectRunScratchpad *scratch);
94 static void DetectRunFrames(ThreadVars *tv, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx,
95  Packet *p, Flow *f, DetectRunScratchpad *scratch);
96 static inline void DetectRunPostRules(ThreadVars *tv, const DetectEngineCtx *de_ctx,
97  DetectEngineThreadCtx *det_ctx, Packet *const p, Flow *const pflow,
98  DetectRunScratchpad *scratch);
99 static void DetectRunCleanup(DetectEngineThreadCtx *det_ctx,
100  Packet *p, Flow * const pflow);
101 static inline void DetectRunAppendDefaultAccept(DetectEngineThreadCtx *det_ctx, Packet *p);
102 
103 /** \internal
104  */
105 static void DetectRun(ThreadVars *th_v,
107  Packet *p)
108 {
109  SCEnter();
110  SCLogDebug("pcap_cnt %" PRIu64 " direction %s pkt_src %s", PcapPacketCntGet(p),
111  p->flow ? (FlowGetPacketDirection(p->flow, p) == TOSERVER ? "toserver" : "toclient")
112  : "noflow",
114 
115  /* Load the Packet's flow early, even though it might not be needed.
116  * Mark as a constant pointer, although the flow itself can change. */
117  Flow * const pflow = p->flow;
118 
119  DetectRunScratchpad scratch =
120  DetectRunSetup(de_ctx, det_ctx, p, pflow, DETECT_FIREWALL_POLICY_PACKET_FILTER);
121 
122  /* run the IPonly engine */
123  DetectRunInspectIPOnly(th_v, de_ctx, det_ctx, pflow, p);
124 
125  /* get our rule group */
126  DetectRunGetRuleGroup(de_ctx, p, pflow, &scratch);
127  /* if we didn't get a sig group head, we
128  * have nothing to do.... */
129  if (scratch.sgh == NULL) {
130  if (!EngineModeIsFirewall()) {
131  SCLogDebug("no sgh for this packet, nothing to match against");
132  goto end;
133  }
134  SCLogDebug(
135  "packet %" PRIu64 ": no sgh, need to apply default policies", PcapPacketCntGet(p));
136  } else {
137  /* run the prefilters for packets */
138  DetectRunPrefilterPkt(th_v, de_ctx, det_ctx, p, &scratch);
139  }
141  /* inspect the rules against the packet */
142  const uint8_t pkt_policy = DetectRulePacketRules(th_v, de_ctx, det_ctx, p, pflow, &scratch);
144  SCLogDebug("packet %" PRIu64 ": pkt_policy %02x (p->action %02x)", PcapPacketCntGet(p),
145  pkt_policy, p->action);
146 
147  /* Only FW rules will already have set the action, IDS rules go through PacketAlertFinalize
148  *
149  * If rules told us to drop or accept:packet/accept:flow, we skip app_filter and app_td.
150  *
151  * accept:hook won't have set the pkt_policy, so we simply continue.
152  *
153  * TODO what about app state progression, cleanup and such? */
154  if (pkt_policy & (ACTION_DROP | ACTION_ACCEPT)) {
155  goto end;
156  }
157 
158  /* run tx/state inspection. Don't call for ICMP error msgs. */
159  if (pflow && pflow->alstate && likely(pflow->proto == p->proto)) {
160  if (p->proto == IPPROTO_TCP) {
161  if ((p->flags & PKT_STREAM_EST) == 0) {
162  SCLogDebug("packet %" PRIu64 ": skip tcp non-established", PcapPacketCntGet(p));
163  if (EngineModeIsFirewall()) {
164  SCLogDebug("default accept: no PKT_STREAM_EST");
165  DetectRunAppendDefaultAccept(det_ctx, p);
166  }
167  goto end;
168  }
169  const TcpSession *ssn = p->flow->protoctx;
170  bool setting_nopayload = p->flow->alparser &&
172  p->flow->alparser, APP_LAYER_PARSER_NO_INSPECTION) &&
174  // we may be right after disabling app-layer (ssh)
175  if (ssn &&
176  ((ssn->flags & STREAMTCP_FLAG_APP_LAYER_DISABLED) == 0 || setting_nopayload)) {
177  // PACKET_PROFILING_DETECT_START(p, PROF_DETECT_TX);
178  DetectRunFrames(th_v, de_ctx, det_ctx, p, pflow, &scratch);
179  // PACKET_PROFILING_DETECT_END(p, PROF_DETECT_TX);
180  }
181  // no update to transactions
182  if (!PKT_IS_PSEUDOPKT(p) && p->app_update_direction == 0 &&
183  ((PKT_IS_TOSERVER(p) && (p->flow->flags & FLOW_TS_APP_UPDATED) == 0) ||
184  (PKT_IS_TOCLIENT(p) && (p->flow->flags & FLOW_TC_APP_UPDATED) == 0))) {
185  SCLogDebug("packet %" PRIu64 ": no app-layer update", PcapPacketCntGet(p));
186  if (EngineModeIsFirewall()) {
187  SCLogDebug("default accept: no app update");
188  DetectRunAppendDefaultAccept(det_ctx, p);
189  }
190  goto end;
191  }
192  } else if (p->proto == IPPROTO_UDP) {
193  DetectRunFrames(th_v, de_ctx, det_ctx, p, pflow, &scratch);
194  }
195 
197  DetectRunTx(th_v, de_ctx, det_ctx, p, pflow, &scratch);
199  /* see if we need to increment the inspect_id and reset the de_state */
202  pflow, pflow->alparser, pflow->alstate, scratch.flow_flags, (scratch.sgh == NULL));
204  } else {
205  SCLogDebug("packet %" PRIu64 ": no flow / app-layer", PcapPacketCntGet(p));
206  if (EngineModeIsFirewall()) {
207  SCLogDebug("default accept: no flow/app");
208  DetectRunAppendDefaultAccept(det_ctx, p);
209  }
210  }
211 
212 end:
213  DetectRunPostRules(th_v, de_ctx, det_ctx, p, pflow, &scratch);
214 
215  DetectRunCleanup(det_ctx, p, pflow);
216  SCReturn;
217 }
218 
219 /** \internal
220  */
221 static void DetectRunPacketHook(ThreadVars *th_v, const DetectEngineCtx *de_ctx,
222  DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p,
223  enum DetectFirewallPacketPolicies fw_pkt_policy)
224 {
225  SCEnter();
226  SCLogDebug("pcap_cnt %" PRIu64 " direction %s pkt_src %s", PcapPacketCntGet(p),
227  p->flow ? (FlowGetPacketDirection(p->flow, p) == TOSERVER ? "toserver" : "toclient")
228  : "noflow",
230 
231  /* Load the Packet's flow early, even though it might not be needed.
232  * Mark as a constant pointer, although the flow itself can change. */
233  Flow *const pflow = p->flow;
234 
235  DetectRunScratchpad scratch = DetectRunSetup(de_ctx, det_ctx, p, pflow, fw_pkt_policy);
236  scratch.sgh = sgh;
237 
238  /* if we didn't get a sig group head, we
239  * have nothing to do.... */
240  if (scratch.sgh == NULL) {
241  SCLogDebug("no sgh for this packet, nothing to match against");
242  goto end;
243  }
244 
245  /* run the prefilters for packets */
246  DetectRunPrefilterPkt(th_v, de_ctx, det_ctx, p, &scratch);
247 
248  // PACKET_PROFILING_DETECT_START(p, PROF_DETECT_RULES); // TODO
249  /* inspect the rules against the packet */
250  const uint8_t pkt_policy = DetectRulePacketRules(th_v, de_ctx, det_ctx, p, pflow, &scratch);
251  // PACKET_PROFILING_DETECT_END(p, PROF_DETECT_RULES);
252  if (pkt_policy & (ACTION_DROP | ACTION_ACCEPT)) {
253  goto end;
254  }
255 
256 end:
257  DetectRunPostRules(th_v, de_ctx, det_ctx, p, pflow, &scratch);
258 
259  DetectRunCleanup(det_ctx, p, pflow);
260  SCReturn;
261 }
262 
263 static void DetectRunPostMatch(ThreadVars *tv,
264  DetectEngineThreadCtx *det_ctx, Packet *p,
265  const Signature *s)
266 {
267  /* run the packet match functions */
269  if (smd != NULL) {
271 
272  SCLogDebug("running match functions, sm %p", smd);
273 
274  while (1) {
276  (void)sigmatch_table[smd->type].Match(det_ctx, p, s, smd->ctx);
277  KEYWORD_PROFILING_END(det_ctx, smd->type, 1);
278  if (smd->is_last)
279  break;
280  smd++;
281  }
282  }
283 }
284 
285 /**
286  * \brief Get the SigGroupHead for a packet.
287  *
288  * \param de_ctx detection engine context
289  * \param p packet
290  *
291  * \retval sgh the SigGroupHead or NULL if non applies to the packet
292  */
294  const Packet *p)
295 {
296  SCEnter();
297  SigGroupHead *sgh = NULL;
298 
299  /* use ethernet non-IP sgh if we're ethernet but have no (valid) IP layer on top of it. */
300  if (PacketIsEthernet(p) && p->proto == 0 && de_ctx->eth_non_ip_sgh != NULL) {
301  SCLogDebug("using eth_non_ip_sgh %p", de_ctx->eth_non_ip_sgh);
302  SCReturnPtr(de_ctx->eth_non_ip_sgh, "SigGroupHead");
303  }
304 
305  /* if the packet proto is 0 (not set), we're inspecting it against
306  * the decoder events sgh we have. */
307  if (p->proto == 0 && p->events.cnt > 0) {
308  SCReturnPtr(de_ctx->decoder_event_sgh, "SigGroupHead");
309  } else if (p->proto == 0) {
310  if (!(PacketIsIPv4(p) || PacketIsIPv6(p))) {
311  /* not IP, so nothing to do */
312  SCReturnPtr(NULL, "SigGroupHead");
313  }
314  }
315 
316  /* select the flow_gh */
317  const int dir = (p->flowflags & FLOW_PKT_TOCLIENT) == 0;
318 
319  int proto = PacketGetIPProto(p);
320  if (proto == IPPROTO_TCP) {
321  DetectPort *list = de_ctx->flow_gh[dir].tcp;
322  SCLogDebug("tcp toserver %p, tcp toclient %p: going to use %p", de_ctx->flow_gh[1].tcp,
323  de_ctx->flow_gh[0].tcp, de_ctx->flow_gh[dir].tcp);
324  const uint16_t port = dir ? p->dp : p->sp;
325  SCLogDebug("tcp port %u -> %u:%u", port, p->sp, p->dp);
326  DetectPort *sghport = DetectPortLookupGroup(list, port);
327  if (sghport != NULL)
328  sgh = sghport->sh;
329  SCLogDebug("TCP list %p, port %u, direction %s, sghport %p, sgh %p", list, port,
330  dir ? "toserver" : "toclient", sghport, sgh);
331  } else if (proto == IPPROTO_UDP) {
332  DetectPort *list = de_ctx->flow_gh[dir].udp;
333  uint16_t port = dir ? p->dp : p->sp;
334  DetectPort *sghport = DetectPortLookupGroup(list, port);
335  if (sghport != NULL)
336  sgh = sghport->sh;
337  SCLogDebug("UDP list %p, port %u, direction %s, sghport %p, sgh %p", list, port,
338  dir ? "toserver" : "toclient", sghport, sgh);
339  } else {
340  sgh = de_ctx->flow_gh[dir].sgh[proto];
341  }
342 
343  SCReturnPtr(sgh, "SigGroupHead");
344 }
345 
346 static inline void DetectPrefilterCopyDeDup(
348 {
349  SigIntId *pf_ptr = det_ctx->pmq.rule_id_array;
350  uint32_t final_cnt = det_ctx->pmq.rule_id_array_cnt;
351  Signature **sig_array = de_ctx->sig_array;
352  Signature **match_array = det_ctx->match_array;
353  SigIntId previous_id = (SigIntId)-1;
354  while (final_cnt-- > 0) {
355  SigIntId id = *pf_ptr++;
356  Signature *s = sig_array[id];
357 
358  /* As the prefilter list can contain duplicates, check for that here. */
359  if (likely(id != previous_id)) {
360  *match_array++ = s;
361  previous_id = id;
362  }
363  }
364 
365  det_ctx->match_array_cnt = (uint32_t)(match_array - det_ctx->match_array);
367  PMQ_RESET(&det_ctx->pmq);
368 }
369 
370 /** \internal
371  * \brief update flow's file tracking flags based on the detection engine
372  * A set of flags is prepared that is sent to the File API. The
373  File API may reject one or more based on the global force settings.
374  */
375 static inline void
376 DetectPostInspectFileFlagsUpdate(Flow *f, const SigGroupHead *sgh, uint8_t direction)
377 {
378  uint16_t flow_file_flags = FLOWFILE_INIT;
379 
380  if (sgh == NULL) {
381  SCLogDebug("requesting disabling all file features for flow");
382  flow_file_flags = FLOWFILE_NONE;
383  } else {
384  if (sgh->filestore_cnt == 0) {
385  SCLogDebug("requesting disabling filestore for flow");
386  flow_file_flags |= (FLOWFILE_NO_STORE_TS|FLOWFILE_NO_STORE_TC);
387  }
388 #ifdef HAVE_MAGIC
389  if (!(sgh->flags & SIG_GROUP_HEAD_HAVEFILEMAGIC)) {
390  SCLogDebug("requesting disabling magic for flow");
391  flow_file_flags |= (FLOWFILE_NO_MAGIC_TS|FLOWFILE_NO_MAGIC_TC);
392  }
393 #endif
394  if (!(sgh->flags & SIG_GROUP_HEAD_HAVEFILEMD5)) {
395  SCLogDebug("requesting disabling md5 for flow");
396  flow_file_flags |= (FLOWFILE_NO_MD5_TS|FLOWFILE_NO_MD5_TC);
397  }
398  if (!(sgh->flags & SIG_GROUP_HEAD_HAVEFILESHA1)) {
399  SCLogDebug("requesting disabling sha1 for flow");
400  flow_file_flags |= (FLOWFILE_NO_SHA1_TS|FLOWFILE_NO_SHA1_TC);
401  }
402  if (!(sgh->flags & SIG_GROUP_HEAD_HAVEFILESHA256)) {
403  SCLogDebug("requesting disabling sha256 for flow");
404  flow_file_flags |= (FLOWFILE_NO_SHA256_TS|FLOWFILE_NO_SHA256_TC);
405  }
406  }
407  if (flow_file_flags != 0) {
408  FileUpdateFlowFileFlags(f, flow_file_flags, direction);
409  }
410 }
411 
412 static inline void
413 DetectRunPostGetFirstRuleGroup(const Packet *p, Flow *pflow, const SigGroupHead *sgh)
414 {
415  if ((p->flowflags & FLOW_PKT_TOSERVER) && !(pflow->flags & FLOW_SGH_TOSERVER)) {
416  /* first time we see this toserver sgh, store it */
417  pflow->sgh_toserver = sgh;
418  pflow->flags |= FLOW_SGH_TOSERVER;
419 
420  if (p->proto == IPPROTO_TCP && (sgh == NULL || !(sgh->flags & SIG_GROUP_HEAD_HAVERAWSTREAM))) {
421  if (pflow->protoctx != NULL) {
422  TcpSession *ssn = pflow->protoctx;
423  SCLogDebug("STREAMTCP_STREAM_FLAG_DISABLE_RAW ssn.client");
425  }
426  }
427 
428  DetectPostInspectFileFlagsUpdate(pflow,
429  pflow->sgh_toserver, STREAM_TOSERVER);
430 
431  } else if ((p->flowflags & FLOW_PKT_TOCLIENT) && !(pflow->flags & FLOW_SGH_TOCLIENT)) {
432  pflow->sgh_toclient = sgh;
433  pflow->flags |= FLOW_SGH_TOCLIENT;
434 
435  if (p->proto == IPPROTO_TCP && (sgh == NULL || !(sgh->flags & SIG_GROUP_HEAD_HAVERAWSTREAM))) {
436  if (pflow->protoctx != NULL) {
437  TcpSession *ssn = pflow->protoctx;
438  SCLogDebug("STREAMTCP_STREAM_FLAG_DISABLE_RAW ssn.server");
440  }
441  }
442 
443  DetectPostInspectFileFlagsUpdate(pflow,
444  pflow->sgh_toclient, STREAM_TOCLIENT);
445  }
446 }
447 
448 static inline void DetectRunGetRuleGroup(
449  const DetectEngineCtx *de_ctx,
450  Packet * const p, Flow * const pflow,
451  DetectRunScratchpad *scratch)
452 {
453  const SigGroupHead *sgh = NULL;
454 
455  if (pflow) {
456  bool use_flow_sgh = false;
457  /* Get the stored sgh from the flow (if any). Make sure we're not using
458  * the sgh for icmp error packets part of the same stream. */
459  if (PacketGetIPProto(p) == pflow->proto) { /* filter out icmp */
461  if ((p->flowflags & FLOW_PKT_TOSERVER) && (pflow->flags & FLOW_SGH_TOSERVER)) {
462  sgh = pflow->sgh_toserver;
463  SCLogDebug("sgh = pflow->sgh_toserver; => %p", sgh);
464  use_flow_sgh = true;
465  } else if ((p->flowflags & FLOW_PKT_TOCLIENT) && (pflow->flags & FLOW_SGH_TOCLIENT)) {
466  sgh = pflow->sgh_toclient;
467  SCLogDebug("sgh = pflow->sgh_toclient; => %p", sgh);
468  use_flow_sgh = true;
469  }
471  }
472 
473  if (!(use_flow_sgh)) {
477 
478  /* HACK: prevent the wrong sgh (or NULL) from being stored in the
479  * flow's sgh pointers */
480  if (PacketIsICMPv4(p) && ICMPV4_DEST_UNREACH_IS_VALID(p)) {
481  ; /* no-op */
482  } else {
483  /* store the found sgh (or NULL) in the flow to save us
484  * from looking it up again for the next packet.
485  * Also run other tasks */
486  DetectRunPostGetFirstRuleGroup(p, pflow, sgh);
487  }
488  }
489  } else { /* p->flags & PKT_HAS_FLOW */
490  /* no flow */
491 
495  }
496 
497  scratch->sgh = sgh;
498 }
499 
500 static void DetectRunInspectIPOnly(ThreadVars *tv, const DetectEngineCtx *de_ctx,
501  DetectEngineThreadCtx *det_ctx,
502  Flow * const pflow, Packet * const p)
503 {
504  if (pflow) {
506  SCLogDebug("testing against \"ip-only\" signatures");
507 
509  IPOnlyMatchPacket(tv, de_ctx, det_ctx, &de_ctx->io_ctx, p);
511  }
512  } else { /* p->flags & PKT_HAS_FLOW */
513  /* no flow */
514 
515  /* Even without flow we should match the packet src/dst */
517  IPOnlyMatchPacket(tv, de_ctx, det_ctx, &de_ctx->io_ctx, p);
519  }
520 }
521 
522 /** \internal
523  * \brief inspect the rule header: protocol, ports, etc
524  * \retval bool false if no match, true if match */
525 static inline bool DetectRunInspectRuleHeader(
526  const Packet *p, const Flow *f, const Signature *s, const uint32_t sflags)
527 {
528  /* check if this signature has a requirement for flowvars of some type
529  * and if so, if we actually have any in the flow. If not, the sig
530  * can't match and we skip it. */
531  if ((p->flags & PKT_HAS_FLOW) && (sflags & SIG_FLAG_REQUIRE_FLOWVAR)) {
532  DEBUG_VALIDATE_BUG_ON(f == NULL);
533 
534  /* no flowvars? skip this sig */
535  const bool fv = f->flowvar != NULL;
536  if (!fv) {
537  SCLogDebug("skipping sig as the flow has no flowvars and sig "
538  "has SIG_FLAG_REQUIRE_FLOWVAR flag set.");
539  return false;
540  }
541  }
542 
543  if (!(s->proto == NULL)) {
544  const uint8_t s_proto_flags = s->proto->flags;
545  /* TODO does it make sense to move these flags to s->flags? */
546  if ((s_proto_flags & DETECT_PROTO_IPV4) && !PacketIsIPv4(p)) {
547  SCLogDebug("ip version didn't match");
548  return false;
549  }
550  if ((s_proto_flags & DETECT_PROTO_IPV6) && !PacketIsIPv6(p)) {
551  SCLogDebug("ip version didn't match");
552  return false;
553  }
554  if (DetectProtoContainsProto(s->proto, PacketGetIPProto(p)) == 0) {
555  SCLogDebug("proto didn't match");
556  if (PacketIsEthernet(p) &&
557  (s_proto_flags & (DETECT_PROTO_ETHERNET | DETECT_PROTO_ARP))) {
558  SCLogDebug("checking ether/arp protocol");
559  if ((s_proto_flags & DETECT_PROTO_ARP) && !PacketIsARP(p)) {
560  return false;
561  }
562  SCLogDebug("checking eth protocol: match!");
563  } else {
564  return false;
565  }
566  }
567  }
568 
569  /* check the source & dst port in the sig */
570  if (p->proto == IPPROTO_TCP || p->proto == IPPROTO_UDP || p->proto == IPPROTO_SCTP) {
571  if (!(sflags & SIG_FLAG_DP_ANY)) {
572  if (p->flags & PKT_IS_FRAGMENT)
573  return false;
574  const DetectPort *dport = DetectPortLookupGroup(s->dp, p->dp);
575  if (dport == NULL) {
576  SCLogDebug("dport didn't match.");
577  return false;
578  }
579  }
580  if (!(sflags & SIG_FLAG_SP_ANY)) {
581  if (p->flags & PKT_IS_FRAGMENT)
582  return false;
583  const DetectPort *sport = DetectPortLookupGroup(s->sp, p->sp);
584  if (sport == NULL) {
585  SCLogDebug("sport didn't match.");
586  return false;
587  }
588  }
589  } else if ((sflags & (SIG_FLAG_DP_ANY|SIG_FLAG_SP_ANY)) != (SIG_FLAG_DP_ANY|SIG_FLAG_SP_ANY)) {
590  SCLogDebug("port-less protocol and sig needs ports");
591  return false;
592  }
593 
594  /* check the destination address */
595  if (!(sflags & SIG_FLAG_DST_ANY)) {
596  if (PacketIsIPv4(p)) {
598  return false;
599  } else if (PacketIsIPv6(p)) {
601  return false;
602  }
603  }
604  /* check the source address */
605  if (!(sflags & SIG_FLAG_SRC_ANY)) {
606  if (PacketIsIPv4(p)) {
608  return false;
609  } else if (PacketIsIPv6(p)) {
611  return false;
612  }
613  }
614 
615  return true;
616 }
617 
618 /** \internal
619  * \brief run packet/stream prefilter engines
620  */
621 static inline void DetectRunPrefilterPkt(ThreadVars *tv, const DetectEngineCtx *de_ctx,
622  DetectEngineThreadCtx *det_ctx, Packet *p, DetectRunScratchpad *scratch)
623 {
624  /* create our prefilter mask */
625  PacketCreateMask(p, &p->sig_mask, scratch->alproto, scratch->app_decoder_events);
626  /* run the prefilter engines */
627  Prefilter(det_ctx, scratch->sgh, p, scratch->flow_flags, p->sig_mask);
628  /* create match list if we have non-pf and/or pf */
629  if (det_ctx->pmq.rule_id_array_cnt) {
630 #ifdef PROFILING
631  if (tv) {
633  &tv->stats, det_ctx->counter_mpm_list, (int64_t)det_ctx->pmq.rule_id_array_cnt);
634  }
635 #endif
637  DetectPrefilterCopyDeDup(de_ctx, det_ctx);
639  }
640 }
641 
642 /** \internal
643  * \brief check if the tx whose id is given is the only one
644  * live transaction for the flow in the given direction
645  *
646  * \param f flow
647  * \param txid transaction id
648  * \param dir direction
649  *
650  * \retval bool true if we are sure this tx is the only one live in said direction
651  */
652 static bool IsOnlyTxInDirection(Flow *f, uint64_t txid, uint8_t dir)
653 {
654  uint64_t tx_cnt = AppLayerParserGetTxCnt(f, f->alstate);
655  if (tx_cnt == txid + 1) {
656  // only live tx
657  return true;
658  }
659  if (tx_cnt == txid + 2) {
660  // 2 live txs, one after us
661  void *tx = AppLayerParserGetTx(f->proto, f->alproto, f->alstate, txid + 1);
662  if (tx) {
664  // test if the other tx is unidirectional in the other way
665  if ((dir == STREAM_TOSERVER && (txd->flags & APP_LAYER_TX_SKIP_INSPECT_TS)) ||
666  (dir == STREAM_TOCLIENT && (txd->flags & APP_LAYER_TX_SKIP_INSPECT_TC))) {
667  return true;
668  }
669  }
670  }
671  return false;
672 }
673 
674 static int SortHelper(const void *a, const void *b)
675 {
676  const Signature *sa = *(const Signature **)a;
677  const Signature *sb = *(const Signature **)b;
678  if (sa->iid == sb->iid)
679  return 0;
680  return sa->iid > sb->iid ? 1 : -1;
681 }
682 
683 static inline bool SkipFwRules(const Packet *p)
684 {
685  if (p->flow != NULL) {
686  return (p->flow->flags & FLOW_ACTION_ACCEPT) != 0;
687  }
688  return false;
689 }
690 
691 /**
692  * \internal
693  * \brief apply packet default policy
694  * \param[in] de_ctx detect engine, for looking up the policy
695  * \param[in] policy policy to apply
696  * \param[in] p packet to apply policy to
697  * \param[in] final see if we need to apply accept:hook to the packet
698  * \retval action action to immediately apply, accept:hook will not set this unless final is true
699  *
700  * If this is run from the post-match final check, we need to apply a
701  * packet:filter accept:hook to the packet as well.
702  */
703 static uint8_t DetectRunApplyPacketPolicy(const DetectEngineCtx *de_ctx,
704  DetectEngineThreadCtx *det_ctx, const enum DetectFirewallPacketPolicies policy, Packet *p,
705  const bool final)
706 {
708  const struct DetectFirewallPolicy *pol = &de_ctx->fw_policies->pkt[policy];
709  if (pol->action & ACTION_DROP) {
710  SCLogDebug("packet %" PRIu64 ": drop PKT_DROP_REASON_FW_DEFAULT_PACKET_POLICY",
713  } else if (pol->action & ACTION_ACCEPT) {
714  SCLogDebug("packet %" PRIu64 ": accept", PcapPacketCntGet(p));
715  if (pol->action_scope == ACTION_SCOPE_PACKET) {
716  p->action |= pol->action;
717  SCLogDebug("packet %" PRIu64 ": accept scope packet", PcapPacketCntGet(p));
718  } else if (pol->action_scope == ACTION_SCOPE_HOOK) {
719  SCLogDebug("packet %" PRIu64 ": accept scope hook", PcapPacketCntGet(p));
720  if (final) {
721  p->action |= pol->action;
722  SCLogDebug("packet %" PRIu64 ": accept scope hook upgraded to packet",
724  }
725  } else if (pol->action_scope == ACTION_SCOPE_FLOW) {
726  p->action |= pol->action;
727  SCLogDebug("packet %" PRIu64 ": accept scope flow", PcapPacketCntGet(p));
728  if (p->flow) {
730  }
731  } else {
732  /* should be unreachable */
734  }
735  } else {
736  /* should be unreachable */
738  }
740  if (s != NULL) {
742  }
743  return p->action;
744 }
745 
746 /** \internal
747  * \brief helper for appending a packet alert
748  * Tries to find (guess) a TX to add to the alert.
749  */
750 static void DetectRulePacketAppendAlert(const DetectEngineCtx *de_ctx,
751  DetectEngineThreadCtx *det_ctx, const Signature *s, Packet *p, Flow *f,
752  const uint8_t alert_flags_in)
753 {
755 
756  if (f && f->alstate) {
757  const uint8_t dir = (p->flowflags & FLOW_PKT_TOCLIENT) ? STREAM_TOCLIENT : STREAM_TOSERVER;
758  const uint64_t tx_id = AppLayerParserGetTransactionInspectId(f->alparser, dir);
759  if ((s->alproto != ALPROTO_UNKNOWN && f->proto == IPPROTO_UDP) ||
760  (de_ctx->guess_applayer && IsOnlyTxInDirection(f, tx_id, dir))) {
761  // if there is a UDP specific app-layer signature,
762  // or only one live transaction
763  // try to use the good tx for the packet direction
764  void *tx_ptr = AppLayerParserGetTx(f->proto, f->alproto, f->alstate, tx_id);
765  AppLayerTxData *txd =
766  tx_ptr ? AppLayerParserGetTxData(f->proto, f->alproto, tx_ptr) : NULL;
768  uint8_t alert_flags = alert_flags_in;
769  if (f->proto != IPPROTO_UDP) {
770  alert_flags |= PACKET_ALERT_FLAG_TX_GUESSED;
771  }
773  AlertQueueAppendAppTxFromPacket(det_ctx, s, p, tx_id, txd->tx_type, alert_flags);
774  return;
775  }
776  }
777  }
778  AlertQueueAppendPacket(det_ctx, s, p, alert_flags_in);
779 }
780 
781 static inline uint8_t DetectRulePacketRules(ThreadVars *const tv,
782  const DetectEngineCtx *const de_ctx, DetectEngineThreadCtx *const det_ctx, Packet *const p,
783  Flow *const pflow, const DetectRunScratchpad *scratch)
784 {
785  uint8_t action = 0;
786  bool fw_verdict = false;
787  const bool have_fw_rules = EngineModeIsFirewall();
788  const Signature *next_s = NULL;
789 
790  /* inspect the sigs against the packet */
791  /* Prefetch the next signature. */
792  SigIntId match_cnt = det_ctx->match_array_cnt;
793 #ifdef PROFILING
794  if (tv) {
795  StatsCounterAvgAddI64(&tv->stats, det_ctx->counter_match_list, (int64_t)match_cnt);
796  }
797 #endif
798  Signature **match_array = det_ctx->match_array;
799 
800  SGH_PROFILING_RECORD(det_ctx, scratch->sgh);
801 #ifdef PROFILING
802  if (match_cnt >= de_ctx->profile_match_logging_threshold)
803  RulesDumpMatchArray(det_ctx, scratch->sgh, p);
804 #endif
805 
806  bool skip_fw = SkipFwRules(p);
807  uint32_t sflags, next_sflags = 0;
808  if (match_cnt) {
809  next_s = *match_array++;
810  next_sflags = next_s->flags;
811  }
812  while (match_cnt--) {
814  bool break_out_of_packet_filter = false;
815  uint8_t alert_flags = 0;
816 #ifdef PROFILE_RULES
817  bool smatch = false; /* signature match */
818 #endif
819  const Signature *s = next_s;
820  sflags = next_sflags;
821  if (match_cnt) {
822  next_s = *match_array++;
823  next_sflags = next_s->flags;
824  }
825 
826  SCLogDebug("packet %" PRIu64 ": inspecting signature id %" PRIu32 "", PcapPacketCntGet(p),
827  s->id);
828 
829  /* if we accept:hook'd the `packet_filter` hook, we skip the rest of the firewall rules. */
830  if (s->flags & SIG_FLAG_FIREWALL) {
831  if (skip_fw) {
832  SCLogDebug("skipping firewall rule %u", s->id);
833  goto next;
834  }
835  } else if (have_fw_rules) {
836  /* fw mode, we skip anything after the fw rules if:
837  * - flow pass is set
838  * - packet pass (e.g. exception policy) */
840  (pflow != NULL && pflow->flags & (FLOW_ACTION_PASS))) {
841  SCLogDebug("skipping firewall rule %u", s->id);
842  break_out_of_packet_filter = true;
843  goto next;
844  }
845  }
846 
847  if (s->app_inspect != NULL) {
848  goto next; // handle sig in DetectRunTx
849  }
850  if (s->frame_inspect != NULL) {
851  goto next; // handle sig in DetectRunFrame
852  }
853 
854  /* skip pkt sigs for flow end packets */
855  if ((p->flags & PKT_PSEUDO_STREAM_END) != 0 && s->type == SIG_TYPE_PKT)
856  goto next;
857 
858  /* don't run mask check for stateful rules.
859  * There we depend on prefilter */
860  if ((s->mask & p->sig_mask) != s->mask) {
861  SCLogDebug("mask mismatch %x & %x != %x", s->mask, p->sig_mask, s->mask);
862  goto next;
863  }
864 
865  if (SigDsizePrefilter(p, s, sflags))
866  goto next;
867 
868  /* if the sig has alproto and the session as well they should match */
869  if (likely(sflags & SIG_FLAG_APPLAYER)) {
870  if (s->alproto != ALPROTO_UNKNOWN && !AppProtoEquals(s->alproto, scratch->alproto)) {
871  SCLogDebug("alproto mismatch");
872  goto next;
873  }
874  }
875 
876  if (DetectRunInspectRuleHeader(p, pflow, s, sflags) == false) {
877  goto next;
878  }
879 
880  if (!DetectEnginePktInspectionRun(tv, det_ctx, s, pflow, p, &alert_flags)) {
881  goto next;
882  }
883 
884 #ifdef PROFILE_RULES
885  smatch = true;
886 #endif
887  DetectRunPostMatch(tv, det_ctx, p, s);
888 
889  DetectRulePacketAppendAlert(de_ctx, det_ctx, s, p, pflow, alert_flags);
890 
891  if (det_ctx->post_rule_work_queue.len > 0) {
892  /* run post match prefilter engines on work queue */
893  PrefilterPostRuleMatch(det_ctx, scratch->sgh, p, pflow);
894 
895  if (det_ctx->pmq.rule_id_array_cnt > 0) {
896  /* undo "prefetch" */
897  match_array--;
898  SCLogDebug("sig_array_len %u det_ctx->pmq.rule_id_array_cnt %u",
900  const Signature **r = det_ctx->replace;
901  for (uint32_t x = 0; x < match_cnt; x++) {
902  *r++ = match_array[x];
903  SCLogDebug("appended %u", match_array[x]->id);
904  }
905  /* append the prefilter results, then sort it */
906  for (uint32_t x = 0; x < det_ctx->pmq.rule_id_array_cnt; x++) {
907  SCLogDebug("adding iid %u", det_ctx->pmq.rule_id_array[x]);
908  Signature *ts = de_ctx->sig_array[det_ctx->pmq.rule_id_array[x]];
909  SCLogDebug("adding id %u", ts->id);
910  if (ts->app_inspect == NULL) {
911  *r++ = ts;
912  match_cnt++;
913  }
914  }
915  if (match_cnt > 1) {
916  qsort(det_ctx->replace, match_cnt, sizeof(Signature *), SortHelper);
917  }
918  /* rewrite match_array to include the new additions, and deduplicate
919  * while at it. */
920  Signature **m = match_array;
921  Signature *last_sig = NULL;
922  uint32_t skipped = 0;
923  for (uint32_t x = 0; x < match_cnt; x++) {
924  /* de-duplicate */
925  if (last_sig == *m) {
926  skipped++;
927  continue;
928  }
929  last_sig = *m;
930  *m++ = (Signature *)det_ctx->replace[x];
931  }
932  match_cnt -= skipped;
933  /* prefetch next */
934  next_s = *match_array++;
935  next_sflags = next_s->flags;
936  SCLogDebug("%u rules added", det_ctx->pmq.rule_id_array_cnt);
937  det_ctx->post_rule_work_queue.len = 0;
938  PMQ_RESET(&det_ctx->pmq);
939  }
940  }
941 
942  /* firewall logic in the packet:filter table:
943  * 1. firewall rules preceed the packet:td rules in the list
944  * 2. if no rule issues an accept, we drop
945  * 3. drop is immediate
946  * 4. accept:
947  * - hook: skip rest of fw rules, inspect packet:td rules
948  * - packet: immediate accept, no packet:td or app:* inspect
949  * - flow: as packet, but applied to all future packets in the
950  * flow as well
951  */
952  if (s->flags & SIG_FLAG_FIREWALL) {
953  if (s->action & (ACTION_ACCEPT)) {
954  fw_verdict = true;
955 
956  enum ActionScope as = s->action_scope;
957  if (as == ACTION_SCOPE_HOOK) {
958  /* accept:hook: jump to first TD. Implemented as:
959  * skip until the first TD rule.
960  * Don't update action as we're just continuing to the next hook. */
961  skip_fw = true;
962 
963  } else if (as == ACTION_SCOPE_PACKET) {
964  /* accept:packet: break loop, return accept */
965  action |= s->action;
966  skip_fw = true;
967 
968  } else if (as == ACTION_SCOPE_FLOW) {
969  /* accept:flow: break loop, return accept */
970  action |= s->action;
971  skip_fw = true;
972 
973  /* set immediately, as we're in hook "packet_filter" */
974  if (pflow) {
975  pflow->flags |= FLOW_ACTION_ACCEPT;
976  }
977  }
978  } else if (s->action & ACTION_DROP) {
979  /* apply a drop immediately here */
980  fw_verdict = true;
981  action |= s->action;
982  break_out_of_packet_filter = true;
983  }
984  }
985 next:
986  DetectVarProcessList(det_ctx, pflow, p);
987  DetectReplaceFree(det_ctx);
988  RULE_PROFILING_END(det_ctx, s, smatch, p);
989 
990  /* fw drop means we're done here */
991  if (break_out_of_packet_filter)
992  break;
993 
994  continue;
995  }
996 
997  /* if no rule told us to accept, and no rule explicitly dropped, we invoke the default drop
998  * policy
999  */
1000  if (have_fw_rules) {
1001  if (skip_fw || fw_verdict) {
1002  /* apply fw action */
1003  p->action |= action;
1004  } else {
1006  /* non-final call as we may have to consider app-layer still */
1007  action |= DetectRunApplyPacketPolicy(de_ctx, det_ctx, scratch->fw_pkt_policy, p, false);
1008  }
1009  }
1010  return action;
1011 }
1012 
1013 /** \internal
1014  * \param fw_pkt_policy policy to apply to packet rules
1015  */
1016 static DetectRunScratchpad DetectRunSetup(const DetectEngineCtx *de_ctx,
1017  DetectEngineThreadCtx *det_ctx, Packet *const p, Flow *const pflow,
1018  const enum DetectFirewallPacketPolicies fw_pkt_policy)
1019 {
1020  AppProto alproto = ALPROTO_UNKNOWN;
1021  uint8_t flow_flags = 0; /* flow/state flags */
1022  bool app_decoder_events = false;
1023 
1025 
1026 #ifdef UNITTESTS
1027  if (RunmodeIsUnittests()) {
1028  p->alerts.cnt = 0;
1029  p->alerts.discarded = 0;
1030  p->alerts.suppressed = 0;
1031  }
1032 #endif
1033  det_ctx->filestore_cnt = 0;
1034  det_ctx->base64_decoded_len = 0;
1035  det_ctx->raw_stream_progress = 0;
1036  det_ctx->match_array_cnt = 0;
1037  det_ctx->json_content_len = 0;
1038 
1039  det_ctx->alert_queue_size = 0;
1040  p->alerts.drop.action = 0;
1042 
1043 #ifdef DEBUG
1044  if (p->flags & PKT_STREAM_ADD) {
1045  det_ctx->pkt_stream_add_cnt++;
1046  }
1047 #endif
1048 
1049  /* grab the protocol state we will detect on */
1050  if (p->flags & PKT_HAS_FLOW) {
1051  DEBUG_VALIDATE_BUG_ON(pflow == NULL);
1052 
1053  if (p->flowflags & FLOW_PKT_TOSERVER) {
1054  flow_flags = STREAM_TOSERVER;
1055  SCLogDebug("flag STREAM_TOSERVER set");
1056  } else if (p->flowflags & FLOW_PKT_TOCLIENT) {
1057  flow_flags = STREAM_TOCLIENT;
1058  SCLogDebug("flag STREAM_TOCLIENT set");
1059  }
1060  SCLogDebug("p->flowflags 0x%02x", p->flowflags);
1061 
1062  if (p->flags & PKT_PSEUDO_STREAM_END) {
1063  flow_flags |= STREAM_EOF;
1064  SCLogDebug("STREAM_EOF set");
1065  }
1066 
1067  /* store tenant_id in the flow so that we can use it
1068  * for creating pseudo packets */
1069  if (p->tenant_id > 0 && pflow->tenant_id == 0) {
1070  pflow->tenant_id = p->tenant_id;
1071  }
1072 
1073  /* live ruleswap check for flow updates */
1074  if (pflow->de_ctx_version == 0) {
1075  /* first time this flow is inspected, set id */
1076  pflow->de_ctx_version = de_ctx->version;
1077  } else if (pflow->de_ctx_version != de_ctx->version) {
1078  /* first time we inspect flow with this de_ctx, reset */
1079  pflow->flags &= ~FLOW_SGH_TOSERVER;
1080  pflow->flags &= ~FLOW_SGH_TOCLIENT;
1081  pflow->sgh_toserver = NULL;
1082  pflow->sgh_toclient = NULL;
1083 
1084  pflow->de_ctx_version = de_ctx->version;
1085  SCGenericVarFree(pflow->flowvar);
1086  pflow->flowvar = NULL;
1087 
1089  }
1090 
1091  /* Retrieve the app layer state and protocol and the tcp reassembled
1092  * stream chunks. */
1093  if ((p->proto == IPPROTO_TCP && (p->flags & PKT_STREAM_EST)) ||
1094  (p->proto == IPPROTO_UDP) ||
1096  {
1097  /* update flow flags with knowledge on disruptions */
1098  flow_flags = FlowGetDisruptionFlags(pflow, flow_flags);
1099  alproto = SCFlowGetAppProtocol(pflow);
1100  if (p->proto == IPPROTO_TCP && pflow->protoctx &&
1103  }
1104  SCLogDebug("alproto %u", alproto);
1105  } else {
1106  SCLogDebug("packet doesn't have established flag set (proto %d)", p->proto);
1107  }
1108 
1109  app_decoder_events = AppLayerParserHasDecoderEvents(pflow->alparser);
1110  }
1111 
1112  DetectRunScratchpad pad = { alproto, flow_flags, app_decoder_events, fw_pkt_policy, NULL };
1114  return pad;
1115 }
1116 
1117 static inline void DetectRunPostRules(ThreadVars *tv, const DetectEngineCtx *de_ctx,
1118  DetectEngineThreadCtx *det_ctx, Packet *const p, Flow *const pflow,
1119  DetectRunScratchpad *scratch)
1120 {
1121  /* so now let's iterate the alerts and remove the ones after a pass rule
1122  * matched (if any). This is done inside PacketAlertFinalize() */
1123  /* PR: installed "tag" keywords are handled after the threshold inspection */
1124 
1126  PacketAlertFinalize(de_ctx, det_ctx, p);
1127  if (p->alerts.cnt > 0) {
1128  StatsCounterAddI64(&tv->stats, det_ctx->counter_alerts, (uint64_t)p->alerts.cnt);
1129  }
1130  if (p->alerts.discarded > 0) {
1132  &tv->stats, det_ctx->counter_alerts_overflow, (uint64_t)p->alerts.discarded);
1133  }
1134  if (p->alerts.firewall_discarded > 0) {
1136  (uint64_t)p->alerts.firewall_discarded);
1137  }
1138  if (p->alerts.suppressed > 0) {
1140  &tv->stats, det_ctx->counter_alerts_suppressed, (uint64_t)p->alerts.suppressed);
1141  }
1143 
1144  /* firewall: "fail" closed if we don't have an ACCEPT. This can happen
1145  * if there was no rule group. */
1146  // TODO review packet src types here
1147  if (EngineModeIsFirewall() && ((p->action & (ACTION_ACCEPT | ACTION_DROP)) == 0) &&
1148  p->pkt_src == PKT_SRC_WIRE) {
1149  SCLogDebug("packet %" PRIu64 ": default action as no verdict set %02x (pkt %s)",
1151  (void)DetectRunApplyPacketPolicy(de_ctx, det_ctx, scratch->fw_pkt_policy, p, true);
1153  }
1154 }
1155 
1156 static void DetectRunCleanup(DetectEngineThreadCtx *det_ctx,
1157  Packet *p, Flow * const pflow)
1158 {
1160  InspectionBufferClean(det_ctx);
1161 
1162  if (pflow != NULL) {
1163  /* update inspected tracker for raw reassembly */
1164  if (p->proto == IPPROTO_TCP && pflow->protoctx != NULL &&
1167  det_ctx->raw_stream_progress);
1168  }
1169  }
1171  SCReturn;
1172 }
1173 
1175  DETECT_TX_FW_FC_OK = 0, /**< continue to next rule */
1176  DETECT_TX_FW_FC_SKIP = 1, /**< skip this rule, continue to next */
1177  DETECT_TX_FW_FC_BREAK = 2, /**< break rule loop */
1178 };
1179 
1181 {
1183  det_ctx->tx_candidates = SCCalloc(size, sizeof(RuleMatchCandidateTx));
1184  if (det_ctx->tx_candidates == NULL) {
1185  FatalError("failed to allocate %" PRIu64 " bytes",
1186  (uint64_t)(size * sizeof(RuleMatchCandidateTx)));
1187  }
1188  det_ctx->tx_candidates_size = size;
1189  SCLogDebug("array initialized to %u elements (%"PRIu64" bytes)",
1190  size, (uint64_t)(size * sizeof(RuleMatchCandidateTx)));
1191 }
1192 
1194 {
1195  SCFree(det_ctx->tx_candidates);
1196  det_ctx->tx_candidates_size = 0;
1197 }
1198 
1199 /* if size >= cur_space */
1200 static inline bool RuleMatchCandidateTxArrayHasSpace(const DetectEngineThreadCtx *det_ctx,
1201  const uint32_t need)
1202 {
1203  if (det_ctx->tx_candidates_size >= need)
1204  return 1;
1205  return 0;
1206 }
1207 
1208 /* realloc */
1209 static int RuleMatchCandidateTxArrayExpand(DetectEngineThreadCtx *det_ctx, const uint32_t needed)
1210 {
1211  const uint32_t old_size = det_ctx->tx_candidates_size;
1212  uint32_t new_size = needed;
1213  void *ptmp = SCRealloc(det_ctx->tx_candidates, (new_size * sizeof(RuleMatchCandidateTx)));
1214  if (ptmp == NULL) {
1215  FatalError("failed to expand to %" PRIu64 " bytes",
1216  (uint64_t)(new_size * sizeof(RuleMatchCandidateTx)));
1217  // TODO can this be handled more gracefully?
1218  }
1219  det_ctx->tx_candidates = ptmp;
1220  det_ctx->tx_candidates_size = new_size;
1221  SCLogDebug("array expanded from %u to %u elements (%"PRIu64" bytes -> %"PRIu64" bytes)",
1222  old_size, new_size, (uint64_t)(old_size * sizeof(RuleMatchCandidateTx)),
1223  (uint64_t)(new_size * sizeof(RuleMatchCandidateTx))); (void)old_size;
1224  return 1;
1225 }
1226 
1227 /** \internal
1228  * \brief sort helper for sorting match candidates by id: ascending
1229  *
1230  * The id field is set from Signature::num, so we sort the candidates to match the signature
1231  * sort order (ascending), where candidates that have flags go first.
1232  */
1233 static int
1234 DetectRunTxSortHelper(const void *a, const void *b)
1235 {
1236  const RuleMatchCandidateTx *s0 = a;
1237  const RuleMatchCandidateTx *s1 = b;
1238  if (s1->id == s0->id) {
1239  if (s1->flags && !s0->flags)
1240  return 1;
1241  else if (!s1->flags && s0->flags)
1242  return -1;
1243  return 0;
1244  } else
1245  return s0->id > s1->id ? 1 : -1;
1246 }
1247 
1248 #if 0
1249 #define TRACE_SID_TXS(sid,txs,...) \
1250  do { \
1251  char _trace_buf[2048]; \
1252  snprintf(_trace_buf, sizeof(_trace_buf), __VA_ARGS__); \
1253  SCLogNotice("%p/%"PRIu64"/%u: %s", txs->tx_ptr, txs->tx_id, sid, _trace_buf); \
1254  } while(0)
1255 #else
1256 #define TRACE_SID_TXS(sid,txs,...)
1257 #endif
1258 
1259 /** \internal
1260  * \brief get correct transaction pointer
1261  *
1262  * Gets an encapsulated DNS transaction in the DOH2 case.
1263  *
1264  * Returns NULL is the TX is not to be inspected by this engine.
1265  */
1266 void *DetectGetInnerTx(void *tx_ptr, AppProto alproto, AppProto engine_alproto, uint8_t flow_flags)
1267 {
1268  SCLogDebug("pre: tx_ptr %p flow::alproto %s engine::alproto %s", tx_ptr,
1269  AppProtoToString(alproto), AppProtoToString(engine_alproto));
1270  if (unlikely(alproto == ALPROTO_DOH2)) {
1271  switch (engine_alproto) {
1272  case ALPROTO_DOH2:
1273  /* need to get the dns tx pointer */
1274  tx_ptr = SCDoH2GetDnsTx(tx_ptr, flow_flags);
1275  break;
1276  case ALPROTO_HTTP2:
1277  case ALPROTO_UNKNOWN:
1278  /* tx_ptr is untouched, so use outer (HTTP/2) layer */
1279  break;
1280  default:
1281  /* any other protocol is a mismatch with DOH2 */
1282  tx_ptr = NULL;
1283  break;
1284  }
1285  } else if (engine_alproto != alproto && engine_alproto != ALPROTO_UNKNOWN) {
1286  /* incompatible engine->alproto with flow alproto */
1287  tx_ptr = NULL;
1288  }
1289  return tx_ptr;
1290 }
1291 
1292 /** \internal
1293  * \brief inspect a rule against a transaction
1294  *
1295  * Inspect a rule. New detection or continued stateful
1296  * detection.
1297  *
1298  * \param stored_flags pointer to stored flags or NULL.
1299  * If stored_flags is set it means we're continuing
1300  * inspection from an earlier run.
1301  *
1302  * \retval 1 sig matched
1303  * \retval 0 partial incomplete match
1304  * \retval -1 failed to match
1305  * \retval -2 no match yet, but not final: the MPM engine will revisit the
1306  * tx as it progresses. The caller must not apply a hook default
1307  * policy for it: that could decide the packet before the revisit
1308  * can turn it into a match.
1309  */
1310 static int DetectRunTxInspectRule(ThreadVars *tv, DetectEngineCtx *de_ctx,
1311  DetectEngineThreadCtx *det_ctx, Packet *p, Flow *f,
1312  const uint8_t in_flow_flags, // direction, EOF, etc
1313  void *alstate, DetectTransaction *tx, const Signature *s, uint32_t *stored_flags,
1315 {
1316  const uint8_t flow_flags = in_flow_flags;
1317  const int direction = (flow_flags & STREAM_TOSERVER) ? 0 : 1;
1318  uint32_t inspect_flags = stored_flags ? *stored_flags : 0;
1319  int total_matches = 0;
1320  uint16_t file_no_match = 0;
1321  bool mpm_before_progress = false; // is mpm engine before progress?
1322  bool mpm_in_progress = false; // is mpm engine in a buffer we will revisit?
1323 
1324  TRACE_SID_TXS(s->id, tx, "starting %s", direction ? "toclient" : "toserver");
1325 
1326  /* for a new inspection we inspect pkt header and packet matches */
1327  if (likely(stored_flags == NULL)) {
1328  TRACE_SID_TXS(s->id, tx, "first inspect, run packet matches");
1329  /* the firewall LTE coverage build already ran the same header check for
1330  * this candidate, so skip repeating it */
1331  if (!can->fw_lte_header_ok && DetectRunInspectRuleHeader(p, f, s, s->flags) == false) {
1332  TRACE_SID_TXS(s->id, tx, "DetectRunInspectRuleHeader() no match");
1333  return -1;
1334  }
1335  if (!DetectEnginePktInspectionRun(tv, det_ctx, s, f, p, NULL)) {
1336  TRACE_SID_TXS(s->id, tx, "DetectEnginePktInspectionRun no match");
1337  return -1;
1338  }
1339  /* stream mpm and negated mpm sigs can end up here with wrong proto */
1340  if (!(AppProtoEquals(s->alproto, f->alproto) || s->alproto == ALPROTO_UNKNOWN)) {
1341  TRACE_SID_TXS(s->id, tx, "alproto mismatch");
1342  return -1;
1343  }
1344  } else {
1345  TRACE_SID_TXS(s->id, tx, "continue, inspect_flags %x", inspect_flags);
1346  }
1347 
1348  const DetectEngineAppInspectionEngine *engine = s->app_inspect;
1349  do {
1350  TRACE_SID_TXS(s->id, tx, "engine %p inspect_flags %x", engine, inspect_flags);
1351 
1352  // also if it is not the same direction, but
1353  // this is a transactional signature, and we are toclient
1354  if (!(inspect_flags & BIT_U32(engine->id)) &&
1355  (direction == engine->dir || ((s->flags & SIG_FLAG_TXBOTHDIR) && direction == 1))) {
1356 
1358  AppLayerParserSupportsSubStates(engine->alproto) && engine->sub_state == 0);
1360  !AppLayerParserSupportsSubStates(engine->alproto) && engine->sub_state != 0);
1361 
1362  if (engine->alproto != ALPROTO_UNKNOWN && // app-layer-events is registered for each
1363  // proto this way
1364  tx->tx_type != engine->sub_state) {
1365  TRACE_SID_TXS(s->id, tx,
1366  "skip because engine alproto %s sub_state %u != tx_type %u (engine "
1367  "progress %u)",
1368  AppProtoToString(engine->alproto), engine->sub_state, tx->tx_type,
1369  engine->progress);
1370  engine = engine->next;
1371  continue;
1372  }
1373  TRACE_SID_TXS(s->id, tx,
1374  "inspecting engine alproto %s sub_state %u == tx_type %u (engine progress %u)",
1375  AppProtoToString(engine->alproto), engine->sub_state, tx->tx_type,
1376  engine->progress);
1377 
1378  void *tx_ptr = DetectGetInnerTx(tx->tx_ptr, f->alproto, engine->alproto, flow_flags);
1379  if (tx_ptr == NULL) {
1380  TRACE_SID_TXS(s->id, tx, "no tx_ptr after DetectGetInnerTx");
1381  if (engine->alproto != ALPROTO_UNKNOWN) {
1382  TRACE_SID_TXS(s->id, tx, "no tx_ptr skip engine");
1383  /* special case: file_data on 'alert tcp' will have engines
1384  * in the list that are not for us. */
1385  engine = engine->next;
1386  continue;
1387  } else {
1388  tx_ptr = tx->tx_ptr;
1389  }
1390  }
1391  TRACE_SID_TXS(s->id, tx, "tx_ptr %p", tx_ptr);
1392 
1393  /* engines are sorted per progress, except that the one with
1394  * mpm/prefilter enabled is first */
1395  if (tx->tx_progress < engine->progress) {
1396  SCLogDebug("tx progress %d < engine progress %d",
1397  tx->tx_progress, engine->progress);
1398  break;
1399  }
1400  if (engine->mpm) {
1401  if (tx->tx_progress > engine->progress) {
1402  TRACE_SID_TXS(s->id, tx,
1403  "engine->mpm: t->tx_progress %u > engine->progress %u, so set "
1404  "mpm_before_progress",
1405  tx->tx_progress, engine->progress);
1406  mpm_before_progress = true;
1407  } else if (tx->tx_progress == engine->progress) {
1408  TRACE_SID_TXS(s->id, tx,
1409  "engine->mpm: t->tx_progress %u == engine->progress %u, so set "
1410  "mpm_in_progress",
1411  tx->tx_progress, engine->progress);
1412  if ((p->flags & PKT_PSEUDO_DETECTLOG_FLUSH) == 0) {
1413  mpm_in_progress = true;
1414  }
1415  }
1416  }
1417 
1418  uint8_t engine_flags = flow_flags;
1419  if (direction != engine->dir) {
1420  engine_flags = flow_flags ^ (STREAM_TOCLIENT | STREAM_TOSERVER);
1421  }
1422  /* run callback: but bypass stream callback if we can */
1423  uint8_t match;
1424  if (unlikely(engine->stream && can->stream_stored)) {
1425  match = can->stream_result;
1426  TRACE_SID_TXS(s->id, tx, "stream skipped, stored result %d used instead", match);
1427  } else if (engine->v2.Callback == NULL) {
1428  /* TODO is this the cleanest way to support a non-app sig on a app hook? */
1429 
1430  if (tx->tx_progress > engine->progress) {
1431  mpm_before_progress = true; // TODO needs a new name now
1432  }
1433 
1434  /* we don't have to store a "hook" match, also don't want to keep any state to make
1435  * sure the hook gets invoked again until tx progress progresses. */
1436  if ((s->flags & SIG_FLAG_FW_HOOK_LTE) == 0 && tx->tx_progress <= engine->progress) {
1437  return 1; // DETECT_ENGINE_INSPECT_SIG_MATCH;
1438  }
1439 
1440  /* if progress > engine progress, track state to avoid additional matches */
1442  } else {
1443  KEYWORD_PROFILING_SET_LIST(det_ctx, engine->sm_list);
1444  DEBUG_VALIDATE_BUG_ON(engine->v2.Callback == NULL);
1445  match = engine->v2.Callback(
1446  de_ctx, det_ctx, engine, s, f, engine_flags, alstate, tx_ptr, tx->tx_id);
1447  TRACE_SID_TXS(s->id, tx, "engine %p match %d", engine, match);
1448  if (engine->stream) {
1449  can->stream_stored = true;
1450  can->stream_result = match;
1451  TRACE_SID_TXS(s->id, tx, "stream ran, store result %d for next tx (if any)", match);
1452  }
1453  }
1454  if (match == DETECT_ENGINE_INSPECT_SIG_MATCH) {
1455  inspect_flags |= BIT_U32(engine->id);
1456  engine = engine->next;
1457  total_matches++;
1458  continue;
1459  } else if (match == DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_FILES) {
1460  /* if the file engine matched, but indicated more
1461  * files are still in progress, we don't set inspect
1462  * flags as these would end inspection for this tx */
1463  engine = engine->next;
1464  total_matches++;
1465  continue;
1466  } else if (match == DETECT_ENGINE_INSPECT_SIG_CANT_MATCH) {
1467  inspect_flags |= DE_STATE_FLAG_SIG_CANT_MATCH;
1468  inspect_flags |= BIT_U32(engine->id);
1469  } else if (match == DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES) {
1470  inspect_flags |= DE_STATE_FLAG_SIG_CANT_MATCH;
1471  inspect_flags |= BIT_U32(engine->id);
1472  file_no_match = 1;
1473  }
1474  /* implied DETECT_ENGINE_INSPECT_SIG_NO_MATCH */
1475  if (engine->mpm && mpm_before_progress) {
1476  inspect_flags |= DE_STATE_FLAG_SIG_CANT_MATCH;
1477  inspect_flags |= BIT_U32(engine->id);
1478  }
1479  break;
1480  } else if (!(inspect_flags & BIT_U32(engine->id)) && s->flags & SIG_FLAG_TXBOTHDIR &&
1481  direction != engine->dir) {
1482  TRACE_SID_TXS(s->id, tx, "handle bidir engine");
1483 
1484  // for transactional rules, the engines on the opposite direction
1485  // are ordered by progress on the different side
1486  // so we have a two mixed-up lists, and we skip the elements
1487  if (direction == 0 && engine->next == NULL) {
1488  // do not match yet on request only
1489  break;
1490  }
1491  engine = engine->next;
1492  continue;
1493  }
1494 
1495  engine = engine->next;
1496  } while (engine != NULL);
1497  TRACE_SID_TXS(s->id, tx, "inspect_flags %x, total_matches %u, engine %p",
1498  inspect_flags, total_matches, engine);
1499 
1500  bool full_match = false;
1501  if (engine == NULL && total_matches) {
1502  inspect_flags |= DE_STATE_FLAG_FULL_INSPECT;
1503  TRACE_SID_TXS(s->id, tx, "MATCH");
1504  full_match = true;
1505  }
1506 
1507  if (stored_flags) {
1508  *stored_flags = inspect_flags;
1509  TRACE_SID_TXS(s->id, tx, "continue inspect flags %08x", inspect_flags);
1510  } else {
1511  // store... or? If tx is done we might not want to come back to this tx
1512 
1513  // also... if mpmid tracking is enabled, we won't do a sig again for this tx...
1514  TRACE_SID_TXS(s->id, tx, "start inspect flags %08x", inspect_flags);
1515  if (inspect_flags & DE_STATE_FLAG_SIG_CANT_MATCH) {
1516  if (file_no_match) {
1517  /* if we have a mismatch on a file sig, we need to keep state.
1518  * We may get another file on the same tx (for http and smtp
1519  * at least), so for a new file we need to re-eval the sig.
1520  * Thoughts / TODO:
1521  * - not for some protos that have 1 file per tx (e.g. nfs)
1522  * - maybe we only need this for file sigs that mix with
1523  * other matches? E.g. 'POST + filename', is different than
1524  * just 'filename'.
1525  */
1526  DetectRunStoreStateTx(scratch->sgh, f, tx->tx_ptr, tx->tx_id, s,
1527  inspect_flags, flow_flags, file_no_match);
1528  }
1529  } else if ((inspect_flags & DE_STATE_FLAG_FULL_INSPECT) && mpm_before_progress) {
1530  TRACE_SID_TXS(s->id, tx, "no need to store match sig, "
1531  "mpm won't trigger for it anymore");
1532 
1533  if (inspect_flags & DE_STATE_FLAG_FILE_INSPECT) {
1534  TRACE_SID_TXS(s->id, tx, "except that for new files, "
1535  "we may have to revisit anyway");
1536  DetectRunStoreStateTx(scratch->sgh, f, tx->tx_ptr, tx->tx_id, s,
1537  inspect_flags, flow_flags, file_no_match);
1538  }
1539  } else if ((inspect_flags & DE_STATE_FLAG_FULL_INSPECT) == 0 && mpm_in_progress) {
1540  TRACE_SID_TXS(s->id, tx, "no need to store no-match sig, "
1541  "mpm will revisit it");
1542  return -2; /* no match, but not final: mpm will revisit it */
1543  } else if (inspect_flags != 0 || file_no_match != 0) {
1544  TRACE_SID_TXS(s->id, tx, "storing state: flags %08x", inspect_flags);
1545  DetectRunStoreStateTx(scratch->sgh, f, tx->tx_ptr, tx->tx_id, s,
1546  inspect_flags, flow_flags, file_no_match);
1547  } else {
1548  if (inspect_flags == 0) {
1549  TRACE_SID_TXS(s->id, tx, "no match: inspect_flags %08x", inspect_flags);
1550  return -1;
1551  }
1552  }
1553  }
1554  if (full_match) {
1555  return 1;
1556  /* can't be a partial match if we're at the end state */
1557  } else if ((inspect_flags & DE_STATE_FLAG_SIG_CANT_MATCH) == 0 &&
1558  tx->tx_progress < tx->tx_end_state) {
1559  return 0;
1560  } else {
1561  return -1;
1562  }
1563 }
1564 
1565 #define NO_TX \
1566  { \
1567  NULL, 0, NULL, NULL, 0, 0, 0, 0, false, 0, \
1568  }
1569 
1570 /** \internal
1571  * \brief get a DetectTransaction object
1572  * \retval struct filled with relevant info or all nulls/0s
1573  */
1574 static DetectTransaction GetDetectTx(const uint8_t ipproto, const AppProto alproto,
1575  const uint64_t tx_id, void *tx_ptr, const uint8_t flow_flags)
1576 {
1577  AppLayerTxData *txd = AppLayerParserGetTxData(ipproto, alproto, tx_ptr);
1578  const uint8_t tx_progress =
1579  (uint8_t)AppLayerParserGetStateProgress(ipproto, alproto, tx_ptr, flow_flags);
1581 
1582  const uint8_t e_tx_end_state =
1583  AppLayerParserGetTxEndState(ipproto, alproto, tx_ptr, flow_flags);
1584  DEBUG_VALIDATE_BUG_ON(e_tx_end_state >= APP_LAYER_MAX_PROGRESS);
1585 
1586  bool updated = (flow_flags & STREAM_TOSERVER) ? txd->updated_ts : txd->updated_tc;
1587  if (!updated && tx_progress < e_tx_end_state && ((flow_flags & STREAM_EOF) == 0)) {
1588  DetectTransaction no_tx = NO_TX;
1589  return no_tx;
1590  }
1591  const uint8_t inspected_flag =
1592  (flow_flags & STREAM_TOSERVER) ? APP_LAYER_TX_INSPECTED_TS : APP_LAYER_TX_INSPECTED_TC;
1593  if (unlikely(txd->flags & inspected_flag)) {
1594  SCLogDebug("%" PRIu64 " tx already fully inspected for %s. Flags %02x", tx_id,
1595  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", txd->flags);
1596  DetectTransaction no_tx = NO_TX;
1597  return no_tx;
1598  }
1599  const uint8_t skip_flag = (flow_flags & STREAM_TOSERVER) ? APP_LAYER_TX_SKIP_INSPECT_TS
1600  : APP_LAYER_TX_SKIP_INSPECT_TC;
1601  if (unlikely(txd->flags & skip_flag)) {
1602  SCLogDebug("%" PRIu64 " tx should not be inspected in direction %s. Flags %02x", tx_id,
1603  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", txd->flags);
1604  DetectTransaction no_tx = NO_TX;
1605  return no_tx;
1606  }
1607 
1608  if (txd->tx_type != 0) {
1609  SCLogDebug("using tx_type %u", txd->tx_type);
1610  }
1611 
1612  const uint8_t detect_progress =
1613  (flow_flags & STREAM_TOSERVER) ? txd->detect_progress_ts : txd->detect_progress_tc;
1614 
1615  const int dir_int = (flow_flags & STREAM_TOSERVER) ? 0 : 1;
1616  DetectEngineState *tx_de_state = txd->de_state;
1617  DetectEngineStateDirection *tx_dir_state =
1618  tx_de_state ? &tx_de_state->dir_state[dir_int] : NULL;
1619  DetectTransaction tx = {
1620  .tx_ptr = tx_ptr,
1621  .tx_id = tx_id,
1622  .tx_data_ptr = (struct AppLayerTxData *)txd,
1623  .de_state = tx_dir_state,
1624  .detect_progress = detect_progress,
1625  .detect_progress_orig = detect_progress,
1626  .tx_progress = (uint8_t)tx_progress,
1627  .tx_end_state = e_tx_end_state,
1628  .is_last = false,
1629  .tx_type = txd->tx_type,
1630  };
1631  return tx;
1632 }
1633 
1634 static inline void StoreDetectProgress(
1635  DetectTransaction *tx, const uint8_t flow_flags, const uint8_t progress)
1636 {
1638  if (flow_flags & STREAM_TOSERVER) {
1639  txd->detect_progress_ts = progress;
1640  } else {
1641  txd->detect_progress_tc = progress;
1642  }
1643 }
1644 
1645 // Merge 'state' rules from the regular prefilter
1646 // updates array_idx on the way
1647 static inline void RuleMatchCandidateMergeStateRules(
1648  DetectEngineThreadCtx *det_ctx, uint32_t *array_idx, bool *fw_lte)
1649 {
1650  // Now, we will merge 2 sorted lists :
1651  // the one in det_ctx->tx_candidates
1652  // and the one in det_ctx->match_array
1653  // For match_array, we take only the relevant elements where s->app_inspect != NULL
1654 
1655  // Basically, we iterate at the same time over the 2 lists
1656  // comparing and taking an element from either.
1657 
1658  // Trick is to do so in place in det_ctx->tx_candidates,
1659  // so as to minimize the number of moves in det_ctx->tx_candidates.
1660  // For this, the algorithm traverses the lists in reverse order.
1661  // Otherwise, if the first element of match_array was to be put before
1662  // all tx_candidates, we would need to shift all tx_candidates
1663 
1664  // Retain the number of elements sorted in tx_candidates before merge
1665  uint32_t j = *array_idx;
1666  // First loop only counting the number of elements to add
1667  for (uint32_t i = 0; i < det_ctx->match_array_cnt; i++) {
1668  const Signature *s = det_ctx->match_array[i];
1669  if (s->app_inspect != NULL) {
1670  if (s->flags & SIG_FLAG_FW_HOOK_LTE) {
1671  *fw_lte = true;
1672  }
1673  (*array_idx)++;
1674  }
1675  }
1676  // Future number of elements in tx_candidates after merge
1677  uint32_t k = *array_idx;
1678 
1679  if (k == j) {
1680  // no new element from match_array to merge in tx_candidates
1681  return;
1682  }
1683 
1684  // variable i is for all elements of match_array (even not relevant ones)
1685  // variable j is for elements of tx_candidates before merge
1686  // variable k is for elements of tx_candidates after merge
1687  for (uint32_t i = det_ctx->match_array_cnt; i > 0;) {
1688  const Signature *s = det_ctx->match_array[i - 1];
1689  if (s->app_inspect == NULL) {
1690  // no relevant element, get the next one from match_array
1691  i--;
1692  continue;
1693  }
1694  // we have one element from match_array to merge in tx_candidates
1695  k--;
1696  if (j > 0) {
1697  // j > 0 means there is still at least one element in tx_candidates to merge
1698  const RuleMatchCandidateTx *s0 = &det_ctx->tx_candidates[j - 1];
1699  if (s->iid <= s0->id) {
1700  // get next element from previous tx_candidates
1701  j--;
1702  // take the element from tx_candidates before merge
1703  det_ctx->tx_candidates[k].s = det_ctx->tx_candidates[j].s;
1704  det_ctx->tx_candidates[k].id = det_ctx->tx_candidates[j].id;
1705  det_ctx->tx_candidates[k].fw_lte_counted = det_ctx->tx_candidates[j].fw_lte_counted;
1706  det_ctx->tx_candidates[k].fw_lte_header_ok =
1707  det_ctx->tx_candidates[j].fw_lte_header_ok;
1708  det_ctx->tx_candidates[k].flags = det_ctx->tx_candidates[j].flags;
1709  det_ctx->tx_candidates[k].stream_reset = det_ctx->tx_candidates[j].stream_reset;
1710  continue;
1711  }
1712  } // otherwise
1713  // get next element from match_array
1714  i--;
1715  // take the element from match_array
1716  det_ctx->tx_candidates[k].s = s;
1717  det_ctx->tx_candidates[k].id = s->iid;
1718  det_ctx->tx_candidates[k].fw_lte_counted = false;
1719  det_ctx->tx_candidates[k].fw_lte_header_ok = false;
1720  det_ctx->tx_candidates[k].flags = NULL;
1721  det_ctx->tx_candidates[k].stream_reset = 0;
1722  }
1723  // Even if k > 0 or j > 0, the loop is over. (Note that j == k now)
1724  // The remaining elements in tx_candidates up to k were already sorted
1725  // and come before any other element later in the list
1726 }
1727 
1734  bool last_fw_rule; /**< processing the last fw rule, so we need to eval all hooks after it. */
1735  /** det_ctx->fw_lte_cover holds the counts for this walk. The counts answer
1736  * "does another pending rule cover hook H": per hook, how many pending LTE
1737  * rules cover it (their own hook and every prior hook). Progress values
1738  * stay under APP_LAYER_MAX_PROGRESS. */
1740 };
1741 
1742 /** \internal
1743  * \brief initialize the per-thread LTE hook coverage for this walk.
1744  *
1745  * The counts live in the thread ctx so IDS traffic does not pay to clear them.
1746  * They are cleared lazily, on the first LTE rule of the walk.
1747  */
1748 static inline void DetectFwEnsureLteCoverage(
1749  DetectEngineThreadCtx *det_ctx, struct DetectFirewallAppTxState *fw_state)
1750 {
1751  if (!fw_state->fw_lte_cover_active) {
1752  memset(det_ctx->fw_lte_cover, 0, sizeof(det_ctx->fw_lte_cover));
1753  fw_state->fw_lte_cover_active = true;
1754  }
1755 }
1756 
1757 /** \internal
1758  * \brief build the per hook coverage of the pending LTE rules.
1759  *
1760  * Counts, per hook, how many pending LTE rules cover it (their own hook and
1761  * every prior hook). The candidate list is sorted, so duplicates - the state
1762  * store and the per-state registrations can both add a rule - are adjacent.
1763  */
1764 static void DetectFwBuildLteCoverage(DetectEngineThreadCtx *det_ctx, Packet *p, Flow *f,
1765  struct DetectFirewallAppTxState *fw_state, const uint32_t array_idx)
1766 {
1767  DetectFwEnsureLteCoverage(det_ctx, fw_state);
1768  for (uint32_t i = 0; i < array_idx; i++) {
1769  const Signature *s = det_ctx->tx_candidates[i].s;
1770  /* only firewall rules implement the per-state policy: a threat
1771  * detection rule using the <hook header must not count as coverage */
1772  if (!(s->flags & SIG_FLAG_FW_HOOK_LTE) || !(s->flags & SIG_FLAG_FIREWALL)) {
1773  continue;
1774  }
1775  RuleMatchCandidateTx *can = &det_ctx->tx_candidates[i];
1776  can->fw_lte_counted = false;
1777  const uint32_t *flags = can->flags;
1778  if (flags == NULL) {
1779  if (!DetectRunInspectRuleHeader(p, f, s, s->flags)) {
1780  /* an out of scope rule never covered anything */
1781  continue;
1782  }
1783  /* the walk inspects this candidate with the same arguments, so it
1784  * can skip repeating the header check */
1785  can->fw_lte_header_ok = true;
1786  }
1787  if (flags != NULL &&
1789  /* already resolved in an earlier pass */
1790  continue;
1791  }
1792  /* duplicates of the same signature (state store + per-state
1793  * registrations) are adjacent: the candidate list is sorted by id with
1794  * the flagged entry first */
1796  i > 0 && det_ctx->tx_candidates[i].id < det_ctx->tx_candidates[i - 1].id);
1797  if (i > 0 && det_ctx->tx_candidates[i - 1].s == s) {
1798  continue;
1799  }
1801  /* defensive: parse rejects this; skip it so the arrays stay in
1802  * bounds and the rule applies its own default policy */
1804  continue;
1805  }
1806  can->fw_lte_counted = true;
1807  for (uint16_t h = 0; h <= s->app_progress_hook; h++) {
1808  det_ctx->fw_lte_cover[h]++;
1809  }
1810  }
1811 }
1812 
1813 /** \internal
1814  * \brief check if a pending LTE rule other than the current one covers its hook.
1815  */
1816 static inline bool DetectFwOtherLteCoversHook(DetectEngineThreadCtx *det_ctx,
1817  const struct DetectFirewallAppTxState *fw_state, const Signature *s, const bool counted)
1818 {
1819  if (!fw_state->fw_lte_cover_active) {
1820  /* no LTE candidate in this walk, so nothing covers the hook */
1821  return false;
1822  }
1825  return false;
1826  }
1827  const uint32_t covered = det_ctx->fw_lte_cover[s->app_progress_hook];
1828  if (s->flags & SIG_FLAG_FW_HOOK_LTE) {
1829  /* an uncounted candidate (header mismatch, already retired) carries
1830  * no own count in the coverage */
1831  return covered > (counted ? 1 : 0);
1832  }
1833  return covered > 0;
1834 }
1835 
1836 /** \internal
1837  * \brief count an LTE rule appended mid-walk into the hook coverage.
1838  *
1839  * Appended candidates are the tail of the list, so duplicates cannot be
1840  * detected by adjacency like in DetectFwBuildLteCoverage().
1841  */
1842 static inline void DetectFwCountAppendedLteRule(DetectEngineThreadCtx *det_ctx, Packet *p, Flow *f,
1843  struct DetectFirewallAppTxState *fw_state, const Signature *s, const uint32_t can_idx)
1844 {
1845  if (!(s->flags & SIG_FLAG_FW_HOOK_LTE) || !(s->flags & SIG_FLAG_FIREWALL) ||
1847  !DetectRunInspectRuleHeader(p, f, s, s->flags)) {
1848  return;
1849  }
1850  for (uint32_t k = 0; k < can_idx; k++) {
1851  if (det_ctx->tx_candidates[k].s == s && det_ctx->tx_candidates[k].fw_lte_counted) {
1852  return;
1853  }
1854  }
1855  DetectFwEnsureLteCoverage(det_ctx, fw_state);
1856  for (uint16_t h = 0; h <= s->app_progress_hook; h++) {
1857  det_ctx->fw_lte_cover[h]++;
1858  }
1859  det_ctx->tx_candidates[can_idx].fw_lte_counted = true;
1860  det_ctx->tx_candidates[can_idx].fw_lte_header_ok = true;
1861 }
1862 
1863 /** \internal
1864  * \brief remove an LTE rule that resolved definitively from the hook coverage.
1865  */
1866 static void DetectFwRetireLteRule(DetectEngineThreadCtx *det_ctx, RuleMatchCandidateTx *can)
1867 {
1868  const Signature *s = can->s;
1871  return;
1872  }
1873  for (uint16_t h = 0; h <= s->app_progress_hook; h++) {
1874  /* the caller only retires counted candidates: a zero here means the
1875  * accounting is broken, not a legitimate case */
1876  DEBUG_VALIDATE_BUG_ON(det_ctx->fw_lte_cover[h] == 0);
1877  if (det_ctx->fw_lte_cover[h] > 0) {
1878  det_ctx->fw_lte_cover[h]--;
1879  }
1880  }
1881  /* the candidate no longer contributes to the counts */
1882  can->fw_lte_counted = false;
1883 }
1884 
1885 static inline void DetectRunAppendDefaultAppPolicyAlert(DetectEngineThreadCtx *det_ctx, Packet *p,
1886  const bool apply_to_packet, const DetectTransaction *tx,
1887  const struct DetectFirewallAppPolicy *ap)
1888 {
1889  if (EngineModeIsFirewall()) {
1890  const Signature *s = ap->alert_signature;
1891  BUG_ON(s == NULL);
1892  uint8_t alert_flags = apply_to_packet ? PACKET_ALERT_FLAG_APPLY_ACTION_TO_PACKET : 0;
1893  AlertQueueAppendAppTxFromPacket(det_ctx, s, p, tx->tx_id, tx->tx_type, alert_flags);
1894  }
1895 }
1896 
1897 /** \internal
1898  * \brief apply default policy
1899  * \param p packet to apply policy to
1900  * \param alproto app proto
1901  * \param progress hook / progress value to apply the policy to
1902  *
1903  * \note alproto and progress are unused right now, will be used
1904  * to look up configurable default policies later
1905  */
1906 static struct DetectFirewallPolicy DetectFirewallApplyDefaultAppPolicy(
1907  DetectEngineThreadCtx *det_ctx, const struct DetectFirewallPolicies *policies,
1908  const DetectTransaction *tx, Packet *p, const AppProto alproto, const uint8_t direction,
1909  const uint8_t progress)
1910 {
1911  const uint8_t dir_flags = direction & (STREAM_TOSERVER | STREAM_TOCLIENT);
1912 
1913  SCLogDebug("packet %" PRIu64 ": tx type %u", PcapPacketCntGet(p), tx->tx_type);
1914 
1915  const struct DetectFirewallPolicy drop_policy = { .action = ACTION_DROP,
1916  .action_scope = ACTION_SCOPE_FLOW };
1917  const struct DetectFirewallAppPolicy lookup = {
1918  .alproto = alproto, .sub_state = tx->tx_type, .progress = progress, .direction = dir_flags
1919  };
1920  const struct DetectFirewallPolicy *policy = NULL;
1921  const struct DetectFirewallAppPolicy *ap =
1922  HashTableLookup(policies->app_policies, (void *)&lookup, 0);
1923  /* table should be fully populated, so this should not be able to fail.
1924  * However as it continues to confuse tooling, at a fallback. */
1925  DEBUG_VALIDATE_BUG_ON(ap == NULL);
1926  if (likely(ap != NULL)) {
1927  policy = &ap->policy;
1928  } else {
1929  policy = &drop_policy;
1930  }
1931  if (policy->action & ACTION_DROP) {
1932  SCLogDebug("dropping packet PKT_DROP_REASON_FW_DEFAULT_APP_POLICY");
1935  SCLogDebug("dropping flow");
1936  FlowSetDropAction(p->flow, FLOW_ACTION_BY_FIREWALL);
1937  }
1938  if (policy->action & ACTION_ALERT) {
1939  DetectRunAppendDefaultAppPolicyAlert(det_ctx, p, true, tx, ap);
1940  }
1941  } else if (policy->action & ACTION_ACCEPT) {
1942  /* should the accept be applied to the packet?
1943  * ACTION_SCOPE_FLOW: yes
1944  * ACTION_SCOPE_TX: only if last_tx
1945  * ACTION_SCOPE_HOOK: only if last_tx and hook is highest available hook
1946  */
1947  const bool last_hook = progress == tx->tx_progress;
1948  bool apply_to_packet = false;
1949 
1950  switch (policy->action_scope) {
1951  case ACTION_SCOPE_FLOW:
1953  apply_to_packet = true;
1954  break;
1955  case ACTION_SCOPE_TX:
1956  tx->tx_data_ptr->flags |= APP_LAYER_TX_ACCEPT;
1957  apply_to_packet = tx->is_last;
1958  break;
1959  case ACTION_SCOPE_HOOK:
1960  apply_to_packet = tx->is_last && last_hook;
1961  break;
1962  default:
1963  /* should be unreachable */
1965  break;
1966  }
1967  SCLogDebug("packet %" PRIu64 " hook %u default policy ACCEPT, apply_to_packet:%s",
1968  PcapPacketCntGet(p), progress, BOOL2STR(apply_to_packet));
1969 
1970  if (policy->action & ACTION_ALERT) {
1971  SCLogDebug("policy alert, do the append");
1972  DetectRunAppendDefaultAppPolicyAlert(det_ctx, p, apply_to_packet, tx, ap);
1973  } else if (apply_to_packet) {
1974  SCLogDebug("default accept: last_tx");
1975  DetectRunAppendDefaultAccept(det_ctx, p);
1976  }
1977  } else {
1978  /* should be unreachable */
1980  }
1981  return *policy;
1982 }
1983 
1984 /** \internal
1985  * \brief run default policies for hook(s)
1986  *
1987  * For a range of hooks look up the policy and apply it.
1988  *
1989  * \param is_last is this tx the last we have? Used to check if an action needs to be applied to
1990  * the packet.
1991  *
1992  * \retval DETECT_TX_FW_FC_BREAK rest of rules shouldn't be inspected
1993  * \retval DETECT_TX_FW_FC_SKIP skip current firewall rule
1994  * \retval DETECT_TX_FW_FC_OK no action needed
1995  */
1996 static enum DetectTxFirewallFlowControl DetectFirewallApplyDefaultPolicies(
1997  DetectEngineThreadCtx *det_ctx, const struct DetectFirewallPolicies *policies,
1998  DetectTransaction *tx, Packet *p, const AppProto alproto, const uint8_t direction,
1999  const uint8_t start_hook, const uint8_t end_hook)
2000 {
2001  DEBUG_VALIDATE_BUG_ON(start_hook > end_hook);
2002 
2003  const bool need_verdict =
2004  tx->is_last && (end_hook == tx->tx_end_state || end_hook == tx->tx_progress);
2005  SCLogDebug("need_verdict:%s is_last:%s end_hook:%u tx->tx_end_state:%u tx->progress: %u",
2006  BOOL2STR(need_verdict), BOOL2STR(tx->is_last), end_hook, tx->tx_end_state,
2007  tx->tx_progress);
2008 
2009  for (uint8_t hook = start_hook; hook <= end_hook; hook++) {
2010  const bool apply_to_packet =
2011  tx->is_last && (hook == tx->tx_end_state || hook == tx->tx_progress);
2012 
2013  SCLogDebug("%" PRIu64 ": %s default policy for hook %u, apply_to_packet %s",
2014  PcapPacketCntGet(p), direction & STREAM_TOSERVER ? "toserver" : "toclient", hook,
2015  BOOL2STR(apply_to_packet));
2016 
2017  const struct DetectFirewallPolicy policy = DetectFirewallApplyDefaultAppPolicy(
2018  det_ctx, policies, tx, p, alproto, direction, hook);
2019  SCLogDebug("fw: hook:%u policy:%02x apply_to_packet:%s", hook, policy.action,
2020  BOOL2STR(apply_to_packet));
2021  if (policy.action & ACTION_DROP) {
2022  SCLogDebug("fw: action %02x", policy.action);
2023  return DETECT_TX_FW_FC_BREAK;
2024 
2025  } else if (policy.action & ACTION_ACCEPT) {
2026  SCLogDebug("fw: accept hook %u action %02x", hook, policy.action);
2027 
2028  /* accepting flow, so skip rest of the fw rules */
2029  if (policy.action_scope == ACTION_SCOPE_FLOW) {
2030  SCLogDebug("fw: accept flow");
2031  return DETECT_TX_FW_FC_SKIP;
2032 
2033  /* accepting flow, so skip rest of the fw rules for this tx */
2034  } else if (policy.action_scope == ACTION_SCOPE_TX) {
2035  return DETECT_TX_FW_FC_SKIP;
2036 
2037  } else if (policy.action_scope == ACTION_SCOPE_HOOK) {
2038  /* we're done */
2039  if (apply_to_packet) {
2040  return DETECT_TX_FW_FC_SKIP;
2041  }
2042  } else {
2044  }
2045  } else {
2047  }
2048  }
2049 
2050  /* if the tx progress is at end_hook state, it means the rule that called us cannot
2051  * match: it's app_progress_hook is not yet available. In this can we need to set
2052  * a default accept. This happens if we got only `accept:hook` policies. */
2053  if (need_verdict) {
2054  SCLogDebug("default accept: last tx and progress at end_hook %u", end_hook);
2055  DetectRunAppendDefaultAccept(det_ctx, p);
2056  /* break as we can't match the calling signature */
2057  return DETECT_TX_FW_FC_BREAK;
2058  }
2059 
2060  return DETECT_TX_FW_FC_OK;
2061 }
2062 
2063 /** \internal
2064  * \brief run pre-rule inspection firewall policy checks
2065  *
2066  * Check for:
2067  * - check if we're in accept:tx mode
2068  * - check for missing accept hooks
2069  * -
2070  *
2071  * \retval DETECT_TX_FW_FC_OK no action needed
2072  * \retval DETECT_TX_FW_FC_BREAK rest of rules shouldn't be inspected
2073  * \retval DETECT_TX_FW_FC_SKIP skip this rule
2074  */
2075 static enum DetectTxFirewallFlowControl DetectRunTxPreCheckFirewallPolicy(
2076  DetectEngineThreadCtx *det_ctx, Packet *p, DetectTransaction *tx, const uint8_t direction,
2077  const Signature *s, const uint32_t can_idx, const bool lte_counted,
2078  struct DetectFirewallAppTxState *fw_state)
2079 {
2080  SCLogDebug("packet %" PRIu64 ": running pre-checks before sid %u", PcapPacketCntGet(p), s->id);
2081 
2082  /* enforce skip app filter. If a prior rule caused a fw_skip_app_filter set, we will skip
2083  * each fw rule from now. Non-FW rules will just be inspected. Non-FW need to hit this
2084  * path to help put into effect the FLOW_ACTION_ACCEPT/APP_LAYER_TX_ACCEPT and call
2085  * the default policy enforcement. */
2086  if (fw_state->fw_skip_app_filter) {
2087  if ((s->flags & SIG_FLAG_FIREWALL) != 0) {
2088  return DETECT_TX_FW_FC_SKIP;
2089  } else {
2090  return DETECT_TX_FW_FC_OK;
2091  }
2092  }
2093  if (p->flow->flags & FLOW_ACTION_ACCEPT) {
2094  fw_state->fw_skip_app_filter = true;
2095  SCLogDebug("default accept due to flow accept");
2096  DetectRunAppendDefaultAccept(det_ctx, p);
2097 
2098  if (s->flags & SIG_FLAG_FIREWALL) {
2099  return DETECT_TX_FW_FC_SKIP;
2100  }
2101  }
2102  /* skip fw rules if we're in accept:tx mode */
2103  if (tx->tx_data_ptr->flags & APP_LAYER_TX_ACCEPT) {
2104  /* append a blank accept:packet action for the APP_LAYER_TX_ACCEPT,
2105  * if this is the last tx */
2106  fw_state->fw_skip_app_filter = true;
2107  const bool accept_tx_applies_to_packet = tx->is_last;
2108  if (accept_tx_applies_to_packet) {
2109  SCLogDebug("accept:tx: should be applied to the packet");
2110  DetectRunAppendDefaultAccept(det_ctx, p);
2111  }
2112 
2113  if (s->flags & SIG_FLAG_FIREWALL) {
2114  SCLogDebug("APP_LAYER_TX_ACCEPT, so skip rule");
2115  return DETECT_TX_FW_FC_SKIP;
2116  }
2117 
2118  /* threat detect rules will be inspected */
2119  return DETECT_TX_FW_FC_OK;
2120  }
2121 
2122  /* handle missing rules case */
2123  if (s->flags & SIG_FLAG_FW_HOOK_LTE) {
2124  SCLogDebug("SIG_FLAG_FW_HOOK_LTE");
2125  return DETECT_TX_FW_FC_OK; // TODO check for other cases
2126  }
2127 
2128  if (can_idx == 0) {
2129  SCLogDebug("check if prior hooks are satisfied: s->app_progress_hook %u, "
2130  "tx->detect_progress_orig %u",
2132 
2133  if (DetectFwOtherLteCoversHook(det_ctx, fw_state, s, lte_counted)) {
2134  SCLogDebug("later LTE in-progress rule brought us here: us:%u covered:%u",
2136  return DETECT_TX_FW_FC_OK;
2137  }
2138 
2139  /* if our first rule is beyond the starting state, we need to check if
2140  * there are rules missing for states in between. */
2141  if (s->app_progress_hook > tx->detect_progress_orig) {
2142  SCLogDebug("missing fw rules at list start: sid %u, progress %u (%u:%u)", s->id,
2144  /* if this rule was after the state we expected meaning that there are
2145  * no rules for that state. Invoke the default policies. */
2146  enum DetectTxFirewallFlowControl r = DetectFirewallApplyDefaultPolicies(det_ctx,
2147  det_ctx->de_ctx->fw_policies, tx, p, s->alproto, direction,
2149  if (r != DETECT_TX_FW_FC_OK) {
2150  /* both SKIP and BREAK mean: no more fw rules to inspect.
2151  * SKIP applies to just this TX.
2152  * DROP applies to everything. */
2153  fw_state->fw_skip_app_filter = true;
2154  }
2155  return r;
2156  }
2157  }
2158  return DETECT_TX_FW_FC_OK;
2159 }
2160 
2161 /**
2162  * \internal
2163  * \brief Check and update firewall rules state.
2164  *
2165  * \param fw_state pointer to flow control state
2166  *
2167  * \retval DETECT_TX_FW_FC_OK no action needed
2168  * \retval DETECT_TX_FW_FC_BREAK rest of rules shouldn't inspected
2169  * \retval DETECT_TX_FW_FC_SKIP skip this rule
2170  */
2171 static enum DetectTxFirewallFlowControl DetectRunTxCheckRuleState(DetectEngineThreadCtx *det_ctx,
2172  Packet *p, Flow *f, DetectTransaction *tx, const Signature *s, const uint32_t can_idx,
2173  const uint32_t can_size, const bool lte_counted, struct DetectFirewallAppTxState *fw_state)
2174 {
2175  if (s->flags & SIG_FLAG_FIREWALL) {
2176  /* check if the next sig is on the same progress hook. If not, we need to apply our
2177  * default policy in case the current sig doesn't apply one. If the next sig has a
2178  * progress beyond our progress + 1, it means the next progress has no rules and needs
2179  * the default policy applied. But only after we evaluate the current rule first, as
2180  * that may override it. */
2181 
2182  if (can_idx + 1 < can_size) {
2183  const Signature *next_s = det_ctx->tx_candidates[can_idx + 1].s;
2184  SCLogDebug(
2185  "peek: peeking at sid %u / progress %u", next_s->id, next_s->app_progress_hook);
2186  if (next_s->flags & SIG_FLAG_FIREWALL) {
2187  if (s->app_progress_hook != next_s->app_progress_hook) {
2188  if (DetectFwOtherLteCoversHook(det_ctx, fw_state, s, lte_counted)) {
2189  SCLogDebug("we have another LTE in-progress. Us:%u covered:%u",
2191  } else {
2192  SCLogDebug("peek: next sid progress %u != current progress %u, so current "
2193  "is last for progress",
2194  next_s->app_progress_hook, s->app_progress_hook);
2195  fw_state->fw_last_for_progress = true;
2196 
2197  if (next_s->app_progress_hook - s->app_progress_hook > 1) {
2198  SCLogDebug("peek: missing progress, so we'll drop that unless we get a "
2199  "sweeping accept first");
2200  fw_state->fw_next_progress_missing = true;
2201  }
2202  }
2203  }
2204  } else {
2205  SCLogDebug("peek: next sid not a fw rule, so current is last for progress");
2206  fw_state->fw_last_for_progress = true;
2207  fw_state->last_fw_rule = true;
2208  }
2209  } else {
2210  SCLogDebug("peek: no peek beyond last rule");
2211  if (!DetectFwOtherLteCoversHook(det_ctx, fw_state, s, lte_counted)) {
2212  if (s->app_progress_hook < tx->tx_progress) {
2213  SCLogDebug("peek: there are no rules to allow the state after this rule");
2214  fw_state->fw_next_progress_missing = true;
2215  }
2216  fw_state->fw_last_for_progress = true;
2217  fw_state->last_fw_rule = true;
2218  }
2219  }
2220 
2221  if (fw_state->skip_fw_hook == true) {
2222  if (s->app_progress_hook <= fw_state->skip_before_progress) {
2223  return DETECT_TX_FW_FC_SKIP;
2224  }
2225  fw_state->skip_fw_hook = false;
2226  }
2227  } else {
2228  /* fw mode, we skip anything after the fw rules if:
2229  * - flow pass is set
2230  * - packet pass (e.g. exception policy) */
2232  SCLogDebug("skipping firewall rule %u", s->id);
2233  return DETECT_TX_FW_FC_BREAK;
2234  }
2235  }
2236  return DETECT_TX_FW_FC_OK;
2237 }
2238 
2239 // TODO move into det_ctx?
2241 static void DetectRunAppendDefaultAccept(DetectEngineThreadCtx *det_ctx, Packet *p)
2242 {
2244  SCLogDebug("packet %" PRIu64 ": appending default firewall accept", PcapPacketCntGet(p));
2245  memset(&default_accept, 0, sizeof(default_accept));
2248  default_accept.iid = UINT32_MAX;
2252  DETECT_TABLE_APP_FILTER; // TODO review, hope this makes it last in sorting
2254 }
2255 
2256 /** \internal
2257  * \brief see if the accept rule needs to apply to the packet
2258  */
2259 static inline bool ApplyAcceptToPacket(const DetectTransaction *tx, const Signature *s)
2260 {
2261  if ((s->flags & SIG_FLAG_FIREWALL) == 0) {
2262  return false;
2263  }
2264  if ((s->action & ACTION_ACCEPT) == 0) {
2265  return false;
2266  }
2267 
2268  /* for accept:tx we need:
2269  * - packet will only be accepted if this is set on the last tx
2270  */
2271  if (s->action_scope == ACTION_SCOPE_TX) {
2272  if (tx->is_last) {
2273  return true;
2274  }
2275  }
2276  /* for accept:hook we need a bit more checking:
2277  * - packet will only be accepted if this is set on the last tx
2278  * - the hook accepted should be the last progress available. */
2279  if (s->action_scope == ACTION_SCOPE_HOOK) {
2280  if (tx->is_last && (s->app_progress_hook == tx->tx_progress)) {
2281  return true;
2282  }
2283  }
2284  return false;
2285 }
2286 
2287 /** \internal
2288  * \brief apply an accept, but do check policies when needed
2289  *
2290  * Updates flow control where needed.
2291  *
2292  * */
2293 static void DetectRunTxFirewallApplyAccept(DetectEngineThreadCtx *det_ctx, Packet *p,
2294  const uint8_t direction, const Signature *s, DetectTransaction *tx,
2295  struct DetectFirewallAppTxState *fw_state)
2296 {
2297  const enum ActionScope as = s->action_scope;
2298  /* accept:hook: jump to first rule of next state.
2299  * Implemented as skip until the first rule of next state. */
2300  if (as == ACTION_SCOPE_HOOK) {
2301  fw_state->skip_fw_hook = true;
2302  fw_state->skip_before_progress = s->app_progress_hook;
2303 
2304  SCLogDebug("fw match sid:%u hook:%u", s->id, s->app_progress_hook);
2305  SCLogDebug("fw fw_skip_app_filter:%s skip_fw_hook:%s "
2306  "skip_before_progress:%u fw_last_for_progress:%s fw_next_progress_missing:%s",
2307  BOOL2STR(fw_state->fw_skip_app_filter), BOOL2STR(fw_state->skip_fw_hook),
2308  fw_state->skip_before_progress, BOOL2STR(fw_state->fw_last_for_progress),
2309  BOOL2STR(fw_state->fw_next_progress_missing));
2310  /* if there is no fw rule for the next progress value,
2311  * we invoke the defaul policies for the remaining available hooks.
2312  * Only when the tx walked over this rule's hook: at progress == hook
2313  * the sweep range would start above its end. */
2314  if (fw_state->fw_next_progress_missing && tx->tx_progress > s->app_progress_hook) {
2315  /* only states the packet actually walked over: states beyond the
2316  * current progress have not been reached, their defaults must not
2317  * decide this packet */
2318  const uint8_t last_hook = fw_state->last_fw_rule
2319  ? tx->tx_progress
2320  : MIN(tx->tx_progress, s->app_progress_hook + 1);
2322  DetectFirewallApplyDefaultPolicies(det_ctx, det_ctx->de_ctx->fw_policies, tx, p,
2323  s->alproto, direction, s->app_progress_hook + 1, last_hook);
2324  if (r == DETECT_TX_FW_FC_BREAK) {
2325  fw_state->fw_skip_app_filter = true;
2326  return;
2327  }
2328  }
2329  } else if (as == ACTION_SCOPE_TX) {
2331  fw_state->skip_fw_hook = true;
2332  fw_state->skip_before_progress = tx->tx_end_state + 1; // skip all hooks
2333  SCLogDebug("accept:tx applied, skip_fw_hook, skip_before_progress %u",
2334  fw_state->skip_before_progress);
2335  } else if (as == ACTION_SCOPE_PACKET) {
2336  fw_state->fw_skip_app_filter = true;
2337  } else if (as == ACTION_SCOPE_FLOW) {
2338  SCLogDebug("sid %u: ACTION_ACCEPT with ACTION_SCOPE_FLOW", s->id);
2339  fw_state->fw_skip_app_filter = true;
2340  }
2341 }
2342 
2343 /**
2344  * \internal
2345  * \brief check if there are no (fw) rules, and apply the default policies if so
2346  *
2347  * \retval 3 policies handled, continue with inspection
2348  * \retval 2 continue with next tx
2349  * \retval 1 done with inspection
2350  * \retval 0 ok, continue as normal. No policies applied.
2351  */
2352 static int DetectTxFirewallNoRulesApplyPolicies(DetectEngineThreadCtx *det_ctx, Packet *p, Flow *f,
2353  DetectTransaction *tx, const AppProto alproto, const uint8_t flow_flags, const int rule_cnt)
2354 {
2355  /* if there are no rules / rule candidates, handling invoking the default
2356  * policy. */
2357  if (rule_cnt == 0 || (det_ctx->tx_candidates[0].s->flags & SIG_FLAG_FIREWALL) == 0) {
2358  /* if there are no rules, make sure to handle accept:flow and accept:tx */
2359  if (rule_cnt == 0) {
2360  if (f->flags & FLOW_ACTION_ACCEPT) {
2361  SCLogDebug("default accept:flow: no rules");
2362  DetectRunAppendDefaultAccept(det_ctx, p);
2363  return 1;
2364  }
2365  if (tx->tx_data_ptr->flags & APP_LAYER_TX_ACCEPT) {
2366  /* current tx is the last we have, append a blank accept:packet */
2367  if (tx->is_last) {
2368  SCLogDebug("default accept:tx: no rules");
2369  DetectRunAppendDefaultAccept(det_ctx, p);
2370  return 1;
2371  }
2372  return 2;
2373  }
2374  }
2375 
2376  /* if there are no fw rules, handle default policies */
2377  if ((f->flags & FLOW_ACTION_ACCEPT) == 0 &&
2378  (tx->tx_data_ptr->flags & APP_LAYER_TX_ACCEPT) == 0) {
2379  /* No rules to eval, so we need to see if there are default policies to apply.
2380  * Start at last inspected progress and check each hook. If all hooks accepted,
2381  * apply the accept to the packet. */
2382  SCLogDebug("tx.detect_progress_orig %u tx.tx_progress %u", tx->detect_progress_orig,
2383  tx->tx_progress);
2385  DetectFirewallApplyDefaultPolicies(det_ctx, det_ctx->de_ctx->fw_policies, tx, p,
2386  alproto, flow_flags & (STREAM_TOSERVER | STREAM_TOCLIENT),
2388  SCLogDebug("r %u", r);
2389  if (r == DETECT_TX_FW_FC_BREAK)
2390  return 1;
2391  if (r == DETECT_TX_FW_FC_SKIP)
2392  return 2;
2393  /* continue with TD rules */
2394  SCLogDebug("continue with TD rules");
2395  return 3;
2396  }
2397  }
2398  return 0;
2399 }
2400 
2401 /** \internal
2402  * \brief handle a full rule match for a firewall rule
2403  *
2404  * For a drop/reject rule, excute action immediately.
2405  * For an accept rule, add an alert even to the queue. This will
2406  * allow TD rules to override the accept.
2407  */
2408 static void DetectRunTxFirewallRuleFullMatch(DetectEngineThreadCtx *det_ctx, const Signature *s,
2409  DetectTransaction *tx, struct DetectFirewallAppTxState *fw_state, Flow *f, Packet *p,
2410  const uint8_t flow_flags)
2411 {
2412  if (s->action & ACTION_ACCEPT) {
2413  /* add alert now, as ApplyAccept may also trigger
2414  * policy matches that could add alerts. */
2415  SCLogDebug("append alert");
2416  /* see if we need to apply tx/hook accept to the packet. This can be needed
2417  * when we've completed the inspection so far for an incomplete tx, and an
2418  * accept:tx or accept:hook is the last match.*/
2419  const bool fw_accept_to_packet = ApplyAcceptToPacket(tx, s);
2420  if (fw_accept_to_packet) {
2421  SCLogDebug("packet %" PRIu64 ": apply accept to packet", PcapPacketCntGet(p));
2422  SCLogDebug("accept:(tx|hook): should be applied to the packet");
2423  AlertQueueAppendAppTx(det_ctx, s, p, tx->tx_id, tx->tx_type,
2425  } else {
2426  AlertQueueAppendAppTx(det_ctx, s, p, tx->tx_id, tx->tx_type, 0);
2427  }
2428  DetectRunTxFirewallApplyAccept(det_ctx, p, flow_flags, s, tx, fw_state);
2429  } else if (s->action & ACTION_DROP) {
2430  SCLogDebug("drop packet because of rule with drop action");
2432  if (s->action_scope == ACTION_SCOPE_FLOW) {
2433  SCLogDebug("drop flow because of rule with drop action");
2434  FlowSetDropAction(f, FLOW_ACTION_BY_FIREWALL);
2435  }
2436  SCLogDebug("append alert");
2437  AlertQueueAppendAppTx(det_ctx, s, p, tx->tx_id, tx->tx_type, 0);
2438  } else {
2439  SCLogDebug("append alert");
2440  AlertQueueAppendAppTx(det_ctx, s, p, tx->tx_id, tx->tx_type, 0);
2441  }
2442 }
2443 
2444 /** \internal
2445  * \brief handle a partial match for firewall rules
2446  *
2447  * Currently only used for LTE mode. Regardless of the final action,
2448  * the partial match acts as a `accept:hook`.
2449  *
2450  * A default accept is appended. TD has a chance to override this accept.
2451  *
2452  * \retval 1 accept partial, caller must break loop
2453  * \retval 0 ok, caller must continue as normal
2454  */
2455 static int DetectRunTxFirewallRulePartialMatch(
2456  DetectEngineThreadCtx *det_ctx, const Signature *s, const DetectTransaction *tx, Packet *p)
2457 {
2458  if ((s->flags & SIG_FLAG_FIREWALL) && (s->action & ACTION_ACCEPT)) {
2459  /* partial match always uses ACTION_SCOPE_HOOK. Final action only on the full
2460  * match */
2461  if (tx->is_last) {
2462  SCLogDebug("need to apply accept to packet");
2463  DetectRunAppendDefaultAccept(det_ctx, p);
2464  }
2465  if (s->action_scope == ACTION_SCOPE_FLOW) {
2466  SCLogDebug("only applying accept:flow on full match, downgrading to "
2467  "accept:hook");
2468  }
2469  return 1;
2470  }
2471  return 0;
2472 }
2473 
2474 /** \internal
2475  * \brief handle the no-match case for a firewall rule
2476  *
2477  * If the rule did not match we need to see if we need invoke the default
2478  * policy for this hook. If that is the case, we handle a drop by telling the
2479  * caller about it. Flow control for various accept options is handled by the
2480  * next rule.
2481  *
2482  * \retval 1 dropped by policy, caller must return
2483  * \retval 0 ok, caller must continue as normal
2484  */
2485 static int DetectRunTxFirewallRuleNoMatch(DetectEngineThreadCtx *det_ctx, const Signature *s,
2486  DetectTransaction *tx, struct DetectFirewallAppTxState *fw_state, Packet *p,
2487  const uint8_t flow_flags)
2488 {
2489  if (fw_state->fw_last_for_progress && (s->flags & SIG_FLAG_FIREWALL)) {
2490  SCLogDebug("%" PRIu64 ": %s default policy for progress %u", PcapPacketCntGet(p),
2491  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", s->app_progress_hook);
2492  /* if this rule was the last for our progress state, and it didn't match,
2493  * we have to invoke the default policy. We only check the current rule hook.
2494  * DROP is immediate, flow control for various accept options is handled by
2495  * the DetectRunTxPreCheckFirewallPolicy function for the next rule. */
2496  const struct DetectFirewallPolicy policy = DetectFirewallApplyDefaultAppPolicy(det_ctx,
2497  det_ctx->de_ctx->fw_policies, tx, p, s->alproto, flow_flags, s->app_progress_hook);
2498  SCLogDebug("fw_last_for_progress policy %02x", policy.action);
2499  if (policy.action & ACTION_DROP) {
2500  return 1;
2501  }
2502  /* an accept with tx or flow scope already carries the verdict. For an
2503  * accept:hook (which does not apply to this packet) the states walked
2504  * over must still be decided: if the tx progressed beyond this rule's
2505  * hook and there is no rule for the states in between, their default
2506  * policies must be applied too - same as the match path does.
2507  * Without this a packet that crosses two states (e.g. a hello
2508  * completing into the certificate phase) would be decided by the
2509  * packet default policy even though the app policy for the current
2510  * state says accept. */
2511  if ((policy.action & ACTION_ACCEPT) && policy.action_scope == ACTION_SCOPE_HOOK &&
2512  fw_state->fw_next_progress_missing && tx->tx_progress > s->app_progress_hook) {
2513  /* only states the packet actually walked over (see the match
2514  * path) */
2515  const uint8_t last_hook = fw_state->last_fw_rule
2516  ? tx->tx_progress
2517  : MIN(tx->tx_progress, s->app_progress_hook + 1);
2519  DetectFirewallApplyDefaultPolicies(det_ctx, det_ctx->de_ctx->fw_policies, tx, p,
2520  s->alproto, flow_flags, s->app_progress_hook + 1, last_hook);
2521  if (r == DETECT_TX_FW_FC_BREAK) {
2522  /* the sweep dropped the packet: same as a current-hook
2523  * policy drop, the caller must stop the walk */
2524  fw_state->fw_skip_app_filter = true;
2525  return 1;
2526  }
2527  }
2528  }
2529  return 0;
2530 }
2531 
2532 /** \internal
2533  * \brief handle full match on rule when state didn't progress yet
2534  *
2535  * For a full rule match on a certain hook, we need to continue to enforce the
2536  * match as long as the tx progress doesn't move beyond that hook.
2537  */
2538 static void DetectRunTxFirewallRuleStatefulReApplyMatch(DetectEngineThreadCtx *det_ctx,
2539  const Signature *s, DetectTransaction *tx, struct DetectFirewallAppTxState *fw_state,
2540  Packet *p, const uint8_t flow_flags)
2541 {
2542  /* if we're still in the same progress state as an earlier full
2543  * match, we need to apply the same accept */
2544  if ((s->flags & SIG_FLAG_FIREWALL) && (s->action & ACTION_ACCEPT) &&
2545  s->app_progress_hook == tx->tx_progress) {
2546  const bool fw_accept_to_packet = ApplyAcceptToPacket(tx, s);
2547  DetectRunTxFirewallApplyAccept(det_ctx, p, flow_flags, s, tx, fw_state);
2548  if (fw_accept_to_packet) {
2549  SCLogDebug("packet %" PRIu64 ": apply accept to packet", PcapPacketCntGet(p));
2550  DetectRunAppendDefaultAccept(det_ctx, p);
2551  }
2552  }
2553 }
2554 
2555 static void DetectRunTx(ThreadVars *tv,
2557  DetectEngineThreadCtx *det_ctx,
2558  Packet *p,
2559  Flow *f,
2560  DetectRunScratchpad *scratch)
2561 {
2562  const uint8_t flow_flags = scratch->flow_flags;
2563  const SigGroupHead * const sgh = scratch->sgh;
2564  void * const alstate = f->alstate;
2565  const uint8_t ipproto = f->proto;
2566  const AppProto alproto = f->alproto;
2567 
2568  const uint64_t total_txs = AppLayerParserGetTxCnt(f, alstate);
2569  uint64_t tx_id_min = AppLayerParserGetTransactionInspectId(f->alparser, flow_flags);
2570  AppLayerGetTxIteratorFunc IterFunc = AppLayerGetTxIterator(ipproto, alproto);
2571  AppLayerGetTxIterState state = { 0 };
2572 
2573  uint32_t tx_inspected = 0;
2574  const bool have_fw_rules = EngineModeIsFirewall();
2575  /* if we skipped the last tx, we did not have a chance to apply a fw accept to the packet. Since
2576  * the tx is skipped, we should consider it accepted. */
2577  bool last_tx_skipped = false;
2578 
2579  SCLogDebug("packet %" PRIu64, PcapPacketCntGet(p));
2580  SCLogDebug("total_txs %" PRIu64, total_txs);
2581 
2582  while (1) {
2583  AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, tx_id_min, total_txs, &state);
2584  if (ires.tx_ptr == NULL) {
2585  SCLogDebug("%p/%" PRIu64 " no transaction to inspect", ires.tx_ptr, tx_id_min);
2586  break;
2587  }
2588 
2589  DetectTransaction tx = GetDetectTx(ipproto, alproto, ires.tx_id, ires.tx_ptr, flow_flags);
2590  if (tx.tx_ptr == NULL) {
2591  SCLogDebug("%p/%"PRIu64" no transaction to inspect",
2592  tx.tx_ptr, tx_id_min);
2593  last_tx_skipped = !ires.has_next;
2594  tx_id_min++; // next (if any) run look for +1
2595  goto next;
2596  }
2597  tx.is_last = !ires.has_next;
2598  tx_id_min = tx.tx_id + 1; // next look for cur + 1
2599  tx_inspected++;
2600 
2601  SCLogDebug("%p/%" PRIu64 " txd flags %02x", tx.tx_ptr, tx.tx_id, tx.tx_data_ptr->flags);
2602  SCLogDebug("%p/%" PRIu64 " is_last %s", tx.tx_ptr, tx.tx_id, BOOL2STR(tx.is_last));
2603 
2604  det_ctx->tx_id = tx.tx_id;
2605  det_ctx->tx_id_set = true;
2606  det_ctx->p = p;
2607 
2608  bool do_sort = false; // do we need to sort the tx candidate list?
2609  bool fw_lte_candidates = false; // does the list have a pending LTE rule?
2610  uint32_t array_idx = 0;
2611  uint32_t total_rules = det_ctx->match_array_cnt;
2612  total_rules += (tx.de_state ? tx.de_state->cnt : 0);
2613 
2614  /* run prefilter engines and merge results into a candidates array */
2615  if (sgh && sgh->tx_engines) {
2617  DetectRunPrefilterTx(det_ctx, sgh, p, ipproto, flow_flags, alproto,
2618  alstate, &tx);
2620  SCLogDebug("%p/%"PRIu64" rules added from prefilter: %u candidates",
2621  tx.tx_ptr, tx.tx_id, det_ctx->pmq.rule_id_array_cnt);
2622 
2623  total_rules += det_ctx->pmq.rule_id_array_cnt;
2624  if (!(RuleMatchCandidateTxArrayHasSpace(det_ctx, total_rules))) {
2625  RuleMatchCandidateTxArrayExpand(det_ctx, total_rules);
2626  }
2627 
2628  for (uint32_t i = 0; i < det_ctx->pmq.rule_id_array_cnt; i++) {
2629  const Signature *s = de_ctx->sig_array[det_ctx->pmq.rule_id_array[i]];
2630  const SigIntId id = s->iid;
2631  det_ctx->tx_candidates[array_idx].s = s;
2632  det_ctx->tx_candidates[array_idx].id = id;
2633  det_ctx->tx_candidates[array_idx].flags = NULL;
2634  det_ctx->tx_candidates[array_idx].fw_lte_counted = false;
2635  det_ctx->tx_candidates[array_idx].fw_lte_header_ok = false;
2636  det_ctx->tx_candidates[array_idx].stream_reset = 0;
2637  if (s->flags & SIG_FLAG_FW_HOOK_LTE) {
2638  fw_lte_candidates = true;
2639  }
2640  array_idx++;
2641  }
2642  PMQ_RESET(&det_ctx->pmq);
2643  } else {
2644  if (!(RuleMatchCandidateTxArrayHasSpace(det_ctx, total_rules))) {
2645  RuleMatchCandidateTxArrayExpand(det_ctx, total_rules);
2646  }
2647  }
2648 
2649  /* merge 'state' rules from the regular prefilter */
2650 #ifdef PROFILING
2651  uint32_t x = array_idx;
2652 #endif
2653  RuleMatchCandidateMergeStateRules(det_ctx, &array_idx, &fw_lte_candidates);
2654 
2655  /* merge stored state into results */
2656  if (tx.de_state != NULL) {
2657  const uint32_t old = array_idx;
2658 
2659  /* if tx.de_state->flags has 'new file' set and sig below has
2660  * 'file inspected' flag, reset the file part of the state */
2661  const bool have_new_file = (tx.de_state->flags & DETECT_ENGINE_STATE_FLAG_FILE_NEW);
2662  if (have_new_file) {
2663  SCLogDebug("%p/%"PRIu64" destate: need to consider new file",
2664  tx.tx_ptr, tx.tx_id);
2666  }
2667 
2668  SigIntId state_cnt = 0;
2669  DeStateStore *tx_store = tx.de_state->head;
2670  for (; tx_store != NULL; tx_store = tx_store->next) {
2671  SCLogDebug("tx_store %p", tx_store);
2672 
2673  SigIntId store_cnt = 0;
2674  for (store_cnt = 0;
2675  store_cnt < DE_STATE_CHUNK_SIZE && state_cnt < tx.de_state->cnt;
2676  store_cnt++, state_cnt++)
2677  {
2678  DeStateStoreItem *item = &tx_store->store[store_cnt];
2679  SCLogDebug("rule id %u, inspect_flags %u", item->sid, item->flags);
2680  if (have_new_file && (item->flags & DE_STATE_FLAG_FILE_INSPECT)) {
2681  /* remove part of the state. File inspect engine will now
2682  * be able to run again */
2684  SCLogDebug("rule id %u, post file reset inspect_flags %u", item->sid, item->flags);
2685  }
2686 
2687  const Signature *ss = de_ctx->sig_array[item->sid];
2688  det_ctx->tx_candidates[array_idx].s = ss;
2689  det_ctx->tx_candidates[array_idx].id = item->sid;
2690  det_ctx->tx_candidates[array_idx].flags = &item->flags;
2691  det_ctx->tx_candidates[array_idx].fw_lte_counted = false;
2692  det_ctx->tx_candidates[array_idx].fw_lte_header_ok = false;
2693  det_ctx->tx_candidates[array_idx].stream_reset = 0;
2694  if (ss->flags & SIG_FLAG_FW_HOOK_LTE) {
2695  fw_lte_candidates = true;
2696  }
2697  array_idx++;
2698  }
2699  }
2700  do_sort |= (array_idx > old); // sort if continue list adds sids
2701  SCLogDebug("%p/%" PRIu64 " rules added from 'continue' list: %u", tx.tx_ptr, tx.tx_id,
2702  array_idx - old);
2703  }
2704  if (do_sort) {
2705  qsort(det_ctx->tx_candidates, array_idx, sizeof(RuleMatchCandidateTx),
2706  DetectRunTxSortHelper);
2707  }
2708 
2709 #ifdef PROFILING
2710  if (array_idx >= de_ctx->profile_match_logging_threshold)
2711  RulesDumpTxMatchArray(det_ctx, scratch->sgh, p, tx.tx_id, array_idx, x);
2712 #endif
2713 
2714 #ifdef DEBUG
2715  for (uint32_t i = 0; i < array_idx; i++) {
2716  RuleMatchCandidateTx *can = &det_ctx->tx_candidates[i];
2717  const Signature *s = det_ctx->tx_candidates[i].s;
2718  SCLogDebug("%u: sid %u flags %p", i, s->id, can->flags);
2719  }
2720 #endif
2721 
2722  /* Only firewall mode uses the per-tx firewall state. The LTE flag is
2723  * tracked where the candidates are added: the list mixes fw and TD
2724  * rules across tables in iid order, so a scan cannot stop early. */
2725  struct DetectFirewallAppTxState fw_state = { 0 };
2726  if (have_fw_rules && fw_lte_candidates) {
2727  DetectFwBuildLteCoverage(det_ctx, p, f, &fw_state, array_idx);
2728  }
2729 
2730  SCLogDebug("%s: tx_progress %u tx %p have_fw_rules %s array_idx %u detect_progress_orig %u "
2731  "cur detect_progress %u",
2732  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", tx.tx_progress,
2733  tx.tx_data_ptr, BOOL2STR(have_fw_rules), array_idx, tx.detect_progress_orig,
2734  tx.detect_progress);
2735 
2736  if (have_fw_rules) {
2737  /* if there are no firewall rules to consider, handle invoking the default
2738  * policies. */
2739  const int r = DetectTxFirewallNoRulesApplyPolicies(
2740  det_ctx, p, f, &tx, alproto, flow_flags, array_idx);
2741  if (r == 1) {
2742  SCLogDebug("done");
2743  return;
2744  } else if (r == 2) {
2745  goto next_tx_fw; /* next tx, need to clean up buffers */
2746  }
2747  }
2748 
2749  /* run rules: inspect the match candidates */
2750  for (uint32_t i = 0; i < array_idx; i++) {
2751  RuleMatchCandidateTx *can = &det_ctx->tx_candidates[i];
2752  const Signature *s = det_ctx->tx_candidates[i].s;
2753  uint32_t *inspect_flags = det_ctx->tx_candidates[i].flags;
2754 
2755  SCLogDebug("%" PRIu64 ": sid:%u: %s tx %u/%u/%u sig %u", PcapPacketCntGet(p), s->id,
2756  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", tx.tx_progress,
2758 
2759  if (have_fw_rules) {
2760  const enum DetectTxFirewallFlowControl fw_r = DetectRunTxPreCheckFirewallPolicy(
2761  det_ctx, p, &tx, flow_flags & (STREAM_TOSERVER | STREAM_TOCLIENT), s, i,
2762  can->fw_lte_counted, &fw_state);
2763  SCLogDebug("fw fw_skip_app_filter:%s skip_fw_hook:%s "
2764  "skip_before_progress:%u fw_last_for_progress:%s "
2765  "fw_next_progress_missing:%s",
2766  BOOL2STR(fw_state.fw_skip_app_filter), BOOL2STR(fw_state.skip_fw_hook),
2769  if (fw_r == DETECT_TX_FW_FC_SKIP) {
2770  continue;
2771  } else if (fw_r == DETECT_TX_FW_FC_BREAK) {
2772  break;
2773  }
2774 
2775  fw_state.fw_last_for_progress = false;
2776  fw_state.fw_next_progress_missing = false; // reset
2777  }
2778 
2779  /* deduplicate: rules_array is sorted, but not deduplicated:
2780  * both mpm and stored state could give us the same sid.
2781  * As they are back to back in that case we can check for it
2782  * here. We select the stored state one as that comes first
2783  * in the array. */
2784  while ((i + 1) < array_idx &&
2785  det_ctx->tx_candidates[i].s == det_ctx->tx_candidates[i + 1].s) {
2786  SCLogDebug("%p/%" PRIu64 " inspecting SKIP NEXT: sid %u (%u), flags %08x",
2787  tx.tx_ptr, tx.tx_id, s->id, s->iid, inspect_flags ? *inspect_flags : 0);
2788  i++;
2789  }
2790 
2791  SCLogDebug("%p/%" PRIu64 " inspecting: sid %u (%u), flags %08x", tx.tx_ptr, tx.tx_id,
2792  s->id, s->iid, inspect_flags ? *inspect_flags : 0);
2793 
2794  if (inspect_flags) {
2795  if (*inspect_flags & DE_STATE_FLAG_FULL_INSPECT) {
2796  SCLogDebug("%p/%" PRIu64
2797  " inspecting: sid %u (%u), flags %08x DE_STATE_FLAG_FULL_INSPECT",
2798  tx.tx_ptr, tx.tx_id, s->id, s->iid, *inspect_flags);
2799 
2800  /* if we're still in the same progress state as an earlier full
2801  * match, we need to apply the same accept */
2802  if (have_fw_rules) {
2803  DetectRunTxFirewallRuleStatefulReApplyMatch(
2804  det_ctx, s, &tx, &fw_state, p, flow_flags);
2805  }
2806  continue;
2807  }
2808  if (*inspect_flags & DE_STATE_FLAG_SIG_CANT_MATCH) {
2809  SCLogDebug("%p/%" PRIu64
2810  " inspecting: sid %u (%u), flags %08x DE_STATE_FLAG_SIG_CANT_MATCH",
2811  tx.tx_ptr, tx.tx_id, s->id, s->iid, *inspect_flags);
2812  continue;
2813  }
2814 
2815  /* continue previous inspection */
2816  SCLogDebug("%p/%" PRIu64 " Continuing sid %u", tx.tx_ptr, tx.tx_id, s->id);
2817  } else {
2818  /* start new inspection */
2819  SCLogDebug("%p/%"PRIu64" Start sid %u", tx.tx_ptr, tx.tx_id, s->id);
2820  }
2821 
2822  if (have_fw_rules) {
2823  /* check if we should run this rule and update the firewall flow state */
2824  const enum DetectTxFirewallFlowControl fw_r = DetectRunTxCheckRuleState(
2825  det_ctx, p, f, &tx, s, i, array_idx, can->fw_lte_counted, &fw_state);
2826  SCLogDebug("fw fw_skip_app_filter:%s skip_fw_hook:%s "
2827  "skip_before_progress:%u fw_last_for_progress:%s "
2828  "fw_next_progress_missing:%s",
2829  BOOL2STR(fw_state.fw_skip_app_filter), BOOL2STR(fw_state.skip_fw_hook),
2832  if (fw_r == DETECT_TX_FW_FC_SKIP)
2833  continue;
2834  else if (fw_r == DETECT_TX_FW_FC_BREAK)
2835  break;
2836  }
2837 
2838  /* call individual rule inspection */
2840  const int r = DetectRunTxInspectRule(tv, de_ctx, det_ctx, p, f, flow_flags,
2841  alstate, &tx, s, inspect_flags, can, scratch);
2842  SCLogDebug("s %u r %d", s->id, r);
2843  if (have_fw_rules && r == -1 && (s->flags & SIG_FLAG_FW_HOOK_LTE) &&
2844  can->fw_lte_counted && tx.tx_progress >= s->app_progress_hook) {
2845  DetectFwRetireLteRule(det_ctx, can);
2846  }
2847  if (r == 1) {
2848  /* match */
2849  DetectRunPostMatch(tv, det_ctx, p, s);
2850 
2851  SCLogDebug(
2852  "%p/%" PRIu64 " sig %u (%u) matched", tx.tx_ptr, tx.tx_id, s->id, s->iid);
2853 
2854  if ((s->flags & SIG_FLAG_FIREWALL) == 0) {
2855  AlertQueueAppendAppTx(det_ctx, s, p, tx.tx_id, tx.tx_type, 0);
2856  } else {
2857  DetectRunTxFirewallRuleFullMatch(det_ctx, s, &tx, &fw_state, f, p, flow_flags);
2858  }
2859  } else if (r == 0) {
2860  SCLogDebug("sid %u partial match", s->id);
2861  if (DetectRunTxFirewallRulePartialMatch(det_ctx, s, &tx, p) == 1) {
2862  break;
2863  }
2864  } else if (r == -1) {
2865  if ((s->flags & SIG_FLAG_FIREWALL) != 0 &&
2866  DetectRunTxFirewallRuleNoMatch(det_ctx, s, &tx, &fw_state, p, flow_flags) ==
2867  1) {
2868  return;
2869  }
2870  } /* r == -2: no match, but not final: the rule is revisited, so a
2871  * hook default now could decide the packet before the revisit can */
2872  DetectVarProcessList(det_ctx, p->flow, p);
2873  RULE_PROFILING_END(det_ctx, s, r == 1, p);
2874 
2875  if (det_ctx->post_rule_work_queue.len > 0) {
2876  SCLogDebug("%p/%" PRIu64 " post_rule_work_queue len %u", tx.tx_ptr, tx.tx_id,
2877  det_ctx->post_rule_work_queue.len);
2878  /* run post match prefilter engines on work queue */
2879  PrefilterPostRuleMatch(det_ctx, scratch->sgh, p, f);
2880 
2881  uint32_t prev_array_idx = array_idx;
2882 
2883  /* Check if there is room for the pmq results before appending them. */
2884  const uint32_t needed = array_idx + det_ctx->pmq.rule_id_array_cnt;
2885  if (!(RuleMatchCandidateTxArrayHasSpace(det_ctx, needed))) {
2886  RuleMatchCandidateTxArrayExpand(det_ctx, needed);
2887  }
2888 
2889  for (uint32_t j = 0; j < det_ctx->pmq.rule_id_array_cnt; j++) {
2890  const Signature *ts = de_ctx->sig_array[det_ctx->pmq.rule_id_array[j]];
2891  if (ts->app_inspect != NULL) {
2892  const SigIntId id = ts->iid;
2893  det_ctx->tx_candidates[array_idx].s = ts;
2894  det_ctx->tx_candidates[array_idx].id = id;
2895  det_ctx->tx_candidates[array_idx].fw_lte_counted = false;
2896  det_ctx->tx_candidates[array_idx].fw_lte_header_ok = false;
2897  det_ctx->tx_candidates[array_idx].flags = NULL;
2898  det_ctx->tx_candidates[array_idx].stream_reset = 0;
2899 
2900  /* a mid-walk enabled LTE rule must count as coverage
2901  * for the remaining checks of this walk */
2902  if (have_fw_rules) {
2903  DetectFwCountAppendedLteRule(det_ctx, p, f, &fw_state, ts, array_idx);
2904  }
2905  array_idx++;
2906 
2907  SCLogDebug("%p/%" PRIu64 " rule %u (%u) added from 'post match' prefilter",
2908  tx.tx_ptr, tx.tx_id, ts->id, id);
2909  }
2910  }
2911  SCLogDebug("%p/%" PRIu64 " rules added from 'post match' prefilter: %u", tx.tx_ptr,
2912  tx.tx_id, array_idx - prev_array_idx);
2913  if (prev_array_idx != array_idx) {
2914  /* sort, but only part of array we're still going to process */
2915  qsort(det_ctx->tx_candidates + i, array_idx - i, sizeof(RuleMatchCandidateTx),
2916  DetectRunTxSortHelper);
2917  }
2918  det_ctx->post_rule_work_queue.len = 0;
2919  PMQ_RESET(&det_ctx->pmq);
2920  }
2921  }
2922 
2923  det_ctx->tx_id = 0;
2924  det_ctx->tx_id_set = false;
2925  det_ctx->p = NULL;
2926 
2927  /* see if we have any updated state to store in the tx */
2928 
2929  /* this side of the tx is done */
2930  if (tx.tx_progress >= tx.tx_end_state) {
2931  SCLogDebug("%" PRIu64 ": %s tx done", PcapPacketCntGet(p),
2932  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient");
2933  const uint8_t inspected_flag = (flow_flags & STREAM_TOSERVER)
2936  tx.tx_data_ptr->flags |= inspected_flag;
2937  SCLogDebug("%p/%" PRIu64 " tx is done for direction %s. Progress %02x", tx.tx_ptr,
2938  tx.tx_id, flow_flags & STREAM_TOSERVER ? "toserver" : "toclient",
2939  tx.detect_progress);
2940  }
2941 
2942  if (tx.detect_progress != tx.detect_progress_orig) {
2943  SCLogDebug("%" PRIu64 ": %s tx state change %u -> %u", PcapPacketCntGet(p),
2944  flow_flags & STREAM_TOSERVER ? "toserver" : "toclient", tx.detect_progress_orig,
2945  tx.detect_progress);
2946  SCLogDebug("%p/%" PRIu64 " Storing new progress %02x (was %02x)", tx.tx_ptr, tx.tx_id,
2948 
2949  StoreDetectProgress(&tx, flow_flags, tx.detect_progress);
2950  }
2951  next_tx_fw:
2952  InspectionBufferClean(det_ctx);
2953 
2954  next:
2955  if (!ires.has_next)
2956  break;
2957  }
2958 
2959  SCLogDebug("packet %" PRIu64 ": tx_inspected %u", PcapPacketCntGet(p), tx_inspected);
2960  if (have_fw_rules) {
2961  if (tx_inspected == 0) {
2962  /* if all tables have been bypassed, we accept:packet */
2963  SCLogDebug("default accept: no app inspect performed");
2964  DetectRunAppendDefaultAccept(det_ctx, p);
2965  } else if (last_tx_skipped) {
2966  /* if the last tx was skipped, we need to apply accept:packet */
2967  // TODO should we check drops first?
2969  SCLogDebug("default accept: last tx skipped");
2970  DetectRunAppendDefaultAccept(det_ctx, p);
2971  }
2972  }
2973 }
2974 
2975 static void DetectRunFrames(ThreadVars *tv, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx,
2976  Packet *p, Flow *f, DetectRunScratchpad *scratch)
2977 {
2978  const SigGroupHead *const sgh = scratch->sgh;
2979  const AppProto alproto = f->alproto;
2980 
2981  /* for TCP, limit inspection to pseudo packets or real packet that did
2982  * an app-layer update. */
2983  if (p->proto == IPPROTO_TCP && !PKT_IS_PSEUDOPKT(p) &&
2984  ((PKT_IS_TOSERVER(p) && (f->flags & FLOW_TS_APP_UPDATED) == 0) ||
2985  (PKT_IS_TOCLIENT(p) && (f->flags & FLOW_TC_APP_UPDATED) == 0))) {
2986  SCLogDebug("pcap_cnt %" PRIu64 ": %s: skip frame inspection for TCP w/o APP UPDATE",
2987  PcapPacketCntGet(p), PKT_IS_TOSERVER(p) ? "toserver" : "toclient");
2988  return;
2989  }
2990  FramesContainer *frames_container = AppLayerFramesGetContainer(f);
2991  if (frames_container == NULL) {
2992  return;
2993  }
2994  Frames *frames;
2995  if (PKT_IS_TOSERVER(p)) {
2996  frames = &frames_container->toserver;
2997  } else {
2998  frames = &frames_container->toclient;
2999  }
3000 
3001  for (uint32_t idx = 0; idx < frames->cnt; idx++) {
3002  SCLogDebug("frame %u", idx);
3003  Frame *frame = FrameGetByIndex(frames, idx);
3004  if (frame == NULL) {
3005  continue;
3006  }
3007 
3008  det_ctx->frame_inspect_progress = 0;
3009  uint32_t array_idx = 0;
3010  uint32_t total_rules = det_ctx->match_array_cnt;
3011 
3012  /* run prefilter engines and merge results into a candidates array */
3013  if (sgh->frame_engines) {
3014  // PACKET_PROFILING_DETECT_START(p, PROF_DETECT_PF_TX);
3015  DetectRunPrefilterFrame(det_ctx, sgh, p, frames, frame, alproto);
3016  // PACKET_PROFILING_DETECT_END(p, PROF_DETECT_PF_TX);
3017  SCLogDebug("%p/%" PRIi64 " rules added from prefilter: %u candidates", frame, frame->id,
3018  det_ctx->pmq.rule_id_array_cnt);
3019 
3020  total_rules += det_ctx->pmq.rule_id_array_cnt;
3021 
3022  if (!(RuleMatchCandidateTxArrayHasSpace(
3023  det_ctx, total_rules))) { // TODO is it safe to overload?
3024  RuleMatchCandidateTxArrayExpand(det_ctx, total_rules);
3025  }
3026 
3027  for (uint32_t i = 0; i < det_ctx->pmq.rule_id_array_cnt; i++) {
3028  const Signature *s = de_ctx->sig_array[det_ctx->pmq.rule_id_array[i]];
3029  const SigIntId id = s->iid;
3030  det_ctx->tx_candidates[array_idx].s = s;
3031  det_ctx->tx_candidates[array_idx].id = id;
3032  det_ctx->tx_candidates[array_idx].flags = NULL;
3033  det_ctx->tx_candidates[array_idx].fw_lte_counted = false;
3034  det_ctx->tx_candidates[array_idx].fw_lte_header_ok = false;
3035  det_ctx->tx_candidates[array_idx].stream_reset = 0;
3036  array_idx++;
3037  }
3038  PMQ_RESET(&det_ctx->pmq);
3039  }
3040  /* merge 'state' rules from the regular prefilter */
3041  uint32_t x = array_idx;
3042  for (uint32_t i = 0; i < det_ctx->match_array_cnt; i++) {
3043  const Signature *s = det_ctx->match_array[i];
3044  if (s->frame_inspect != NULL) {
3045  const SigIntId id = s->iid;
3046  det_ctx->tx_candidates[array_idx].s = s;
3047  det_ctx->tx_candidates[array_idx].id = id;
3048  det_ctx->tx_candidates[array_idx].flags = NULL;
3049  det_ctx->tx_candidates[array_idx].fw_lte_counted = false;
3050  det_ctx->tx_candidates[array_idx].fw_lte_header_ok = false;
3051  det_ctx->tx_candidates[array_idx].stream_reset = 0;
3052  array_idx++;
3053 
3054  SCLogDebug("%p/%" PRIi64 " rule %u (%u) added from 'match' list", frame, frame->id,
3055  s->id, id);
3056  }
3057  }
3058  SCLogDebug("%p/%" PRIi64 " rules added from 'match' list: %u", frame, frame->id,
3059  array_idx - x);
3060  (void)x;
3061 
3062  /* run rules: inspect the match candidates */
3063  for (uint32_t i = 0; i < array_idx; i++) {
3064  const Signature *s = det_ctx->tx_candidates[i].s;
3065 
3066  /* deduplicate: rules_array is sorted, but not deduplicated.
3067  * As they are back to back in that case we can check for it
3068  * here. We select the stored state one as that comes first
3069  * in the array. */
3070  while ((i + 1) < array_idx &&
3071  det_ctx->tx_candidates[i].s == det_ctx->tx_candidates[i + 1].s) {
3072  i++;
3073  }
3074  SCLogDebug("%p/%" PRIi64 " inspecting: sid %u (%u)", frame, frame->id, s->id, s->iid);
3075 
3076  /* start new inspection */
3077  SCLogDebug("%p/%" PRIi64 " Start sid %u", frame, frame->id, s->id);
3078 
3079  /* call individual rule inspection */
3081  bool r = DetectRunInspectRuleHeader(p, f, s, s->flags);
3082  if (r) {
3083  r = DetectRunFrameInspectRule(tv, det_ctx, s, f, p, frames, frame);
3084  if (r) {
3085  /* match */
3086  DetectRunPostMatch(tv, det_ctx, p, s);
3087  det_ctx->frame_id = frame->id;
3088  SCLogDebug(
3089  "%p/%" PRIi64 " sig %u (%u) matched", frame, frame->id, s->id, s->iid);
3090  const uint8_t alert_flags =
3092  if (frame->flags & FRAME_FLAG_TX_ID_SET) {
3093  const uint8_t ipproto = p->proto;
3094  uint8_t sub_state = 0;
3095  void *tx = AppLayerParserGetTx(
3096  ipproto, alproto, p->flow->alstate, frame->tx_id);
3097  if (tx) {
3098  AppLayerTxData *txd = AppLayerParserGetTxData(ipproto, alproto, tx);
3099  sub_state = txd->tx_type;
3100  }
3101  AlertQueueAppendAppTx(det_ctx, s, p, frame->tx_id, sub_state, alert_flags);
3102  } else {
3103  AlertQueueAppendPacket(det_ctx, s, p, alert_flags);
3104  }
3105  }
3106  }
3107  DetectVarProcessList(det_ctx, p->flow, p);
3108  RULE_PROFILING_END(det_ctx, s, r == 1, p);
3109  }
3110 
3111  /* update Frame::inspect_progress here instead of in the code above. The reason is that a
3112  * frame might be used more than once in buffers with transforms. */
3113  if (frame->inspect_progress < det_ctx->frame_inspect_progress) {
3114  frame->inspect_progress = det_ctx->frame_inspect_progress;
3115  SCLogDebug("frame->inspect_progress: %" PRIu64 " -> updated", frame->inspect_progress);
3116  } else {
3117  SCLogDebug(
3118  "frame->inspect_progress: %" PRIu64 " -> not updated", frame->inspect_progress);
3119  }
3120 
3121  SCLogDebug("%p/%" PRIi64 " rules inspected, running cleanup", frame, frame->id);
3122  InspectionBufferClean(det_ctx);
3123  }
3124 }
3125 
3126 static DetectEngineThreadCtx *GetTenantById(HashTable *h, uint32_t id)
3127 {
3128  /* technically we need to pass a DetectEngineThreadCtx struct with the
3129  * tenant_id member. But as that member is the first in the struct, we
3130  * can use the id directly. */
3131  return HashTableLookup(h, &id, 0);
3132 }
3133 
3134 static void DetectFlow(ThreadVars *tv,
3136  Packet *p)
3137 {
3138  Flow *const f = p->flow;
3139 
3140  /* we check the flow drop here, and not the packet drop. This is
3141  * to allow stream engine "invalid" drop packets to still be
3142  * evaluated by the stream event rules. */
3143  if (f->flags & FLOW_ACTION_DROP) {
3145  SCReturn;
3146  }
3147 
3148  /* in firewall mode, we still need to run the fw rulesets even for exception policy pass */
3149  bool skip = (p->flags & PKT_NOPACKET_INSPECTION || f->flags & (FLOW_ACTION_PASS));
3150  if (EngineModeIsFirewall() && (f->flags & FLOW_ACTION_ACCEPT) == 0) {
3151  skip = false;
3152  }
3153  if (skip) {
3154  /* enforce prior accept:flow */
3155  if (f->flags & FLOW_ACTION_ACCEPT) {
3156  p->action |= ACTION_ACCEPT;
3157  }
3158  /* hack: if we are in pass the entire flow mode, we need to still
3159  * update the inspect_id forward. So test for the condition here,
3160  * and call the update code if necessary. */
3161  const int pass = (f->flags & (FLOW_ACTION_PASS | FLOW_ACTION_ACCEPT));
3162  if (pass) {
3163  uint8_t flags = STREAM_FLAGS_FOR_PACKET(p);
3165  if (f->alstate) {
3167  }
3168  }
3169  SCLogDebug("p->pcap %" PRIu64 ": no detection on packet, "
3170  "PKT_NOPACKET_INSPECTION is set",
3171  PcapPacketCntGet(p));
3172  return;
3173  }
3174 
3175  /* see if the packet matches one or more of the sigs */
3176  DetectRun(tv, de_ctx, det_ctx, p);
3177 }
3178 
3179 
3180 static void DetectNoFlow(ThreadVars *tv,
3182  Packet *p)
3183 {
3184  /* No need to perform any detection on this packet, if the given flag is set.*/
3186  return;
3187  }
3188 
3189  /* see if the packet matches one or more of the sigs */
3190  DetectRun(tv, de_ctx, det_ctx, p);
3191 }
3192 
3194 {
3195  const DetectEngineCtx *de_ctx = det_ctx->de_ctx;
3196  const SigGroupHead *sgh = de_ctx->pre_flow_sgh;
3197 
3198  SCLogDebug("thread id: %u, packet %" PRIu64 ", sgh %p", tv->id, PcapPacketCntGet(p), sgh);
3199  DetectRunPacketHook(tv, de_ctx, det_ctx, sgh, p, DETECT_FIREWALL_POLICY_PRE_FLOW);
3200  return p->action;
3201 }
3202 
3204 {
3205  const DetectEngineCtx *de_ctx = det_ctx->de_ctx;
3206  const int direction = (PKT_IS_TOCLIENT(p) != 0);
3207  const SigGroupHead *sgh = de_ctx->pre_stream_sgh[direction];
3208 
3209  SCLogDebug("thread id: %u, packet %" PRIu64 ", sgh %p", tv->id, PcapPacketCntGet(p), sgh);
3210  DetectRunPacketHook(tv, de_ctx, det_ctx, sgh, p, DETECT_FIREWALL_POLICY_PRE_STREAM);
3211  return p->action;
3212 }
3213 
3214 /** \brief Detection engine thread wrapper.
3215  * \param tv thread vars
3216  * \param p packet to inspect
3217  * \param data thread specific data
3218  * \param pq packet queue
3219  * \retval TM_ECODE_FAILED error
3220  * \retval TM_ECODE_OK ok
3221  */
3223 {
3225 
3226  DetectEngineCtx *de_ctx = NULL;
3227  DetectEngineThreadCtx *det_ctx = (DetectEngineThreadCtx *)data;
3228  if (det_ctx == NULL) {
3229  printf("ERROR: Detect has no thread ctx\n");
3230  goto error;
3231  }
3232 
3233  if (unlikely(SC_ATOMIC_GET(det_ctx->so_far_used_by_detect) == 0)) {
3234  (void)SC_ATOMIC_SET(det_ctx->so_far_used_by_detect, 1);
3235  SCLogDebug("Detect Engine using new det_ctx - %p",
3236  det_ctx);
3237  }
3238 
3239  /* if in MT mode _and_ we have tenants registered, use
3240  * MT logic. */
3241  if (det_ctx->mt_det_ctxs_cnt > 0 && det_ctx->TenantGetId != NULL)
3242  {
3243  uint32_t tenant_id = p->tenant_id;
3244  if (tenant_id == 0)
3245  tenant_id = det_ctx->TenantGetId(det_ctx, p);
3246  if (tenant_id > 0 && tenant_id < det_ctx->mt_det_ctxs_cnt) {
3247  p->tenant_id = tenant_id;
3248  det_ctx = GetTenantById(det_ctx->mt_det_ctxs_hash, tenant_id);
3249  if (det_ctx == NULL)
3250  return TM_ECODE_OK;
3251  de_ctx = det_ctx->de_ctx;
3252  if (de_ctx == NULL)
3253  return TM_ECODE_OK;
3254 
3255  if (unlikely(SC_ATOMIC_GET(det_ctx->so_far_used_by_detect) == 0)) {
3256  (void)SC_ATOMIC_SET(det_ctx->so_far_used_by_detect, 1);
3257  SCLogDebug("MT de_ctx %p det_ctx %p (tenant %u)", de_ctx, det_ctx, tenant_id);
3258  }
3259  } else {
3260  /* use default if no tenants are registered for this packet */
3261  de_ctx = det_ctx->de_ctx;
3262  }
3263  } else {
3264  de_ctx = det_ctx->de_ctx;
3265  }
3266 
3267  if (p->flow) {
3268  DetectFlow(tv, de_ctx, det_ctx, p);
3269  } else {
3270  DetectNoFlow(tv, de_ctx, det_ctx, p);
3271  }
3272 
3273 #ifdef PROFILE_RULES
3274  /* aggregate statistics */
3275  struct timeval ts;
3276  gettimeofday(&ts, NULL);
3277  if (ts.tv_sec != det_ctx->rule_perf_last_sync) {
3278  SCProfilingRuleThreatAggregate(det_ctx);
3279  det_ctx->rule_perf_last_sync = ts.tv_sec;
3280  }
3281 #endif
3282 
3283  return TM_ECODE_OK;
3284 error:
3285  return TM_ECODE_FAILED;
3286 }
3287 
3288 /** \brief disable file features we don't need
3289  * Called if we have no detection engine.
3290  */
3292 {
3293  DetectPostInspectFileFlagsUpdate(f, NULL /* no sgh */, STREAM_TOSERVER);
3294  DetectPostInspectFileFlagsUpdate(f, NULL /* no sgh */, STREAM_TOCLIENT);
3295 }
3296 
3297 #if defined(UNITTESTS) || defined(FUZZ)
3298 /**
3299  * \brief wrapper for old tests
3300  */
3303 {
3304  if (p->flow) {
3305  DetectFlow(tv, de_ctx, det_ctx, p);
3306  } else {
3307  DetectNoFlow(tv, de_ctx, det_ctx, p);
3308  }
3309 }
3310 #endif
3311 
3312 /*
3313  * TESTS
3314  */
3315 
3316 #ifdef UNITTESTS
3317 #include "tests/detect.c"
3318 #endif
PKT_IS_TOCLIENT
#define PKT_IS_TOCLIENT(p)
Definition: decode.h:240
default_accept
thread_local Signature default_accept
Definition: detect.c:2240
DetectEngineAppInspectionEngine_::stream
bool stream
Definition: detect.h:425
PacketCheckAction
bool PacketCheckAction(const Packet *p, const uint8_t a)
Definition: packet.c:50
FLOWFILE_NO_MD5_TS
#define FLOWFILE_NO_MD5_TS
Definition: flow.h:148
RulesDumpTxMatchArray
void RulesDumpTxMatchArray(const DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, const Packet *p, const uint64_t tx_id, const uint32_t rule_cnt, const uint32_t pkt_prefilter_cnt)
Definition: detect-engine-profile.c:34
SIG_GROUP_HEAD_HAVEFILEMD5
#define SIG_GROUP_HEAD_HAVEFILEMD5
Definition: detect.h:1572
DETECT_TX_FW_FC_SKIP
@ DETECT_TX_FW_FC_SKIP
Definition: detect.c:1176
DetectFirewallPolicies
Definition: detect.h:962
PACKET_ALERT_FLAG_TX_GUESSED
#define PACKET_ALERT_FLAG_TX_GUESSED
Definition: decode.h:280
FLOWFILE_NO_MD5_TC
#define FLOWFILE_NO_MD5_TC
Definition: flow.h:149
SigGroupHead_::tx_engines
PrefilterEngine * tx_engines
Definition: detect.h:1736
DetectEngineAppInspectionEngine_
Definition: detect.h:420
Packet_::proto
uint8_t proto
Definition: decode.h:538
DetectTransaction_::tx_data_ptr
struct AppLayerTxData * tx_data_ptr
Definition: detect-engine-prefilter.h:34
DetectEngineAppInspectionEngine_::mpm
bool mpm
Definition: detect.h:424
DE_STATE_CHUNK_SIZE
#define DE_STATE_CHUNK_SIZE
Definition: detect-engine-state.h:55
RuleMatchCandidateTx::stream_stored
bool stream_stored
Definition: detect.h:1275
Frame::inspect_progress
uint64_t inspect_progress
Definition: app-layer-frames.h:55
DetectEngineThreadCtx_::alert_queue_size
uint16_t alert_queue_size
Definition: detect.h:1401
PROF_DETECT_GETSGH
@ PROF_DETECT_GETSGH
Definition: suricata-common.h:472
ts
uint64_t ts
Definition: source-erf-file.c:68
AppLayerTxData::flags
uint8_t flags
Definition: app-layer-parser.h:182
PacketAlerts_::firewall_discarded
uint16_t firewall_discarded
Definition: decode.h:291
DetectEngineAppInspectionEngine_::v2
struct DetectEngineAppInspectionEngine_::@82 v2
SCAppLayerParserStateIssetFlag
uint16_t SCAppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:2079
FLOW_ACTION_BY_FIREWALL
#define FLOW_ACTION_BY_FIREWALL
Definition: flow.h:126
detect-engine.h
detect-engine-proto.h
DetectEngineThreadCtx_::match_array_cnt
SigIntId match_array_cnt
Definition: detect.h:1415
Frame::tx_id
uint64_t tx_id
Definition: app-layer-frames.h:54
DetectEngineStateDirection_::flags
uint8_t flags
Definition: detect-engine-state.h:91
DetectEngineThreadCtx_::counter_alerts
StatsCounterId counter_alerts
Definition: detect.h:1361
detect-dsize.h
Signature_::addr_src_match6
DetectMatchAddressIPv6 * addr_src_match6
Definition: detect.h:739
Flow_::flags
uint64_t flags
Definition: flow.h:409
SIG_FLAG_FW_HOOK_LTE
#define SIG_FLAG_FW_HOOK_LTE
Definition: detect.h:255
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
PKT_HAS_FLOW
#define PKT_HAS_FLOW
Definition: decode.h:1311
RuleMatchCandidateTx::fw_lte_header_ok
bool fw_lte_header_ok
Definition: detect.h:1271
DetectEngineCtx_::decoder_event_sgh
struct SigGroupHead_ * decoder_event_sgh
Definition: detect.h:1084
FlowGetPacketDirection
int FlowGetPacketDirection(const Flow *f, const Packet *p)
determine the direction of the packet compared to the flow
Definition: flow.c:285
DetectEngineCtx_::flow_gh
DetectEngineLookupFlow flow_gh[FLOW_STATES]
Definition: detect.h:1023
DETECT_TABLE_APP_FILTER
@ DETECT_TABLE_APP_FILTER
Definition: detect.h:570
DE_STATE_FLAG_SIG_CANT_MATCH
#define DE_STATE_FLAG_SIG_CANT_MATCH
Definition: detect-engine-state.h:59
DetectFirewallAppPolicy
Definition: detect.h:951
DetectEngineAppInspectionEngine_::next
struct DetectEngineAppInspectionEngine_ * next
Definition: detect.h:446
DETECT_PROTO_IPV6
#define DETECT_PROTO_IPV6
Definition: detect-engine-proto.h:32
detect-engine-siggroup.h
SigGroupHead_::flags
uint16_t flags
Definition: detect.h:1725
PostRuleMatchWorkQueue::len
uint32_t len
Definition: detect.h:1299
PKT_IS_PSEUDOPKT
#define PKT_IS_PSEUDOPKT(p)
return 1 if the packet is a pseudo packet
Definition: decode.h:1364
DetectEngineState_
Definition: detect-engine-state.h:95
stream-tcp.h
PrefilterRuleStore_::rule_id_array_cnt
uint32_t rule_id_array_cnt
Definition: util-prefilter.h:40
detect-engine-event.h
SigGroupHead_
Container for matching data for a signature group.
Definition: detect.h:1724
PACKET_ALERT_FLAG_STATE_MATCH
#define PACKET_ALERT_FLAG_STATE_MATCH
Definition: decode.h:270
DetectEngineCtx_::guess_applayer
bool guess_applayer
Definition: detect.h:1046
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
detect.c
AppLayerTxData::tx_type
uint8_t tx_type
Definition: app-layer-parser.h:215
SC_ATOMIC_SET
#define SC_ATOMIC_SET(name, val)
Set the value for the atomic variable.
Definition: util-atomic.h:386
PKT_DROP_REASON_FW_RULES
@ PKT_DROP_REASON_FW_RULES
Definition: decode.h:407
Signature_::app_progress_hook
uint8_t app_progress_hook
Definition: detect.h:729
AppLayerFramesGetContainer
FramesContainer * AppLayerFramesGetContainer(const Flow *f)
Definition: app-layer-parser.c:209
KEYWORD_PROFILING_SET_LIST
#define KEYWORD_PROFILING_SET_LIST(ctx, list)
Definition: util-profiling.h:46
DetectAddressMatchIPv4
int DetectAddressMatchIPv4(const DetectMatchAddressIPv4 *addrs, uint16_t addrs_cnt, const Address *a)
Match a packets address against a signatures addrs array.
Definition: detect-engine-address.c:1604
PcapPacketCntGet
uint64_t PcapPacketCntGet(const Packet *p)
Definition: decode.c:1193
DetectEngineAppInspectionEngine_::Callback
InspectEngineFuncPtr Callback
Definition: detect.h:439
Signature_::alproto
AppProto alproto
Definition: detect.h:697
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:282
FLOW_SGH_TOCLIENT
#define FLOW_SGH_TOCLIENT
Definition: flow.h:75
AppLayerParserSetTransactionInspectId
void AppLayerParserSetTransactionInspectId(const Flow *f, AppLayerParserState *pstate, void *alstate, const uint8_t flags, bool tag_txs_as_inspected)
Definition: app-layer-parser.c:844
DETECT_TX_FW_FC_OK
@ DETECT_TX_FW_FC_OK
Definition: detect.c:1175
DetectEngineStateDirection_::cnt
SigIntId cnt
Definition: detect-engine-state.h:89
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:783
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
SigMatchData_::is_last
bool is_last
Definition: detect.h:371
AppLayerTxData::de_state
DetectEngineState * de_state
Definition: app-layer-parser.h:223
InspectionBufferClean
void InspectionBufferClean(DetectEngineThreadCtx *det_ctx)
Definition: detect-engine-inspect-buffer.c:30
Flow_::proto
uint8_t proto
Definition: flow.h:382
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:87
PacketAlerts_::cnt
uint16_t cnt
Definition: decode.h:289
DetectEngineThreadCtx_::tx_id
uint64_t tx_id
Definition: detect.h:1392
SCFlowGetAppProtocol
AppProto SCFlowGetAppProtocol(const Flow *f)
Definition: flow.c:1290
SigMatchData_::ctx
SigMatchCtx * ctx
Definition: detect.h:372
action-globals.h
FLOWFILE_NO_MAGIC_TS
#define FLOWFILE_NO_MAGIC_TS
Definition: flow.h:140
FramesContainer::toserver
Frames toserver
Definition: app-layer-frames.h:74
Packet_::flags
uint32_t flags
Definition: decode.h:562
ssn
TcpSession ssn
Definition: fuzz_dataset.c:31
Packet_::action
uint8_t action
Definition: decode.h:624
ICMPV4_DEST_UNREACH_IS_VALID
#define ICMPV4_DEST_UNREACH_IS_VALID(p)
Definition: decode-icmpv4.h:253
Frame
Definition: app-layer-frames.h:45
Flow_
Flow data structure.
Definition: flow.h:360
DetectFirewallPacketPolicies
DetectFirewallPacketPolicies
Definition: detect.h:938
PROF_DETECT_ALERT
@ PROF_DETECT_ALERT
Definition: suricata-common.h:483
DetectEngineThreadCtx_::pmq
PrefilterRuleStore pmq
Definition: detect.h:1429
SIG_GROUP_HEAD_HAVEFILESHA1
#define SIG_GROUP_HEAD_HAVEFILESHA1
Definition: detect.h:1574
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its normalized string equivalent.
Definition: app-layer-protos.c:53
FLOW_TC_APP_UPDATED
#define FLOW_TC_APP_UPDATED
Definition: flow.h:120
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:995
DetectEngineCtx_::pre_stream_sgh
struct SigGroupHead_ * pre_stream_sgh[2]
Definition: detect.h:1225
DETECT_PROTO_ETHERNET
#define DETECT_PROTO_ETHERNET
Definition: detect-engine-proto.h:33
DetectRunScratchpad
struct DetectRunScratchpad DetectRunScratchpad
DetectFirewallAppPolicy::policy
struct DetectFirewallPolicy policy
Definition: detect.h:956
PROF_DETECT_PF_TX
@ PROF_DETECT_PF_TX
Definition: suricata-common.h:478
Frames::cnt
uint16_t cnt
Definition: app-layer-frames.h:61
Frame::id
int64_t id
Definition: app-layer-frames.h:53
DetectFirewallPolicies::pkt_policy_signatures
Signature * pkt_policy_signatures[DETECT_FIREWALL_POLICY_SIZE]
Definition: detect.h:965
DetectEngineThreadCtx_::p
Packet * p
Definition: detect.h:1396
DetectEngineState_::dir_state
DetectEngineStateDirection dir_state[2]
Definition: detect-engine-state.h:96
FrameGetByIndex
Frame * FrameGetByIndex(Frames *frames, const uint32_t idx)
Definition: app-layer-frames.c:146
RuleMatchCandidateTx::id
SigIntId id
Definition: detect.h:1269
PROF_DETECT_CLEANUP
@ PROF_DETECT_CLEANUP
Definition: suricata-common.h:485
SIG_FLAG_DST_ANY
#define SIG_FLAG_DST_ANY
Definition: detect.h:245
ACTION_SCOPE_FLOW
@ ACTION_SCOPE_FLOW
Definition: action-globals.h:45
NO_TX
#define NO_TX
Definition: detect.c:1565
FLOW_PKT_TOSERVER
#define FLOW_PKT_TOSERVER
Definition: flow.h:237
HashTable_
Definition: util-hash.h:35
SIG_FLAG_TXBOTHDIR
#define SIG_FLAG_TXBOTHDIR
Definition: detect.h:253
MIN
#define MIN(x, y)
Definition: suricata-common.h:422
Packet_::sig_mask
SignatureMask sig_mask
Definition: decode.h:553
Frames
Definition: app-layer-frames.h:60
FramesContainer
Definition: app-layer-frames.h:73
DetectFirewallAppTxState::fw_skip_app_filter
bool fw_skip_app_filter
Definition: detect.c:1729
PacketAlerts_::drop
PacketAlert drop
Definition: decode.h:296
DetectEngineThreadCtx_::counter_alerts_overflow
StatsCounterId counter_alerts_overflow
Definition: detect.h:1363
DetectRunScratchpad
Definition: detect.c:70
SIG_GROUP_HEAD_HAVERAWSTREAM
#define SIG_GROUP_HEAD_HAVERAWSTREAM
Definition: detect.h:1568
FLOW_ACTION_DROP
#define FLOW_ACTION_DROP
Definition: flow.h:70
DetectFirewallAppTxState::fw_lte_cover_active
bool fw_lte_cover_active
Definition: detect.c:1739
TcpStream_::flags
uint16_t flags
Definition: stream-tcp-private.h:107
FLOWFILE_NONE
#define FLOWFILE_NONE
Definition: flow.h:172
detect-engine-frame.h
SigMatchSignatures
void SigMatchSignatures(ThreadVars *tv, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p)
wrapper for old tests
Definition: detect.c:3301
p
Packet * p
Definition: fuzz_dataset.c:30
Signature_::sm_arrays
SigMatchData * sm_arrays[DETECT_SM_LIST_MAX]
Definition: detect.h:759
proto
uint8_t proto
Definition: decode-template.h:0
m
SCMutex m
Definition: flow-hash.h:6
DetectPort_::sh
struct SigGroupHead_ * sh
Definition: detect.h:234
PKT_NOPAYLOAD_INSPECTION
#define PKT_NOPAYLOAD_INSPECTION
Definition: decode.h:1297
PACKET_PROFILING_DETECT_END
#define PACKET_PROFILING_DETECT_END(p, id)
Definition: util-profiling.h:221
DetectEngineThreadCtx_::counter_alerts_suppressed
StatsCounterId counter_alerts_suppressed
Definition: detect.h:1367
Detect
TmEcode Detect(ThreadVars *tv, Packet *p, void *data)
Detection engine thread wrapper.
Definition: detect.c:3222
detect-engine-payload.h
DetectEngineThreadCtx_::counter_firewall_discarded_alerts
StatsCounterId counter_firewall_discarded_alerts
Definition: detect.h:1365
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:547
EngineModeIsFirewall
bool EngineModeIsFirewall(void)
Definition: suricata.c:239
SIG_FLAG_SRC_ANY
#define SIG_FLAG_SRC_ANY
Definition: detect.h:244
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:82
DetectRunFrameInspectRule
bool DetectRunFrameInspectRule(ThreadVars *tv, DetectEngineThreadCtx *det_ctx, const Signature *s, Flow *f, Packet *p, const Frames *frames, const Frame *frame)
Definition: detect-engine-frame.c:229
Flow_::protoctx
void * protoctx
Definition: flow.h:439
DetectFirewallAppTxState::skip_before_progress
uint8_t skip_before_progress
Definition: detect.c:1731
AppLayerGetTxIterTuple::tx_ptr
void * tx_ptr
Definition: app-layer-parser.h:160
SigMatchData_
Data needed for Match()
Definition: detect.h:369
DetectFirewallAppPolicy::alert_signature
Signature * alert_signature
Definition: detect.h:959
DeStateStoreItem_::sid
SigIntId sid
Definition: detect-engine-state.h:77
RuleMatchCandidateTx::s
const Signature * s
Definition: detect.h:1281
KEYWORD_PROFILING_START
#define KEYWORD_PROFILING_START
Definition: util-profiling.h:50
SigMatchData_::type
uint16_t type
Definition: detect.h:370
DetectEngineCtx_::version
uint32_t version
Definition: detect.h:1080
DetectFirewallPolicy::action
uint8_t action
Definition: detect.h:947
DisableDetectFlowFileFlags
void DisableDetectFlowFileFlags(Flow *f)
disable file features we don't need Called if we have no detection engine.
Definition: detect.c:3291
AppLayerParserGetTransactionInspectId
uint64_t AppLayerParserGetTransactionInspectId(AppLayerParserState *pstate, uint8_t direction)
Definition: app-layer-parser.c:813
Packet_::alerts
PacketAlerts alerts
Definition: decode.h:637
detect-engine-prefilter.h
DetectRunPrefilterFrame
void DetectRunPrefilterFrame(DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p, const Frames *frames, const Frame *frame, const AppProto alproto)
Definition: detect-engine-frame.c:74
Packet_::events
PacketEngineEvents events
Definition: decode.h:643
Signature_::frame_inspect
DetectEngineFrameInspectionEngine * frame_inspect
Definition: detect.h:755
PROF_DETECT_PF_SORT2
@ PROF_DETECT_PF_SORT2
Definition: suricata-common.h:481
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:81
PacketCreateMask
void PacketCreateMask(Packet *p, SignatureMask *mask, AppProto alproto, bool app_decoder_events)
Definition: detect-engine-build.c:406
SIG_FLAG_APPLAYER
#define SIG_FLAG_APPLAYER
Definition: detect.h:252
KEYWORD_PROFILING_END
#define KEYWORD_PROFILING_END(ctx, type, m)
Definition: util-profiling.h:64
detect-flowvar.h
RuleMatchCandidateTx::fw_lte_counted
bool fw_lte_counted
Definition: detect.h:1270
DetectEngineThreadCtx_::mt_det_ctxs_hash
HashTable * mt_det_ctxs_hash
Definition: detect.h:1328
PacketAlert_::action
uint8_t action
Definition: decode.h:251
TcpSession_::flags
uint32_t flags
Definition: stream-tcp-private.h:294
DetectEnginePktInspectionRun
bool DetectEnginePktInspectionRun(ThreadVars *tv, DetectEngineThreadCtx *det_ctx, const Signature *s, Flow *f, Packet *p, uint8_t *alert_flags)
Definition: detect-engine.c:1999
SIG_FLAG_FIREWALL
#define SIG_FLAG_FIREWALL
Definition: detect.h:249
Flow_::sgh_toserver
const struct SigGroupHead_ * sgh_toserver
Definition: flow.h:492
PROF_DETECT_TX_UPDATE
@ PROF_DETECT_TX_UPDATE
Definition: suricata-common.h:484
DetectEngineAppInspectionEngine_::id
uint8_t id
Definition: detect.h:423
DetectRunStoreStateTx
void DetectRunStoreStateTx(const SigGroupHead *sgh, Flow *f, void *tx, uint64_t tx_id, const Signature *s, uint32_t inspect_flags, uint8_t flow_flags, const uint16_t file_no_match)
Definition: detect-engine-state.c:213
StatsCounterAvgAddI64
void StatsCounterAvgAddI64(StatsThreadContext *stats, StatsCounterAvgId id, int64_t x)
Definition: counters.c:239
DetectEngineAppInspectionEngine_::sm_list
uint16_t sm_list
Definition: detect.h:428
FLOWFILE_INIT
#define FLOWFILE_INIT
Definition: flow.h:137
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:484
FLOW_ACTION_PASS
#define FLOW_ACTION_PASS
Definition: flow.h:117
DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
#define DETECT_ENGINE_INSPECT_SIG_CANT_MATCH_FILES
Definition: detect-engine-state.h:46
FLOWFILE_NO_SHA1_TC
#define FLOWFILE_NO_SHA1_TC
Definition: flow.h:153
DETECT_SM_LIST_POSTMATCH
@ DETECT_SM_LIST_POSTMATCH
Definition: detect.h:128
FramesContainer::toclient
Frames toclient
Definition: app-layer-frames.h:75
DetectEngineCtx_::pre_flow_sgh
struct SigGroupHead_ * pre_flow_sgh
Definition: detect.h:1230
DetectEngineThreadCtx_::tx_candidates
RuleMatchCandidateTx * tx_candidates
Definition: detect.h:1417
SIG_TYPE_PKT
@ SIG_TYPE_PKT
Definition: detect.h:73
Signature_::addr_src_match4
DetectMatchAddressIPv4 * addr_src_match4
Definition: detect.h:736
decode.h
PKT_SRC_WIRE
@ PKT_SRC_WIRE
Definition: decode.h:52
DetectEngineCtx_::fw_policies
struct DetectFirewallPolicies * fw_policies
Definition: detect.h:1026
DETECT_PROTO_ARP
#define DETECT_PROTO_ARP
Definition: detect-engine-proto.h:34
TOSERVER
#define TOSERVER
Definition: flow.h:46
DetectTransaction_::tx_end_state
const uint8_t tx_end_state
Definition: detect-engine-prefilter.h:44
DetectEngineThreadCtx_::counter_mpm_list
StatsCounterAvgId counter_mpm_list
Definition: detect.h:1369
AppLayerTxData
Definition: app-layer-parser.h:172
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:22
PKT_IS_TOSERVER
#define PKT_IS_TOSERVER(p)
Definition: decode.h:239
DetectFirewallAppTxState::skip_fw_hook
bool skip_fw_hook
Definition: detect.c:1730
Prefilter
void Prefilter(DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p, const uint8_t flags, const SignatureMask mask)
Definition: detect-engine-prefilter.c:244
DetectTransaction_::detect_progress_orig
const uint8_t detect_progress_orig
Definition: detect-engine-prefilter.h:41
DetectEngineThreadCtx_
Definition: detect.h:1316
DEBUG_VALIDATE_PACKET
#define DEBUG_VALIDATE_PACKET(p)
Definition: util-validate.h:108
DeStateStoreItem_::flags
uint32_t flags
Definition: detect-engine-state.h:76
PKT_STREAM_ADD
#define PKT_STREAM_ADD
Definition: decode.h:1305
DetectTransaction_::detect_progress
uint8_t detect_progress
Definition: detect-engine-prefilter.h:39
AlertQueueAppendAppTxFromPacket
void AlertQueueAppendAppTxFromPacket(DetectEngineThreadCtx *det_ctx, const Signature *s, Packet *p, uint64_t tx_id, const uint8_t sub_state, uint8_t alert_flags)
Append signature to local packet alert queue for later preprocessing This does not automatically set ...
Definition: detect-engine-alert.c:435
BIT_U32
#define BIT_U32(n)
Definition: suricata-common.h:431
DetectEngineThreadCtx_::tx_candidates_size
uint32_t tx_candidates_size
Definition: detect.h:1418
FRAME_FLAG_TX_ID_SET
#define FRAME_FLAG_TX_ID_SET
Definition: app-layer-frames.h:38
PKT_PSEUDO_STREAM_END
#define PKT_PSEUDO_STREAM_END
Definition: decode.h:1313
DETECT_TX_FW_FC_BREAK
@ DETECT_TX_FW_FC_BREAK
Definition: detect.c:1177
PKT_IS_FRAGMENT
#define PKT_IS_FRAGMENT
Definition: decode.h:1335
BOOL2STR
#define BOOL2STR(b)
Definition: util-debug.h:542
STREAM_FLAGS_FOR_PACKET
#define STREAM_FLAGS_FOR_PACKET(p)
Definition: stream.h:30
SCEnter
#define SCEnter(...)
Definition: util-debug.h:284
PMQ_RESET
#define PMQ_RESET(pmq)
Definition: util-prefilter.h:46
detect-engine-mpm.h
DetectEngineLookupFlow_::sgh
struct SigGroupHead_ * sgh[256]
Definition: detect.h:894
HashTableLookup
void * HashTableLookup(HashTable *ht, void *data, uint16_t datalen)
Definition: util-hash.c:194
AppLayerGetTxIterTuple::tx_id
uint64_t tx_id
Definition: app-layer-parser.h:161
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
DeStateStore_::next
struct DeStateStore_ * next
Definition: detect-engine-state.h:82
DetectTransaction_::is_last
bool is_last
Definition: detect-engine-prefilter.h:45
Packet_::sp
Port sp
Definition: decode.h:523
FLOWFILE_NO_SHA256_TS
#define FLOWFILE_NO_SHA256_TS
Definition: flow.h:156
DETECT_ENGINE_INSPECT_SIG_MATCH
#define DETECT_ENGINE_INSPECT_SIG_MATCH
Definition: detect-engine-state.h:41
PKT_DETECT_HAS_STREAMDATA
#define PKT_DETECT_HAS_STREAMDATA
Definition: decode.h:1350
FLOW_PKT_TOCLIENT_FIRST
#define FLOW_PKT_TOCLIENT_FIRST
Definition: flow.h:241
DetectFirewallPolicies::pkt
struct DetectFirewallPolicy pkt[DETECT_FIREWALL_POLICY_SIZE]
Definition: detect.h:964
StreamReassembleRawHasDataReady
bool StreamReassembleRawHasDataReady(TcpSession *ssn, Packet *p)
does the stream engine have data to inspect?
Definition: stream-tcp-reassemble.c:1509
detect-engine-port.h
PktSrcToString
const char * PktSrcToString(enum PktSrcEnum pkt_src)
Definition: decode.c:894
DetectFirewallAppPolicy::progress
uint8_t progress
Definition: detect.h:954
DetectPort_
Port structure for detection engine.
Definition: detect.h:223
PacketAlerts_::discarded
uint16_t discarded
Definition: decode.h:290
app-layer-parser.h
Signature_::app_inspect
DetectEngineAppInspectionEngine * app_inspect
Definition: detect.h:753
ThreadVars_::id
int id
Definition: threadvars.h:86
AppLayerParserGetStateProgress
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *tx, uint8_t flags)
get the progress value for a tx/protocol
Definition: app-layer-parser.c:1199
util-detect.h
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:331
detect-engine-profile.h
Flow_::sgh_toclient
const struct SigGroupHead_ * sgh_toclient
Definition: flow.h:489
DetectEngineThreadCtx_::base64_decoded_len
int base64_decoded_len
Definition: detect.h:1399
SIG_FLAG_REQUIRE_FLOWVAR
#define SIG_FLAG_REQUIRE_FLOWVAR
Definition: detect.h:270
RuleMatchCandidateTx::stream_result
uint8_t stream_result
Definition: detect.h:1276
Signature_::action
uint8_t action
Definition: detect.h:707
util-profiling.h
DetectTransaction_::tx_id
const uint64_t tx_id
Definition: detect-engine-prefilter.h:33
DetectEngineLookupFlow_::udp
DetectPort * udp
Definition: detect.h:893
DetectEngineThreadCtx_::raw_stream_progress
uint64_t raw_stream_progress
Definition: detect.h:1337
SigIntId
#define SigIntId
Definition: detect-engine-state.h:38
FileUpdateFlowFileFlags
void FileUpdateFlowFileFlags(Flow *f, uint16_t set_file_flags, uint8_t direction)
set a flow's file flags
Definition: util-file.c:1091
SCReturn
#define SCReturn
Definition: util-debug.h:286
Signature_::flags
uint32_t flags
Definition: detect.h:693
RuleMatchCandidateTxArrayFree
void RuleMatchCandidateTxArrayFree(DetectEngineThreadCtx *det_ctx)
Definition: detect.c:1193
AppLayerGetTxIterState
Definition: app-layer-parser.h:148
ACTION_ALERT
#define ACTION_ALERT
Definition: action-globals.h:29
Packet_
Definition: decode.h:516
detect-engine-build.h
ACTION_SCOPE_TX
@ ACTION_SCOPE_TX
Definition: action-globals.h:47
DetectEngineThreadCtx_::frame_id
int64_t frame_id
Definition: detect.h:1393
detect-engine-alert.h
AppLayerTxData::guessed_applayer_logged
uint8_t guessed_applayer_logged
Definition: app-layer-parser.h:202
DetectEngineThreadCtx_::filestore_cnt
uint16_t filestore_cnt
Definition: detect.h:1358
PROF_DETECT_IPONLY
@ PROF_DETECT_IPONLY
Definition: suricata-common.h:473
RULE_PROFILING_END
#define RULE_PROFILING_END(a, b, c, p)
Definition: util-profiling.h:422
TmEcode
TmEcode
Definition: tm-threads-common.h:80
RULE_PROFILING_START
#define RULE_PROFILING_START(p)
Definition: util-profiling.h:421
ALPROTO_DOH2
@ ALPROTO_DOH2
Definition: app-layer-protos.h:66
SCReturnPtr
#define SCReturnPtr(x, type)
Definition: util-debug.h:300
DetectPreFlow
uint8_t DetectPreFlow(ThreadVars *tv, DetectEngineThreadCtx *det_ctx, Packet *p)
Definition: detect.c:3193
DetectTransaction_::de_state
DetectEngineStateDirection * de_state
Definition: detect-engine-prefilter.h:35
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
detect-filestore.h
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1501
DetectTransaction_::tx_type
const uint8_t tx_type
Definition: detect-engine-prefilter.h:48
DetectFirewallAppTxState::last_fw_rule
bool last_fw_rule
Definition: detect.c:1734
detect-replace.h
AppLayerGetTxIterTuple
Definition: app-layer-parser.h:159
RulesDumpMatchArray
void RulesDumpMatchArray(const DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, const Packet *p)
Definition: detect-engine-profile.c:81
ALPROTO_HTTP2
@ ALPROTO_HTTP2
Definition: app-layer-protos.h:69
Signature_::addr_dst_match6_cnt
uint16_t addr_dst_match6_cnt
Definition: detect.h:719
AppLayerTxData::detect_progress_ts
uint8_t detect_progress_ts
Definition: app-layer-parser.h:210
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:238
SigGroupHead_::frame_engines
PrefilterEngine * frame_engines
Definition: detect.h:1737
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:292
Signature_::sp
DetectPort * sp
Definition: detect.h:747
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1219
DetectRunScratchpad::sgh
const SigGroupHead * sgh
Definition: detect.c:75
PACKET_ALERT_FLAG_APPLY_ACTION_TO_PACKET
#define PACKET_ALERT_FLAG_APPLY_ACTION_TO_PACKET
Definition: decode.h:282
DETECT_FIREWALL_POLICY_PRE_STREAM
@ DETECT_FIREWALL_POLICY_PRE_STREAM
Definition: detect.h:941
PacketAlertFinalize
void PacketAlertFinalize(const DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p)
Check the threshold of the sigs that match, set actions, break on pass action This function iterate t...
Definition: detect-engine-alert.c:829
DETECT_ENGINE_INSPECT_SIG_CANT_MATCH
#define DETECT_ENGINE_INSPECT_SIG_CANT_MATCH
Definition: detect-engine-state.h:42
DETECT_ENGINE_STATE_FLAG_FILE_NEW
#define DETECT_ENGINE_STATE_FLAG_FILE_NEW
Definition: detect-engine-state.h:73
Flow_::flowvar
GenericVar * flowvar
Definition: flow.h:495
RuleMatchCandidateTx::flags
uint32_t * flags
Definition: detect.h:1272
PACKET_ALERT_FLAG_FRAME
#define PACKET_ALERT_FLAG_FRAME
Definition: decode.h:278
Frame::flags
uint8_t flags
Definition: app-layer-frames.h:47
DetectEngineAppInspectionEngine_::alproto
AppProto alproto
Definition: detect.h:421
SCRealloc
#define SCRealloc(ptr, sz)
Definition: util-mem.h:50
detect-engine-analyzer.h
FLOWFILE_NO_SHA256_TC
#define FLOWFILE_NO_SHA256_TC
Definition: flow.h:157
DetectEngineStateDirection_::head
DeStateStore * head
Definition: detect-engine-state.h:86
DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_FILES
#define DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_FILES
Definition: detect-engine-state.h:52
DetectEngineCtx_::eth_non_ip_sgh
struct SigGroupHead_ * eth_non_ip_sgh
Definition: detect.h:1087
APP_LAYER_MAX_PROGRESS
#define APP_LAYER_MAX_PROGRESS
Definition: app-layer-parser.h:81
DetectProto_::flags
uint8_t flags
Definition: detect-engine-proto.h:40
th_v
ThreadVars * th_v
Definition: fuzz_dataset.c:29
DETECT_PROTO_IPV4
#define DETECT_PROTO_IPV4
Definition: detect-engine-proto.h:31
app-layer-frames.h
DetectAddressMatchIPv6
int DetectAddressMatchIPv6(const DetectMatchAddressIPv6 *addrs, uint16_t addrs_cnt, const Address *a)
Match a packets address against a signatures addrs array.
Definition: detect-engine-address.c:1637
Packet_::tenant_id
uint32_t tenant_id
Definition: decode.h:678
Packet_::flow
struct Flow_ * flow
Definition: decode.h:564
DetectEngineStateResetTxs
void DetectEngineStateResetTxs(Flow *f)
Reset de state for active tx' To be used on detect engine reload.
Definition: detect-engine-state.c:259
FLOWFILE_NO_MAGIC_TC
#define FLOWFILE_NO_MAGIC_TC
Definition: flow.h:141
flags
uint8_t flags
Definition: decode-gre.h:0
SCGenericVarFree
void SCGenericVarFree(GenericVar *gv)
Definition: util-var.c:48
suricata-common.h
SIG_FLAG_SP_ANY
#define SIG_FLAG_SP_ANY
Definition: detect.h:246
ActionScope
ActionScope
Definition: action-globals.h:42
DETECT_FIREWALL_POLICY_PACKET_FILTER
@ DETECT_FIREWALL_POLICY_PACKET_FILTER
Definition: detect.h:939
AppLayerTxData::updated_tc
bool updated_tc
Definition: app-layer-parser.h:179
ACTION_SCOPE_HOOK
@ ACTION_SCOPE_HOOK
Definition: action-globals.h:46
Signature_::action_scope
uint8_t action_scope
Definition: detect.h:714
packet.h
DeStateStore_
Definition: detect-engine-state.h:80
ACTION_DROP
#define ACTION_DROP
Definition: action-globals.h:30
DetectTransaction_
Definition: detect-engine-prefilter.h:31
Packet_::app_update_direction
uint8_t app_update_direction
Definition: decode.h:550
PROF_DETECT_SETUP
@ PROF_DETECT_SETUP
Definition: suricata-common.h:471
DetectEngineStateDirection_
Definition: detect-engine-state.h:85
DetectEngineThreadCtx_::frame_inspect_progress
uint64_t frame_inspect_progress
Definition: detect.h:1394
DetectEngineCtx_::profile_match_logging_threshold
uint32_t profile_match_logging_threshold
Definition: detect.h:1119
FLOW_TS_APP_UPDATED
#define FLOW_TS_APP_UPDATED
Definition: flow.h:119
Signature_::proto
DetectProto * proto
Definition: detect.h:711
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1420
FatalError
#define FatalError(...)
Definition: util-debug.h:517
DetectFirewallAppTxState::fw_next_progress_missing
bool fw_next_progress_missing
Definition: detect.c:1733
AppLayerTxData::detect_progress_tc
uint8_t detect_progress_tc
Definition: app-layer-parser.h:211
TcpSession_::client
TcpStream client
Definition: stream-tcp-private.h:297
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:34
DetectFirewallAppTxState
Definition: detect.c:1728
AlertQueueAppendPacket
void AlertQueueAppendPacket(DetectEngineThreadCtx *det_ctx, const Signature *s, Packet *p, uint8_t alert_flags)
Append signature to local packet alert queue for later preprocessing.
Definition: detect-engine-alert.c:445
FLOW_ACTION_ACCEPT
#define FLOW_ACTION_ACCEPT
Definition: flow.h:64
util-validate.h
DetectTransaction_::tx_ptr
void * tx_ptr
Definition: detect-engine-prefilter.h:32
Signature_::addr_src_match6_cnt
uint16_t addr_src_match6_cnt
Definition: detect.h:720
StreamReassembleRawUpdateProgress
void StreamReassembleRawUpdateProgress(TcpSession *ssn, Packet *p, const uint64_t progress)
update stream engine after detection
Definition: stream-tcp-reassemble.c:1555
FLOWFILE_NO_SHA1_TS
#define FLOWFILE_NO_SHA1_TS
Definition: flow.h:152
PROF_DETECT_RULES
@ PROF_DETECT_RULES
Definition: suricata-common.h:474
APP_LAYER_TX_INSPECTED_TS
#define APP_LAYER_TX_INSPECTED_TS
Definition: app-layer-parser.h:51
DetectRunScratchpad::app_decoder_events
const bool app_decoder_events
Definition: detect.c:73
TcpSession_::server
TcpStream server
Definition: stream-tcp-private.h:296
Signature_::dp
DetectPort * dp
Definition: detect.h:747
PacketAlerts_::suppressed
uint16_t suppressed
Definition: decode.h:292
PACKET_PROFILING_DETECT_START
#define PACKET_PROFILING_DETECT_START(p, id)
Definition: util-profiling.h:214
DetectEngineThreadCtx_::replace
const Signature ** replace
Definition: detect.h:1410
DetectFirewallPolicy
Definition: detect.h:946
PKT_PSEUDO_DETECTLOG_FLUSH
#define PKT_PSEUDO_DETECTLOG_FLUSH
Definition: decode.h:1353
Signature_::iid
SigIntId iid
Definition: detect.h:704
FLOW_SGH_TOSERVER
#define FLOW_SGH_TOSERVER
Definition: flow.h:73
APP_LAYER_TX_ACCEPT
#define APP_LAYER_TX_ACCEPT
Definition: app-layer-parser.h:54
SCFree
#define SCFree(p)
Definition: util-mem.h:61
Packet_::pkt_src
uint8_t pkt_src
Definition: decode.h:626
DetectEngineAppInspectionEngine_::sub_state
uint8_t sub_state
Definition: detect.h:431
SGH_PROFILING_RECORD
#define SGH_PROFILING_RECORD(det_ctx, sgh)
Definition: util-profiling.h:252
Signature_::addr_dst_match6
DetectMatchAddressIPv6 * addr_dst_match6
Definition: detect.h:738
Flow_::alstate
void * alstate
Definition: flow.h:485
Signature_::id
uint32_t id
Definition: detect.h:741
DeStateStore_::store
DeStateStoreItem store[DE_STATE_CHUNK_SIZE]
Definition: detect-engine-state.h:81
DetectEngineCtx_::guess_applayer_log_limit
uint8_t guess_applayer_log_limit
Definition: detect.h:1043
RuleMatchCandidateTx::stream_reset
uint32_t stream_reset
Definition: detect.h:1278
ACTION_SCOPE_PACKET
@ ACTION_SCOPE_PACKET
Definition: action-globals.h:44
detect-engine-iponly.h
DetectEngineThreadCtx_::fw_lte_cover
uint32_t fw_lte_cover[APP_LAYER_MAX_PROGRESS]
Definition: detect.h:1423
detect-parse.h
Signature_
Signature container.
Definition: detect.h:692
AppLayerGetTxIterTuple::has_next
bool has_next
Definition: app-layer-parser.h:162
PACKET_ALERT_FLAG_TX
#define PACKET_ALERT_FLAG_TX
Definition: decode.h:274
DetectFirewallAppTxState::fw_last_for_progress
bool fw_last_for_progress
Definition: detect.c:1732
AppLayerParserGetTxEndState
uint8_t AppLayerParserGetTxEndState(uint8_t ipproto, AppProto alproto, void *tx, uint8_t flags)
get the end state (progress) for a transaction.
Definition: app-layer-parser.c:1177
PKT_DROP_REASON_FW_DEFAULT_APP_POLICY
@ PKT_DROP_REASON_FW_DEFAULT_APP_POLICY
Definition: decode.h:409
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
TRACE_SID_TXS
#define TRACE_SID_TXS(sid, txs,...)
Definition: detect.c:1256
FLOW_PKT_ESTABLISHED
#define FLOW_PKT_ESTABLISHED
Definition: flow.h:239
DetectEngineThreadCtx_::tx_id_set
bool tx_id_set
Definition: detect.h:1390
PacketDrop
void PacketDrop(Packet *p, const uint8_t action, enum PacketDropReason r)
issue drop action
Definition: packet.c:34
ACTION_ACCEPT
#define ACTION_ACCEPT
Definition: action-globals.h:36
STREAMTCP_FLAG_APP_LAYER_DISABLED
#define STREAMTCP_FLAG_APP_LAYER_DISABLED
Definition: stream-tcp-private.h:201
DetectRunScratchpad::flow_flags
const uint8_t flow_flags
Definition: detect.c:72
DetectEngineThreadCtx_::de_ctx
DetectEngineCtx * de_ctx
Definition: detect.h:1444
suricata.h
IPOnlyMatchPacket
void IPOnlyMatchPacket(ThreadVars *tv, const DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const DetectEngineIPOnlyCtx *io_ctx, Packet *p)
Match a packet against the IP Only detection engine contexts.
Definition: detect-engine-iponly.c:1000
DetectEngineCtx_::sig_array
Signature ** sig_array
Definition: detect.h:1014
Packet_::dst
Address dst
Definition: decode.h:521
DETECT_FIREWALL_POLICY_PRE_FLOW
@ DETECT_FIREWALL_POLICY_PRE_FLOW
Definition: detect.h:940
PROF_DETECT_TX
@ PROF_DETECT_TX
Definition: suricata-common.h:475
DetectEngineAppInspectionEngine_::dir
uint8_t dir
Definition: detect.h:422
Signature_::detect_table
uint8_t detect_table
Definition: detect.h:726
PKT_NOPACKET_INSPECTION
#define PKT_NOPACKET_INSPECTION
Definition: decode.h:1292
PrefilterPostRuleMatch
void PrefilterPostRuleMatch(DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p, Flow *f)
invoke post-rule match "prefilter" engines
Definition: detect-engine-prefilter.c:221
DetectGetInnerTx
void * DetectGetInnerTx(void *tx_ptr, AppProto alproto, AppProto engine_alproto, uint8_t flow_flags)
Definition: detect.c:1266
DetectPreStream
uint8_t DetectPreStream(ThreadVars *tv, DetectEngineThreadCtx *det_ctx, Packet *p)
Definition: detect.c:3203
PKT_DROP_REASON_FW_DEFAULT_PACKET_POLICY
@ PKT_DROP_REASON_FW_DEFAULT_PACKET_POLICY
Definition: decode.h:408
DetectRunScratchpad::alproto
const AppProto alproto
Definition: detect.c:71
DE_STATE_FLAG_FULL_INSPECT
#define DE_STATE_FLAG_FULL_INSPECT
Definition: detect-engine-state.h:58
STREAMTCP_STREAM_FLAG_DISABLE_RAW
#define STREAMTCP_STREAM_FLAG_DISABLE_RAW
Definition: stream-tcp-private.h:238
DetectEngineThreadCtx_::json_content_len
uint8_t json_content_len
Definition: detect.h:1355
DetectEngineThreadCtx_::mt_det_ctxs_cnt
uint32_t mt_det_ctxs_cnt
Definition: detect.h:1326
AppLayerGetTxIteratorFunc
AppLayerGetTxIterTuple(* AppLayerGetTxIteratorFunc)(const uint8_t ipproto, const AppProto alproto, void *alstate, uint64_t min_tx_id, uint64_t max_tx_id, AppLayerGetTxIterState *state)
tx iterator prototype
Definition: app-layer-parser.h:232
likely
#define likely(expr)
Definition: util-optimize.h:32
IPPROTO_SCTP
#define IPPROTO_SCTP
Definition: decode.h:1273
DE_STATE_FLAG_FILE_INSPECT
#define DE_STATE_FLAG_FILE_INSPECT
Definition: detect-engine-state.h:63
DetectEngineThreadCtx_::counter_match_list
StatsCounterAvgId counter_match_list
Definition: detect.h:1370
AppLayerParserSupportsSubStates
bool AppLayerParserSupportsSubStates(const AppProto alproto)
Definition: app-layer-parser.c:1356
DetectFirewallAppPolicy::alproto
AppProto alproto
Definition: detect.h:952
DetectFirewallPolicies::app_policies
HashTable * app_policies
Definition: detect.h:968
DetectTransaction_::tx_progress
const uint8_t tx_progress
Definition: detect-engine-prefilter.h:43
DetectEngineCtx_::io_ctx
DetectEngineIPOnlyCtx io_ctx
Definition: detect.h:1037
SC_ATOMIC_GET
#define SC_ATOMIC_GET(name)
Get the value from the atomic variable.
Definition: util-atomic.h:375
Signature_::addr_dst_match4
DetectMatchAddressIPv4 * addr_dst_match4
Definition: detect.h:735
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1170
TcpSession_
Definition: stream-tcp-private.h:283
DetectRunScratchpad::fw_pkt_policy
enum DetectFirewallPacketPolicies fw_pkt_policy
Definition: detect.c:74
flow.h
Signature_::addr_src_match4_cnt
uint16_t addr_src_match4_cnt
Definition: detect.h:718
DetectFirewallPolicy::action_scope
uint8_t action_scope
Definition: detect.h:948
DetectTxFirewallFlowControl
DetectTxFirewallFlowControl
Definition: detect.c:1174
DeStateStoreItem_
Definition: detect-engine-state.h:75
Signature_::addr_dst_match4_cnt
uint16_t addr_dst_match4_cnt
Definition: detect.h:717
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:456
Packet_::dp
Port dp
Definition: decode.h:531
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
DetectEngineCtx_::sig_array_len
uint32_t sig_array_len
Definition: detect.h:1015
SIG_GROUP_HEAD_HAVEFILESHA256
#define SIG_GROUP_HEAD_HAVEFILESHA256
Definition: detect.h:1575
AlertQueueAppendAppTx
void AlertQueueAppendAppTx(DetectEngineThreadCtx *det_ctx, const Signature *s, Packet *p, uint64_t tx_id, uint8_t sub_state, uint8_t alert_flags)
Append signature to local packet alert queue for later preprocessing.
Definition: detect-engine-alert.c:423
ThreadVars_::stats
StatsThreadContext stats
Definition: threadvars.h:121
Signature_::type
enum SignatureType type
Definition: detect.h:695
StatsCounterAddI64
void StatsCounterAddI64(StatsThreadContext *stats, StatsCounterId id, int64_t x)
Adds a value of type uint64_t to the local counter.
Definition: counters.c:145
SigGroupHead_::filestore_cnt
uint16_t filestore_cnt
Definition: detect.h:1730
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *f, void *alstate)
Definition: app-layer-parser.c:1212
DetectFirewallAppPolicy::direction
uint8_t direction
Definition: detect.h:955
AppLayerParserHasDecoderEvents
bool AppLayerParserHasDecoderEvents(AppLayerParserState *pstate)
Definition: app-layer-parser.c:1747
FLOW_PKT_TOSERVER_FIRST
#define FLOW_PKT_TOSERVER_FIRST
Definition: flow.h:240
DetectEngineLookupFlow_::tcp
DetectPort * tcp
Definition: detect.h:892
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:109
detect-engine-address.h
Flow_::tenant_id
uint32_t tenant_id
Definition: flow.h:430
Packet_::src
Address src
Definition: decode.h:520
SigMatchSignaturesGetSgh
const SigGroupHead * SigMatchSignaturesGetSgh(const DetectEngineCtx *de_ctx, const Packet *p)
Get the SigGroupHead for a packet.
Definition: detect.c:293
DetectRunPrefilterTx
void DetectRunPrefilterTx(DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p, const uint8_t ipproto, const uint8_t flow_flags, const AppProto alproto, void *alstate, DetectTransaction *tx)
run prefilter engines on a transaction
Definition: detect-engine-prefilter.c:95
RuleMatchCandidateTxArrayInit
void RuleMatchCandidateTxArrayInit(DetectEngineThreadCtx *det_ctx, uint32_t size)
Definition: detect.c:1180
APP_LAYER_TX_INSPECTED_TC
#define APP_LAYER_TX_INSPECTED_TC
Definition: app-layer-parser.h:52
SIG_FLAG_DP_ANY
#define SIG_FLAG_DP_ANY
Definition: detect.h:247
DetectPortLookupGroup
DetectPort * DetectPortLookupGroup(DetectPort *dp, uint16_t port)
Function that find the group matching port in a group head.
Definition: detect-engine-port.c:585
DetectEngineThreadCtx_::post_rule_work_queue
PostRuleMatchWorkQueue post_rule_work_queue
Definition: detect.h:1427
PKT_STREAM_EST
#define PKT_STREAM_EST
Definition: decode.h:1307
detect-engine-threshold.h
Signature_::mask
SignatureMask mask
Definition: detect.h:703
AppLayerTxData::updated_ts
bool updated_ts
Definition: app-layer-parser.h:180
app-layer.h
RuleMatchCandidateTx
Definition: detect.h:1268
DetectEngineThreadCtx_::TenantGetId
uint32_t(* TenantGetId)(const void *, const Packet *p)
Definition: detect.h:1333
DetectEngineAppInspectionEngine_::progress
uint8_t progress
Definition: detect.h:430
PrefilterRuleStore_::rule_id_array
SigIntId * rule_id_array
Definition: util-prefilter.h:38
PacketEngineEvents_::cnt
uint8_t cnt
Definition: decode.h:310
f
Flow f
Definition: fuzz_dataset.c:32
Flow_::de_ctx_version
uint32_t de_ctx_version
Definition: flow.h:470
DetectProtoContainsProto
int DetectProtoContainsProto(const DetectProto *dp, int proto)
see if a DetectProto contains a certain proto
Definition: detect-engine-proto.c:115
DetectEngineThreadCtx_::match_array
Signature ** match_array
Definition: detect.h:1407