-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[DOCS-9953] Add Cloud SIEM Threat Intelligence doc #28716
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 all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
0561924
add doc
maycmlee e7e5ab9
add section
maycmlee 59a4fc4
add nav item
maycmlee 6265364
updates
maycmlee 8987356
Apply suggestions from code review
maycmlee b0fb9b0
add link to doc
maycmlee e2f49dc
Merge branch 'master' into may/cloud-siem-threat-intel
maycmlee 0ce8d02
apply suggestions
maycmlee c0dc584
fix typo
maycmlee 3553797
Apply suggestions from code review
maycmlee dc67eab
Update content/en/security/cloud_siem/threat_intelligence.md
maycmlee 4b38d88
Merge branch 'master' into may/cloud-siem-threat-intel
maycmlee 3432f8e
remove domain
maycmlee 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
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,102 @@ | ||
| --- | ||
| title: Threat Intelligence | ||
| disable_toc: false | ||
| further_reading: | ||
| - link: "security/cloud_siem/detection_rules" | ||
| tag: "Documentation" | ||
| text: "Create custom detection rules" | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Datadog provides built-in [threat intelligence][1] for Cloud SIEM logs. This article explains how to extend that functionality by enriching logs with your own custom threat intelligence feeds. | ||
|
|
||
| ## Bring your own threat intelligence | ||
|
|
||
| Cloud SIEM supports enriching and searching logs using threat intelligence indicators of compromise (IOCs) stored in Datadog reference tables. [Reference Tables][7] allow you to combine metadata with information already in Datadog. | ||
|
|
||
| ### Storing indicators of compromise in reference tables | ||
|
|
||
| Threat intelligence is supported in the CSV format, and requires a table for each Indicator type (for example, IP address) and requires the following columns: | ||
|
|
||
| #### CSV structure for IP address | ||
|
|
||
| | Field | Data | Description | Required | Example | | ||
| |-------------------|-------|-------------------------------------------------------------------------------------------------|----------|----------------------------------| | ||
| | ip_address | text | The primary key for the reference table in the IPv4 dot notation format. | true | 192.0.2.1 | | ||
| | additional_data | json | Additional data to enrich the logs. | false | `{"ref":"hxxp://example.org"}` | | ||
| | category | text | The threat intel [category][8]. This is used by some out-of-the-box detection rules. | true | Malware | | ||
| | intention | text | The threat intel [intent][9]. This is used by some out-of-the-box detection rules. | true | malicious | | ||
| | source | text | The name of the source and the link to its site, such as your team and your team's wiki. | true | `{"name":"internal_security_team", "url":"https://teamwiki.example.org"}` | | ||
|
|
||
| <div class="alert alert-info">JSON in a CSV requires double quoting. The following is an example CSV.</div> | ||
|
|
||
| ``` | ||
| ip_address,additional_data,category,intention,source | ||
| 192.0.2.1,"{""ref"":""hxxp://example.org""}",scanner,suspicious,"{""name"":""internal_security_team"", ""url"":""https://teamwiki.example.org""}" | ||
| 192.0.2.2,"{""ref"":""hxxp://example.org""}",scanner,suspicious,"{""name"":""internal_security_team"", ""url"":""https://teamwiki.example.org""}" | ||
| 192.0.2.3,"{""ref"":""hxxp://example.org""}",scanner,suspicious,"{""name"":""internal_security_team"", ""url"":""https://teamwiki.example.org""}" | ||
| ``` | ||
|
|
||
| ### Uploading and enabling your own threat intelligence | ||
|
|
||
| Datadog supports creating reference tables either by a manual upload or by periodically retrieving the data from Amazon S3, Azure storage, or Google Cloud storage. | ||
|
|
||
| **Notes**: | ||
| - It can take 10 to 30 minutes to start enriching Logs after creating a table. | ||
| - If a primary key is duplicated, it is skipped and an error message about the key is displayed. | ||
|
|
||
| On a new [reference table][2] page: | ||
|
|
||
| 1. Name the table. The table name is referenced in the Threat Intelligence setting. | ||
| 1. Upload a local CSV or import a CSV from a cloud storage bucket. The file is normalized and validated. | ||
| 1. Preview the table schema and choose the IOC column as the Primary Key. | ||
| 1. Save the table. | ||
| 1. In [Threat Intel][3], locate the new table and toggle it on to enable it. | ||
|
|
||
| #### Using cloud storage | ||
|
|
||
| When the reference table is created from cloud storage, it is refreshed periodically. The entire table is replaced. Data is not merged. | ||
|
|
||
| See the related reference table documentation for: | ||
|
|
||
| - [Amazon S3][4] | ||
| - [Azure storage][5] | ||
| - [Google Cloud storage][6] | ||
|
|
||
| #### Troubleshooting cloud imports | ||
maycmlee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If a reference table is not refreshing, open the reference table's settings menu and select **View Change Events**. | ||
|
|
||
| **View Change Events** opens a page in **Event Management** showing potential error events for the ingestion. You can also filter in **Event Management** using the reference table name. | ||
|
|
||
| In Datadog Event Management, it may appear that data has been fetched from the cloud, but it can take a few additional minutes for those changes to propagate to Threat Intelligence. Other useful cloud import details to remember: | ||
|
|
||
| - The expected latency before updated enrichments are available when a source is uploaded or updated is 10 to 30 minutes. | ||
| - How to know when the updates are applied: The changes are visible in the reference table or in the logs. Select the **View Change Events** link from settings on the reference table detail page to see the related events. | ||
| - The update replaces the entire table with the new data. | ||
| In case of a duplicated primary key, the rows with the duplicated key are not written, and an error is shown in the reference table detail page. | ||
|
|
||
| ## Threat intelligence in the user interface | ||
|
|
||
| To enable Cloud SIEM threat intelligence data for reference tables: | ||
| 1. Navigate to [Threat Intelligence][3]. | ||
| 1. For the table you want to see Cloud SIEM threat intelligence data, click the dropdown menu in the **Enabled** column and select Cloud SIEM. | ||
|
|
||
| After applying a reference table to Cloud SIEM, all incoming logs are evaluated against the table using a specific Indicator of Compromise (IoC) key, such as an IP address. If a match is found, the log is enriched with relevant Threat Intelligence (TI) attributes from the table, which enhances detection, investigation, and response. | ||
|
|
||
| A threat intelligence reference table can be shared across multiple security products. | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: /security/threat_intelligence/#threat-intelligence-sources | ||
| [2]: https://app.datadoghq.com/reference-tables/create | ||
| [3]: https://app.datadoghq.com/security/configuration/threat-intel | ||
| [4]: /reference_tables/?tab=amazons3#create-a-reference-table | ||
| [5]: /reference_tables/?tab=azurestorage#create-a-reference-table | ||
| [6]: /reference_tables/?tab=googlecloudstorage#create-a-reference-table | ||
| [7]: /reference_tables/ | ||
| [8]: /security/threat_intelligence/#threat-intelligence-categories | ||
| [9]: /security/threat_intelligence/#threat-intelligence-intents | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.