Wireshark Developer’s Guide For Wireshark 2.1 Ulf Lamping <ulf.lamping[AT]web.de> Luis E. Ontanon <luis[AT]ontanon.org> Graham Bloice <graham.bloice[AT]trihedral.com> Wireshark Developer’s Guide: For Wireshark 2.1 by Ulf Lamping, Luis E. Ontanon, and Graham Bloice Copyright © 2004-2014 Ulf Lamping, Luis E. Garcia Ontanon, Graham Bloice Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation. All logos and trademarks in this document are property of their respective owners. Preface ............................................................................................................................. ix 1. Foreword ............................................................................................................... ix 2. Who should read this document? ............................................................................... ix 3. Acknowledgements ................................................................................................. ix 4. About this document ............................................................................................... ix 5. Where to get the latest copy of this document? ............................................................. x 6. Providing feedback about this document ...................................................................... x I. Wireshark Build Environment ............................................................................................ 1 1. Introduction ............................................................................................................ 2 1.1. Introduction .................................................................................................. 2 1.2. What is Wireshark? ....................................................................................... 2 1.3. Supported Platforms ...................................................................................... 2 1.3.1. Unix ................................................................................................. 2 1.3.2. Linux ................................................................................................ 2 1.3.3. Microsoft Windows ............................................................................ 3 1.4. Development and maintenance of Wireshark ...................................................... 3 1.4.1. Programming languages used ................................................................ 3 1.4.2. Open Source Software ......................................................................... 4 1.5. Releases and distributions ............................................................................... 4 1.5.1. Binary distributions ............................................................................. 4 1.5.2. Source code distributions ..................................................................... 5 1.6. Automated Builds (Buildbot) .......................................................................... 5 1.6.1. Advantages ........................................................................................ 5 1.6.2. What does the Buildbot do? ................................................................. 6 1.7. Reporting problems and getting help ................................................................ 6 1.7.1. Website ............................................................................................. 6 1.7.2. Wiki ................................................................................................. 6 1.7.3. FAQ ................................................................................................. 7 1.7.4. Other sources ..................................................................................... 7 1.7.5. Mailing Lists ..................................................................................... 7 1.7.6. Bug database (Bugzilla) ....................................................................... 8 1.7.7. Q&A Site .......................................................................................... 8 1.7.8. Reporting Problems ............................................................................ 8 1.7.9. Reporting Crashes on UNIX/Linux platforms ........................................... 9 1.7.10. Reporting Crashes on Windows platforms ............................................. 9 2. Quick Setup .......................................................................................................... 10 2.1. UNIX: Installation ....................................................................................... 10 2.2. Win32/64: Step-by-Step Guide ...................................................................... 10 2.2.1. Install PowerShell ............................................................................. 10 2.2.2. Optional: Install Chocolatey ................................................................ 10 2.2.3. Install Microsoft C compiler and SDK .................................................. 10 2.2.4. Install Qt ......................................................................................... 11 2.2.5. Install Cygwin .................................................................................. 12 2.2.6. Install Python ................................................................................... 12 2.2.7. Install Git ........................................................................................ 13 2.3. Install CMake ............................................................................................. 13 2.3.1. Install and Prepare Sources ................................................................. 14 2.3.2. Open a Visual Studio Command Prompt ............................................... 14 2.3.3. Generate the build files ...................................................................... 15 2.3.4. Build Wireshark ............................................................................... 16 2.3.5. Debug Environment Setup .................................................................. 16 2.3.6. Optional: Create User’s and Developer’s Guide ...................................... 16 2.3.7. Optional: Create a Wireshark Installer .................................................. 16 3. Work with the Wireshark sources ............................................................................. 18 iii Wireshark Developer’s Guide 3.1. Introduction ................................................................................................ 18 3.2. The Wireshark Git repository ........................................................................ 18 3.2.1. The web interface to the Git repository ................................................. 18 3.3. Obtain the Wireshark sources ........................................................................ 19 3.3.1. Git over SSH or HTTPS .................................................................... 19 3.3.2. Git web interface .............................................................................. 20 3.3.3. Buildbot Snapshots ............................................................................ 21 3.3.4. Released sources ............................................................................... 21 3.4. Update the Wireshark sources ........................................................................ 21 3.4.1. Update Using Git .............................................................................. 21 3.4.2. Update Using Source Archives ............................................................ 22 3.5. Build Wireshark .......................................................................................... 22 3.5.1. Building on Unix .............................................................................. 22 3.5.2. Win32 native ................................................................................... 23 3.6. Run generated Wireshark .............................................................................. 23 3.6.1. Unix/Linux ...................................................................................... 23 3.6.2. Win32 native ................................................................................... 23 3.7. Debug your generated Wireshark ................................................................... 23 3.7.1. Unix/Linux ...................................................................................... 23 3.7.2. Win32 native ................................................................................... 24 3.8. Make changes to the Wireshark sources .......................................................... 24 3.9. Contribute your changes ............................................................................... 24 3.9.1. Some tips for a good patch ................................................................. 25 3.9.2. Code Requirements ........................................................................... 25 3.9.3. Uploading your changes ..................................................................... 26 3.9.4. Backporting a change ........................................................................ 26 3.10. Apply a patch from someone else ................................................................. 27 3.10.1. Using patch .................................................................................... 27 3.11. Binary packaging