Strelka Web UI — это браузерный и API-ориентированный фронтенд для отправки файлов в Strelka Enterprise File Scanner. Он позволяет пользователям отправлять файлы в кластер Strelka и легко просматривать исторические результаты ответов. Strelka Web UI поддерживает LDAP-аутентификацию и доступ через API, обеспечивая безопасный и гибкий способ взаимодействия со сканером Strelka. В этом документе описано, как настроить и использовать Strelka Web UI, а также его возможности и связанные проекты.

Страница результатов Strelka UI

Возможности

UI для отправки файлов предоставляет следующие возможности:

• Отправка файлов в кластер Strelka и просмотр ответов из браузера.
• Хранение и просмотр результатов предыдущих отправок и активности в локальной или удалённой базе данных.
• Поддержка LDAP-аутентификации
• Поддержка API

Предварительные требования

• Доступный экземпляр Strelka (см.: Strelka Quickstart)
• Docker
• Docker-compose
• Python 3.10+

Быстрый старт

По умолчанию Strelka UI настроен на использование минимального развёртывания «quickstart», позволяющего пользователям протестировать систему. Это развёртывание будет нацелено на локальный экземпляр Strelka и запустит локальную базу данных. Пользователи смогут получить доступ к этой системе с любым именем пользователя / паролем. Для получения дополнительной информации о нацеливании на удалённый экземпляр Strelka, базу данных или использовании LDAP для аутентификации см. раздел Дополнительная настройка:

Шаг 1: Убедитесь, что кластер Strelka готов

Start or ensure Strelka cluster is ready and accessible.
See https://github.com/target/strelka for more information.

Шаг 2: Соберите и запустите Strelka UI (Docker)

# Terminal 1
# From the ./strelka-ui directory
$ docker-compose -f docker-compose.yml up

Шаг 3: Получите доступ к Strelka UI

1) Open A Browser
2) Navigate to 0.0.0.0:8080
3) Login with:
    - Username: strelka
    - Password: strelka

Дополнительные шаги

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

Настройка переменных окружения

Конфигурация бэкенда задаётся через переменные окружения и может быть статически установлена в ./app/config/config.py.

При локальном запуске приоритет конфигурации следующий: System environment -> .env -> ./app/config/config.py. При запуске в Docker приоритет конфигурации следующий: Docker environment -> System environment -> ./app/config/config.py.

Обратитесь к ./app/example.env для настройки переменных окружения.

Параметры переменных окружения

Ниже описаны элементы конфигурации в ./app/config/config.py.

Поддержка внешних горячих ссылок

Вы также можете задать ссылку в таблице отправок UI, чтобы позволить пользователям быстро переходить на внешний сайт на основе request.id. Изменив ./ui/src/config.js и следуя примеру SEARCH_URL в следующей таблице, вы можете предоставить пользователям ссылку на внешний сайт (например, SIEM / логгер). Убедитесь, что ваша ссылка содержит строку <REPLACE>, и UI заменит эту строку на идентификатор запроса соответствующего файла.

Поддерживаемые поля модификации в ./ui/src/config.js:

Предоставление CA-сертификатов

Если ваша сетевая среда требует пользовательского CA-бандла (например, корпоративный прокси для TLS-инспекции), вы можете предоставить его как на этапе сборки, так и во время выполнения, не добавляя файлы сертификатов в репозиторий.

На этапе сборки — передайте путь к вашему CA-бандлу через CUSTOM_CA_CERT перед запуском docker compose build. Сертификат монтируется эфемерно с использованием секрета BuildKit и никогда не записывается ни в один слой образа:

CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose build
# or, combined with up:
CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose up --build

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

docker compose up --build

Во время выполнения — каталог certs в корне проекта монтируется в /certs внутри запущенного контейнера. Поместите туда ваш CA-бандл и задайте REQUESTS_CA_BUNDLE (и, при необходимости, SSL_CERT_FILE) в ./app/strelka_ui/.env или в качестве переменной окружения Docker:

# ./app/strelka_ui/.env
REQUESTS_CA_BUNDLE=/certs/ca-bundle.crt
SSL_CERT_FILE=/certs/ca-bundle.crt

API

Strelka UI также предоставляет маршруты API для доступа на основе пользовательских скриптов. Обратитесь к приведённым ниже маршрутам для получения подробностей:

Маршруты аутентификации

• [base url]/api/auth/login (POST)
• [base url]/api/auth/logout (GET)

Маршруты Strelka

• [base url]/api/strelka/scans/stats (GET)
• [base url]/api/strelka/scans/upload (POST, form-encoded)
• [base url]/api/strelka/scans?page=?&per_page=? (GET)
• [base url]/api/strelka/scans/scan id

Пример

Примеры того, как аутентифицироваться в API Strelka UI, собирать статистику сканирований и отправлять файл с помощью Python requests, можно найти в ./misc/examples/api_examples.py

База данных

База данных использует https://www.sqlalchemy.org/ в качестве ORM. Flask-Migrate используется для обеспечения миграций БД через Alembic. Предоставляется вспомогательный скрипт manage.py для помощи с типовыми задачами базы данных.

Если вы создаёте новую базу данных или изменяете текущую, вы должны выполнить следующие шаги — хотя при запуске кластера эти команды будут выполнены за вас:

Сгенерировать новую миграцию из изменений модели:

• python manage.py db migrate

Обновить базу данных, используя текущую конфигурацию базы данных

• python manage.py db upgrade

Детали приложения

Бэкенд-приложение преимущественно состоит из следующих технологий:

• https://flask.palletsprojects.com/en/1.1.x/
• https://www.sqlalchemy.org/
• https://www.postgresql.org/

Фронтенд UI — это приложение на React JS, созданное с использованием React и обслуживаемое из Flask. UI использует библиотеку Antd и Antd ProComponents, а маршрутизация обрабатывается React Router.

• create-react-app
• Ant Financial UI
• Antd ProComponents
• React Router

Страница панели управления Strelka UI

Связанные проекты

• Strelka

Лицензирование

Strelka UI и связанный с ним код выпускаются на условиях Apache 2.0 License.