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

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

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

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

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

2. Создание файла конфигурации с параметрами экспорта и импорта данных.

   В зависимости от требуемого набора данных используйте один из файлов конфигурации:

   • kuma-ptvm-config.yaml — для импорта информации об активах и уязвимостях.
   • kuma-ptvm-vulnerable-assets-config.yaml — для импорта информации об активах и уязвимостях с возможностью дополнительной фильтрации.

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

   Файл kuma-ptvm-vulnerable-assets-config.yaml дополнительно содержит секцию Vulnerabilities assets settings, в которой задаются параметры импорта информации об уязвимостях.

3. Экспорт данных из MaxPatrol VM и их импорт в KUMA с помощью утилиты kuma-ptvm.

   Запустите утилиту с соответствующим файлом конфигурации:

   • Для импорта информации об активах:

     ./kuma-ptvm --config <path to kuma-ptvm-config.yaml> --download --upload

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

     ./kuma-ptvm vulnerable-assets-api --config <path to kuma-ptvm-vulnerable-assets-config.yaml> --download --upload

   При выполнении команды данные сначала экспортируются из MaxPatrol VM и сохраняются в директории утилиты. Информация по каждому тенанту сохраняется в отдельный файл в формате JSON.

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

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

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

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

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

Если в конфигурационном файле kuma-ptvm-config.yaml вы укажете параметр strict_import со значением false, то из MaxPatrol будут импортированы данные по всем активам, в том числе без обязательных для KUMA полей и с недопустимыми для KUMA значениями полей. Если FQDN актива содержит пробел или "_", данные по таким активам не будут импортированы в KUMA, в журнале будет указано, что такие активы пропущены при импорте.

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

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

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

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

   • Роль Главного администратора, Администратора тенанта, Аналитика второго уровня и Аналитика первого уровня.
   • Доступ к тенанту, в который будут импортированы активы.
   • В учетной записи пользователя в группе параметров Права доступа через API установлен флажок для POST /api/v3/assets/import.
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. Скопируйте шаблон и создайте конфигурационный файл в зависимости от необходимого способа импорта активов.
   • Для стандартного импорта данных об активах:

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

   • Если необходимо дополнительно настроить параметры импорта данных об уязвимостях:

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

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

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

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

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

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

1. Если вы хотите импортировать информацию об активах из MaxPatrol VM в KUMA без промежуточной проверки экспортированных данных, выполните команду download и upload одновременно. Выберите команду в зависимости от используемого конфигурационного файла:
   • Для kuma-ptvm-config.yaml:

     ./kuma-ptvm --config <path> --download --upload

   • Для kuma-ptvm-vulnerable-assets-config.yaml:

     kuma-ptvm vulnerable-assets-api --config <path> --download --upload

   где:

   <path> — полный путь к соответствующему конфигурационному файлу: kuma-ptvm-config.yaml или kuma-ptvm-vulnerable-assets-config.yaml.

2. Если вы хотите проверить правильность экспортированных из MaxPatrol VM данных перед импортом в KUMA, сначала выполните только экспорт:
   • Для kuma-ptvm-config.yaml:

     ./kuma-ptvm --config <path> --download

   • Для kuma-ptvm-vulnerable-assets-config.yaml:

     ./kuma-ptvm vulnerable-assets-api --config <path> --download

   где:

   <path> — полный путь к соответствующему конфигурационному файлу: kuma-ptvm-config.yaml или kuma-ptvm-vulnerable-assets-config.yaml.

   При необходимости вы можете использовать параметр --cvss-version <номер CVSS версии>, чтобы указать, для какой версии CVSS нужно загрузить значения уязвимостей активов. Доступные значения:

   • 2 – загружаются только значения CVSS версии 2.
   • 3 – загружаются только значения CVSS версии 3. Если уязвимость описана только по версии 2, поле CVSS будет пустым.
   • latest – загружаются значения последней доступной версии CVSS (значение по умолчанию). Если уязвимость не имеет значения CVSS версии 3, используется значение версии 2.

   Примеры:

   ./kuma-ptvm vulnerable-assets-api --config <path> --cvss-version 2 --download

   ./kuma-ptvm vulnerable-assets-api --config <path> --cvss-version 3 --download

   ./kuma-ptvm vulnerable-assets-api --config <path> --cvss-version latest --download

   где:

   <path> — полный путь к соответствующему конфигурационному файлу: kuma-ptvm-config.yaml или kuma-ptvm-vulnerable-assets-config.yaml.

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

   При необходимости проверьте и измените экспортированные данные:

   • Распределите активы по соответствующим тенантам.
   • Из файла тенанта по умолчанию default вручную перенесите данные активов в файлы нужных тенантов.
   • В файле tenants отредактируйте список тенантов, активы которых будут импортированы в KUMA.
   1. После проверки импортируйте информацию об активах в KUMA:
      • Для kuma-ptvm-config.yaml:

        ./kuma-ptvm --config <path> --upload

      • Для kuma-ptvm-vulnerable-assets-config.yaml:

        ./kuma-ptvm vulnerable-assets-api --config <path> --upload

      где:

      <path> — полный путь к соответствующему конфигурационному файлу: kuma-ptvm-config.yaml или kuma-ptvm-vulnerable-assets-config.yaml.

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

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

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

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

Решение:

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

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

  ignore_server_cert: true

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