aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-02-18 14:57:27 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2014-02-18 14:57:27 -0800
commitf8cf48bb4a751451ebb7571e91e1eda3b7345e88 (patch)
tree85137c3db5c7f895516d5d7d031c30f6c61cb5cd /docs
parent788147d4e3f085362c7151e1b202aa4bb90fce69 (diff)
parentd883cd2f13187a4d1054c543872677b5ca4ffb2c (diff)
downloadcryptography-f8cf48bb4a751451ebb7571e91e1eda3b7345e88.tar.gz
cryptography-f8cf48bb4a751451ebb7571e91e1eda3b7345e88.tar.bz2
cryptography-f8cf48bb4a751451ebb7571e91e1eda3b7345e88.zip
Merge pull request #634 from reaperhulk/rsa-signing-interfaces
RSA Sign/Verify Interfaces
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/backends/interfaces.rst36
-rw-r--r--docs/hazmat/primitives/interfaces.rst33
2 files changed, 69 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index e6bf8f69..bd38ed50 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -212,3 +212,39 @@ A specific ``backend`` may provide one or more of these interfaces.
provider.
:raises ValueError: If the public_exponent is not valid.
+
+ .. method:: create_rsa_signature_ctx(private_key, padding, algorithm)
+
+ :param private_key: An instance of an
+ :class:`~cryptography.hazmat.primitives.interfaces.RSAPrivateKey`
+ provider.
+
+ :param padding: An instance of an
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ provider.
+
+ :param algorithm: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
+ provider.
+
+ :returns:
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
+
+ .. method:: create_rsa_verification_ctx(public_key, signature, padding, algorithm)
+
+ :param public_key: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.RSAPublicKey`
+ provider.
+
+ :param bytes signature: The signature to verify.
+
+ :param padding: An instance of an
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding`
+ provider.
+
+ :param algorithm: An instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
+ provider.
+
+ :returns:
+ :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext`
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index df17e59d..5be3dd95 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -231,6 +231,39 @@ Asymmetric Interfaces
The public exponent. Alias for :attr:`public_exponent`.
+.. class:: AsymmetricSignatureContext
+
+ .. versionadded:: 0.2
+
+ .. method:: update(data)
+
+ :param bytes data: The data you want to sign.
+
+ .. method:: finalize()
+
+ :return bytes signature: The signature.
+
+
+.. class:: AsymmetricVerificationContext
+
+ .. versionadded:: 0.2
+
+ .. method:: update(data)
+
+ :param bytes data: The data you wish to verify using the signature.
+
+ .. method:: verify()
+
+ :raises cryptography.exceptions.InvalidSignature: If signature does not
+ validate.
+
+
+.. class:: AsymmetricPadding
+
+ .. versionadded:: 0.2
+
+ .. attribute:: name
+
Hash Algorithms
~~~~~~~~~~~~~~~