diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2023-01-08 21:59:47 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-08 08:59:47 -0500 |
| commit | 5c48b8917a2f327a197f2abbbe38f76fb38d7f01 (patch) | |
| tree | 2cd50a03937c256bae49a97f29613a204c67d04c /docs | |
| parent | f7f33fb6763cebe93f240ec7367287215d4275d1 (diff) | |
| download | cryptography-5c48b8917a2f327a197f2abbbe38f76fb38d7f01.tar.gz | |
more rigorously document that our verify methods return none (#8010)
they raise an exception!
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/dsa.rst | 1 | ||||
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/ec.rst | 1 | ||||
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/ed25519.rst | 1 | ||||
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/ed448.rst | 1 | ||||
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/rsa.rst | 1 |
5 files changed, 5 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst index 69f128ba1..8bfe815bb 100644 --- a/docs/hazmat/primitives/asymmetric/dsa.rst +++ b/docs/hazmat/primitives/asymmetric/dsa.rst @@ -408,6 +408,7 @@ Key interfaces :class:`~cryptography.hazmat.primitives.asymmetric.utils.Prehashed` if the ``data`` you want to sign has already been hashed. + :returns: None :raises cryptography.exceptions.InvalidSignature: If the signature does not validate. diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 95244c2eb..dd95f223d 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -715,6 +715,7 @@ Key Interfaces :param signature_algorithm: An instance of :class:`EllipticCurveSignatureAlgorithm`. + :returns: None :raises cryptography.exceptions.InvalidSignature: If the signature does not validate. diff --git a/docs/hazmat/primitives/asymmetric/ed25519.rst b/docs/hazmat/primitives/asymmetric/ed25519.rst index 3229f0932..17ebe2778 100644 --- a/docs/hazmat/primitives/asymmetric/ed25519.rst +++ b/docs/hazmat/primitives/asymmetric/ed25519.rst @@ -169,6 +169,7 @@ Key interfaces :param bytes data: The data to verify. + :returns: None :raises cryptography.exceptions.InvalidSignature: Raised when the signature cannot be verified. diff --git a/docs/hazmat/primitives/asymmetric/ed448.rst b/docs/hazmat/primitives/asymmetric/ed448.rst index fb79dcb61..d20fe7389 100644 --- a/docs/hazmat/primitives/asymmetric/ed448.rst +++ b/docs/hazmat/primitives/asymmetric/ed448.rst @@ -123,6 +123,7 @@ Key interfaces :param bytes data: The data to verify. + :returns: None :raises cryptography.exceptions.InvalidSignature: Raised when the signature cannot be verified. diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst index 0bf4c0291..7291e8c5b 100644 --- a/docs/hazmat/primitives/asymmetric/rsa.rst +++ b/docs/hazmat/primitives/asymmetric/rsa.rst @@ -729,6 +729,7 @@ Key interfaces :class:`~cryptography.hazmat.primitives.asymmetric.utils.Prehashed` if the ``data`` you want to verify has already been hashed. + :returns: None :raises cryptography.exceptions.InvalidSignature: If the signature does not validate. |