Перейти к содержанию

Быстрый старт с Валарм API Security

С помощью данной инструкции вы сможете быстро установить первую фильтрующую ноду Валарм на основе NGINX и попробовать базовые возможности продукта. Быстрая установка ноды подходит только для первого знакомства с продуктом. Для установки ноды в боевой среде мы рекомендуем использовать отдельные инструкции для подходящих платформ.

Быстрая установка ноды Валарм реализована с помощью специального shell‑скрипта, который необходимо выполнить на сервере с поддерживаемой операционной системой (ОС) на базе Linux.

Описание скрипта для быстрого старта

Для быстрой установки ноды Валарм используется shell‑скрипт getwallarm.sh. Скрипт выполняет следующие шаги:

  1. Выключает механизм SELinux на установленной ОС. Быстрая установка ноды Валарм невозможна при включенном механизме SELinux.

  2. Устанавливает последнюю доступную версию NGINX stable из официального репозитория NGINX.

  3. Устанавливает пакеты Валарм для модуля Валарм-NGINX и модуля постаналитики.

  4. Регистрирует новую ноду в Облаке Валарм. Новая нода фильтрует запросы в режиме блокировки.

  5. Настраивает NGINX с установленной нодой Валарм как обратный прокси‑сервер для домена, который необходимо защитить от атак.

  6. Отправляет следующие тестовые запросы:

    • GET‑запрос на адрес 127.0.0.8/wallarm-status, чтобы проверить доступность сервиса статистики Валарм.
    • GET‑запрос на адрес инстанса NGINX (порт 80/TCP), чтобы проверить доступ к домену, который защищает нода.
    • Тестовый запрос с атаками SQLi и XSS на адрес инстанса NGINX:

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

      Ожидаемый ответ на запрос — 403, так как нода работает в режиме блокировки.

    Если реальный ответ на запрос отличается от ожидаемого, скрипт вернет сообщение с описанием ошибки и инструкцией для исправления.

Процедура быстрого старта

  1. Создайте аккаунт в Консоли управления Валарм, используя ссылку для европейского или российского Облака.

    Подробнее об Облаках Валарм →

  2. Установите поддерживаемую ОС на ваш сервер. Для корректной работы скрипта быстрого старта рекомендуется использовать образ/дистрибутив ОС с базовым набором пакетов, а также не выполнять дополнительную конфигурацию ОС. Нода, установленная с помощью скрипта для быстрого старта, может не поддерживать дополнительную конфигурацию ОС (например, дополнительные настройки безопасности или другие настройки, соответствующие внутренним стандартам компании).

    • Debian 10.x (buster)
    • Ubuntu 18.04 LTS (bionic)
    • Ubuntu 20.04 LTS (focal)
    • CloudLinux OS 6.x (CentOS 6.x)
    • CentOS 7.x
    • CentOS 8.x
  3. Подключитесь к серверу с поддерживаемой ОС и переключитесь на пользователя с правами root, используя команду:

    sudo -i
    
  4. Скачайте скрипт getwallarm.sh, используя команду:

    curl -o getwallarm.sh https://raw.githubusercontent.com/wallarm/quick-start/stable/3.2/getwallarm.sh
    
    wget -O getwallarm.sh https://raw.githubusercontent.com/wallarm/quick-start/stable/3.2/getwallarm.sh
    
  5. Запустите скрипт с необходимыми параметрами:

    sh getwallarm.sh -u <YOUR_WALLARM_USERNAME> -p <YOUR_WALLARM_PASSWORD> -S <WALLARM_CLOUD> -n <WALLARM_NODE_NAME> -d <DOMAIN_NAME> -o <ORIGIN_SERVER>
    
    Параметр Описание Обязательный?
    <YOUR_WALLARM_USERNAME> Email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
    <YOUR_WALLARM_PASSWORD> Пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
    <WALLARM_CLOUD> Название используемого Облака Валарм. Возможные значения: eu (по умолчанию), ru. Нет
    <WALLARM_NODE_NAME> Имя ноды Валарм. По умолчанию используется имя хоста.

    Вы сможете изменить заданное имя позже в Консоли управления Валарм → Ноды.
    Нет
    <DOMAIN_NAME> Нода Валарм будет обрабатывать трафик, поступающий на указанный домен. В качестве значения вы можете указать внешний эндпоинт вашего API, адрес сайта компании или любого другого сайта (например, example.com).

    Значение по умолчанию: localhost.
    Нет
    <ORIGIN_SERVER> Домен, на который необходимо проксировать трафик. Если параметр не передан в явном виде, используется значение <DOMAIN_NAME>. Нет
  6. Убедитесь, что скрипт вернул сообщение We've completed the Wallarm node deployment process.

    Если при выполнении скрипта возникли ошибки, скрипт вернет сообщения с описанием ошибок и инструкциями для исправления.

  7. Откройте Консоли управления Валарм для европейского или российского ОблакаСобытия и убедитесь, что атаки SQLi и XSS появились в списке:

    Атаки в интерфейсе

Следующие шаги

Быстрая установка ноды Валарм выполнена успешно!

Для дальнейшего знакомства с продуктом мы рекомендуем изучить следующие базовые возможности Валарм API Security:

Установка ноды в боевой среде

Если вы завершили быстрый старт и изучили базовые возможности Валарм API Security, рекомендуем перейти к установке фильтрующей ноды в боевой среде.

Поддерживаемые способы установки ноды Валарм в боевой среде →