Setting
|
Description
|
Name
|
Unique name of the resource. Maximum length of the name: 128 Unicode characters.
Required setting.
|
Tenant
|
The name of the tenant that owns the resource.
Required setting.
|
State
|
Events must be sent to the destination.
The toggle switch is turned off by default.
|
Type
|
Type of the destination. You need to select nats-jetstream.
Required setting.
|
URL
|
URL that you want to connect to.
Required setting.
|
Topic
|
The topic of NATS messages. You need to specify a Unicode string.
Required setting.
|
Delimiter
|
The character that marks the boundary between events. Available values:
If you do not select a value, \n is selected by default.
|
Authorization
|
Type of authorization when connecting to the specified URL. Possible values:
- disabled. The default value.
- plain. If this option is selected, you must indicate the secret containing user account credentials for authorization when connecting to the destination.
How to add a secret? To add a secret:
- If you have created a secret, select it from the Secret drop-down list. If no secrets have been created, the Secret drop-down list displays No data.
- If you want to add a new secret, click the button on the right of the Secret list.
The Secret window opens. - In the Name field, enter the name of the secret.
- In the User and Password fields, enter the credentials of the user account that the Agent will use to connect to the connector.
- If necessary, add more information about the secret in the Description field.
- Click the Save button.
The secret will be added and displayed in the Secret list.
|
Description
|
Description of the resource. Maximum length of the description: 4000 Unicode characters.
|
Setting
|
Description
|
Compression
|
Using Snappy compression. Available values:
- Disabled. The default value.
- Use Snappy.
|
Buffer size
|
Destination buffer size in bytes for accumulating events in the RAM of the server before sending sending them for further processing or storage. The value must be a positive integer. Default desination buffer size: 1,048,576 bytes (1 MB). Maximum destination buffer size: 67,108,864 bytes (64 MB).
|
Disk buffer size limit
|
Size of the destination disk buffer in bytes. The default value is 10 GB.
|
Cluster ID
|
ID of the NATS cluster.
|
Output format
|
Format for sending events to an external destination. Available values:
- JSON.
- CEF. If this value is selected, the transmitted events contain the CEF header and only non-empty fields.
|
TLS mode
|
TLS encryption mode. Available values:
- Disabled means TLS encryption is not used. The default value.
- 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 folder /opt/kaspersky/kuma/core/certificates/.
- Custom CA means TLS encryption is used with verification that the certificate was signed by a Certificate Authority. If you select this value, from the Custom CA drop-down list, select a secret with a certificate signed by the CA.
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:
- Generate a key to be used by the Certificate Authority, for example:
openssl genrsa -out ca.key 2048 - 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 - 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 - 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 - Upload the generated
server.crt certificate to the KUMA web interface into a secret of the certificate type, then select the secret of the certificate type in the Custom CA drop-down list.
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. When using TLS encryption, you cannot specify an IP address as the URL.
|
Delimiter
|
In the drop-down list, you can select the character to mark the boundary between events. By default, \n is used.
|
Buffer flush interval
|
Interval (in seconds) for sending data to the destination. The default value is 1 second.
|
Number of handlers
|
Number of handlers that the service can run simultaneously to process response rules in parallel. By default, this value is equal to the number of vCPUs of the KUMA Core server.
|
Debug
|
Resource logging. The toggle switch is turned off by default.
|
Disk buffer disabled
|
Whether a disk buffer is used. By default, the disk buffer is enabled.
The disk buffer is used if the collector cannot send normalized events to the destination. The amount of allocated disk space is limited by the value specified in the Disk buffer size limit field.
If the disk space allocated for the disk buffer is exhausted, events are rotated as follows: new events replace the oldest events written to the buffer.
|
Filter
|
Conditions for determining which events must be processed by the resource. You can select an existing filter or create a filter.
How to create a filter?
To create a filter:
- In the Filter drop-down list, select Create new.
- If you want to keep the filter as a separate resource, select the Save filter check box. In this case, you will be able to use the created filter in various services. This check box is cleared by default.
- If you selected the Save filter check box, enter a name for the created filter resource in the Name field. Maximum length of the name: 128 Unicode characters.
- In the Conditions settings block, specify the conditions that the events must meet:
- Click the Add condition button.
- In the Left operand and Right operand drop-down lists, specify the search parameters. Depending on the data source selected in the Right operand field, you may see fields of additional parameters for identifying the value to be passed to the filter. For example, when you select active list, you must specify the name of the active list, the entry key, and the entry key field.
- In the operator drop-down list, select an operator.
Filter operators - =—the left operand equals the right operand.
- <—the left operand is less than the right operand.
- <=—the left operand is less than or equal to the right operand.
- >—the left operand is greater than the right operand.
- >=—the left operand is greater than or equal to the right operand.
- inSubnet—the left operand (IP address) is in the subnet of the right operand (subnet).
- contains—the left operand contains values of the right operand.
- startsWith—the left operand starts with one of the values of the right operand.
- endsWith—the left operand ends with one of the values of the right operand.
- match—the left operand matches the regular expression of the right operand. The RE2 regular expressions are used.
- hasBit—checks whether the left operand (string or number) contains bits whose positions are listed in the right operand (in a constant or in a list).
The value to be checked is converted to binary and processed right to left. Chars are checked whose index is specified as a constant or a list. If the value being checked is a string, then an attempt is made to convert it to integer and process it in the way described above. If the string cannot be converted to a number, the filter returns False . - hasVulnerability—checks whether the left operand contains an asset with the vulnerability and vulnerability severity specified in the right operand.
If you do not specify the ID and severity of the vulnerability, the filter is triggered if the asset in the event being checked has any vulnerability. - inActiveList—this operator has only one operand. Its values are selected in the Key fields field and are compared with the entries in the active list selected from the Active List drop-down list.
- inDictionary—checks whether the specified dictionary contains an entry defined by the key composed with the concatenated values of the selected event fields.
- inCategory—the asset in the left operand is assigned at least one of the asset categories of the right operand.
- inActiveDirectoryGroup—the Active Directory account in the left operand belongs to one of the Active Directory groups in the right operand.
- TIDetect—this operator is used to find events using CyberTrace Threat Intelligence (TI) data. This operator can be used only on events that have completed enrichment with data from CyberTrace Threat Intelligence. In other words, it can only be used in collectors at the destination selection stage and in correlators.
- inContextTable—presence of the entry in the specified context table.
- intersect—presence in the left operand of the list items specified in the right operand.
- If you want the operator to be case-insensitive, select the do not match case check box. The selection of this check box does not apply to the InSubnet, InActiveList, InCategory or InActiveDirectoryGroup operators. This check box is cleared by default.
- If you want to add a negative condition, select If not from the If drop-down list.
You can add multiple conditions or a group of conditions. - If you have added multiple conditions or groups of conditions, choose a selection condition (and, or, not) by clicking the AND button.
- If you want to add existing filters that are selected from the Select filter drop-down list, click the Add filter button. You can view the nested filter settings by clicking the button.
|