Document OpenSSL version requirements and post-quantum groups for the ssl group and signature algorithm APIs
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
Documentation
Python 3.15 added SSLContext.set_groups(), SSLContext.get_groups() and SSLSocket.group() for choosing and inspecting the groups used for TLS key agreement. This is also how you reach the post-quantum hybrid key exchange that OpenSSL 3.5 now offers by default, such as X25519MLKEM768. The same release added ssl.get_sigalgs(), SSLSocket.client_sigalg() and SSLSocket.server_sigalg() for signature algorithms.
The reference documentation for both sets of methods is thinner than it could be.
Five of them need a specific OpenSSL version and raise NotImplementedError when linked against an older one, but the reference docs don't say so:
SSLSocket.group()needs OpenSSL 3.2 or laterSSLContext.get_groups()needs OpenSSL 3.5 or laterssl.get_sigalgs()needs OpenSSL 3.4 or laterSSLSocket.client_sigalg()needs OpenSSL 3.5 or laterSSLSocket.server_sigalg()needs OpenSSL 3.5 or later
Each requirement is already stated in the What's New in 3.15 entries and enforced in Modules/_ssl.c, so this is only about the reference pages.
There are a few other gaps around the group API. set_groups() has no example and never mentions that it supports post-quantum groups, even though the What's New in 3.15 does. set_ecdh_curve() doesn't point readers at the newer and more general set_groups(). And the TLS 1.3 section says nothing about key agreement groups or the post-quantum hybrids that are now enabled by default.
Linked PRs
- gh-154518
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelas páginas de referência de SSL para set_groups(), get_groups(), group(), as APIs de algoritmos de assinatura, set_ecdh_curve() e a seção sobre TLS 1.3; em seguida, compare os detalhes existentes com Modules/_ssl.c e as entradas de What's New in 3.15. O trabalho estará concluído quando os requisitos documentados do OpenSSL, o comportamento de NotImplementedError, o suporte a grupos pós-quânticos, os exemplos e as referências cruzadas cobrirem as lacunas descritas no issue.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 25/100