(ed) 9. private_key_jwt "Clients that have registered a public key sign a JWT using that key" is wrong
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 3
- Forks
- 3
- Avg merge
- 20h 14m
- Merged PRs (30d)
- 1
Description
Originally submitted by Nat (Nat Sakimura) on 2025-03-27
In section 9, private_key_jwt, it says:
Clients that have registered a public key sign a JWT using that key
Literally, “that key” is “public key” here, and thus this is wrong, though all of us who know about public key cryptography understand that it means the paired private key (signing key).
Proposes to amend the sentence to be:
Clients that have registered a public key sign a JWT using the corresponding private key.
Bitbucket status: new
Bitbucket origin: issue 2173
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Review section 9, private_key_jwt, and locate the sentence about clients that have registered a public key. Change it to say that clients sign a JWT using the corresponding private key; done means the wording no longer implies that a public key performs the signing.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100