Upgrading Wallarm NGINX modules¶

These instructions describe the steps to upgrade the Wallarm NGINX modules 3.4 or 3.2 to version 3.6. 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

• Kong module

To upgrade the node 2.18 or lower, please use the different instructions.

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: Upgrade NGINX to the latest version¶

Upgrade NGINX to the latest version using the relevant instructions:

sudo apt update
sudo apt install nginx

sudo yum update
sudo yum install 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 2: 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/6/3.6/x86_64/Packages/wallarm-node-repo-1-6.el6.noarch.rpm

sudo yum remove wallarm-node-repo
sudo yum clean all
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/7/3.6/x86_64/Packages/wallarm-node-repo-1-6.el7.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 9.x (stretch)Debian 9.x (stretch-backports)Debian 10.x (buster)Ubuntu 18.04 LTS (bionic)Ubuntu 20.04 LTS (focal)

   deb https://repo.wallarm.com/debian/wallarm-node stretch/3.6/
   

   deb https://repo.wallarm.com/debian/wallarm-node stretch/3.6/
   deb https://repo.wallarm.com/debian/wallarm-node stretch-backports/3.6/
   

   deb https://repo.wallarm.com/debian/wallarm-node buster/3.6/
   

   deb https://repo.wallarm.com/ubuntu/wallarm-node bionic/3.6/
   

   deb https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/
   

Step 3: 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: https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ 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: https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ 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

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 lower

   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: https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ Release:The following
   signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
   E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ 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
   

   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: https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ Release:The following
   signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
   E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/3.6/ 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
   

   sudo yum update
   

Step 4: Update the Wallarm blocking page¶

In the 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 the blocked requests, copy and customize the new version of a sample page.

Step 5: 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

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 6: 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 7: Restart NGINX¶

sudo systemctl restart nginx

sudo service nginx restart

sudo systemctl restart nginx

Step 8: Test Wallarm node operation¶

1. Send the request with test SQLI and XSS attacks to the protected resource address:

   curl http://localhost/?id='or+1=1--a-<script>prompt(1)</script>'
   

2. Open the Wallarm Console → Attacks section in the US Cloud or EU Cloud and ensure attacks are displayed in the list.
   

Settings customization¶

The Wallarm modules are updated to version 3.6. 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

• Double‑detection of attacks with libdetection

Was this page helpful?

How can we improve this article? (Optional)

Information is unclear or confusing

Insufficient information

Outdated or incorrect information

0/240

Send