fixups
[netsniff-ng.git] / README
blob6b9eef31675855087fd19f7100a26ec997810be5
1 ////////////////////////////////////////////////////////////////
3         netsniff-ng - the packet sniffing beast
5 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
7 netsniff-ng is is a free, performant Linux network analyzer and networking
8 toolkit [1].
10 The gain of performance is reached by 'zero-copy' mechanisms, so that the
11 kernel does not need to copy packets from kernelspace to userspace and vice
12 versa.
14 For this purpose netsniff-ng is libpcap independent, but nevertheless supports
15 the pcap file format for capturing, replaying and performing offline-analysis
16 of pcap dumps. Furthermore we are focussing on building a robust, clean and
17 secure analyzer and utilities that complete netsniff-ng as a support for
18 penetration testing.
20 netsniff-ng can be used for protocol analysis, reverse engineering and network
21 debugging and currently consists of the following tools:
23   * netsniff-ng: the 'zero-copy' sniffer itself
24   * trafgen: a powerful 'zero-copy' network packet generator
25   * ifpps: a top-like kernel networking statistics tool
26   * curvetun: an ECC-based multiuser IP tunnel
27   * bpfc: a tiny BPF compiler
29 For any questions or feedback about netsniff-ng you are welcome to leave us a
30 message to <workgroup@netsniff-ng.org>. This project is purely non-commercial
31 and will always stay that way! netsniff-ng is developed by Daniel Borkmann and
32 Emmanuel Roullit.
34 Also, have a look at our FAQ [2] for answering your questions. Furthermore,
35 we have a development blog [3] where we sometimes drop some interesting things
36 or news for the outside world! A public repository of the old stable releases
37 (which you probably do not want to have a look at), can be found here [4]. A 
38 probably not so much up-to-date benchmark is available to the public [5], too.
40 Sometimes we also hang out in IRC at #netsniff-ng on freenode.org. A mailing
41 list for netsniff-ng moderated (spam free) user discussions is open to the
42 public, too. Subscribe and mail to <netsniff-ng@googlegroups.com>.
44 You might want to have a look at NOTE, INSTALL, REPORTING-BUGS, HACKING,
45 CODING, FAQ, PATENTS and COPYING, too. Good lord, so much to read! Anyways,
46 enough talking from my side and happy packet hacking!
48 [1] http://netsniff-ng.org/
49 [2] http://netsniff-ng.org/faq.html
50 [3] http://dev.netsniff-ng.org/
51 [4] http://pub.netsniff-ng.org/
52 [5] http://netsniff-ng.org/bench.html