STIX/TAXII 2 Client Source

Beta

STIX/TAXII are two standards used together to exchange threat intelligence information between systems. STIX defines the format and structure of the data. TAXII defines how the API endpoints are served and accessed by clients. This Sumo Logic source supports collecting indicators from STIX/TAXII 2.0 and 2.1 versions. The legacy STIX/TAXII 1.x versions are not supported with this source.

Data collected

This source collects threat intelligence indicators from a vendor's STIX/TAXII 2.x endpoints. This means the specific endpoints we collect data from are the endpoints defined in the TAXII standard. Vendor APIs must follow the standard. The source will collect all indicators from the TAXII server when it runs for the first time and it will check for updates once an hour. This one-hour polling interval can be adjusted in the source configuration.

Setup

Vendor configuration

note

The threat intel vendor must follow the STIX/TAXII 2.0 or 2.1 standard.

1. Identify a vendor who uses the STIX/TAXII 2.0 or 2.1 standard for sharing threat intelligence indicators.
2. Follow their documentation to obtain the following information:
   • The STIX/TAXII version they provide (either 2.0 or 2.1)
   • The TAXII Discovery URL
   • Your authentication credentials if required

Source configuration

When you create an TAXII 2 Client Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector and Source.

To configure a TAXII 2 Client Source:

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. On the Collection page, click Add Source next to a Hosted Collector.
3. Search for and select TAXII 2 Client.
4. Enter a Name for the Source. The description is optional.
5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
7. Sumo Logic Threat Intel Source ID. Provide your own threat intelligence source ID. This is useful for organizing multiple sources.
8. Authentication. Select the authentication type:
   • Basic. Provide your vendor username and password.
   • API Key. Provide:
     • How to use the key (either in the HTTP request header or HTTP request URL parameters).
     • The location where to use the key, such as the HTTP header key name (for example, Authorization).
     • The API key.
     • The API key prefix (optional).
   • Bearer. Provide the bearer auth token.
   • None. Select if no authorization is needed.
9. STIX/TAXII Configuration:
   1. Version. Select the STIX/TAXII version the vendor is using (2.0 or 2.1).
   2. API Root URL Source. Enter:
      • Discovery URL. Enter the TAXII Discovery URL provided by the vendor (optional).
      • Root URL(s). Enter the TAXII root URL(s). For example, https://stix2.mysource.org/my-root.
   3. Collection Id(s). Enter the collection IDs for TAXII (optional).
10. Other Settings:
    1. (Optional) Set Indicators Limit Per Page. Set the maximum number of indicators to return per page. The default is 99.
    2. (Optional) Polling Interval. Set how frequently to poll for new or updated indicators. It must be between 5 minutes and 48 hours.
11. When you are finished configuring the Source, click Save.

JSON Configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See Use JSON to Configure Sources for details. 

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	{"type":"TAXII 2 Client"}	Yes	Define the specific schema type.
sourceType	String	"Universal"	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	null	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source.	"mySource"
description	String	No	null	Type a description of the source.	"Testing source"
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	"mySource/test"
fields	JSON Object	No	null	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	{"_siemForward": false, "fieldA": "valueA"}
ti_user_source_id	String	Yes	null	Your Sumo Logic threat intel destination source name
ti_version	String	Yes	2.1	The STIX/TAXII server version used
ti_discovery_url	String	Yes	null	The STIX/TAXII discovery URL
http_user	String	No	null	HTTP basic authentication username
http_password	String	No	null	HTTP basic authentication password

JSON example

{
	"api.version":"v1",
	"source":{
		"config":{
			"name":"STIX TAXII 2 Client for Palo Alto",
			"description":"Collects indicators from Unit 42 and stores them in Sumo Logic",
            "ti_user_source_id": "Palo Alto Intel",
            "ti_version": "2.0",
            "ti_discovery_url": "https://stix2.unit42.org/taxii/",
            "http_user": "user@acme.com",
            "http_password": "****************************"
		},
		"schemaRef":{
			"type":"TAXII 2 Client"
		},
		"sourceType":"Security"
	}
}

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "taxii2_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "TAXII 2 Client"
  }
  config = jsonencode({
			"name":"STIX TAXII 2 Client for Palo Alto",
			"description":"Collects indicators from Unit 42 and stores them in Sumo Logic",
			"category":"source_category",
            "ti_user_source_id": "Palo Alto Intel",
            "ti_version": "2.0",
            "ti_discovery_url": "https://stix2.unit42.org/taxii/",
            "http_user": "user@acme.com",
            "http_password": "****************************"
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example

FAQ

info

Click here for more information about Cloud-to-Cloud sources.