A Python package to interact with the Mitre ATT&CK Framework
Project description
pyattck
A Python Module to interact with the Mitre ATT&CK Framework
pyattck has the following notable features in it's current release:
-
Retrieve all Tactics, Techniques, Actors, Malware, Tools, and Mitigations
-
All techniques have suggested mitigations as a property
-
For each class you can access additional information about related data points:
-
Actor
- Tools used by the Actor or Group
- Malware used by the Actor or Group
- Techniques this Actor or Group uses
-
Malware
- Actor or Group(s) using this malware
- Techniques this malware is used with
-
Mitigation
- Techniques related to a specific set of mitigation suggestions
-
Tactic
- Techniques found in a specific Tactic (phase)
-
Technique
- Tactics a technique is found in
- Mitigation suggestions for a given technique
- Actor or Group(s) identified as using this technique
-
Tools
- Techniques that the specified tool is used within
- Actor or Group(s) using a specified tool
Installation
OS X & Linux:
pip install pyattck
Windows:
pip install pyattck
Usage example
To use pyattck you must instantiate a Attck object:
from pyattck import Attck
attack = Attck()
You can access the following properties on your Attck object:
- actor
- malware
- mitigation
- tactic
- technique
- tools
Below are examples of accessing each of these properties:
from pyattck import Attck
attack = Attck()
# accessing actors
for actor in attack.actors:
print(actor)
# accessing malware used by an actor or group
for malware in actor.malware:
print(malware)
# accessing tools used by an actor or group
for tool in actor.tools:
print(tool)
# accessing techniques used by an actor or group
for technique in actor.techniques:
print(technique)
# accessing malware
for malware in attack.malwares:
print(malware)
# accessing actor or groups using this malware
for actor in malware.actors:
print(actor)
# accessing techniques that this malware is used in
for technique in malware.techniques:
print(technique)
# accessing mitigation
for mitigation in attack.mitigations:
print(mit)
# accessing techniques related to mitigation recommendations
for technique in mitigation.techniques:
print(technique)
# accessing tactics
for tactic in attack.tactics:
print(tactic)
# accessing techniques related to this tactic
for technique in tactic.techniques:
print(technique)
# accessing techniques
for technique in attack.techniques:
print(technique)
# accessing tactics that this technique belongs to
for tactic in technique.tactics:
print(tactic)
# accessing mitigation recommendations for this technique
for mitigation in technique.mitigation:
print(mitigation)
# accessing actors using this technique
for actor in technique.actors:
print(actor)
# accessing tools
for tool in attack.tools:
print(tool)
# accessing techniques this tool is used in
for technique in tool.techniques:
print(technique)
# accessing actor or groups using this tool
for actor in tool.actors:
print(actor)
Release History
- 1.0.0
- Initial release of pyattck to PyPi
- 1.0.1
- Updating Documentation with new reference links
Meta
Josh Rickard – @MSAdministrator – rickardja@live.com
Distributed under the MIT license. See LICENSE
for more information.
Contributing
- Fork it (https://github.com/swimlane/pyattck/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyattck-1.0.0.tar.gz
.
File metadata
- Download URL: pyattck-1.0.0.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d926d4ff26538f31b0e8bdee911f36ce75b53ef268896cbbf2c19c034ce5a123 |
|
MD5 | 2a460afc5234138a79156df906ae5fd6 |
|
BLAKE2b-256 | dda729ad352fa3df0db86c20a20e4cddae8682690f4f1ab9296ba62618c00893 |
File details
Details for the file pyattck-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: pyattck-1.0.0-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fd149314f9f0fd0bc2fe2b4b4bda46d43da5af84268009b5d0bbca5dcf85a32 |
|
MD5 | ca18dd9efd686f20a4b54f4b4c7a33f8 |
|
BLAKE2b-256 | d633b88cdb2e71615568a943b59f2b1a9f3adc7988cddbd8940c1f670bfee181 |