summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2013-11-17 14:36:03 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2013-11-17 14:36:03 (GMT)
commit6b2b084192a4acf53249c47b44b1984d6c304a98 (patch)
tree0ed9c202617772e930bb1831108a7af6797dbcb2 /Doc
parent633db6f6a69fd44b4a27e7e216ff7a138f69aaf3 (diff)
parent9eefe91fc2922de7ae7eee2e55d17ea452468083 (diff)
downloadcpython-6b2b084192a4acf53249c47b44b1984d6c304a98.zip
cpython-6b2b084192a4acf53249c47b44b1984d6c304a98.tar.gz
cpython-6b2b084192a4acf53249c47b44b1984d6c304a98.tar.bz2
Issue #19508: direct the user to read the security considerations for the ssl module
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/ssl.rst19
1 files changed, 14 insertions, 5 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 5af56f9..96cae9d 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -30,12 +30,10 @@ probably additional platforms, as long as OpenSSL is installed on that platform.
openssl version 1.0.1.
.. warning::
+ Don't use this module without reading the :ref:`ssl-security`. Doing so
+ may lead to a false sense of security, as the default settings of the
+ ssl module are not necessarily appropriate for your application.
- OpenSSL's internal random number generator does not properly handle fork.
- Applications must change the PRNG state of the parent process if they use
- any SSL feature with :func:`os.fork`. Any successful call of
- :func:`~ssl.RAND_add`, :func:`~ssl.RAND_bytes` or
- :func:`~ssl.RAND_pseudo_bytes` is sufficient.
This section documents the objects and functions in the ``ssl`` module; for more
general information about TLS, SSL, and certificates, the reader is referred to
@@ -1480,6 +1478,17 @@ format <http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT>`_.
If you want to check which ciphers are enabled by a given cipher list,
use the ``openssl ciphers`` command on your system.
+Multi-processing
+^^^^^^^^^^^^^^^^
+
+If using this module as part of a multi-processed application (using,
+for example the :mod:`multiprocessing` or :mod:`concurrent.futures` modules),
+be aware that OpenSSL's internal random number generator does not properly
+handle forked processes. Applications must change the PRNG state of the
+parent process if they use any SSL feature with :func:`os.fork`. Any
+successful call of :func:`~ssl.RAND_add`, :func:`~ssl.RAND_bytes` or
+:func:`~ssl.RAND_pseudo_bytes` is sufficient.
+
.. seealso::