diff options
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/primitives/constant-time.rst | 5 | ||||
| -rw-r--r-- | docs/hazmat/primitives/cryptographic-hashes.rst | 4 | ||||
| -rw-r--r-- | docs/hazmat/primitives/key-derivation-functions.rst | 20 | ||||
| -rw-r--r-- | docs/hazmat/primitives/mac/cmac.rst | 9 | ||||
| -rw-r--r-- | docs/hazmat/primitives/mac/hmac.rst | 9 | ||||
| -rw-r--r-- | docs/hazmat/primitives/padding.rst | 4 |
6 files changed, 16 insertions, 35 deletions
diff --git a/docs/hazmat/primitives/constant-time.rst b/docs/hazmat/primitives/constant-time.rst index 3296dbde..1394b6b3 100644 --- a/docs/hazmat/primitives/constant-time.rst +++ b/docs/hazmat/primitives/constant-time.rst @@ -36,9 +36,8 @@ about the timing attacks on KeyCzar and Java's ``MessageDigest.isEqual()``. :param bytes b: The right-hand side. :returns bool: ``True`` if ``a`` has the same bytes as ``b``, otherwise ``False``. - :raises TypeError: This exception is raised if ``a`` or ``b`` is not a - binary type. This is ``str`` in Python 2 and ``bytes`` - in Python 3. + :raises TypeError: This exception is raised if ``a`` or ``b`` is not + ``bytes``. .. _`Coda Hale's blog post`: http://codahale.com/a-lesson-in-timing-attacks/ diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst index 43dee3f3..7e5295c4 100644 --- a/docs/hazmat/primitives/cryptographic-hashes.rst +++ b/docs/hazmat/primitives/cryptographic-hashes.rst @@ -54,9 +54,7 @@ Message digests :param bytes data: The bytes to be hashed. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`. - :raises TypeError: This exception is raised if ``data`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``data`` is not ``bytes``. .. method:: copy() diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst index c9c0c3cc..f68b12c1 100644 --- a/docs/hazmat/primitives/key-derivation-functions.rst +++ b/docs/hazmat/primitives/key-derivation-functions.rst @@ -88,9 +88,7 @@ Different KDFs are suitable for different tasks such as: provided ``backend`` does not implement :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend` - :raises TypeError: This exception is raised if ``salt`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``salt`` is not ``bytes``. .. method:: derive(key_material) @@ -104,8 +102,7 @@ Different KDFs are suitable for different tasks such as: once. :raises TypeError: This exception is raised if ``key_material`` is not - a binary type. This is ``str`` in Python 2 and - ``bytes`` in Python 3. + ``bytes``. This generates and returns a new key from the supplied password. @@ -200,16 +197,14 @@ Different KDFs are suitable for different tasks such as: :class:`~cryptography.hazmat.backends.interfaces.HMACBackend` :raises TypeError: This exception is raised if ``salt`` or ``info`` is not - a binary type. This is ``str`` in Python 2 and ``bytes`` - in Python 3. + ``bytes``. .. method:: derive(key_material) :param bytes key_material: The input key material. :return bytes: The derived key. :raises TypeError: This exception is raised if ``key_material`` is not - a binary type. This is ``str`` in Python 2 and - ``bytes`` in Python 3. + ``bytes``. Derives a new key from the input key material by performing both the extract and expand operations. @@ -292,9 +287,7 @@ Different KDFs are suitable for different tasks such as: provided ``backend`` does not implement :class:`~cryptography.hazmat.backends.interfaces.HMACBackend` :raises TypeError: This is raised if the provided ``info`` is a unicode object - :raises TypeError: This exception is raised if ``info`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``info`` is not ``bytes``. .. method:: derive(key_material) @@ -304,8 +297,7 @@ Different KDFs are suitable for different tasks such as: :raises TypeError: This is raised if the provided ``key_material`` is a unicode object :raises TypeError: This exception is raised if ``key_material`` is not - a binary type. This is ``str`` in Python 2 and - ``bytes`` in Python 3. + ``bytes``. Derives a new key from the input key material by performing both the extract and expand operations. diff --git a/docs/hazmat/primitives/mac/cmac.rst b/docs/hazmat/primitives/mac/cmac.rst index 86c3b6a9..23b1fea2 100644 --- a/docs/hazmat/primitives/mac/cmac.rst +++ b/docs/hazmat/primitives/mac/cmac.rst @@ -68,9 +68,7 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`. :param bytes data: The bytes to hash and authenticate. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` - :raises TypeError: This exception is raised if ``data`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``data`` is not ``bytes``. .. method:: copy() @@ -92,9 +90,8 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` :raises cryptography.exceptions.InvalidSignature: If signature does not match digest - :raises TypeError: This exception is raised if ``signature`` is not a - binary type. This is ``str`` in Python 2 and - ``bytes`` in Python 3. + :raises TypeError: This exception is raised if ``signature`` is not + ``bytes``. .. method:: finalize() diff --git a/docs/hazmat/primitives/mac/hmac.rst b/docs/hazmat/primitives/mac/hmac.rst index 0fc4a19a..d56927b9 100644 --- a/docs/hazmat/primitives/mac/hmac.rst +++ b/docs/hazmat/primitives/mac/hmac.rst @@ -69,9 +69,7 @@ of a message. :param bytes msg: The bytes to hash and authenticate. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` - :raises TypeError: This exception is raised if ``msg`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``msg`` is not ``bytes``. .. method:: copy() @@ -93,9 +91,8 @@ of a message. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` :raises cryptography.exceptions.InvalidSignature: If signature does not match digest - :raises TypeError: This exception is raised if ``signature`` is not a - binary type. This is ``str`` in Python 2 and - ``bytes`` in Python 3. + :raises TypeError: This exception is raised if ``signature`` is not + ``bytes``. .. method:: finalize() diff --git a/docs/hazmat/primitives/padding.rst b/docs/hazmat/primitives/padding.rst index 72378e1f..0322f9d2 100644 --- a/docs/hazmat/primitives/padding.rst +++ b/docs/hazmat/primitives/padding.rst @@ -70,9 +70,7 @@ multiple of the block size. :return bytes: Returns the data that was padded or unpadded. :raises TypeError: Raised if data is not bytes. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`. - :raises TypeError: This exception is raised if ``data`` is not a binary - type. This is ``str`` in Python 2 and ``bytes`` in - Python 3. + :raises TypeError: This exception is raised if ``data`` is not ``bytes``. .. method:: finalize() |