Skip to content

Commit 870a8b5

Browse files
robsdedudefbiville
andauthored
Warn about using ssl_context config option (#714)
Update docs added with #639 Co-authored-by: Florent Biville <[email protected]>
1 parent 682b861 commit 870a8b5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/source/api.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,12 @@ This setting does not have any effect if ``encrypted`` is set to ``False``.
318318
---------------
319319
Specify a custom SSL context to use for wrapping connections.
320320

321-
If give, ``encrypted`` and ``trusted_certificates`` have no effect.
321+
If given, ``encrypted`` and ``trusted_certificates`` have no effect.
322+
323+
.. warning::
324+
This option may compromise your application's security if used improperly.
325+
326+
Its usage is strongly discouraged and comes without any guarantees.
322327

323328
:Type: :class:`ssl.SSLContext` or :const:`None`
324329
:Default: :const:`None`

0 commit comments

Comments
 (0)