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

Консоль управления ПроAPI Защита

Консоль управления ПроAPI Защита представляет собой компонент для управления нодами «ПроAPI Защита» и получения с них событий и метрик.

Требования

  • Установленный и настроенный Docker и Docker Compose.

  • Доступ к приватному репозиторию Docker Registry: registry.webmonitorx.ru

  • Спецификация:

    OpenAPI 3.0 для REST API приложения, которое должно быть защищено с помощью ПО ПроAPI Защита

Авторизация

На странице необходимо ввести свои учетные данные для входа в административную панель API Firewall Manager, после успешной авторизации открывается Дашборд.

Разделы

1. Дашборд

Основная цель дашборда — предоставить общую картину работы по всем или конкретному приложению. Здесь можно найти:

  • Счетчики запросов, блокировок, RPS за указанный период

  • Графики по запросам и блокировкам

  • Графики по ошибкам валидации и Shadow API событиям

API Firewall Manager Дашборд

Подробнее о дашборде →

2. События

Раздел События служит для отображения событий, происходящих в процессе валидации трафика на соответствие OAS нодами. Событием является отклонение запроса от спецификации.

События группируются по совпадению полей:

  • Временное окно

  • Приложение

  • Тип события

  • Метод запроса

  • Домен

  • Путь

  • Параметр запроса

Таблица с перечнем групп событий включает следующие поля:

  • Дата и длительность: дата и время запроса, общая длительность обработки группы запросов
  • События: количество событий
  • Тип: тип cобытия
  • IP/Источник: IP‑адрес первого события
  • Метод: метод запроса
  • Домен/Путь: домен и путь, на которые отправлен запрос
  • Параметр: параметр запроса, который не соответствует спецификации
  • Цветовой индикатор: отражает режим работы ноды: оранжевый, если запрос обнаружен, но не заблокирован (установлен режим мониторинга трафика, LOG_ONLY); красный, если запрос обнаружен и заблокирован, BLOCK
  • Код: код ответа на запрос

Чтобы посмотреть детальную информацию о каждом событии в группе, разверните её, нажав на данные в столбце Дата и длительность.

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

Вы можете сохранять фильтры, чтобы использовать их в будущем.

3. Приложения

Раздел предназначен для управления приложениями — вашими API, которые нужно защитить.
После создания приложения вы получите команду для запуска Docker-контейнера (ноды), через которую будет проксироваться трафик API. Для отказоустойчивости можно запустить несколько нод.
Если на одной ноде нужно обрабатывать трафик разных API (с уникальными спецификациями), используйте группу приложений.

Создание приложения API Firewall Manager

Возможности:

  • Получить общую картину по защищаемым приложением

  • Создать / редактировать / удалить приложение

  • Создать / редактировать / удалить группу приложений

  • Обновить спецификацию приложения

  • Получить подсказку по запуску docker контейнера фильтрующей ноды

4. Ноды

Раздел предоставляет возможность получать информацию по фильтрующим нодам, доступна фильтрация по приложениям.

Ноды API Firewall Manager

Доступны следующие свойства и метрики:

  • Уникальный идентификатор, ID ноды

  • Имя приложения

  • Количество RPS: количество обработанных запросов в секунду

  • Количество запросов, обработанных с начала текущего месяца

  • IP‑адрес

  • Активность: время последней синхронизации с консолью управления

  • Версия спецификации, состоящая из версии из файла OAS и первых 10 символов контрольной суммы файла

    Пример: 1.0.0 0f37288ef7, где 1.0.0 – версия из файла OAS, 0f37288ef7 – 10 первых символов контрольной суммы файла в формате SHA-256

  • Версия ПО ноды

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

Лицензия ноды

5. Белый список IP-адресов

Белый список — список доверенных IP-адресов, которым вы разрешаете доступ к приложениям вне зависимости от структуры запроса или ответа приложения.

Примечание

Запросы от источников из белого списка не проверяются на соответствие спецификации.

Вы можете управлять IP‑адресами из белого списка:

  • Добавлять отдельные IP‑адреса и подсети

  • Настраивать время и причину хранения IP‑адреса в списке

  • Удалять IP‑адреса из списка

6. Настройки

Раздел предназначен для настройки работы Консоли управления ПроAPI Защита. В разделе можно изменить пароль, указать URL для подключения нод к консоли управления и просматривать историю авторизаций.

Настройки API Firewall Manager

Просмотр истории авторизаций

История авторизаций помогает отслеживать активность пользователей в системе. Она содержит следующую информацию:

  • Дата и время каждой авторизации

  • IP-адрес, с которого была выполнена авторизация

Данные полезны для контроля доступа и выявления подозрительной активности и доступны для просмотра всем пользователям, имеющим доступ к системе.

6. О системе

Раздел предназначен для предоставления информации о статусе и времени окончания лицензии, а также о версии компонентов.

О системе

Если лицензия близка к истечению, то в интерфейсе появится предупреждающее сообщение.

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