Отдельная установка модуля постаналитики¶

Обработка запросов в модуле Валарм делится на две фазы:

Первичная обработка в модуле NGINX-Wallarm (нодой Валарм). Не требует большого объема оперативной памяти, может быть размещена на текущих frontend-серверах без изменения требований.
Статистический анализ обработанных запросов в модуле постаналитики. Требует значительного объема памяти, что может потребовать внесения изменений в конфигурацию существующих серверов либо выполнение постаналитики на другом сервере.

В зависимости от архитектуры системы, модуль NGINX-Wallarm и модуль постаналитики могут быть установлены на один сервер или на разные серверы.

Данная инструкция описывает способ установки модуля постаналитики на отдельный сервер.

Требования¶

Модуль NGINX-Wallarm, установленный для NGINX stable из репозитория NGINX, NGINX из репозитория Debian/CentOS или NGINX Plus
Доступ к аккаунту с ролью Администратор или Деплой и отключенной двухфакторной аутентификацией в Консоли управления Валарм для RU‑Облака или EU‑Облака
SELinux, отключенный или настроенный по инструкции
Выполнение команд от имени суперпользователя (например, root)
Возможность обращаться к https://repo.wallarm.com для загрузки пакетов. Убедитесь, что доступ не ограничен настройками файервола
Доступ к https://api.wallarm.com:444 для работы с EU‑Облаком Валарм или к https://api.wallarm.ru:444 для работы с RU‑Облаком Валарм. Если доступ к Валарм API возможен только через прокси‑сервер, используйте инструкцию для настройки
Доступ к адресам GCP или хранилища Яндекс S3, чтобы обеспечить корректную блокировку IP‑адресов, зарегистрированных в странах или дата-центрах из белого, черного и серого списков IP. Набор адресов:
- Диапазон адресов для EU-Облака Валарм
- Для RU-Облака Валарм необходимо обеспечить доступ к нескольким диапазонам: диапазон 1 и диапазон 2
Установленный текстовый редактор vim, nano или другой. В инструкции используется редактор vim

Установка¶

1. Добавьте репозитории Валарм¶

Модуль постаналитики, как и другие модули Валарм, устанавливается и обновляется из репозиториев Валарм. Для добавления репозиториев используйте команды для вашей платформы:

Debian 9.x (stretch)

sudo apt install dirmngr
curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/debian/wallarm-node stretch/3.4/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

Debian 9.x (stretch-backports)

sudo apt install dirmngr
curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/debian/wallarm-node stretch/3.4/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sh -c "echo 'deb http://repo.wallarm.com/debian/wallarm-node stretch-backports/3.4/' | sudo tee --append /etc/apt/sources.list.d/wallarm.list"
# for correct Wallarm node operation, uncomment the following line in /etc/apt/sources.list`:
# deb http://deb.debian.org/debian stretch-backports main contrib non-free
sudo apt update

Debian 10.x (buster)

sudo apt install dirmngr
curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/debian/wallarm-node buster/3.4/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

Debian 11.x (buster)

sudo apt install dirmngr
curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.wallarm.com/debian/wallarm-node bullseye/3.4/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

Ubuntu 18.04 LTS (bionic)

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

Ubuntu 20.04 LTS (focal)

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

CloudLinux OS 6.x

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

CentOS 7.x

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

Amazon Linux 2

sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/7/3.4/x86_64/Packages/wallarm-node-repo-1-6.el7.noarch.rpm

CentOS 8.x

sudo yum install -y epel-release
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/8/3.4/x86_64/Packages/wallarm-node-repo-1-6.el8.noarch.rpm

2. Установите пакеты для модуля постаналитики¶

Для модуля постаналитики и хранилища Tarantool необходимо установить группу пакетов wallarm-node-tarantool из репозитория Валарм:

Debian

sudo apt install --no-install-recommends wallarm-node-tarantool

Ubuntu

sudo apt install --no-install-recommends wallarm-node-tarantool

CentOS или Amazon Linux 2

sudo yum install wallarm-node-tarantool

3. Подключите модуль постаналитики к Облаку Валарм¶

В процессе работы модуль постаналитики взаимодействует с Облаком Валарм. Чтобы обеспечить взаимодействие с Облаком, необходимо создать отдельную ноду Валарм для модуля постаналитики. Нода будет получать правила обработки трафика из Облака и выгружать данные об атаках в Облако.

Чтобы создать ноду и подключить модуль постаналитики к Облаку, выполните следующие действия:

Убедитесь, что роль вашего пользователя в Консоли управления Валарм — Администратор или Деплой и для пользователя отключена двухфакторная аутентификация.

Для этого перейдите к списку пользователей в RU‑Облаке или EU‑Облаке и проверьте столбцы Роль и Auth:
В системе с установленными пакетами модуля постаналитики запустите скрипт addnode:
EU‑Облако
```
sudo /usr/share/wallarm-common/addnode --no-sync
```
RU‑Облако
```
sudo /usr/share/wallarm-common/addnode -H api.wallarm.ru --no-sync
```
Введите email и пароль от вашего аккаунта Валарм.
Введите имя ноды для модуля постаналитики или нажмите Enter, чтобы использовать имя, сгенерированное автоматически.

Вы сможете изменить заданное имя позже в Консоли управления Валарм → Ноды.
Перейдите в Консоль управления Валарм → секция Ноды для RU‑Облака или EU‑Облака и убедитесь, что в списке появилась созданная нода.

4. Обновите конфигурацию модуля постаналитики¶

Конфигурационный файл для модуля постаналитики расположен по пути:

/etc/default/wallarm-tarantool для операционных систем Debian и Ubuntu
/etc/sysconfig/wallarm-tarantool для операционных систем CentOS и Amazon Linux 2

Чтобы открыть файл для редактирования, используйте команду:

Debian

sudo vim /etc/default/wallarm-tarantool

Ubuntu

sudo vim /etc/default/wallarm-tarantool

CentOS или Amazon Linux 2

sudo vim /etc/sysconfig/wallarm-tarantool

Оперативная память¶

Модуль постаналитики использует находящееся в памяти хранилище Tarantool. Рекомендуемое количество памяти для Tarantool в боевой среде: 75% от общей памяти виртуальной машины. Для тестирования ноды вы можете выделить меньшее количество памяти (например, 25% от общего объема).

Размер памяти для Tarantool необходимо передать в ГБ в директиве SLAB_ALLOC_ARENA в конфигурационном файле /etc/default/wallarm-tarantool или /etc/sysconfig/wallarm-tarantool. Значение может быть целым или дробным (разделитель целой и дробной части — точка). Например:

Для тестирования ноды

SLAB_ALLOC_ARENA=0.5

Для установки ноды в боевой среде

SLAB_ALLOC_ARENA=24

Подробные рекомендации по выделению памяти для Tarantool описаны в инструкции.

Адрес сервера постаналитики¶

Чтобы настроить адрес сервера постаналитики, необходимо:

Открыть для редактирования конфигурационный файл Tarantool:
Debian
```
sudo vim /etc/default/wallarm-tarantool
```
Ubuntu
```
sudo vim /etc/default/wallarm-tarantool
```
CentOS или Amazon Linux 2
```
sudo vim /etc/sysconfig/wallarm-tarantool
```
Снять комментарии с переменных HOST и PORT и указать следующие значения для переменных:
```
# address and port for bind
HOST='0.0.0.0'
PORT=3313
```
Если конфигурационный файл Tarantool настроен принимать соединения на адресах, отличных от 0.0.0.0 или 127.0.0.1, указать эти адреса в конфигурационном файле /etc/wallarm/node.yaml:
```
hostname: <name of the Wallarm postanalytics node>
uuid: <UUID of postanalytics node>
secret: <secret key of postanalytics node>
tarantool:
    host: '<IP address of Tarantool>'
    port: 3313
```
Указать адрес отдельного сервера постаналитики на сервере с установленными пакетами NGINX‑Wallarm, как описано в инструкции для подходящей формы установки:

5. Перезапустите сервисы Валарм¶

Чтобы применить заданные настройки к модулю постаналитики и к модулю NGINX‑Wallarm, необходимо:

Перезапустить сервис wallarm-tarantool на сервере с модулем постаналитики:
Debian
```
sudo systemctl restart wallarm-tarantool
```
Ubuntu
```
sudo systemctl restart wallarm-tarantool
```
CentOS или Amazon Linux 2
```
sudo systemctl restart wallarm-tarantool
```
Перезапустить сервис NGINX на сервере с модулем NGINX‑Wallarm:
Debian
```
sudo systemctl restart nginx
```
Ubuntu
```
sudo service nginx restart
```
CentOS или Amazon Linux 2
```
sudo systemctl restart nginx
```

6. Проверьте взаимодействие модуля NGINX‑Wallarm и модуля постаналитики¶

Чтобы проверить взаимодействие модулей Валарм, установленных на разных серверах, вы можете отправить на адрес защищаемого приложения тестовую атаку:

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

Если модуль NGINX‑Wallarm и модуль постаналитики настроены корректно, атака выгрузится в Облако Валарм и отобразится в Консоли управления Валарм → секция События:

Если атака не выгрузилась в Облако, проверьте наличие ошибок в работе сервисов:

Убедитесь, что сервис модуля постаналитики wallarm-tarantool находится в статусе active
```
sudo systemctl status wallarm-tarantool
```
Проанализируйте логи модуля постаналитики
```
sudo cat /var/log/wallarm/tarantool.log
```
Если в логах есть запись, подобная SystemError binary: failed to bind: Cannot assign requested address, убедитесь, что сервер принимает соединение по указанному адресу и порту.
На сервере с модулем NGINX‑Wallarm проанализируйте логи NGINX:
```
sudo cat /var/log/nginx/error.log
```
Если в логах есть запись, подобная [error] wallarm: <address> connect() failed, убедитесь, что на сервере с модулем NGINX‑Wallarm указан верный адрес сервера с модулем постаналитики и сервер с модулем постаналитики принимает соединение по указанному адресу и порту.
На сервере с модулем NGINX‑Wallarm: выполните команду для получения статистики по обработанным запросам и убедитесь, что значение tnt_errors равно 0
```
curl http://127.0.0.8/wallarm-status
```
Описание всех параметров, которые возвращает сервис статистики →

Защита модуля постаналитики¶

Защита постаналитики

Мы настоятельно рекомендуем защитить установленный модуль постаналитики файерволом. В противном случае есть риск несанкционированного подключения к сервису, что может привести к получению:

Информации об обработанных запросах
Возможности выполнения произвольного Lua-кода и команд операционной системы

Обратите внимание, что если модуль постаналитики устанавливается на одном сервере с модулем NGINX‑Wallarm, то такого риска нет, так как модуль постаналитики подключается к порту 3313.

Настройки файервола для отдельно установленного модуля постаналитики:

Разрешите прохождение HTTPS‑трафика к API-серверам Валарм (api.wallarm.com:444 для EU‑Облака или api.wallarm.ru:444 для RU‑Облака) в обоих направлениях, чтобы модуль постаналитики мог взаимодействовать с этими серверами.
Ограничьте доступ к порту 3313 Tarantool по протоколам TCP и UDP, разрешив соединения только с IP‑адресов нод Валарм.