Skip to main content

Installation

How to install SIPVicious PRO

We offer two ways to run the toolset:

  • through a Docker container
  • as an executable binary

Using Docker to run SIPVicious PRO (preferred)

The SIPVicious PRO docker image is the preferred way to run SIPVicious PRO as it handles dependency requirements for you. This is also the only way, currently, to run the toolset on newer Mac computers with the Apple’s M1 chipset.

Using the binaries directly

We distribute executable binaries for the following systems:

  • Linux AMD64
  • MacOS AMD64
  • Windows AMD64
  • Linux ARM64
  • Linux ARMHF (optional)
  • Windows 386 (optional)
  • MacOS ARM64 (works in progress)

The executable binaries may be saved in a directory that is in the default path so that it is available to the user that needs to run it, or may be run locally. For example, on Linux and NIX systems, that might be /usr/local/bin, while on Windows that might be %WINDIR%\system32.

Installing dependencies

Opus requirement

SIPVicious PRO makes use of Opus which is an external dependency for the Linux and OSX builds. For Debian-flavoured distributions (e.g. Ubuntu), this can be installed by running the following:

sudo apt-get install pkg-config libopus-dev libopusfile-dev

On Redhat flavoured Linux distributions, that might be done by running:

yum install opusfile-devel pkg-config opus-devel

For MacOS, the following command would install it given that you have homebrew set up already:

brew install pkg-config opus opusfile

If you are making use of SIPVicious PRO from Windows, the correct DLL files are already distributed with your build and therefore, no extra files need to be downloaded.

Fuzzing requirements

For the fuzzer modules, we make use of 3rd-party/external mutators which need to be installed on the system running SIPVicious PRO. Users have the choice of using radamsa or zzuf as a mutator.

To acquire radamsa, one should visit the radamsa releases page and follow the instructions. A similar method is required for zzuf, by visiting the releases page for that project. Once the code is compiled, make sure that the binaries (radamsa and/or zzuf) are copied to your $PATH, typically /usr/bin or /usr/local/bin on Linux systems.

Alternatively, one may install this software by using the package found on their Linux distribution.

On Redhat flavoured Linux distributions, that might be done by running:

yum install radamsa
yum install zzuf

On Debian flavoured Linux distributions, that might be done by running:

apt-get install radamsa
apt-get install zzuf

Updating SIPVicious PRO

Notification of new builds of SIPVicious PRO is sent by email with instructions on how to download the new version. When using the Docker image, follow the instructions here. When using the binary directly, the old sipvicious binary can then be overwritten with the new one.

System configuration after installation

The tool loads up configuration files from the local directory which change the default behaviour of the tool. Therefore, the directory from which the command is run may change the default behaviour of the tool if a configuration file is found. Additionally, command line auto-completion is available for the bash shell by making use of the utils dump autocomplete command. Some basic details on how to install bash automatic completion can be found in the command line basics page.