aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/interfaces.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2015-02-16 15:31:52 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2015-02-16 22:32:57 -0600
commit48402ffeef3224452d042f4b349c9d2c16ff2852 (patch)
treef755c2c00f3e07dc9f3103552c62cb57626ce616 /docs/hazmat/primitives/interfaces.rst
parent5e208e7be554cb5c132acef9754c54681e24fab9 (diff)
downloadcryptography-48402ffeef3224452d042f4b349c9d2c16ff2852.tar.gz
cryptography-48402ffeef3224452d042f4b349c9d2c16ff2852.tar.bz2
cryptography-48402ffeef3224452d042f4b349c9d2c16ff2852.zip
move KDF interface
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r--docs/hazmat/primitives/interfaces.rst42
1 files changed, 2 insertions, 40 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index 6029d1a9..f58d324d 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -47,46 +47,8 @@ In 0.8 the EC key interfaces were moved to the
Key derivation functions
------------------------
-.. class:: KeyDerivationFunction
-
- .. versionadded:: 0.2
-
- .. method:: derive(key_material)
-
- :param bytes key_material: The input key material. Depending on what
- key derivation function you are using this
- could be either random bytes, or a user
- supplied password.
- :return: The new key.
- :raises cryptography.exceptions.AlreadyFinalized: This is raised when
- :meth:`derive` or
- :meth:`verify` is
- called more than
- once.
-
- This generates and returns a new key from the supplied key material.
-
- .. method:: verify(key_material, expected_key)
-
- :param bytes key_material: The input key material. This is the same as
- ``key_material`` in :meth:`derive`.
- :param bytes expected_key: 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.
- :raises cryptography.exceptions.AlreadyFinalized: This is raised when
- :meth:`derive` or
- :meth:`verify` is
- called more than
- once.
-
- 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.
+In 0.8 the key derivation function interface was moved to the
+:mod:`cryptography.hazmat.primitives.kdf` module.
`Message Authentication Code`_