Balancer の構成

2024年4月11日

ID 214597

Balancer のパラメータは、配布キットに含まれる設定情報ファイル kl_balancer.conf に指定されています。kl_balancer.conf は、次の表示で説明されているパラメータが含まれる XML ファイルです。

構成ファイルのパラメータ

パラメータ

説明

Balancer

Balancer に接続するためのアドレスを指定します。

この値は、IPv4 アドレス、IPv6 アドレス、またはホスト名である場合があります。

次のパラメータを指定する必要があります:

  • matching_port—Balancer が受信イベントを受信するポート。このパラメータの値の範囲は、165535 です。このパラメータは必須です。
  • api_port—Balancer が API リクエストを受け入れるポート。このパラメータの値の範囲は、165535 です。このパラメータは必須です。
  • cybertrace_port—Balancer が Kaspersky CyberTrace インスタンスからアラートイベントを受信するポート。このパラメータの値の範囲は、165535 です。このパラメータは必須です。
  • scanners_count—同時接続の最大数。このパラメータの値の範囲は、1100 です。このパラメータは必須です。

この要素は必須です。設定情報ファイルに含めることができるは、1 つの Balancer 要素のみです。

EventDelimiter

イベントの区切り記号を定義する正規表現。

この要素は任意です。

イベントに改行文字(\n)が含まれる場合、このようなイベントは、この要素の値と改行文字の両方を区切り記号として使用して分割されます。

SSLCertificatePath

HTTPS 接続用の PEM 形式の証明書へのパス。

この要素には、絶対パスまたは相対パスを含めることができます。相対パスを指定すると、Balancer のバイナリファイルとの相対的なパスが計算されます。

このパラメータは任意です。既定値は次の通りです:

  • Windows システムの場合:

    ..\httpsrv\kl_feed_service_cert.pem

  • Linux システムの場合:

    ../httpsrv/kl_feed_service_cert.pem

Kaspersky CyberTrace がインストールされていないコンピューターに Balancer をデプロイする場合、この要素の値を更新してください。

SSLPrivateKeyPath

HTTPS 接続用の PEM 形式の秘密鍵へのパス。

この要素には、絶対パスまたは相対パスを含めることができます。相対パスを指定すると、Balancer のバイナリファイルとの相対的なパスが計算されます。

このパラメータは任意です。既定値は次の通りです:

  • Windows システムの場合:

    ..\httpsrv\kl_feed_service_private.pem

  • Linux システムの場合:

    ../httpsrv/kl_feed_service_private.pem

Kaspersky CyberTrace がインストールされていないコンピューターに Balancer をデプロイする場合、この要素の値を更新してください。

LicenseDirPath

ライセンスファイルがあるディレクトリへのパス。

この要素には、絶対パスまたは相対パスを含めることができます。相対パスを指定すると、Balancer のバイナリファイルとの相対的なパスが計算されます。

このパラメータは任意です。既定値は次の通りです:

  • Windows システムの場合:

    ..\httpsrv\lic

  • Linux システムの場合:

    ../httpsrv/lic

Kaspersky CyberTrace がインストールされていないコンピューターに Balancer をデプロイする場合、この要素の値を更新してください。

CertDirPath

CyberTrace の参照証明書があるディレクトリへのパス。

この要素には、絶対パスまたは相対パスを含めることができます。相対パスを指定すると、Balancer の実行可能ファイルとの相対的なパスが計算されます。

このパラメータは必須です。既定値は次の通りです:

..\etc\certs

OutputSettings

受信イベントのマッチングの結果を送信するためのアドレスを指定します。

この値は、IPv4 アドレス、IPv6 アドレス、またはホスト名である場合があります。

次のパラメータを指定できます:

  • port—Balancer が受信イベントのマッチングの結果を送信するポート。このパラメータの値の範囲は、165535 です。このパラメータは必須です。

この要素は必須です。

Instances

Kaspersky CyberTrace インスタンスのパラメータを持つ要素が含まれるセクション。

このセクションには次のパラメータを指定できます:

  • update_seconds—アクセス不可能な Kaspersky CyberTrace のインスタンスへの接続試行間の時間間隔(秒)。

    このパラメータは必須です。このパラメータの値の範囲は、13600 です。

  • matching_timeout_seconds—受信イベントのマッチングの結果を持つ Kaspersky CyberTrace のインスタンスからのレスポンスのタイムアウト(秒)。

    このパラメータは必須です。このパラメータの値の範囲は、13600 です。

  • api_timeout_seconds—Kaspersky CyberTrace のインスタンスから REST API リクエストへのレスポンスのタイムアウト(秒)。

    このパラメータは必須です。このパラメータの値の範囲は、13600 です。

この要素は必須です。

Instances/Instance

Kaspersky CyberTrace のインスタンスへの接続用のパラメータを持つ要素。

この値は IPv4 または IPv6 アドレスである場合があります。

この要素は必須です。

次のパラメータを指定できます:

  • enabled—Kaspersky CyberTrace のインスタンスの状態を指定します。

    このパラメータは必須です。

    このパラメータの値として true または false を使用してください。

  • matching_port—Kaspersky CyberTrace のインスタンスが受信イベントを受け入れるポート。

    このパラメータの値は、Kaspersky CyberTrace のインスタンスの設定情報ファイル内の[InputSettings]→[ConnectionString]要素の値と同じである必要があります。

    このパラメータは必須です。

    このパラメータの値の範囲は、165535 です。

  • api_port—Kaspersky CyberTrace のインスタンスが REST API リクエストを受け入れるポート。

    このパラメータの値は、Kaspersky CyberTrace のインスタンスの設定情報ファイル内の[HTTPServer]→[ConnectionString]要素の値と同じである必要があります。

    このパラメータは必須です。

    このパラメータの値の範囲は、165535 です。

  • scanners_count—Kaspersky CyberTrace のインスタンスに許可された同時接続の最大数。

    このパラメータは必須です。このパラメータの値の範囲は、1100 です。

    Kaspersky CyberTrace のインスタンスの scanners_count パラメータの値は、その Kaspersky CyberTrace のインスタンスの設定情報ファイルに指定されている ScannersCount パラメータの値から 1 引いた値を超えてはなりません。

この要素は必須です。

AllowedRequests

このセクションには、Kaspersky CyberTrace のインスタンスに対して許可された REST API リクエストのパラメータを持つ要素が含まれます。

この要素は必須です。

AllowedRequests/AllowedRequest

Kaspersky CyberTrace のインスタンスに対して許可された REST API リクエストのパラメータを持つ要素。

この要素は任意です。

この要素には、長さが 1 ~ 2048 文字で、ASCII 文字のみが含まれる文字列を含めることができます。

この要素の値には、「*」ワイルドカードを含めることができます。これは、ゼロ個または任意の数の文字を表します。

次のパラメータを指定できます:

  • method—リクエストメソッド。このパラメータの値として GETPOSTPUT、または DELETE を使用してください。

    このパラメータは必須です。このパラメータの値は大文字小文字が区別されません。

既定では、kl_balancer.conf には、Kaspersky CyberTrace の REST API を使用するために必要な AllowedRequest 要素がすべて含まれます。

既定の設定情報ファイル

既定では、kl_balancer.conf には次のパラメータが含まれます:

<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>

上記の既定の設定情報ファイルは、Windows システムの配布キットに含まれるものです。Linux システムの既定の設定情報ファイルにも同じ内容が含まれますが、SSLCertificatePathSSLPrivateKeyPathLicenseDirPath パラメータの値内のローカルパスの形式が異なります(この場合、「\」が「/」に置き換わります)。

この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。