README

   1 $Id$
   2
   3 General Information
   4 ------- -----------
   5
   6 Wireshark 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 Wireshark distribution also comes with TShark, 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 Wireshark, 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 Wireshark is
  19
  20     http://www.wireshark.org
  21
  22 The latest distribution can be found in the subdirectory
  23
  24     http://www.wireshark.org/download
  25
  26
  27 Installation
  28 ------------
  29
  30 Wireshark is known to compile and run on the following systems:
  31
  32   - Linux (2.0 and later kernels, various distributions)
  33   - Solaris (2.5.1 and later)
  34   - FreeBSD (2.2.5 and later)
  35   - NetBSD
  36   - OpenBSD
  37   - Mac OS X (10.2 and later)
  38   - HP-UX (10.20, 11.00, 11.11)
  39   - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  40   - Tru64 UNIX (formerly Digital UNIX) (3.2 and later)
  41   - Irix (6.5)
  42   - AIX (4.3.2, with a bit of work)
  43   - Win32 (NT 4.0, 2000, 2003, XP, Vista)
  44
  45 and possibly on other versions of those OSes.  It should run on other
  46 Unix-ish systems without too much trouble.
  47
  48 NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
  49 work with the "make" that comes with Solaris 7 nor the BSD "make".
  50 Perl is also needed to create the man page.
  51
  52 If you decide to modify the yacc grammar or lex scanner, then
  53 you need "flex" - it cannot be built with vanilla "lex" -
  54 and either "bison" or the Berkeley "yacc". Your flex
  55 version must be 2.5.1 or greater. Check this with 'flex -V'.
  56
  57 If you decide to modify the NetWare Core Protocol dissector, you
  58 will need python, as the data for packet types is stored in a python
  59 script, ncp2222.py.
  60
  61 You must therefore install Perl, GNU "make", "flex", and either "bison" or
  62 Berkeley "yacc" on systems that lack them.
  63
  64 Full installation instructions can be found in the INSTALL file.
  65
  66 See also the appropriate README.<OS> files for OS-specific installation
  67 instructions.
  68
  69 Usage
  70 -----
  71
  72 In order to capture packets from the network, you need to make the
  73 dumpcap program set-UID to root, or you need to have access to the
  74 appropriate entry under /dev if your system is so inclined (BSD-derived
  75 systems, and systems such as Solaris and HP-UX that support DLPI,
  76 typically fall into this category).  Although it might be tempting to
  77 make the Wireshark and TShark executables setuid root, or to run them as
  78 root please don't.  The capture process has been isolated in dumpcap;
  79 this simple program is less likely to contain security holes, and thus
  80 safer to run as root.
  81
  82 Please consult the man page for a description of each command-line
  83 option and interface feature.
  84
  85
  86 Multiple File Types
  87 -------------------
  88
  89 The wiretap library is a packet-capture library currently under
  90 development parallel to wireshark.  In the future it is hoped that
  91 wiretap will have more features than libpcap, but wiretap is still in
  92 its infancy. However, wiretap is used in wireshark for its ability
  93 to read multiple file types. You can read the following file
  94 formats:
  95
  96 libpcap (tcpdump -w, etc.) - this is Wireshark's native format
  97 snoop and atmsnoop
  98 Shomiti/Finisar Surveyor
  99 Novell LANalyzer
 100 Network General/Network Associates DOS-based Sniffer (compressed and
 101     uncompressed)
 102 Microsoft Network Monitor
 103 AIX's iptrace
 104 Cinco Networks NetXRray
 105 Network Associates Windows-based Sniffer
 106 AG Group/WildPackets EtherPeek/TokenPeek/AiroPeek/EtherHelp
 107 RADCOM's WAN/LAN Analyzer
 108 Lucent/Ascend access products
 109 HP-UX's nettl
 110 Toshiba's ISDN routers
 111 ISDN4BSD "i4btrace" utility
 112 Cisco Secure Intrustion Detection System iplogging facility
 113 pppd logs (pppdump-format files)
 114 VMS's TCPIPtrace utility
 115 DBS Etherwatch for VMS
 116 Traffic captures from Visual Networks' Visual UpTime
 117 CoSine L2 debug output
 118 Output from Accellent's 5Views LAN agents
 119 Endace Measurement Systems' ERF format
 120 Linux Bluez Bluetooth stack "hcidump -w" traces
 121 Network Instruments Observer version 9
 122 Trace files for the EyeSDN USB S0
 123
 124 In addition, it can read gzipped versions of any of these files
 125 automatically, if you have the zlib library available when compiling
 126 Wireshark. Wireshark needs a modern version of zlib to be able to use
 127 zlib to read gzipped files; version 1.1.3 is known to work.  Versions
 128 prior to 1.0.9 are missing some functions that Wireshark needs and won't
 129 work.  "./configure" should detect if you have the proper zlib version
 130 available and, if you don't, should disable zlib support. You can always
 131 use "./configure --disable-zlib" to explicitly disable zlib support.
 132
 133 Although Wireshark can read AIX iptrace files, the documentation on
 134 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
 135 starts a daemon which you must kill in order to stop the trace. Through
 136 experimentation it appears that sending a HUP signal to that iptrace
 137 daemon causes a graceful shutdown and a complete packet is written
 138 to the trace file. If a partial packet is saved at the end, Wireshark
 139 will complain when reading that file, but you will be able to read all
 140 other packets.  If this occurs, please let the Wireshark developers know
 141 at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
 142 file if it's small and contains non-sensitive data.
 143
 144 Support for Lucent/Ascend products is limited to the debug trace output
 145 generated by the MAX and Pipline series of products.  Wireshark can read
 146 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
 147 commands.
 148
 149 Wireshark can also read dump trace output from the Toshiba "Compact Router"
 150 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 151 and start a dump session with "snoop dump".
 152
 153 CoSine L2 debug output can also be read by Wireshark. To get the L2
 154 debug output, get in the diags mode first and then use
 155 "create-pkt-log-profile" and "apply-pkt-log-profile" commands under
 156 layer-2 category. For more detail how to use these commands, you
 157 should examine the help command by "layer-2 create ?" or "layer-2 apply ?".
 158
 159 To use the Lucent/Ascend, Toshiba and CoSine traces with Wireshark, you must
 160 capture the trace output to a file on disk.  The trace is happening inside
 161 the router and the router has no way of saving the trace to a file for you.
 162 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 163 Or, if your system has the "script" command installed, you can save
 164 a shell session, including telnet to a file. For example, to a file named
 165 tracefile.out:
 166
 167 $ script tracefile.out
 168 Script started on <date/time>
 169 $ telnet router
 170 ..... do your trace, then exit from the router's telnet session.
 171 $ exit
 172 Script done on <date/time>
 173
 174
 175
 176 IPv6
 177 ----
 178 If your operating system includes IPv6 support, wireshark will attempt to
 179 use reverse name resolution capabilities when decoding IPv6 packets.
 180
 181 If you want to turn off name resolution while using wireshark, start
 182 wireshark with the "-n" option to turn off all name resolution (including
 183 resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
 184 with the "-N mt" option to turn off name resolution for all
 185 network-layer addresses (IPv4, IPv6, IPX).
 186
 187 You can make that the default setting by opening the Preferences dialog
 188 box using the Preferences item in the Edit menu, selecting "Name
 189 resolution", turning off the appropriate name resolution options,
 190 clicking "Save", and clicking "OK".
 191
 192 If you would like to compile wireshark without support for IPv6 name
 193 resolution, use the "--disable-ipv6" option with "./configure".  If you
 194 compile wireshark without IPv6 name resolution, you will still be able to
 195 decode IPv6 packets, but you'll only see IPv6 addresses, not host names.
 196
 197
 198 SNMP
 199 ----
 200 Wireshark can do some basic decoding of SNMP packets; it can also use
 201 the libsmi library to do more sophisticated decoding, by reading MIB
 202 files and using the information in those files to display OIDs and
 203 variable binding values in a friendlier fashion.  The configure script
 204 will automatically determine whether you have the libsmi library on
 205 your system.  If you have the libsmi library but _do not_ want to have
 206 Wireshark use it, you can run configure with the "--without-libsmi"
 207 option.
 208
 209 How to Report a Bug
 210 -------------------
 211 Wireshark is still under constant development, so it is possible that you will
 212 encounter a bug while using it. Please report bugs at http://bugs.wireshark.org.
 213 Be sure you enter into the bug:
 214
 215         1) the complete build information from the "About Wireshark"
 216            item in the Help menu or the output of "wireshark -v" for
 217            Wireshark bugs and the output of "tshark -v" for TShark bugs;
 218
 219         2) if the bug happened on Linux, the Linux distribution you were
 220            using, and the version of that distribution;
 221
 222         3) the command you used to invoke Wireshark, if you ran
 223            Wireshark from the command line, or TShark, if you ran
 224            TShark, and the sequence of operations you performed that
 225            caused the bug to appear.
 226
 227 If the bug is produced by a particular trace file, please be sure to
 228 attach to the bug a trace file along with your bug description.  If the
 229 trace file contains sensitive information (e.g., passwords), then please
 230 do not send it.
 231
 232 If Wireshark died on you with a 'segmentation violation', 'bus error',
 233 'abort', or other error that produces a UNIX core dump file, you can
 234 help the developers a lot if you have a debugger installed.  A stack
 235 trace can be obtained by using your debugger ('gdb' in this example),
 236 the wireshark binary, and the resulting core file.  Here's an example of
 237 how to use the gdb command 'backtrace' to do so.
 238
 239 $ gdb wireshark core
 240 (gdb) backtrace
 241 ..... prints the stack trace
 242 (gdb) quit
 243 $
 244
 245 The core dump file may be named "wireshark.core" rather than "core" on
 246 some platforms (e.g., BSD systems).  If you got a core dump with
 247 TShark rather than Wireshark, use "tshark" as the first argument to
 248 the debugger; the core dump may be named "tshark.core".
 249
 250 Disclaimer
 251 ----------
 252
 253 There is no warranty, expressed or implied, associated with this product.
 254 Use at your own risk.
 255
 256
 257 Gerald Combs <gerald@wireshark.org>
 258 Gilbert Ramirez <gram@alumni.rice.edu>
 259 Guy Harris <guy@alum.mit.edu>