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

Консоль управления Про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‑адрес, с которого был отправлен запрос

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

  • Домен/Путь: домен и путь, на которые отправлен запрос

  • Параметр: параметр запроса, который не соответствует спецификации

  • Код: код ответа на запрос.

  • Цветовой индикатор отображается в столбце Код и указывает на статус блокировки атаки:

    • Индикатор оранжевый, если запрос обнаружен, но не заблокирован (установлен режим мониторинга трафика)
    • Индикатор красный, если запрос обнаружен и заблокирован

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

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

В разделе представлен список всех созданных приложений, к которым можно подключить фильтрующие ноды ПО ПроAPI Защита.

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

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

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

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

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

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

4. Ноды

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

Ноды API Firewall Manager

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

  • Уникальный идентификатор (UUID)

  • Имя

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

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

  • IP‑адрес

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

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

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

  • Версия

5. Настройки

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

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

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

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

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

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

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

6. О системе

Раздел предназначен для предоставления пользователям информации о текущей конфигурации и статусе системы.

О системе

Отображается следующая информация:

  • Срок действия лицензии: дата окончания срока действия действующей лицензии

  • Версия системы: текущая версия программного обеспечения, установленная на сервере

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

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