docs/about.rst

   1
   2 .. -*- coding: utf-8 -*-
   3
   4 Welcome to Tahoe-LAFS!
   5 ======================
   6
   7 Welcome to Tahoe-LAFS_, the first decentralized storage system with
   8 *provider-independent security*.
   9
  10 .. _Tahoe-LAFS: https://tahoe-lafs.org
  11
  12 What is "provider-independent security"?
  13 ========================================
  14
  15 Every seller of cloud storage services will tell you that their service is
  16 "secure".  But what they mean by that is something fundamentally different
  17 from what we mean.  What they mean by "secure" is that after you've given
  18 them the power to read and modify your data, they try really hard not to let
  19 this power be abused.  This turns out to be difficult!  Bugs,
  20 misconfigurations, or operator error can accidentally expose your data to
  21 another customer or to the public, or can corrupt your data.  Criminals
  22 routinely gain illicit access to corporate servers.  Even more insidious is
  23 the fact that the employees themselves sometimes violate customer privacy out
  24 of carelessness, avarice, or mere curiousity.  The most conscientious of
  25 these service providers spend considerable effort and expense trying to
  26 mitigate these risks.
  27
  28 What we mean by "security" is something different.  *The service provider
  29 never has the ability to read or modify your data in the first place—never.*
  30 If you use Tahoe-LAFS, then all of the threats described above are non-issues
  31 to you.  Not only is it easy and inexpensive for the service provider to
  32 maintain the security of your data, but in fact they couldn't violate its
  33 security if they tried.  This is what we call *provider-independent
  34 security*.
  35
  36 This guarantee is integrated naturally into the Tahoe-LAFS storage system and
  37 doesn't require you to perform a manual pre-encryption step or cumbersome key
  38 management.  (After all, having to do cumbersome manual operations when
  39 storing or accessing your data would nullify one of the primary benefits of
  40 using cloud storage in the first place—convenience.)
  41
  42 Here's how it works:
  43
  44 .. image:: https://tahoe-lafs.org/~zooko/network-and-reliance-topology.png
  45
  46 A "storage grid" is made up of a number of storage servers.  A storage server
  47 has direct attached storage (typically one or more hard disks).  A "gateway"
  48 uses the storage servers and provides access to the filesystem over HTTP(S)
  49 or (S)FTP.
  50
  51 Users do not rely on storage servers to provide *confidentiality* nor
  52 *integrity* for their data -- instead all of the data is encrypted and
  53 integrity-checked by the gateway, so that the servers can neither read nor
  54 modify the contents of the files.
  55
  56 Users do rely on storage servers for *availability*.  The ciphertext is
  57 erasure-coded into ``N`` shares distributed across at least ``H`` distinct
  58 storage servers (the default value for ``N`` is 10 and for ``H`` is 7) so
  59 that it can be recovered from any ``K`` of these servers (the default
  60 value of ``K`` is 3).  Therefore only the failure of ``H-K+1`` (with the
  61 defaults, 5) servers can make the data unavailable.
  62
  63 In the typical deployment mode each user runs her own gateway on her own
  64 machine.  This way she relies on her own machine for the confidentiality and
  65 integrity of the data.
  66
  67 An alternate deployment mode is that the gateway runs on a remote machine and
  68 the user connects to it over HTTPS or SFTP.  This means that the operator of
  69 the gateway can view and modify the user's data (the user *relies on* the
  70 gateway for confidentiality and integrity), but the advantage is that the
  71 user can access the filesystem with a client that doesn't have the gateway
  72 software installed, such as an Internet kiosk or cell phone.
  73
  74 Access Control
  75 ==============
  76
  77 There are two kinds of files: immutable and mutable. When you upload a file
  78 to the storage grid you can choose which kind of file it will be in the
  79 grid. Immutable files can't be modified once they have been uploaded.  A
  80 mutable file can be modified by someone with read-write access to it. A user
  81 can have read-write access to a mutable file or read-only access to it, or no
  82 access to it at all.
  83
  84 A user who has read-write access to a mutable file or directory can give
  85 another user read-write access to that file or directory, or they can give
  86 read-only access to that file or directory.  A user who has read-only access
  87 to a file or directory can give another user read-only access to it.
  88
  89 When linking a file or directory into a parent directory, you can use a
  90 read-write link or a read-only link.  If you use a read-write link, then
  91 anyone who has read-write access to the parent directory can gain read-write
  92 access to the child, and anyone who has read-only access to the parent
  93 directory can gain read-only access to the child.  If you use a read-only
  94 link, then anyone who has either read-write or read-only access to the parent
  95 directory can gain read-only access to the child.
  96
  97 For more technical detail, please see the `the doc page`_ on the Wiki.
  98
  99 .. _the doc page: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc
 100
 101 Get Started
 102 ===========
 103
 104 To use Tahoe-LAFS, please see quickstart.rst_.
 105
 106 .. _quickstart.rst: quickstart.rst
 107
 108 License
 109 =======
 110
 111 You may use this package under the GNU General Public License, version 2 or,
 112 at your option, any later version.  See the file COPYING.GPL_ for the terms
 113 of the GNU General Public License, version 2.
 114
 115 You may use this package under the Transitive Grace Period Public Licence,
 116 version 1 or, at your option, any later version.  The Transitive Grace Period
 117 Public Licence has requirements similar to the GPL except that it allows you
 118 to wait for up to twelve months after you redistribute a derived work before
 119 releasing the source code of your derived work. See the file
 120 COPYING.TGPPL.rst_ for the terms of the Transitive Grace Period Public
 121 Licence, version 1.
 122
 123 (You may choose to use this package under the terms of either licence, at
 124 your option.)
 125
 126 .. _COPYING.GPL: ../COPYING.GPL
 127 .. _COPYING.TGPPL.rst: ../COPYING.TGPPL.rst