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