Name

Unique name of the resource. The maximum length of the name is 128 Unicode characters.

Required setting.

Tenant

The name of the tenant that owns the resource.

Required setting.

Type

Connector type: nats-jetstream.

Required setting.

Tags

Tags for resource search.

Optional setting.

URL

URL that you want to connect to. The following URL formats are supported:

• <host name>:<port number>
• <IPv4 address>:<port number>
• <IPv6 address>:<port number>

  You can specify IPv6 addresses in the following format: [<IPv6 address>%<interface>:<port number>, for example, [fe80::5054:ff:fe4d:ba0c%eth0]:4222.

You can add multiple URLs or remove an URL. KUMA does not allow saving a resource or service if the URL field contains a tab or space character. To add an URL, click the + Add button. To remove an URL, click the delete icon next to it.

Required setting.

Authorization

Type of authorization when connecting to the URL specified in the URL field:

• Disabled. This value is selected by default.
• Plain. Authorization of this type is performed using the SASL/PLAIN mechanism, which transmits the user name and password in plain text. Typically, TLS is used to provide transmission security (encryption) in SASL/PLAIN.

  If this option is selected, in the Secret drop-down list, specify the secret containing user account credentials for authorization when connecting to the destination. You can select an existing secret or create a new secret. To create a new secret, select Create new.

  If you want to edit the settings of an existing secret, click the pencil icon next to it.

  How to create a secret?

  To create a secret:

  1. In the Name field, enter the name of the secret.
  2. In the User and Password fields, enter the credentials of the user account that the Agent will use to connect to the connector.
  3. If necessary, enter a description of the secret in the Description field.
  4. Click the Create button.

  The secret is added and displayed in the Secret drop-down list.

Subject

The topic of NATS messages. Characters are entered in Unicode encoding.

Required setting.

GroupID.

The value of the GroupID parameter for NATS messages. Maximum length of the value: 255 Unicode characters. The default value is default.

Delimiter

The character that marks the boundary between events:

• \n
• \t
• \0

If you do not select a value in this drop-down list, an empty value is selected by default. This means that the connector does not parse one event into many, but instead passes it to the normalizer as it is.

Description

Description of the resource. The maximum length of the description is 4000 Unicode characters.

Debug

The switch enables resource logging. The toggle switch is turned off by default.

Buffer size

Buffer size in bytes for accumulating events in the RAM of the server before sending them for further processing or storage. The value must be a positive integer. Default buffer size: 67,108,864 (64 MB), displayed as 0 in the interface.

Number of handlers

Number of handlers that the service can run simultaneously to process response rules in parallel.

The value must be a positive integer up to 999.

Character encoding

Character encoding. The default is UTF-8.

TLS mode

TLS encryption mode. When using TLS encryption, you cannot specify an IP address in the URL field on the Basic settings. Available values:

• Disabled means TLS encryption is not used. This value is selected by default.
• Enabled means TLS encryption is used, but certificates are not verified.
• With verification means TLS encryption is used with verification of the certificate signed with the KUMA root certificate. The root certificate and key of KUMA are created automatically during application installation and are stored on the KUMA Core server in the /opt/kaspersky/kuma/core/certificates/ directory.

  Obsolete encryption mode, deprecated. Will be removed in future versions of KUMA.

• Custom CA means TLS encryption is used with verification that the certificate was signed by a Certificate Authority. If you select this value, in the Custom CA drop-down list, specify a secret with a certificate signed by a certification authority. You can select an existing secret or create a new secret. To create a new secret, select Create new.

  If you want to edit the settings of an existing secret, click the pencil icon next to it.

  How to create a certificate signed by a Certificate Authority?

  You can create a CA-signed certificate on the KUMA Core server (the following command examples use OpenSSL).

  To create a certificate signed by a Certificate Authority:

  1. Generate a key to be used by the Certificate Authority, for example:

     openssl genrsa -out ca.key 2048

  2. Create a certificate for the generated key, for example:

     openssl req -new -x509 -days 365 -key ca.key -subj "/CN=<common host name of Certificate Authority>" -out ca.crt

  3. Create a private key and a request to have it signed by the Certificate Authority, for example:

     openssl req -newkey rsa:2048 -nodes -keyout server.key -subj "/CN=<common host name of KUMA server>" -out server.csr

  4. Create the certificate signed by the Certificate Authority. You need to include the domain names or IP addresses of the server for which you are creating the certificate in the subjectAltName variable, for example:

     openssl x509 -req -extfile <(printf "subjectAltName=DNS:domain1.ru,DNS:domain2.com,IP:192.168.0.1") -days 365 -in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out server.crt

  5. Upload the created server.crt certificate in the KUMA web interface to a secret of the certificate type, then in the Custom CA drop-down list, select the secret of the certificate type.

  To use KUMA certificates on third-party devices, you must change the certificate file extension from CERT to CRT. Otherwise, you can get the x509: certificate signed by unknown authority error.

• Custom PFX means TLS encryption with a PFX secret. You must generate a PFX certificate with a private key in PKCS#12 container format, then upload the PFX certificate to the KUMA web interface as a PFX secret. If you select this value, in the PFX secret drop-down list, specify a PFX secret with a certificate signed by a certification authority. You can select an existing PFX secret or create a new PFX secret. To create a new PFX secret, select Create new.

  If you want to edit the settings of an existing secret, click the pencil icon next to it.

  How to create a PFX secret?

  To create a PFX secret:

  1. In the Name field, enter the name of the PFX secret.
  2. Click Upload PFX and select the PKCS#12 container file to which you exported the PFX file with the private key.
  3. In the Password field, enter the password of the PFX file that was set in the PFX Export Wizard.
  4. Click the Create button.

  The PFX secret is created and displayed in the PFX secret drop-down list.

  The Custom PFX mode is not displayed when Authorization is set to Plain.

Compression

Drop-down list for configuring Snappy compression:

• Disabled. This value is selected by default.
• Use Snappy.