aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/asymmetric
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2015-02-13 08:20:35 -0500
committerAlex Gaynor <alex.gaynor@gmail.com>2015-02-13 08:20:35 -0500
commit723cc3f2ed921c01168ea8f35ca7e94f2cc0a44b (patch)
treef265ae766459b1f02cf4fd952db5f043402387c8 /docs/hazmat/primitives/asymmetric
parent731f4296de1eceee149bf2003b780c2e33f8bde3 (diff)
parenta10be69304b3c0dc61689487075b6ddd31a2823b (diff)
downloadcryptography-723cc3f2ed921c01168ea8f35ca7e94f2cc0a44b.tar.gz
cryptography-723cc3f2ed921c01168ea8f35ca7e94f2cc0a44b.tar.bz2
cryptography-723cc3f2ed921c01168ea8f35ca7e94f2cc0a44b.zip
Merge pull request #1654 from reaperhulk/make-docs-nitpicky
make our docs job nitpicky and fix every broken link
Diffstat (limited to 'docs/hazmat/primitives/asymmetric')
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst2
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst2
-rw-r--r--docs/hazmat/primitives/asymmetric/rsa.rst10
-rw-r--r--docs/hazmat/primitives/asymmetric/serialization.rst14
4 files changed, 14 insertions, 14 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
index ff934a6a..59c0d973 100644
--- a/docs/hazmat/primitives/asymmetric/dsa.rst
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -3,7 +3,7 @@
DSA
===
-.. currentmodule:: cryptography.hazmat.primitives.asymmetric.dsa
+.. module:: cryptography.hazmat.primitives.asymmetric.dsa
`DSA`_ is a `public-key`_ algorithm for signing messages.
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst
index 4b8177ea..caa3f285 100644
--- a/docs/hazmat/primitives/asymmetric/ec.rst
+++ b/docs/hazmat/primitives/asymmetric/ec.rst
@@ -3,7 +3,7 @@
Elliptic curve cryptography
===========================
-.. currentmodule:: cryptography.hazmat.primitives.asymmetric.ec
+.. module:: cryptography.hazmat.primitives.asymmetric.ec
.. function:: generate_private_key(curve, backend)
diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst
index c37961eb..e516f749 100644
--- a/docs/hazmat/primitives/asymmetric/rsa.rst
+++ b/docs/hazmat/primitives/asymmetric/rsa.rst
@@ -3,7 +3,7 @@
RSA
===
-.. currentmodule:: cryptography.hazmat.primitives.asymmetric.rsa
+.. module:: cryptography.hazmat.primitives.asymmetric.rsa
`RSA`_ is a `public-key`_ algorithm for encrypting and signing messages.
@@ -307,7 +307,7 @@ is unavailable.
.. attribute:: public_numbers
- :type: :class:`~cryptography.hazmat.primitives.rsa.RSAPublicNumbers`
+ :type: :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicNumbers`
The :class:`RSAPublicNumbers` which makes up the RSA public key
associated with this RSA private key.
@@ -316,19 +316,19 @@ is unavailable.
:type: int
- ``p``, one of the two primes composing the :attr:`modulus`.
+ ``p``, one of the two primes composing ``n``.
.. attribute:: q
:type: int
- ``q``, one of the two primes composing the :attr:`modulus`.
+ ``q``, one of the two primes composing ``n``.
.. attribute:: d
:type: int
- The private exponent. Alias for :attr:`private_exponent`.
+ The private exponent.
.. attribute:: dmp1
diff --git a/docs/hazmat/primitives/asymmetric/serialization.rst b/docs/hazmat/primitives/asymmetric/serialization.rst
index 7ff4ce30..8155e6f4 100644
--- a/docs/hazmat/primitives/asymmetric/serialization.rst
+++ b/docs/hazmat/primitives/asymmetric/serialization.rst
@@ -104,9 +104,9 @@ all begin with ``-----BEGIN {format}-----`` and end with ``-----END
not encrypted. Or if the key was encrypted but no
password was supplied.
- :raises UnsupportedAlgorithm: If the serialized key is of a type that
- is not supported by the backend or if the key is encrypted with a
- symmetric cipher that is not supported by the backend.
+ :raises cryptography.exceptions.UnsupportedAlgorithm: If the serialized key
+ is of a type that is not supported by the backend or if the key is
+ encrypted with a symmetric cipher that is not supported by the backend.
.. function:: load_pem_public_key(data, backend)
@@ -133,8 +133,8 @@ all begin with ``-----BEGIN {format}-----`` and end with ``-----END
:raises ValueError: If the PEM data's structure could not be decoded
successfully.
- :raises UnsupportedAlgorithm: If the serialized key is of a type that
- is not supported by the backend.
+ :raises cryptography.exceptions.UnsupportedAlgorithm: If the serialized key
+ is of a type that is not supported by the backend.
OpenSSH Public Key
@@ -181,5 +181,5 @@ DSA keys look almost identical but begin with ``ssh-dss`` rather than
:raises ValueError: If the OpenSSH data could not be properly decoded or
if the key is not in the proper format.
- :raises UnsupportedAlgorithm: If the serialized key is of a type that is
- not supported.
+ :raises cryptography.exceptions.UnsupportedAlgorithm: If the serialized
+ key is of a type that is not supported.