summaryrefslogtreecommitdiff
path: root/docs/reference/server-database.rst
blob: dba9d42cf40f9427eb86092e54d73ddf7ffd46ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Server-side databases
=====================

Soledad Server works with one database per user and one shared database in
which user's encrypted secrets might be stored.

User databases
--------------

User databases in the server are named 'user-<uuid>' and Soledad Client may
perform synchronization between its local replicas and the user's database in
the server. Authorization for creating, updating, deleting and retrieving
information about the user database as well as performing synchronization is
handled by the `leap.soledad.server.auth` module.

.. _shared-database:

Shared database
---------------

Each user may store password-encrypted recovery data in the shared database.

Recovery documents are stored in the database without any information that
may identify the user. In order to achieve this, the doc_id of recovery
documents are obtained as a hash of the user's uid and the user's password.
User's must have a valid token to interact with recovery documents, but the
server does not perform further authentication because it has no way to know
which recovery document belongs to each user.

This has some implications:

* The security of the recovery document doc_id, and thus of access to the
  recovery document (encrypted) content, as well as tampering with the
  stored data, all rely on the difficulty of obtaining the user's password
  (supposing the user's uid is somewhat public) and the security of the hash
  function used to calculate the doc_id.

* The security of the content of a recovery document relies on the
  difficulty of obtaining the user's password.

* If the user looses his/her password, he/she will not be able to obtain the
  recovery document.

* Because of the above, it is recommended that recovery documents expire
  (not implemented yet) to prevent excess storage.

The authorization for creating, updating, deleting and retrieving recovery
documents on the shared database is handled by `leap.soledad.server.auth`
module.