Add TypeScript types for key generation functions#860
Open
mahmoud-moursy wants to merge 2 commits intopanva:mainfrom
Open
Add TypeScript types for key generation functions#860mahmoud-moursy wants to merge 2 commits intopanva:mainfrom
mahmoud-moursy wants to merge 2 commits intopanva:mainfrom
Conversation
Author
|
@panva sorry for pinging you about this -- not sure if you have notifications for pull requests turned on or not. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sorry for not creating a discussion first -- alas, I read the CONTRIBUTING.md just after finishing up the code for this contribution.
Benefits
Costs
The weakest link in any cybersecurity system is humans; there is a danger that, by introducing automatic type hints, users may potentially do less pre-reading before using Jose and accidentally introduce security vulnerabilities into their own code-bases by using inappropriate algorithms. I have tried to link to the relevant documentation in the JSDoc comments of these types to reduce the incidence rate of this.
Tests(?)
I made sure to run
npm formatandnpm testbefore contributing this. Nothing seems broken from what I can glean.AI Disclosure
All the code was written by hand. I submitted it to Claude to review, where it did catch a typo that I'd made in the identifier for the type
SecretKeyAlgorithm.