diff options
| author | jvoisin | 2020-06-09 19:38:26 +0200 |
|---|---|---|
| committer | jvoisin | 2020-06-09 19:38:26 +0200 |
| commit | 7f9602ebc23582195d63eb35f1de1961297f2e00 (patch) | |
| tree | cfeaf9a70b28db5ef02565114f231aedbd037493 /doc | |
| parent | 47d25cea2b34f8dc214a8aa5f748c5efe6455b96 (diff) | |
Improve the documentation wrt. "modifiers"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/config.rst | 13 |
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. | |||
| 254 | Virtual-patching | 254 | Virtual-patching |
| 255 | ---------------- | 255 | ---------------- |
| 256 | 256 | ||
| 257 | Snuffleupagus provides virtual-patching via the ``disable_function`` directive, allowing you to stop or control dangerous behaviours. | 257 | Snuffleupagus provides virtual-patching via the ``disable_function`` directive, |
| 258 | In 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. | 258 | allowing you to stop or control dangerous behaviours. In the situation where |
| 259 | you have a call to ``system()`` that lacks proper user-input validation, this | ||
| 260 | could cause issues as it would lead to an **RCE**. The virtual-patching would | ||
| 261 | allow this to be prevented. | ||
| 259 | 262 | ||
| 260 | :: | 263 | :: |
| 261 | 264 | ||
| @@ -305,8 +308,14 @@ The ``type`` must be one of the following values: | |||
| 305 | Actions | 308 | Actions |
| 306 | ^^^^^^^ | 309 | ^^^^^^^ |
| 307 | 310 | ||
| 311 | Every 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 | |||
| 316 | Modifications | ||
| 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 | ||
