Skip to content

Add versionadded directives to ssl.minimum_version and ssl.maximum_version #11894

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.

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
Feb 28, 2019
Merged
Changes from all commits
Commits
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
16 changes: 10 additions & 6 deletions Doc/library/ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
:exc:`SSLError` is raised.

.. versionadded:: 3.8

.. note::
Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3
support, the method raises :exc:`NotImplementedError`.

.. versionadded:: 3.8

.. method:: SSLSocket.version()

Return the actual SSL protocol version negotiated by the connection
Expand Down Expand Up @@ -1922,6 +1922,8 @@ to speed up repeated connections from the same clients.
This attribute is not available unless the ssl module is compiled
with OpenSSL 1.1.0g or newer.

.. versionadded:: 3.7

.. attribute:: SSLContext.minimum_version

Like :attr:`SSLContext.maximum_version` except it is the lowest
Expand All @@ -1932,6 +1934,8 @@ to speed up repeated connections from the same clients.
This attribute is not available unless the ssl module is compiled
with OpenSSL 1.1.0g or newer.

.. versionadded:: 3.7

.. attribute:: SSLContext.options

An integer representing the set of SSL options enabled on this context.
Expand Down Expand Up @@ -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
performed.

.. versionadded:: 3.8

.. note::
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

.. versionadded:: 3.8

.. attribute:: SSLContext.protocol

The protocol version chosen when constructing the context. This attribute
Expand All @@ -1982,11 +1986,11 @@ to speed up repeated connections from the same clients.
subject common name in the absence of a subject alternative name
extension (default: true).

.. versionadded:: 3.7

.. note::
Only writeable with OpenSSL 1.1.0 or higher.

.. versionadded:: 3.7

.. attribute:: SSLContext.verify_flags

The flags for certificate verification operations. You can set flags like
Expand Down