Updates for 0.10.13.
[obnox/wireshark/wip.git] / 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   <!ENTITY DocumentTitle "<application>Ethereal</application> Release Notes">
13   <!ENTITY DocumentSubTitle "&DocumentVersion; (&SvnVersion;) for Ethereal &EtherealCurrentVersion;">
14   <!ENTITY DocumentTitleAbbreviation "Relnotes">
15
16   <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
17   %SvnVersionFile;
18 <!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
19
20 <!--
21 Ethereal Info
22 -->
23   <!ENTITY EtherealCurrentVersion "0.10.13 (preliminary)">
24   <!ENTITY EtherealWebSite "http://www.ethereal.com">
25   <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
26   <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
27   <!ENTITY EtherealBinariesPage "&EtherealWebSite;/download.html#releases">
28   <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
29   <!ENTITY EtherealProtocolsPage "&EtherealWebSite;/docs/dfref/">
30   <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
31   <!ENTITY EtherealFAQPromiscPage "&EtherealWebSite;/faq#promiscsniff">
32   <!ENTITY EtherealMediaPage "&EtherealWebSite;/media.html">
33   <!ENTITY EtherealWikiPage "http://wiki.ethereal.com">
34   <!ENTITY EtherealWikiCaptureFiltersPage "&EtherealWikiPage;/CaptureFilters">
35   <!ENTITY EtherealWikiDisplayFiltersPage "&EtherealWikiPage;/DisplayFilters">
36   <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
37   <!ENTITY EtherealWikiColoringRulesPage "&EtherealWikiPage;/ColoringRules">
38   <!ENTITY EtherealWikiPreferencesPage "&EtherealWikiPage;/Preferences">
39
40   <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
41   <!ENTITY EtherealUsersMailList "ethereal-users[AT]ethereal.com">
42
43   
44 <!--
45 Winpcap Info
46 -->
47   <!ENTITY WinPcapWebsite "http://www.winpcap.org">
48   <!ENTITY WinPcapDownloadWebsite "http://www.winpcap.org/install/default.htm">
49
50 <!--
51 Gnu info
52 -->
53   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
54
55 ]>
56
57 <article>
58   <title>Ethereal &EtherealCurrentVersion; Release Notes</title>
59
60   <section id="WhatIs"><title>What is Ethereal?</title>
61     <para>
62       Ethereal is the world's most popular network protocol analyzer.  It
63       is used for troubleshooting, analysis, development, and education.
64     </para>
65   </section>
66
67   <section id="WhatsNew"><title>What's New</title>
68     <section><title>Bug Fixes</title>
69     <para>
70       Several security vulnerabilities have been fixed since the
71       previous release.  See the
72       <ulink url="http://www.ethereal.com/appnotes/enpa-sa-00021.html">application
73       advisory</ulink> for more details.
74       <itemizedlist>
75
76         <listitem><para>
77           The ISAKMP dissector could exhaust system memory.
78           <!-- Fixed in r15163 -->
79           <!-- Bug IDs: none -->
80           Versions affected: 0.10.11 to 0.10.12.
81         </para></listitem>
82
83         <listitem><para>
84           The FC-FCS dissector could exhaust system memory.
85           <!-- Fixed in r15204 -->
86           <!-- Bug IDs: 312 -->
87           Versions affected: 0.9.0 to 0.10.12.
88         </para></listitem>
89
90         <listitem><para>
91           The RSVP dissector could exhaust system memory.
92           <!-- Fixed in r15206, r15600 -->
93           <!-- Bug IDs: 311, 314, 382 -->
94           Versions affected: 0.9.4 to 0.10.12.
95         </para></listitem>
96
97         <listitem><para>
98           The ISIS LSP dissector could exhaust system memory.
99           <!-- Fixed in r15245 -->
100           <!-- Bug IDs: 320, 326 -->
101           Versions affected: 0.8.18 to 0.10.12.
102         </para></listitem>
103
104         <listitem><para>
105           The IrDA dissector could crash.
106           <!-- Fixed in r15265, r15267 -->
107           <!-- Bug IDs: 328, 329, 330, 334, 335, 336 -->
108           Versions affected: 0.10.0 to 0.10.12.
109         </para></listitem>
110
111         <listitem><para>
112           The SLIMP3 dissector could overflow a buffer.
113           <!-- Fixed in r15279 -->
114           <!-- Bug IDs: 327 -->
115           Versions affected: 0.9.1 to 0.10.12.
116         </para></listitem>
117
118         <listitem><para>
119           The BER dissector was susceptible to an infinite loop.
120           <!-- Fixed in r15292 -->
121           <!-- Bug IDs: none -->
122           Versions affected: 0.10.3 to 0.10.12.
123         </para></listitem>
124
125         <listitem><para>
126           The SCSI dissector could dereference a null pointer and crash.
127           <!-- Fixed in r15289 -->
128           <!-- Bug IDs: none -->
129           Versions affected: 0.10.3 to 0.10.12.
130         </para></listitem>
131
132         <listitem><para>
133           If the "Dissect unknown RPC program numbers" option was enabled,
134           the ONC RPC dissector might be able to exhaust system memory.
135           This option is disabled by default.
136           <!-- Fixed in r15290 -->
137           <!-- Bug IDs: none -->
138           Versions affected: 0.7.7 to 0.10.12.
139         </para></listitem>
140
141         <listitem><para>
142           The sFlow dissector could dereference a null pointer and crash.
143           <!-- Fixed in r15375 -->
144           <!-- Bug IDs: 356 -->
145           Versions affected: 0.9.14 to 0.10.12.
146         </para></listitem>
147
148         <listitem><para>
149           The RTnet dissector could dereference a null pointer and crash.
150           <!-- Fixed in r15673 -->
151           <!-- Bug IDs: none -->
152           Versions affected: 0.10.8 to 0.10.12.
153         </para></listitem>
154
155         <listitem><para>
156           The SigComp UDVM could go into an infinite loop or crash.
157           <!-- Fixed in r15715, r15901, r15919 -->
158           <!-- Bug IDs: none -->
159           Versions affected: 0.10.12.
160         </para></listitem>
161
162         <listitem><para>
163           If SMB transaction payload reassembly is enabled the SMB
164           dissector could crash.  This preference is disabled by default.
165           <!-- Fixed in r15789 -->
166           <!-- Bug IDs: 421 -->
167           Versions affected: 0.9.7 to 0.10.12.
168         </para></listitem>
169
170         <listitem><para>
171           The X11 dissector could attempt to divide by zero.
172           <!-- Fixed in r15927 -->
173           <!-- Bug IDs: none -->
174           Versions affected: 0.10.1 to 0.10.12.
175         </para></listitem>
176
177         <listitem><para>
178           The AgentX dissector could overflow a buffer.
179           <!-- Fixed in r16003 -->
180           <!-- Bug IDs: none -->
181           Versions affected: 0.10.10 to 0.10.12.
182         </para></listitem>
183
184       </itemizedlist>
185     </para>
186
187     <para>
188       When trying to save a flow graph, Ethereal could crash.
189     </para>
190
191     <para>
192       The PCRE library that ships with the Windows installer has been upgraded
193       from version 4.4 to 6.3 in response to a
194       <ulink url="http://www.securityfocus.com/bid/14620">security
195       vulnerability</ulink>.
196     </para>
197     </section>
198
199     <section><title>New and Updated Features</title>
200     <para>
201       The following features are new (or have been significantly updated) since 
202           the last release:
203       <itemizedlist>
204
205         <listitem><para>
206           The <command>timestamp display precision</command> of the Packet List 
207           can be adjusted now. The precision will be automatically adjusted 
208           depending on the file format loaded, e.g. libpcap typically uses 
209           microsecond resolution displayed like "0.000000". In addition you can 
210           adjust the precision manually through the View/Time Display Format menu 
211           items.
212         </para></listitem>
213
214         <listitem><para>
215           The <command>WinPcap version 3.1</command> installer was released since 
216           the last Ethereal release. The version included in the Ethereal Windows 
217           installer has been updated from 3.1 beta 4 to 3.1. 
218           If you want to upgrade WinPcap separately or install a 
219           different version you can download it from:
220           <ulink url="http://www.winpcap.org">the WinPcap web site</ulink>.
221         </para></listitem>
222
223         <listitem><para>
224           The behavior of the display filter
225           <command>"ip.checksum_bad" has changed</command>.
226       Instead of merely checking for its presence you must now make sure
227       it is set, e.g. instead of using "ip.checksum_bad" you must now
228       use "ip.checksum_bad == 1".
229         </para></listitem>
230
231         <listitem><para>
232           A new capture file format 
233           <command>"Nanosecond libpcap (Ethereal)"</command> was added. It is 
234           very similar to the common libpcap file format but is capable of keeping 
235           nanosecond resolution timestamps. This format is currently supported only
236           by Ethereal.
237         </para></listitem>
238
239         <listitem><para>
240           Ethereal's memory managment has been greatly improved.
241         </para></listitem>
242
243       </itemizedlist>
244     </para>
245     </section>
246
247     <section><title>New Protocol Support</title>
248     <para>
249
250     CIMD, CISCOWL-L2, DCCP, EDP, GNM, LLDP, ROS, RTSE, STANAG 4406,
251     WINS Replication, X.411, X.420
252
253     </para>
254     </section>
255
256     <section><title>Updated Protocol Support</title> <para>
257
258     802.11 Radiotap, A11, AARP, ACSE, ACtrace, AFP, AFS, AgentX,
259     AIM, AJP13, ALCAP, AMR, ANSI A, ANSI IS-637-A, ANSI IS-683-A,
260     ANSI IS-801, ANSI MAP, AOE, AppleTalk, Armagetronad, ARP, ASAP,
261     ASN.1, BACapp, BER, BGP, BitTorrent, BOOTP, CAMEL, CLNP, CMIP,
262     CMP, CMS, COPS, CRMF, CSM_ENCAPS, DAAP, DCERPC (ATSVC, DCE_DFS,
263     FLDB, INITSHUTDOWN, LSA, NETLOGON, NT, SAMR, SPOOLSS, WINREG), DCM,
264     DCOM, DHCP Failover, DIAMETER, ENRP, ESS, FC, FCCT, FCDNS, FCELS,
265     FCFCS, FCFZS, FCP, FCSWILS, FTAM, GIOP, GPRS LLC, GSM, GTP, H1,
266     H.225, H.235, H.245, H.248, H.261, H.263, H.450, HSRP, HTTP, IAX2,
267     IEEE 802.11, IEEE 802.3, IEEE 802.3 Slow protocols, IP, IP/IEEE1394,
268     IRC, IrDA, ISAKMP, iSCSI, ISIS, ISUP, Jabber, JFIF, Juniper, JXTA,
269     K12, Kerberos, LDAP, LDP, LLC, LPD, MAP_DialoguePDU, MDSHDR, Media,
270     MEGACO, MGCP, MIME multipart, MMS, MOUNT, MQ, MSMMS, NBNS, NDMP,
271     NS_CERT_EXTS, OCSP, OPSI, OSPF, PARLAY, PER, PKINIT, PKIX, PN-RT,
272     PPP, PRES, PTP, RADIUS, RDT, RPC, RSVP, RTCP, RTnet, RTSP, SCCP,
273     SCSI, SCTP, SES, sFlow, SIGCOMP, SIP, SliMP3, SMB, SMPP, SMRSE,
274     SNA, SNMP, SPNEGO, STUN, T.38, TCAP, TCP, Text, TPKT, UMA, WBXML,
275     WLANCERTEXTN, WSP, X11, X.25, X.509, XML, YMSG
276
277     </para>
278     </section>
279
280     <section><title>New and Updated Capture File Support</title>
281     <para>
282
283     Tektronix K12
284
285     </para>
286     </section>
287
288   </section>
289
290   <section id="GettingEthereal"><title>Getting Ethereal</title>
291     <section><title>Microsoft Windows</title>
292       <para>
293         Download ethereal-setup-&EtherealCurrentVersion;.exe from the
294         <ulink url="http://www.ethereal.com/docs/distribution/win32/">Windows
295         download area</ulink> on the main web site.  Double-click the 
296         installer executable.
297       </para>
298     </section>
299
300     <section><title>Sun Solaris</title>
301       <para>
302         Download the appropriate package from the
303         <ulink url="http://www.ethereal.com/docs/distribution/solaris/">Solaris
304         download area</ulink> on the main web site.  Uncompress the package
305         using bzip2, and install it using pkgadd.
306       </para>
307     </section>
308
309     <section><title>Source Code</title>
310       <para>
311         Download ethereal-&EtherealCurrentVersion;.tar.gz from the
312         <ulink url="http://www.ethereal.com/docs/distribution/">main
313         download area</ulink> on the web site.  Extract the package
314         using tar and gzip.  Run "configure ; make ; make install".
315       </para>
316     </section>
317
318     <section><title>Vendor-supplied Packages</title>
319       <para>
320         Most Linux and Unix vendors supply their own Ethereal packages.
321         You can install or upgrade Ethereal using the package management
322         system specific to that platform.
323       </para>
324     </section>
325
326   </section>
327
328   <!-- XXX needs to be written 
329   <section id="RemovingEthereal"><title>Removing Ethereal</title>
330     <para>
331     </para>
332   </section>
333   -->
334
335   <section id="FileLocations"><title>File Locations</title>
336     <para>
337       Ethereal and Tethereal look in several different locations for
338       preference files, plugins, SNMP MIBS, and RADIUS dictionaries.
339       These locations vary from platform to platform.  You can use
340       About->Folders to find the default locations on your system.
341     </para>
342   </section>
343
344   <section id="KnownProblems"><title>Known Problems</title>
345     <para>
346     On Windows systems the packet list scroll bar can sometimes disappear
347     or become unusable.  Until the problem is fixed you can work around it
348     by resizing the packet list or the main window.
349     (<ulink url="http://bugs.ethereal.com/bugzilla/show_bug.cgi?id=220">Bug
350     #220</ulink>)
351     </para>
352   </section>
353
354   <section id="GettingHelp"><title>Getting Help</title>
355     <para>
356     Community support is available on the ethereal-users mailing list.
357     Subscription information and archives for all of Ethereal's mailing
358     lists can be found on <ulink url="http://www.ethereal.com/lists">the
359     web site</ulink>. There is also an <ulink url="irc://irc.freenode.net/ethereal">IRC channel dedicated to Ethereal</ulink>.
360     </para>
361     <para>
362     Commercial support, training, and development services are available
363     from <ulink url="http://www.etherealsoft.com/">Ethereal Software</ulink>.
364     </para>
365   </section>
366
367   <section id="FAQ"><title>Frequently Asked Questions</title>
368     <para>
369     A complete FAQ is available on the
370     <ulink url="http://www.ethereal.com/faq.html">Ethereal web site</ulink>.
371     </para>
372   </section>
373
374 </article>