README.md

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