diff options
| author | David Reid <dreid@dreid.org> | 2013-11-02 23:16:33 -0700 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2013-11-02 23:16:33 -0700 |
| commit | d4e98f8d552843c371600c88e1cdab94678081a9 (patch) | |
| tree | 5699ddce355497cbb6890e9c55013d64e7cfc9d8 /docs | |
| parent | 178f6f19a611219f27a0b4e1837134b308de08d2 (diff) | |
| parent | 3949f1171084c2e1cfe43f638857ea0e0f8f246d (diff) | |
| download | cryptography-d4e98f8d552843c371600c88e1cdab94678081a9.tar.gz cryptography-d4e98f8d552843c371600c88e1cdab94678081a9.tar.bz2 cryptography-d4e98f8d552843c371600c88e1cdab94678081a9.zip | |
Merge pull request #215 from alex/unsupported-cipher
Document and implement the public API for when the backend doesn't suppo...
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/exceptions.rst | 9 | ||||
| -rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
3 files changed, 19 insertions, 0 deletions
diff --git a/docs/exceptions.rst b/docs/exceptions.rst new file mode 100644 index 00000000..6ac11b3c --- /dev/null +++ b/docs/exceptions.rst @@ -0,0 +1,9 @@ +Exceptions +========== + +.. currentmodule:: cryptography.exceptions + +.. class:: UnsupportedAlgorithm + + This is raised when a backend doesn't support the requested algorithm (or + combination of algorithms). diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index b8b1c839..c1c8d247 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -42,12 +42,21 @@ where the encrypter and decrypter both use the same key. :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` provider. + If the backend doesn't support the requested combination of ``cipher`` + and ``mode`` an :class:`cryptography.exceptions.UnsupportedAlgorithm` + will be raised. + .. method:: decryptor() :return: A decrypting :class:`~cryptography.hazmat.primitives.interfaces.CipherContext` provider. + If the backend doesn't support the requested combination of ``cipher`` + and ``mode`` an :class:`cryptography.exceptions.UnsupportedAlgorithm` + will be raised. + + .. currentmodule:: cryptography.hazmat.primitives.interfaces .. class:: CipherContext diff --git a/docs/index.rst b/docs/index.rst index 4fd5d3be..eb30b5dd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,6 +31,7 @@ Contents :maxdepth: 2 architecture + exceptions contributing security community |