Skip to content

Installation and Configuration

Joe Rozner edited this page Sep 29, 2020 · 11 revisions

1. Download and Installation

You can find official releases for MacOS and Linux available in the releases section of the repo here. Download and unzip the release then place the the aterm executable somewhere in your operating system's path making sure that the application has the execute bit set. If you already have the ASHIRT client installed and configured you can skip step 2 and move onto step 3.

2. Generating Authentication Keys

Authentication to the ASHIRT server is managed via API keys that you can generate when logged into the web interface. Once you login use the dropdown menu in the top right to select Account Settings and navigate to the API Keys tab in the left rail.

API Keys

You'll see a Create new API Key button. Click this button to generate a new API key. A modal will pop up with your access key and secret key pair. Don't close this modal without saving the secret key somewhere because you won't be able to see it again.

New API Key

3. Configuring aterm

aterm will automatically detect existing ashirt configurations and attempt to populate common values, such as api keys and the host, from that file. If you have not yet installed the ashirt client you can walk through the first run configuration menus to enter in all the necessary values. Start by executing aterm from your shell with the aterm. This should start the program if you have install the program into a location that is in your path. aterm will tell you the version that you are running and whether there are any updates available then walk you through the configuration process.

aterm configuration

After providing the necessary information aterm will attempt to reach the ASHIRT server to verify it's connectivity and that the credentials are valid. You should see the following.

aterm configured

At this point you're ready to go! aterm will drop to your chosen shell and will begin recording your session. When you're ready to exit simply type exit or exit use some other way to exit your shell that will not terminate aterm to be brought back to the aterm menus where you can save the recording, upload, or discard it.

Debugging

If you are unable to communicate with the ASHIRT server you can use the Test Connection option in the menu to get more detailed information about what is failing.

  • Check your api url to ensure you are using the correct protocol, host, and port.
  • Ensure that your access and secret keys is correct
  • Ensure you can communicate with the api url using another program