Skip to content

Commit f62fee3

Browse files
authored
Merge pull request #168 from sgevorgyancl/feature/port-limits-ui
DEF-38050 Documentation about Enhanced DOS setting and ports limit field
2 parents ac04cb7 + 7510326 commit f62fee3

4 files changed

Lines changed: 46 additions & 5 deletions

File tree

30.9 KB
Loading
55 KB
Loading
81.5 KB
Loading

docs/dashboard/README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1199,7 +1199,8 @@ imunify360-agent config update '{"DOS": {"enabled": true}}'
11991199
It is possible to configure how Imunify360 will behave:
12001200

12011201
* <span class="notranslate">_Max Connections_</span>– allows to setup the number of simultaneous connections allowed before IP will be blocked. Cannot be set lower than 100.
1202-
* <span class="notranslate">_Check delay_</span> – allows to setup period in seconds between each DoS detection system activation that will check a server for DoS attack. Also, it is possible to set different limits for different local ports by editing the [configuration file](/config_file_description/) directly.
1202+
* <span class="notranslate">_Check delay_</span> – allows to setup period in seconds between each DoS detection system activation that will check a server for DoS attack.
1203+
* <span class="notranslate">_Per-port Max Connections_</span> – allows to set different connection limits for specific ports. Click "Manage per-port limits" to open a dialog where you can add, edit, or remove port-specific limits.
12031204

12041205
**The minimum values**:
12051206

@@ -1220,8 +1221,6 @@ Imunify360 DoS protection is automatically disabled if CSF is active - a warning
12201221

12211222
![](/images/DosProtection.png)
12221223

1223-
Click <span class="notranslate">_Save changes_</span> button on the bottom of the section to save changes.
1224-
12251224
#### Enhanced DOS Protection
12261225

12271226
The Enhanced DOS Protection feature forms an additional layer of protection, increasing the stability of servers facing DOS attacks. It takes a different approach than our existing [DOS Protection feature](/dashboard/#dos-protection), which focuses on monitoring the number of simultaneous connections. Enhanced DOS Protection, on the other hand, monitors the rate of requests originating from attacker IP addresses per unit of time.
@@ -1233,10 +1232,38 @@ Standard DoS protection, in turn, will block attacks that use long-lived connect
12331232
You can find all incidents related to the new feature in the incidents table by the description:
12341233

12351234
```
1236-
Denial of Service (DoS) attack was discovered from %IP%: %threshold% connections per %timeframe% seconds to %port% port.
1235+
"Denial of Service (DoS) attack was discovered from %IP%: %threshold% connections per %timeframe% seconds to %port% port".
12371236
```
12381237

1239-
<h4>Activating and fine-tuning Enhanced DOS Protection</h4>
1238+
<h4>Configuring Enhanced DOS Protection via UI</h4>
1239+
1240+
Enhanced DOS Protection settings are available in the Imunify360 admin interface under <span class="notranslate">Settings → General</span>.
1241+
1242+
![](/images/EnhancedDosProtection.png)
1243+
1244+
The following options are available:
1245+
1246+
* <span class="notranslate">_Enhanced DoS Protection_</span> – enables or disables the feature.
1247+
* <span class="notranslate">_Max Connections_</span> – the maximum number of requests allowed from a single IP within the timeframe before action is taken. Cannot be set lower than 100.
1248+
* <span class="notranslate">_Timeframe (seconds)_</span> – the period in seconds during which requests are counted.
1249+
* <span class="notranslate">_Default action on detect_</span> – the action taken when an attack is detected (Gray list or Black list).
1250+
* <span class="notranslate">_Per-port Max Connections_</span> – allows to set different request limits for specific ports. Click "Manage per-port limits" to open a dialog where you can add, edit, or remove port-specific limits.
1251+
1252+
<h4>Per-port Max Connections Dialog</h4>
1253+
1254+
Click the "Manage per-port limits" button to open the port limits configuration dialog:
1255+
1256+
![](/images/PortLimitsDialog.png)
1257+
1258+
In this dialog you can:
1259+
* Add new port limits by clicking the "Add" button
1260+
* Set the port number (single port like `80` or a range like `8080-8090`)
1261+
* Set the maximum connections limit for that port (between 100 and 10000)
1262+
* Remove existing port limits by clicking the delete icon
1263+
1264+
Click "Apply" to save changes or "Cancel" to discard them.
1265+
1266+
<h4>Configuring Enhanced DOS Protection via CLI</h4>
12401267

12411268
The feature is switched off by default. You can activate Enhanced DOS Protection in Imunify360 using the following CLI command:
12421269

@@ -1264,12 +1291,26 @@ imunify360-agent config update '{"ENHANCED_DOS":{"timeframe":60}}'
12641291
imunify360-agent config update '{"ENHANCED_DOS":{"default_limit":500}}'
12651292
```
12661293

1294+
<h4>Per-port Limits via CLI</h4>
1295+
12671296
Request limits for different ports could be set separately, using the following CLI commands:
12681297

12691298
```
12701299
imunify360-agent config update '{"ENHANCED_DOS": {"port_limits": {"80": 150}}}'
12711300
```
12721301

1302+
To set limits for multiple ports:
1303+
1304+
```
1305+
imunify360-agent config update '{"ENHANCED_DOS": {"port_limits": {"80": 150, "443": 200}}}'
1306+
```
1307+
1308+
To clear all port-specific limits:
1309+
1310+
```
1311+
imunify360-agent config update '{"ENHANCED_DOS": {"port_limits": {}}}'
1312+
```
1313+
12731314
We also recommend checking and configuring the CAPTCHA_DOS section of [parameters](/config_file_description) to blacklist IPs after repetitive requests to the captcha.
12741315

12751316
#### SMTP Traffic Manager

0 commit comments

Comments
 (0)