source: networking/netutils/wireshark.xml@ 646a42e

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 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 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 646a42e was 646a42e, checked in by Fernando de Oliveira <fernando@…>, 9 years ago

Update to lua-5.3.0 and required fixes of other packages.

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

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