aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-06 14:26:08 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-06 14:26:08 -0800
commitb5c4891e0c2e30118641092aff975e8d0e63cbab (patch)
treeb6209797e16ed81a5021fa6172e47ce2ebd94e1d /docs
parent07c36baec6ee7d4a89b3cbe18a37b9e5cbe48f64 (diff)
parenta07925a154e2b28db30499c5a3cf40fedc451d10 (diff)
downloadcryptography-b5c4891e0c2e30118641092aff975e8d0e63cbab.tar.gz
cryptography-b5c4891e0c2e30118641092aff975e8d0e63cbab.tar.bz2
cryptography-b5c4891e0c2e30118641092aff975e8d0e63cbab.zip
Merge pull request #285 from reaperhulk/fix-282
raise ValueErrors when supplying/not supplying tags for GCM
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/bindings/interfaces.rst4
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst4
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 e2cce195..2f390175 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -350,8 +350,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::