diff options
| author | David Reid <dreid@dreid.org> | 2014-04-15 16:06:25 -0400 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2014-04-15 16:06:25 -0400 |
| commit | 1eab656b3fd5537630500a0d6d35fbb157b4c95c (patch) | |
| tree | 99709197a0e80a7264728abe9d0d50a0c858600e /docs | |
| parent | 99335fe99038c020d557deb8160e0575c04e155b (diff) | |
| parent | 96c9981e8e4867610216890d9386ee2d8f12e6dd (diff) | |
| download | cryptography-1eab656b3fd5537630500a0d6d35fbb157b4c95c.tar.gz cryptography-1eab656b3fd5537630500a0d6d35fbb157b4c95c.tar.bz2 cryptography-1eab656b3fd5537630500a0d6d35fbb157b4c95c.zip | |
Merge pull request #923 from reaperhulk/rsa-interface-docs
Add missing sign/verify/generate docs for the RSA interfaces
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index cdb925ee..f4fb8ded 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -112,6 +112,27 @@ Asymmetric interfaces An `RSA`_ private key. + .. method:: signer(padding, algorithm, backend) + + .. versionadded:: 0.3 + + Sign data which can be verified later by others using the public key. + + :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` + .. method:: public_key() :return: :class:`~cryptography.hazmat.primitives.interfaces.RSAPublicKey` @@ -200,6 +221,31 @@ Asymmetric interfaces An `RSA`_ public key. + .. method:: verifier(signature, padding, algorithm, backend) + + .. versionadded:: 0.3 + + Verify data was signed by the private key associated with this public + key. + + :param bytes signature: The signature to verify. + + :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.AsymmetricVerificationContext` + + .. attribute:: modulus :type: int |