Skip to content

Commit 1446645

Browse files
authored
Merge pull request #997 from splunk/update_readme
Update readme
2 parents 3002c8c + ab46ae4 commit 1446645

File tree

1 file changed

+26
-50
lines changed

1 file changed

+26
-50
lines changed

README.md

Lines changed: 26 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -45,51 +45,35 @@ git lfs pull --include=datasets/attack_techniques/T1003.001/atomic_red_team/wind
4545

4646
# Anatomy of a Dataset 🧬
4747
### Datasets
48-
Datasets are defined by a common YML structure. The structure has the following fields:
49-
50-
|field| description|
51-
|---|---|
52-
| id | UUID of dataset |
53-
|name | name of author |
54-
| date | last modified date |
55-
| dataset | array of URLs where the hosted version of the dataset is located |
56-
| description | describes the dataset as detailed as possible |
57-
| environment | markdown filename of the environment description see below |
58-
| technique | array of MITRE ATT&CK techniques associated with dataset |
59-
| references | array of URLs that reference the dataset |
60-
| sourcetypes | array of sourcetypes that are contained in the dataset |
61-
62-
63-
For example
64-
48+
example:
6549
```
66-
id: 405d5889-16c7-42e3-8865-1485d7a5b2b6
6750
author: Patrick Bareiss
51+
id: cc9b25e1-efc9-11eb-926b-550bf0943fbb
6852
date: '2020-10-08'
69-
description: 'Atomic Test Results: Successful Execution of test T1003.001-1 Windows
70-
Credential Editor Successful Execution of test T1003.001-2 Dump LSASS.exe Memory
71-
using ProcDump Return value unclear for test T1003.001-3 Dump LSASS.exe Memory using
72-
comsvcs.dll Successful Execution of test T1003.001-4 Dump LSASS.exe Memory using
73-
direct system calls and API unhooking Return value unclear for test T1003.001-6
74-
Offline Credential Theft With Mimikatz Return value unclear for test T1003.001-7
75-
LSASS read with pypykatz '
53+
description: 'Atomic Test Results: Successful Execution of test T1003.003-1 Create
54+
Volume Shadow Copy with NTDS.dit Successful Execution of test T1003.003-2 Copy NTDS.dit
55+
from Volume Shadow Copy Successful Execution of test T1003.003-3 Dump Active Directory
56+
Database with NTDSUtil Successful Execution of test T1003.003-4 Create Volume Shadow
57+
Copy with WMI Return value unclear for test T1003.003-5 Create Volume Shadow Copy
58+
with Powershell Successful Execution of test T1003.003-6 Create Symlink to Volume
59+
Shadow Copy '
7660
environment: attack_range
77-
technique:
78-
- T1003.001
79-
dataset:
80-
- https://media.githubusercontent.com/media/splunk/attack_data/master/datasets/attack_techniques/T1003.001/atomic_red_team/windows-powershell.log
81-
- https://media.githubusercontent.com/media/splunk/attack_data/master/datasets/attack_techniques/T1003.001/atomic_red_team/windows-security.log
82-
- https://media.githubusercontent.com/media/splunk/attack_data/master/datasets/attack_techniques/T1003.001/atomic_red_team/windows-sysmon.log
83-
- https://media.githubusercontent.com/media/splunk/attack_data/master/datasets/attack_techniques/T1003.001/atomic_red_team/windows-system.log
84-
references:
85-
- https://attack.mitre.org/techniques/T1003/001/
86-
- https://github.com/redcanaryco/atomic-red-team/blob/master/atomics/T1003.001/T1003.001.md
87-
- https://github.com/splunk/security-content/blob/develop/tests/T1003_001.yml
88-
sourcetypes:
89-
- XmlWinEventLog:Microsoft-Windows-Sysmon/Operational
90-
- WinEventLog:Microsoft-Windows-PowerShell/Operational
91-
- WinEventLog:System
92-
- WinEventLog:Security
61+
directory: atomic_red_team
62+
mitre_technique:
63+
- T1003.003
64+
datasets:
65+
- name: crowdstrike_falcon
66+
path: /datasets/attack_techniques/T1003.003/atomic_red_team/crowdstrike_falcon.log
67+
sourcetype: crowdstrike:events:sensor
68+
source: crowdstrike
69+
- name: 4688_windows-security
70+
path: /datasets/attack_techniques/T1003.003/atomic_red_team/4688_windows-security.log
71+
sourcetype: XmlWinEventLog
72+
source: XmlWinEventLog:Security
73+
- name: windows-sysmon
74+
path: /datasets/attack_techniques/T1003.003/atomic_red_team/windows-sysmon.log
75+
sourcetype: XmlWinEventLog
76+
source: XmlWinEventLog:Microsoft-Windows-Sysmon/Operational
9377
```
9478

9579

@@ -129,14 +113,6 @@ pip install -r bin/requirements.txt
129113

130114
See a quick demo 📺 of this process [here](https://www.youtube.com/watch?v=41NAG0zGg40).
131115

132-
### Into DSP
133-
134-
To send datasets into DSP the simplest way is to use the [scloud](https://docs.splunk.com/Documentation/DSP/1.1.0/Admin/AuthenticatewithSCloud) command-line-tool as a requirement.
135-
136-
1. Download the dataset
137-
2. Ingest the dataset into DSP via scloud command `cat attack_data.json | scloud ingest post-events --format JSON
138-
3. Build a pipeline that reads from the firehose and you should see the events.
139-
140116
# Contribute Datasets 🥰
141117

142118
1. Generate a dataset
@@ -162,7 +138,7 @@ This project takes advantage of automation to generate datasets using the attack
162138

163139
## License
164140

165-
Copyright 2023 Splunk Inc.
141+
Copyright 2025 Splunk Inc.
166142

167143
Licensed under the Apache License, Version 2.0 (the "License");
168144
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)