diff options
Diffstat (limited to 'doc/reference.rst')
-rw-r--r-- | doc/reference.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/reference.rst b/doc/reference.rst index 53dee63..d80416a 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -44,6 +44,12 @@ Exceptions Module: rsa.bigfile -------------------------------------------------- +.. warning:: + + The :py:mod:`rsa.bigfile` module is NOT recommended for general use, has been + deprecated since Python-RSA 3.4, and will be removed in a future release. It's + vulnerable to a number of attacks. See :ref:`bigfiles` for more information. + The :py:mod:`rsa.bigfile` module contains functions for encrypting and decrypting files that are larger than the RSA key. See :ref:`bigfiles` for more information. @@ -57,6 +63,12 @@ decrypting files that are larger than the RSA key. See The VARBLOCK file format ++++++++++++++++++++++++++++++++++++++++++++++++++ +.. warning:: + + The VARBLOCK format is NOT recommended for general use, has been deprecated since + Python-RSA 3.4, and will be removed in a future release. It's vulnerable to a + number of attacks. See :ref:`bigfiles` for more information. + The VARBLOCK file format allows us to encrypt files that are larger than the RSA key. The format is as follows; || denotes byte string concatenation:: |