README

   1 What is netsniff-ng?
   2 ====================
   3
   4 netsniff-ng is a high performance Linux network sniffer for packet
   5 inspection.
   6
   7 Basically it is similar to analyzers like tcpdump, but without the
   8 need to perform system calls for fetching network packets. A memory
   9 mapped area within kernelspace will be used for accessing packets,
  10 thus there is no requirement for copying them to userspace ('zero-copy'
  11 mechanism). For this purpose netsniff-ng is libpcap independent, but
  12 nevertheless supports the pcap file format for capturing, replaying and
  13 performing offline-analysis of pcap dumps. Furthermore we are focussing
  14 on building a robust, clean and secure analyzer and utilities that
  15 complete netsniff-ng as a support for penetration testing.
  16
  17 netsniff-ng can be used for protocol analysis, reverse engineering and
  18 network debugging.
  19
  20 Some use cases and features
  21 ===========================
  22
  23 * Open source project and free licensing
  24 * Analizing and debugging of network problems or protocol implementations
  25 * Reverse engineering of (proprietary) network protocols
  26 * Dumping, replaying and offline analysis of pcap traces
  27 * Integrated high performance capabilities
  28 * Focus on usability, robustness, security and functionality
  29 * Support utility for penetration testing
  30 * Regular expression based grepping of specific packet information
  31 * Monitoring of network usage
  32 * Network statistic creation (e.g. for Nagios)
  33
  34 What are the main goals?
  35 ========================
  36
  37 netsniff-ngs main goal is to be a high performance network sniffer that
  38 focuses on usability, robustness and functionality. Its aim is to support
  39 the daily work for networking engineers, developers, admins or Linux
  40 users by providing support with or in network monitoring, protocol
  41 analysis, reverse engineering, network debugging and penetration testing.
  42
  43 Homepage
  44 ========
  45
  46 You can reach us via http://www.netsniff-ng.org/.
  47
  48 Installation
  49 ============
  50
  51 For installation instructions, have a look at INSTALL.
  52
  53 Development
  54 ===========
  55
  56 There's a public Git repository at http://github.com/danborkmann/netsniff-ng/
  57 where you can check out the latest code base.
  58
  59 git clone git://github.com/danborkmann/netsniff-ng.git
  60
  61 Note that there is also a HACKING and TODO file for further readings. Next to
  62 this we've set up a FAQ page with development questions at
  63 http://netsniff-ng.org/faq.html.
  64
  65 Our coding conventions can be found in CODING.
  66
  67 Contact
  68 =======
  69
  70 For questions:
  71     <workgroup@netsniff-ng.org>,
  72     <netsniff-ng@googlegroups.com>,
  73     http://netsniff-ng.org/faq.html
  74     #netsniff-ng on freenode.org
  75
  76 For bugs:
  77     <bugs@netsniff-ng.org>,
  78     http://github.com/danborkmann/netsniff-ng/issues/
  79
  80 For improvements, hacks and all the rest:
  81     <workgroup@netsniff-ng.org>
  82
  83 Website:
  84     http://www.netsniff-ng.org/
  85
  86 IRC:
  87     #netsniff-ng on freenode.org
  88
  89 Hosted on and associated with:
  90     http://www.gnumaniacs.org/
  91
  92 In honorem ...
  93 ==============
  94
  95 Leipzig University of Applied Science,
  96 Faculty of Computer Science, Mathematics and Natural Sciences
  97 http://www.imn.htwk-leipzig.de/
  98