diff options
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 58 |
1 files changed, 6 insertions, 52 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 0995489f..86a3a7e4 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -1,5 +1,7 @@ .. hazmat:: +.. module:: cryptography.hazmat.primitives.interfaces + Interfaces ========== @@ -15,9 +17,6 @@ to document argument and return types. Symmetric ciphers ----------------- -.. currentmodule:: cryptography.hazmat.primitives.interfaces - - .. class:: CipherAlgorithm A named symmetric encryption algorithm. @@ -75,9 +74,10 @@ Interfaces used by the symmetric cipher modes described in meets any necessary invariants. This should raise an exception if they are not met. - For example, the :class:`~cryptography.hazmat.primitives.modes.CBC` - mode uses this method to check that the provided initialization - vector's length matches the block size of the algorithm. + For example, the + :class:`~cryptography.hazmat.primitives.ciphers.modes.CBC` mode uses + this method to check that the provided initialization vector's length + matches the block size of the algorithm. .. class:: ModeWithInitializationVector @@ -160,52 +160,6 @@ In 0.8 the EC key interfaces were moved to the :mod:`cryptography.hazmat.primitives.asymmetric.ec` module. -Hash algorithms ---------------- - -.. class:: HashAlgorithm - - .. attribute:: name - - :type: str - - The standard name for the hash algorithm, for example: ``"sha256"`` or - ``"whirlpool"``. - - .. attribute:: digest_size - - :type: int - - The size of the resulting digest in bytes. - - .. attribute:: block_size - - :type: int - - The internal block size of the hash algorithm in bytes. - - -.. class:: HashContext - - .. attribute:: algorithm - - A :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` that - will be used by this context. - - .. method:: update(data) - - :param bytes data: The data you want to hash. - - .. method:: finalize() - - :return: The final digest as bytes. - - .. method:: copy() - - :return: A :class:`~cryptography.hazmat.primitives.interfaces.HashContext` - that is a copy of the current context. - - Key derivation functions ------------------------ |