Add support for App Check replay protection in callable functions#7296

avolkovi · 2023-05-12T16:47:40Z

Hey there! So you want to contribute to a Firebase SDK?
Before you file this pull request, please read these guidelines:

Discussion

Read the contribution guidelines (CONTRIBUTING.md).
If this has been discussed in an issue, make sure to link to the issue here.
If not, go file an issue about this before creating a pull request to discuss.

Testing

Make sure all existing tests in the repository pass after your change.
If you fixed a bug or added a feature, add a new test to cover your code.

API Changes

internal API proposal: go/fac-1-use-callable-sdk

changeset-bot · 2023-05-12T16:47:44Z

🦋 Changeset detected

Latest commit: 2ca507c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@firebase/app-check-interop-types	Minor
@firebase/app-check	Minor
@firebase/functions	Minor
@firebase/app-check-compat	Patch
firebase	Patch
@firebase/functions-compat	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

hsubox76

Code LG, one suggestion to streamline the test.

For the PR process:

This will need a changeset (yarn changeset will automatically help you add the packages (should be patch for app-check and minor for functions) but you'll also need to add 'firebase': minor manually beneath those.
This will make a docs change, you'll need to run yarn docgen devsite and check in chagnes to the docs-devsite dir and have them reviewed by the appropriate tech writer for App Check which I think is @kevinthecheung

packages/functions/src/callable.test.ts

google-oss-bot · 2023-05-12T17:10:20Z

Size Report ¹

Affected Products

@firebase/app-check
Type Base (a9da1b7) Merge (84629f5) Diff
browser 26.2 kB 26.2 kB +54 B (+0.2%)
esm5 31.4 kB 31.5 kB +69 B (+0.2%)
main 32.6 kB 32.7 kB +69 B (+0.2%)
module 26.2 kB 26.2 kB +54 B (+0.2%)
@firebase/functions
Type Base (a9da1b7) Merge (84629f5) Diff
browser 9.55 kB 9.72 kB +170 B (+1.8%)
esm5 11.8 kB 12.1 kB +256 B (+2.2%)
main 12.6 kB 12.9 kB +256 B (+2.0%)
module 9.55 kB 9.72 kB +170 B (+1.8%)

`bundle`

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
app-check (CustomProvider)	36.3 kB	36.6 kB	+254 B (+0.7%)
app-check (ReCaptchaEnterpriseProvider)	38.8 kB	39.1 kB	+254 B (+0.7%)
app-check (ReCaptchaV3Provider)	38.8 kB	39.1 kB	+254 B (+0.7%)
functions (call)	31.1 kB	31.2 kB	+72 B (+0.2%)

`firebase`

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
firebase-app-check-compat.js	23.1 kB	23.3 kB	+246 B (+1.1%)
firebase-app-check.js	22.1 kB	22.1 kB	+34 B (+0.2%)
firebase-compat.js	773 kB	773 kB	+321 B (+0.0%)
firebase-functions-compat.js	8.12 kB	8.19 kB	+72 B (+0.9%)
firebase-functions.js	11.0 kB	11.0 kB	+72 B (+0.7%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/1DHis6URo1.html

google-oss-bot · 2023-05-12T17:28:36Z

Size Analysis Report ¹

Affected Products

`@firebase/app-check`

`CustomProvider`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	7.51 kB	7.65 kB	+142 B (+1.9%)
size-with-ext-deps	25.2 kB	25.4 kB	+146 B (+0.6%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

20 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

21 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getLimitedUseToken$1 getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

`ReCaptchaEnterpriseProvider`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	11.2 kB	11.3 kB	+144 B (+1.3%)
size-with-ext-deps	28.8 kB	28.9 kB	+146 B (+0.5%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

33 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaEnterpriseTokenRequest getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeEnterprise internalFactory isValid loadReCAPTCHAEnterpriseScript makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage

34 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaEnterpriseTokenRequest getLimitedUseToken$1 getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeEnterprise internalFactory isValid loadReCAPTCHAEnterpriseScript makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

`ReCaptchaV3Provider`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	11.2 kB	11.3 kB	+144 B (+1.3%)
size-with-ext-deps	28.7 kB	28.9 kB	+146 B (+0.5%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

33 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaV3TokenRequest getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeV3 internalFactory isValid loadReCAPTCHAV3Script makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage

34 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaV3TokenRequest getLimitedUseToken$1 getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeV3 internalFactory isValid loadReCAPTCHAV3Script makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

getLimitedUseToken
Size
Type Base (a9da1b7) Merge (84629f5) Diff
size 7.19 kB 7.22 kB +28 B (+0.4%)
size-with-ext-deps 24.5 kB 24.5 kB +29 B (+0.1%)

`getToken`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	7.13 kB	7.28 kB	+142 B (+2.0%)
size-with-ext-deps	24.4 kB	24.5 kB	+146 B (+0.6%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

21 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

22 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getLimitedUseToken$1 getStateReference getToken getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

`initializeAppCheck`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	10.9 kB	11.1 kB	+249 B (+2.3%)
size-with-ext-deps	35.3 kB	35.6 kB	+254 B (+0.7%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

35 dependencies

_activate addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDebugState getDebugToken getExchangeDebugTokenRequest getStateReference getToken$2 initTokenRefresher initializeAppCheck initializeDebugMode internalFactory isDebugMode isValid makeDummyTokenResult notifyTokenListeners read readDebugTokenFromIndexedDB readOrCreateDebugTokenFromStorage readTokenFromIndexedDB readTokenFromStorage registerAppCheck removeTokenListener setInitialState sleep write writeDebugTokenToIndexedDB writeTokenToIndexedDB writeTokenToStorage

36 dependencies

_activate addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDebugState getDebugToken getExchangeDebugTokenRequest getLimitedUseToken$1 getStateReference getToken$2 initTokenRefresher initializeAppCheck initializeDebugMode internalFactory isDebugMode isValid makeDummyTokenResult notifyTokenListeners read readDebugTokenFromIndexedDB readOrCreateDebugTokenFromStorage readTokenFromIndexedDB readTokenFromStorage registerAppCheck removeTokenListener setInitialState sleep write writeDebugTokenToIndexedDB writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

`onTokenChanged`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	7.23 kB	7.37 kB	+142 B (+2.0%)
size-with-ext-deps	24.5 kB	24.6 kB	+146 B (+0.6%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

21 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners onTokenChanged registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

22 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getLimitedUseToken$1 getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners onTokenChanged registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

`setTokenAutoRefreshEnabled`

Size

Type	Base (`a9da1b7`)	Merge (`84629f5`)	Diff
size	7.22 kB	7.37 kB	+142 B (+2.0%)
size-with-ext-deps	24.5 kB	24.6 kB	+146 B (+0.6%)

Dependency

Type Base (a9da1b7) Merge (84629f5) Diff

functions

21 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setTokenAutoRefreshEnabled sleep write writeTokenToIndexedDB writeTokenToStorage

22 dependencies

addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getLimitedUseToken$1 getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setTokenAutoRefreshEnabled sleep write writeTokenToIndexedDB writeTokenToStorage

+ getLimitedUseToken$1

@firebase/functions
- connectFunctionsEmulator
  Size
  Type Base (a9da1b7) Merge (84629f5) Diff
  size 2.42 kB 2.46 kB +46 B (+1.9%)
  size-with-ext-deps 19.5 kB 19.5 kB +46 B (+0.2%)
- getFunctions
  Size
  Type Base (a9da1b7) Merge (84629f5) Diff
  size 2.60 kB 2.65 kB +46 B (+1.8%)
  size-with-ext-deps 27.3 kB 27.3 kB +46 B (+0.2%)
- httpsCallable
  Size
  Type Base (a9da1b7) Merge (84629f5) Diff
  size 6.02 kB 6.09 kB +72 B (+1.2%)
  size-with-ext-deps 23.1 kB 23.2 kB +72 B (+0.3%)
- httpsCallableFromURL
  Size
  Type Base (a9da1b7) Merge (84629f5) Diff
  size 5.97 kB 6.04 kB +72 B (+1.2%)
  size-with-ext-deps 23.0 kB 23.1 kB +72 B (+0.3%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/qGq1PCQLa3.html

hsubox76

LG - make sure you get tech writer review before merging.
Also can you add a description? Can just be a link to the design doc/API proposal, it's fine if it's internal, you can just say (internal doc)

packages/functions/src/public-types.ts

Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>

common/api-review/functions.api.md

docs-devsite/functions.httpscallableoptions.md

packages/app-check-interop-types/index.d.ts

ssbushi added 2 commits May 11, 2023 15:02

Add limited token support for functions
8faaddc

add test, works as a unit test, broken karma
6c54002

avolkovi requested review from hsubox76, a team and dwyfrequency as code owners May 12, 2023 16:47

avolkovi assigned hsubox76, ssbushi and avolkovi May 12, 2023

Finish adding support for app check callable functions SDK
f0119d6

avolkovi force-pushed the avolkovi-fac-functions branch from b765a5d to f0119d6Compare May 12, 2023 16:50

hsubox76 reviewed May 12, 2023
View reviewed changes

packages/functions/src/callable.test.ts Outdated Show resolvedHide resolved

PR Feedback
c220234

avolkovi requested review from a team, egilmorez, markarndt and kevinthecheung as code owners May 12, 2023 17:26

avolkovi assigned kevinthecheung May 12, 2023

avolkovi requested a review from hsubox76 May 12, 2023 17:49

hsubox76 approved these changes May 15, 2023
View reviewed changes

kevinthecheung approved these changes May 15, 2023
View reviewed changes

packages/functions/src/public-types.ts Outdated Show resolvedHide resolved

Doc feedback
178e420
Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>

avolkovi force-pushed the avolkovi-fac-functions branch from fb6e91b to 178e420Compare May 15, 2023 22:11

weixifan reviewed May 15, 2023
View reviewed changes

common/api-review/functions.api.md Outdated Show resolvedHide resolved
docs-devsite/functions.httpscallableoptions.md Outdated Show resolvedHide resolved

s/useLimitedUseAppCheckToken/limitedUseAppCheckTokens/g
e378140

weixifan approved these changes May 15, 2023
View reviewed changes

packages/app-check-interop-types/index.d.ts Outdated Show resolvedHide resolved

PR Feedback
2ca507c

avolkovi merged commit e12e7f5 into masterMay 15, 2023

avolkovi deleted the avolkovi-fac-functions branch May 15, 2023 23:25

google-oss-bot mentioned this pull request May 23, 2023
Version Packages #7320
Merged

firebase locked and limited conversation to collaborators Jun 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for App Check replay protection in callable functions#7296

Add support for App Check replay protection in callable functions #7296

avolkovi commented May 12, 2023•
edited
Loading

changeset-botbot commented May 12, 2023•
edited
Loading

hsubox76 left a comment

google-oss-bot commented May 12, 2023•
edited
Loading

`@firebase/app-check`

`@firebase/functions`

`bundle`

`firebase`

google-oss-bot commented May 12, 2023•
edited
Loading

`@firebase/app-check`

`CustomProvider`

`ReCaptchaEnterpriseProvider`

`ReCaptchaV3Provider`

`getLimitedUseToken`

`getToken`

`initializeAppCheck`

`onTokenChanged`

`setTokenAutoRefreshEnabled`

`@firebase/functions`

`connectFunctionsEmulator`

`getFunctions`

`httpsCallable`

`httpsCallableFromURL`

hsubox76 left a comment

Add support for App Check replay protection in callable functions#7296

Add support for App Check replay protection in callable functions #7296

Conversation

avolkovi commented May 12, 2023• edited Loading

Discussion

Testing

API Changes

changeset-botbot commented May 12, 2023• edited Loading

🦋 Changeset detected

hsubox76 left a comment

Choose a reason for hiding this comment

google-oss-bot commented May 12, 2023• edited Loading

Size Report 1

Affected Products

@firebase/app-check

@firebase/functions

bundle

firebase

Test Logs

google-oss-bot commented May 12, 2023• edited Loading

Size Analysis Report 1

Affected Products

@firebase/app-check

CustomProvider

ReCaptchaEnterpriseProvider

ReCaptchaV3Provider

getLimitedUseToken

getToken

initializeAppCheck

onTokenChanged

setTokenAutoRefreshEnabled

@firebase/functions

connectFunctionsEmulator

getFunctions

httpsCallable

httpsCallableFromURL

Test Logs

hsubox76 left a comment

Choose a reason for hiding this comment

avolkovi commented May 12, 2023•
edited
Loading

changeset-botbot commented May 12, 2023•
edited
Loading

google-oss-bot commented May 12, 2023•
edited
Loading

Size Report ¹

`@firebase/app-check`

`@firebase/functions`

`bundle`

`firebase`

google-oss-bot commented May 12, 2023•
edited
Loading

Size Analysis Report ¹

`@firebase/app-check`

`CustomProvider`

`ReCaptchaEnterpriseProvider`

`ReCaptchaV3Provider`

`getLimitedUseToken`

`getToken`

`initializeAppCheck`

`onTokenChanged`

`setTokenAutoRefreshEnabled`

`@firebase/functions`

`connectFunctionsEmulator`

`getFunctions`

`httpsCallable`

`httpsCallableFromURL`