Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
5912f9c
register custom executor
thorinaboenke Mar 5, 2026
bb8eb34
Background command return Command started in Background,0
thorinaboenke Mar 9, 2026
5e08b22
typo
thorinaboenke Mar 9, 2026
cceaa60
note on background command
thorinaboenke Mar 9, 2026
0d6685d
register all sliver commands
thorinaboenke Mar 10, 2026
80c2292
register simple commands
thorinaboenke Mar 10, 2026
6b84488
update command integration docs
thorinaboenke Mar 10, 2026
362273d
update readme with uv
thorinaboenke Mar 10, 2026
22049d7
update manual with uv
thorinaboenke Mar 10, 2026
941cb15
installation docs
thorinaboenke Mar 10, 2026
fd91cd6
include uv in manual installation
thorinaboenke Mar 10, 2026
1f8d950
typo
thorinaboenke Mar 10, 2026
dc58ede
improve sliver section
thorinaboenke Mar 10, 2026
27c7802
improve config section
thorinaboenke Mar 10, 2026
8ef312c
improve basic.rst
thorinaboenke Mar 10, 2026
0838811
use absolute image path in readme
thorinaboenke Mar 10, 2026
bcb5b77
improve command docs
thorinaboenke Mar 10, 2026
c75ae7f
improve command docs
thorinaboenke Mar 10, 2026
0d8692d
improve command docs
thorinaboenke Mar 10, 2026
a17db60
wording
thorinaboenke Mar 10, 2026
81a0463
msf payload docs
thorinaboenke Mar 10, 2026
b0a3cd6
regex docs
thorinaboenke Mar 10, 2026
f2382d3
remote and setvar docs
thorinaboenke Mar 11, 2026
d47f5e0
ssh and sftp docs
thorinaboenke Mar 11, 2026
fc931c7
shell docs
thorinaboenke Mar 11, 2026
3d7266c
more command docs
thorinaboenke Mar 11, 2026
7444ce1
rewrite session docs
thorinaboenke Mar 11, 2026
bf55f99
typos and formatting
thorinaboenke Mar 11, 2026
7189ae7
rewrite how
thorinaboenke Mar 11, 2026
77bfc0b
formatting
thorinaboenke Mar 11, 2026
ed10cfc
fix logo
thorinaboenke Mar 11, 2026
053f0f4
improve about
thorinaboenke Mar 11, 2026
da5b8e0
docs consistency
thorinaboenke Mar 11, 2026
2080cac
formatting
thorinaboenke Mar 11, 2026
90b3f2e
links and consistency
thorinaboenke Mar 11, 2026
9fc3360
add required info for command paramaters
thorinaboenke Mar 11, 2026
a757a04
enable autodocs
thorinaboenke Mar 11, 2026
f415125
docs small fixes
thorinaboenke Mar 11, 2026
348d330
update readme
thorinaboenke Mar 11, 2026
d6c3610
add waing on python comparing conventions
thorinaboenke Mar 11, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,46 @@ $ pip3 install .
```

Using pip:

```
$ pip3 install attackmate
```

Using uv:
```
$ git clone https://github.com/ait-aecid/attackmate.git
$ cd attackmate
$ uv sync
```

## Execute

With pip:
```
$ attackmate playbook.yml
```

With uv:
```
$ uv run attackmate playbook.yml
```

![AttackMate Demo](docs/source/images/Demo.gif "AttackMate Demo")

## Documentation

Please take a look at our documentation for how to install and use attackmate:
Please take a look at our documentation on how to install and use attackmate:

* [Installation](https://ait-testbed.github.io/attackmate/main/installation/index.html)
* [Documentation](https://ait-testbed.github.io/attackmate/main/index.html)
* [Command Reference](https://ait-testbed.github.io/attackmate/main/playbook/commands/index.html)
* [Example Playbooks](https://ait-testbed.github.io/attackmate/main/playbook/examples.html)
* [Arxiv Paper](https://arxiv.org/pdf/2601.14108)

## Publications
* [AttackMate: Realistic Emulation and Automation of Cyber Attack Scenarios Across the Kill Chain](https://arxiv.org/pdf/2601.14108) on Arxiv

## Contribution

We're happily taking patches and other contributions. Please see the following links for how to get started:
We're happily taking patches and other contributions. Please see the following links on how to get started:

- [Contribution Guide](https://ait-testbed.github.io/attackmate/main/developing/contribution.html)

Expand All @@ -64,13 +78,12 @@ information may result in criminal charges.

## Security

AttackMate should only be executed against own test or training systems.
For this reason, every software bug is treated equally, regardless of
whether it is security relevant or not.
AttackMate should only be executed against systems you own or have explicit permission to test.
For this reason, all software bugs are treated with equal priority, regardless of whether they have security implications.

*Please note that AttackMate could easily be executed in a dangerous way. For example, by
parsing the RESULT_STDOUT of a malicious server. The server response could lead to
a command injection. Keep that in mind!
a command injection. Keep that in mind and always treat external input with caution!

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
About
=====

AttackMate is a command line tool that can perform entire attack chains based on playbooks. It can be used for cybersecurity training as well as for testing detection engines. AttackMate is so designed that any part of an attack can be easily replaced or varied. Furthermore, the playbooks enable the portability and reproducibility of attack chains. A key focus was on user-friendliness and flexibility for attack chain designers.
AttackMate is a command-line tool that executes full attack chains defined in playbooks. It is designed for cybersecurity training, red team exercises, and testing detection engines. Individual attack steps can be freely replaced or varied, and playbooks ensure that attack chains are portable and reproducible. A key focus was on user-friendliness and flexibility for attack chain designers.

.. image:: images/Demo.gif
Loading
Loading