diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-03-04 18:54:47 -0430 | 
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-03-04 18:54:47 -0430 | 
| commit | 826b374c5707294681ccc920e35e1dbbdd02febe (patch) | |
| tree | 8ae41679bea4d093a8b34e999b0cd78777f6b200 /docs | |
| parent | aee8b1aee873f125ba6fad172c2fcbe205fe8fe4 (diff) | |
| parent | 29aa3aad4405f90c98ff7498718d1cca91fe7c8b (diff) | |
| download | cryptography-826b374c5707294681ccc920e35e1dbbdd02febe.tar.gz cryptography-826b374c5707294681ccc920e35e1dbbdd02febe.tar.bz2 cryptography-826b374c5707294681ccc920e35e1dbbdd02febe.zip | |
Merge pull request #719 from skeuomorf/master
Add DSA interfaces
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 108 | 
1 files changed, 108 insertions, 0 deletions
| diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 15ad1d1b..cc2a3000 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:: DSAParameters + +    .. versionadded:: 0.3 + +    `DSA`_ parameters. + +    .. attribute:: modulus + +        :type: int + +        The prime modulus that is used in generating the DSA key pair and used +        in the DSA signing and verification processes. + +    .. attribute:: subgroup_order + +        :type: int + +        The subgroup order that is used in generating the DSA key pair +        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 key pair and used +        in the DSA signing and verification processes. + +    .. attribute:: p + +        :type: int + +        The prime modulus that is used in generating the DSA key pair and used +        in the DSA signing and verification processes. Alias for :attr:`modulus`. + +    .. attribute:: q + +        :type: int + +        The subgroup order that is used in generating the DSA key pair +        by the generator and used in the DSA signing and verification +        processes. Alias for :attr:`subgroup_order`. + +    .. attribute:: g + +        :type: int + +        The generator that is used in generating the DSA key pair and used +        in the DSA signing and verification processes. Alias for :attr:`generator`. + + +.. class:: DSAPrivateKey + +    .. versionadded:: 0.3 + +    A `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.DSAParameters` + +        The DSAParameters 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 + +    A `DSA`_ private key. + +    .. method:: parameters() + +        :return: :class:`~cryptography.hazmat.primitives.interfaces.DSAParameters` + +        The DSAParameters object associated with this public key. + +    .. attribute:: y + +        :type: int + +        The public key. + +  .. class:: AsymmetricSignatureContext      .. versionadded:: 0.2 @@ -335,3 +442,4 @@ Key Derivation Functions  .. _`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 | 
