Documenting how to use OpenSSL::SSL::SSLContext in PQC use cases
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 55/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- ruby
- Domaine
- cryptography, documentation, security
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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?
- Langage dominant
- C
- Étoiles
- 276
- Forks
- 203
- Merge moyen
- 1 j 7 h
- PR mergées (30 j)
- 9
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ruby/openssl
-
Add OpenSSL::SSL::SSLContext#client_hello_cb= (binding for SSL_CTX_set_client_hello_cb())Peut-être pris @kou l’a pris il y a 8 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 53/100
ruby/openssl#1125 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Expose XOFs like SHAKE128 and SHAKE256Peut-être pris @rhenium l’a pris il y a 105 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
ruby/openssl#1082 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
ruby/openssl#1075 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Unchecked *_set_* callsPeut-être pris @ndossche l’a pris il y a 175 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
ruby/openssl#1038 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 Une demi-journée Accessibilité débutants 45/100
ruby/openssl#975 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ruby/openssl
Issues similaires
-
Bug Status: Needs Triage
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
v9.6.0: CMake incorrectly enforces presence of libevdevPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
Les mainteneurs répondent en général sous 1 jour
-
IoTSDK
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Azure/azure-iot-sdk-c#2776 ·
Les mainteneurs répondent en général sous 2 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
-
[Bug] Unhandled ValueError terminates watchdog thread when GISRC value contains multiple colonsOuvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour