[1a3dd316] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[1a3dd316] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY ethereal-download-http "http://www.ethereal.com/distribution/ethereal-ðereal-version;.tar.bz2">
|
---|
| 8 | <!ENTITY ethereal-download-ftp "ftp://ftp.ethereal.com/pub/ethereal/all-versions/ethereal-ðereal-version;.tar.bz2">
|
---|
[28d83dbc] | 9 | <!ENTITY ethereal-md5sum "03aa7fe2cbef9aa0654637cdc60e0458">
|
---|
| 10 | <!ENTITY ethereal-size "5.9 MB">
|
---|
| 11 | <!ENTITY ethereal-buildsize "225 MB">
|
---|
| 12 | <!ENTITY ethereal-time "4.2 SBU">
|
---|
[1a3dd316] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="ethereal" xreflabel="Ethereal-ðereal-version;">
|
---|
[13659efc] | 16 | <?dbhtml filename="ethereal.html"?>
|
---|
[50b8d8b] | 17 |
|
---|
[13659efc] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[50b8d8b] | 22 |
|
---|
[13659efc] | 23 | <title>Ethereal-ðereal-version;</title>
|
---|
[50b8d8b] | 24 |
|
---|
[13659efc] | 25 | <indexterm zone="ethereal">
|
---|
| 26 | <primary sortas="a-Ethereal">Ethereal</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Ethereal</title>
|
---|
| 31 |
|
---|
[1065a91] | 32 | <para>The <application>Ethereal</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>Ethereal</application> provides both GUI and TTY-mode programs
|
---|
| 37 | for examining captured network packets from over 500 protocols, as well as
|
---|
| 38 | the capability to read capture files from many other popular network
|
---|
[28d83dbc] | 39 | analyzers.</para>
|
---|
[50b8d8b] | 40 |
|
---|
[13659efc] | 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (HTTP): <ulink url="ðereal-download-http;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (FTP): <ulink url="ðereal-download-ftp;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download MD5 sum: ðereal-md5sum;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download size: ðereal-size;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated disk space required: ðereal-buildsize;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[2174baa] | 59 | <para>Estimated build time: ðereal-time;</para>
|
---|
| 60 | </listitem>
|
---|
[13659efc] | 61 | </itemizedlist>
|
---|
[50b8d8b] | 62 |
|
---|
[13659efc] | 63 | <bridgehead renderas="sect3">Ethereal dependencies</bridgehead>
|
---|
[50b8d8b] | 64 |
|
---|
[13659efc] | 65 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[1065a91] | 66 | <para><xref linkend="GLib"/> or <xref linkend="glib2"/> (to build the
|
---|
[13659efc] | 67 | TTY-mode front-end only)</para>
|
---|
[50b8d8b] | 68 |
|
---|
[13659efc] | 69 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 70 | <para><xref linkend="libpcap"/> (required to capture data)</para>
|
---|
[50b8d8b] | 71 |
|
---|
[13659efc] | 72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[1065a91] | 73 | <para><xref linkend="pkgconfig"/>,
|
---|
| 74 | <xref linkend="GTK"/> or <xref linkend="gtk2"/> (to build the
|
---|
| 75 | GUI front-end),
|
---|
| 76 | <xref linkend="openssl"/>,
|
---|
| 77 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
| 78 | <xref linkend="python"/>,
|
---|
| 79 | <xref linkend="pcre"/>,
|
---|
| 80 | <ulink url="http://www.net-snmp.org/">Net-SNMP</ulink> and
|
---|
[13659efc] | 81 | <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink></para>
|
---|
[28d83dbc] | 82 |
|
---|
[1065a91] | 83 | <bridgehead renderas="sect4">Optional (to build additional
|
---|
[28d83dbc] | 84 | documentation)</bridgehead>
|
---|
| 85 | <para><xref linkend="doxygen"/>,
|
---|
[1065a91] | 86 | <xref linkend="libxml"/>,
|
---|
[28d83dbc] | 87 | <xref linkend="libxslt"/>,
|
---|
| 88 | <xref linkend="fop"/></para>
|
---|
| 89 |
|
---|
[13659efc] | 90 | </sect2>
|
---|
[50b8d8b] | 91 |
|
---|
[13659efc] | 92 | <sect2 role="kernel" id="ethereal-kernel">
|
---|
| 93 | <title>Kernel Configuration</title>
|
---|
[50b8d8b] | 94 |
|
---|
[1065a91] | 95 | <para>The kernel must have the Packet protocol enabled for
|
---|
| 96 | <application>Ethereal</application> to capture live packets from the
|
---|
| 97 | network. Enable the Packet protocol by choosing <quote>Y</quote> in the
|
---|
[50b8d8b] | 98 | <quote>Device Drivers</quote> – <quote>Networking support</quote>
|
---|
[1065a91] | 99 | – <quote>Networking options</quote> –
|
---|
| 100 | <quote>Packet socket</quote> configuration parameter. Alternatively,
|
---|
| 101 | build the af_packet module by choosing <quote>M</quote> in this
|
---|
[28d83dbc] | 102 | parameter.</para>
|
---|
[50b8d8b] | 103 |
|
---|
[13659efc] | 104 | <indexterm zone="ethereal ethereal-kernel">
|
---|
[1065a91] | 105 | <primary sortas="d-Capturing-network-packets">Capturing network
|
---|
[13659efc] | 106 | packets</primary>
|
---|
| 107 | </indexterm>
|
---|
[50b8d8b] | 108 |
|
---|
[13659efc] | 109 | </sect2>
|
---|
[50b8d8b] | 110 |
|
---|
[13659efc] | 111 | <sect2 role="installation">
|
---|
| 112 | <title>Installation of Ethereal</title>
|
---|
| 113 |
|
---|
[1065a91] | 114 | <para>Install <application>Ethereal</application> by running the following
|
---|
[13659efc] | 115 | commands:</para>
|
---|
| 116 |
|
---|
| 117 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
[1a3dd316] | 118 | --enable-randpkt --enable-threads &&
|
---|
[13659efc] | 119 | make</userinput></screen>
|
---|
[28d83dbc] | 120 |
|
---|
| 121 | <para>This package does not come with a test suite.</para>
|
---|
[50b8d8b] | 122 |
|
---|
[13659efc] | 123 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[50b8d8b] | 124 |
|
---|
[28d83dbc] | 125 | <screen role="root"><userinput>make install &&
|
---|
| 126 | install -v -m644 doc/README.* /usr/share/ethereal &&
|
---|
| 127 | install -v -m644 -D ethereal.desktop \
|
---|
| 128 | /usr/share/applications/ethereal.desktop &&
|
---|
| 129 | install -v -m644 -D image/elogo3d48x48.png \
|
---|
| 130 | /usr/share/pixmaps/ethereal.png &&
|
---|
| 131 | install -v -m755 -d /usr/share/pixmaps/ethereal/toolbar &&
|
---|
| 132 | install -v -m644 image/*.{png,ico,xpm} /usr/share/pixmaps/ethereal &&
|
---|
| 133 | install -v -m644 image/toolbar/* /usr/share/pixmaps/ethereal/toolbar</userinput></screen>
|
---|
[50b8d8b] | 134 |
|
---|
[13659efc] | 135 | </sect2>
|
---|
[50b8d8b] | 136 |
|
---|
[13659efc] | 137 | <sect2 role="commands">
|
---|
| 138 | <title>Command Explanations</title>
|
---|
[50b8d8b] | 139 |
|
---|
[1065a91] | 140 | <para><parameter>--enable-randpkt</parameter>: This parameter builds the
|
---|
[28d83dbc] | 141 | random capture program.</para>
|
---|
[50b8d8b] | 142 |
|
---|
[1065a91] | 143 | <para><parameter>--enable-threads</parameter>: This parameter enables the
|
---|
[28d83dbc] | 144 | use of threads in <command>ethereal</command>.</para>
|
---|
[50b8d8b] | 145 |
|
---|
[1065a91] | 146 | <para><option>--with-ssl</option>: This parameter enables the use of the
|
---|
[50b8d8b] | 147 | <application>OpenSSL</application>
|
---|
[13659efc] | 148 | <filename class='libraryfile'>libcrypto</filename> library.</para>
|
---|
[50b8d8b] | 149 |
|
---|
[13659efc] | 150 | </sect2>
|
---|
[50b8d8b] | 151 |
|
---|
[13659efc] | 152 | <sect2 role="configuration">
|
---|
| 153 | <title>Configuring Ethereal</title>
|
---|
| 154 |
|
---|
| 155 | <sect3 id="ethereal-config">
|
---|
| 156 | <title>Config Files</title>
|
---|
[50b8d8b] | 157 |
|
---|
[1065a91] | 158 | <para><filename>/etc/ethereal.conf</filename> and
|
---|
[13659efc] | 159 | <filename>~/.ethereal/preferences</filename></para>
|
---|
[50b8d8b] | 160 |
|
---|
[13659efc] | 161 | <indexterm zone="ethereal ethereal-config">
|
---|
| 162 | <primary sortas="e-AA.ethereal-preferences">~/.ethereal/preferences</primary>
|
---|
| 163 | </indexterm>
|
---|
[50b8d8b] | 164 |
|
---|
[13659efc] | 165 | <indexterm zone="ethereal ethereal-config">
|
---|
| 166 | <primary sortas="e-etc-ethereal.conf">/etc/ethereal.conf</primary>
|
---|
| 167 | </indexterm>
|
---|
[50b8d8b] | 168 |
|
---|
[13659efc] | 169 | </sect3>
|
---|
[50b8d8b] | 170 |
|
---|
[13659efc] | 171 | <sect3>
|
---|
| 172 | <title>Configuration Information</title>
|
---|
[50b8d8b] | 173 |
|
---|
[1065a91] | 174 | <para>Though the default configuration parameters are very sane,
|
---|
| 175 | reference the configuration section of the
|
---|
| 176 | <ulink url="http://www.ethereal.com/docs/user-guide/">Ethereal User's
|
---|
| 177 | Guide</ulink> for configuration information. Most of
|
---|
| 178 | <application>Ethereal</application>'s configuration can be accomplished
|
---|
[50b8d8b] | 179 | using the menu options of the <command>ethereal</command>
|
---|
[13659efc] | 180 | GUI interface.</para>
|
---|
[50b8d8b] | 181 |
|
---|
[13659efc] | 182 | <note>
|
---|
[1065a91] | 183 | <para>If you want to look at packets, make sure you don't filter
|
---|
| 184 | them out with <xref linkend="iptables"/>. If you want to exclude
|
---|
| 185 | certain classes of packets, it is more efficient to do it with
|
---|
| 186 | <application>iptables</application> than
|
---|
[13659efc] | 187 | <application>Ethereal</application>.</para>
|
---|
| 188 | </note>
|
---|
[50b8d8b] | 189 |
|
---|
[13659efc] | 190 | </sect3>
|
---|
[50b8d8b] | 191 |
|
---|
[13659efc] | 192 | </sect2>
|
---|
[50b8d8b] | 193 |
|
---|
[13659efc] | 194 | <sect2 role="content">
|
---|
| 195 | <title>Contents</title>
|
---|
| 196 |
|
---|
| 197 | <segmentedlist>
|
---|
| 198 | <segtitle>Installed Programs</segtitle>
|
---|
| 199 | <segtitle>Installed Libraries</segtitle>
|
---|
| 200 | <segtitle>Installed Directories</segtitle>
|
---|
[50b8d8b] | 201 |
|
---|
[13659efc] | 202 | <seglistitem>
|
---|
[1065a91] | 203 | <seg>capinfos, dftest, editcap, ethereal, idl2eth, mergecap, randpkt,
|
---|
[13659efc] | 204 | tethereal and text2pcap</seg>
|
---|
[1065a91] | 205 | <seg>libethereal.so, libwiretap.so and numerous dissector plugin
|
---|
[28d83dbc] | 206 | modules</seg>
|
---|
[1065a91] | 207 | <seg>/usr/lib/ethereal, /usr/share/ethereal and
|
---|
[28d83dbc] | 208 | /usr/share/pixmaps/ethereal</seg>
|
---|
[13659efc] | 209 | </seglistitem>
|
---|
| 210 | </segmentedlist>
|
---|
[50b8d8b] | 211 |
|
---|
[13659efc] | 212 | <variablelist>
|
---|
| 213 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 214 | <?dbfo list-presentation="list"?>
|
---|
| 215 | <?dbhtml list-presentation="table"?>
|
---|
[50b8d8b] | 216 |
|
---|
[13659efc] | 217 | <varlistentry id="capinfos">
|
---|
| 218 | <term><command>capinfos</command></term>
|
---|
| 219 | <listitem>
|
---|
[1065a91] | 220 | <para>reads a saved capture file and returns any or all of several
|
---|
| 221 | statistics about that file. It is able to detect and read any capture
|
---|
[13659efc] | 222 | supported by the <application>Ethereal</application> package.</para>
|
---|
| 223 | <indexterm zone="ethereal capinfos">
|
---|
| 224 | <primary sortas="b-capinfos">capinfos</primary>
|
---|
| 225 | </indexterm>
|
---|
| 226 | </listitem>
|
---|
| 227 | </varlistentry>
|
---|
[50b8d8b] | 228 |
|
---|
[13659efc] | 229 | <varlistentry id="dftest">
|
---|
| 230 | <term><command>dftest</command></term>
|
---|
| 231 | <listitem>
|
---|
| 232 | <para>is a display-filter-compiler test program.</para>
|
---|
| 233 | <indexterm zone="ethereal dftest">
|
---|
| 234 | <primary sortas="b-dftest">dftest</primary>
|
---|
| 235 | </indexterm>
|
---|
| 236 | </listitem>
|
---|
| 237 | </varlistentry>
|
---|
[50b8d8b] | 238 |
|
---|
[13659efc] | 239 | <varlistentry id="editcap">
|
---|
| 240 | <term><command>editcap</command></term>
|
---|
| 241 | <listitem>
|
---|
[1065a91] | 242 | <para>edits and/or translates the format of capture files. It knows
|
---|
| 243 | how to read <application>libpcap</application> capture files,
|
---|
| 244 | including those of <command>tcpdump</command>,
|
---|
| 245 | <application>Ethereal</application> and other tools that write
|
---|
[28d83dbc] | 246 | captures in that format.</para>
|
---|
[13659efc] | 247 | <indexterm zone="ethereal editcap">
|
---|
| 248 | <primary sortas="b-editcap">editcap</primary>
|
---|
| 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
[50b8d8b] | 252 |
|
---|
[13659efc] | 253 | <varlistentry id="ethereal-prog">
|
---|
| 254 | <term><command>ethereal</command></term>
|
---|
| 255 | <listitem>
|
---|
[1065a91] | 256 | <para>is a GUI network protocol analyzer. It lets you interactively
|
---|
| 257 | browse packet data from a live network or from a previously
|
---|
[13659efc] | 258 | saved capture file.</para>
|
---|
| 259 | <indexterm zone="ethereal ethereal-prog">
|
---|
| 260 | <primary sortas="b-ethereal">ethereal</primary>
|
---|
| 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
[50b8d8b] | 264 |
|
---|
[13659efc] | 265 | <varlistentry id="idl2eth">
|
---|
| 266 | <term><command>idl2eth</command></term>
|
---|
| 267 | <listitem>
|
---|
[1065a91] | 268 | <para>takes a user specified CORBA
|
---|
| 269 | IDL file and generates <quote>C</quote> source code that
|
---|
[50b8d8b] | 270 | can be used to create an <application>Ethereal</application>
|
---|
[28d83dbc] | 271 | plugin.</para>
|
---|
[13659efc] | 272 | <indexterm zone="ethereal idl2eth">
|
---|
| 273 | <primary sortas="b-idl2eth">idl2eth</primary>
|
---|
| 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
[50b8d8b] | 277 |
|
---|
[13659efc] | 278 | <varlistentry id="mergecap">
|
---|
| 279 | <term><command>mergecap</command></term>
|
---|
| 280 | <listitem>
|
---|
[1065a91] | 281 | <para>combines multiple saved capture files into a single output
|
---|
[13659efc] | 282 | file.</para>
|
---|
| 283 | <indexterm zone="ethereal mergecap">
|
---|
| 284 | <primary sortas="b-mergecap">mergecap</primary>
|
---|
| 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
[50b8d8b] | 288 |
|
---|
[13659efc] | 289 | <varlistentry id="randpkt">
|
---|
| 290 | <term><command>randpkt</command></term>
|
---|
| 291 | <listitem>
|
---|
| 292 | <para>creates random-packet capture files.</para>
|
---|
| 293 | <indexterm zone="ethereal randpkt">
|
---|
| 294 | <primary sortas="b-randpkt">randpkt</primary>
|
---|
| 295 | </indexterm>
|
---|
| 296 | </listitem>
|
---|
| 297 | </varlistentry>
|
---|
[50b8d8b] | 298 |
|
---|
[13659efc] | 299 | <varlistentry id="tethereal">
|
---|
| 300 | <term><command>tethereal</command></term>
|
---|
| 301 | <listitem>
|
---|
[1065a91] | 302 | <para>is a TTY-mode network protocol analyzer. It lets you capture
|
---|
| 303 | packet data from a live network or read packets from a
|
---|
[13659efc] | 304 | previously saved capture file.</para>
|
---|
| 305 | <indexterm zone="ethereal tethereal">
|
---|
| 306 | <primary sortas="b-tethereal">tethereal</primary>
|
---|
| 307 | </indexterm>
|
---|
| 308 | </listitem>
|
---|
| 309 | </varlistentry>
|
---|
[50b8d8b] | 310 |
|
---|
[13659efc] | 311 | <varlistentry id="text2pcap">
|
---|
| 312 | <term><command>text2pcap</command></term>
|
---|
| 313 | <listitem>
|
---|
[1065a91] | 314 | <para>reads in an ASCII hex dump and writes the
|
---|
| 315 | data described into a <application>libpcap</application>-style
|
---|
[28d83dbc] | 316 | capture file.</para>
|
---|
[13659efc] | 317 | <indexterm zone="ethereal text2pcap">
|
---|
| 318 | <primary sortas="b-text2pcap">text2pcap</primary>
|
---|
| 319 | </indexterm>
|
---|
| 320 | </listitem>
|
---|
| 321 | </varlistentry>
|
---|
[50b8d8b] | 322 |
|
---|
[13659efc] | 323 | <varlistentry id="libethereal">
|
---|
| 324 | <term><filename class='libraryfile'>libethereal.so</filename></term>
|
---|
| 325 | <listitem>
|
---|
[1065a91] | 326 | <para>contains functions used by the
|
---|
| 327 | <application>Ethereal</application> programs to perform filtering and
|
---|
[13659efc] | 328 | packet capturing.</para>
|
---|
| 329 | <indexterm zone="ethereal libethereal">
|
---|
| 330 | <primary sortas="c-libethereal">libethereal.so</primary>
|
---|
| 331 | </indexterm>
|
---|
| 332 | </listitem>
|
---|
| 333 | </varlistentry>
|
---|
[50b8d8b] | 334 |
|
---|
[13659efc] | 335 | <varlistentry id="libwiretap">
|
---|
| 336 | <term><filename class='libraryfile'>libwiretap.so</filename></term>
|
---|
| 337 | <listitem>
|
---|
[1065a91] | 338 | <para>is a library being developed as a future replacement for
|
---|
| 339 | <filename class='libraryfile'>libpcap</filename>, the current
|
---|
| 340 | standard Unix library for packet capturing. For more information,
|
---|
| 341 | see the <filename>README</filename> file in the source
|
---|
[13659efc] | 342 | <filename class='directory'>wiretap</filename> directory.</para>
|
---|
| 343 | <indexterm zone="ethereal libwiretap">
|
---|
| 344 | <primary sortas="c-libwiretap">libwiretap.so</primary>
|
---|
| 345 | </indexterm>
|
---|
| 346 | </listitem>
|
---|
| 347 | </varlistentry>
|
---|
[50b8d8b] | 348 |
|
---|
[13659efc] | 349 | </variablelist>
|
---|
| 350 |
|
---|
| 351 | </sect2>
|
---|
[1a3dd316] | 352 |
|
---|
| 353 | </sect1>
|
---|