]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: Update byte_test documentation
authorJeff Lucovsky <jeff@lucovsky.org>
Sun, 15 Dec 2019 19:44:07 +0000 (14:44 -0500)
committerJeff Lucovsky <jeff@lucovsky.org>
Sun, 22 Mar 2020 14:10:54 +0000 (10:10 -0400)
doc/userguide/rules/payload-keywords.rst

index ad4e5814af024280d013de91e68fe23232cf4827..ca4f6eeb6c55f2955469250856ddb59b0a1c44e7 100644 (file)
@@ -299,7 +299,11 @@ Example of dsize in a rule:
 
 byte_test
 ---------
-The ``byte_test`` keyword extracts ``<num of bytes>`` and performs an operation selected with ``<operator>`` against the value in ``<test value>`` at a particular ``<offset>``.
+The ``byte_test`` keyword extracts ``<num of bytes>`` and performs an operation selected
+with ``<operator>`` against the value in ``<test value>`` at a particular ``<offset>``.
+The ``<bitmask value>`` is applied to the extracted bytes (before the operator is applied),
+and the final result will be right shifted one bit for each trailing ``0`` in
+the ``<bitmask value>``.
 
 Format::