README.md

obsidian-mitre-attack

This is a modified and extended version of the original version that can be found here vincenzocaputo/obsidian-mitre-attack. Some functions have been removed (create canvas) and some have been added such as always generating the full MITRE ATT&CK (enterprise-attack, ics-attack and mobile-attack) as well as adding some missing parts for the original repository.

Python code is used to parse the MITRE ATT&CK knowledge base into Markdown format, making it readable and browsable using the Obsidian note-taking application. MITRE ATT&CK data is retrieved from the MITRE GitHub repository (https://github.com/mitre-attack/attack-stix-data) in STIX 2.1 JSON format.

The main idea behind this project is to make the MITRE ATT&CK knowledge base easily accessible and seamlessly integrable into Obsidian, along with reports or your personal notes. Utilizing Obsidian's features such as hyperlinks, tags, graph view, and more can greatly support threat intelligence analysis and investigations.

Quick start from release

Generating the files takes a long time at the moment and it is recommended that you download the release zip-file that contains the result of running the code. After downloading it unzip it and place the content of the MITRE folder in your Obsidian vault.

Example usage

With the Dataview plugin for Obsidian installed you can get a list of f MITRE ATT&CK techniques or software (or something else) for the current note with the following code.

## Techniques
```dataview
list from #technique
WHERE contains(file.inlinks, this.file.link)
```

## Tools and malware
```dataview
list from #tool or #malware
WHERE contains(file.inlinks, this.file.link)
```

The image below shows the source of a simple investigation of a made up attack by APT28.

Result is shown below.

Locking at the graph it is also easy to see that T1548.004 is not associated with APT28 by MITRE ATT&CK.

The Markdown shown above is available here.

TODO

• Add more relevant tags and consider prepending tags with attack or use attack/.
• Add other metadata? Att&ck ID, etc. (URL has been added)
• Should top level pages be added to each category or are they not needed when ATT&CK is used in Obsidian?
• Check for unused code and remove it.
• Since speed is not the main concern (runs one time) it has not been top priority but I should look at oasis-open/cti-python-stix2#516 (comment).

Done

• Add Data sources
• Add Assets
• Add one link per page to the corresponding page on https://attack.mitre.org/

Status

Missing in the current implementation:

• Groups
  • First version done.
• Mitigations
  • First version done.
• Campaigns
  • First version done.
• Software
  • First version done.
• Tactics
  • First version done.
• Techniques
  • No links to data sources since they are not implemented yet.
  • No "Targeted Assets" since they are not implemented yet.

Current time to run the scripts and the different parts in verbose mode:

2024-05-17 05:36:02 - Getting STIX data from https://raw.githubusercontent.com/mitre-attack/attack-stix-data/master for version 15.1
2024-05-17 05:36:07 - STIX data loaded successfully
2024-05-17 05:36:07 - Getting tactics data for enterprise-attack domain
2024-05-17 05:36:07 - Getting techniques data for enterprise-attack domain
2024-05-17 05:43:48 - Getting mitigations data for enterprise-attack domain
2024-05-17 05:44:20 - Getting tactics data for mobile-attack domain
2024-05-17 05:44:20 - Getting techniques data for mobile-attack domain
2024-05-17 05:44:25 - Getting mitigations data for mobile-attack domain
2024-05-17 05:44:26 - Getting tactics data for ics-attack domain
2024-05-17 05:44:26 - Getting techniques data for ics-attack domain
2024-05-17 05:44:29 - Getting mitigations data for ics-attack domain
2024-05-17 05:44:30 - Getting data sources data
2024-05-17 05:48:15 - Getting assets data
2024-05-17 05:48:17 - Getting groups data
2024-05-17 06:03:18 - Getting campaigns data
2024-05-17 06:03:26 - Getting software data
2024-05-17 06:11:02 - CTI data loaded successfully

Development

Installation

Clone this repository

git clone https://github.com/vincenzocaputo/obsidian-mitre-attack.git

Create a Python virtual environment

cd obsidian-mitre-attack
python3 -m venv .venv
source .venv/bin/activate

Install Python module dependencies

python3 -m pip install -U pip
python3 -m pip install -r requirements.txt

Run

Run the application specifying the output directory path (i.e.: your obsidian vault)

python3 . -o obsidian_vault_path

Options

usage: . [-h] [--path PATH] [-o OUTPUT]

Download MITRE ATT&CK STIX data and parse it to Obsidian Markdown notes

options:
  -h, --help            show this help message and exit
  --path PATH           Filepath to the markdown note file
  -o OUTPUT, --output OUTPUT
                        Output directory in which the notes will be saved. It should be placed inside a Obsidian vault.