Coralogix
Fetch incidents, search for supporting data and tag interesting datapoints in/from your Coralogix account.
Data Enrichment & Threat Intelligence · Coralogix
Details
| ID | Coralogix |
|---|---|
| Provider | Coralogix |
| Category | Data Enrichment & Threat Intelligence |
| From Version | 5.0.0 |
| Docker Image | demisto/python3:3.12.8.3296088 |
| Supported Modules | Agentix XSIAM |
README
Overview
Use this integration to pull incidents and supporting information from your Coralogix account and tag interesting points in time from Cortex XSOAR.
Use Cases
- Configure your Coralogix account as a full fledged SIEM solution by using any of its available integrations and tools and streamline the process of security incident handling by using Cortex XSOAR’s playbooks to automatically pull the incidents from Coralogix and handle them by any of the other Cortex XSOAR integrations.
- Use supporting data from Coralogix while you prepare the security incident report directly from the war room in Cortex XSOAR.
- Automatically tag the timestamps in Coralogix at which point a security incident was detected by any of the other Cortex XSOAR integrations.
Configure Coralogix on Cortex XSOAR
- Navigate to Marketplace.
- Search for Coralogix.
- Click on Install on the top right corner and then on Install at the bottom right corner.
- Once it is installed, click on Settings > Integrations and then on Add instance on the right-hand side and fill in the following parameters:
| Parameter Name | Description | Required | Default Value |
|---|---|---|---|
| Fetches incidents | Whether or not to fetch incidents via this integration | No | Do not fetch |
| Coralogix WebAPI Endpoint URL | The Coralogix WebAPI URL | Yes (Don’t change it unless instructed to do so by Coralogix personnel) | https://webapi.coralogix.com |
| Private Key | Your Coralogix account private key | Yes | N/A |
| Application Name (for tags) | The Coralogix application name that will be assigned to the tags created by this instance | Yes | Cortex XSOAR |
| Subsystem Name (for tags) | The Coralogix subsystem name that will be assigned to the tags created by this instance | Yes | Cortex XSOAR |
| Coralogix ES-API Endpoint URL | The Coralogix ES-API URL | Yes | https://coralogix-esapi.coralogix.com:9443 |
| Basic incidents query | The Lucene query for fetching incidents. If not specified, will return Coralogix alerts that were sent to the Demisto webhook | No | N/A |
| Incidents Application Name | Limits the incidents query to only return incidents of a specific application name | No | N/A |
| Incidents Severity | Limits the incidents query to only return incidents of a specific severity | No | N/A |
| incidents Name Field | The Coralogix field value that should be used as the incident’s name. If not specified, the integration will use the “alert_name” field | No | N/A |
| Incidents first fetch days | The number of days to look back for incidents | No | 3 |
| Maximum number of incidents to fetch at a single call | Maximum number of incidents to retrieve at each call to Coralogix | No | 50 |
Commands
You can execute the following commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
coralogix-searchcoralogix-tag
1. coralogix-search
Returns logs from your Coralogix account according to the specified Lucene query
Base Command
coralogix-search
Input
| Argument Name | Description | Required | Default |
|---|---|---|---|
| query | The Lucene query to run | Yes | N/A |
| app_name | A Coralogix application name to filter results by | No | empty |
| subsystem_name | A Coralogix subsystem name to filte results by | No | empty |
| severity | A Coralogix severity name to filter results by | No | empty |
| since_timestamp | The timestamp in the format of YYYY-MM-DD (e.g 1978-03-31T23:59:59) from which you would like to start the search | No | empty |
| to_timestamp | The timestamp in the format of YYYY-MM-DD (e.g 1978-03-31T23:59:59) that will be the upper boundary of the search timespan | No | ‘now’ |
| max_items_to_retrieve | Maximum number of log entries to retrieve from Coralogix | No | 50 |
Command Examples
!coralogix-search query="security.rcode_name:\"NXDOMAIN\"" using="Coralogix_instance_1"
!coralogix-search query="security.rcode_name:\"NXDOMAIN\"" max_items_to_retrieve="100" since_timestamp="2020-12-31T23:59:59" using="Coralogix_instance_1"
Output
| coralogix.timestamp | coralogix.metadata.applicationName | coralogix.metadata.subsystemName | security.source_ip | security.destination_ip | security.event_type | security.source_port | security.destination_port | security.protocol | security.query | security.query_type_name | … |
|---|---|---|---|---|---|---|---|---|---|---|---|
| 2020-08-27T02:39:35.886Z | test-sta | test-sta | 172.31.7.153 | 172.31.0.2 | bro_dns | 33161 | 53 | udp | upload.wikimedia.org.ncsa.uiuc.edu | A | … |
| 2020-08-27T02:52:35.699Z | test-sta | test-sta | 172.31.7.153 | 172.31.0.2 | bro_dns | 44618 | 53 | udp | www.googgle.com | AAAA | … |
2. coralogix-tag
Allows you to tag an interesting point in time in Coralogix from Cortex XSOAR
Base Command
coralogix-tag
Input
| Argument Name | Description | Required | Default |
|---|---|---|---|
| name | The name of the tag that will be created in Coralogix | Yes | N/A |
| timestamp | The timestamp at which the tag will be created in Coralogix | No | Defaults to the current timestamp |
| icon_url | A URL to an icon file (JPG or PNG) that will be displayed as the tag at Coralogix. Can be up to 50KB in size | No | Defaults to a lightning icon |
Command Example
!coralogix-tag name="Data leak started"
Output
Tag added successfully
Configuration parameters
isFetch— Fetch incidentsincidentType— Incident typeincidentFetchInterval— Incidents Fetch Intervalwebapi_url— Coralogix WebAPI Endpoint URL (required)privatekey— Private Key (required)app_name— Application Name (for tags) (required)subsystem_name— Subsystem Name (for tags) (required)esapi_url— Coralogix ES-API Endpoint URL (required)incidents_query— Basic incidents queryincidents_application_name— Incidents Application Nameincidents_severity— Incidents Severityincident_description_field— Incidents Name Fieldincidents_subsystem_name— Incidents Subsystem Nameincidents_first_fetch_range— First fetch timestamp in daysincidents_max_fetch— Maximum number of incidents to fetch at a single call
Commands (2)
-
coralogix-searchQuery Coralogix for information.
-
coralogix-tagTag timestamp in Coralogix.
category: Data Enrichment & Threat Intelligence sectionorder: - Connect - Collect provider: Coralogix commonfields: id: Coralogix version: -1 configuration: - display: Fetch incidents name: isFetch type: 8 required: false section: Collect - display: Incident type name: incidentType type: 13 required: false section: Collect - display: Incidents Fetch Interval name: incidentFetchInterval defaultvalue: '1' required: false type: 19 advanced: true section: Collect - additionalinfo: The Coralogix WebAPI endpoint for your account - Do not modify unless instructed to by Coralogix Customer Success defaultvalue: https://webapi.coralogix.com display: Coralogix WebAPI Endpoint URL name: webapi_url required: true type: 0 section: Connect - additionalinfo: Your Coralogix account private key. Can be found in Coralogix under Settings > Send your logs display: Private Key name: privatekey required: true type: 4 section: Connect - additionalinfo: This is the Coralogix Application Name that will be used when creating tags in Coralogix by using the coralogix-tag command defaultvalue: Demisto display: Application Name (for tags) name: app_name required: true type: 0 section: Connect - additionalinfo: This is the Coralogix Subsystem Name that will be used when creating tags in Coralogix by using the coralogix-tag command defaultvalue: Demisto display: Subsystem Name (for tags) name: subsystem_name required: true type: 0 section: Connect - additionalinfo: The Coralogix ES-API endpoint for your account - Do not modify unless instructed to by Coralogix Customer Success defaultvalue: https://coralogix-esapi.coralogix.com:9443 display: Coralogix ES-API Endpoint URL name: esapi_url required: true type: 0 section: Connect - additionalinfo: Sets the query for retrieving incidents for Coralogix. If not set, the incidents fetch will retrieve all alerts that were sent to the Demisto/Cortex XSOAR webhook in Coralogix display: Basic incidents query name: incidents_query type: 0 required: false section: Collect - additionalinfo: Narrows the incidents search to a specific Application Name. If not set, the incidents fetch will retrieve all alerts that were sent to the Demisto/Cortex XSOAR webhook in Coralogix display: Incidents Application Name name: incidents_application_name type: 0 required: false section: Collect - additionalinfo: Narrow the incidents search to a specific severity level. If not set, the incidents fetch will retrieve all alerts that were sent to the Demisto/Cortex XSOAR webhook in Coralogix display: Incidents Severity name: incidents_severity type: 0 required: false section: Collect - additionalinfo: Sets the field in Coralogix response that will be used as the incident's name in Demisto/Cortex XSOAR. If not set will use the field 'alert_name' display: Incidents Name Field name: incident_description_field type: 0 required: false section: Collect - additionalinfo: Narrows the incidents search to a specific Subsystem Name. If not set, the incidents fetch will retrieve all alerts that were sent to the Demisto/Cortex XSOAR webhook in Coralogix display: Incidents Subsystem Name name: incidents_subsystem_name type: 0 required: false section: Collect - additionalinfo: Normally, when the Coralogix fetches incidents it will fetch incidents detected since the last time it fetched them. This value sets the time period (in days) to look for incidents on the first fetch. The default value is 3 days. This value cannot exceed the maximum allowed query range limit for the Coralogix account used. defaultvalue: '3' display: First fetch timestamp in days name: incidents_first_fetch_range type: 0 required: false section: Collect - additionalinfo: Maximum number of incidents to fetch at a single call to avoid overloading Cortex XSOAR defaultvalue: '50' display: Maximum number of incidents to fetch at a single call name: incidents_max_fetch type: 0 required: false section: Collect description: Fetch incidents, search for supporting data and tag interesting datapoints in/from your Coralogix account. display: Coralogix name: Coralogix script: commands: - arguments: - description: The name of the tag. name: name required: true - description: The point in time to tag in Coralogix. name: timestamp - description: A link to an icon file (png, jpeg, SVG) that will be used as the tag image in Coralogix. Cannot exceed 50KB. name: icon_url description: Tag timestamp in Coralogix. name: coralogix-tag - arguments: - description: A Coralogix Lucene query. name: query required: true - description: Narrows the search to the specified Coralogix Application name. name: app_name - description: Narrows the search to the specified Coralogix Subsystem name. name: subsystem_name - description: Narrows the search to the specified Coralogix severity value. name: severity - description: Limit the search to the data that arrived after a certain timestamp. If not set will search for all the data matching the query. name: since_timestamp - description: Limit the search to data that arrived until a certain timestamp.If not set will search for all the data matching the query. name: to_timestamp - defaultValue: '50' description: The maximum number of events to retrieve per query. name: max_items_to_retrieve required: true description: Query Coralogix for information. name: coralogix-search dockerimage: demisto/python3:3.12.8.3296088 isfetch: true runonce: false script: '-' subtype: python3 type: python fromversion: 5.0.0 tests: - No tests