aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/interfaces.rst
diff options
context:
space:
mode:
authorMohammed Attia <skeuomorf@gmail.com>2014-03-04 03:29:56 +0200
committerMohammed Attia <skeuomorf@gmail.com>2014-03-04 03:29:56 +0200
commitb416715b8ee96c445587d444a4684bc7817e4638 (patch)
tree277166117208a1e2a37e69fac554cf9dcf199aea /docs/hazmat/primitives/interfaces.rst
parentdada0f8e13ac12a97b75acb68cc3d4cefca2f398 (diff)
downloadcryptography-b416715b8ee96c445587d444a4684bc7817e4638.tar.gz
cryptography-b416715b8ee96c445587d444a4684bc7817e4638.tar.bz2
cryptography-b416715b8ee96c445587d444a4684bc7817e4638.zip
Added documentation for the DSA interfaces
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r--docs/hazmat/primitives/interfaces.rst107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index 15ad1d1b..b119bc5b 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -231,6 +231,113 @@ Asymmetric Interfaces
The public exponent. Alias for :attr:`public_exponent`.
+.. class:: DSAParams
+
+ .. versionadded:: 0.3
+
+ `DSA`_ parameters.
+
+ .. attribute:: modulus
+
+ :type: int
+
+ The prime modulus that's used in generating the DSA keypair and used
+ in the DSA signing and verification processes.
+
+ .. attribute:: subgroup_order
+
+ :type: int
+
+ The subgroup order that's used in generating the DSA keypair
+ by the generator and used in the DSA signing and verification
+ processes.
+
+ .. attribute:: generator
+
+ :type: int
+
+ The generator that is used in generating the DSA keypair and used
+ in the DSA signing and verification processes."
+
+ .. attribute:: p
+
+ :type: int
+
+ The prime modulus that's used in generating the DSA keypair and used
+ in the DSA signing and verification processes. Alias for modulus.
+
+ .. attribute:: q
+
+ :type: int
+
+ The subgroup order that's used in generating the DSA keypair
+ by the generator and used in the DSA signing and verification
+ processes. Alias for subgroup_order.
+
+ .. attribute:: g
+
+ :type: int
+
+ The generator that is used in generating the DSA keypair and used
+ in the DSA signing and verification processes. Alias for generator.
+
+
+.. class:: DSAPrivateKey
+
+ .. versionadded:: 0.3
+
+ An `DSA`_ private key.
+
+ .. method:: public_key()
+
+ :return: :class:`~cryptography.hazmat.primitives.interfaces.DSAPublicKey`
+
+ An DSA public key object corresponding to the values of the private key.
+
+ .. method:: parameters()
+
+ :return: :class:`~cryptography.hazmat.primitives.interfaces.DSAParams`
+
+ The DSAParams object associated with this private key.
+
+ .. attribute:: key_size
+
+ :type: int
+
+ The bit length of the modulus.
+
+ .. attribute:: x
+
+ :type: int
+
+ The private key.
+
+ .. attribute:: y
+
+ :type: int
+
+ The public key.
+
+
+.. class:: DSAPublicKey
+
+ .. versionadded:: 0.3
+
+ An `DSA`_ private key.
+
+ .. method:: parameters()
+
+ :return: :class:`~cryptography.hazmat.primitives.interfaces.DSAParams`
+
+ The DSAParams object associated with this public key.
+
+ .. attribute:: y
+
+ :type: int
+
+ The public key.
+
+
.. class:: AsymmetricSignatureContext
.. versionadded:: 0.2