Wireshark User's Guide 31944 for Wireshark 1.2 Ulf Lamping, Richard Sharpe, NS Computer Software and Services P/L Ed Warnicke,Wireshark User's Guide: 31944 for Wireshark 1.2 by Ulf Lamping, Richard Sharpe, and Ed Warnicke ‘Copyright © 2004-2008 UIf Lamping Richard Sharpe Ed Wamicke ‘Permission is granted to copy, dtbute tor moi this document unde the terms ofthe GNU General Public License, Version 2or any late ‘venionpubised bythe Free Sofware Foundation All logos and wademats inthis document are propeny oftheir respective woes,Table of Contents 1. Foreword 2. Who should read this document? 3. Acknowledgements 4. About this document 5. Where to get the latest copy of this document? 6. Providing feedback about this document 1. Introduction 1.1, What is Wireshark? 1.1, Some intended purposes 1.2. Features 1.3, Live capture from many different network media La. Impor files from many other eapeare programs 1.5. Expor files for many other capture programs 16. Many protocol decoders 1.7. Open Source Software 1.8. What Wireshark is not stem Requirements 1.2.1. General Remarks 1.2.2. Microsoft Windows 1.2.3. Unix / Linux 1.3, Where to get Witeshark? 14. A brief history of Wireshark 1.5. Development and maintenance of Wireshark 1.6. Reporting problems and getting help 1.6.1. Website 1.6.2. Wiki 1.63. FAQ 1.64. Mailing Lists 1.6. Reporting Problems 1.6.6. Reporting Crashes on UNIX/Linux platforms 1.6.7. Reporting Crashes on Windows platforms 1 1 1 1 1 1 1 1 2. Building and Installing Wireshark 2.1, Introduction 2.2. Obtaining the source and binary distributions Before you build Wireshark under UNIX Building Wireshark from source under UNIX Installing the binaries under UNIX 2.5.1. Installing from spm’s under Red Hat and alike 25.2. Installing from deb's under Debian 2.5.3, Installing from portage under Gentoo Linux 2.54. Installing from packages under FreeBSD 2.6, Troubleshooting during the install on Unix 2.7. Building from source under Windows 2.8. Installing Wireshark under Windows 2.8.1. Install Wireshark 2.8.2. Manual WinPeap Installation 28.3. Update Wireshark 284. Update WinPeap 285. Uninstall Wireshark 2.86. Uninstall WinPeapWireshark User's Guide 3. User Interface 3.1 Ingoduetion 2, Start Wireshark 3.3, The Main window sa... . 3.3.1, Main Window Novguon 3.4, The Menu ... ssnuennen "Telephony" menu... "Tools" menu Packet List” pane ... "Packet Details” pane 3.19. The "Packet Bytes” pane 20. The Statusbar 4, Capturing Live Network Data . 4.1, Introduction... 2, Prerequisites 43, Start Capturing ssessenee 44, The "Capture Interfaces” dialog box 48. The "Capture Options” dialog box 4.5.1. Capture frame . 4.5.2. Capture File(s) frame 45.3. Stop Capture... frame 4.5.4, Display Options frame . 4.5.8. Name Resolution frame 4.56. Buttons 4.6, The "Remote Capture Interfaces” dislog box . 4.6.1. Remote Capture Interfaces 4.6.2. Remote Capture . 4.633, Remote Capture Seutings . 4.7, The “Interface Details” dialog box 4.8, Capture files and file modes 4.9, Link-layer header type 4.10. Filtering while capturing 4.10.1. Automatic Remote Traffic Filtering 4.11, While « Cepture is running 2... . . : : 4.11.1. Stop the running capture 61 4.11.2. Restart a running capture. . . . co OL 5. File Input / Output and Printing .....c.estnnnennenennensnnnnaiennanennnnaenes 62 Sul Introduction... . . . . . -. 62 5.2. Open capture files 2 5.2.1. The "Open Capture File” dialog BOX .....cstcnnereinenseneinainnneiennens 62 5.2.2. Input File Formats 65 5.3, Saving captured packets 66 5.3.1. The "Save Capture File As" dialog box 66 5.3.2. Output File Formats 68Wireshark User's Guide Sa, 35: 36. Merging capture files 5.4.1, The “Merge wit Capture Fle" dialog box. File Sets ssnnsne 55.1. The "List Fi Exporting data 5.6.1. The "Export as Plain Text File” dialog box... 5.6.2. The "Export as PostScript File” dialog box dialog box. dialog box. B 5.6.3. The "Export es CSV (Comma Separated Values) Fi 5.6.6. The "Expor as C Arrays (packet bytes) file” dialog box B 5.65. The "Export as PSML File" dialog box B 5.66. The "Export as PDML File" dialog box "4 5.6.7. The "Export selected packet bytes" dialog box 8 5.6.8. The "Export Objects" dialog BOK... . . nnenene TS 5.7, Printing packets 2... sontnnnntinnnnsnnnnininnnnnnnnsnannnnnsn TT 5.7.1. The "Print dialog box sossssnnnsonnsnnnninsnnnnnvnsnnnn TT 5.8, The Packet Range frame ...crntnanennennnnnnnnnnanennenenennaienens TS 5.9. The Packet Format frame 78 6. Working with captured packets costunninnnnnnnenenennnenennnnenenses 80 6.1, Viewing packets you have captured 80 6.2, Pop-up menus... csstnnnanennninenenennnenenneenense BL 62.1. Pop-up mens of the "Packet List” pane 81 6.2.2. Pop-up menu of the "Packet Details” pane 83 6.3, Filtering packets while Viewing ......:0.:eunsetnnnneanennennnnnnnneneneses 85 64, Building display filter expressions . . . . co 86 64.1. Display filter elds .....cnneetennennnntnnnninenenennnnnnensse 86 6.4.2, Comparing valves 86 64.3. Combining expressions 88 64.6. A common mistake ....r.esnnnnnsnnnnnninnnnninninnnnnninnnnnssn 9D 6.5. The "Filter Expression” ditlog BOK .....snsesnnnsennnitnnniennnnneeneneses 90 6.6, Defining and saving filters . 91 67, Defining and saving filter macros . 1 93 68, Finding packets . : : : . os) 6.81. The "Find Packet" dislog B08 suons.snnnsmnnnnnnnnnnnnennnnns 9 6.8.2. The "Find Next” command 4 6.8.3. The "Find Previous” command. a) 6.9. Go to a specific packet... 2 94 69.1. The "Go Back” command 9M 94 6.9.3. The "Go to Packet” dialog box 4 69.4. The "Go to Corresponding Packe'" consmind 95 69.5. The "Go to First Packet” command... 95 6.9.6. The "Go to Last Packet” command 95 6.10. Marking packets 95 6.11. Ignoring packets 9s 6.12. Time display formats and time references Sonninnninninnnennnnnsnsn 96 6.12.1, Packet time referencing 97 7. Advanced Topics TA. Introduction... 7.2, Following TCP streams . . . . 7.21. The "Follow TCP Stream" dialog DO sss 98 7.3, Expert Infos . : 7331. Exper Info Entries. . . . 73.2. "Expert Info Composite” dilog ....0snssnssnvonsnnnnvonnssnnne 102 7.3.3. "Colorized” Protocol Details Tree jrj.ssnnssnsnnnninnnnnsnnnnnnnnnnenenss 102Wireshark User's Guide 7.3.4. "Expert" Packet List Column (optional) 103 74, Time Stamps 103 74.1, Wireshark intemals ....ss.ncnnusininninninnnnnnnnnnnnninsnnnnsne 103 7.4.2. Capture file formats 104 74,3. Accuracy esse 104 75, Time Zones 104 7551. Set your compute’ time correctly! . . ones 105 7.5.2. Wireshark and Time Zones 106 7.6, Packet Reassembling 107 7.6.1, What is 8? soso Sonuinnnnininnnnnnnnannnnnnnennnnnanns 107 7.6.2. How Wireshark handles i¢....0010sssssssssnsnsnennsssssee 107 7.1, Name Resolution... 7.1.1. Name Resolution drawbacks 7.7.2. Ethernet name resolution (MAC layer) 109 7.7.3. IP name resolution (nctwork layer) . . 7.7.4, IPX name resolution (network layer) 109 7.7.5. TCPIUDP port name resolution (transport layer)... : soe 110 78, Checksums 110 7.8.1, Wireshark checksum validation ..... . . coenes HO 7.8.2. Checksum offloading iL 8. Statistics 12 81 Ingoduetion 2 2. The “Summary” window 12 ‘The "Protocol Hierarchy” window 1B Conversations sss continaninnnninannnninnnnnannnnnaes AS 8.4.1. What is « Conversttion? 1s 84.2. The "Conversations" window ... seve LS 84.3. The protocol specific "Conversation List” windows 116 8.5, Endpoints «0... coneinnneinnennenennennnennnnnanennnees 6 85.1. What is an Endpoin? ...s0cssnnnnnnnnnnnninnnnennnnnnnes U6 85.2. The "Endpoints" window ..... ontnnnninninnnnnnnneenne AT 85.3. The protocol specific "Endpoint List” windows 18 8.6. The "IO Graphs” window cc: sncnnentanensnnnnanennenneneninaennees HB 8.7. Service Response Time .. . . 119 8.7.1, The "Service Response Time DCE-RPC" window 120 8.8, WLAN Traffic Statistics 120 8.9. The protocol specific statistics windows 121 9. Telephony 122 9.1, Introduction... . 122 2, RTP Analysis oo. . 122 9.3, VoIP Calls oo. ontuninninninnanninennntnnisnnsnnnes 122 9.4, LTE MAC Traffic Statisties ones 123 9.5, LTE RLC Traffic Statisties 123 9.6. The protocol specific statistics windows 1m 10. Customizing Wireshark . . fone 125 10.1. Introduction ss... sonninnnninninnannnnnnnnnnninnanen LS 10.2. Stat Wiresbark from the command line. 125 10.3, Packet colorization BL 10.4. Control Protocol dissection 10.4.1. The "Enabled Protocols" dialog box . 1M 10.4.2. User Specified Decodes 1... . . . 135 10.4.3. Show User Specified Decodes 136 10.5. Preferences 137 10.5.1. Interface Options 138 134Wireshark User's Guide 10.6. Configuration Profiles ....:1..:cunoiennensenennnnnnenieinenenenennesens 139 10.7. User Table . 108. Display Filter Macros ML 10.9. GeolP Database Paths 10.10. Tektronix K12xw/15 RFS protocols Table .... . . . 10.11. PRES Users Comtext List ....onornnnnnsnnninninnnannnnnnnninsnnnannnn M2 10.12. SCCP users Table . 10.13. SMI (MIB and PIB) Modules . . 10.14. SMI (MIB and PIB) Paths 2 ML ML 142 2 142 10.15. SNMP Enterprise Specific Trap Types . . . on HB 10.16. SNMP users Table 1B 10.17. User DLTs protocol table... . . . ones MB 10.18. IKEv2 decryption table 144 11, Lue Support in Wireshark 145 LA. Introduction «sc. Sonnininnnininninninnennnninnnnnen MS 11.2. Example of Dissector writen in LU ...cssnsmsnnnnnnnnsnnnnnnnnsns M48 11.3. Example of Listener written in Lua 146 11.4, Wireshark’s Lua API Reference Manual M7 11.4.1. Saving capture files .....cstcnnenennenennniennenenennenenes 147 11.4.2. Obtaining dissection data 149 11.43. GUI support... . . . con ISL 11.44, Postisseetion packet analysis. sssscrnnenvnnncnnnensncenn 156 11.45, Obtaining packet information .......eueseennneneninnnenenenneeies 1ST 11.466, Functions for writing dissectors 161 11.4.7 Adding information to the dissection tree .. . . 172 11.4.8, Functions for handling packet data .....soncsnessnnnnnnennenennensnses TT 11.4.9. Utility Functions ..c..cnsuncnneneanenennnanennenenenenenees 180 A. Files and Folders 184 AdL Capture Files... . . . . 186 ‘ALLL, Libpeap File Contents ....ssnvnnnnisnnnnnnnnnsnnnnnnnnnne 184 A.L.2, Not Saved in the Capture File 134 A2. Configuration Files and Folders .......cnsicnnenenneninnnaiennenenenenes 185 AB, Windows f0ldetS ...rcnsusnannnninnnnninninnannnninninninnsnnnnnsnnss 190 A3.L, Windows profiles 190 43.2, Windows Vista/XP/2000/NT roaming profiles 191 43.3, Windows temporary folder 191 B, Protocols and Protocol Fields ...s.nussssninsinnnstinnnnsnnnninnnnsnninnennnss IZ C. Wireshark Messages 193 iL, Packet List Messages scion . . . . 193 CLA. [Malformed Packet) «sso. ssneinninnnnnnnaiennensenssseee 193 C12. [Packet size Limited during eaplute) on .ncnsnnnnnsnnnnnnnnns 193 C.2, Packet Details Messages . . . . 193 C21, [Response in frame: 123] 193 [Request in frame: 123) 193 [Time from request: 0.123 seconds} 194 [Stream setup by PROTOCOL (frame 123)] 194 D. Related command line tools... 195 Dil, Introduction 195 D2. tshark: Terminal-based Wireshark 195 D3. tepdump: Capturing with tcpdump for viewing with Wireshark 195 D4, dumpeap: Capturing with dumpeap for viewing with Wireshark 195 1D.S. capinfos: Print information about capture fe a... nsesnnnsinnnaiennenseneises 196 D6. editeap: Edit cepture files... fntinnnnnnnnsnannnnensnees I9T D7. mergecap: Merging multiple capture files imo one «...sssennnsnnnnnnesnss 201Wireshark User's Guide D8. text2peap: Converting ASCII bexdumps to network captures 202 D9. idi2wrs: Creating dissectors from CORBA IDL files D.9.L. What i8 i? oso . D.9.2. Why do this? D.9.3, How to use idl2wrs .... D94, TODO ... D9S. Limitations D.96. Notes : E, This Document’s License (GPL) .Preface 1. Foreword Wireshark is one of those programs that many network managers would love to be able to use, but they are ‘often prevented from getting what they would like from Wireshark because of the lack of documentation, ‘This document is part of an effort by the Wireshark team to improve the usability of Wireshark, ‘We hope that you find it useful, and look forward to your comments 2. Who should read this document? ‘The intended audience of this book is anyone using Wireshark. ‘This book will explain all the basies and also some of the advanced features that Wireshark provides. AS ‘Wireshark has become a very complex program since the early days, not every feature of Wireshark may be explained in this book ‘This book is not intended to explain network sniffing in general and it will not provide details about specific network protocols. A lot of useful information regarding these topics can be found at the Wireshark Wiki at htp:/wiki.wireshark org By reading this book, you will learn how to instal Wireshark, how to use the basic elements of the graphical user interface (such as the menu) and what's behind some of the advanced features that are not always ‘obvious at first sight. It will hopefully guide you around some common problems that frequently appear for new (and sometimes even advanced) users of Wireshark. 3. Acknowledgements ‘The authors would like to thank the whole Wireshark team for their assistance. In particular, the authors ‘would like to thank: + Gerald Combs, for initiating the Wireshark project and fonding to do this documentation * Guy Haris, for many helpful hints and a great deal of patience in reviewing ths document. + Gilbort Ramirez for general encouragement and helpful hin slong the way ‘The authors would also like to thank the following people for ther helpful feedback on this docament + Pat Byler, forhis suggestions on improving the example on generating a backtrace + Martin Regner, for his various suggestions and corrections. + Graeme Hewson, fora lot of grammatical corrections ‘The authors would like to acknowledge those man page and README authors for the Wireshark project from who sections of this document borrow heavily: + Scott Renfro from whose mergecap man page Section D.7, “mergecap: Merging multiple capture files into one” is derivedPreface + Ashok Narayanan from whose textpcap man page Section D.8, “text2pcap: Converting ASCII hhexdumps to network captures ” is derived. ection D.9, “idl2wrs: Creating dissectors from Frank Singleton from whose Fé CORBA IDL files "is derived. 4. About this document This book was originally developed by Richard Sharpe with funds provided from the Wireshark Fund. It ‘was updated by Ed Warnicke and more recently redesigned and updated by Ulf Lamping. tis written in DocBook/KML, You will find some specially marked parts in this book: This is a warning! A ‘You should pay attention to a warning, as otherwise date loss might occur. | A This is a note! -Amot will point you common mistakes and things that might nt be obvious. This is a tip! y Tips will be helpful for your everyday work using Wireshark. 5. Where to get the latest copy of this document? ‘The latest copy of this documentation ean always be found at: http://www witeshark.org/doesl 6. Providing feedback about this document Should you b feedback about this document, please send it to the authors through wire dev AT] witChapter 1. Introduction 1.1. What is Wireshark? 1.1.1. 1.1.2. Wireshark is a network packet analyzer. A network packet analyzer will uy to capture network packets and tries to display that packet data as detailed as possible. ‘You could think of a network packet analyzer as a measuring device used to examine what's going on ork cable, just ike a voltmeter is used by an electrician to examine whats going on inside inside a an electric cable (hut at higher level, of course) In the past, such tools were either very expensive, proprietary, or both. However, with the advent of Wireshark, all that has changed. ‘Wireshark is perhaps one of the best open source packet analyzers available today. Some intended purposes Here are some examples people use Wireshark for: + network administrators use itto troubleshoot network problems + neswork security engineers us to examine security problems + developers use itto debug protocol implementations + people use it to learn network protocol intemals Beside these examples, Wireshark can be helpful in many other situations too. Features ‘The following are som ofthe many features Wireshark provides + Available for UNIX and Windows, + Capture live packet date from » newwork inerce, + Displey packets with very detailed protocol information + Open and Save packet data captured, + Import and Export packet data from and to a lt of other capture programs + Fitter packets on many criteria + Search for packets on many enitria + Colorize packet display based on filters + Create various statistics, + and alot more!Introduction However, to really appreciate its power, you have to start using it Figure 1.1, “ Wireshark captures packets and allows you to examine their content.” shows Wireshark having captured some packets and waiting for you to examine them. Figure 1.1. Wireshark captures packets and allows you to examine their content, Er Se Cote the am Beeew oax*s.s @eeeF2 BS aa a RE 1.1.3. Live capture from many different network media Wireshark can capture traffic from many different network media types - and despite its name - including wicless LAN as well. Which media types are sepportd, depends on many things like the operating system you are using. An overview of the supported media types can be found at hip wiki wireshers or CapuureSeup/NowiorkMedia, 1.1.4. Import files from many other capture programs ‘Wireshark can open packets captured from a large number of other capture programs. For a list of input formats see Section 5.2.2, “Input File Formats". 1.1.5. Export files for many other capture programs Wireshark can save packets captured in a large numer of formats of other capture programs. Fora list of ‘output formats see Section 5.3.2, “Output File Formats", 1.1.6. Many protocol decoders ‘There are protocol decoders (or dissectors, as they are known in Wireshark) for @ great many protocols: see Appendix B, Protocols and Protocol Fields,Introduction 1.1.7. Open Source Software Wireshark is an open source software project, and is released under the GNU General Public License (GPL). Youcan freely use Wireshark on any number of computers you like, without worrying about license kkeys or fees or such. In addition, all source code is freely available under the GPL. Because of that, itis ‘very easy for people to add new protacols to Wireshark, either as plugins, or built into the source, and they often do! 1.1.8. What Wireshark is not Here are some things Wireshark does not provide: + Wireshark isn't an intrusion detection system. It will not warn you when someone does strange things ‘on your network that he/she isn't allowed to do. However, if strange things happen, Wireshark might help you figure out what is really going on, + Wireshark will not manipulate things on the network, it will only “measure” things from it, Wireshark doesnt send packets on the network or do other active things (except for name resolutions, but even that can be disabled), 1.2. System Requirements What you'll need to get Wireshark up and running 1.2.1. General Remarks + The values below are the minimum requirements and only “rules of thumb” for use on a moderately. used network + Working with « busy network can easily produce huge memory and disk space usage! For example: Capturing on a fully saturated 1OOMBit/s Ethernet will produce ~ 750MBytes/min! Having a fast processor, ots of memory and disk space is a good ides in that case, + If Wireshark is running out of memory it crashes, sce: hitp:/wiki.wireshark.org/KnownBugs! (OutOiMemory for details and workarounds + Wireshark won't filtering packets are single thread real time” capture, capturing traffic runs in one process and dissecting and displaying packets runs in another process - which should benefit from two processors, 1.2.2. Microsoft Windows + Windows XP Home, XP Pro, XP Tablet PC, XP Media Center, much from Multiprocessor/Hyperthread systems as time consuming tasks like No nile is without exception: during an "Update list of packets in ler 2003, Vista, 2008, 7, 18 R2 + Any modern 32-bit x86 or 64-bit AMD64/x86-64 processor. + 128MB available RAM. Larger capture files require more RAM. + TSMB available disk space. Capture files require additional disk space. * 800600 (1280*1024 or higher recommended) resolution with at least 65536 (6bit) colors (256 colors should work if Wireshark is installed withthe "legacy GTKL” selection of the Wireshark 1.0.xreleases)Introduction 1.2.3. + A supported network card for capturing: + Ethernet: Any card supported by Windows should work. See the wiki pages on Ethernet capuure and offloading for issues that may affect your environment. + 802.11: See the Wireshark wiki page. Capturing raw 802.11 information may be difficult without special equipment, * Other media: See htp://wiki,wireshark. org/CaprureSetup/NetworkMedis Remarks: + Many older Windows versions are no longer supported for three reasons: None of the developers use those systems which makes suppor difficult. The libraries Wireshark depends on (GTK, WinPeap, ...) have dropped suppor for older releases. Microsoft has also dropped support for these systems, + Windows 95, 98 and ME are no longer supported. The "old technology" releases of Windows lack ‘memory protection (specifically VirutalProtect) which we use to improve program safety and security ‘The last known version to work was Ethereal 0.99.0 (which includes WinPcep 3.1). You can get it from hitp//ethereal.com/download.html. According to this bug report, you may need to install Ethereal 0.10.0 on some systems. Microsoft retired support for Windows 98 and ME in 2006, + Windows NT 4.0 no longer works with Wireshark. The last known version to work was Wireshark 0.99.4 (which includes WinPeap 3.1), You si ‘can get it from hitp:/ www. wireshark,org/download win32/all-versions/wireshark-setup-0.99.4.exe, Microsoft retired support for Windows NT 4.0 in 2005, + Windows CE and the embedded versions of Windows are not currently supported. + Multiple mor Unix / Linux 3 setups are supported but may behave a bit strangely Wireshark currently runs on most UNIX platforms. The system requirements should be comparable to the Windows values listed above, Binary packages are available for at least the following platforms + Apple Mac OS X + Debian GNUMLinax + FreeBsb + Gentoo Linux + HP-UX + Mandriva Linux + News + OpenPKG + Rod Hat Fedora/Enterprise Linux + Path Linux + Sun Solarisi386Introduction + Sun SolarisSpare + Canonical Ubuntu Ifa binary package is not available for your platform, you should download the source and try to build it, Please report your experiences to wireshark-Jev|AT|wireshark.orz 1.3. Where to get Wireshark? You can get the latest copy of the program from the Wireshark website: http://www wireshark. ory download html, The Website allows you to choose from among several mirrors for downloading, A new Wireshark version will typically become available every 4-8 months If you want to be notified about new Wireshark releases, you should subscribe to the wireshark-announce railing list. You will find more details in Section 1.6.4, “Mailing Lists 1.4. A brief history of Wireshark 1.5. In late 1997, Gerald Combs needed a tool for tracking down networking prolems and wanted to learn more about networking, so he started writing Ethereal (the former name of the Wireshark project) as a ‘way to solve both problems, Ethereal was initially released, after several pauses in development, in July 1998 as version 0.2.0. Within days, patches, bug reports, and words of encouragement started arriving, so Ethereal was on its way to ‘Not long after that, Gilbert Ramirez, saw its potential and contributed a low-level dissector to it. In October, 1998, Guy Harris of Network Appliance was looking for something better than tepview, so he started applying patches and contributing dissectors to Ethereal. In ate 1998, Richard Sharpe, who was giving TCP/IP courses, saw its potential on such courses, and started looking at it to see if it supported the protocols he needed. While it didnt at that point, new protocols could be easily added. So he started contributing dissectors and contributing patches. ‘The list of people who have contributed to the project has become very long since then, and almost all of them started with a protocol that they needed that Wireshark or Ethereal did not already handle. So they copied an existing dissector and contributed the code back to the team. {In 2006 the project moved house and re-emerged under a new name: Wireshark, Development and maintenance of Wireshark ‘Wireshark was initially developed by Gerald Combs. Ongoing development and maintenance of Wireshark is handled by the Wireshark team, a loose group of individuals who fix bugs and provide new functionality ‘There have also been a large number of people who have contributed protocol dissectors to Witeshark, and it is expected that this will continue, You can find a list of the people who have contributed code t0 Wireshark by checking the about dialog box of Wireshark, or at the authors page on the Wireshark web site Wireshark is an open source software project, and is released under the GNU General Public License (GPL). All source code is freely available under the GPL. You are welcome to modify Wireshark to suitIntroduction ‘your own needs, and it would be appreciated if you contribute your improvements back to the Wireshark icam. ‘You gain three benefits by contributing your improvements back to the community + Other people who find your contributions useful will appreciate them, and you will know that you have helped people in the same way that the developers of Wireshark have helped people. + The developers of Wireshark might improve your changes even more, as there's always room for improvement. Or they may implement some advanced things on top of your code, which can be useful for yourself too, + The maintainers and developers of Wireshark will maintain your code as well, fixing it when API changes or other changes are made, and generally keeping it in tune with what is happening with Wireshark. So if Wireshark is updated (which is done often), you can get a new Wireshark version from the website and your cha included without any effort for you "The Wireshark source code and binary kits for some platforms are all available on the download page of the Wireshark website: htp:/vww.wireshark org/download hn 1.6. Reporting problems and getting help If you have problems, or need help with Wireshark, there are several places that may be of interest fo you (well, besides this guide of course). 1.6.1. Website ‘You will find lots of useful information on the Wireshark homepage at http://www wireshark. org 1.6.2. Wiki ‘The Wireshark Wiki at htp://wiki.wireshark.ong provides a wide range of information related to Wireshark and packet capturing in general. You wil finda lot of information not part of this users guide. For example, there is an explanation how to capture on a switched network, an ongoing effort to build a protocol reference and a lot more. ‘And best of all, if you would like to contribute your knowledge on a specific topic (maybe a network protocol you know well), you can edit the wiki pages by simply using your web browser. 1.6.3. FAQ ‘The "Frequently Asked Questions” will list often asked questions and the corresponding answers. A Read the FAQ! Before sending any mail tothe mailing lists below, be sure to read the FAQ, as it will often answer the question(s) you might have. This will save yourself and others alot of time (keep in mind tha a lot of people are subscribed tothe mailinglist) ‘You will find the FAQ inside Wireshark by clicking the menu item Help/Contents and selecting the FAQ page in the dialog shown, ‘An online version is available at che Wireshark website: hp:/iwww wireshark.orp/fag.html, You might prefer this online version, as it's typically more up to date and the HTML format is easier to use.Introduction 1.6.4. Mailing Lists ‘There are several mailing lists of specific Wireshark wireshark-announce This mailing list will inform you about new program releases, which usually appear about every 4-8 weeks, wireshark-users This lst is for users of Wireshark. People post questions about building and using Witeshark, others (hopefully) provide answers. wireshark-dev ‘This list is for Wireshark developers. If you want to start developing a protocol dissector, join this list. You can subscribe to each of these lists from the Wireshark web site: huip:/Wwww.wireshark org. Simply ing lists link on the left hand side of the site, The e Wireshark web sis are archived att select the ms site as well ip! a ‘You can scarch in the list archives to see if someone asked the same question some time before and maybe already got an answer. That way you don't have to wait until someone answers your question, 1.6.5. Reporting Problems | F Note! Before reporting any problems, please make sure you have installed the latest version of Wireshark, When reporting problems with Wireshark, i is helpful if you supply the following information 1. The version number of Wireshark and the dependent libraries linked with it, e.g. GTK+, ete. You can ‘obtain this with the command wireshark -¥ 2. Information about the platform you run Wireshark on, 3. A detailed description of your problem. 4. If you get an error/warning message, copy the text of that message (and also a few lines before and after it, if there are some), $0 others may find the place where things go wrong, Please don't give something like; "I get a weming while doing x" as this won't give a good idea where to look at A Don't send large files! Do not send large files (100KB) to the mailing lists, just place @ note that further data is available on request. Large files will only annoy a lot of people on the list who are not interested in your specific problem. If required, you will be asked for further data by the persons who really can help you. A Don't send confidential information! If you send captured data to the mailing lists, be sure they don't contain any sensitive or confidential information like passwords or such.Introduction 1.6.6. Reporting Crashes on UNIX/Linux platforms When reporting crashes with Wireshark, itis helpful if you supply the traceback information (besides the information mentioned in "Reporting Problems") ‘You can obtain this traceback information with the following commands: | F Note ‘Type the characters in the first Hine verbatim! Those are back-ties there! | A Note backtrace is a gdb command. You should enter it verbatim after the first line shown above, but it will not be echoed. The 3D (ControL-D, that is, press the Control key and the D key {ogether) will cause gab to exit. This will leave you with a file calle directory. Include the file with your bug report. xt im the current | a Note If you do not have gdb available, you will have to check out your operating system's debugger, ‘You should mail the traceback tothe witeshark-devl Al wireshark org mailing lst. 1.6.7. Reporting Crashes on Windows platforms ‘The Windows distributions don't contain the symbol files (.pdb), because they are very large. For this reason it’s not possible to create a meaningful backtrace file from it. You should report your crash just like ‘ther problems, using the mechanism described above.Chapter 2. Building and Installing Wireshark 2.1. Introduction ‘As with all things, there mast be a beginning, and so itis with Wireshark. To use Wireshask, you must: Obtain a binary package for your operating system, oF (Obtain the source and build Wireshark for your operating system. Currently, several Linux distributions ship Wireshark, but they are commonly shipping an out-of-date version. No other versions of UNIX ship Wireshark so far, and Microsoft does not ship it with any version ‘of Windows. For that reason, you will need to know where to get the latest version of Wireshark and how to install it ‘This chapter shows you how to obtain source and binary packages, and how to build Wireshark from source, should you choose to do so. ‘The following are the general steps you would use 1 Download the relevant package for your needs, e.g. source or binary distribution. 2. Build the source into a binary, if you have downloaded the source ‘This may involve building and/or installing other necessary packages. 3. Install the binaries ino their final destinations, 2.2. Obtaining the source and binary distributions You can obtain both source and binary distributions from the Wireshark web site: hep:/ .wwnw.wwineshark.org. Simply select the download link, and then sclect either the source package or binary package of your choice from the mirror site closest to you. [Fy Download all required files! In general, unless you have already downloaded Wireshark before, you will most likely need to download several source packages if you are building Wireshark from source. This is covered in more detail below. Once you have downloaded the relevant files, you can go on to the next step. [Fr Note! While you will find a number of binary packages available on the Wireshark web site, you ‘might not find one for your platform, and they often tend to be several versions behind the current released version, as they are contributed by people who have the platforms they are built for.Building and Installing Wireshark For this reason, you might want to pull down the source distribution and build it, as the process is relatively simple. 2.3. Before you build Wireshark under UNIX Before you build Wireshark from sources, or install a binary package, you must ensure following other packages installed: that you have the + GTK+, The GIMP Tool Kit. ‘You will also need Glib. Both can be obtained from www. gtk org + libpeap, the packet capture software that Wireshark uses. ‘You can obtain libpeap from www sepdump org Depending on your system, you may be able to install these from binaries, eg. RPMS, or you may need ‘to obtain them in source code form and build them. If you have downloaded the source for GTK:, the instructions shown in Example 2.1, “Building GTK+ from source” may provide some help in building it: Example 2.1. Building GTK+ from source | A Note! =} Youmay need to change the version numberof gtk+ in Example 2.1, “Building GTK+ from (o match the version of GTK+ you have downloaded. The directory you change to will change if the version of GTK+ changes, and in all cases, tar xvf - will show you the name of the directory you should change to | F Note! If you use Linux, or have GNU tar installed, you can use tar 2xvf gtk+-1.2.10.tar.gz. It is also possible to use gunzip -c or gzeat rather than gzip -de on many UNIX systems. | A Note! If you downloaded gtk+ or any other tar file using Windows, you may find your file called gtct-1_2.8 targz, You should consult the GTK+ web site if any errors occur in carrying out the instructions in Example 2.1 uilding GTK+ from sour 10Building and Installing Wireshark If you have downloaded the source to libpeap, the general instructions shown in Example 2.2, “Building and installing libpcap” will assist in building it, Also, if your operating system does not support tepdump, ‘you might also want to download it from: the tcpdump web site and install i, Example 2.2. Building and installing libpcap A Note! The directory you should change to will depend on the version of libpeap you have downloaded. In all cases, tar xvf - will show you the name of the directory that has been unpacked, Under Red Hat 6.x and beyond (and distributions based on it, like Mandrake) you can simply install each of the packages you need from RPMs, Most Linux systems will install GTK+ and GLib in any case, however ‘you will probably nced to install the devel versions of each of these packages. The commands shown in Example 2.3, “Installing required RPMs under Red Hat Linux 6.2 and beyond” will instal all the needed RPMs if they are not already installed. Example 2.3. Installing required RPMs under Red Hat Linux 6.2 and beyond Note If you are using a version of Red Hat later than 6.2, the required RPMs have most likely changed. Simply use the correct RPMs from your distribution. Under Debian you can install Wireshark using aptitude. aptitude will handle any dependency issues for you. Example 2.4, “Installing debs under Debian” shows how to do this. Example 2.4. Installing debs under Debian 2.4. Building Wireshark from source under UNIX Use the following general steps if you are building Wireshark from source under a UNIX operating system: iBuilding and Installing Wireshark 1. Unpack the source from its gzip'd tar file. Ifyou are using Linux, or your version of UNIX uses GNU tar, you can use the following command: For other versions of UNIX, you will want to use the following commands: 12 12 | A Note! The pipeline gzip -de wireshark-1.2-tar.gz | tar xvf - will work here as well | F Note! If you have downloaded the Wireshark tarball under Windows, you may find thet your browser has created a file with underscores rather than periods init file name. 2. Change directory to the Wireshark source directory, 3. Configure your source so it will build correctly for your version of UNIX. You can do this with the following command: If this step fails, you will have to rectify the problems and rerun configure. Troubleshooting hints are provided in Section 2.6, “Troubleshooting during the install on Unix’ 4, Build the sources into a binary, with the make command, For example: ‘5. Install the software inits final destination, using the command: ‘Once you have installed Wireshark with make install above, you should be able to run it by entering wireshark, 2.5. Installing the binaries under UNIX In genera, installing he binary under your version of UNIX will be specifi othe installation methods used with your version of UNIX. For example, under AIX, you would use sm to install the Wireshark binary package, while under Tru64 UNIX (formerly Digital UNIX) you would use setld. 2.5.1. Installing from rpm's under Red Hat and alike I the Wireshark RPM that you have downloaded from the Wireshark Use the following command toi web site:Building and Installing Wireshark If the above step fails because of missing dependencies, install the dependencies first, and then retry the step above, See Example 2.3, “ Installing required RPMs under Red Hat Linux 6.2 and beyond ” for information on what RPMs you will need to have installed 2.5.2. Installing from deb's under Debian If you can just install from the repository then use: aptitude should take care of all of the dependency issues for you. ‘Use the following command to install downloaded Wireshark deb's under Debian: apky “1 wiroshark-common_1.2.0-1_1386.dob Wireshark 1.2.0-1_1386.deb dpkg doesn take care of all dependencies, but reports what's missing, 2.5.3. Installing from portage under Gentoo Linux ‘Use the following commend to install Wireshark under Gentoo Linux with all ofthe extra features: 2.5.4. Installing from packages under FreeBSD Use the following command to install Wireshark under FreeBSD: pkg_add should take care of al of the dependency issues for you. 2.6. Troubleshooting during the install on Unix _Annumber of crrors can occur during the installation process. Some hints on solving these are provided here. If the configure stage fails, you will need to find out why. You can check the file cong. 209 in the source directory to find out what failed. The last few lines of this file should help in determining the problem, ‘The standard problems are that you do not have GTK+ on your system, or you do not have a recent enough version of GTK+. The configure will also fail if you do not have libpcap (at least the required include files) on your system. Another common problem is forthe final compile and link stage to terminate with 2 complaint of: Output {oo long. This i likely to be caused by an antiquated sed (such as the one shipped with Solaris). Since sed BBuilding and Installing Wireshark is used by the libtool script to construct the final Link command, this leads to mysterious problems. This can be resolved by downloading a recent version of sed from hlip:/directory.fsf ore/project/seu Ifyou cannot determine what the problems are, send an email to the wireshark-dev mailing list ‘your problem, and including the output from con® ig.1og and anything el a trace of the make stage. 2.7. Building from source under Windows Itis recommended to use Findows platform. plaining ou think is relevant, ike 1¢ binary installer for Windows, until you want to start developing Wireshark For further information how to build Wireshark for Windows from the sources, have a Took at the Developer's Guide o scumentation Page, ‘You may also want to have a look at the Development Wiki: hitp://wikiwireshark.org/Development for the latest available development documentation. 2.8. Installing Wireshark under Windows In this section we explore installing Wireshark under Windows from the binary packages. 2.8.1. Install Wireshark You may acquire a binary installer of Wireshark named something like: wireshark winxx-1.2.x.exe. The Wireshark installer includes WinPcap, so you don't need to download and install wo separate packages, Simply download the Wireshark installer from: hep:/www wireshark.org/download html and execute it. Beside the usual installer options like where to install the program, there are several optional components. Tip: Just keep the defaults! {If you are unsure which settings to select, just keep the defaults. 2.8.1.1. "Choose Components" page Wireshark, + Wireshark GTK - Wireshark is a GUI network protocol analyzer. “TShark - TShark isa command-line based network protocol analyzer. Plugins / Extensions (forthe Wireshark and TShark dissection engines): + Dissector Plugins - Plugins with some extended dissections + Tree Statisties Plugins - Plugins with some extended statistics, + Mate - Meta Analysis and Tracing Engine (experimental) - user configurable extension(s) of the display filter engine, see htp://wiki. wireshark,org/Mate for details, + SNMP MIBs - SNMP MIBs for a more detailed SNMP dissection. 4Building and Installing Wireshark Tools (additional command line tools to work with capture files) + Editeap - Editcap is a program that reads a capture file and writes some or all of the packets into another capture file, + Text2Pcap - Text2pcap is a program that reads in an ASCH hex dump and writes the data into a ibpeap-style capture file + Mergecap - Mergecap is program that con ines multiple saved capture files into a single output file, + Capinfos - Capinfos is a program that provides information on capture files. + Rawshark - Rawshark is a raw packet filter User's Guide - Local installation of the U: internet connection to show help pages if the User's Guide ism 2.8.1.2. "Additional Tasks" page + Start Menu Shortcuts - add some start menu shortcuts Guide. The Help buttons on most dialogs will require an installed locally + Desktop Icon - add a Wireshark icon to the desktop. + Quick Launch Icon - add a Wireshark icon to the Explorer quick launch toolbar. + Associate file extensions to Wireshark - Associate standard network trace files to Wireshark 2.8.1.3. "Install WinPcap?” page ‘The Wireshark installer contains the latest released WinPcap installer IF you don't have WinPcep installed, you won't be able to capture live network traffic, but you will still be able to open saved capture fies. + Currently installed WinPeap version - the Wireshark installer detects the currently installed WinPcap version, + Install WinPeap x.x - if the currently installed version is older than the one which comes with the Wireshark installer (or WinPcap isnot installed at all), this will be selected by default, + Start WinPcap service "NPE" at startup - so users without administrative privileges can capture. More WinPeap inf: + Wireshark related: htp//wiki.wireshark.ors/WinPeap + General WinPcap info: bapswww.winpeap.ors 2.8.1.4. Command line options You can simply start the Wireshark installer without any command line parameters, it will show you the usual interactive installer. For special cases, there are some command line parameters available: + INCRC disables the CRC check 15Building and Installing Wireshark 2.8.2. 2.8.3. 2.8.4. +S runs the installer or uninstaller silently with default values, Please note: The silent installer won't install WinPCap! + Idesktopicon installation of the desktop icon, =yes - force installation, =no - don't install, otherwise use defaults / user settings. This option can be useful for a silent installer. + fquicklaunchicon installation of the quick launch icon, =yes - force installation, otherwise use defaults / user settings. 10 ~ don't install, + MD sets the default installation directory (SINSTDIR), overriding InstallDir and InstallDirRegKey. It ‘must be the last parameter used in the command line and must not contain any quotes, even ifthe path contains spaces. Example: Manual WinPcap Installation | a Note! ‘As mentioned above, the Wireshark installer takes care of the installation of WinPcap, so usually you don't have to worry about WinPcap at all! ‘The following is only necessary if you want to try a different version than the one included in the Wireshark installer, eg. because a new WinPcap (beta) version was released Additional WinPeap versions (including newer alpha or beta relewses) can be downloaded from the following locations +The main WinPeap site: hp:/www winpeap org. +The Wiretapped.net mirror: http://www mirrors.wiretapped.neusecurity/packet-capture/winpcap At the download page you will find a single installer exe called something like “auto-installer”, which can be installed under various Windows systems, including NT4.0/2000/XP/2003/Vista/7/2008, Update Wireshark From time to time you may want to update your installed Wireshark to a more recent version. Ifyou join ‘Wireshark’s announce mailing list, you will be informed about new Wireshark versions, s “Mailing Lists” for details how to subscribe to this list, Section 1.64, New versions of Wireshark usually become available every 4 to 8 months. Updating Wireshark is done the same way as installing it, you simply download and stat the installer exe. A reboot is usually not required and all your personal settings remain unchanged. Update WinPcap "New versions of WinPcap are less frequently available, maybe only once in a year. You will find WinPcap update instructions where you can download new WinPcap versions. Usually you have to reboot the machine after installing a new WinPcap version. 16Building and Installing Wireshark Warning! A Ifyou have an older version of WinPap installed, you must uninstall it before installing the current version, Recent versions of the WinPcap installer will eke cae ofthis 2.8.5. Uninstall Wireshark You can uninstall Wireshark the usual way, using the "Add or Remove Programs" option inside the Control ancl. Select the "Wireshark" entry to star the uninstallation procedure. ‘The Wireshark uninstaller will provide several options as to which things are to be uninstalled; the default isto remove the core components but keep the personal settings, WinPeap and alike, ‘WinPcap won't be uninstalled by default, as other programs than Wireshark may use it as well 2.8.6. Uninstall WinPcap You can uninstall WinPcap independently of Wireshark, using the "WinPeap” entry inthe "Add or Remove Programs" of the Control Pancl. [F Note! After uninstallation of WinPcap you can't capture anything with Wireshark, It might be a good idea to reboot Windows afterwards. 7Chapter 3. User Interface 3.1. Introduction By now you have installed Wireshark and are most likely keen to get started capturing your first packets. In the next chapters we will explore: How the Wireshark user interface works How to capture packets in Wireshark How to view packets in Wireshark How to filter packets in Wireshark and many other things! 3.2. Start Wireshark You can start Wireshark from your shell or window manager. A Tip! When starting Wis See Section 102, hark ics possible to specify optional settings using the command line. cart Wireshark from the command line" for details, Note! In the following chapters, a lot of screenshots from Wireshark will be shown. As Wireshark runs on many different platforms with many different window managers, different styles applied and there are different versions of the underlying GUI toolkit used, your screen ‘might look different from the provided sercenshots. But as there are no real differences in functionality, these screenshots should still be well understandable. 3.3. The Main window Let's look at Wireshark's user interface. Figure 3.1, “The Main window” shows Wireshark as you would usually see it after some packets ate captured or loaded (how to de this will be described late). 18User Interface Figure 3.1. The Main window eter cote i — Beeewoar*+5 Bere 2 BR aa {eter Hy Set iso. 10.6.2 (tensarsretoa) orks Meta 24t73:98 Coopbead75 1) Imre: Proto}, et 198680.2 (9268.02). Oats 102 168.0-1 (9.168.0.1) {Wnomsetn control Protocsy ine Rott 306 Ge)y be torts fete Cy ei Lent 9 Cesination ports fet (> Seer lenges 2 bree 4 Fans xc0e Go Wireshark’s main window consists of parts that are commonly known from many other GUI programs. 1, The menu (see Section 3.4, “The Menu”) is used to start actions, 2. The main toolbar (see Section 3.15, “The "Main" toolbar”) provides quick access to frequently used items from the menu. 3. Thefilter toolbar (see Section 3.16, “The "Filter" toolbar”) provides a way to directly manipulate the currently used display filter (see Section 6.3, “Filtering packets while view: 4, The packet list pane (see Section 3,17, “The "Packet List" pane”) displays a summary of each packet ‘captured. By clicking on packets inthis pane you control what is displayed in the other two panes. S. The packet details pane (see Section 3.18, “The "Packet Detuils" pane”) displays the packet selected in the packet list pane in more detail, 6 Thepacker bytes pane (see Section 3.19, “The "Packet Bytes" pane”) displays the data from the packet selected in the packet list pane, and highlights the field selected inthe packet details pane. 7. The statusbar (see Section 3.20, “The Statusbar”) shows some detailed information about the current program state and the eaptured dat Tip! u The layout of the main window can be customized by changing preference settings. See Section 10.5, “Preferences” for details! 19User Interface 3.3.1. Main Window Navigation Packet lst and detail navigation can be done entirely from the keyboard, Table 3 1,“Keyboard Navigation” shows a list of keystrokes that will let you quickly move around a capture file. See Table 3.5, “Go menu items" for additional navigation keystrokes. ‘Table 3.1. Keyboard Navi Accelerator |Description Tab, Shift*Tab [Move between screen clements, e.g. from the toolbars to the packet list to the packet tion derail Down ‘Move to the next packet or detail em, UP “Move to the previous packet or detail item, Curl#Down, F8_ [Move to the next packet, even if the packet list isn't focused. CultUp, F7__ [Move to the previous packer, even if the packet list isn't focused, Let In the packet detail, closes the selected tree item. If is already closed, jumps to the parent node. Right Tn the packet detail, opens the selected wee item, Shift+Right [In the packet detail, opens the selected tree item and all ofits subtrees. CurlsRight [In the packet detail, opens all wee items. CulvLett In the packet detail, closes all tree items. Backspace __|In the packet detail, jumps to the parent node. Retum, Enter [In the packet detail, toggles the selected tree item. Additionally, typing anywhere in the main window will start filling in a display filer. 3.4. The Menu ‘The Wireshark menu sits on top of the Wireshark window. An example is shown in Figure 3.2, “The Menu", A Note! “Menu items will be greyed out ifthe corresponding feature isn't available. For example, you ccannot save a capture file if you didn't capture or load any date before Figure 3.2. The Menu le Edt Yew Go aptre Anais Statities Teephory Tools bl It contains the following items: File ‘This memu contains items to open and merge capture files, save / print / export capture files in whole or in part, and to quit from Wireshark. See Section 3. "The “File” menu”, ‘This menu contains items to find a packet, time reference or mark one or more packets, handle configuration profiles, and sct your preferences; (cut, copy, and paste are not presently implemented). See Section 3.6, “The "Edit" menu". 20User Interface View Statisties ‘Telephony Tools Help This menu controls the display of the captured data, including colorization of packets, zooming the font, showing a packet ina separate window, expanding and collapsing trees in packet details, ... See Section 3.7, “The "View" menu”, This menu contains items to go to a specific packet, See Section 3.8, “The "Go" menu", start and stop captures and to edit capture filters, See Section 3.9. -ms to manipulate display filters, enable or disable the dissection of cr specified decodes and follow a TCP stream, See Section 3.10 This menv contains items to display various statistic windows, including a summary of the packets that have been captured, display protocol hierarchy statistics and much more, See Section 3.11, “The "Statistics" menu”, This menu contains items to display various telephony related statistic windows, including a media analysis, flow diagrams, display protocol hierarchy statistics and much more. See Section 3.12, “The "Telephony" menu”, This menu contains various tools available in Wireshark, such as creating Firewall ACL Rules, See Section 3.13, “The "Tools" menu” This menu contains items to help the user, eg, access to some basic help, a list of the supported protocols, manual pages, online access to some of the webpages, and the usual about dialog. See Section 3.14, “The "Help" menu”, Each of these menu items is described in more detail in the sections that follow. Tip! ‘You can access menu items directly or by pressing the corresponding accelerator keys which are shown at the right side of the menu. For example, you can press the Control (or Strg in German) and the K keys together to open the capture dialog, 3.5. The "File" menu ‘The Wireshark file menu contains the fields shown in Table 3.2, “File menu items” 21User Interface Figure 3.3. The "File" Menu ‘otensarsreson), ots netpuu_24173:98 ooopesbe2d7519) [3 Tmerne Protea Set 198610.2 (92-168.0-2). Oats 102 16.0-1 (.468.0-1) | Witeteean como Protorty inc ae 306 Ge)s torts fot (dy ei Len 8 Terce nese Te Cesination ports fet (> 22further in Section 5.5, “File Set File Set > Next File Ifthe currently loaded file is part of a file st, jump to the next file innthe Befedfitcisnt part of file sot or just the last fle in that set, ¥ File Se > ‘Fablod.2uFile menu items Ifthe currently loaded file is part of a file set, jump to the previous file in the set. Ft isn't part of a file set or just the frst fle in that set, this item is greyed out Export > as “Plain Text" file. This menuitem allows you to exportall (or some) ofthe packets in the capture file to & plain ASCII text file. I pops up the Wireshark Export dialog box (which is discussed further in Section 5.6.1 ‘The "Export as Plain Text File” dialog box’ Export > as “PostScript” file. ‘This menu item allows you to export all (or some) of the packets in the capture file to a PostScript file. It pops up the Wireshark Export dialog box (which is discussed further in Section 5.6.2, “The "Export as PostScript File” dialog box”) Export > as| “CSV"(Comma| Separated Values packet| summary) file. ‘This menu item allows you to expor all (or some) of the packet summaries in the capture file to a.csv file e.g. used by spreadsheet programs). It pops up the Wireshark Export dialog box (which is discussed further in Section 5.6.3, “The "Export as CSV (Comme Separated Values) File” dialog box” Export > as "C) Arrays" (packet| bytes) file. ‘This menu item allows you to expor all (or some) of the packet bytes in the capture file toa « file so you can impor the stream data into your own C program. It pops up the Wireshark Export dialog box (Which is discussed further in Section 5.6.4, “The "Export as, |C Arrays (packet bytes) file” dialog box") Export > as “PSML" file. ‘This menu item allows you to export all (or some) of the packets in the capture file to a PSML (packet summary markup language) XML file. It pops up the Wireshark Export diglog box (which is discussed further in Section 5.6.5, “The "Export as PSML File" dialog box"), Export > as “PDML" file. ‘This menu item allows you to expor all (or some) of the packets in the capture file toa PDML. (packet details markup language) XML. file. tpopsup the Wireshark Export dialog box (which is discussed further in Section 5.6.6, “The "Export as PDML File” dialog box”), Export >| Selected Packet Bytes... Cole This menu item allows you to expon the curently selected bytes Jn the packet bytes pane toa binary fie. It pops up the Wireshark Export dialog box (which is discussed further in Section 5.67 “The "Export selected packet bytes" dialog box") Objects > HTTP ‘This mene item allows you to export all or some of the captured HTTP objects into local files. It pops up the Wireshark HTTP object list (which is discussed further in Section 5.6.8, “The ‘Export Objects" dialog box") CoP ‘This menu item allows you to print all (or some) of the packets in the capture file. It pops up the Wireshark Print dialog box (which is discussed further in Section 5.7, “Printing packets” culeQ ‘This menu item allows you to quit from Wireshark. Wireshark will ask to save your capture file if you haven't previously saved it (this ‘can be disabled by a preference setting) 23User Interface 3.6. The "Edit" menu ‘The Wireshark Fait menu contains the fields shown in Table 3.3, “Fait menu items” Figure 3.4. The "Edit" Menu Gates fest "ee Beret 2 ElRaa 8 part ome rover terme ow theta mora m4Copy ===> | Shift+Cul+F —_| This menu item will copy the ficldname of the selected item in the Fildname dal view tothe clipboard Copy Value |ShiteCuieW Rbgpagpy gp will copy the value he selected em inthe dal Bieri wit Copy > _As|ShitrCuivC [This menu item will use the sleced tem in the dtl view to Tillie 33. Bat menultems es dpiay Sr Thr daly er eon copa we clipboa Find Packet. |CulsF This menu Kem brings up a daiog box Gat allows you t finda packet by many criteria. Thre is farther informaton on finding packets in Seton 68, “Finding packets Find Next [Coie This menuitem tres o find the next packet matching he stings from "Find Packet." Find Previous |Ctrl+B. ‘This menu item tries to find the previous packet matching the stings fom "ind Packet." Mark Packet|CoieM This menu fem “maria” the cumenly selected packet See (toggle) Section 6.10, “Marking packets” for details. Find Next] ShitsCuieN [Find the next marked packet Mark Find Previous |ShiftrCuirB [Find te previous marked packet. Mark Mark All This mena em “marks” al played packet, Displayed Packets Unmark All This mena em "unmars” al marked packets Packets Tgoore Packet Culex This mena em marks the cuenly slot packet as ignored. See (toggle) Section 6.11, “Ignoring packets” for details. Ignore Al|ShifsCu}-AIe-X [This mena item mars al displayed packets as ignored. Displayed Packets Unelgnore Al|Shif-Col-X [This meno item unmarks all ignored packs Packets Set Time| Caer This mena fem seta Gime reference on the cureny selected Reference packet. See Section 6.12.1. "Packst time referencing” for more (tog) Information about the ame referenced packets, Find Next ‘This men tem wrest find he nex time referenced packet Reference Find Previous This mena em wes to find the previous dime referenced packet Reference Configuration | Shift-Ctrl-A ‘This menu item brings up @ dialog box for handling configuration Profs. profiles. Mote deals provided in Section 10.6, "Configuration Profiles Preferences..[ShifteCulsP [This mena em brings up a dialog box that allows you to se preferences for many parameter that contol Wireshark. You can ls save your preferences so Wireshark ill use them the nex time you stat it More deal is provided in Section 10,5, "Prfesncs 25User Interface 3.7. The "View" menu ‘The Wireshark View menu contains the fields shown in Table 3.4, “View menu items”. Figure 3.5. The "View" Menu 16 a¢eeF 2 BBaa + tttwesm. wow Vow * orate Per) bear) aeka. 3), es ETE IED fs save Ge), ve torts hota Cy Sei Lens 9 26# Enabling colorization will slow down the display of ‘User Interfadle Packets while capturing / loading capture fils. ‘Kuto_ Scroll im This ent allows you to specify that Wirtshark should scroll the Live Capture packet list pane as new packets come in, so you are always looking Table 3.4. View menu items _|at the last packet. If you do not specify this, Wireshark simply adds new packets onto the end of the list, but does not scroll the packet list pane. ‘Zoom In Cui ‘Zoom into the packet data (increase the font size). Zoom Out [Cult+ Zoom out of the packet data (decrease the font size). Normal Size [Ctrl+= ‘Set zoom level back to 100% (set font size back to normal). Resize All Resize all column widths so the content will fit into it. Columns | A Note! Resizing may take a significant amount of time, especially if a large capture file is loaded. “This menu item expands the currently selected subtree in the packet Subtrees details tree. Expand All Wireshark Keeps @ list of all the protocol subtrees that are ‘expanded, and uses it to ensure that the correct subtrees are ‘expanded when you display a packet. This menu item expands all ‘subtrees in all packets in the capture. Collapse All ‘This menu item collapses the tree view of all packets in the capture ist. Colorize ‘This menu item brings up a submenu that allows you to color Conversation packets in the packet list pane based on the addresses of the currently selected packet. This makes it easy to distinguish packets belonging to different conversations. Section 10.3, “Packet colorization”. Colorize ‘These menu items enable one of the ten temporary color filters Conversation >| ‘based on the currently selected conversation. Color 1-10 Colorize This menu item clears all temporary coloring rules, Conversation >| Reset coloring Colorize ‘This menu item opens a dialog window in which a new permanent Conversation >| ‘coloring ule can be created based on the currently selected New Coloring] ‘conversation, Rule. Coloring ‘This menu item brings up # dialog box that allows you to color Rules. packets in the packet list pane according to filter expressions you choose. It can be very useful for spotting certain types of packets, see Section 10.3, “Packet colorization”. ‘Show Packet in| ‘This menu item brings up the selected packet in a separate window. New Window ‘The separate window shows only the tree view and byte view anes. Reload CuLR ‘This menu item allows you to reload the current capture file. 27User Interface 3.8. The "Go" menu ‘The Wireshark Go menu contains the fies shown in Table 3.5, “Go menu items”, Figure 3.6. The "Go" Menu “Srinmsason control rote Sre mores GLOE), Ow Forts ete eae Sate Oy Lane Soren rts Tipe ON) oeinaion ports et > 28User Interface Table 3.5. Go menu items Menu Item Accelerator _| Description. Back ‘AltsLeft Tomp to the recently visited packet inthe packet history, much like the page history in a web browser. Forward ‘AlesRight ‘Tump to the next visited packet in the packet history, much like the page history in a web browser. Go to Packet... [Cul-G Bring up # dialog box that allows you to specify a packet number, ‘and then goes to that packet. See Section 6.9, “Go to a specific packet” for details Go ry Go to the corresponding packet of the currently selected protocol Corresponding field. Ifthe selected field doesn't correspond to a packet, this item Packet is greyed out. Previous Culp ‘Move to the previous packet in the list, This can be used f© move Packet to the previous packet even if the packet list doesn't have keyboard focus, Next Packet [CultDown ‘Move tothe next packet in the ist. This can be used to move to the previous packet even ifthe packet list doesn't have keyboard focus, First Packet [Cul+Home ‘Tump tothe first packet of the capture file, Last Packet |Cul+End Tomp to the last packet ofthe capture file 3.9. The "Capture" ‘The Wireshark Capture menu contains the fields shown in Table 3.6, "Capture menu items”, menu 29User Interface Figure 3.7. The "Capture" i ver oe ET ee gan, wus fea Menu Cas aaa *8 8e¢%e272 BIB)aa 1 ome. wow Yao [s eebernet Hf, set 498. 1680.2 (0OHODiaTzOHCdSO), Osts Netoew24175:98 COO ft Smernet procs, art og.isho.2 Ga.ten0-2, ost: urieso (as.ten. 0) * Tenamseton Control Protocly ine Bots JHB6 316), ot orks Mtn C0}, fi y Lent 8 Taree pe me grey ination ports Wet (0) Schence nnbers 0” (relative cestnce rater) aa ———] Table 3.6. Capture menu items Menu Item —|Aceelerator _| Description Interfaces... ‘This menu item brings up a dialog box that shows what's going ‘on atthe network interfaces Wireshark knows of, see Section 4.4, ‘~The "Capture Interfaces" dialog box") Options... [Cui¥K This menu item brings up the Capture Options dialog box Giscussed further in Section 4.5, “The "Capture Options” dialog, ox”) and allows you to start capturing packets Start Tmmediately start capturing packets with the same settings than the last time. ‘Stop CohE, ‘This menu item stops the currently running capture, sce Section 4.11.1, “Stop the running capture”) Restart ‘This menu item stops the currently running capture and starts again with the same options, this is just for convenience. Capture "This menu item brings up a dialog box that allows you to create and edit capture filters. You can name filters, and you can save them for furure use. More detail on this subject is provided in “Defining and saving filters 3.10. The "Analyze" menu ‘The Wireshark Analyze menu contains the fields shown in Table 3.7, “Analyze menu items", 30User Interface Figure 3.8, The "Analyze" Menu —— Bestinton grt: (0) 31User Interface Table 3.7. Analyze menu items Menu Item Accelerator _| Description. Display ‘This menu item brings up a dialog box that allows you to create and Filters... dit display filters. You can name filters, and you can save them for future use. More detail on this subject is provided in Section 6.6, “Defining and saving filters” Display Filter "This menu item brings up a dialog box that allows you to create and Macros... edit display filter macros. You can name filter macros, and you can save them for future use. More detail om this subject is provided in Section 6.7, "Defining and saving flter macros” ‘Apply as Filter ‘These menu items will change the current display filter and apply > the changed filter immediately. Depending on the chosen menu item, the current display filter string will be replaced or appended to by the selected protocol fild in the packet details pane. Prepare a Filter ‘These menu items will change the current display filter but won't Daw apply the changed filter. Depending on the chosen ment item, the current display filter string will be replaced or appended to by the selected protocol field in the packet details pane. Enabled Shift-Cul+R [This menu item allows the user to enable/disable protocol Protocols. dissectors, see Section 10.4.1, “The "Enabled Protocols" dialog, box” Decode As... ‘This menu item allows the user to force Wireshark 0 decode certain packets as a particular protocol, see Section 10.4.2, “User Specified Decodes” User Specified ‘This menu ikem allows the user to force Wireshark to decode Decodes.. certain packets as a particular protocol, see Section 10.4.3, “Show User Specified Decodes" Follow TCP ‘This menu Kem brings up a separate window and displays all the Stream ‘TCP segments captured that are on the same TCP connection as = selected packet, see Section 7.2, “Following TCP streams” Follow UDP} ‘Same functionality as "Follow TCP Stream” but for UDP streams, Stream Follow SSL ‘Same functionality as “Follow TCP Stream” but for SSL streams, Stream XXX - how to provide the SSL keys? Expert Info (Opena dialog showing some expert information about the captured packets in a log style display. The amount of information will depend on the protocol and varies from very detailed to none existing. This is currently a work in progress. XXX - add a new section about this and link from here Expert Info ‘Same information as in "Expert Info" but trying to group items Composite together for faster analysis, Conversation In this menu you will find conversation filter for various protocols. Filter >. 32User Interface 3.11. The "Statistics" menu ‘The Wireshark Statistics menu contains the fields shown in Table 3.8, “Statistics menu items”, Figure 3,9. The "Statistics" Menu tow Go Capture brah sunmy ee EO ere conversions B ndponts ouc-ReC Programs “op sream Graph Loe ict streams MA Tae, ‘Sturce ports ncu-2 (3186) Destinetion port: heep (80) {stream index: 5} Seauctelnaberi’e) (ralative oveierathiieer] eader Lengths 20 bytes » lags oxc2 (Sin) Pace a ape OM frat Daa | All menu items will bring up @ new window showing specific statistical information, 33User Interface Table 3.8. Statistics menu items Menu Item Accelerator _| Description. ‘Summary ‘Show information about the data captured, see Section 8.2, “The ‘Summary” window”, Protocol Display a hierarchical tee of protocol statistics, see Section 83, Hierarchy "The "Protocol Hierarchy” window”, Conversations Display alist of conversations (traffic between two endpoints), see ‘Section 8.4.2, “The "Conversations" window”, Endpoints Display a list of endpoints (traffic to/from an address), see Section 8.5.2, “The "Endpoints" window”, Packet ‘See Section 8.9, “The protocol specific statisties windows” Lengths... 10 Graphs Display user specified graphs (e.g, the number of packets in the course of time), see Section 8.6, “The "IO Graphs" window”, Conversation Display a list of conversations, obsoleted by the combined window List ‘of Conversations above, see Section 8.4.3, “The protocol specific ‘Conversation List" windows” Endpoint List Display a list of endpoints, obsoleted by the combined window ‘of Endpoints above, see Section 85.3, “The protocol specific “Endpoint List” windows” Service Display the time between a request and the corresponding Response Time response, see Section 8.7, "Service Response Time”, BOOTP- ‘See Section 8.9, “The protocol specific statistics windows” DHCP... Compare... ‘See Section 8.9, “The protocol specific statistics windows” Flow Graph... ‘See Section 89, “The protocol specific statistics windows” HTTP HTTP requestresponse statistics, see Section 89. “The proweol specific statistics windows" IP Addresses... ‘See Section 8.9, “The protocol specific statistics windows” 1P ‘See Section 8.9, “The protocol specific tatisties windows” Destinations... IP Protocol ‘See Section 89, “The protocol specific statistics windows" ‘Types. ISUP Messages ‘Soe Section 8.9, “The protocol specific statistics windows” ‘ONC-RPC, ‘See Section 8.9, “The protocol specific statisties windows” Programs TCP Stream! ‘See Section 8.9, “The protocol specific statistics windows” Graph UDP Multicast ‘See Section 8.9, “The protocol specific statistics windows” Streams N Traffic ‘See Section 88, “WLAN Traffic Statistics”User Interface 3.12. The "Telephony" menu “The Wireshark Telephony mens contains the fields showin in Table 19, “Telephony ment items" Figure 3.10. The "Telephony" Menu Hie Gdt_viow Go Ganture anaize_ Statice Beate Saxse Brite: 1.025659 12. i> Frame 11 (ea bytes on wire, 2 byten captured) > ethernet 11, sre: Fuji tau a0:ed:02 (00:0b:54:20:cd:02), Ost: Netgear_2i:75:58 (00:00:5b:24: ‘rei 192.160.0.2 (182, 108.0.2), Ost’ 192,100.0.1 {262-168.0.1) Source ports new-2 (3108) Destination pore: hep (60) (Stream index: 5) Sequence number: © (relative sequence number) Header Length: 23 bytes Frararasnn ConmaT ara ST BB Packer are ‘All menu items will bring up a new window showing specific telephony related statistical information, 35User Interface Table 3.9. Telephony menu items Menu Item Accelerator _| Description. ANST ‘See Section 9.6, “The protocol specific statisties windows” Fax 138 ‘See Section 9.6, “The protocol specific statistics windows” Analysis. GSM ‘Soe Section 9.6, “The protocol specific statistics windows” 11225... ‘See Section 9.6, “The protocol specific statisties windows” TAX2 ‘See Section 9.6, “The protocol specific statisties windows" ‘See Section 9.6, “The protocol specific statisties windows” ‘See Section 94, “LTE MAC Traffic Statistics” ‘See Section 9.5, "LTE RLC Traffic Statistics ‘See Section 9.6, “The protocol specific statistics windows” ‘See Section 92, “RTP Analysis” ‘Soe Section 9.6, “The protocol specific statistics windows” ‘See Section 9.6, “The protocol specific statistics windows" ‘See Section 9.6. “The protocol specific statistics windows” ‘See Section 9.6, “The protocol specific statistics windows” ‘See Section 9.3, “VoIP Calls" WAP-WSP., ‘See Section 9.6, “The protocol specific statistics windows” 3.13. The "Tools" menu ‘The Wireshark Tools menu contains the fields shown in Table 3.1 fools menu items! Table 3.10. Tools menu items Menu tem —|Accelerator | Description Firewall ACL) This allows you to create command-line ACL rules for many Rules different firewall products, including Cisco IOS, Linux Netfilter Gptables), OpenBSD pf and Windows Firewall (via netsh). Rules for MAC addresses, IPv4 addresses, TCP and UDP ports, and TPv4sport combinations are supported. It is assumed that the rules will be applied to an outside interface. 3.14. The "Help" menu ‘The Wireshark Help menu contains the ficlds shown in Table 3.11, “Help menu items 36User Interface Figure 3.11. The "Help" Menu Serie nett te Ce) Eerination ports met (©) ‘eee kero) (vive soc te) + Fase ‘Table 3.11. Help menu items Menu Item —_|Accelerator __| Description Contents FI ‘This menu item brings up a basic help system. FAQ's ‘This menu item starts a Web browser showing various FAQs. Manual Pages| ‘This menu item starts a Web browser showing one of the locally Dane installed htral manual pages, Wireshark ‘This menu item starts a Web browser showing the chosen webpage Online > from: ht. l/www.wireshark org. ‘Supported ‘This menu item brings up a dialog box showing the supported Protocols protocols and protocol fields (slow!) ‘About ‘This menu item brings up an information window that provides Wireshark, some information on Wireshark, such as the plugins, the used folders, [A Calling a Web browser might be unsupported in your version of Wireshark. Ifthis isthe case, the corresponding menu items will be hidden, 37User Interface | A Note! If calling a Web browser fails on your machine, maybe because just nothing happens or the browser is started but no page is shown, have a look at the web browser setting in the preferences dialog. 3.15. The "Main" toolbar ‘The main toolbar provides quick access to frequs ‘customized by the user, but it can be hidden using the View menu, if the space on the screen is needed to show even more packet data, ly used items from the menu, This toolbar cannot be ‘As in the menu, only the items useful in the current program state will be available, The others will be rey J out (€.g. you cannot save a capture file if you havent loaded one). Figure 3.12. The "Main" toolbar Sesee o8*+ eS BeroFze OG QQ 38packets in the capture file. It pops up the Wireshark Print dialog box (which is discussed further in ‘Section 5.7, “Printing packets"). User Interface Find Packet... |Ediv/Find Packet...| This item brings up a dialog box that allows you to find a packet. There is further information on finding Table 3/12. Main toolbar items packets in Section 6.8, “Finding packets” @ [GoBack (GolGo Back | This item jumps back in the packet history, ® [GoForward —_|GoiGo Forward _| This item jumps forward in the packet history. % [Goto Packet... _|GoiGo to Packet...| This tem brings up a dialog box that allows you to specify a packet number to go to that packet. Go To First|GorFirst Packet _ | This item jumps to the first packet of the capture file Packet E GoTo _Last|GorLast Packet | This item jumps to the last packet of the capture file Packet 5 [Colorize ‘View/Colorize | Colorize the packet list (or not) BQ___ [Auto Scroll in|ViewiAuto Scroll| Auto scroll packet list while doing a live capture (or Live Capture in Live Capture | not). Q Zoomin ‘View/Zoom In |Zoom into the packet data (increase the Font siz). Q_ [Zoomout ‘View/Zoom Out [Zoom out of the packet data (decrease the font size). @Q_ [Normal Size _| View/Normal Size] Set zoom level back to 100%: FE __ [Resize Columns |View/Resize | Resize columns, so the content fits into them, Columns Capture Fitters... |Captare/Capiure | This item brings up a dialog box that allows you to Fikers create and edit capture filters. You can name filters, ‘and you can save them for future use. More detail on this subject is provided in Section 6.6, “Defining and saving filters 4) __ [Display Filters... |Analyze/Display | This item brings up a dialog box that allows you to Fikers, create and edit display filters. You can name filters, and you can save them for future use. More detail on this subject is provided in Section 6.6, “Defining and saving filters! ‘Coloring Rules... |View/Coloring [This item brings up a dialog box that allows you Rules. color packets in the packet list pane according. t filter expressions you choose. It can be very useful for spotting certain types of packets. More detail ‘on this subject is provided in Section 10.3, “Packet colorization”, RK __[Preferences.._|EdivPreferences [This item brings up a dialog box that allows you to set preferences for many parameters that control Wireshark. You can also save your preferences so Wireshark will use them the next time you start it. ‘More detail is provided in Secsion 10.5, “Proferenci [Hep HelpiContents This item brings up help dialog box. 39User Interface 3.16. The "Filter" toolbar ‘The filter toolbar lets you quickly edit and apply display filters. More information on display filters is available in Section 6.3, “Filtering packets while viewing” Figure 3.13. The "Filter" toolbar Bie: + @Epesion., chr ¥ sob Table 3.13. Filter toolbar items Toolbar eon ‘Toolbar Item Description “ Filter: Filter input [Brings up the filter construction dialog, described in Figure 67, “The ‘Capture Filters" and "Display Filters" dialog boxes". ‘The area to enter or edit a display filter string, see Section 6.4, “Building, display filter expressions” . A syntax check of your filter string is done while you are typing. The background will tum red if you enter an incomplete or invalid string, and will become green when you enter @ valid string. You can click on the pull down arrow to select a previously- centered filter string from a lst. The entries inthe pull down lis will remain available even after a program restart # Note! After you've changed something in this field, don't forget to press the Apply button (or the Enter/Return key), to apply this filter string to the display # Note! | is fietdisatso where the curren filter in effeetis displayed, Expression... ‘The middle button labeled "Add Expression...” opens a dialog box that lets you edit a display filter from a list of protocol fields, deseribed in 5. pression” dialog bos ‘Clear Res ‘carrent display filter and clears the edit area. < ‘Apply "Apply the current value in the edit area as the new display filter. # Note! Applying a display filter on large capture files might take quite a long time! 3.17. The "Packet List" pane ‘The packet list pane displays all the packets in the current capture file. 40User Interface Figure 3.14, The "Packet List” pane Each line in the packet list corresponds to one packet in the capture file. If you select a line in this pane, ‘more details will be displayed in the "Packet Details” and "Packet Bytes” panes. While dissecting a packet, Wireshark will place information from the protocol dissectors into the columns. [As higher level protocols might overwrite information from lower levels, you will typically see the information from the highest possible level only. For example, let’s look at a packet containing TCP inside IP inside an Ethernet packet, The Ethernet dissector will write its data (such asthe Ethernet addresses), the IP dissector will overwrite this by its own. (such as the IP addresses), the TCP dissector will overwrite the IP information, and so on, ‘There are a lot of different columns available. Which columns are displayed can be selected by preference settings, see Section 10.5, “Preferences” ‘The default columns will show: + No. The number of the packet in the capture file. This number won't change, even if a display filter is used ‘+ ‘Time ‘The timestamp of the packet. The presentation format of this timestamp can be changed, see Section 6,12, “Time display formats and time referenc + Source The address where this packet is coming from. + Destination ‘The address where this packet is going to. + Protocol The protocol name in a short (pethaps abbreviated) version. + Info Additional information about the packet content ‘There is a context menu (right mouse click) available, see details in Figure 6.3, “Pop-up menu of the "Packet List" pane 3.18. The "Packet Details" pane ‘The packet details pane shows the current packet (selected in the "Packet List" pane) in a more detailed form. Figure 3.15. The "Packet Details” pane aUser Interface This pane shows the protocols and protocol fields of the packet selected in the "Packet List” pane. The protocols and fields of the packet are displayed using a tree, which can be expanded and collapsed. ‘There is 2 context menu (right mouse click) available, see details in Figure 6.4, “Pop-up menu of the Packet Details" pane’ Some protocol fields are specially displayed. + Generated fields Wireshark itself will generate additional protocol fields which are surrounded by brackets. The information in these fields is derived from the known context to other packets in the capture file. For example, Wireshark is doing a sequence/acknowledge analysis of each TCP stream, ‘which is displayed in the [SEQ/ACK analysis] fields of the TCP protocol ks If Wireshark detected a relationship to another packet in the capture fie, it will generate a ink o that packet, Links are underlined and displayed in blue, If double-clicked, Wireshark jumps to the corresponding packet 3.19. The "Packet Bytes" pane ‘The packet bytes pane shows the data of the current packet (selected inthe "Packet List" pane) ina hexdump style. Figure 3.16. The "Packet Bytes" pane ‘As usual for a hexdump, the left side shows the offset in the packet data, in the middle the packet data is shown in a hexadecimal representation and on the right the corresponding ASCII characters (or . if not appropriate) are displayed. Depending on the packet data, sometimes more than one page is available, e.g. when Wireshark has reassembled some packets into a single chunk of data, see Section 7.6, “Packet Reassembline”. In this ease there are some additional tabs shown atthe bottom of the pane to let you select the page you want to sce. Figure 3.17. The "Packet Bytes" pane with tabs mal pages might contain data picked from multiple packets. The context menu (right mouse click) ofthe tab labels will show a list of all available pages. This can be helpful if the size in the pane is too small forall the tab labels. 3.20. The Statusbar ‘The statusbar displays informational messages. a2User Interface {In general, the eft side will show context related information, the middle part will show the current number ‘of packets, and the right side will show the selected configuration profile, Drag the handles between the text areas to change the size, Figure 3.18. The initial Statusbar pasty toad or capture No Packets ‘This statusbar is shown while no capture file is loaded, e.g, when Wireshark is started, Figure 3.19. The Statusbar with a loaded capture file (© Wie haan pea? 1679 wa 000082 Pockets 229 played 30 Makedo Pele Oo J + The colorized bullet on the left shows the highest expert info level found in the currently loaded capture file, Hovering the mouse over this icon will show a textual description ofthe expert info level and clicking the icon will bring up the Expert Infos dialog box. For a detailed description of expert info, see Section 7.3, “Expert Infos”. + The left side shows information about the capture file, its name, its size and the elapsed time while it was being captured, + The middle part shows the current number of packets in the capture file. The following values are displayed: + Packets: the number of captured packets + Displayed: the number of packets currently being displayed + Marked: the number of marked packets + Dropped: the number of dropped packets (only displayed if Wireshark was unable to capture all packess) + The right side shows the sclected configuration profile. Clicking in this part of the statusbar will bring up a menu with all available configuration profiles, and selecting from this list will change the configuration profile. Figure 3.20. The Statusbar with a configuration profile menu ny Band TC? On For a detailed description of configuration profiles, see Section 10.6, “Configuration Profiles”, Figure 3.21. The Statusbar with a selected protocol field ke 0 Pilea (9 peed ar This is displayed if you have selected a protocol field from the "Packet Details" pane, BUser Interface Tip! '% The value between the brackets (in this example arp.opeode) can be used as a display filter string, representing the selected protocol ficld Figure 3.22. The Statusbar with a display filter message on may have ures ecledresuts (ee the Use 287 Marked: role: Daft ‘This is displayed if you are tying to use a display filter which may have unexpected results. Fora detailed description, see Section 6.4.4, “A common mistake" a4Chapter 4. Capturing Live Network Data 4.1. Introduction ‘Capturing live network data is one of the major features of Wireshark ‘The Wireshark capture engine provides the following features * Capture from different kinds of network hardware (Ethemet, Token Ring, ATM, ..). + Stop the capture on different triggers like: amount of captured data, captured time, captured number of packers, + Simulkancously show decoded packets while Wireshark keeps on capturing. + Filter packets, reducing the amount of data to be captured, see Section 4.10, "Filtering while capturing + Capturing into multiple files while doing a long term capture, and in addition the option to form a ringbuffer of these files, keeping only the last x files, useful for a "very long term" capture, see ‘The capture engine still lacks the following features: * Simultaneous capturing from multiple network interfaces (however, you can start multiple instances ‘of Wireshark and merge capture files later) + Stop capturing (or doing some other action), depending on the captured data. 4.2. Prerequisites Sexting up Wireshark to capture packets forthe first time can be tricky. Tip! A comprehensive guide "How To setup a Capture" is available at: htp:/wiki,wireshark. org CapsureSenuy Here are some common pitfalls: + You need to have root / Administrator privileges to start a live capture. + You need to choose the right network interface to capture packet data from. + You nced to capture at the right place in the network to see the traffic you ws +. and a lot more! If you have any problems setting up your capture environment, you should have 2 look at the guide mentioned above. 45Capturing Live Network Data 4.3. Start Capturing ‘One of the following methods can be used to start capturing packets with Wireshark * You can get an overview of the available local interfaces using the "Sif Capture Interfaces" dialog box, see Figure 4.1, “The "Capture Interfaces" dialog box on Microsoft Windows” or Fisure 4.2, “The ‘Capture Interfaces” dialog box on Unix/Linux”. You can start a capture from this dialog box, using {one off the "Capture" button(s). ‘You can stat capturing using the “BL Capture Options” dialog box, see Figure 4.3, “The "Capture Options” dialog box", + Ifyou have selected the right capture options before, you can immediately start a caprure using the ‘BW. capnare Se + If you already know the name of the capture interface, you can start Wireshark from the command line and use the following: xt" menu / toolbar item. The capture process will star immediately This will start Wireshark capturing on interface ethO, more details can be found at: reshark from the command line 4.4. The "Capture Interfaces" dialog box When you select “Interfaces...” from the Capture menu, Wireshark pops up the "Capture Interfaces" dialog box as shown in Figure 4.1, “The "Capture Interfaces” dialog box on Microsoft Windows" or Figure 4.2 “The "Capture Ineerfaces" dialog box on Unix/Linux" Section 10.2. “Start A This dialog consumes lot's of system resources! As the "Capture Interfaces" dialog is showing live captured data, it is consuming a lot of system resources. Close this dialog as soon as possible to prevent excessive system load. | A Not all available interfaces may be displayed! This dialog box will only show the local interfaces Wireshark knows of. It will not show interfaces marked as hidden in Section 10.5.1, “Interface Options". As Wireshark might not be able to detect all local interfaces, and it cannot detect the remote interfaces available, there could be more caprure interfaces available than listed. Figure 4.1. The "Capture Interfaces" dialog box on Microsoft WindowsCapturing Live Network Data Figure 4,2. The "Capture Interfaces” dialog box on Unix/Linux weno wszreso1z7 aes 2 (@fatarghaeten wiry Peeudodeice that captures on alinefaces m2 we neo. (Gist) arene] Ox | Device (Unix/Linux only) Description Pp Packets Packets/s Stop Start Options Details (Microsoft Windows only) Help Close ‘The interface device name. ‘The interface description provided by the operating system, or the user defined comment added in Section 10.5.1, “Interface Options”, ‘The first IP address Wireshark could resolve from this interface. If no address could be resolved (e.g. no DHCP server available), “unknown” will be displayed. If mote than one IP address could be resolved, only the first is shown (unpredictable which one in that case). ‘The number of packets captured from this interface, since this dialog was opened. Will be greyed out, if no packet was captured in the last second. Number of packets captured in the last second, Will be greyed out, iff no packet was captured in the last second, ‘Stop a currently running capture. ‘Start acapture on this interface immediately, using the settings from the last capture. Open the Capture Options dialog with this interface selected, see Section 45, “The "Capture Options” dialog box”, Open a dialog with detailed information about the interface, see Section 4.7, “The "Interface Details" dialog box”. ‘Show this help page. Close this dialog box. 4.5. The "Capture Options” dialog box ‘When you select Start... from the Capture menu (or use the corresponding item in the "Main" toolbes), Wireshark pops up the "Capture Options” dialog box as shown in Figure 4.3, “The "Capture Options" dialog box" a7Capturing Live Network Data Figure 4.3. The "Capture Options” dialog box 1 Wireshark: Capture Options ‘Capture Interface: [Local | | evicetNP_{c8436757-FD07-457F-5755-AS36E9A5E566} >] IP address: 192,168.1.70 © Capture packets in promiscuous mode L. cept packets in panna Format (expertnertl) Limit each packet to | 1 bites p ‘Capture Fle(=) Display Options rie (rs) | pa et fact raat Use mute files © automatic scaling in ive capture ©] tide capture info dialog “Name Resolution (| Enable MAC name reschition = C7 Enable network name resoluton (© Enable transport name resolution =) Tip! "Ifyou are unsure which options to choose in this dialog box, just try Keeping the defaults as this should work well in many cases. ‘You can set the following fields in this dialog box: 4.5.1. Capture frame Interface (Windows only) ‘The drop down list allows you to select the group of interfaces you want look at. Normally that would be the local interfaces, but, here you can also select a remote interface. Any previously opened remote interfaces will be added to this list also Interface This field specifies the imerface you want to capture on. You can only capture on one interface, and you can only capture on interfaces that Wireshark has found on the system, either local or remote. Itis a drop-down list, so simply click on the button on the a8Capturing Live Network Data IP address Link-layer header type Remote setting (Windows only) Buffer size: n megabyte(s) Capture packets in promiscuous mode Capture packets in peap-ng format right hand side and select the interface you want. It defaults to the first non-loopback interface that supports capturing, and if there are none, the first loopback interface, On some systems, loopback interfaces cannot be used for capturing | Fr Note loopback interfaces are not available on Windows platforms, This field performs the same function as. the command line option, ‘The IP address(es) of the selected interface. If no address could be resolved from the system, "uoknown” will be shown, Unless you are in the rare situation that you need this, just keep the default. For a detailed description, see Section 4.9, “Lin header type’ Here you can set the settings for remote capture. For a detailed descriprion, see Section 4.6, “The "Remote Capture Interfaces! dialog box" Enter the buffer size to be used while capturing. This isthe size of the kernel buffer which will keep the captured packets, until they are written to disk, If you encounter packet drops, try increasing this value, [F Note This option is only available on Windows platforms. This checkbox allows you to specify that Wireshark should put the interface in promiscuous mode wien capturing. If you do not specify this, Wireshark will only capeure the packets going to or from your computer (not all packets on your LAN segment). EA Note If some other process has put the interface in promiscuous mode you may be capturing in promiscuous mode even if you turn off this option. FP Note (| _Evenin promiscuous mode you still won't necessarily see all packets on your LAN segment, see hips! www, wireshark org/fag himltpromisesniff for some more explanations This checkbox allows you to specify that Wireshark saves the captured packets in peap-ng format. This next generation capture file format is currently in development. 0Capturing Live Network Data Limit each packet to n bytes Capture Filter Warning A This is an experimental feature, The resulting saved file may or may not be valid. See hip:/ wiki wireshark.org/DevelopmenvPeapNg for more “details on peap-ng. This field allows you to specify the maximum amount of data that will be captured for each packet, and is sometimes referred to asthe snaplen. If disabled, the value is set to the maximum 65535, which will be sufficient for most protocols. Some rules of thumb: + Ifyou are unsure, just keep the default value + Ifyou don't need al ofthe data in a packet - for example, if you only need the link-layer, IP, and TCP headers - you might want to.choose a small snapshot length, as less CPU time is required for copying packets, less buffer space is required for packe and thus perhaps fewer packets will be dropped if traffic is very heavy. ‘+ If you don't caprare all of the data in a packet, you might find thatthe packet data you want in the part that's dropped, or that reassembly isn't possible asthe data required for reassembly is missing. This field allows you to specify a capture filter. Capture filters are discussed in more details in Section 4.10, “Titering while capturing”. It defaults to empty, of no filter, You can also click on the button labeled "Capture Filter", and Wireshark will bring up the Capture Filters dialog box and allow you to create andior select a filter, Please see Section 6.6, “Defining ‘and saving filters” 4.5.2. Capture File(s) frame ‘An explanation about capture file usage can be found in Section 4.8, “Capture files and file modes”, File Use multiple files [Next file every n megabyte(s) Next file every n minute(s) ‘This field allows you to specify the file name that will be used for the capture file, This field is left blank by default. If the field is left blank, the capture data will be stored in a temporary file, sce Section 4.8, “Capture files and file modes" for details ‘You can also click on the button to the right of this field to browse through the filesystem. Instead of using a single file, Wireshark will automatically switch toa new one, if a specific trigger condition is reached, Multiple files only: Switch to the next file after the given number of byte(sykilobyte(s\megabyte(s)/gigabyte(s) have been captured Multiple files only: Switch to the next file after the given number of second(s)/minutes(s)fhours(s)/days(s) have elapsed. 50Capturing Live Network Data 4.5.3. Ring buffer with n files ‘Stop capture after n file(s) Stop Capture. after n packet(s) after n megabytes(s) «after n minute(s) Multiple files only: Form a ring buffer of the capture files, with the given number of files, Multiple files only: Stop capturing after switching to the next file the given number of times, . frame Stop capturing after the given number of packets have been captured. Stop capturing after the given number of byte(s)/kilobyte(s)/ megabyte(s)/gigabyt red. This option is greyed oat, if "Use multiple files ‘Stop capturing after the given number of second(s)/minutes(s)/ hhours(s)/days(s) have elapsed. 4.5.4. Display Options frame 4.5.5. 4.5.6. Update list of packets in real time ‘Automatic scrolling in live capture Hide capture info dialog ‘This option allows you to specify that Wireshark should update the packet list pane in real time. If you do not specify this, Wireshark does not display any packets until you stop the capture. When you check this, Wireshark captures in a separate process and feeds the captures to the display process. ‘This option allows you to specify that Wireshark should scroll the packet list pane as new packets come in, so you are always looking atthe lest packet. If you do not specify this, Wireshark simply adds new packets onto the end of the list, but dacs not scroll the packet list pane. This option is greyed out if "Update list of packets in real time’ is disabled If this option is checked, che capture info dialog deseribed in Section 4.11, “While a Capture is running..." will be hidden, Name Resolution frame Enable MAC name resolution, Enable transport name resolution Buttons Once you have set the values you desire and have This option allows you to control whether or not Wireshark translates MAC addresses into names, see Section 7.7, “Name Resolution” This option allows you to contol whether or not Wireshark translates network addresses into names, see Section 7.7, “Name Resolution” This option allows you to control whether or not Wireshark translates transport addresses into protocols, see Section 77, “Name Resolution”, ccted the options you need, simply click on Start to ‘commence the capture, or Cancel to cancel the capture. SLCapturing Live Network Data If you start a capture, Wireshark allows you to stop capturing when you have enough packets captured, for details see Section 4.11, “While a Capture is running 4.6. The "Remote Capture Interfaces" dialog box Besides doing capture on local interfaces Wireshark is capable of reaching out across t called capture daemon ot service processes to receive captured data from. A Microsoft Windows only ‘This dialog and capability is only available on Microsoft Windows. On Linux/Unix you can achieve the same effect (securely) through an SSH tunnel ‘The Remote Packet Capture Protocol service must first be running on the target platform before Wireshark ‘can connect to it, The easiest way isto install WinPeap from hiip://www.winpcap org/instal/default him ‘on the target. Once installation is completed go to the Services control panel, find the Remote Packet Capture Protocol service and start it | a Note Make sure you have outside access to port 2002 on the target platform. This isthe port where the Remote Packet Capture Protocol service can be reached, by default Toaccess the Remote Capture Interfaces dialog use the Interfaces dropdown list on the "Capture dialog, see Figure 4.3, “The "Capture Options” dialog box”, and select "RemoCapturing Live Network Data 4.6.1. Remote Capture Interfaces Figure 4.4, The "Remote Capture Interfaces” dialog box Rees Capture face: not, | [bees pre orewrnacc-conaao orn IP address: unknown = )ed Host: Post: Authentication © Nfl authentication © Password authentication Display Options ‘Username: | Usernarne| ++) Update list of packets in realtime Password: ©] Automatic scrolling in ve capture te captre info log Nae Resliton ©] Enable MAC nome reschition 7 Enable netierk ses eslation (| Enable transport name resohtion ‘Sat ‘Sencel ‘You have to set the following parameter in this dialog: Host Port Null authentication Password authentication Enter the IP address or host name of the target platform where the Remote Packet Capture Protocol service is listening, Set the port number where the Remote Packet Capture Protocol service is listening on. Leave open to use the default port (2002). Select this if you don't need authentication to take place for a remote capture to be started. This depends on the target platform. Configuring the target platform like this makes it insecure. ‘This is the normal way of connecting t a target platform. Set the credentials needed t0 connect tothe Remote Packet Capture Protocol 33Capturing Live Network Data 4.6.2. Remote Capture When the connection to the Remote Packet Capture Protocol service is successfully established the "Capture Options” dialog looks like this, see Figure 4.5, “The "Remote Capture” dialog box”, Figure 4.5. The "Remote Capture” dialog box morose Inteyface: 192.160.21.102 y Networic adapter ‘Intel 6255: Integrated Fact Fthere||~ | IP address: Remote Setengs F costne pacts npronsacur node cee ‘ieee LD contre pacts in pean Format espertnerta intescnpecet to bites re Capture Fs) ipiay Options Fle: Update it of packets in realtime Use muti les automate scotng nv ceptre th capture nf log are Reelution capture Sap Cap TA noble NAC name resehtion aes 1 enable sete nme reson Do. after Do. after (s# Lee] ‘The Interface dropdown list now shows the IP address or host name of the Remote Packet Capture Protocol service and the other field shows the interfaces on the remote target. After selecting the desired interface Just click Start to start the remote capture. Y] Enable trenspert neme resolution 4.6.3. Remote Capture Settings ‘The remote capture can be furhter fine tuned to match your situation. The Remote Settings button gives you this option. It pops up the dialog shown in Figure 4.6, “The "Remote Capture Settings" dialog box", 4Capturing Live Network Data Figure 4.6. The "Remote Capture Settings" dialog box Irtfoce 150.160.21.102 |) [Netw adapt Ite 6cbased Integrin ast he J odes: 192.168.2102 (remote stings) aptre options ifersaer[ __@ mepabyess) Bo mk capture mn ROCA lf (C1 Use Une For data transfer a Deploy Oobons 7] Update lst of packets in reat time Automatic scraling in ve capture Hide capture info dstog Reschin [| Enable MAC name resolution C1 Enable netitork name resolution Y] Enable transport name resoktion [sat ‘ancl ‘You can set the following parameters inthis dialog: Do not capture own RPCA\ ‘This option sets a capture filter so that the traffic flowing back traffic from the Remote Packet Capture Protocol service to Wireshark isnt captured as well and also send back. The recursion in this saturates the link with duplicate traffic. You only should switch this off when capturing on an interface ‘other then the interface connecting back to Wireshark. Use UDP for data transfer Remote capture control and data flows over a TCP connection. This option allows you to choose an UDP stream for data transfer. ‘Sampling option None ‘This option instructs the Remote Packet Capture Protocol service to send back all captured packets which have passed the capture filter. Tiss usually not a problem on a emote capture session with sufficient bandwidth, ‘Sampling option 1 of x packets This option limits the Remote Packet Capture Protocol service to send only a sub sampling of the captured data, in terms of number 35Capturing Live Network Data of packets, This allows capture over a narrow band remote capture session of a higher bandwidth interface. ‘Sampling option 1 every x This option limits the Remote Packet Capture Protocol service to milliseconds send only a sub sampling of the captured data, in terms of time. This allows caprure over a narrow band capture session of a higher bandwidth interface. 4.7. The "Interface Details" dialog box ‘When you select Details from the Capture Interface menu, Wireshark pops up the “Interface Details" dialog box as shown in Figure 4,7, “The "Interface Details" dialog box”. This dialog shows various characteri and statistics forthe selected interface. A Microsoft Windows only This dialog is only available on Microsoft Windows Figure 4.7. The "Interface Details” dialog box EI ‘oe oun ule Aner aca ae) To ater sp Se te sy fh ano ry att cd 4.8. Capture files and file modes ‘While capturing, the underlying kbpeap capturing engine will grab the packets from t keep the packet data in a (relatively) small kemel buffer. This data is read by Wire the capture file(s) the user specified. network card and shark and saved into Different modes of operation are available when saving tis packet data othe capture file(s). Tip! "Working with large files (several 100 MB's) can be quite slow. Ifyou plan to do a long term cepture or capturing from a high traffic network, think about using one of the "Multiple files” 36Capturing Live Network Data options. This will spread the captured packets over several smaller files which ean be much more pleasant to work with, A Note! Using Multiple files may cut context related information, Wireshark keeps context information of the loaded packet data soit can report context related problems (like a stream ertor) and keeps information about context related protocols (¢.g. where data is exchanged atthe establishing phase and only referred to in later packets), As it keeps this information only for the loaded file, using one of the multiple file modes may cut these contexts. Ifthe establishing phase is saved in one file and the things you would like to sec isin another, you ‘might not see some of the valuable context related information, Tip! Information about the folders used forthe captor file(s), canbe found in Apnendix A, Files and Folders, Table 4.1. Capture file mode selected by capture options 02.cap, 02.cap, 02.cap, 02.cap, “File” option "Use multiple] "Ring buffer with] Mode Resulting filename(s) files" option —_n files" option used - - : ‘Single temporary etherXXXXXX (where file XXXXXX is a unique number) Too.cap - : ‘Single named file |foo.cap foo.cap x : “Multiple files,|foo_00001_20040205110) ‘continuous foo_00002_20040205110) foo.cap x x “Multiple files,|foo_00001_20040205110) ring buffer o0_00002_ 200402051101 ‘Single temporary file A temporary file will be created and used (this is the default). After the capturing is stopped, this file can be saved later under a user specified name, ‘Single named file A single capture file will be used. If you want to place the new Multiple files, continuous Multiple files, ring buffer capture file to a specific folder, choose this mode. Like the "Single named file” mode, but a new file is created and used, after reaching one of the multiple file switch conditions (one of the "Next file every .." values). Much like "Multiple files continuous”, reaching one ofthe multiple files switch conditions (one of the "Next file every values) will switch to the next file. This will be a newly created file if value of "Ring buffer with n files" is not reached, otherwise it will replace the oldest of the formerly used files (thus forming @ "ring”) ‘This mode will imit the maximum disk usage, even for an unlimited amount of capture input data, keeping the latest captured data, 37Capturing Live Network Data 4.9. Link-layer header type ‘you won't have to choose this link-layer header type. The following paragraphs describe the exceptional cases, where selecting this type is possible, so you will have a guide of what to do: In the usual case, If you are capturing on an 802.11 device on some versions of BSD, this might offer a choice of “Ethenet' ‘or "802.11". “Ethernet” will cause the captured packets to have fake Ethemet headers; "802.11" will cause them t have IEEE 802.11 headers. Unless the capture needs to be read by an application that doesn't support 802.11 headers, you should select "802.11 If you are capturing on an Endace DAG card connected to a synchronous serial line, this might offer a choice of "PPP over serial" or "Cisco HDLC”; ifthe protocol on the serial line is PPP, select "PPP over serial, and ifthe protocol on the serial line is Cisco HDLC, select "Cisco HDLC”. If you are capturing on an Endace DAG card connected to an ATM network, this might offer a choice of "RFC 1483 IP-over-ATM" or "Sun raw ATM”. If the only traffic being captured is RFC 1483 LLC- encapsulated IP, orif the capture needs to be read by an application that doesn’t support SunATM headers, select "RFC 1483 IP-over-ATM'", otherwise select "Sun raw ATM". If you are capturing on an Ethemect device, this might offer a choice of "Ethernet" or "DOCSIS". If you are capturing traffic from a Cisco Cable Modem Termination System that is putting DOCSIS traffic onto the Ethemet to be captured, select "DOCSIS", otherwise select "Ethernet" 4.10. Filtering while capturing ‘Wireshark uses the libpcap filter language for capture filters. This is explained in the tepdump man page, which can be hard to understand, so its explained here to some exten’ ip! 1 Youwill find lot of Cape iter examples at hop vik witeshrk ors/Capture ers. You enter the capture filter into the Filter field of the Wireshark Capture Options dialog box, as shown in Figure 4.3, “Th ¢ dialog box". The following is an outline of the syntax of the ‘tepdump capture filter language. See the expression option at the tepdump manual page for details: hitp:! (ecwwtepdump.orgftepdump_man.html A capture filter takes the form of a series of primitive expressions connected by conjunctions (and/or) primitive ‘An example is shown in Example 4.1," A capture filter for telnet that captures waffic to and from a particular hos Example 4.1. A capture filter for telnet that captures traffic to and from a particular host This example captures telnet traffic to and from the host 10.0.0.5, and shows how to use two primitives and the and conjunction. Another example is shown in Example 4.2, * Capturing all telnet traffic not from 10.0.0.5", and shows how to capture all telnet traffic except that from 10.0.0.5 38Capturing Live Network Data Example 4.2. Capturing all telnet traffic not from 10.0.0.5, XXX - add examples tothe following list. ‘A primitive is simply one of the following: [sreldst] host ether [srcldst] host ‘gateway host [sreldst] net [{mask -}i{len }] [tepludp] [sreldst] port lessigreater iplether proto cether‘ip broadcastimulticast relop This primitive allows you to filter on a host IP address or name, ‘You can optionally precede the primitive with the keyword srel dst to specify that you are only interested in source or destination addresses. If these are not present, packets where the specified address appears as either the source or the destination address will be selected ‘This primitive allows you to filter on Ethernet host addresses. You can optionally include the keyword sreldst between the keywords ether and host to specify that you are only interested in source or destination addresses. If these are not present, packets where the specified address appears in either the source or destination address will be selected. This primitive allows you to filter on packets that used host as a gateway. That is, where the Ethernet source or destination was host but neither the source nor destination IP address wes host. This primitive allows you to fier on network numbers, You can optionally precede this primitive with the keyword sreldst to specify that you are only interested in a source or dest network. If neither of these are present, packets will be selected that have the specified network in either the source or destination address, In addition, you can specify either the netmask or the CIDR prefix for the network if they are different from your own. ‘This primitive allows you to filter on TCP and UDP port numbers ‘You can optionally precede this primitive with the keywords sreldst and tepludp which allow you to specify that you are only interested in source or destination ports and TCP or UDP packets respectively ‘The keywords tepludp must appear before sreldst. If these are not specified, packets will be selected for both the TCP and UDP protocols and when the specified address appears in either the source or destination port field This primitive allows you to filter on packets whose length was less than or equal to the specified length, or greater than or equal to the specified length, respectively This primitive allows you filter on the Ethernet layer or the IP layer. specified protocol at either This primitive allows you to filter on either Ethernet or IP broadcasts or multicasts, ‘This primitive allows you to create complex filter expressions that select bytes or ranges of bytes in packets. Please see the tepdump 9Capturing Live Network Data ‘man page at hip://www. tcpdump org/tepdump_man html for more details 4.10.1. Automatic Remote Traffic Filtering If Wireshark is running remotely (using e.g. SSH, an exported X11 window, a terminal server, ..), the remote content has to be transported over the network, adding @ lot of (usually unimportant) packets to the actually interesting traffic. To avoid this, Wireshark tries to figure out if i's remotely connected (by looking at some specific environment variables) and automatically creates a capture filter that matches espects of the connection, ‘The following environment variables are analyzed: remote IP> REMOTEHOST (tesh, others?) DISPLAY (x11) [remote name}: SESSIONNAME (terminal server) While a Capture is running ... ‘While a capture is running, the following dialog box is shown: 4.11 Figure 4.8. The "Capture Info" dialog box ‘This dialog box will inform you about the number of capa J packets and the time since the capture was changed, started. The selection of which protocols are counted cannot Tip! 'F —_ This Capeare Info dialog box ean be hidden, using the "Hide capture info dialog” option in the Capture Options dialog box ©Capturing Live Network Data 4.11.1. Stop the running capture ‘A running caprre session willbe stopped in one of the following ways: 1. Using the “WF Stop" burton from the Capture Info dialog box | A Note! ‘The Capture Info dialog box might be hidden, if the option "Hide capture info dialog” is used ‘Using the menu item "Capture /Mf Stop” Using the toolbar item ‘BF Stop" 4. Pressing the accelerator keys: Ctrl¥E, 5. The capture will be automatically stopped, if one of the Stop Conditions is exceeded, e.g. the ‘maximum amount of daca was captured, 4.11.2. Restart a running capture ‘A running capture session canbe restarted with the same caprre options asthe lst time, this will remove all packets previously captured, This can be useful, if some uninteresting packets are captured and there's ro need to keep them, Restart is @ convenience function and equivalent toa capture stop following by an immediate capture start A restart can be triggered in one of the following ways: Using the menu item "Capture Restar” Using the toolbar item "Bit Restart 6Chapter 5. File Input / Output and Printing 5.1. Introduction This chapter will describe input and output of capture data + Open/Import capture files in various capture file formats + Save/Export capture files in various capture file formats + Merge capture files together + Print packets 5.2. Open capture files 5.2.1. ‘Wireshark can read in previously saved capture files. To read them, simply select the menu or toolbar item: "ie! 2 Open”. Wireshark will en popup the File Open dialog box, which is dscussedin move derail in Section 82 "The “Open Capture Fle” dialog box It's convenient to use drag-and-drop! 9 to open afile, by simply dragging the desired file from your fle manager and dropping it conto Wireshark’s main window. However, drag-and-drop is not available/won't work in all desktop environments IF you haven't previously saved the current capture file, you will be asked to do so, to prevent data loss (this behaviour can be disabled in the preferences). In addition to its native file format (libpeap format, also used by tepdump/WinDump and other libpcap/ ‘WinPcap-based programs), Wireshark can read capture files from a large number of other packet capture programs as well. Sce Section 5.2.2, “Input File Formats” for the list of capture formats Wireshark understands The "Open Capture File” dialog box ‘The "Open Capture File" dialog box allows you to search for a capture file containing previously captured packets for display in Wireshark, Table 5.1, "The system specific "Open Capture File" dialog box” shows some examples of the Wireshark Open File Dialog box. F ‘The dialog appearance depends on your system! ‘The appearance of this dialog depends on the system and/or GTK+- toolkit version used However, the functionality remains basically the same on any particular system. Common dialog behaviour on all systems: + Select files and directories.File Input / Output and Printing + Click the Open/Ok button to accept your selected file and open it + Click the Cancel button to go back to Wireshark and not load a capture file. ‘Wireshark extensions to the standard behaviour of these dialogs’ + View file preview information (like the filesize, the number of packets, ..), if you've selected a capture file. + Specify a display filter with the "Filter." button and filter field. This filter will be used when opening the new file. The text field background becomes green for a valid fier string and red for an invalid ‘one. Clicking on the Filter button causes Wireshark to pop up the Filters dialog box (which is discussed further in Section 6,3, “Filtering packets while viewing") XXX - we need a better description of these read filters + Specify which type of name resolution is to be performed for all peckets by clicking on one of the " ‘name resolution” check buttons, Details about name resolution can be found in Section 7.7, “Name Resolution”. Save a lot of time loading huge capture files! a ‘You can change the display filter and name resolution settings later while viewing the packets, However, loading huge capture files can take a significant amount of extra ime if these settings are changed later, so in such situntios it cam bea good idea to stat least he filter in advance here 8File Input / Output and Printing Table 5.1. The system specific "Open Capture File" dialog box Figure 5.1. "Open" on native Windows me — a) te (at coe] os) = tem eae Microsoft Windows |This is che common Windows file open dialog - plus some Wireshark extensions. Specific for this dialog. + Ifavailable, the this section of this {clp" button will lead you to ser's Guide" + XXX - the “Filler:” button currently doesn't work on Windows! + XXX - missing feature: If Wireshark doesn't recognize the selected file as a capture fie, i should grey out the "Open” button Figure 5.2. "Open" - new GTK version Unix/Linux: GTK version >= 2.4 [This is the common Gimp¥GNOME file open dialog - plus some Wireshark extensions Specific for this dialog: + The “+ Add" button allows you to add a: directory, selected in the right-hand pane, to the favorites list on the lefl. Those changes are persistent, + ‘The ": Remove" button allows you to remove a. selected directory from that list again (the items like: "Home", "Desktop", and "Filesystem" ‘cannot be removed). + If Wireshark doesn’t recognize the selected fil fas a capture file, it will grey out the "Open button Figure 5.3. "Open" - old GTK version [Unix/tinux: ATK version < 2.4 [This is the file open dialog of former Gimp/ |GNOME versions - plus some Wireshark lextensions, Specific for this dialog. + If Wireshark doesn't recognize the selected file ‘asa capture file, it wil grey out the "OK" button,File Input / Output and Printing 5.2.2. Input File Formats ‘The following fle formats from other capture tools ean be oper ed by Wireshark: + libpeap, tcpdump and various other tools using tcpdump's capture format + Sun snoop and atmsnoop + Shomiti/Finisar Surveyor captures + Novell LANalyzer captures + Microsoft Network Monitor captures + ADXsiptrace captures + Cinco Networks NetXray captures + Network Associates Windows-based Sniffer and Sniffer Pro captures + Network General/Network Associates DOS-based Sniffer (compressed or uncompressed) captures + AG Group/WildPackets EtherPeck/TokenPcek!AiroPeck/EtherHelp/PacketGrabber captures + RADCOM's WAN/LAN Analyzer capcures + Network Instruments Observer version 9 captures + Lucent/Ascend router debug output + HP-UX's nett + Toshiba's ISDN routers dump output + ISDNABSD iMbrrace + traces from the EyeSDN USB SO + IPLog format from the Cisco Secure Intrusion Detection System *+ ppd logs (pppdump format) he output from VMS's TCPIPtrace/TCPtrace/UCXSTRACE utilities + the text output from the DBS Etherwatch VMS utility + Visual Networks! Visual UpTime traffie capture + the output from CoSine L2 debug, the output from Accellents SViews LAN agents + Endace Measurement Systems’ ERF format captures + Linux Bluez Bluetooth stack heidump -w traces 5File Input / Output and Printing + Catapult DCT2000 ost files + Gammu generated text output from Nokia DCT3 phones in Netmonitor mode + IBM Series (08/400) Comm traces (ASCII & UNICODE) + Juniper Netscreen snoop captures + Symbian OS btsnoop captures + Tamosoft CommView captures + Textronix KI2xx 32bit of format captures + Textronix K12 text file format captures * Wireshark .pcapng captures (Experimental) + new file formats are added from time to time A Opening a file may fail due to invalid packet types! Itmay not be possible to read some formats dependent on the packet types captured, theme captures are usually supported for most file formats but it may not be possible to read other packet types (e.g. token ring packets) from all file formats 5.3. Saving captured packets You can save captured packets simply by using the Save AS... menu item from the File menu under Wireshark, You can choose which packets to save and which file format to be used. A Saving may reduce the available information! Saving the captured pac of dropped packets will be Tost will slightly reduce the amount of information, e.g. the number Section A.1, “Capture Files” for details. 5.3.1. The "Save Capture File As" dialog box ‘The "Save Capture File As” dialog box allows you to save the current capture to @ file, Table 5.2, “The system specific "Save Capture File As” dialog box” shows some examples of this dialog box. A The dialog appearance depends on your system! ‘The appearance of this dialog depends on the system and GTK+ toolkit version used. However, the functionality remains basically the same on any particular system, 66File Input / Output and Printing Figure 5.4, "Save" on native Windows ave CaptiresE HE Asin Gi AMQRibOF te save dialog - pus Microsoft Windows some Wireshark extensions Specific for this dialog: + Ifavailable, the "Help" button will lead you to, this section of this "User's Guide” + If you don't provide a file extension to the: filename - c.g. pap, Wireshark will append the standard file extension for tha file format. wm remo Cee Lies) nd = Otentvnase ge . setae (oJ) (Unix/Linux: GTK version >= 24 {This is the common Gimp/GNOME file save dialog - plus some Wireshark extensions Specific for this dialog: + Clicking on the + at "Browse for other folders” will allow you to browse files und folders in your file system, [Unix/Linux: GTK version < 24 This is the file save dialog of former Gimp/GNOME versions - plus some Wireshark extensions. 67File Input / Output and Printing 5.3.2. ‘With this dialog box, you can perform the following actions: 1 ame of the file you wish to save the captured packets in, as standard file name in your Select the directory to save the file into, 3. Select the range of the packets to be saved, see Section 5.8, “The Packet Range frame” 4. Specify the format of the saved capture file by clicking on the File type drop down box. You can \ypes, described in Section 5.3.2, “Output File Formats choose from the | FP The selection of capture formats may be reduced! ‘Some capture formats may not be available, depending on the packet types captured, File formats can be converted! You can convert caprre files from one format to another by reading in a capture fle and writing ic out using a different format. 5. Click on the Save/Ok button to accept your selected file and save to it. If Wireshark has a problem saving the captured packets to the file you specified, it will display an error dialog box. After clicking (OK on that error dialog box, you can try again, 6 Click on the Cancel button to go back to Wireshark and not save the captured packe Output File Formats Wireshark can save the packet data in its "native" file format (libpcap) and in the file formats of some ‘other protacol analyzers, so other tools can read the capeure data. A File formats have different time stamp accuracies! Saving from the currently used file format to a different format may reduce the time stamp accuracy; see the Section 7.4, “Time Stamps" for details. ‘The following file formats can be saved by Wireshark (with the known file extensions): + libpeap, tcpdump and various other t 1s using tepdump’s caprare format (*peap.*.cap,*.dmp) + Accent SViews (Sew) + HP-UX net (*:TRCO.* TRC) + Microsoft Network Monitor - NetMon *.cap) + Network Associates Sniffer - DOS ¢*.cap,* ene, *.tre,*fde,* ye) + Network Associates Sniffer - Windows (*.cap) + Network Instruments Observer version 9 (*-ff) + Novell LANalyzer (*.r1) 8File Input / Output and Printing + Sun snoop (# snoop,*.cap) + Visual Networks Visual UpTime traffic (*.°) + new file formats are added from time to time If the above tools will be more helpful than Wireshark is a different question :-) Third party protocol analyzers may require specific file [FA extensions Other protocol analyzers than Wireshark may require that the file has a certain file extension in order to read the files you generate with Wireshark, ©. ccap" for Network Associates Sniffer - Windows 5.4. Merging capture files 5.4.1. Sometimes you need to merge several capture files into one. For example this can be useful, if you have captured simultaneously from multiple interfaces at once (e.g. using multiple instances of Wireshark). ‘Merging capture files can be done in three ways: + Use the menu item "Merge" from the "Fik Merge with Capture File" dialog box”. This menu item will be disabled, until you have loaded a capture file. ‘menu, to open the merge dialog, see The + Use drag-and-drop to drop multiple files on the main window. Wireshark will ty to merge the packets in chronological order from the dropped files into a newly created temporary file. If you drop only a single file, it will simply replace a (maybe) existing one + Use the mergecap tool, which is a command line tool to merge capture files. This tool provides the _most options to merge capture files, see Section D.7. “mergecap: Merging multiple capture files into The "Merge with Capture File" dialog box This dialog box let you select a file to be merged imto the currently loaded file. A You will be prompted for an unsaved file first! If your current data wasn't saved before, you will be asked to save it first, before this dialog box is shown. Most controls of this dialog will work the same way as described in the "Open Capture File” dialog box, see Section 5.2.1, “The "Open Capsure File" dialog box". Specific controls of this merge dialog are: Prepend packets to existing file Prepend the packets from the selected file before the currently loaded packets. Merge packets chronologically Merge both the packets from the selected and currently loaded file in chronological order, 0File Input / Output and Printing Append packets to existing file Append the packets from the selected file after the currently loaded packets. Table 5.3. The system specific "Merge Capture File As" dialog box Figure 5.7. "Merge" on native Windows] Microsoft Windows /This is che common Windows file open dialog - plus some Wireshark extensions. (Unix/Linux: GTK version >= 2.4 |This is che common GimpyGNOME file open dialog - plus some Wireshark extensions. [Unix/Linux: GTK version < 2.4 [This is the file open dialog of former Gimp/ |GNOME versions - plus some Wireshark lextensions, 5.5. File Sets ‘When using the "Multiple Files” option while doing a capture (see: Section 4.8, “Caprure files and file ‘modes"), the capture data is spread over several capture files, called a fie set. As it can become tedious to work with a file set by hand, Wireshark provides some features to handle these file sets in a convenient way. 70File Input / Output and Printing How does Wireshark detect the files of a file set?” A filename in a file set uses the format Prefix_Number_DateTimeSuffix which might look ike this: "test_00001_20060420183910.pcap". All files of a file set share the same prefix (e.g. "test") and suffix (e.g. "peap") and a varying middle part. To find the files ofa file set, Wireshark scans the directory where the currently loaded file resides and checks for files matching the filename pattern (prefix and suffix) of the currently loaded file. This simple mechanism usually works well, but has its drawbacks. If several file sets were captured with the seme prefix and suffix, Wireshark will detect them asa single file set. Ifiles were renamed ‘or spread over several directories the mechanism will fail to find al files of a set. ‘The following features in the "File Set" submenu of the "Tile" menu are available to work with file sets in a convenient way’ + ‘The List Files dialog box will isthe files Wireshark has recognized as being part ofthe current file set. + Next File closes the current and opens the next fle in the file set. + Previous File closes the current and opens the previous file in the file st 5.5.1. The "List Files" dialog box Figure 5.10. The "List Files" dialog box soso i9i815a9 2583918508 109 | tou 155 ae toute ae et on 150 9 een en 150 0 Bee Each line contains information about a file of the file set: + Filename the name of the file. If you click on the filename (or the radio button left to it), the current file will be closed and the corresponding capture file will be opened. + Created the creation time of the file 7File Input / Output and Printing + Last Modified the last time the file was modified + Size the size of the file ‘The last line will contain info about the currently used directory where all of the files in the file set ean be found. ‘The content of this dialog box is updated each time a capture file is penediclosed. ‘The Close button will, well, close the dialog box. 5.6. Exporting data Wireshark provides several ways and formats to export packet data. This section describes general ways to export data from Wireshark, [7 Note! ‘There ere more specialized functions to export specific data, which will be described atthe appropriate places XXX - add detailed descriptions ofthe ouput formats and some sample ovtps, too 5.6.1. The "Export as Plain Text File" dialog box Export packet data into a plain ASC text file, much lke the format used to prin packets Figure 5.11. The "Export as Plain Text File" dialog box —_ a) (Gonder) Clr amare =i rant ete : motos © mange ae + Export to file: frame chooses the file to export the packet data to. ‘The Packet Range frame is described in Section 5.8, “The Packet Range frame”, + The Packet Details frame is described in Section 5.9, “The Packet Format fram 5.6.2. The "Export as PostScript File" dialog box Export packet data into PostScript, much like the format used to print packets. 2File Input / Output and Printing Tip! | You can easily convert PostScript files to PDF files using ghostscript. For example: export ‘oa file named foo.ps and then call: ps2paf foo.ps Figure 5.12. The "Export as PostScript File” dialog box reson tba cna he a et Be) [Gesedlomid) | PIPeot mere eae ai Crate (O nentpont oy : Export to file: frame chooses the file to export the packet data to The Packet Range frame is described in Section 5.8, “The Packet Range frame” ‘The Packet Details frame is described in Section 5.9, “The Packet Format frame” 5.6.3. The "Export as CSV (Comma Separated Values) File" dialog box XXX - add screenshot Export packet summary into CSV, used eg. by spreadsheet programs to im-fexport data, + Export to file: frame chooses the file to export the packet data to. ‘The Packet Range frame is described in Section 5.8, “The Packet Range frame”, 5.6.4. The "Export as C Arrays (packet bytes) file" dialog box XXX - add screenshot Export packet bytes into C arrays so you can import the stream data into your own C program. + Export to file: frame chooses the file to export the packet data to. ‘The Packet Range frame is described in Section 5.8, “The Packet Range frame”, 5.6.5. The "Export as PSML File" dialog box Export packet data into PSML.. This is an XML based format including only the packet summary. The PSML file specification is available at: hp://www.nbee.org/doku php idenetpdl:psml_ specification, BFile Input / Output and Printing Figure 5.13, The "Export as PSML File" dialog box + Export to file: frame chooses the file to export the packet data to + The Packet Range frame is described in Section 5.8, “The Packet Range frame”, There's no such thing as a packet details frame for PSML expor, as the packet format is defined by the PSML specitication. 5.6.6. The "Export as PDML File" dialog box [Export packet data into PDML. This is an XML based format including the packet details, The PDML file specification is available at; http://www nbee.org/doku.phpid=netpdl:pdml_specification The PDML specification is not officially released and Wireshark’s implementation of itis still in an early beta state, so please expect changes in future Witeshark versions, Figure 5.14. The "Export as PDML File" dialog box + Export to file: frame chooses the file to export the packet data to. + The Packet Range frame is described in Section 5.8, “The Packet Range frame" ‘There's no such thing as a packet details frame for PDML export, as the packet format is defined by the PDML specification ™File Input / Output and Printing 5.6.7. The "Export selected packet bytes" dialog box EExpor the bytes selected in the “Packet Bytes” pane into a raw binary ile Figure 5.15, The "Export Selected Packet Bytes” dialog box Scere ne Mts tytn yeast Give | eewe + Name: the filename to export the packet data to + The Save in folder: field lets you select the folder to save to (from some predefined folders) + Browse for other folders provides a flexible way to choose a folder. 5.6.8. The "Export Objects" dialog box This feature scans through HTTP streams in the currently open capture file or running capture and takes reassembled objects such as HTML documents, image files, executables and anything else that ccan be transferred over HTTP and lets you save them to disk. If you have a capture running, this list is automatically updated every few seconds with any new objects seen. The saved objects can then be opened with the proper viewer or executed in the case of executables (if itis forthe same platform you are running. Wireshark on) without any further work on your part. This feature is not available when using GTK2 versions below 2.4. 75File Input / Output and Printing Figure 5.16. The "Export Objects” dialog box a | 0) aa] He] hss sea Columns + Packet num: The packet mumber in which this object was found. In some cases, there can be multiple ‘objects in the same packet. + Hostname: The hostname ofthe server that sent the objet a response to an HTTP request. + Content Type: The HTTP conten ype ofthis objcet, + Bytes: The size ofthis objcet in bytes. + Filename: The fins! part ofthe URI (ater the lst slash). This is typically filename, but may be 4 long complex looking sting, which typically indicates thatthe fle was rceived in response to 8 HTTP POST request Burton: + Help: Opens this section inthe wtr's guide + Close: Closes this dog + Save As: Saves the currently selected object as a filename you specify. The default filename to save as is taken from the filename column of the objects list. + Save All: Saves all objects inthe list using the filename from the filename column. You will be asked ‘what directory / folder to save them in, Ifthe filename is invalid for the operating system/ file system you are running Wireshark on, then an error will appear and that object will not be saved (but all of the others will be) 76File Input / Output and Printing 5.7. Printing packets ‘To print packets, select the "Print." menu item from the File menu. When you do this, Wireshark pops up the Print dialog box as shown in Figure 5.17, “The "Print" dialog box" 5.7.1. The "Print" dialog box Figure 5.17. The "Print" dialog box ‘The following fils are available in the Print dialog box Printer ‘This field contains a pair of mutually exclusive radio buttons + Plain Text specifies that the packet print should be in plain text, + PostSeript specifies that the packet print process should use PostScript «0 ‘generate a better print output on PostScript aware printers + Output to file: specifies that printing be done toa file, using the filename entered in the field or selected with the browse button, ‘This field is where you enter the file to print to if you have selected Print to a file, or you can click the button to browse the filesystem. Itis greyed out if Print toa ile is not selected, + Print command specifies that a command be used for printing. #F Note! These Print command fields are not available on windows platforms, This field specifies the command to use for printing. It is typically Ipr. You ‘would change itto specify a particular queue if you need to print to a queue other than the default. An example might be: 77File Input / Output and Printing ‘This field is greyed out if Output to file: is checked above. Packet Range Select the packets to be printed, see Section 5.8, “The Packet Range frame” Packet Format Select the output format of the packets to be printed. You can choose, how each packets printed, see Figure 5.19, “The "Packet Format" frame” 5.8. The Packet Range frame ‘The packet range frame is a part of various output packets should be processed by the output function, J dialog boxes. It provides options to select which Figure 5.18. The "Packet Range" frame ae tl oe : tured button is set (default), all packets from the selected rule will be processed. If the Displayed ‘button is set, only the currently displayed packets are taken into account to the selected rue. + All packets will process all packets. + Selected packet only process only the selected packet. + Marked packets only process only the marked packets, + From first to last marked packet process the packets from the first to the last marked one, + Specify a packet range process a user specified range of packets, eg. specifying §,10-15,20- will process the packet number five, the packets from packet number ten to fifteen (inclusive) and every packet from number twenty to the end of the capture. 5.9. The Packet Format frame ‘The packet format frame is apart of various output related dialog boxes. It provides options to select which part of a packet should be used for the ourput function. Figure 5.19. The "Packet Format" frame [Eircctamer te Bream Net Creme (tohont name 78File Input / Output and Printing Packet summary line enable the output of the summary line, just as in the "Packet List” pane, Packet details enable the ousput ofthe packet +All collapsed the info from the "Packet Detils” pane in “all collapsed” state + As displayed the info from: the "Packet Details" pane in the current state + Allexpanded the info from the "Packet Details" pane in “all expanded” state Packet bytes enable the ourpu of the packet bytes, just a in the "Packet Bytes” pane. Each packet on a new page put cach packet on a separate page (e.g. when saving/printing to a text file, this will puta form feed character between the packets), 79Chapter 6. Working with captured packets 6.1. Viewing packets you have captured ‘Once you have captured some packets, or you have opened a previously saved capture file, you can view the packets that are displayed in the packet list pane by simply clicking on a packet inthe packet list pane, ‘which will bring up the selected packet in the tree view and byte view panes. ‘You can then expand any part of the tree view by clicking on the plus sign (the symbol itself may vary) to the left ofthat part of the payload, and you can select individual fields by clicking on them in the wee ‘view pane. An example with a TCP packet selected is shown in Figure 6.1, “Wireshark with a TCP packet selected for viewing”. Italso has the Acknowledgment number in the TCP header selected, which shows up in the byte view as the selected bytes. Figure 6.1. Wireshark with a TCP packet selected for vi Beeewoax*+.o aee0t2 Si aa estnation ports 7 (357) ius enbers 0 (ehetive sewence maber) You can also select and view packets the same way, while Wireshark is capturing, if you selected "Update list of packets in real time” in the Wireshark Capture Preferences dialog box. In addition, you can view individual packets in a separate window as shown in Figure 6.2, “Viewing a packet in.a separate window”, Do this by selecting the packet in which you are interested in the packet list pane, and then select "Show Packet in New Windows" from the Display menu. This allows you to easily ‘compare two or even more packets, 80Working with captured packets Figure 6.2. Viewing a packet in a separate window 6.2. Pop-up menus ‘You can bring up a pop-up menu over either the "Packet List” or "Packet Details" pane by clicking your right mouse button at the corresponding pane. 6.2.1. Pop-up menu of the "Packet " pane Figure 6.3. Pop-up menu of the "Packet List” pane @**s @Bexert? SS aaasie ee irre pores 2 meat ond) > z0:ea:02 (9ot0n:54:20re4:02) Gas2-268.0.2 ceotsdeadbattnee 330 fs Stherowt 41, ster mergear *fource pores 1095 (3025), hs ‘estinatton port: 5000 (5000) Sequance number! a relative sequence) Or Acinoviedgenart nimbert A. Grelative at header lengths 20 bytes ‘The following table gives an overview of which functions are available in this panc, where to find the corresponding function in the main menu, and a short description of each item. 81item Identical to main |Description ‘menu's item: ‘Mark Packet |Edit “Mark/unmark a packet. (toggle) Working) with eaprured packets Set Time| Edit ‘Seureset a time reference. RABE. The menu items of the "Packet List” pop-up menu ‘Apply as Filter [Analyze Prepare and apply a display filter based on the currenly selected item Prepare a Filter [Analyze Prepare display filter based on the currently selected item Conversation |- ‘This mena item applies @ display filter with the address Filter information from the selected packet E.g. the IP menu entry will seta filter to show the traffic between the two IP addresses of the current packet, XXX - add a new section describing this beter. Colorize - “This menu item uses a display filter with the address information Conversation from the selected packet to build « new coloring rule SCIP, - XXX add an explanation of this. Follow TCP|Analyze "Allows you to view all the data on a TCP stream between @ pair Stream of nodes, Follow SSL|Analyze ‘Same as "Follow TCP Stream?” but for SSL, XXX - add a new Stream section describing this beter. ‘Copy Summary|- (Copy the summary fields as displayed to the clipboard, as tab- (ext) separated text. Copy/ Summary|- Copy the summary fields as displayed to the clipboard, as csv) ‘comma-separated text Copy/ As Filter Prepare a display filter based on the currently selected item and copy that filter to the clipboard Copy Bytes|- ‘Copy the packet bytes to the clipboard in hexdump-like format (Offset Hex Text) Copy/— Bytes|- ‘Copy the packet bytes to the clipboard in hexdump-lke format, (Oltset Hex) ‘but without the text portion, Copy! Bytes|- (Copy the packet bytes to the clipboard as ASCII text, excluding (Printable Text ‘non-printable characters. Only) Copy/ Bytes (Hex|- Copy the packet bytes to the clipboard as an unpunctuated list Stream) of hex digits Copy/__Bytes|- ‘Copy the packet bytes to the clipboard as raw binary. The (Binary Stream) data is stored in te clipboard as MIME-type "application/octet- steam’ ‘This option isnot available in versions of Wireshark built using GTK+ Lx Export Selected File “This menu item is the same as the File menu item of the same Packet Bytes... name. It allows you to expor raw packet bytes to a binary file Decode As. [Analyze ‘Change or apply @ new relation between two dissectors Print. File rint packets Show Packet in|View DDisplay the selected packet in a new window. New Window 2Working with captured packets 6.2.2. Pop-up menu of the "Packet Details” pane Figure 6.4. Pop-up menu of the "Packet Details" pane mamas « ee woe e@*+s 8@erxet? BE aacagie eee Pectherer a, sree Netgen?=29: 73:98, (OrO9"S020 a Irvernae prococel, sees 192.266.0.1 C1s2.168.0, eadHt = teangeteston contcod proracsl, arc pore: iozs ¢ cama ource port: 1025 «a025), oer Sestination part: 5000 (5600) Sequence number! 1 (Felatve sequence nuk _ Est Sete AStnoviedgenent nibers d Crelatve 3 ET ns teaser lengths 20 Beer owe aft tesanant + ge OH Gen) Fanta srtsentd a Choctsuns one797 (correct) ie Sd 2 Tsenyacx anaiysisy ene Sian ‘The following table gives an overview of which functions are available in this pane, where to find the corresponding function in the main menu, and a short description of each item. 33“opyl Bytes) (Offset Hex Text) Working, (“Copy the packet bytes to the clipboard in hexCump-lke format, similar to the Packet List Pane command, but copies only the’ bytes relevant to the selected part of the tee (the bytes selected |istheediveheu utaeeRane). Copy Bytes|- (Offset Hex) ‘Copy the packet Bytes to the clipboard in hexdump like format, but without the text portion: similar to the Packet List Pane Table 6.2. The menu items of theoisRasket Despilstnpope-panensian othe slected part ofthe tce (the bytes selected in the Packet Bytes Pane) Copy) Bytes (Printable Text Only) ‘Copy the packet bytes to the clipboard as ASCII text, excluding. ‘non-printable characters; similar to the Packet List Pane’ ‘command, but copies only the bytes relevant to the selected part lof the tee (the bytes selected in the Packet Bytes Pane). Copy/ Bytes (Hex Stream) ‘Copy the packet bytes o the clipboard as an unpunctuated list of| hhex digits; similar to the Packet List Pane command, but copies’ ‘only the bytes relevant to the selected part ofthe tree (the bytes! selected in the Packet Bytes Pane). Copy/ Bytes (Binary Stream) ‘Copy the packet bytes to the clipboard as raw binary; similar t0 ‘the Packet List Pane command, but copies only the bytes relevant to the selected part of the tree (the bytes selected in the Packet ‘Bytes Pane). The data is stored in the clipboard as MIME-type’ "applicationvoctet-stream”. “This option is not available in versions of Wireshark built using’ GTK+ Lx Export Selected| File Packet Bytes. "This menu item is the same as the File menu item of the same’ ‘name. It allows you to export raw packet bytes to a binary file, ‘Apply as Filter [Analyze ‘Prepare and apply a display filter based on the currently selected item, Prepare a Filter [Analyze [Prepare a display filter based on the currently selected iter Colorize _with|- Filter ‘Prepare a display filter based on the currently selected item and! use it to prepare a new colorize rule Follow TCP/ Analyze Stream ‘Allows you to view all the data on a TCP stream between a pair of nodes. Follow SSL|Analyze Stream ‘Same as "Follow TCP Stream” but for SSL. XXX - add a new’ section describing this beter. Wiki Protocol|- ‘Show the wiki page corresponding to the currenily selected’ Page [protocol in your web browser. Filter ‘Field |- ‘Show the filter field reference web page corresponding (0 the’ Reference currently selected protocol in your web browser. Protocol : "The menu item takes you to the properties dialog and selects Preferences... the page corresponding to the protocol if there are properties’ associated with the highlighted field. More information on’ preferences can be found in Figure 10.8, “The preferences dialog box". Decode As... [Analyze ‘Change or apply a new relation between two dissectors Resolve Name | View ‘Causes a name resolution tobe performed forthe selected packer, ‘but NOT every packet in the capture. Go to|Go Corresponding Packet If the selected field has a corresponding packet, go to it (Comresponding packets will usually be a requestresponse packet pair or such,‘Working with captured packets 6.3. Filtering packets while viewing ‘Wireshark has two filtering languages: One used when capturing packets, and one used when displaying packets. In this section we explore that second type of filter: Display filters. The first one has already been dealt with in Section 4.10, “Filtering while capturing” Display filters allow you to concentrate on the packets you are interested in while hiding the currently. uninteresting ones. They allow you to select packets by + Protocol +The presence of afield +The values of fields + A comparison between fields + and alot more! To seleet packets based on protocol type simply type the protocol in which you are interested in the Filter: field inthe filter toolbar of the Wireshark window and press enter to initiate the filter, Pigure 6.5, "Filtering ‘on the TCP protocol” shows an example of what happens when you type tep inthe filter Field | A Note! |<} altprotocol and field names are entered in lowercase. Also, don't forget to press enter after centering the filter expression. Figure 6.5. Filtering on the TCP protocol eR te cone tnt a Beet oa~+s aeveote Beara fb kemroet tt, arct ton end.e (ovmssersree), { Tivontaean cont Prtoey See Ret 896 (6), ae hres Weta (Wy Sei y Lent 9 85Working with captured packet ‘As you might have noticed, only packets of the TCP protocol are displayed now (e.g. packets 1-10 are hidden). The packet numbering will remain as before, so the first packet shown is now packet number 11 | F Note! When using & display filter, all packets remain in the capture file. The display filter only changes the display of the capture file but not its content! You can filter on any protocol that Wireshark understands. You ean also filter on any field that a dissector adds to the tree view, but only if the dissector has added an abt A listof such fields is available in Wireshark in the Add Expression... dialog box. You can find more information on the Add Expression... dialog box in Section 6.5, “The "Filter Expression” dialog box” ation for the For example, to narrow the packet list pane down to only those packets to or from the IP address 192.168.0.1, use ipaddr==192.168.0.1, | A Note! To remove the filter, click on the Clear button to the right of the filter field. 6.4. Building display filter expressions 6.4.1. 6.4.2. Wireshark provides a simple bat powerful display filter language that allows you to build quite complex filter expressions. You can compare values in packets as well as combine expressions into more specific expressions. The following sections provide more information on doing this. ip! ¥ ‘You will find a lot of Display Filter examples at the Wireshark Wiki Display at hep/wiki, wireshark org/DisplavFilters, Display filter fields Every field in the packet details pane can be used as a filter string, this will result in showing only the ppackets where this field exists. For example: the filter string: tep will show all packets containing the tep protocol, ‘There is a complete list of all filter fields available through the menu item "Help/Supported Protocols" in the page "Display Filter Fields" of the Supported Protocols dialog, 2XXX--add some more info here and ink to the statusbar info, Comparing values ‘You can build display filters that compate values using a number of different comparison operators. They are shown in Table 6.3, “Display Filter comparison operators Tip! "% You can use English and C-like terms in the same way, they can even be mixed in a filter string! 86Working with captured packets Table 6.3. Display Filter comparison operators English [C-like [Description and example ea = ip.sre!=10.0.0.5 at > (Greater than feoneston > 10 t fe Less than sne-len < 128 se p= (Greater than or equal to frane.len ge 0x100 ie = ‘Less than or equal to In addition, al protocol fields are typed. Table 6.4, ‘Display Filker Field Types" provides a list of the types ‘and example of how to express them, 87‘Working with captured packets Table 6.4. Display Filter Field Types Type Example Unsigned integer (8-bit, 16-bit, 24-bit, 32-bit) | You can express integers in decimal, octal, or Inexadecimal. ‘The following display filters are equivalent: jip-ter Le 1500 jipvten te 02734 fipsten Le 04436 ‘Signed integer (B-bit, 16-bit, 24-bit, 32-bit) Boolean [A boolean field is present in the protocol decode: lonly its value is true. For example, tep.flags.syn is present, and thus true, only ifthe SYN flag is present in a TCP segment header. [Thus the filter expression tep.fags.syn will select lonly those packets for which this flag exis, that is, [TCP scgments where the segment header contains the SYN flag. Similarly, to find source-routed token ring packets, use filter expression of tr.sr [Ethernet address (6 bytes) Separators can be a colon (), dot (.) or dash ) and. [can have one or two bytes bewween separators: TP v4 address ipaddr == 192.1680.1 [Classless InterDomain Routing (CIDR) notation. [can be used to test if an IPv4 address isin a certain subnet. For example, this display filter will find all Ipackets in the 129.111 Class-B network 129.111.0016 pada TP address ipv6addr == 1 IPX address ipx addr == 00000000. FFT String (ext) Insp requesturi = “hapiliwww wireshark orgy” 6.4.3. Combining expressions You can combine filter expressions in Wireshark using the logical operators shown in Table 6.5. “Display. Filter Logical Operations” 88‘Working with captured packets Table 6.5. Display Filter Logical Operations English [C-like [Description and example and ea ‘Logical AND ip.sre--10.0,0.5 and tep. flags. fin or 0 ‘Logical OR sprscr=-10.0,0.5 or ipesren192-1Li xor fan Logical XOR Jeredot (0:3) == 0.6.29 xor trsre(0:3] == 0.6.29 not T Logical NOT not ite La ‘Substring Operator ‘Wireshark allows you to select subsequences of a sequence in rather elaborate ‘ways. After a label you can place a pair of brackets (J containing « comma ‘separated list of range specifiers. loth 0:3] == 90:00:63 ‘The example above uses the n:m format to specify a single range. In this case n| isthe beginning offset and m is the length of the range being specified loth.srefi-?} == 90:83 “The example above uses the n-m format to specify a single range. In this case n| isthe beginning offset and m is the ending offset. Jotn.erets4) == 00:00:83:00 ‘The example above uses the :m format, which takes everything from the ‘beginning of a sequence to offset m. It is equivalent to O:m loth Ar] = 20:20 ‘The example above uses the n: format, which takes everything from offset n to ‘the end of the sequence. lothesret2] == 63 “The example above uses the n format to specify a single range. In this case the ‘clement in the sequence at offset nis selected. This is equivalent ton: lotn.erc( 0:3, 1-2) 24,4242) = 00:00:83:00:83:00:00:03:00+20:20:83 ‘Wireshark allows you to sting together single ranges in a comma separated list to form compound ranges as shown above. 89Working with captured packet 6.4.4. A common mistake A Warning! Using the != operator on combined expressions like: eth addr, ip.addr, tep.port, udp-port and alike will probably not Often people use a filter string to display something like ip.addr == 1.2.3.4 which will display all packets ‘containing the IP address 1.2.3.4 ‘Then they use ip.addr != 1.2.3.4 see all packets not containing the IP address 1.2.3.4 in it. Unfortunately, this does not do the expected. Instead, that expression will even be true for packets where either source or destination IP address equals 1.2.3.4 The reason for this i thatthe expression ip.addr != 1.2.3.4 must be read as "the packet contains a field named ip.addr with a value different from 1.2.3.4". As an IP datagram contains both a source and a destination address, the expression will evaluate to true whenever at least one ofthe two addresses differs from 1.2.3.4. Ifyou want to filter out all packets containing IP datagrams to or from IP address 1.2.3.4, add ipaaddr exists with a value of 1.2.34", or in other words, “filter out all packets for which there are no of afield named ip.addr with the value 1.2.3 n the correct filteris| 1.2.3.4) asitreads “show me all the packets for which itis not true that a field named 6.5. The "Filter Expression" dialog box ‘When you are accustomed to Wireshark’s filtering system and know what labels you wish to use in your filters it can be very quick to simply type a filter string. However if you are new to Wiresbark or are working with a slightly unfamiliar protocol it can be very confusing to try o figure out what to type. The Filter Expression dialog box helps with this. Tip! The "Filter Expressio display filter strings, dialog box is an excellent way to leam how to write Wireshark 90‘Working with captured packets Figure 6.6. The "Filter Expression” dialog box When you first bring up the Filter Expression dialog box you are shown a tree list of field names, organized by protocol, and a box for selecting a relation Field Name Sclect a protocol field from the protocol field tre. Every protocol with flterable fields is listed at the top level. (You can search for a particular protocol entry by entering the first few letters of the protocol name). By clicking on the "+" next to & protocol name ‘you can get list ofthe field names available for filtering for that protocol Relation Select a relation from the list of available relation. The is present is a unary relation Which i true if the selected field is present ina packet. All other listed relations are binary relations which require additional data (c.g. a Value to match) to complete. ‘When you select a field from the field name list and select a binary relation (such as the equality relation you will be given the opportunity to enter a value, and possibly some range information, Value ‘You may enter an appropriate value in the Value text box. The Value will also indicate the type of value for the field name you have selected (like character string). Predefined values Some of the protocol fields have predefined values available, much Tike fenum’s in C. If the s ‘choose one of ther here. ed protocol field has such values defined, you ean Range XXX - add an explanation here! 0K When you have builta satisfactory expression click OK and a filter string will be built for you. Cancel ‘You can leave the Add Expression... dialog box without any effect by clicking ‘the Cancel button, 6.6. Defining and saving filters ‘You can define filters with Wireshark and give them Iebels for later use, This can save time in remembering and retyping some of the more complex filters you use, 91‘Working with captured packets To define a new filter or edit an existing one, select the Capture Filters... menu item from the Capture ‘menu or the Display Filters... menu item from the Analyze menu. Wireshark will then pop up the Filters ialog as shown in Figure 6,7, “The "Capture Filters" and "Display Filters" dialog boxes", A Note! ‘The mechanisms for defining and saving capture filters and display filters are almost identical. So both will be described here, differences between these two will be marked as such, Warning! A You must use Save to save your filters permanently. Ok or Apply will not save the fiers, so they wll be lost when you close Wireshark, Figure 6.7. The "Capture Filters" and "Display Filters" dialog boxes New ‘This button adds & new filter to the list of filters, The currently entered values from Filter name and Filter string will be used. Ifany of these fields are empty, ‘twill be set to "new" Delete ‘This button deletes the selected filter. I¢ will be greyed out, if no filter is selected. Filter ‘You can select a filter from this lst (which will fill in the filter name and filter string inthe ficlds down at the bottom of the dialog box). Filter name: You can change the name of the currently selected filter here a Note! The filter name will only be used in this dialog to identify the filter for your convenience, it will not be used elsewhere. You ccan add multiple filters with the same name, but this is not very useful 2‘Working with captured packets Filter string: You can change the filter string of the currently selected filter here. Display Filter only: the string will be syntax checked while you are typing. Display Filter only: This button brings up the Add Expression dialog box ‘which assists in building filter strings. You can find more information about the Add Expression dialog in Section 6.5, “The “Filter Expression’ dialog box” OK Display Filter only: This button applies the selected filter to the current display and closes the dialog. Apply Display Filter only: This button applies the selected filter to the current display, and keeps the dialog open. Save Save the current settings in this dialog. The file location and format is explained in Appendix A, Files and Folders Close ‘Close this dialog. This will discard unsaved settings. 6.7. Defining and saving filter macros ‘You can define filter macros with Wireshark and give them labels for later use. This can save time in remembering and retyping some of the more complex filters you use. XXX - add an explanation of this. 6.8. Finding packets You can easily find packets once you have captured some packets or have read in a previously saved capeure file. Simply selec he Find Packet... mena item from the Et men. Wireshark will pop up the dialog box shown in Figure 68, “The "Find Packet” dilog box 6.8.1. The "Find Packet” dialog box Figure 6.8. The "Find Packet" dialog box One0 (a) Cem] ‘You might first select che kind of thing to search for + Display filter Simply enter a display filter string into the Filter: field, select a direction, and click on OK, For example, to find the three way handshake for a connection from host 192.168.0.1, use the following filter string: 3‘Working with captured packets For more details on display filters, see Section 6.3, “Fikering packets while viewins” + Hex Value Search fora specific byte sequence in the packet dat For example, use "00:00" to find the next packet including two null bytes inthe packet data + String Find a string in the packet data, with various options. ‘The value to be found will be syntax checked while you type it in. If the syntax check of your value succeeds, the background of the entry field will cum green, if it fails, it will tum red, ‘You can choose the search direction: + Up Search upwards in the packet list (decreasing packet numbers). + Down ‘Search downwards in the packet list (increasing packet numbers). 6.8.2. The "Find Next" command "Find Next" will continue searching with the same options used in the last "Find Packet” 6.8.3. The "Find Previous" command 'Find Previous" will do the same thing as "Find Next", but with reverse search direction, 6.9. Go to a specific packet ‘You can easily jump to specific packets with one of the menu items in the Go menu, 6.9.1. The "Go Back" command Go back in the packet his 6.9.2. The "Go Forward" command Go forward in the packet history, works much like the page history in current web browsers, 6.9.3. The "Go to Packet" dialog box Figure 6.9. The "Go To Packet" dialog box ry, orks much like the page history in current web browsers, on‘Working with captured packets 6.9.4. 6.9.5. 6.9.6. 6.10. 6.11 This dialog box will let you enter a packet number, When you press OK, Wireshark will jump to that packet The "Go to Corresponding Packet" command Ifa protocol field is to that packet | a Note! As these protocol fields now work like links Gust as in your Web browser), it’s easier to simply double-click on the field to jump to the corresponding field scted which points to another packet in the capture file, this command will jump The "Go to First Packet" command ‘This command will simply jump to the first packet displayed. The "Go to Last Packet" command ‘This command will simply jump to the last packet displayed. Marking packets ‘You can mark packets in the "Packet List” pane, A marked packet will be shown with black background, regardless of the coloring rules set, Marking a packet can be useful to find it later while analyzing in a large capture file Warning! ‘The packet marks are not stored in the capture file or anywhere else, so all packet marks will be lost if you close the capture fie ‘You can use packet marking to control the output of packets when saving/exporting/printing. To do so, an ‘option in the packet range is available, see Section 5.8, “The Packet Range frame’ “There are three functions to manipulate the marked state of a packet + Mark packet (toggle) toggles the marked state of a single packet. + Mark all displayed packets set the mark state of all displayed packets + Unmark all packets reset the mark state of all packets. ‘These mark functions are available from the "Edit" menu, and the "Mark packet (toggle)” function is also available from the pop-up menu of the "Packet List” pane. Ignoring packets You ean ignore packets in the exist in the capture file. An ignored packet will be shown with white background and gray foreground, regardless of the coloring rules set, icket List” pane, Wireshark will then pretend that this packets does not 95Working with captured packet 6.12. Warning! A The packet ignored marks are not stored inthe capture file or anywhere else, s0 all packet ignored marks will be lost if you close the capture file There are three Functions to manipulate the ignored state ofa packet + Ignore packet (toggle) togees the ignored state of a single packet + Ignore all displayed packets set the ignored state ofall displayed packets, + Un-lgnore all packets reset the ignored state of al packets These ignore functions are available from the "Edit" menu, and the "Ignore packet toggle)” function is also available from the pop-up menu of the "Packet List” pane. Time display formats and time references While packets are captured, each packet is timestamped. These timestamps will be saved to the capture file, so they will be available for later analysis, ‘A detailed description of timestamps, timezones and alike can be found at: Section 7.4, “Time Stamps” ‘The timestamp pres see Figure 3.5, “The "View" Menu” tation format and the precision in the packet list can be chosen using the View mena, ‘The available presentation formats are: + Date and Time of Day: 1970-01-01 0 che packet was captured, 03.123456 The absolute date and time of the day when + Time of Day: 01:02:03,123456 The absolute time of the day when the packet was captured. + Seconds Since Beginning of Capture: 123.123456 The time relative to the start of the capture file or the first “Time Reference” before this packet (see Section 6.12.1, "Packet time referencing”) + Seconds Since Previous Captured Packet: 1.123456 The time relative to the previous captured packet + Seconds Since Previous Displayed Packet: 1.123456 The time relative to the previous displayed packet + Seconds Since Epoch (1970-01-01): of January 1, 1970), 1234567890.123456 The time relative to epoch (midnight UTC "The available precisions (aka. the number of displayed decimal places) are: + Automatic The timestamp precision of the loaded capture file format will be used (the default). + Seconds, Deciseconds, Centiseconds, Milliseconds, Microseconds or Nanoseconds The timestamp precision will be forced to the given setting. Ifthe actually available precision is smaller, zeros will be appended. If the precision is larger, the remaining decimal places will be cut off. Precision example: If you have a timestamp and it’s displayed using, "Seconds Since Previous Packet", the value might be 1.123456, This will be displayed using the "Automatic" setting for libpeap files (which is microseconds). If you use Seconds it would show simply | and if you use Nanoseconds it shows 1.123456000. 96‘Working with captured packets 6.12.1. Packet time referencing ‘The user can set time references to packets. A time reference isthe starting point for all subsequent packet time calculations. It will be useful, if you want to see the time values relative to a special packet, ¢ the start of a new request. I¢s possible to set multiple time references in the capture file Warning! & ‘The time references wll nocbe saved permanently and willbe lost when you elose the capeure fit a Note! Time referencing will only be useful, if the time display format is set to "Seconds Since Beginning of Capture". If one of the other time display formats are used, time referencing will have no effect (and will make no sense either). ‘To work with time references, choose one of the "Time Reference” items in the "Edit" menu , see Section 3.6, “The “Edit” menu”, or from the pop-up menu of the "Packet Lis + Set Time Reference (toggle) Toggles the time rofeence state ofthe currently selected packet to on or off. + Find Next Find the nex time referenced packet in the "Packet List” pane. + Find Previous Find the previous time referenced packet in the "Packet List” pane Figure 6.10. Wireshark showing a time referenced packet, ES er Ge Coe fe Sa Ow Beeew oaxr+s Bee eot?e2 OR aa a Heder checaunOx08 corect) 7‘Working with captured packets ‘A time referenced packet will be marked with the string *REF* in the Time column (see packet number 10). All subsequent packets will show the time since the last time reference. 8Chapter 7. Advanced Topics 7.1. Introduction In this chapter some of the advanced features of Wireshark will be described, 7.2. Following TCP streams 7.2.1. If you are working with TCP based protocols it can be very helpful to see the data from a TCP stream in the way that the application layer sees it. Perhaps you are looking for passwords in a Telnet stream, or you are trying to make sense of a data steam. Maybe you just need a display filter to show only the packets of that TCP stream. If so, Wireshark’s ability to follow a TCP stream will be useful to you. Simply s the Follow TCP Stream menu item from the Wireshark Tools menu (or use the context menu in the packet list). Wireshark will set an appropriate display filter and pop up a dialog box with all the data from the ‘TCP stream laid out in order, as shown in Figure 7.1, “The "Follow TCP Stream" dialog box" CP packet inthe packet lst ofthe stream/connection you are interested in and then select A Note! =} itis worthwhitenoxing that Follow TCP Stream installs a display filter to selectall the packets 7 in the TCP stream you have sé The "Follow TCP Stream" dialog box Figure 7.1. The "Follow TCP Stream" dialog box [Gmme) Gon] cov cenraomived Tio wen Owe 0 Bx 9Advanced Topies ‘The stream content is displayed in the same sequence as it appeared on the network. Traffic from A to B is marked in red, while traffic from B to A is marked in blue. If you like, you can change these colors in the EdivPreferences "Colors" page. ‘Non: printable characters will be replaced by dots. XXX - What about line wrapping (maximum line length) and CRNL conversions? ‘The stream content won't be updated while doing a live cepture. To get the lat reopen the dialog. sontent you'll have to You can choose from the following actions: 1. Save As: Save the stream data in the currently selected format. 2. Print: Print the stream data in the currently selected format. tection: Choose the stream direction to be displayed ("Entire conversation, “data from A to B only" of "data from B to A only") 4. Filter out this stream: Apply a display filter removing the current TCP stream data from the display. 5. Close: Close this dialog box, leaving the current display filter in effect. ‘You can choose to view the data in one of the following formats: 1. ASCII: In this view you sce the data from cach direction in ASCII. Obviously best for ASCII based protocols, ¢g. HTTP. EBCDIC: For the big-iron freaks out there. 3. HEX Dump: This allows you to sce all the data, This will require a lot of sereen space and is best used with binary protocols. 4. C-Arrays: This allows you to import the stream data into your own C program, 5. Raw: This allows you to load the unaltered stream data into a different program for further examination. The display will look the same as the ASCII setting, but "Save As" will result in a binary file. 7.3. Expert Infos ‘The expert infos is a kind of log of the anomalies found by Wireshark in a capture file. ‘The general idea behind the following "Expert Info" is to have a better display of "uncommon" or just notable network behaviour. This way, both novice and expert users will hopefully find probable network problems a lot faster, compared to scanning the packet list "manually A Expert infos are only a hint! ‘Take expert infos as a hint what! of expert infos doe: Worth looking at, but not more, For example: The absence necessarily mean everything is ok! The amount of expert infos largely depends on the protocol A being used! While some common protocols like TCP/P will show detailed expert infos, most other protocols currently won't show any expert infos at all. 100Advanced Topies ‘The following will first describe the components of a single expert info, then 1 7.3.1. Expert Info Entries Each expert info will contain the following things which will be described in detail below Table 7.1. Some example expert infos Packet# —|Severity {Group __|Protocol__ {Summary 1 Note ‘Sequence [TCP Duplicate ACK (#1) Chat ‘Sequence [TCP ‘Connection | reset (RST) 8 Note ‘Sequence [TCP Keep-Alive 9 Warn ‘Sequence [TCP Fast rotransmissio (suspected) 7.3.1.1. Severity Every expert info has a specific severity level. The following severity levels are used, in parentheses are the colors in which the items will be marked in the GUL + Chat (grey): information about usual workflow, e.g. a TCP packet with the SYN flag set + Note (cyan): notable things, e.g. an application returned an “usual” error code like HTTP 404 + Warn (yellow): waming, c.g. application returned an "unusual" error code like a connection problem. ‘ror (red): serious problem, eg. [Malformed Packet 7.3.1.2. Group Tere are some common groups of expert infos. The following are currently implemented: + Checksum: a checksum was invalid + Sequence: protocol sequence suspicious, e.g. sequence wasn't continuous or a retransmission was detected or + Response Code: problem with application response code, e.g. HTTP 404 page not found + Request Code: an application request (e.g. File Handl ), usually Chat level + Undecoded: dissector incomplete or data can't be decoded for other reasons + Reassemble: problems while reassembl happened while reassembling 1g. €. not all fragments were available oF an exception + Protocol: violation of protocol specs (e.g. invalid ficld values or illegal lengths), dissection of this packet is probably continued + Malformed: malformed packet or dissector has a bug, dissection of this packet aborted, + Debug: debugging (should not occur in release versions) It's possible that more such group values will be added in the future 101Advanced Topies 7.3.1.3. Protocol The protocol in which the exper info was caused 7.3.1.4. Summary Each expert info will also have a short additional text with some further explanation. 7.3.2. "Expert Info Composite” dialog From the main menu you can open the expert info dialog, using: "Analyze/Expert Info Composite” XXX - "Analyze/Expert Info" also exists but is subject to removal and therefore not explained here XXX - add explanation of the dialogs context menu, 7.3.2.1. Errors / Warnings / Notes / Chats tabs ‘An casy and quick way to find the most interesting infos (rather than using the Details tab), is to have a look at the separate tabs for each severity level. As the tab label also contains the number of existing entries, it's easy to find the tab with the most important entries. ‘There are usually a lot of identical expert infos only differing in the pack: will be combined into a single fi number. The: file, Clicking on the plus sign shows the individual packet numbers in a tree view. 7.3.2.2. Details tab Jentical infos - with a count column showing how often they appeared in the capture ‘The Details tab provides the expert infos in a “log like” view, each entry on its own line (much like the packet list). As the amount of expert infos for a capture file can easily become very large, getting an idea ‘of the interesting infos with this view can take quite a while. The advantage ofthis tab isto have all entries in the sequence as they appeared, this is sometimes 2 help to pinpoint problems. 7.3.3. "Colorized" Protocol Details Tree Ineernet prococol, sret 192-108-2-6 (292,368.46), Ost! 224-0:0-207 (234- 0-0 102Advanced Topies 7.3.4. ‘The protocol field causing an expert info is colorized, e.g. uses a cyan background for a note severity level. This color is propagated to the toplevel protocol iter in the tree, so it's easy to find the field that ‘caused the exper info. For the example screenshot above, the IP "Time to live" value is very low (only 1), so the corresponding ‘protocol field is marked with a cyan background. To easier find that item in the packet tree, the IP protocol toplevel item is marked cyan as well “Expert” Packet List Column (optional) ‘An optional "Expert Info Severity” packet list column is available (since SVN 22387 -> 0.99.7), that displays the most significant severity of a packet, or stays empty if everything seems ok. Tais column is not displayed by default, but can be easily added using the Preferences Columns page described in Section 10.5, “Preferences 7.4. Time Stamps 7.41. ‘Time stamps, their precisions and all that can be quite confusing. This section will provide you with information about what's going on while Wireshark processes time stamps, While packets are captured, each packet is time stamped as it comes in. These time stamps will be saved to the capture file, so they also will be available for (later) analysis, ‘So where do these time stamps come from? While capturing, Wireshark gets the time stamps from the bpcap (WinPcap) library, which in tum gets them from the operating system kernel. Ifthe capture data is loaded from a capture file, Wireshark obviously gets the data from that fie, Wireshark internals ‘The internal format that Wireshark uses to keep a packet time stamp consists of the date (in days since 11.1970) and the time of day (in nanoseconds since midnight). You can adjust the way Wireshark displays the time stamp deta inthe packet lis, see the "Time Display Format” item in the Section 3.7, “The "View" menu” for details ‘While reading or writing capture files, Wireshark converts the time stamp data between the capture file format and the internal format as required. While capturing, Wireshark uses the libpcap (WinPcap) capture library which supports microsecond resolution. Unless you are working with specialized capturing hardware, this resolution should be adequate. 103Advanced Topies 7.4.2. 7.4.3. Capture file formats Every capture file format that Wireshark knows supports time stamps. The time stamp precision supported by a specific capture file format differs widely and varies from one second “ '0.123456789". Most file formats store the time stamps with a fixed precision (e.g. microseconds), while some file formats are even capable of storing the time stamp precision itself (whatever the benefit may be) to one nanosecond ‘The common libpeap capture file format that is used by Wireshark (and a lot of other tools) supports a 123456" only. fixed microsecond resolution | A Note! Writing data into @ capture file format that doesn't provide the capability to store the actual precision will lead to loss of information. Example: If you load a capture file with nanosecond resolution and store the capture data to a Hbpeap file (with microsecond resolution) Wireshark obviously must reduce the precision from nanosecond to microsecond Accuracy It's often asked: "Which time stamp accuracy is provided by Wireshark?”. Well, Wireshark doesn't create any time stamps itself but simply gets them from "somewhere else" and displays them, So accuracy will depend on the capture system (operating system, performance, ..) that you use, Because ofthis, the above {question is difficult to answer in a general way | A Note! USB connected network adapters often provide a very bad time stamp accuracy. The have to take "a long and winding road” to travel through the USB cable el. As the incoming pack e stamped when they are stamping mechanism becomes very inaccurate. incoming pac until they actually reach the ker processed by the kernel, this tim are tim Conclusion: don't use USB connected NICs when you need precise time stamp accuracy! (XXX - are there any such NIC's that generate time stamps on the USB hardware?) 7.5. Time Zones Ifyou around the world time zones wel across the planet, time zones ean be confusing. If you get a eapture file from somewhere sn even be a lot more confusing ;-) First of al, there are two reasons why you may not need to think about time zones at al: se only interested inthe time differences between the packet time stamps and don’t need to know ve of the captured packets (which is o en the ease) + You don’t get capture files from different ti Jones than your own, so there are simply no time zone mis working in the same time zone as yourself. problems. For example: everyone in your 108Advanced Topies ‘What are time zones? People expect that the time reflects the sunset. Dawn should be in the morning maybe around 06:00 and dusk in the evening maybe at 20:00. These times will obviously vary depending on the season It would be very confusing if everyone on carth would use the same global time as this would correspond to the sunset only at a small part of the world For that reason, the earth is split into several different time zones, each zone with a local time that corresponds to the local sunset. The time zone’s base time is UTC (Coordinated Universal Time) or Zulu Time (military and aviation). The older term GMT (Greenwich Mean Time) shouldn't be used as itis slightly incorrect (upt009 seconds difference to UTC). The UTC base time equals to 0 (based at Greenwich, England) and all time zones have an offsct to UTC between -12 to +14 hours! For example: If you live in Berlin you are in a time zone one hour earlier than UTC, so you are in time zone "+1" (ime difference in hours compared to UTC). If it's 3 clock in Berlin it’s? o'clock in UTC “at the same moment" Be aware that ata few places on earth dont use time zones with even hour offsets (e.g. New Delhi uses UTC+05:30)! Farther information can be found at: _http:/en.wikipedia.ors/wiki/Time zone and _http.// cn.wikipedia.org/wiki/Coordinated Universal Time. ‘What is daylight saving time (DST)? Daylight Saving Time (DST), ulso known as Summer Time, is intended to "save" some daylight during the summer months. To do this lot of countries (but not all!) add a DST hour to the already existing UTC offset. So you may need to take another hour (or in very rare cases even two hours!) difference into your "time zone calculations”. Unfortunately, the date at which DST actually takes effect is different throughout the world. You ‘may also note, that the northern and southem hemispheres have opposite DST's (c.g. while it's summer in Europe it's winter in Australia. Keep in mind: UTC remains the same all year around, regardless of DST! Farther information can be found at:_hitp://en. wikipedia org/wiki/Daylight saving Further time zone and DST information can be found at: htp://wwp.ereenwichmeantime.com/ and bsp:/! www.timeanddate.com/worldelock 7.5.1. Set your computer's time correctly! If you work with people sround the world it's very helpfol to set your computer's time and time zone right. You should set your computers time and time zone in the correct sequence: 1. Set your ime zone to your current location 2. Set your computer's clock tothe local time ‘This way you will ell your computer both the local time and also the time offset to UTC. 105Advanced Topies Tip! Ifyou travel around the world, its an often made mistake to adjust the hours of your computer clock to the local time. Don't adjust the hours but your time zone setting instead! For your Computer, the time is essentially the same as before, you are simply in a different time zone with a different local time! Tip! {You can use the Network Time Protocol (NTP) to automatically adjust your computer to the correct time, by synchronizing it to Intemet NTP clock servers. NTP clients are available for all operating systems that Wireshark supports (and for a lot more), for examples see: htip:// www.ntp orgl. 7.5.2. Wireshark and Time Zones So what's the relationship between Wireshark and time zones anyway? Wireshark’s native capture file format (libpcap format), and some other capture file formats, such as the Windows Sniffer, EtherPeck, AiroPeek, and Sun snoop formats, save the arrival time of packets as UTC values. UN*X systems, and "Windows NT based” systems (Windows NT 4.0, 2000, XP, Server 2003, Vista, Server 2008) represent time internally as UTC. When Wireshark is capturing, no conversion is necessary. However, if the system time zone is not set correctly, the system's UTC time might not bbe correctly set even if the system clock appears to display correct local time. "Windows 9x based! systems (Windows 95, Windows 98, Windows Me) represent time internally as local time. When capturing, WinPeap has to conver the time to UTC before supplying it co Wireshark. If the system's time zone is not set correctly, that conversion will not be done correctly. Other capture file formats, such as the Microsoft Network Monitor, DOS-based Sniffer, and Network Instruments Observer formals, save the arrival time of packets as local time values, Internally to Wireshark, time stamps are represented in UTC; this means that, when reading capture files that save the arrival time of packets as local time values, Wireshark must convert those local time values 10 UTC values. ‘Wireshark in turn will display the time stamps always in local time. ‘The displaying computer will convert them from UTC to local time and displays this (local) time. For capture files saving packets as UTC values, this means thatthe arrival time will be displayed as the local time in your time zone, which might not be the same as the arrival time in the time zone in which the packet was captured, For capture files saving the arrival time of packets as local time values, the conversion to UTC will be done using your time zon correctly; the conversion back to local time for display might undo this correctly, in which case the arrival ‘ime will be displayed as the arrival time in which the packet was captured. ¢ arrival time of | offset from UTC and DST rules, which means the conversion will not be done Table 7.2. Time zone examples for UTC arrival times (without DST) [Los Angeles |New York Madrid {London _ {Berlin Tokyo Capture File] 10:00 10:00 10:00 10:00 10:00 10:00 (Te) Local Offset|-8 3 ct 0 a 39 toUTC Displayed [02:00 05:00 09:00 10:00 11:00 19:00 Time (Local! Time) 106Advanced Topies ‘An example: Let's assume that someone in Los Angeles captured a packet with Wireshark at exactly 2 ‘o'clock local time and sends you this capture file, The capture file's time stamp will be represented in UTC as 10 o¢lock, You are located in Berlin and will sce 11 o'clock on your Wireshark display, "Now you have a phone call, video conference or Internet meeting with that one to talk about that capcure file. As you are both looking at the displayed time on your local computers, the one in Los Angeles still sees 2 o'clock but you in Berlin will sec 11 o'clock. The time displays are different as both Wireshark displays will show the (different) local times at the same point in time. Conclusion: You may not bother about the date/time of the time stamp you currently look at, unless you ‘must make sure that the date/time is as expected. So, if you get a capture file from a different time zone andi ‘or DST, you'll have to find out the time zone/DST difference between the two local times and “mentally adjust” the time stamps accordingly. In any case, make sure that every computer in question hes the correct ‘time and time zone setting. 7.6. Packet Reassembling 7.6.1. 7.6.2. What is it? Network protocols often need to transport large chunks of data, which are complete in themselves, ¢.g. ‘when wansferring a file. The underlying protocol might not be able to handle that chunk size (c.g imitation of the network packet size), or is stream-based like TCP, which doesn't know data chunks at all. In that case the network protocol has to handle the chunk boundaries itself and (if requited) spread the data over multiple packets, It obviously also needs a mechanism to determine the chunk boundaries on the receiving side, Tip! Wireshark calls this mechanism ree ‘might use a different term for this (e.g. desegmentation, defragmentation, ... How Wireshark handles it embling, although a specific protocol specification For some of the network protocols Wireshark knows of, a mechanism is implemented to find, decode and display these chunks of data. Wireshark will try to find the corresponding packets of this chunk, and will show the combined data as additional pages in the "Packet Bytes" pane (For information about this pane, see Section 3.19, “The "Packet Bytes" pane”) Figure 7.2. The "Packet Bytes” pane with a reassembled tab | A Note! Reassembling might take place at several protocol layers, so i's possible that multiple tabs inthe "Packet Bytes" pane appear | A Note! ‘You will find the reassembled data in the lest packet of the chunk. 107Advanced Topies ‘An example: In « HTTP GET response, the requested data (e.g. an HTML page) is returned, Wireshark will show the hex dump of the data in a new tab "Uncompressed entity body" in the "Packet Bytes” pane. Reassembling is enabled in the preferences by default. The defaults were changed from disabled to enabled in September 2005. If you created your preference settings before this date, you might look ifreassembling is actually enabled, as it can be extremely helpful while analyzing network packets. ‘The enabling or disabling of the reassemble settings of a protocol typically requires two things: 1. the lower level protocol (c.g., TCP) must support reassembly. Often this reassembly cam be enabled or disabled via the protocol preferences. the higher level protocol (¢.g., HTTP) must use the reassembly mechanism to reassemble fragmented protocol data, This too can often be enabled or disabled via the protocol preferences. ‘The tooltip of the high also has to be considered, 7.7. Name Resolution Name resolution tries to resolve some of the numerical address values into @ human readable format. ‘There are two possible ways to do these conversations, depending on the resolution t be done: calling system/network services (like the gethostname function) and/or evaluate from Wireshark specific ‘configuration files, For details about the configuration files Wireshark uses for name resolution and alike, pendix A, Files and Folders. The name resolution feature can be en-/disabled separately forthe protocol layers of the following sections 7.7.1. Name Resolution drawbacks Name resolution can be invaluable while working with Wireshark and may even save you hours of work. Unfortunately, it also has its drawbacks. level protocol setting will notify you if and which lower level protocol setting + Name resolution will often fail. The name to be resolved might simply be unknown by the name servers asked or the servers are just not available and the name is also not found in Wireshark’s, configuration files. + The resolved names are not stored in the capture file or somewhere else. So the resolved names ‘might not be available if you open the capture file later or on a different machine. Each time you open a capture file it may look “slightly different”, maybe simply because you can't connect to a name server (which you could connect before. + DNS may add additional packets to your capture file. You may see packets to/from your machine in your capture file, which are caused by name resolution network services of the machine Wireshark captures from. XXX - are there any other such packets than DNS ones? + Resolved DNS names are cached by Wireshark. This is required for acceptable performance. However, if the name resolution information should change while Wireshark is running. Wireshark ‘won't notice a change to the name resolution information once it gets cached. If this information changes while Wireshark is running, e.g. a new DHCP lease takes effect, Wireshark won't notice it. XXX - is this true for all or only for DNS info? ip! 9 The name resolution in the packet list is done while the list is filled. If a name could be resolved after a packet was added tothe list, that former entry won't be changed. As the name 108Advanced Topies 7.7.2. 7.7.3. 7.7.4. resolution results are cached, you can use "View/Reload” to rebuild the packet list, this time with the correctly resolved names. However, ths isnt possible while « capture is in progre Ethernet name resolution (MAC layer) ‘Try to resolve an Ethernet MAC address (e.g. 00:09:5:01:02-03) to something more "hum: readable” ARP name resolution (system service): Wireshark will ask the operating system to convert an Ethernet adress to the corresponding IP address (c.g. 00:09:5b:01:02:03 -> 192.168.0.1). Ethernet codes (ethers file): If the ARP name resolution failed, Wireshark tries to convert the Ethernet address to a known device name, which has been assigned by the user using an ethers file (e.g. (00:09:5b:01:02:03 -> homerouter). Ethernet manufacturer codes (manuf file): If neither ARP or ethers returns a result, Wireshark tries to convert the first 3 bytes of an ethernet address to an abbreviated manufacturer name, which has been assigned by the IEEE (e.g. 00:09:5b:01:02:03 -> Netgear_01:02:03). IP name resolution (network layer) ‘Try toresolve an IP address (e.g. 216.239.3799) to something more “human readable DNS/ADNS name resolution (system/library service): Wireshark will ask the operating system (or the ADNS library), to convert an IP address to the hostname associated with it (e.g. 216.239.37.99 -> www. | google.com). The DNS service is using synchronous calls to the DNS server. So Wireshark will stop responding until a response to a DNS request is returned. If possible, you might consider using the ADNS library (which won't wait for a network Warning! & Enabling network name resolution when your name server is unavailable may significantly slow down Wireshark while it waits for all of the name server requests to time out, Use ADNS in that case. yonse), DNS ys. ADNS: here's @ short comparison: Both mechanisms are used to convert an TP address to some ‘human readable (domain) name, The usual DNS call gethostname() will try to convert the address to a ‘name. To do this, it will frst ask the systems hosts file (e.g. /ete/hosts) if it finds a matching entry. If that fails, it will ask the configured DNS server(s) about the name. So the real difference between DNS and ADNS comes when the system has to wait for the DNS server about a name resolution. The system call gethostname() will wait until a name is resolved or an error ‘occurs. Ifthe DNS server is unavailable, this might take quite a while (several seconds). The ADNS service will work a bit differently. It will also ask the DNS server, return to Wireshark in a very short umount of time. ‘The actual (and the following) address fields won't show the resolved name until the ADNS call returned. As mentioned above, the values get cached, so you ‘but it won't wait for the answer. It will just ccan use View/Reload to "update" these fields to show the resolved values. hosts name resolution (hosts file): If DNS name resolution failed, Wireshark will try to convert an IP address to the hostname associated with it, using a hosts file provided by the user (e.g. 216.239.37.99 - > www.google.com). IPX name resolution (network layer) ipxnet name resolution (ipxnets file): XXX - add ipxnets name esolution explanation 109Advanced Topies 7.7.5. TCP/UDP port name resolution (transport layer) ‘Try to resolve a TCP/UDP port (eg. 80) to something more "human readable”, ‘TCP/UDP port conversion (system service): Wireshark will ask the operating system to convert a TCP ‘or UDP port to its well known name (e.g. 80 -> hp) XXX - mention the role of the /ete/services file (but don't forget the files and folders section)! 7.8. Checksums Several network protocols use checksums to ensure data integrity. Tip! {F —_Applying checksums as described here is also known as redundancy checking, What are checksums for? ‘Checksums are used to ensure the integrity of data portions for data transmission or storage. A checksum is basically a calculated summary of such a data portion, ‘Network data transmissions often produce errors, such as toggled, missing or duplicated bits. As a result, the data received might not be identical to the data transmitted, which is obviously a bad thing. Because of these transmission errors, network protocols very often use checksums to detect such ‘errors. The transmitter will calculate a checksum of the data and transmits the data together with the ‘checksum. The receiver will calculate the checksum of the received data with the same algorithm as the transmitter. If the received and calculated checksums don't match a transmission error has ‘occurred, Some checksum algorithms are able to recover (simple) errors by calculating where the expected ‘error must be and repairing it. If there are errors that cannot be recovered, the receiving side throws away the packet. Depending ‘on the network protocol, this data loss is simply ignored or the sending side needs to detect this loss somehow and retransmits the required packet(s). Using a checksum drastically reduces the number of undetected transmission errors. However, the ‘usual checksum algorithms cannot guarantee an error detection of 100%, so a very small number Of transmission errors may remain undetected. ‘There are several different kinds of checksum algorithms; an example of an often used checksum algorithm is CRC32. The checksum algorithm actually chosen for a specific network protocol will ‘depend on the expected error rate of the network medium, the importance of error detection, the ‘processor load to perform the calculation, the performance needed and many other things. Further information about checksums can be found at: http://en, wikipedia org/wiki/Checksum, 7.8.1. Wireshark checksum validation Wireshark will validate the checksums of several protocols, ¢g.:IP, TCP, UDP, 110Advanced Topies 7.8.2. {It will do the same calculation as a "normal receiver" would do, and shows the checksum packet details with a comment, ¢.: [correct] [invalid, must be 0x12345678] or alike. lds in the ‘Checksum validation can be switched off for various protocols in the Witeshark protocol preferences, ¢. to (very slightly) increase performance. If the checksum validation is enabled and it detected an invalid checksum, features like packet reassembling won't be processed. This is avoided as incorrect connection data could "confuse" the internal database, Checksum offloading ‘The checksum calculation might be done by the network driver, protocol driver or even in hardware For example: The Ethernet transmitting hardware calculates the Ethernet CRC32 checksum and the receiving hardware validates this checksum. Ifthe received checksum is wrong Wireshark won't even see the packet, as the Ethernet hardware internally throws away the packet. Higher level checksums are “traditionally”: packet is then handed over to the hardware, tulated by the protocol implementation and the completed Recent network hardware can perform advanced features such as IP checksum calculation, also known as checksum offloading. The network driver won't calculate the checksum itself but will simply hand over an empty (zero or garbage filled) checksum field to the hardware. | A Note! Checksum offloading often causes confusion as the network packets to be transmitted are handed over to Wireshark before the checksums are actually calculated, Wireshark gets these “empty checksums and displays them as invalid even though the packets will contin valid checksums when they leave the network hardware later. Checksum offloading can be confusing and having 2 lot of [invalid] m {quite annoying, As mentioned above, analysis ofthe pacl wages on the screen can be invalid checksums may lead to unreassembled packets, making the et data much harder, You can do two things to avoid this checksum offloading problem: + Tum off the checksum offloading in the network driver, if this option is available, + Tum off checksum validation of the specific protocol in the Wireshark preferences. iLChapter 8. Statistics 8.1. Introduction Wireshark provides a wide range of network statistics which can be accessed via the Statistics menu, ‘hese statistics range from general information about the loaded capture file (like the number of caprured packets), to statistics about specific protocols (eg. statistics about the number of HTTP requests and responses captured). General statistics: + Summary about the capture file. + Protocol Hierarchy of the captured packets. + Conversations e.g. trafic between specific IP addresses. + Endpoints eg. traffic to and from an IP addresses + 10 Graphs visualizing the numberof packets (or similar in time Protocol specific statistics: + Service Response ‘Time between request and response of some protocols. + Various other protocol specific statistics. [7 Note! ——! the protocol specific statistics requires detailed knowledge about the specific protocol. Unless you are familiar with that protocol, statistics about it willbe pretty hard to understand, 8.2. The "Summary" window General statistics about the current capture file. 12Statistics Figure 8.1. The "Summary" window Name omebstightp eae Leth 1713604 bes Ferma esha pep Packet ie et essis bas Fist packet 2e07-1-20 204042 Last packet 2007-1120 2050214 copure ace a0 Dropped packets nbn Coptre er: one ‘ia fer: repo drs Yale Captured | Ouplayed | arkad ug packateee soso sas eg packet sie apr bes 873507 bes ones emese 242i rg bytes 513087 072021 na Mouse ons 0086 [ou | ‘+ File: general information about the capture file ‘+ Time: the timestamps when the first and the last packet were captured (and the time between them). + Capture: information from the time when the capture was done (only available if the packet data was captured from the network and not loaded from & file). + Display: some display related information, + ‘Traffic: some statistics of the network traffic scen. If display filter is set, you will see values in the Captured column, and if any packages are marked, you will see values in the Marked column. The values in the Captured column will remain the same as before, while the valucs in the Displayed column will reflect the values corresponding to the packets shown in the display. The values in the Marked column will reflect the values corresponding to the marked packages. 8.3. The "Protocol Hierarchy" window ‘The protocol hierarchy of the captured packets. 13Statistics Figure 8.2. The "Protocol Hierarchy" window Diy fier: tp or re [rotoct ‘Packets Packets Bytes MOLIs End Pockets Endites| End MOIS © ethane 000k 267 211211 006 © 8 ote “© anemison Corre rates sem 242 207029 01 4s uss ood Line bated tot data 22m 1212265 0405, 2 oes PEGE nterchange Format 027% 1-990 0000, 1 000 ertensbleMarup Language 027% == 714 0000, 1 74 oo ‘© User Datagrm Prtacl ese 24 ana 02 ny) This is a ree of all the protocols in the capture. You can collapse or expand subtrees, by clicking on the plus / minus icons. By default, all tees are expanded. Each row contains the statistical values of one protocol. The Display filter will show the current display filter. ‘The following columns containing the statistical values are available: Protocol: this protocols name “e Packets: the percentage of protocol packets, relative tall packets in the capture Packets the absolute number of packet ofthis protocol Bytes: che absolute numberof bytes ofthis protocol MB/s: che bandwidth of this protocol, relative to the caprure time End Packets: the absolute number of packets of this protocol (where this protocol was the highest protocol to decode) End Bytes: the absolute number of bytes of this protocol (where this protocol was the highest protocol to decode) End MBits: the bandwidth of this protocol, relative tothe capture time (where this protocol was the highest protocol to decode) Note! Packets will usually contain multiple protocols, so more than one protocol will be counted for ceach packet. Example: In the screenshot IP has 99,17% and TCP 85,83% (which is together ‘much more than 100%). ieStatistics A Note! Protocol layers can consist of packets that won't contain any higher layer protocol, so the sum of all higher layer packets may not sum up to the protocols packet count. Example: In the screenshot TCP has 85,83% but the sum of the subprotocols (HTTP, ..) is much less. ‘This may de caused by TCP protocol overhead, e.g. TCP ACK packets won't be counted as packets ofthe higher layer). | A Note! ‘A single packet can contain the same protocol more than once. In this ease, the protocol is counted more than once. For example: in some tunneling configurations the IP layer can appear twice. 8.4. Conversations ‘Statistics of the captured conversations. 8.4.1. What is a Conversation? ‘A network conversation is the traffic between two specific endpoints. For example, an IP conversation is all the traffic between two IP addresses. The description of the known endpoint types can be found in Section 8.5.1, “What is an Endpoint?”. 8.4.2. The "Conversations" window ‘The conversations window is similar to the endpoint Window; see Section 8.5.2, “The "Endpoints" window” for a description of their common features. Along with addresses, packet counters, and byte ‘counters the conversation window adds four columns: the time in seconds between the stat of the capture and the start of the conversation ("Rel Start", the duration ofthe conversation in seconds, and the average bits (not bytes) per second in each direction Figure 8.3. The "Conversations" window hat ‘alemns oan eae = Joona] [Addoss A Por A |Adirss Por Packets | Byes” Packte AB tee ADB Packets Ac 1021158 3 43305 ep 2 1956 . or not Selected 197, find Packet + cand Slates la Nae erosion Lr oly ther 15Statistics 8.4.3. Each row in the list shows the statistical values for exactly one conversation, [Name resolution will be done if selected in the window and if it is active for the specific protocol layer (MAC layer for the selected Ethernet endpoints page) Limit to display filter will only show conversations matching the current display filter ‘The copy button will copy the list values to the clipboard in CSV (Comma Separated Valucs) format Tip! '%_—__ This window will be updated frequently, soit will be useful, even if you open it before (or while) you are doing alive capture. The protocol specific "Conversation List" windows Before the combined window described above was available, ch ofits pages was shown as a separate window. Even though the combined window is much more convenient to use, these separate windows are still available, The main reason is that they might process faster for very large c: the functionality is exactly the same as in the combined window, they won't be discussed in detail here. cure files, However, as 8.5. Endpoints 8.5.1. Statistics ofthe endpoints captured Tip! Ifyou are looking for a feature other network tools call a hostlist, here is the right place to Took. The list of Ethernet or IP endpoints is usually what you're looking for. What is an Endpoint? A network endpoint is the logical endpoint of separate protocol traffic of a specific protocol layer. The ‘endpoint statisties of Wireshark will take the following endpoints into account: + Ethernet; an Ethernet endpoint is identical to the Ethemet’s MAC address. + Fi yre Channel: XXX - insert info here. + FDDI: a FDDI endpoint is identical to the FDDI MAC address. + IPv4: an IP endpoint is identical to its IP address. + IPX: an IPX endpoint is concatenation of a 32 bit network number and 48 bit node address, be default we Ethernets! MAC address + SXTA: aJXTA endpoint is @ 160 bit SHA-I URN. + NCP: XXX + insert info here + RSVP: XXX - insert info here. + SCTP: a SCTP endpoint is a combination of the host IP addresses (plural) and the SCTP port used, So different SCTP ports on the same IP address are different SCTP endpoints, but the same SCTP port on different IP addresses of the same host are still the same endpoint. 116Statistics ‘+ TCP: a TCP endpoint is a combination of the IP address and the TCP port used, o different TCP ports con the same IP address are different TCP endpoints, + Token Ring: a Token Ring endpoint is identical to the Token Ring MAC address. ‘+ UDP: a UDP endpoint is a combination of the IP address and the UDP port used, so different UDP ports on the same IP address are different UDP endpoint. + USB: XXX - insert info here. + WLAN: XXX - insert info here. A Broadcast / multicast endpoints Broadcast / multicast traffic will be shown separately as additional endpoints. Of course, as these endpoints are virtual endpoints, the real traffic will be received by all (multicast: some) of the listed unicast endpoints 8.5.2. The "Endpoints" window ‘This window shows statistics about the endpoints captured. Figure 8.4, The "Endpoints" window Fier het or ens deuce Pasiote Bytes Tinsdente” Tebjtae Reboekote me Djoe frien 6 Tai Propare ater | Not tigaisa%0 7 Mi fndtcwme | «and Salada 58 colrze wow mate or Selected Tosasvio7s3 + 2 Toa ~-andne Sleted a Nae esoiion a Lr to sly ther On For each supported protocol, a tab is shown in this window. Each tab label shows the number of endpoints ‘captured (e.g. the tab label "Ethernet: 5" tells you that five ethernet endpoints have been captured). If no ‘endpoints of a specific protocol were captured, the tad label will be greyed out (although the related page ‘can stil be selected). Each row in the list shows the statistical values for exactly one endpoint. ‘Name resolution will be done if selected in the window and if itis active for the specific protocol layer (MAC layer for the selected Ethernet endpoints page). As you might have noticed, the first row has @ name resolution ofthe first three bytes "Netgear", the second row’s address was resolved to an IP address (using 17Statistics ARP) and the third was resolved to a broadcast (unresolved this would sil be: FFE: CEE EE 10; the last two Ethernet addresses remain unresolved. Limit to display filter will only show conversations matching the current display fle. ‘The copy button will copy the list values to the clipboard in CSV (Comma Separated Values) format, Tip! 'J This window will be updated frequently, s it will be useful, even if you open it before (or hile) you are doing a ive capture 8.5.3. The protocol specific "Endpoint List" windows Before the combined window described above was availabe, cach of is pages was shown as a separate ‘window. Eventhough the combined window is much more convenient ose, these separate windows are still available. The main reason is that they might process faster for very large capture files. However, as the functionality is exactly the same as in the combined window, they won't be discussed in detail here. 8.6. The "IO Graphs" window User configurable graph of the captured network packets. You can define up to five differently colored graphs. Figure 8.5. The "IO Graphs" window “ek etenal{ see (eek ee [iter (See com [ee | Puatepectks [10 [sro 3} co eer [ ai (cron) corer une: [paca] [cron co Blower] scale: [ate 13] Que sony |{ Esme |[ ‘The user can configure the following things: + Graphs + Graph 1-5: enable the specific graph 1-5 (only graph | is enabled by default) + Color: the color ofthe graph (cannot be changed) 118Statistics Filter: a display filter for this graph (only the packets that pass this filter will be taken into account for this graph) + Style: the style ofthe graph (Line/Impulse/FBar/Dot) +X Axi ‘Tick interval: an interval in x direction lasts (10/1 minutes or 10/1/0.1/0.01/0.001 seconds) Is per tick: use 10/5/2/1 pixels per tick interval ‘View as time of day: option to view x direction labels as time of day instead of seconds or minutes since beginning of capture + Y Axis Unit: the unit for the y direction (Packets/Tick, Bytes/Tick, Bits/Tick, Advanced...) [XXX describe the Advanced feature.] Seale: the scale for the y unit (Logerithmic,Auto,10,20,50,100,200,500,..) ‘The save button will save the currently displayed portion of the graph as one of vatious file formats. The save feature is only available when using GTK version 2.6 or higher (the latest Windows versions comply With this requirement) and Wireshark version 0.99.7 or higher. ‘The copy button will copy values from selected graphs to the clipboard in CSV (Comma Separated Values) format. The copy feature is only available in Wireshark version 0.99.8 or higher. Tip! "Click in the graph to select the first package in the selected interval 8.7. Service Response Time ‘The service response time is the time between a request and the corresponding response. This information is available for many protocols. Service response time statistics are currently available for the following protocols: + DCE. RI + Fibre Channel + 1225 RAS + Loar + LTEMAC + MGce + ONC-RPC + SMB 119Statistics ‘As an example, the DCE-RPC service response time is described in more detail | A Note! ‘The other Service Response Time windows will work the same way (or only slightly different) compared to the following description. 8.7.1. The "Service Response Time DCE-RPC” window ‘The service response time of DCE-RPC is the time between the request and the corresponding response. First of al, you have to select the DCE-RPC interface: Figure 8.6. The "Compute DCE-RPC statistics" window ‘You can optionally set a display filter, to reduce the amount of packets. Figure 8.7. The "DCE-RPC Statistic for ..." window Each row coresponds to a method of the interface selected (so the EPM interface in version 3 has 7 methods), For each method the number of calls, and the statistics of the SRT time is calculated, 8.8. WLAN Traffic Statistics Statistics of the captured WLAN traffic. This window will summarize the wireless network traffic found in the capture. Probe requests will be merged into an existing network if the SSID matches. 120Statistics Figure 8.8. The "WLAN Traffic Statistics" window wn rae static sso ___|Giemel|ss0 econ DatPsats_ rib oq_obe ep Ath enh tar Pct motion a aaa [err Sry | (Edam Each row in the list shows the statistical values for exactly one wireless network. [Name resolution will be done if selected in the window and if itis active for the MAC layer. ‘Only show existing networks will exclude probe requests with a SSID not matching any network from the list ‘The copy button will copy the list values to the clipboard in CSV (Comma Separated Values) format Tip! This window will be updated frequently, so it willbe useful, even if you open it before (or while) you are doing alive eapeare 8.9. The protocol specific statistics windows ‘The protocol specific statistics windows display detailed information of specifie protocols and might be described in a Tater version of this document. ‘Some of these statistics are described at che http//wiki wireshark org/Statistics pages. 12Chapter 9. Telephony 9.1. Introduction Wireshark provides a wide range of telephony related network statistics which can be accessed via the ‘Telephony menu. ‘These statistics range from specific signaling protocols, to analysis of signaling and media flows. If «encoded in a compatible encoding the media flow can even be played. 9.2. RTP Analysis ‘The RTP analysis function takes the sclected RTP stream (and the reverse stream, if possible) and generates alist of statistics on it Figure 9.1. The "RTP Stream Analysis" window ey Forward econ | Analysing stream from 10:13.143 pert $000 to 10.1618 prt 2006 SSRC = OxDEEDEESE ir [rceeasete |stewinss Pew [war [stots 0.0 0.03 448 ok 3013 0.0 010 72 ok) $9136 3011 0.02 021 a9 ok) $9137 3011 0.02 032 1120 (oe) 59138 30.18 0.03, 051 1344 ok) 2073 0. 076 1568 ok) 2999 0.10 077 92 ok) 2988 0.10 o7e 2016 ok) ‘Max deta = 34,83 me at packet no, 274 ‘Max ter = 0.83 me, Mean ter = 0.37 me Max skew =-4.14 me ‘TaalRTP packets = 235 (expected 236) Lost ATP packets = 0 (0.00%) Sequence errors = 0 Duration 7.05 s (-60 ms clock ait, corresponding to 7932 He (0.85%) Sem pofoad..| sam eecsv...| fQaeresh | eopmete | Graph on ‘Starting with basic data as packet number and sequence number, further statistics are created based on arrival time, delay, jitter, packet size, etc. Besides the per packet statistics the lower pane shows the overall statistics, with minimums and maximums for delta jitter and clock skew. Also an indication of lost packets is included, ‘The RTP Stream Analysis window further provides the option to save the RTP payload (as raw data or, ifin ‘a PCM encoding, in an Audio file). Other options a to export and plot various statistics on the RTP streams. 9.3. VoIP Calls ‘The VoIP Calls window shows a list of all detected VoIP calls in the captured traffic. It finds calls by their signaling. 122Telephony More details are described at the http: //wiki,wireshark org/VoIP_calls page. 9.4. LTE MAC Traffic Statistics ‘Statstis of the captured LTE MAC traffic. This window will summarize the LTE MAC traffic found in the capture. Figure 9,2. The "LTE MAC Traffic Statistics" window ech Frames 0 wcnsyes 0 Pon Frames 0 Powys 0 ‘UUDLSOH data 20 UE) [UL Frames] Bs] ORE Emr Ut ReTX Fames] Ox amet] Bes] OL GRC Enon DU RTE Panes] ‘The top pane shows statistics for common channels. Each row in the middle pane shows statistical highlights for exactly onc UE/C-RNTI. In the lower pane, you can sec the for the currently selected UEY C-RNTI the traffic broken down by individual channel 9.5. LTE RLC Traffic Statistics ‘Statistics of the captured LTE RLC waffic, This window will summarize the LTE RLC waffic found in the capture. 123Telephony Figure 9,3. The "LTE RLC Traffic Statistics" window [ue | Oc res] OL Be] Mode] OL Famer Os] UL NER | U NNER BL Framer [BL Byes] BLACK [BU NACKE Se1U diay efor ts chanel | Set dspay er fortis chanel) Set OL pay er for is char! Orer Ocise “At the top, the check-box allows this window to include RLC PDUs found withing MAC PDUs or not. ‘This will affect both the PDUs counted as well as the display filters gencrated (see below). ‘The upper list shows summaries of each active UE. Each row in the lower list shows statistical highlights for individual channels within the selected UE. ‘The lower par of the windows allows display filters to be generated and set forthe selected channel, Note that in the case of Acknowledged Mode channels, if a single direction is chosen, the generated filter will show data in that direction and control PDUs in the opposite direction, 9.6. The protocol specific statistics windows ‘The protocol specific statistics windows display detailed information of specific protocols and might be described in a later version of this document. ‘Some of these statistics are described at the htt://wiki wireshark.ors/Statistis pages, 124Chapter 10. Customizing Wireshark 10.1. Introduction Wireshark’s default bebaviour 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 10.2. 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 linc. Wireshark supports a large number of command line parameters. To sce what they ar, simply enter the ‘command wireshark -h and the help information shown in Example 10.1, “Help informstion available from Wireshark” (or something similar) shouldbe printed 125Customizing Wireshark Example 10.1, Help information available from Wireshark See Nltp://wwxireshark-org for more informal ion copyright 1996-2009 Cereld Combe and contetbutors Tf einterEace> ome oF fae of interface (def: Cizst non toopback) ackst snapshot Lengih (det: 63535) start capturing immediately (del: do nothing! Sh cbutter sizes size of kernel buffer (def: IMB) “y Link layer type (del: fizst appropriate) Te cpacket count slop after f packets (def: infinite! ep sintite> sel the fitenane Uo read from (no pipes or stain!) =n Uisable all nome resolutions (del! ll enabled) ON cnome resolve (lage> enable specific mane resolution (s]: "aRlcy “3 Specify a criterion that specifies when Wireshark is to stop writing toa 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 elaps filesive:value Stop writing to a capture file afterit reaches asize of valuc kilobytes (where akilobyteis 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 writen, -b If a maximum capture file size was specified, this option causes Wireshark to run in "ring buffer” mode, withthe specified number of files. In "ting 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 tothe next file, until it fills up the last file, at which point ill discard the data in the first file (unless 0 is specified, in which case, the numberof files is unlimited) and star waiting to that file and so on, If the optional duration is specified, Wireshark will also switch to the next file when the specified number of seconds has elapsed even if the current file is not completely fill 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 ile after value umber of files were written (form @ ring buffer) -B 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 127Customizing Wireshark -c -f “8 “J jump filter> This option specifies the maximum number of packets to capture when capturing live data, It would be used in conjunction with the -k option 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 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, here 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 nctwork capture must be run from an account with special privileges (for example, as root) then, if Wireshark is ran with the =D flag and is not run from such an account, it will not list any interfaces, Tis option sets the initial caprure filter expression to be used when capturing packets. After reading in a capture file using the -F flag, go to the given ‘packet number, The -h option requests Wireshark to print its version and usage instructions (as shown above) and exit. 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 youre using UNIX, netsta {config -a might also work to list interface names, although not all versions of UNIX support the -a flag to ifconfig. Ifno interface is specified, Wireshark searches the list of imterfaces, 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 crror and doesn't start che 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 libpeap format. After reading in a capture file using the -r flag, jump to the first packet which matches the filter expression. The filter expression is in display filter format, IFan exact match cannot be found the first packet afterwards is selected. Use this option after the -J option to search backwards for a first packet to £0 to. 128Customizing Wireshark 1 -m -N -o 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. 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). List the data link types supported by the interface and exit. This option sets the name of the font used for most text displayed by Wireshark. XXX - add an example! Disable network object name resolution (such as hostname, TCP and UDP port names) Tums 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, m 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. 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 sting 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 can be given on a single command line. ‘An example of setting a single preference would be: wireshark -o mgep.display_dissect_tree: TRUE An example of setting multiple preferences would be: wireshark -0 —_ mgepdisplay_dissect_tree:TRUE —-0 ‘mgep.udp.callagent_port:2627 Tip! 9 You can get a list of all available preference strings from the preferences file, see Appendix A, Files ond Folders. User access tables can be overridden using "vat," followed by the UAT file name and a valid record for the file: wireshark -o “uat:user_dits:\"User 0 (DLT=147)\",\"http\", yore The example above would dissect packets with a libpeap data link type 147 as HTTTP, just as if you had configured it in the DLT_USER protocol preferences. 129Customizing Wireshark ? -P path setting> + -R -s -t 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, broadcest traffic, and multicast traffic to addresses received by that machine. Special path settings usually detected automatically. This is used for special cases, ¢. stating Wireshark from a known location on an USB stick. The criterion is of the form key:path, where key is one of persconf:path path of personal configuration files, ike the preferences files. persdata:path path of personal data files, i's the folder initially opened, After the initialization, the recent file will Keep the folder lst used, This option forces Wireshark to exit when capturing is complete. It cean be used with the -¢ option, It must be used in conjunction with the +i and -w options, 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, 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 Section 6.3, “Filtering packets while viewing”, Packets not matching she filter are discarded. This option specifies the snapshot length to use when capturing packets. Wireshark will only capture bytes of data for each packet. 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. This option sets the format of packet timestamps that are displayed in the packet list window. The format can be one of: + rrelative, 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 forall packe +d delta, which specifies previous packet. timestamps are relative to the BOCustomizing Wireshark 10.3. +e epoch, which specifies that timestamps are seconds since ch (an 1, 1970 00:00:00) ~ The -v option requests Wireshark to print out its version information and exit -w This option sets the name of the savefile to be used when saving a capture file -y Ifa capture is started from the command line with -k, set the data link type to use while capturing packets, The values reported by - Laare the values that can be used. -X Specify an option to be passed to a TShark module, The eXtension option isin the form extension_key:value, where extension_Key can be: ua_script:lue_script_filename; Tells Wireshark to load the given script in addition to the default Lua scripts, ~1 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 (usully) ested in. Tip! % You will find a lot of Coloring Rule examples at the Wireshark Wiki at htep:fiwiki.wireshark.org/ColoringRules, Coloring Rules page ‘There are two types of coloring rules in Wireshark. Temporary ones that are only used tntil you quit the program. And permanent ones that will be saved to a pref ference file so that they are available on a next ‘Temporary coloring rules can be added by selecting a packet and pressing the key together with one Of the number keys. This will create a coloring rule based on the currently selected conversation, It will try to create a conversation filter based on TCP firs, then UDP, then IP and at last Ethernet. Temporary filters can also be created by selecting the "Colorize with Filter> Color X” menu items when rightelicking. in the packet-detail pane. ‘To permanently colorize packets, select the Coloring Rules... menu item from the View menu; Wireshark will pop up the "Coloring Rules” dialog box as shown in Figure 10.1, “The "Coloring Rules” dialog box" BICustomizing Wireshark Figure 10.1, 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. A Note! You will need to carefully select the order the coloring rules are listed as they ure 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 match first), If this isthe first time you have used Coloring Rules, click on the New button which will bri color filter dialog box as shown in Figure 10.2. “The "Edit Color Filter” dialog box”, up the Edit Figure 10.2. 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 inthe Filter text field, Figure 10.2, “The "Edit Color Filter" dialog box” 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 centered these values, you can choose a foreground and background color for packets that match the filter expression, Click on Foreground color... of Background color... to achieve this and Wireshark will op up the Choose foreground/background color for protocol dialog box as shown in Figure 10.3, “The "Choose color” dialog box”. 132Customizing Wireshark Figure 10.3, The "Choose color” dialog box Select the color you desire forthe 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 Figwe 10.4, “Using color filters with Wireshark” 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. Figure 10.4, Using color filters with Wireshark eR te cone tte a = Bweeew oars Be eee Baa {Clorseg tule hams 2) {rig fe Seige) ae 133Customizing Wireshark 10.4. Control Protocol dissection ‘The user can control how protocols are dissec Each protocol has its own dissector, so dissecting @ com packet will typically involve several dissectors. As Wireshark tries to find the right dissector for each packet (using static "routes” and heuristics it might choose the wrong dissector in your specific case, For example, Wireshark won't know if you use @ common protocol on an uncommon TCP port, 8. 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 compl 10.4.1. The "Enabled Protocols" dialog box of temporarily divert the way Wireshark calls the dissectors ‘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. | A Note! Disabling @ 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 Ethemet 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. ‘To enable/disable protocols select the Enabled Protocols. item from the Analyze menu; Wiresbark will op up the "Enabled Protocols" dialog box as shown in Figure 10.5, “The "Enabled Protocols" dialos box" iMCustomizing Wireshark Figure 10.5, The "Enabled Protocols" dialog box tn weer trot ane fest eae {Litt Nose a a a a 5 a e 5 ee ——— To disable orenable a protocol, simply click on it using the mouse or press the space bar when the protocol ishighlighted. Note that typing the first few letters of the protocol name when the Enabled Protocols dialog box is active will temporarily open a search text box and automatically select the first matching protocol ‘name Gf it exists) Warning! A You have to use the Save button to save your settings, The OK or Apply buttons will not save your changes permanently, s0 they willbe lost when Wireshark is closed ‘You can choose from the following actions: 1. Enable AU: Enable all protocols inthe list. 2. Disable All: Disable all protocols in thelist. 3. Invert: Toggle the state of al protocols in the list, 4. 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 Appendix A, Files and Folders for details. Cancel: Cancel the changes and close the dialog box. 10.4.2. User Specified Decodes ‘The "Decode As” functionality let you temporatily divert specific protocol dissections. This might be useful for example, if you do some uncommon experiments on your network. 135Customizing Wireshark Decode As is accessed by selecting the Decode As... item from the Analyze menu; Wireshark will pop up the "Decode As" dialog box as shown in Figure 10.6, “The "Decode As” dialog box” Figure 10.6, The "Decode As" dialog box ‘The content of this dialog box depends on the selected packet when it was opened. A Warning! The user specified decodes can notbe saved. If you quit Wireshark, these settings will be lost. 1. Devode: Decode packets the selected way 2. Do.not decode: Do not decode packets the selected way 3. Link/Network/Transport: Specify the network layer at which "Decode As” should take place. Which of those pages are available depends on the content of the selected packet when this dialog box is opened, 4, Show Current: Open a dialog box showing the current lst of user specified decodes, 5. OK: Apply the currently selected decode and close the dialog box. 6 Apply: Apply the currently selected decode and keep the dialog box open. 7. Caneel: Cancel the changes and close the dialog box. 10.4.3. Show User Specified Decodes This dialog box shows the currently active user specified decodes, 136Customizing Wireshark Figure 10.7. The "Decode As: Show" dialog box 1. OK: Close this dialog box. 2. Clear: Removes all us specified decodes, 10.5. Preferences ‘There are a number of preferences you can set. Simply select the Preferences... menu item from the Kit ‘menu; and Wireshark will pop up the Preferences dialog box as shown in Figure 10.8, “The preferences dialog box”, with the "User Interface” page as default. On the left side is a tree where you can select the page to be shown, [7 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 htp:// wwiki.wireshark org/Preferences, A 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 preferences settings and keep the dialog open. + The Save button will apply the preferences settings, save the dialog open. ings on the hard disk and keep the + ‘The Caneel button will restore all preferences settings to the last saved state 7Customizing Wireshark Figure 10.8. The preferences dialog box © teenie eotoy © taste 10.5.1. Interface Options In the Capture preferences it is possible to configure several options for the interfaces available on your ‘computer, Select the Capture pane and press the Interfaces: Edit button, In this window itis possible to cchange the default link-layer header type for the interface, add a comment or choose to hide a interface from other parts of the program, Figure 10.9. The interface options dialog box estes fas noe comment Hide? ° theme voce Deen One rlaerheadr ie: [Be : Hide mercer: Each row contains options for each interface available on your computer. + Device: the device name provided by the operating system, ‘+ Description: provided by the operating system, 138Customizing Wireshark + Default link-layer: each interface may provide several link-layer header types. The default link-layer chosen here is the one used when you fist start Wireshark. It is also possible to change this value in Section 4.5, “The "Capture Options” dialog box” when you start @ capture, For & detailed description, see Section 49, “Link-layer header type”, + Comment: a user provided description of the interface, This comment will be used as a description instead of the operating system description + Hide?: enable this option to hide the interface from other parts of the program. 10.6. Configuration Profiles Configuration Profiles can be used to configure and use more thar configurations. Select the Configuration Profiles... menu item from the Carl-A; and Wireshark will pop up the Configuration Profiles dialog box as shown in Figure 10.10, “The ‘configuration profiles dialog box”. Iti also possible to click in the "Profile" part of the statusbar to popup a menu with available Configuration Profiles (Figure 3.20, “The Statusbar with a configuration profile menu”) ‘Configuration files stored inthe Profiles + Preferences (preferences) (Section 105, "Preferences" + Capture Fikers (filters) Section 66, “Defining and saving Gites") + Display Fitters (afters) (Section 6.6, “Defining and saving fiers") * Coloring Rules (colorfters) (Section 10.3, “Packet colorization”) + Disabled Protocols (disabled_protos) (Section 104.1, “The "Enabled Protocols" dialog box") + User Accessible Tables ‘+ Display Filter Macros (dfilter_macros) fection 10.8, “Display Filter Macros") + GoolP Database Paths (geoip_db_ paths) (Secvion 10.9, “GeolP Database Paths") + K12 Protocols (k12_protos) (Section 10.10, “Tektronix K12xx/15 RFS protocols Table") + PRES Users Context List (pres_context_list) (Section 10.11, “PRES Users Context List") + SCCP Users Table (scep_users) (Section 10.12, “SCCP users Table”) + SMI Modules (smi_modules) (Section 10.13, “SMI (MIB and PIB) Modules”) ‘+ SMI Paths (smi_paths) (Section 10.14, “SMI (MIB and PIB) Paths") ‘+ SNMP Enterprise Specific Trap Types (snmp_specific_traps) (Section 10.15, “SNMP Enterprise Specific Trap Types”) + SNMP Users (snmp_users) (Section 10.16, “SNMP users Table”) + User DLTs Table (user_dlts) (Section 10.17, “User DLs protocol table”) + Some recent settings (recent), such as pane sizes in the Main window (Section 3.3, “The Main window"), column widths in the packet list (Section 3.17, “The "Packet List” pane”), all selections in the "View" menu (Section 3.7, “The "View" menu) and the last directory navigated to in the File Open dialog. 139Customizing Wireshark A Other configurations All other configurations are stored in the personal configuration folder, and are common to all profiles, Figure 10.10. The configuration profiles dialog box ‘ConsguationProies| Ciseny | No reassembly Ooewiete Properties rote name: reese New ‘This button adds a new profile to the profiles list. The name of the created profile is "New profile” and can be changed in the Properties field. Copy ‘This bution adds a new profile to the profiles list, copying all configuration from the profile currently selected in the list. The name of the created profile is the same as the copied profile, with the text “(copy)” applied. The name can be changed in the Properties field. Delete ‘This button deletes the selected profile, including all configurat files used in this profile. It is not possible to delete the "Default" profile Configuration Profiles ‘You can select a configuration profile from this list (which will fill in the profile name in the fields down at the bottom of the dialog box). Profile name: ‘You can change the name of the currently selected profile here. Used as a folder name ‘The profile name will be used as a folder name in the configured "Personal configurations” folder. If adding ‘multiple profiles with the same name, only one profile will be created. [a Illegal characters (On Windows the profile name cannot stator end with 4 period (), and cannot contain any of the following characters: \/: #2" <> 40Customizing Wireshark (On Unis the profile name cannot contain the 7 character, OK This button saves all changes, applies the selected profile and closes the dialog. Apply This button saves all changes, applies the selected profile and the dialog open, Cancel Close this dialog, This will discard unsaved settings, new profiles will not be added and deleted profiles will not be del Help Show this help page. 10.7. User Table ‘The User Table editor is used for managing various tables in wireshark. Its main dialog works very similarly to that of Section 10.3, “Packet colorization” 10.8. Display Filter Macros Display Filter Macros are a mechanism to ereate shortcuts for complex filters. For exemple defining a display filter macro named tep_cony whose text is ( (ipsre == $1 and ip.dst == $2 and tepsreport ‘$3 and tep.dstport = $4) or (ipsre dst == $1 and tep-sreport == $4 and tep.dstport: '$3)) would allow to use a display filter Like ${tep_conv:10.1.1.2;10.1.1.3:1200;1400} instead of typing the whole filter. Display Filter Macros can be managed with a Section 10.7, “User Table” by selecting Analyze # Display Filter Macros from the menu, The User Table has the following fields Name The name of the macro, Text The replacement text for the macro it uses $1, $2, $3, .. as the input arguments 10.9. GeolP Database Paths If your copy of Wireshark supports MaxMind's GeolP library, you can use their databases to match IP addresses to countries, cites, autonomous system numbers, ISPs, and other bits of information. Some databases are available at no cost, while others require a licensing fee. See the MaxMind web site for more information. ‘This table is handled by an Section 10.7, “User Table” with the following fields, Database pathname This specifics a directory containing GcolP data files. Any files beginning with Geo and ending with .clat. will be automatically loaded. A total of 8 files can be loaded. ‘The locations for your data files are up to you, but /usr/share/GeoLP (Linux), c:\ceoLe (Windows), c:\program ¥iles\wireshark 2B (Windows) might be good choices. MaCustomizing Wireshark 10.10. Tektronix K12xx/15 RF5 protocols Table ‘The Tektronix K12xx/15 rf5 fle format uses helper files (*-stk) to identify the various protocols that are used by a certain interface. Wireshark doesn't read these stk files, it uses a table that helps it identify which lowest layer protocol to use. Stk filet protocol matching is handled by an Section 10.7, “User Table” with the following fields, Match string _A partial match for an stk filename, the first match wins, so if you have a specific case ‘and a general one the specific one must appear fist in the list. Protocol ‘This isthe name of the encapsulating protocol (the lowest layer in the packet data) it cean be either just the name of the protocol (e.g. mtp2, e ‘application’ protocol over it separated dy a colon (e.g sscop:ssef-nni, sscopcaleap, sscop:nbap, .) 10.11. PRES Users Context List Wireshark uses this table to map a presentation context identifier to a given object identifier when the capture does not contain a PRES package with a presentation context definition list for the conversation. toutfes, ssef-nni } or the name of the encapsulation protocol and th ‘This table is handled by an Section 10.7, “User Table” with the following fields, Context 1d An Integer representing the presentation context identifier for which this association is valid. Syntax Name OID The object identifier representing the abstract syntax name, which defines the [protocol that is carried over this association. 10.12. SCCP users Table Wireshark uses this table to map specific protocols toa certain DPC/SSN combination for SCCP. ‘This table is handled by an Section 10.7. “User Table” with the following fields, Network Indicator An Integer representing the network indicator for which this association is valid Called DCS An range of inegers representing the dpes for which this association is vad Called SSNs An range of integers representing the sans for which this association is valid User protocol The protocol thats carried over this association 10.13. SMI (MIB and PIB) Modules If your copy of Wireshark supports ibSMI, you can specify 2 list of MIB and PIB modules here. The ‘COPS and SNMP dissectors can use them to fesolve OIDs. Module name — The 10.14. SMI (MIB and PIB) Paths If your copy of Wireshark supports libSMI, you can specify one or more paths to MIB and PIB modules here. ne of the module, e.g. IF-MIB. 142Customizing Wireshark Directory name A module directory, ¢g. /usr/Local/snnp/mibs. Wireshark automatically uses the standard SMI path for your system, so you usually don't have to add anything here, 10.15. SNMP Enterprise Specific Trap Types Wireshark uses this table to map specific-trap values to user defined descriptions in a Trap PDU. The description is shown in the packet details specific-trap element. ‘This table is handled by an Section 10.7, “User Table” with the following fields Enterprise OID The object identifier representing the abject generating the trap. ‘Trap ld ‘An Integer representing the specificrap code. Description ‘The description to show in the packet details, 10.16. SNMP users Table ‘Wireshark uses this table to verify authentication and to decrypt encrypted SNMPV3 packets. ‘This table is handled by an Section 10.7. “User Table with the following fields, Engine ID If given this entry will be used only for packets whose engine id is this. This field takes an hexadecimal string in the form 0102030408. Username ‘This is the userName. When a single user has more than one password for different SNMP-engines the first entry to match both is taken, if you rnced a catch all engine-id (empty) that entry should be the last one. Authentication model Which auth model to use (either "MDS" or "SHA Password ‘The authentication password. Use ‘xDD! for unprintable characters. An hexadecimal password must be entered as @ sequence of "XDD" characters. For exemple the hex password 010203040506 must be entered as \xONNKO2ixO3iAOAKOSIAOG. Privacy protocol Which encryption algorithm to use (ether "DES" or "AES". Privacy password ‘The privacy password. Use XDD’ for unprintable characters. An hexadecimal password must be entered as a sequence of ‘xDD’ characters. For example the hex password 010203040506 must be ent "\eO11x02\x03\x04\x051x06' 10.17. User DLTs protocol table ‘When a peap file uses onc of the user DLT (147 to 162) wireshark uses this table to know which protacol(s) to use for cach user DLT. ed as ‘This table is handled by an Section 10.7, “User Table” with the following fields DLT One of the user dts, Payload protocol ‘This is the name of the payload protocol (the lowest layer in the packet data, (eg. “eth” for ethernet, “ip” for IPv4) 13Customizing Wireshark Header size If there is « header protocol (before the payload protocol) this tells which size this header is, A value of 0 disables the header protocol, Header protocol The name of the header protocol to be used (uses "data" as default). ‘Trailer size If there is a trailer protocol (after the payload protocol) this tells which size this trailer is. A valve of 0 disables the trailer protocol. ‘Trailer protocol The name of the trailer protocol to be used (uses “data” as default) 10.18. IKEv2 decryption table Wireshark can decrypt Encrypted Payloads of IKEv2 (Intemet Key Exchange version 2) packets if necessary information is provided. Note that you can decrypt only IKEv2 packets with this feature. If ‘you want to decrypt IKEvI packets or ESP packets, use Log Filename setting under ISAKMP protocol preference or settings under ESP protocol preference respectively ‘This table is handled by an Section 10.7, “User Table” withthe following fields, Initiator's SPL Initiator’s SPL of the IKE_SA. This field takes hexadecimal string without ‘Ox" prefix and the length must be 16 hex chars (represents 8 octets). Responder's SPI Responder's SPI of the IKE_SA. This field takes hexadecimal string ‘without "Ox" prefix and the length must be 16 hex chars (represents 8 octets) Key used to enerypUdecrypt IKEv2 packets from initiator to responder. ‘This field takes hexadecimal string without "Ox" prefix andits le ‘meet the requirement of the encryption algorithm selected. th must Sk er Key used to encrypUdecrypt IKEv2 packets from responder to initiator. ‘This field takes hexadecimal string without "Ox" prefix and its length must, meet the requirement of the encryption algorithm selected. Encryption Algorithm yption algorithm of the IKE. SK ai Key used to calculate Integrity Checksum Data for IKEv2 packets from responder to initiator. This field takes hexadecimal string without "Ox" prefix and its length must meet the requirement of the integrity algorithm selected, Sk ar Key used to calculate Integrity Checksum Data for IKEv2 packets from initiator to responder. This field takes hexadecimal string without "Ox' prefix and its length must meet the requirement of the integrity algorithm selected, Integrity Algorithm. Integrity algorithm of the IKE_SA. 4Chapter 11. Lua Support in Wireshark 11.1. Introduction Wireshark has an embedded Lua interpreter. Lua is a powerful light-weight programming language designed for extending applications. Luais designed and implemented by ateam at PUC-Rio, the Pontifical Catholic University of Rio de Janeiro in Brazil, Lua was bom and raised at‘Tecgraf, the Computer Graphics Technology Group of PUC-Rio, and is now housed at Lua.org. Both Tecgraf and Lua.org are laboratories of the Department of Computer Science. In Wireshark Lua can be used to write disseetors and taps. ‘Wireshark’s Lua interpreter starts by loading init.Jua that is located in the global configuration directory ‘of Wireshark. Lua is disabled by default by setting the variable disable lua to true in ini.ua. To enable Tua the Tine that sets that variable must be removed or commented out ‘After loading initua from the data directory if Tua is enabled Wireshark will try to Toad a file named initua in the user's directory. ‘Wireshark will also load all files with lua suffix from both the global and the personal plagins directory ‘The command line option -X lua_scripts can be used to load lua scripts as well ‘The Luacode will be executed once after all the protocols have being initialized and before reading any file. 11.2. Example of Dissector written in Lua 45‘Lua Support in Wireshark 11.3 (10) = picsectortable.qet ("ectp.ppit) :qet_dissector (3), —— mua Lit) = dissectortable-qet (*ip.proto") :get_dissector (132), - sctp , Function p_multi.dissector (buf, pkt, root) Local © = root sade (p_mvlti, Buf (0,21) radd (£_proto, Buf (0,11) iad (fate, Bue (1, 11) local prote_id = buf (0,1) :uint () local disssctor - protes{prote_idl) Sf dissector ~= nfl chen aiesector:call (buf (2) :tvb(), Pkt, root) olecit prote_id <2 thon ‘cradd text, but (2)) ““'pkt cols. info:eat (buf (2,buf:1en() ~ 3) :etring}) else data_dis:eall (but (2) stub () Pkt, root) ens table - DissectorTable.aet (*#tap_encap") local udp_ancap_table ~ DissectorTable. get ("udp.port") table:add (wtap-USERIS, p_multi) ‘able:add (weap.USERI2, pomulti) ‘udp_ancap_fable:ada (7555, pli) Example of Listener written in Lua “thie program will register a mens that willl open a window with a count of occurrences = of avery address in the capture local function menvable_tap() SSpeclare the window we wil] wee local tw = Texthindow.nex("Rddreas Counter") <= This will contain a hach of counters of appearances of a certain address local ips = () -- thie ie our tap local tap = Listener-new (0; Fonction remove () UM thi way we remove the Istener than otherige willl remain running sndifinitelly tapironove (1 — wwe toll the window to call the renove() function when closed ‘ureat_atclose (remove) —- thie function will be called once for each packet Function tap.packst (pinto, tub) local sre = ipeltestring (pinfo.erc) ] or 0 local det = ipeltestring(pinto.det)] or 0 ipe{tostring ipinte.ere)] = ore ips[tostring pinte.dst)] = det 146‘Lua Support in Wireshark 11.4. Wireshark's Lua API Reference Manual “This Par ofthe User Guide desribes the Wireshark specific function inthe embedded La, 11.4.1. Saving capture files 11.4.1.1. Dumper 11.4.1.1.1, Dumper.new(filename, [filetype], [encap]) ‘Creates a file to write packets. Dumper:new_for_current() will probably be a better choice. 11.41.1441, Arguments filename ‘The name of the capture file to be created filetype (optional) ‘The type of the file to be created cencap (optional) ‘The encapsulation to be used in the file to be created 19.4.1.1.1.2, Returns ‘The newly created Dumper object 11.4.4.1.1.3, Errors Not every filetype handles every encap 11.4.1.1.2, dumper:close() Closes a dumper 11.4.4.1.24. Errors Cannot operate on a closed dumper 7‘Lua Support in Wireshark 11.4.1.1.3. dumper:flush() Writes all unsaved data of a dumper tothe disk. 11.4.1.1.4. dumper:dump(timestamp, pseudoheader, bytearray) Dumps an arbitrary packet. Note: Dumper:dump_current() will ft best in most eases 11.4.1.1.4.1, Arguments timestamp The absolute timestamp the packet will have pscudoheader ‘The Pscudoheader to use. bytearray the data to be saved 11.4.1.1.5. dumper:new_for_current([filetype]) Creates a capture file using the same encapsulation as the one ofthe cuurrent packet 11.4.1.1.5.1, Arguments filetype (optional) ‘The file type. Defaults to peap. 11.4.1.1.5.2. Returns ‘The newly created Dumper Object 11.4.1... Errors + Cannot be used outside a tap or a dissector 11.4.1.1.6. dumper:dump_current() Dumps the current packet as itis, 11.4.1.1.6.1. Errors + Cannot be used outside a tap or a dissector 11.4.1.2. PseudoHeader ‘A pscudoheader to be used to save captured frames. 11.4.1.2.1. PseudoHeader.none() Creates a "no" pseudoheader. 11.4.1.2.1.1. Returns A null pseudoheader 11.4.1.2.2. PseudoHeader.eth([fcslen]) Creates an ethernet pseudohesder 11.4.1.2.2.1, Arguments feslen (optional) The s length 148‘Lua Support in Wireshark 11.4.1.2.2.2. Returns "The ethernet pseudoheader 11.4,1.2.3, PseudoHeader.atm([aal], [vpi], [vei], [channel], [cells], [aal5u2u], [aal5len]) (Creates an ATM pscudoheader 11.4,1.2.3.1, Arguments zal (optional) AAL number ‘pi (optional) vel ‘ei (optional vet channel (optional) Channel cells (optional) amber of cells in the PDU aalSu2u (optionel) AALS User to User indicator salSten (optional) AALS Len 11.4.1.2.3.2. Returns ‘The ATM pscudoheader 11.4.1.2.4, PseudoHeader.mtp2() Creates an MTP? PscudoHeader 11.4.1.2.4.1, Returns “The MTP2 preudoheader 11.4.2. Obtaining dissection data 11.4.2.1. Field A Field extractor to to obtain field values. 11.4.2.1.1. Field.new(fieldname) (Create a Feld extractor 11.4.2.1.1.1. Arguments fiekdname The fier name ofthe field (eg. ipddr) 11.4.2.1.4.2. Returns “The field extractor 11.4.2.1.1.3. Errors + A Field extractor must be defined before Taps or Dissectors get called 149‘Lua Support in Wireshark 11.4.2.1.2. field:__call() Obtain all values (see FieldInfo) for this field. 1.2.1. Returns All the values ofthis field 11.4.21.2.2. Errors + Fields cannot be used outside dissectors or taps 11.4.2.2. FieldInfo ‘An extracted Field 11.4.2.2.1. fieldinfo:_len() Obtain the Length ofthe field 11.4.2.2.2. fleldinfo:_unm() Obtain the Offset ofthe field 11.4.2.2.3. fieldinfo:__call() ‘Obtain the Value of the field 11.4.2.2.4. fieldinfo:__tostring() “The sting representation of the field 11.4.2.2.5. fieldinfo:_eq() Checks w er Ths is within rhs 11.4.2.2.5.1. Errors + Data source must be the same for both fields 11.4.2.2.6. fieldinfo:_le() ‘Checks whether the end byte of ths is before the end of rhs 11.4.2.2.7. fieldinfo:_It() ‘Checks whether the end byte of ths is before the beginning of rhs. 11.4.2.2.7.1. Errors + Data source must be the same for both fields 11.4.2.2.8. fieldinfo.name ‘The name of this field 150‘Lua Support in Wireshark 11.4.2.2.9. fieldinfo.label ‘The string representing this field 11.4.2.2.10. fieldinfo.value ‘The value of tis field 11.4.2.2.11. fieldinfo.len ‘The length ofthis field 11.4,2.2.12. Idinfo.offset The offset ofthis field 11.4.2.3. Non Method Func’ 11.4.2.3.1. all_field_intos() ‘Obtain al fields from the current tree 11.4.2.3.1.1. Errors + Cannot be called outside a listener or dissector 11.4.3. GUI support 11.4.3.1. ProgDig Manages a progress bar dialog. 11.4.3.1.1. ProgDlg.newi({title], [task]) Creates a new TextWindow. 11.4.3.1.1.1. Arguments tile (optional Title of the new window, defaults to "Progress" task (optional) Current task, defaults to 11.4.3.1.1.2. Returns ‘The newly created TextWindow object. 11.4.3.1.2. progdlg:update(progress, [task]) Appends text 11.4.3.1.2.1, Arguments progress art done (eg. 0.75 ) task (optional) Current task, defaults 10" 151‘Lua Support in Wireshark 11.4.3.1.2.2. Errors + Cannot e called for something not a ProgDlg + Progress value out of range (must be between 0.0 and 1.0) 11.4.3.1.3. progdig:stopped() ‘Checks wheher the user has pressed the stop button. 11.4.3.1.3.1. Returns true if the user has asked to stop the progress. 11.4.3.1.8.2. Errors + Cannot be called for something not a ProgDig 11.4.3.1.4, progdig:close() Appends text 11.4.3.1.4.1. Errors + Cannot be called for something not a ProgDIg 11.4.3.2. TextWindow Manages a text window. 11.4.3.2.1. TextWindow.newi[title]) Creates a new TextWindow. 11.4.3.2.1.1, Arguments title (optional) Tide of the new window 11.4.3.2.1.2. Returns The newly created Text Window object. 11.4.3.2.2. textwindow:set_atclose(action) Set the function that willbe called when the window closes 11.4.3.22.1. Arguments action A function to be executed when the user closes the window 11.4.3.2.2.2. Returns The TextWindow object. 11.43.22. Errors + Cannot be called for something not a Text Window 152‘Lua Support in Wireshark 11.4.3.2.3. textwindow:set(text) Sets the text. 11.4.3.2.3.1. Arguments text The texto be used 11.4.3.2:3.2. Returns The TextWindow object. 11.4.3.23.3. Errors + Cannot be called for something not a Text Window 11.4.3.2.4. textwindow:append(text) ‘Append text 11.4.3.2.4.1. Arguments text The texto be appended 11.4.3.2.4.2. Returns The TextWindow object. 11.4.3.2.4.3. Errors + Cannot be called for something not a Text Window 11.4.3.2.5. textwindow:prepend(text) Prepends text 11.4.3.25.1. Arguments text The texto be appended 11.4.3.2.5.2. Returns The TextWindow object. 11.4.3.25.3. Errors + Cannot be called for something not a Text Window 11.4.3.2.6. textwindow:clear() [Erass all text in the window: 11.4.3.2.6.1. Returns The TextWindow object. 11.4.3.2.6.2. Errors + Cannot be called for something not a Text Window 153‘Lua Support in Wireshark 11.4.3.2.7. textwindow:get_text() Get the text ofthe window 11.4.3.27.1. Returns ‘The TextWindow's text. 11.4.3.2.7.2. Errors + Cannot be called for something not a Text Window 11.4.3.2.8. textwindow:set_editable([editable]) Make this window editable 11.4.3.2.8.1. Arguments editable (optional) A boolean flag, defaults to true 11.4.3.28.2. Returns ‘The TextWindow object. 11.4.3.28.3. Errors + Cannot be called for something not a TextWindow 11.4.3.2.9. textwindow:add_button(label, function) 11.43.29.1. Arguments label The label of the button function ‘The function tobe called when clicked 11.4.3.2.9.2. Returns “The TextWindow object. 11.43.29.3. Errors + Cannot be called for something not a TextWindow 11.4.3.3. Non Method Functions 11.4.3.3.1. gui_enabled() ‘Checks whether the GUI facility is enabled 11.4.3.3.1.1. Returns ‘A boolean: true if it is enabled, false iti isn. 11.4.3.3.2. register_menu(name, action, [group] Register a menu item in one of the main ments. 154‘Lua Support in Wireshark 11.4,3.3.2.1, Arguments action group (optional) 11.4.3.3.3. new_dialog(title, action, Pops up new dialog 11.4,3.3.3.1. Arguments ‘The name of the menu item. The submenus are to be separated by ''s. (string) The function to be called when the menu item is invoked. (function taking no arguments and returning nothing) The menu group into’ which the menu item is to be inserted. If omitted, defaults. t9 MENU_STAT GENERIC. One of MENU_STAT_UNSORTED _ (Statistics) TAT_GENERIC (Statistics, STAT_CONVERSATION (Statistics! Conversation List, ME NDPOINT _(Statisties/Endpoint List), MI T_RESPONSE. (Statistics/Service Response Time), MENU_STAT_TELEPHONY (Telephony), MENU_ANALYZE (Analyze), MENU_ANALYZE_CONVERSATION — (Analyze/Conversation Filter), MENU_TOOLS_UNSORTED (Tools). (number) ) frst section), MENU. title Title ofthe dialog's window. action Action to be performed when OKA. A series of strings to be used as labels of the dialog's fields 11.4,3.3.3.2. Errors + Atleast one field required + All fields must be strings 11.4.3.3.4. retap_packets() Rescan all packets and just run taps - don't reconstruct the display 11.4.3.3.5. copy_to_clipboard(text) ‘Copy a string into the clipboard 11.4,3.3.5.1. Arguments text The string to be copied into the clipboard. 11.4.3.3.6. open_capture_file(filename, filter) ‘Open and display a capture file 11.4,3.3.6.1. Arguments filename The name ofthe file to be ops a filter A filter to be applied as the file gets opened. 155‘Lua Support in Wireshark 11.4.3.3.7. set_filter(text) Set the main filter text 11.4.3.3.7.1. Arguments text The filter's text. 11.4.3.3.8. apply_filter() Apply the filter inthe main filter box 11.4.3.3.9. reload() Reload the eurent capture file 11.4.3.3.10. browser_open_url(url) (Open an ulin a browser 11.4.3.3.10.1. Arguments ud The ut. 11.4.3.3.11. browser_open_data_file(filename) (Open an file in browser 11.4.3.3.11.1. Arguments filename The ut. 11.4.4. Post-dissection packet analysis 11.4.4.1. Listener ‘A Listener, is called once for every packet that matches a certain filter or hus a certain tap. Itean read the tree, the packet's Tvb eventually the tapped data bat it cannot add elements to the tee. 11.4.4.1.1. Listener.new([tap], [filter] Creates a new Listener listener 1.4.1. Arguments tap (optional) ‘The name of this tap filter (optional) A filter that when matches the tap.packet function gets called (use nil to be called for every packet) 11.4.4.1.1.2, Returns ‘The newly created Listener listener object 11.4.4.1.1.3. Errors + ap registration error 156‘Lua Support in Wireshark 11.4.4.1.2. listener:remove() Removes a tap listener 11.4.4.1.3. listener.packet A function that will be called once every packet matches the Listener listener filter. function tap packet(pinfo,vb,userdata) .. end 11.4.4.1.4, listener.draw ‘A function that will be called once every few seconds to redraw the gui objects in shark this funtion is called oly atthe very end of the capture file. function tap.draw(userdata) .. end 11.4.4.1.5. listener.reset ‘A function that willbe called atthe end ofthe capture run, function tap.eset(userdata). end 11.4.5. Obtaining packet information 11.4.5.1. Address Represents an address 11.4.5.1.1. Address.ip(hostname) Creates an Address Object representing an IP address. 11.4.8.1.1.1. Arguments hhostmame ‘The address or name ofthe IP host 11.4.5.1.1.2. Returns The Address object 11.4.5.1.2. address:_tostring() 11.4.5.1.2.1. Returns “The sting representing the address. 11.4.5.1.3. address:_eq() ‘Compares two Addresses 11.4.5.1.4. address:_le() ‘Compares two Addresses 11.4.5.1.5. address:__It() ‘Compares two Addresses 11.4.5.2. Column A Column in the packet list 157‘Lua Support in Wireshark 11.4.5.2.1. column:__tostring() 11.4.5.2.1.1. Returns A string representing the column 11.4.5.2.2. column:clear() (Clears @ Column 11.4.5.2.3. column:set(text) Sets the text of a Column 11.4.5.23.1. Arguments text The text to which to set the Column 11.4.5.2.4. column:append(text) Appends text to a Column 11.4.5.2.4.1, Arguments text The text to append to the Column 11.4.5.2.5. column:preppend(text) Prepends text to a Column 11.4.5.25.1. Arguments text ‘The text to pre 11.4.5.3. Columns ‘The Columns of the packet list. to the Column, 11.4.5.3.1. columns:__tostring() 11.45.3.1.1, Returns ‘The string "Columns", no real use, just for debugging purposes. 11.4.5.3.2. columns:_newindex(column, text) Sess the text ofa specific column 11.4.5.3.2.1. Arguments column The name of the column to set text. The text for the column 11.4.5.4. Pinfo Packet information 158‘Lua Support in Wireshark 11.4.5.4.1. pinfo.number “The number ofthis packet inthe curren ile 11.4.5.4.2. pinfo.len “The length of the frame 11.4.5.4.3. pinfo.caplen ‘The captured length of the frame 11.4.5.4.4. pinfo.abs_ts ‘When the packet was captured 11.4.5.4.5. pinfo.rel_ts Number of seconds passed since beginning of capture 11.4.5.4.6. pinfo.delta_ts Number of seconds passed since the last captured packet 11.4.5.4.7. pinfo.delta_dis_ts Number of seconds passed since the las displayed packet 11.45.48. pinfo.visited Whether this packet hass been already visited 11.4.5.4.9. pinfo.sre Source Address of this Packet 11.4.5.4.10. pinfo.dst Destination Address ofthis Packet 11.4.5.4.11. pinfo.lo lower Addeess of this Packet 11.4.5.4.12. pinfo.hi higher Address ofthis Packet 11.4.5.4.13. pinfo.dl_sre Data Link Source Address ofthis Packet 11.4.5.4.14. pinfo.dl_dst Data Link Destination Address of this Packet 159‘Lua Support in Wireshark 11.4.5.4.15. pinfo.net_src [Network Layer Source Address of this Packet 11.4.5.4.16. pinfo.net_dst Network Layer Destination Address of this Packet 11.4.5.4.17. pinfo.ptype ‘Type of Port of sre_port and dst_port 11.4.5.4.18. pinfo.src_port Source Port of this Packet 11.4.5.4.19. pinfo.dst_port Source Address of this Packet 11.4.5.4.20. pinfo.ipproto IP Protocol id 11.4.5.4.21. pinfo.circuit_id For circuit based protocols 11.4.5.4.22. pinfo.match Poru/Data we are matching 11.4.5.4.23. pinfo.curr_proto Which Protocol are we dissecting 11.4.5.4.24. pinfo.columns Accesss tothe packet list columns 11.4.5.4.25. pinfo.cols ‘Accesss tothe packet list columns (equivalent to pinfo.columns) 11.4.5.4.26. pinfo.desegment_len. Estimated number of additional bytes required for completing the PDU 11.4.5.4.27. pinfo.desegment_offset ‘Offset in the tvbuf at which the dissector will continue processing when next called 11.4.5.4.28. pinfo.private_dal ‘Access to private data 160‘Lua Support in Wireshark 11.4.6. Functions for writing dissectors 11.4.6.1. issector ‘Arofererence to a dis used to call a dissector against a packet or a part of it 11.4.6.1.1. Dissector.get(name) Obtains a dissector reference by name 11.4.6.1.1.1. Arguments name ‘The name of the dissector 11.4.6.1.1.2. Returns The Dissector reference 11.4.6.1.2. dissector:call(tvb, pinfo, tree) Calls a dissector against a given packet (or part of it) 11.4.6.1.2.1. Arguments te The buffer to dissect info. The packet info tree The tree on which to add the protocol items 11.4.6.2. sectorTable ‘A table of subdissectors of a particular protocol (e.g. TCP subdissectors like hp, smtp, sip are added to table "tep.port”). Useful to add more dissectors to a table so that they appear in the Decode As... dialog. 11.4.6.2.1. DissectorTable.new(tablename, [uiname], [type], [base]) Creates a new DissectorTeble for your dissector's use 11.4.6.2.1.1, Arguments tablename ‘The short name of the table, uuiname (optional) ‘The name of the table in the User Interface (defaults to the name given) type (optional) Either FT_UINT* or FT_STRING (defaults to FT_UINT32) base (optional) Either BASE_NONE, BASE_DEC, BASE_HEX, _BASE_OCT, BASE_DEC_HEX or BASE_HEX DEC (default to BASE_DEC) 11.4.6.2.1.2. Returns The newly created Dissector Table 11.4.6.2.2. DissectorTable.get(tablename) Obtain a reference to an existing dissector table 161‘Lua Support in Wireshark 11.46.2.2.1. Arguments fablename The short name of the table. 11.4.6.2.2.2. Returns The DissectorTable 11.4.6.2.3. dissectortable:add(pattern, dissector) Adda dssectorw a table 11.4.6.23.1. Arguments pavera “The pattem to match (ether an integer ora string depending on the table's type) dissector ‘The disscctor to add (cither an Proto or a Dissector). 11.4.6.2.4. dissectortable:remove(pattern, dissector) Remove a dissector from a table 11.46.2.4.1. Arguments pater The patter to match (either an integer or string depending on the table's type) Assector The dissetor to add (ether an Proto ora Dissector), 11.4.6.2.5. dissectortable:try(patten, tvb, pinfo, tree) ‘Try to call a dissector from a table 11.4.6.2.5.1, Arguments pattem ‘The pattern to be matched (either an integer ora string depending on the table's type. wo The buffer to dissect info "The packet info tree ‘The tree on which to add the protocol items 11.4.6.2.6. dissectortable:get_dissector(pattern) Try to obtain adissector from a table 11.4.6.2.6.1. Arguments pattern ‘The pattern to be matched (either an integer ora string depending on the table's type). 11.46.2.6.2. Returns ‘The dissector handle if found 11.4.6.3. Pref A preference of « Protocol, 162‘Lua Support in Wireshark 11.4.6.3.1. Pref.bool(label, default, descr) Creates a boolean preference to be added to a Protocol's prefs table, 11.4.6.3.1.1. Arguments label The Label (text inthe right side ofthe preference input) for this preference default ‘The default value for this preference descr A description of what this preference is 11.4.6.3.2, Pref.uint(label, default, descr) Creates an (unsigned) integer preference to be added to a Protocol's prefs table. 11.4.6.3.2.1. Arguments label ‘The Label (text in the right side ofthe preference input) for this pref default "The default value for this preference deser A description of what this preference is 11.4.6.3.3. Pref.string(label, default, descr) (Creates a string preference to be added to a Protocol's prefs table 11.4.6.3.3.1. Arguments label ‘The Label (text in the right side of the preference input) for this preference default ‘The default value for this preference deser A description of what this preference is 11.4.6.3.4, Pref.enum(label, default, descr, enum, radio) Creates an enum preference to be added to a Protocol's prefs table. 11.4.6.3.4.1. Arguments label ‘The Label (text in the right side of the preference input) for this preference default ‘The default value for this preference descr A description of what this preference is coum Acnum table radio Radio button (true) or Combobox (false) 11.4.6.3.5. Pref.range(label, default, descr, range, max) Creates a range preference to be added to Protocol's prefs table 11.4.6.3.5.1. Arguments label ‘The Label (text in the right side of the preference input) for this preference 163‘Lua Support in Wireshark default The default value for this preference descr A description of what this preference is range The range max ‘The maximum value 11.4.6.3.6. Pref.statictext(label, descr) Creates a stati text preference to be added to @ Protocol's prefs table 11.4.6.36.1. Arguments Tabet The static text descr ‘The static text description 11.4.6.4. Prefs The table of preferences ofa protocol 11.4.6.4.1. prefs:__newindex(name, pref) Creates a now preference 11.46.41. Arguments name ‘The abbreviation of this preference pref A valid bu still unassigned Pref object. 11.46.4.1.2. Errors © Unknow Pref type 11.4.6.4.2. prefs: index(name) the value of a preferes seting 11.46.4.2.1. Arguments name ‘The abbreviation of this preference 11.4.6.4.2.2. Returns The current value ofthe preference 11.46.4.2.3. Errors + Unknow Pref type 11.4.6.5. Proto Anew protocol in wireshark, Protocols have more uses, the main one is to dissect a protocol. But they can be just dummics used to register preferences for other purposes. 166‘Lua Support in Wireshark 11.4.6.5.1. Proto.new(name, desc) 11.4.6.5.1.1. Arguments name The name ofthe protocol desc Long Text description of the protocol (usually lowercase) 11.46.5.1.2. Returns ‘The newly created protocol 11.4.6.5.2, proto.dissector ‘The protocol's dissector, a function you define 11.4.6.5.3. proto.fields “The Fields Table of this dissector 11.4.6.5.4. proto.prefs “The preferences of this dssector 11.4.6.5.5. proto.init ‘The init routine of this dissector, «function you define 11.4.6.5.6. proto.name ‘The name given to this dissector 11.4.6.6. ProtoField A Protocol field (to be used when adding items to the dissection tree) 11.4.6.6.1. ProtoField.new(name, abbr, type, [valuestring], [base], [mask], [descr]) Creates a new field to be used in a protocol 11.4.6.6.1.1. Arguments name Actual name of the field (the string that appears inthe tree) abbr Filter name of the field (he string that is used in filters) type Field Type (FT_*), valuestring (optional) A ValueString object. base (optional) ‘The representation BASE_* mask (optional) The bitmask to be used. float() Get a Little Endian floating point number from a TvbRange. The range must be 4 or 8 octets long. 11.4.8.4.11. tvbrange: 178‘Lua Support in Wireshark 11.4.8.4.11.1, Returns ‘The floating point value 11.4.8.4.12. tvbrange:ipva() Get an IPv4 Address from a TvbRange, 11.4.8.4.12.1. Returns ‘The IPvé Address 11.4,8.4.13. tvbrang ipva() Get an Little Endian IPv4 Address from a TvoRange. 11.4.8.4.13.1. Retums The IPv4 Address 11.4.8.4.14. tvbrange:ether() Get an Ethernet Address from a TvbRange 11.4.8.4.14.1. Returns ‘The Ethernet Address 11.4.8.4,142. Errors + The range must be 6 bytes long. 11.4.8.4.15. tvbrange:string() CObvain a string from a TvbRange 11.4.8.4.15.1. Retums The string 11.4.8.4.16. tvbrange:: tringz() ‘Obtain a zero terminated string from a TvbRange 11.4.8.4.16.1. Returns ‘The zero terminated string 11.4.8.4.17. tvbrange:bytes() Obtain a ByteArray 11.4.8.4.17.1. Returns ‘The ByteArray 11.4.8.4.18. tvbrange:bitfield([position], [length]) Geta bitfield from a TvbRange. 179‘Lua Support in Wireshark 11.4.8.4.18.1. Arguments position (optional) “The bit offset from the begining of the TvbRange. Defaults to 0. length (optional) ‘Tre length (in bits) ofthe field, Defaults to 1 11.4.8.4.182. Returns The bitfield value 11.4.8.4.19. tvbrange:range([oftset], [length]) Creates a sub-TvbRange from this TvbRange. This i used also asthe TvbRange:_call) metamethod. 11.4.8.4.19.1. Arguments offset (optional) ‘The offset (in octets) from the begining ofthe TvbRange. Defaults to 0 length (optional) “The length (in octets) ofthe range. Defaults to until the end of the TvbRange 11.4.8.4.19.2. Returns The TvbRange 11.4.8.4.20. tvbrange:len() Obtain the length of a TvbRange 11.4.8.4.21. tvbrange:offset() Obtain the offset in 2 TybRange 11.4.8.4.22. tvbrange:_tostring() Convers the TybRange into @ string. As the string gets truncated you should use this only for debugging [Purposes or if what you want is to have a truncated string in the format 67:89:AB: 11.4.8.5. UInt Unt represents 1 64 bit unsigned integer. 11.4.9. Utility Functions 11.4.9.1. Dir A Directory 11.4.9.1.1, Dir.open(pathname, [extension]) Usage: for filename in Diropen(path) do. end 14.49.1.4.4. Arguments pathname ‘The pathname of the directory 180‘Lua Support in Wireshark extension (optional) If given, only file with this extension will be returned 11.4.9.1.1.2. Returns the Dir object 11.4.9.1.2. di a) At every invocation will return one file (nil when done) 11.4.9.1.3. dir:close() (Closes the directory 11.4.9.2. Non Method Functions 11.4.9.2.1. format_date(timestamp) Formats an absolute timestamp into @ human readable date 11.4.9.2.1.1, Arguments timestamp A timestamp valve w conver. 11.4.9.2.1.2. Returns A string with the formated date 11.4.9.2.2. format_time(timestamp) Formats a relative timestamp in a human readable form 11.49.2241. Arguments timestamp A timestamp value to convert 11.4.9.2.2.2. Returns ‘A string withthe formated time 11.4.9.2.3. report_failure(text) Reports a failure to the user 11.4.9.2.3.1. Arguments text Message 11.4.9.2.4. critical(...) Will add a tog entry with eiicl severity 11.4.9.2.4.1. Arguments “objects to be printed 181‘Lua Support in Wireshark 11.4.9.2.5. warn(...) Will add a log entry with warn severity 11.4.9.25.1. Arguments ‘objects tobe primed 11.4.9.2.6. message( Will add a log entry with message severity 11.4.9.26.1. Arguments ‘objects to be printed 11.4.9.2.7. info...) Will edd a log entry with info severity 11.4.9.2.7.1, Arguments ‘objects to be printed 11.4.9.2.8. debug(...) ‘Will add a log entry with debug severity 11.4.9.28.1. Arguments ‘objects to be printed 11.4.9.2.9. loadfile(tilename) LLua's lozdfile() has been modified so th it in wireshark’s user and system directories a file does not exist in the current directory it will look for 11.4,9.2.9.1. Arguments filename Name of the file to be loaded 11.4.9.2.10. dofile(filename) Lua's dofile() has been modified so that if a file does not exist in the current directory it will look for it in wireshark’s user and system directories 11.4.8.2.10.1. Arguments filename Name ofthe file to be run 11.4.9.2.11. persconffile_path({filename}) 11.4.9.2.11.1. Arguments filename (optional) A filename 11.4.9.2.11.2. Retums ‘The full pathname fora file inthe personal configuration directory 182‘Lua Support in Wireshark 11.4.9.2.12. datafile_path([filename]) 11.4.9.2.12.1. Arguments filename (optional A filename 11.49.2.12.2. Returns “The full pathname fora file in wireshark’s configuration directory 11.4.9.2.13. register_stat_cmd_arg(argument, [action]) Register a fonction to handle a -z option 11.4.9.2.13.1. Arguments argument Argument action (optional) Action 183Appendix A. Files and Folders A.1. Capture Files ‘To understand which information will remain available after the captured packets are saved to a capture file, ifs helpful to know a bit about the capture file contents Wireshark uses the libpeap file format as the default format to save captured packets; this format has existed fora long time and it's pretty simple. However, it as some drawbacks: it's not extensible and lacks some information that would be really helpful (e.g. being able to add a comment to a packet such as “the ‘problems start here would be really nice) In addition to the libpeap format, Wireshark supports several different capture file formats. However, the problems described above also applies for these formats. AA new capture file format "PCAP Next Generation Domp File Format which will fix these drawbacks. However, i till might take a while until Wireshark can use it is currently under development, new file format is ready and A.1.1,. Libpeap File Contents ‘At the start of cach libpeap capture file some basic information is stored like a magic number to identify the libpcap file format. The most interesting information of this file start is the link layer type (Ethernet, Token Ring, .. The following data is saved for each packet: + the timestamp with millisecond resolution + the packet length as it was “on the wire + the packet length a it’s saved in the file + the packet's raw bytes A detailed description of the libpcap file format can be found at: hitp:/wiki, wireshark org/Development/ LibpeapFileFormat A.1.2. Not Saved in the Capture File + current selections (selected packet, ..) + name resolution information, see Section 7.7, “Name Resolution” for details Warning! A The name resolution information is rebuilt each time Wireshark is restarted so this information might even change when the capture file is reopened on the same machine later! 184Files and Folders + the number of packets dropped while capturing + packet marks set with "EdivMark Packet" + time references set with "EdivTime Reference” + the current display filter A.2. Configuration Files and Folders Wireshark uses @ number of files and folders while it is running. Some of these reside in the personal ‘configuration folder and are used to maintain information between nuns of Wireshark, while some of them are maintained in system areas Tip "A Tistof the folders Wireshark actually uses can be found under the Folders tab in the dialog box shown when you select About Wireshark from the Help menu ‘The content format of the configuration files isthe same on all platforms. However, to match the different policies for Unix and Windows platforms, different folders are used for these file 185Files and Folders Table A.1. Configuration files and folders overview File/Folder |Description {UniwLinux _| Windows folders folders preferences [Settings from the|/etc/ ‘SEWIRESHARK\wireshark.conf, Preferences dialog wireshark.conf, _|SAPPDATA‘\Wiresharkipreferences box, 'SHOMEY.wireshar preferences recent Recent GUI SHOMEY.wiresharkAPPDATA%\Wiresharkirecent setings (eg. recent recent files lists) filters (Capture filters. | SHOME/.wireshark/WIRESHARK%\cfilters, APPDATA filters \Wiresharktefilters ‘filters Display fiers. | SHOMEI.wiresharkWIRESHARK®dfilters, SAPPDATA% filters \Wiresharktdfilters colorfilters [Coloring nules. | SHOME/.wiresharl/WIRESHARKicolorfilters, GAPPDATA, colorfilters ‘AWireshark\colorfilters disabled_protos| Disabled ‘SHOME/. wiresharkWIRESHARK®disebled_protos, protocols, disabled_protos _|%APPDATA\Wireshark\disabled_protos thers [Ethemet _name|/etcethers, ‘EWIRESHARK‘\ethers, _ GAPPDATA% resolution 'SHOME!. wireshark{Wiresharkethers ethers manuf [Ethernet _name|/ete/manuf, ‘@WIRESHARK‘%\manuf, %APPDATA% resolution. ‘SHOME!wireshark§Wireshark\manuf manuf hosts TP and _IPv6|/etchhosts, ‘GEWIRESHARK“élhosts, _ %APPDATA% name resolution. | SHOMEY.wiresharkfWireshark\hosts hosts ‘services Nevwork services. [/etc/services, | GWIRESHARK “services, GAPPDATA% ‘SHOMEL.wireshark{Wireshark'services ‘subnets TP v4 subnet name|/ecc/subnets, __|%WIRESHARK®subnets, %APPDATA% resolution. ‘SHOMEL wireshark{Wiresharkisubnets subnets ipxnets 1PX nhame|fete/ipxnets, __|WIRESHARK“\ipxnets, %APPDATA% resolution, 'SHOMEL.wireshark{Wiresharkipxnets ipxnets plugins Plugin directories. |/ust/share/ ‘GWIRESHARK%\plugins\cversion>, wwireshark/ ‘APPDATA %\Wireshark\plugins plugins, /ust/local! shate/wireshark plugins, ‘SHOMEL.wireshark/ plugins temp ‘Temporary files, Environment: _|Environment: TMPDIR or TEMP TMPDIR 186Files and Folders [A Windows folders GAPPDATA% points to the personal configuration folder, eg.: C:\Documents and Set \Application Data (details can be found at Section A.3.1, “Windows profiles"), ‘WIRESHARK% points to the Wireshark program folder, ¢.& Wireshark Unix/Linux folders The /ete folder is the global Wireshark configuration folder. The folder actually used on your system may vary, maybe something like: /usr/Local/ete, SHOME is usually something like: /home/ preferences/wireshark.cont This file contains your Wireshark preferences, including defaults recent filters filters for capturing and displaying packets. It ise simple text file containing statements of the form: ‘The settings from this fle are read in at program start and written to disk when you press the Save button in the "Preferences" dialog This file contains various GUI related settings like the main window position and size, the recent files list and such. It is a simple text file containing statements of the form: I is read at program start and written at program exit This file contains all the capture filters thet you have defined and saved. It consists of one or more lines, where each Tine has the following format: ‘The settings from this file are ead in at program star and written to disk when you press the Save button in the "Capture Filters’ dialog This file contains all the display filters thet you have defined and saved. It consists of one or more lines, where each Tine has the following format: 187Files and Folders ‘The settings from this file are read in at program start and written to disk when you press the Save button inthe "Display Filters" dialog box. colorfilters ‘This file contains all the color filters that you have defined and saved. It consists of one or more lines, where each line has the following format: Gcfilver nane>2efilver ring>€l] [] “The settings from this file are ead in at program start and written to disk when you press the Save button in the "Coloring Rules’ dialog box. disabled_protos Each line in this file specifies a dissbled protocol name. The following are some examples: aap ‘The settings from this fle are read in at program start and written to disk when you press the Save button in the "Enabled Protocols" dialog box. ethers ‘When Wireshark is trying to translate Ethernet hardware addresses to names, it consults the files listed in Table A.J, “Configuration files and folders overview" If an address is not found in fete/ethers, ‘Wireshark looks in SHOMEZ. wireshark/ethers [Bach line in these files consists of one hardware address and name separated by whitespace. The digits of hardware addresses are separated by colons (2), dashes (-) or periods(). The Following are some examples: sepeeseseee Pe rereravarrs 90.2b.06.93.4b.al Freds_machine ‘The settings from this file are read in at program start and never written by Wireshark, ‘manuf Wireshark uses the files listed in Table A.1, “Configuration files and folders overview" to translate the first three bytes of an Ethernet address into a manufacturers name, This file has the same format as the ethers file, except addresses are three bytes long. An example is 90:00:01 xerox 4 x2n0x conPoRATTON ‘The settings from this file are read in at program start and never written by Wireshark, 188Files and Folders hosts subnets ipxnets ‘Wireshark uses the files listed in Table A.J, “Configuration files and folders overview” to translate IPv4 and IPV6 addresses into ‘This file has the same format as the usual /ere/hosts fle on Unix systems, An example is: # Comments must be prepended by the # ekan! 192,168,0.1 nomeseever ‘The settings from this file are read in at program start and never written by Wireshark, Wireshark uses the files listed in Table A. 1, “Configuration files and folders overview" to translate por numbers into names. An example is nydne S065/udp 4 My own Domain Mame Server yn Soas/icp —# My own Domain Name Server ‘The settings from this file are read in at program start and never written by Wireshark, Wireshark uses the files listed in Table A.1, “Configuration files and folders overview" to wanslate an IPv4 address into a subnet name. If no exact match from the hosts file or from DNS is found, ‘Wireshark will atempt a partial match for the subnet of the address. ach line of this file consists of an IPv4 address, a subnet mask length separated only by a’ and a name separated by whitespace While the address must be a ull [Pv address, any values beyond the mask length are subsequently ignored An example is 4 Comments mast be prepended by the # sign! 192.168.0.0/24 ws_tast_network A. partially matched name will be printed as nname.remaining-address". For example, "192.168.0.1 subnet above would be printed as "ws_test_network. 1"; if the mask length above had been 16 rather than 24, the printed address would be "Ws test_network 0.1" ‘The settings from this file are read in at program start and never written by Wireshark, Wireshark uses the files listed in Table A.1, “Configuration files and folders overview” to translate IPX network numbers into names. 189Files and Folders An example is The settings from this file are read in at program start and never written by Wireshark. plugins folder Wireshark searches for plugins in the directories listed in Table AL ‘Configuration files and folders overview". They are searched in the order listed, temp folder If you start @ new capture and dontt specify a filename for it, Wireshark uses this directory to store that file; see Section 4.8 “Capture files and file modes”, A.3. Windows folders Here you will find some details about the folders used in Wireshark on diffeei indows versions. As already mentioned, you can find the currently used folders in the About Wireshark dialog, A.3.1. Windows profiles Windows uses some special directories to store user configuration files which define the "user profile” This can be confusing, as the default directory location changed from Windows version to version and ‘ight also be different for English and internationalized versions of Windows. | A Note! If you've upgraded to new Windows version, your profile might be kept in the former location, so the defaults mentioned here might not apply ‘The following guides you to the right place where to look for Wireshark’s profile data, Vista cu) sers\\appbata\Roaming Wizeshark XP/2000 C:\Documents and Settinga\ \Applicat Data, "Documents and Settings” and "Application Data” might be internationalized, NT-4 (no longer supported by —_C: \WINNT\Profiles\\appl Wireshark) Data\Wiceshack MEJ8 - with enabled user In Windows ME and 98 you can enable separate user profiles (no longer supported by profiles. In that case, something like: C:\windows\Pro£. Wireshark) \Application Data\Wizeshark is used MEZ/98/95 (no longer supported The default in Windows ME/98095 is: all users work with the by Wireshark) same profile, which is located at: C: \windows \Appl ication pata\Wireshark 190Files and Folders A.3.2. Windows Vista/XP/2000/NT roaming profiles ‘The following will only be applicable if you are using roaming profiles. This might be the case, if you ‘work in a Windows domain environment (used in company nesworks). The configurations of all programs ‘you use won't be saved on the local hard drive of the computer you are currently working on, but on the ‘domain server. As Wireshark is using the correct places to store its profile data, your settings will travel with you, if you logon to a different computer the next time. ‘There is an exception to this: The "Local Settings" folder in your profile data (typically something like: and Settings\\Local Settings) will not be transferred to the domain server. This is the default for temporary capture files. c:\Doeume: A.3.3. Windows temporary folder ‘Wireshark uses the folder which is set by the TMPDIR or TEMP environment variable. This variable will be set by the Windows installer. Vista XXX — could someone give information about this? XP/2000 Cc: \D uments and Settings\\Local Settinga\temp NT4 sc: \TeMe 19Appendix B. Protocols and Protocol Fields Wireshark distinguishes between protocols (c.g. tcp) and protocol fields (e.g. tep por!) A comprehensive list of all protocols and protocol fields can be found at: hsp://www wireshark.org/does! defi 192Appendix C. Wireshark Messages Wireshark provides you with additional information gencrated out ofthe plain packet data or it may need to indicate dissection problems. Messages generated by Wireshark arc usually placed in {] parentheses. C.1. Packet List Messages ‘These messages might appear in the packet list. C.1.1. [Malformed Packet] ‘Malformed packet means that the protocol diss ‘There can be various reasons: ‘or can't dissect the contents of the packet any further. + Wrong dissector: Wireshark erroneously has chosen the wrong protocol dissector for this packet. This will happen e.g. if you are using a protocol not on its well known TCP or UDP port. You may try AnalyzelDecode As to circumvent this problem, + Packet not reassembled: The packet is longer than a single frame and it is not reassembled, see Section 7.6, “Packet Reassembling” for further details + Packet is malformed: The packet is actually wrong (malformed), meaning that a part of the packet is just not as expected (not following the protocol specifications) + Dissector is buggy: The corresponding protocol dissector is simply buggy or still incomplete, Any of the above is possible. You'll have ‘a look into the specific situation to determine the reason. You ‘could disable the dissector by disabling the protocol on the Analyze menu and check how Wireshark displays the packet then. You could (if i's TCP) enable reassembly for TCP and the specific dissector (if possible) in the EditPreferences menu. You could check the packet contents yourself by reading the ppacket bytes and comparing it to the protocol specification. This could reveal a dissector bug. Or you could find out thatthe packer is indeed wrong. C.1.2. [Packet size limited during capture] ‘The packet size was limited during capture, see "Limit each packet to n bytes” at the Section 4.5, “The "Capture Options” dialog box", While dissecting, the current protocol dissector was simply running out of packet bytes and had to give up. There's nothing else you can do now, except to repeat the whole capture ‘process again with a higher (or no) packet size limitation, C.2. Packet Details Messages ‘These messages might appear in the packet details, C.2.1. [Response in frame: 123] ‘The current packet is the request of a detected requesvresponse pair. You can directly jump to the corresponding response packet just by double elicking on this message. C.2.2. [Request in frame: 123] Same as "Response in frame: 123" above, but the other way round, 193Wireshark Messages C.2.3. [Time from request: 0.123 seconds] The time between the request and the response packets C.2.4. [Stream setup by PROTOCOL (frame 123)] ‘The session control protocol (SDP, H225, etc) message which signaled the creation of this session. You can directly jump to the corresponding packet just by double clicking on this message. 194Appendix D. Related command line tools D.1. Introduction Besides the shark GUI application, there are some command line tools which can be helpful for doing -cialized things. These tools will be described in this chapter. D.2. tshark: Terminal-based Wireshark ‘TShark is a terminal oriented version of Wireshark designed for cepturing and displaying packets when an interactive user interface isn't necessary or available. It supports the same options as wireshark. For more information on tshark, sce the manual pages (man tshark). D.3. tcpdump: Capturing with tcpdump for viewing with Wireshark ‘There are occasions when you want to capture packets using tepdump rather than wireshark, especially when you want to do a remote capture and do not want the network load associated with running Wireshark remotely (not to mention all the X traffic polluting your capture) However, the default tepdump parameters result ina capture file where cach packet is truncated, because most versions of tepdump, will, by default, only capture the first 68 or 96 bytes of cach packet. To ensure that you capture complete packets, use the following command: You will have to specify the correct interface and the name of a file to save into. In addition, you will have to terminate the capture with “C when you believe you have captured enough packets. | A Note! J epdump is not part of the Wireshark distribution. You can get it from: hp: www tepdump org for various platforms D.4. dumpcap: Capturing with dumpcap for viewing with Wireshark Dumpcap is a network traffic dump tool. It captures packet data from a live network and writes the packets toa file. Dumpcap's native capture file format is libpeap format, which is also the format used by Wireshark, tepdump and various other tools. Without any options set it will use the peap library to capture traffic from the first available network interface and write the received raw packet data, along with the packets’ time stamps into a libpeap fil. 195Related command line tools Packet capturing is performed with the pap library. The capture filter syntax follows the rules of the peap Library. Example D.1. Help information available from dumpcap dunpeap -h Dompeap 1.1.4 Capture network packste and dump thom into a libpeap file: See htep://imn.wireshark.ora for more information Veage: dumpeap (options) sure interface: 4s cintorface> nama or idx of interface (def: first non-loopback) packet filter in libpeap filter eyntax “2 packet snapshot length (def: 63535) a don"t capture in promiscuous mode Ob cbutter stze> size of kernel buffer (def: IMB) oy elink type> Link layer type (dof: first appropriate) 2 print list of interfaces and exit 1 print list of Link-layer types of iface and exit “3 Print gtatisrics for each interface once every second 4 for -B, 1, and -8 produce machine-readable output “e packet count> stop after n packets (def: infinite) Sa cutostop cond.> ... duration:nUM "stop after NUM seconds Filesize:NUM ~ ctop this file after NUM KE Files:NuM ~ stop after NUM files, output (#ile8) “we name of file to save (def: tompfile) Oh exingbufter opt.> ... duration:NlM — geiteh to next file after NUM secs Silesize:Nll! — switch co next tle after NUY RP Files: ~ ringbuffer: replace after NUM files on ‘use peapng format inctead of pcap vsecellaneove S print version information and exit a display this help and exit Example: dumpeap ~i oth -a duration:60 -x output .peap SCapture network packets from intertace eth until sls pacsed into output pear Use ctrl-c te stop capturing at any time D.5. capinfos: Print information about capture files Included with Wireshark is a small utility called eapinfos, which is a command-line utility to print information about binary capture files. 196Related command line tools Example D.2. Help information available from capinfos 8 capintos -h pintos 11. Prints information about capture files See http://nt.wireshark.org for more information Usage: capinfos [options] ceneral “t display the capture file type “E digplay the capture file encapevlation “e display tho number of packsts “ display tho size of the file (in bytes) “4 display the total length of all packets (in bytes) time “v dieplay the capture duration (in seconds) -a display the capture start time “e display the capture end time “y display average data rate (in bytes/sec) “i digplay average data rate (in bite/eec! “2 display average packet size (in bytes) “x digplay average packet rate (in packets/sec! vsecellaneovs “h digplay thie help and oxit If no options are given the default is to display all infos D.6. editcap: Edit capture files Included with Wireshark is small utility called editeap, which is a command-line utility for working with ‘capture files. Its main function is to remove packets from capture files, but it can also be used to convert ‘capture files from one format to another, as well as to print information about capture files, 197Related command line tools Example D.3. Help information available from editcap 8 editeap -h Editeap 1.1.4 Edit and/or translate the format of capture files See hetp://innewireshark.org for more information Usage: editeap [options) ... ( ) 0. | and must both be present: A single packet or a range of packets can be selected Packet selection “r keep the selected packets; default is to delete thom. Ok cotart tine on't output packets whose timestamp #9 before che given tine (format as YYYY-#W-0D hhimm:es) -B Son't output packets whose timestamp 1 after the Given tine (format ag YYYY-4W-DD hhiem:es) Duplicate packst removal "3 remove packet if duplicate (window == 5) =D ie specified in relative seconds (ea. 0.000001) NOTE: The use of the “Duplicate packet romoval’ options with ‘other editeap options except —v may not always work ag expected Specifically the -r and -t options will vory likely NOT have the Secired effect if combined with shed, Bor -¥ Packet manipulation “e runcate each packet to max. bytes of data - chop each packet at the and by bytes, “t adjust the timestamp of each packet) Stine adquetment> is in relative seconds (e-7- -0.9) “E sot the probability (betwoon 0.0 and 1.0 incl.) ‘that a particular packet byte will be tandomly changed output Files) “¢ split the packet output to different files based on uniform packet counte with a maximum of cach “4 split the packet output to different files based on uniform tine intervals with a maximum of cach “ sat the output file typo; default ie Libpcap. an enpty "-F* option will list the file types -t set the output file encapeulacion type; default is the came as che input file an empty "-T" option willl list the encapsulation tyres vsecellaneove “r dieplay this help and exit. oo verbose output If -v ig used with any of the “Duplicate Packet Removal’ optione (3, -p or x) then Packet lenazhe and MES hashes are printed to standard-out 198Related command line tools Example D.4. Capture file types available from editeap 8 ediveap -F editcap: option requires an argunent —— F editcap: The available capture file types for “F* Libpeap ~ Rireshark/tepdump/... ~ Libpcap necclibpcap ~ Wireshark ~ nanosecond Libpeap modlibpeap ~ Modified tepdump ~ libpcap nokialibpeap — Nokia tepsunp — Libpeap rhé_llibpeap ~ RedHat 8.1 tepdump ~ Libpeap suses_3libpeap ~ SuSt §.3 tepdump ~ Libpeap Sviows — Accellent sViows capture fict2000 - Catapult UCTZ000 trace (.out format) novel ~ HP-UX note crace etmonl ~ Microsoft Netwon 1.x etmon? ~ Microsoft Netton 2. naoniffer - RA Sniffer (DOS) navonifrer il ~ NA Sniffer (Windows) 1.1 nawaniffor=2_0 — NA Sniffer (Rindows) 2.00% niobservers?- Network Instrumente Observer (V3) analyzer ~ Novell LaNalyzer snoop ~ Sun snoop TES Tektronix Kl2ex 32-bit rf format ‘igual ~ Visual Networks traffic capture ki2tewe ~ R12 text fle conmuiow — TamoSort CommViox peapng ~ Wireshark ~ peapng (experimental) Example D.5. Encapsulation types available from editeap 8 editeap -T editcap: option requires an argument ~~ T editcap: The available encapsulation types for “T* ‘ether — Fehernet r= Token Ring slip ~ SLIP pr ~ PPP fans — FDDT foat-owapped — FDI with bit-owapped MAC addresses ravip ~ Raw TP arenet — ARCKET arenet_linox — Linwe ARCKET sem recie3 — RFC 1283 ATH Linux-atm-clip ~ Linux ATM CLIP ap — TAPE. atm-pdus — ATM PLUS atm-paus-untruncated - ATM PLUs - untruncated nell NULL ascend ~ tucent/Ascand access equipment Sean Tsp spover- fo — RFC 2629 1P-over-Fabre channel ppp with direction — PPP with Directsonal Info Seee 802-11 - TEEP 902.11 nizelees 2AN prim ~ TEFE 802-11 plus Prion TT monitor mode header Seee 802-I1-radio - TEEF 802.11 @ireless LAK with radio information ieee-802-11-radiotap - THEE 802.11 plus radiotap KLAN header ieee-802-11-ave TERE 802.11 plus AVS WLAN header Linux-sll ~ Linux cooked-node capture frelay ~ Frano Relay Erelay-with-airection ~ Frane Relay with Directional Info chale — Chaco HDLC Sos - Chace ToS internal ital ~ localzale 199Related command line tools pfloq-old opens PF Firewall loag, pre-3.é hnale — faPach HDI Gocsis — Bata Over Cable Service Interface Specification cosine - Cosine 12 debug loa whdle ~ Kellflect Hie sole ~ Sbic ‘tzep - Tazman sniffer protocol fone ~ openPSh ene (é) eneapevlacing interface flog ~ OpenBsb PF Firewall logs Ehdle-with direction — taco HDLC with Dérecttonal Info bluetooth hé Bluetooth He mop? S87 MIRO pep) — 687 STFS Seda spa veer — USER O seri — USER 1 vvser? — USER 2 seri — USER 3 sere — USER 4 veers — USER 5 seré — USER 6 ser? — USER 7 vsers — USER § voerd — USER 9 seri ~ USER 10 veeril — USER 11 seri? — USER 12, seri} — USER 13, veerlé — USER 14 seri — USER 15 symantec ~ Symantec Enterprise Firewall apl33é ~ Apple TP-over-TEFE 1334 bbacnet-me-tp ~ BACRot MS/TP rawicnp nett) — Raw ICMP with nettl headere raw-icmpes-nectl ~ Raw TcMPus with nettl headers apre-Lle ~ GPRS Lic juniper-atml - Juniper ATM juniper-atn2 — Juniper ATM2 redback ~ Redback snartFdge rawip-netel — Raw IP with nettl headers ether-nettl — Fehernet with nectl headers ‘tr-nettl ~ Token Ring with nett] headers foat-nettl — FED with nett] headers tunknewn-nettl ~ Unknown link-layer type ith nettl headers mipe-with-phor — HTP? wich pocudoheader junipor-prpoe ~ Juniper PEPOE acon-tiel ~ ', Any lines of text between the bytestring lines is ignored. The offsets are used to track the bytes, so offsets must be correct. Any line which has only bytes without a leading offset is ignored, An offset is recognized as being a hex number longer than two characters. Any text after the bytes is ignored (¢.g. the character damp). Any hex numbers in this text are also ignored. An offset of zero is indicative of starting a new packet, soa single text fle wih a series of hexdummps can be converted to & packet capture with multiple packets. Multiple packets are read in with timestamps differing by one second each, In general, short of these restrictions, text2pcap is prety liberal about reading in hexdumps and has been tested with variety of mangled outputs (including being forwarded through email multiple times, with limited line wrap et.) ‘There are a couple of other special features to note. Any line where the first non-whitespace characteris # will be ignored as a comment. Any line beginning with #TEXT2PCAP is a directive and options can be inserted after this command to be processed by text2peap. Currently there are no directives implemented; in the future, these may be used to give more fine grained control on the dump and the way it should be processed e.g. timestamps, encapsulation type etc ‘Texpcap also allows the user to read in dumps of application-level data, by inserting dummy L2, L3 and L4 headers before each packet, Possiblities include inserting headers such as Ethernet, Ethernet + IP, Ethemet + IP + UDP, or Ethernet + Ip + TCP before each packet, This allows Wireshark or any other full- packet decoder to handle these dumps. 203Related command line tools Example D.8. Help information available for text2pcap 8 toxt2pcap -h Toxt2peap 1.1.4 Generate a capture file from an ASCIT hoxdump of packets See htep://inn.wireshark.org for more information Usage: text2pcap [options] whore epecifics input filename (use - for standard input) specifies output filename (use - for standard output) Input “o hoxloct Idee parce offects a6 (hex, (olctal or (decimal; default is hex Ot eeimetme> treats the text before the packet as a date/time code ‘the specified arqunont ig a format string of the sort supporsed by strptine Example: The time “10:15:14.5676" hag the format code seishwens.” NOTE: The subsecond component delimiter must be given (:) but no pattern ie required; the remaining number 6 agsuned to be fractions of 2 second Note: Date/time fields from the ovrrent date/tine are used as the default for unspecified fields. “1 Link-layer type number; default is 1 (Ethernet) See the file net/bpf-h for list of numbers Use this option if your dump ie a complete hex dump ‘of an encapsulated packet and you wish to specify ‘the exact type of encapaulacion Example: 117 for ARCNeE packers -m max packet length in output; default is 64000 Propend duray header: we prepend dummy Ethernet IT header with specified 19PmD (in HEX) Example: “2 0x806 to specify an ARP packet “4 , __propand dummy UDP header with spocitied est and eource porte (in DECTYAL) Automatically propends Ethernet ¢ TP headers a¢ voll Example: -u 1000 $3 co make the packets look like TFTP/UDP packets. -T __propand dummy ToP header with pacified est and eource porte (in DECTYAL) Automatically propends Ethernet ¢ IP headers a¢ voll Example: -T 50, 60 “e ,, propand dummy SCTP header with epecified Sect/source porte and verification caq (in DECIMAL) Automatically propends Ethernet ¢ TP headers ag woll Example: -e 30, £0, 34 “8 ,, propend dummy SCTP header with epecified Sect /source porte and verification tag 0. Automatically prepends a dummy SCTP TATA chunk header with payload protocol identifier ppi Example: 8 30, £0,.36 wsecellaneove “r dieplay this help and exit. “4 detailed debug of parser states “a generate no output at all (automatically turns off -4) 204Related command line tools D.9. idl2wrs: Creating dissectors from CORBA IDL files In an ideal world idl2wrs would be mentioned in the users guide in passing and document developers guide. As the developers guide has not yet been completed it will be documented here D.9.1. What is it? ‘As you have probably guessed from the name, idI2Wrs takes a user specified IDL. file and attempts t0 build a dissector that can decode the IDL traffic over GIOP. The resulting file is "C” code, that should ‘compile okay as a Wireshark dissector, in the ial2wrs basically parses the data struct given to it by the omniidl compiler, and using the GIOP API available in packet-giop [ch], generates get_CDR_xxx calls to decode the CORBA traffic on the wire. consists of 4 main files README. idi2wrs This document wireshark_be ‘The main compiler backend wireshark_gen.py helper class that generat the C code, dl2wes ‘A simple shell script wrapper that the end user should use to generate the dissector from the IDL. file(s) D.9.2. Why do this? It is important to understand what CORBA taffic looks like over GIOP/IIOP, and to help build 2 tool that can assist in woubleshooting CORBA interworking. This was especially the ease after seeing a lot of. discussions about how particular IDL types are represented inside an octet stream, have also had comments/feedback that this tool would be good for say a CORBA class when teaching students what CORBA traffic looks like "on the wire It is also COOL to work on a great Open Source project such as the case with "Wireshark" ( hep:/ www, wireshark org ) D.9.3. How to use idl2wrs To use the id2wrs to generate Wireshark dssectors, you need the following: Prerequisites to using idl2wrs 1. Python must be installed. See http://python.org/ 2. omniidl from the the omniORB package must be available. See htp//omniorb sourceforge.net/ 3. Of course you need Wireshark installed to compile the code and tweak it if required, idl2wrs is part of the standard Wireshark distribution To use idl2wrs to generate an Wireshark dissector from an idl file use the following procedure: 205Related command line tools Procedure for converting a CORBA idl file into a Wireshark dissector 1, Towrite the C code to stdout sdldurs eg. 2. Towrite toa fil, just redirect the ourput. sdlzwre yo.tdh > pi e-idl.e ‘You may wish to comment out the register_giop_user_moduleQ) code and that will leave you with heuristic dissection. If you don't want to use the shell script wrapper, then try steps 3 oF 4 instead. 3. To write the C code to stdout 1: omniidl -p ./ -b wiroshark be J wizesnerk 4. Towrite to file, just redirect the output. ildl op o/b wirasnerk echo tdi > packet test tate ‘You may wish to comment out che register_giop_user_module() code and that will leave you with heuristic dissection. 5S. Copy the resulting C code to subdirectory epanidissectors/ inside your Wireshark source directory. ep Ps sevidl.e /aie/n (rs reshark/ Lives /epan/dia ‘The new dissector has tobe added to Makefile.common in the same directory. Look for the declaration CLEAN_DISSECTOR_SRC and add the new dissector there. For example, becomes For the next steps, go up to the top of your Wireshark source directory. 6 Run configure feontigure (or -/eutogen-sh) 7. Compile the code 206Related command line tools 8. Good Luck !! D.9.4. TODO 4, Exception code not generated (yet), but can be added manvally. Enums not converted to symbolic values ot), but can be added manually, ‘Add command line options ete More Iam sure :>) D.9.5. Limitations Sce the TODO list inside packet-giop.c D.9.6. Notes 1 The "-p ." option passed to omniidl indicates that the wireshark_be.py and wireshark_gen.py are residing in the current directory. This may need tweaking if you place these files somewhere els. fit complains about being unable to find some modules (c.g. tempfile py), you may want to check if PYTHONPATH is set correctly. On my Linux box, itis PYTHONPATH=Vusrlib/python2.4/ 207Appendix E. This Document's License (GPL) ‘As with the original licence and documentation distributed with Wireshark, this document is covered by the GNU General Public Licence (GNU GPL). If you haven‘ read the GPL before, please do so. Itexplains all the things that you are allowed to do with this code and documentation. GRU GENERAL PUBLIC LICENSE Version 2, June 1391 copyright () 1989, 1991 Free Software Foundation, Ine 53 Tomple Place, suite 330, Boston, YA O2111-1307 USA Everyone ig pormittad to copy and distribute verbatim copies fof this License document, but changing it is net allowed Preamble ‘The Iicenses for most software are designed to take away your Freadom to share and change it. By contract, the GNU General Public License is intended to quarantes your freedom to share and change free software. to make gure the software ig free for all see users. This General Public License applies to most of the Free Software Foundation’s software and to any other program whoge authors commit to vaing i. (Sone other Free Software Foundation software se covered by ‘the GNU Library General Public Licence inetead.) You can apply i to hen we speak of free software, we are referring to freedom, not price. Our General Public Licenges are designed ro make sure that you have the freadom to distribute copies of free software (and charge for this service if you wish! that you receive source code or can get it Af you want it, that you can change the software or use pieces of it in now free programe; and that you know you can do these things To protect your rights, ve need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights: These restrictions tranelate to cortain responsibilities for you if you distribute copies of the software, oF $f you moaisy 4 For example, if you distribute copies of such a program, whether gratis or for a feo, you must give the recipiante all the rights that You have. You mst make gure that they, £00, receive or can got the source code. And you must chow them these terms so they know shear rights, ie protect your rights with evo steps: (1) copyright the software, and (2) offer you this License which gives you legal permission £0 copy, distribute and/or modify the software leo, for each author's protection and ours, we want to make certain hat everyone understands that there is ne warranty for this free software. If the software is modified by someone else and passed on, we want ite recipiente to know shat what they have se not che original, eo ‘that any problone introduced by othere will not reflect on the original authors" repucations: Finally, any free program is threatened constantly by software patents. Me wich to avoid the danger that redistributors of a free 208‘This Document’s License (GPL) program will individually obtain patent licenses, in effect making the Program propristary. To prevent this, xe have made st clear chat any patent mst be Licensed for everyone's frea use or not licensed at all, ‘The procice terme and conditions for copying, distribution and nosifieation follow. GRU GENERAL PUBLIC LICENSE ‘TERMS. AND CONDITIONS FOR COPYIN 0. This License applies to any program or other work which contains ‘a notice placed by tho copyright holder saying it way be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work baced on the Proaran” eane either the Proqram or any derivative work onder copyriqhe lav that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or tranelaved into another Janquage. (Hereinafter, eranelation ig sncluded wiehout Limitation an ‘the term *modification".) Fach liconeee is addressed as "you" Activities other than copying, distribution and modification are not covered by this Licance; thoy are outside its scope. The act of running the Program is not restricted, and the output from the Program Se covared only if ite contents constitute a work based on the Program (independant of Raving been made by running the Program) ‘hethor that is true depends on what the Program dovs 1. You may copy and distribute verbatim copies of the Proaran'e source code ae you Teceive it, in any medium, provided chat you conspicuously and appropriately publich on each copy an appropriate copyright notice and disclaimer of warranty; Keep intact all the notices that refer to thie License and to the absence of any warrantys and give any other recipients of the Progran a copy of this License along with the Program, You may charge a foc for tho physical act of transferring a copy, and you say at your option offer warranty protection in exchange for a feo 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and Gsetribute ouch modifications or work under the terms of Section I above, provided that you also meet all of these conditions a) You must cause the modified files te carry prominent notices stating that you changed the files and the date of any change b) You must cause any work that you distribute or publish, that in whole or in part contain or se derived from the Program oF any part thereof, ro be licensed ag a whole at no charge to all third parties under the terms of thie License €) Tf the modified program normally reads commands interactively sehen ron, you must cause #t, when starced running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, eaying that you provide a warranty) and that users may redistribute the program under ‘these conditions, and telling the user how to view a copy of this Licenso. (Exception: if tho Program iteelf is interactive but does not normally print uch an announcement, your work haged on ‘the Program ig not required to print an announcement.) ‘These requirements apply to the modified work asa whole. If identifiable sections of that work are not derived fron the Program, and can be reasonably considered independent and separate works in ‘hengelves, thon this License, and ite terms, do not apply to those sections when you distribute them as separate works, But when you 209‘This Document’s License (GPL) Ssetribute the sane sections ae part of a whole which ie a work based fon the Program, the distrshutson of the whole must be on the terme of this License, whose pormiceions for other licensees extend to the fontire whole, and thus to each and ovary part regardless of who wrote it. ‘Thus, i ie not the intent of this section to claim rights or contest your’ rights to work written entirely by yous rather, the intent is te exercise the right to control the distribution of derivative or collective works based on the Proaram. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on che Program) on a volume of 4 storage of distribution medium does not bring the other work onder ‘the scope of thie Liconee 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terme of Sections 1 and 2 above provided that you aleo de one of the following: 1a) Accompany it with the complete corresponding machine-readable sources code, which must be dictributed under the terms of Sections Land 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically porforming source distribution, a complete machine-readable copy of the corresponding source’ code, to be Gsetributed under the terms of Sections | and 2 ahove on a medium customarily used for software interchange; ory c) Accompany it with the information you received as to the offer to distribute corresponding source code. (Thie alternative ie allowed only for noncommercial disteshurion and only 1 you received the program in object code or executable form with uch an offer, in accord with Subsection b above.) ‘The source code for a work means the preferred form of the work for making modifications to it. For an execvtable wore, complete source code moans all the source code for all modules it containe, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. Howover, as a special exception, the source code distributed need not include anything that ie normally distributed (in either souree or binary form) with the major components (compiler, kernel, and 90 on) of the operating system on which the executable tune, unless that component, itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the came place counts as Ssetribution of the source code, evan though third parties are not compelled to copy the source along with the object code 4, You may not copy, modify, eublicenss, or distribute the Program ‘oxcopt a6 expracely provided under this License. Any atterpt otherwise to copy, modify, sublicense or distribute the Program ie void, and will automatically terminate your rights under thie License However, partice who have received copies, or rights, from you under this liense will not have thet licenses terminated o long as such parties remain in full compliance: 5. You are not required to accept this Licenses, since you have not signed it. However, nothing elee grants you permission to modify or Gsetribute the Proqran or ite derivative works. These actions are prohibited by law if you do not accopt this License. Therefore, by modifying or distributing the Program (er any work based on the Program), you indicate your acceptance of thie Licenge to do Go, and 210‘This Document’s License (GPL) all ite terms and conditions for copying, distributing or modifying The Program or works based on $¢ 6. Bach time you redistribute the Program (or any work based on the Program), the recipient automatically recetves a license from the original Licensor to copy, distribute or modify the Program eubject to these tors and conditions. You say not impose any further restrictions on the recipiante’ exercise of the rights granted herein. You aro not responsible for enforcing compliance by third parties to thie License 2. Tf, ae a consequence of a court judgment or allegation of patent infvingoment or for any other reason (not Limited to patent issues), conditions ara imposed on you (whether by court order, agreament oF otherwise) that contradict the conditions of this License, they do not ‘excuse you from the conditions of thie License. If you cannot distribute co as to satisfy simultaneously your obligations under this Licance and any other pertinent obligations, then ac a consequence you may not distribute tho Program at all. For example, if a patent License would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then ‘the only ay you could eatisty both it and thie License would bo to refrain entirely from distribution of the Program. If any portion of this section ss held invalid or unenforceable under any particular circunstance, the balance of the section ie intended to apply and the section aoa whole $2 intended to apply an other It ie not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any Such claine; this section has the sole purpose of protecting the Sncegrity of the free software distribution system, which 2 implononted by public license practices. Many poople have made generous contributions to the wide range of software diserthuced through that eysten in reliance on consistent application of that system; it is up to the author/donor te decide if he or che is willing to distribute software through any other system and a licensee cannot impose that choice: ‘This section ie intended to make thoroughly clear what ie believed to be a consequence of the reat of this Licance 8, Tf the distribution and/or use of the Program ie restricted in cortain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under thie Licence may add an explicit geographical distribution Limitation excluding ‘those countries, so that distribution is pormittad only in or anong countries not thus excluded. In auch casa, this License incorporates, the limitation ae 4£ written in the body of this License. 9. The Free Software Foundation may publish revised and/or new voreions of the General Public ticense from time to time. Such new versions will) be similar in spirit to the present version, but may differ in detail co address new probleme oF concerns. Fach version is given a distinguishing version number. If the Program specifies a varcion number of this Iicense which applies to = and "any later version", you have the option of following the terme and conditions either of that’ version or of any later vareion published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choos any version ever publiched by the Froe Software Foundation 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are differant, write to the author fo ack for permseston. For software which se copyriqhted by che Free 2U‘This Document’s License (GPL) Software Foundation, write to the Free Software Foundations xe sometimes make exceptions for thie. Gor decteion will be quided by the two qoale Of preserving che #rea etatus of all derivatives of our free software and ‘of promoting the sharing and reuse of software generally. No RARRANTY 11, BECAUSE THE PROGRAM I LICENSED FREE OF CHARGE, THERE TS NO AARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAR. EXCEPT AHEN COTHERAISE STATED IN ARITING THE COPYRIGHT HOLDERS ARD/OR OTHER PARTIES PROVIDE THE PROGRAM "AS TS" KITHOUT AARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AAD PITHESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS ‘To THE QUALITY AND PERFORMANCE OF THE PROGRAM TS ITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESGARY SERVICIN REPAIR OR CORRECTION. 12. IN No EVENT UNLESS REQUIRED BY APPLICABLE AW OR AGREED TO IN #RITING [RILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY AHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIRBLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECTAL, INCIDENTAL OR CONSEQUENTIAL DAVAGES ARTSING (OUT OF THE USE OR INABILITY To’ USE THE PROGRAM (INCLUDING BUT NOT LIMITED ‘TO 10SS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE ITH ARY OTHER PROGRAMS), EVEN TF SUCH HODDER OR OTHER PARTY HAS BEEN ALVISED OF THE POSSIBILITY OF SUCH DAMAGES: ERD OF TERMS AND CONDITIONS Now to Apply These Terms to Your Now Programs If you develop a nex program, and you want it to be of the qreatest possthle vse to the public, the best way to achieve this s¢ to make st free software which everyone can redistribute and change under these terns: To do go, attach the following notices to the program. It is safest zo attach then to the start of each source file to most effectively convey the exclusion of warranty; and cach file should have at leact She “copyright” line and a pointer to where the full notice $8 found Copyright (€) cnane of avehor> This program ie free software; you can redistribute it and/or modify it under the terme of the GNU General Public License as published by ‘the Freo Software Foundation; either version 2 of the Licence, oF (at your option) any later version ‘his program 9 distributed in the hope that st will be veetel, bot ®ITHOUT ANY ARRANTY; seithout even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GND General Public License for more detasle You should have received a copy of the GNU General Public Licence along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MR 02111-1307 USA leo add information on how to contact you by electronic and paper mail If the program is interactive, make it output a short notice like thie when it starts an an anteractive mode. nomevision version $3, Copyright(C) year name of author Gnomovision cones with ABSOLUTELY NO RARRANTY; for detaile type “show w* This is free software, and you are welcome to redistribute it under cortain conditions; type ‘show c* for details,‘This Document’s License (GPL) ‘The hypothetical commands “show w' and “show c! should show the appropriate parte of the General Public License. Of course, the commands you wee nay bbe called soneching other than show x" and show c'; chey cobld even be rovse-clicks or menu iteng-—hatever ouits your proaran, You should also got your employer (if you work as a programmer) or your school, if any, te eign a “copyright disclaimer" for the program, if necessary. Hore is a comple; alter the names Yoyodyne, Inc.» hereby disclaims all copyright interest in the program Gnonovision’ (which makes pasces at compilers) writtan by Janes Hacker ) 1 April 1389 Ty Coon, President of Vice ‘This General Fublic License doss not permit incorporating your program inte propristary programs. If your program is a eubroutine Library, you may Consider it more useful to permit linking proprietary applications with the Library. Tf chig 4g what you want to do, wee the ckU Tabrary General Public itcense instead of thie Licence 23