doc/rules: document config rule option

diff --git a/doc/userguide/rules/config.rst b/doc/userguide/rules/config.rst
new file mode 100644 (file)
index 0000000..2603643
--- /dev/null
+++ b/doc/userguide/rules/config.rst
@@ -0,0 +1,44 @@
+Config Rules
+============
+
+Config rules are rules that when matching, will change the configuration of
+Suricata for a flow, transaction, packet or other unit.
+
+Example::
+
+  config dns any any -> any any (dns.query; content:"suricata"; config: logging disable, type tx, scope tx; sid:1;)
+
+This example will detect if a DNS query contains the string `suricata` and if
+so disable the DNS transaction logging. This means that `eve.json` records,
+but also Lua output, will not be generated/triggered for this DNS transaction.
+
+Keyword
+-------
+
+The `config` rule keyword provides the setting and the scope of the change.
+
+Syntax::
+
+  config:<subsys> <action>, type <type>, scope <scope>;
+
+`subsys` can be set to:
+
+* `logging` setting affects logging.
+
+`type` can be set to:
+
+* `tx` sub type of the `subsys`. If `subsys` is set to `logging`, setting the `type` to `tx` means transaction logging is affected.
+
+`scope` can be set to:
+
+* `tx` setting affects the matching transaction.
+
+The `action` in `<subsys>` is currently limited to `disable`.
+
+
+Action
+------
+
+Config rules can, but don't have to, use the `config` rule action. The `config`
+rule action won't generate an alert when the rule matches, but the rule actions
+will still be applied. It is equivalent to `alert ... (noalert; ...)`.

diff --git a/doc/userguide/rules/index.rst b/doc/userguide/rules/index.rst
index 5e9dca8ebe1bc7934c0a7f6d8f4827bf2e9fa66b..651763a64a95b66656e5f4982acdfc0c81fd1b4d 100644 (file)
--- a/doc/userguide/rules/index.rst
+++ b/doc/userguide/rules/index.rst
@@ -32,6 +32,7 @@ Suricata Rules
    xbits
    thresholding
    ip-reputation-rules
+   config
    datasets
    rule-lua-scripting
    differences-from-snort