Rename and document
diff --git a/cryptography/hazmat/backends/__init__.py b/cryptography/hazmat/backends/__init__.py
index 0818033..41d260a 100644
--- a/cryptography/hazmat/backends/__init__.py
+++ b/cryptography/hazmat/backends/__init__.py
@@ -12,7 +12,7 @@
# limitations under the License.
from cryptography.hazmat.backends import openssl
-from cryptography.hazmat.backends.multibackend import PrioritizedMultiBackend
+from cryptography.hazmat.backends.multibackend import MultiBackend
from cryptography.hazmat.bindings.commoncrypto.binding import (
Binding as CommonCryptoBinding
)
@@ -24,7 +24,7 @@
_ALL_BACKENDS.append(commoncrypto.backend)
-_default_backend = PrioritizedMultiBackend(_ALL_BACKENDS)
+_default_backend = MultiBackend(_ALL_BACKENDS)
def default_backend():
diff --git a/cryptography/hazmat/backends/multibackend.py b/cryptography/hazmat/backends/multibackend.py
index 9415237..49a4014 100644
--- a/cryptography/hazmat/backends/multibackend.py
+++ b/cryptography/hazmat/backends/multibackend.py
@@ -24,7 +24,7 @@
@utils.register_interface(HashBackend)
@utils.register_interface(HMACBackend)
@utils.register_interface(PBKDF2HMACBackend)
-class PrioritizedMultiBackend(object):
+class MultiBackend(object):
name = "multibackend"
def __init__(self, backends):
diff --git a/docs/hazmat/backends/multibackend.rst b/docs/hazmat/backends/multibackend.rst
new file mode 100644
index 0000000..23e6d48
--- /dev/null
+++ b/docs/hazmat/backends/multibackend.rst
@@ -0,0 +1,14 @@
+.. hazmat::
+
+MultiBackend
+============
+
+.. currentmodule:: cryptography.hazmat.backends.multibackend
+
+.. class:: MultiBackend(backends)
+
+ This class allows you to combine multiple backends into a single backend
+ which offers the combined features of all of its constituents.
+
+ :param backends: A ``list`` of backend objects. Backends are checked for
+ feature support in the other they exist in this list.
diff --git a/tests/hazmat/backends/test_multibackend.py b/tests/hazmat/backends/test_multibackend.py
index f77d268..ca21c9f 100644
--- a/tests/hazmat/backends/test_multibackend.py
+++ b/tests/hazmat/backends/test_multibackend.py
@@ -18,7 +18,7 @@
from cryptography.hazmat.backends.interfaces import (
CipherBackend, HashBackend, HMACBackend, PBKDF2HMACBackend
)
-from cryptography.hazmat.backends.multibackend import PrioritizedMultiBackend
+from cryptography.hazmat.backends.multibackend import MultiBackend
from cryptography.hazmat.primitives import hashes, hmac
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
@@ -80,9 +80,9 @@
raise UnsupportedAlgorithm
-class TestPrioritizedMultiBackend(object):
+class TestMultiBackend(object):
def test_ciphers(self):
- backend = PrioritizedMultiBackend([
+ backend = MultiBackend([
DummyHashBackend([]),
DummyCipherBackend([
(algorithms.AES, modes.CBC),
@@ -111,7 +111,7 @@
cipher.decryptor()
def test_hashes(self):
- backend = PrioritizedMultiBackend([
+ backend = MultiBackend([
DummyHashBackend([hashes.MD5])
])
assert backend.hash_supported(hashes.MD5())
@@ -122,7 +122,7 @@
hashes.Hash(hashes.SHA1(), backend=backend)
def test_hmac(self):
- backend = PrioritizedMultiBackend([
+ backend = MultiBackend([
DummyHMACBackend([hashes.MD5])
])
assert backend.hmac_supported(hashes.MD5())
@@ -133,7 +133,7 @@
hmac.HMAC(b"", hashes.SHA1(), backend=backend)
def test_pbkdf2(self):
- backend = PrioritizedMultiBackend([
+ backend = MultiBackend([
DummyPBKDF2HMAC([hashes.MD5])
])
assert backend.pbkdf2_hmac_supported(hashes.MD5())