[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">
|
---|
[3239e36] | 9 | <!ENTITY ethereal-md5sum "372b60e6eca14b7e1cf3e789207027f7">
|
---|
| 10 | <!ENTITY ethereal-size "7.7 MB">
|
---|
| 11 | <!ENTITY ethereal-buildsize "255 MB">
|
---|
| 12 | <!ENTITY ethereal-time "4.6 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 |
|
---|
[3239e36] | 117 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --enable-threads &&
|
---|
[13659efc] | 118 | make</userinput></screen>
|
---|
[28d83dbc] | 119 |
|
---|
| 120 | <para>This package does not come with a test suite.</para>
|
---|
[50b8d8b] | 121 |
|
---|
[13659efc] | 122 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[50b8d8b] | 123 |
|
---|
[28d83dbc] | 124 | <screen role="root"><userinput>make install &&
|
---|
| 125 | install -v -m644 doc/README.* /usr/share/ethereal &&
|
---|
| 126 | install -v -m644 -D ethereal.desktop \
|
---|
| 127 | /usr/share/applications/ethereal.desktop &&
|
---|
| 128 | install -v -m644 -D image/elogo3d48x48.png \
|
---|
| 129 | /usr/share/pixmaps/ethereal.png &&
|
---|
| 130 | install -v -m755 -d /usr/share/pixmaps/ethereal/toolbar &&
|
---|
| 131 | install -v -m644 image/*.{png,ico,xpm} /usr/share/pixmaps/ethereal &&
|
---|
| 132 | install -v -m644 image/toolbar/* /usr/share/pixmaps/ethereal/toolbar</userinput></screen>
|
---|
[50b8d8b] | 133 |
|
---|
[13659efc] | 134 | </sect2>
|
---|
[50b8d8b] | 135 |
|
---|
[13659efc] | 136 | <sect2 role="commands">
|
---|
| 137 | <title>Command Explanations</title>
|
---|
[50b8d8b] | 138 |
|
---|
[1065a91] | 139 | <para><parameter>--enable-threads</parameter>: This parameter enables the
|
---|
[28d83dbc] | 140 | use of threads in <command>ethereal</command>.</para>
|
---|
[50b8d8b] | 141 |
|
---|
[1065a91] | 142 | <para><option>--with-ssl</option>: This parameter enables the use of the
|
---|
[50b8d8b] | 143 | <application>OpenSSL</application>
|
---|
[13659efc] | 144 | <filename class='libraryfile'>libcrypto</filename> library.</para>
|
---|
[50b8d8b] | 145 |
|
---|
[13659efc] | 146 | </sect2>
|
---|
[50b8d8b] | 147 |
|
---|
[13659efc] | 148 | <sect2 role="configuration">
|
---|
| 149 | <title>Configuring Ethereal</title>
|
---|
| 150 |
|
---|
| 151 | <sect3 id="ethereal-config">
|
---|
| 152 | <title>Config Files</title>
|
---|
[50b8d8b] | 153 |
|
---|
[1065a91] | 154 | <para><filename>/etc/ethereal.conf</filename> and
|
---|
[13659efc] | 155 | <filename>~/.ethereal/preferences</filename></para>
|
---|
[50b8d8b] | 156 |
|
---|
[13659efc] | 157 | <indexterm zone="ethereal ethereal-config">
|
---|
| 158 | <primary sortas="e-AA.ethereal-preferences">~/.ethereal/preferences</primary>
|
---|
| 159 | </indexterm>
|
---|
[50b8d8b] | 160 |
|
---|
[13659efc] | 161 | <indexterm zone="ethereal ethereal-config">
|
---|
| 162 | <primary sortas="e-etc-ethereal.conf">/etc/ethereal.conf</primary>
|
---|
| 163 | </indexterm>
|
---|
[50b8d8b] | 164 |
|
---|
[13659efc] | 165 | </sect3>
|
---|
[50b8d8b] | 166 |
|
---|
[13659efc] | 167 | <sect3>
|
---|
| 168 | <title>Configuration Information</title>
|
---|
[50b8d8b] | 169 |
|
---|
[1065a91] | 170 | <para>Though the default configuration parameters are very sane,
|
---|
| 171 | reference the configuration section of the
|
---|
| 172 | <ulink url="http://www.ethereal.com/docs/user-guide/">Ethereal User's
|
---|
| 173 | Guide</ulink> for configuration information. Most of
|
---|
| 174 | <application>Ethereal</application>'s configuration can be accomplished
|
---|
[50b8d8b] | 175 | using the menu options of the <command>ethereal</command>
|
---|
[13659efc] | 176 | GUI interface.</para>
|
---|
[50b8d8b] | 177 |
|
---|
[13659efc] | 178 | <note>
|
---|
[1065a91] | 179 | <para>If you want to look at packets, make sure you don't filter
|
---|
| 180 | them out with <xref linkend="iptables"/>. If you want to exclude
|
---|
| 181 | certain classes of packets, it is more efficient to do it with
|
---|
| 182 | <application>iptables</application> than
|
---|
[13659efc] | 183 | <application>Ethereal</application>.</para>
|
---|
| 184 | </note>
|
---|
[50b8d8b] | 185 |
|
---|
[13659efc] | 186 | </sect3>
|
---|
[50b8d8b] | 187 |
|
---|
[13659efc] | 188 | </sect2>
|
---|
[50b8d8b] | 189 |
|
---|
[13659efc] | 190 | <sect2 role="content">
|
---|
| 191 | <title>Contents</title>
|
---|
| 192 |
|
---|
| 193 | <segmentedlist>
|
---|
| 194 | <segtitle>Installed Programs</segtitle>
|
---|
| 195 | <segtitle>Installed Libraries</segtitle>
|
---|
| 196 | <segtitle>Installed Directories</segtitle>
|
---|
[50b8d8b] | 197 |
|
---|
[13659efc] | 198 | <seglistitem>
|
---|
[1065a91] | 199 | <seg>capinfos, dftest, editcap, ethereal, idl2eth, mergecap, randpkt,
|
---|
[13659efc] | 200 | tethereal and text2pcap</seg>
|
---|
[1065a91] | 201 | <seg>libethereal.so, libwiretap.so and numerous dissector plugin
|
---|
[28d83dbc] | 202 | modules</seg>
|
---|
[1065a91] | 203 | <seg>/usr/lib/ethereal, /usr/share/ethereal and
|
---|
[28d83dbc] | 204 | /usr/share/pixmaps/ethereal</seg>
|
---|
[13659efc] | 205 | </seglistitem>
|
---|
| 206 | </segmentedlist>
|
---|
[50b8d8b] | 207 |
|
---|
[13659efc] | 208 | <variablelist>
|
---|
| 209 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 210 | <?dbfo list-presentation="list"?>
|
---|
| 211 | <?dbhtml list-presentation="table"?>
|
---|
[50b8d8b] | 212 |
|
---|
[13659efc] | 213 | <varlistentry id="capinfos">
|
---|
| 214 | <term><command>capinfos</command></term>
|
---|
| 215 | <listitem>
|
---|
[1065a91] | 216 | <para>reads a saved capture file and returns any or all of several
|
---|
| 217 | statistics about that file. It is able to detect and read any capture
|
---|
[13659efc] | 218 | supported by the <application>Ethereal</application> package.</para>
|
---|
| 219 | <indexterm zone="ethereal capinfos">
|
---|
| 220 | <primary sortas="b-capinfos">capinfos</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
[50b8d8b] | 224 |
|
---|
[13659efc] | 225 | <varlistentry id="dftest">
|
---|
| 226 | <term><command>dftest</command></term>
|
---|
| 227 | <listitem>
|
---|
| 228 | <para>is a display-filter-compiler test program.</para>
|
---|
| 229 | <indexterm zone="ethereal dftest">
|
---|
| 230 | <primary sortas="b-dftest">dftest</primary>
|
---|
| 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
[50b8d8b] | 234 |
|
---|
[13659efc] | 235 | <varlistentry id="editcap">
|
---|
| 236 | <term><command>editcap</command></term>
|
---|
| 237 | <listitem>
|
---|
[1065a91] | 238 | <para>edits and/or translates the format of capture files. It knows
|
---|
| 239 | how to read <application>libpcap</application> capture files,
|
---|
| 240 | including those of <command>tcpdump</command>,
|
---|
| 241 | <application>Ethereal</application> and other tools that write
|
---|
[28d83dbc] | 242 | captures in that format.</para>
|
---|
[13659efc] | 243 | <indexterm zone="ethereal editcap">
|
---|
| 244 | <primary sortas="b-editcap">editcap</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
| 247 | </varlistentry>
|
---|
[50b8d8b] | 248 |
|
---|
[13659efc] | 249 | <varlistentry id="ethereal-prog">
|
---|
| 250 | <term><command>ethereal</command></term>
|
---|
| 251 | <listitem>
|
---|
[1065a91] | 252 | <para>is a GUI network protocol analyzer. It lets you interactively
|
---|
| 253 | browse packet data from a live network or from a previously
|
---|
[13659efc] | 254 | saved capture file.</para>
|
---|
| 255 | <indexterm zone="ethereal ethereal-prog">
|
---|
| 256 | <primary sortas="b-ethereal">ethereal</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
[50b8d8b] | 260 |
|
---|
[13659efc] | 261 | <varlistentry id="idl2eth">
|
---|
| 262 | <term><command>idl2eth</command></term>
|
---|
| 263 | <listitem>
|
---|
[1065a91] | 264 | <para>takes a user specified CORBA
|
---|
| 265 | IDL file and generates <quote>C</quote> source code that
|
---|
[50b8d8b] | 266 | can be used to create an <application>Ethereal</application>
|
---|
[28d83dbc] | 267 | plugin.</para>
|
---|
[13659efc] | 268 | <indexterm zone="ethereal idl2eth">
|
---|
| 269 | <primary sortas="b-idl2eth">idl2eth</primary>
|
---|
| 270 | </indexterm>
|
---|
| 271 | </listitem>
|
---|
| 272 | </varlistentry>
|
---|
[50b8d8b] | 273 |
|
---|
[13659efc] | 274 | <varlistentry id="mergecap">
|
---|
| 275 | <term><command>mergecap</command></term>
|
---|
| 276 | <listitem>
|
---|
[1065a91] | 277 | <para>combines multiple saved capture files into a single output
|
---|
[13659efc] | 278 | file.</para>
|
---|
| 279 | <indexterm zone="ethereal mergecap">
|
---|
| 280 | <primary sortas="b-mergecap">mergecap</primary>
|
---|
| 281 | </indexterm>
|
---|
| 282 | </listitem>
|
---|
| 283 | </varlistentry>
|
---|
[50b8d8b] | 284 |
|
---|
[13659efc] | 285 | <varlistentry id="randpkt">
|
---|
| 286 | <term><command>randpkt</command></term>
|
---|
| 287 | <listitem>
|
---|
| 288 | <para>creates random-packet capture files.</para>
|
---|
| 289 | <indexterm zone="ethereal randpkt">
|
---|
| 290 | <primary sortas="b-randpkt">randpkt</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
[50b8d8b] | 294 |
|
---|
[13659efc] | 295 | <varlistentry id="tethereal">
|
---|
| 296 | <term><command>tethereal</command></term>
|
---|
| 297 | <listitem>
|
---|
[1065a91] | 298 | <para>is a TTY-mode network protocol analyzer. It lets you capture
|
---|
| 299 | packet data from a live network or read packets from a
|
---|
[13659efc] | 300 | previously saved capture file.</para>
|
---|
| 301 | <indexterm zone="ethereal tethereal">
|
---|
| 302 | <primary sortas="b-tethereal">tethereal</primary>
|
---|
| 303 | </indexterm>
|
---|
| 304 | </listitem>
|
---|
| 305 | </varlistentry>
|
---|
[50b8d8b] | 306 |
|
---|
[13659efc] | 307 | <varlistentry id="text2pcap">
|
---|
| 308 | <term><command>text2pcap</command></term>
|
---|
| 309 | <listitem>
|
---|
[1065a91] | 310 | <para>reads in an ASCII hex dump and writes the
|
---|
| 311 | data described into a <application>libpcap</application>-style
|
---|
[28d83dbc] | 312 | capture file.</para>
|
---|
[13659efc] | 313 | <indexterm zone="ethereal text2pcap">
|
---|
| 314 | <primary sortas="b-text2pcap">text2pcap</primary>
|
---|
| 315 | </indexterm>
|
---|
| 316 | </listitem>
|
---|
| 317 | </varlistentry>
|
---|
[50b8d8b] | 318 |
|
---|
[13659efc] | 319 | <varlistentry id="libethereal">
|
---|
| 320 | <term><filename class='libraryfile'>libethereal.so</filename></term>
|
---|
| 321 | <listitem>
|
---|
[1065a91] | 322 | <para>contains functions used by the
|
---|
| 323 | <application>Ethereal</application> programs to perform filtering and
|
---|
[13659efc] | 324 | packet capturing.</para>
|
---|
| 325 | <indexterm zone="ethereal libethereal">
|
---|
| 326 | <primary sortas="c-libethereal">libethereal.so</primary>
|
---|
| 327 | </indexterm>
|
---|
| 328 | </listitem>
|
---|
| 329 | </varlistentry>
|
---|
[50b8d8b] | 330 |
|
---|
[13659efc] | 331 | <varlistentry id="libwiretap">
|
---|
| 332 | <term><filename class='libraryfile'>libwiretap.so</filename></term>
|
---|
| 333 | <listitem>
|
---|
[1065a91] | 334 | <para>is a library being developed as a future replacement for
|
---|
| 335 | <filename class='libraryfile'>libpcap</filename>, the current
|
---|
| 336 | standard Unix library for packet capturing. For more information,
|
---|
| 337 | see the <filename>README</filename> file in the source
|
---|
[13659efc] | 338 | <filename class='directory'>wiretap</filename> directory.</para>
|
---|
| 339 | <indexterm zone="ethereal libwiretap">
|
---|
| 340 | <primary sortas="c-libwiretap">libwiretap.so</primary>
|
---|
| 341 | </indexterm>
|
---|
| 342 | </listitem>
|
---|
| 343 | </varlistentry>
|
---|
[50b8d8b] | 344 |
|
---|
[13659efc] | 345 | </variablelist>
|
---|
| 346 |
|
---|
| 347 | </sect2>
|
---|
[1a3dd316] | 348 |
|
---|
| 349 | </sect1>
|
---|