diff options
| -rw-r--r-- | cryptography/hazmat/primitives/interfaces.py | 14 | ||||
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 87 |
2 files changed, 99 insertions, 2 deletions
diff --git a/cryptography/hazmat/primitives/interfaces.py b/cryptography/hazmat/primitives/interfaces.py index f270cc5a..5bca9c52 100644 --- a/cryptography/hazmat/primitives/interfaces.py +++ b/cryptography/hazmat/primitives/interfaces.py @@ -508,7 +508,17 @@ class EllipticCurve(object): @six.add_metaclass(abc.ABCMeta) class EllipticCurveSignatureAlgorithm(object): - pass + @abc.abstractmethod + def signer(self, private_key, algorithm, backend): + """ + Returns an AsymmetricSignatureContext used for signing data. + """ + + @abc.abstractmethod + def verifier(self, public_key, algorithm, backend): + """ + Returns an AsymmetricVerificationContext used for signing data. + """ @six.add_metaclass(abc.ABCMeta) @@ -561,7 +571,7 @@ class EllipticCurvePublicKey(object): @abc.abstractmethod def verifier(self, signature_algorithm, digest_algorithm, backend): """ - Returns an AsymmetricSignatureContext used for signing data. + Returns an AsymmetricVerificationContext used for signing data. """ @abc.abstractproperty diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 6ec6de62..e53c6099 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -483,6 +483,54 @@ Asymmetric interfaces The bit length of the curves base point. +.. class:: EllipticCurveSignatureAlgorithm + + .. versionadded:: 0.4 + + A signature algorithm for use with elliptic curve keys. + + .. method:: signer(private_key, algorithm, backend) + + Sign data which can be verified later by others using the public key. + + :param private_key: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePrivateKey` + provider. + + :param algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider. + + :param backend: A + :class:`~cryptography.hazmat.backends.interfaces.RSABackend` + provider. + + :returns: + :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` + + .. method:: verifier(public_key, algorithm, backend) + + Verify data was signed by the private key associated with this public + key. + + :param bytes signature: The signature to verify. + + :param public_key: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicKey` + provider. + + :param algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider. + + :param backend: A + :class:`~cryptography.hazmat.backends.interfaces.RSABackend` + provider. + + :returns: + :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext` + + .. class:: EllipticCurvePrivateKey .. versionadded:: 0.4 @@ -490,6 +538,25 @@ Asymmetric interfaces An elliptic curve private key for use with an algorithm such as `ECDSA`_ or `EdDSA`_. + .. classmethod:: signer(signature_algorithm, digest_algorithm, backend) + + Sign data which can be verified later by others using the public key. + + :param signature_algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurveSignatureAlgorithm` + provider. + + :param digest_algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider. + + :param backend: A + :class:`~cryptography.hazmat.backends.interfaces.RSABackend` + provider. + + :returns: + :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` + .. attribute:: curve :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` @@ -533,6 +600,26 @@ Asymmetric interfaces An elliptic curve public key. + .. classmethod:: verifier(signature_algorithm, digest_algorithm, backend) + + Verify data was signed by the private key associated with this public + key. + + :param signature_algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurveSignatureAlgorithm` + provider. + + :param digest_algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider. + + :param backend: A + :class:`~cryptography.hazmat.backends.interfaces.RSABackend` + provider. + + :returns: + :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` + .. attribute:: curve :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` |