INSTALL

   1 Currently only operating systems running on Linux kernels with
   2 CONFIG_PACKET_MMAP enabled. This feature can be found even back to the days of
   3 2.4 kernels. Most operating systems ship pre-compiled kernels that have this
   4 config option enabled and even the latest kernel versions got rid of this
   5 option and have this functionality already built-in. However, we recommend a
   6 kernel >= 2.6.31, because the TX_RING is officially integrated since then.
   7
   8 netsniff-ng has been successfully tested on x86 and x86_64. Please drop
   9 us a short mail, if it runs successfully on hardware other than that.
  10
  11 What libraries / tools are required?
  12
  13  - libc (all)
  14  - cmake (all)
  15  - libpthread (curvetun, netsniff-ng, flowtop)
  16  - libncurses (ifpps, flowtop)
  17  - libGeoIP and its database (ashunt, flowtop)
  18  - flex, bison (bpfc)
  19  - ntpd [or equivalent] (curvetun)
  20  - libnacl (curvetun)
  21  - libnetfilter-conntrack (flowtop)
  22  - liburcu (flowtop)
  23
  24 It is common, that these libraries are shipped as distribution packages
  25 for an easy installation. We try to keep this as minimal as possible.
  26
  27 For downloading the latest GeoIP database, you can use the script that
  28 is located at scripts/geoip-database-update.
  29
  30 The installation process done by cmake is fairly simple:
  31
  32   $ cd netsniff-ng/src/
  33   $ mkdir build
  34   $ cd build
  35   $ cmake ..
  36   $ make
  37   # make install
  38
  39 Man pages are generated out of the corresponding source files by cmake.
  40 They are written in POD format as a C header comment within those files.
  41 For this, you need the tool pod2man which is distributed with Perl and
  42 should therefore be available on most systems.
  43
  44 To uninstall, simply remove all files refered in install_manifest.txt
  45
  46 For bpfc, we also have a Vim syntax highlighting file. Have a look at
  47 scripts/bpf.vim for installation instructions.
  48
  49 In order to build curvetun, libnacl must be built first. A helper script
  50 called build_nacl.sh is there to facilitate this process. If you want to
  51 build NaCl in the directory ~/nacl, the script should be called this way:
  52
  53   $ cd src/curvetun
  54   $ ./build_nacl.sh ~/nacl
  55
  56 This gives an initial output such as "Building NaCl for arch amd64 on host
  57 fuuubar (grab a coffee, this takes a while) ...". If the automatically
  58 detected architecture (such as amd64) is not the one you intend to compile
  59 for, then edit the (cc="gcc") variable within the build_nacl.sh script to
  60 your cross compiler.
  61
  62 If NaCl already has been built on the target, it is quicker to use nacl_path.sh
  63 this way:
  64
  65   $ cd src/curvetun
  66   $ ./nacl_path.sh ~/nacl/build/include/x86 ~/nacl/build/lib/x86
  67
  68 When done, netsniff-ng build infrastructure will read nacl_path.cmake to get
  69 the needed paths to NaCl.
  70
  71 For using TUN/TAP devices as a user, e.g. create a file called
  72 src/50-tuntap.rules in /etc/udev/rules.d/ with:
  73 KERNEL=="tun", NAME="net/%k", GROUP="netdev", MODE="0660", OPTIONS+="ignore_remove"
  74  and restart the udev daemon. Add yourself to the "netdev" group.
  75
  76 NOTES
  77
  78 The following warnings can be seen when compiling bpfc with flex 2.5.35 and
  79 bison 2.4.1:
  80  - redundant redeclaration of ‘isatty’
  81  - cannot optimize loop, the loop counter may overflow
  82
  83 Those two warnings occur on generated C code produced by flex and bison
  84 and there is no possibility on our side to fix them.
  85
  86 Similar to that, gcc will throw a warning on strchr(3) which is a false
  87 positive (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=36513) from glibc:
  88  - warning: logical ‘&&’ with non-zero constant will always evaluate as true