aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/interfaces.rst
diff options
context:
space:
mode:
authorJean-Paul Calderone <exarkun@twistedmatrix.com>2013-12-27 11:09:42 -0500
committerJean-Paul Calderone <exarkun@twistedmatrix.com>2013-12-27 11:09:42 -0500
commit08adc00087c8fe128abc2317776de1f974f4eed6 (patch)
tree9baacf858eb2ab752505cec675ddda118ed2f35d /docs/hazmat/backends/interfaces.rst
parentcf99cc77f863a7254d449ecb5f80a35ad7db11ab (diff)
parentb645521e84026633f666aa107816ac2fc5e05cc6 (diff)
downloadcryptography-08adc00087c8fe128abc2317776de1f974f4eed6.tar.gz
cryptography-08adc00087c8fe128abc2317776de1f974f4eed6.tar.bz2
cryptography-08adc00087c8fe128abc2317776de1f974f4eed6.zip
Merge remote-tracking branch 'origin/master' into some-typedef-fixes
Diffstat (limited to 'docs/hazmat/backends/interfaces.rst')
-rw-r--r--docs/hazmat/backends/interfaces.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index b524943d..5b6cd64d 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -126,6 +126,17 @@ A specific ``backend`` may provide one or more of these interfaces.
A backend with methods for using cryptographic hash functions as message
authentication codes.
+ .. method:: hmac_supported(algorithm)
+
+ Check if the specified ``algorithm`` is supported by this backend.
+
+ :param algorithm: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
+ provider.
+
+ :returns: ``True`` if the specified ``algorithm`` is supported for HMAC
+ by this backend, otherwise ``False``.
+
.. method:: create_hmac_ctx(algorithm)
Create a