README

   1 General Information
   2 -------------------
   3
   4 Wireshark is a network traffic analyzer, or "sniffer", for Unix and
   5 Unix-like operating systems.  It uses Qt, a graphical user interface
   6 library, and libpcap, a packet capture and filtering library.
   7
   8 The Wireshark distribution also comes with TShark, which is a
   9 line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
  10 same dissection, capture-file reading and writing, and packet filtering
  11 code as Wireshark, and with editcap, which is a program to read capture
  12 files and write the packets from that capture file, possibly in a
  13 different capture file format, and with some packets possibly removed
  14 from the capture.
  15
  16 The official home of Wireshark is
  17
  18     https://www.wireshark.org
  19
  20 The latest distribution can be found in the subdirectory
  21
  22     https://www.wireshark.org/download
  23
  24
  25 Installation
  26 ------------
  27
  28 The Wireshark project builds and tests regularly on the following platforms:
  29
  30   - Linux (Ubuntu)
  31   - Microsoft Windows
  32   - macOS / {Mac} OS X
  33
  34 Official installation packages are available for Microsoft Windows and
  35 macOS.
  36
  37 It is available as either a standard or add-on package for many popular
  38 operating sytems and Linux distributions including Debian, Ubuntu, Fedora,
  39 CentOS, RHEL, Arch, Gentoo, openSUSE, FreeBSD, DragonFly BSD, NetBSD, and
  40 OpenBSD.
  41
  42 Additionaly it is available through many third-party packaging systems
  43 such as pkgsrc, OpenCSW, Homebrew, and MacPorts.
  44
  45 It should run on other Unix-ish systems without too much trouble.
  46
  47 In some cases the current version of Wireshark might not support your
  48 operating system. This is the case for Windows XP, which is supported by
  49 Wireshark 1.10 and earlier. In other cases the standard package for
  50 Wireshark might simply be old. This is the case for Solaris and HP-UX.
  51
  52 NOTE: The Makefile depends on GNU "make"; it doesn't appear to
  53 work with the "make" that comes with Solaris 7 nor the BSD "make".
  54
  55 Both Perl and Python are needed, the former for building the man pages.
  56
  57 If you decide to modify the yacc grammar or lex scanner, then
  58 you need "flex" - it cannot be built with vanilla "lex" -
  59 and either "bison" or the Berkeley "yacc". Your flex
  60 version must be 2.5.1 or greater. Check this with 'flex -V'.
  61
  62 You must therefore install Perl, Python, GNU "make", "flex", and either "bison"
  63 or Berkeley "yacc" on systems that lack them.
  64
  65 Full installation instructions can be found in the INSTALL file and in the
  66 Developer's Guide at https://www.wireshark.org/docs/wsdg_html_chunked/
  67
  68 See also the appropriate README.<OS> files for OS-specific installation
  69 instructions.
  70
  71 Usage
  72 -----
  73
  74 In order to capture packets from the network, you need to make the
  75 dumpcap program set-UID to root, or you need to have access to the
  76 appropriate entry under /dev if your system is so inclined (BSD-derived
  77 systems, and systems such as Solaris and HP-UX that support DLPI,
  78 typically fall into this category).  Although it might be tempting to
  79 make the Wireshark and TShark executables setuid root, or to run them as
  80 root please don't.  The capture process has been isolated in dumpcap;
  81 this simple program is less likely to contain security holes, and thus
  82 safer to run as root.
  83
  84 Please consult the man page for a description of each command-line
  85 option and interface feature.
  86
  87
  88 Multiple File Types
  89 -------------------
  90
  91 The wiretap library is a packet-capture library currently under
  92 development parallel to wireshark.  In the future it is hoped that
  93 wiretap will have more features than libpcap, but wiretap is still in
  94 its infancy. However, wiretap is used in wireshark for its ability
  95 to read multiple file types.  See the Wireshark man page or the
  96 Wireshark User's Guide for a list of supported file formats.
  97
  98 In addition, it can read gzipped versions of any of those files
  99 automatically, if you have the zlib library available when compiling
 100 Wireshark. Wireshark needs a modern version of zlib to be able to use
 101 zlib to read gzipped files; version 1.1.3 is known to work.  Versions
 102 prior to 1.0.9 are missing some functions that Wireshark needs and won't
 103 work.  "./configure" should detect if you have the proper zlib version
 104 available and, if you don't, should disable zlib support. You can always
 105 use "./configure --disable-zlib" to explicitly disable zlib support.
 106
 107 Although Wireshark can read AIX iptrace files, the documentation on
 108 AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
 109 starts a daemon which you must kill in order to stop the trace. Through
 110 experimentation it appears that sending a HUP signal to that iptrace
 111 daemon causes a graceful shutdown and a complete packet is written
 112 to the trace file. If a partial packet is saved at the end, Wireshark
 113 will complain when reading that file, but you will be able to read all
 114 other packets.  If this occurs, please let the Wireshark developers know
 115 at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
 116 file if it's small and contains non-sensitive data.
 117
 118 Support for Lucent/Ascend products is limited to the debug trace output
 119 generated by the MAX and Pipline series of products.  Wireshark can read
 120 the output of the "wandsession" "wandisplay", "wannext", and "wdd"
 121 commands.
 122
 123 Wireshark can also read dump trace output from the Toshiba "Compact Router"
 124 line of ISDN routers (TR-600 and TR-650). You can telnet to the router
 125 and start a dump session with "snoop dump".
 126
 127 CoSine L2 debug output can also be read by Wireshark. To get the L2
 128 debug output, get in the diags mode first and then use
 129 "create-pkt-log-profile" and "apply-pkt-log-profile" commands under
 130 layer-2 category. For more detail how to use these commands, you
 131 should examine the help command by "layer-2 create ?" or "layer-2 apply ?".
 132
 133 To use the Lucent/Ascend, Toshiba and CoSine traces with Wireshark, you must
 134 capture the trace output to a file on disk.  The trace is happening inside
 135 the router and the router has no way of saving the trace to a file for you.
 136 An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
 137 Or, if your system has the "script" command installed, you can save
 138 a shell session, including telnet to a file. For example, to a file named
 139 tracefile.out:
 140
 141 ----
 142 $ script tracefile.out
 143 Script started on <date/time>
 144 $ telnet router
 145 ..... do your trace, then exit from the router's telnet session.
 146 $ exit
 147 Script done on <date/time>
 148 ----
 149
 150
 151 Name Resolution
 152 ---------------
 153
 154 Wireshark will attempt to use reverse name resolution capabilities
 155 when decoding IPv4 and IPv6 packets.
 156
 157 If you want to turn off name resolution while using Wireshark, start
 158 Wireshark with the "-n" option to turn off all name resolution (including
 159 resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
 160 with the "-N mt" option to turn off name resolution for all
 161 network-layer addresses (IPv4, IPv6, IPX).
 162
 163 You can make that the default setting by opening the Preferences dialog
 164 box using the Preferences item in the Edit menu, selecting "Name
 165 resolution", turning off the appropriate name resolution options,
 166 clicking "Save", and clicking "OK".
 167
 168
 169 SNMP
 170 ----
 171
 172 Wireshark can do some basic decoding of SNMP packets; it can also use
 173 the libsmi library to do more sophisticated decoding, by reading MIB
 174 files and using the information in those files to display OIDs and
 175 variable binding values in a friendlier fashion.  The configure script
 176 will automatically determine whether you have the libsmi library on
 177 your system.  If you have the libsmi library but _do not_ want to have
 178 Wireshark use it, you can run configure with the "--without-libsmi"
 179 option.
 180
 181 How to Report a Bug
 182 -------------------
 183
 184 Wireshark is under constant development, so it is possible that you will
 185 encounter a bug while using it. Please report bugs at https://bugs.wireshark.org.
 186 Be sure you enter into the bug:
 187
 188 1. The complete build information from the "About Wireshark"
 189    item in the Help menu or the output of "wireshark -v" for
 190    Wireshark bugs and the output of "tshark -v" for TShark bugs;
 191
 192 2. If the bug happened on Linux, the Linux distribution you were
 193    using, and the version of that distribution;
 194
 195 3. The command you used to invoke Wireshark, if you ran
 196    Wireshark from the command line, or TShark, if you ran
 197    TShark, and the sequence of operations you performed that
 198    caused the bug to appear.
 199
 200 If the bug is produced by a particular trace file, please be sure to
 201 attach to the bug a trace file along with your bug description.  If the
 202 trace file contains sensitive information (e.g., passwords), then please
 203 do not send it.
 204
 205 If Wireshark died on you with a 'segmentation violation', 'bus error',
 206 'abort', or other error that produces a UNIX core dump file, you can
 207 help the developers a lot if you have a debugger installed.  A stack
 208 trace can be obtained by using your debugger ('gdb' in this example),
 209 the wireshark binary, and the resulting core file.  Here's an example of
 210 how to use the gdb command 'backtrace' to do so.
 211
 212 ----
 213 $ gdb wireshark core
 214 (gdb) backtrace
 215 ..... prints the stack trace
 216 (gdb) quit
 217 $
 218 ----
 219
 220 The core dump file may be named "wireshark.core" rather than "core" on
 221 some platforms (e.g., BSD systems).  If you got a core dump with
 222 TShark rather than Wireshark, use "tshark" as the first argument to
 223 the debugger; the core dump may be named "tshark.core".
 224
 225 Disclaimer
 226 ----------
 227
 228 There is no warranty, expressed or implied, associated with this product.
 229 Use at your own risk.
 230
 231
 232 Gerald Combs <gerald@wireshark.org>
 233
 234 Gilbert Ramirez <gram@alumni.rice.edu>
 235
 236 Guy Harris <guy@alum.mit.edu>