Skip to content

Warn about using ssl_context config option #714

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
Apr 20, 2022
Merged

Warn about using ssl_context config option #714

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f6f4ae
Warn about using ssl_context config option
robsdedude Apr 19, 2022
f8fd21c
Update docs/source/api.rst
robsdedude Apr 19, 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
7 changes: 6 additions & 1 deletion docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,12 @@ This setting does not have any effect if ``encrypted`` is set to ``False``.
---------------
Specify a custom SSL context to use for wrapping connections.

If give, ``encrypted`` and ``trusted_certificates`` have no effect.
If given, ``encrypted`` and ``trusted_certificates`` have no effect.

.. warning::
This option may compromise your application's security if used improperly.

Its usage is strongly discouraged and comes without any guarantees.

:Type: :class:`ssl.SSLContext` or :const:`None`
:Default: :const:`None`
Expand Down