diff options
| author | Julian Krause <julian.krause@gmail.com> | 2013-12-25 11:00:49 -0800 |
|---|---|---|
| committer | Julian Krause <julian.krause@gmail.com> | 2013-12-25 11:00:49 -0800 |
| commit | c91fe6a21fbae3107de7b2e53b7343cd67ac8c6d (patch) | |
| tree | d63eddf0364329af999a930100a828817bacfc5f /docs | |
| parent | 2288e30119e2af3e2b448345cf6a9e61f8d06aa0 (diff) | |
| download | cryptography-c91fe6a21fbae3107de7b2e53b7343cd67ac8c6d.tar.gz cryptography-c91fe6a21fbae3107de7b2e53b7343cd67ac8c6d.tar.bz2 cryptography-c91fe6a21fbae3107de7b2e53b7343cd67ac8c6d.zip | |
Clean up documentation and naming.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/exceptions.rst | 6 | ||||
| -rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst | 7 | ||||
| -rw-r--r-- | docs/hazmat/primitives/hmac.rst | 7 |
3 files changed, 14 insertions, 6 deletions
diff --git a/docs/exceptions.rst b/docs/exceptions.rst index 087066b8..8be2c48c 100644 --- a/docs/exceptions.rst +++ b/docs/exceptions.rst @@ -8,6 +8,12 @@ Exceptions This is raised when a context is used after being finalized. +.. class:: InvalidSignature + + This is raised when the verify function of a hash function does not + compare equal. + + .. class:: NotYetFinalized This is raised when the AEAD tag property is accessed on a context diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index 02c7b5e1..f6a3f7a1 100644 --- a/docs/hazmat/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -67,12 +67,13 @@ Message Digests :return bytes: The message digest as bytes. - .. method:: verify(sig) + .. method:: verify(digest) - Finalize the current context and securely compare digest to sig. + Finalize the current context and securely compare that digest to ``digest``. + :param bytes digest: Received hash digest :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` - :raises cryptography.exceptions.InvalidSignature: If sig does not match digest + :raises cryptography.exceptions.InvalidSignature: If hash digest does not match digest .. _cryptographic-hash-algorithms: diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index b556bd6a..0c19f20c 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -70,9 +70,10 @@ message. :return bytes: The message digest as bytes. :raises cryptography.exceptions.AlreadyFinalized: - .. method:: verify(sig) + .. method:: verify(signature) - Finalize the current context and securely compare digest to sig. + 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 sig does not match digest + :raises cryptography.exceptions.InvalidSignature: If signature does not match digest |