README

   1 //////////////////////////////////////////////////////////////////////////////
   2
   3                     netsniff-ng - the packet sniffing beast
   4
   5 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
   6                                       .      .
   7                                      /(      )\
   8                                    .' {______} '.
   9                                     \ ^,    ,^ /
  10  netsniff-ng is a free, performant   |'O\  /O'|   _.<0101011>--
  11  Linux network analyzer and          > `'  '` <  /
  12  networking toolkit.                 ) ,.==., (  |
  13                                     (|/--~~--\|)-'
  14  Release: 2012-xx-xx               /
  15                                   (      ___
  16  Web: http://netsniff-ng.org       \__.=|___E
  17
  18 The gain of performance is reached by zero-copy mechanisms, so that on packet
  19 reception and transmission the kernel does not need to copy packets from kernel
  20 space to user space and vice versa.
  21
  22 For this purpose, the netsniff-ng toolkit [1] is libpcap independent, but
  23 nevertheless supports the pcap file format for capturing, replaying and
  24 performing offline-analysis of pcap dumps. Furthermore, we are focussing on
  25 building a robust and clean analyzer and utilities that complete netsniff-ng as
  26 a support for network development, debugging or network reconnaissance. (Note:
  27 libpcap starting from 1.0.0 now also supports zero-copy, but for capturing only)
  28
  29 The netsniff-ng toolkit currently consists of the following utilities:
  30
  31   * netsniff-ng: a zero-copy analyzer, pcap capturing and replaying tool
  32   * trafgen: a high performance zero-copy network packet generator
  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 ISP testing utility
  36   * flowtop: a top-like netfilter connection tracking tool
  37   * bpfc: a tiny Berkeley Packet Filter compiler supporting 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). This
  45 project is purely non-commercial and will always stay that way! The current
  46 project status can be considered as "working". In general, all tools have been
  47 tested by us to a great extend including their command-line options. In fact,
  48 many of our tools are used in production systems. However, we give no guarantee
  49 that our tools are free of bugs! If you spot some issues, contact us as
  50 described in REPORTING-BUGS.
  51
  52 Also, have a look at our FAQ [2] for answering your questions. Furthermore,
  53 we have a development blog [3] where we sometimes drop some interesting things
  54 or news for the outside world! A public repository of the old stable releases
  55 can be found here [4].
  56
  57 Happy packet hacking!
  58
  59 [1] http://netsniff-ng.org/
  60 [2] http://netsniff-ng.org/faq.html
  61 [3] http://dev.netsniff-ng.org/
  62 [4] http://pub.netsniff-ng.org/