aboutsummaryrefslogtreecommitdiffstats
path: root/docs/fernet.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-11-22 10:25:13 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-11-22 10:25:13 -0800
commit36597b4379bd62e520b9076072a030c73b85f471 (patch)
treebe6b32dc7ed2d1092dcf902223461d8fc904d90d /docs/fernet.rst
parent7a121fce784efb6d436816d84ed01e873f251490 (diff)
downloadcryptography-36597b4379bd62e520b9076072a030c73b85f471.tar.gz
cryptography-36597b4379bd62e520b9076072a030c73b85f471.tar.bz2
cryptography-36597b4379bd62e520b9076072a030c73b85f471.zip
An API for generating keys
Diffstat (limited to 'docs/fernet.rst')
-rw-r--r--docs/fernet.rst13
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/fernet.rst b/docs/fernet.rst
index c95077bb..241bf1ea 100644
--- a/docs/fernet.rst
+++ b/docs/fernet.rst
@@ -3,13 +3,6 @@ Fernet
.. currentmodule:: cryptography.fernet
-.. testsetup::
-
- import base64
- import binascii
- key = base64.urlsafe_b64encode(binascii.unhexlify(b"0" * 64))
-
-
`Fernet`_ is an implementation of symmetric (also known as "secret key")
authenticated cryptography. Fernet provides guarantees that a message encrypted
using it cannot be manipulated or read without the key.
@@ -21,6 +14,7 @@ using it cannot be manipulated or read without the key.
.. doctest::
>>> from cryptography.fernet import Fernet
+ >>> key = Fernet.generate_key()
>>> f = Fernet(key)
>>> ciphertext = f.encrypt(b"my deep dark secret")
>>> ciphertext
@@ -32,6 +26,11 @@ using it cannot be manipulated or read without the key.
kept secret. Anyone with this key is able to create and
read messages.
+ .. classmethod:: generate_key()
+
+ Generates a fresh fernet key. Keep this some place safe! If you lose it
+ you'll no longer be able to decrypt messages; if anyone else gains
+ access to it, they'll be able to decrypt all of your messages.
.. method:: encrypt(plaintext)