diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/architecture.rst | 6 | ||||
-rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst (renamed from docs/primitives/cryptographic-hashes.rst) | 2 | ||||
-rw-r--r-- | docs/hazmat/primitives/index.rst (renamed from docs/primitives/index.rst) | 0 | ||||
-rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst (renamed from docs/primitives/symmetric-encryption.rst) | 14 | ||||
-rw-r--r-- | docs/index.rst | 9 |
5 files changed, 19 insertions, 12 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index 0a9550c0..8de8649d 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -10,9 +10,9 @@ Architecture * ``cryptography.bindings``: This package contains bindings to low level cryptographic libraries. Our initial target will be OpenSSL. -* ``cryptography.primitives``: This packages contains low level algorithms, - things like ``AES`` or ``SHA1``. This is implemented on top of +* ``cryptography.hazmat.primitives``: This packages contains low level + algorithms, things like ``AES`` or ``SHA1``. This is implemented on top of ``cryptography.bindings``. * ``cryptography``: This package contains higher level recipes, for example "encrypt and then MAC". This is implemented on top of - ``cryptography.primitives``. + ``cryptography.hazmat.primitives``. diff --git a/docs/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index dcf21250..05004080 100644 --- a/docs/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -1,7 +1,7 @@ Message Digests =============== -.. currentmodule:: cryptography.primitives.hashes +.. currentmodule:: cryptography.hazmat.primitives.hashes .. class:: BaseHash(data=None) diff --git a/docs/primitives/index.rst b/docs/hazmat/primitives/index.rst index c18c62ca..c18c62ca 100644 --- a/docs/primitives/index.rst +++ b/docs/hazmat/primitives/index.rst diff --git a/docs/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index 87e1e692..e2586aaf 100644 --- a/docs/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -1,7 +1,7 @@ Symmetric Encryption ==================== -.. currentmodule:: cryptography.primitives.block +.. currentmodule:: cryptography.hazmat.primitives.block .. testsetup:: @@ -22,7 +22,7 @@ where the encrypter and decrypter both use the same key. .. doctest:: - >>> from cryptography.primitives.block import BlockCipher, ciphers, modes + >>> from cryptography.hazmat.primitives.block import BlockCipher, ciphers, modes >>> cipher = BlockCipher(ciphers.AES(key), modes.CBC(iv)) >>> encryptor = cipher.encryptor() >>> ct = encryptor.update(b"a secret message") + encryptor.finalize() @@ -36,16 +36,16 @@ where the encrypter and decrypter both use the same key. .. method:: encryptor() :return: An encrypting - :class:`~cryptography.primitives.interfaces.CipherContext` + :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` provider. .. method:: decryptor() :return: A decrypting - :class:`~cryptography.primitives.interfaces.CipherContext` + :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` provider. -.. currentmodule:: cryptography.primitives.interfaces +.. currentmodule:: cryptography.hazmat.primitives.interfaces .. class:: CipherContext() @@ -68,7 +68,7 @@ where the encrypter and decrypter both use the same key. Ciphers ~~~~~~~ -.. currentmodule:: cryptography.primitives.block.ciphers +.. currentmodule:: cryptography.hazmat.primitives.block.ciphers .. class:: AES(key) @@ -109,7 +109,7 @@ Ciphers Modes ~~~~~ -.. currentmodule:: cryptography.primitives.block.modes +.. currentmodule:: cryptography.hazmat.primitives.block.modes .. class:: CBC(initialization_vector) diff --git a/docs/index.rst b/docs/index.rst index a868a5d6..47418abb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,8 +31,15 @@ Contents :maxdepth: 2 architecture - primitives/index bindings/index contributing security community + +Hazard Materials +---------------- + +.. toctree:: + :maxdepth: 2 + + hazmat/primitives/index |