]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
lua: better doc for ja3 lib
authorPhilippe Antoine <pantoine@oisf.net>
Thu, 8 May 2025 19:33:00 +0000 (21:33 +0200)
committerVictor Julien <victor@inliniac.net>
Tue, 13 May 2025 07:29:26 +0000 (09:29 +0200)
Completes commit 7e78ad944c8484bc8e8c3f00d95a0ef1f1850aaa

Tickt: 7605

doc/userguide/lua/libs/ja3.rst

index e025cbddc618c316f7d0e61daeda6dbb7ba5b441..8811337158ea90e427d96d78ab473ffea4cada9d 100644 (file)
@@ -1,8 +1,8 @@
 JA3
 ---
 
-JA3 details are exposes to Lua scripts with the
-``suricata.ja3`` library, For example::
+JA3 details are exposed to Lua scripts with the
+``suricata.ja3`` library. For example::
 
   local ja3 = require("suricata.ja3")
 
@@ -17,11 +17,11 @@ by calling ``ja3.enable_ja3()``::
   end
 
 ``ja3.enable_ja3()`` will not enable ja3 if they are explicitly
-disabled, so you should add ``requires: feature ja3;`` to your rule.
+disabled, so you should add ``requires: feature ja3;``
+(see :ref:`keyword_requires`) to your rule.
 
-For use in rule matching, the rule may **hook** into a TLS or QUIC
-transaction state if you want to match on only one of these protocols.
-Or you should use need ``ja3`` or ``ja3s`` in your init script::
+For use in rule matching, the rule should use need ``ja3`` or
+``ja3s`` in your init script::
 
   function init (args)
     ja3.enable_ja3()