[doc] soledad docs fields
authorRuben Pollan <meskio@sindominio.net>
Mon, 21 Dec 2015 14:59:58 +0000 (15:59 +0100)
committerRuben Pollan <meskio@sindominio.net>
Thu, 25 Feb 2016 17:35:24 +0000 (11:35 -0600)
- Resolves: #7712

changes/next-changelog.txt
docs/soledad-documents.rst [new file with mode: 0644]

index be6da72..163c1ee 100644 (file)
@@ -13,6 +13,7 @@ Features
 - `#7485 <https://leap.se/code/issues/7485>`_: Move validation, usage and audited date to the active document.
 - `#7713 <https://leap.se/code/issues/7713>`_: Update soledad documents by adding versioning field.
 - `#7500 <https://leap.se/code/issues/7500>`_: Use fingerprints instead of key ids.
+- `#7712 <https://leap.se/code/issues/7712>`_: Document the soledad docs fields.
 - Make EncryptionKey aware of the active address.
 
 - `#1234 <https://leap.se/code/issues/1234>`_: Description of the new feature corresponding with issue #1234.
diff --git a/docs/soledad-documents.rst b/docs/soledad-documents.rst
new file mode 100644 (file)
index 0000000..67055b2
--- /dev/null
@@ -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