aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/index.rst')
-rw-r--r--doc/sphinx/index.rst74
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
new file mode 100644
index 0000000..8c19ebc
--- /dev/null
+++ b/doc/sphinx/index.rst
@@ -0,0 +1,74 @@
1..
2 This file is part of GNU Anastasis.
3 Copyright (C) 2020-2021 Anastasis SARL
4
5 Anastasis is free software; you can redistribute it and/or modify it under the
6 terms of the GNU Affero General Public License as published by the Free Software
7 Foundation; either version 2.1, or (at your option) any later version.
8
9 Anastasis is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11 A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
12
13 You should have received a copy of the GNU Affero General Public License along with
14 Anastasis; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
15
16 @author Christian Grothoff
17
18Anastasis Documentation
19=======================
20
21Anastasis is Free Software protocol and implementation that allows
22users to securely deposit **core secrets** with an open set of escrow
23providers and to recover these secrets if their original copies are
24lost.
25
26Anastasis is intended for users that want to make backups of key
27material, such as OpenPGP encryption keys, hard disk encryption keys
28or master keys of electronic wallets. Anastasis is NOT intended to
29store large amounts of secret data, it is only designed to safeguard
30key material.
31
32Anastasis solves the issue of keeping key material both available
33to the authorized user(s), and confidential from anyone else.
34
35With Anastasis, the **core secrets** are protected from the Anastasis
36escrow providers by encrypting each with a **master key**. The
37**master key** can be split and distributed across the escrow
38providers to ensure that no single escrow provider can recover the
39**master key** on its own. Which subset(s) of Anastasis providers
40must be contacted to recover a **master key** is freely configurable.
41
42With Anastasis, users can reliably recover their **core secret**,
43while Anastasis makes this difficult for everyone else. This is even
44true if the user is unable to reliably remember any secret with
45sufficiently high entropy: Anastasis does not simply reduce the
46problem to encrypting the **core secret** using some other key
47material in possession of the user.
48
49
50
51Documentation Overview
52----------------------
53
54.. toctree::
55 :numbered:
56 :maxdepth: 2
57
58 introduction
59 installation
60 configuration
61 cryptography
62 rest
63 reducer
64 authentication
65 db
66 design-documents/index
67 global-licensing
68 manindex
69 genindex
70
71.. toctree::
72 :hidden:
73
74 fdl-1.3