]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - NEWS.rst
.gitignore: also ignore tahoe-deps and .tgz, to fix 'make tarballs'
[tahoe-lafs/tahoe-lafs.git] / NEWS.rst
1 
2 ==================================
3 User-Visible Changes in Tahoe-LAFS
4 ==================================
5
6 Release 1.9.1 (2012-01-12)
7 --------------------------
8
9 Security-related Bugfix
10 '''''''''''''''''''''''
11
12 - Fix flaw that would allow servers to cause undetected corruption when
13   retrieving the contents of mutable files (both SDMF and MDMF). (`#1654`_)
14
15 .. _`#1654`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1654
16
17
18 Release 1.9.0 (2011-10-30)
19 --------------------------
20
21 New Features
22 ''''''''''''
23
24 - The most significant new feature in this release is MDMF: "Medium-size
25   Distributed Mutable Files". Unlike standard SDMF files, these provide
26   efficient partial-access (reading and modifying small portions of the file
27   instead of the whole thing). MDMF is opt-in (it is not yet the default
28   format for mutable files), both to ensure compatibility with previous
29   versions, and because the algorithm does not yet meet memory-usage goals.
30   Enable it with ``--format=MDMF`` in the CLI (``tahoe put`` and ``tahoe
31   mkdir``), or the "format" radioboxes in the web interface. See
32   `<docs/specifications/mutable.rst>`_ for more details (`#393`_, `#1507`_)
33 - A "blacklist" feature allows blocking access to specific files through
34   a particular gateway. See the "Access Blacklist" section of
35   `<docs/configuration.rst>`_ for more details. (`#1425`_)
36 - A "drop-upload" feature has been added, which allows you to upload
37   files to a Tahoe-LAFS directory just by writing them to a local
38   directory. This feature is experimental and should not be relied on
39   to store the only copy of valuable data. It is currently available
40   only on Linux. See `<docs/frontends/drop-upload.rst>`_ for documentation.
41   (`#1429`_)
42 - The timeline of immutable downloads can be viewed using a zoomable and
43   pannable JavaScript-based visualization. This is accessed using the
44   'timeline' link on the File Download Status page for the download, which
45   can be reached from the Recent Uploads and Downloads page.
46
47 Configuration/Behavior Changes
48 ''''''''''''''''''''''''''''''
49
50 - Prior to Tahoe-LAFS v1.3, the configuration of some node options could
51   be specified using individual config files rather than via ``tahoe.cfg``.
52   These files now cause an error if present. (`#1385`_)
53 - Storage servers now calculate their remaining space based on the filesystem
54   containing the ``storage/shares/`` directory. Previously they looked at the
55   filesystem containing the ``storage/`` directory. This allows
56   ``storage/shares/``, rather than ``storage/``, to be a mount point or a
57   symlink pointing to another filesystem. (`#1384`_)
58 - ``tahoe cp xyz MUTABLE`` will modify the existing mutable file instead of
59   creating a new one. (`#1304`_)
60 - The button for unlinking a file from its directory on a WUI directory
61   listing is now labelled "unlink" rather than "del". (`#1104`_)
62
63 Notable Bugfixes
64 ''''''''''''''''
65
66 - The security bugfix for the vulnerability allowing deletion of shares,
67   detailed in the news for v1.8.3 below, is also included in this
68   release. (`#1528`_)
69 - Some cases of immutable upload, for example using the ``tahoe put`` and
70   ``tahoe cp`` commands or SFTP, did not appear in the history of Recent
71   Uploads and Downloads. (`#1079`_)
72 - The memory footprint of the verifier has been reduced by serializing
73   block fetches. (`#1395`_)
74 - Large immutable downloads are now a little faster than in v1.8.3 (about
75   5% on a fast network). (`#1268`_)
76
77 Packaging Changes
78 '''''''''''''''''
79
80 - The files related to Debian packaging have been removed from the Tahoe
81   source tree, since they are now maintained as part of the official
82   Debian packages. (`#1454`_)
83 - The unmaintained FUSE plugins were removed from the source tree. See
84   ``docs/frontends/FTP-and-SFTP.rst`` for how to mount a Tahoe filesystem on
85   Unix via sshfs. (`#1409`_)
86 - The Tahoe licenses now give explicit permission to combine Tahoe-LAFS
87   with code distributed under the following additional open-source licenses
88   (any version of each):
89
90   * Academic Free License
91   * Apple Public Source License
92   * BitTorrent Open Source License
93   * Lucent Public License
94   * Jabber Open Source License
95   * Common Development and Distribution License
96   * Microsoft Public License
97   * Microsoft Reciprocal License
98   * Sun Industry Standards Source License
99   * Open Software License
100
101 Compatibility and Dependencies
102 ''''''''''''''''''''''''''''''
103
104 - To resolve an incompatibility between Nevow and zope.interface (versions
105   3.6.3 and 3.6.4), Tahoe-LAFS now requires an earlier or later
106   version of zope.interface. (`#1435`_)
107 - The Twisted dependency has been raised to version 10.1 to ensure we no
108   longer require pywin32 on Windows, the new drop-upload feature has the
109   required support from Twisted on Linux, and that it is never necessary to
110   patch Twisted in order to use the FTP frontend. (`#1274`_, `#1429`_,
111   `#1438`_)
112 - An explicit dependency on pyOpenSSL has been added, replacing the indirect
113   dependency via the "secure_connections" option of foolscap. (`#1383`_)
114
115 Minor Changes
116 '''''''''''''
117
118 - A ``man`` page has been added (`#1420`_). All other docs are in ReST
119   format.
120 - The ``tahoe_files`` munin plugin reported an incorrect count of the number
121   of share files. (`#1391`_)
122 - Minor documentation updates: #627, #1104, #1225, #1297, #1342, #1404
123 - Other minor changes: #636, #1355, #1363, #1366, #1388, #1392, #1412, #1344,
124   #1347, #1359, #1389, #1441, #1442, #1446, #1474, #1503
125
126 .. _`#393`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/393
127 .. _`#1079`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1079
128 .. _`#1104`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1104
129 .. _`#1268`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1268
130 .. _`#1274`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1274
131 .. _`#1304`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1304
132 .. _`#1355`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1355
133 .. _`#1383`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1383
134 .. _`#1384`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1384
135 .. _`#1385`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1385
136 .. _`#1388`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1388
137 .. _`#1391`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1391
138 .. _`#1392`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1392
139 .. _`#1395`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1395
140 .. _`#1409`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1409
141 .. _`#1420`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1420
142 .. _`#1425`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1425
143 .. _`#1429`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1429
144 .. _`#1435`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1435
145 .. _`#1438`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1438
146 .. _`#1454`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1454
147 .. _`#1507`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1507
148
149
150 Release 1.8.3 (2011-09-13)
151 --------------------------
152
153 Security-related Bugfix
154 '''''''''''''''''''''''
155
156 - Fix flaw that would allow a person who knows a storage index of a file to
157   delete shares of that file. (`#1528`_)
158 - Remove corner cases in mutable file bounds management which could expose
159   extra lease info or old share data (from prior versions of the mutable
160   file) if someone with write authority to that mutable file exercised these
161   corner cases in a way that no actual Tahoe-LAFS client does. (Probably not
162   exploitable.) (`#1528`_)
163
164 .. _`#1528`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1528
165
166
167 Release 1.8.2 (2011-01-30)
168 --------------------------
169
170 Compatibility and Dependencies
171 ''''''''''''''''''''''''''''''
172
173 - Tahoe is now compatible with Twisted-10.2 (released last month), as
174   well as with earlier versions. The previous Tahoe-1.8.1 release
175   failed to run against Twisted-10.2, raising an AttributeError on
176   StreamServerEndpointService (`#1286`_)
177 - Tahoe now depends upon the "mock" testing library, and the foolscap
178   dependency was raised to 0.6.1 . It no longer requires pywin32
179   (which was used only on windows). Future developers should note that
180   reactor.spawnProcess and derivatives may no longer be used inside
181   Tahoe code.
182
183 Other Changes
184 '''''''''''''
185
186 - the default reserved_space value for new storage nodes is 1 GB
187   (`#1208`_)
188 - documentation is now in reStructuredText (.rst) format
189 - "tahoe cp" should now handle non-ASCII filenames
190 - the unmaintained Mac/Windows GUI applications have been removed
191   (`#1282`_)
192 - tahoe processes should appear in top and ps as "tahoe", not
193   "python", on some unix platforms. (`#174`_)
194 - "tahoe debug trial" can be used to run the test suite (`#1296`_)
195 - the SFTP frontend now reports unknown sizes as "0" instead of "?",
196   to improve compatibility with clients like FileZilla (`#1337`_)
197 - "tahoe --version" should now report correct values in situations
198   where 1.8.1 might have been wrong (`#1287`_)
199
200 .. _`#174`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/174
201 .. _`#1208`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1208
202 .. _`#1282`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1282
203 .. _`#1286`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1286
204 .. _`#1287`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1287
205 .. _`#1296`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1296
206 .. _`#1337`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1337
207
208
209 Release 1.8.1 (2010-10-28)
210 --------------------------
211
212 Bugfixes and Improvements
213 '''''''''''''''''''''''''
214
215 - Allow the repairer to improve the health of a file by uploading some
216   shares, even if it cannot achieve the configured happiness
217   threshold. This fixes a regression introduced between v1.7.1 and
218   v1.8.0. (`#1212`_)
219 - Fix a memory leak in the ResponseCache which is used during mutable
220   file/directory operations. (`#1045`_)
221 - Fix a regression and add a performance improvement in the
222   downloader.  This issue caused repair to fail in some special
223   cases. (`#1223`_)
224 - Fix a bug that caused 'tahoe cp' to fail for a grid-to-grid copy
225   involving a non-ASCII filename. (`#1224`_)
226 - Fix a rarely-encountered bug involving printing large strings to the
227   console on Windows. (`#1232`_)
228 - Perform ~ expansion in the --exclude-from filename argument to
229   'tahoe backup'. (`#1241`_)
230 - The CLI's 'tahoe mv' and 'tahoe ln' commands previously would try to
231   use an HTTP proxy if the HTTP_PROXY environment variable was set.
232   These now always connect directly to the WAPI, thus avoiding giving
233   caps to the HTTP proxy (and also avoiding failures in the case that
234   the proxy is failing or requires authentication). (`#1253`_)
235 - The CLI now correctly reports failure in the case that 'tahoe mv'
236   fails to unlink the file from its old location. (`#1255`_)
237 - 'tahoe start' now gives a more positive indication that the node has
238   started. (`#71`_)
239 - The arguments seen by 'ps' or other tools for node processes are now
240   more useful (in particular, they include the path of the 'tahoe'
241   script, rather than an obscure tool named 'twistd'). (`#174`_)
242
243 Removed Features
244 ''''''''''''''''
245
246 - The tahoe start/stop/restart and node creation commands no longer
247   accept the -m or --multiple option, for consistency between
248   platforms.  (`#1262`_)
249
250 Packaging
251 '''''''''
252
253 - We now host binary packages so that users on certain operating
254   systems can install without having a compiler.
255   <https://tahoe-lafs.org/source/tahoe-lafs/deps/tahoe-lafs-dep-eggs/README.html>
256 - Use a newer version of a dependency if needed, even if an older
257   version is installed. This would previously cause a VersionConflict
258   error. (`#1190`_)
259 - Use a precompiled binary of a dependency if one with a sufficiently
260   high version number is available, instead of attempting to compile
261   the dependency from source, even if the source version has a higher
262   version number. (`#1233`_)
263
264 Documentation
265 '''''''''''''
266
267 - All current documentation in .txt format has been converted to .rst
268   format. (`#1225`_)
269 - Added docs/backdoors.rst declaring that we won't add backdoors to
270   Tahoe-LAFS, or add anything to facilitate government access to data.
271   (`#1216`_)
272
273 .. _`#71`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/71
274 .. _`#174`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/174
275 .. _`#1212`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1212
276 .. _`#1045`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1045
277 .. _`#1190`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1190
278 .. _`#1216`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1216
279 .. _`#1223`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1223
280 .. _`#1224`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1224
281 .. _`#1225`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1225
282 .. _`#1232`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1232
283 .. _`#1233`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1233
284 .. _`#1241`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1241
285 .. _`#1253`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1253
286 .. _`#1255`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1255
287 .. _`#1262`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1262
288
289
290 Release 1.8.0 (2010-09-23)
291 --------------------------
292
293 New Features
294 ''''''''''''
295
296 - A completely new downloader which improves performance and
297   robustness of immutable-file downloads. It uses the fastest K
298   servers to download the data in K-way parallel. It automatically
299   fails over to alternate servers if servers fail in mid-download. It
300   allows seeking to arbitrary locations in the file (the previous
301   downloader which would only read the entire file sequentially from
302   beginning to end). It minimizes unnecessary round trips and
303   unnecessary bytes transferred to improve performance. It sends
304   requests to fewer servers to reduce the load on servers (the
305   previous one would send a small request to every server for every
306   download) (`#287`_, `#288`_, `#448`_, `#798`_, `#800`_, `#990`_,
307   `#1170`_, `#1191`_)
308 - Non-ASCII command-line arguments and non-ASCII outputs now work on
309   Windows. In addition, the command-line tool now works on 64-bit
310   Windows. (`#1074`_)
311
312 Bugfixes and Improvements
313 '''''''''''''''''''''''''
314
315 - Document and clean up the command-line options for specifying the
316   node's base directory. (`#188`_, `#706`_, `#715`_, `#772`_,
317   `#1108`_)
318 - The default node directory for Windows is ".tahoe" in the user's
319   home directory, the same as on other platforms. (`#890`_)
320 - Fix a case in which full cap URIs could be logged. (`#685`_,
321   `#1155`_)
322 - Fix bug in WUI in Python 2.5 when the system clock is set back to
323   1969. Now you can use Tahoe-LAFS with Python 2.5 and set your system
324   clock to 1969 and still use the WUI. (`#1055`_)
325 - Many improvements in code organization, tests, logging,
326   documentation, and packaging. (`#983`_, `#1074`_, `#1108`_,
327   `#1127`_, `#1129`_, `#1131`_, `#1166`_, `#1175`_)
328
329 Dependency Updates
330 ''''''''''''''''''
331
332 - on x86 and x86-64 platforms, pycryptopp >= 0.5.20
333 - pycrypto 2.2 is excluded due to a bug
334
335 .. _`#188`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/188
336 .. _`#287`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/287
337 .. _`#288`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/288
338 .. _`#448`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/448
339 .. _`#685`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/685
340 .. _`#706`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/706
341 .. _`#715`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/715
342 .. _`#772`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/772
343 .. _`#798`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/798
344 .. _`#800`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/800
345 .. _`#890`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/890
346 .. _`#983`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/983
347 .. _`#990`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/990
348 .. _`#1055`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1055
349 .. _`#1074`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1074
350 .. _`#1108`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1108
351 .. _`#1155`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1155
352 .. _`#1170`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1170
353 .. _`#1191`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1191
354 .. _`#1127`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1127
355 .. _`#1129`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1129
356 .. _`#1131`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1131
357 .. _`#1166`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1166
358 .. _`#1175`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1175
359
360 Release 1.7.1 (2010-07-18)
361 --------------------------
362
363 Bugfixes and Improvements
364 '''''''''''''''''''''''''
365
366 - Fix bug in which uploader could fail with AssertionFailure or report
367   that it had achieved servers-of-happiness when it hadn't. (`#1118`_)
368 - Fix bug in which servers could get into a state where they would
369   refuse to accept shares of a certain file (`#1117`_)
370 - Add init scripts for managing the gateway server on Debian/Ubuntu
371   (`#961`_)
372 - Fix bug where server version number was always 0 on the welcome page
373   (`#1067`_)
374 - Add new command-line command "tahoe unlink" as a synonym for "tahoe
375   rm" (`#776`_)
376 - The FTP frontend now encrypts its temporary files, protecting their
377   contents from an attacker who is able to read the disk. (`#1083`_)
378 - Fix IP address detection on FreeBSD 7, 8, and 9 (`#1098`_)
379 - Fix minor layout issue in the Web User Interface with Internet
380   Explorer (`#1097`_)
381 - Fix rarely-encountered incompatibility between Twisted logging
382   utility and the new unicode support added in v1.7.0 (`#1099`_)
383 - Forward-compatibility improvements for non-ASCII caps (`#1051`_)
384
385 Code improvements
386 '''''''''''''''''
387
388 - Simplify and tidy-up directories, unicode support, test code
389   (`#923`_, `#967`_, `#1072`_)
390
391 .. _`#776`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/776
392 .. _`#923`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/923
393 .. _`#961`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/961
394 .. _`#967`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/967
395 .. _`#1051`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1051
396 .. _`#1067`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1067
397 .. _`#1072`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1072
398 .. _`#1083`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1083
399 .. _`#1097`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1097
400 .. _`#1098`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1098
401 .. _`#1099`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1099
402 .. _`#1117`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1117
403 .. _`#1118`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1118
404
405
406 Release 1.7.0 (2010-06-18)
407 --------------------------
408
409 New Features
410 ''''''''''''
411
412 - SFTP support (`#1037`_)
413   Your Tahoe-LAFS gateway now acts like a full-fledged SFTP server. It
414   has been tested with sshfs to provide a virtual filesystem in Linux.
415   Many users have asked for this feature.  We hope that it serves them
416   well! See the `FTP-and-SFTP.rst`_ document to get
417   started.
418 - support for non-ASCII character encodings (`#534`_)
419   Tahoe-LAFS now correctly handles filenames containing non-ASCII
420   characters on all supported platforms:
421
422  - when reading files in from the local filesystem (such as when you
423    run "tahoe backup" to back up your local files to a Tahoe-LAFS
424    grid);
425  - when writing files out to the local filesystem (such as when you
426    run "tahoe cp -r" to recursively copy files out of a Tahoe-LAFS
427    grid);
428  - when displaying filenames to the terminal (such as when you run
429    "tahoe ls"), subject to limitations of the terminal and locale;
430  - when parsing command-line arguments, except on Windows.
431
432 - Servers of Happiness (`#778`_)
433   Tahoe-LAFS now measures during immutable file upload to see how well
434   distributed it is across multiple servers. It aborts the upload if
435   the pieces of the file are not sufficiently well-distributed.
436   This behavior is controlled by a configuration parameter called
437   "servers of happiness". With the default settings for its erasure
438   coding, Tahoe-LAFS generates 10 shares for each file, such that any
439   3 of those shares are sufficient to recover the file. The default
440   value of "servers of happiness" is 7, which means that Tahoe-LAFS
441   will guarantee that there are at least 7 servers holding some of the
442   shares, such that any 3 of those servers can completely recover your
443   file.  The new upload code also distributes the shares better than the
444   previous version in some cases and takes better advantage of
445   pre-existing shares (when a file has already been previously
446   uploaded). See the `architecture.rst`_ document [3] for details.
447
448 Bugfixes and Improvements
449 '''''''''''''''''''''''''
450
451 - Premature abort of upload if some shares were already present and
452   some servers fail. (`#608`_)
453 - python ./setup.py install -- can't create or remove files in install
454   directory. (`#803`_)
455 - Network failure => internal TypeError. (`#902`_)
456 - Install of Tahoe on CentOS 5.4. (`#933`_)
457 - CLI option --node-url now supports https url. (`#1028`_)
458 - HTML/CSS template files were not correctly installed under
459   Windows. (`#1033`_)
460 - MetadataSetter does not enforce restriction on setting "tahoe"
461   subkeys.  (`#1034`_)
462 - ImportError: No module named
463   setuptools_darcs.setuptools_darcs. (`#1054`_)
464 - Renamed Title in xhtml files. (`#1062`_)
465 - Increase Python version dependency to 2.4.4, to avoid a critical
466   CPython security bug. (`#1066`_)
467 - Typo correction for the munin plugin tahoe_storagespace. (`#968`_)
468 - Fix warnings found by pylint. (`#973`_)
469 - Changing format of some documentation files. (`#1027`_)
470 - the misc/ directory was tied up. (`#1068`_)
471 - The 'ctime' and 'mtime' metadata fields are no longer written except
472   by "tahoe backup". (`#924`_)
473 - Unicode filenames in Tahoe-LAFS directories are normalized so that
474   names that differ only in how accents are encoded are treated as the
475   same. (`#1076`_)
476 - Various small improvements to documentation. (`#937`_, `#911`_,
477   `#1024`_, `#1082`_)
478
479 Removals
480 ''''''''
481
482 - The 'tahoe debug consolidate' subcommand (for converting old
483   allmydata Windows client backups to a newer format) has been
484   removed.
485
486 Dependency Updates
487 ''''''''''''''''''
488
489 - the Python version dependency is raised to 2.4.4 in some cases
490   (2.4.3 for Redhat-based Linux distributions, 2.4.2 for UCS-2 builds)
491   (`#1066`_)
492 - pycrypto >= 2.0.1
493 - pyasn1 >= 0.0.8a
494 - mock (only required by unit tests)
495
496 .. _`#534`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/534
497 .. _`#608`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/608
498 .. _`#778`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/778
499 .. _`#803`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/803
500 .. _`#902`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/902
501 .. _`#911`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/911
502 .. _`#924`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/924
503 .. _`#937`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/937
504 .. _`#933`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/933
505 .. _`#968`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/968
506 .. _`#973`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/973
507 .. _`#1024`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1024
508 .. _`#1027`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1027
509 .. _`#1028`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1028
510 .. _`#1033`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1033
511 .. _`#1034`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1034
512 .. _`#1037`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1037
513 .. _`#1054`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1054
514 .. _`#1062`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1062
515 .. _`#1066`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1066
516 .. _`#1068`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1068
517 .. _`#1076`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1076
518 .. _`#1082`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1082
519 .. _architecture.rst: docs/architecture.rst
520 .. _FTP-and-SFTP.rst: docs/frontends/FTP-and-SFTP.rst
521
522 Release 1.6.1 (2010-02-27)
523 --------------------------
524
525 Bugfixes
526 ''''''''
527
528 - Correct handling of Small Immutable Directories
529
530   Immutable directories can now be deep-checked and listed in the web
531   UI in all cases. (In v1.6.0, some operations, such as deep-check, on
532   a directory graph that included very small immutable directories,
533   would result in an exception causing the whole operation to abort.)
534   (`#948`_)
535
536 Usability Improvements
537 ''''''''''''''''''''''
538
539 - Improved user interface messages and error reporting. (`#681`_,
540   `#837`_, `#939`_)
541 - The timeouts for operation handles have been greatly increased, so
542   that you can view the results of an operation up to 4 days after it
543   has completed. After viewing them for the first time, the results
544   are retained for a further day. (`#577`_)
545
546 Release 1.6.0 (2010-02-01)
547 --------------------------
548
549 New Features
550 ''''''''''''
551
552 - Immutable Directories
553
554   Tahoe-LAFS can now create and handle immutable
555   directories. (`#607`_, `#833`_, `#931`_) These are read just like
556   normal directories, but are "deep-immutable", meaning that all their
557   children (and everything reachable from those children) must be
558   immutable objects (i.e. immutable or literal files, and other
559   immutable directories).
560
561   These directories must be created in a single webapi call that
562   provides all of the children at once. (Since they cannot be changed
563   after creation, the usual create/add/add sequence cannot be used.)
564   They have URIs that start with "URI:DIR2-CHK:" or "URI:DIR2-LIT:",
565   and are described on the human-facing web interface (aka the "WUI")
566   with a "DIR-IMM" abbreviation (as opposed to "DIR" for the usual
567   read-write directories and "DIR-RO" for read-only directories).
568
569   Tahoe-LAFS releases before 1.6.0 cannot read the contents of an
570   immutable directory. 1.5.0 will tolerate their presence in a
571   directory listing (and display it as "unknown"). 1.4.1 and earlier
572   cannot tolerate them: a DIR-IMM child in any directory will prevent
573   the listing of that directory.
574
575   Immutable directories are repairable, just like normal immutable
576   files.
577
578   The webapi "POST t=mkdir-immutable" call is used to create immutable
579   directories. See `webapi.rst`_ for details.
580
581 - "tahoe backup" now creates immutable directories, backupdb has
582   dircache
583
584   The "tahoe backup" command has been enhanced to create immutable
585   directories (in previous releases, it created read-only mutable
586   directories) (`#828`_). This is significantly faster, since it does
587   not need to create an RSA keypair for each new directory. Also
588   "DIR-IMM" immutable directories are repairable, unlike "DIR-RO"
589   read-only mutable directories at present. (A future Tahoe-LAFS
590   release should also be able to repair DIR-RO.)
591
592   In addition, the backupdb (used by "tahoe backup" to remember what
593   it has already copied) has been enhanced to store information about
594   existing immutable directories. This allows it to re-use directories
595   that have moved but still contain identical contents, or that have
596   been deleted and later replaced. (The 1.5.0 "tahoe backup" command
597   could only re-use directories that were in the same place as they
598   were in the immediately previous backup.)  With this change, the
599   backup process no longer needs to read the previous snapshot out of
600   the Tahoe-LAFS grid, reducing the network load
601   considerably. (`#606`_)
602
603   A "null backup" (in which nothing has changed since the previous
604   backup) will require only two Tahoe-side operations: one to add an
605   Archives/$TIMESTAMP entry, and a second to update the Latest/
606   link. On the local disk side, it will readdir() all your local
607   directories and stat() all your local files.
608
609   If you've been using "tahoe backup" for a while, you will notice
610   that your first use of it after upgrading to 1.6.0 may take a long
611   time: it must create proper immutable versions of all the old
612   read-only mutable directories. This process won't take as long as
613   the initial backup (where all the file contents had to be uploaded
614   too): it will require time proportional to the number and size of
615   your directories. After this initial pass, all subsequent passes
616   should take a tiny fraction of the time.
617
618   As noted above, Tahoe-LAFS versions earlier than 1.5.0 cannot list a
619   directory containing an immutable subdirectory. Tahoe-LAFS versions
620   earlier than 1.6.0 cannot read the contents of an immutable
621   directory.
622
623   The "tahoe backup" command has been improved to skip over unreadable
624   objects (like device files, named pipes, and files with permissions
625   that prevent the command from reading their contents), instead of
626   throwing an exception and terminating the backup process. It also
627   skips over symlinks, because these cannot be represented faithfully
628   in the Tahoe-side filesystem. A warning message will be emitted each
629   time something is skipped. (`#729`_, `#850`_, `#641`_)
630
631 - "create-node" command added, "create-client" now implies
632   --no-storage
633
634   The basic idea behind Tahoe-LAFS's client+server and client-only
635   processes is that you are creating a general-purpose Tahoe-LAFS
636   "node" process, which has several components that can be
637   activated. Storage service is one of these optional components, as
638   is the Helper, FTP server, and SFTP server. Web gateway
639   functionality is nominally on this list, but it is always active; a
640   future release will make it optional. There are three special
641   purpose servers that can't currently be run as a component in a
642   node: introducer, key-generator, and stats-gatherer.
643
644   So now "tahoe create-node" will create a Tahoe-LAFS node process,
645   and after creation you can edit its tahoe.cfg to enable or disable
646   the desired services. It is a more general-purpose replacement for
647   "tahoe create-client".  The default configuration has storage
648   service enabled. For convenience, the "--no-storage" argument makes
649   a tahoe.cfg file that disables storage service. (`#760`_)
650
651   "tahoe create-client" has been changed to create a Tahoe-LAFS node
652   without a storage service. It is equivalent to "tahoe create-node
653   --no-storage". This helps to reduce the confusion surrounding the
654   use of a command with "client" in its name to create a storage
655   *server*. Use "tahoe create-client" to create a purely client-side
656   node. If you want to offer storage to the grid, use "tahoe
657   create-node" instead.
658
659   In the future, other services will be added to the node, and they
660   will be controlled through options in tahoe.cfg . The most important
661   of these services may get additional --enable-XYZ or --disable-XYZ
662   arguments to "tahoe create-node".
663
664 - Performance Improvements
665
666   Download of immutable files begins as soon as the downloader has
667   located the K necessary shares (`#928`_, `#287`_). In both the
668   previous and current releases, a downloader will first issue queries
669   to all storage servers on the grid to locate shares before it begins
670   downloading the shares. In previous releases of Tahoe-LAFS, download
671   would not begin until all storage servers on the grid had replied to
672   the query, at which point K shares would be chosen for download from
673   among the shares that were located. In this release, download begins
674   as soon as any K shares are located. This means that downloads start
675   sooner, which is particularly important if there is a server on the
676   grid that is extremely slow or even hung in such a way that it will
677   never respond. In previous releases such a server would have a
678   negative impact on all downloads from that grid. In this release,
679   such a server will have no impact on downloads, as long as K shares
680   can be found on other, quicker, servers.  This also means that
681   downloads now use the "best-alacrity" servers that they talk to, as
682   measured by how quickly the servers reply to the initial query. This
683   might cause downloads to go faster, especially on grids with
684   heterogeneous servers or geographical dispersion.
685
686 Minor Changes
687 '''''''''''''
688
689 - The webapi acquired a new "t=mkdir-with-children" command, to create
690   and populate a directory in a single call. This is significantly
691   faster than using separate "t=mkdir" and "t=set-children" operations
692   (it uses one gateway-to-grid roundtrip, instead of three or
693   four). (`#533`_)
694
695 - The t=set-children (note the hyphen) operation is now documented in
696   webapi.rst, and is the new preferred spelling of the
697   old t=set_children (with an underscore). The underscore version
698   remains for backwards compatibility. (`#381`_, `#927`_)
699
700 - The tracebacks produced by errors in CLI tools should now be in
701   plain text, instead of HTML (which is unreadable outside of a
702   browser). (`#646`_)
703
704 - The [storage]reserved_space configuration knob (which causes the
705   storage server to refuse shares when available disk space drops
706   below a threshold) should work on Windows now, not just
707   UNIX. (`#637`_)
708
709 - "tahoe cp" should now exit with status "1" if it cannot figure out a
710   suitable target filename, such as when you copy from a bare
711   filecap. (`#761`_)
712
713 - "tahoe get" no longer creates a zero-length file upon
714   error. (`#121`_)
715
716 - "tahoe ls" can now list single files. (`#457`_)
717
718 - "tahoe deep-check --repair" should tolerate repair failures now,
719   instead of halting traversal. (`#874`_, `#786`_)
720
721 - "tahoe create-alias" no longer corrupts the aliases file if it had
722   previously been edited to have no trailing newline. (`#741`_)
723
724 - Many small packaging improvements were made to facilitate the
725   "tahoe-lafs" package being included in Ubuntu. Several mac/win32
726   binary libraries were removed, some figleaf code-coverage files were
727   removed, a bundled copy of darcsver-1.2.1 was removed, and
728   additional licensing text was added.
729
730 - Several DeprecationWarnings for python2.6 were silenced. (`#859`_)
731
732 - The checker --add-lease option would sometimes fail for shares
733   stored on old (Tahoe v1.2.0) servers. (`#875`_)
734
735 - The documentation for installing on Windows (docs/quickstart.rst)
736   has been improved. (`#773`_)
737
738 For other changes not mentioned here, see
739 <https://tahoe-lafs.org/trac/tahoe-lafs/query?milestone=1.6.0&keywords=!~news-done>.
740 To include the tickets mentioned above, go to
741 <https://tahoe-lafs.org/trac/tahoe-lafs/query?milestone=1.6.0>.
742
743 .. _`#121`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/121
744 .. _`#287`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/287
745 .. _`#381`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/381
746 .. _`#457`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/457
747 .. _`#533`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/533
748 .. _`#577`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/577
749 .. _`#606`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/606
750 .. _`#607`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/607
751 .. _`#637`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/637
752 .. _`#641`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/641
753 .. _`#646`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/646
754 .. _`#681`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/681
755 .. _`#729`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/729
756 .. _`#741`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/741
757 .. _`#760`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/760
758 .. _`#761`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/761
759 .. _`#768`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/768
760 .. _`#773`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/773
761 .. _`#786`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/786
762 .. _`#828`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/828
763 .. _`#833`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/833
764 .. _`#859`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/859
765 .. _`#874`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/874
766 .. _`#875`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/875
767 .. _`#931`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/931
768 .. _`#837`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/837
769 .. _`#850`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/850
770 .. _`#927`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/927
771 .. _`#928`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/928
772 .. _`#939`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/939
773 .. _`#948`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/948
774 .. _webapi.rst: docs/frontends/webapi.rst
775
776 Release 1.5.0 (2009-08-01)
777 --------------------------
778
779 Improvements
780 ''''''''''''
781
782 - Uploads of immutable files now use pipelined writes, improving
783   upload speed slightly (10%) over high-latency connections. (`#392`_)
784
785 - Processing large directories has been sped up, by removing a O(N^2)
786   algorithm from the dirnode decoding path and retaining unmodified
787   encrypted entries.  (`#750`_, `#752`_)
788
789 - The human-facing web interface (aka the "WUI") received a
790   significant CSS makeover by Kevin Reid, making it much prettier and
791   easier to read. The WUI "check" and "deep-check" forms now include a
792   "Renew Lease" checkbox, mirroring the CLI --add-lease option, so
793   leases can be added or renewed from the web interface.
794
795 - The CLI "tahoe mv" command now refuses to overwrite
796   directories. (`#705`_)
797
798 - The CLI "tahoe webopen" command, when run without arguments, will
799   now bring up the "Welcome Page" (node status and mkdir/upload
800   forms).
801
802 - The 3.5MB limit on mutable files was removed, so it should be
803   possible to upload arbitrarily-sized mutable files. Note, however,
804   that the data format and algorithm remains the same, so using
805   mutable files still requires bandwidth, computation, and RAM in
806   proportion to the size of the mutable file.  (`#694`_)
807
808 - This version of Tahoe-LAFS will tolerate directory entries that
809   contain filecap formats which it does not recognize: files and
810   directories from the future.  This should improve the user
811   experience (for 1.5.0 users) when we add new cap formats in the
812   future. Previous versions would fail badly, preventing the user from
813   seeing or editing anything else in those directories. These
814   unrecognized objects can be renamed and deleted, but obviously not
815   read or written. Also they cannot generally be copied. (`#683`_)
816
817 Bugfixes
818 ''''''''
819
820 - deep-check-and-repair now tolerates read-only directories, such as
821   the ones produced by the "tahoe backup" CLI command. Read-only
822   directories and mutable files are checked, but not
823   repaired. Previous versions threw an exception when attempting the
824   repair and failed to process the remaining contents. We cannot yet
825   repair these read-only objects, but at least this version allows the
826   rest of the check+repair to proceed. (`#625`_)
827
828 - A bug in 1.4.1 which caused a server to be listed multiple times
829   (and frequently broke all connections to that server) was
830   fixed. (`#653`_)
831
832 - The plaintext-hashing code was removed from the Helper interface,
833   removing the Helper's ability to mount a
834   partial-information-guessing attack. (`#722`_)
835
836 Platform/packaging changes
837 ''''''''''''''''''''''''''
838
839 - Tahoe-LAFS now runs on NetBSD, OpenBSD, ArchLinux, and NixOS, and on
840   an embedded system based on an ARM CPU running at 266 MHz.
841
842 - Unit test timeouts have been raised to allow the tests to complete
843   on extremely slow platforms like embedded ARM-based NAS boxes, which
844   may take several hours to run the test suite. An ARM-specific
845   data-corrupting bug in an older version of Crypto++ (5.5.2) was
846   identified: ARM-users are encouraged to use recent
847   Crypto++/pycryptopp which avoids this problem.
848
849 - Tahoe-LAFS now requires a SQLite library, either the sqlite3 that
850   comes built-in with python2.5/2.6, or the add-on pysqlite2 if you're
851   using python2.4. In the previous release, this was only needed for
852   the "tahoe backup" command: now it is mandatory.
853
854 - Several minor documentation updates were made.
855
856 - To help get Tahoe-LAFS into Linux distributions like Fedora and
857   Debian, packaging improvements are being made in both Tahoe-LAFS and
858   related libraries like pycryptopp and zfec.
859
860 - The Crypto++ library included in the pycryptopp package has been
861   upgraded to version 5.6.0 of Crypto++, which includes a more
862   efficient implementation of SHA-256 in assembly for x86 or amd64
863   architectures.
864
865 dependency updates
866 ''''''''''''''''''
867
868 - foolscap-0.4.1
869 - no python-2.4.0 or 2.4.1 (2.4.2 is good) (they contained a bug in base64.b32decode)
870 - avoid python-2.6 on windows with mingw: compiler issues
871 - python2.4 requires pysqlite2 (2.5,2.6 does not)
872 - no python-3.x
873 - pycryptopp-0.5.15
874
875 .. _#392: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/392
876 .. _#625: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/625
877 .. _#653: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/653
878 .. _#683: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/683
879 .. _#694: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/694
880 .. _#705: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/705
881 .. _#722: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/722
882 .. _#750: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/750
883 .. _#752: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/752
884
885 Release 1.4.1 (2009-04-13)
886 --------------------------
887
888 Garbage Collection
889 ''''''''''''''''''
890
891 - The big feature for this release is the implementation of garbage
892   collection, allowing Tahoe storage servers to delete shares for old
893   deleted files. When enabled, this uses a "mark and sweep" process:
894   clients are responsible for updating the leases on their shares
895   (generally by running "tahoe deep-check --add-lease"), and servers
896   are allowed to delete any share which does not have an up-to-date
897   lease. The process is described in detail in
898   `garbage-collection.rst`_.
899
900   The server must be configured to enable garbage-collection, by
901   adding directives to the [storage] section that define an age limit
902   for shares. The default configuration will not delete any shares.
903
904   Both servers and clients should be upgraded to this release to make
905   the garbage-collection as pleasant as possible. 1.2.0 servers have
906   code to perform the update-lease operation but it suffers from a
907   fatal bug, while 1.3.0 servers have update-lease but will return an
908   exception for unknown storage indices, causing clients to emit an
909   Incident for each exception, slowing the add-lease process down to a
910   crawl. 1.1.0 servers did not have the add-lease operation at all.
911
912 Security/Usability Problems Fixed
913 '''''''''''''''''''''''''''''''''
914
915 - A super-linear algorithm in the Merkle Tree code was fixed, which
916   previously caused e.g. download of a 10GB file to take several hours
917   before the first byte of plaintext could be produced. The new
918   "alacrity" is about 2 minutes. A future release should reduce this
919   to a few seconds by fixing ticket `#442`_.
920
921 - The previous version permitted a small timing attack (due to our use
922   of strcmp) against the write-enabler and lease-renewal/cancel
923   secrets. An attacker who could measure response-time variations of
924   approximatly 3ns against a very noisy background time of about 15ms
925   might be able to guess these secrets. We do not believe this attack
926   was actually feasible. This release closes the attack by first
927   hashing the two strings to be compared with a random secret.
928
929 webapi changes
930 ''''''''''''''
931
932 - In most cases, HTML tracebacks will only be sent if an "Accept:
933   text/html" header was provided with the HTTP request. This will
934   generally cause browsers to get an HTMLized traceback but send
935   regular text/plain tracebacks to non-browsers (like the CLI
936   clients). More errors have been mapped to useful HTTP error codes.
937
938 - The streaming webapi operations (deep-check and manifest) now have a
939   way to indicate errors (an output line that starts with "ERROR"
940   instead of being legal JSON). See `webapi.rst`_ for
941   details.
942
943 - The storage server now has its own status page (at /storage), linked
944   from the Welcome page. This page shows progress and results of the
945   two new share-crawlers: one which merely counts shares (to give an
946   estimate of how many files/directories are being stored in the
947   grid), the other examines leases and reports how much space would be
948   freed if GC were enabled. The page also shows how much disk space is
949   present, used, reserved, and available for the Tahoe server, and
950   whether the server is currently running in "read-write" mode or
951   "read-only" mode.
952
953 - When a directory node cannot be read (perhaps because of insufficent
954   shares), a minimal webapi page is created so that the "more-info"
955   links (including a Check/Repair operation) will still be accessible.
956
957 - A new "reliability" page was added, with the beginnings of work on a
958   statistical loss model. You can tell this page how many servers you
959   are using and their independent failure probabilities, and it will
960   tell you the likelihood that an arbitrary file will survive each
961   repair period. The "numpy" package must be installed to access this
962   page. A partial paper, written by Shawn Willden, has been added to
963   docs/proposed/lossmodel.lyx .
964
965 CLI changes
966 '''''''''''
967
968 - "tahoe check" and "tahoe deep-check" now accept an "--add-lease"
969   argument, to update a lease on all shares. This is the "mark" side
970   of garbage collection.
971
972 - In many cases, CLI error messages have been improved: the ugly
973   HTMLized traceback has been replaced by a normal python traceback.
974
975 - "tahoe deep-check" and "tahoe manifest" now have better error
976   reporting.  "tahoe cp" is now non-verbose by default.
977
978 - "tahoe backup" now accepts several "--exclude" arguments, to ignore
979   certain files (like editor temporary files and version-control
980   metadata) during backup.
981
982 - On windows, the CLI now accepts local paths like "c:\dir\file.txt",
983   which previously was interpreted as a Tahoe path using a "c:" alias.
984
985 - The "tahoe restart" command now uses "--force" by default (meaning
986   it will start a node even if it didn't look like there was one
987   already running).
988
989 - The "tahoe debug consolidate" command was added. This takes a series
990   of independent timestamped snapshot directories (such as those
991   created by the allmydata.com windows backup program, or a series of
992   "tahoe cp -r" commands) and creates new snapshots that used shared
993   read-only directories whenever possible (like the output of "tahoe
994   backup"). In the most common case (when the snapshots are fairly
995   similar), the result will use significantly fewer directories than
996   the original, allowing "deep-check" and similar tools to run much
997   faster. In some cases, the speedup can be an order of magnitude or
998   more.  This tool is still somewhat experimental, and only needs to
999   be run on large backups produced by something other than "tahoe
1000   backup", so it was placed under the "debug" category.
1001
1002 - "tahoe cp -r --caps-only tahoe:dir localdir" is a diagnostic tool
1003   which, instead of copying the full contents of files into the local
1004   directory, merely copies their filecaps. This can be used to verify
1005   the results of a "consolidation" operation.
1006
1007 other fixes
1008 '''''''''''
1009
1010 - The codebase no longer rauses RuntimeError as a kind of
1011   assert(). Specific exception classes were created for each previous
1012   instance of RuntimeError.
1013
1014  -Many unit tests were changed to use a non-network test harness,
1015   speeding them up considerably.
1016
1017 - Deep-traversal operations (manifest and deep-check) now walk
1018   individual directories in alphabetical order. Occasional turn breaks
1019   are inserted to prevent a stack overflow when traversing directories
1020   with hundreds of entries.
1021
1022 - The experimental SFTP server had its path-handling logic changed
1023   slightly, to accomodate more SFTP clients, although there are still
1024   issues (`#645`_).
1025
1026 .. _#442: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/442
1027 .. _#645: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/645
1028 .. _garbage-collection.rst: docs/garbage-collection.rst
1029
1030 Release 1.3.0 (2009-02-13)
1031 --------------------------
1032
1033 Checker/Verifier/Repairer
1034 '''''''''''''''''''''''''
1035
1036 - The primary focus of this release has been writing a checker /
1037   verifier / repairer for files and directories.  "Checking" is the
1038   act of asking storage servers whether they have a share for the
1039   given file or directory: if there are not enough shares available,
1040   the file or directory will be unrecoverable. "Verifying" is the act
1041   of downloading and cryptographically asserting that the server's
1042   share is undamaged: it requires more work (bandwidth and CPU) than
1043   checking, but can catch problems that simple checking
1044   cannot. "Repair" is the act of replacing missing or damaged shares
1045   with new ones.
1046
1047 - This release includes a full checker, a partial verifier, and a
1048   partial repairer. The repairer is able to handle missing shares: new
1049   shares are generated and uploaded to make up for the missing
1050   ones. This is currently the best application of the repairer: to
1051   replace shares that were lost because of server departure or
1052   permanent drive failure.
1053
1054 - The repairer in this release is somewhat able to handle corrupted
1055   shares. The limitations are:
1056
1057  - Immutable verifier is incomplete: not all shares are used, and not
1058    all fields of those shares are verified. Therefore the immutable
1059    verifier has only a moderate chance of detecting corrupted shares.
1060  - The mutable verifier is mostly complete: all shares are examined,
1061    and most fields of the shares are validated.
1062  - The storage server protocol offers no way for the repairer to
1063    replace or delete immutable shares. If corruption is detected, the
1064    repairer will upload replacement shares to other servers, but the
1065    corrupted shares will be left in place.
1066  - read-only directories and read-only mutable files must be repaired
1067    by someone who holds the write-cap: the read-cap is
1068    insufficient. Moreover, the deep-check-and-repair operation will
1069    halt with an error if it attempts to repair one of these read-only
1070    objects.
1071  - Some forms of corruption can cause both download and repair
1072    operations to fail. A future release will fix this, since download
1073    should be tolerant of any corruption as long as there are at least
1074    'k' valid shares, and repair should be able to fix any file that is
1075    downloadable.
1076
1077 - If the downloader, verifier, or repairer detects share corruption,
1078   the servers which provided the bad shares will be notified (via a
1079   file placed in the BASEDIR/storage/corruption-advisories directory)
1080   so their operators can manually delete the corrupted shares and
1081   investigate the problem. In addition, the "incident gatherer"
1082   mechanism will automatically report share corruption to an incident
1083   gatherer service, if one is configured. Note that corrupted shares
1084   indicate hardware failures, serious software bugs, or malice on the
1085   part of the storage server operator, so a corrupted share should be
1086   considered highly unusual.
1087
1088 - By periodically checking/repairing all files and directories,
1089   objects in the Tahoe filesystem remain resistant to recoverability
1090   failures due to missing and/or broken servers.
1091
1092 - This release includes a wapi mechanism to initiate checks on
1093   individual files and directories (with or without verification, and
1094   with or without automatic repair). A related mechanism is used to
1095   initiate a "deep-check" on a directory: recursively traversing the
1096   directory and its children, checking (and/or verifying/repairing)
1097   everything underneath. Both mechanisms can be run with an
1098   "output=JSON" argument, to obtain machine-readable check/repair
1099   status results. These results include a copy of the filesystem
1100   statistics from the "deep-stats" operation (including total number
1101   of files, size histogram, etc). If repair is possible, a "Repair"
1102   button will appear on the results page.
1103
1104 - The client web interface now features some extra buttons to initiate
1105   check and deep-check operations. When these operations finish, they
1106   display a results page that summarizes any problems that were
1107   encountered. All long-running deep-traversal operations, including
1108   deep-check, use a start-and-poll mechanism, to avoid depending upon
1109   a single long-lived HTTP connection. `webapi.rst`_ has
1110   details.
1111
1112 Efficient Backup
1113 ''''''''''''''''
1114
1115 - The "tahoe backup" command is new in this release, which creates
1116   efficient versioned backups of a local directory. Given a local
1117   pathname and a target Tahoe directory, this will create a read-only
1118   snapshot of the local directory in $target/Archives/$timestamp. It
1119   will also create $target/Latest, which is a reference to the latest
1120   such snapshot. Each time you run "tahoe backup" with the same source
1121   and target, a new $timestamp snapshot will be added. These snapshots
1122   will share directories that have not changed since the last backup,
1123   to speed up the process and minimize storage requirements. In
1124   addition, a small database is used to keep track of which local
1125   files have been uploaded already, to avoid uploading them a second
1126   time. This drastically reduces the work needed to do a "null backup"
1127   (when nothing has changed locally), making "tahoe backup' suitable
1128   to run from a daily cronjob.
1129
1130   Note that the "tahoe backup" CLI command must be used in conjunction
1131   with a 1.3.0-or-newer Tahoe client node; there was a bug in the
1132   1.2.0 webapi implementation that would prevent the last step (create
1133   $target/Latest) from working.
1134
1135 Large Files
1136 '''''''''''
1137
1138 - The 12GiB (approximate) immutable-file-size limitation is
1139   lifted. This release knows how to handle so-called "v2 immutable
1140   shares", which permit immutable files of up to about 18 EiB (about
1141   3*10^14). These v2 shares are created if the file to be uploaded is
1142   too large to fit into v1 shares. v1 shares are created if the file
1143   is small enough to fit into them, so that files created with
1144   tahoe-1.3.0 can still be read by earlier versions if they are not
1145   too large. Note that storage servers also had to be changed to
1146   support larger files, and this release is the first release in which
1147   they are able to do that. Clients will detect which servers are
1148   capable of supporting large files on upload and will not attempt to
1149   upload shares of a large file to a server which doesn't support it.
1150
1151 FTP/SFTP Server
1152 '''''''''''''''
1153
1154 - Tahoe now includes experimental FTP and SFTP servers. When
1155   configured with a suitable method to translate username+password
1156   into a root directory cap, it provides simple access to the virtual
1157   filesystem. Remember that FTP is completely unencrypted: passwords,
1158   filenames, and file contents are all sent over the wire in
1159   cleartext, so FTP should only be used on a local (127.0.0.1)
1160   connection. This feature is still in development: there are no unit
1161   tests yet, and behavior with respect to Unicode filenames is
1162   uncertain. Please see `FTP-and-SFTP.rst`_ for
1163   configuration details. (`#512`_, `#531`_)
1164
1165 CLI Changes
1166 '''''''''''
1167
1168 - This release adds the 'tahoe create-alias' command, which is a
1169   combination of 'tahoe mkdir' and 'tahoe add-alias'. This also allows
1170   you to start using a new tahoe directory without exposing its URI in
1171   the argv list, which is publicly visible (through the process table)
1172   on most unix systems.  Thanks to Kevin Reid for bringing this issue
1173   to our attention.
1174
1175 - The single-argument form of "tahoe put" was changed to create an
1176   unlinked file. I.e. "tahoe put bar.txt" will take the contents of a
1177   local "bar.txt" file, upload them to the grid, and print the
1178   resulting read-cap; the file will not be attached to any
1179   directories. This seemed a bit more useful than the previous
1180   behavior (copy stdin, upload to the grid, attach the resulting file
1181   into your default tahoe: alias in a child named 'bar.txt').
1182
1183 - "tahoe put" was also fixed to handle mutable files correctly: "tahoe
1184   put bar.txt URI:SSK:..." will read the contents of the local bar.txt
1185   and use them to replace the contents of the given mutable file.
1186
1187 - The "tahoe webopen" command was modified to accept aliases. This
1188   means "tahoe webopen tahoe:" will cause your web browser to open to
1189   a "wui" page that gives access to the directory associated with the
1190   default "tahoe:" alias. It should also accept leading slashes, like
1191   "tahoe webopen tahoe:/stuff".
1192
1193 - Many esoteric debugging commands were moved down into a "debug"
1194   subcommand:
1195
1196  - tahoe debug dump-cap
1197  - tahoe debug dump-share
1198  - tahoe debug find-shares
1199  - tahoe debug catalog-shares
1200  - tahoe debug corrupt-share
1201
1202    The last command ("tahoe debug corrupt-share") flips a random bit
1203    of the given local sharefile. This is used to test the file
1204    verifying/repairing code, and obviously should not be used on user
1205    data.
1206
1207 The cli might not correctly handle arguments which contain non-ascii
1208 characters in Tahoe v1.3 (although depending on your platform it
1209 might, especially if your platform can be configured to pass such
1210 characters on the command-line in utf-8 encoding).  See
1211 https://tahoe-lafs.org/trac/tahoe-lafs/ticket/565 for details.
1212
1213 Web changes
1214 '''''''''''
1215
1216 - The "default webapi port", used when creating a new client node (and
1217   in the getting-started documentation), was changed from 8123 to
1218   3456, to reduce confusion when Tahoe accessed through a Firefox
1219   browser on which the "Torbutton" extension has been installed. Port
1220   8123 is occasionally used as a Tor control port, so Torbutton adds
1221   8123 to Firefox's list of "banned ports" to avoid CSRF attacks
1222   against Tor. Once 8123 is banned, it is difficult to diagnose why
1223   you can no longer reach a Tahoe node, so the Tahoe default was
1224   changed. Note that 3456 is reserved by IANA for the "vat" protocol,
1225   but there are argueably more Torbutton+Tahoe users than vat users
1226   these days. Note that this will only affect newly-created client
1227   nodes. Pre-existing client nodes, created by earlier versions of
1228   tahoe, may still be listening on 8123.
1229
1230 - All deep-traversal operations (start-manifest, start-deep-size,
1231   start-deep-stats, start-deep-check) now use a start-and-poll
1232   approach, instead of using a single (fragile) long-running
1233   synchronous HTTP connection. All these "start-" operations use POST
1234   instead of GET. The old "GET manifest", "GET deep-size", and "POST
1235   deep-check" operations have been removed.
1236
1237 - The new "POST start-manifest" operation, when it finally completes,
1238   results in a table of (path,cap), instead of the list of verifycaps
1239   produced by the old "GET manifest". The table is available in
1240   several formats: use output=html, output=text, or output=json to
1241   choose one. The JSON output also includes stats, and a list of
1242   verifycaps and storage-index strings. The "return_to=" and
1243   "when_done=" arguments have been removed from the t=check and
1244   deep-check operations.
1245
1246 - The top-level status page (/status) now has a machine-readable form,
1247   via "/status/?t=json". This includes information about the
1248   currently-active uploads and downloads, which may be useful for
1249   frontends that wish to display progress information. There is no
1250   easy way to correlate the activities displayed here with recent wapi
1251   requests, however.
1252
1253 - Any files in BASEDIR/public_html/ (configurable) will be served in
1254   response to requests in the /static/ portion of the URL space. This
1255   will simplify the deployment of javascript-based frontends that can
1256   still access wapi calls by conforming to the (regrettable)
1257   "same-origin policy".
1258
1259 - The welcome page now has a "Report Incident" button, which is tied
1260   into the "Incident Gatherer" machinery. If the node is attached to
1261   an incident gatherer (via log_gatherer.furl), then pushing this
1262   button will cause an Incident to be signalled: this means recent log
1263   events are aggregated and sent in a bundle to the gatherer. The user
1264   can push this button after something strange takes place (and they
1265   can provide a short message to go along with it), and the relevant
1266   data will be delivered to a centralized incident-gatherer for later
1267   processing by operations staff.
1268
1269 - The "HEAD" method should now work correctly, in addition to the
1270   usual "GET", "PUT", and "POST" methods. "HEAD" is supposed to return
1271   exactly the same headers as "GET" would, but without any of the
1272   actual response body data. For mutable files, this now does a brief
1273   mapupdate (to figure out the size of the file that would be
1274   returned), without actually retrieving the file's contents.
1275
1276 - The "GET" operation on files can now support the HTTP "Range:"
1277   header, allowing requests for partial content. This allows certain
1278   media players to correctly stream audio and movies out of a Tahoe
1279   grid. The current implementation uses a disk-based cache in
1280   BASEDIR/private/cache/download , which holds the plaintext of the
1281   files being downloaded. Future implementations might not use this
1282   cache. GET for immutable files now returns an ETag header.
1283
1284 - Each file and directory now has a "Show More Info" web page, which
1285   contains much of the information that was crammed into the directory
1286   page before. This includes readonly URIs, storage index strings,
1287   object type, buttons to control checking/verifying/repairing, and
1288   deep-check/deep-stats buttons (for directories). For mutable files,
1289   the "replace contents" upload form has been moved here too. As a
1290   result, the directory page is now much simpler and cleaner, and
1291   several potentially-misleading links (like t=uri) are now gone.
1292
1293 - Slashes are discouraged in Tahoe file/directory names, since they
1294   cause problems when accessing the filesystem through the
1295   wapi. However, there are a couple of accidental ways to generate
1296   such names. This release tries to make it easier to correct such
1297   mistakes by escaping slashes in several places, allowing slashes in
1298   the t=info and t=delete commands, and in the source (but not the
1299   target) of a t=rename command.
1300
1301 Packaging
1302 '''''''''
1303
1304 - Tahoe's dependencies have been extended to require the
1305   "[secure_connections]" feature from Foolscap, which will cause
1306   pyOpenSSL to be required and/or installed. If OpenSSL and its
1307   development headers are already installed on your system, this can
1308   occur automatically. Tahoe now uses pollreactor (instead of the
1309   default selectreactor) to work around a bug between pyOpenSSL and
1310   the most recent release of Twisted (8.1.0). This bug only affects
1311   unit tests (hang during shutdown), and should not impact regular
1312   use.
1313
1314 - The Tahoe source code tarballs now come in two different forms:
1315   regular and "sumo". The regular tarball contains just Tahoe, nothing
1316   else. When building from the regular tarball, the build process will
1317   download any unmet dependencies from the internet (starting with the
1318   index at PyPI) so it can build and install them. The "sumo" tarball
1319   contains copies of all the libraries that Tahoe requires (foolscap,
1320   twisted, zfec, etc), so using the "sumo" tarball should not require
1321   any internet access during the build process. This can be useful if
1322   you want to build Tahoe while on an airplane, a desert island, or
1323   other bandwidth-limited environments.
1324
1325 - Similarly, tahoe-lafs.org now hosts a "tahoe-deps" tarball which
1326   contains the latest versions of all these dependencies. This
1327   tarball, located at
1328   https://tahoe-lafs.org/source/tahoe/deps/tahoe-deps.tar.gz, can be
1329   unpacked in the tahoe source tree (or in its parent directory), and
1330   the build process should satisfy its downloading needs from it
1331   instead of reaching out to PyPI.  This can be useful if you want to
1332   build Tahoe from a darcs checkout while on that airplane or desert
1333   island.
1334
1335 - Because of the previous two changes ("sumo" tarballs and the
1336   "tahoe-deps" bundle), most of the files have been removed from
1337   misc/dependencies/ . This brings the regular Tahoe tarball down to
1338   2MB (compressed), and the darcs checkout (without history) to about
1339   7.6MB. A full darcs checkout will still be fairly large (because of
1340   the historical patches which included the dependent libraries), but
1341   a 'lazy' one should now be small.
1342
1343 - The default "make" target is now an alias for "setup.py build",
1344   which itself is an alias for "setup.py develop --prefix support",
1345   with some extra work before and after (see setup.cfg). Most of the
1346   complicated platform-dependent code in the Makefile was rewritten in
1347   Python and moved into setup.py, simplifying things considerably.
1348
1349 - Likewise, the "make test" target now delegates most of its work to
1350   "setup.py test", which takes care of getting PYTHONPATH configured
1351   to access the tahoe code (and dependencies) that gets put in
1352   support/lib/ by the build_tahoe step. This should allow unit tests
1353   to be run even when trial (which is part of Twisted) wasn't already
1354   installed (in this case, trial gets installed to support/bin because
1355   Twisted is a dependency of Tahoe).
1356
1357 - Tahoe is now compatible with the recently-released Python 2.6 ,
1358   although it is recommended to use Tahoe on Python 2.5, on which it
1359   has received more thorough testing and deployment.
1360
1361 - Tahoe is now compatible with simplejson-2.0.x . The previous release
1362   assumed that simplejson.loads always returned unicode strings, which
1363   is no longer the case in 2.0.x .
1364
1365 Grid Management Tools
1366 '''''''''''''''''''''
1367
1368 - Several tools have been added or updated in the misc/ directory,
1369   mostly munin plugins that can be used to monitor a storage grid.
1370
1371  - The misc/spacetime/ directory contains a "disk watcher" daemon
1372    (startable with 'tahoe start'), which can be configured with a set
1373    of HTTP URLs (pointing at the wapi '/statistics' page of a bunch of
1374    storage servers), and will periodically fetch
1375    disk-used/disk-available information from all the servers. It keeps
1376    this information in an Axiom database (a sqlite-based library
1377    available from divmod.org). The daemon computes time-averaged rates
1378    of disk usage, as well as a prediction of how much time is left
1379    before the grid is completely full.
1380
1381  - The misc/munin/ directory contains a new set of munin plugins
1382    (tahoe_diskleft, tahoe_diskusage, tahoe_doomsday) which talk to the
1383    disk-watcher and provide graphs of its calculations.
1384
1385  - To support the disk-watcher, the Tahoe statistics component
1386    (visible through the wapi at the /statistics/ URL) now includes
1387    disk-used and disk-available information. Both are derived through
1388    an equivalent of the unix 'df' command (i.e. they ask the kernel
1389    for the number of free blocks on the partition that encloses the
1390    BASEDIR/storage directory). In the future, the disk-available
1391    number will be further influenced by the local storage policy: if
1392    that policy says that the server should refuse new shares when less
1393    than 5GB is left on the partition, then "disk-available" will
1394    report zero even though the kernel sees 5GB remaining.
1395
1396  - The 'tahoe_overhead' munin plugin interacts with an
1397    allmydata.com-specific server which reports the total of the
1398    'deep-size' reports for all active user accounts, compares this
1399    with the disk-watcher data, to report on overhead percentages. This
1400    provides information on how much space could be recovered once
1401    Tahoe implements some form of garbage collection.
1402
1403 Configuration Changes: single INI-format tahoe.cfg file
1404 '''''''''''''''''''''''''''''''''''''''''''''''''''''''
1405
1406 - The Tahoe node is now configured with a single INI-format file,
1407   named "tahoe.cfg", in the node's base directory. Most of the
1408   previous multiple-separate-files are still read for backwards
1409   compatibility (the embedded SSH debug server and the
1410   advertised_ip_addresses files are the exceptions), but new
1411   directives will only be added to tahoe.cfg . The "tahoe
1412   create-client" command will create a tahoe.cfg for you, with sample
1413   values commented out. (ticket `#518`_)
1414
1415 - tahoe.cfg now has controls for the foolscap "keepalive" and
1416   "disconnect" timeouts (`#521`_).
1417
1418 - tahoe.cfg now has controls for the encoding parameters:
1419   "shares.needed" and "shares.total" in the "[client]" section. The
1420   default parameters are still 3-of-10.
1421
1422 - The inefficient storage 'sizelimit' control (which established an
1423   upper bound on the amount of space that a storage server is allowed
1424   to consume) has been replaced by a lightweight 'reserved_space'
1425   control (which establishes a lower bound on the amount of remaining
1426   space). The storage server will reject all writes that would cause
1427   the remaining disk space (as measured by a '/bin/df' equivalent) to
1428   drop below this value. The "[storage]reserved_space=" tahoe.cfg
1429   parameter controls this setting. (note that this only affects
1430   immutable shares: it is an outstanding bug that reserved_space does
1431   not prevent the allocation of new mutable shares, nor does it
1432   prevent the growth of existing mutable shares).
1433
1434 Other Changes
1435 '''''''''''''
1436
1437 - Clients now declare which versions of the protocols they
1438   support. This is part of a new backwards-compatibility system:
1439   https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Versioning .
1440
1441 - The version strings for human inspection (as displayed on the
1442   Welcome web page, and included in logs) now includes a platform
1443   identifer (frequently including a linux distribution name, processor
1444   architecture, etc).
1445
1446 - Several bugs have been fixed, including one that would cause an
1447   exception (in the logs) if a wapi download operation was cancelled
1448   (by closing the TCP connection, or pushing the "stop" button in a
1449   web browser).
1450
1451 - Tahoe now uses Foolscap "Incidents", writing an "incident report"
1452   file to logs/incidents/ each time something weird occurs. These
1453   reports are available to an "incident gatherer" through the flogtool
1454   command. For more details, please see the Foolscap logging
1455   documentation. An incident-classifying plugin function is provided
1456   in misc/incident-gatherer/classify_tahoe.py .
1457
1458 - If clients detect corruption in shares, they now automatically
1459   report it to the server holding that share, if it is new enough to
1460   accept the report.  These reports are written to files in
1461   BASEDIR/storage/corruption-advisories .
1462
1463 - The 'nickname' setting is now defined to be a UTF-8 -encoded string,
1464   allowing non-ascii nicknames.
1465
1466 - The 'tahoe start' command will now accept a --syslog argument and
1467   pass it through to twistd, making it easier to launch non-Tahoe
1468   nodes (like the cpu-watcher) and have them log to syslogd instead of
1469   a local file. This is useful when running a Tahoe node out of a USB
1470   flash drive.
1471
1472 - The Mac GUI in src/allmydata/gui/ has been improved.
1473
1474 .. _#512: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/512
1475 .. _#518: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/518
1476 .. _#521: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/521
1477 .. _#531: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/531
1478
1479 Release 1.2.0 (2008-07-21)
1480 --------------------------
1481
1482 Security
1483 ''''''''
1484
1485 - This release makes the immutable-file "ciphertext hash tree"
1486   mandatory.  Previous releases allowed the uploader to decide whether
1487   their file would have an integrity check on the ciphertext or not. A
1488   malicious uploader could use this to create a readcap that would
1489   download as one file or a different one, depending upon which shares
1490   the client fetched first, with no errors raised. There are other
1491   integrity checks on the shares themselves, preventing a storage
1492   server or other party from violating the integrity properties of the
1493   read-cap: this failure was only exploitable by the uploader who
1494   gives you a carefully constructed read-cap. If you download the file
1495   with Tahoe 1.2.0 or later, you will not be vulnerable to this
1496   problem. `#491`_
1497
1498   This change does not introduce a compatibility issue, because all
1499   existing versions of Tahoe will emit the ciphertext hash tree in
1500   their shares.
1501
1502 Dependencies
1503 ''''''''''''
1504
1505 - Tahoe now requires Foolscap-0.2.9 . It also requires pycryptopp 0.5
1506   or newer, since earlier versions had a bug that interacted with
1507   specific compiler versions that could sometimes result in incorrect
1508   encryption behavior. Both packages are included in the Tahoe source
1509   tarball in misc/dependencies/ , and should be built automatically
1510   when necessary.
1511
1512 Web API
1513 '''''''
1514
1515 - Web API directory pages should now contain properly-slash-terminated
1516   links to other directories. They have also stopped using absolute
1517   links in forms and pages (which interfered with the use of a
1518   front-end load-balancing proxy).
1519
1520 - The behavior of the "Check This File" button changed, in conjunction
1521   with larger internal changes to file checking/verification. The
1522   button triggers an immediate check as before, but the outcome is
1523   shown on its own page, and does not get stored anywhere. As a
1524   result, the web directory page no longer shows historical checker
1525   results.
1526
1527 - A new "Deep-Check" button has been added, which allows a user to
1528   initiate a recursive check of the given directory and all files and
1529   directories reachable from it. This can cause quite a bit of work,
1530   and has no intermediate progress information or feedback about the
1531   process. In addition, the results of the deep-check are extremely
1532   limited. A later release will improve this behavior.
1533
1534 - The web server's behavior with respect to non-ASCII (unicode)
1535   filenames in the "GET save=true" operation has been improved. To
1536   achieve maximum compatibility with variously buggy web browsers, the
1537   server does not try to figure out the character set of the inbound
1538   filename. It just echoes the same bytes back to the browser in the
1539   Content-Disposition header. This seems to make both IE7 and Firefox
1540   work correctly.
1541
1542 Checker/Verifier/Repairer
1543 '''''''''''''''''''''''''
1544
1545 - Tahoe is slowly acquiring convenient tools to check up on file
1546   health, examine existing shares for errors, and repair files that
1547   are not fully healthy. This release adds a mutable
1548   checker/verifier/repairer, although testing is very limited, and
1549   there are no web interfaces to trigger repair yet. The "Check"
1550   button next to each file or directory on the wapi page will perform
1551   a file check, and the "deep check" button on each directory will
1552   recursively check all files and directories reachable from there
1553   (which may take a very long time).
1554
1555   Future releases will improve access to this functionality.
1556
1557 Operations/Packaging
1558 ''''''''''''''''''''
1559
1560 - A "check-grid" script has been added, along with a Makefile
1561   target. This is intended (with the help of a pre-configured node
1562   directory) to check upon the health of a Tahoe grid, uploading and
1563   downloading a few files. This can be used as a monitoring tool for a
1564   deployed grid, to be run periodically and to signal an error if it
1565   ever fails. It also helps with compatibility testing, to verify that
1566   the latest Tahoe code is still able to handle files created by an
1567   older version.
1568
1569 - The munin plugins from misc/munin/ are now copied into any generated
1570   debian packages, and are made executable (and uncompressed) so they
1571   can be symlinked directly from /etc/munin/plugins/ .
1572
1573 - Ubuntu "Hardy" was added as a supported debian platform, with a
1574   Makefile target to produce hardy .deb packages. Some notes have been
1575   added to `debian.rst`_ about building Tahoe on a debian/ubuntu
1576   system.
1577
1578 - Storage servers now measure operation rates and
1579   latency-per-operation, and provides results through the /statistics
1580   web page as well as the stats gatherer. Munin plugins have been
1581   added to match.
1582
1583 Other
1584 '''''
1585
1586 - Tahoe nodes now use Foolscap "incident logging" to record unusual
1587   events to their NODEDIR/logs/incidents/ directory. These incident
1588   files can be examined by Foolscap logging tools, or delivered to an
1589   external log-gatherer for further analysis. Note that Tahoe now
1590   requires Foolscap-0.2.9, since 0.2.8 had a bug that complained about
1591   "OSError: File exists" when trying to create the incidents/
1592   directory for a second time.
1593
1594 - If no servers are available when retrieving a mutable file (like a
1595   directory), the node now reports an error instead of hanging
1596   forever. Earlier releases would not only hang (causing the wapi
1597   directory listing to get stuck half-way through), but the internal
1598   dirnode serialization would cause all subsequent attempts to
1599   retrieve or modify the same directory to hang as well. `#463`_
1600
1601 - A minor internal exception (reported in logs/twistd.log, in the
1602   "stopProducing" method) was fixed, which complained about
1603   "self._paused_at not defined" whenever a file download was stopped
1604   from the web browser end.
1605
1606 .. _#463: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/463
1607 .. _#491: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/491
1608 .. _debian.rst: docs/debian.rst
1609
1610 Release 1.1.0 (2008-06-11)
1611 --------------------------
1612
1613 CLI: new "alias" model
1614 ''''''''''''''''''''''
1615
1616 - The new CLI code uses an scp/rsync -like interface, in which
1617   directories in the Tahoe storage grid are referenced by a
1618   colon-suffixed alias. The new commands look like:
1619
1620  - tahoe cp local.txt tahoe:virtual.txt
1621  - tahoe ls work:subdir
1622
1623 - More functionality is available through the CLI: creating unlinked
1624   files and directories, recursive copy in or out of the storage grid,
1625   hardlinks, and retrieving the raw read- or write- caps through the
1626   'ls' command. Please read `CLI.rst`_ for complete details.
1627
1628 wapi: new pages, new commands
1629 '''''''''''''''''''''''''''''
1630
1631 - Several new pages were added to the web API:
1632
1633  - /helper_status : to describe what a Helper is doing
1634  - /statistics : reports node uptime, CPU usage, other stats
1635  - /file : for easy file-download URLs, see `#221`_
1636  - /cap == /uri : future compatibility
1637
1638 - The localdir=/localfile= and t=download operations were
1639   removed. These required special configuration to enable anyways, but
1640   this feature was a security problem, and was mostly obviated by the
1641   new "cp -r" command.
1642
1643 - Several new options to the GET command were added:
1644
1645  -  t=deep-size : add up the size of all immutable files reachable from the directory
1646  -  t=deep-stats : return a JSON-encoded description of number of files, size distribution, total size, etc
1647
1648 - POST is now preferred over PUT for most operations which cause
1649   side-effects.
1650
1651 - Most wapi calls now accept overwrite=, and default to overwrite=true
1652
1653 - "POST /uri/DIRCAP/parent/child?t=mkdir" is now the preferred API to
1654   create multiple directories at once, rather than ...?t=mkdir-p .
1655
1656 - PUT to a mutable file ("PUT /uri/MUTABLEFILECAP", "PUT
1657   /uri/DIRCAP/child") will modify the file in-place.
1658
1659 - more munin graphs in misc/munin/
1660
1661  - tahoe-introstats
1662  - tahoe-rootdir-space
1663  - tahoe_estimate_files
1664  - mutable files published/retrieved
1665  - tahoe_cpu_watcher
1666  - tahoe_spacetime
1667
1668 New Dependencies
1669 ''''''''''''''''
1670 -  zfec 1.1.0
1671 -  foolscap 0.2.8
1672 -  pycryptopp 0.5
1673 -  setuptools (now required at runtime)
1674
1675 New Mutable-File Code
1676 '''''''''''''''''''''
1677
1678 - The mutable-file handling code (mostly used for directories) has
1679   been completely rewritten. The new scheme has a better API (with a
1680   modify() method) and is less likely to lose data when several
1681   uncoordinated writers change a file at the same time.
1682
1683 - In addition, a single Tahoe process will coordinate its own
1684   writes. If you make two concurrent directory-modifying wapi calls to
1685   a single tahoe node, it will internally make one of them wait for
1686   the other to complete. This prevents auto-collision (`#391`_).
1687
1688 - The new mutable-file code also detects errors during publish
1689   better. Earlier releases might believe that a mutable file was
1690   published when in fact it failed.
1691
1692 other features
1693 ''''''''''''''
1694
1695 - The node now monitors its own CPU usage, as a percentage, measured
1696   every 60 seconds. 1/5/15 minute moving averages are available on the
1697   /statistics web page and via the stats-gathering interface.
1698
1699 - Clients now accelerate reconnection to all servers after being
1700   offline (`#374`_). When a client is offline for a long time, it
1701   scales back reconnection attempts to approximately once per hour, so
1702   it may take a while to make the first attempt, but once any attempt
1703   succeeds, the other server connections will be retried immediately.
1704
1705 - A new "offloaded KeyGenerator" facility can be configured, to move
1706   RSA key generation out from, say, a wapi node, into a separate
1707   process. RSA keys can take several seconds to create, and so a wapi
1708   node which is being used for directory creation will be unavailable
1709   for anything else during this time. The Key Generator process will
1710   pre-compute a small pool of keys, to speed things up further. This
1711   also takes better advantage of multi-core CPUs, or SMP hosts.
1712
1713 - The node will only use a potentially-slow "du -s" command at startup
1714   (to measure how much space has been used) if the "sizelimit"
1715   parameter has been configured (to limit how much space is
1716   used). Large storage servers should turn off sizelimit until a later
1717   release improves the space-management code, since "du -s" on a
1718   terabyte filesystem can take hours.
1719
1720 - The Introducer now allows new announcements to replace old ones, to
1721   avoid buildups of obsolete announcements.
1722
1723 - Immutable files are limited to about 12GiB (when using the default
1724   3-of-10 encoding), because larger files would be corrupted by the
1725   four-byte share-size field on the storage servers (`#439`_). A later
1726   release will remove this limit. Earlier releases would allow >12GiB
1727   uploads, but the resulting file would be unretrievable.
1728
1729 - The docs/ directory has been rearranged, with old docs put in
1730   docs/historical/ and not-yet-implemented ones in docs/proposed/ .
1731
1732 - The Mac OS-X FUSE plugin has a significant bug fix: earlier versions
1733   would corrupt writes that used seek() instead of writing the file in
1734   linear order.  The rsync tool is known to perform writes in this
1735   order. This has been fixed.
1736
1737 .. _#221: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/221
1738 .. _#374: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/374
1739 .. _#391: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/391
1740 .. _#439: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/439
1741 .. _CLI.rst: docs/CLI.rst