diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 12 | ||||
| -rw-r--r-- | docs/bindings/index.rst | 7 | ||||
| -rw-r--r-- | docs/hazmat/bindings/index.rst | 14 | ||||
| -rw-r--r-- | docs/hazmat/bindings/openssl.rst (renamed from docs/bindings/openssl.rst) | 14 | ||||
| -rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst (renamed from docs/primitives/cryptographic-hashes.rst) | 9 | ||||
| -rw-r--r-- | docs/hazmat/primitives/index.rst | 15 | ||||
| -rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst (renamed from docs/primitives/symmetric-encryption.rst) | 21 | ||||
| -rw-r--r-- | docs/index.rst | 11 | ||||
| -rw-r--r-- | docs/primitives/index.rst | 8 |
9 files changed, 73 insertions, 38 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index 0a9550c0..4cf639c2 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -8,11 +8,11 @@ Architecture ``cryptography`` has three different layers: -* ``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.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``. +* ``cryptography.hazmat.primitives``: This packages contains low level + algorithms, things like ``AES`` or ``SHA1``. This is implemented on top of + ``cryptography.hazmat.bindings``. +* ``cryptography.hazmat.bindings``: This package contains bindings to low level + cryptographic libraries. Our initial target will be OpenSSL. diff --git a/docs/bindings/index.rst b/docs/bindings/index.rst deleted file mode 100644 index 80f53594..00000000 --- a/docs/bindings/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Bindings -======== - -.. toctree:: - :maxdepth: 1 - - openssl diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst new file mode 100644 index 00000000..4de2df47 --- /dev/null +++ b/docs/hazmat/bindings/index.rst @@ -0,0 +1,14 @@ +.. danger:: + + This is a "Hazardous Materials" module. You should **ONLY** use it if + you're 100% absolutely sure that you know what you're doing because this + module is full of land mines, dragons, and dinosaurs with laser guns. + + +Bindings +======== + +.. toctree:: + :maxdepth: 1 + + openssl diff --git a/docs/bindings/openssl.rst b/docs/hazmat/bindings/openssl.rst index e59b0c13..00e8094a 100644 --- a/docs/bindings/openssl.rst +++ b/docs/hazmat/bindings/openssl.rst @@ -1,16 +1,16 @@ -OpenSSL -======= +.. danger:: -.. warning:: + This is a "Hazardous Materials" module. You should **ONLY** use it if + you're 100% absolutely sure that you know what you're doing because this + module is full of land mines, dragons, and dinosaurs with laser guns. - The OpenSSL API is not easy to use, small mistakes can lead to significant - security vulnerabilities. We strongly recommend not using this directly, - and instead using one of the higher level APIs exposed by ``cryptography``. +OpenSSL +======= These are `CFFI`_ bindings to the `OpenSSL`_ C library. -.. data:: cryptography.bindings.openssl.backend +.. data:: cryptography.hazmat.bindings.openssl.backend This is the exposed API for the OpenSSL bindings. It has two public attributes: diff --git a/docs/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index dcf21250..de66b7fe 100644 --- a/docs/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -1,7 +1,14 @@ +.. danger:: + + This is a "Hazardous Materials" module. You should **ONLY** use it if + you're 100% absolutely sure that you know what you're doing because this + module is full of land mines, dragons, and dinosaurs with laser guns. + + Message Digests =============== -.. currentmodule:: cryptography.primitives.hashes +.. currentmodule:: cryptography.hazmat.primitives.hashes .. class:: BaseHash(data=None) diff --git a/docs/hazmat/primitives/index.rst b/docs/hazmat/primitives/index.rst new file mode 100644 index 00000000..6ae769a6 --- /dev/null +++ b/docs/hazmat/primitives/index.rst @@ -0,0 +1,15 @@ +.. danger:: + + This is a "Hazardous Materials" module. You should **ONLY** use it if + you're 100% absolutely sure that you know what you're doing because this + module is full of land mines, dragons, and dinosaurs with laser guns. + + +Primitives +========== + +.. toctree:: + :maxdepth: 1 + + cryptographic-hashes + symmetric-encryption diff --git a/docs/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index 87e1e692..758a4648 100644 --- a/docs/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -1,7 +1,14 @@ +.. danger:: + + This is a "Hazardous Materials" module. You should **ONLY** use it if + you're 100% absolutely sure that you know what you're doing because this + module is full of land mines, dragons, and dinosaurs with laser guns. + + Symmetric Encryption ==================== -.. currentmodule:: cryptography.primitives.block +.. currentmodule:: cryptography.hazmat.primitives.block .. testsetup:: @@ -22,7 +29,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 +43,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 +75,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 +116,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..23e966d1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,8 +31,15 @@ Contents :maxdepth: 2 architecture - primitives/index - bindings/index contributing security community + +Hazardous Materials +------------------- + +.. toctree:: + :maxdepth: 2 + + hazmat/primitives/index + hazmat/bindings/index diff --git a/docs/primitives/index.rst b/docs/primitives/index.rst deleted file mode 100644 index c18c62ca..00000000 --- a/docs/primitives/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Primitives -========== - -.. toctree:: - :maxdepth: 1 - - cryptographic-hashes - symmetric-encryption |