diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-08 07:35:26 -0700 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-08 07:35:26 -0700 |
| commit | 0ca7fdbd09184648939214ccdc83675b112e86c9 (patch) | |
| tree | f843fb46edae1904234439cf8242f9f514177ede /docs/primitives | |
| parent | f6c47e9eacdcd096b5d112d73b96f7e84f908f61 (diff) | |
| download | cryptography-0ca7fdbd09184648939214ccdc83675b112e86c9.tar.gz cryptography-0ca7fdbd09184648939214ccdc83675b112e86c9.tar.bz2 cryptography-0ca7fdbd09184648939214ccdc83675b112e86c9.zip | |
Begin to describe the methods
Diffstat (limited to 'docs/primitives')
| -rw-r--r-- | docs/primitives/symmetric-encryption.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/primitives/symmetric-encryption.rst b/docs/primitives/symmetric-encryption.rst index acb5fc17..cf92437a 100644 --- a/docs/primitives/symmetric-encryption.rst +++ b/docs/primitives/symmetric-encryption.rst @@ -20,3 +20,11 @@ or GCM). A simple example of encrypting content with AES is: # The ciphertext [...] +Here ``key`` is the encryption key (which must be kept secret), and ``iv`` is +the initialization vector (which should be random). Exactly what form these +values should take is described for each of the ciphers and modes. + +``encrypt()`` should be called repeatedly with additional plaintext, and it +will return the encrypted bytes, if there isn't enough data, it will buffer it +internally. ``finalize()`` should be called at the end, and will return +whatever data is left. |