diff options
author | Aviv Palivoda <palaviv@gmail.com> | 2016-07-02 19:43:06 +0300 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2016-07-02 12:43:06 -0400 |
commit | 2120a8e090ff8974d727f76aae5f2f9eac56656c (patch) | |
tree | c79d3eaac5584d05bead50f516e5f5dac0cd4bea /docs/hazmat/primitives | |
parent | 14a9ad4c35a625088339e2e142907243adfffa99 (diff) | |
download | cryptography-2120a8e090ff8974d727f76aae5f2f9eac56656c.tar.gz cryptography-2120a8e090ff8974d727f76aae5f2f9eac56656c.tar.bz2 cryptography-2120a8e090ff8974d727f76aae5f2f9eac56656c.zip |
One shot sign/verification ECDSA (#3029)
* Add sign and verify methods to ECDSA
* Documented ECDSA sign/verify methods
* Added CHANGELOG entry
* Skipping test verify and sign if curve is not supported
* Fixed typo in documentation return type
* Removed provider language from EllipticCurvePrivateKey and EllipticCurvePublicKey
Diffstat (limited to 'docs/hazmat/primitives')
-rw-r--r-- | docs/hazmat/primitives/asymmetric/dsa.rst | 2 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/ec.rst | 49 |
2 files changed, 46 insertions, 5 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst index 7ab79f8c..f77af2a2 100644 --- a/docs/hazmat/primitives/asymmetric/dsa.rst +++ b/docs/hazmat/primitives/asymmetric/dsa.rst @@ -322,7 +322,7 @@ Key interfaces :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` provider. - :return: bytes: Signature. + :return bytes: Signature. .. class:: DSAPrivateKeyWithSerialization diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 2c59374a..979d3e4b 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -48,6 +48,16 @@ Elliptic Curve Signature Algorithms >>> signer.update(b" to sign") >>> signature = signer.finalize() + There is a shortcut to sign sufficiently short messages directly: + + .. doctest:: + + >>> data = b"this is some data I'd like to sign" + >>> signature = private_key.sign( + ... data, + ... ec.ECDSA(hashes.SHA256()) + ... ) + The ``signature`` is a ``bytes`` object, whose contents is DER encoded as described in :rfc:`3279`. This can be decoded using :func:`~cryptography.hazmat.primitives.asymmetric.utils.decode_dss_signature`. @@ -371,8 +381,8 @@ Key Interfaces The signature is formatted as DER-encoded bytes, as specified in :rfc:`3279`. - :param signature_algorithm: An instance of a - :class:`EllipticCurveSignatureAlgorithm` provider. + :param signature_algorithm: An instance of + :class:`EllipticCurveSignatureAlgorithm`. :returns: :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricSignatureContext` @@ -401,6 +411,20 @@ Key Interfaces The EllipticCurvePublicKey object for this private key. + .. method:: sign(data, signature_algorithm) + + .. versionadded:: 1.5 + + Sign one block of data which can be verified later by others using the + public key. + + :param bytes data: The message string to sign. + + :param signature_algorithm: An instance of + :class:`EllipticCurveSignatureAlgorithm`. + + :return bytes: Signature. + .. class:: EllipticCurvePrivateKeyWithSerialization @@ -455,8 +479,8 @@ Key Interfaces :param bytes signature: The signature to verify. DER encoded as specified in :rfc:`3279`. - :param signature_algorithm: An instance of a - :class:`EllipticCurveSignatureAlgorithm` provider. + :param signature_algorithm: An instance of + :class:`EllipticCurveSignatureAlgorithm`. :returns: :class:`~cryptography.hazmat.primitives.asymmetric.AsymmetricVerificationContext` @@ -490,6 +514,23 @@ Key Interfaces :return bytes: Serialized key. + .. method:: verify(signature, data, signature_algorithm) + + .. versionadded:: 1.5 + + Verify one block of data was signed by the private key associated + with this public key. + + :param bytes signature: The signature to verify. + + :param bytes data: The message string that was signed. + + :param signature_algorithm: An instance of + :class:`EllipticCurveSignatureAlgorithm`. + + :raises cryptography.exceptions.InvalidSignature: If the signature does + not validate. + .. class:: EllipticCurvePublicKeyWithSerialization |