README

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