diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2015-12-28 12:11:55 +0100 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2015-12-28 12:51:19 +0100 |
| commit | a86ff8aa50beea7d1e879a12788d7cfd992a7120 (patch) | |
| tree | 23ff327ef0eb081ddb1a90623753473a8de9ac35 /docs | |
| parent | 0ff41549a8a316e5577a5cd01f0bcc679943910e (diff) | |
Update some documentation
This adds a development notes section to the README and changes the
wording on the encryption page.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/encryption.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/encryption.rst b/docs/encryption.rst index 768a3f4..0d5cf3e 100644 --- a/docs/encryption.rst +++ b/docs/encryption.rst @@ -3,9 +3,9 @@ PSKC encryption .. module:: pskc.encryption -The keys (and some embedded data) in PSKC files can be encrypted with either -pre-shared keys, passphrase-based keys or asymmetric keys (asymmetric keys -are currently unimplemented). +Some of the information in PSKC files (e.g. key material) can be encrypted +with either pre-shared keys, passphrase-based keys or asymmetric keys +(asymmetric keys are currently unimplemented). Embedded PSKC encryption is handled inside the :class:`Encryption` class that defines encryption key or means of deriving keys. It is accessed from the @@ -23,7 +23,7 @@ or:: Once the encryption key has been set up, any encrypted key values from the PSKC file are available transparently. -If an incorrect key has been set up, upon accessing encrypted +If no key or an incorrect key has been set configured, upon accessing encrypted information (e.g. the :attr:`~pskc.key.Key.secret` attribute of a :class:`~pskc.key.Key` instance) a :exc:`~pskc.exceptions.DecryptionError` exception will be raised. |