Added Getting Started Page for the Remote API #237
Conversation
…ote_config.rst to port actually used by default
|
|
||
| * AttackMate installed on the server. | ||
| * attackmate-api-server installed and running on the server. | ||
| * attackmate-client installed on the client. |
There was a problem hiding this comment.
why is an attackmate-client required?
| * `attackmate-api-server <https://github.com/ait-testbed/attackmate-api-server>`__: | ||
| runs on the remote AttackMate host and exposes an HTTPS API. | ||
| * `attackmate-client <https://github.com/ait-testbed/attackmate-client>`__: | ||
| runs on the local/client host and sends commands or playbooks to the API |
There was a problem hiding this comment.
specify what the client is and when it is required.
| It is recommended to install AttackMate on the client too. This allows the | ||
| client to parse local wrapper playbooks and use the normal ``attackm8`` command. |
There was a problem hiding this comment.
I would describe when to install just the attackmate-client and when to install the attackmate instead. It is not recommended to install AttackMate and the Client.
| The systemd service logs are available with: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| journalctl -u attackmate-api -f | ||
|
|
There was a problem hiding this comment.
where did you explain how to install attackmate-api using systemd?
| server. | ||
|
|
||
| The `attackmate-ansible <https://github.com/ait-testbed/attackmate-ansible>`__ | ||
| role can install and configure both sides. |
There was a problem hiding this comment.
add here that the client is a dependency of attackmate?
There was a problem hiding this comment.
..but it isn't, right? both the attackmate-client and attackmate can work without the other?
There was a problem hiding this comment.
attackmate needs attackmate-client for the remote-executor. so that attackmate can control other attackmates.
There was a problem hiding this comment.
sure, just thought that was an optional feature :) adapted the doc to reflect it
|
|
||
| A working remote setup needs at least: | ||
|
|
||
| * AttackMate installed on the server. |
There was a problem hiding this comment.
link somewhere here to the ansible role, and that it can install attackmate as an api server
| the remote playbook is still running, waiting for a session, or stuck in a tool | ||
| such as Metasploit. Check the server logs and any AttackMate playbook logs. | ||
|
|
||
| You can also increase the timeout period of attackmate-client by changing DEFAULT_TIMEOUT in ``/usr/local/share/attackmate/.venv/lib/python3.12/site-packages/attackmate_client/attackmate_client.py`` |
There was a problem hiding this comment.
we should make this easier configurable
3 participants
Added Getting Started Documentation for the Remote API.
Changed default port number in remote_config.rst doc.