diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-05-09 13:08:01 -0700 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-05-09 13:08:01 -0700 |
| commit | 155856477a250a8bcfec71cb5ae472a1384fcd0a (patch) | |
| tree | 8767f9dcf3d342e27ab9001d1879f93a5d8f6e7a /docs | |
| parent | bb06ac3513261d7654b3472543762cb8fb9a8dca (diff) | |
| parent | c929e40631c6bfe048e4ed43ca6102d932fa153e (diff) | |
| download | cryptography-155856477a250a8bcfec71cb5ae472a1384fcd0a.tar.gz cryptography-155856477a250a8bcfec71cb5ae472a1384fcd0a.tar.bz2 cryptography-155856477a250a8bcfec71cb5ae472a1384fcd0a.zip | |
Merge pull request #1031 from reaperhulk/rsa-docs-fix
Improve RSABackend interface docs (fixes #1022)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/backends/interfaces.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index f363b541..1e1a6b28 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -275,6 +275,14 @@ A specific ``backend`` may provide one or more of these interfaces. :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding` provider. + :return bytes: The decrypted data. + + :raises cryptography.exceptions.UnsupportedAlgorithm: If an unsupported + MGF, hash function, or padding is chosen. + + :raises ValueError: When decryption fails or key size does not match + ciphertext length. + .. method:: encrypt_rsa(public_key, plaintext, padding) :param public_key: An instance of an @@ -287,6 +295,12 @@ A specific ``backend`` may provide one or more of these interfaces. :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricPadding` provider. + :return bytes: The encrypted data. + + :raises cryptography.exceptions.UnsupportedAlgorithm: If an unsupported + MGF, hash function, or padding is chosen. + + :raises ValueError: When plaintext is too long for the key size. .. class:: TraditionalOpenSSLSerializationBackend |