Use same leeway for exp and nbf when parsing JWT
#1312
Merged
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
rachel-carvalho
commented
Apr 16, 2024
lib/shopify_api/auth/jwt_payload.rb
Outdated
| @@ -73,8 +73,7 @@ def ==(other) | |||
|
|
|||
| sig { params(token: String, api_secret_key: String).returns(T::Hash[String, T.untyped]) } | |||
| def decode_token(token, api_secret_key) | |||
| JWT.decode(token, api_secret_key, true, | |||
| { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0] | |||
| JWT.decode(token, api_secret_key, true, leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256")[0] | |||
There was a problem hiding this comment.
I would prefer to rename the constant to JWT_LEEWAY since it doesn't only apply to expiration anymore, but it's a public constant and might make this a breaking change, so I decided to keep it.
There was a problem hiding this comment.
Oh yeah good call, I'll do that then 👍
paulomarg
approved these changes
Apr 16, 2024
lib/shopify_api/auth/jwt_payload.rb
Outdated
| @@ -73,8 +73,7 @@ def ==(other) | |||
|
|
|||
| sig { params(token: String, api_secret_key: String).returns(T::Hash[String, T.untyped]) } | |||
| def decode_token(token, api_secret_key) | |||
| JWT.decode(token, api_secret_key, true, | |||
| { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0] | |||
| JWT.decode(token, api_secret_key, true, leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256")[0] | |||
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
Right now we specify a leeway of 10 seconds when validating JWT payload expiration, but no leeway for
nbf(not valid before). Theshopify-apiJS library does allow forclockTolerancein both fields, and I think it makes sense for the Ruby gem to do the same.How has this been tested?
I added unit tests.
Checklist: