Встроенные шаблоны СЗИ

Встроенные шаблоны СЗИ содержат предварительно заполненные параметры взаимодействия с СЗИ. Перед использованием шаблона проверьте параметры подключения и подготовьте указанные для него секреты.

Как выбрать шаблон

  1. Выберите СЗИ, с которым нужно взаимодействовать.

  2. Определите доступный протокол: API или ICAP.

  3. Выберите режим: синхронный — результат возвращается при выполнении запроса; с опросом (Poll) — результат нужно запрашивать повторно. Если для работы с СЗИ требуется несколько запросов, учитывайте число шагов шаблона.

Таблица помогает найти шаблон; особенности настройки и ограничения приведены в разделах ниже.

СЗИШаблонПротокол и режимШаговЧто подготовить

PDF Converter

built_in_file_converter_base_template

API, Sync

1

CDR_API_KEY

YARA Analyser

built_in_yara_analyser_base_template

API, Sync

1

YARA_API_KEY, неймспейсы

PT Sandbox

pt_sync_api_base_template

API, Sync

2

PT_SANDBOX_API_KEY

PT Sandbox

pt_poll_api_base_template

API, Poll

3

PT_SANDBOX_API_KEY

PT Sandbox

pt_sync_icap_base_template

ICAP, Sync

1

Параметры ICAP и Preview

Zecurion

zecurion_sync_icap_base_template

ICAP, Sync

1

Параметры ICAP-сервера

AvSoft Athena

avsoft_athena_poll_api_base_template

API, Poll

2

ATHENA_API_KEY

AvSoft Athena

avsoft_athena_icap_base_template

ICAP, Sync

1

Порт и параметры ICAP

KSE

kse_sync_icap_base_template

ICAP, Sync

1

Параметры ICAP

KSE

kse_sync_api_scanmemory_base_template

API, Sync

1

KSE_TOKEN в Base64

KSE

kse_sync_api_scanfile_base_template

API, Sync

1

KSE_TOKEN, Пример настройки KSE ScanFile

KATA

kata_sync_icap_base_template

ICAP, Sync

1

Параметры ICAP

KATA

kata_poll_api_base_template

API, Poll

2

KATA_SENSOR_ID, Регистрация Системы в KATA по API

InfoWatch Traffic Monitor

iwtm_sync_icap_base_template

ICAP, Sync

1

Параметры ICAP

PDF Converter

built_in_file_converter_base_template

Назначение: PDF Converter (Sync API, MP. Scanner_converter — CDR + pdf-converter). Шаблон подходит и для других одношаговых взаимодействий по API после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: создайте секрет CDR_API_KEY. Для версии коннектора 2.2 назначьте в получателях путь сохранения «очищенных» файлов. Чтобы при вердикте «очищен» клиент получал модифицированную версию файла в синхронном режиме ICAP/API, включите соответствующий параметр в источниках (см. Пассивный сбор).

Особенности: в коннекторе обновлены маппинг и источник вердикта, а также глобальные заголовки:

  • CDR проставляет уровень критичности обнаруженных в файле вставок.

  • Конвертер в PDF проставляет no_verdict, который в коннекторе приравнивается к Clean.

  • CDR передаёт заголовок X-Sanitization-Status, определяющий, был ли файл полностью очищен. Вердикт извлекается из этого заголовка, сопоставленного со спецификационной переменной $SANITIZATION_STATUS. Это позволяет работать с новым вердиктом «очищен».

Заголовок X-File-Modified, который использовался в версии 2.0, больше не приходит.

YARA

built_in_yara_analyser_base_template

Назначение: YARA Analyser (Sync API, MP. YARA-анализатор). Шаблон подходит и для других одношаговых взаимодействий по API после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: создайте секрет YARA_API_KEY. Заголовок Excluded-namespaces задаёт неймспейсы, исключаемые из анализа. Замените демонстрационное значение заголовка на список неймспейсов для вашей интеграции.

Особенности: в коннекторе обновлены глобальные заголовки, маппинг распаковки ответа и вердикта:

  • поле namespaces из ответа анализатора распаковывается в спецификационную переменную $NAMESPACES для дальнейшего применения в критериях пулов;

  • поле scan_status распаковывается из тела ответа вместо success;

  • вердикт определяется на основе max_severity из анализатора.

PT Sandbox

pt_sync_api_base_template

Назначение: PT Sandbox (Sync API). Шаблон подходит и для других двухшаговых взаимодействий по API после изменения параметров.

Порядок работы:

  1. Загрузить файл и получить его ID из СЗИ.

  2. Запустить задачу на анализ файла и сразу дождаться ответа.

Перед использованием: создайте секрет PT_SANDBOX_API_KEY (см. Подраздел "Секреты").

pt_poll_api_base_template

Назначение: PT Sandbox (Poll API). Шаблон подходит и для других трёхшаговых взаимодействий по API с опросом результата после изменения параметров.

Порядок работы:

  1. Загрузить файл и получить его ID из СЗИ.

  2. Запустить задачу на анализ файла и получить ID задачи.

  3. Периодически запрашивать состояние задачи до получения результата сканирования.

Перед использованием: создайте секрет PT_SANDBOX_API_KEY (см. Подраздел "Секреты").

pt_sync_icap_base_template

Назначение: PT Sandbox (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: проверьте параметры подключения и режима Preview по конфигурации ICAP-сервера PT Sandbox.

Параметры блока sync для ICAP:

sync.icap_options_enabled true
sync.icap_preview_mode auto
sync.icap_preview_bytes 0

Zecurion

zecurion_sync_icap_base_template

Назначение: Zecurion (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: проверьте настройки ICAP-сервера, показанные на рисунке.

Настройки ICAP-сервера Zecurion

В коннекторе обновлены параметры блока sync для ICAP:

sync.icap_options_enabled true
sync.icap_preview_mode auto
sync.icap_preview_bytes 0

AvSoft Athena

avsoft_athena_poll_api_base_template

Назначение: AvSoft Athena (Poll API). Шаблон подходит и для других двухшаговых взаимодействий по API с опросом результата после изменения параметров.

Порядок работы:

  1. Отправить файл с параметрами проверки и получить набор его контрольных сумм.

  2. Периодически запрашивать результат по одной из полученных контрольных сумм; рекомендуется sha256.

Перед использованием: создайте секрет ATHENA_API_KEY (см. Подраздел "Секреты").

Особенности: через параметры запроса на первом шаге можно выбрать только статический либо также динамический анализ (StaticOnly, зависит от конфигурации СЗИ), а также принудительно перезапустить проверку файла, если он уже проверялся в СЗИ (force).

avsoft_athena_icap_base_template

Назначение: AvSoft Athena (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: по умолчанию указан порт 13440. Проверьте настройки ICAP-сервера, показанные на рисунке.

Настройки ICAP-сервера AvSoft Athena

В коннекторе обновлены параметры блока sync для ICAP:

sync.icap_options_enabled true
sync.icap_preview_mode auto
sync.icap_preview_bytes 0

KSE

kse_sync_icap_base_template

Назначение: KSE (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Особенность: используется режим ICAP req mode.

kse_sync_api_scanmemory_base_template

Назначение: KSE (Sync API), метод API scanmemory. Шаблон подходит и для других одношаговых взаимодействий по API после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Перед использованием: проверьте порт подключения — по умолчанию 443. Подготовьте токен в Base64 и создайте секрет KSE_TOKEN (см. Подраздел "Секреты").

Содержимое файла передаётся непосредственно в JSON-теле запроса в Base64. Не рекомендуется использовать этот шаблон для больших файлов.

kse_sync_api_scanfile_base_template

Назначение: KSE (Sync API), метод API scanfile.

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

Перед использованием: проверьте порт подключения — по умолчанию 443 — и путь к файловой шаре KSE — по умолчанию /srv/kse-inbox. Подготовьте токен в Base64 и создайте секрет KSE_TOKEN (см. Подраздел "Секреты").

Файлы для проверки должны быть заранее доставлены на файловую шару KSE. Коннектор отправляет только путь к файлу. Структура шары предполагается плоской — без дополнительных каталогов и вложенности.

Подробный двухцепочечный сценарий и настройка файловой шары приведены на странице Пример настройки KSE ScanFile.

KATA

kata_sync_icap_base_template

Назначение: KATA (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Особенность: используется режим ICAP req mode. Настройки показаны на рисунке.

Настройки ICAP для KATA

kata_poll_api_base_template

Назначение: KATA (Poll API). Шаблон подходит и для других двухшаговых взаимодействий по API с опросом результата на втором шаге.

Порядок работы:

  1. Отправить файл с параметрами проверки.

  2. Периодически запрашивать результат по идентификатору сканирования; к результатам ответа СЗИ применяется поиск.

Перед использованием: зарегистрируйте Систему в KATA по API (см. Регистрация Системы в KATA по API) и создайте секрет KATA_SENSOR_ID (см. Подраздел "Секреты").

Особенность: в качестве идентификатора сканирования в коннекторе используется $FILE_LAST_CHECKSUM.

InfoWatch

iwtm_sync_icap_base_template

Назначение: InfoWatch Traffic Monitor (Sync ICAP). Шаблон подходит и для других одношаговых взаимодействий по ICAP после изменения параметров.

Порядок работы: отправить файл и сразу получить результат.

Особенность: используется режим ICAP req mode.