aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/interfaces.rst
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-05-17 16:50:11 +0100
committerAlex Stapleton <alexs@prol.etari.at>2014-05-31 22:28:48 +0100
commit13f1d8dfd7c216177c605341aa9a180ff813bd19 (patch)
tree4704f794fb34759dbeadb3ed8390dcd5455b8064 /docs/hazmat/backends/interfaces.rst
parentd9488d06859da184eedf97f9021a45f3b708fe7b (diff)
downloadcryptography-13f1d8dfd7c216177c605341aa9a180ff813bd19.tar.gz
cryptography-13f1d8dfd7c216177c605341aa9a180ff813bd19.tar.bz2
cryptography-13f1d8dfd7c216177c605341aa9a180ff813bd19.zip
EllipticCurveBackend interfaces
Diffstat (limited to 'docs/hazmat/backends/interfaces.rst')
-rw-r--r--docs/hazmat/backends/interfaces.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 6f24f906..c1ce621a 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -476,3 +476,54 @@ A specific ``backend`` may provide one or more of these interfaces.
:raises cryptography.exceptions.UnsupportedAlgorithm: If the data is
encrypted with an unsupported algorithm.
+
+
+.. class:: EllipticCurveBackend
+
+ .. versionadded:: 0.5
+
+ .. method:: elliptic_curve_supported(curve)
+
+ :param curve: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve`
+ provider.
+
+ :returns: True if the elliptic curve is supported by this backend.
+
+ .. method:: elliptic_curve_signature_algorithm_supported(signature_algorithm, curve)
+
+ :param signature_algorithm: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurveSignatureAlgorithm`
+ provider.
+
+ :param curve: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve`
+ provider.
+
+ :returns: True if the signature algorithm and curve are supported by this backend.
+
+ .. method:: generate_elliptic_curve_private_key(curve)
+
+ :param curve: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve`
+ provider.
+
+ .. method:: elliptic_curve_private_key_from_numbers(numbers)
+
+ :param numbers: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePrivateNumbers`
+ provider.
+
+ :returns: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePrivateKey`
+ provider.
+
+ .. method:: elliptic_curve_public_key_from_numbers(numbers)
+
+ :param numbers: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicNumbers`
+ provider.
+
+ :returns: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicKey`
+ provider.