Documenting how to use OpenSSL::SSL::SSLContext in PQC use cases
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- ruby
- Domain
- cryptography, documentation, security
Research direction
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.
Written by the indexing model from the issue text.
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?
- Dominant language
- C
- Stars
- 276
- Forks
- 205
- Avg merge
- 21h 17m
- Merged PRs (30d)
- 17
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ruby/openssl
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
Add OpenSSL::SSL::SSLContext#client_hello_cb= (binding for SSL_CTX_set_client_hello_cb())Possibly taken @kou claimed this 37 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 53/100
ruby/openssl#1125 · 6 comments ·
Maintainers usually reply within 1 day
-
Expose XOFs like SHAKE128 and SHAKE256Possibly taken @rhenium claimed this 133 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
ruby/openssl#1082 · 4 comments ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
ruby/openssl#1075 · 4 comments ·
Maintainers usually reply within 1 day
Similar issues
-
isolation2 lockmodes fails on cassert builds: extra AccessShareLock on partition rootPossibly taken @tuhaihe claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/cloudberry#2356 ·
Maintainers usually reply within 2 days
-
windows-artifacts: the win-arm64 job uses a Visual Studio generator missing from windows-11-armOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
wasm-micro-runtime/wasm-micro-runtime#5217 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
HandBrake/HandBrake#8278 · 1 comment ·
Maintainers usually reply within 1 day