diff options
| author | Donald Stufft <donald@stufft.io> | 2013-10-27 16:59:56 -0400 |
|---|---|---|
| committer | Donald Stufft <donald@stufft.io> | 2013-10-28 08:37:33 -0400 |
| commit | d8f0118745ca0f6308e462b8bfd3ddd9caaa3607 (patch) | |
| tree | cf6d45f83c881a6df34087df69c6234fb1141658 /docs/hazmat | |
| parent | 95904672deabf6bb16f7fbfa4b068e7337feef14 (diff) | |
| download | cryptography-d8f0118745ca0f6308e462b8bfd3ddd9caaa3607.tar.gz cryptography-d8f0118745ca0f6308e462b8bfd3ddd9caaa3607.tar.bz2 cryptography-d8f0118745ca0f6308e462b8bfd3ddd9caaa3607.zip | |
Warn about dragons and dinosaurs with laser guns
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/bindings/index.rst | 7 | ||||
| -rw-r--r-- | docs/hazmat/bindings/openssl.rst | 8 | ||||
| -rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst | 7 | ||||
| -rw-r--r-- | docs/hazmat/primitives/index.rst | 7 | ||||
| -rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst | 7 |
5 files changed, 32 insertions, 4 deletions
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index 80f53594..163e82e8 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -1,6 +1,13 @@ Bindings ======== +.. 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. + + .. toctree:: :maxdepth: 1 diff --git a/docs/hazmat/bindings/openssl.rst b/docs/hazmat/bindings/openssl.rst index 5a00395e..04532466 100644 --- a/docs/hazmat/bindings/openssl.rst +++ b/docs/hazmat/bindings/openssl.rst @@ -1,11 +1,11 @@ OpenSSL ======= -.. warning:: +.. danger:: - 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``. + 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. These are `CFFI`_ bindings to the `OpenSSL`_ C library. diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index 05004080..72fd8692 100644 --- a/docs/hazmat/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -1,6 +1,13 @@ Message Digests =============== +.. 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. + + .. currentmodule:: cryptography.hazmat.primitives.hashes .. class:: BaseHash(data=None) diff --git a/docs/hazmat/primitives/index.rst b/docs/hazmat/primitives/index.rst index c18c62ca..bd3ef410 100644 --- a/docs/hazmat/primitives/index.rst +++ b/docs/hazmat/primitives/index.rst @@ -1,6 +1,13 @@ Primitives ========== +.. 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. + + .. toctree:: :maxdepth: 1 diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index e2586aaf..e65e48d4 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -1,6 +1,13 @@ Symmetric Encryption ==================== +.. 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. + + .. currentmodule:: cryptography.hazmat.primitives.block .. testsetup:: |