Skip to content

INSTALL.md

Latest commit

 

History

History
107 lines (83 loc) · 4.33 KB

INSTALL.md

File metadata and controls

107 lines (83 loc) · 4.33 KB

Installing and Building ZMap

Installing via Package Manager

ZMap operates on GNU/Linux, macOS, and BSD. The latest stable version may be available in package managers.

OS
Fedora 19+ or EPEL 6+ yum install zmap
Debian 8+ or Ubuntu 14.04+ apt install zmap
Gentoo emerge zmap
macOS (using Homebrew) brew install zmap
macOS (using MacPorts) port install zmap
Arch Linux pacman -S zmap

Building from Source

Installing ZMap Dependencies

ZMap has the following dependencies:

  • CMake - Cross-platform, open-source build system
  • GMP - Arbitrary precision arithmetic
  • gengetopt - Command line option parsing
  • libpcap - User-level packet capture library
  • flex and byacc - Lexer and parser generator
  • json-c - JSON parsing and output
  • libunistring - Unicode string library
  • pkg-config - compiler and library helper tool
  • libjudy - Judy Array for packet de-duplication

Install the required dependencies with the following commands.

  • On Debian-based systems (including Ubuntu):

    sudo apt-get install build-essential cmake libgmp3-dev gengetopt libpcap-dev flex byacc libjson-c-dev pkg-config libunistring-dev libjudy-dev

  • On RHEL- and Fedora-based systems (including CentOS):

    sudo dnf install gcc cmake gmp-devel gengetopt libpcap-devel flex byacc json-c-devel libunistring-devel Judy-devel

  • On Arch systems

    pacman -S base-devel cmake gmp gengetopt libpcap flex byacc json-c pkg-config libunistring judy python

  • On Gentoo systems

    emerge sys-devel/binutils dev-libs/gmp dev-util/gengetopt net-libs/libpcap sys-devel/flex dev-util/byacc dev-libs/json-c dev-util/pkgconf dev-libs/libunistring dev-libs/judy

  • On macOS systems (using Homebrew):

    brew install pkg-config cmake gmp gengetopt json-c byacc libunistring judy

  • On macOS systems (using MacPorts):

    sudo port install cmake byacc flex gengetopt pkgconfig gmp libpcap json-c libunistring judy

  • To launch a shell inside a Docker container with the build dependencies mounted at /src:

    docker run -it -v $(pwd):/src zmap/builder

Building and Installing ZMap

Once these prerequisites are installed, ZMap can be compiled by running:

cmake .
make -j4

and then installed via sudo make install.

Development Notes

  • Enabling development turns on debug symbols, and turns off optimizations. Release builds should be built with -DENABLE_DEVELOPMENT=OFF.

  • Enabling log_trace can have a major performance impact and should not be used except during early development. Release builds should be built with -DENABLE_LOG_TRACE=OFF.

  • Building packages for some systems like Fedora and RHEL requires a user-definable directory (buildroot) to put files. The way to respect this prefix is to run cmake with -DRESPECT_INSTALL_PREFIX_CONFIG=ON.

  • Manpages (and their HTML representations) are generated from the .ronn source files in the repository, using the ronn tool. This does not happen automatically as part of the build process; to regenerate the man pages you'll need to run make manpages. This target assumes that ronn is in your PATH.

  • Building with some versions of CMake may fail with unable to find parser.h. If this happens, try updating CMake. If it still fails, don't clone ZMap into a path that contains the string .com, and try again.

  • ZMap may be installed to an alternative directory, with the CMAKE_INSTALL_PREFIX option. For example, to install it in $HOME/opt run

    cmake -DCMAKE_INSTALL_PREFIX=$HOME/opt .
make -j4
make install