summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2016-08-29 22:53:54 -0400
committerKali Kaneko (leap communications) <kali@leap.se>2016-08-29 22:53:54 -0400
commit31bfd94c0bd8e42894ec1f855c19d9ed60d44a58 (patch)
tree9eab21840d6b9ff4d1442863c562254b83bb6786 /docs
parent3b7a763af94cdfefd80cd1101925f3b47749fd6f (diff)
[pkg] remove rest of keymanager repo
Diffstat (limited to 'docs')
-rw-r--r--docs/keymanager-soledad-docs.rst77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/keymanager-soledad-docs.rst b/docs/keymanager-soledad-docs.rst
new file mode 100644
index 00000000..67055b2f
--- /dev/null
+++ b/docs/keymanager-soledad-docs.rst
@@ -0,0 +1,77 @@
+=================
+Soledad Documents
+=================
+
+KeyManager uses two types of documents for the keyring:
+
+* key document, that stores each gpg key.
+
+* active document, that relates an address to its corresponding key.
+
+
+Each key can have 0 or more active documents with a different email address
+each:
+
+::
+
+ .-------------. .-------------.
+ | foo@foo.com | | bar@bar.com |
+ '-------------' '-------------'
+ | |
+ | .-----------. |
+ | | | |
+ | | key | |
+ '----->| |<----'
+ | |
+ '-----------'
+
+
+Fields in a key document:
+
+* uids
+
+* fingerprint
+
+* key_data
+
+* private. bool marking if the key is private or public
+
+* length
+
+* expiry_date
+
+* refreshed_at
+
+* version = 1
+
+* type = "OpenPGPKey"
+
+* tags = ["keymanager-key"]
+
+
+Fields in an active document:
+
+* address
+
+* fingerprint
+
+* private
+
+* validation
+
+* last_audited_at
+
+* encr_used
+
+* sign_used
+
+* version = 1
+
+* type = "OpenPGPKey-active"
+
+* tags = ["keymanager-active"]
+
+
+The meaning of validation, encr_used and sign_used is related to the `Transitional Key Validation`_
+
+.. _Transitional Key Validation: https://leap.se/en/docs/design/transitional-key-validation