Step 2. Sending events from Kaspersky CyberTrace Service to RSA NetWitness

April 11, 2024

ID 167793

This section describes the actions to take so that Kaspersky CyberTrace Service will send events to RSA NetWitness.

Note that Kaspersky CyberTrace Service sends events to a Log Decoder service.

To send events from Kaspersky CyberTrace Service to RSA NetWitness:

  1. In Kaspersky CyberTrace Web, on the Settings > Service tab, specify the following value for the Service sends events to text box:

    [IP]:514

    Here [IP] is the IP address of the Log Decoder service to which Kaspersky CyberTrace Service will send events.

    If there are several Log Decoder services, perform the integration with only one of the Log Decoders.

  2. In /etc/netwitness/ng/envision/etc/devices directory of the computer on which Log Decoder runs, create a cybertrace subdirectory and copy to the subdirectory the following files from the %service_dir%/integration/rsa/cybertrace directory:
    • cybertrace.ini

      This is a configuration file that contains declaration of Kaspersky CyberTrace Service for RSA NetWitness.

    • v20_cybertracemsg.xml

      This is a configuration file that contains parsing rules for events that are sent from Kaspersky CyberTrace Service to RSA NetWitness. See below in this section for a description of the contents.

    You can find these files in the integration/rsa/cybertrace directory of the distribution kit.

  3. Restart Log Decoder.

    For this purpose, in the Services view, for the selected Log Decoder click the Settings split button (Settings split button in RSA NetWitness.) and from the drop-down list select Restart.

  4. Make sure that the cybertrace service parser is turned on in RSA NetWitness.

    You can do this as follows:

    1. In the RSA NetWitness menu, select Administration > Services.
    2. In the Services grid, select the Log Decoder, and from the Actions menu, choose View > Config.
    3. In the Service Parsers Configuration panel, search for cybertrace, and ensure that the Config Value field in this row is selected.

    Service Parsers Configuration window in RSA NetWitness.

    Service Parsers Configuration grid

  5. Restart Kaspersky CyberTrace Service.

    You can restart Kaspersky CyberTrace Service by running the kl_feed_service script as follows:

    systemctl restart cybertrace.service

    You can do this by using Kaspersky CyberTrace Web too.

Contents of integration files

The v20_cybertracemsg.xml file contains the following rule for parsing service events from Kaspersky CyberTrace Service:

alert=<action>,context=<msg>

The v20_cybertracemsg.xml file contains several rules for parsing detection events from Kaspersky CyberTrace Service:

  • MATCH_EVENT:01—For parsing detection events when Botnet C&C URL Data Feed is involved in the detection process.
  • MATCH_EVENT:02—For parsing detection events when Malicious URL Data Feed is involved in the detection process.
  • MATCH_EVENT:03—For parsing detection events when Mobile Botnet C&C URL Data Feed is involved in the detection process.
  • MATCH_EVENT:04—For parsing detection events when Malicious Hash Data Feed is involved in the detection process.
  • MATCH_EVENT:05—For parsing detection events when Phishing URL Data Feed is involved in the detection process.
  • MATCH_EVENT:06—For parsing detection events when Ransomware URL Data Feed or IoT URL Data Feed are involved in the detection process.
  • MATCH_EVENT:07—For parsing detection events when IP Reputation Data Feed is involved in the detection process.
  • MATCH_EVENT:09—For parsing detection events when Mobile Malicious Hash Data Feed is involved in the detection process.
  • MATCH_EVENT:10—For parsing detection events when APT IP and URL feeds are involved in the detection process.
  • MATCH_EVENT:11—For parsing detection events when Industrial Control Systems Data Feed is involved in the detection process.
  • MATCH_EVENT:12—For parsing detection events when APT Hash feeds are involved in the detection process.
  • MATCH_EVENT—For parsing detection events when other feeds are involved in the detection process.

The fields of the cybertrace.ini file and the v20_cybertracemsg.xml file correspond to the following format of service events and detection events from Kaspersky CyberTrace Service:

<AlertFormat><![CDATA[<232>%CyberTrace:ALERT_EVENT alert=%Alert%,context=%RecordContext%]]></AlertFormat>

<EventFormat><![CDATA[<232>%CyberTrace:MATCH_EVENT category=%Category%,detected=%MatchedIndicator%,url=%RE_URL%,hash=%RE_HASH%,dst=%DST_IP%,src=%SRC_IP%,dvc=%DeviceIp%,dev_name=%Device%,dev_action=%DeviceAction%,user=%UserName%,cnf=%Confidence%,actF:%ActionableFields%,context=%RecordContext%]]> </EventFormat>

In the v20_cybertracemsg.xml file, the format of events from Kaspersky CyberTrace Service is provided in the HEADER/content element and in the MESSAGE/content element. Make sure that the following fields are present in the index files of Log Decoder and Concentrator: virusname, url, checksum, and ip.src, ip.dst. As for the fields other than virusname, url, checksum, and ip.src, ip.dst in the MESSAGE/content element, you may or may not use them in the index files of Log Decoder and Concentrator. Also, make sure that the value of the flags attribute is None for each of these fields in the table-map-custom.xml file. If any of these conditions are not met, refer to the section about RSA NetWitness troubleshooting.

The following tables describe the fields used in the v20_cybertracemsg.xml and kl_feed_service.conf files, and describe how fields in one file correspond to fields in the other. If you want to constantly use some new field in detection events, contact your Technical Account Manager (TAM).

  • Fields of service events

    Field in kl_feed_service.conf

    Field in v20_cybertracemsg.xml

    Description

    <232>

    -

    Service string for RSA NetWitness.

    %CyberTrace:

    %CyberTrace:

    Informs RSA NetWitness that an event is sent from Kaspersky CyberTrace Service.

    ALERT_EVENT

    &lt;messageid&gt;

    The event type.

    -

    &lt;!payload&gt;

    Notifies RSA NetWitness that the event has additional information, the format of which is provided in the MESSAGE/content element.

    %Alert%

    &lt;action&gt;

    The service event (for example, KL_ALERT_ServiceStarted).

    %RecordContext%

    &lt;msg&gt;

    Context information about the service event.

  • Fields of detection events

    Field in kl_feed_service.conf

    Field in v20_cybertracemsg.xml

    Description

    <232>

    -

    Service string for RSA NetWitness.

    %CyberTrace:

    %CyberTrace:

    Informs RSA NetWitness that an event is sent from Kaspersky CyberTrace Service.

    MATCH_EVENT

    &lt;messageid&gt;

    The event type.

    -

    &lt;!payload&gt;

    Notifies RSA NetWitness that the event has additional information, the format of which is provided in the MESSAGE/content element.

    %Category%

    &lt;virusname&gt;

    Category of the detected object.

    %MatchedIndicator%

    &lt;kl_detected_indicator%gt;

    The detected indicator.

    %RE_URL%

    &lt;url&gt;

    The URL specified in the event from RSA NetWitness.

    %RE_HASH%

    &lt;checksum&gt;

    The hash specified in the event from RSA NetWitness.

    %DST_IP%

    &lt;daddr&gt;

    The IP address to which the request is sent.

    %SRC_IP%

    &lt;saddr&gt;

    The IP address from which the request is sent.

    %DeviceIp%

    &lt;hostip&gt;

    The IP address from which the event is sent.

    %Device%

    &lt;event_source&gt;

    The name of the device that has sent the event.

    %DeviceAction%

    &lt;action&gt;

    The action that the device has performed.

    %UserName%

    &lt;c_username&gt;

    The name of the user on whose account the action described in the event is performed.

    %ActionableFields%

    The fields' names are discussed below in this section.

    Fields of the feed record involved in the detection process that are displayed apart from the context.

    %RecordContext%

    &lt;fld1&gt;

    Context of the feed record that was involved in the detection process.

    To view the contents of this field, open the event in RSA NetWitness and select the View Log tab.

    %Confidence%

    &lt;kl_confidence&gt;

    The level of confidence in the indicators of the feed, in percent.

The following tables describe the actionable fields used in the feeds and in the v20_cybertracemsg.xml file, and describe how fields in a feed correspond to fields in the file:

  • Botnet C&C URL Data Feed and Demo Botnet C&C URL Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    mask

    kl_mask

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    threat

    kl_threat

  • Malicious Hash Data Feed and Demo Malicious Hash Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    MD5

    kl_md5

    SHA1

    kl_sha1

    SHA256

    kl_sha256

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    file_type

    kl_file_type

    file_size

    kl_file_size

    threat

    kl_threat

  • IP Reputation Data Feed and Demo IP Reputation Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    ip

    kl_ip

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    threat_score

    kl_threat_score

    category

    kl_category

    threat

    kl_threat

  • Malicious URL Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    mask

    kl_mask

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    files/threat

    kl_threat

    category

    kl_category

  • Mobile Malicious Hash Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    MD5

    kl_md5

    SHA1

    kl_sha1

    SHA256

    kl_sha256

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    threat

    kl_threat

    file_size

    kl_file_size

  • Phishing URL Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    mask

    kl_mask

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

    industry

    kl_industry

  • Mobile Botnet C&C URL Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    threat

    kl_threat

  • Ransomware URL Data Feed or IoT URL Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    mask

    kl_mask

    first_seen

    kl_first_seen

    last_seen

    kl_last_seen

    popularity

    kl_popularity

  • APT IP and URL feeds

    Field in the feed

    Field in v20_cybertracemsg.xml

    detection_date

    kl_detect_date

    publication_name

    kl_pub_name

  • APT Hash feeds

    Field in the feed

    Field in v20_cybertracemsg.xml

    detection_date

    kl_detect_date

    publication_name

    kl_pub_name

    SHA1

    kl_sha1

    SHA256

    kl_sha256

  • Industrial Control Systems Data Feed

    Field in the feed

    Field in v20_cybertracemsg.xml

    first_seen

    kl_first_seen

    popularity

    kl_popularity

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.