Installation

This document will describe the process for locating, installing & verifying GoNetSim. Please ensure you are following the correct instructions for your operating system.

Prerequisites

Windows

• Windows 10+ OR Windows Server 2016+
• x86_64 or ARM64 CPU architecture

macOS

Danger

macOS binaries are not built by the maintainer(s) of GoNetSim. To use GoNetSim on macOS, please use dockerised GoNetSim

Linux

• x86_64 or ARM64 CPU architecture

Note

GoNetSim is only tested & officially supported on Ubuntu-based distributions, but should work on any modern Linux distribution. Depending on your platform, youmay be better of using dockerised GoNetSim

Download

The source repository can be found here (github.com/lachlanharrisdev/gonetsim). It is periodically mirrored to here (git.lachlanharris.dev/lachlanharris.dev/gonetsim), and a GitLab mirror is soon to be established.

Windows

1. Go to the releases page and find the latest release.

2. Download the correct release for your platform

   x86_64

   Download GoNetSim_Windows_x86_64.zip

   ARM64

   Download GoNetSim_Windows_arm64.zip

   Note

   You may have to click “Show all assets” at the bottom of the release to see some of the files.

3. Extract the downloaded archive

4. Move the extracted gonetsim.exe to a directory in your PATH (e.g. C:\Windows\System32)

5. Verify the installation

   gonetsim --version

macOS

Danger

macOS binaries are not built by the maintainer(s) of GoNetSim. To use GoNetSim on macOS, please use dockerised GoNetSim

Linux

Install script

Caution

The installation script is a work in progress. Please report any issues on either the GoNetSim repository or the GoNetSim Docs repository. If you’d like to inspect the script before use, you can navigate here

1. Run the install script

   curl https://gonetsim.lachlanharris.dev/install.sh | sh

Manual installation

1. Download the latest release directly from the releases page

   x86_64

   curl -L -O https://github.com/lachlanharrisdev/gonetsim/releases/latest/download/GoNetSim_Linux_x86_64.tar.gz

   ARM64 / AARCH64

   curl -L -O https://github.com/lachlanharrisdev/gonetsim/releases/latest/download/GoNetSim_Linux_arm64.tar.gz

2. Extract the downloaded archive

   x86_64

   tar -xzf GoNetSim_Linux_x86_64.tar.gz

   ARM64 / AARCH64

   tar -xzf GoNetSim_Linux_arm64.tar.gz

   A single binary named GoNetSim should be extracted to the current working directory

3. Move the extracted binary to a directory in your PATH (and rename it to gonetsim)

   sudo mv GoNetSim /usr/local/bin/gonetsim

4. Allow permission to listen on privileged ports. This stops the binary from requiring sudo to run

   sudo setcap 'cap_net_bind_service=+ep' /usr/local/bin/gonetsim

5. Verify the installation

   gonetsim --version

Docker

Please see the Docker guide for instructions on how to use GoNetSim with Docker.

First Run

After installing GoNetSim, it should work right out the box by running:

Linux / MacOS

gonetsim

Windows

gonetsim.exe

The first run of the command will create a default configuration file at $XDG_CONFIG_HOME/gonetsim/config.toml (or ~/.config/gonetsim/config.toml if XDG_CONFIG_HOME is not set). You can edit this file to change the default configuration, or specify a different config file with the --config flag.

For more information on configuration, see the configuration documentation.

The first run will also create persistent TLS certificates if you don’t have user-provided ones configured. For more information on this, see the TLS reference.

Note

It’s recommended to install the CA certificate (gonetsim-ca.pem) generated on the first run into your analysis VM to avoid TLS warnings. For instructions on how to do this, see the TLS reference.