wireshark.org protocol dissector with Osmocom additions
Go to file
Peter Wu 68698db8cc Always use html2text.py for FAQ, improve output
A recent commit broke compilation with Python 3. The original author of
html2text.py is deceased and the fork has increased the number of files
for this "simple" helper.

The html2text.py script in this patch was rewritten and its output
matches with lynx (except for a few newlines around lists). This means
that indentation has been added for headings, paragraphs and lists.
Also, since it was written from scratch, a new license could be chosen
that matches Wireshark.

Since now the in-tree html2text.py script provides nicer output, remove
detection of the alternative programs (elinks, links). lynx/w3m is
somehow still necessary for asciidoc though.

(I also looked into reusing html2text.py for the release notes to
replace asciidoc, but the --format=html output produces different output
(HTML adds a ToC and section numbers). For now still require lynx for
release notes)

Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and
LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing
to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch
Linux x86_64. Test:

    # For each $PATH per python version, execute (with varying LC_ALL)
    help/faq.py -b | tools/html2text.py /dev/stdin | md5sum
    help/faq.py -b | tools/html2text.py | md5sum
    help/faq.py -b | tools/html2text.py
    help/faq.py -b | tools/html2text.py >/dev/null

Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd
Reviewed-on: https://code.wireshark.org/review/7779
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-03-25 07:08:52 +00:00
.tx Add Transifex Configuration 2015-03-05 06:31:14 +00:00
aclocal-fallback Revert "Bring pkg.m4 in from pkgconfig version 0.28 so we can use the PKG_PROG_PKG_CONFIG macro to try searching for pkg-config even when it isn't installed. Without this (and without pkg-config installed) the configure script is broken. With it, it gives a mes" 2015-01-02 03:49:52 +00:00
asn1 ftsanity.py: make it work with modern tshark 2015-03-24 05:13:46 +00:00
capchild Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
caputils Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
cmake Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
codecs Minor CMake updates to better group build artefacts 2015-01-05 23:48:46 +00:00
debian Update libwireshark0.symbols file 2015-03-22 18:52:33 +00:00
diameter [Diameter] Add 3GPP AVPs 2015-03-12 13:40:38 +00:00
doc Implement proto_tree_add_item_ret_int() and proto_tree_add_item_ret_uint() which 2015-03-19 16:06:18 +00:00
docbook Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
dtds Continue to remove $Id$ from top of file 2014-03-31 18:31:42 +00:00
echld Get rid of unused variable. 2015-02-28 02:47:10 +00:00
epan Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
fix Remove all $Id$ from top of file 2014-03-04 14:27:33 +00:00
help Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
idl
image Add the @2x expert indicators. 2015-03-08 18:12:06 +00:00
macosx-support-lib-patches Remove printing done for debugging/test purposes. 2014-07-27 20:14:18 +00:00
packaging Small fixes to Windows installer 2015-03-25 05:10:37 +00:00
plugins Update Custom.nmake.example with the change done in g2ef72cb 2015-03-14 19:34:32 +00:00
profiles
radius RADIUS: Sync with FreeRADIUS Master 2015-03-11 16:28:55 +00:00
test Add a test-programs target everywhere. 2015-03-13 22:41:40 +00:00
tools Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
tpncp Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
ui Generate the filter using _ws.expert.message instead of expert.message 2015-03-25 05:00:17 +00:00
wimaxasncp Continue to remove $Id$ from top of file 2014-03-31 18:46:03 +00:00
wiretap 1.99.5 → 1.99.6. 2015-03-20 00:53:49 +00:00
wsutil Add support for WIRESHARK_EXTCAP_DIR environment variable on Windows 2015-03-25 05:08:02 +00:00
.bzrignore
.gitattributes Add tests for the Qt UI. 2014-10-01 22:30:33 +00:00
.gitignore Added nsis generated files to .gitignore 2015-02-01 10:54:39 +00:00
.gitreview Fix the host entry. 2014-02-11 17:36:35 +00:00
.mailmap EAPOL-MKA: Included fixes for the distributed sak handling. 2015-01-17 15:03:18 +00:00
.travis.yml Add .travis.yml for Travis CI (for Github user...) 2014-09-20 19:39:50 +00:00
AUTHORS PCEP, support new drafts: 2015-03-16 13:52:51 +00:00
CMakeLists.txt Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
CMakeListsCustom.txt.example Add missing stuff for custom plugins. 2014-10-29 08:38:34 +00:00
CMakeOptions.txt Add AddressSanitizer (ASAN) build option 2015-02-18 18:05:53 +00:00
COPYING Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
CPackConfig.txt CMake: Build an application bundle (Wireshark.app) on OS X. 2014-10-09 20:07:48 +00:00
ChangeLog Build 1.99.5. 2015-03-19 23:32:52 +00:00
ConfigureChecks.cmake Look for and use gethostbyname() if we don't have getaddrinfo(). Fail to 2015-03-03 15:02:08 +00:00
INSTALL Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
INSTALL.configure
Makefile.am Add a test-programs target everywhere. 2015-03-13 22:41:40 +00:00
Makefile.am.inc Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
Makefile.common Get us building with the subdir-objects automake option. 2015-01-22 02:12:46 +00:00
Makefile.nmake Add a test-programs target everywhere. 2015-03-13 22:41:40 +00:00
Makefile.nmake.inc Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
NEWS Build 1.99.5. 2015-03-19 23:32:52 +00:00
README Indicate that Python is required to compile Wireshark. 2014-08-12 23:59:12 +00:00
README.DECT Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.aix Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.bsd Insert URLs for finding Wireshark's dependencies in README.bsd 2014-12-24 00:31:14 +00:00
README.cmake Note that the Lua tests don't work in cmake. 2015-03-04 21:23:24 +00:00
README.hpux Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.linux Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.macos Update READMEs to reflect recent CMake environment changes. 2014-10-10 22:05:10 +00:00
README.tru64 Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.vmware Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
README.windows Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
abi-descriptor.template
acinclude.m4 Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
aclocal-flags Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
adns_dll.dep
adns_dll.rc
autogen.sh Check for pkg-config. 2014-12-27 23:17:38 +00:00
capinfos.c Don't use ctime(). 2015-02-28 09:15:10 +00:00
capture_info.c Handle DLT_LOOP differently from DLT_NULL. 2015-02-15 22:47:03 +00:00
capture_info.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
capture_opts.c Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
capture_opts.h Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
capture_stop_conditions.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
capture_stop_conditions.h Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
captype.c Suppress a bunch of cast-qual warnings. 2015-02-20 04:04:15 +00:00
cfile.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
cfile.h Qt: Apply recent settings. 2015-02-24 09:58:03 +00:00
cfilters
cmakeconfig.h.in Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
color.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
color_filters.c (Trivial) Fix printf-related 'Mismatch on sign' warnings 2015-02-09 18:57:14 +00:00
color_filters.h Qt: Add the Coloring Rules dialog. 2015-02-07 00:30:30 +00:00
colorfilters
conditions.c Modify includes of config.h so that out-of-tree builds, i.e. CMake 2014-08-24 08:04:08 +00:00
conditions.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
config.guess
config.h.win32 Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
config.nmake Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
config.sub
configure.ac Always use html2text.py for FAQ, improve output 2015-03-25 07:08:52 +00:00
dfilter_macros
dfilters The "not DNS" filter used UDP in the description but matched against 2014-04-08 19:24:13 +00:00
dftest.c Just have init_progfile_dir() take a void pointer. 2015-02-20 00:24:08 +00:00
doxygen.cfg.in Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
doxygen_global.cfg Upgrade doxygen configuration (with doxyen 1.8) 2014-04-14 20:31:42 +00:00
dumpcap.c Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
echld_test.c Remove some unneeded includes of <sys/time.h>. 2015-02-28 04:59:08 +00:00
editcap.c Remove some unneeded includes of <sys/time.h>. 2015-02-28 04:59:08 +00:00
extcap.c extcap: remove use of g_list_free_full 2014-10-13 16:09:47 +00:00
extcap.h Convert "4 space tabs" to spaces; Adjust editor modelines. 2014-10-06 18:29:40 +00:00
extcap_parser.c Convert "4 space tabs" to spaces; Adjust editor modelines. 2014-10-06 18:29:40 +00:00
extcap_parser.h Convert "4 space tabs" to spaces; Adjust editor modelines. 2014-10-06 18:29:40 +00:00
file.c Reduce epan dependence on dissectors by having print module "cache" the protocol and field ids that it needs. 2015-03-20 05:30:52 +00:00
file.h Declare read_keytab_file() in epan/dissectors/packet-kerberos.h. 2015-01-01 23:05:57 +00:00
fileset.c We use GLib's directory-reading routines, so we don't need <dire[cn]t.h>. 2015-02-14 07:23:20 +00:00
fileset.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
frame_tvbuff.c Remove tvb_ from the names of wsutil mempbrk routines. 2015-02-21 20:39:25 +00:00
frame_tvbuff.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
globals.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
ipmap.html
log.h Replace tabs by spaces when editor modelines has "expandtab" 2015-02-13 17:34:53 +00:00
macosx-setup.sh Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
make-version.pl 1.99.5 → 1.99.6. 2015-03-20 00:53:49 +00:00
manuf [Automatic manuf, services and enterprise-numbers update for 2015-03-22] 2015-03-22 15:05:55 +00:00
manuf.tmpl Add short name for CableLabs. 2014-04-21 18:06:50 +00:00
mergecap.c Remove some unneeded includes of <sys/time.h>. 2015-02-28 04:59:08 +00:00
mkcap.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
pcapio.c Modify includes of config.h so that out-of-tree builds, i.e. CMake 2014-08-24 08:04:08 +00:00
pcapio.h Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
pdml2html.xsl Bugfix pdml2html.xsl fails to expand multiple identical 'proto' tags 2014-06-08 19:28:19 +00:00
randpkt.c Suppress a bunch of cast-qual warnings. 2015-02-20 04:04:15 +00:00
rawshark.c Make FT_{U}INT64 behave more like FT_{U}INT32, add support for FT_{U}INT{40,48,56} 2015-02-21 16:57:52 +00:00
register.h Remove unused RA_PYTHON_REGISTER and RA_PYTHON_HANDOFF. 2014-10-31 12:10:59 +00:00
reordercap.c Suppress a bunch of cast-qual warnings. 2015-02-20 04:04:15 +00:00
ringbuffer.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
ringbuffer.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
services [Automatic manuf, services and enterprise-numbers update for 2015-03-15] 2015-03-15 15:05:46 +00:00
smi_modules
summary.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
summary.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
sync_pipe.h Replace tabs by spaces when editor modelines has "expandtab" 2015-02-13 17:34:53 +00:00
sync_pipe_write.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
text2pcap-scanner.l text2pcap-scanner.l: On Windows: #include <io.h> req'd for isatty() 2014-08-21 17:20:17 +00:00
text2pcap.c Suppress a bunch of cast-qual warnings. 2015-02-20 04:04:15 +00:00
text2pcap.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00
tfshark.c Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
trigcap.c Add editor modelines; Adjust whitespace as needed. 2014-10-12 18:58:32 +00:00
tshark.c Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
wireshark-mime-package.xml Add a MIME type for Tektronix rf5 files and register Wireshark for that type of 2014-12-04 14:04:58 +00:00
wireshark-qt.cpp Have a #define for whether the capture buffer size can be set. 2015-03-25 03:22:33 +00:00
wireshark.appdata.xml Add an appdata entry for Wireshark. 2015-02-18 01:50:56 +00:00
wireshark.desktop Add a MIME type for Tektronix rf5 files and register Wireshark for that type of 2014-12-04 14:04:58 +00:00
wireshark.dox
wireshark.pc.in Add pkg-config file 2014-03-08 23:55:38 +00:00
wka.tmpl TRILL updates 2014-08-22 10:55:40 +00:00
ws_symbol_export.h Always put editor-modelines at the end of the file ... 2014-10-14 20:08:29 +00:00

README

General Information
------- -----------

Wireshark is a network traffic analyzer, or "sniffer", for Unix and
Unix-like operating systems.  It uses GTK+, a graphical user interface
library, and libpcap, a packet capture and filtering library.

The Wireshark distribution also comes with TShark, which is a
line-oriented sniffer (similar to Sun's snoop, or tcpdump) that uses the
same dissection, capture-file reading and writing, and packet filtering
code as Wireshark, and with editcap, which is a program to read capture
files and write the packets from that capture file, possibly in a
different capture file format, and with some packets possibly removed
from the capture.

The official home of Wireshark is

    http://www.wireshark.org

The latest distribution can be found in the subdirectory

    http://www.wireshark.org/download


Installation
------------

Wireshark is known to compile and run on the following systems:

  - Linux (2.0 and later kernels, various distributions)
  - Solaris (2.5.1 and later)
  - FreeBSD (2.2.5 and later)
  - NetBSD
  - OpenBSD
  - Mac OS X (10.2 and later)
  - HP-UX (10.20, 11.00, 11.11)
  - Sequent PTX v4.4.5  (Nick Williams <njw@sequent.com>)
  - Tru64 UNIX (formerly Digital UNIX) (3.2 and later)
  - Irix (6.5)
  - AIX (4.3.2, with a bit of work)
  - Windows (2003, XP, Vista, 7)

and possibly on other versions of those OSes.  It should run on other
Unix-ish systems without too much trouble.

If you have an older version of the operating systems listed above, it
might be supported by an older version of Wireshark. In particular,
Windows 2000 is supported by Wireshark 1.2.x, Windows NT 4.0 is supported by
Wireshark 0.99.4, and Windows 95, 98, and ME are supported by Ethereal 0.99.0.

NOTE: the Makefile appears to depend on GNU "make"; it doesn't appear to
work with the "make" that comes with Solaris 7 nor the BSD "make".

Both Perl and Python are needed, the former for building the man pages.

If you decide to modify the yacc grammar or lex scanner, then
you need "flex" - it cannot be built with vanilla "lex" -
and either "bison" or the Berkeley "yacc". Your flex
version must be 2.5.1 or greater. Check this with 'flex -V'.

You must therefore install Perl, Python, GNU "make", "flex", and either "bison"
or Berkeley "yacc" on systems that lack them.

Full installation instructions can be found in the INSTALL file.

See also the appropriate README.<OS> files for OS-specific installation
instructions.

Usage
-----

In order to capture packets from the network, you need to make the
dumpcap program set-UID to root, or you need to have access to the
appropriate entry under /dev if your system is so inclined (BSD-derived
systems, and systems such as Solaris and HP-UX that support DLPI,
typically fall into this category).  Although it might be tempting to
make the Wireshark and TShark executables setuid root, or to run them as
root please don't.  The capture process has been isolated in dumpcap;
this simple program is less likely to contain security holes, and thus
safer to run as root.

Please consult the man page for a description of each command-line
option and interface feature.


Multiple File Types
-------------------

The wiretap library is a packet-capture library currently under
development parallel to wireshark.  In the future it is hoped that
wiretap will have more features than libpcap, but wiretap is still in
its infancy. However, wiretap is used in wireshark for its ability
to read multiple file types.  See the Wireshark man page or the
Wireshark User's Guide for a list of supported file formats.

In addition, it can read gzipped versions of any of those files
automatically, if you have the zlib library available when compiling
Wireshark. Wireshark needs a modern version of zlib to be able to use
zlib to read gzipped files; version 1.1.3 is known to work.  Versions
prior to 1.0.9 are missing some functions that Wireshark needs and won't
work.  "./configure" should detect if you have the proper zlib version
available and, if you don't, should disable zlib support. You can always
use "./configure --disable-zlib" to explicitly disable zlib support.

Although Wireshark can read AIX iptrace files, the documentation on
AIX's iptrace packet-trace command is sparse.  The 'iptrace' command
starts a daemon which you must kill in order to stop the trace. Through
experimentation it appears that sending a HUP signal to that iptrace
daemon causes a graceful shutdown and a complete packet is written
to the trace file. If a partial packet is saved at the end, Wireshark
will complain when reading that file, but you will be able to read all
other packets.  If this occurs, please let the Wireshark developers know
at wireshark-dev@wireshark.org, and be sure to send us a copy of that trace
file if it's small and contains non-sensitive data.

Support for Lucent/Ascend products is limited to the debug trace output
generated by the MAX and Pipline series of products.  Wireshark can read
the output of the "wandsession" "wandisplay", "wannext", and "wdd"
commands.

Wireshark can also read dump trace output from the Toshiba "Compact Router"
line of ISDN routers (TR-600 and TR-650). You can telnet to the router
and start a dump session with "snoop dump".

CoSine L2 debug output can also be read by Wireshark. To get the L2
debug output, get in the diags mode first and then use
"create-pkt-log-profile" and "apply-pkt-log-profile" commands under
layer-2 category. For more detail how to use these commands, you
should examine the help command by "layer-2 create ?" or "layer-2 apply ?".

To use the Lucent/Ascend, Toshiba and CoSine traces with Wireshark, you must
capture the trace output to a file on disk.  The trace is happening inside
the router and the router has no way of saving the trace to a file for you.
An easy way of doing this under Unix is to run "telnet <ascend> | tee <outfile>".
Or, if your system has the "script" command installed, you can save
a shell session, including telnet to a file. For example, to a file named
tracefile.out:

$ script tracefile.out
Script started on <date/time>
$ telnet router
..... do your trace, then exit from the router's telnet session.
$ exit
Script done on <date/time>



IPv6
----
If your operating system includes IPv6 support, wireshark will attempt to
use reverse name resolution capabilities when decoding IPv6 packets.

If you want to turn off name resolution while using wireshark, start
wireshark with the "-n" option to turn off all name resolution (including
resolution of MAC addresses and TCP/UDP/SMTP port numbers to names), or
with the "-N mt" option to turn off name resolution for all
network-layer addresses (IPv4, IPv6, IPX).

You can make that the default setting by opening the Preferences dialog
box using the Preferences item in the Edit menu, selecting "Name
resolution", turning off the appropriate name resolution options,
clicking "Save", and clicking "OK".

If you would like to compile wireshark without support for IPv6 name
resolution, use the "--disable-ipv6" option with "./configure".  If you
compile wireshark without IPv6 name resolution, you will still be able to
decode IPv6 packets, but you'll only see IPv6 addresses, not host names.


SNMP
----
Wireshark can do some basic decoding of SNMP packets; it can also use
the libsmi library to do more sophisticated decoding, by reading MIB
files and using the information in those files to display OIDs and
variable binding values in a friendlier fashion.  The configure script
will automatically determine whether you have the libsmi library on
your system.  If you have the libsmi library but _do not_ want to have
Wireshark use it, you can run configure with the "--without-libsmi"
option.

How to Report a Bug
-------------------
Wireshark is still under constant development, so it is possible that you will
encounter a bug while using it. Please report bugs at http://bugs.wireshark.org.
Be sure you enter into the bug:

	1) the complete build information from the "About Wireshark"
	   item in the Help menu or the output of "wireshark -v" for
	   Wireshark bugs and the output of "tshark -v" for TShark bugs;

	2) if the bug happened on Linux, the Linux distribution you were
	   using, and the version of that distribution;

	3) the command you used to invoke Wireshark, if you ran
	   Wireshark from the command line, or TShark, if you ran
	   TShark, and the sequence of operations you performed that
	   caused the bug to appear.

If the bug is produced by a particular trace file, please be sure to
attach to the bug a trace file along with your bug description.  If the
trace file contains sensitive information (e.g., passwords), then please
do not send it.

If Wireshark died on you with a 'segmentation violation', 'bus error',
'abort', or other error that produces a UNIX core dump file, you can
help the developers a lot if you have a debugger installed.  A stack
trace can be obtained by using your debugger ('gdb' in this example),
the wireshark binary, and the resulting core file.  Here's an example of
how to use the gdb command 'backtrace' to do so.

$ gdb wireshark core
(gdb) backtrace
..... prints the stack trace
(gdb) quit
$

The core dump file may be named "wireshark.core" rather than "core" on
some platforms (e.g., BSD systems).  If you got a core dump with
TShark rather than Wireshark, use "tshark" as the first argument to
the debugger; the core dump may be named "tshark.core".

Disclaimer
----------

There is no warranty, expressed or implied, associated with this product.
Use at your own risk.


Gerald Combs <gerald@wireshark.org>
Gilbert Ramirez <gram@alumni.rice.edu>
Guy Harris <guy@alum.mit.edu>