Использование помощника по настройке

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

sudo /opt/kaspersky/vulnerability-management/helper/helper.sh [configure|unattendedconfigure|start|stop|restart|status|collect-logs|ksn-participating|setplugin|updatemode|rotate-certs|help]

Где:

• configure. Помощник по настройке запускается в интерактивном режиме для полной настройки решения.
• unattendedconfigure. Помощник по настройке запускается в тихом режиме для полной настройки решения. Вместе с этим параметром требуется добавить KVMANSWERSFILE=/path/to/file.json, где /path/to/file.json – путь к JSON-файлу с параметрами для настройки Kaspersky Vulnerability Management.

  {

  "eulaAccepted":true,

  "privacyPolicyAccepted":true,

  "ksnAgreementAccepted":true|false,

  "database":

  {

  "host":"",

  "port":,

  "dbname":"",

  "dbschema":"",

  "dbuser":"",

  "dbpassword":"",

  "dbssl":

  {

  "mode":"verify-full|disable|allow|prefer|require|verify-ca",

  "certpath":""

  }

  },

  "proxy":

  {

  "enabled":true|false,

  "host":"",

  "port":,

  "login":"",

  "password":""

  },

  "ksc":

  {

  "apiurl":"",

  "iamproxyurl":"",

  "users":

  {

  "worker":

  {

  "username":"",

  "password":""

  },

  "scanner":

  {

  "username":"",

  "password":""

  }

  }

  },

  "tls":

  {

  "certificates":"generate|existing",

  "existing":

  {

  "type":"ca|selfsigned",

  "services":

  {

  "ca":

  {

  "certpath":""

  },

  "privateapi":

  {

  "certpath":"",

  "keypath":""

  },

  "publicapi":

  {

  "certpath":"",

  "keypath":""

  },

  "vms":

  {

  "certpath":"",

  "keypath":""

  }

  }

  }

  }

  }

  Параметры файла file.json определяют следующее:

  .eulaAccepted (boolean) — признак согласия с Лицензионным соглашением. Для продолжения настройки должен быть true.

  .privacyPolicyAccepted (boolean) — признак согласия с "Политикой конфиденциальности". Для продолжения настройки должен быть true.

  .ksnAgreementAccepted (boolean) — признак принятия Положения о KSN, влияет на работу модуля обнаружения уязвимостей. Возможные значения: true или false.

  Функциональность KSN может быть недоступна в решении на территории США.

  .database.host (string) — FQDN или IP-адрес для доступа к устройству с созданной базой данных решения.

  .database.port (int) — номер порта для доступа к устройству с созданной базой данных решения.

  .database.dbname (string) — имя базы данных решения.

  .database.dbschema (string) — схема в базе данных, с которой будет работать решение.

  .database.dbuser (string) — имя роли пользователя для решения в базе данных.

  .database.dbpassword (string) — пароль роли пользователя для решения в базе данных.

  .database.dbssl.mode (string) — режим SSL для подключения к базе данных. Возможные значения:verify-full|disable|allow|prefer|require|verify-ca. Подробнее о каждом режиме см. в документации к PostgreSQL.

  .database.dbssl.certpath (string) — путь к SSL-сертификату базы данных. Обязателен, если для параметра .database.dbssl.mode указано одно из значений verify-full|require|verify-ca.

  .proxy.enabled (boolean) — признак, определяющий необходимость использовать прокси-сервер для доступа к обновляемым базам. Если значение равно true, то все остальные значения раздела .proxy должны быть указаны. Значения этих параметров вы можете посмотреть в Kaspersky Security Center Web Console в разделе Параметры → Интеграция на вкладке Параметры прокси-сервера Web Console.

  .proxy.host (string) — адрес прокси-сервера в формате proxy.example.com.

  .proxy.port (int) — порт прокси-сервера (по умолчанию – 8080).

  .proxy.login (string) — имя пользователя для аутентификации на прокси-сервере. Для анонимной аутентификации на прокси-сервере не указывайте значение.

  .proxy.password (string) — пароль пользователя для аутентификации на прокси-сервере. Для анонимной аутентификации на прокси-сервере не указывайте значение.

  .ksc.apiurl (string) — адрес для доступа к Kaspersky Security Center API в формате https://ksc.example.com:13299.

  .ksc.iamproxyurl (string) — адрес для доступа к Kaspersky Security Center IAM Proxy в формате https://ksc-iam.example.com:9050.

  .ksc.users.worker.username (string) — имя учетной записи VM Worker, созданной перед установкой компонентов Kaspersky Vulnerability Management.

  .ksc.users.worker.password (string) — пароль учетной записи VM Worker.

  .ksc.users.scanner.username (string) — имя учетной записи VM Scanner с ролью VM Scanner, созданной перед установкой компонентов Kaspersky Vulnerability Management.

  .ksc.users.scanner.password (string) — пароль учетной записи VM Scanner.

  .tls.certificates (string) — способ указания TLS-сертификатов. Возможные значения:

  • generate. Если указано это значение, помощник по настройке самостоятельно создает TLS-сертификаты, заполнять остальные поля в блоке .tls не требуется.
  • existing. Если указано это значение, необходимо ввести пути к заранее созданным TLS-сертификатам и заполнить остальные поля в блоке .tls.

  .tls.existing.type (string) — тип заранее созданных TLS-сертификатов. Возможные значения:

  • ca. Сертификаты выписаны корпоративным центром сертификации. Все сертификаты должны быть выписаны одними и теми же корневым и промежуточным (если такой используется в организации) центрами сертификации.
  • selfsigned. Самоподписанные сертификаты.

  .tls.existing.services.ca.certpath (string) — путь к файлу с цепочкой сертификатов корпоративного центра сертификации. Должен содержать сертификаты как корневого, так и промежуточного (если используется в организации) центров сертификации. Поле не требуется заполнять, если .tls.existing.type имеет значение selfsigned.

  .tls.existing.services.privateapi.certpath (string) — путь к файлу с сертификатом для Private API. Файл должен быть незашифрованным.

  .tls.existing.services.privateapi.keypath (string) — путь к файлу с ключом сертификата для Private API. Файл должен быть незашифрованным.

  .tls.existing.services.publicapi.certpath (string) — путь к файлу с сертификатом для Public API. Файл должен быть незашифрованным.

  .tls.existing.services.publicapi.keypath (string) — путь к файлу с ключом сертификата для Public API. Файл должен быть незашифрованным.

  .tls.existing.services.vms.certpath (string) — путь к файлу с сертификатом для VMS. Файл должен быть незашифрованным.

  .tls.existing.services.vms.keypath (string) — Путь к файлу с ключом сертификата для VMS. Файл должен быть незашифрованным.

  Например: sudo KVMANSWERSFILE=/path/to/file.json /opt/kaspersky/vulnerability-management/helper/helper.sh unattendedconfigure

• start. Помощник по настройке запускает процессы компонентов решения.
• stop. Помощник по настройке останавливает процессы компонентов решения.
• restart. Помощник по настройке останавливает и далее запускает процессы компонентов решения.
• status. Помощник по настройке выводит статус работы компонентов решения.
• collect-logs. Помощник по настройке собирает журналы событий и доступные для редактирования конфигурационные файлы, помещает их в архив и выводит путь к архиву.
• ksn-participating. Помощник по настройке предоставляет возможность изменить решение о принятии условий Положения о KSN. Если вы принимаете условия Положения о KSN, взаимодействие с KSN включается. Если вы не принимаете условия Положения о KSN, взаимодействие с KSN выключается.

  Вы можете ознакомиться с условиями Положения о KSN, прочитав текст файла ksn.<идентификатор языка>, который включен в комплект поставки решения и расположен после установки компонентов решения в директории /opt/kaspersky/vulnerability-management/doc/.

• setplugin. Помощник по настройке устанавливает и настраивает хранилище данных плагинов в Kaspersky Security Center. Может понадобиться, если необходимо заменить сертификат Private API, изменить адрес устройства для установки Private API или если во время установки не удалось установить или проверить хранилище данных плагинов.
• updatemode. Помощник по настройке предоставляет возможность изменить источник для обновления баз уязвимостей.
• rotate-certs. Помощник по настройке выполняет следующие действия:
  • Выпускает новые сертификаты для служб Private API, Public API и VMS.
  • Обновляет сертификаты KSC OpenAPI и IAM для доверия им со стороны служб Kaspersky Vulnerability Management.
  • Прописывает новый сертификат Private API в хранилище данных плагинов в Kaspersky Security Center.
• help. Вызов справки со списком всех доступных параметров и их описаниями.

Например:

sudo /opt/kaspersky/vulnerability-management/helper/helper.sh updatemode