summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDaniel Borkmann <dborkman@redhat.com>2013-03-15 10:41:48 +0100
committerDaniel Borkmann <dborkman@redhat.com>2013-03-15 10:41:48 +0100
commit1a9fbac03c684f29cff9ac44875bd9504a89f54e (patch)
tree1b2e40dbe5dc1899ef5b62c4325c9b94c9c450fc /README
all: import netsniff-ng 0.5.8-rc0 source
We decided to get rid of the old Git history and start a new one for several reasons: *) Allow / enforce only high-quality commits (which was not the case for many commits in the history), have a policy that is more close to the one from the Linux kernel. With high quality commits, we mean code that is logically split into commits and commit messages that are signed-off and have a proper subject and message body. We do not allow automatic Github merges anymore, since they are total bullshit. However, we will either cherry-pick your patches or pull them manually. *) The old archive was about ~27MB for no particular good reason. This basically derived from the bad decision that also some PDF files where stored there. From this moment onwards, no binary objects are allowed to be stored in this repository anymore. The old archive is not wiped away from the Internet. You will still be able to find it, e.g. on git.cryptoism.org etc. Signed-off-by: Daniel Borkmann <dborkman@redhat.com> Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..fdf591f
--- /dev/null
+++ b/README
@@ -0,0 +1,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