Installing Wallarm from DEB/RPM packages for Kong¶

These instructions provide you with the steps to install the Wallarm module for Kong using DEB/RPM packages.

Installation¶

To install the Wallarm module with Kong, you need to:

1. Add Wallarm repositories.

2. Install Wallarm packages.

3. Configure postanalytics.

4. Set up the filtering node for using a proxy server.

5. Connect the filtering node to the Wallarm Cloud.

6. Configure the postanalytics server addresses.

7. Configure the filtration mode.

8. Configure logging.

apt list wallarm-node

apt list wallarm-node

yum list wallarm-node

# run from the server with installed Wallarm filtering node
apt list wallarm-node-nginx
# run from the server with installed postanalytics
apt list wallarm-node-tarantool

# run from the server with installed Wallarm filtering node
apt list wallarm-node-nginx
# run from the server with installed postanalytics
apt list wallarm-node-tarantool

# run from the server with installed Wallarm filtering node
yum list wallarm-node-nginx
# run from the server with installed postanalytics
yum list wallarm-node-tarantool

1. Add Wallarm repositories¶

The filtering node installs and updates from the Wallarm repositories.

Depending on your operating system, run one of the following commands:

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/ubuntu/wallarm-node xenial/2.18/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/ubuntu/wallarm-node bionic/2.18/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

sudo yum install -y epel-release
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/7/2.18/x86_64/Packages/wallarm-node-repo-1-6.el7.noarch.rpm

2. Install Wallarm Packages¶

To install the filtering node and postanalytics on the same server, run the command:

sudo apt install --no-install-recommends wallarm-node kong-module-wallarm

sudo apt install --no-install-recommends wallarm-node kong-module-wallarm

sudo yum install wallarm-node kong-module-wallarm

To install the filtering node alone, run the command:

sudo apt install --no-install-recommends wallarm-node-nginx kong-module-wallarm

sudo apt install --no-install-recommends wallarm-node-nginx kong-module-wallarm

sudo yum install wallarm-node-nginx kong-module-wallarm

3. Configure postanalytics¶

The amount of memory determines the quality of work of the statistical algorithms. Learn more about amount of required resources here. Note that for testing environments you can allocate lower resources than for the production ones.

Allocate the operating memory size for Tarantool:

Open for editing the configuration file of Tarantool:

sudo vim /etc/default/wallarm-tarantool

sudo vim /etc/default/wallarm-tarantool

sudo vim /etc/sysconfig/wallarm-tarantool

Set the allocated memory size in the configuration file of Tarantool via the SLAB_ALLOC_ARENA directive. The value can be an integer or a float (a dot . is a decimal separator).

Restart Tarantool:

sudo service wallarm-tarantool restart

sudo service wallarm-tarantool restart

sudo systemctl restart wallarm-tarantool

4. Set up the filtering node for using a proxy server¶

You need to assign new values to the environment variables, which define the proxy server used, to configure Wallarm node for using your proxy server.

Add new values of the environment variables to the /etc/environment file:

• Add https_proxy to define a proxy for the https protocol.

• Add http_proxy to define a proxy for the http protocol.

• Add no_proxy to define the list of the resources proxy should not be used for.

Assign the <scheme>://<proxy_user>:<proxy_pass>@<host>:<port> string values to the https_proxy and http_proxy variables.

• <scheme> defines the protocol used. It should match the protocol that the current environment variable sets up proxy for.

• <proxy_user> defines the username for proxy authorization.

• <proxy_pass> defines the password for proxy authorization.

• <host> defines a host of the proxy server.

• <port> defines a port of the proxy server.

Assign a "<res_1>, <res_2>, <res_3>, <res_4>, ..." array value, where <res_1>, <res_2>, <res_3>, and <res_4> are the IP addresses and/or domains, to the no_proxy variable to define a list of the resources which proxy should not be used for. This array should consist of IP addresses and/or domains.

The example of the correct /etc/environment file contents below demonstrates the following configuration:

• HTTPS and HTTP requests are proxied to the 1.2.3.4 host with the 1234 port, using the admin username and the 01234 password for authorization on the proxy server.

• Proxying is disabled for the requests sent to 127.0.0.1, 127.0.0.8, 127.0.0.9, and localhost.

https_proxy=http://admin:01234@1.2.3.4:1234
http_proxy=http://admin:01234@1.2.3.4:1234
no_proxy="127.0.0.1, 127.0.0.8, 127.0.0.9, localhost"

5. Connect the filtering node to the Wallarm Cloud¶

The filtering node interacts with the Wallarm Cloud.

To connect the node to the cloud using your cloud account requisites, proceed with the following steps:

1. Make sure that your Wallarm account has the Administrator or Deploy role enabled and two-factor authentication disabled, therefore allowing you to connect a filtering node to the Cloud.

   You can check the above mentioned parameters by navigating to the user account list in Wallarm Console.

   • If you are using https://my.wallarm.com/, proceed to the following link to check your user settings.
   • If you are using https://us1.my.wallarm.com/, proceed to the following link to check your user settings.
   

2. Run the addnode script in a system with the filtering node:

   Info

   You have to pick the script to run depending on the Cloud you are using.

   • If you are using https://us1.my.wallarm.com/, run the script from the US Cloud tab below.
   • If you are using https://my.wallarm.com/, run the script from the EU Cloud tab below.
   US CloudEU Cloud

   sudo /usr/share/wallarm-common/addnode -H us1.api.wallarm.com
   

   sudo /usr/share/wallarm-common/addnode
   

   To specify the name of the created node, use the -n <node name> option. Also, the node name can be changed in Wallarm Console → Nodes.

3. Provide your Wallarm account’s email and password when prompted.

6. Configure the postanalytics server addresses¶

Add the server address of postanalytics to /etc/kong/nginx-wallarm.template:

upstream wallarm_tarantool {
    server <ip1>:3313 max_fails=0 fail_timeout=0 max_conns=1;
    server <ip2>:3313 max_fails=0 fail_timeout=0 max_conns=1;

    keepalive 2;
}

# omitted

wallarm_tarantool_upstream wallarm_tarantool;

7. Set up the filtration mode¶

The filtering and proxying rules are configured in the /etc/kong/nginx-wallarm.template file.

To see detailed information about working with NGINX configuration files, proceed to the official NGINX documentation.

Wallarm directives define the operation logic of the Wallarm filtering node. To see the list of Wallarm directives available, proceed to the Wallarm configuration options page.

Configuration file example

Let us suppose that you need to configure the server to work in the following conditions:

• Only HTTP traffic is processed. There are no HTTPS requests processed.

• The following domains receive the requests: example.com and www.example.com.

• All requests must be passed to the server 10.80.0.5.

• All incoming requests are considered less than 1MB in size (default setting).

• The processing of a request takes no more than 60 seconds (default setting).

• Wallarm must operate in the monitor mode.

• Clients access the filtering node directly, without an intermediate HTTP load balancer.

To meet the listed conditions, the contents of the configuration file must be the following:

    server {
      listen 80;
      listen [::]:80 ipv6only=on;

      # the domains for which traffic is processed
      server_name example.com; 
      server_name www.example.com;

      # turn on the monitoring mode of traffic processing
      wallarm_mode monitoring; 
      # wallarm_instance 1;

      location / {
        # setting the address for request forwarding
        proxy_pass http://10.80.0.5; 
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      }
    }

8. Configure logging¶

Configure the filtering node variables logging using NGINX. This will allow to perform a quick filtering node diagnostics with the help of the NGINX log file.

Start Kong¶

To start Kong with the installed Wallarm module, run the command:

kong start --nginx-conf /etc/kong/nginx-wallarm.template

The installation is complete¶

Check that the filtering node runs and filters the traffic. See Check the filtering node operation.

Additional settings¶

The filtering node may require some additional configuration after installation.

The document below lists a few of the typical setups that you can apply if needed.

To get more information about other available settings, proceed to the Configuration section of the Administrator’s guide.

Configuring the display of the client's real IP¶

If the filtering node is deployed behind a proxy server or load balancer without any additional configuration, the request source address may not be equal to the actual IP address of the client. Instead, it may be equal to one of the IP addresses of the proxy server or the load balancer.

In this case, if you want the filtering node to receive the client's IP address as a request source address, you need to perform an additional configuration of the proxy server or the load balancer.

Adding Wallarm Scanner addresses to the allowlist¶

The Wallarm Scanner checks the resources of your company for vulnerabilities. Scanning is conducted using IP addresses from one of the following lists (depending on the type of Wallarm Cloud you are using):

• US Scanner addresses for US Cloud users

• EU Scanner addresses for EU Cloud users

If you are using the Wallarm Scanner, you need to configure the allowlists on your network scope security software (such as firewalls, intrusion detection systems, etc.) to contain Wallarm Scanner IP addresses.

For example, a Wallarm filtering node with default settings is placed in the blocking mode, thus rendering the Wallarm Scanner unable to scan the resources behind the filtering node.

To make the Scanner operational again, allowlist the Scanner's IP addresses on this filtering node.

Limiting the single request processing time¶

Use the wallarm_process_time_limit Wallarm directive to specify the limit of the duration for processing a single request by the filtering node.

If processing the request consumes more time than specified in the directive, then the information on the error is entered into the log file and the request is marked as an overlimit_res attack.

Limiting the server reply waiting time¶

Use the proxy_read_timeout NGINX directive to specify the timeout for reading the proxy server reply.

If the server sends nothing during this time, the connection is closed.

Limiting the maximum request size¶

Use the client_max_body_size NGINX directive to specify the limit for the maximum size of the body of the client's request.

If this limit is exceeded, NGINX replies to the client with the 413 (Payload Too Large) code, also known as the Request Entity Too Large message.