doc/userguide/lua/lua-usage.rst

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