Add versionadded directives to ssl.minimum_version and ssl.maximum_version (GH-11894)

This commit is contained in:
Zhiming Wang 2019-03-01 01:15:04 +08:00 committed by Cheryl Sabella
parent 4cbea518a0
commit ae2ea33d5d
1 changed files with 10 additions and 6 deletions

View File

@ -1328,12 +1328,12 @@ SSL sockets also have the following additional methods and attributes:
If any precondition isn't met (e.g. not TLS 1.3, PHA not enabled), an If any precondition isn't met (e.g. not TLS 1.3, PHA not enabled), an
:exc:`SSLError` is raised. :exc:`SSLError` is raised.
.. versionadded:: 3.8
.. note:: .. note::
Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3
support, the method raises :exc:`NotImplementedError`. support, the method raises :exc:`NotImplementedError`.
.. versionadded:: 3.8
.. method:: SSLSocket.version() .. method:: SSLSocket.version()
Return the actual SSL protocol version negotiated by the connection Return the actual SSL protocol version negotiated by the connection
@ -1922,6 +1922,8 @@ to speed up repeated connections from the same clients.
This attribute is not available unless the ssl module is compiled This attribute is not available unless the ssl module is compiled
with OpenSSL 1.1.0g or newer. with OpenSSL 1.1.0g or newer.
.. versionadded:: 3.7
.. attribute:: SSLContext.minimum_version .. attribute:: SSLContext.minimum_version
Like :attr:`SSLContext.maximum_version` except it is the lowest Like :attr:`SSLContext.maximum_version` except it is the lowest
@ -1932,6 +1934,8 @@ to speed up repeated connections from the same clients.
This attribute is not available unless the ssl module is compiled This attribute is not available unless the ssl module is compiled
with OpenSSL 1.1.0g or newer. with OpenSSL 1.1.0g or newer.
.. versionadded:: 3.7
.. attribute:: SSLContext.options .. attribute:: SSLContext.options
An integer representing the set of SSL options enabled on this context. An integer representing the set of SSL options enabled on this context.
@ -1965,12 +1969,12 @@ to speed up repeated connections from the same clients.
:meth:`SSLSocket.verify_client_post_handshake` is called and some I/O is :meth:`SSLSocket.verify_client_post_handshake` is called and some I/O is
performed. performed.
.. versionadded:: 3.8
.. note:: .. note::
Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3 Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3
support, the property value is None and can't be modified support, the property value is None and can't be modified
.. versionadded:: 3.8
.. attribute:: SSLContext.protocol .. attribute:: SSLContext.protocol
The protocol version chosen when constructing the context. This attribute The protocol version chosen when constructing the context. This attribute
@ -1982,11 +1986,11 @@ to speed up repeated connections from the same clients.
subject common name in the absence of a subject alternative name subject common name in the absence of a subject alternative name
extension (default: true). extension (default: true).
.. versionadded:: 3.7
.. note:: .. note::
Only writeable with OpenSSL 1.1.0 or higher. Only writeable with OpenSSL 1.1.0 or higher.
.. versionadded:: 3.7
.. attribute:: SSLContext.verify_flags .. attribute:: SSLContext.verify_flags
The flags for certificate verification operations. You can set flags like The flags for certificate verification operations. You can set flags like