Skip to content

gh-138252: Document OpenSSL version requirements for the ssl signature-algorithm APIs#154521

Open
fedonman wants to merge 1 commit into
python:mainfrom
fedonman:docs-ssl-sigalg-version-notes
Open

gh-138252: Document OpenSSL version requirements for the ssl signature-algorithm APIs#154521
fedonman wants to merge 1 commit into
python:mainfrom
fedonman:docs-ssl-sigalg-version-notes

Conversation

@fedonman

Copy link
Copy Markdown
Contributor

This is a small documentation follow-up to the signature-algorithm support added in gh-138252.

Three of those APIs require a specific OpenSSL version, but the reference docs don't mention it. ssl.get_sigalgs() requires OpenSSL 3.4 or later, and SSLSocket.client_sigalg() and SSLSocket.server_sigalg() require 3.5 or later. On an older version each raises NotImplementedError. The requirement is already stated in the What's New in 3.15 entry and enforced in the C code (Modules/_ssl.c), so this just brings the three reference entries in line.

A companion PR, #154518, adds the same kind of note to SSLSocket.group() and SSLContext.get_groups().

This is documentation only, so there is no news entry.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33718550 | 📁 Comparing d1782da against main (206788a)

  🔍 Preview build  

1 file changed
± library/ssl.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant