From 23a6266ac6a763f07ce397af0c1957cc124e7f81 Mon Sep 17 00:00:00 2001 From: Alex Stapleton Date: Fri, 16 May 2014 22:43:40 +0100 Subject: Add docs for EC numbers --- docs/hazmat/primitives/asymmetric/ec.rst | 51 ++++++++++++++++++++++++++++++++ docs/hazmat/primitives/interfaces.rst | 30 ------------------- 2 files changed, 51 insertions(+), 30 deletions(-) create mode 100644 docs/hazmat/primitives/asymmetric/ec.rst (limited to 'docs/hazmat') diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst new file mode 100644 index 00000000..44c24d7f --- /dev/null +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -0,0 +1,51 @@ +.. hazmat:: + +Elliptic Curve +============== + +.. currentmodule:: cryptography.hazmat.primitives.asymmetric.ec + + +.. class:: EllipticCurvePrivateNumbers + + .. versionadded:: 0.5 + + The collection of integers that make up an EC private key. + + .. attribute:: public_numbers + + :type: :class:`~cryptography.hazmat.primitives.ec.EllipticCurvePublicNumbers` + + The :class:`EllipticCurvePublicNumbers` which makes up the EC public + key associated with this EC private key. + + .. attribute:: private_key + + :type: int + + The private key. + + +.. class:: EllipticCurvePublicNumbers + + .. versionadded:: 0.5 + + The collection of integers that make up an EC public key. + + .. attribute:: curve + + :type: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurve` + + The elliptic curve for this key. + + .. attribute:: x + + :type: int + + The affine x component of the public point used for verifying. + + .. attribute:: y + + :type: int + + The affine y component of the public point used for verifying. diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 9a957cc2..f4597fbf 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -524,30 +524,12 @@ Asymmetric interfaces The elliptic curve for this key. - .. attribute:: private_key - - :type: int - - The private key. - .. attribute:: key_size :type: int The bit length of the curves base point. - .. attribute:: x - - :type: int - - The affine x component of the public point used for verifying. - - .. attribute:: y - - :type: int - - The affine y component of the public point used for verifying. - .. method:: public_key() :return: :class:`~cryptography.hazmat.primitives.interfaces.EllipticCurvePublicKey` @@ -585,18 +567,6 @@ Asymmetric interfaces The elliptic curve for this key. - .. attribute:: x - - :type: int - - The affine x component of the public point used for verifying. - - .. attribute:: y - - :type: int - - The affine y component of the public point used for verifying. - .. attribute:: key_size :type: int -- cgit v1.2.3