aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2024-01-25 13:09:27 -0800
committerGitHub <noreply@github.com>2024-01-25 21:09:27 +0000
commit3da3a3703bef1772b08bfc7da4b9221b5592f506 (patch)
treeb3da53e9ae5f2f7dcb4db090bf222e14ff7b7a8a /docs
parent08b24d87a64734ac7f5c575b309ad7d49c246353 (diff)
downloadpyca-cryptography-3da3a3703bef1772b08bfc7da4b9221b5592f506.zip
pyca-cryptography-3da3a3703bef1772b08bfc7da4b9221b5592f506.tar.gz
pyca-cryptography-3da3a3703bef1772b08bfc7da4b9221b5592f506.tar.bz2
support bytes-like consistently across our asym sign/verify APIs (#10260)
and update our docs to show it as well
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst9
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst9
-rw-r--r--docs/hazmat/primitives/asymmetric/ed25519.rst9
-rw-r--r--docs/hazmat/primitives/asymmetric/ed448.rst9
4 files changed, 24 insertions, 12 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
index bcd4c99..b159a09 100644
--- a/docs/hazmat/primitives/asymmetric/dsa.rst
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -289,7 +289,8 @@ Key interfaces
Sign one block of data which can be verified later by others using the
public key.
- :param bytes data: The message string to sign.
+ :param data: The message string to sign.
+ :type data: :term:`bytes-like`
:param algorithm: An instance of
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` or
@@ -391,9 +392,11 @@ Key interfaces
Verify one block of data was signed by the private key
associated with this public key.
- :param bytes signature: The signature to verify.
+ :param signature: The signature to verify.
+ :type signature: :term:`bytes-like`
- :param bytes data: The message string that was signed.
+ :param data: The message string that was signed.
+ :type data: :term:`bytes-like`
:param algorithm: An instance of
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` or
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst
index 561218c..75165b6 100644
--- a/docs/hazmat/primitives/asymmetric/ec.rst
+++ b/docs/hazmat/primitives/asymmetric/ec.rst
@@ -569,7 +569,8 @@ Key Interfaces
Sign one block of data which can be verified later by others using the
public key.
- :param bytes data: The message string to sign.
+ :param data: The message string to sign.
+ :type data: :term:`bytes-like`
:param signature_algorithm: An instance of
:class:`EllipticCurveSignatureAlgorithm`, such as :class:`ECDSA`.
@@ -678,12 +679,14 @@ Key Interfaces
Verify one block of data was signed by the private key associated
with this public key.
- :param bytes signature: The DER-encoded signature to verify.
+ :param signature: The DER-encoded signature to verify.
A raw signature may be DER-encoded by splitting it into the ``r``
and ``s`` components and passing them into
:func:`~cryptography.hazmat.primitives.asymmetric.utils.encode_dss_signature`.
+ :type signature: :term:`bytes-like`
- :param bytes data: The message string that was signed.
+ :param data: The message string that was signed.
+ :type data: :term:`bytes-like`
:param signature_algorithm: An instance of
:class:`EllipticCurveSignatureAlgorithm`.
diff --git a/docs/hazmat/primitives/asymmetric/ed25519.rst b/docs/hazmat/primitives/asymmetric/ed25519.rst
index 1ca06fc..8d4b910 100644
--- a/docs/hazmat/primitives/asymmetric/ed25519.rst
+++ b/docs/hazmat/primitives/asymmetric/ed25519.rst
@@ -67,7 +67,8 @@ Key interfaces
.. method:: sign(data)
- :param bytes data: The data to sign.
+ :param data: The data to sign.
+ :type data: :term:`bytes-like`
:returns bytes: The 64 byte signature.
@@ -192,9 +193,11 @@ Key interfaces
.. method:: verify(signature, data)
- :param bytes signature: The signature to verify.
+ :param signature: The signature to verify.
+ :type signature: :term:`bytes-like`
- :param bytes data: The data to verify.
+ :param data: The data to verify.
+ :type data: :term:`bytes-like`
:returns: None
:raises cryptography.exceptions.InvalidSignature: Raised when the
diff --git a/docs/hazmat/primitives/asymmetric/ed448.rst b/docs/hazmat/primitives/asymmetric/ed448.rst
index efe245d..27a8092 100644
--- a/docs/hazmat/primitives/asymmetric/ed448.rst
+++ b/docs/hazmat/primitives/asymmetric/ed448.rst
@@ -47,7 +47,8 @@ Key interfaces
.. method:: sign(data)
- :param bytes data: The data to sign.
+ :param data: The data to sign.
+ :type data: :term:`bytes-like`
:returns bytes: The 114 byte signature.
@@ -146,9 +147,11 @@ Key interfaces
.. method:: verify(signature, data)
- :param bytes signature: The signature to verify.
+ :param signature: The signature to verify.
+ :type signature: :term:`bytes-like`
- :param bytes data: The data to verify.
+ :param data: The data to verify.
+ :type data: :term:`bytes-like`
:returns: None
:raises cryptography.exceptions.InvalidSignature: Raised when the