summaryrefslogtreecommitdiff
path: root/README
blob: fdf591fb24c2d5880c7e76fd1ca3e55e24621fe1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
//////////////////////////////////////////////////////////////////////////////

                    netsniff-ng - the packet sniffing beast

\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
                                         .      .
netsniff-ng is a free, performant       /(      )\
Linux network analyzer and            .' {______} '.
networking toolkit. If you will,       \ ^,    ,^ /
the Swiss army knife for network        |'O\  /O'|   _.<0101011>--
packets.                                > `'  '` <  /
                                        ) ,.==., (  |
Web: http://netsniff-ng.org          .-(|/--~~--\|)-'
                                    (      ___
The gain of performance is           \__.=|___E 
reached by built-in zero-copy
mechanisms, so that on packet reception and transmission the kernel does not
need to copy packets from kernel space to user space, and vice versa.

The netsniff-ng toolkit's primary usage goal is to facilitate a network
developer's / hacker's daily Linux plumbing. It can be used for network
development, debugging, analysis, auditing or network reconnaissance. It
consists of the following fixed set of utilities:

  * netsniff-ng: a zero-copy packet analyzer, pcap capturing/replaying tool
  * trafgen: a multithreaded low-level zero-copy network packet generator
  * mausezahn: high-level packet generator for HW/SW appliances with Cisco-CLI
  * ifpps: a top-like kernel networking and system statistics tool
  * curvetun: a lightweight curve25519-based multiuser IP tunnel
  * astraceroute: an autonomous system trace route and DPI testing utility
  * flowtop: a top-like netfilter connection tracking tool
  * bpfc: a Berkeley Packet Filter compiler with Linux extensions

Have a look at the Documentation/ folder for further information, also at known
issues under Documentation/KnownIssues. Carefully read the INSTALL document for
the next steps in building netsniff-ng. Note that the toolkit is still quite
young and under heavy development, not yet feature complete and in a quality
level where we're satisfied with (i.e. for mausezahn). However, we're on a good
way towards tackling all these goals.

The netsniff-ng toolkit is an open source project covered by the GNU General 
Public License, version 2.0. For any questions or feedback about netsniff-ng
you are welcome to leave us a message at <netsniff-ng@googlegroups.com>.

netsniff-ng is non-profit and provided in the hope, that it is found useful.
The current project status can be considered as "working". In general, all tools
have been tested by us to a great extend including their command-line options.
In fact, many of our tools are used in a lot of production systems. However, we
give no guarantee that our tools are free of bugs! If you spot some issues,
contact us as described in REPORTING-BUGS. Also, have a look at our FAQ [2] for
answering your questions. This project has received support from companies and
institutions listed in Documentation/Sponsors. Thanks for contributing, we're
thrilled to provide you with netsniff-ng!

Happy packet hacking!

  [1] http://netsniff-ng.org/
  [2] http://netsniff-ng.org/faq.html