aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2013-11-22 13:42:02 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2013-11-29 17:19:45 -0600
commit6331daa36902edf5a5dd04e4e3fa0e188db59420 (patch)
tree846d388bdee292b748ac230b955045aa8057376f /docs/hazmat/primitives
parent24316fd1945909ef720ceb0e294752c4d3b6bbb2 (diff)
downloadcryptography-6331daa36902edf5a5dd04e4e3fa0e188db59420.tar.gz
cryptography-6331daa36902edf5a5dd04e4e3fa0e188db59420.tar.bz2
cryptography-6331daa36902edf5a5dd04e4e3fa0e188db59420.zip
gcm doc improvements
Diffstat (limited to 'docs/hazmat/primitives')
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst
index bd9a3f60..4e7990b0 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -137,7 +137,8 @@ an "encrypt-then-MAC" formulation as `described by Colin Percival`_.
.. attribute:: tag
:return bytes: Returns the tag value as bytes.
- :raises: :class:`~cryptography.exceptions.NotFinalized`
+ :raises: :class:`~cryptography.exceptions.NotYetFinalized` if called
+ before the context is finalized.
.. _symmetric-encryption-algorithms:
@@ -319,7 +320,10 @@ Modes
.. class:: GCM(initialization_vector, tag=None)
GCM (Galois Counter Mode) is a mode of operation for block ciphers. It
- is an AEAD (authenticated encryption with additional data) mode.
+ is an AEAD (authenticated encryption with additional data) mode. AEAD
+ is a type of block cipher mode that encrypts the message as well as
+ authenticating it (and optionally additional data that is not encrypted)
+ simultaneously.
:param bytes initialization_vector: Must be random bytes. They do not need
to be kept secret (they can be included