Expose and document existing 'json' option in jws.decode and jws.createVerify APIs #105
Conversation
This file contains 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
loucadufault
commented
Jan 30, 2023
| @@ -100,7 +101,7 @@ util.inherits(VerifyStream, Stream); | |||
| VerifyStream.prototype.verify = function verify() { | |||
| try { | |||
| var valid = jwsVerify(this.signature.buffer, this.algorithm, this.key.buffer); | |||
| var obj = jwsDecode(this.signature.buffer, this.encoding); | |||
| var obj = jwsDecode(this.signature.buffer, {json: this.json, encoding: this.encoding}); | |||
There was a problem hiding this comment.
note: encoding option was previously not being passed correctly here, which is fine since it was ignored, see #86 (comment)
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.
Description
The
jsonoption is currently accepted by thejws.decodeAPI, although it is not documented in repo. From its usage, it seems it intends to enable configuring how the payload should be parsed when thetypis not set to 'JWT' on the JWS header.This change:
a) documents the option as part of the API
b) adds support for the option via the
jws.createVerifyAPI, which will pass through the option tojws.decodeinternally.Testing
Added tests for when:
the
typis set to 'JWT'the
typis missingthe
typis invalidthe
typis invalid, butjsonoption is set to true, forcing parsing of payload as JSONhandle null value for
jsonoption as expectedThis change adds test coverage for new/changed/fixed functionality
Checklist