]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
detect/config: add flow tracking doc 13410/head
authorVictor Julien <vjulien@oisf.net>
Sat, 24 May 2025 07:23:01 +0000 (09:23 +0200)
committerVictor Julien <victor@inliniac.net>
Tue, 10 Jun 2025 06:36:36 +0000 (08:36 +0200)
doc/userguide/rules/config.rst

index 260364378a280cd27cfb9ce4d0aeafc9f0957b21..47898e918c78eb5e96fc5e37165248b8b6348bb8 100644 (file)
@@ -12,6 +12,12 @@ This example will detect if a DNS query contains the string `suricata` and if
 so disable the DNS transaction logging. This means that `eve.json` records,
 but also Lua output, will not be generated/triggered for this DNS transaction.
 
+Example::
+
+  config tcp:pre_flow any any <> any 666 (config: tracking disable, type flow, scope packet; sid:1;)
+
+This example skips flow tracking for any packet from or to tcp port 666.
+
 Keyword
 -------
 
@@ -24,14 +30,17 @@ Syntax::
 `subsys` can be set to:
 
 * `logging` setting affects logging.
+* `tracking` setting affects tracking.
 
 `type` can be set to:
 
 * `tx` sub type of the `subsys`. If `subsys` is set to `logging`, setting the `type` to `tx` means transaction logging is affected.
+* `flow` sub type of the `subsys`. If `subsys` is set to `flow`, setting the `type` to `flow` means flow tracking is disabled.
 
 `scope` can be set to:
 
 * `tx` setting affects the matching transaction.
+* `packet` setting affects the matching packet.
 
 The `action` in `<subsys>` is currently limited to `disable`.