aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2019-10-19 01:12:03 +0200
committerAlex Gaynor <alex.gaynor@gmail.com>2019-10-18 19:12:03 -0400
commit2620fd85d82308401ab6888ef178496b07263b65 (patch)
tree7cce98bdb827fcb392f522e4bb62e27f38e01b4c /docs
parent1c186772f6fd64180bd3387de2e1ef1a6d1ba58e (diff)
downloadcryptography-2620fd85d82308401ab6888ef178496b07263b65.tar.gz
cryptography-2620fd85d82308401ab6888ef178496b07263b65.tar.bz2
cryptography-2620fd85d82308401ab6888ef178496b07263b65.zip
Correctly document `backend` argument of KBKDFHMAC (#5026)
The documentation states that `backend` should be a `HashBackend` instance when in fact it should be a `HMACBackend` instance.
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/primitives/key-derivation-functions.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst
index af7fb40a..fe9f0b0d 100644
--- a/docs/hazmat/primitives/key-derivation-functions.rst
+++ b/docs/hazmat/primitives/key-derivation-functions.rst
@@ -674,12 +674,12 @@ Different KDFs are suitable for different tasks such as:
and ``context`` is ignored.
:param backend: A cryptography backend
- :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
+ :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
instance.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
if the provided ``backend`` does not implement
- :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
+ :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
:raises TypeError: This exception is raised if ``label`` or ``context``
is not ``bytes``. Also raised if ``rlen`` or ``llen`` is not ``int``.