feat(appcheck): Added replay protection feature to App Check verifyToken() API
#2148
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
lahirumaramba
force-pushed
the
lm-fac-1use
branch
from
25c8d58
to
748dcec
Compare
weixifan
reviewed
Apr 12, 2023
| return true; | ||
| }) | ||
| .catch((err) => { | ||
| throw this.toFirebaseError(err); |
There was a problem hiding this comment.
(Just for informational purposes, no action needed.) Right now the backend has two main error conditions (in this order of priority):
- If the token is invalid (expired, invalid signature, wrong audience, etc.), an HTTP 403 Forbidden will be returned.
- If the token had a provider of
safety_net, an HTTP 400 Bad Request will be returned. (Maybe we could even detect this early and avoid the network call?)
There was a problem hiding this comment.
Ah good point! Since we check the validity of the token prior to making the call to BE, 1) should be addressed already. How do we check 2)?, is it a custom claim encoded in the JWT?
There was a problem hiding this comment.
For (2), yes, it is actually a private claim named provider in the JWT, but now that I think about this more, I think a more robust method for detecting whether the token supports Replay Protection is to see whether its jti claim is populated with a nonempty string rather than checking the provider claim against a hardcoded list of allowed providers.
lahirumaramba
force-pushed
the
lm-fac-1use
branch
3 times, most recently
from
c51e981
to
913d149
Compare
lahirumaramba
commented
Apr 14, 2023
lahirumaramba
commented
Apr 14, 2023
lahirumaramba
requested review from
kevinthecheung
and removed request for
egilmorez
taeold
approved these changes
Apr 17, 2023
kevinthecheung
approved these changes
Apr 17, 2023
src/app-check/app-check-api.ts
Outdated
| @@ -41,6 +41,27 @@ export interface AppCheckTokenOptions { | |||
| ttlMillis?: number; | |||
| } | |||
|
|
|||
| /** | |||
| * Interface representing options for {@link AppCheck.verifyToken} method. | |||
There was a problem hiding this comment.
Suggested change
| * Interface representing options for {@link AppCheck.verifyToken} method. | |
| * Interface representing options for the {@link AppCheck.verifyToken} method. |
src/app-check/app-check-api.ts
Outdated
Comment on lines
49
to
52
| * To use the replay protection feature, set this to true to mark the token as consumed. | ||
| * Tokens that are found to be already consumed will be marked as such in the response. |
There was a problem hiding this comment.
Suggested change
| * To use the replay protection feature, set this to true to mark the token as consumed. | |
| * Tokens that are found to be already consumed will be marked as such in the response. | |
| * To use the replay protection feature, set this to true. The {@link AppCheck.verifyToken} | |
| * method will mark the token as consumed after verifying it. | |
| * | |
| * Tokens that are found to be already consumed will be marked as such in the response. |
weixifan
approved these changes
Apr 19, 2023
lahirumaramba
changed the title
verifyToken() API
lahirumaramba
assigned lahirumaramba and unassigned kevinthecheung, taeold and weixifan
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.
RELEASE NOTE: Added replay protection feature to App Check
verifyToken()API.