Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vincenzocaputo/obsidian-mitre-attack
Parse MITRE ATT&CK to markdown for Obsidian
https://github.com/vincenzocaputo/obsidian-mitre-attack
markdown mitre-attack obsidian stix
Last synced: 21 days ago
JSON representation
Parse MITRE ATT&CK to markdown for Obsidian
- Host: GitHub
- URL: https://github.com/vincenzocaputo/obsidian-mitre-attack
- Owner: vincenzocaputo
- License: gpl-3.0
- Created: 2023-06-03T14:37:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-02T11:25:45.000Z (about 2 months ago)
- Last Synced: 2024-11-02T12:17:17.063Z (about 2 months ago)
- Topics: markdown, mitre-attack, obsidian, stix
- Language: Python
- Homepage:
- Size: 732 KB
- Stars: 19
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# obsidian-mitre-attack
This repository implements a Python script that parses the MITRE ATT&CK knowledge base into a markdown format, making it readable and browsable using the Obsidian note-taking app.
The ATT&CK data is retrieved from the MITRE GitHub repository (https://github.com/mitre-attack/attack-stix-data) that contains the dataset represented in STIX 2.1 JSON collection. 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
### 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
```
pip install -r requirements.txt
```
### Run
#### Edit the config file (Optional)
> **It is recommended to use the default config file.**
In the `config.yml` file, you can change the following options:
- **repository_url**: The base URL pointing to the mitre/attack-stix-data repository.
- **domain**: The MITRE ATT&CK domain to pull. It should be either "enterprise-attack", "mobile-attack", or "ics-attack". Note: Currently, only the "enterprise-attack" domain is fully tested.
- **version**: The ATT&CK version to pull. You can remove this entry to pull the latest version.
#### Run the script
Run the application specifying the output directory path (i.e.: your obsidian vault)
```
python . -o obsidian_vault_path
```
### Options
```
usage: . [-h] [-d DOMAIN] [-o OUTPUT] [--generate-hyperlinks] [--generate-matrix] [--path PATH]
Downdload MITRE ATT&CK STIX data and parse it to Obsidian markdown notes
options:
-h, --help show this help message and exit
-d DOMAIN, --domain DOMAIN
Domain should be 'enterprise-attack', 'mobile-attack' or 'ics-attack'
-o OUTPUT, --output OUTPUT
Output directory in which the notes will be saved. It should be placed inside a Obsidian
vault.
--generate-hyperlinks
Generate techniques hyperlinks in a markdown note file
--generate-matrix Create ATT&CK matrix starting from a markdown note file
--path PATH Filepath to the markdown note file
```
## Images and Examples
