Skip to content

Commit 4a2a726

Browse files
update bulk file for STIX objects
1 parent 6945594 commit 4a2a726

File tree

1 file changed

+88
-27
lines changed

1 file changed

+88
-27
lines changed

articles/sentinel/indicators-bulk-file-import.md

Lines changed: 88 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Add indicators in bulk to threat intelligence by file
2+
title: Add threat intelligence in bulk by file
33
titleSuffix: Microsoft Sentinel
4-
description: Learn how to bulk add indicators to threat intelligence from flat files like .csv or .json in Microsoft Sentinel.
4+
description: Learn how to add threat intelligence in bulk from flat files like .csv or .json into Microsoft Sentinel.
55
author: austinmccollum
66
ms.service: microsoft-sentinel
77
ms.topic: how-to
@@ -13,13 +13,13 @@ appliesto:
1313
ms.collection: usx-security
1414

1515

16-
#Customer intent: As a security analyst, I want to import threat indicators in bulk from CSV or JSON files so that I can quickly integrate and analyze emerging threats within my threat intelligence platform.
16+
#Customer intent: As a security analyst, I want to import threat intelligence in bulk from CSV or JSON files so that I can quickly integrate and analyze emerging threats within Microsoft Sentinel.
1717

1818
---
1919

20-
# Add indicators in bulk to Microsoft Sentinel threat intelligence from a CSV or JSON file
20+
# Add threat intelligence in bulk to Microsoft Sentinel from a CSV or JSON file
2121

22-
In this article, you add indicators from a CSV or JSON file into Microsoft Sentinel threat intelligence. Threat intelligence sharing still happens across emails and other informal channels during an ongoing investigation. You have the ability to import indicators directly into Microsoft Sentinel threat intelligence so that you can quickly relay emerging threats to your team. You make the threats available to power other analytics, such as producing security alerts, incidents, and automated responses.
22+
This article demonstrates how to add indicators from a CSV or STIX objects from a JSON file into Microsoft Sentinel threat intelligence. Because threat intelligence sharing still happens across emails and other informal channels during an ongoing investigation, the ability to import that information quickly into Microsoft Sentinel is important to relay emerging threats to your team. These identified threats are then available to power other analytics, such as producing security alerts, incidents, and automated responses.
2323

2424
> [!IMPORTANT]
2525
> This feature is currently in preview. See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for more legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
@@ -28,11 +28,11 @@ In this article, you add indicators from a CSV or JSON file into Microsoft Senti
2828
2929
## Prerequisites
3030

31-
You must have read and write permissions to the Microsoft Sentinel workspace to store your threat indicators.
31+
You must have read and write permissions to the Microsoft Sentinel workspace to store your threat intelligence.
3232

33-
## Select an import template for your indicators
33+
## Select an import template for your threat intelligence
3434

35-
Add multiple indicators to your threat intelligence with a specially crafted CSV or JSON file. Download the file templates to get familiar with the fields and how they map to the data you have. Review the required fields for each template type to validate your data before you import it.
35+
Add multiple threat intelligence objects with a specially crafted CSV or JSON file. Download the file templates to get familiar with the fields and how they map to the data you have. Review the required fields for each template type to validate your data before you import it.
3636

3737
1. For Microsoft Sentinel in the [Azure portal](https://portal.azure.com), under **Threat management**, select **Threat intelligence**.
3838

@@ -42,34 +42,39 @@ Add multiple indicators to your threat intelligence with a specially crafted CSV
4242

4343
#### [Azure portal](#tab/azure-portal)
4444

45-
:::image type="content" source="media/indicators-bulk-file-import/import-using-file-menu-fixed.png" alt-text="Screenshot that shows the menu options to import indicators by using a file menu." lightbox="media/indicators-bulk-file-import/import-using-file-menu-fixed.png":::
45+
:::image type="content" source="media/indicators-bulk-file-import/import-using-file-menu-fixed.png" alt-text="Screenshot that shows the menu options to import threat intelligence by using a file menu." lightbox="media/indicators-bulk-file-import/import-using-file-menu-fixed.png":::
4646

4747
#### [Defender portal](#tab/defender-portal)
48-
:::image type="content" source="media/indicators-bulk-file-import/import-using-file-menu-defender-portal.png" alt-text="Screenshot that shows the menu options to import indicators by using a file menu from the Defender portal." lightbox="media/indicators-bulk-file-import/import-using-file-menu-defender-portal.png":::
48+
:::image type="content" source="media/indicators-bulk-file-import/import-using-file-menu-defender-portal.png" alt-text="Screenshot that shows the menu options to import threat intelligence by using a file menu from the Defender portal." lightbox="media/indicators-bulk-file-import/import-using-file-menu-defender-portal.png":::
4949
---
5050

5151
1. On the **File format** dropdown menu, select **CSV** or **JSON**.
5252

5353
:::image type="content" source="media/indicators-bulk-file-import/format-select-and-download.png" alt-text="Screenshot that shows the dropdown menu to upload a CSV or JSON file, choose a template to download, and specify a source.":::
54+
55+
> [!NOTE]
56+
> The CSV template only supports indicators. The JSON template supports indicators and other STIX objects like threat actors, attack patterns, identities and relationships.
57+
> For more information about crafting supported STIX objects in JSON, see [STIX objects API reference](stix-objects-api.md).
58+
5459

5560
1. After you choose a bulk upload template, select the **Download template** link.
5661

57-
1. Consider grouping your indicators by source because each file upload requires one.
62+
1. Consider grouping your threat intelligence by source because each file upload requires one.
5863

59-
The templates provide all the fields you need to create a single valid indicator, including required fields and validation parameters. Replicate that structure to populate more indicators in one file. For more information on the templates, see [Understand the import templates](indicators-bulk-file-import.md#understand-the-import-templates).
64+
The templates provide all the fields you need to create a single valid indicator, including required fields and validation parameters. Replicate that structure to populate more indicators in one file, or add STIX objects to the JSON file. For more information on the templates, see [Understand the import templates](indicators-bulk-file-import.md#understand-the-import-templates).
6065

61-
## Upload the indicator file
66+
## Upload the threat intelligence file
6267

6368
1. Change the file name from the template default, but keep the file extension as .csv or .json. When you create a unique file name, it's easier to monitor your imports from the **Manage file imports** pane.
6469

65-
1. Drag your indicators file to the **Upload a file** section, or browse for the file by using the link.
70+
1. Drag your bulk threat intelligence file to the **Upload a file** section, or browse for the file by using the link.
6671

67-
1. Enter a source for the indicators in the **Source** text box. This value is stamped on all the indicators included in that file. View this property as the `SourceSystem` field. The source is also displayed in the **Manage file imports** pane. For more information, see [Work with threat indicators](work-with-threat-indicators.md#find-and-view-your-indicators-in-logs).
72+
1. Enter a source for the threat intelligence in the **Source** text box. This value is stamped on all the indicators included in that file. View this property as the `SourceSystem` field. The source is also displayed in the **Manage file imports** pane. For more information, see [Work with threat indicators](work-with-threat-indicators.md#find-and-view-your-indicators-in-logs).
6873

69-
1. Choose how you want Microsoft Sentinel to handle invalid indicator entries by selecting one of the buttons at the bottom of the **Import using a file** pane:
74+
1. Choose how you want Microsoft Sentinel to handle invalid entries by selecting one of the buttons at the bottom of the **Import using a file** pane:
7075

71-
- Import only the valid indicators and leave aside any invalid indicators from the file.
72-
- Don't import any indicators if a single indicator in the file is invalid.
76+
- Import only the valid entries and leave aside any invalid entries from the file.
77+
- Don't import any entries if a single object in the file is invalid.
7378

7479
:::image type="content" source="media/indicators-bulk-file-import/upload-file-pane.png" alt-text="Screenshot that shows the dropdown menu to upload a CSV or JSON file, choose a template, and specify a source highlighting the Import button.":::
7580

@@ -83,19 +88,19 @@ Monitor your imports and view error reports for partially imported or failed imp
8388

8489
:::image type="content" source="media/indicators-bulk-file-import/manage-file-imports.png" alt-text="Screenshot that shows the menu option to manage file imports.":::
8590

86-
1. Review the status of imported files and the number of invalid indicator entries. The valid indicator count is updated after the file is processed. Wait for the import to finish to get the updated count of valid indicators.
91+
1. Review the status of imported files and the number of invalid entries. The valid entry count is updated after the file is processed. Wait for the import to finish to get the updated count of valid entries.
8792

8893
:::image type="content" source="media/indicators-bulk-file-import/manage-file-imports-pane.png" alt-text="Screenshot that shows the Manage file imports pane with example ingestion data. The columns show sorted by imported number with various sources.":::
8994

90-
1. View and sort imports by selecting **Source**, the indicator file **Name**, the number **Imported**, the **Total** number of indicators in each file, or the **Created** date.
95+
1. View and sort imports by selecting **Source**, the threat intelligence file **Name**, the number **Imported**, the **Total** number of entries in each file, or the **Created** date.
9196

92-
1. Select the preview of the error file or download the error file that contains the errors about invalid indicators.
97+
1. Select the preview of the error file or download the error file that contains the errors about invalid entries.
9398

9499
Microsoft Sentinel maintains the status of the file import for 30 days. The actual file and the associated error file are maintained in the system for 24 hours. After 24 hours, the file and the error file are deleted, but any ingested indicators continue to show in threat intelligence.
95100

96101
## Understand the import templates
97102

98-
Review each template to ensure that your indicators are imported successfully. Be sure to reference the instructions in the template file and the following supplemental guidance.
103+
Review each template to ensure that your threat intelligence is imported successfully. Be sure to reference the instructions in the template file and the following supplemental guidance.
99104

100105
### CSV template structure
101106

@@ -120,17 +125,19 @@ Phishing,"demo, csv",MDTI article - Franken-Phish domainname,Entity appears in M
120125

121126
### JSON template structure
122127

123-
1. There's only one JSON template for all indicator types. The JSON template is based on the STIX 2.1 format.
128+
1. There's only one JSON template for all STIX object types. The JSON template is based on the STIX 2.1 format.
124129

125-
1. The `pattern` element supports indicator types of `file`, `ipv4-addr`, `ipv6-addr`, `domain-name`, `url`, `user-account`, `email-addr`, and `windows-registry-key`.
130+
1. The `type` element supports `indicator`, `attack-pattern`, `identity`, `threat-actor`, and `relationship`.
131+
132+
1. For indicators, the `pattern` element supports indicator types of `file`, `ipv4-addr`, `ipv6-addr`, `domain-name`, `url`, `user-account`, `email-addr`, and `windows-registry-key`.
126133

127134
1. Remove the template comments before upload.
128135

129-
1. Close the last indicator in the array by using the `}` without a comma.
136+
1. Close the last object in the array by using the `}` without a comma.
130137

131138
The maximum file size for a JSON file import is 250 MB.
132139

133-
Here's an example `ipv4-addr` indicator that uses the JSON template:
140+
Here's an example `ipv4-addr` indicator and `attack-pattern` using the JSON file format:
134141

135142
```json
136143
[
@@ -161,13 +168,67 @@ Here's an example `ipv4-addr` indicator that uses the JSON template:
161168
"external_references": [],
162169
"object_marking_refs": [],
163170
"granular_markings": []
171+
},
172+
{
173+
"type": "attack-pattern",
174+
"spec_version": "2.1",
175+
"id": "attack-pattern--fb6aa549-c94a-4e45-b4fd-7e32602dad85",
176+
"created": "2015-05-15T09:12:16.432Z",
177+
"modified": "2015-05-20T09:12:16.432Z",
178+
"created_by_ref": "identity--f431f809-377b-45e0-aa1c-6a4751cae5ff",
179+
"revoked": false,
180+
"labels": [
181+
"heartbleed",
182+
"has-logo"
183+
],
184+
"confidence": 55,
185+
"lang": "en",
186+
"object_marking_refs": [
187+
"marking-definition--34098fce-860f-48ae-8e50-ebd3cc5e41da"
188+
],
189+
"granular_markings": [
190+
{
191+
"marking_ref": "marking-definition--089a6ecb-cc15-43cc-9494-767639779123",
192+
"selectors": [
193+
"description",
194+
"labels"
195+
],
196+
"lang": "en"
197+
}
198+
],
199+
"extensions": {
200+
"extension-definition--d83fce45-ef58-4c6c-a3f4-1fbc32e98c6e": {
201+
"extension_type": "property-extension",
202+
"rank": 5,
203+
"toxicity": 8
204+
}
205+
},
206+
"external_references": [
207+
{
208+
"source_name": "capec",
209+
"description": "spear phishing",
210+
"external_id": "CAPEC-163"
211+
}
212+
],
213+
"name": "Attack Pattern 2.1",
214+
"description": "menuPass appears to favor spear phishing to deliver payloads to the intended targets. While the attackers behind menuPass have used other RATs in their campaign, it appears that they use PIVY as their primary persistence mechanism.",
215+
"kill_chain_phases": [
216+
{
217+
"kill_chain_name": "mandiant-attack-lifecycle-model",
218+
"phase_name": "initial-compromise"
219+
}
220+
],
221+
"aliases": [
222+
"alias_1",
223+
"alias_2"
224+
]
164225
}
165226
]
166227
```
167228

168229
## Related content
169230

170-
In this article, you learned how to manually bolster your threat intelligence by importing indicators gathered in flat files. To learn more about how indicators power other analytics in Microsoft Sentinel, see the following articles:
231+
In this article, you learned how to manually bolster your threat intelligence by importing indicators and other STIX objects gathered in flat files. To learn more about how threat intelligence powers other analytics in Microsoft Sentinel, see the following articles:
171232

172233
- [Work with threat indicators in Microsoft Sentinel](work-with-threat-indicators.md)
173234
- [Threat indicators for cyber threat intelligence in Microsoft Sentinel](/azure/architecture/example-scenario/data/sentinel-threat-intelligence)

0 commit comments

Comments
 (0)