aboutsummaryrefslogtreecommitdiffstats
path: root/docs/fernet.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2017-05-27 15:11:24 -0500
committerAlex Gaynor <alex.gaynor@gmail.com>2017-05-27 16:11:24 -0400
commitafa84f10a2077b2365c30a133ae943e96c1c1ee8 (patch)
treeb6fc79dbd407ee8a22718a09115b1e29303a2260 /docs/fernet.rst
parent35acb37330e8d8e079b19d9fde2e16003f0defab (diff)
downloadcryptography-afa84f10a2077b2365c30a133ae943e96c1c1ee8.tar.gz
cryptography-afa84f10a2077b2365c30a133ae943e96c1c1ee8.tar.bz2
cryptography-afa84f10a2077b2365c30a133ae943e96c1c1ee8.zip
strongly encourage the use of fernet, document its limitation (#3623)
Diffstat (limited to 'docs/fernet.rst')
-rw-r--r--docs/fernet.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/fernet.rst b/docs/fernet.rst
index 0c1eb43d..65f70cf4 100644
--- a/docs/fernet.rst
+++ b/docs/fernet.rst
@@ -163,6 +163,13 @@ Specifically it uses:
For complete details consult the `specification`_.
+Limitations
+-----------
+
+Fernet is ideal for encrypting data that easily fits in memory. As a design
+feature it does not expose unauthenticated bytes. Unfortunately, this makes it
+generally unsuitable for very large files at this time.
+
.. _`Fernet`: https://github.com/fernet/spec/
.. _`specification`: https://github.com/fernet/spec/blob/master/Spec.md