You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains a library of Python tools and utilities for working with ATT&CK data. For more information,
4
-
see the [full documentation](https://mitreattack-python.readthedocs.io/) on ReadTheDocs.
3
+
This repository contains a library of Python tools and utilities for working with ATT&CK data.
4
+
For more information, see the [full documentation](https://mitreattack-python.readthedocs.io/) on ReadTheDocs.
5
5
6
6
## Install
7
7
@@ -11,26 +11,12 @@ To use this package, install the mitreattack-python library with [pip](https://p
11
11
pip install mitreattack-python
12
12
```
13
13
14
-
Note: the library requires [python3](https://www.python.org/).
15
-
16
14
## MitreAttackData Library
17
15
18
-
The ``MitreAttackData`` library is used to read in and work with MITRE ATT&CK STIX 2.0 content. This library provides
16
+
The ``MitreAttackData`` library is used to read in and work with MITRE ATT&CK STIX 2.0 content. This library provides
19
17
the ability to query the dataset for objects and their related objects. This is the main content of mitreattack-python;
20
18
you can read more about other modules in this library under "Additional Modules".
21
19
22
-
## Additional Modules
23
-
24
-
More detailed information and examples about the specific usage of the additional modules in this package can be found in the individual README files for each module linked below.
25
-
26
-
| module | description | documentation |
27
-
|:------------|:------------|:--------------|
28
-
|[navlayers](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/navlayers)| A collection of utilities for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) layers. Provides the ability to import, export, and manipulate layers. Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/README.md).|
29
-
|[attackToExcel](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/attackToExcel)| A collection of utilities for converting [ATT&CK STIX data](https://github.com/mitre/cti) to Excel spreadsheets. It also provides access to [Pandas](https://pandas.pydata.org/) DataFrames representing the dataset for use in data analysis. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/attackToExcel/README.md).|
30
-
|[collections](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/collections)| A set of utilities for working with [ATT&CK Collections and Collection Indexes](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md). Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/README.md).|
31
-
|[diffStix](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/diffStix)| Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two versions of the STIX2 bundles representing the ATT&CK content. Run `diff_stix -h` for full usage instructions. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/diffStix/README.md).|
32
-
33
-
34
20
## Related MITRE Work
35
21
36
22
### CTI
@@ -60,36 +46,7 @@ STIX is designed to improve many capabilities, such as collaborative threat anal
60
46
61
47
<https://oasis-open.github.io/cti-documentation/>
62
48
63
-
### ATT&CK scripts
64
-
65
-
One-off scripts and code examples you can use as inspiration for how to work with ATT&CK programmatically. Many of the functionalities found in the mitreattack-python package were originally posted on attack-scripts.
66
-
67
-
<https://github.com/mitre-attack/attack-scripts>
68
-
69
-
70
49
## Contributing
71
50
72
51
To contribute to this project, either through a bug report, feature request, or merge request,
73
52
please see the [Contributors Guide](https://github.com/mitre-attack/mitreattack-python/blob/main/docs/CONTRIBUTING.md).
74
-
75
-
## Notice
76
-
77
-
Copyright 2025 The MITRE Corporation
78
-
79
-
Approved for Public Release; Distribution Unlimited. Case Number 19-0486.
80
-
81
-
Licensed under the Apache License, Version 2.0 (the "License");
82
-
you may not use this file except in compliance with the License.
83
-
You may obtain a copy of the License at
84
-
85
-
<http://www.apache.org/licenses/LICENSE-2.0>
86
-
87
-
Unless required by applicable law or agreed to in writing, software
88
-
distributed under the License is distributed on an "AS IS" BASIS,
89
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
90
-
See the License for the specific language governing permissions and
91
-
limitations under the License.
92
-
93
-
This project makes use of ATT&CK®
94
-
95
-
[ATT&CK Terms of Use](https://attack.mitre.org/resources/terms-of-use/)
0 commit comments