Live: Create a Custom Feed

Document created by RSA Information Design and Development on Nov 22, 2016Last modified by RSA Information Design and Development on Mar 28, 2017
Version 3Show Document
  • View in full screen mode
  

This topic provides instructions for creating a custom feed using a .csv or STIX formatted feed data file in RSA Security Analytics.

Note: From 10.6.1 or later, Security Analytics supports Structured Threat Information Expression (STIX). STIX is a structured language for describing cyber threat information so it can be shared, stored, and analyzed in a consistent manner. For more information about STIX, see https://stixproject.github.io/.

In Security Analytics, STIX (.xml) feed of type Indicator or Observable which contains the properties such as the IP addresses, File hashes, Domain names, and URLs are supported. The properties values in Equals operator is only supported. And, the attributes such as Type and Title are also read from the STIX (.xml). The STIX (.xml ) with a single STIX_Package is only supported.

You can easily create a custom feed using the Custom Feed wizard. To complete this procedure, you need a feed data file in .csvor .xml format. If you also have an associated feed definition file in .xml format, which describes the structure of the feed data file, you can use the feed definition file to create a feed. The Custom Feed wizard can create the feed based on a feed data file, or based on a feed data file and corresponding feed definition file.

After completing this procedure, you will have created a custom feed.

The feed data file (.csv or STIX (.xml)) and optionally the feed definition file (.xml) must be available on the local file system for an on-demand custom feed. For a recurring custom feed, the files must be available at a URL that is accessible to the Security Analytics server.

To create a custom feed:

  1. In the Security Analytics menu, select Live > Feeds.

    The Feeds view is displayed.

    Feeds.png

  2. In the toolbar, click Icon-Add.png.

    The Setup Feed dialog is displayed.

    SetFeed.png

  3. To select the feed type, click Custom Feed and Next.

    The Configure a Custom Feed wizard is displayed, with the Define Feed form open.

  4. In the Feed Type, do one of the following:

    • To define a feed based on a .csv formatted feed data file, select Default.
    • To define a feed based on a STIX formatted .xml file, select STIX.

  5. To define an on-demand feed task that executes once, select Adhoc in the Feed Task Type field and do one of the following:

    1. (Conditional) To define a feed based on a .csv formatted feed data file, type the feed Name, select a .csv content File from the local file system, and click Next.
    2. (Conditional) To define a feed based on STIX formatted .xml file, type the feed Name, select a STIX  formatted .xml content File from the local file system, and click Next.

    3. (Conditional) To define a feed based on an XML feed file, select Advanced Options.

      The Advanced Options are displayed:

    4. Select an XML feed file from the local file system, choose the Separator (default is comma), and specify the Comment characters used in the feed data file (default is #), and click Next.
    5. The Select Services form is displayed. This is an example of the form for a feed based on a feed data file with no feed definition file. If you are defining a feed based on a feed definition file, the Define Columns tab is not needed.

      SelectServices.png

  6. To define a recurring feed task that executes repeatedly at specified intervals, during a specified date range.

    1. Select Recurring in the Feed Task Type field.

      The Define Feed form includes the fields for a recurring feed.

    2. In the URL field, enter the URL where the feed data file is located, for example, http://<hostname>/<feeddatafile>.csv, and click Verify.

      Security Analytics verifiies the location where the file is stored, so that Security Analytics can check for the latest file automatically before each recurrence.

    3. (Optional) If the URL has restricted access and requires authentication using your username and password, select Authenticated.

      Security Analytics provides your user name and password for authentication to the URL.

    4. If you want the Security Analytics server to access the Feed URL through a proxy, select Use Proxy. For more information on configuring a proxy, see the Configure Proxy for Security Analytics topic in the System Configuration Guide. By default, the Use Proxy checkbox is not selected.
    5. To define the interval for recurrence, do one of the following:

      • Specify the number of minutes, hours, or days between recurrences of the feed.
      • Specify recurrence every week, and select the days of the week.
    6. To define the date range for the execution of the feed to recur, specify the Start Date and time and the End Date and time.

  7. (Conditional) If you want to define a feed based on an XML feed file:

    • Type the feed Name, select Advanced Options.

      The Advanced Options fields are displayed.

    • Select an XML feed file from the local file system, choose the Separator (default is comma), specify the Comment characters used in the feed data file (default is #) and click Next.

      The Select Services form is displayed.

      SelectServices.png

  8. To identify services on which to deploy the feed, do one of the following:

    1. Select one or more Decoders and Log Decoders, and click Next.
    2. Click the Groups tab and select a group. Click Next.

      The Define Columns form is displayed.

  9. To map columns in the Define Columns form:

    1. Define the Index type: IPIP Range, or Non IP, and select the index column.
    2. (Conditional) If the index type is IP or IP Range and the IP address is in CIDR notation, select CIDR.
    3. (Conditional) If the index type is Non IP, additional settings are displayed. Select the service type and Callback Keys, and optionally select the Truncate Domain option.

      104CCFDefineColumns.png

    4. Select the language key to apply to the data in each column from the drop-down list. The meta displayed in the drop-down list is based on the meta available for the service define values. You can also add other meta based on advanced expertise.

      104CCFDefineColFilled.png

    5. Click Next.

      The Review form is displayed.

      104CCFReview.png

  10. Anytime before you click Finish, you can:

    • Click Cancel to close the wizard without saving your feed definition.
    • Click Reset to clear the data in the wizard.
    • Click Next to display the next form (if not viewing the last form).
    • Click Prev to display the previous form (if not viewing the first form).
  11. Review the feed information, and if correct, click Finish.
  12. Upon successful creation of the feed definition file, the Create Feed wizard closes, and the feed and corresponding token file are listed in the Feed grid and progress bar tracks completion. You can expand or collapse the entry to see how many services are included, and which services were successful.

104AddedCustomFeed.png

MetaCallback Feeds using CIDR Index Range for IPv4 and IPv6

This section describes how to use CIDR index ranges for IPv4 and IPv6 in custom MetaCallback feeds. As with other custom feeds, you must create feed data file in .csv format, and a feed definition file in .xml format.

Note: Using Metacallback feeds with CIDR index ranges is supported only through the Advanced Configuration wizard or the REST interface.

The following example shows the contents of both a .csv file and an .xml file for a MetaCallback feed using CIDR index ranges for IPv4 or IPv6.

.csv file:

192.168.0.0/24, Sydney

192.168.1.0/24, Melbourne

.xml file:

<?xml version="1.0" encoding="UTF-8"?>

<FDF xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="feed-definitions.xsd">

<FlatFileFeed name="ip_test" path="ip_test.csv" separator="," comment="#">

<MetaCallback name="DstIP" valuetype="IPv4" apptype="0" truncdomain="false">

<Meta name="ip.dst"/>

</MetaCallback>

<LanguageKeys>

<LanguageKey name="alert" valuetype="Text" />

</LanguageKeys>

<Fields>

<Field index="1" type="index" range="cidr"/>

<Field index="2" type="value" key="alert" />

</Fields>

</FlatFileFeed>

</FDF>

Note: To configure a CIDR index range for feeds with single or multiple MetaCallbacks of value type IPv4 or IPv6, the field of type index MUST contain a range attribute with range="cidr". Also, configuring "cidr" index ranges for feeds with MetaCallbacks of multiple different value types is not supported.

Previous Topic:Manage Custom Feeds
You are here
Table of Contents > Additional Procedures > Manage Custom Feeds > Create a Custom Feed

Attachments

    Outcomes