aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-02-25 13:56:53 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-02-25 13:56:53 -0600
commit62a9217aa3f6cf34d4cafcd1d147082bc7c7918c (patch)
tree4d447e448c5af00afc338013dc171182524eb9e0
parentc5b4d7239614ce3718a05601184276ca2691c84e (diff)
downloadcryptography-62a9217aa3f6cf34d4cafcd1d147082bc7c7918c.tar.gz
cryptography-62a9217aa3f6cf34d4cafcd1d147082bc7c7918c.tar.bz2
cryptography-62a9217aa3f6cf34d4cafcd1d147082bc7c7918c.zip
reorganize docs slightly
-rw-r--r--docs/hazmat/primitives/asymmetric/rsa.rst36
1 files changed, 21 insertions, 15 deletions
diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst
index 64928878..682820b3 100644
--- a/docs/hazmat/primitives/asymmetric/rsa.rst
+++ b/docs/hazmat/primitives/asymmetric/rsa.rst
@@ -54,20 +54,7 @@ RSA
.. versionadded:: 0.3
- :param padding: An instance of a
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
- provider.
-
- :param algorithm: An instance of a
- :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
- provider.
-
- :param backend: A
- :class:`~cryptography.hazmat.backends.interfaces.RSABackend`
- provider.
-
- :returns:
- :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+ Sign data which can be verified later by others using the public key.
.. doctest::
@@ -79,11 +66,30 @@ RSA
... key_size=2048,
... backend=default_backend()
... )
- >>> signer = private_key.signer(padding.PKCS1v15(), hashes.SHA256(), default_backend())
+ >>> signer = private_key.signer(
+ ... padding.PKCS1v15(),
+ ... hashes.SHA256(),
+ ... default_backend()
+ ... )
>>> signer.update(b"this is some data I'd like")
>>> signer.update(b" to sign")
>>> signature = signer.finalize()
+ :param padding: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ provider.
+
+ :param algorithm: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
+ provider.
+
+ :param backend: A
+ :class:`~cryptography.hazmat.backends.interfaces.RSABackend`
+ provider.
+
+ :returns:
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+
.. class:: RSAPublicKey(public_exponent, modulus)