[people/ms/suricata.git] / doc / userguide / lua / lua-usage.rst

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.
Commit	Line	Data
0c4bf2d3 EL	1	Lua usage in Suricata
	2	=====================
	3
4a90dced	4	Lua scripting can be used in two components of Suricata. The first is in
b116a56a	5	output and the second one in rules in the detection engine.
0c4bf2d3	6
e7f1736f	7	Both features are using a list of functions to access the data extracted by
4a90dced	8	Suricata. You can get the list of functions in the :ref:`lua-functions` page.
0c4bf2d3	9
e7f1736f JF	10	.. 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.
e7f1736f JF	11
0c4bf2d3 EL	12	Lua output
	13	----------
	14
	15	Lua can be used to write arbitrary output. See :ref:`lua-output` for more information.
	16
4a90dced	17	Lua detection
0c4bf2d3 EL	18	-------------
0c4bf2d3 EL	19
4256c1cc	20	Lua script can be used as a filter condition in signatures. See :ref:`lua-detection` for more information.