Ticket #1400: NEWS-rst.2

File NEWS-rst.2, 63.5 KB (added by marlowe, at 2011-05-11T02:32:32Z)

Wish I could say what I fixed, but I deleted the section and reentered it by hand. However, it resolves the issue.

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