diff options
author | Alex Stapleton <alexs@prol.etari.at> | 2015-02-16 15:59:50 +0000 |
---|---|---|
committer | Alex Stapleton <alexs@prol.etari.at> | 2015-02-16 15:59:50 +0000 |
commit | 99c1b803aeb2260d8dbc131aca608276a714285c (patch) | |
tree | 979666c5fb3b4aca15549bb0bff09487956cacc7 /docs/hazmat/primitives/interfaces.rst | |
parent | ebc1717d73eaccffeddc32cee9eb0ad5936f7a4b (diff) | |
parent | 7c5c9fedd513f4ef66b62fcf5fdcde8dc30fe532 (diff) | |
download | cryptography-99c1b803aeb2260d8dbc131aca608276a714285c.tar.gz cryptography-99c1b803aeb2260d8dbc131aca608276a714285c.tar.bz2 cryptography-99c1b803aeb2260d8dbc131aca608276a714285c.zip |
Merge pull request #1659 from reaperhulk/move-cipher-interfaces
Move cipher and mode interfaces
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 86a3a7e4..67c6b3d5 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -14,95 +14,6 @@ to document argument and return types. .. _`Abstract Base Classes`: https://docs.python.org/3/library/abc.html -Symmetric ciphers ------------------ - -.. class:: CipherAlgorithm - - A named symmetric encryption algorithm. - - .. attribute:: name - - :type: str - - The standard name for the mode, for example, "AES", "Camellia", or - "Blowfish". - - .. attribute:: key_size - - :type: int - - The number of bits in the key being used. - - -.. class:: BlockCipherAlgorithm - - A block cipher algorithm. - - .. attribute:: block_size - - :type: int - - The number of bits in a block. - - -Cipher modes -~~~~~~~~~~~~ - -Interfaces used by the symmetric cipher modes described in -:ref:`Symmetric Encryption Modes <symmetric-encryption-modes>`. - -.. class:: Mode - - A named cipher mode. - - .. attribute:: name - - :type: str - - This should be the standard shorthand name for the mode, for example - Cipher-Block Chaining mode is "CBC". - - The name may be used by a backend to influence the operation of a - cipher in conjunction with the algorithm's name. - - .. method:: validate_for_algorithm(algorithm) - - :param CipherAlgorithm algorithm: - - Checks that the combination of this mode with the provided algorithm - meets any necessary invariants. This should raise an exception if they - are not met. - - 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 - - A cipher mode with an initialization vector. - - .. attribute:: initialization_vector - - :type: bytes - - Exact requirements of the initialization are described by the - documentation of individual modes. - - -.. class:: ModeWithNonce - - A cipher mode with a nonce. - - .. attribute:: nonce - - :type: bytes - - Exact requirements of the nonce are described by the documentation of - individual modes. - Asymmetric interfaces --------------------- |