summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorjvoisin2020-06-09 19:38:26 +0200
committerjvoisin2020-06-09 19:38:26 +0200
commit7f9602ebc23582195d63eb35f1de1961297f2e00 (patch)
treecfeaf9a70b28db5ef02565114f231aedbd037493 /doc/source
parent47d25cea2b34f8dc214a8aa5f748c5efe6455b96 (diff)
Improve the documentation wrt. "modifiers"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/config.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst
index 7691f89..91e085c 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -254,8 +254,11 @@ blacklisted, it'll be allowed.
254Virtual-patching 254Virtual-patching
255---------------- 255----------------
256 256
257Snuffleupagus provides virtual-patching via the ``disable_function`` directive, allowing you to stop or control dangerous behaviours. 257Snuffleupagus provides virtual-patching via the ``disable_function`` directive,
258In the situation where you have a call to ``system()`` that lacks proper user-input validation, this could cause issues as it would lead to an **RCE**. The virtual-patching would allow this to be prevented. 258allowing you to stop or control dangerous behaviours. In the situation where
259you have a call to ``system()`` that lacks proper user-input validation, this
260could cause issues as it would lead to an **RCE**. The virtual-patching would
261allow this to be prevented.
259 262
260:: 263::
261 264
@@ -305,8 +308,14 @@ The ``type`` must be one of the following values:
305Actions 308Actions
306^^^^^^^ 309^^^^^^^
307 310
311Every rule *must* have one action.
312
308- ``allow()``: **allow** the request if the rule matches 313- ``allow()``: **allow** the request if the rule matches
309- ``drop()``: **drop** the request if the rule matches 314- ``drop()``: **drop** the request if the rule matches
315
316Modifications
317^^^^^^^^^^^^^
318
310- ``dump(directory)``: dump the request in the ``directory`` if it matches the rule 319- ``dump(directory)``: dump the request in the ``directory`` if it matches the rule
311- ``simulation()``: enabled the simulation mode 320- ``simulation()``: enabled the simulation mode
312 321