diff options
Diffstat (limited to 'Doc/library/httplib.rst')
| -rw-r--r-- | Doc/library/httplib.rst | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/Doc/library/httplib.rst b/Doc/library/httplib.rst index fcdfbc0..23b0e64 100644 --- a/Doc/library/httplib.rst +++ b/Doc/library/httplib.rst @@ -70,12 +70,25 @@ The module provides the following classes: *source_address* was added. -.. class:: HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout[, source_address]]]]]]) +.. class:: HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout[, source_address, context, check_hostname]]]]]]) A subclass of :class:`HTTPConnection` that uses SSL for communication with - secure servers. Default port is ``443``. *key_file* is the name of a PEM - formatted file that contains your private key. *cert_file* is a PEM formatted - certificate chain file. + secure servers. Default port is ``443``. If *context* is specified, it must + be a :class:`ssl.SSLContext` instance describing the various SSL options. + + *key_file* and *cert_file* are deprecated, please use + :meth:`ssl.SSLContext.load_cert_chain` instead, or let + :func:`ssl.create_default_context` select the system's trusted CA + certificates for you. + + Please read :ref:`ssl-security` for more information on best practices. + + .. note:: + If *context* is specified and has a :attr:`~ssl.SSLContext.verify_mode` + of either :data:`~ssl.CERT_OPTIONAL` or :data:`~ssl.CERT_REQUIRED`, then + by default *host* is matched against the host name(s) allowed by the + server's certificate. If you want to change that behaviour, you can + explicitly set *check_hostname* to False. .. warning:: This does not do any verification of the server's certificate. @@ -88,6 +101,9 @@ The module provides the following classes: .. versionchanged:: 2.7 *source_address* was added. + .. versionchanged:: 2.7.9 + *context* and *check_hostname* was added. + .. class:: HTTPResponse(sock, debuglevel=0, strict=0) |