Customizing Wireshark
Introduction Wireshark's default behaviour will usually suit your needs pretty well. However, as you become more familiar with Wireshark, it can be customized in various ways to suit your needs even better. In this chapter we explore: How to start Wireshark with command line parameters How to colorize the packet list How to control protocol dissection How to use the various preference settings
Start Wireshark from the command line You can start Wireshark from the command line, but it can also be started from most Window managers as well. In this section we will look at starting it from the command line. Wireshark supports a large number of command line parameters. To see what they are, simply enter the command wireshark -h and the help information shown in (or something similar) should be printed. Help information available from Wireshark Version 0.99.0 Copyright 1998-2006 Gerald Combs <gerald@wireshark.org> and contributors. Compiled with GTK+ 2.6.9, with GLib 2.6.6, with WinPcap (version unknown), with libz 1.2.3, with libpcre 6.4, with Net-SNMP 5.2.2, with ADNS, with Lua 5.1. Running with WinPcap version 3.1 (packet.dll version 3, 1, 0, 27), based on libpcap version 0.9[.x] on Windows XP Service Pack 2, build 2600. wireshark [ -vh ] [ -DklLnpQS ] [ -a <capture autostop condition> ] ... [ -b <capture ring buffer option> ] ... [ -B <capture buffer size> ] [ -c <capture packet count> ] [ -f <capture filter> ] [ -g <packet number> ] [ -i <capture interface> ] [ -m <font> ] [ -N <name resolving flags> ] [ -o <preference/recent setting> ] ... [ -r <infile> ] [ -R <read (display) filter> ] [ -s <capture snaplen> ] [ -t <time stamp format> ] [ -w <savefile> ] [ -y <capture link type> ] [ -X <eXtension option> ] [ -z <statistics> ] [ <infile> ] We will examine each of the command line options in turn. The first thing to notice is that issuing the command wireshark by itself will bring up Wireshark. However, you can include as many of the command line parameters as you like. Their meanings are as follows ( in alphabetical order ): XXX - is the alphabetical order a good choice? Maybe better task based? -a <capture autostop condition> Specify a criterion that specifies when Wireshark is to stop writing to a capture file. The criterion is of the form test:value, where test is one of: duration:value Stop writing to a capture file after value of seconds have elapsed. filesize:value Stop writing to a capture file after it reaches a size of value kilobytes (where a kilobyte is 1000 bytes, not 1024 bytes). If this option is used together with the -b option, Wireshark will stop writing to the current capture file and switch to the next one if filesize is reached. files:value Stop writing to capture files after value number of files were written. -b <capture ring buffer option> If a maximum capture file size was specified, cause Wireshark to run in "ring buffer" mode, with the specified number of files. In "ring buffer" mode, Wireshark will write to several capture files. Their name is based on the number of the file and on the creation date and time. When the first capture file fills up, Wireshark will switch to writing to the next file, until it fills up the last file, at which point it'll discard the data in the first file (unless 0 is specified, in which case, the number of files is unlimited) and start writing to that file and so on. If the optional duration is specified, Wireshark will switch also to the next file when the specified number of seconds has elapsed even if the current file is not completely fills up. duration:value Switch to the next file after value seconds have elapsed, even if the current file is not completely filled up. filesize:value Switch to the next file after it reaches a size of value kilobytes (where a kilobyte is 1000 bytes, not 1024 bytes). files:value Begin again with the first file after value number of files were written (form a ring buffer). -B <capture buffer size (Win32 only)> Win32 only: set capture buffer size (in MB, default is 1MB). This is used by the the capture driver to buffer packet data until that data can be written to disk. If you encounter packet drops while capturing, try to increase this size. -c <capture packet count> This option specifies the maximum number of packets to capture when capturing live data. It would be used in conjunction with the -k option. -D Print a list of the interfaces on which Wireshark can capture, and exit. For each network interface, a number and an interface name, possibly followed by a text description of the interface, is printed. The interface name or the number can be supplied to the -i flag to specify an interface on which to capture. This can be useful on systems that don't have a command to list them (e.g., Windows systems, or UNIX systems lacking ifconfig -a); the number can be useful on Windows 2000 and later systems, where the interface name is a somewhat complex string. Note that "can capture" means that Wireshark was able to open that device to do a live capture; if, on your system, a program doing a network capture must be run from an account with special privileges (for example, as root), then, if Wireshark is run with the -D flag and is not run from such an account, it will not list any interfaces. -f <capture filter> This option sets the initial capture filter expression to be used when capturing packets. -g <packet number> After reading in a capture file using the -r flag, go to the given packet number. -h The -h option requests Wireshark to print its version and usage instructions (as shown above) and exit. -i <capture interface> Set the name of the network interface or pipe to use for live packet capture. Network interface names should match one of the names listed in wireshark -D (described above); a number, as reported by wireshark -D, can also be used. If you're using UNIX, netstat -i or ifconfig -a might also work to list interface names, although not all versions of UNIX support the -a flag to ifconfig. If no interface is specified, Wireshark searches the list of interfaces, choosing the first non-loopback interface if there are any non-loopback interfaces, and choosing the first loopback interface if there are no non-loopback interfaces; if there are no interfaces, Wireshark reports an error and doesn't start the capture. Pipe names should be either the name of a FIFO (named pipe) or ``-'' to read data from the standard input. Data read from pipes must be in standard libpcap format. -k The -k option specifies that Wireshark should start capturing packets immediately. This option requires the use of the -i parameter to specify the interface that packet capture will occur from. -l This option turns on automatic scrolling if the packet list pane is being updated automatically as packets arrive during a capture ( as specified by the -S flag). -L List the data link types supported by the interface and exit. -m <font> This option sets the name of the font used for most text displayed by Wireshark. XXX - add an example! -n Disable network object name resolution (such as hostname, TCP and UDP port names). -N <name resolving flags> Turns on name resolving for particular types of addresses and port numbers; the argument is a string that may contain the letters m to enable MAC address resolution, n to enable network address resolution, and t to enable transport-layer port number resolution. This overrides -n if both -N and -n are present. The letter C enables concurrent (asynchronous) DNS lookups. -o <preference/recent settings> Sets a preference or recent value, overriding the default value and any value read from a preference/recent file. The argument to the flag is a string of the form prefname:value, where prefname is the name of the preference (which is the same name that would appear in the preference/recent file), and value is the value to which it should be set. Multiple instances of -o <preference settings> can be given on a single command line. An example of setting a single preference would be: wireshark -o mgcp.display_dissect_tree:TRUE An example of setting multiple preferences would be: wireshark -o mgcp.display_dissect_tree:TRUE -o mgcp.udp.callagent_port:2627 Tip! You can get a list of all available preference strings from the preferences file, see . -p Don't put the interface into promiscuous mode. Note that the interface might be in promiscuous mode for some other reason; hence, -p cannot be used to ensure that the only traffic that is captured is traffic sent to or from the machine on which Wireshark is running, broadcast traffic, and multicast traffic to addresses received by that machine. -Q This option forces Wireshark to exit when capturing is complete. It can be used with the -c option. It must be used in conjunction with the -i and -w options. -r <infile> This option provides the name of a capture file for Wireshark to read and display. This capture file can be in one of the formats Wireshark understands. -R <read (display) filter> This option specifies a display filter to be applied when reading packets from a capture file. The syntax of this filter is that of the display filters discussed in . Packets not matching the filter are discarded. -s <capture snaplen> This option specifies the snapshot length to use when capturing packets. Wireshark will only capture <snaplen> bytes of data for each packet. -S This option specifies that Wireshark will display packets as it captures them. This is done by capturing in one process and displaying them in a separate process. This is the same as "Update list of packets in real time" in the Capture Options dialog box. -t <time stamp format> This option sets the format of packet timestamps that are displayed in the packet list window. The format can be one of: r relative, which specifies timestamps are displayed relative to the first packet captured. a absolute, which specifies that actual times be displayed for all packets. ad absolute with date, which specifies that actual dates and times be displayed for all packets. d delta, which specifies that timestamps are relative to the previous packet. -v The -v option requests Wireshark to print out its version information and exit. -w <savefile> This option sets the name of the savefile to be used when saving a capture file. -y <capture link type> If a capture is started from the command line with -k, set the data link type to use while capturing packets. The values reported by -L are the values that can be used. -X <eXtension option> Specify an option to be passed to a TShark module. The eXtension option is in the form extension_key:value, where extension_key can be: lua_script:lua_script_filename Tell Wireshark to load the given script in addition to the default Lua scripts. -z <statistics-string> Get Wireshark to collect various types of statistics and display the result in a window that updates in semi-real time. XXX - add more details here!
Packet colorization A very useful mechanism available in Wireshark is packet colorization. You can set-up Wireshark so that it will colorize packets according to a filter. This allows you to emphasize the packets you are usually interested in. Tip! You will find a lot of Coloring Rule examples at the Wireshark Wiki Coloring Rules page at &WiresharkWikiColoringRulesPage;. To colorize packets, select the Coloring Rules... menu item from the View menu, Wireshark will pop up the "Coloring Rules" dialog box as shown in .
The "Coloring Rules" dialog box
Once the Coloring Rules dialog box is up, there are a number of buttons you can use, depending on whether or not you have any color filters installed already. Note! You will need to carefully select the order the coloring rules are listed (and thus applied) as they are applied in order from top to bottom. So, more specific rules need to be listed before more general rules. For example, if you have a color rule for UDP before the one for DNS, the color rule for DNS will never be applied (as DNS uses UDP, so the UDP rule will be matching first). If this is the first time you have used Coloring Rules, click on the New button which will bring up the Edit color filter dialog box as shown in .
The "Edit Color Filter" dialog box
In the Edit Color dialog box, simply enter a name for the color filter, and enter a filter string in the Filter text field. shows the values arp and arp which means that the name of the color filter is arp and the filter will select protocols of type arp. Once you have entered these values, you can choose a foreground and background color for packets that match the filter expression. Click on Foreground color... or Background color... to achieve this and Wireshark will pop up the Choose foreground/background color for protocol dialog box as shown in .
The "Choose color" dialog box
Select the color you desire for the selected packets and click on OK. Note! You must select a color in the colorbar next to the colorwheel to load values into the RGB values. Alternatively, you can set the values to select the color you want. shows an example of several color filters being used in Wireshark. You may not like the color choices, however, feel free to choose your own. If you are uncertain which coloring rule actually took place for a specific packet, have a look at the [Coloring Rule Name: ...] and [Coloring Rule String: ...] fields.
Using color filters with Wireshark
Control Protocol dissection The user can control how protocols are dissected. Each protocol has its own dissector, so dissecting a complete packet will typically involve several dissectors. As Wireshark tries to find the right dissector for each packet (using static "routes" and heuristics "guessing"), it might choose the wrong dissector in your specific case. For example, Wireshark won't know if you use a common protocol on an uncommon TCP port, e.g. using HTTP on TCP port 800 instead of the standard port 80. There are two ways to control the relations between protocol dissectors: disable a protocol dissector completely or temporarily divert the way Wireshark calls the dissectors.
The "Enabled Protocols" dialog box The Enabled Protocols dialog box lets you enable or disable specific protocols, all protocols are enabled by default. When a protocol is disabled, Wireshark stops processing a packet whenever that protocol is encountered. Note! Disabling a protocol will prevent information about higher-layer protocols from being displayed. For example, suppose you disabled the IP protocol and selected a packet containing Ethernet, IP, TCP, and HTTP information. The Ethernet information would be displayed, but the IP, TCP and HTTP information would not - disabling IP would prevent it and the other protocols from being displayed.
The "Enabled Protocols" dialog box
To disable or enable a protocol, simply click on it using the mouse or press the space bar when the protocol is highlighted. Warning! You have to use the Save button to save your settings. The OK or Apply buttons will not save your changes permanently, so they will be lost when Wireshark is closed. You can choose from the following actions: Enable All Enable all protocols in the list. Disable All Disable all protocols in the list. Invert Toggle the state of all protocols in the list. OK Apply the changes and close the dialog box. Apply Apply the changes and keep the dialog box open. Save Save the settings to the disabled_protos, see for details. Cancel Cancel the changes and close the dialog box.
User Specified Decodes The "Decode As" functionality let you temporarily divert specific protocol dissections. This might be useful for example, if you do some uncommon experiments on your network.
The "Decode As" dialog box
The content of this dialog box depends on the selected packet when it was opened. Warning! The user specified decodes can not be saved. If you quit Wireshark, these settings will be lost. Decode Decode packets the selected way. Do not decode Do not decode packets the selected way. Link/Network/Transport Specify the network layer at which "Decode As" should take place. Which of these pages are available, depends on the content of the selected packet when this dialog box was opened. Show Current Open a dialog box showing the current list of user specified decodes. OK Apply the currently selected decode and close the dialog box. Apply Apply the currently selected decode and keep the dialog box open. Cancel Cancel the changes and close the dialog box.
Show User Specified Decodes This dialog box shows the currently active user specified decodes.
The "Decode As: Show" dialog box
OK Close this dialog box. Clear Removes all user specified decodes.
Preferences There are a number of preferences you can set. Simply select the Preferences... menu item from the Edit menu, and Wireshark will pop up the Preferences dialog box as shown in , with the "User Interface" page as default. On the left side is a tree where you can select the page to be shown. Note! Preference settings are added frequently. For a recent explanation of the preference pages and their settings have a look at the Wireshark Wiki Preferences page at &WiresharkWikiPreferencesPage;. Warning! The OK or Apply button will not save the preference settings, you'll have to save the settings by clicking the Save button. The OK button will apply the preferences settings and close the dialog. The Apply button will apply the preferences settings and keep the dialog open. The Save button will apply the preferences settings, save the settings on the hard disk and keep the dialog open. The Cancel button will restore all preferences settings to the last saved state.
The preferences dialog box