This integration provides the following benefits:
- Validates that security tools are writing log events to Google Chronicle to ensure compliance with security policies and regulations
- Collects events generated by security tools that write to Google Chronicle to test the efficacy and configuration of security controls using Security Validation jobs
Use this document to configure the integration using one of the following methods:
- MSI (Supported and recommended for new integration configurations)
- Legacy (Supported for existing integration configurations)
Configure MSI integration
This document covers the the MSI method of creating an integration. This method is the recommended approach for configuring new integrations in Security Validation.
API calls
| API | Usage |
|---|---|
/v1alpha/{instance}/legacy:legacyFetchUdmSearchView |
UDM search that returns matching events and alerting detections from Google Chronicle |
Supported versions
Google Chronicle v1alpha
Before you begin
To configure this integration, you will need to provide the Auth Scopes when initializing your API client. Use the following scopes to initialize your Google API client:
https://www.googleapis.com/auth/cloud-platform
You may choose one of the following two authentication methods:
Direct service account authentication
You will need a Google Developer Cloud Service Account JSON key file. The service account must have the necessary permissions for the Chronicle APIs. This will be provided to you by your Google Security Operations representative.
Service account impersonation
Service account impersonation is the recommended way of integrating with Google Cloud, which allows one identity to assume the permissions of another service account without using its credentials.
For that, instead of giving permissions to the service account, a source service account is created which impersonates an existing IAM.
- Log into the Google Cloud Console
- Navigate to the IAM & Admin section, then navigate to Service Accounts.
- Click Create Service Account, fill in the form and grant the
Service Account Token Creatorrole. - Generate the JSON keys that will be used for authenticating
After these steps, you can add an existing target account for accessing the service.
Authorization scopes
Requires the cloud-platform OAuth scope.
IAM Permissions
Requires the following IAM permission on the instance resource:
chronicle.legacies.legacyFetchUdmSearchView
Configure Security Validation
- Go to Settings > Integrations.
- From the Integrations table, click Add Integration > Google Chronicle.
You can add this as either a Direct or Remote Integration.
- Enter a meaningful Integration Name.
- Optional: From the Proxy drop-down, choose a proxy profile if one is available. If one isn't available and all outbound connections go through a proxy, first, set up a Proxy Rule.
- Optional: Change the HttpProtocols value to determine what protocol is used for requests (Http or Https).
- Enter the Host value for the Google Chronicle Backstory instance as a hostname or IP address. The default is chronicle.us.rep.googleapis.com.
- Enter a Port value. The default is 443.
- For the Project Id, enter the unique identifier for your Google Cloud project.
- For the Location, enter the geographical region in Google Cloud where your Chronicle instance is located (for example, us-central1 or europe-west1).
- For the Instance Id, enter the specific identifier for your Chronicle instance.
- Enter the Service Account Info, which is the contents of the Google Developer Service Account Credential and API Scope JSON file. The value for this field must be valid JSON.
Alternatively, you can click Browse and select the JSON file.
- Enter the Impersonated Service Account Email, which is the email of the Service Account that has the correct permissions to access the service.
- Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 seconds.
- Optional: Add or remove Queries, as needed. Default values are provided for IP Query, Hostname Query, Domain Query, and Email Query.
- Optional: Change the Max Results value, if needed. This value is the maximum number of results that are returned for each query. The default is 1000.
- Optional: Modify the FieldMapModel values, as necessary.
- Each field map box can hold a JSON-formatted comma-separated list of columns returned by the API to be considered for each field when translating into the normalized event object format. Example: description could be configured to be 'msg_s' or 'SyslogMessage' in some environments. The field map tries both if set to: ['msg_s','SyslogMessage'] and whichever matches first is the column that is used.
- When configuring an integration in Security Validation, you can assign additional host values in the Field Map settings. If none of the assigned fields return a valid host name, Network Actions may miss matched events from the third-party technology. Additional hosts values helps ensure the likelihood of a match between the two environments.
- Optional: If necessary, configure Alert Fields Map values.
-
Optional: Expand Advanced options and update the information as necessary.
- Update Query Time and Delay Time.The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.
- Update Query Interval (seconds).
- If supported by your integration, configure correlation queries:
- Select Correlation Query Enabled and fill in the Correlation Query.
- Modify the Correlation Query Interval, if necessary (minutes).
- Select
Discover network devices automatically, the default and recommended option.If unselected, reported events won't include product information for any matching network security technology.
- Select Save Suspicious Events.
- Modify the Event Time Adjustment (seconds). The default is 0.
Modify the Limit value if you need to prevent a flood of results. This value is set to 10000 by default. This limit applies to both events and alerts individually, so if you set it to 10, you can still see a maximum of 10 events and 10 alerts.
- Update Query Time and Delay Time.
-
Click Save.
Verify connectivity
- Go to Settings > Integrations.
- From the Direct Integrations table, click
> Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.
For more information on setting up queries, see Manage Integrations.
Configure Legacy integration
This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
Update Backstory
Identify or create credentials to access Chronicle Backstory with read access, at minimum.
API Calls
The following API calls are used by the Validation Platform.
|
Purpose |
Call |
|---|---|
| To get all events associated | backstory.googleapis.com/v1/asset/listevents |
Update the Validation Platform
Prerequisites
Information to gather before you start:
- Identify the ProjectID associated with your Chronicle Backstory account
- In Chronicle Backstory, download your Service Account JSON file
Configuration
To add the Chronicle Backstory integration
-
Go to Settings > Integrations.
- Click Add Integration > Integration.
- Enter the Project ID from Chronicle Backstory.
- Upload your Chronicle Backstory Service Account JSON file.
-
Expand Advanced options and update the information if necessary.
-
(Optional) Assign a Name.
-
(Optional) Choose Yes to save suspicious events.
-
Click Submit.
Set up Proxy Assignment
If all outbound connections go through a proxy, you may want to set up a proxy definition and assignment for your integration. For information on setting up your proxy rules, see Proxy Rules.
Verify connectivity
To verify connectivity to Chronicle Backstory
Click Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.