wireshark.org protocol dissector with Osmocom additions
Go to file
Bill Meier 8ef3e2fad3 For getopt() arg processing:
- Use exit(0) for -h option as per convention;

For g_option...() arg processing (when USE_GOPTION is set):
 - Fix bug: 'capinfos x' doesn't print any info about x;
   (bug introduced in SVN #48481);
 - Use stderr for error messages related to cmd-line arg parsing;


svn path=/trunk/; revision=54555
2014-01-02 15:41:45 +00:00
aclocal-fallback More SVN properties cleanup. 2013-10-27 01:11:15 +00:00
asn1 Fix [-Wmissing-prototypes] 2014-01-02 11:27:10 +00:00
cmake Beginnings of doxygen support. 2013-12-22 01:21:56 +00:00
codecs (Trivial) remove some trailing whitespace. 2013-12-13 14:19:52 +00:00
debian Add GPLv2+ license header to headers-check.c as per private email from the 2013-12-23 15:19:25 +00:00
diameter Add an application id. 2013-11-29 07:14:13 +00:00
doc Add proto_tree_add_ts_23_038_7bits_item() / tvb_get_ts_23_038_7bits_string() functions and update dissectors to use it. 2014-01-01 14:33:19 +00:00
docbook add Novell PKIS to the list of new protocols 2013-12-31 14:25:28 +00:00
dtds
echld From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
epan Fix [-Wmissing-prototypes] 2014-01-02 11:27:10 +00:00
filetap rename filetap/file_wrappers.[hc] -> filetap/ft_file_wrappers.[hc] 2014-01-02 15:17:14 +00:00
fix
help From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
idl
image Filetap library, version 0.001 2014-01-01 13:18:45 +00:00
macosx-support-lib-patches Use older versions of some libraries, and build 32-bit, when building 2013-07-09 04:41:34 +00:00
packaging Happy new year! 2014-01-01 12:20:27 +00:00
plugins Fix [-Wmissing-prototypes] 2014-01-02 11:27:10 +00:00
profiles Bluetooth: HSP: Add support for HSP. Bug 9446 (https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9446) 2013-11-28 18:33:26 +00:00
radius From Michael Bean via https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9384 : 2013-11-11 21:13:55 +00:00
test Revert part of r53874 2013-12-11 20:52:05 +00:00
tools The IEEE OUI, IAB, and OUI-36 lists currently redirect to 2013-12-29 17:28:12 +00:00
tpncp
ui Fix indent always use tab 2014-01-02 11:46:58 +00:00
wimaxasncp
wiretap Have a routine that reads and processes the record header, and use it in 2014-01-02 09:23:45 +00:00
wsutil There's no need to mark inline functions with _U_ 2013-12-26 10:53:53 +00:00
.bzrignore
.gitignore Add .gitreview 2013-12-13 00:02:46 +00:00
AUTHORS For the Juan Antonio entry: specify the dissector written; 2013-12-29 21:22:51 +00:00
CMakeLists.txt Generated stuff does not belong into the source tree 2013-12-22 01:29:21 +00:00
CMakeOptions.txt Turn WANT_PACKET_EDITOR into an option until such a time that 2013-11-07 20:32:41 +00:00
COPYING Add a license-ignore for tools/html2text.py 2013-11-06 17:43:49 +00:00
CPackConfig.txt
ChangeLog
ConfigureChecks.cmake We don't need to check for lauxlib.h. 2013-10-11 07:53:17 +00:00
INSTALL
INSTALL.configure
Makefile.am Add a "captype" file that just reports the type of a capture file, based 2013-12-13 02:59:16 +00:00
Makefile.am.inc Pass the name of the sed executable as an explicit argurment to 2013-11-03 12:22:39 +00:00
Makefile.common Drop isprint.h use g_ascii_isprint() when this include hack was enabled. 2013-12-21 15:01:45 +00:00
Makefile.nmake Add a "captype" file that just reports the type of a capture file, based 2013-12-13 02:59:16 +00:00
Makefile.nmake.inc Pass the name of the sed executable as an explicit argurment to 2013-11-03 12:22:39 +00:00
NEWS unknown2/3 -> capturelen1/2 2013-12-20 21:41:54 +00:00
README
README.DECT
README.aix
README.bsd
README.cmake Finally successfully built with the msvc2010 GUI a Debug 2013-12-04 22:07:26 +00:00
README.hpux
README.irix
README.linux
README.macos
README.tru64
README.vmware
README.windows
abi-descriptor.template Add dumpabi targets to CMake builds 2013-02-25 18:12:20 +00:00
acinclude.m4 Fix configure-script errors with some versions of autoconf. 2013-12-26 21:45:51 +00:00
aclocal-flags Use "command -v", required by recent POSIX, rather than "which"; I seem 2013-08-12 17:16:08 +00:00
adns_dll.dep
adns_dll.rc
airpcap.h Fix spelling/typos found using a list of commonly misspelled words. 2013-02-26 04:42:26 +00:00
airpcap_loader.c Add a UAT dialog. Make UAT preferences uat_t * instead of void *. 2013-07-25 23:49:47 +00:00
airpcap_loader.h Clean up white space (get rid of 4-space tabs). 2013-02-17 03:16:57 +00:00
all.vcproj
autogen.sh Don't assume $(uname) works; it's not a standard Bourne shell feature, 2013-06-20 00:27:52 +00:00
capinfos.c For getopt() arg processing: 2014-01-02 15:41:45 +00:00
capture-pcap-util-int.h
capture-pcap-util-unix.c Use a bunch of #includes only when needed. (2nd try; hat tip to Guy). 2013-09-09 14:26:41 +00:00
capture-pcap-util.c Revert SVN #52650 as per discussion on wireshark-dev 2013-10-18 15:08:19 +00:00
capture-pcap-util.h
capture-wpcap.c - Rename PCAP_VERSION to WINPCAP_VERSION - the version of the underlying 2013-12-01 10:05:16 +00:00
capture-wpcap.h
capture.c When including <epan/prefs.h> don't force inclusion of <epan/uat.h> 2013-12-03 22:16:49 +00:00
capture.h Fix warning found by doxygen 2013-12-15 19:07:26 +00:00
capture_ifinfo.c Revert SVN #52650 as per discussion on wireshark-dev 2013-10-18 15:08:19 +00:00
capture_ifinfo.h get main_window_update out of the way... pass an update_cb to the capture_sync stuff 2013-06-27 17:10:50 +00:00
capture_info.c Add missing includes 2013-12-21 17:23:17 +00:00
capture_info.h Pull the capture-session state information out of capture_opts and put 2013-05-22 07:44:28 +00:00
capture_opts.c When including <epan/prefs.h> don't force inclusion of <epan/uat.h> 2013-12-03 22:16:49 +00:00
capture_opts.h Add a comment about the "default options". 2013-11-26 02:25:20 +00:00
capture_session.h Try to fix Qt compilation when libpcap is disabled. 2013-10-11 21:26:26 +00:00
capture_stop_conditions.c Handle the 2GiB boundary case of the max filesize autostop condition properly so that we avoid overflow conditions and so that we ensure we don't capture more than 2GiB. Also, document the max filesize autostop value of 2GIB as well as indicating that it's truly GiB and not GB. 2013-08-29 18:15:13 +00:00
capture_stop_conditions.h
capture_sync.c When including <epan/prefs.h> don't force inclusion of <epan/uat.h> 2013-12-03 22:16:49 +00:00
capture_sync.h Fix warning found by doxygen 2013-12-15 19:07:26 +00:00
capture_ui_utils.c get main_window_update out of the way... pass an update_cb to the capture_sync stuff 2013-06-27 17:10:50 +00:00
capture_ui_utils.h Add interface options preferences. 2013-03-13 12:38:08 +00:00
capture_win_ifnames.c Use SecureZeroMemory instead of plain ZeroMemory because checkAPI says to. 2013-10-20 23:38:37 +00:00
capture_win_ifnames.h Fix another dozen or so files with bad FSF addresses as caught by licensecheck. 2013-04-16 00:00:09 +00:00
capture_wpcap_packet.c Replace STRINGIFY with glib version. 2013-11-09 14:37:13 +00:00
capture_wpcap_packet.h
captype.c Report files not recognized as capture files as type "unknown" rather 2013-12-26 13:45:59 +00:00
cfile.c Abuse epan_t more: add callback to get interface name. 2013-07-22 19:38:38 +00:00
cfile.h Avoid including definition of column_info structure in dissectors. 2013-12-22 10:41:27 +00:00
cfilters
cfutils.c Replace implicit conversions with explicit casts. 2013-03-24 18:22:07 +00:00
cfutils.h
clopts_common.c No need to include epan header files here; include things directly as necessary. 2013-07-12 01:22:35 +00:00
clopts_common.h
cmakeconfig.h.in At least winpcap checks for WIN32 and not for _WIN32, so 2013-11-29 09:45:44 +00:00
cmdarg_err.h No need to include epan header files here; include things directly as necessary. 2013-07-12 01:22:35 +00:00
color.h
color_filters.c When including <epan/prefs.h> don't force inclusion of <epan/uat.h> 2013-12-03 22:16:49 +00:00
color_filters.h Avoid including <epan/epan.h> in dissectors. 2013-12-03 23:49:51 +00:00
colorfilters Add HTTP2 to colorfilters 2013-08-30 11:14:26 +00:00
conditions.c Reformat some lines; 2013-11-16 03:16:57 +00:00
conditions.h Reformat some lines; 2013-11-16 03:16:57 +00:00
config.guess Update to the latest config.guess and config.sub. 2013-06-11 02:14:47 +00:00
config.h.win32 Add MSC version for VS2013. 2013-12-08 21:28:29 +00:00
config.nmake Back out inadvertant change introduced in SVN #54340 2013-12-23 16:47:10 +00:00
config.sub Update to the latest config.guess and config.sub. 2013-06-11 02:14:47 +00:00
configure.ac From Dirk 2013-12-31 14:20:08 +00:00
dfilter_macros
dfilters
dftest.c Initialize the error-reporting routines before scanning for plugins, as 2013-12-05 09:30:22 +00:00
doxygen.cfg.in Move the contents of wsar_html/core to wsar_html. Create tag files for 2013-04-30 00:27:02 +00:00
doxygen_global.cfg From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
dumpcap.c Change G_GINT64_CONSTANT(xxxxU) to G_GUINT64_CONSTANT(xxxx) 2013-12-20 22:39:32 +00:00
dumpcap.vcproj Move tempfile.{h,c} into wsutil. 2013-06-26 01:14:35 +00:00
echld_test.c Remove not needed ';' 2013-12-14 11:12:20 +00:00
editcap.c From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
file.c int -> gboolean 2013-12-05 21:35:25 +00:00
file.h cf_start_tail() is (now) just a wrapper around cf_open(). Get rid of it and just call cf_open(). 2013-10-11 21:29:12 +00:00
fileset.c Move the epan/filesystem.c routines to wsutil; they're not specific to 2013-11-17 02:55:14 +00:00
fileset.h
filters.c Move the epan/filesystem.c routines to wsutil; they're not specific to 2013-11-17 02:55:14 +00:00
filters.h
frame_tvbuff.c If packet was modified fallback to generic clone 2013-08-20 19:53:24 +00:00
frame_tvbuff.h Avoid including <wiretap/wtap.h> in dissectors. 2013-11-29 20:53:00 +00:00
globals.h
iface_monitor.c For C string functions, the header to include is <string.h>, not 2013-07-06 08:29:01 +00:00
iface_monitor.h
ipmap.html
log.h
macosx-setup.sh From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
make-version.pl 1.11.2 → 1.11.3. 2013-11-18 17:41:00 +00:00
manuf The IEEE OUI, IAB, and OUI-36 lists currently redirect to 2013-12-29 17:28:12 +00:00
manuf.tmpl From Hadriel Kaplan: 2013-03-26 21:53:09 +00:00
mergecap.c The "file types" we have are actually combinations of types and 2013-11-08 09:53:01 +00:00
mkcap.c
nio-ie5.c
nio-ie5.h
packaging.vcproj Revert part of 52896 and (for now) all of 52935. As Jeff pointed out, 2013-10-29 04:05:27 +00:00
pcapio.c Change G_GINT64_CONSTANT(xxxxU) to G_GUINT64_CONSTANT(xxxx) 2013-12-20 22:39:32 +00:00
pcapio.h Fix warning found by doxygen 2013-12-15 19:07:26 +00:00
pdml2html.xsl Add some license headers after emailing the respective authors to confirm. 2013-10-09 17:30:50 +00:00
proto_hier_stats.c Some work on multi file dissection 2013-07-21 18:38:03 +00:00
proto_hier_stats.h
randpkt.c Follow convention for -h option: 2013-12-31 16:17:09 +00:00
rawshark.c Add FT_SYSTEM_ID type and convert the dissectors that use print_system_id with FT_BYTES to now use FT_SYSTEM_ID type. 2013-12-23 15:18:48 +00:00
register.h Export libwireshark symbols using WS_DLL_PUBLIC define 2013-03-01 23:53:11 +00:00
reordercap.c Add -h option (with output to stdout and exit status 0). 2013-12-31 16:23:00 +00:00
ringbuffer.c coverity 990813 dereference after null check 2013-03-31 16:19:53 +00:00
ringbuffer.h
services [Automatic manuf, services and enterprise-numbers update for 2013-12-29] 2013-12-29 15:03:50 +00:00
smi_modules
stat_menu.h Add a REGISTER_STAT_GROUP_TELEPHONY_SCTP, make the SCTP chunk counter 2013-05-31 23:00:39 +00:00
summary.c
summary.h Make the stuff in summary.h usable from C++ code. 2013-05-22 08:21:33 +00:00
sync_pipe.h
sync_pipe_write.c
text2pcap-scanner.l
text2pcap.c Use the normal convention for exit status and output file descriptors: 2013-12-31 15:10:51 +00:00
text2pcap.h
trigcap.c
tshark.c Improve tshark command-line error help. Fixes https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9548 and adds addtional help, better formatting, sorting and some minimal documentation of the -u option to the tshark man page. 2013-12-11 16:52:40 +00:00
tshark.vcproj
update.c Move the epan/filesystem.c routines to wsutil; they're not specific to 2013-11-17 02:55:14 +00:00
version_info.c Happy new year! 2014-01-01 12:20:27 +00:00
version_info.h
wireshark-mime-package.xml Also register for gzip'd network captures. 2013-03-25 02:11:07 +00:00
wireshark.desktop Update URLs to specs. 2013-03-09 01:35:58 +00:00
wireshark.dox Move the contents of wsar_html/core to wsar_html. Create tag files for 2013-04-30 00:27:02 +00:00
wireshark.sln
wireshark.vcproj
wka.tmpl
ws80211_utils.c From Ville Skyttä: Spelling Fixes 2013-12-23 15:53:13 +00:00
ws80211_utils.h Fix includes to get things compiling. 2013-07-22 11:17:25 +00:00
ws_symbol_export.h I guess the order *doesn't* matter. 2013-11-16 22:57:54 +00:00

README

$Id$

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".
Perl is also needed to create the man page.

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'.

If you decide to modify the NetWare Core Protocol dissector, you
will need python, as the data for packet types is stored in a python
script, ncp2222.py.

You must therefore install Perl, 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>