gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links (GH-94416)

This commit is contained in:
Sam Ezeh 2022-07-01 17:21:27 +01:00 committed by GitHub
parent ad55147c1d
commit 80aaeabb8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 2 deletions

View File

@ -20,7 +20,7 @@ This module defines classes for implementing HTTP servers.
.. warning::
:mod:`http.server` is not recommended for production. It only implements
basic security checks.
:ref:`basic security checks <http.server-security>`.
One class, :class:`HTTPServer`, is a :class:`socketserver.TCPServer` subclass.
It creates and listens at the HTTP socket, dispatching the requests to a
@ -499,3 +499,14 @@ following command runs an HTTP/1.1 conformant server::
the ``--cgi`` option::
python -m http.server --cgi
.. _http.server-security:
Security Considerations
-----------------------
.. index:: pair: http.server; security
:class:`SimpleHTTPRequestHandler` will follow symbolic links when handling
requests, this makes it possible for files outside of the specified directory
to be served.

View File

@ -14,7 +14,7 @@ The following modules have specific security considerations:
argument disabling known insecure and blocked algorithms
<hashlib-usedforsecurity>`
* :mod:`http.server` is not suitable for production use, only implementing
basic security checks
basic security checks. See the :ref:`security considerations <http.server-security>`.
* :mod:`logging`: :ref:`Logging configuration uses eval()
<logging-eval-security>`
* :mod:`multiprocessing`: :ref:`Connection.recv() uses pickle