Don't expect monkeypatched nacl.signing.SigningKey instances

Open
#16 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cryptography, security

Research direction

Start by locating the functions that accept signedjson.types.SigningKey and review matrix-org/synapse#11714 for the monkeypatching problem. Define the proposed key data type, update those function boundaries, and verify the major-version API change is consistently represented.

Written by the indexing model from the issue text.

Description

enhancement

A nicer way to fix matrix-org/synapse#11714 (imo)

  • Define a new type which holds the data (key: nacl.signing.SigningKey, alg: str, version: str). Either inherit from nacl.signing.SigningKey or introduce a new wrapper.
  • Change functions that take a signedjson.types.SigningKey to accept this new data type.
  • Major version bump.
Dominant language
Python
Stars
13
Forks
10
No merged PRs in 30d

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.

More from matrix-org/python-signedjson

All issues in matrix-org/python-signedjson

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.