-
Notifications
You must be signed in to change notification settings - Fork 228
Digital Guardian Source doc #4619
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
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
acf53fb
Digital Guardian Source doc
JV0812 00c2f79
Update cid-redirects.json
JV0812 d081042
Update example.json
kimsauce 772a13c
Update example.json
kimsauce e9d5a9e
swap logo with trademarked version
kimsauce 0eb9daf
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
kimsauce 713c23c
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 129ca89
Beta tag removed
JV0812 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
109 changes: 109 additions & 0 deletions
109
...sted-collectors/cloud-to-cloud-integration-framework/digital-guardian-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,109 @@ | ||
| --- | ||
| id: digital-guardian-source | ||
| title: Digital Guardian Source | ||
| sidebar_label: Digital Guardian | ||
| tags: | ||
| - cloud-to-cloud | ||
| - digital-guardian | ||
| description: The Digital Guardian Source provides a secure endpoint to receive authentication logs from the Cybereason Malops API. | ||
| --- | ||
| import CodeBlock from '@theme/CodeBlock'; | ||
| import ExampleJSON from '/files/c2c/digital-guardian/example.json'; | ||
| import MyComponentSource from '!!raw-loader!/files/c2c/digital-guardian/example.json'; | ||
| import TerraformExample from '!!raw-loader!/files/c2c/digital-guardian/example.tf'; | ||
| import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| <p><a href="/docs/beta"><span className="beta">Beta</span></a></p> | ||
|
|
||
| <img src={useBaseUrl('img/send-data/digital-guardian-logo.png')} alt="icon" width="70"/> | ||
|
|
||
| Digital Guardian is a data protection platform that discovers, classifies, and controls data movement across endpoints, networks, and the cloud. Digital Guardian Analytics and Reporting Cloud (DG ARC) is an advanced analytics, workflow, and reporting cloud service that delivers no-compromise data protection. | ||
|
|
||
| The Digital Guardian integration ingest the export data using the [Export API](https://accessgw.msp.digitalguardian.com/rest/1.0/export_profiles/{Export_Profile}/export) and uses [Acknowledge API](https://accessgw.msp.digitalguardian.com/rest/1.0/export_profiles/{Export_Profile}/acknowledge) to advance the bookmark value to obtain the next chunk of data from export endpoint. | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data | | ||
| | :--- | :--- | | ||
| | 5 min | Export data | | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Vendor configuration | ||
|
|
||
| The Digital Guardian source requires you to provide the Digital Guardian Base URL (API Gateway URL), Authentication Server URL, Client ID, Client Secret, and Profile to export to configure the source. Follow the below steps to generate the required values: | ||
|
|
||
| 1. From the ARC Tenant Settings, copy and save the **Tenant ID (API Client ID)** and **Authentication Token (API Secret)**. | ||
| 1. From the Digital Guardian Management Console (DGMC), copy the **Access Gateway Base URL (API Gateway URL)** and **Authorization server URL**. | ||
| 1. To copy ARC **Export Profile ID**: | ||
| 1. Navigate to **Admin** > **reports** > **export profiles**. | ||
| 1. Copy only the GUID part from the export profile. | ||
|
|
||
| ### Source configuration | ||
|
|
||
| When you create a Digital Guardian 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 Digital Guardian 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 Collectors page, click **Add Source** next to a Hosted Collector. | ||
| 1. Search for and select the **Digital Guardian** icon. | ||
| 1. Enter a **Name** to display for the Source in Sumo Logic. 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 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. | ||
| 1. In **API Gateway URL**, enter the API Gateway URL of your account. | ||
| 1. In **Authorization Server URL**, enter the Authorization Server URL of your account. | ||
| 1. In **API Client ID**, enter the API Client ID you generated from the Digital Guardian platform. | ||
| 1. In **API Secret**, enter the API Secret you generated from the Digital Guardian platform. | ||
| 1. In **Export Profile**, enter the name of the profile that needs to be exported. | ||
| 1. The **Polling Interval** is set for 5 minutes hours by default. You can adjust it based on your needs. | ||
| 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":"Digital Guardian"}` | 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"}` | | ||
| | APIGatewayURL | String | Yes | `null` | API Gateway URL of your account. | | | ||
| | authServerURL | String | Yes | `null` | Authorization Server URL of your account. | | | ||
| | clientID | String | Yes | `null` | API Access ID of your account. | | | ||
| | clientSecret | String | Yes | `null` | API Secret of your account. | | | ||
| | exportProfile | String | Yes | `null` | Profile to be exported. | | | ||
| | pollingIntervalMin | Integer | Yes | 5 mins | Set to true to duplicate logs for each element in the users array. | | | ||
|
|
||
| ### JSON example | ||
|
|
||
| <CodeBlock language="json">{MyComponentSource}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/digital-guardian/example.json" target="_blank">Download example</a> | ||
|
|
||
| ### Terraform example | ||
|
|
||
| <CodeBlock language="json">{TerraformExample}</CodeBlock> | ||
|
|
||
| <a href="/files/c2c/digital-guardian/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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "API.version": "v1", | ||
| "source": { | ||
| "config": { | ||
| "name": "DG ARC", | ||
| "clientID": "hduj34-nduy73h-sdfnuw3r", | ||
| "clientSecret": "sadadsfsfsdf", | ||
| "APIGatewayURL": "https://accessgw.XYZ.digitalguardian.com", | ||
| "authServerURL": "https://authsrv.XYZ.digitalguardian.com", | ||
| "exportProfile": "profile", | ||
| "pollingIntervalMin": 5 | ||
| }, | ||
| "schemaRef": { | ||
| "type": "Digital Guardian ARC" | ||
| }, | ||
| "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,19 @@ | ||
| resource "sumologic_cloud_to_cloud_source" "digital-guardian-source" { | ||
| collector_id = sumologic_collector.collector.id | ||
| schema_ref = { | ||
| type = "Digital Guardian" | ||
| } | ||
| config = jsonencode({ | ||
| "name": "DG ARC", | ||
| "clientID": "hduj34-nduy73h-sdfnuw3r", | ||
| "clientSecret": "sadadsfsfsdf", | ||
| "APIGatewayURL": "https://accessgw.XYZ.digitalguardian.com", | ||
| "authServerURL": "https://authsrv.XYZ.digitalguardian.com", | ||
| "exportProfile": "profile", | ||
| "pollingIntervalMin": 5 | ||
| }) | ||
| } | ||
| 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.
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.