docbook/release-notes.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8 DOCUMENT SECTION
   9 -Use this section to encode all document information
  10 -->
  11
  12 <!--
  13 Ethereal Info
  14 -->
  15   <!ENTITY EtherealCurrentVersion "0.99.0">
  16
  17 ]>
  18
  19 <article>
  20   <title>Ethereal &EtherealCurrentVersion; Release Notes</title>
  21
  22   <section id="WhatIs"><title>What is Ethereal?</title>
  23     <para>
  24       Ethereal is the world's most popular network protocol analyzer.  It
  25       is used for troubleshooting, analysis, development, and education.
  26     </para>
  27   </section>
  28
  29   <section id="WhatsNew"><title>What's New</title>
  30     <section><title>Bug Fixes</title>
  31     <para>
  32       Many security vulnerabilities have been fixed since the
  33       previous release.  See the
  34       <ulink url="http://www.ethereal.com/appnotes/enpa-sa-00022.html">application
  35       advisory</ulink> for more details.
  36       <itemizedlist>
  37
  38         <listitem><para>
  39           The H.248 dissector could crash.
  40           <!-- Fixed in r16967, r17015 -->
  41           <!-- Bug IDs: 651 -->
  42           Versions affected: 0.10.14.
  43         </para></listitem>
  44
  45         <listitem><para>
  46           The UMA dissector could go into an infinite loop.
  47           <!-- Fixed in r17119, r17273 -->
  48           <!-- Bug IDs: 716 -->
  49           Versions affected: 0.10.12.
  50         </para></listitem>
  51
  52         <!-- Canary bugs found after r17235 -->
  53
  54         <listitem><para>
  55           The X.509if dissector could crash.
  56           <!-- Fixed in r16995, r17337 -->
  57           <!-- Bug IDs: None -->
  58           Versions affected: 0.10.14.
  59         </para></listitem>
  60
  61         <listitem><para>
  62           The SRVLOC dissector could crash.
  63           <!-- Fixed in r17001 -->
  64           <!-- Bug IDs: None -->
  65           Versions affected: 0.10.0.
  66         </para></listitem>
  67
  68         <listitem><para>
  69           The H.245 dissector could crash.
  70           <!-- Fixed in r17022 -->
  71           <!-- Bug IDs: 667 -->
  72           Versions affected: 0.10.13.
  73         </para></listitem>
  74
  75         <listitem><para>
  76           Ethereal's OID printing routine was susceptible to an
  77           off-by-one error.
  78           <!-- Fixed in r17048 -->
  79           <!-- Bug IDs: 698 -->
  80           Versions affected: 0.10.14.
  81         </para></listitem>
  82
  83         <listitem><para>
  84           The COPS dissector could overflow a buffer.
  85           <!-- Fixed in r17051 -->
  86           <!-- Bug IDs: None -->
  87           Versions affected: 0.9.15.
  88         </para></listitem>
  89
  90         <!-- Coverity bugs (r17499 and above) -->
  91
  92       </itemizedlist>
  93
  94       Under a grant funded by the U.S. Department of Homeland Security,
  95       <ulink url="http://www.coverity.com">Coverity</ulink> has uncovered
  96       a number of vulnerabilities in Ethereal:
  97       <itemizedlist>
  98
  99         <listitem><para>
 100           The GSM SMS dissector could crash Ethereal.
 101           <!-- Fixed in r17506 -->
 102           <!-- Bug IDs: None -->
 103           <!-- Coverity CID 104 -->
 104           Versions affected: 0.9.16.
 105         </para></listitem>
 106
 107       </itemizedlist>
 108     </para>
 109
 110     <para>
 111       Win32: Unicode characters in the users profile path causes problems
 112       reading/writing the preferences (and alike) files.
 113       <!-- Fixed in r17024,r17025 -->
 114       <!-- Bug IDs: 648 -->
 115       Versions affected: 0.10.14.
 116     </para>
 117
 118     </section>
 119
 120     <section><title>New and Updated Features</title>
 121     <para>
 122       The following features are new (or have been significantly updated)
 123       since the last release:
 124       <itemizedlist>
 125
 126         <listitem><para>
 127           The new command line tool <command>dumpcap</command> makes it
 128           possible to capture network data without the drawbacks of (t)ethereal
 129           (memory usage, security problems, ...) while keeping the benefit of
 130           advanced techniques like multiple (ringbuffer) files and alike.
 131           </para>
 132           <para>
 133           The manpage of <command>dumpcap</command> in HTML format is available
 134           at: <ulink url="http://www.ethereal.com/docs/"/>
 135         </para></listitem>
 136
 137         <listitem><para>
 138           Win32: Catch hardware exceptions caused by buggy dissectors.
 139           If e.g. a NULL pointer exceptions occurs, Ethereal won't crash now
 140           but displays the exception and tries to continue decoding packets.
 141         </para></listitem>
 142
 143         <listitem><para>
 144           The Windows version of Ethereal now uses native open and save
 145           file dialogs.
 146         </para>
 147         <para>
 148           In related news, Ethereal now runs as a full-fledged Unicode
 149           application under Windows.
 150         </para></listitem>
 151
 152         <listitem><para>
 153           Recent versions of Ethereal were flagging packets with an
 154           incorrect TCP checksum as malformed.  False positives were
 155           being triggered on systems that use TCP checksum offloading.
 156           We now check to see if the checksum is <emphasis>not</emphasis>
 157           0x0000 before flagging the packet as malformed.
 158
 159           <note><title>Please Note</title>
 160           <para>
 161             If your system uses TCP checksum offloading <emphasis>and</emphasis>
 162             Ethereal still shows bad checksums for outgoing TCP packets
 163             <emphasis>and</emphasis> the checksums for outgoing TCP packets
 164             are <emphasis>not</emphasis> 0x0000, this could mean that your
 165             operating system is exposing kernel memory unneccessarily.  If
 166             this is the case, you should report the problem to your OS
 167             vendor.
 168           </para>
 169                   </note>
 170         </para></listitem>
 171
 172       </itemizedlist>
 173     </para>
 174     </section>
 175
 176     <section><title>New Protocol Support</title>
 177     <para>
 178
 179     </para>
 180     </section>
 181
 182     <section><title>Updated Protocol Support</title> <para>
 183
 184     </para>
 185     </section>
 186
 187     <section><title>New and Updated Capture File Support</title>
 188     <para>
 189
 190     </para>
 191     </section>
 192
 193   </section>
 194
 195   <section id="GettingEthereal"><title>Getting Ethereal</title>
 196     <section><title>Microsoft Windows</title>
 197       <para>
 198         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
 199         <ulink url="http://www.ethereal.com/distribution/win32/">Windows
 200         download area</ulink> on the main web site.  Double-click the
 201         installer executable.
 202       </para>
 203     </section>
 204
 205     <section><title>Sun Solaris</title>
 206       <para>
 207         Download the appropriate package from the
 208         <ulink url="http://www.ethereal.com/distribution/solaris/">Solaris
 209         download area</ulink> on the main web site.  Uncompress the package
 210         using bzip2, and install it using pkgadd.
 211       </para>
 212     </section>
 213
 214     <section><title>Source Code</title>
 215       <para>
 216         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
 217         <ulink url="http://www.ethereal.com/distribution/">main
 218         download area</ulink> on the web site.  Extract the package
 219         using tar and gzip.  Run "configure ; make ; make install".
 220       </para>
 221     </section>
 222
 223     <section><title>Vendor-supplied Packages</title>
 224       <para>
 225         Most Linux and Unix vendors supply their own Ethereal packages.
 226         You can install or upgrade Ethereal using the package management
 227         system specific to that platform.  A list of third-party packages
 228         can be found on the <ulink url="http://www.ethereal.com/download.html#otherplat">download page</ulink> on the Ethereal web site.
 229       </para>
 230     </section>
 231
 232   </section>
 233
 234   <!-- XXX needs to be written
 235   <section id="RemovingEthereal"><title>Removing Ethereal</title>
 236     <para>
 237     </para>
 238   </section>
 239   -->
 240
 241   <section id="FileLocations"><title>File Locations</title>
 242     <para>
 243       Ethereal and Tethereal look in several different locations for
 244       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
 245       These locations vary from platform to platform.  You can use
 246       About->Folders to find the default locations on your system.
 247     </para>
 248   </section>
 249
 250   <section id="KnownProblems"><title>Known Problems</title>
 251
 252     <para>
 253       On Windows systems the packet list scroll bar can sometimes disappear
 254       or become unusable.  Until the problem is fixed you can work around it
 255       by resizing the packet list or the main window.
 256       (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
 257       #220</ulink>)
 258     </para>
 259
 260     <para>
 261       The <userinput>Filter</userinput> button is nonfunctional in the
 262       file dialogs under Windows.
 263     </para>
 264
 265   </section>
 266
 267   <section id="GettingHelp"><title>Getting Help</title>
 268     <para>
 269     Community support is available on the ethereal-users mailing list.
 270     Subscription information and archives for all of Ethereal's mailing
 271     lists can be found on <ulink url="http://www.ethereal.com/lists/">the
 272     web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
 273     </para>
 274     <para>
 275     Commercial support, training, and development services are available
 276     from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
 277     </para>
 278   </section>
 279
 280   <section id="FAQ"><title>Frequently Asked Questions</title>
 281     <para>
 282     A complete FAQ is available on the
 283     <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
 284     </para>
 285   </section>
 286
 287 </article>