aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/hmac.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-11 21:59:08 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-11 21:59:08 -0600
commit74169660e47b760f82c0653b4210b3bc5d3bf46b (patch)
tree33835b3e733f6b918b56240200e29402092cc384 /docs/hazmat/primitives/hmac.rst
parent9ad4d755bb3a2edfb8e46b60f6dfaff6365f0386 (diff)
parent089a860f2d3f0ac923fc3f78190055990a940e2a (diff)
downloadcryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.tar.gz
cryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.tar.bz2
cryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.zip
Merge branch 'master' into urandom-engine
* master: (169 commits) Make just one call to ffi.cdef for most of the definitions Use pytest.fixture for backends drop to >= 0.8 to make pypy happy change to anonymous enum require cffi >= 0.8.1 remove extraneous spaces add hmac to commoncrypto binding bytes byte back add check to confirm we've loaded error strings Bind all the PEM errors Spelling! oops, bytes plz don't leak a context in the test add tests to the openssl backend to verify that we've registered Nonsense I think we need. This is a dep init the ssl library in the backend Actuall install a thing Try to run the spellchecker on travis Use a normal quote here, not sure where the smart quote came from ... Conflicts: cryptography/hazmat/bindings/openssl/binding.py tests/hazmat/backends/test_openssl.py
Diffstat (limited to 'docs/hazmat/primitives/hmac.rst')
-rw-r--r--docs/hazmat/primitives/hmac.rst29
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst
index b8f94fd2..a21799be 100644
--- a/docs/hazmat/primitives/hmac.rst
+++ b/docs/hazmat/primitives/hmac.rst
@@ -37,6 +37,16 @@ message.
If the backend doesn't support the requested ``algorithm`` an
:class:`~cryptography.exceptions.UnsupportedAlgorithm` 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:
+
+ .. code-block:: pycon
+
+ >>> h.verify(b"an incorrect signature")
+ Traceback (most recent call last):
+ ...
+ cryptography.exceptions.InvalidSignature: Signature did not match digest.
+
:param key: Secret key as ``bytes``.
:param algorithm: A
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
@@ -61,6 +71,17 @@ message.
and finalized independently of the original instance.
:raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`
+ .. method:: verify(signature)
+
+ Finalize the current context and securely compare digest to
+ ``signature``.
+
+ :param bytes signature: The bytes to compare the current digest
+ against.
+ :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`
+ :raises cryptography.exceptions.InvalidSignature: If signature does not
+ match digest
+
.. method:: finalize()
Finalize the current context and return the message digest as bytes.
@@ -71,11 +92,3 @@ message.
:return bytes: The message digest as bytes.
:raises cryptography.exceptions.AlreadyFinalized:
-
- .. method:: verify(signature)
-
- Finalize the current context and securely compare digest to ``signature``.
-
- :param bytes signature: The bytes of the HMAC signature recieved.
- :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`
- :raises cryptography.exceptions.InvalidSignature: If signature does not match digest