aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/mac
diff options
context:
space:
mode:
authorGabriel Orisaka <orisaka@gmail.com>2016-07-31 10:49:59 -0300
committerAlex Gaynor <alex.gaynor@gmail.com>2016-07-31 09:49:59 -0400
commit617fe4b487485d993def60e9e35175c8e4d229ac (patch)
tree1d0b07e159fa5c55dc6ef08d4762583319377593 /docs/hazmat/primitives/mac
parent33c59a3b176d76230c37f6b7b00cc74ba3263b02 (diff)
downloadcryptography-617fe4b487485d993def60e9e35175c8e4d229ac.tar.gz
cryptography-617fe4b487485d993def60e9e35175c8e4d229ac.tar.bz2
cryptography-617fe4b487485d993def60e9e35175c8e4d229ac.zip
Remove provider language from docs (#3072)
Diffstat (limited to 'docs/hazmat/primitives/mac')
-rw-r--r--docs/hazmat/primitives/mac/cmac.rst14
-rw-r--r--docs/hazmat/primitives/mac/hmac.rst8
2 files changed, 10 insertions, 12 deletions
diff --git a/docs/hazmat/primitives/mac/cmac.rst b/docs/hazmat/primitives/mac/cmac.rst
index e04a849f..e170db31 100644
--- a/docs/hazmat/primitives/mac/cmac.rst
+++ b/docs/hazmat/primitives/mac/cmac.rst
@@ -22,7 +22,7 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`.
.. versionadded:: 0.4
CMAC objects take a
- :class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm` provider.
+ :class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm` instance.
.. doctest::
@@ -40,7 +40,7 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`.
If ``algorithm`` isn't a
:class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`
- provider then ``TypeError`` will be raised.
+ instance then ``TypeError`` will be raised.
To check that a given signature is correct use the :meth:`verify` method.
You will receive an exception if the signature is wrong:
@@ -54,12 +54,10 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`.
...
cryptography.exceptions.InvalidSignature: Signature did not match digest.
- :param algorithm: An
- :class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`
- provider.
- :param backend: An
- :class:`~cryptography.hazmat.backends.interfaces.CMACBackend`
- provider.
+ :param algorithm: An instance of
+ :class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`.
+ :param backend: An instance of
+ :class:`~cryptography.hazmat.backends.interfaces.CMACBackend`.
:raises TypeError: This is raised if the provided ``algorithm`` is not an instance of
:class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if the
diff --git a/docs/hazmat/primitives/mac/hmac.rst b/docs/hazmat/primitives/mac/hmac.rst
index 2515ac91..e00c4de2 100644
--- a/docs/hazmat/primitives/mac/hmac.rst
+++ b/docs/hazmat/primitives/mac/hmac.rst
@@ -18,7 +18,7 @@ of a message.
.. class:: HMAC(key, algorithm, backend)
HMAC objects take a ``key`` and a
- :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` provider.
+ :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` instance.
The ``key`` should be :doc:`randomly generated bytes </random-numbers>` and
is recommended to be equal in length to the ``digest_size`` of the hash
function chosen. You must keep the ``key`` secret.
@@ -39,7 +39,7 @@ of a message.
raised.
If ``algorithm`` isn't a
- :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` provider
+ :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` instance
then ``TypeError`` will be raised.
To check that a given signature is correct use the :meth:`verify` method.
@@ -57,11 +57,11 @@ of a message.
:param bytes key: Secret key as ``bytes``.
:param algorithm: An
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
- provider such as those described in
+ instance such as those described in
:ref:`Cryptographic Hashes <cryptographic-hash-algorithms>`.
:param backend: An
:class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
- provider.
+ instance.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if the
provided ``backend`` does not implement