Skip to content

Commit

Permalink
doc/userguide: upgrade notes for Lua
Browse files Browse the repository at this point in the history
- Sandboxed Lua for rules
- Search path changes for Lua output scripts
  • Loading branch information
jasonish committed Feb 12, 2025
1 parent 5267fcc commit a8311af
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/userguide/output/lua-output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Example:
file:close(file)
end

.. _lua-output-yaml:

YAML
----

Expand All @@ -87,6 +89,15 @@ scripts like so:
- lua:
enabled: yes
scripts-dir: /etc/suricata/lua-output/

# By default the Lua module search paths are empty. If you plan
# to use external modules these paths will need to be set. The
# examples below are likely suitable for finding modules
# installed with a package manager on a 64 bit Linux system, but
# may need tweaking.
#path: "/usr/share/lua/5.4/?.lua;/usr/share/lua/5.4/?/init.lua;/usr/lib64/lua/5.4/?.lua;/usr/lib64/lua/5.4/?/init.lua;./?.lua;./?/init.lua"
#cpath: "/usr/lib64/lua/5.4/?.so;/usr/lib64/lua/5.4/loadall.so;./?.so"

scripts:
- tcp-data.lua
- flow.lua
Expand Down
6 changes: 6 additions & 0 deletions doc/userguide/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ Major changes
Suricata 8.0, ``stream.checksum-validation`` no longer affects the checksum rule keywords.
E.g., ``ipv4-csum: valid`` will only match if the check sum is valid, even when engine
checksum validations are disabled.
- Lua detection scripts (rules) now run in a sandboxed
environment. See :ref:`lua-detection`.
- Lua output scripts have no default module search path, a search path
will need to be set before external modules can be loaded. See the
new default configuration file or :ref:`lua-output-yaml` for more
details.

Removals
~~~~~~~~
Expand Down

0 comments on commit a8311af

Please sign in to comment.