diff options
Diffstat (limited to 'docs/keymanager/index.rst')
-rw-r--r-- | docs/keymanager/index.rst | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/docs/keymanager/index.rst b/docs/keymanager/index.rst new file mode 100644 index 00000000..fa3f0c83 --- /dev/null +++ b/docs/keymanager/index.rst @@ -0,0 +1,82 @@ +.. _keymanager: + +================= +Keymanager +================= + +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 |