source: networking/netutils/wireshark.xml@ 359fdb62

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 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 systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 359fdb62 was 359fdb62, checked in by Fernando de Oliveira <fernando@…>, 11 years ago

Revert some formats. Thanks to Igor

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

  • Property mode set to 100644
File size: 16.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 "http://www.wireshark.org/download/src/all-versions/wireshark-&wireshark-version;.tar.bz2">
8 <!ENTITY wireshark-download-ftp " ">
9 <!ENTITY wireshark-md5sum "cd7fedd0a67df5ad4905fd356efdc1e8">
10 <!ENTITY wireshark-size "25 MB">
11 <!ENTITY wireshark-buildsize "1.1 GB">
12 <!ENTITY wireshark-time "5.4 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 &lfs74_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;-packet_gluster_duplicate_enums_fix-1.patch"/>
71 </para>
72 </listitem>
73 <listitem>
74 <para>Additional Documentation:
75 <ulink url="http://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 if you don't have <application>Gtk+</application>
91 installed, you will need to pass <option>--disable-wireshark</option>
92 to the <command>configure</command> command.</para>
93
94 <bridgehead renderas="sect4">Recommended</bridgehead>
95 <para role="recommended">
96 <xref linkend="libpcap"/> (required to capture data)
97 </para>
98
99 <bridgehead renderas="sect4">Optional</bridgehead>
100 <para role="optional">
101 <xref linkend="pkgconfig"/>,
102 <xref linkend="gtk2"/> or <xref linkend="gtk3"/> (to build the GUI front-end),
103 <xref linkend="openssl"/>,
104 <xref linkend="mitkrb"/>,
105 <xref linkend="python2"/>,
106 <xref linkend="pcre"/>,
107 <xref linkend="gnutls"/>,
108 <ulink url="http://www.portaudio.com/download.html">PortAudio</ulink>,
109 <ulink url="http://www.maxmind.com/app/c">GeoIP</ulink>,
110 <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink>, and
111 <xref linkend="lua"/>
112 </para>
113
114 <para condition="html" role="usernotes">User Notes:
115 <ulink url="&blfs-wiki;/wireshark"/></para>
116
117 </sect2>
118
119 <sect2 role="kernel" id="wireshark-kernel">
120 <title>Kernel Configuration</title>
121
122 <para>The kernel must have the Packet protocol enabled for
123 <application>Wireshark</application> to capture live packets from the
124 network.</para>
125
126<screen><literal>Networking support: Y
127 Networking options:
128 Packet: sockets monitoring interface: M or Y</literal></screen>
129
130 <para>If built as a module, the name is
131 <filename>af_packet.ko</filename>.</para>
132
133 <indexterm zone="wireshark wireshark-kernel">
134 <primary sortas="d-Capturing-network-packets">Capturing network
135 packets</primary>
136 </indexterm>
137
138 </sect2>
139
140 <sect2 role="installation">
141 <title>Installation of Wireshark</title>
142
143 <para>Optionally, fix the description of the program in the title.
144 The first change overwrites the default "SVN Unknown" in the title
145 and the secong overwrites a utility script that resets the version
146 to "unknown".</para>
147
148<screen><userinput>cat > svnversion.h &lt;&lt; "EOF"
149#define SVNVERSION "BLFS"
150#define SVNPATH "source"
151EOF
152
153cat > make-version.pl &lt;&lt; "EOF"
154#!/usr/bin/perl
155EOF</userinput></screen>
156
157 <para><application>Wireshark</application> is a very large and complex
158 application. These instructions provide additional security measures to
159 ensure that only trusted users are allowed to view network traffic. First,
160 set up a system group for wireshark. As the <systemitem
161 class="username">root</systemitem> user:</para>
162
163<screen role="root"><userinput>groupadd -g 62 wireshark</userinput></screen>
164
165 <para>Continue to install <application>Wireshark</application> by running
166 the following commands:</para>
167
168<screen><userinput>patch -Np1 -i ../wireshark-&wireshark-version;-packet_gluster_duplicate_enums_fix-1.patch &amp;&amp;
169./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
170make</userinput></screen>
171
172 <para>This package does not come with a test suite.</para>
173
174 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
175
176<screen role="root"><userinput>make install &amp;&amp;
177
178install -v -m755 -d /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
179install -v -m755 -d /usr/share/pixmaps/wireshark &amp;&amp;
180
181install -v -m644 README{,.linux} doc/README.* doc/*.{pod,txt} \
182 /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
183
184pushd /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
185 for FILENAME in ../../wireshark/*.html; do
186 ln -s -v $FILENAME .
187 done &amp;&amp;
188popd &amp;&amp;
189
190install -v -m644 -D wireshark.desktop \
191 /usr/share/applications/wireshark.desktop &amp;&amp;
192
193install -v -m644 -D image/wsicon48.png \
194 /usr/share/pixmaps/wireshark.png &amp;&amp;
195
196install -v -m644 image/*.{png,ico,xpm,bmp} \
197 /usr/share/pixmaps/wireshark</userinput></screen>
198
199 <para>If you downloaded any of the documentation files from the page
200 listed in the 'Additional Downloads', install them by issuing the following
201 commands as the <systemitem class="username">root</systemitem> user:</para>
202
203<screen role="root"><userinput>install -v -m644 <replaceable>&lt;Downloaded_Files&gt;</replaceable> /usr/share/doc/wireshark-&wireshark-version;</userinput></screen>
204
205 <para>Now, set ownership and permissions of sensitive applications to
206 only allow authorized users. As the <systemitem
207 class="username">root</systemitem> user:</para>
208
209<screen role="root"><userinput>chown -v root:wireshark /usr/bin/{tshark,dumpcap} &amp;&amp;
210chmod -v 6550 /usr/bin/{tshark,dumpcap}</userinput></screen>
211
212 <para>Finally, add any users to the wireshark group with <userinput>usermod -a -G
213 wireshark &lt;username&gt;</userinput>.</para>
214
215 </sect2>
216
217 <sect2 role="commands">
218 <title>Command Explanations</title>
219
220 <para><parameter>--enable-threads</parameter>: This parameter enables the
221 use of threads in <command>wireshark</command>.</para>
222
223 <para><option>--with-ssl</option>: This option is required if you
224 are linking Kerberos libraries into the build so that the
225 <application>OpenSSL</application>
226 <filename class='libraryfile'>libcrypto</filename> library is found.</para>
227
228 <para><option>--with-python</option>: This option is required if you
229 want Python bindings built.</para>
230
231 </sect2>
232
233 <sect2 role="configuration">
234 <title>Configuring Wireshark</title>
235
236 <sect3 id="wireshark-config">
237 <title>Config Files</title>
238
239 <para><filename>/etc/wireshark.conf</filename> and
240 <filename>~/.wireshark/*</filename></para>
241
242 <indexterm zone="wireshark wireshark-config">
243 <primary sortas="e-AA.wireshark-star">~/.wireshark/*</primary>
244 </indexterm>
245
246 <indexterm zone="wireshark wireshark-config">
247 <primary sortas="e-etc-wireshark.conf">/etc/wireshark.conf</primary>
248 </indexterm>
249
250 </sect3>
251
252 <sect3>
253 <title>Configuration Information</title>
254
255 <para>Though the default configuration parameters are very sane,
256 reference the configuration section of the
257 <ulink url="http://www.wireshark.org/docs/wsug_html/">Wireshark User's
258 Guide</ulink> for configuration information. Most of
259 <application>Wireshark</application>'s configuration can be accomplished
260 using the menu options of the <command>wireshark</command>
261 graphical interface.</para>
262
263 <note>
264 <para>If you want to look at packets, make sure you don't filter
265 them out with <xref linkend="iptables"/>. If you want to exclude
266 certain classes of packets, it is more efficient to do it with
267 <application>iptables</application> than it is with
268 <application>Wireshark</application>.</para>
269 </note>
270
271 </sect3>
272
273 </sect2>
274
275 <sect2 role="content">
276 <title>Contents</title>
277
278 <segmentedlist>
279 <segtitle>Installed Programs</segtitle>
280 <segtitle>Installed Libraries</segtitle>
281 <segtitle>Installed Directories</segtitle>
282
283 <seglistitem>
284 <seg>capinfos, dftest, dumpcap, editcap, idl2wrs, mergecap, randpkt,
285 rawshark, text2pcap, tshark, and wireshark</seg>
286 <seg>libwireshark.so, libwiretap.so, libwsutil.so, and
287 numerous plugin modules</seg>
288 <seg>/usr/lib/wireshark, /usr/share/doc/wireshark-&wireshark-version;,
289 /usr/share/pixmaps/wireshark, and /usr/share/wireshark</seg>
290 </seglistitem>
291 </segmentedlist>
292
293 <variablelist>
294 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
295 <?dbfo list-presentation="list"?>
296 <?dbhtml list-presentation="table"?>
297
298 <varlistentry id="capinfos">
299 <term><command>capinfos</command></term>
300 <listitem>
301 <para>reads a saved capture file and returns any or all of several
302 statistics about that file. It is able to detect and read any capture
303 supported by the <application>Wireshark</application> package.</para>
304 <indexterm zone="wireshark capinfos">
305 <primary sortas="b-capinfos">capinfos</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="dftest">
311 <term><command>dftest</command></term>
312 <listitem>
313 <para>is a display-filter-compiler test program.</para>
314 <indexterm zone="wireshark dftest">
315 <primary sortas="b-dftest">dftest</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="dumpcap">
321 <term><command>dumpcap</command></term>
322 <listitem>
323 <para>is a network traffic dump tool. It lets you capture packet data
324 from a live network and write the packets to a file.</para>
325 <indexterm zone="wireshark dumpcap">
326 <primary sortas="b-dumpcap">dumpcap</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="editcap">
332 <term><command>editcap</command></term>
333 <listitem>
334 <para>edits and/or translates the format of capture files. It knows
335 how to read <application>libpcap</application> capture files,
336 including those of <command>tcpdump</command>,
337 <application>Wireshark</application> and other tools that write
338 captures in that format.</para>
339 <indexterm zone="wireshark editcap">
340 <primary sortas="b-editcap">editcap</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="idl2wrs">
346 <term><command>idl2wrs</command></term>
347 <listitem>
348 <para>takes a user specified CORBA
349 IDL file and generates <quote>C</quote> source code that
350 can be used to create an <application>Wireshark</application>
351 plugin.</para>
352 <indexterm zone="wireshark idl2wrs">
353 <primary sortas="b-idl2wrs">idl2wrs</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="mergecap">
359 <term><command>mergecap</command></term>
360 <listitem>
361 <para>combines multiple saved capture files into a single output
362 file.</para>
363 <indexterm zone="wireshark mergecap">
364 <primary sortas="b-mergecap">mergecap</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="randpkt">
370 <term><command>randpkt</command></term>
371 <listitem>
372 <para>creates random-packet capture files.</para>
373 <indexterm zone="wireshark randpkt">
374 <primary sortas="b-randpkt">randpkt</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="rawshark">
380 <term><command>rawshark</command></term>
381 <listitem>
382 <para>dump and analyze raw libpcap data.</para>
383 <indexterm zone="wireshark rawshark">
384 <primary sortas="b-rawshark">rawshark</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="text2pcap">
390 <term><command>text2pcap</command></term>
391 <listitem>
392 <para>reads in an ASCII hex dump and writes the
393 data described into a <application>libpcap</application>-style
394 capture file.</para>
395 <indexterm zone="wireshark text2pcap">
396 <primary sortas="b-text2pcap">text2pcap</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="tshark">
402 <term><command>tshark</command></term>
403 <listitem>
404 <para>is a TTY-mode network protocol analyzer. It lets you capture
405 packet data from a live network or read packets from a
406 previously saved capture file.</para>
407 <indexterm zone="wireshark tshark">
408 <primary sortas="b-tshark">tshark</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="wireshark-prog">
414 <term><command>wireshark</command></term>
415 <listitem>
416 <para>is a GUI network protocol analyzer. It lets you interactively
417 browse packet data from a live network or from a previously
418 saved capture file.</para>
419 <indexterm zone="wireshark wireshark-prog">
420 <primary sortas="b-wireshark">wireshark</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="libwireshark">
426 <term><filename class='libraryfile'>libwireshark.so</filename></term>
427 <listitem>
428 <para>contains functions used by the
429 <application>Wireshark</application> programs to perform filtering and
430 packet capturing.</para>
431 <indexterm zone="wireshark libwireshark">
432 <primary sortas="c-libwireshark">libwireshark.so</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="libwiretap">
438 <term><filename class='libraryfile'>libwiretap.so</filename></term>
439 <listitem>
440 <para>is a library being developed as a future replacement for
441 <filename class='libraryfile'>libpcap</filename>, the current
442 standard Unix library for packet capturing. For more information,
443 see the <filename>README</filename> file in the source
444 <filename class='directory'>wiretap</filename> directory.</para>
445 <indexterm zone="wireshark libwiretap">
446 <primary sortas="c-libwiretap">libwiretap.so</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 </variablelist>
452
453 </sect2>
454
455</sect1>
Note: See TracBrowser for help on using the repository browser.