aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2017-05-20 10:09:02 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2017-05-20 10:09:02 -0700
commit51032351297b9bf7d783b7138ac0c142d8e38918 (patch)
tree3a3ca718dbb0cf904d66b9046489185349ba508b /docs
parentd08ddd5af21de62088c0236bfac1d647a6cb84a2 (diff)
downloadcryptography-51032351297b9bf7d783b7138ac0c142d8e38918.tar.gz
cryptography-51032351297b9bf7d783b7138ac0c142d8e38918.tar.bz2
cryptography-51032351297b9bf7d783b7138ac0c142d8e38918.zip
time to remove commoncrypto, fare thee well (#3551)
* time to remove commoncrypto, fare thee well * remove even more * update the changelog * remove more things * don't need this function * remove CAST5 CTR tests since that was only supported in commoncrypto * assert a thing
Diffstat (limited to 'docs')
-rw-r--r--docs/development/getting-started.rst14
-rw-r--r--docs/hazmat/backends/commoncrypto.rst30
-rw-r--r--docs/hazmat/backends/index.rst1
-rw-r--r--docs/hazmat/backends/interfaces.rst4
-rw-r--r--docs/hazmat/bindings/commoncrypto.rst30
-rw-r--r--docs/hazmat/bindings/index.rst1
6 files changed, 0 insertions, 80 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst
index 29d01c31..66173d40 100644
--- a/docs/development/getting-started.rst
+++ b/docs/development/getting-started.rst
@@ -86,20 +86,6 @@ You may not have all the required Python versions installed, in which case you
will see one or more ``InterpreterNotFound`` errors.
-Explicit backend selection
---------------------------
-
-While testing you may want to run tests against a subset of the backends that
-cryptography supports. Explicit backend selection can be done via the
-``--backend`` flag. This flag should be passed to ``py.test`` with a comma
-delimited list of backend names.
-
-
-.. code-block:: console
-
- $ tox -- --backend=openssl
- $ py.test --backend=openssl,commoncrypto
-
Building documentation
----------------------
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst
deleted file mode 100644
index e976b6f7..00000000
--- a/docs/hazmat/backends/commoncrypto.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. hazmat::
-
-CommonCrypto backend
-====================
-
-The `CommonCrypto`_ C library provided by Apple on macOS and iOS. The
-CommonCrypto backend is only supported on macOS versions 10.8 and above.
-
-.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend
-
-.. versionadded:: 0.2
-
-.. data:: cryptography.hazmat.backends.commoncrypto.backend
-
- This is the exposed API for the CommonCrypto backend.
-
- It implements the following interfaces:
-
- * :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`
- * :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
- * :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
- * :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend`
-
- It has one additional public attribute.
-
- .. attribute:: name
-
- The string name of this backend: ``"commoncrypto"``
-
-.. _`CommonCrypto`: https://developer.apple.com/library/content/documentation/Security/Conceptual/cryptoservices/GeneralPurposeCrypto/GeneralPurposeCrypto.html#//apple_ref/doc/uid/TP40011172-CH9-SW10
diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst
index aec7a1e0..56d18901 100644
--- a/docs/hazmat/backends/index.rst
+++ b/docs/hazmat/backends/index.rst
@@ -31,6 +31,5 @@ Individual backends
:maxdepth: 1
openssl
- commoncrypto
multibackend
interfaces
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 4f15d5c6..e3c67474 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -22,7 +22,6 @@ A specific ``backend`` may provide one or more of these interfaces.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
- * :doc:`/hazmat/backends/commoncrypto`
.. method:: cipher_supported(cipher, mode)
@@ -84,7 +83,6 @@ A specific ``backend`` may provide one or more of these interfaces.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
- * :doc:`/hazmat/backends/commoncrypto`
.. method:: hash_supported(algorithm)
@@ -118,7 +116,6 @@ A specific ``backend`` may provide one or more of these interfaces.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
- * :doc:`/hazmat/backends/commoncrypto`
.. method:: hmac_supported(algorithm)
@@ -181,7 +178,6 @@ A specific ``backend`` may provide one or more of these interfaces.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
- * :doc:`/hazmat/backends/commoncrypto`
.. method:: pbkdf2_hmac_supported(algorithm)
diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst
deleted file mode 100644
index 63e734c6..00000000
--- a/docs/hazmat/bindings/commoncrypto.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. hazmat::
-
-CommonCrypto binding
-====================
-
-.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
-
-.. versionadded:: 0.2
-
-These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is only
-available on macOS versions 10.8 and above.
-
-.. class:: cryptography.hazmat.bindings.commoncrypto.binding.Binding()
-
- This is the exposed API for the CommonCrypto bindings. It has two public
- attributes:
-
- .. attribute:: ffi
-
- This is a ``cffi.FFI`` instance. It can be used to allocate and
- otherwise manipulate CommonCrypto structures.
-
- .. attribute:: lib
-
- This is a ``cffi`` library. It can be used to call CommonCrypto
- functions, and access constants.
-
-
-.. _`CFFI`: https://cffi.readthedocs.io
-.. _`CommonCrypto`: https://developer.apple.com/library/content/documentation/Security/Conceptual/cryptoservices/GeneralPurposeCrypto/GeneralPurposeCrypto.html#//apple_ref/doc/uid/TP40011172-CH9-SW10
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst
index 8075be14..655f4620 100644
--- a/docs/hazmat/bindings/index.rst
+++ b/docs/hazmat/bindings/index.rst
@@ -20,4 +20,3 @@ Individual bindings
:maxdepth: 1
openssl
- commoncrypto