IP intelligence

F5 WAF for NGINX has an IP intelligence feature which allows you to customize enforcement based on the source IP address of a request. This allows you to limit access from specific IP addresses.

It is disabled by default, requiring extra steps to enable and configure.

Enable IP intelligence

Before you begin

To complete this guide, you will need the following prerequisites:

The host must have an active internet connection and working DNS
The host must be able to access vector.brightcloud.com over port 443
The host must be configured properly if connecting through a forward proxy server

A proxy server can be configured in the file /etc/app_protect/tools/iprepd.cfg:

shellEnableProxy=True 
ProxyHost=5.1.2.4
ProxyPort=8080
ProxyUsername=admin        # Optional
ProxyPassword=admin        # Optional
CACertPath=/etc/ssl/certs/ca-certificates.crt  # Optional`

After saving the changes, restart the client to apply the new settings:

/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &

Install virtual machine packages

This section only applies to virtual machines/bare metal installations.

To enable IP intelligence on a virtual machine or bare metal installation, you must install an extra package. You can install the extra package during or after set-up.

Review the virtual machine installation instructions for information on how to use the package manager for a specific operating system.

Operating system	Package name
Alpine Linux	app-protect-ip-intelligence
Amazon Linux	app-protect-ip-intelligence
Debian	app-protect-ip-intelligence
Oracle Linux / RHEL / Rocky Linux 8	app-protect-ip-intelligence
Ubuntu	app-protect-ip-intelligence
RHEL / Rocky Linux 9	app-protect-ip-intelligence

After installing the package, run the client:

/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &

Then verify the client is populating the database:

tail -f iprepd.log

Once complete, you can now Configure policies for IP intelligence.

Modify Docker compose file

This section only applies to installations using Docker.

IP intelligence has its own Docker container, which can be added to an existing Docker compose file for deployment.

First, create the required directory:

sudo mkdir -p /var/IpRep

Then set correct ownership of the directory:

sudo chown -R 101:101 /var/IpRep

Modify the original docker-compose.yml file to include the IP intelligence container, replacing image tags as appropriate:

services:
  waf-enforcer:
    container_name: waf-enforcer
    image: waf-enforcer:5.7.0
    environment:
      - ENFORCER_PORT=50000
    ports:
      - "50000:50000"
    volumes:
      - /opt/app_protect/bd_config:/opt/app_protect/bd_config
    networks:
      - waf_network
    restart: always
    depends_on:
      - waf-ip-intelligence

  waf-config-mgr:
    container_name: waf-config-mgr
    image: waf-config-mgr:5.7.0
    volumes:
      - /opt/app_protect/bd_config:/opt/app_protect/bd_config
      - /opt/app_protect/config:/opt/app_protect/config
      - /etc/app_protect/conf:/etc/app_protect/conf
    restart: always
    network_mode: none
    depends_on:
      waf-enforcer:
        condition: service_started

   waf-ip-intelligence:
    container_name: waf-ip-intelligence
    image: waf-ip-intelligence:5.7.0
    volumes:
      - /var/IpRep:/var/IpRep
    networks:
      - waf_network
    restart: always

networks:
  waf_network:
    driver: bridge

Once complete, you can now Configure policies for IP intelligence.

Modify Manifest configuration files

To enable IP intelligence on a Manifest-based Kubernetes deployment, you must add it as a container to your deployment file.

yaml        - name: waf-ip-intelligence
          image: private-registry.nginx.com/napwaf-ip-intelligence:<version-tag>
          imagePullPolicy: IfNotPresent
          securityContext:
            allowPrivilegeEscalation: false
          volumeMounts:
            - name: var-iprep
              mountPath: /var/IpRep

A full example could look as follows:

yamlapiVersion: apps/v1
kind: Deployment
metadata:
  name: nap5-deployment
spec:
  selector:
    matchLabels:
      app: nap5
  replicas: 2
  template:
    metadata:
      labels:
        app: nap5
    spec:
      imagePullSecrets:
        - name: regcred
      containers:
        - name: nginx
          image: <your-private-registry>/waf:<your-tag>
          imagePullPolicy: IfNotPresent
          volumeMounts:
            - name: app-protect-bd-config
              mountPath: /opt/app_protect/bd_config
            - name: app-protect-config
              mountPath: /opt/app_protect/config
        - name: waf-enforcer
          image: private-registry.nginx.com/nap/waf-enforcer:<version-tag>
          imagePullPolicy: IfNotPresent
          env:
            - name: ENFORCER_PORT
              value: "50000"
          volumeMounts:
            - name: app-protect-bd-config
              mountPath: /opt/app_protect/bd_config
            - name: var-iprep
              mountPath: /var/IpRep
        - name: waf-config-mgr
          image: private-registry.nginx.com/nap/waf-config-mgr:<version-tag>
          imagePullPolicy: IfNotPresent
          securityContext:
            allowPrivilegeEscalation: false
            capabilities:
              drop:
                - all
          volumeMounts:
            - name: app-protect-bd-config
              mountPath: /opt/app_protect/bd_config
            - name: app-protect-config
              mountPath: /opt/app_protect/config
            - name: app-protect-bundles
              mountPath: /etc/app_protect/bundles
        - name: waf-ip-intelligence
          image: private-registry.nginx.com/napwaf-ip-intelligence:<version-tag>
          imagePullPolicy: IfNotPresent
          securityContext:
            allowPrivilegeEscalation: false
          volumeMounts:
            - name: var-iprep
              mountPath: /var/IpRep
      volumes:
        - name: app-protect-bd-config
          emptyDir: {}
        - name: app-protect-config
          emptyDir: {}
         - name: var-iprep
          emptyDir: {}
        - name: app-protect-bundles
          persistentVolumeClaim:
            claimName: nap5-bundles-pvc

Once complete, you can now Configure policies for IP intelligence.

Configure policies for IP intelligence

Once the requirements for IP intelligence have been installed, you can enable it in two sections of your policy:

In the violation list, assigning block and alarm values ("name": "VIOL_MALICIOUS_IP")
In a new IP intelligence section, defining actions for each category ("ip-intelligence": {"enabled": true})

The following policy shows examples of both, with all IP intelligence categories configure to block and alarm:

json{
    "policy": {
        "name": "ip_intelligency_policy",
        "template": {
            "name": "POLICY_TEMPLATE_NGINX_BASE"
        },
        "applicationLanguage": "utf-8",
        "caseInsensitive": false,
        "enforcementMode": "blocking",
        "blocking-settings": {
            "violations": [
                {
                    "name": "VIOL_MALICIOUS_IP",
                    "alarm": true,
                    "block": true
                }
            ]
        },
        "ip-intelligence": {
            "enabled": true,
            "ipIntelligenceCategories": [
                {
                    "category": "Anonymous Proxy",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "BotNets",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Cloud-based Services",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Denial of Service",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Infected Sources",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Mobile Threats",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Phishing Proxies",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Scanners",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Spam Sources",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Tor Proxies",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Web Attacks",
                    "alarm": true,
                    "block": true
                },
                {
                    "category": "Windows Exploits",
                    "alarm": true,
                    "block": true
                }
            ]
        }
    }
}

This policy will block all IP addresses that are part of any threat category ("block": true) and add a log entry ("alarm": true) for the transaction.

The IP address database is managed by an external provider and is constantly updated (every 1 minute by default).

The database categorizes IP addresses into one or more threat categories. These are the same categories that can be configured individually in the IP intelligence section:

Anonymous Proxy
BotNets
Cloud-based Services
Denial of Service
Infected Sources
Mobile Threats
Phishing Proxies
Scanners
Spam Sources
Tor Proxies
Web Attacks
Windows Exploits

Since the IP address database is constantly updated, their enforcement may also change. Addresses may be added, removed, or moved from one category to another based on their reported activity.

View source

Edit this page

Create a new issue