docs: minor reformatting in readme
[netsniff-ng.git] / contrib / html / index.html
blob141ec942233fa8c8533aaadaaf606c359e81981a
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
4 <head>
5 <title>netsniff-ng - the packet sniffing beast</title>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8 <meta name="Robots" content="noarchive">
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" />
13 <script type="text/javascript">
14 function InsertMail(mailnam,mailsvr,maildom)
16 document.write('&lt;<a href="mailto:' + mailnam + '@' + mailsvr + '.'
17 + maildom + '">' + mailnam + '@' + mailsvr + '.' + maildom +
18 '<\/a>&gt;');
20 </script>
21 </head>
23 <body>
24 <a href="https://github.com/gnumaniacs/netsniff-ng/"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://a248.e.akamai.net/assets.github.com/img/7afbc8b248c68eb468279e8c17986ad46549fb71/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub"></a>
25 <blockquote>
27 <p>
28 <table border="0">
29 <tr>
30 <td>
31 <a href="http://netsniff-ng.org"><img src="http://netsniff-ng.org/img/logo.png" border="0" alt="netsniff-ng"></a>
32 </td>
33 <td>
34 <br><br><br>
35 <img src="http://netsniff-ng.org/img/logo2.png" border="0" alt="the packet sniffing beast">
36 </td>
37 </tr>
38 </table>
39 </blockquote>
41 <table border="1" width="100%" class="header"<tr><td>
42 <table border="0" width="90%">
43 <tr>
44 <td valign="top" width="200" align="right">
45 <b>Latest version:</b>
46 </td>
47 <td valign="top">
48 <a href="https://github.com/gnumaniacs/netsniff-ng/tree/master">netsniff-ng 0.5.6-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="https://github.com/gnumaniacs/netsniff-ng/tags">A</a>)
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://github.com/gnumaniacs/netsniff-ng.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">Gmane</a>, <a href="http://www.mail-archive.com/netsniff-ng%40googlegroups.com/">Archive</a>
91 </td>
92 </tr>
93 <tr>
94 <td valign="top" width="200" align="right">
95 <b>IRC:</b>
96 </td>
97 <td valign="top">
98 <a href="http://webchat.freenode.net/?randomnick=1&channels=netsniff-ng&uio=d4">#netsniff-ng@irc.freenode.net</a>
99 </td>
100 </tr>
101 <tr>
102 <td valign="top" width="200" align="right">
103 <b>Blog:</b>
104 </td>
105 <td valign="top">
106 <a href="http://blog.netsniff-ng.org/">http://blog.netsniff-ng.org/</a>
107 </td>
108 </tr>
109 <tr>
110 <td valign="top" width="200" align="right">
111 <b>Support us:</b>
112 </td>
113 <td valign="top">
114 via <a href="http://flattr.com/thing/421382/gnumaniacs-devs" target="_blank">Flattr</a> or <a href="https://github.com/gnumaniacs/netsniff-ng/blob/master/PROJECTS">Contribute</a> to the <a href="https://github.com/gnumaniacs/netsniff-ng">Source Code</a><br>
115 </td>
116 </tr>
117 </table>
118 </td></tr></table>
120 <h2>Abstract</h2>
122 netsniff-ng is a free, performant Linux networking toolkit.
123 <br><br>
124 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.
125 <br><br>
126 For this purpose, the netsniff-ng toolkit is libpcap independent, but nevertheless supports the pcap file format for capturing, replaying and performing offline-analysis of pcap dumps. Furthermore, we are focussing on building a robust and clean analyzer and utilities that complete netsniff-ng as a support for network development, debugging or network reconnaissance.
127 <br><br>
128 The netsniff-ng toolkit consists of the following utilities:
129 <ul>
130 <li><b>netsniff-ng</b>, a zero-copy analyzer, pcap capturer and replayer</li>
131 <li><b>trafgen</b>, a high-performance zero-copy network traffic generator</li>
132 <li><b>bpfc</b>, a Berkeley Packet Filter compiler supporting Linux extensions</li>
133 <li><b>ifpps</b>, a top-like kernel networking and system statistics tool</li>
134 <li><b>flowtop</b>, a top-like netfilter connection tracking tool</li>
135 <li><b>curvetun</b>, a lightweight multiuser IP tunnel based on elliptic curve cryptography</li>
136 <li><b>ashunt</b>, an Autonomous System (AS) trace route and ISP testing utility</li>
137 </ul>
139 (Note: <a href="http://www.tcpdump.org/">libpcap</a> starting from 1.0.0 now also supports zero-copy, but for capturing only! netsniff-ng's pcap files can also be opened with tools like <a href="http://www.wireshark.org/">Wireshark</a>, and vice versa!)
141 <h2>Development</h2>
143 <b>Source control</b>
145 There's a public Git repository at <a href="https://github.com/gnumaniacs/netsniff-ng">https://github.com/gnumaniacs/netsniff-ng</a> (<a href="http://repo.or.cz/w/netsniff-ng.git">mirror</a>, <a href="http://git.cryptoism.org/cgit.cgi/netsniff-ng.git/">mirror</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>. However, in case of the tarballs, you might want to check the downloaded archives for inconsistencies with <code>md5sum -c MD5SUMS</code> or <code>sha256sum -c SHA256SUMS</code>.
147 <b>Documents</b>
149 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, especially the CODING and HACKING files. <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.
151 For reporting bugs please use our <a href="http://bugs.netsniff-ng.org/">bug tracking system</a> or
152 write an e-mail to <script type="text/javascript">InsertMail("bugs", "netsniff-ng", "org");</script>.
154 <b>Contribute</b>
156 If you think this software is great, then please consider <a href="http://flattr.com/thing/421382/gnumaniacs-devs" target="_blank">donating</a> (Flattr) some money to help us to keep up development, server fees, or travelling costs for conferences.
157 If you would like to help otherwise, we would like to see more people to:
158 <ul>
159 <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/PROJECTS">PROJECTS</a> file)</li>
160 <li>Adding or updating documentation, Manpages, write interesting howtos</li>
161 <li>Donate hardware, networking equipment, especially for 10-Gbit/s-Ethernet</li>
162 <li>Maintain distribution specific packages</li>
163 <li>Test netsniff-ng on your specific platform, especially on non-x86</li>
164 <li>Mirror our site and public archive, <a href="https://github.com/gnumaniacs/netsniff-ng">fork/hack</a> on the source</li>
165 </ul>
167 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! (Here is a nice explanation why; we really share <a href="http://www.fefe.de/nowindows/">Felix von Leitner's point of view</a>.)
169 <h2>Documentation</h2>
171 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 repository will give you some useful information.
173 To dig into the inner workings of the Berkeley Packet Filter architecture have a look at <a href="bpf.pdf">this</a>.
175 Documentation about the ``packet_mmap'' architecture with ``pf_packet'' sockets for the Linux kernel can be downloaded from <a href="http://www.kernel.org/">http://www.kernel.org/</a> under <a href="http://lxr.linux.no/linux+v3.2.9/Documentation/networking/packet_mmap.txt">packet_mmap.txt</a>.
177 <h2>Support</h2>
179 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>.
181 Before posting questions, have a look at our <a href="faq.html">FAQ</a>.
183 <h2>netsniff-ng around the world</h2>
185 Distribution specific packages -- a huge thanks to our awesome maintainers -- may be found here:
186 <ul>
187 <li><a href="http://packages.debian.org/search?keywords=netsniff-ng">Debian</a> - by <a href="http://people.debian.org/~kartik/">Kartik Mistry</a></li>
188 <li><a href="https://admin.fedoraproject.org/pkgdb/acls/name/netsniff-ng">Fedora/RHEL</a> - by <a href="http://fedoraproject.org/wiki/User:Jskala">Jiří Skála </a></li>
189 <li><a href="https://launchpad.net/ubuntu/+source/netsniff-ng/">Ubuntu</a> - pulled from Debian</li>
190 <li><a href="http://aur.archlinux.org/packages.php?K=netsniff-ng">Arch Linux</a> - by <a href="mailto:dcelasun@nospam.gmail.com">Dcelasun</a></li>
191 <li><a href="http://packages.gentoo.org/package/net-analyzer/netsniff-ng">Gentoo</a> - by <a href="mailto:xmw@nospam.gentoo.org">Michael Weber</a></li>
192 <li><a href="http://gpo.zugaina.org/net-misc/netsniff-ng">Sabayon</a> - by <a href="mailto:epinephrineaddict@nospam.gmail.com">Epinephrine</a></li>
193 <li><a href="http://www.slackers.it/repository/netsniff-ng/">Slackware</a> - by <a href="mailto:conraid@nospam.gmail.com">Corrado Franco</a></li>
194 <li><a href="http://software.opensuse.org/search?baseproject=ALL&amp;p=1&amp;q=netsniff-ng">openSUSE/SLE</a> - by <a href="mailto:pascal.bleser@nospam.skynet.be">Pascal Bleser</a></li>
195 <li><a href="http://sophie.zarb.org/srpm/Mandriva,cooker,/netsniff-ng">Mandriva</a> - by <a href="mailto:guillomovitch@nospam.mandriva.org">Guillaume Rousse</a></li>
196 <li><a href="http://packages.trisquel.info/slaine/net/netsniff-ng">Trisquel</a> - pulled from Debian</li>
197 <li><a href="http://grml.org/">GRML</a> - pulled from Debian</li>
198 <li><a href="http://git.alpinelinux.org/cgit/aports.git/commit/?id=43f91b3d133e6937a3de8372f60733d02f3fa065">Alpine Linux</a> - by <a href="mailto:fabian@nospam.affolter-engineering.ch">Fabian Affolter</a></li>
199 </ul>
201 Some documents and other resources may be found here:
202 <ul>
203 <li><a href="http://www.cs.columbia.edu/~hgs/internet/traffic-generator.html">Columbia University</a></li>
204 <li><a href="http://www.grid.unina.it/software/ITG/link.php">University of Napoli Federico II</a></li>
205 <li><a href="http://portal.imn.htwk-leipzig.de/fakultaet/forschung/studentische-projekte">Leipzig University of Applied Sciences</a></li>
206 <li><a href="http://packetstormsecurity.org/files/author/7838/">Packetstormsecurity</a></li>
207 <li><a href="http://pastebin.com/1aHHYbGC">Fedora's Security Spin</a></li>
208 <li><a href="http://www.xplico.org/archives/944">netsniff-ng for Xplico</a></li>
209 <li><a href="http://networksecuritytoolkit.org/">Network Security Toolkit (NST)</a></li>
210 <li><a href="http://wiki.networksecuritytoolkit.org/nstwiki/index.php/LAN_Ethernet_Maximum_Rates,_Generation,_Capturing_%26_Monitoring">NST Wiki article, including netsniff-ng</a></li>
211 <li><a href="http://carnivore.it/2011/12/27/linux_3.0_bpf_jit_x86_64_exploit">Linux 3.0 BPF JIT x86_64 exploit (utilized bpfc)</a></li>
212 <li><a href="http://wiki.alpinelinux.org/wiki/Alpine_security">Alpine Linux Security Toolset</a></li>
213 </ul>
215 Note: If your netsniff-ng related project / article / paper / ... should be added here, simply drop us a mail.
218 <a href="http://www.debian.org/"><img src="http://netsniff-ng.org/img/debian.png" border="0" alt="powered by Debian"></a>&nbsp;
219 <a href="http://www.vim.org/"><img src="http://netsniff-ng.org/img/vim.png" border="0" alt="powered by vim"></a>&nbsp;
220 <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;
221 <a href="http://eupat.ffii.org/"><img src="http://netsniff-ng.org/img/no_epatent.png" border="0" alt="no epatents"></a>&nbsp;
222 <a href="http://www.laquadrature.net/"><img src="http://netsniff-ng.org/img/qdn.png" border="0" alt="qdn"></a>
224 <table border="0" width="90%">
225 <tr>
226 <td>
227 <address>Copyright (C) 2009-2012 <a href="http://gnumaniacs.org">Daniel Borkmann</a>
228 <script type="text/javascript">InsertMail("daniel", "netsniff-ng", "org");</script>
230 <a href="http://emmanuel.netsniff-ng.org">Emmanuel Roullit</a>
231 <script type="text/javascript">InsertMail("emmanuel", "netsniff-ng", "org");</script>
232 </address>
233 </td>
234 </tr>
235 </table>
237 </body>
238 </html>