summaryrefslogtreecommitdiffstats
path: root/doc/userguide/lua/lua-usage.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
commita0aa2307322cd47bbf416810ac0292925e03be87 (patch)
tree37076262a026c4b48c8a0e84f44ff9187556ca35 /doc/userguide/lua/lua-usage.rst
parentInitial commit. (diff)
downloadsuricata-a0aa2307322cd47bbf416810ac0292925e03be87.tar.xz
suricata-a0aa2307322cd47bbf416810ac0292925e03be87.zip
Adding upstream version 1:7.0.3.upstream/1%7.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/userguide/lua/lua-usage.rst')
-rw-r--r--doc/userguide/lua/lua-usage.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/userguide/lua/lua-usage.rst b/doc/userguide/lua/lua-usage.rst
new file mode 100644
index 0000000..19946db
--- /dev/null
+++ b/doc/userguide/lua/lua-usage.rst
@@ -0,0 +1,20 @@
+Lua usage in Suricata
+=====================
+
+Lua scripting can be used in two components of Suricata. The first is in
+output and the second one in rules in the detection engine.
+
+Both features are using a list of functions to access the data extracted by
+Suricata. You can get the list of functions in the :ref:`lua-functions` page.
+
+.. note:: Currently, there is a difference in the ``needs`` key in the ``init`` function, depending on what is the usage: ``output`` or ``detection``. The list of available functions may also differ.
+
+Lua output
+----------
+
+Lua can be used to write arbitrary output. See :ref:`lua-output` for more information.
+
+Lua detection
+-------------
+
+Lua script can be used as a filter condition in signatures. See :ref:`lua-detection` for more information.