diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference.rst | 1 | ||||
| -rw-r--r-- | docs/reference/server-database.rst | 48 |
2 files changed, 49 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst index a2b62c42..11da7bf4 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -7,6 +7,7 @@ This page gathers reference documentation to understanding the internals of Sole :maxdepth: 1 reference/environment_variables + reference/server-database reference/auth reference/blobs reference/incoming_box diff --git a/docs/reference/server-database.rst b/docs/reference/server-database.rst new file mode 100644 index 00000000..591d688d --- /dev/null +++ b/docs/reference/server-database.rst @@ -0,0 +1,48 @@ +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 +--------------- + +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. + |