blob: 78cafcd5f68f29544c2eb2b6f3839bb216a0e8f6 [file] [log] [blame]
Frédéric Lécaille6d889502017-11-15 14:50:19 +01001------------------------------------------------------------------------
2How to build wireshark with HAProxy Peers Protocol dissection support.
3------------------------------------------------------------------------
4
5Please note that at this time, HAProxy Peers Protocol dissection is not supported
6on Windows systems (could not be tested).
7
81) File list
9-------------
Joseph Herlantbd0f83f2018-11-09 19:00:24 -080010 - packet-happp.c: source code for HAProxy Peers Protocol (HAPPP) dissection
Frédéric Lécaille6d889502017-11-15 14:50:19 +010011 support.
12 - wireshark.happp.dissector.patch: a patch file for wireshark sources to enable HAPPP
13 dissection support. Note that this patch file modifies only two files:
14 (epan/dissectors/CMakeLists.txt and epan/dissectors/Makefile.am) to add
15 packet-happp.c file DISSECTOR_SRC variable which list all wireshark
16 - README: this file.
17
William Lallemand2be58f72020-04-25 22:03:29 +0200182a) To build wireshark with HAPPP dissection support
Frédéric Lécaille6d889502017-11-15 14:50:19 +010019---------------------------------------------------
20 - Download wireshark sources:
21 $ git clone https://code.wireshark.org/review/wireshark
22 - copy packet-happp.c file to epan/dissectors/ directory.
23 - apply wireshark.happp.dissector.patch file to wireshark source directory.
24 - build wireshark (see https://www.wireshark.org/docs/wsdg_html_chunked/):
25 $ ./autogen.sh
26 $ ./configure
27 $ make
William Lallemand2be58f72020-04-25 22:03:29 +020028
292b) Alternative: build the HAPPP dissector as a wireshark plugin
30-----------------------------------------------------------------
31If you don't want to build completely wireshark, you can build the dissector as
32a plugin.
33
34You will need the development package of your distribution, which is
35"libwireshark-dev" for debian based distribution and "wireshark-dev" for
36redhat-based ones.
37
38$ make
39
40To install it in your home directory:
41
42$ make install
43
44The plugin will be installed in ~/.wireshark/plugins/ by default, but you can
45change this path by setting the "plugins" variable. If it didn't work, check
46the paths in "Help > About Wireshark > Folders > Personal Plugins" which should
47give you the right path to use.
48
49In some distribution it will be in ~/.local/lib/wireshark/ so you will need to
50install it this way:
51
52$ make install plugins=~/.local/lib/wireshark/plugins/3.2/epan/
53
54If you want to install it in the system directory you can do it this way, the
55righ path is also in the Folder window. Change the plugins variable this way:
56
57$ sudo make install plugins=/usr/lib64/wireshark/plugins/3.2/epan/
58
59Be careful to use the right version number in the path.
60
613) Check if you have the dissector in wireshark
62-----------------------------------------------
63To verify if the protocol was well loaded by your wireshark, open the Supported
64Protocols window in "View > Internals > Supported Protocols" and look for
65"HAPPP".
66
67In the case of a plugin, you should see your plugin loaded in "Help > About
68Wireshark > Plugins".