summaryrefslogtreecommitdiff
path: root/doc/reference.rst
diff options
context:
space:
mode:
authorSybren A. Stüvel <sybren@stuvel.eu>2017-04-10 11:31:09 +0200
committerSybren A. Stüvel <sybren@stuvel.eu>2017-04-10 11:33:37 +0200
commit1d14c4e6c6c78acb2af553cdbc4fe23fc72024b9 (patch)
treeaffca546b73e086411e97999e5a52d10519b31d3 /doc/reference.rst
parent88927a9fcf3f93475e640ce9b5a04cd7c2dfc405 (diff)
downloadrsa-git-1d14c4e6c6c78acb2af553cdbc4fe23fc72024b9.tar.gz
Updated documentation for removal of bigfile/VARBLOCK support.
Diffstat (limited to 'doc/reference.rst')
-rw-r--r--doc/reference.rst22
1 files changed, 1 insertions, 21 deletions
diff --git a/doc/reference.rst b/doc/reference.rst
index d1b0b6d..d81f742 100644
--- a/doc/reference.rst
+++ b/doc/reference.rst
@@ -49,32 +49,13 @@ Exceptions
.. index:: VARBLOCK (file format)
-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.
-
-.. autofunction:: rsa.bigfile.encrypt_bigfile
-
-.. autofunction:: rsa.bigfile.decrypt_bigfile
-
-.. _VARBLOCK:
-
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
+ Python-RSA 3.4, and was removed in version 4.0. 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
@@ -109,4 +90,3 @@ the core of the entire library.
.. autofunction:: rsa.core.encrypt_int
.. autofunction:: rsa.core.decrypt_int
-