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