source: networking/netutils/wireshark.xml@ 625769d2

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 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 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 625769d2 was 625769d2, checked in by Bruce Dubbs <bdubbs@…>, 9 years ago

Grammar

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

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