README

   1 $Id: README,v 1.41 2000/08/22 06:50:04 gram Exp $
   2
   3 General Information
   4 ------- -----------
   5
   6 Ethereal is a network traffic analyzer, or "sniffer", for Unix and
   7 Unix-like operating systems.  It uses GTK+, a graphical user interface
   8 library, and libpcap, a packet capture and filtering library.
   9
  10 The Ethereal distribution also comes with Tethereal, which is a
  11 line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
  12 same dissection, capture-file reading and writing, and packet filtering
  13 code as Ethereal, and with editcap, which is a program to read capture
  14 files and write the packets from that capture file, possibly in a
  15 different capture file format, and with some packets possibly removed
  16 from the capture.
  17
  18 The official home of Ethereal is
  19
  20     http://ethereal.zing.org
  21
  22 The latest distribution can be found in the subdirectory
  23
  24     http://ethereal.zing.org/distribution
  25
  26
  27 Installation
  28 ------------
  29
  30 Ethereal is known to compile and run on the following systems:
  31
  32   - Linux (2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x)
  33   - Solaris (2.5.1, 2.6, 7)
  34   - FreeBSD (2.2.5, 2.2.6, 3.1, 3.2, 3.3)
  35   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  36   - Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
  37   - Irix (6.5)
  38   - AIX (4.3.2, with a bit of work)
  39   - Win32 (NT, 98)
  40
  41 It should run on other Unix-ish systems without too much trouble.
  42
  43 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
  44 work with the "make" that comes with Solaris 7 nor the BSD "make".
  45 Perl is also needed to create the man page.
  46
  47 If you decide to modify the yacc grammar or lex scanner, then
  48 you need "flex" - it cannot be built with vanilla "lex" -
  49 and either "bison" or the Berkeley "yacc". Your flex
  50 version must be 2.5.1 or greater. Check this with 'flex -V'.
  51
  52 If you decide to modify the NetWare Core Protocol dissector, you
  53 will need python, as the data for packet types is stored in a python
  54 script, ncp2222.py.
  55
  56 You must therefore install Perl, GNU "make", "flex", and either "bison" or
  57 Berkeley "yacc" on systems that lack them.
  58
  59 Full installation instructions can be found in the INSTALL file.
  60
  61 See also the appropriate README.<OS> files for OS-specific installation
  62 instructions.
  63
  64 Usage
  65 -----
  66
  67 In order to capture packets from the network, you need to be running as
  68 root, or have access to the appropriate entry under /dev if your system
  69 is so inclined (BSD-derived systems, and systems such as Solaris and
  70 HP-UX that support DLPI, typically fall into this category).  Although
  71 it might be tempting to make the Ethereal executable setuid root, please
  72 don't - alpha code is by nature not very robust, and liable to contain
  73 security holes.
  74
  75 Please consult the man page for a description of each command-line
  76 option and interface feature.
  77
  78
  79 Multiple File Types
  80 -------------------
  81
  82 The wiretap library is a packet-capture library currently under
  83 development parallel to ethereal.  In the future it is hoped that
  84 wiretap will have more features than libpcap, but wiretap is still in
  85 its infancy. However, wiretap is used in ethereal for its ability
  86 to read multiple file types. You can read the following file
  87 formats:
  88
  89 libpcap (tcpdump -w, Ethereal)
  90 Sniffer (compressed and uncompressed)
  91 NetXray
  92 Sniffer Pro
  93 snoop
  94 Shomiti
  95 LANalyzer
  96 Microsoft Network Monitor
  97 AIX's iptrace
  98 RADCOM's WAN/LAN Analyzer
  99 Lucent/Ascend access products
 100 HP-UX's nettl
 101 Toshiba's ISDN routers
 102 ISDN4BSD "i4btrace" utility
 103 Cisco Secure Intrustion Detection System iplogging facility
 104
 105 In addition, it can read gzipped versions of any of these files
 106 automatically, if you have the zlib library available when compiling
 107 Ethereal. Ethereal needs a modern version of zlib to be able to use
 108 zlib to read gzipped files; version 1.1.3 is known to work.  Versions
 109 prior to 1.0.9 are missing some functions that Ethereal needs and won't
 110 work.  "./configure" should detect if you have the proper zlib version
 111 available and, if you don't, should disable zlib support. You can always
 112 use "./configure --disable-zlib" to explicitly disable zlib support.
 113
 114 Although Ethereal can read AIX iptrace files, the documentation on
 115 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
 116 starts a daemon which you must kill in order to stop the trace. Through
 117 experimentation it appears that sending a HUP signal to that iptrace
 118 daemon causes a graceful shutdown and a complete packet is written
 119 to the trace file. If a partial packet is saved at the end, Ethereal
 120 will complain when reading that file, but you will be able to read all
 121 other packets.  If this occurs, please let the Ethereal developers know
 122 at ethereal-dev@zing.org, and be sure to send us a copy of that trace
 123 file if it's small and contains non-sensitive data.
 124
 125 Support for Lucent/Ascend products is limited to the debug trace output
 126 generated by the MAX and Pipline series of products.  Ethereal can read
 127 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
 128 commands.  For detailed information on use of these commands, please refer
 129 the following pages:
 130
 131 "wandsession", "wandisplay", and "wannext" on the Pipeline series:
 132   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006c79
 133
 134 "wandsession", "wandisplay", and "wannext" on the MAX series:
 135   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006972
 136
 137 "wdd" on the Pipeline series:
 138   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006877
 139
 140 Ethereal can also read dump trace output from the Toshiba "Compact Router"
 141 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 142 and start a dump session with "snoop dump".
 143
 144 To use the Lucent/Ascend and Toshiba traces with Ethereal, you must capture
 145 the trace output to a file on disk.  The trace is happening inside the router
 146 and the router has no way of saving the trace to a file for you.
 147 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 148 Or, if your system has the "script" command installed, you can save
 149 a shell session, including telnet to a file. For example, to a file named
 150 tracefile.out:
 151
 152 $ script tracefile.out
 153 Script started on <date/time>
 154 $ telnet router
 155 ..... do your trace, then exit from the router's telnet session.
 156 $ exit
 157 Script done on <date/time>
 158
 159
 160
 161 IPv6
 162 ----
 163 If your operating system includes IPv6 support, ethereal will attempt to
 164 use reverse name resolution capabilities when decoding IPv6 packets. If
 165 you want to turn off name resolution while using ethereal, start ethereal
 166 with the "-n" option. If you would like to compile ethereal without
 167 support for IPv6 name resolution, use the "--disable-ipv6" option with
 168 "./configure". If you compile ethereal without IPv6 name resolution,
 169 you will still be able to decode IPv6 packets, but you'll only see IPv6
 170 addresses, not host names.
 171
 172
 173 NetWare Core Protocol
 174 ---------------------
 175 There are over 400 different NCP packet types. The NCP dissector does
 176 not understand all of these; support is being added little by little. If
 177 you have some NCP packets that are not dissected by Ethereal, send
 178 a trace file to ethereal-dev@zing.org and if possible, we will add support
 179 for those packets types.
 180
 181
 182 SNMP
 183 ----
 184 Ethereal can do some basic decoding of SNMP packets; it can also use an
 185 external SNMP library to do more sophisticated decoding..  The configure
 186 script will automatically determine which library you have on your
 187 system and will use it.  If you have an SNMP library but _do not_ want
 188 to have ethereal use it, you can run configure with the "--disable-snmp"
 189 option.
 190
 191
 192 How to Report a Bug
 193 -------------------
 194 Ethereal is still under constant development, so it is possible that you will
 195 encounter a bug while using it. Please report bugs to ethereal-dev@zing.org.
 196 Be sure you tell us:
 197
 198         1) Operating System and version (the command 'uname -sr' may
 199            tell you this, although on Linux systems it will probably
 200            tell you only the version number of the Linux kernel, not of
 201            the distribution as a whole; on Linux systems, please tell us
 202            both the version number of the kernel, and which version of
 203            which distribution you're running)
 204         2) Version of GTK+ (the command 'gtk-config --version' will tell you)
 205         3) Version of Ethereal (the command 'ethereal -v' will tell you,
 206            unless the bug is so severe as to prevent that from working,
 207            and should also tell you the versions of libraries with which
 208            it was built)
 209         4) The command you used to invoke Ethereal, and the sequence of
 210            operations you performed that caused the bug to appear
 211
 212 If the bug is produced by a particular trace file, please be sure to send
 213 a trace file along with your bug description. Please don't send a trace file
 214 greater than 1 MB when compressed. If the trace file contains sensitive
 215 information (e.g., passwords), then please do not send it.
 216
 217 If Ethereal died on you with a 'segmentation violation', you can help the
 218 developers a lot if you have a debugger installed. A stack trace can be
 219 obtained by using your debugger ('gdb' in this example), the ethereal binary,
 220 and the resulting core file. Here's an example of how to use the gdb
 221 command 'backtrace' to do so.
 222
 223 $ gdb ethereal core
 224 (gdb) backtrace
 225 ..... prints the stack trace
 226 (gdb) quit
 227 $
 228
 229 Disclaimer
 230 ----------
 231
 232 There is no warranty, expressed or implied, associated with this product.
 233 Use at your own risk.
 234
 235
 236 Gerald Combs <gerald@zing.org>
 237 Gilbert Ramirez <gram@xiexie.org>
 238 Guy Harris <guy@alum.mit.edu>