Wireshark - 0.99.7 User Manuals

Table of Contents

• Wireshark Developer's Guide

  3
• Table of Contents

  4
• Preface

  8
  • 1. Foreword

    8
  • 2. Who should read this document?

    9
  • 3. Acknowledgements

    10
  • 4. About this document

    11
  • 5. Where to get the latest copy of this document?

    12
  • 6. Providing feedback about this document

    13
• Part I. Wireshark Build Environment

  15
  • Chapter 1. Introduction

    16
    • 1.1. Introduction

      16
    • 1.2. What is Wireshark?

      17
    • 1.3. Platforms Wireshark runs on

      18
      • 1.3.1. Unix

        18
      • 1.3.2. Linux

        18
      • 1.3.3. Microsoft Windows

        19
    • 1.4.  Development and maintenance of Wireshark

      20
      • 1.4.1. Programming language(s) used

        20
      • 1.4.2. Open Source Software

        20
    • 1.5. Releases and distributions

      22
      • 1.5.1. Binary distributions

        22
      • 1.5.2. Source code distributions

        22
    • 1.6. Automated Builds (Buildbot)

      23
      • 1.6.1. Advantages

        23
      • 1.6.2. What does the Buildbot do?

        23
    • 1.7. Reporting problems and getting help

      24
      • 1.7.1. Website

        24
      • 1.7.2. Wiki

        24
      • 1.7.3. FAQ

        24
      • 1.7.4. Other sources

        24
      • 1.7.5. Mailing Lists

        24
      • 1.7.6. Bug database (Bugzilla)

        25
      • 1.7.7. Reporting Problems

        25
      • 1.7.8. Reporting Crashes on UNIX/Linux platforms

        26
      • 1.7.9. Reporting Crashes on Windows platforms

        26
  • Chapter 2. Quick Setup

    28
    • 2.1. UNIX: Installation

      28
    • 2.2. Win32: Step-by-Step Guide

      29
      • 2.2.1. Install Microsoft C compiler and Platform SDK

        29
      • 2.2.2. Install Cygwin

        29
      • 2.2.3. Install Python

        30
      • 2.2.4. Install Subversion Client

        30
        • 2.2.4.1. Subversion

          30
        • 2.2.4.2. TortoiseSVN

          30
      • 2.2.5. Install and Prepare Sources

        30
      • 2.2.6. Prepare cmd.exe

        31
      • 2.2.7. Verify installed tools

        31
      • 2.2.8. Install Libraries

        32
      • 2.2.9. Distclean Sources

        32
      • 2.2.10. Build Wireshark

        32
      • 2.2.11. Debug Environment Setup (XXX)

        33
      • 2.2.12. Optional: Create User's and Developer's Guide

        33
      • 2.2.13. Optional: Create a Wireshark Installer

        33
  • Chapter 3. Work with the Wireshark sources

    35
    • 3.1. Introduction

      35
    • 3.2. The Wireshark Subversion repository

      36
      • 3.2.1. The web interface to the Subversion repository

        36
    • 3.3. Obtain the Wireshark sources

      38
      • 3.3.1. Anonymous Subversion access

        38
      • 3.3.2. Anonymous Subversion web interface

        38
      • 3.3.3. Buildbot Snapshots

        38
      • 3.3.4. Released sources

        39
    • 3.4. Update the Wireshark sources

      40
      • 3.4.1. ... with Anonymous Subversion access

        40
      • 3.4.2. ... from zip files

        40
    • 3.5. Build Wireshark

      41
      • 3.5.1. Unix

        41
      • 3.5.2. Win32 native

        41
    • 3.6. Run generated Wireshark

      43
    • 3.7. Debug your generated Wireshark

      44
      • 3.7.1. Win32 native

        44
    • 3.8. Make changes to the Wireshark sources

      45
    • 3.9. Contribute your changes

      46
      • 3.9.1. What is a diff file (a patch)?

        46
      • 3.9.2. Generate a patch

        47
        • 3.9.2.1. Using the svn command-line client

          47
        • 3.9.2.2. Using the diff feature of the GUI Subversion clients

          47
        • 3.9.2.3. Using the diff tool

          47
      • 3.9.3. Some tips for a good patch

        48
      • 3.9.4. Code Requirements

        48
      • 3.9.5. Sending your patch for inclusion

        49
    • 3.10. Apply a patch from someone else

      51
      • 3.10.1. Using patch

        51
      • 3.10.2. CVS diff (obsolete)

        51
    • 3.11. Add a new file to the Subversion repository

      53
    • 3.12. Binary packaging

      54
      • 3.12.1. Debian: .deb packages

        54
      • 3.12.2. Red Hat: .rpm packages

        54
      • 3.12.3. Win32: NSIS .exe installer

        54
  • Chapter 4. Tool Reference

    57
    • 4.1. Introduction

      57
    • 4.2. Win32: Cygwin

      58
      • 4.2.1. Add/Update/Remove Cygwin Packages

        58
    • 4.3. GNU compiler toolchain (UNIX or Win32 Cygwin)

      59
      • 4.3.1. gcc (GNU compiler collection)

        59
      • 4.3.2. gdb (GNU project debugger)

        59
      • 4.3.3. ddd (GNU Data Display Debugger)

        59
      • 4.3.4. make (GNU Make)

        60
    • 4.4. Microsoft compiler toolchain (Win32 native)

      61
      • 4.4.1. Toolchain Package Alternatives

        61
      • 4.4.2. Legal issues with MSVC > V6?

        63
      • 4.4.3. cl.exe (C Compiler)

        64
      • 4.4.4. nmake.exe (Make)

        65
      • 4.4.5. link.exe (Linker)

        65
      • 4.4.6. C-Runtime "Redistributable" files

        65
        • 4.4.6.1. msvcrt.dll - Version 6.0

          66
        • 4.4.6.2. msvcr70.dll - Version 7.0 (2002)

          66
        • 4.4.6.3. msvcr71.dll - Version 7.1 (2003)

          66
        • 4.4.6.4. msvcr80.dll / vcredist_x86.exe - Version 8.0 (2005)

          66
        • 4.4.6.5. msvcr90.dll - Version 9.0 (2008)

          67
      • 4.4.7. Windows (Platform) SDK

        67
      • 4.4.8. HTML Help

        67
        • 4.4.8.1. HTML Help Compiler (hhc.exe)

          67
        • 4.4.8.2. HTML Help Build Files (htmlhelp.c / htmlhelp.lib)

          67
      • 4.4.9. Debugger

        68
        • 4.4.9.1. Visual Studio integrated debugger

          68
        • 4.4.9.2. Debugging Tools for Windows

          68
    • 4.5. bash

      69
      • 4.5.1. UNIX or Win32 Cygwin: GNU bash

        69
      • 4.5.2. Win32 native: -

        69
    • 4.6. python

      70
      • 4.6.1. UNIX or Win32 Cygwin: python

        70
      • 4.6.2. Win32 native: python

        70
    • 4.7. perl

      71
      • 4.7.1. UNIX or Win32 Cygwin: perl

        71
      • 4.7.2. Win32 native: perl

        71
    • 4.8. sed

      72
      • 4.8.1. UNIX or Win32 Cygwin: sed

        72
      • 4.8.2. Win32 native: sed

        72
    • 4.9. yacc (bison)

      73
      • 4.9.1. UNIX or Win32 Cygwin: bison

        73
      • 4.9.2. Win32 native: bison

        73
    • 4.10. flex

      74
      • 4.10.1. UNIX or Win32 Cygwin: flex

        74
      • 4.10.2. Win32 native: flex

        74
    • 4.11. Subversion (SVN) client (optional)

      75
      • 4.11.1. UNIX or Win32 Cygwin: svn

        75
      • 4.11.2. Win32 native: svn

        75
    • 4.12. Subversion (SVN) GUI client (optional)

      76
      • 4.12.1. UNIX or Win32 Cygwin: rapidSVN, subcommander

        76
      • 4.12.2. Win32 native: TortoiseSVN

        76
    • 4.13. diff (optional)

      77
      • 4.13.1. UNIX or Win32 Cygwin: GNU diff

        77
      • 4.13.2. Win32 native: diff

        77
    • 4.14. patch (optional)

      78
      • 4.14.1. UNIX or Win32 Cygwin: patch

        78
      • 4.14.2. Win32 native: patch

        78
    • 4.15. Win32: GNU wget (optional)

      79
    • 4.16. Win32: GNU unzip (optional)

      80
    • 4.17. Win32: NSIS (optional)

      81
  • Chapter 5. Library Reference

    83
    • 5.1. Introduction

      83
    • 5.2. Binary library formats

      84
      • 5.2.1. Unix

        84
      • 5.2.2. Win32: MSVC

        84
      • 5.2.3. Win32: cygwin gcc

        84
    • 5.3. Win32: Automated library download

      85
      • 5.3.1. Initial download

        85
      • 5.3.2. Update of a previous download

        85
    • 5.4. GTK+ / GLib / GDK / Pango / ATK / GNU gettext / GNU libiconv

      87
      • 5.4.1. Unix

        87
      • 5.4.2. Win32 MSVC

        87
    • 5.5. Net-SNMP (optional)

      88
      • 5.5.1. Unix

        88
      • 5.5.2. Win32 MSVC

        88
    • 5.6. GNU adns (optional)

      89
      • 5.6.1. Unix

        89
      • 5.6.2. Win32 MSVC

        89
    • 5.7. PCRE (optional)

      90
      • 5.7.1. Unix

        90
      • 5.7.2. Win32 MSVC

        90
    • 5.8. zlib (optional)

      91
      • 5.8.1. Unix

        91
      • 5.8.2. Win32 MSVC

        91
    • 5.9. libpcap/WinPcap (optional)

      92
      • 5.9.1. Unix: libpcap

        92
      • 5.9.2. Win32 MSVC: WinPcap

        92
    • 5.10. GnuTLS (optional)

      93
      • 5.10.1. Unix

        93
      • 5.10.2. Win32 MSVC

        93
    • 5.11. Gcrypt (optional)

      94
      • 5.11.1. Unix

        94
      • 5.11.2. Win32 MSVC

        94
    • 5.12. Kerberos (optional)

      95
      • 5.12.1. Unix

        95
      • 5.12.2. Win32 MSVC

        95
    • 5.13. LUA (optional)

      96
      • 5.13.1. Unix

        96
      • 5.13.2. Win32 MSVC

        96
    • 5.14. PortAudio (optional)

      97
      • 5.14.1. Unix

        97
      • 5.14.2. Win32 MSVC

        97
    • 5.15. Win32: GTK WIMP (optional) for GTK 2.x only

      98
• Part II. Wireshark Development (incomplete)

  100
  • Chapter 6. How Wireshark Works

    101
    • 6.1. Introduction

      101
    • 6.2. Overview

      102
    • 6.3. Capturing packets

      104
    • 6.4. Capture Files

      105
    • 6.5. Dissect packets

      106
  • Chapter 7. Introduction

    108
    • 7.1. Source overview

      108
    • 7.2. Coding styleguides

      109
    • 7.3. The GLib library

      110
  • Chapter 8. Packet capturing

    112
    • 8.1. How to add a new capture type to libpcap

      112
  • Chapter 9. Packet dissection

    114
    • 9.1. How it works

      114
    • 9.2. Adding a basic dissector

      115
      • 9.2.1. Setting up the dissector

        115
      • 9.2.2. Dissecting the details of the protocol

        117
      • 9.2.3. Improving the dissection information

        120
    • 9.3. How to handle transformed data

      123
    • 9.4. How to reassemble split packets

      124
      • 9.4.1. How to reassemble split UDP packets

        124
      • 9.4.2. How to reassemble split TCP Packets

        127
    • 9.5. How to tap protocols

      129
    • 9.6. How to produce protocol stats

      130
    • 9.7. How to use conversations

      132
  • Chapter 10. User Interface

    134
    • 10.1. Introduction

      134
    • 10.2. The GTK library

      135
      • 10.2.1. GTK Version 1.x

        135
      • 10.2.2. GTK Version 2.x

        135
      • 10.2.3. Compatibility between 1.x and 2.x

        136
      • 10.2.4. GTK resources on the web

        136
    • 10.3. GUI Reference documents

      138
    • 10.4. Adding/Extending Dialogs

      139
    • 10.5. Widget naming

      140
    • 10.6. Common GTK programming pitfalls

      141
      • 10.6.1. Usage of gtk_widget_show() / gtk_widget_show_all()

        141
• Appendix A. This Document's License (GPL)

  143