aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-13 20:28:55 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-13 20:28:55 -0800
commitf8796b15a279db82cdefcd00bebfef4cdef8fee8 (patch)
treed356e592a7a174f356a8f5b9904860b95e9a0312 /docs
parentb9dd85c661f405099a88b7a76aefde5f59a6b985 (diff)
downloadcryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.tar.gz
cryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.tar.bz2
cryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.zip
Renamed bindings to backends
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.rst6
-rw-r--r--docs/contributing.rst2
-rw-r--r--docs/hazmat/backends/index.rst (renamed from docs/hazmat/bindings/index.rst)2
-rw-r--r--docs/hazmat/backends/interfaces.rst (renamed from docs/hazmat/bindings/interfaces.rst)2
-rw-r--r--docs/hazmat/backends/openssl.rst (renamed from docs/hazmat/bindings/openssl.rst)2
-rw-r--r--docs/hazmat/primitives/cryptographic-hashes.rst4
-rw-r--r--docs/hazmat/primitives/hmac.rst4
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst8
-rw-r--r--docs/index.rst2
9 files changed, 16 insertions, 16 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 5ca2c252..bacde1bb 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -8,6 +8,6 @@ Architecture
``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.
+ ``cryptography.hazmat.backends``.
+* ``cryptography.hazmat.backends``: This package contains bindings to low level
+ cryptographic libraries. Our initial target is OpenSSL.
diff --git a/docs/contributing.rst b/docs/contributing.rst
index a8010a9a..cb9c7283 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -79,7 +79,7 @@ whether the signature was valid.
APIs at the :doc:`/hazmat/primitives/index` layer should always take an
explicit backend, APIs at the recipes layer should automatically use the
-:func:`~cryptography.hazmat.bindings.default_backend`, but optionally allow
+:func:`~cryptography.hazmat.backends.default_backend`, but optionally allow
specifying a different backend.
C bindings
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/backends/index.rst
index 746f4596..a89cf0d5 100644
--- a/docs/hazmat/bindings/index.rst
+++ b/docs/hazmat/backends/index.rst
@@ -13,7 +13,7 @@ Bindings
Getting a Backend Provider
~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. currentmodule:: cryptography.hazmat.bindings
+.. currentmodule:: cryptography.hazmat.backends
``cryptography`` aims to support multiple backends to ensure it can provide
the widest number of supported cryptographic algorithms as well as supporting
diff --git a/docs/hazmat/bindings/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 711c82c2..b524943d 100644
--- a/docs/hazmat/bindings/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -3,7 +3,7 @@
Backend Interfaces
==================
-.. currentmodule:: cryptography.hazmat.bindings.interfaces
+.. currentmodule:: cryptography.hazmat.backends.interfaces
Backend implementations may provide a number of interfaces to support operations
diff --git a/docs/hazmat/bindings/openssl.rst b/docs/hazmat/backends/openssl.rst
index d6bfa672..12fbff04 100644
--- a/docs/hazmat/bindings/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -5,7 +5,7 @@ OpenSSL
These are `CFFI`_ bindings to the `OpenSSL`_ C library.
-.. data:: cryptography.hazmat.bindings.openssl.backend
+.. data:: cryptography.hazmat.backends.openssl.backend
This is the exposed API for the OpenSSL bindings. It has two public
attributes:
diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst
index 312d7e69..90ca198a 100644
--- a/docs/hazmat/primitives/cryptographic-hashes.rst
+++ b/docs/hazmat/primitives/cryptographic-hashes.rst
@@ -20,7 +20,7 @@ Message Digests
.. doctest::
- >>> from cryptography.hazmat.bindings import default_backend
+ >>> from cryptography.hazmat.backends import default_backend
>>> from cryptography.hazmat.primitives import hashes
>>> digest = hashes.Hash(hashes.SHA256(), backend=default_backend())
>>> digest.update(b"abc")
@@ -39,7 +39,7 @@ Message Digests
provider such as those described in
:ref:`below <cryptographic-hash-algorithms>`.
:param backend: A
- :class:`~cryptography.hazmat.bindings.interfaces.HashBackend`
+ :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
provider.
.. method:: update(data)
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst
index db5e98d3..0c0d0220 100644
--- a/docs/hazmat/primitives/hmac.rst
+++ b/docs/hazmat/primitives/hmac.rst
@@ -27,7 +27,7 @@ message.
.. doctest::
- >>> from cryptography.hazmat.bindings import default_backend
+ >>> from cryptography.hazmat.backends import default_backend
>>> from cryptography.hazmat.primitives import hashes, hmac
>>> h = hmac.HMAC(key, hashes.SHA256(), backend=default_backend())
>>> h.update(b"message to hash")
@@ -41,7 +41,7 @@ message.
provider such as those described in
:ref:`Cryptographic Hashes <cryptographic-hash-algorithms>`.
:param backend: A
- :class:`~cryptography.hazmat.bindings.interfaces.HMACBackend`
+ :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
provider.
.. method:: update(msg)
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst
index ef6f0871..9fccf552 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -34,7 +34,7 @@ an "encrypt-then-MAC" formulation as `described by Colin Percival`_.
.. doctest::
>>> from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
- >>> from cryptography.hazmat.bindings import default_backend
+ >>> from cryptography.hazmat.backends import default_backend
>>> backend = default_backend()
>>> cipher = Cipher(algorithms.AES(key), modes.CBC(iv), backend=backend)
>>> encryptor = cipher.encryptor()
@@ -51,7 +51,7 @@ an "encrypt-then-MAC" formulation as `described by Colin Percival`_.
provider such as those described
:ref:`below <symmetric-encryption-modes>`.
:param backend: A
- :class:`~cryptography.hazmat.bindings.interfaces.CipherBackend`
+ :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`
provider.
.. method:: encryptor()
@@ -229,7 +229,7 @@ Weak Ciphers
.. doctest::
>>> from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
- >>> from cryptography.hazmat.bindings import default_backend
+ >>> from cryptography.hazmat.backends import default_backend
>>> algorithm = algorithms.ARC4(key)
>>> cipher = Cipher(algorithm, mode=None, backend=default_backend())
>>> encryptor = cipher.encryptor()
@@ -356,7 +356,7 @@ Modes
.. doctest::
>>> from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
- >>> from cryptography.hazmat.bindings import default_backend
+ >>> from cryptography.hazmat.backends import default_backend
>>> cipher = Cipher(algorithms.AES(key), modes.GCM(iv), backend=default_backend())
>>> encryptor = cipher.encryptor()
>>> encryptor.authenticate_additional_data(b"authenticated but not encrypted payload")
diff --git a/docs/index.rst b/docs/index.rst
index 2263c32f..776c9d37 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -53,4 +53,4 @@ Hazardous Materials
:maxdepth: 2
hazmat/primitives/index
- hazmat/bindings/index
+ hazmat/backends/index