source: networking/netutils/wireshark.xml@ 8fad0a2

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 8fad0a2 was 8fad0a2, checked in by Fernando de Oliveira <fernando@…>, 10 years ago

Wireshark-1.12.0: minor fixes.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@13792 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 20.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY wireshark-download-http "http://www.wireshark.org/download/src/all-versions/wireshark-&wireshark-version;.tar.bz2">
8 <!ENTITY wireshark-download-ftp " ">
9 <!ENTITY wireshark-md5sum "8dcfe451d8769901129809d2e19c1fb7">
10 <!ENTITY wireshark-size "28 MB">
11 <!ENTITY wireshark-buildsize "875 MB">
12 <!ENTITY wireshark-time "5.0 SBU">
13]>
14
15<sect1 id="wireshark" xreflabel="Wireshark-&wireshark-version;">
16 <?dbhtml filename="wireshark.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Wireshark-&wireshark-version;</title>
24
25 <indexterm zone="wireshark">
26 <primary sortas="a-Wireshark">Wireshark</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Wireshark</title>
31
32 <para>The <application>Wireshark</application> package contains a network
33 protocol analyzer, also known as a <quote>sniffer</quote>. This is useful
34 for analyzing data captured <quote>off the wire</quote> from a live network
35 connection, or data read from a capture file.
36 <application>Wireshark</application> provides both a graphical and a TTY-mode
37 front-end for examining captured network packets from over 500 protocols,
38 as well as the capability to read capture files from many other popular
39 network analyzers.</para>
40
41 &lfs75_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&wireshark-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&wireshark-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &wireshark-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &wireshark-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &wireshark-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &wireshark-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
66 <itemizedlist spacing="compact">
67 <listitem>
68 <para>Additional Documentation:
69 <ulink url="http://www.wireshark.org/download/docs/"/>
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <para>From this page you can download many different docs in a variety
75 of formats.</para>
76
77 <bridgehead renderas="sect3">Wireshark dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="glib2"/> (to build the TTY-mode front-end only)
82 </para>
83
84 <para>Note that you need <application>Gtk+</application> or
85 <application>Qt4</application> installed, otherwise, pass
86 <option>--disable-wireshark</option> to the
87 <command>configure</command> command. SBU and disk space required are larger
88 for the Qt GUI.</para>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="gtk3"/> (to build the <application>Gtk+3</application>
93 GUI) and
94 <xref linkend="libpcap"/> (required to capture data)
95 </para>
96
97 <bridgehead renderas="sect4">Optional</bridgehead>
98 <para role="optional">
99 <xref linkend="gnutls"/>,
100 <xref linkend="libgcrypt"/>,
101 <xref linkend="lua"/>,
102 <xref linkend="mitkrb"/>,
103 <xref linkend="openssl"/>,
104 <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink>,
105 <ulink url="http://www.maxmind.com/app/c">GeoIP</ulink>, and
106 <ulink url="http://www.portaudio.com/download.html">PortAudio</ulink>
107 </para>
108
109 <bridgehead renderas="sect4">Optional (to build the GUI front-end)</bridgehead>
110 <para role="optional">
111 <xref linkend="gtk2"/>,
112 <xref linkend="qt4"/>, or
113 <xref linkend="qt5"/>
114 </para>
115
116 <para condition="html" role="usernotes">User Notes:
117 <ulink url="&blfs-wiki;/wireshark"/></para>
118
119 </sect2>
120
121 <sect2 role="kernel" id="wireshark-kernel">
122 <title>Kernel Configuration</title>
123
124 <para>The kernel must have the Packet protocol enabled for
125 <application>Wireshark</application> to capture live packets from the
126 network.</para>
127
128<screen><literal>Networking support: Y
129 Networking options:
130 Packet: sockets monitoring interface: M or Y</literal></screen>
131
132 <para>If built as a module, the name is
133 <filename>af_packet.ko</filename>.</para>
134
135 <indexterm zone="wireshark wireshark-kernel">
136 <primary sortas="d-Capturing-network-packets">Capturing network
137 packets</primary>
138 </indexterm>
139
140 </sect2>
141
142 <sect2 role="installation">
143 <title>Installation of Wireshark</title>
144
145 <para>Optionally, fix the description of the program in the title.
146 The first change overwrites the default "SVN Unknown" in the title
147 and the second overwrites a utility script that resets the version
148 to "unknown".</para>
149
150<screen><userinput>cat > svnversion.h &lt;&lt; "EOF"
151#define SVNVERSION "BLFS"
152#define SVNPATH "source"
153EOF
154
155cat > make-version.pl &lt;&lt; "EOF"
156#!/usr/bin/perl
157EOF</userinput></screen>
158
159 <para><application>Wireshark</application> is a very large and complex
160 application. These instructions provide additional security measures to
161 ensure that only trusted users are allowed to view network traffic. First,
162 set up a system group for wireshark. As the <systemitem
163 class="username">root</systemitem> user:</para>
164
165<screen role="root"><userinput>groupadd -g 62 wireshark</userinput></screen>
166
167 <para>If you want an unpriviledged user to execute
168 <application>wireshark</application>, run the following command as the
169 <systemitem class="username">root</systemitem> user:</para>
170
171<screen><userinput>usermod -a -G wireshark <replaceable>&lt;username&gt;</replaceable></userinput></screen>
172
173 <para>If you have <application>GTK+2</application> and 3, and
174 <application>Qt4</application> and 5, one GUI linked to
175 <application>GTK+3</application> and another one linked to
176 <application>Qt5</application> are built, by default. Instead, we chose to
177 only build the <application>GTK+3</application> GUI, as the BLFS default.
178 If you prefer otherwise, some modifications are mecessary. For
179 modifications in the <command>configure</command> switches, see
180 "Command Explanations".</para>
181
182 <para>If you want to build a Qt GUI and have both
183 <application>Qt4</application> and 5 installed, issue either:</para>
184
185<screen><userinput>source setqt5</userinput></screen>
186
187 <para>if you want the <application>Qt5</application> GUI built, or:</para>
188
189<screen><userinput>source setqt4 &amp;&amp;
190sed -i 's/Qt5 Qt/Qt/' configure</userinput></screen>
191
192 <para>if you want the <application>Qt4</application> GUI built.</para>
193
194 <para>Continue to install <application>Wireshark</application> by running
195 the following commands:</para>
196
197<screen><userinput>./configure --prefix=/usr \
198 --with-gtk3=yes \
199 --with-qt=no \
200 --sysconfdir=/etc &amp;&amp;
201make</userinput></screen>
202
203 <para>This package does not come with a test suite.</para>
204
205 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
206
207<screen role="root"><userinput>make install &amp;&amp;
208
209install -v -m755 -d /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
210install -v -m755 -d /usr/share/pixmaps/wireshark &amp;&amp;
211
212install -v -m644 README{,.linux} doc/README.* doc/*.{pod,txt} \
213 /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
214
215pushd /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
216 for FILENAME in ../../wireshark/*.html; do
217 ln -s -v -f $FILENAME .
218 done &amp;&amp;
219popd &amp;&amp;
220
221install -v -m644 -D wireshark.desktop \
222 /usr/share/applications/wireshark.desktop &amp;&amp;
223
224install -v -m644 -D image/wsicon48.png \
225 /usr/share/pixmaps/wireshark.png &amp;&amp;
226
227install -v -m644 image/*.{png,ico,xpm,bmp} \
228 /usr/share/pixmaps/wireshark</userinput></screen>
229
230 <para>If you downloaded any of the documentation files from the page
231 listed in the 'Additional Downloads', install them by issuing the following
232 commands as the <systemitem class="username">root</systemitem> user:</para>
233
234<screen role="root"><userinput>install -v -m644 <replaceable>&lt;Downloaded_Files&gt;</replaceable> /usr/share/doc/wireshark-&wireshark-version;</userinput></screen>
235
236 <para>Now, set ownership and permissions of sensitive applications to
237 only allow authorized users. As the <systemitem
238 class="username">root</systemitem> user:</para>
239
240<screen role="root"><userinput>chown -v root:wireshark /usr/bin/{tshark,dumpcap} &amp;&amp;
241chmod -v 6550 /usr/bin/{tshark,dumpcap}</userinput></screen>
242
243 <para>Finally, add any users to the wireshark group (as root user):</para>
244
245<screen role="root"><userinput>usermod -a -G wireshark &lt;username&gt;</userinput></screen>
246
247 </sect2>
248
249 <sect2 role="commands">
250 <title>Command Explanations</title>
251
252 <para><command>sed -i 's/Qt5 Qt/Qt/' ...</command>: This command is required
253 because, without it, libraries and includes from
254 <application>Qt5</application> are found and used first, if both versions
255 are installed, when trying to build with <application>Qt4</application>,
256 and <command>make</command> does not complete.</para>
257
258 <para><option>--disable-wireshark</option>: This option is required if you
259 have <application>GTK+</application> installed but do not want to build
260 the GTK+ and Qt GUIs.</para>
261
262 <para><parameter>--with-gtk3=yes</parameter>: This switch is required
263 to use <application>GTK+3</application> for the GUI, if you are using
264 <parameter>--with-qt=no</parameter>. Change gtk3 by gtk2,to use
265 <application>GTK+3</application> for the GUI.</para>
266
267 <para><parameter>--with-qt=no</parameter>: This switch disables build of
268 the Qt GUI. Replace "no" by "yes", if you want it to be built.</para>
269
270 <para><option>--with-gtk2=yes</option>: This option is required if you want
271 to use <application>GTK+</application>2, instead of 3, for the GUI. Notice
272 that the GUI for only one GTK+ version (either 2 or 3) can be built.</para>
273
274 </sect2>
275
276 <sect2 role="configuration">
277 <title>Configuring Wireshark</title>
278
279 <sect3 id="wireshark-config">
280 <title>Config Files</title>
281
282 <para><filename>/etc/wireshark.conf</filename> and
283 <filename>~/.wireshark/*</filename></para>
284
285 <indexterm zone="wireshark wireshark-config">
286 <primary sortas="e-AA.wireshark-star">~/.wireshark/*</primary>
287 </indexterm>
288
289 <indexterm zone="wireshark wireshark-config">
290 <primary sortas="e-etc-wireshark.conf">/etc/wireshark.conf</primary>
291 </indexterm>
292
293 </sect3>
294
295 <sect3>
296 <title>Configuration Information</title>
297
298 <para>Though the default configuration parameters are very sane,
299 reference the configuration section of the
300 <ulink url="http://www.wireshark.org/docs/wsug_html/">Wireshark User's
301 Guide</ulink> for configuration information. Most of
302 <application>Wireshark</application>'s configuration can be accomplished
303 using the menu options of the <command>wireshark</command>
304 graphical interfaces.</para>
305
306 </sect3>
307
308 <sect3>
309 <title>Desktop file for the Qt GUI</title>
310
311 <para>If Qt GUI was built and you wish an entry in the desktop menu,
312 there are two possibilities (instructions must be run as root).</para>
313
314 <para>If only the Qt GUI was built:</para>
315
316<screen role="root"><userinput>mv -v /usr/share/applications/wireshark.desktop \
317 /usr/share/applications/wireshark-qt.desktop</userinput></screen>
318
319 <para>If both, GTK+ and Qt GUIs were built:</para>
320
321<screen role="root"><userinput>cp -v /usr/share/applications/wireshark.desktop \
322 /usr/share/applications/wireshark-qt.desktop</userinput></screen>
323
324 <para>Now, fix it for <command>wireshark-qt</command>:</para>
325
326<screen role="root"><userinput>sed -e 's/ireshark/&amp;-qt/' \
327 -e 's/^\(Icon=wireshark\)-qt/\1/' \
328 -i /usr/share/applications/wireshark-qt.desktop</userinput></screen>
329
330 <note>
331 <para>If you want to look at packets, make sure you don't filter
332 them out with <xref linkend="iptables"/>. If you want to exclude
333 certain classes of packets, it is more efficient to do it with
334 <application>iptables</application> than it is with
335 <application>Wireshark</application>.</para>
336 </note>
337
338 </sect3>
339
340 </sect2>
341
342 <sect2 role="content">
343 <title>Contents</title>
344
345 <segmentedlist>
346 <segtitle>Installed Programs</segtitle>
347 <segtitle>Installed Libraries</segtitle>
348 <segtitle>Installed Directories</segtitle>
349
350 <seglistitem>
351 <seg>capinfos, captype, dftest, dumpcap, editcap, mergecap, randpkt,
352 rawshark, reordercap, text2pcap, tshark,
353 wireshark and wireshark-qt</seg>
354 <seg>libfiletap.so, libwireshark.so, libwiretap.so, libwsutil.so, and
355 numerous modules under /usr/lib/wireshark/plugins</seg>
356 <seg>/usr/lib/wireshark, /usr/share/doc/wireshark-&wireshark-version;,
357 /usr/share/pixmaps/wireshark, and /usr/share/wireshark</seg>
358 </seglistitem>
359 </segmentedlist>
360
361 <variablelist>
362 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
363 <?dbfo list-presentation="list"?>
364 <?dbhtml list-presentation="table"?>
365
366 <varlistentry id="capinfos">
367 <term><command>capinfos</command></term>
368 <listitem>
369 <para>reads a saved capture file and returns any or all of several
370 statistics about that file. It is able to detect and read any capture
371 supported by the <application>Wireshark</application> package.</para>
372 <indexterm zone="wireshark capinfos">
373 <primary sortas="b-capinfos">capinfos</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="captype">
379 <term><command>captype</command></term>
380 <listitem>
381 <para>prints the file types of capture files.</para>
382 <indexterm zone="wireshark captype">
383 <primary sortas="b-captype">captype</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="dftest">
389 <term><command>dftest</command></term>
390 <listitem>
391 <para>is a display-filter-compiler test program.</para>
392 <indexterm zone="wireshark dftest">
393 <primary sortas="b-dftest">dftest</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="dumpcap">
399 <term><command>dumpcap</command></term>
400 <listitem>
401 <para>is a network traffic dump tool. It lets you capture packet data
402 from a live network and write the packets to a file.</para>
403 <indexterm zone="wireshark dumpcap">
404 <primary sortas="b-dumpcap">dumpcap</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="editcap">
410 <term><command>editcap</command></term>
411 <listitem>
412 <para>edits and/or translates the format of capture files. It knows
413 how to read <application>libpcap</application> capture files,
414 including those of <command>tcpdump</command>,
415 <application>Wireshark</application> and other tools that write
416 captures in that format.</para>
417 <indexterm zone="wireshark editcap">
418 <primary sortas="b-editcap">editcap</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="mergecap">
424 <term><command>mergecap</command></term>
425 <listitem>
426 <para>combines multiple saved capture files into a single output
427 file.</para>
428 <indexterm zone="wireshark mergecap">
429 <primary sortas="b-mergecap">mergecap</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="randpkt">
435 <term><command>randpkt</command></term>
436 <listitem>
437 <para>creates random-packet capture files.</para>
438 <indexterm zone="wireshark randpkt">
439 <primary sortas="b-randpkt">randpkt</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry id="rawshark">
445 <term><command>rawshark</command></term>
446 <listitem>
447 <para>dump and analyze raw libpcap data.</para>
448 <indexterm zone="wireshark rawshark">
449 <primary sortas="b-rawshark">rawshark</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="reordercap">
455 <term><command>reordercap</command></term>
456 <listitem>
457 <para>reorder timestamps of input file frames into output file.</para>
458 <indexterm zone="wireshark reordercap">
459 <primary sortas="b-reordercap">reordercap</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="text2pcap">
465 <term><command>text2pcap</command></term>
466 <listitem>
467 <para>reads in an ASCII hex dump and writes the
468 data described into a <application>libpcap</application>-style
469 capture file.</para>
470 <indexterm zone="wireshark text2pcap">
471 <primary sortas="b-text2pcap">text2pcap</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="tshark">
477 <term><command>tshark</command></term>
478 <listitem>
479 <para>is a TTY-mode network protocol analyzer. It lets you capture
480 packet data from a live network or read packets from a
481 previously saved capture file.</para>
482 <indexterm zone="wireshark tshark">
483 <primary sortas="b-tshark">tshark</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="wireshark-prog">
489 <term><command>wireshark</command></term>
490 <listitem>
491 <para>is the GTK+ GUI network protocol analyzer. It lets you
492 interactively browse packet data from a live network or from a
493 previously saved capture file.</para>
494 <indexterm zone="wireshark wireshark-prog">
495 <primary sortas="b-wireshark">wireshark</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="wireshark-qt-prog">
501 <term><command>wireshark-qt</command></term>
502 <listitem>
503 <para>is the Qt GUI network protocol analyzer. It lets you
504 interactively browse packet data from a live network or from a
505 previously saved capture file.</para>
506 <indexterm zone="wireshark wireshark-qt-prog">
507 <primary sortas="b-wireshark-qt">wireshark-qt</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 <varlistentry id="libwireshark">
513 <term><filename class='libraryfile'>libwireshark.so</filename></term>
514 <listitem>
515 <para>contains functions used by the
516 <application>Wireshark</application> programs to perform filtering and
517 packet capturing.</para>
518 <indexterm zone="wireshark libwireshark">
519 <primary sortas="c-libwireshark">libwireshark.so</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="libwiretap">
525 <term><filename class='libraryfile'>libwiretap.so</filename></term>
526 <listitem>
527 <para>is a library being developed as a future replacement for
528 <filename class='libraryfile'>libpcap</filename>, the current
529 standard Unix library for packet capturing. For more information,
530 see the <filename>README</filename> file in the source
531 <filename class='directory'>wiretap</filename> directory.</para>
532 <indexterm zone="wireshark libwiretap">
533 <primary sortas="c-libwiretap">libwiretap.so</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 </variablelist>
539
540 </sect2>
541
542</sect1>
Note: See TracBrowser for help on using the repository browser.