diff options
| author | David Reid <dreid@dreid.org> | 2013-11-15 16:19:50 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2013-11-15 16:19:50 -0800 |
| commit | 0a394df31c4165d0230843ebea2717b3cd3caafa (patch) | |
| tree | 5c674a900d0f7465cde2796b9bba21a87d67b56e /docs | |
| parent | 9489c769dbd7ea7c6830b5fcd70095818452e607 (diff) | |
| download | cryptography-0a394df31c4165d0230843ebea2717b3cd3caafa.tar.gz cryptography-0a394df31c4165d0230843ebea2717b3cd3caafa.tar.bz2 cryptography-0a394df31c4165d0230843ebea2717b3cd3caafa.zip | |
Implement and document an interface for cipher algorithms
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/primitives/interfaces.rst | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst index 7068316e..11cff51a 100644 --- a/docs/hazmat/primitives/interfaces.rst +++ b/docs/hazmat/primitives/interfaces.rst @@ -12,11 +12,33 @@ to document argument and return types. .. _`Abstract Base Classes`: http://docs.python.org/3.2/library/abc.html -Cipher Modes -~~~~~~~~~~~~ +Symmetric Ciphers +~~~~~~~~~~~~~~~~~ .. currentmodule:: cryptography.hazmat.primitives.interfaces + +.. 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. + + +Cipher Modes +------------ + Interfaces used by the symmetric cipher modes described in :ref:`Symmetric Encryption Modes <symmetric-encryption-modes>`. |
