Installation Guide

Table of Contents

• Prebuilt Binaries
• Using Docker
• Compile from Source
• Packages Maintained by the Amass Project
  • Homebrew
  • Snapcraft
• Packages Maintained by a Third Party
  • Arch Linux
  • BlackArch Linux
  • DragonFly BSD
  • FreeBSD
  • Kali Linux
  • Nix or NixOS
  • Parrot Linux
  • Pentoo Linux

Prebuilt Binaries

A precompiled version is available with each release.

Using Docker

1. Build the Docker image:

docker build -t amass https://github.com/OWASP/Amass.git

2. Run the Docker image:

docker run -v OUTPUT_DIR_PATH:/.config/amass/ amass enum --list

The volume argument allows the Amass graph database to persist between executions and output files to be accessed on the host system. The first field (left of the colon) of the volume option is the amass output directory that is external to Docker, while the second field is the path, internal to Docker, where amass will write the output files.

The wordlists maintained in the Amass git repository are available in /examples/wordlists/ within the docker container. For example, to use all.txt:

docker run -v OUTPUT_DIR_PATH:/.config/amass/ amass enum -brute -w /wordlists/all.txt -d example.com

Compile From Source

If you prefer to build your own binary from the latest release of the source code, make sure you have a correctly configured Go >= 1.14 environment. More information about how to achieve this can be found on the golang website..

Simply execute the following commands:

1. Add the Go Module environment variable:

export GO111MODULE=on

2. Download OWASP Amass:

go get -v -u github.com/OWASP/Amass/v3/...

At this point, the binary should be in $GOPATH/bin.

3. If you'd like to rebuild the binary from the project source code:

cd $GOPATH/src/github.com/OWASP/Amass

go install ./...

Several wordlists for performing DNS name alterations and brute forcing can be found in the following directory:

ls $GOPATH/src/github.com/OWASP/Amass/examples/wordlists/

Packages Maintained by the Amass Project

Homebrew

For Homebrew, the following two commands will install Amass into your environment:

brew tap caffix/amass
brew install amass

Snapcraft

If your operating environment supports Snap, you can click here to install, or perform the following from the command-line:

sudo snap install amass

Add the Snap bin directory to your PATH:

export PATH=$PATH:/snap/bin

Periodically, execute the following command to update all your snap packages:

sudo snap refresh

Packages Maintained by a Third Party

Arch Linux

Details regarding this package can be found here

BlackArch Linux

Details regarding this package can be found here

DragonFly BSD

pkg upgrade
pkg install amass

FreeBSD

cd /usr/ports/dns/amass/ && make install clean
pkg install amass

Kali Linux

OWASP Amass is installed by default and can be managed like any other Kali package:

apt-get update
apt-get install amass

Nix or NixOS

nix-env -f '<nixpkgs>' -iA amass

Parrot Linux

apt-get update
apt-get install amass

Pentoo Linux

sudo emerge net-analyzer/amass

Periodically, execute the following command to update all packages:

sudo pentoo-updater