diff options
author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-12-06 11:49:42 -0600 |
---|---|---|
committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-12-06 11:57:04 -0600 |
commit | a07925a154e2b28db30499c5a3cf40fedc451d10 (patch) | |
tree | 9a3a94bc7b39fdae6554b452a5b4fd25ac9ec726 /docs/hazmat | |
parent | b91221dd7f27b3dcc09d3ad55645b12da08780cf (diff) | |
download | cryptography-a07925a154e2b28db30499c5a3cf40fedc451d10.tar.gz cryptography-a07925a154e2b28db30499c5a3cf40fedc451d10.tar.bz2 cryptography-a07925a154e2b28db30499c5a3cf40fedc451d10.zip |
update docs to explain tag requirements and valueerror
Diffstat (limited to 'docs/hazmat')
-rw-r--r-- | docs/hazmat/bindings/interfaces.rst | 4 | ||||
-rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst | 4 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/hazmat/bindings/interfaces.rst b/docs/hazmat/bindings/interfaces.rst index c55d86dc..711c82c2 100644 --- a/docs/hazmat/bindings/interfaces.rst +++ b/docs/hazmat/bindings/interfaces.rst @@ -69,6 +69,8 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` + :raises ValueError: When tag is not None in an AEAD mode + .. method:: create_symmetric_decryption_ctx(cipher, mode) @@ -86,6 +88,8 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` + :raises ValueError: When tag is None in an AEAD mode + .. class:: HashBackend diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index 8d8d558b..46148689 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -349,8 +349,8 @@ Modes Do not reuse an ``initialization_vector`` with a given ``key``. - :param bytes tag: The tag bytes to verify during decryption. Must be provided - for decryption, but is ignored when encrypting. + :param bytes tag: The tag bytes to verify during decryption. When encrypting + this must be None. .. doctest:: |