Documenting how to use OpenSSL::SSL::SSLContext in PQC use cases
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- ruby
- Domínio
- cryptography, documentation, security
Direção de pesquisa
Start by reviewing the examples in ruby-pqc-test/openssl and ruby-pqc-test/openssl/script, along with the referenced OpenSSL workflow. Then inspect html/OpenSSL.html, html/OpenSSL/SSL/SSLContext.html, and html/OpenSSL/SSL/SSLSocket.html to determine the best placement for the PQC guidance. Done means the generated RDoc pages explain the relevant SSLContext and socket APIs with ML-DSA and ML-KEM examples.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The ruby/drb started to support PQC by the PR https://github.com/ruby/drb/pull/62. The approach is that drb accepts OpenSSL::SSL::SSLContext object from users. However, drb users need to understand how to create OpenSSL::SSL::SSLContext instance for PQC use cases. The usages are such as using #groups= to specify the key exchange algorithm with ML-KEM, and using #sigalgs= to specify signature algorithms with ML-DSA only for ML-DSA cert server, or ML-DSA/RSA for ML-DSA/RSA multiple cert server.
I created the following Ruby scripts to show the examples of OpenSSL::SSL::SSLContext in some PQC server/client cases with ML-DSA single certificate server and ML-DSA/RSA multiple certificate server.
- https://github.com/junaruga/ruby-pqc-test/tree/main/openssl
- https://github.com/junaruga/ruby-pqc-test/tree/main/openssl/script
- https://github.com/junaruga/ruby-pqc-test/blob/main/.github/workflows/openssl.yml
I want to document the usages of OpenSSL::SSL::SSLContext in PQC use cases in ruby/openssl, to fill the knowledge gap, and guide users of other ruby/* libraries accepting or exposing OpenSSL::SSL::SSLContext instance.
I want to update the following generated rdoc documents, adding the PQC related contents with code examples.
- html/OpenSSL.html - This document shows topic-based code examples on the top of the page. So, adding new section "Post-Quantum Cryptography" or/and "ML-DSA Encryption".
- html/OpenSSL/SSL/SSLContext.html -
#groups=,#sigalgs= - html/OpenSSL/SSL/SSLSocket.html -
#group,#sigalg,#peer_sigalg
I am still considering what is the best to document this topic. What do you think? Is there a good idea about where and how to document this topic?
- Linguagem predominante
- C
- Estrelas
- 276
- Forks
- 204
- Merge médio
- 1d 3h
- PRs com merge (30d)
- 8
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o 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.
Mais de ruby/openssl
-
Add OpenSSL::SSL::SSLContext#client_hello_cb= (binding for SSL_CTX_set_client_hello_cb())Talvez já em andamento @kou assumiu há 12 dias. Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 53/100
ruby/openssl#1125 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
Expose XOFs like SHAKE128 and SHAKE256Talvez já em andamento @rhenium assumiu há 109 dias. Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
ruby/openssl#1082 · 4 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
ruby/openssl#1075 · 4 comentários ·
Mantenedores costumam responder em até 1 dia
-
Unchecked *_set_* callsTalvez já em andamento @ndossche assumiu há 179 dias. Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
ruby/openssl#1038 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 Meio dia Facilidade para iniciantes 45/100
ruby/openssl#975 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
Todas as issues de ruby/openssl
Issues semelhantes
-
Add `CPC_TAKE_TILL_CHARS`Abertadifficulty: easy
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
performance solver
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
ChefKissInc/Inferno#319 ·
-
llvm-tools
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
llvm/llvm-project#235522 ·
Mantenedores costumam responder em até 1 dia