Patch JwtPayload in order to correctly parse Checkout UI extensions session tokens #1346
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
…okens, missing "iss" and "sid" keys (see: https://shopify.dev/docs/api/checkout-ui-extensions/2024-10/apis/session-token)
|
I have signed the CLA! |
lizkenyon
reviewed
Nov 6, 2024
| @@ -27,15 +27,15 @@ def initialize(token) | |||
| decode_token(token, T.must(Context.old_api_secret_key)) | |||
| end | |||
|
|
|||
| @iss = T.let(payload_hash["iss"], String) | |||
| @iss = T.let(payload_hash["iss"], T.nilable(String)) | |||
| @dest = T.let(payload_hash["dest"], String) | |||
| @aud = T.let(payload_hash["aud"], String) | |||
| @sub = T.let(payload_hash["sub"], String) | |||
There was a problem hiding this comment.
In my testing I found that the sub claim could also be nil, if the customer is not logged in.
| @@ -49,7 +49,7 @@ def shop | |||
|
|
|||
| sig { returns(Integer) } | |||
| def shopify_user_id | |||
| @sub.to_i | |||
| @sub.tr("^0-9", "").to_i | |||
There was a problem hiding this comment.
Is there a reason why you are extracting the ID?
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.
Checkout UI session tokens are actually missing "iss" and "sid" keys (see: https://shopify.dev/docs/api/checkout-ui-extensions/2024-10/apis/session-token). The current implementation makes them mandatory, generating exceptions while verifying JWT tokens (see the new
ShopifyApp::WithShopifyIdTokenconcern, and the legacyShopifyApp::JWTMiddlewaremiddleware).Description
The PR is for:
ShopifyAPI::Auth::JwtPayloadconstructor (line 30) when the JWT Token is missing the "iss" and "sid" keys (both optional in Checkout UI session tokens)ShopifyAppengine fails, raising an obscure exceptionshopify_user_idfrom the "sid" key, even when it's formatted asgid://shopify/Customer/<customerId>How has this been tested?
Develop a basic frontend Checkout UI extension and make cors authenticated calls to a Rails backend developed using
shopify_appgem (v22.4). Any request fails without reaching the corresponding controller, since an exception is raised in theShopifyApp::JWTMiddlewaremiddleware injected by theShopifyAppengine (seeengine.rb, row 20).After applying the patch, requests are nomally executed without raising any exception.
Checklist: