Автоматизированная установка агентов

Общее определение

Автоматизированная установка агентов - это централизованное и массовое развертывание программных агентов без ручного вмешательства. Данный подход позволяет установить агенты сразу на множество активов (серверов, рабочих станций, виртуальных машин) с помощью готовых скриптов, систем управления конфигурациями (например, Ansible), групповых политик Windows (GPO), PowerShell-скриптов.

Массовая автоматизированная установка Агентов на большое количество Активов возможна с использованием средств автоматизации и API Системы.

Поддерживаемые ОС

LINUX

В качестве примера рассмотрим развертывание Агентов на linux-активах с помощью системы Ansible:

1. Формируется файл описания задания (playbook) для Ansible (см. пример ниже), который выполняет следующие действия:
   • копирует на хосты специальный bash-скрипт для установки и запуска Агента,
   • удаляет скрипт после успешной установки Агента.
2. Запускаемый на Активе bash-скрипт (скачать*) выполняет действия:
   • используя API Системы, создает Актив и получает уникальный URL для скачивания установщика Агента,
   • скачивает и запускает установщик Агента,
   • проверяет корректность запуска службы Агента.

## Пример playbook-файла для Ansible
     - name: "Prepare to remote hosts"
       hosts: *
       tasks:
        - name: Copy deploy script ./deploy-linux-agent.sh to remote host
          ansible.builtin.copy:
              src: "./deploy-linux-agent.sh" 
              dest: "/tmp/deploy-linux-agent.sh"
              mode: '0775'
        - name: Run deploy script
          command:
             cmd: "/tmp/deploy-linux-agent.sh"
        - name: Remove deploy script from host
          file:
             path: "/tmp/deploy-linux-agent.sh"
             state: absent

^* в bash-скрипте (https://download.vulns.io/onpremise/scripts/deploy-linux-agent.sh) необходимо указать параметры:

* SERVER_IP - ip-адрес вашего сервера с установленной Системой,
* API_KEY - ключ API для доступа к вашей Системе (см. раздел "Создание API-токена" ниже),
* SENSOR_ID - id Сенсора, если Активы необходимо подключить к Сенсору.

После завершения задания Ansible в Системе появятся все Активы, на которых был успешно установлен Агент.

WINDOWS

Существует 3 способа массовой установки Агентов на windows-активы:

• с помощью специального powershell-скрипта deploy-windows-agent.ps1,
• с помощью установщика Агента agent-windows-installer-x64-latest.msi,
• с использованием групповой политики (Group Policy Object) и установщика Агента.

С помощью powershell-скрипта

Для массового развертывания Агентов на windows-активах необходимо использовать powershell-скрипт (скачать*), который выполняет следующие действия:

• используя API Системы, создает Актив и получает уникальный URL для скачивания установщика Агента,
• скачивает и запускает установщик Агента,
• проверяет корректность запуска службы Агента.

^* в powershell-скрипте (https://download.vulns.io/onpremise/scripts/deploy-windows-agent.ps1) необходимо указать параметры:

* $SERVER_IP - ip-адрес вашего сервера с установленной Системой,
* $API_KEY - ключ API для доступа к вашей Системе (см. раздел "Создание API-токена"),
* SENSOR_ID - id Сенсора, если Активы необходимо подключить к Сенсору.

Для корректного запуска скрипта, необходимо отключить проверку подписи скрипта:

• для отключения проверки только для заданного скрипта: Powershell -executionpolicy remotesigned -file 'deploy-windows-agent.ps1'
• для отключения проверки в текущем сеансе: set-executionpolicy RemoteSigned -Scope Process
• для отключения проверки любых PS-скриптов из командной строки PowerShell выполнить команду: set-executionpolicy remotesigned

Скрипт нужно однократно запустить на Активах с помощью групповых политик или любых средств автоматизации. После того, как скрипт отработает, в Системе появятся все Активы, на которых был успешно установлен Агент.

С помощью установщика Агента

Другой способ массового развертывания Агентов на windows-активах - с помощью установщика Агента agent-windows-installer-x64-latest.msi (версии 1.1.69+), который находится в папке /var/lib/docker/volumes/manage_agents-volume/_data хоста Системы.

Перед запуском установщика на активах необходимо подготовить конфигурационный файл с названием agent-windows-installer.conf (или agent-windows-installer.json) и положить его рядом с файлом установщика:

{
"account_id": "{account_id}",
"user_id": "{user_id}",
"api_token": "{api_token}",
"api_url": "{api_url}",
"is_new_asset_create": "1",
"is_ignore_ssl_error": "0"
"sensor_id": "{sensor_id}" ## необязательный параметр, добавлять в случае подключения актива к сенсору
}

где:

• account_id - id организации, в которой создается актив (раздел "Пользователи / Организации"),
• user_id - id пользователя, от которого добавляется актив (раздел "Пользователи"),
• api_token - токен, для доступа к методам API (см. ниже),
• api_url - URL Системы в виде https://<ip> или https://<domain>,
• is_new_asset_create - флаг создания нового актива в системе,
• is_ignore_ssl_error - флаг игнорирования SSL ошибок,
• sensor_id - id Сенсора, к которому будет подключен актив. Если актив подключается к серверу, то sensor_id не нужно добавлять в файл конфигурации.

Установщик Агента (с созданным конфигурационным файлом) нужно однократно запустить на Активах с помощью групповых политик или любых средств автоматизации. После завершения установки в Системе появятся все Активы, на которых был успешно установлен Агент.

На всех активах запускается один и тот же установщик и конфигурационный файл.

Примеры запуска установщика:

   ## С созданием лог-файла установки

   msiexec /quiet /i "agent-windows-installer-x64-latest.msi" /l*v "install.log"

   ## Без использования конфигурационного файла:

   msiexec /quiet /i "agent-windows-installer-x64-latest.msi" /l*v "install.log" \
   ACCOUNT_ID="{account_id}" USER_ID="{user_id}" API_TOKEN="{api_token}" \
   API_URL="{api_url}" IS_NEW_ASSET_CREATE="1" IS_IGNORE_SSL_ERROR="0"

   ## Если необходимо использовать прокси:

   msiexec /quiet /i "agent-windows-installer-x64-latest.msi" /l*v "install.log" \
   PROXY_URL="{proxy_url}" PROXY_LOGIN="{proxy_login}" PROXY_PASSWORD="{proxy_password}"

С использованием групповой политики

Существует возможность массовой установки Агента на windows-активах через групповые политики (Group Policy Object, GPO) с помощью установщика Агента agent-windows-installer-x64-latest.msi, который находится в папке /var/lib/docker/volumes/manage_agents-volume/_data хоста Системы.

Для массового развертывания Агентов с использованием GPO необходимо использовать MSI-файл установщика версии 1.2.20+, а также подготовить MST-файл преобразования, позволяющий изменить стандартные настройки пакета MSI.

Для создания файла модификации MST для MSI пакетов можно использовать утилиту ORCA (https://learn.microsoft.com/ru-ru/windows/win32/msi/orca-exe):

1. Необходимо открыть agent-windows-installer-x64-latest.msi с помощью утилиты Orca.
2. В программе нужно создать New Transformation и изменить/добавить следующие параметры MSI-пакета в разделе Property:
   • IS_NEW_ASSET_CREATE: 1
   • IS_IGNORE_SSL_ERROR: 1
   • ACCOUNT_ID: {account_id}
   • USER_ID: {user_id}
   • API_TOKEN: {api_token}
   • API_URL: {api_url}
   • SENSOR_ID: {sensor_id} ## необязательный параметр, добавлять в случае подключения актива к сенсору

где:

• account_id - id организации, в которой создается актив (раздел "Пользователи / Организации"),
• user_id - id пользователя, от которого добавляется актив (раздел "Пользователи"),
• api_token - токен, для доступа к методам API (см. ниже),
• api_url - URL Системы в виде https://<ip> или https://<domain>,
• is_new_asset_create - флаг создания нового актива в системе,
• is_ignore_ssl_error - флаг игнорирования SSL ошибок,
• sensor_id - id Сенсора, к которому будет подключен актив. Если актив подключается прямо к Серверу, параметр добавлять не нужно.

Затем необходимо выбрать Transform→GenerateTransform и сохранить изменения в файл с раширением MST. Данный файл необходимо положить в одну папку с установщиком при создании политики GPO и указать в качестве модификации во вкладке «Modification».

Создание API-токена

Для автоматизированной установки Агентов используется API Системы, поэтому необходимо предварительно сгенерировать API-токен в разделе "Система / Настройки / API-токены" со следующими ограничениями:

• Организации - укажите организацию, в которую будут импортироваться активы,
• API-методы - укажите следующие методы:
  • /integration/v1/agents
  • /integration/v1/agents/download/installer/url
  • /integration/v1/assets

Заключение

Среди ключевых преимуществ автоматизированной установки агентов можно отметить следующие:

1. Экономия времени — один сценарий или политика охватывает все необходимые хосты, устраняя монотонные ручные действия.

2. Масштабируемость — процесс легко адаптируется для инфраструктуры любого размера, без увеличения трудозатрат.

3. Снижение ошибок — единые скрипты и параметры исключают человеческий фактор и обеспечивают одинаковую конфигурацию агентов на всех хостах.

4. Централизованный контроль — администратор видит статус установки и подключения агентов через интерфейс или API системы, что упрощает аудит и поддержку.

5. Гибкость — можно использовать разные инструменты (PowerShell, GPO, Ansible и др.) в зависимости от платформы и политики безопасности.