Skip to content

gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links #94416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2022
Merged

gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links #94416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1071e11
Document that SimpleHTTPRequestHandler follows symbolic links
dignissimus Jun 29, 2022
6ea4b7f
Create new http.server security consideration section. Add reference …
dignissimus Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion Doc/library/http.server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion Doc/library/security_warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down