Skip to content

Quickstart

John Kennedy edited this page Mar 12, 2021 · 14 revisions

Quickstart

Download the current release from our page.

OSX

Mount the DMG, and move ashirt.app into your /Applicaions folder. Launch ashirt from your /Applications folder, through Spolight, or open -a ashirt in the terminal.

Getting Started

Locate the ashirt tray icon

Select Settings

On the first launch, the user must first set up an appropriate configuration. When the tray displays, open the tray and select Settings. From here, you will be presented with some options.

General Settings

Field Meaning
Capture Area Command The CLI command to take a screenshot of an arbitrary area and save to a file. More on this below
[Capture Area Command] Shortcut The key combination used (at a system level) to trigger the capture area command
Capture Window Command The CLI command to take of a given window, and save to a file
[Capture Area Command] Shortcut The key combination used (at a system level) to trigger the capture window command

Server Settings

Field Meaning
Evidence Repository Where evidence is stored. Note that this is a jumping off point. Files are stored in a subdirectory using the operation name
Access Key The (shorter) base-64 key given by the ashirt frontend (look for this in Account Settings)
Secret Key The (longer) base-64 key given by the ashirt frontend
Host Path The http location to the ashirt API server (If you are following the ashirt-server quickstart this will be http://localhost:3000)

Once the above is configured, save the settings and you can now select an operation. Open the tray, and under Select Operation, choose an operation to start using the application. Note that whenever you change the host path, the list of operations will be updated

Clone this wiki locally