-
Notifications
You must be signed in to change notification settings - Fork 228
Dragos C2C (Source) #4873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Dragos C2C (Source) #4873
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
fe79b55
Dragos C2C (Source)
amee-sumo 58ffc42
spell check
amee-sumo 70fdc07
minor updates on file size
amee-sumo 5ed0ddd
Changed release note date to Dec 13 2024
jpipkin1 4b3744c
Update docs/integrations/product-list/product-list-a-l.md
amee-sumo a0b6713
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo e54b7ac
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo b87ccde
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 18b9ad0
Create 2024-12-16-collection.md
amee-sumo 931441b
Delete 2024-12-13-collection.md
amee-sumo 19f9fe8
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo db5d44d
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo d97482d
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo f044f03
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 85d06b6
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 3eb1a50
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 0ae2050
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo d647fd6
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo bbd208a
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 5ca856e
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo 5205d45
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
amee-sumo b71461e
Update sidebars.ts
amee-sumo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: Dragos C2C Source (Collection) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - collection | ||
| - dragos-source | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a> | ||
|
|
||
| We're excited to announce the release of our new cloud-to-cloud source for Dragos. This source helps you to collect address, asset, vulnerability, and zone details from the Dragos API and ingest them into Sumo Logic for streamlined analysis. [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dragos-source). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 119 additions & 0 deletions
119
...nd-data/hosted-collectors/cloud-to-cloud-integration-framework/dragos-source.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| --- | ||
| id: dragos-source | ||
| title: Dragos Source | ||
| sidebar_label: Dragos | ||
| tags: | ||
| - Dragos | ||
| description: Collect address, asset, vulnerability, and zone details from the Dragos API and send them to Sumo Logic. | ||
| --- | ||
| import CodeBlock from '@theme/CodeBlock'; | ||
| import ExampleJSON from '/files/c2c/dragos/example.json'; | ||
| import MyComponentSource from '!!raw-loader!/files/c2c/dragos/example.json'; | ||
| import TerraformExample from '!!raw-loader!/files/c2c/dragos/example.tf'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <img src={useBaseUrl('img/send-data/dragos-logo.png')} alt="dragos-logo" width="50" /> | ||
|
|
||
| Dragos is a cybersecurity platform with an ecosystem tailored for industrial environments, including Industrial Control Systems (ICS), Supervisory Control and Data Acquisition (SCADA), Distributed Control System (DCS), and Operational Technology (OT) environments. | ||
| Dragos's Operational Technology (OT) offers clear visibility into your Industrial Control System (ICS) assets and communications. It monitors networks, detects threats, and addresses vulnerabilities without causing disruptions or shutdowns, helping you respond confidently to potential threats. | ||
|
|
||
| The Dragos source collects address, asset, vulnerability, and zone details from the Dragos API and sends it to Sumo Logic for streamlined analysis. | ||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 5 minutes | Vulnerability | | ||
| | 24 hours | Addresses | | ||
| | 24 hours | Zones | | ||
| | 24 hours | Assets | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| The Dragos source supports API token-based authentication and requires you to provide the **Endpoint URL**, **API ID**, and **API Secret** to access the data. | ||
|
|
||
| #### Endpoint URL | ||
|
|
||
| You can use the Hostname to create the Endpoint URL. For example, `https://<hostname>/`. | ||
|
|
||
| #### API ID and API Secret | ||
|
|
||
| Follow the instructions below to generate the API ID and API Secret: | ||
|
|
||
| 1. Sign in to the Dragos platform. | ||
| 1. Navigate to the **Admin** > **User**. | ||
| 1. Click **ADD NEW API KEY** under the **API Keys** section. | ||
| 1. Enter the name of the API Key in the **Name** field and then click **GENERATE KEY**. | ||
| 1. Copy the **API ID** and **API Secret**. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create a Dragos 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](/docs/send-data/hosted-collectors/configure-hosted-collector). | ||
|
|
||
| To configure a Dragos Source: | ||
| 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-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**. | ||
| 1. On the Collection page, click **Add Source** next to a Hosted Collector. | ||
| 1. Search for and select **Dragos**. | ||
| 1. Enter a **Name** for the Source. The description is optional. | ||
| 1. (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`. | ||
| 1. (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 is ignored, known as dropped. | ||
| 1. **Endpoint URL**. Enter the Dragos platform endpoint URL. For example, `https://test.cxc.dragos.cloud/`. | ||
| 1. **API ID**. Enter the API ID of your account collected from the [Dragos platform](#vendor-configuration). For example, `036fxxxx-b642-xxxx-99d3-fcxxxx2exxxx`. | ||
| 1. **API Secret**. Enter the API Secret of your account collected from the [Dragos platform](#vendor-configuration).. For example, `xxxU1TxxxxxxxxKSJwHYOpK37xxxxxxxxrEHAkU91xxxxxxxxxFrrJ06xxx`. | ||
| 1. Select the checkbox depending on the type of data that you wish to collect. | ||
| 1. (Optional) **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in the [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). | ||
| 1. 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 [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. | ||
|
|
||
| | Parameter | Type | Value | Required | Description | | ||
| |:--|:--|:--|:--|:--| | ||
| | schemaRef | JSON Object | `{"type":"Dragos"}` | Yes | Define the specific schema type. | | ||
| | sourceType | String | `"Universal"` | Yes | Type of source. | | ||
| | config | JSON Object | [Configuration 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](/docs/search/get-started-with-search/search-basics/built-in-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](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/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"}` | | ||
| | requestEndpoint | String | Yes | `null` | The API URL to fetch the data from the Dragos log source. | `https://sumologic-dragos.cxc.dragos.cloud/` | | ||
| | apiID | String | Yes | `null` | API ID of your account for authorization. | `036fxxxx-b642-xxxx-99d3-fcxxxx2exxxx` | | ||
| | apiSecret | String | Yes | `null` | API Secret of your account for authorization. | `xxxU1TxxxxxxxxKSJwHYOpK37xxxxxxxxrEHAkU91xxxxxxxxxFrrJ06xxx` | | ||
| | pollingIntervalVulnerabilityMin | String | Yes | `5 minutes` | Time interval (in minutes) after which the source will check for new data for API.<br/>**Default**: 5 minutess <br/>**Minimum**: 5 minutes<br/>**Maximum**: 60 minutes | | | ||
| | pollingIntervalAddressesHour | String | Yes | `24 hours` | Time interval (in hours) after which the source will check for new data for API.<br/>**Default**: 24 hours<br/>**Minimum**: 12 hours<br/>**Maximum**: 24 hours | | | ||
| | pollingIntervalZonesHour | String | Yes | `24 hours` | Time interval (in hours) after which the source will check for new data for API.<br/>**Default**: 24 hours<br/>**Minimum**: 12 hours<br/>**Maximum**: 24 hours | | | ||
| | pollingIntervalAssetsHour | String | Yes | `24 hours` | Time interval (in hours) after which the source will check for new data for API.<br/>**Default**: 24 hours<br/>**Minimum**: 12 hours<br/>**Maximum**: 24 hours | | | ||
| | collectAddressDetails | Boolean | No | `True` | Specify if you need to collect the address details. | | | ||
| | collectZoneDetails | Boolean | No | `True` | Specify if you need to collect the zone details. | | | ||
| | collectDeviceDetails | Boolean | No | `True` | Specify if you need to collect the assets details. | | | ||
| | collectVulnerabilityDetails | Boolean | No | `True` | Specify if you need to collect the vulnerability details. | | | ||
|
|
||
| ### JSON example | ||
|
|
||
| <CodeBlock language="json">{MyComponentSource}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/dragos/example.json" target="_blank">Download example</a> | ||
|
|
||
| ### Terraform example | ||
|
|
||
| <CodeBlock language="json">{TerraformExample}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/dragos/example.tf" target="_blank">Download example</a> | ||
|
|
||
| ## FAQ | ||
|
|
||
| :::info | ||
| Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. | ||
| ::: | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "API.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "Dragos", | ||
| "requestEndpoint": "https://sumologic-dragos.cxc.dragos.cloud/", | ||
| "apiID": "036fxxxx-b642-xxxx-99d3-fcxxxx2exxxx", | ||
| "apiSecret": "xxxU1TxxxxxxxxKSJwHYOpK37xxxxxxxxrEHAkU91xxxxxxxxxFrrJ06xxx", | ||
| "collectVulnerability": true, | ||
| "collectAddress": true, | ||
| "collectZone": false, | ||
| "collectAsset": false, | ||
| "pollingIntervalVulnerabilityMin": "24h", | ||
| "pollingIntervalAddressesHour": "5h" | ||
| }, | ||
| "schemaRef": { | ||
| "type": "Dragos" | ||
| }, | ||
| "sourceType": "Universal" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "dragos-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "Dragos" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "Dragos", | ||
| "requestEndpoint": "https://sumologic-dragos.cxc.dragos.cloud/", | ||
| "apiID": "036fxxxx-b642-xxxx-99d3-fcxxxx2exxxx", | ||
| "apiSecret": "xxxU1TxxxxxxxxKSJwHYOpK37xxxxxxxxrEHAkU91xxxxxxxxxFrrJ06xxx", | ||
| "collectVulnerability": true, | ||
| "collectAddress": true, | ||
| "collectZone": false, | ||
| "collectAsset": false, | ||
| "pollingIntervalVulnerabilityMin": "24h", | ||
| "pollingIntervalAddressesHour": "5h" | ||
| }) | ||
| } | ||
| resource "sumologic_collector" "collector" { | ||
| name = "my-collector" | ||
| description = "Just testing this" | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.