contrib/html/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3
   4 <head>
   5 <title>netsniff-ng - the packet sniffing beast</title>
   6
   7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   8 <meta name="Robots" content="noarchive">
   9
  10 <link rel="Shortcut Icon" href="http://netsniff-ng.org/img/tiny-logo.png" type="image/png">
  11 <link type="text/css" rel="stylesheet" media="screen" href="style.css" />
  12
  13 <script type="text/javascript">
  14   function InsertMail(mailnam,mailsvr,maildom)
  15   {
  16     document.write('&lt;<a href="mailto:' + mailnam + '@' + mailsvr + '.'
  17       + maildom + '">' + mailnam + '@' + mailsvr + '.' + maildom +
  18       '<\/a>&gt;');
  19   }
  20 </script>
  21 </head>
  22
  23 <body>
  24 <a href="https://github.com/gnumaniacs/netsniff-ng"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a>
  25 <blockquote>
  26 <p>
  27 <table border="0">
  28 <tr>
  29 <td>
  30 <a href="http://netsniff-ng.org"><img src="http://netsniff-ng.org/img/logo.png" border="0" alt="netsniff-ng"></a>
  31 </td>
  32 <td>
  33 <br><br><br>
  34 <img src="http://netsniff-ng.org/img/logo2.png" border="0" alt="the packet sniffing beast">
  35 </td>
  36 </tr>
  37 </table>
  38 </blockquote>
  39
  40 <table border="1" width="100%" class="header"<tr><td>
  41 <table border="0" width="90%">
  42 <tr>
  43   <td valign="top" width="200" align="right">
  44     <b>Latest version:</b>
  45   </td>
  46   <td valign="top">
  47     <a href="https://github.com/gnumaniacs/netsniff-ng/tree/master">netsniff-ng 0.5.8-next</a> (<a href="http://git.cryptoism.org/cgit.cgi/netsniff-ng.git/">M</a>, <a href="http://repo.or.cz/w/netsniff-ng.git/">M</a>, <a href="https://github.com/gnumaniacs/netsniff-ng/tarball/master">T</a>, <a href="http://lingrok.org/xref/netsniff-ng/">X</a>, <a href="https://github.com/gnumaniacs/netsniff-ng/tags">A</a>)<br>
  48     <a href="http://pub.netsniff-ng.org/netsniff-ng/netsniff-ng-0.5.7.tar.gz">netsniff-ng 0.5.7-curr</a> (<a href="http://dl.packetstormsecurity.net/sniffers/netsniff-ng-0.5.7.tar.gz">M</a>)<br>
  49   </td>
  50 </tr>
  51 </table>
  52 </td></tr></table>
  53 <br>
  54 <table border="1" width="100%" class="header"><tr><td>
  55 <table border="0" width="90%">
  56 <tr>
  57   <td valign="top" width="200" align="right">
  58     <b>Git repository:</b>
  59   </td>
  60   <td valign="top">
  61     git clone git://<a href="https://github.com/gnumaniacs/netsniff-ng">github.com/gnumaniacs/netsniff-ng</a>.git
  62   </td>
  63 </tr>
  64 <tr>
  65   <td valign="top" width="200" align="right">
  66     <b>Git web:</b>
  67   </td>
  68   <td valign="top">
  69     <a href="http://src.netsniff-ng.org/">http://src.netsniff-ng.org/</a><br>
  70   </td>
  71 </tr>
  72 </table>
  73 </td></tr></table>
  74 <br>
  75 <table border="1" width="100%" class="header"><tr><td>
  76 <table border="0" width="90%">
  77 <tr>
  78   <td valign="top" width="200" align="right">
  79     <b>Bug tracker:</b>
  80   </td>
  81   <td valign="top">
  82     <a href="http://bugs.netsniff-ng.org/">http://bugs.netsniff-ng.org/</a>
  83   </td>
  84 </tr>
  85 <tr>
  86   <td valign="top" width="200" align="right">
  87     <b>Mailing list:</b>
  88   </td>
  89   <td valign="top">
  90     via <a href="http://groups.google.com/group/netsniff-ng">Google</a> (<a href="http://news.gmane.org/gmane.linux.network.netsniff-ng">M</a>, <a href="http://www.mail-archive.com/netsniff-ng%40googlegroups.com/">M</a>), <a href="http://tools.ietf.org/html/rfc1855">How to Post</a>
  91   </td>
  92 </tr>
  93 <tr>
  94   <td valign="top" width="200" align="right">
  95     <b>Contribute:</b>
  96   </td>
  97   <td valign="top">
  98     <a href="https://github.com/gnumaniacs/netsniff-ng/blob/master/TODO">Hack the Code</a>, <a href="https://github.com/gnumaniacs/netsniff-ng/blob/master/Documentation/SubmittingPatches">How to Hack</a>
  99   </td>
 100 </tr>
 101 </table>
 102 </td></tr></table>
 103
 104 <h2>Abstract</h2>
 105 <p>
 106 netsniff-ng is a free, performant Linux networking toolkit.
 107 <br><br>
 108 The gain of performance is reached by zero-copy mechanisms, so that on packet reception <i>and</i> transmission the kernel does not need to copy packets from kernel space to user space and vice versa.
 109 <br><br>
 110 Our toolkit can be used for network development and analysis, debugging, auditing or network reconnaissance.
 111 <br><br>
 112 The netsniff-ng toolkit consists of the following utilities:
 113 <ul>
 114   <li><b>netsniff-ng</b>, a high-performance zero-copy analyzer, pcap capturing and replaying tool</li>
 115   <li><b>trafgen</b>, a high-performance zero-copy network traffic generator</li>
 116   <li><b>mausezahn</b>, a packet generator and analyzer for HW/SW appliances with a Cisco-CLI</li>
 117   <li><b>bpfc</b>, a Berkeley Packet Filter (BPF) compiler with Linux extensions</li>
 118   <li><b>ifpps</b>, a top-like kernel networking and system statistics tool</li>
 119   <li><b>flowtop</b>, a top-like netfilter connection tracking tool</li>
 120   <li><b>curvetun</b>, a lightweight multiuser IP tunnel based on elliptic curve cryptography</li>
 121   <li><b>astraceroute</b>, an autonomous system (AS) trace route utility</li>
 122 </ul>
 123 <p>
 124
 125 <h2>Development</h2>
 126 <p>
 127 <b>Source control</b>
 128 <p>
 129 There's a public Git repository at <a href="https://github.com/gnumaniacs/netsniff-ng">GitHub</a> where you can check out the entire code base. If you are curious about the latest development happenings, you really might prefer our Git master's branch instead of the tarballs within our <a href="http://pub.netsniff-ng.org/">public archive</a>. For tamper resistant downloading, clone the Git repository and checkout the corresponding version tag.
 130 <p>
 131 <b>Documents</b>
 132 <p>
 133 There is a netsniff-ng <a href="faq.html">frequently asked question</a> site and for participating in development have a look at the documentation files within the source code. <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0-faq.html">Here</a> is also a FAQ about the GNU GPL version 2, under which netsniff-ng is licensed.
 134 <p>
 135 For reporting bugs please use our <a href="http://bugs.netsniff-ng.org/">bug tracking system</a> or write an e-mail to <script type="text/javascript">InsertMail("bugs", "netsniff-ng", "org");</script>.
 136 <p>
 137 <b>Contribute</b>
 138 <p>
 139 If you think this software is great, then please consider to contribute in one of the following ways:
 140 <ul>
 141   <li>Review and contribute to the <a href="https://github.com/gnumaniacs/netsniff-ng">source code</a> (see <a href="https://github.com/gnumaniacs/netsniff-ng/blob/master/TODO">todo</a> file)</li>
 142   <li>Add or improve documentation, Man-pages, write interesting howtos or blog articles</li>
 143   <li>Mention us in your talks at conferences</li>
 144   <li>Maintain distribution specific packages</li>
 145   <li>Donate hardware, networking equipment, especially for 10-Gbit/s-Ethernet</li>
 146   <li>Test netsniff-ng on your specific platform, especially on non-x86/x86_64</li>
 147 </ul>
 148 <p>
 149 Currently, netsniff-ng is only available for Linux platforms. If you have a port for *BSD, let us know for merging your port into the main source tree. However, please do not port netsniff-ng to Windows or other proprietary junk! Here is a nice explanation why; we share Felix von Leitner's <a href="http://www.fefe.de/nowindows/">point of view</a>.
 150
 151 <h2>Documentation</h2>
 152 <p>
 153 The man page of each stable release of netsniff-ng will cover all of the usage details. It is included within the source code distribution package. We also have a <a href="faq.html">frequently asked question</a> page. Furthermore, the documents within the <a href="https://github.com/gnumaniacs/netsniff-ng/tree/master/Documentation">repository</a> will give you some useful information. Also see the Wikipedia <a href="http://en.wikipedia.org/wiki/Netsniff-ng">article</a> people wrote about netsniff-ng.
 154 <p>
 155 To dig into the inner workings of the Berkeley Packet Filter architecture, have a look at <a href="bpf.pdf">this</a>. Documentation about the ``packet_mmap'' architecture with ``pf_packet'' sockets for the Linux kernel can be downloaded from <a href="http://www.kernel.org/">kernel.org</a> under <a href="http://lxr.linux.no/linux+v3.2.9/Documentation/networking/packet_mmap.txt">packet_mmap.txt</a>.
 156
 157 <h2>Support</h2>
 158 <p>
 159 A mailing list for netsniff-ng moderated (spam free) user discussions is open to the <a href="http://groups.google.com/group/netsniff-ng">public</a>. Subscribe and mail to <script type="text/javascript">InsertMail("netsniff-ng", "googlegroups", "com");</script>. There's also an archive at <a href="http://dir.gmane.org/gmane.linux.network.netsniff-ng">Gmane</a> and a <a href="http://www.mail-archive.com/netsniff-ng%40googlegroups.com/">searchable archive</a>.
 160 <p>
 161 Before posting questions, have a look at our <a href="faq.html">FAQ</a>.<br><br>
 162
 163 <p>
 164 <a href="http://www.debian.org/"><img src="http://netsniff-ng.org/img/debian.png" border="0" alt="powered by Debian"></a>&nbsp;
 165 <a href="http://www.vim.org/"><img src="http://netsniff-ng.org/img/vim.png" border="0" alt="powered by vim"></a>&nbsp;
 166 <a href="http://www.anybrowser.org/campaign/"><img src="http://netsniff-ng.org/img/vt100.gif" border="0" alt="best viewed with vt100"></a>&nbsp;
 167 <a href="http://eupat.ffii.org/"><img src="http://netsniff-ng.org/img/no_epatent.png" border="0" alt="no epatents"></a>&nbsp;
 168 <a href="http://www.laquadrature.net/"><img src="http://netsniff-ng.org/img/qdn.png" border="0" alt="qdn"></a>
 169 <table border="0" width="90%">
 170 <tr>
 171   <td>
 172     <code>Copyright (C) 2009-2012 <a href="http://gnumaniacs.org">Daniel Borkmann</a>
 173     <script type="text/javascript">InsertMail("daniel", "netsniff-ng", "org");</script>
 174     and <a href="https://github.com/gnumaniacs/netsniff-ng/blob/master/AUTHORS">contributers</a>
 175     </code><br>
 176   </td>
 177 </tr>
 178 </table>
 179
 180 </body>
 181 </html>