aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-03-29 21:35:06 -0500
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-03-29 21:35:06 -0500
commita7f6edfb9d26d81c748a71bfd64f179f3633af28 (patch)
tree59752c3adf605f5cf7076e72c333a1d58a9547f6 /docs
parent323ef6c708456951da6f8373330de6b007db73b9 (diff)
parent24171ccb2ca5fad010fd1839fc7cde62e847b980 (diff)
downloadcryptography-a7f6edfb9d26d81c748a71bfd64f179f3633af28.tar.gz
cryptography-a7f6edfb9d26d81c748a71bfd64f179f3633af28.tar.bz2
cryptography-a7f6edfb9d26d81c748a71bfd64f179f3633af28.zip
Merge pull request #868 from skeuomorf/dsa-parameters
Add DSA parameters api, docs and tests
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst29
-rw-r--r--docs/hazmat/primitives/asymmetric/index.rst1
2 files changed, 30 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
new file mode 100644
index 00000000..c9fd2f55
--- /dev/null
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -0,0 +1,29 @@
+.. hazmat::
+
+DSA
+===
+
+.. currentmodule:: cryptography.hazmat.primitives.asymmetric.dsa
+
+`DSA`_ is a `public-key`_ algorithm for signing messages.
+
+.. class:: DSAParameters(modulus, subgroup_order, generator)
+
+ .. versionadded:: 0.4
+
+ DSA Parameters are required for generating a DSA private key.
+
+ This class conforms to the
+ :class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`
+ interface.
+
+ :raises TypeError: This is raised when the arguments are not all integers.
+
+ :raises ValueError: This is raised when the values of ``modulus``,
+ ``subgroup_order``, or ``generator`` do
+ not match the bounds specified in `FIPS 186-4`_.
+
+
+.. _`DSA`: https://en.wikipedia.org/wiki/Digital_Signature_Algorithm
+.. _`public-key`: https://en.wikipedia.org/wiki/Public-key_cryptography
+.. _`FIPS 186-4`: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf
diff --git a/docs/hazmat/primitives/asymmetric/index.rst b/docs/hazmat/primitives/asymmetric/index.rst
index 7ec1c5f2..ca048d11 100644
--- a/docs/hazmat/primitives/asymmetric/index.rst
+++ b/docs/hazmat/primitives/asymmetric/index.rst
@@ -6,5 +6,6 @@ Asymmetric algorithms
.. toctree::
:maxdepth: 1
+ dsa
rsa
padding