diff options
author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-02-14 10:27:14 -0600 |
---|---|---|
committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2015-02-14 10:36:24 -0600 |
commit | 7c5c9fedd513f4ef66b62fcf5fdcde8dc30fe532 (patch) | |
tree | 1600ea1cdc548421f021bdc79a1251db8a7a0ebf /docs/hazmat/primitives/symmetric-encryption.rst | |
parent | 2129d5035849c69f990a646ac76891d1a886be55 (diff) | |
download | cryptography-7c5c9fedd513f4ef66b62fcf5fdcde8dc30fe532.tar.gz cryptography-7c5c9fedd513f4ef66b62fcf5fdcde8dc30fe532.tar.bz2 cryptography-7c5c9fedd513f4ef66b62fcf5fdcde8dc30fe532.zip |
export interfaces from base in ciphers, update docs
Diffstat (limited to 'docs/hazmat/primitives/symmetric-encryption.rst')
-rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index d47035d8..1cbf60ee 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -4,7 +4,7 @@ Symmetric encryption ==================== -.. currentmodule:: cryptography.hazmat.primitives.ciphers +.. module:: cryptography.hazmat.primitives.ciphers Symmetric encryption is a way to `encrypt`_ or hide the contents of material @@ -43,7 +43,7 @@ in an "encrypt-then-MAC" formulation as `described by Colin Percival`_. 'a secret message' :param algorithms: A - :class:`~cryptography.hazmat.primitives.ciphers.base.CipherAlgorithm` + :class:`~cryptography.hazmat.primitives.ciphers.CipherAlgorithm` provider such as those described :ref:`below <symmetric-encryption-algorithms>`. :param mode: A :class:`~cryptography.hazmat.primitives.ciphers.modes.Mode` @@ -60,7 +60,7 @@ in an "encrypt-then-MAC" formulation as `described by Colin Percival`_. .. method:: encryptor() :return: An encrypting - :class:`~cryptography.hazmat.primitives.ciphers.base.CipherContext` + :class:`~cryptography.hazmat.primitives.ciphers.CipherContext` provider. If the backend doesn't support the requested combination of ``cipher`` @@ -70,7 +70,7 @@ in an "encrypt-then-MAC" formulation as `described by Colin Percival`_. .. method:: decryptor() :return: A decrypting - :class:`~cryptography.hazmat.primitives.ciphers.base.CipherContext` + :class:`~cryptography.hazmat.primitives.ciphers.CipherContext` provider. If the backend doesn't support the requested combination of ``cipher`` @@ -293,7 +293,7 @@ Modes .. danger:: When using this mode you **must** not use the decrypted data until - :meth:`~cryptography.hazmat.primitives.ciphers.base.CipherContext.finalize` + :meth:`~cryptography.hazmat.primitives.ciphers.CipherContext.finalize` has been called. GCM provides **no** guarantees of ciphertext integrity until decryption is complete. @@ -423,7 +423,7 @@ Insecure modes Interfaces ---------- -.. module:: cryptography.hazmat.primitives.ciphers.base +.. currentmodule:: cryptography.hazmat.primitives.ciphers .. class:: CipherContext |