@react-native-firebase/app-check 18.6.1 → 18.7.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [18.7.0](https://github.com/invertase/react-native-firebase/compare/v18.6.2...v18.7.0) (2023-11-28)
+
+### Features
+
+- **app-check:** implement getLimitedUseToken / Replay Protection ([#7424](https://github.com/invertase/react-native-firebase/issues/7424)) ([c6cd505](https://github.com/invertase/react-native-firebase/commit/c6cd50501a09855fe7253873549eabe869a24978))
+
+## [18.6.2](https://github.com/invertase/react-native-firebase/compare/v18.6.1...v18.6.2) (2023-11-23)
+
+**Note:** Version bump only for package @react-native-firebase/app-check
+
 ## [18.6.1](https://github.com/invertase/react-native-firebase/compare/v18.6.0...v18.6.1) (2023-11-01)
 
 **Note:** Version bump only for package @react-native-firebase/app-check

package/android/src/main/java/io/invertase/firebase/appcheck/ReactNativeFirebaseAppCheckModule.java

@@ -206,6 +206,35 @@ public class ReactNativeFirebaseAppCheckModule extends ReactNativeFirebaseModule
             });
   }
 
+  @ReactMethod
+  public void getLimitedUseToken(String appName, Promise promise) {
+    Log.d(LOGTAG, "getLimitedUseToken appName: " + appName);
+    FirebaseApp firebaseApp = FirebaseApp.getInstance(appName);
+
+    Tasks.call(
+            getExecutor(),
+            () -> {
+              return Tasks.await(
+                  FirebaseAppCheck.getInstance(firebaseApp).getLimitedUseAppCheckToken());
+            })
+        .addOnCompleteListener(
+            getExecutor(),
+            (task) -> {
+              if (task.isSuccessful()) {
+                WritableMap tokenResultMap = Arguments.createMap();
+                tokenResultMap.putString("token", task.getResult().getToken());
+                promise.resolve(tokenResultMap);
+              } else {
+                Log.e(
+                    LOGTAG,
+                    "Unknown error while fetching limited-use AppCheck token "
+                        + task.getException().getMessage());
+                rejectPromiseWithCodeAndMessage(
+                    promise, "token-error", task.getException().getMessage());
+              }
+            });
+  }
+
   /** Add a new token change listener - if one doesn't exist already */
   @ReactMethod
   public void addAppCheckListener(final String appName) {

package/ios/RNFBAppCheck/RNFBAppCheckModule.m

@@ -134,4 +134,38 @@ RCT_EXPORT_METHOD(getToken
                }];
 }
 
+RCT_EXPORT_METHOD(getLimitedUseToken
+                  : (FIRApp *)firebaseApp
+                  : (RCTPromiseResolveBlock)resolve
+                  : (RCTPromiseRejectBlock)reject) {
+  FIRAppCheck *appCheck = [FIRAppCheck appCheckWithApp:firebaseApp];
+  DLog(@"appName %@", firebaseApp.name);
+  [appCheck limitedUseTokenWithCompletion:^(FIRAppCheckToken *_Nullable token,
+                                            NSError *_Nullable error) {
+    if (error != nil) {
+      // Handle any errors if the token was not retrieved.
+      DLog(@"RNFBAppCheck - getLimitedUseToken - Unable to retrieve App Check token: %@", error);
+      [RNFBSharedUtils rejectPromiseWithUserInfo:reject
+                                        userInfo:(NSMutableDictionary *)@{
+                                          @"code" : @"token-error",
+                                          @"message" : [error localizedDescription],
+                                        }];
+      return;
+    }
+    if (token == nil) {
+      DLog(@"RNFBAppCheck - getLimitedUseToken - Unable to retrieve App Check token.");
+      [RNFBSharedUtils rejectPromiseWithUserInfo:reject
+                                        userInfo:(NSMutableDictionary *)@{
+                                          @"code" : @"token-null",
+                                          @"message" : @"no token fetched",
+                                        }];
+      return;
+    }
+
+    NSMutableDictionary *tokenResultDictionary = [NSMutableDictionary new];
+    tokenResultDictionary[@"token"] = token.token;
+    resolve(tokenResultDictionary);
+  }];
+}
+
 @end

package/ios/RNFBAppCheck/RNFBAppCheckProvider.m

@@ -76,8 +76,14 @@
 
 - (void)getTokenWithCompletion:(nonnull void (^)(FIRAppCheckToken *_Nullable,
                                                  NSError *_Nullable))handler {
-  DLog(@"proxying to delegateProvider...");
+  DLog(@"proxying getTokenWithCompletion to delegateProvider...");
   [self.delegateProvider getTokenWithCompletion:handler];
 }
 
+- (void)getLimitedUseTokenWithCompletion:(nonnull void (^)(FIRAppCheckToken *_Nullable,
+                                                           NSError *_Nullable))handler {
+  DLog(@"proxying getLimitedUseTokenWithCompletion to delegateProvider...");
+  [self.delegateProvider getLimitedUseTokenWithCompletion:handler];
+}
+
 @end

package/lib/index.d.ts

@@ -266,6 +266,14 @@ export namespace FirebaseAppCheckTypes {
      */
     getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
 
+    /**
+     * Requests a Firebase App Check token. This method should be used only if you need to authorize requests
+     * to a non-Firebase backend. Returns limited-use tokens that are intended for use with your non-Firebase
+     * backend endpoints that are protected with Replay Protection (https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection).
+     * This method does not affect the token generation behavior of the getAppCheckToken() method.
+     */
+    getLimitedUseToken(): Promise<AppCheckTokenResult>;
+
     /**
      * Registers a listener to changes in the token state. There can be more
      * than one listener registered at the same time for one or more

package/lib/index.js

@@ -29,6 +29,7 @@ import version from './version';
 export {
   addTokenListener,
   getToken,
+  getLimitedUseToken,
   initializeAppCheck,
   setTokenAutoRefreshEnabled,
 } from './modular/index';
@@ -141,6 +142,10 @@ class FirebaseAppCheckModule extends FirebaseModule {
     }
   }
 
+  getLimitedUseToken() {
+    return this.native.getLimitedUseToken();
+  }
+
   _parseListener(listenerOrObserver) {
     return typeof listenerOrObserver === 'object'
       ? listenerOrObserver.next.bind(listenerOrObserver)

package/lib/modular/index.js

@@ -45,6 +45,16 @@ export function getToken(appCheckInstance, forceRefresh) {
   return appCheckInstance.app.appCheck().getToken(forceRefresh);
 }
 
+/**
+ * Get a limited-use (consumable) App Check token.
+ * For use with server calls to firebase functions or custom backends using the firebase admin SDK
+ * @param appCheckInstance - AppCheck
+ * @returns {Promise<AppCheckTokenResult>}
+ */
+export function getLimitedUseToken(appCheckInstance) {
+  return appCheckInstance.app.appCheck().getLimitedUseToken();
+}
+
 /**
  * Registers a listener to changes in the token state.
  * There can be more than one listener registered at the same time for one or more App Check instances.

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '18.6.1';
+module.exports = '18.7.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app-check",
-  "version": "18.6.1",
+  "version": "18.7.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - App Check",
   "main": "lib/index.js",
@@ -23,10 +23,10 @@
     "appCheck"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "18.6.1"
+    "@react-native-firebase/app": "18.7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3d73352fb7434251fe661b426115339cf6d30bc1"
+  "gitHead": "02f1a2e1f32032b187b94316584e5b70abb47477"
 }

package/ios/RNFBAppCheck/RNFBAppCheckDebugProvider.h

@@ -1,7 +0,0 @@
-// Subclass FIRAppCheckDebugProvider here
-// https://developer.apple.com/library/archive/documentation/General/Conceptual/DevPedia-CocoaCore/MethodOverriding.html
-
-// 1. have a new nullable configuredDebugToken property
-// 2. override implementation of currentDebutToken to:
-//   - return configuredDebugToken if it exists,
-//   - else return [super currentDebugToken] if not