Skip to content

Commit 5f351d2

Browse files
committed
indicate OpenSSL requirements for new functions
1 parent 6df1740 commit 5f351d2

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

Doc/library/intro.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,18 @@ this material.
4848
Let the show begin!
4949

5050

51+
.. _requirements-notes:
52+
53+
Notes on requirements
54+
=====================
55+
56+
* A "Requirements: OpenSSL >= 3.5" note means that this function requires
57+
that Python has been built with OpenSSL 3.5 or later.
58+
59+
* A "Requirements: not AWS-LC" note means that this function is not available
60+
if Python has been built with AWS-LC instead of OpenSSL.
61+
62+
5163
.. _availability:
5264

5365
Notes on availability

Doc/library/ssl.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ Signature algorithms
232232
:meth:`SSLContext.set_client_sigalgs` and
233233
:meth:`SSLContext.set_server_sigalgs` methods.
234234

235+
.. requirements:: OpenSSL >= 3.4
236+
235237
.. versionadded:: next
236238

237239

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

1323+
.. requirements:: OpenSSL >= 3.2
1324+
13211325
.. versionadded:: next
13221326

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

1333+
.. requirements:: OpenSSL >= 3.5
1334+
13291335
.. versionadded:: next
13301336

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

1343+
.. requirements:: OpenSSL >= 3.5
1344+
13371345
.. versionadded:: next
13381346

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

1721+
.. requirements:: OpenSSL >= 3.5
1722+
17131723
.. versionadded:: next
17141724

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

1790+
.. requirements:: not AWS-LC
1791+
17801792
.. versionadded:: next
17811793

17821794
.. method:: SSLContext.set_server_sigalgs(sigalgs, /)

0 commit comments

Comments
 (0)