diff options
| author | David Reid <dreid@dreid.org> | 2014-11-17 11:09:27 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2014-11-17 11:09:27 -0800 |
| commit | 97758a795c3aa3d57d91aec8f674de7b914e4339 (patch) | |
| tree | e71fa9f4ba94ea6eadb41e99ec7530e87d7c161b | |
| parent | b581cc6a7abe8a8e6d487535dbf78453833fc34d (diff) | |
| parent | 93f135ad8a967c34e08fc7524e5c7d15bce77280 (diff) | |
| download | cryptography-97758a795c3aa3d57d91aec8f674de7b914e4339.tar.gz cryptography-97758a795c3aa3d57d91aec8f674de7b914e4339.tar.bz2 cryptography-97758a795c3aa3d57d91aec8f674de7b914e4339.zip | |
Merge pull request #1477 from alex/improve-docs
Improved the interface docs for DSA and ECDSA signatures
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 4cb64c83..4f185af3 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -334,6 +334,8 @@ DSA .. versionadded:: 0.4 Sign data which can be verified later by others using the public key. + The signature is formatted as DER-encoded bytes, as specified in + :rfc:`6979`. :param algorithm: An instance of a :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` @@ -470,8 +472,11 @@ Elliptic Curve An elliptic curve private key for use with an algorithm such as `ECDSA`_ or `EdDSA`_. - .. classmethod:: signer(signature_algorithm) + .. method:: signer(signature_algorithm) + Sign data which can be verified later by others using the public key. + The signature is formatted as DER-encoded bytes, as specified in + :rfc:`6979`. :param signature_algorithm: An instance of a :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurveSignatureAlgorithm` @@ -483,8 +488,6 @@ Elliptic Curve :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` - The elliptic curve for this key. - .. method:: public_key() :return: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicKey` @@ -519,7 +522,8 @@ Elliptic Curve Verify data was signed by the private key associated with this public key. - :param bytes signature: The signature to verify. + :param bytes signature: The signature to verify. DER encoded as + specified in :rfc:`6979`. :param signature_algorithm: An instance of a :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurveSignatureAlgorithm` |