diff options
Diffstat (limited to 'docs/hazmat/primitives/mac/index.rst')
| -rw-r--r-- | docs/hazmat/primitives/mac/index.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/mac/index.rst b/docs/hazmat/primitives/mac/index.rst index 05db708c..86c407c4 100644 --- a/docs/hazmat/primitives/mac/index.rst +++ b/docs/hazmat/primitives/mac/index.rst @@ -9,6 +9,38 @@ recommend that HMAC should be used unless you have a good reason otherwise. For more information on why HMAC is preferred, see `Use cases for CMAC vs. HMAC?`_ +HMAC and CMAC both use the ``MACContext`` interface: + +.. currentmodule:: cryptography.hazmat.primitives.mac + +.. class:: MACContext + + .. versionadded:: 0.7 + + .. method:: update(data) + + :param bytes data: The data you want to authenticate. + + .. method:: finalize() + + :return: The message authentication code. + + .. method:: copy() + + :return: A + :class:`~cryptography.hazmat.primitives.mac.MACContext` that + is a copy of the current context. + + .. method:: verify(signature) + + :param bytes signature: The signature to verify. + + :raises cryptography.exceptions.InvalidSignature: This is raised when + the provided signature does not match the expected signature. + + + +.. _`CMAC`: https://en.wikipedia.org/wiki/CMAC .. _`Use cases for CMAC vs. HMAC?`: https://crypto.stackexchange.com/questions/15721/use-cases-for-cmac-vs-hmac .. toctree:: |