wireshark.org protocol dissector with Osmocom additions
 
 
 
 
 
 
Go to file
João Valverde dc7f0b88bb Refactor our logging and extend the wslog API
Experience has shown that:

  1. The current logging methods are not very reliable or practical.
A logging bitmask makes little sense as the user-facing interface (who
would want debug but not crtical messages for example?); it's
computer-friendly and user-unfriendly. More importantly the console
log level preference is initialized too late in the startup process
to be used for the logging subsystem and that fact raises a number
of annoying and hard-to-fix usability issues.

  2. Coding around G_MESSAGES_DEBUG to comply with our log level mask
and not clobber the user's settings or not create unexpected log misses
is unworkable and generally follows the principle of most surprise.
The fact that G_MESSAGES_DEBUG="all" can leak to other programs using
GLib is also annoying.

  3. The non-structured GLib logging API is very opinionated and lacks
configurability beyond replacing the log handler.

  4. Windows GUI has some special code to attach to a console,
but it would be nice to abstract away the rest under a single
interface.

  5. Using this logger seems to be noticeably faster.

Deprecate the console log level preference and extend our API to
implement a log handler in wsutil/wslog.h to provide easy-to-use,
flexible and dependable logging during all execution phases.

Log levels have a hierarchy, from most verbose to least verbose
(debug to error). When a given level is set everything above that
is also enabled.

The log level can be set with an environment variable or a command
line option (parsed as soon as possible but still later than the
environment). The default log level is "message".

Dissector logging is not included because it is not clear what log
domain they should use. An explosion to thousands of domains is
not desirable and putting everything in a single domain is probably
too coarse and noisy. For now I think it makes sense to let them do
their own thing using g_log_default_handler() and continue using the
G_MESSAGES_DEBUG mechanism with specific domains for each individual
dissector.

In the future a mechanism may be added to selectively enable these
domains at runtime while trying to avoid the problems introduced
by G_MESSAGES_DEBUG.
2021-06-11 09:40:28 +00:00
.github CI: Don't run xcode-select. 2021-02-18 13:54:47 +00:00
.gitlab/issue_templates Gitlab Issue Template: Add label via quick action 2021-04-20 10:28:13 +00:00
.tx Qt: Add Spanish (es) translation assets. 2020-01-03 08:27:21 +00:00
capture Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
cmake/modules Windows: Update GLib to 2.66.4. 2021-06-10 03:48:28 +00:00
debian Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
diameter Diameter: Update AVPs from 3GPP TS 29.272 V16.4.0 2021-06-03 15:49:38 +02:00
doc Add documentation for display filter raw string syntax 2021-06-07 18:58:49 +00:00
docbook WSUG: README.Debian - update file: link; add online link 2021-06-09 04:36:34 +00:00
dtds HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
epan Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
extcap Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
fix FIX: fix spelling typo found by lintian 2016-11-02 14:03:52 +00:00
fuzz fuzzshark: close a leak. 2021-05-21 19:40:00 -07:00
idl HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
image Fix the captions for the buttons in the "export specified packets" dialog. 2021-03-14 17:10:57 -07:00
macosx-support-lib-patches macos-setup.sh: More GTK and minimum supported version cleanups 2018-04-10 05:02:17 +00:00
packaging Windows: Switch from HTML Help to plain HTML. 2021-06-04 08:57:32 +00:00
plugins PROFINET: DCP SET Block with 0 Block Length 2021-06-09 05:23:16 +00:00
profiles [Automatic update for 2021-05-09] 2021-05-09 09:29:13 +00:00
protobuf Add SparkplugB dissector 2021-05-14 12:11:03 +01:00
radius radius dict aerohive: Add comment about attr 212 (ap mgmt mac) 2021-02-23 20:27:05 +00:00
randpkt_core CMake: Add ENABLE_VLD option for MSVC 2021-04-10 21:53:59 +00:00
speexdsp CMake: Check for and use system SpeexDSP library 2019-05-02 21:12:01 +00:00
test Updated unit test with relative sequence numbers. 2021-06-09 05:08:11 +00:00
tools Windows: Update GLib to 2.66.4. 2021-06-10 03:48:28 +00:00
tpncp TPNCP: Initial support for "Since" version 2021-01-01 10:22:48 +00:00
ui Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
wimaxasncp
wiretap Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
writecap Write the if_hardware option, if available, to pcapng files when capturing. 2020-03-28 03:34:18 +00:00
wsutil Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
.bzrignore
.cirrus.yml cirrus: remove FreeBSD 11.4. 2020-12-18 23:20:34 +01:00
.editorconfig Miscellaneous EditorConfig fixes 2021-03-02 19:13:54 +00:00
.gitattributes version: include version information for tarballs from git 2019-05-16 17:31:50 +00:00
.gitignore Add /*build*/ to .gitignore 2020-09-27 21:36:15 +00:00
.gitlab-ci.yml GitLab CI: Don't clobber the Code Lines before_script. 2021-06-07 11:40:19 -07:00
.mailmap Update .mailmap after g2402521a 2020-10-06 20:21:53 +00:00
.travis.yml CI: Don't run xcode-select. 2021-02-18 13:54:47 +00:00
AUTHORS [Automatic update for 2021-06-06] 2021-06-06 17:06:37 +00:00
AUTHORS.src Added "Follow DCCP stream" feature. 2021-02-22 12:48:46 +01:00
CMakeGraphVizOptions.cmake cmake: Add CMakeGraphVizOptions.cmake to improve the generated layout. 2018-11-11 00:15:01 +00:00
CMakeLists.txt Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
CMakeListsCustom.txt.example HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
CMakeOptions.txt CMake: Reverse logic to handle debug code 2021-06-10 00:57:49 +01:00
CONTRIBUTING.md Add an initial CONTRIBUTING file. 2021-02-04 01:02:19 +00:00
COPYING
ChangeLog Build: 3.3.1. 2020-10-01 10:32:43 -07:00
ConfigureChecks.cmake Fix the way we get high-resolution time. 2020-12-20 13:31:57 -08:00
INSTALL Clean up URLs. 2020-10-02 20:13:42 -07:00
NEWS [Automatic update for 2021-06-06] 2021-06-06 17:06:37 +00:00
README.DECT
README.aix HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
README.bsd More Qt minimum version updates. 2019-12-10 19:52:58 +00:00
README.hpux HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
README.linux Note that newer versions of various distributions won't have these problems. 2017-08-02 07:31:18 +00:00
README.macos macOS: Remove more obsolete documentation 2019-09-28 07:22:03 +00:00
README.md wiretap: Convert ascend.y to Lemon. 2020-11-30 08:15:43 +00:00
README.windows Windows: Get rid of textify.ps1. 2019-12-17 21:52:54 +00:00
Vagrantfile Bump Ubuntu version to 18.04 in Vagrantfile 2019-05-30 20:29:47 +00:00
WiresharkConfig.cmake.in CMake: Modernize config-file package support 2018-08-25 18:07:21 +00:00
appveyor.yml appveyor: upload installer artifacts for development branches 2019-02-11 09:36:59 +00:00
capinfos.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
capture_opts.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
capture_opts.h Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
captype.c Add more error-reporting routines that call through a function pointer. 2021-03-15 12:17:59 -07:00
cfile.c Remove unnecessary inclues of wiretap/pcapng.h. 2021-03-15 15:29:40 -07:00
cfile.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
cfilters Remove IPX from our default filters. 2018-06-27 20:46:17 +00:00
cli_main.c cli-main.c: free() argv's memory 2020-12-12 17:29:57 +00:00
cli_main.h cli_main: remove real_main from stack traces for non-Windows 2019-01-02 12:08:20 +00:00
cmakeconfig.h.in Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
colorfilters Remove keep alives from "Bad TCP" coloring rules 2020-03-02 14:48:09 +00:00
dfilter_macros ship the dfilter_macros file. 2019-06-05 17:04:22 +00:00
dfilters Remove IPX from our default filters. 2018-06-27 20:46:17 +00:00
dftest.c Add more error-reporting routines that call through a function pointer. 2021-03-15 12:17:59 -07:00
doxygen.cfg.in Update doxygen config to 1.8.17 2020-05-24 13:05:14 +00:00
dumpcap.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
editcap.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
enterprises.tsv [Automatic update for 2021-06-06] 2021-06-06 17:06:37 +00:00
extcap.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
extcap.h extcap(.h): fix empty paragraph passed to '@return' command [-Wdocumentation] 2020-07-24 12:54:32 +00:00
extcap_parser.c extcap: Fix a memory leak 2020-04-13 12:43:30 +00:00
extcap_parser.h Revert "extcap: Pass --extcap-version if extcap supports it" 2019-12-10 21:09:35 +00:00
file.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
file.h Impose limits on the number of records we read. 2020-10-26 16:52:58 -07:00
file_packet_provider.c Try to squeeze some bytes out of the frame_data structure. 2018-12-27 04:34:29 +00:00
fileset.c Detect and replace bad allocation patterns 2020-12-22 14:56:38 +00:00
fileset.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
frame_tvbuff.c Detect and replace bad allocation patterns 2020-12-22 14:56:38 +00:00
frame_tvbuff.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
globals.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
ipmap.html Update URLs pointing to the bug database. 2020-10-03 07:54:12 -07:00
manuf [Automatic update for 2021-06-06] 2021-06-06 17:06:37 +00:00
manuf.tmpl Remove more duplicate manuf.tmpl entries. 2021-01-01 19:58:45 +00:00
mergecap.c Replace g_assert(FALSE) with g_assert_not_reached() 2021-03-24 22:24:37 +00:00
mmdbresolve.c mmdbresolve: check the return value of malloc 2019-06-26 06:44:07 +00:00
org.wireshark.Wireshark-mime.xml doc: Clean up lists of file types. 2021-03-13 10:02:02 +00:00
org.wireshark.Wireshark.desktop Linux: rename metadata according to spec 2020-12-10 18:11:12 +00:00
org.wireshark.Wireshark.metainfo.xml Linux: rename metadata according to spec 2020-12-10 18:11:12 +00:00
pdml2html.xsl Clean up URLs. 2020-10-02 20:13:42 -07:00
pytest.ini test: enable parallelism by default for pytest 2019-01-05 06:47:25 +00:00
randpkt.c Add a new header defining commonly-used exit codes. 2021-04-13 01:23:21 -07:00
rawshark.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
reordercap.c Add a new header defining commonly-used exit codes. 2021-04-13 01:23:21 -07:00
ringbuffer.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
ringbuffer.h add support for compression of capture file 2020-10-30 00:25:22 +00:00
services [Automatic update for 2021-05-16] 2021-05-16 09:29:06 +00:00
sharkd.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
sharkd.h sharkd: Add configuration profile and other options 2021-02-08 10:27:18 +00:00
sharkd_daemon.c sharkd_daemon: fix signed vs. unsigned comparison. 2021-04-30 23:49:20 -07:00
sharkd_session.c epan: Change export_object_entry_t.payload_len to size_t 2021-06-08 07:16:22 +00:00
smi_modules
sync_pipe.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
sync_pipe_write.c sync_pipe_write: Fixup a comment. 2020-06-08 05:08:35 +00:00
text2pcap-scanner.l text2pcap: gracefully handle hexdump without trailing LF 2018-10-13 05:16:22 +00:00
text2pcap.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
text2pcap.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
tfshark.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
tshark.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
vagrant_build.sh Vagrant: Fix provisioning script 2019-09-20 22:06:21 +00:00
version_info.c version info: Clean clang version 2021-06-07 00:20:14 +00:00
version_info.h Move more version-info-related stuff to version_info.c. 2018-12-13 03:16:13 +00:00
wireshark.dox Switch the Doxygen API reference build to CMake. 2018-04-17 03:46:05 +00:00
wireshark.pc.in plugins: Minor interface improvement 2018-08-21 19:56:12 +00:00
wka wka: Add Cisco ACI gleaning src MAC 2020-01-09 14:54:45 +00:00
ws_attributes.h MSVC: Warn about unused formal parameters 2019-09-21 08:51:34 +00:00
ws_compiler_tests.h replace SPDX identifier GPL-2.0+ with GPL-2.0-or-later. 2018-02-08 14:57:36 +00:00
ws_diag_control.h text_import: just suppress the two-initializers warning. 2021-03-27 14:00:44 -07:00
ws_log_domains.h Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
ws_symbol_export.h HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
ws_version.h.in plugins: Minor interface improvement 2018-08-21 19:56:12 +00:00
wspcap.h Update comments - Npcap no longer requires HAVE_REMOTE to be defined. 2020-03-13 00:13:31 +00:00

README.md

General Information

Wireshark is a network traffic analyzer, or "sniffer", for Linux, macOS, *BSD and other Unix and Unix-like operating systems and for Windows. It uses Qt, a graphical user interface library, and libpcap and npcap as packet capture and filtering libraries.

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 / {Mac} 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 systems and Linux distributions including Debian, Ubuntu, Fedora, CentOS, RHEL, Arch, Gentoo, openSUSE, FreeBSD, DragonFly BSD, NetBSD, and OpenBSD.

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

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

You must therefore install Perl, Python, GNU "make", and "flex" (vanilla "lex" won't work) 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 is 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

Wireshark can read packets from a number of different file types. See the Wireshark man page or the Wireshark User's Guide for a list of supported file formats.

Wireshark can transparently read gzipped versions of any of those files if zlib was available when Wireshark was compiled. CMake will automatically use zlib if it is found on your system. You can disable zlib support by running cmake -DENABLE_ZLIB=OFF.

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; 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 first enter the diags mode and then use create-pkt-log-profile and apply-pkt-lozg-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 log 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 using the Preferences item in the Edit menu, selecting "Name resolution", turning off the appropriate name resolution options, 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. CMake will automatically determine whether you have the libsmi library on your system. If you have the libsmi library but do not want Wireshark to use it, you can run cmake with the -DENABLE_SMI=OFF 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://gitlab.com/wireshark/wireshark/-/issues. 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 gharris@sonic.net