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 ++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/hazmat/primitives/asymmetric/ec.rst (limited to 'docs/hazmat/primitives/asymmetric') 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. -- cgit v1.2.3 From 3d643c57c219d9560890381561d831b789305c3c Mon Sep 17 00:00:00 2001 From: Alex Stapleton Date: Sat, 17 May 2014 16:59:58 +0100 Subject: Add __init__ arguments to docs --- docs/hazmat/primitives/asymmetric/ec.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 44c24d7f..4b0d30c5 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -6,7 +6,7 @@ Elliptic Curve .. currentmodule:: cryptography.hazmat.primitives.asymmetric.ec -.. class:: EllipticCurvePrivateNumbers +.. class:: EllipticCurvePrivateNumbers(private_key, public_numbers) .. versionadded:: 0.5 @@ -26,7 +26,7 @@ Elliptic Curve The private key. -.. class:: EllipticCurvePublicNumbers +.. class:: EllipticCurvePublicNumbers(x, y, curve) .. versionadded:: 0.5 -- cgit v1.2.3 From 81ce8ef0ad52edac1d252c9bc7485c79ba2fcec9 Mon Sep 17 00:00:00 2001 From: Alex Stapleton Date: Sat, 17 May 2014 20:08:44 +0100 Subject: Add EC docs to the index --- docs/hazmat/primitives/asymmetric/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/index.rst b/docs/hazmat/primitives/asymmetric/index.rst index 047f9cb9..6a5228ba 100644 --- a/docs/hazmat/primitives/asymmetric/index.rst +++ b/docs/hazmat/primitives/asymmetric/index.rst @@ -7,6 +7,7 @@ Asymmetric algorithms :maxdepth: 1 dsa + ec rsa padding serialization -- cgit v1.2.3 From a264eccab51b57422b99bd12d58a3f2a3f15ac1c Mon Sep 17 00:00:00 2001 From: Alex Stapleton Date: Sun, 18 May 2014 15:31:56 +0100 Subject: Rename private_key to private_value --- docs/hazmat/primitives/asymmetric/ec.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 4b0d30c5..f88b965a 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -6,7 +6,7 @@ Elliptic Curve .. currentmodule:: cryptography.hazmat.primitives.asymmetric.ec -.. class:: EllipticCurvePrivateNumbers(private_key, public_numbers) +.. class:: EllipticCurvePrivateNumbers(private_value, public_numbers) .. versionadded:: 0.5 @@ -19,11 +19,11 @@ Elliptic Curve The :class:`EllipticCurvePublicNumbers` which makes up the EC public key associated with this EC private key. - .. attribute:: private_key + .. attribute:: private_value :type: int - The private key. + The private value. .. class:: EllipticCurvePublicNumbers(x, y, curve) -- cgit v1.2.3