README

   1 //////////////////////////////////////////////////////////////////////////////
   2
   3                     netsniff-ng - the packet sniffing beast
   4
   5 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
   6                                          .      .
   7 netsniff-ng is a free, performant       /(      )\
   8 Linux network analyzer and            .' {______} '.
   9 networking toolkit. If you will,       \ ^,    ,^ /
  10 the Swiss army knife for network        |'O\  /O'|   _.<0101011>--
  11 packets.                                > `'  '` <  /
  12                                         ) ,.==., (  |
  13 Release: 2012-06-29                  .-(|/--~~--\|)-'
  14                                     (      ___
  15 Web: http://netsniff-ng.org          \__.=|___E
  16
  17 The gain of performance is reached by zero-copy mechanisms, so that on packet
  18 reception and transmission the kernel does not need to copy packets from kernel
  19 space to user space and vice versa.
  20
  21 For this purpose, the netsniff-ng toolkit [1] is libpcap independent, but
  22 nevertheless supports the pcap file format for capturing, replaying and
  23 performing offline-analysis of pcap dumps. Furthermore, this project focusses
  24 on building a robust, fast and clean analyzer and utilities that complete
  25 netsniff-ng as a support for network development, debugging or network
  26 reconnaissance.
  27
  28 The netsniff-ng toolkit currently consists of the following utilities:
  29
  30   * netsniff-ng: a zero-copy packet analyzer, pcap capturing/replaying tool
  31   * trafgen: a zero-copy network packet generator
  32   * gremlin: a threaded analyzer/generator with Cisco-cli for hw/sw appliances
  33   * ifpps: a top-like kernel networking and system statistics tool
  34   * curvetun: a lightweight curve25519-based multiuser IP tunnel
  35   * ashunt: an autonomous system trace route and DPI testing utility
  36   * flowtop: a top-like netfilter connection tracking tool
  37   * bpfc: a tiny Berkeley Packet Filter compiler with Linux extensions
  38
  39 Have a look at the Documentation/ folder for further information.
  40
  41 The netsniff-ng toolkit is an Open Source project covered by the GNU General
  42 Public License. For any questions or feedback about netsniff-ng you are welcome
  43 to leave us a message to <workgroup@netsniff-ng.org> or to our mailing list
  44 at <netsniff-ng@googlegroups.com> (Note: you have to register first).
  45 netsniff-ng is purely non-profit and provided in the hope, that it is found
  46 useful. The current project status can be considered as "working". In general,
  47 all tools have been tested by us to a great extend including their command-line
  48 options. In fact, many of our tools are used in production systems. However, we
  49 give no guarantee that our tools are free of bugs! If you spot some issues,
  50 contact us as described in REPORTING-BUGS. Also, have a look at our FAQ [2] for
  51 answering your questions. This project has received support from institutions
  52 listed in Documentation/Sponsors.
  53
  54 Happy packet hacking!
  55
  56 [1] http://netsniff-ng.org/
  57 [2] http://netsniff-ng.org/faq.html