Corrected spinning loop potential in getrandombytes
[netsniff-ng-old.git] / README
blobdb51d5df1a5f7d6726d7e45f87fb3a1bb88fca24
1 //////////////////////////////////////////////////////////////////////////////
3                     netsniff-ng - the packet sniffing beast
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 
17 The gain of performance is reached by built-in zero-copy mechanisms, so that
18 on packet reception and transmission the kernel does not need to copy packets
19 from kernel space to user space, and vice versa.
21 The netsniff-ng toolkit's primary usage goal is to facilitate a network
22 developer's / hacker's daily Linux plumbing. It can be used for network
23 development, debugging, analysis, auditing or network reconnaissance. It
24 consists of the following fixed set of utilities:
26   * netsniff-ng: a zero-copy packet analyzer, pcap capturing/replaying tool
27   * trafgen: a multithreaded low-level zero-copy network packet generator
28   * mausezahn: high-level packet generator for HW/SW appliances with Cisco-CLI
29   * ifpps: a top-like kernel networking and system statistics tool
30   * curvetun: a lightweight curve25519-based multiuser IP tunnel
31   * astraceroute: an autonomous system trace route and DPI testing utility
32   * flowtop: a top-like netfilter connection tracking tool
33   * bpfc: a Berkeley Packet Filter compiler with Linux extensions
35 Have a look at the Documentation/ folder for further information, also at known
36 issues under Documentation/KnownIssues. Carefully read the INSTALL document for
37 the next steps in building netsniff-ng. Note that the toolkit is still quite
38 young and under heavy development, not yet feature complete and in a quality
39 level where we're satisfied with (i.e. for mausezahn). However, we're on a good
40 way towards tackling all these goals.
42 The netsniff-ng toolkit is an open source project covered by the GNU General 
43 Public License, version 2.0. For any questions or feedback about netsniff-ng
44 you are welcome to leave us a message at <netsniff-ng@googlegroups.com>.
46 netsniff-ng is non-profit and provided in the hope, that it is found useful.
47 The current project status can be considered as "working". In general, all tools
48 have been tested by us to a great extend including their command-line options.
49 In fact, many of our tools are used in a lot of production systems. However, we
50 give no guarantee that our tools are free of bugs! If you spot some issues,
51 contact us as described in REPORTING-BUGS. Also, have a look at our FAQ [2] for
52 answering your questions. This project has received support from companies and
53 institutions listed in Documentation/Sponsors. Thanks for contributing, we're
54 thrilled to provide you with netsniff-ng!
56 Happy packet hacking!
58   [1] http://netsniff-ng.org/
59   [2] http://netsniff-ng.org/faq.html