CrowdStrike Source
The CrowdStrike Source provides a secure endpoint to receive event data from the CrowdStrike Streams API. It securely stores the required authentication, scheduling, and state tracking information.
The CrowdStrike API documentation is not public and can only be accessed by partners or customers.
The types of events are defined in the Streaming API Event Dictionary.
Data collected
Polling Interval | Data |
---|---|
5 min | Event data |
Setup
Vendor configuration
Before you can connect to event streams, you must contact the CrowdStrike support team to enable the streaming APIs on your customer account. If it's not enabled, your requests will receive HTTP 500 responses.
You must contact CrowdStrike support and enable the Streams API.
A CrowdStrike Source authenticates with an OAuth2 API key. These are created in the Crowdstrike Console under API Clients and Keys. The API token needs the READ
privilege for the following properties:
- Detections
- Event Streams
- Hosts
Source configuration
When you create a CrowdStrike 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.
To configure a CrowdStrike Source:
- 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. - On the Collectors page, click Add Source next to a Hosted Collector.
- Search for and select CrowdStrike.
- Enter a Name for the Source. The description is optional.
- (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
. - Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM. note
Select Forward to SIEM only if you have Cloud SIEM installed.
- (Optional) Fields. Click the +Add Field link 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 that does not exist in the Fields schema it is ignored, known as dropped.
- CrowdStrike domain: Provide your CrowdStrike domain, for example,
api.crowdstrike.com
. - Client ID: Provide the CrowdStrike Client ID you want to use to authenticate collection requests.
- Secret Key. Provide the CrowdStrike API key you want to use to authenticate collection requests.
- (Optional) Application ID. To allow for easier tracking of your log ingestion, you can provide a 1 to 15 character identifier to add to your CrowdStrike Audit Logs.
note
If no Application ID is provided, a random ID is generated. Any time this ID is changed, the Source will re-read the data stream starting at the beginning.
- When you are finished configuring the Source, click Submit.
Metadata fields
Field | Value | Description |
---|---|---|
_siemVendor | CrowdStrike | Set when Forward To SIEM is checked. |
_siemProduct | Falcon Endpoint Protection (CNC) | Set when Forward To SIEM is checked. |
_siemFormat | JSON | Set when Forward To SIEM is checked. |
_siemEventID | <metadata.eventype> | Where <metadata.eventype> is the value of the field from the JSON event, such as IncidentSummaryEvent or DetectionSummaryEvent. |
JSON schema
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.
Parameter | Type | Value | Required | Description |
---|---|---|---|---|
schemaRef | JSON Object | {"type":"CrowdStrike"} | 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"} |
domain | String | Yes | null | Your CrowdStrike domain. | api.crowdstrike.com |
clientID | String | Yes | null | The CrowdStrike Client ID you want to use to authenticate collection requests. | |
secretKey | String | Yes | null | The CrowdStrike API key you want to use to authenticate collection requests. |
JSON example
{
"api.version":"v1",
"source":{
"schemaRef":{
"type":"CrowdStrike"
},
"config":{
"name":"CrowdStrike",
"description":"East field",
"domain":"api.crowdstrike.com",
"secretKey":"********",
"clientID":"123",
"fields":{
"_siemForward":false
},
"category":"eastTeam"
},
"sourceType":"Universal"
}
}
Terraform example
resource "sumologic_cloud_to_cloud_source" "crowdstrike_source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "CrowdStrike"
}
config = jsonencode({
"name":"CrowdStrike",
"description":"East field",
"domain":"api.crowdstrike.com",
"secretKey":"********",
"clientID":"123",
"fields":{
"_siemForward":false
},
"category":"eastTeam"
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}
FAQ
Click here for more information about Cloud-to-Cloud sources.