Skip to content

Commit ce877e5

Browse files
committed
fix: last minute fixes
1 parent d9b0f0d commit ce877e5

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

content/includes/nap-waf/config/common/ip-intelligence-conf.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33

44
As of NAP version 4.15.0 (for NAP V4 deployments), and NAP version 5.7.0 (for NAP V5 deployments), NGINX App Protect WAF includes a new feature named IP Intelligence. This features allows customizing the enforcement based on the source IP of the request to limit access from IP addresses with questionable reputation. Please note that:
5-
- The IP intelligence feature is disabled by default and needs to be explicitly enabled and configured in the policy.
6-
- The package `app-protect-ip-intelligence` needs to be installed (for NAP V4 deployments), or the IP Intelligence image deployed (for NAP V5 deployments), before configuring and using the feature. This package installs the client that downloads and updates the database required for enforcing IP Intelligence.
5+
- The IP intelligence feature is **disabled** by default and needs to be explicitly enabled and configured in the policy.
6+
- The package `app-protect-ip-intelligence` must be installed (for NAP V4 deployments), or the IP Intelligence image deployed (for NAP V5 deployments), before configuring and using the feature. This package installs the client that downloads and updates the database required for enforcing IP Intelligence.
77

88
After installing the package or image, enable the feature in the following two places in the policy:
9-
1. By enabling the corresponding violation in the violation list: `"name": "VIOL_MALICIOUS_IP"` and assigning the required `block` and `alarm` values to the violation.
9+
1. By enabling the corresponding violation in the violation list: `"name": "VIOL_MALICIOUS_IP"` and assigning the appropriate `block` and `alarm` values to the violation.
1010

1111
2. By enabling the featue in the corresponding IP Intelligence JSON section: `"ip-intelligence": {"enabled": true}` and define actions for the IP Intelligence categories listed below.
1212

@@ -99,6 +99,7 @@ An example policy where both elements are enabled, and all the IP intelligence c
9999
}
100100
}
101101
```
102+
102103
This policy will basically block `"block": true` all IP addresses that are part of any threat category and add a log entry `"alarm": true` for the transaction.
103104

104105
The IP address database is managed by an external provider and is constantly updated (every 1 minute by default). The database also categorizes IP addresses into one or more threat categories. These are the same categories that can be configured individually in the IP intelligence section:

content/includes/nap-waf/ip-intelligence.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
### Docker Compose File with IP Intelligence
2-
31
If the deployment intends to use the IP intelligence Feature (avaiable from version 5.7.0), then the IP intelligence container needs to be added to the deployment in the docker compose file.
42

53
Modify the original `docker-compose.yml` file to include the additional IP Intelligence container:
@@ -56,14 +54,14 @@ Notes:
5654
- Replace `waf-config-mgr`, `waf-enforcer` and `waf-ip-intelligence` tags with the actual release version tag you are deploying. We are using version 5.7.0 for this example deployment.
5755
- By default, the containers `waf-config-mgr`, `waf-enforcer` and `waf-ip-intelligence` operate with the user and group IDs set to 101:101. Ensure that the folders and files are accessible to these IDs.
5856

59-
Before you create the deployment in docker compose, create the directories:
57+
Before creating the deployment in docker compose, create the required directories:
6058

6159
```shell
6260
sudo mkdir -p /opt/app_protect/config /opt/app_protect/bd_config /var/IpRep
6361
```
6462

65-
Then set ownership:
63+
Then set correct ownership:
6664

6765
```shell
6866
sudo chown -R 101:101 /opt/app_protect/ /var/IpRep
69-
```
67+
```

content/nap-waf/v4/admin-guide/install.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1079,7 +1079,7 @@ RUN --mount=type=secret,id=nginx-crt,dst=/etc/apk/cert.pem,mode=0644 \
10791079
# Only use if you want to install and use the IP intelligence feature:
10801080
RUN --mount=type=secret,id=nginx-crt,dst=/etc/apk/cert.pem,mode=0644 \
10811081
--mount=type=secret,id=nginx-key,dst=/etc/apk/cert.key,mode=0644 \
1082-
apk update && apk app-protect-ip-intelligence
1082+
apk update && apk add app-protect-ip-intelligence
10831083
10841084
# Forward request logs to Docker log collector:
10851085
RUN ln -sf /dev/stdout /var/log/nginx/access.log \
@@ -1743,7 +1743,7 @@ On a host with access to the NGINX App Protect WAF repository:
17431743
yum install --downloadonly --downloaddir=/etc/packages/ app-protect
17441744
```
17451745
1746-
Only use if you want to install and use the IP intelligence feature:
1746+
Only use if you want to install and use the IP intelligence feature:
17471747
17481748
```shell
17491749
yum install --downloadonly --downloaddir=/etc/packages/ app-protect-ip-intelligence
@@ -1777,7 +1777,7 @@ On an offline host:
17771777
yum -y install app-protect
17781778
```
17791779
1780-
Only use if you want to install and use the IP intelligence feature:
1780+
Only use if you want to install and use the IP intelligence feature:
17811781
17821782
```shell
17831783
yum -y install app-protect-ip-intelligence
@@ -1797,7 +1797,8 @@ On a host with access to the NGINX App Protect WAF repository:
17971797
apt-get update
17981798
for i in $(apt-cache depends --recurse --no-recommends --no-suggests --no-conflicts --no-breaks --no-replaces --no-enhances app-protect | grep "^\w" | sort -u); do apt-get download $i 2>>errors.txt; done
17991799
```
1800-
Only use if you want to install and use the IP intelligence feature:
1800+
1801+
Only use if you want to install and use the IP intelligence feature:
18011802
18021803
```shell
18031804
cd /etc/packages/
@@ -1818,7 +1819,7 @@ On an offline host:
18181819
apt-get update
18191820
apt-get install -y app-protect
18201821
```
1821-
Only use if you want to install and use the IP intelligence feature:
1822+
Only use if you want to install and use the IP intelligence feature:
18221823
18231824
```shell
18241825
apt-get install -y app-protect-ip-intelligence

0 commit comments

Comments
 (0)