aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-11-10 23:57:12 +0100
committerJay Berkenbilt <ejb@ql.org>2021-11-11 18:24:15 +0100
commit750aca5b94351f730fa768b07caa3fc26c8d27c0 (patch)
tree2f95b4770973da7f1fb530cb1b5c8dd7e25401e7 /README.md
parent37916f392568c84570ae0a6afb33a62d8c9e3a10 (diff)
downloadqpdf-750aca5b94351f730fa768b07caa3fc26c8d27c0.tar.zst
First increment of improving handling of weak crypto (fixes #358)
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index ceec231d..ff968dcb 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,10 @@ For example, if you want to guarantee that the GnuTLS crypto provider is used, y
Please see the section on crypto providers in the manual for more details.
+## Note about weak cryptographic algorithms
+
+The PDF file format used to rely on RC4 for encryption. Using 256-bit keys always uses AES instead, and with 128-bit keys, you can elect to use AES. qpdf does its best to warn when someone is writing a file with weak cryptographic algorithms, but qpdf must always retain support for being able to read and even write files with weak encryption to be able to fully support older PDF files and older PDF readers.
+
# Building from a pristine checkout
When building qpdf from a pristine checkout from version control, generated documentation files are not present. You may either generate them (by passing `--enable-doc-maintenance` to `./configure` and satisfying the extra build-time dependencies) or obtain them from a released source package, which includes them. If you want to grab just the files that are in the source distribution but not in the repository, extract a source distribution in a temporary directory, and run `make CLEAN=1 distfiles.zip`. This will create a file called `distfiles.zip`, which can you can extract in a checkout of the source repository. This step is optional unless you are running make install and want the html and PDF versions of the documentation to be installed.