README

   1 General Information
   2 ------- -----------
   3
   4 Ethereal is a network traffic analyzer, or "sniffer", for Unix and
   5 Unix-like operating systems.  It uses GTK+, a graphical user interface
   6 library, and libpcap, a packet capture and filtering library.
   7
   8 The official home of Ethereal is
   9
  10     http://ethereal.zing.org
  11
  12 The latest distribution can be found in the subdirectory
  13
  14     http://ethereal.zing.org/distribution
  15
  16 Interesting and exotic packet traces can be found at
  17
  18     http://ethereal.zing.org/~gram/sample.html
  19
  20
  21 Installation
  22 ------------
  23
  24 Ethereal is known to compile and run on the following systems:
  25
  26   - Linux (2.0.x, 2.1.x, 2.2.x)
  27   - Solaris (2.5.1, 2.6)
  28   - FreeBSD (2.2.5, 2.2.6)
  29   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  30   - Tru64 UNIX (formerly Digital UNIX) (3.2, 4.0)
  31   - Irix (version?)
  32
  33 It should run on other systems without too much trouble.
  34
  35 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
  36 work with the "make" that comes with Solaris 7 nor the BSD "make".
  37 Perl is also needed to create the man page.
  38
  39 If you decide to modify the yacc grammar or lex scanner, then
  40 you need "flex" - it cannot be built with vanilla "lex" -
  41 and either "bison" or the Berkeley "yacc". Your flex
  42 version must be 2.5.1 or greater. Check this with 'flex -V'.
  43
  44 You must therefore install Perl, GNU "make", "flex", and either "bison" or
  45 Berkeley "yacc" on systems that lack them.
  46
  47 Full installation instructions can be found in the INSTALL file.
  48
  49 See also the appropriate README.<OS> files for OS-specific installation
  50 instructions.
  51
  52 Usage
  53 -----
  54
  55 In order to capture packets from the network, you need to be running
  56 as root, or have access to the appropriate entry under /dev if your
  57 system is so inclined (BSD-derived systems and Solaris typically fall
  58 into this category.  Although it might be tempting to make the
  59 Ethereal executable setuid root, please don't - alpha code is by nature
  60 not very robust, and liable to contain security holes.
  61
  62 Please consult the man page for a description of each command-line
  63 option and interface feature.
  64
  65
  66 Multiple File Types
  67 -------------------
  68
  69 The wiretap library is a packet-capture library currently under
  70 development parallel to ethereal.  In the future it is hoped that
  71 wiretap will have more features than libpcap, but wiretap is still in
  72 its infancy. However, wiretap is used in ethereal for its ability
  73 to read multiple file types. You can read the following file
  74 formats, and create display filters for them as well:
  75
  76 libpcap (tcpdump -w), Sniffer (uncompressed), NetXray, Sniffer Pro,
  77 snoop, Shomiti, LANalyzer, Network Monitor, AIX's iptrace 2.0,
  78 RADCOM's WAN/LAN Analyzer, Lucent/Ascend access products, HP-UX's nettl,
  79 and Toshiba's ISDN routers.
  80
  81 Although Ethereal can read AIX iptrace files, the documentation on
  82 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
  83 starts a daemon which you must kill in order to stop the trace. Through
  84 experimentation it appears that sending a HUP signal to that iptrace
  85 daemon causes a graceful shutdown and a complete packet is written
  86 to the trace file. If a partial packet is saved at the end, Ethereal
  87 will complain when reading that file, but you will be able to read all
  88 other packets.  If this occurs, please let the Ethereal developers know
  89 at ethereal-dev@zing.org, and be sure to send us a copy of that trace
  90 file if it's small and contains non-sensitive data.
  91
  92 Support for Lucent/Ascend products is limited to the debug trace output
  93 generated by the MAX and Pipline series of products.  Ethereal can read
  94 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
  95 commands.  For detailed information on use of these commands, please refer
  96 the following pages:
  97
  98 "wandsession", "wandisplay", and "wannext" on the Pipeline series:
  99   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006c79
 100
 101 "wandsession", "wandisplay", and "wannext" on the MAX series:
 102   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006972
 103
 104 "wdd" on the Pipeline series:
 105   http://aos.ascend.com/aos:/gennavviewer.html?doc_id=0900253d80006877
 106
 107 Ethereal can also read dump trace output from the Toshiba "Compact Router"
 108 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 109 and start a dump session with "snoop dump".
 110
 111 To use the Lucent/Ascend and Toshiba traces with Ethereal, you must capture
 112 the trace output to a file on disk.  The trace is happening inside the router
 113 and the router has no way of saving the trace to a file for you.
 114 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 115 Or, if your system has the "script" command installed, you can save
 116 a shell session, including telnet to a file. For example, to a file named
 117 tracefile.out:
 118
 119 $ script tracefile.out
 120 Script started on <date/time>
 121 $ telnet router
 122 ..... do your trace, then exit from the router's telnet session.
 123 $ exit
 124 Script done on <date/time>
 125
 126
 127
 128 IPv6
 129 ----
 130 If your operating system includes IPv6 support, ethereal will attempt to
 131 use reverse name resolution capabilities when decoding IPv6 packets. If
 132 you want to turn off name resolution while using ethereal, start ethereal
 133 with the "-n" option. If you would like to compile ethereal without
 134 support for IPv6 name resolution, use the "--disable-ipv6" option with
 135 "./configure". If you compile ethereal without IPv6 name resolution,
 136 you will still be able to decode IPv6 packets, but you'll only see IPv6
 137 addresses, not host names.
 138
 139 The "Follow TCP Stream" feature only supports TCP over IPv4. Support for TCP
 140 over IPv6 is planned.
 141
 142
 143 SNMP
 144 ----
 145 Ethereal can do some basic decoding of SNMP packets, but it relies on an
 146 external SNMP library to do this. You can use either the UCD or the CMU
 147 SNMP libraries. The configure script will automatically determine which
 148 library you have on your system and will use it. If you have an SNMP
 149 library but _do not_ want to have ethereal use it, you can run configure
 150 with the "--disable-snmp" option. No SNMP support will be compiled into
 151 ethereal with this option.
 152
 153
 154 How to Report a Bug
 155 -------------------
 156 Ethereal is still under constant development, so it is possible that you will
 157 encounter a bug while using it. Please report bugs to ethereal-dev@zing.org.
 158 Be sure you tell us:
 159
 160         1) Operating System and version
 161         2) Version of GTK+ (the command 'gtk-config --version' will tell you)
 162         3) The command you used to invoke Ethereal
 163
 164 If the bug is produced by a particular trace file, please be sure to send
 165 a trace file along with your bug description. Please don't send a trace file
 166 greather than 1 MB when compressed. If the trace file contains sensitive
 167 information (e.g., passwords), then please do not send it.
 168
 169 If Ethereal died on you with a 'segmentation violation', you can help the
 170 developers a lot if you have a debugger installed. A stack trace can be
 171 obtained by using your debugger ('gdb' in this example), the ethereal binary,
 172 and the resulting core file. Here's an example of how to use the gdb
 173 command 'backtrace' to do so.
 174
 175 $ gdb ethereal core
 176 (gdb) backtrace
 177 ..... prints the stack trace
 178 (gdb) quit
 179 $
 180
 181 Disclaimer
 182 ----------
 183
 184 There is no warranty, expressed or implied, associated with this product.
 185 Use at your own risk.
 186
 187
 188 Gerald Combs <gerald@zing.org>
 189 Gilbert Ramirez <gram@xiexie.org>