Skip to content

gh-95816: fix client_context example from ssl protocol versions docs #93798

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

gh-95816: fix client_context example from ssl protocol versions docs #93798

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1b97375
fix client_context example from ssl protocol versions docs
graingert Jun 14, 2022
d642d91
Merge branch 'main' into patch-5
graingert Aug 9, 2022
1187dd0
Merge branch 'main' into patch-5
graingert Oct 14, 2024
98d744c
Update Doc/library/ssl.rst
graingert Oct 14, 2024
63dac5a
Merge branch 'main' into patch-5
graingert Dec 28, 2024
3e0f334
Update Doc/library/ssl.rst
graingert Dec 28, 2024
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
4 changes: 2 additions & 2 deletions Doc/library/ssl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2600,8 +2600,8 @@ disabled by default.
::

>>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> client_context.minimum_version = ssl.TLSVersion.TLSv1_3
>>> client_context.maximum_version = ssl.TLSVersion.TLSv1_3
Copy link
Contributor Author

Choose a reason for hiding this comment

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

introduced here https://github.com/python/cpython/pull/25455/files#diff-df0c7115ade453321aadb2eb534941f2ec87c4b52563bae70421918dce5435dcR2653-R2654

>>> client_context.minimum_version = ssl.TLSVersion.TLSv1_2
>>> client_context.maximum_version = ssl.TLSVersion.MAXIMUM_VERSION


The SSL context created above will only allow TLSv1.2 and later (if
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this states the context above supports TLSv1.2-max but the example was TLSv1.3 only

Copy link
Contributor

@janbrasna janbrasna Dec 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@graingert If you update to current main the wording now states "TLSv1.3 and later" — so I'd recommend to match ssl.* min version with main too, but definitely propose the MAXIMUM_SUPPORTED anyways which makes much more sense compared to the current docs.

(While the docs specify "Deprecated since version 3.10: All TLSVersion members except TLSVersion.TLSv1_2 and TLSVersion.TLSv1_3 are deprecated." I believe that doesn't include the magic constants, as I can't see any proof in the deprecation warning code to raise any warnings for the MIN_/MAX_ constants, so it's just the description that's written too broadly.)

Copy link
Contributor

Choose a reason for hiding this comment

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

On the other hand, configuring the max version in this way is superfluous, as that is by the definition the default:

"SSLContext.maximum_version — A TLSVersion enum member representing the highest supported TLS version. The value defaults to TLSVersion.MAXIMUM_SUPPORTED."
— https://docs.python.org/3/library/ssl.html#ssl.SSLContext.minimum_version

so there's no point of showing an example set this way.

I'd personally vouch for showing a real range as in #107273 (review) …

Expand Down