diff options
author | Alex Stapleton <alexs@prol.etari.at> | 2015-02-12 14:21:52 +0000 |
---|---|---|
committer | Alex Stapleton <alexs@prol.etari.at> | 2015-02-12 14:21:52 +0000 |
commit | b41c80b0cfa4fd9a14016c81557776cc01feedba (patch) | |
tree | be07a4e4aad4c57715410ea680a7008a841ee8ef /docs/hazmat/primitives/interfaces.rst | |
parent | dff7e721394ea77e0ed61e320dbefb5fe4f954a3 (diff) | |
parent | fb88e187c1fcc9992923c31d476a3c705ed1b1e4 (diff) | |
download | cryptography-b41c80b0cfa4fd9a14016c81557776cc01feedba.tar.gz cryptography-b41c80b0cfa4fd9a14016c81557776cc01feedba.tar.bz2 cryptography-b41c80b0cfa4fd9a14016c81557776cc01feedba.zip |
Merge pull request #1652 from reaperhulk/move-ec
Move EC interface definitions
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 129 |
1 files changed, 2 insertions, 127 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index bd329b98..0995489f 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -152,132 +152,12 @@ RSA In 0.8 the RSA key interfaces were moved to the :mod:`cryptography.hazmat.primitives.asymmetric.rsa` module. -.. class:: EllipticCurve - - .. versionadded:: 0.5 - - A named elliptic curve. - - .. attribute:: name - - :type: string - - The name of the curve. Usually the name used for the ASN.1 OID such as - ``secp256k1``. - - .. attribute:: key_size - - :type: int - - The bit length of the curve's base point. - Elliptic Curve ~~~~~~~~~~~~~~ -.. class:: EllipticCurveSignatureAlgorithm - - .. versionadded:: 0.5 - - A signature algorithm for use with elliptic curve keys. - - .. attribute:: algorithm - - :type: :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` - - The digest algorithm to be used with the signature scheme. - - -.. class:: EllipticCurvePrivateKey - - .. versionadded:: 0.5 - - An elliptic curve private key for use with an algorithm such as `ECDSA`_ or - `EdDSA`_. - - .. 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` - provider. - - :returns: - :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` - - - :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` - - .. method:: public_key() - - :return: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicKey` - - The EllipticCurvePublicKey object for this private key. - - -.. class:: EllipticCurvePrivateKeyWithNumbers - - .. versionadded:: 0.6 - - Extends :class:`EllipticCurvePrivateKey`. - - .. method:: private_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateNumbers` - object. - - :returns: An - :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateNumbers` - instance. - - -.. class:: EllipticCurvePublicKey - - .. versionadded:: 0.5 - - An elliptic curve public key. - - .. method:: verifier(signature, signature_algorithm) - - Verify data was signed by the private key associated with this public - key. - - :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` - provider. - - :returns: - :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext` - - .. attribute:: curve - - :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` - - The elliptic curve for this key. - - -.. class:: EllipticCurvePublicKeyWithNumbers - - .. versionadded:: 0.6 - - Extends :class:`EllipticCurvePublicKey`. - - .. method:: public_numbers() - - Create a - :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicNumbers` - object. - - :returns: An - :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicNumbers` - instance. +In 0.8 the EC key interfaces were moved to the +:mod:`cryptography.hazmat.primitives.asymmetric.ec` module. Hash algorithms @@ -419,9 +299,4 @@ Key derivation functions the provided signature does not match the expected signature. -.. _`RSA`: https://en.wikipedia.org/wiki/RSA_(cryptosystem) -.. _`Chinese remainder theorem`: https://en.wikipedia.org/wiki/Chinese_remainder_theorem -.. _`DSA`: https://en.wikipedia.org/wiki/Digital_Signature_Algorithm .. _`CMAC`: https://en.wikipedia.org/wiki/CMAC -.. _`ECDSA`: https://en.wikipedia.org/wiki/ECDSA -.. _`EdDSA`: https://en.wikipedia.org/wiki/EdDSA |