aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/interfaces.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-01-28 05:46:15 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2014-01-28 05:46:15 -0800
commit5484f72a8f83b8488bd22cae98be7c0c3576991a (patch)
tree014410e7c246cdc79035fddaeafba47555410e8e /docs/hazmat/primitives/interfaces.rst
parent288403a1a45554609d8b519d8b8d5a5abc9576c5 (diff)
downloadcryptography-5484f72a8f83b8488bd22cae98be7c0c3576991a.tar.gz
cryptography-5484f72a8f83b8488bd22cae98be7c0c3576991a.tar.bz2
cryptography-5484f72a8f83b8488bd22cae98be7c0c3576991a.zip
Try to improve the docs
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r--docs/hazmat/primitives/interfaces.rst26
1 files changed, 14 insertions, 12 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index ac48dd2c..ddccb773 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -211,27 +211,29 @@ Key Derivation Functions
.. method:: derive(key_material)
- :param key_material bytes: The raw key material. Depending on what key
- derivation function you are using this could
- be either random material, or a user
+ :param key_material bytes: The input key material. Depending on what
+ key derivation function you are using this
+ could be either random material, or a user
supplied password.
- :return: The resulting key.
+ :return: The new key.
- The generates and returns a new key from the supplied key material.
+ This generates and returns a new key from the supplied key material.
.. method:: verify(key_material, expected_key)
- :param key_material bytes: The raw key material. This is the same as
+ :param key_material bytes: The input key material. This is the same as
``key_material`` in :meth:`derive`.
- :param expected_key bytes: What the expected result of deriving a new
- key is.
+ :param expected_key bytes: The expected result of deriving a new key,
+ this is the same as the return value of
+ :meth:`derive`.
:raises cryptography.exceptions.InvalidKey: This is raised when the
derived key does not match
the expected key.
- This checks whether deriving a key from the supplied ``key_material``
- generates the same key as the ``expected_key``, and raises an exception
- if they do not match. This can be used for something like checking
- whether a user's password attempt matches the stored derived key.
+ This checks whether deriving a new key from the supplied
+ ``key_material`` generates the same key as the ``expected_key``, and
+ raises an exception if they do not match. This can be used for
+ something like checking whether a user's password attempt matches the
+ stored derived key.
.. _`RSA`: http://en.wikipedia.org/wiki/RSA_(cryptosystem)