diff options
| author | Henry Turner <henryturner@me.com> | 2020-06-13 04:09:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-12 22:09:47 -0500 |
| commit | bf7def7424e597b3be2c84377aa0d210e3953c9a (patch) | |
| tree | 593faa066fc52b11d2021f0ea93dabf5d95c22ee | |
| parent | 9dd4e1f2ce885a08420c4036f81de6bbd36c8836 (diff) | |
| download | cryptography-bf7def7424e597b3be2c84377aa0d210e3953c9a.tar.gz cryptography-bf7def7424e597b3be2c84377aa0d210e3953c9a.tar.bz2 cryptography-bf7def7424e597b3be2c84377aa0d210e3953c9a.zip | |
Add missing exceptions to documentation in key derivation function primitives (#5271)
* Update key-derivation-functions.rst
Add missing exception to documentation
* Update key-derivation-functions.rst
Adding missing exception documentation for AlreadyFinalized to all the derive() functions missing it
* Removed trailing whitespace
| -rw-r--r-- | docs/hazmat/primitives/key-derivation-functions.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst index b5466240..4b474124 100644 --- a/docs/hazmat/primitives/key-derivation-functions.rst +++ b/docs/hazmat/primitives/key-derivation-functions.rst @@ -205,6 +205,11 @@ Different KDFs are suitable for different tasks such as: :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material by performing both the extract and expand operations. @@ -293,6 +298,11 @@ Different KDFs are suitable for different tasks such as: :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material by performing both the extract and expand operations. @@ -382,6 +392,11 @@ Different KDFs are suitable for different tasks such as: :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material. @@ -475,6 +490,11 @@ Different KDFs are suitable for different tasks such as: :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material. @@ -568,6 +588,11 @@ Different KDFs are suitable for different tasks such as: :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material. @@ -695,6 +720,11 @@ Different KDFs are suitable for different tasks such as: :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not ``bytes``. + :raises cryptography.exceptions.AlreadyFinalized: This is raised when + :meth:`derive` or + :meth:`verify` is + called more than + once. Derives a new key from the input key material. |