Upgrading EOL Wallarm NGINX modules¶

These instructions describe the steps to upgrade the end‑of‑life Wallarm NGINX modules (version 3.6 and lower) to version 4.4. Wallarm NGINX modules are the modules installed in accordance with one of the following instructions:

• NGINX stable module

• Module for NGINX from CentOS/Debian repositories

• NGINX Plus module

Requirements¶

• Access to the account with the Administrator role in Wallarm Console in the US Cloud or EU Cloud

• Access to https://us1.api.wallarm.com if working with US Wallarm Cloud or to https://api.wallarm.com if working with EU Wallarm Cloud. Please ensure the access is not blocked by a firewall

Upgrade procedure¶

• If filtering node and postanalytics modules are installed on the same server, then follow the instructions below to upgrade all packages.

• If filtering node and postanalytics modules are installed on different servers, first upgrade the postanalytics module following these instructions and then perform the steps below for filtering node modules.

Step 1: Inform Wallarm technical support that you are upgrading filtering node modules (only if upgrading node 2.18 or lower)¶

If upgrading node 2.18 or lower, inform Wallarm technical support that you are updating filtering node modules up to the latest version and ask to enable new IP lists logic for your Wallarm account. When new IP lists logic is enabled, please open Wallarm Console and ensure that the section IP lists is available.

Step 2: Disable the Active threat verification module (if upgrading node 2.16 or lower)¶

If upgrading Wallarm node 2.16 or lower, please disable the Active threat verification module in Wallarm Console → Scanner → Settings.

The module operation can cause false positives during the upgrade process. Disabling the module minimizes this risk.

Step 3: Update API port¶

Starting with version 4.0, the filtering node uploads data to the Cloud using the us1.api.wallarm.com:443 (US Cloud) and api.wallarm.com:443 (EU Cloud) API endpoints instead of us1.api.wallarm.com:444 and api.wallarm.com:444.

If you upgrade the node from the version 3.x or lower and your server with the deployed node has a limited access to the external resources and the access is granted to each resource separately, then after upgrade the synchronization between the filtering node and the Cloud will stop.

To restore the synchronization, in your configuration, change port 444 to 443 for API endpoint for each resource.

Step 4: Upgrade NGINX to the latest version¶

Upgrade NGINX to the latest version using the relevant instructions:

sudo apt update
sudo apt -y install nginx

sudo yum update
sudo yum install -y nginx

If your infrastructure needs to use a specific version of NGINX, please contact the Wallarm technical support to build the Wallarm module for a custom version of NGINX.

Step 5: Add new Wallarm repository¶

Delete the previous Wallarm repository address and add a repository with a new Wallarm node version package. Please use the commands for the appropriate platform.

CentOS and Amazon Linux 2.0.2021x and lower

sudo yum remove wallarm-node-repo
sudo yum clean all
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/7/4.4/x86_64/wallarm-node-repo-4.4-0.el7.noarch.rpm

sudo yum remove wallarm-node-repo
sudo yum clean all
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/8/4.4/x86_64/wallarm-node-repo-4.4-0.el8.noarch.rpm

Debian and Ubuntu

1. Open the file with the Wallarm repository address in the installed text editor. In these instructions, vim is used.

   sudo vim /etc/apt/sources.list.d/wallarm.list
   

2. Comment out or delete the previous repository address.

3. Add a new repository address:

   Debian 10.x (buster)Debian 11.x (bullseye)Ubuntu 18.04 LTS (bionic)Ubuntu 20.04 LTS (focal)

   Unsupported by NGINX stable and NGINX Plus

   Official NGINX versions (stable and Plus) and, as a result, Wallarm node 4.4 and above cannot be installed on Debian 10.x (buster). Please use this OS only if NGINX is installed from Debian/CentOS repositories.

   deb http://repo.wallarm.com/debian/wallarm-node buster/4.4/
   

   deb http://repo.wallarm.com/debian/wallarm-node bullseye/4.4/
   

   deb http://repo.wallarm.com/ubuntu/wallarm-node bionic/4.4/
   

   deb http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/
   

Step 6: Migrate allowlists and denylists from the previous Wallarm node version to 4.4 (only if upgrading node 2.18 or lower)¶

If upgrading node 2.18 or lower, migrate allowlist and denylist configuration from previous Wallarm node version to the latest version.

Step 7: Upgrade Wallarm packages¶

Filtering node and postanalytics on the same server¶

Execute the following command to upgrade the filtering node and postanalytics modules:

sudo apt update
sudo apt dist-upgrade

W: GPG error: http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release' is not signed.
N: Updating from such a repository can't be done securely, and is therefore disabled by default.
N: See apt-secure(8) manpage for repository creation and user configuration details.

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sudo apt update
sudo apt dist-upgrade

sudo apt update
sudo apt dist-upgrade

W: GPG error: http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release' is not signed.
N: Updating from such a repository can't be done securely, and is therefore disabled by default.
N: See apt-secure(8) manpage for repository creation and user configuration details.

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sudo apt update
sudo apt dist-upgrade

sudo yum update

sudo yum update

Filtering node and postanalytics on different servers¶

1. Upgrade postanalytics packages following these instructions.

2. Upgrade Wallarm node packages:

   DebianUbuntuCentOS or Amazon Linux 2.0.2021x and lowerAlmaLinux, Rocky Linux or Oracle Linux 8.x

   sudo apt update
   sudo apt dist-upgrade
   

   The error "signatures couldn't be verified"

   If added GPG keys expired, the following error would be returned:

   W: GPG error: http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release:The following
   signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
   E: The repository 'http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release' is not signed.
   N: Updating from such a repository can't be done securely, and is therefore disabled by default.
   N: See apt-secure(8) manpage for repository creation and user configuration details.
   

   To fix the problem, please import new GPG keys for the Wallarm packages and then upgrade the packages using the following commands:

   curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
   sudo apt update
   sudo apt dist-upgrade
   

   Upgrading Wallarm dependencies

   The sudo apt dist-upgrade command upgrades both the Wallarm packages and filtering node dependencies. It is the recommended upgrade option providing correct operation of the newer filtering node version.

   sudo apt update
   sudo apt dist-upgrade
   

   The error "signatures couldn't be verified"

   If added GPG keys expired, the following error would be returned:

   W: GPG error: http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release:The following
   signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
   E: The repository 'http://repo.wallarm.com/ubuntu/wallarm-node focal/4.4/ Release' is not signed.
   N: Updating from such a repository can't be done securely, and is therefore disabled by default.
   N: See apt-secure(8) manpage for repository creation and user configuration details.
   

   To fix the problem, please import new GPG keys for the Wallarm packages and then upgrade the packages using the following commands:

   curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
   sudo apt update
   sudo apt dist-upgrade
   

   Upgrading Wallarm dependencies

   The sudo apt dist-upgrade command upgrades both the Wallarm packages and filtering node dependencies. It is the recommended upgrade option providing correct operation of the newer filtering node version.

   sudo yum update
   

   sudo yum update
   

3. If the package manager asks for confirmation to rewrite the content of the configuration file /etc/cron.d/wallarm-node-nginx:

   1. Ensure that the IP lists migration is completed.

   2. Confirm the file rewrite by using the option Y.

      The package manager would ask for the rewrite confirmation if the file /etc/cron.d/wallarm-node-nginx had been changed in the previous Wallarm node versions. Since IP list logic was changed in Wallarm node 3.x, the /etc/cron.d/wallarm-node-nginx content was updated accordingly. For the IP address denylist to operate correctly, the Wallarm node 3.x should use the updated configuration file.

      By default, the package manager uses the option N but the option Y is required for the correct IP address denylist operation in Wallarm node 3.x.

Step 8: Update the node type¶

The deployed node has the deprecated regular type that is now replaced with the new Wallarm node type.

It is recommended to install the new node type instead of the deprecated one during migration to the version 4.4. The regular node type will be removed in future releases, please migrate before.

If the postanalytics module is installed on a separate server

If the initial traffic processing and postanalytics modules are installed on separate servers, it is recommended to connect these modules to the Wallarm Cloud using the same node token. The Wallarm Console UI will display each module as a separate node instance, e.g.:

The Wallarm node has already been created during the separate postanalytics module upgrade. To connect the initial traffic processing module to the Cloud using the same node credentials:

1. Copy the node token generated during the separate postanalytics module upgrade.
2. Proceed to the 4^th step in the list below.

To replace the regular node with the Wallarm node:

1. Make sure that your Wallarm account has the Administrator role enabled in Wallarm Console.

   You can check mentioned settings by navigating to the user list in the US Cloud or EU Cloud.

   

2. Open Wallarm Console → Nodes in the US Cloud or EU Cloud and create the node of the Wallarm node type.

   

3. Copy the generated token.

4. Pause the NGINX service on the server with the node of the older version:

   DebianUbuntuCentOS or Amazon Linux 2.0.2021x and lowerAlmaLinux, Rocky Linux or Oracle Linux 8.x

   sudo systemctl stop nginx
   

   sudo service nginx stop
   

   sudo systemctl stop nginx
   

   sudo systemctl stop nginx
   

   The NGINX service pausing mitigates the risk of incorrect RPS calculation.

5. Execute the register-node script to run the Wallarm node:

   US CloudEU Cloud

   sudo /usr/share/wallarm-common/register-node -t <NODE_TOKEN> -H us1.api.wallarm.com --force
   

   sudo /usr/share/wallarm-common/register-node -t <NODE_TOKEN> --force
   

   • <NODE_TOKEN> is the Wallarm node token.
   • The --force option forces rewriting of the Wallarm Cloud access credentials specified in the /etc/wallarm/node.yaml file.

Step 9: Update the Wallarm blocking page¶

In new node version, the Wallarm sample blocking page has been changed. The logo and support email on the page are now empty by default.

If the page &/usr/share/nginx/html/wallarm_blocked.html was configured to be returned in response to blocked requests, copy and customize the new version of a sample page.

Step 10: Rename deprecated NGINX directives¶

Rename the following NGINX directives if they are explicitly specified in configuration files:

• wallarm_instance → wallarm_application

• wallarm_local_trainingset_path → wallarm_custom_ruleset_path

• wallarm_global_trainingset_path → wallarm_protondb_path

• wallarm_ts_request_memory_limit → wallarm_general_ruleset_memory_limit

We only changed the names of the directives, their logic remains the same. Directives with former names will be deprecated soon, so you are recommended to rename them before.

Step 11: Update the node logging variables¶

In the new node version the following changes to the node logging variables have been implemented:

• The wallarm_request_time variable has been renamed to wallarm_request_cpu_time.

  We only changed the variable name, its logic remains the same. The old name is temporarily supported as well, but still it is recommended to rename the variable.

• The wallarm_request_mono_time variable has been added – place it in the configuration of the logging format if you need log information about total time being the sum of:

  • Time in the queue
  • Time in seconds the CPU spent processing the request

Step 12: Adjust Wallarm node filtration mode settings to changes released in the latest versions¶

1. Ensure that the expected behavior of settings listed below corresponds to the changed logic of the off and monitoring filtration modes:

   • Directive wallarm_mode
   • General filtration rule configured in Wallarm Console
   • Low-level filtration rules configured in Wallarm Console

2. If the expected behavior does not correspond to the changed filtration mode logic, please adjust the filtration mode settings to released changes using the instructions.

Step 13: Transfer the overlimit_res attack detection configuration from directives to the rule¶

Starting from the version 3.6, you can fine-tune the overlimit_res attack detection using the rule in Wallarm Console.

Earlier, the wallarm_process_time_limit and wallarm_process_time_limit_block NGINX directives have been used. The listed directives are considered to be deprecated with the new rule release and will be deleted in future releases.

If the overlimit_res attack detection settings are customized via the listed directives, it is recommended to transfer them to the rule as follows:

1. Open Wallarm Console → Rules and proceed to the Fine-tune the overlimit_res attack detection rule setup.

2. Configure the rule as done via the NGINX directives:

   • The rule condition should match the NGINX configuration block with the wallarm_process_time_limit and wallarm_process_time_limit_block directives specified.
   • The time limit for the node to process a single request (milliseconds): the value of wallarm_process_time_limit.

   • Request processing: the Stop processing option is recommended.

     Risk of running out of system memory

     The high time limit and/or continuation of request processing after the limit is exceeded can trigger memory exhaustion or out-of-time request processing.

   • Register the overlimit_res attack: the Register and display in the events option is recommended.

     If the wallarm_process_time_limit_block or process_time_limit_block value is off, choose the Do not create attack event option.

   • The rule does not have the explicit equivalent option for the wallarm_process_time_limit_block directive. If the rule sets Register and display in the events, the node will either block or pass the overlimit_res attack depending on the node filtration mode:

     • In the monitoring mode, the node forwards the original request to the application address. The application has the risk to be exploited by the attacks included in both processed and unprocessed request parts.
     • In the safe blocking mode, the node blocks the request if it is originated from the graylisted IP address. Otherwise, the node forwards the original request to the application address. The application has the risk to be exploited by the attacks included in both processed and unprocessed request parts.
     • In the block mode, the node blocks the request.

3. Delete the wallarm_process_time_limit and wallarm_process_time_limit_block NGINX directives from the NGINX configuration file.

   If the overlimit_res attack detection is fine-tuned using both the directives and the rule, the node will process requests as the rule sets.

Step 14: Update the wallarm-status.conf file contents¶

Update the /etc/nginx/conf.d/wallarm-status.conf contents as follows:

server {
  listen 127.0.0.8:80;
  server_name localhost;

  allow 127.0.0.0/8;   # Access is only available for loopback addresses of the filter node server  
  deny all;

  wallarm_mode off;
  disable_acl "on";   # Checking request sources is disabled, denylisted IPs are allowed to request the wallarm-status service. https://docs.wallarm.com/admin-en/configure-parameters-en/#disable_acl
  access_log off;

  location ~/wallarm-status$ {
    wallarm_status on;
  }
}

More details on the statistics service configuration

Step 15: Restart NGINX¶

sudo systemctl restart nginx

sudo service nginx restart

sudo systemctl restart nginx

sudo systemctl restart nginx

Step 16: Test Wallarm node operation¶

1. Send the request with the test Path Traversal attack to the application address:

   curl http://localhost/etc/passwd
   

2. Make sure the node of the new type processes the request in the same way as the regular node did, e.g.:

   • Blocks the request if the appropriate filtration mode is configured.
   • Returns the custom blocking page if it is configured.

3. Open Wallarm Console → Events in the EU Cloud or US Cloud and make sure that:

   • The attack is displayed in the list.
   • Hit details display the Wallarm node UUID.
   

Step 17: Re-enable the Active threat verification module (only if upgrading node 2.16 or lower)¶

Learn the recommendation on the Active threat verification module setup and re-enable it if required.

After a while, ensure the module operation does not cause false positives. If discovering false positives, please contact the Wallarm technical support.

Step 18: Delete the node of the previous version¶

Once the operation of the new node is properly tested, open the Nodes section of Wallarm Console and delete the regular node of the previous version from the list.

If the postanalytics module is installed on a separate server, please also delete the node instance related to this module.

Settings customization¶

The Wallarm modules are updated to version 4.4. Previous filtering node settings will be applied to the new version automatically. To make additional settings, use the available directives.

Common customization options:

• Configuration of the filtration mode

• Logging Wallarm node variables

• Using the balancer of the proxy server behind the filtering node

• Limiting the single request processing time in the directive wallarm_process_time_limit

• Limiting the server reply waiting time in the NGINX directive proxy_read_timeout

• Limiting the maximum request size in the NGINX directive client_max_body_size

• Configuring dynamic DNS resolution in NGINX