aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/asymmetric/ec.rst
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-05-16 22:43:40 +0100
committerAlex Stapleton <alexs@prol.etari.at>2014-05-23 21:05:47 +0100
commit23a6266ac6a763f07ce397af0c1957cc124e7f81 (patch)
treeffe53abd93c7f6dedbb8885d9f52e24bbbb04523 /docs/hazmat/primitives/asymmetric/ec.rst
parentfc7e24aafc8de687c97c6416758b462b411d20fc (diff)
downloadcryptography-23a6266ac6a763f07ce397af0c1957cc124e7f81.tar.gz
cryptography-23a6266ac6a763f07ce397af0c1957cc124e7f81.tar.bz2
cryptography-23a6266ac6a763f07ce397af0c1957cc124e7f81.zip
Add docs for EC numbers
Diffstat (limited to 'docs/hazmat/primitives/asymmetric/ec.rst')
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst51
1 files changed, 51 insertions, 0 deletions
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.