wireshark.org protocol dissector with Osmocom additions
Go to file
Jeff Widman 330fd5733c Add /*build*/ to .gitignore
A common pattern is to build the source artifacts within a *build* dir.

For example, the wiki instructions for [building `wireshark` on `macOS` specify to
create a `./build`
directory](https://gitlab.com/wireshark/wireshark/-/wikis/BuildingAndInstalling#macos):
```
mkdir build && cd build && cmake ../ && make
```

So this commit adds this directory to `.gitignore` to prevent
accidentally committing build artifacts.

The specific format `/*build*/` protects against the following:
1. The leading slash makes sure only top-level directories that match
this pattern are ignored.
2. The trailing slash makes sure that only directories (and not files)
are ignored.
3. The wildcards catch all the various variations on `build` folder name
that are used...
2020-09-27 21:36:15 +00:00
.github github: fix windows build. 2020-09-04 10:27:27 +00:00
.gitlab/issue_templates Fix a typo in FeatureRequest.md 2020-09-08 22:48:27 +02:00
.tx Qt: Add Spanish (es) translation assets. 2020-01-03 08:27:21 +00:00
capchild Have callback function pointers in a capture_session structure. 2020-03-25 23:16:06 +00:00
caputils Windows: Switch from the WpdPack SDK to vcpkg's libpcap. 2020-07-21 04:33:13 +00:00
cmake CMake: Fix libssh >= 0.9.5 version detection 2020-09-12 16:38:01 +01:00
debian Version: 3.3.0 → 3.3.1. 2020-09-15 17:29:32 -07:00
diameter Diameter make use of OctetStringOrUTF8 2020-09-17 08:52:35 +02:00
doc Fix issues discovered by common python linters 2020-09-26 04:38:18 +00:00
docbook docbook: Fix wiki links. 2020-09-24 22:24:10 +00:00
dtds HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
epan Fix some wrong filter names. 2020-09-27 18:40:13 +00:00
extcap wiretap: have wtap_dump_flush(), and its callers, check for errors. 2020-08-09 23:08:51 +00:00
fix
fuzz HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
idl HTTPS In More Places, update some URLs. 2019-07-27 07:55:36 +00:00
image Qt: Add Spanish (es) translation assets. 2020-01-03 08:27:21 +00:00
macosx-support-lib-patches
packaging Windows: upgrade Npcap to 1.00 2020-09-27 14:22:19 +02:00
plugins PROFINET: IOCS and IOData object dissection with Multi AR 2020-09-21 12:54:12 +00:00
profiles [Automatic update for 2020-05-10] 2020-05-10 18:18:48 +00:00
radius Radius: include newly added dictionary files 2020-08-13 05:32:16 +00:00
randpkt_core wiretap: have wtap_dump_flush(), and its callers, check for errors. 2020-08-09 23:08:51 +00:00
speexdsp CMake: Check for and use system SpeexDSP library 2019-05-02 21:12:01 +00:00
test Fix issues discovered by common python linters 2020-09-26 04:38:18 +00:00
tools Windows: upgrade Npcap to 1.00 2020-09-27 14:22:19 +02:00
tpncp TPNCP: Update tpncp.dat 2020-06-08 08:02:27 +00:00
ui Qt: Fix the packet diagram start offset arithmetic. 2020-09-26 12:23:54 -07:00
wimaxasncp
wiretap Yet more spelling fixes. 2020-09-07 16:35:13 +01:00
writecap Write the if_hardware option, if available, to pcapng files when capturing. 2020-03-28 03:34:18 +00:00
wsutil Update our issue tracker URL in some places. 2020-09-16 01:29:07 +00:00
.bzrignore
.cirrus.yml cirrus: upgrade to freebsd 11.4. 2020-08-26 23:55:39 +02:00
.editorconfig GitLab CI: Restrict the Windows build to wireshark/wireshark. 2020-09-07 19:35:45 +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 Windows: Switch to Qt 5.15.1. 2020-09-22 16:35:55 -07:00
.mailmap .mailmap: Update of April/May (2019) 2019-06-05 03:42:16 +00:00
.travis.yml travis: allow ppc64le builds fail. 2020-05-02 22:31:00 +00:00
AUTHORS [Automatic update for 2020-09-27] 2020-09-27 16:25:52 +00:00
AUTHORS.src New dissector: Asphodel Protocol 2020-06-15 19:18:14 +00:00
CMakeGraphVizOptions.cmake cmake: Add CMakeGraphVizOptions.cmake to improve the generated layout. 2018-11-11 00:15:01 +00:00
CMakeLists.txt Shellcheck fixes. 2020-09-21 22:09:13 +00:00
CMakeListsCustom.txt.example HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
CMakeOptions.txt Build: Add LTO/IPO support 2020-08-04 05:21:01 +00:00
COPYING
ChangeLog Build: 3.3.0. 2020-09-15 13:56:25 -07:00
ConfigureChecks.cmake HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
INSTALL More Qt minimum version updates. 2019-12-10 19:52:58 +00:00
NEWS [Automatic update for 2020-09-27] 2020-09-27 16:25:52 +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
README.macos macOS: Remove more obsolete documentation 2019-09-28 07:22:03 +00:00
README.md Update my email address. 2020-09-08 16:26:26 -07: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 Windows: Set our locale to ".UTF-8". 2020-07-06 16:20:25 +00:00
capture_opts.c Dumpcap: print closed ring-buffer file names 2020-08-08 08:04:13 +00:00
capture_opts.h Dumpcap: print closed ring-buffer file names 2020-08-08 08:04:13 +00:00
captype.c Windows: Set our locale to ".UTF-8". 2020-07-06 16:20:25 +00:00
cfile.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
cfile.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
cfilters
cli_main.c cli_main: remove real_main from stack traces for non-Windows 2019-01-02 12:08:20 +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 extcap: assume we're using libssh 0.6 or later. 2020-07-16 09:26:43 +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
dftest.c Windows: Set our locale to ".UTF-8". 2020-07-06 16:20:25 +00:00
doxygen.cfg.in Update doxygen config to 1.8.17 2020-05-24 13:05:14 +00:00
dumpcap.c Dumpcap: print closed ring-buffer file names 2020-08-08 08:04:13 +00:00
editcap.c editcap: use constant for maximum nanosecs in 1sec 2020-08-07 08:24:34 +00:00
enterprises.tsv [Automatic update for 2020-09-27] 2020-09-27 16:25:52 +00:00
extcap.c extcap: Lazily load our interface list. 2020-07-07 05:28:29 +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 Qt: Stretch last packet list header section 2020-05-06 03:50:18 +00:00
file.h Remove some single-SHB assumptions. 2020-05-01 19:46:42 +00: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 HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
fileset.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
frame_tvbuff.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +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 Re-implement "Map" feature for Endpoints 2019-02-16 21:11:12 +00:00
log.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
manuf [Automatic update for 2020-09-27] 2020-09-27 16:25:52 +00:00
manuf.tmpl Convert Gerrit URLs to GitLab. 2020-08-24 23:31:32 +00:00
mergecap.c CMake: remove ENABLE_PCAP_NG_DEFAULT option 2020-04-06 01:29:37 +00:00
mmdbresolve.c mmdbresolve: check the return value of malloc 2019-06-26 06:44:07 +00:00
pdml2html.xsl epan,packaging: convert http URLs to https 2019-07-20 20:50:59 +00:00
pytest.ini test: enable parallelism by default for pytest 2019-01-05 06:47:25 +00:00
randpkt.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
rawshark.c Windows: Set our locale to ".UTF-8". 2020-07-06 16:20:25 +00:00
reordercap.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
ringbuffer.c Dumpcap: print closed ring-buffer file names 2020-08-08 08:04:13 +00:00
ringbuffer.h Dumpcap: print closed ring-buffer file names 2020-08-08 08:04:13 +00:00
services [Automatic update for 2020-09-27] 2020-09-27 16:25:52 +00:00
sharkd.c Kill libwscodecs plugin library, just use plugins 2019-06-11 20:59:39 +00:00
sharkd.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
sharkd_daemon.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
sharkd_session.c Check that at least one token exists to consider the JSON as valid 2020-08-14 13:53:16 +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 Write the if_hardware option, if available, to pcapng files when capturing. 2020-03-28 03:34:18 +00:00
text2pcap.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
tfshark.c Windows: Set our locale to ".UTF-8". 2020-07-06 16:20:25 +00:00
tshark.c extcap: Lazily load our interface list. 2020-07-07 05:28:29 +00:00
vagrant_build.sh Vagrant: Fix provisioning script 2019-09-20 22:06:21 +00:00
version_info.c version_info: make indentation more consistent. 2020-06-17 05:31:19 +00:00
version_info.h Move more version-info-related stuff to version_info.c. 2018-12-13 03:16:13 +00:00
wireshark-mime-package.xml
wireshark.appdata.xml Build: 3.3.0. 2020-09-15 13:56:25 -07:00
wireshark.desktop HTTPS In Even More Places, update some links. 2019-07-28 04:21:18 +00:00
wireshark.dox
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
ws_diag_control.h Revert "Make versions of DIAG_OFF() and DIAG_ON() for GCC 4.2 through 4.5." 2018-09-11 18:54:02 +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.

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