wireshark.org protocol dissector with Osmocom additions
 
 
 
 
 
 
Go to file
John Thacker e33bc8d5bf docs: Update the sample dissector
Update the sample dissector for some best practices,
and avoid some deprecated behavior.

Use register_protocol instead of creating an anonymous
dissector handle, so that Lua, Export PDU, custom
User DLT disection, etc. can find it. (See #5612)

Use auto preferences and prefer port ranges when possible
(See #14319)
2022-08-15 04:53:58 +00:00
.github/workflows github: fix ubuntu workflow. 2022-08-01 21:36:07 +00:00
.gitlab/issue_templates Gitlab Issue Template: Add label via quick action 2021-04-20 10:28:13 +00:00
.tx Transifex: Update our configuration. 2021-10-06 00:04:08 +00:00
capture capture: Stop extcaps before dumpcap 2022-08-13 20:23:51 +02:00
cmake/modules Docs: Fix our man page dependencies. 2022-07-29 18:52:07 +00:00
doc docs: Update the sample dissector 2022-08-15 04:53:58 +00:00
docbook Docbook: Add a comment about the "reproducible" attribute. 2022-08-13 17:16:51 +00:00
epan frame: warn if the real length is less than the captured length. 2022-08-14 16:12:07 -07:00
extcap sshdump: may be used uninitialized in this function [-Wmaybe-uninitialized] 2022-08-12 18:25:56 +00:00
fix FIX: fix spelling typo found by lintian 2016-11-02 14:03:52 +00:00
fuzz epan: Rearrange column includes 2022-08-13 19:37:28 +00:00
include exceptions: make the exception handler stack per-thread. 2022-01-11 05:00:42 +00:00
macosx-support-lib-patches macos-setup.sh: More GTK and minimum supported version cleanups 2018-04-10 05:02:17 +00:00
packaging wsutil: Remove flawed ws_pipe_close() function 2022-08-14 16:05:22 +00:00
plugins Use `register_dissector()` for more protocols 2022-08-09 18:50:08 +00:00
randpkt_core wiretap: have wtap_dump_close() provide a "needs to be reloaded" indication. 2022-03-14 19:12:20 +00:00
resources Qt: Add an "x-reset" icon and use to reset extcap options. 2022-08-07 20:21:12 +00:00
speexdsp Windows: Don't define or check for WIN32. 2022-08-05 08:33:49 +00:00
test HTTP2: Send headers to the follow tap after decompression 2022-08-08 23:50:20 +00:00
tools check_typed_item_calls.py: check for consecutive calls to same item 2022-08-12 16:20:35 +00:00
ui [Automatic update for 2022-08-14] 2022-08-14 16:53:51 +00:00
wiretap wiretap: Do not silently limit capture length 2022-08-03 18:50:53 +02:00
writecap Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
wsutil wsutil: Remove flawed ws_pipe_close() function 2022-08-14 16:05:22 +00:00
.cirrus.yml cirrus: remove FreeBSD 11.4. 2020-12-18 23:20:34 +01:00
.editorconfig Git+CMake: Add support for CMake presets. 2022-06-05 13:04:07 -07:00
.gitattributes tools: Port make-version.pl to Python 2022-07-11 14:44:23 +00:00
.gitignore gitignore: Add Qt creator autosave 2022-07-28 14:29:12 +00:00
.gitlab-ci.yml GitLab CI: BUILD_logwolf → BUILD_logray. 2022-08-11 17:56:28 -07:00
.mailmap MeshConnex (MCX): MCX packet decode logic 2021-12-02 17:05:21 +05:30
.travis.yml CI: Don't run xcode-select. 2021-02-18 13:54:47 +00:00
AUTHORS [Automatic update for 2022-08-07] 2022-08-07 16:38:23 +00:00
AUTHORS.src Convert Acknowledgements to markdown and update GUI 2022-08-02 00:09:29 +00:00
Acknowledgements.md Convert Acknowledgements to markdown and update GUI 2022-08-02 00:09:29 +00:00
CMakeGraphVizOptions.cmake cmake: Add CMakeGraphVizOptions.cmake to improve the generated layout. 2018-11-11 00:15:01 +00:00
CMakeLists.txt extcap: Close capture session after extcap finishes 2022-08-10 06:18:15 +02:00
CMakeListsCustom.txt.example HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
CMakeOptions.txt Rename Logwolf to Logray 2022-07-06 15:04:25 +00:00
CODE_OF_CONDUCT.adoc Add a code of conduct. 2021-08-30 20:29:19 +00:00
CONTRIBUTING.md Add an initial CONTRIBUTING file. 2021-02-04 01:02:19 +00:00
COPYING Update license file structure and GUI display 2022-07-21 19:10:06 +00:00
ChangeLog Build: 3.7.2. 2022-07-28 12:05:42 -07:00
ConfigureChecks.cmake wsutil/inet_addr: Refactor to use C99/POSIX types 2021-12-27 19:02:50 +00:00
INSTALL More Perl cleanup. 2022-07-24 11:05:44 -07:00
NEWS [Automatic update for 2022-08-07] 2022-08-07 16:38:23 +00:00
README.DECT Fix some spellings. 2022-07-06 09:02:37 +01:00
README.aix HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
README.bsd docs: Remove references to configure 2022-04-28 16:19:13 +00:00
README.hpux docs: Remove references to configure 2022-04-28 16:19:13 +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 Make Perl optional. 2022-07-23 21:12:25 +00:00
README.msys2 CMake: Use more consistent naming for options 2022-01-03 15:55:06 +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 plugins.example: Make installation relocatable 2022-03-28 13:23:28 +00:00
appveyor.yml appveyor: We no longer require Perl. 2022-07-24 23:47:53 +00:00
capinfos.c wsutil: Add configuration namespaces. 2022-04-04 09:39:27 -07:00
capture_opts.c wsutil: Remove flawed ws_pipe_close() function 2022-08-14 16:05:22 +00:00
capture_opts.h capture: Stop extcaps before dumpcap 2022-08-13 20:23:51 +02:00
captype.c wsutil: Add configuration namespaces. 2022-04-04 09:39:27 -07:00
cfile.c Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
cfile.h Convert capture file regex search to PCRE2. 2022-07-27 11:21:03 +00:00
cli_main.c cli-main.c: free() argv's memory 2020-12-12 17:29:57 +00:00
cli_main.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
cmake_uninstall.cmake.in cmake: fix the uninstall script. 2021-09-11 15:21:19 -07:00
cmakeconfig.h.in Windows: Don't define or check for WIN32. 2022-08-05 08:33:49 +00:00
dftest.c Try to fix a narrowing warning 2022-04-11 22:23:13 +01:00
doxygen.cfg.in CMake: Deduplicate some version variables. 2022-06-07 16:04:17 -07:00
dumpcap.c dumpcap: Count more block types as packets. 2022-03-20 17:04:58 +00:00
editcap.c Make sure we don't create comment options longer than 65535 bytes. 2022-08-02 16:38:49 -07:00
enterprises.tsv [Automatic update for 2022-08-14] 2022-08-14 16:53:51 +00:00
extcap.c capture: Stop extcaps before dumpcap 2022-08-13 20:23:51 +02:00
extcap.h capture: Stop extcaps before dumpcap 2022-08-13 20:23:51 +02:00
extcap_parser.c Prefs/Extcap: Added support for password which is never stored on the disk 2021-12-30 16:03:15 +00:00
extcap_parser.h extcap: Add header files to Doxygen 2021-11-30 08:29:39 +00:00
file.c Convert capture file regex search to PCRE2. 2022-07-27 11:21:03 +00:00
file.h file: Fix documentation 2022-06-28 20:53:24 +00:00
file_packet_provider.c regex: Prefer C99/POSIX types 2021-11-15 02:41:59 +00:00
fileset.c Replace g_strdup_printf() with ws_strdup_printf() 2021-12-19 21:21:58 +00:00
fileset.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
frame_tvbuff.c Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
frame_tvbuff.h Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
globals.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
gpl-2.0-standalone.html Update license file structure and GUI display 2022-07-21 19:10:06 +00:00
manuf [Automatic update for 2022-08-14] 2022-08-14 16:53:51 +00:00
manuf.tmpl Remove more duplicate manuf.tmpl entries. 2021-01-01 19:58:45 +00:00
mergecap.c editcap/mergecap: swap 'v'|'V' options to match other CLI utilities 2022-06-16 02:13:50 +00:00
mmdbresolve.c mmdbresolve: check the return value of malloc 2019-06-26 06:44:07 +00:00
pytest.ini test: enable parallelism by default for pytest 2019-01-05 06:47:25 +00:00
randpkt.c wsutil: Add configuration namespaces. 2022-04-04 09:39:27 -07:00
rawshark.c extcap: Close capture session after extcap finishes 2022-08-10 06:18:15 +02:00
reordercap.c wsutil: Add configuration namespaces. 2022-04-04 09:39:27 -07:00
ringbuffer.c Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
ringbuffer.h Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
services [Automatic update for 2022-08-14] 2022-08-14 16:53:51 +00:00
sharkd.c wsutil: Add configuration namespaces. 2022-04-04 09:39:27 -07:00
sharkd.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
sharkd_daemon.c Remove editor modelines and .editorconfig exceptions from root files 2022-02-20 19:39:37 +00:00
sharkd_session.c epan: Rearrange column includes 2022-08-13 19:37:28 +00:00
sync_pipe.h Add a ws_posix_compat.h header 2021-12-21 01:30:06 +00:00
sync_pipe_write.c Replace g_assert() with ws_assert() 2021-06-19 01:23:31 +00:00
text2pcap.c text2pcap: Switch default file format to pcapng 2022-05-12 16:20:40 +00:00
text2pcap.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +00:00
tfshark.c extcap: Close capture session after extcap finishes 2022-08-10 06:18:15 +02:00
tshark.c capture: Move capture pipe polling out of UI 2022-07-30 16:42:12 +02:00
vagrant_build.sh Vagrant: Fix provisioning script 2019-09-20 22:06:21 +00:00
wireshark.dox Switch the Doxygen API reference build to CMake. 2018-04-17 03:46:05 +00:00
wireshark.pc.in CMake: Deduplicate some version variables. 2022-06-07 16:04:17 -07:00
wka wka: Add Cisco ACI gleaning src MAC 2020-01-09 14:54:45 +00:00
ws_version.h.in plugins: Minor interface improvement 2018-08-21 19:56:12 +00:00
wspcap.h Add remaining header files to Doxygen 2021-12-12 03:56:35 +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.

Python 3 is needed to build Wireshark. AsciiDoctor is required to build the documentation, including the man pages. Perl and flex are required to generate some of the source code.

You must therefore install Python 3, AsciiDoctor, and GNU "flex" (vanilla "lex" won't work) on systems that lack them. You might need to install Perl as well.

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 compressed versions of any of those files if the required compression library was available when Wireshark was compiled. Currently supported compression formats are:

  • GZIP
  • ZSTD
  • LZ4

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

License

Wireshark is distributed under the GNU GPLv2. See the file COPYING for the full text of the license. When in doubt the full text is the legally binding part. These notes are just to make it easier for people that are not familiar with the GPLv2.

There are no restrictions on its use. There are restrictions on its distribution in source or binary form.

Most parts of Wireshark are covered by a "GPL version 2 or later" license. Some files are covered by different licenses that are compatible with the GPLv2.

As a notable exception, some utilities distributed with the Wireshark source are covered by other licenses that are not themselves directly compatible with the GPLv2. This is OK, as only the tools themselves are licensed this way, the output of the tools is not considered a derived work, and so can be safely licensed for Wireshark's use. An incomplete selection of these tools includes:

  • the pidl utility (tools/pidl) is licensed under the GPLv3+.

Parts of Wireshark can be built and distributed as libraries. These parts are still covered by the GPL, and NOT by the Lesser General Public License or any other license.

If you integrate all or part of Wireshark into your own application, then that application must be released under a license compatible with the GPL.

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