1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# 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](https://brew.sh)) | `brew install zmap` |
| macOS (using [MacPorts](https://macports.org)) | `port install zmap`|
| Arch Linux | `pacman -S zmap` |
## Building from Source
### Installing ZMap Dependencies
ZMap has the following dependencies:
- [CMake](http://www.cmake.org/) - Cross-platform, open-source build system
- [GMP](http://gmplib.org/) - Arbitrary precision arithmetic
- [gengetopt](http://www.gnu.org/software/gengetopt/gengetopt.html) - Command line option parsing
- [libpcap](http://www.tcpdump.org/) - User-level packet capture library
- [flex](http://flex.sourceforge.net/) and [byacc](http://invisible-island.net/byacc/) - Lexer and parser generator
- [json-c](https://github.com/json-c/json-c/) - JSON parsing and output
- [libunistring](https://www.gnu.org/software/libunistring/) - Unicode string library
- [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) - compiler and library helper tool
- [libjudy](https://judy.sourceforge.net/) - Judy Array for packet de-duplication
Install the required dependencies with the following commands.
* On Debian-based systems (including Ubuntu):
```sh
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):
```sh
sudo dnf install gcc cmake gmp-devel gengetopt libpcap-devel flex byacc json-c-devel libunistring-devel Judy-devel
```
* On Arch systems
```sh
pacman -S base-devel cmake gmp gengetopt libpcap flex byacc json-c pkg-config libunistring judy python
```
* On Gentoo systems
```sh
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](https://brew.sh/)):
```sh
brew install pkg-config cmake gmp gengetopt json-c byacc libunistring judy
```
* On macOS systems (using [MacPorts](https://macports.org/)):
```
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`:
```sh
docker run -it -v $(pwd):/src zmap/builder
```
### Building and Installing ZMap
Once these prerequisites are installed, clone the ZMap repository and navigate into the cloned directory.
```sh
cd zmap
```
Then, ZMap can be compiled by running:
```sh
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](https://github.com/rtomayko/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
```sh
cmake -DCMAKE_INSTALL_PREFIX=$HOME/opt .
make -j4
make install
```
|
