Add support for RFC7797 unencoded payloads #561
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
added 3 commits
May 4, 2023 18:03
adds `encode_detached` to JWT, which produces a jwt with an empty payload segment adds support for the `b64` header, which when set to false will prevent the payload from being base64 encoded adds support for decoding JWTs with the `b64` header set to false adds support for decoding and verifying JWTs with detached payloads
abiagini
reviewed
Mar 22, 2024
| @@ -22,7 +22,16 @@ def encode(payload, key, algorithm = 'HS256', header_fields = {}) | |||
| Encode.new(payload: payload, | |||
| key: key, | |||
| algorithm: algorithm, | |||
| headers: header_fields).segments | |||
| headers: header_fields, | |||
| detached: false).segments | |||
There was a problem hiding this comment.
Maybe we can set detached as default false
| @@ -15,11 +15,24 @@ def initialize(options) | |||
| @algorithm = resolve_algorithm(options[:algorithm]) | |||
| @headers = options[:headers].transform_keys(&:to_s) | |||
| @headers[ALG_KEY] = @algorithm.alg | |||
| @detached = options[:detached] | |||
There was a problem hiding this comment.
Here we can set as default false
@detached = options[:detached] || false
| def parse_and_decode(segment, decode: true) | ||
| if decode | ||
| JWT::JSON.parse(::JWT::Base64.url_decode(segment)) | ||
| else |
There was a problem hiding this comment.
We can avoid else statement with a guard clause.
|
Hi guys, this feature is quite common, will be good to have this supported. |
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.
This adds support for RFC7797 and addresses #309
Here is the specification: https://www.rfc-editor.org/rfc/rfc7797
Happy to receive feedback and would love to get this released soon as I need it for my current project.