Настройка Balancer

Balancer

Задает адрес для подключения к Balancer.

Значение может быть IPv4-адресом, IPv6-адресом или именем хоста.

Необходимо указать следующие параметры:

• matching_port — порт, на котором Balancer принимает входящие события. Диапазон значений этого параметра: от 1 до 65535. Этот параметр является обязательным.
• api_port — порт, на котором Balancer принимает запросы API. Диапазон значений этого параметра: от 1 до 65535. Этот параметр является обязательным.
• cybertrace_port — порт, на котором Balancer получает системные оповещения от экземпляров Kaspersky CyberTrace. Диапазон значений этого параметра: от 1 до 65535. Этот параметр является обязательным.
• scanners_count — максимальное количество одновременных подключений. Диапазон значений этого параметра: от 1 до 100. Этот параметр является обязательным.

Этот элемент является обязательным. В конфигурационном файле может быть только один элемент Balancer.

EventDelimiter

Регулярное выражение, определяющее разделитель для событий.

Этот элемент не является обязательным.

Если событие содержит символы новой строки (\n), разбиение такого события произойдет как по символу, заданному в этом параметре, так и по символу новой строки.

SSLCertificatePath

Путь к сертификату в формате PEM для HTTPS-соединений.

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

Этот параметр является необязательным. По умолчанию задано следующее значение:

• В системах Windows:

  ..\httpsrv\kl_feed_service_cert.pem.

• В системах Linux:

  ../httpsrv/kl_feed_service_cert.pem.

Значение этого элемента следует изменить, если Balancer развернут на сервере без Kaspersky CyberTrace.

SSLPrivateKeyPath

Путь к закрытому ключу в формате PEM для HTTPS-соединений.

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

Этот параметр является необязательным. По умолчанию задано следующее значение:

• В системах Windows:

  ..\httpsrv\kl_feed_service_private.pem.

• В системах Linux:

  ../httpsrv/kl_feed_service_private.pem.

Значение этого элемента следует изменить, если Balancer развернут на сервере без Kaspersky CyberTrace.

LicenseDirPath

Путь к каталогу с файлом лицензионного ключа.

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

Этот параметр является необязательным. По умолчанию задано следующее значение:

• В системах Windows:

  ..\httpsrv\lic.

• В системах Linux:

  ../httpsrv/lic.

Значение этого элемента следует изменить, если Balancer развернут на сервере без Kaspersky CyberTrace.

CertDirPath

Путь к каталогу с сертификатами Kaspersky CyberTrace.

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

Этот параметр является обязательным. По умолчанию задано следующее значение:

..\etc\certs

OutputSettings

Задает адрес для отправки результатов сопоставления входящих событий.

Значение может быть IPv4-адресом, IPv6-адресом или именем хоста.

Можно указать следующий параметр:

• port — порт, на который Balancer отправляет результаты сопоставления входящих событий. Диапазон значений этого параметра: от 1 до 65535. Этот параметр является обязательным.

Этот элемент является обязательным.

FinishedEventFormat

Указывает на необходимость отправки сообщения о завершении сопоставления и формат этого сообщения.

Этот элемент может содержать строку, которая должна соответствовать следующим требованиям:

• длина от 1 до 2048 символов;
• только символы ASCII.

Этот элемент обладает следующими атрибутами:

• enabled

  Этот атрибут может принимать значения true или false. По умолчанию задано значение false.

По умолчанию для этого элемента задано значение LookupFinished.

Этот элемент не является обязательным.

Пример формата: <FinishedEventFormat enabled="false">LookupFinished</FinishedEventFormat>

Instances

Раздел, содержащий элементы с параметрами экземпляров Kaspersky CyberTrace.

Для раздела можно задать следующие параметры:

• update_seconds — интервал времени в секундах между попытками подключения к недоступным экземплярам Kaspersky CyberTrace.

  Этот параметр является обязательным. Диапазон значений этого параметра: от 1 до 3600.

• matching_timeout_seconds — время ожидания ответа от экземпляра Kaspersky CyberTrace с результатом сопоставления входящего события, в секундах.

  Этот параметр является обязательным. Диапазон значений этого параметра: от 1 до 3600.

• api_timeout_seconds — время ожидания ответа от экземпляра Kaspersky CyberTrace на запрос REST API в секундах.

  Этот параметр является обязательным. Диапазон значений этого параметра: от 1 до 3600.

Этот элемент является обязательным.

Instances/Instance

Элемент с параметрами подключения к экземпляру Kaspersky CyberTrace.

Значение может быть адресом IPv4 или IPv6.

Этот элемент является обязательным.

Можно указать следующие параметры:

• enabled — задает состояние экземпляра Kaspersky CyberTrace.

  Этот параметр является обязательным.

  Этот параметр может принимать значения true или false.

• matching_port — порт, на котором экземпляр Kaspersky CyberTrace принимает входящие события.

  Значение этого параметра должно соответствовать значению элемента InputSettings > ConnectionString в конфигурационном файле экземпляра Kaspersky CyberTrace.

  Этот параметр является обязательным.

  Диапазон значений этого параметра: от 1 до 65535.

• api_port — порт, на котором экземпляр Kaspersky CyberTrace принимает запросы REST API.

  Значение этого параметра должно соответствовать значению элемента HTTPServer > ConnectionString element in the configuration file of the Kaspersky CyberTrace instance.

  Этот параметр является обязательным.

  Диапазон значений этого параметра: от 1 до 65535.

• scanners_count — максимальное количество одновременных подключений, разрешенных для экземпляра Kaspersky CyberTrace.

  Этот параметр является обязательным. Диапазон значений этого параметра: от 1 до 100.

  Значение параметра scanners_count для экземпляра Kaspersky CyberTrace не должно превышать значение (меньше 1) параметра ScannersCount, указанного в конфигурационном файле данного экземпляра Kaspersky CyberTrace.

Этот элемент является обязательным.

AllowedRequests

Раздел, содержащий элементы с параметрами разрешенных запросов REST API к экземплярам Kaspersky CyberTrace.

Этот элемент является обязательным.

AllowedRequests/AllowedRequest

Элемент, содержащий параметры отдельного разрешенного запроса REST API к экземплярам Kaspersky CyberTrace.

Этот элемент не является обязательным.

Этот элемент может содержать строку длиной от 1 до 2048 символов, содержащую только символы ASCII.

Значение этого элемента может содержать подстановочный знак «*», обозначающий ноль или более любых символов.

Можно указать следующий параметр:

• method — метод запроса. В качестве значения этого параметра можно использовать GET, POST, PUT или DELETE.

  Этот параметр является обязательным. Значение этого параметра нечувствительно к регистру.

По умолчанию файл kl_balancer.conf содержит все элементы AllowedRequest, необходимые для работы REST API Kaspersky CyberTrace.

<Settings>

<Balancer matching_port="9998" api_port="9997" cybertrace_port="9996" scanners_count="9">127.0.0.1</Balancer>

<SSLCertificatePath>..\httpsrv\kl_feed_service_cert.pem</SSLCertificatePath>

<SSLPrivateKeyPath>..\httpsrv\kl_feed_service_private.pem</SSLPrivateKeyPath>

<LicenseDirPath>..\httpsrv\lic</LicenseDirPath>

<OutputSettings port="514">127.0.0.1</OutputSettings>

<Instances update_seconds="60" matching_timeout_seconds="5" api_timeout_seconds="30">

<Instance enabled="true" matching_port="9999" api_port="443" scanners_count="8">127.0.0.1</Instance>

</Instances>

<AllowedRequests>

<AllowedRequest method="GET">/api/1.2/suppliers</AllowedRequest>

<AllowedRequest method="GET">/api/1.2/suppliers/*</AllowedRequest>

<AllowedRequest method="POST">/api/1.2/lookup</AllowedRequest>

<AllowedRequest method="GET">/api/1.2/tags</AllowedRequest>

<AllowedRequest method="GET">/ioc_exports/*</AllowedRequest>

</AllowedRequests>

</Settings>