diff --git a/doc/userguide/rule-management/index.rst b/doc/userguide/rule-management/index.rst index 75caabfeb2..d97888cca1 100644 --- a/doc/userguide/rule-management/index.rst +++ b/doc/userguide/rule-management/index.rst @@ -3,6 +3,7 @@ Rule Management .. toctree:: + suricata-update oinkmaster adding-your-own-rules rule-reload diff --git a/doc/userguide/rule-management/suricata-update.rst b/doc/userguide/rule-management/suricata-update.rst new file mode 100644 index 0000000000..bd4e496b47 --- /dev/null +++ b/doc/userguide/rule-management/suricata-update.rst @@ -0,0 +1,117 @@ +Rule Management with Suricata-Update +==================================== + +.. note:: ``suricata-update`` is in active development and is not yet + considered 'production quality'. Proceed with care. + +While it is possible to download and install rules manually, it is +recommended to use a management tool for this. Suricata-Update is the +official way to update and manage rules for Suricata. + + +To install suricata-update + +:: + + sudo apt install python-pip python-yaml + sudo pip install --pre --upgrade suricata-update + +To download the Emerging Threats Open ruleset, it is enough to simply run: + +:: + + sudo suricata-update + +This will download the ruleset into /var/lib/suricata/rules/ + +Suricata's configuration will have to be updated to have a rules config like +this: + +:: + + default-rule-path: /var/lib/suricata/rules + rule-files: + - suricata.rules + +Now (re)start Suricata. + + +Updating your rules +~~~~~~~~~~~~~~~~~~~ + +To update the rules, simply run + +:: + + sudo suricata-update + +It is recommended to update your rules frequently. + + +Using other rulesets +~~~~~~~~~~~~~~~~~~~~ + +Suricata-Update is capable of making other rulesets accessible as well. + +To see what is available, fetch the master index from the OISF hosts: + +:: + + sudo suricata-update update-sources + +Then have a look at what is available: + +:: + + sudo suricata-update list-sources + +This will give a result similar to + +.. image:: suricata-update/suricata-update.png + +To enable 'oisf/trafficid', enter: + +:: + + sudo suricata-update enable-source oisf/trafficid + sudo suricata-update + +Now restart Suricata again and the rules from the OISF TrafficID ruleset are loaded. + +To see which rulesets are currently active, use "list-enabled-sources". + +Controlling which rules are used +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +By default suricata-update will merge all rules into a single file +"/var/lib/suricata/rules/suricata.rules". + +To enable rules that are disabled by default, use '/etc/suricata/enable.conf' + +:: + + 2019401 # enable this sid + group:emerging-icmp.rules # enable this rulefile + re:trojan # enable all rules with this string + + +Similarly, to disable rules use /etc/suricata/disable.conf: + +:: + + 2019401 # enable this sid + group:emerging-info.rules # disable this rulefile + re:heartbleed # disable all rules with this string + +After updating these files, rerun ``suricata-update`` again: + +:: + + sudo suricata-update + +Finally restart Suricata. + +Further reading +~~~~~~~~~~~~~~~ + +See http://suricata-update.readthedocs.io/en/latest/ diff --git a/doc/userguide/rule-management/suricata-update/suricata-update.png b/doc/userguide/rule-management/suricata-update/suricata-update.png new file mode 100644 index 0000000000..96b1645d33 Binary files /dev/null and b/doc/userguide/rule-management/suricata-update/suricata-update.png differ