aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Stasiak <jakub@stasiak.at>2020-05-25 20:13:35 +0200
committerGitHub <noreply@github.com>2020-05-25 13:13:35 -0500
commit27f04412b5874374f00aab388c9a8c37d257f1ef (patch)
tree190dc5016645579a710a33a8e0a231aa061d3b42
parenteceea9d912994dbd84bfc7b27031c1254e675e28 (diff)
downloadcryptography-27f04412b5874374f00aab388c9a8c37d257f1ef.tar.gz
cryptography-27f04412b5874374f00aab388c9a8c37d257f1ef.tar.bz2
cryptography-27f04412b5874374f00aab388c9a8c37d257f1ef.zip
Document that Fernet accepts text keys (#5255)
Keys are passed to base64.urlsafe_b64decode for decoding and it accepts text as well as bytes.
-rw-r--r--docs/fernet.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/fernet.rst b/docs/fernet.rst
index 9b95621e..c01d18ca 100644
--- a/docs/fernet.rst
+++ b/docs/fernet.rst
@@ -23,9 +23,10 @@ has support for implementing key rotation via :class:`MultiFernet`.
>>> f.decrypt(token)
b'my deep dark secret'
- :param bytes key: A URL-safe base64-encoded 32-byte key. This **must** be
- kept secret. Anyone with this key is able to create and
- read messages.
+ :param key: A URL-safe base64-encoded 32-byte key. This **must** be
+ kept secret. Anyone with this key is able to create and
+ read messages.
+ :type key: bytes or str
.. classmethod:: generate_key()