Kaspersky Unified Monitoring and Analysis Platform

Импорт данных об активах из MaxPatrol VM

В поставку KUMA входит утилита kuma-ptvm, которая состоит из исполняемого файла и файла конфигурации. Поддерживается работа под управлением ОС Windows и Linux. Утилита позволяет выполнить подключение к API MaxPatrol VM, получить данные об устройствах и их атрибутах, включая уязвимости, а также позволяет отредактировать данные об активах и импортировать данные с использованием API KUMA. Импорт данных поддерживается для MaxPatrol VM 1.1, 2.6.

Настройка импорта информации об активах из MaxPatrol VM в KUMA состоит из следующих шагов:

  1. Подготовительные действия в KUMA и MaxPatrol VM.

    Вам потребуется создать учетные записи пользователей и токен KUMA для операций через API.

  2. Создание файла конфигурации с параметрами экспорта и импорта данных.
  3. Импорт данных об активах в KUMA с помощью утилиты kuma-ptvm:
    1. Данные экспортируются из MaxPatrol VM и сохраняются в директории утилиты. Информация по каждому тенанту сохраняется в отдельный файл в формате JSON.

      При необходимости вы можете отредактировать полученные файлы.

    2. Информация из файлов импортируется в KUMA.

При повторном импорте уже существующие в KUMA активы будут перезаписаны. Таким образом устраненные уязвимости будут удалены.

Известные ограничения

Если для двух активов с разными FQDN указан один IP-адрес, KUMA импортирует такие активы как два разных актива, активы не будут объединены.

Если у актива два ПО с одинаковыми данными в полях name, version, vendor, KUMA импортирует эти данные как одно ПО, несмотря на разные пути установки ПО в активе.

Если FQDN актива содержит пробел или "_", данные по таким активам не будут импортированы в KUMA, в журнале будет указано, что такие активы пропущены при импорте.

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

Подготовительные действия

  1. Создайте отдельную учетную запись пользователя в KUMA и в MaxPatrol VM с минимально необходимым набором прав на использование API-запросов.
  2. Создайте учетные записи, для которых впоследствии сгенерируете API-токен.

    Требования к учетным записям, для которых генерируется API-токен:

  3. Сгенерируйте токен для доступа к KUMA REST API.

Создание конфигурационного файла

Чтобы создать конфигурационный файл:

  1. Перейдите в директорию установщика KUMA, выполнив следующую команду:

    cd kuma-ansible-installer/roles/kuma/files/

  2. Распакуйте архив kuma-ptvm.tar.gz, выполнив следующую команду:

    tar -xvf kuma-ptvm.tar.gz

  3. Скопируйте шаблон kuma-ptvm-config-template.yaml и создайте конфигурационный файл с именем kuma-ptvm-config.yaml:

    cp kuma-ptvm-config-template.yaml kuma-ptvm-config.yaml

  4. Отредактируйте параметры конфигурационного файла kuma-ptvm-config.yaml.
  5. Сохраните изменения в файле.

Конфигурационный файл будет создан. Теперь вы можете переходить к шагу Импорт информации об активах.

Импорт данных об активах

Чтобы импортировать данные об активах:

  1. Если вы хотите импортировать информацию об активах из MaxPatrol VM в KUMA без промежуточной проверки экспортированных данных, запустите утилиту kuma-ptvm со следующими параметрами:

    ./kuma-ptvm --config <путь к файлу kuma-ptvm-config.yaml> --download --upload

  2. Если вы хотите проверить корректность экспортированных из MaxPatrol VM данных перед импортом в KUMA:
    1. Запустите утилиту kuma-ptvm со следующими параметрами:

      ./kuma-ptvm --config <путь к файлу kuma-ptvm-config.yaml> --download

      Для каждого тенанта, указанного в конфигурационном файле, будет создан отдельный файл с именем вида <Идентификатор тенанта KUMA>.JSON. Также при экспорте будет создан файл tenants со списком JSON-файлов для загрузки в KUMA. Все файлы сохраняются в директории утилиты.

    2. Проверьте экспортированные файлы активов и при необходимости внесите изменения:
      • Распределите активы по соответствующим тенантам.
      • Из файла тенанта по умолчанию default вручную перенесите данные активов в файлы нужных тенантов.
      • В файле tenants отредактируйте список тенантов, активы которых будут импортированы в KUMA.
    3. Импортируйте информацию об активах в KUMA с помощью команды:

      ./kuma-ptvm --config <путь к файлу kuma-ptvm-config.yaml> --upload

    Чтобы просмотреть информацию о доступных командах утилиты, выполните команду --help.

Информация об активах будет импортирована из MaxPatrol VM в KUMA. В консоли отображаются сведения о количестве новых и обновленных активов.

Возможные ошибки

При запуске утилиты kuma-ptvm может вернуться ошибка "tls: failed to verify certificate: x509: certificate is valid for localhost".

Решение:

  • Выписать сертификат в соответствии с документацией MaxPatrol. Мы рекомендуем этот способ устранения ошибки, как предпочтительный.
  • Отключить проверку сертификата.

    Чтобы отключить проверку сертификата, добавьте в конфигурационный файл в разделе MaxPatrol settings следующую строку:

    ignore_server_cert: true

В результате запуск утилиты выполняется без ошибок.

В начало
[Topic 265427]

Параметры конфигурационного файла kuma-ptvm-config.yaml

В таблице представлены параметры, доступные для настройки в файле kuma-ptvm-config.yaml.

Описание параметров конфигурационного файла kuma-ptvm-config.yaml

Параметр

Описание

Значения

log_level

Необязательный параметр в группе General settings.

Уровень журналирования.

Доступные значения:

  • trace
  • info
  • warning
  • error

Значение по умолчанию: info.

period

Необязательный параметр в группе General settings.

Из MaxPatrol будут экспортированы данные об активах, которые изменялись за указанный срок.

Ограничения отсутствуют.

Значение по умолчанию: 30d.

strict_import

Необязательный параметр в группе General settings.

При экспорте активов из MaxPatrol проверять, заполнены ли обязательные для KUMA поля. Не экспортировать из MaxPatrol активы, не прошедшие проверку.

Доступные значения:

  • true - проверять наличие обязательных для KUMA полей.
  • false - не проверять наличие обязательных для KUMA полей.

Значение по умолчанию: false.

Мы рекомендуем указывать значение true при экспорте активов из MaxPatrol, это позволит выявить возможные ошибки в файлах JSON и исправить ошибки перед тем, как вы импортируете активы в KUMA.

endpoint

Обязательный параметр в группе KUMA settings.

URL сервера KUMA API. Например: kuma-example.com:7223

-

token

Обязательный параметр в группе KUMA settings.

Токен KUMA API.

-

ignore_server_cert

Необязательный параметр в группе KUMA settings.

Проверка сертификата KUMA.

Доступные значения:

  • true - отключить проверку сертификата KUMA.
  • false - выполнить проверку сертификата KUMA.

Параметр не включен в шаблон конфигурационного файла. Вы можете указать параметр со значением true вручную, тогда при запуске утилита kuma-ptvm не будет проверять сертификат.

endpoint

Обязательный параметр в группе MaxPatrol VM settings.

URL сервера MaxPatrol API.

-

user

Обязательный параметр в группе MaxPatrol VM settings.

Имя пользователя MaxPatrol API.

-

password

Обязательный параметр в группе MaxPatrol VM settings.

Пароль пользователя MaxPatrol API.

-

secret

Обязательный параметр в группе MaxPatrol VM settings.

Секрет MaxPatrol API

-

ignore_server_cert

Необязательный параметр в группе MaxPatrol VM settings.

Проверка сертификата MaxPatrol.

Доступные значения:

  • true - отключить проверку сертификата MaxPatrol.
  • false - выполнить проверку сертификата MaxPatrol.

Параметр не включен в шаблон конфигурационного файла. Вы можете указать параметр со значением true вручную, в случае возникновения ошибки "tls: failed to verify certificate: x509: certificate is valid for localhost". В таком случае при запуске утилита kuma-ptvm не будет проверять сертификат.

Мы рекомендуем выписать сертификат в соответствии с документацией MaxPatrol, как предпочтительный способ устранения ошибки.

only_exploitable

Необязательный параметр в группе Vulnerability filter.

Экспортировать из MaxPatrol только активы с уязвимостями, для которых известны эксплойты.

Доступные значения:

  • true - экспортировать только активы с уязвимостями, для которых известны эксплойты.
  • false - экспортировать все активы.

Значение по умолчанию: false.

min_severity

Необязательный параметр в группе Vulnerability filter.

Импортировать только уязвимости указанного уровня и выше.

Доступные значения:

  • low
  • medium
  • high
  • critical

Значение по умолчанию: low.

id

Обязательный параметр в группе Tenant map.

Идентификатор тенанта в KUMA.

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

-

fqdn

Необязательный параметр в группе Tenant map.

Регулярное выражение для поиска FQDN актива.

-

networks

Необязательный параметр в группе Tenant map.

Одна или несколько подсетей.

-

default_tenant

Необязательный параметр.

Идентификатор тенанта KUMA по умолчанию, куда будут поступать данные об активах, которые не удалось распределить по тенантам, заданным в группе параметров Tenants.

-

В начало
[Topic 267952]