CrowdStrike FileVantage Source

The CrowdStrike FileVantage source will collect CrowdStrike FileVantage logs by querying the API for file changes resource IDs. It will then make another API call using those resource IDs to obtain the file changelogs and ingest them into Sumo Logic.

info

The CrowdStrike API documentation is not public and can only be accessed by partners or customers.

note

This source is available in all deployments, including the Fed deployment.

Data collected

Polling Interval	Data
15 minutes	highVolumeQueryChanges Endpoint - Retrieves log resource IDs
15 minutes	getChanges Endpoint - Retrieves file changelogs from resource IDs from previous endpoint

Setup

Vendor configuration

Prerequisites

To collect file integrity monitoring data from the CrowdStrike platform, you must have an authorized CrowdStrike account. CrowdStrike APIs use an OAuth 2.0 authorization token to make authorized API calls. The CrowdStrike API client is required to get the OAuth 2.0 authorization token. To define a CrowdStrike API client, you must be designated as a CrowdStrike Falcon Administrator role.

In this configuration, you will set up the CrowdStrike FileVantage and configure it to be authorized and authenticated to collect logs from the FileVantage API. To obtain the auth token, you will need the following parameters.

API Client and API Secret

The API security token is used to authenticate with CrowdStrike FileVantage API. After successfully creating the API client, you will get the Client Id, Client Secret, and Base URL.

To get the CrowdStrike API Client, follow the steps below:

1. Access the CrowdStrike Platform.
2. Sign in using your email address and password. After you've completed the two-factor authentication, you'll be directed to the application dashboard.
3. From the CrowdStrike console, select the Support and resources option from the menu.
4. In the Resources and tools section, select the API clients and keys option. You can then view existing clients or add new API clients from there.
5. Click Add new API client. You will be prompted to give a descriptive name and select the appropriate API scopes.
6. Provide a proper name and description and select the Falcon FileVantage:read scope. Click on ADD to complete the process.
7. After you click on ADD a dialogue box will appear with the Client ID, Client Secret and Base URL. Copy and save the Client Id, Client Secret and Base URL to a folder location because you will need them when creating the CrowdStrike FileVantage source.

Region

Identify your Region based on your Base URL. The region can be selected from the list below.

Region	Base URL
US-1	https://api.crowdstrike.com
US-2	https://api.us-2.crowdstrike.com
EU-1	https://api.eu-1.crowdstrike.com
US-GOV-1	https://api.laggar.gcw.crowdstrike.com

Source configuration

When you create a CrowdStrike FileVantage 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 the CrowdStrike FileVantage Source:

1. In Sumo Logic, select Manage Data > Collection > Collection. 
2. On the Collectors page, click Add Source next to a Hosted Collector.
3. Search for and select CrowdStrike FileVantage icon.
4. Enter a Name to display for the Source in the Sumo Logic web application. 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 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 Logic that does not exist in the Fields schema it is ignored, known as dropped.
7. In CrowdStrike Base URL, choose the region as per your Base URL. See Region section to know your region.
8. In API Client ID, enter the Client ID you generated and secured from the API Client section.
9. In API Client Secret, enter the Client Secret you generated and secured from the API Secret section.
10. (Optional) The Polling Interval is set for 15 minutes default, you can adjust it based on your needs.
11. When you are finished configuring the Source, click Save.

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 FileVantage"}	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"}
base_url	String	Yes	null	The API base url for the region of your CrowdStrike account.
client_id	String	Yes	null	The CrowdStrike Client ID you want to use to authenticate collection requests.
client_secret	String	Yes	null	The CrowdStrike Client Secret you want to use to authenticate collection requests.
pollingInterval	String	No	15m	This sets how often the Source checks for data.

JSON example

{
    "api.version":"v1",
    "source":{
      "config":{
        "name": "CrowdStrike FileVantage Source",
        "base_url": "https://api.crowdstrike.com",
        "client_id": "********",
        "client_secret": "********",
        "polling_interval": "15m"
      },
      "schemaRef":{
        "type":"CrowdStrike FileVantage"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "crowdstrike-filevantage_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "CrowdStrike FileVantage"
  }
  config = jsonencode({
      "name":"CrowdStrike FileVantage Source",
      "base_url":"https://api.crowdstrike.com",
      "client_id":"********",
      "client_secret":"********",        
      "polling_interval":"15m",
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example