pyca / pyca/pyopenssl

set_session_id method is missing a word in its name

Open
#845 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
944
Forks
440
Avg merge
1d 6h
Merged PRs (30d)
6

Description

The correct method name should be set_session_id_context, since it is a wrapper around https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set_session_id_context.html. Somewhat understandably the original implementation probably thought "context" was just a redundant-for-no-reason copy of "CTX", but the "session ID context" is legitimately a completely different thing from the "session ID" (which you set on the session object, with https://www.openssl.org/docs/man1.1.0/man3/SSL_SESSION_get_id.html, something that pyOpenSSL doesn't currently expose any methods on).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the wrapper entry point for the existing set_session_id method and compare it with OpenSSL's SSL_CTX_set_session_id_context documentation. Rename the exposed method to set_session_id_context and check references to the old name; done means the wrapper's name matches the documented OpenSSL operation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
security
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.