diff options
author | Donald Stufft <donald@stufft.io> | 2013-11-17 10:52:33 -0800 |
---|---|---|
committer | Donald Stufft <donald@stufft.io> | 2013-11-17 10:52:33 -0800 |
commit | 4a28d323b1227860da118a933d5f4940acaef999 (patch) | |
tree | e354636fdb891044548a3bb7042a253bfa97a616 /docs/hazmat | |
parent | 83e0e1f00224c1f995298226c2e0837d555af67c (diff) | |
parent | 0a394df31c4165d0230843ebea2717b3cd3caafa (diff) | |
download | cryptography-4a28d323b1227860da118a933d5f4940acaef999.tar.gz cryptography-4a28d323b1227860da118a933d5f4940acaef999.tar.bz2 cryptography-4a28d323b1227860da118a933d5f4940acaef999.zip |
Merge pull request #262 from dreid/cipher-algorithm-interfaces
Implement and document an interface for cipher algorithms
Diffstat (limited to 'docs/hazmat')
-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>`. |