Skip to content

Commit a8c5295

Browse files
committed
Address review: match existing wording, drop set_groups() example
Use the phrasing already used in this file for the five version notes, as suggested by serhiy-storchaka. Remove the set_groups() example and post-quantum paragraph, which restate the OpenSSL documentation, and drop the redundant claim that OpenSSL 3.5 offers hybrid groups by default.
1 parent 6c94325 commit a8c5295

1 file changed

Lines changed: 13 additions & 26 deletions

File tree

Doc/library/ssl.rst

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ Signature algorithms
230230
:meth:`SSLContext.set_client_sigalgs` and
231231
:meth:`SSLContext.set_server_sigalgs` methods.
232232

233-
This function requires OpenSSL 3.4 or later; it raises
234-
:exc:`NotImplementedError` when linked against an older version.
233+
This function will raise :exc:`NotImplementedError` if the OpenSSL library
234+
is older than 3.4.
235235

236236
.. versionadded:: 3.15
237237

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

1321-
This method requires OpenSSL 3.2 or later; it raises
1322-
:exc:`NotImplementedError` when linked against an older version.
1321+
This method will raise :exc:`NotImplementedError` if the OpenSSL library
1322+
is older than 3.2.
13231323

13241324
.. versionadded:: 3.15
13251325

@@ -1329,8 +1329,8 @@ SSL sockets also have the following additional methods and attributes:
13291329
authentication on this connection, or ``None`` if no connection has been
13301330
established or client authentication didn't occur.
13311331

1332-
This method requires OpenSSL 3.5 or later; it raises
1333-
:exc:`NotImplementedError` when linked against an older version.
1332+
This method will raise :exc:`NotImplementedError` if the OpenSSL library
1333+
is older than 3.5.
13341334

13351335
.. versionadded:: 3.15
13361336

@@ -1340,8 +1340,8 @@ SSL sockets also have the following additional methods and attributes:
13401340
handshake on this connection, or ``None`` if no connection has been
13411341
established or the cipher suite has no signature.
13421342

1343-
This method requires OpenSSL 3.5 or later; it raises
1344-
:exc:`NotImplementedError` when linked against an older version.
1343+
This method will raise :exc:`NotImplementedError` if the OpenSSL library
1344+
is older than 3.5.
13451345

13461346
.. versionadded:: 3.15
13471347

@@ -1719,8 +1719,8 @@ to speed up repeated connections from the same clients.
17191719
:const:`True` this method will also return any associated aliases such as
17201720
the ECDH curve names supported in older versions of OpenSSL.
17211721

1722-
This method requires OpenSSL 3.5 or later; it raises
1723-
:exc:`NotImplementedError` when linked against an older version.
1722+
This method will raise :exc:`NotImplementedError` if the OpenSSL library
1723+
is older than 3.5.
17241724

17251725
.. versionadded:: 3.15
17261726

@@ -1769,19 +1769,6 @@ to speed up repeated connections from the same clients.
17691769
context. It should be a string in the `OpenSSL group list format
17701770
<https://docs.openssl.org/master/man3/SSL_CTX_set1_groups_list/>`_.
17711771

1772-
This is a more general replacement for :meth:`~SSLContext.set_ecdh_curve`:
1773-
it accepts several groups in order of preference and supports finite-field
1774-
and post-quantum hybrid groups in addition to ECDH curves. For example,
1775-
to prefer the post-quantum hybrid group ``X25519MLKEM768`` and fall back
1776-
to the classical ``X25519`` group::
1777-
1778-
>>> ctx = ssl.create_default_context()
1779-
>>> ctx.set_groups("X25519MLKEM768:X25519") # doctest: +SKIP
1780-
1781-
Post-quantum hybrid groups such as ``X25519MLKEM768`` require OpenSSL 3.5
1782-
or later. Requesting a group that the linked OpenSSL does not recognize
1783-
raises an :class:`SSLError`.
1784-
17851772
.. note::
17861773

17871774
When connected, the :meth:`SSLSocket.group` method of SSL sockets will
@@ -2966,9 +2953,9 @@ of TLS/SSL. Some new TLS 1.3 features are not yet available.
29662953
negotiated cipher for both TLS 1.3 and earlier versions once a connection
29672954
is established.
29682955
- Key agreement can use post-quantum hybrid groups such as
2969-
``X25519MLKEM768`` when linked against OpenSSL 3.5 or later, which offers
2970-
them by default. Use :meth:`SSLContext.set_groups` to choose which groups
2971-
are offered and :meth:`SSLSocket.group` to see which one was negotiated.
2956+
``X25519MLKEM768`` when linked against OpenSSL 3.5 or later. Use
2957+
:meth:`SSLContext.set_groups` to choose which groups are offered and
2958+
:meth:`SSLSocket.group` to see which one was negotiated.
29722959
- Session tickets are no longer sent as part of the initial handshake and
29732960
are handled differently. :attr:`SSLSocket.session` and :class:`SSLSession`
29742961
are not compatible with TLS 1.3.

0 commit comments

Comments
 (0)