8000 [3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… by csabella · Pull Request #12101 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… #12101

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 1 commit into from
Feb 28, 2019
Merged

[3.7] Add versionadded directives to ssl.minimum_version and ssl.maxi… #12101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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.7.1

.. 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.7.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hum wait, why is it version 3.8 in the master branch but 3.7.1 in the 3.7 branch? The versionadded should be the same in 3.7 and master branches, no? cc @csabella @tiran (I only checked verify_client_post_handshake, I didn't check other versionadded markups.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's how it was when originally added in GH-9460 and GH-9505, so I didn't change it. If it should be 3.7.1 on both, I'll update master.


.. 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.7.1

.. 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.7.1

.. 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
0