diff options
| author | Alex Stapleton <alexs@prol.etari.at> | 2014-04-20 16:44:26 +0100 |
|---|---|---|
| committer | Alex Stapleton <alexs@prol.etari.at> | 2014-05-23 21:05:47 +0100 |
| commit | 80228a19eaeebb3d9f46faccc2679ba0ef2b09ae (patch) | |
| tree | 68bf27310889cd8e52bc7ff524b36ea4c522a145 /docs | |
| parent | 69579ffe94195df7d23f5291c631a9f0e3f6a7c2 (diff) | |
| download | cryptography-80228a19eaeebb3d9f46faccc2679ba0ef2b09ae.tar.gz cryptography-80228a19eaeebb3d9f46faccc2679ba0ef2b09ae.tar.bz2 cryptography-80228a19eaeebb3d9f46faccc2679ba0ef2b09ae.zip | |
Update docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 32 |
1 files changed, 12 insertions, 20 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index e53c6099..d7f3298b 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -489,7 +489,13 @@ Asymmetric interfaces A signature algorithm for use with elliptic curve keys. - .. method:: signer(private_key, algorithm, backend) + .. attribute:: algorithm + + :type: :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + + The digest algorithm to be used with the signature scheme. + + .. method:: signer(private_key, backend) Sign data which can be verified later by others using the public key. @@ -497,10 +503,6 @@ Asymmetric interfaces :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. @@ -508,7 +510,7 @@ Asymmetric interfaces :returns: :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` - .. method:: verifier(public_key, algorithm, backend) + .. method:: verifier(signature, public_key, backend) Verify data was signed by the private key associated with this public key. @@ -519,10 +521,6 @@ Asymmetric interfaces :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. @@ -538,7 +536,7 @@ Asymmetric interfaces An elliptic curve private key for use with an algorithm such as `ECDSA`_ or `EdDSA`_. - .. classmethod:: signer(signature_algorithm, digest_algorithm, backend) + .. classmethod:: signer(signature_algorithm, backend) Sign data which can be verified later by others using the public key. @@ -546,10 +544,6 @@ Asymmetric interfaces :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. @@ -600,19 +594,17 @@ Asymmetric interfaces An elliptic curve public key. - .. classmethod:: verifier(signature_algorithm, digest_algorithm, backend) + .. classmethod:: verifier(signer, signature_algorithm, backend) Verify data was signed by the private key associated with this public key. + :param bytes signature: The signature to verify. + :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. |