Skip to content

Commit

Permalink
doc: add thresholding by_flow
Browse files Browse the repository at this point in the history
  • Loading branch information
victorjulien committed Mar 8, 2024
1 parent 461e6fe commit 33fed0f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
3 changes: 2 additions & 1 deletion doc/userguide/configuration/global-thresholds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Syntax:
::

threshold gen_id <gid>, sig_id <sid>, type <threshold|limit|both>, \
track <by_src|by_dst|by_rule|by_both>, count <N>, seconds <T>
track <by_src|by_dst|by_rule|by_both|by_flow>, count <N>, seconds <T>

rate_filter
~~~~~~~~~~~
Expand Down Expand Up @@ -55,6 +55,7 @@ done per IP-address. The Host table is used for storage. When using by_rule
it's done globally for the rule.
Option by_both used to track per IP pair of source and destination. Packets
going to opposite directions between same addresses tracked as the same pair.
The by_flow option tracks the rule matches in the flow.

count
^^^^^
Expand Down
23 changes: 22 additions & 1 deletion doc/userguide/rules/thresholding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ frequency. It has 3 modes: threshold, limit and both.

Syntax::

threshold: type <threshold|limit|both>, track <by_src|by_dst|by_rule|by_both>, count <N>, seconds <T>
threshold: type <threshold|limit|both>, track <by_src|by_dst|by_rule|by_both|by_flow>, count <N>, seconds <T>

type "threshold"
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -85,6 +85,27 @@ performed for each of the matches.

*Rule actions drop (IPS mode) and reject are applied to each packet.*


track
~~~~~

.. table::

+------------------+--------------------------+
|Option |Tracks By |
+==================+==========================+
|by_src |source IP |
+------------------+--------------------------+
|by_dst |destination IP |
+------------------+--------------------------+
|by_both |pair of src IP and dst IP |
+------------------+--------------------------+
|by_rule |signature id |
+------------------+--------------------------+
|by_flow |flow |
+------------------+--------------------------+


detection_filter
----------------

Expand Down

0 comments on commit 33fed0f

Please sign in to comment.