Skip to content

gh-138633: indicate SSL backend requirements for SSL functions #138656

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
picnixz wants to merge 8 commits into
base: main
Choose a base branch
from
Open

gh-138633: indicate SSL backend requirements for SSL functions #138656

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6df1740
add an extension for indicating library requirements
picnixz Sep 8, 2025
5f351d2
indicate OpenSSL requirements for new functions
picnixz Sep 8, 2025
dca32b5
Revert "add an extension for indicating library requirements"
picnixz Sep 16, 2025
df4f93b
remove un-necessary directive
picnixz Sep 16, 2025
c1ae0f6
Define SSL backends separately
picnixz Sep 29, 2025
7c60b75
improve availability wording
picnixz Sep 30, 2025
0db99b9
Apply suggestion from @picnixz
picnixz Oct 5, 2025
b092f31
Merge branch 'main' into docs/ssl/required-version-138633
picnixz Oct 26, 2025
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
Prev Previous commit
Next Next commit
indicate OpenSSL requirements for new functions
  • Loading branch information
@picnixz
picnixz committed Sep 8, 2025
commit 5f351d20957dc879f6a4f4723be1addac6fbdfdf
12 changes: 12 additions & 0 deletions Doc/library/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,18 @@ this material.
Let the show begin!


.. _requirements-notes:

Notes on requirements
=====================

* A "Requirements: OpenSSL >= 3.5" note means that this function requires
that Python has been built with OpenSSL 3.5 or later.

* A "Requirements: not AWS-LC" note means that this function is not available
if Python has been built with AWS-LC instead of OpenSSL.


.. _availability:

Notes on availability
Expand Down
12 changes: 12 additions & 0 deletions Doc/library/ssl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,8 @@ Signature algorithms
:meth:`SSLContext.set_client_sigalgs` and
:meth:`SSLContext.set_server_sigalgs` methods.

.. requirements:: OpenSSL >= 3.4

.. versionadded:: next


Expand Down Expand Up @@ -1318,6 +1320,8 @@ SSL sockets also have the following additional methods and attributes:
Return the group used for doing key agreement on this connection. If no
connection has been established, returns ``None``.

.. requirements:: OpenSSL >= 3.2

.. versionadded:: next

.. method:: SSLSocket.client_sigalg()
Expand All @@ -1326,6 +1330,8 @@ SSL sockets also have the following additional methods and attributes:
authentication on this connection, or ``None`` if no connection has been
established or client authentication didn't occur.

.. requirements:: OpenSSL >= 3.5

.. versionadded:: next

.. method:: SSLSocket.server_sigalg()
Expand All @@ -1334,6 +1340,8 @@ SSL sockets also have the following additional methods and attributes:
handshake on this connection, or ``None`` if no connection has been
established or the cipher suite has no signature.

.. requirements:: OpenSSL >= 3.5

.. versionadded:: next

.. method:: SSLSocket.compression()
Expand Down Expand Up @@ -1710,6 +1718,8 @@ to speed up repeated connections from the same clients.
:const:`True` this method will also return any associated aliases such as
the ECDH curve names supported in older versions of OpenSSL.

.. requirements:: OpenSSL >= 3.5

.. versionadded:: next

.. method:: SSLContext.set_default_verify_paths()
Expand Down Expand Up @@ -1777,6 +1787,8 @@ to speed up repeated connections from the same clients.
sockets will return the signature algorithm used for performing
certificate-based client authentication on that connection.

.. requirements:: not AWS-LC

.. versionadded:: next

.. method:: SSLContext.set_server_sigalgs(sigalgs, /)
Expand Down
Loading