docs/about.rst

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