wireshark.org protocol dissector with Osmocom additions
Go to file
Guy Harris 5fbcfd632a Clean up some UN*X-vs-Windows socket issues.
Have a wsutil/socket.h file, for inclusion by everything that uses
sockets, that contains the UN*X-vs-Windows #includes and #defines to
hide some UN*X-sockets vs. Winsock API differences.  That stuff mostly
comes from from extcap/extcap-base.h; have that file just include
wsutil/socket.h rather than defining that stuff itself.

Include it in sharkd_daemon.c.  Use socklen_t for the size of things to
pass to bind() as the last argument; wsutil/socket.h defines it as int
on Windows.

Ignore sharkd in Git.

Change-Id: I3f2171b7aa613717f52305f62bfd7d43e0172dc6
Reviewed-on: https://code.wireshark.org/review/19796
Petri-Dish: Guy Harris <guy@alum.mit.edu>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2017-01-26 07:00:06 +00:00
.tx Transifex: Add type of translation file 2015-10-22 08:10:11 +00:00
capchild capchild: Fix loading of extcap with no winpcap.dll 2016-10-21 11:55:26 +00:00
caputils Don't use PCAP_ERROR if it's not known to be defined. 2016-12-19 18:55:59 +00:00
cmake Fix release-notes.html generation 2016-12-15 20:56:21 +00:00
codecs Change SpanDSP capitalization 2016-12-07 00:51:14 +00:00
debian Internalize struct preference 2017-01-22 10:43:57 +00:00
diameter Diameter: decode Emergency-Indication AVP (1538) 2017-01-12 15:43:49 +00:00
doc MAN wireshark-filter: Add ~ operator 2017-01-22 19:05:38 +00:00
docbook Dissector: IndigoCare nursecall protocols support 2017-01-24 14:01:29 +00:00
dtds
echld Add enabled protocol list for dissectors who are disabled by default 2016-12-24 02:30:21 +00:00
epan ldss: Ensure ldss_file_request_t structure gets allocated 2017-01-26 02:04:32 +00:00
extcap Clean up some UN*X-vs-Windows socket issues. 2017-01-26 07:00:06 +00:00
fix FIX: fix spelling typo found by lintian 2016-11-02 14:03:52 +00:00
help help/Makefile.am: Use the python command chosen by the configure script 2016-10-04 01:40:24 +00:00
idl
image Remove name resolution from the file dialogs. 2016-09-09 21:43:01 +00:00
m4 Update comments and messages for the new name for Apple's OS for Macs. 2016-12-20 08:45:51 +00:00
macosx-support-lib-patches Add copyright notices. 2016-08-05 18:21:47 +00:00
packaging Revert "Another change required for that." 2017-01-04 11:11:24 +00:00
plugins profinet (pn): Fix Dead Store (Dead assignement/Dead increment) Warning found by Clang 2017-01-16 16:07:14 +00:00
profiles Bluetooth profile: configure columns and layout for Bluetooth 2016-12-14 22:06:49 +00:00
radius Mark another dictionary as commented out due to no RFC 6929 support. 2016-11-25 03:33:56 +00:00
randpkt_core Have a routine to do all the work of initializing libwiretap. 2016-12-04 21:42:44 +00:00
test lua: Added new integer sizes in TvbRange 2016-11-06 09:01:16 +00:00
tools Fuzz: Fix the capinfos check (again). 2017-01-23 23:24:17 +00:00
tpncp
ui Qt: Use preference editor for port number entries 2017-01-25 18:36:30 +00:00
wimaxasncp Fix a lot of typos and misspellings 2016-01-08 20:04:56 +00:00
wiretap Fix typo. 2017-01-20 01:52:01 +00:00
writecap cmake: make WERROR_COMMON_FLAGS a normal string 2016-09-30 20:08:02 +00:00
wsutil Clean up some UN*X-vs-Windows socket issues. 2017-01-26 07:00:06 +00:00
.bzrignore
.editorconfig remove unused mkcap.c. 2016-09-11 04:22:58 +00:00
.gitattributes
.gitignore Clean up some UN*X-vs-Windows socket issues. 2017-01-26 07:00:06 +00:00
.gitlab-ci.yml Add .gitlab-ci.yml. 2016-11-25 17:07:49 +00:00
.gitreview
.mailmap .mailmap: Update (of november) 2016-12-09 00:25:50 +00:00
.travis.yml travis: improve test matrix. 2016-11-14 17:56:21 +00:00
AUTHORS [Automatic update for 2017-01-22] 2017-01-22 16:11:59 +00:00
AUTHORS.src AUTHORS: Update record for Harald Welte 2016-11-07 14:00:31 +00:00
CMakeLists.txt CMake,autotools: remove unneeded files, fixes build 2017-01-25 15:19:03 +00:00
CMakeListsCustom.txt.example Add modelines 2016-06-19 08:40:16 +00:00
CMakeOptions.txt sharkd: add cmake option. 2017-01-25 15:06:46 +00:00
COPYING
CPackConfig.txt cmake: add creation of version.conf to be shipped in tarball. 2016-11-21 09:02:11 +00:00
ChangeLog Build 2.1.1. 2016-07-14 18:14:47 +00:00
ConfigureChecks.cmake Fix the #defines for the presence of structure names. 2016-10-22 09:53:19 +00:00
INSTALL
INSTALL.configure
Makefile.am CMake,autotools: remove unneeded files, fixes build 2017-01-25 15:19:03 +00:00
Makefile.am.inc Use the proper include dirs for ABI check 2016-10-19 07:45:13 +00:00
NEWS Build 2.1.1. 2016-07-14 18:14:47 +00:00
README Update the README. 2016-08-18 04:26:32 +00:00
README.DECT
README.aix
README.bsd
README.cmake cmake: install icons and .desktop files 2016-11-18 20:15:23 +00:00
README.hpux
README.linux
README.macos Cleanups. 2015-11-17 22:36:16 +00:00
README.vmware
README.windows
Vagrantfile
abi-descriptor.template Fix 'make dumpapi' target 2015-11-23 07:50:57 +00:00
acinclude.m4 CMake,autotools: enable -Werror=implicit by default 2016-12-28 22:31:28 +00:00
autogen.sh Run libtoolize before aclocal. 2017-01-11 05:44:09 +00:00
capinfos.c Fix exit code for non-existent file. 2017-01-08 08:10:59 +00:00
capture_info.c Don't limit capture packet counts to a fixed set of protocols. 2015-12-22 05:23:06 +00:00
capture_info.h Don't limit capture packet counts to a fixed set of protocols. 2015-12-22 05:23:06 +00:00
capture_opts.c More signed vs. unsigned argument cleanups. 2016-09-11 20:49:05 +00:00
capture_opts.h Have routines for parsing options that affect dissection. 2016-10-30 22:57:16 +00:00
capture_stop_conditions.c Clean up includes of unistd.h, fcntl.h, and sys/stat.h. 2015-11-07 21:52:23 +00:00
capture_stop_conditions.h
captype.c Fix exit code for non-existent file. 2017-01-08 08:10:59 +00:00
cfile.c No need to check for string option values being null. 2016-07-21 00:28:18 +00:00
cfile.h Line up comments. 2016-06-11 20:28:57 +00:00
cfilters
cmakeconfig.h.in Change SpanDSP capitalization 2016-12-07 00:51:14 +00:00
colorfilters Add proto_tree_add_checksum. 2016-07-21 12:35:22 +00:00
conditions.c
conditions.h
config.guess Update to the latest config.guess and config.sub 2016-06-15 20:50:04 +00:00
config.sub Update to the latest config.guess and config.sub 2016-06-15 20:50:04 +00:00
configure.ac Add sharkd - daemon variant 2017-01-25 07:19:05 +00:00
dfilter_macros
dfilters
dftest.c Clean up initialization code for programs. 2016-12-05 04:27:49 +00:00
doxygen.cfg.in
doxygen_global.cfg
dumpcap.c Qt: Fix simple_dialog formatting. 2016-11-30 17:06:39 +00:00
echld_test.c
editcap.c Clean up initialization code for programs. 2016-12-05 04:27:49 +00:00
extcap.c Internalize struct preference 2017-01-22 10:43:57 +00:00
extcap.h Include extcap binaries in the count of things to point out during startup. 2017-01-04 22:10:48 +00:00
extcap_parser.c extcap: add new option type (timestamp). 2016-12-09 04:49:33 +00:00
extcap_parser.h extcap: add new option type (timestamp). 2016-12-09 04:49:33 +00:00
extcap_spawn.c extcap: Whitespace cleanup. 2016-12-08 21:18:41 +00:00
extcap_spawn.h extcap: Use stderr to print error message 2016-07-30 21:15:39 +00:00
file.c Qt: Show merge progress. 2017-01-21 06:50:30 +00:00
file.h Qt: Show merge progress. 2017-01-21 06:50:30 +00:00
fileset.c Clean up conditional code for getting creation time. 2016-10-22 10:18:47 +00:00
fileset.h
filter_files.c use #include <file.h> for generated include files 2016-06-13 21:17:29 +00:00
filter_files.h Allow/Create an option to use "capture filter" labels defined in wireshark GUI from CLI 2016-01-27 13:40:24 +00:00
frame_tvbuff.c Minimize allocations for frame tvbuffs and Buffers. 2016-07-22 04:18:08 +00:00
frame_tvbuff.h
globals.h
ipmap.html
log.h
macosx-setup.sh Add snappy compression library setup 2016-11-02 06:00:01 +00:00
make-version.pl More make-version.pl fixups. 2017-01-05 10:01:31 +00:00
manuf [Automatic update for 2017-01-22] 2017-01-22 16:11:59 +00:00
manuf.tmpl Merge the CaveBear list into manuf.tmpl. 2016-08-22 04:46:52 +00:00
mergecap.c Clean up initialization code for programs. 2016-12-05 04:27:49 +00:00
pdml2html.xsl add link to Wireshark wiki to pdml2html.xsl 2016-09-18 17:49:31 +00:00
randpkt.c Clean up initialization code for programs. 2016-12-05 04:27:49 +00:00
rawshark.c Add enabled protocol list for dissectors who are disabled by default 2016-12-24 02:30:21 +00:00
register.h Remove RA_CONFIGURATION. 2017-01-05 02:46:00 +00:00
reordercap.c Fix exit code for non-existent file. 2017-01-08 08:10:59 +00:00
ringbuffer.c More checks for localtime() and gmtime() returning NULL. 2016-10-22 02:27:32 +00:00
ringbuffer.h Don't include "file.h" if you don't need it. 2015-11-04 08:46:30 +00:00
services [Automatic update for 2017-01-15] 2017-01-15 16:12:14 +00:00
sharkd.c Add sharkd - daemon variant 2017-01-25 07:19:05 +00:00
sharkd.h Add sharkd - daemon variant 2017-01-25 07:19:05 +00:00
sharkd_daemon.c Clean up some UN*X-vs-Windows socket issues. 2017-01-26 07:00:06 +00:00
sharkd_session.c Make some variables 64-bit, to avoid overflows. 2017-01-26 06:06:30 +00:00
smi_modules
summary.c Redo the block options APIs. 2016-07-14 23:02:39 +00:00
summary.h Directly use wtap_opttypes calls to fetch SHB options. 2016-06-06 00:22:21 +00:00
sync_pipe.h Revert "Windows: Wait for dumpcap to initialize." 2016-04-28 00:12:31 +00:00
sync_pipe_write.c Windows: Remove the need for _CRT_NONSTDC_NO_DEPRECATE. 2016-04-13 02:16:20 +00:00
text2pcap-scanner.l Include config.h at the very beginning of all Flex scanners. 2016-12-02 21:02:10 +00:00
text2pcap.c Include <io.h> and <fcntl.h> for _setmode(). 2016-11-22 19:40:21 +00:00
text2pcap.h
tfshark.c Add enabled protocol list for dissectors who are disabled by default 2016-12-24 02:30:21 +00:00
trigcap.c
tshark.c Add enabled protocol list for dissectors who are disabled by default 2016-12-24 02:30:21 +00:00
vagrant_build.sh
vagrant_provision.sh
wireshark-gtk.desktop Change "System" category to "Network" in desktop files 2016-03-04 16:07:31 +00:00
wireshark-mime-package.xml Don't register Wireshark for .pfx (IPFIX) files. 2016-06-14 03:37:17 +00:00
wireshark-qt.cpp Add g_log entries to measure startup time, protected by #ifdef 2017-01-05 10:57:49 +00:00
wireshark.appdata.xml
wireshark.desktop Register a few more file extensions as belonging to Wireshark. 2016-06-01 04:30:19 +00:00
wireshark.dox
wireshark.pc.in Generate better pkg-config file 2016-01-04 08:15:29 +00:00
wka.tmpl Change spaces to tab for recent wka entries 2016-12-13 07:34:59 +00:00
ws_diag_control.h Add clang-specific DIAG_OFF pragma 2016-05-22 04:55:47 +00:00
ws_symbol_export.h
ws_version_info.c make-version: Clean up handling of VCSVERSION 2016-10-28 08:33:25 +00:00
ws_version_info.h Link version code statically again 2016-04-21 18:59:56 +00:00

README

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

Wireshark is a network traffic analyzer, or "sniffer", for Unix and
Unix-like operating systems.  It uses Qt, 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

    https://www.wireshark.org

The latest distribution can be found in the subdirectory

    https://www.wireshark.org/download


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

The Wireshark project builds and tests regularly on the following platforms:

  - Linux (Ubuntu)
  - Microsoft Windows
  - macOS / OS X

Official installation packages are available for Microsoft Windows and
macOS.

It is available as either a standard or add-on package for many popular
operating sytems and Linux distributions including Debian, Ubuntu, Fedora,
CentOS, RHEL, Arch, Gentoo, openSUSE, FreeBSD, DragonFly BSD, NetBSD, and
OpenBSD.

Additionaly it is available through many third-party packaging systems
such as pkgsrc, OpenCSW, Homebrew, and MacPorts.

It should run on other Unix-ish systems without too much trouble.

In some cases the current version of Wireshark might not support your
operating system. This is the case for Windows XP, which is supported by
Wireshark 1.10 and earlier. In other cases the standard package for
Wireshark might simply be old. This is the case for Solaris and HP-UX.

NOTE: The Makefile depends 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 and in the
Developer's Guide at https://www.wireshark.org/docs/wsdg_html_chunked/

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


Name Resolution
---------------

Wireshark will attempt to use reverse name resolution capabilities
when decoding IPv4 and 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".


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 under constant development, so it is possible that you will
encounter a bug while using it. Please report bugs at https://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>