CloudFunctionsのアプリチェックの実施を有効にする

呼び出し可能なCloudFunctionsでAppCheckトークン要件の適用を開始するには、有効なAppCheckトークンをチェックするように関数を変更します。

あなたが始める前に

AppleAndroid 、およびWebクライアントでアプリチェックを有効にします。

AppCheckサポートを関数に追加します

  1. プロジェクトのfirebase firebase-functionsの依存関係をバージョン3.14.0以降に更新します。

    npm install firebase-functions@">=3.14.0"
    

    プロジェクトのfirebase firebase-admin依存関係をバージョン9.8.0以降に更新します。

    npm install firebase-admin@">=9.8.0"
    
  2. 関数にcontext.appのチェックを追加します。 context.appが定義されていない場合、関数は失敗するはずです。

    exports.yourCallableFunction = functions.https.onCall((data, context) => {
      // context.app will be undefined if the request doesn't include an
      // App Check token. (If the request includes an invalid App Check
      // token, the request will be rejected with HTTP error 401.)
      if (context.app == undefined) {
        throw new functions.https.HttpsError(
            'failed-precondition',
            'The function must be called from an App Check verified app.')
      }
    
      // Your function logic follows.
    });
    
  3. (オプション)独自のロジックで無効なアプリチェックトークンを処理する場合(たとえば、完全な施行を有効にする前に無効なリクエストを拒否するのではなく一時的にログに記録する場合)、 allowInvalidAppCheckTokentrueに設定します。

    exports.yourCallableFunction = functions.
      .runWith({
        allowInvalidAppCheckToken: true  // Opt-out: Requests with invalid App
                                         // Check tokens continue to your code.
      })
      .https.onCall((data, context) => {
        // Now, requests with an invalid App Check token are not rejected.
        //
        // context.app will be undefined if the request:
        //   1) Does not include an App Check token
        //   2) Includes an invalid App Check token
        if (context.app == undefined) {
          // You can inspect the raw request header to check whether an App
          // Check token was provided in the request. If you're not ready to
          // fully enable App Check yet, you could log these conditions instead
          // of throwing errors.
          const rawToken = context.rawRequest.header['X-Firebase-AppCheck'];
          if (rawToken == undefined) {
            throw new functions.https.HttpsError(
                'failed-precondition',
                'The function must be called from an App Check verified app.'
            );
          } else {
            throw new functions.https.HttpsError(
                'unauthenticated',
                'Provided App Check token failed to validate.'
            );
          }
        }
    
        // Your function logic follows.
      });
    

    完全なアプリチェック保護を有効にするには、 allowInvalidAppCheckTokenfalseに設定します。

  4. 関数を再デプロイします。

    firebase deploy --only functions
    

これらの変更がデプロイされると、呼び出し可能なCloudFunctionsには有効なアプリチェックトークンが必要になります。 Cloud FunctionsクライアントSDKは、呼び出し可能な関数を呼び出すと、アプリチェックトークンを自動的にアタッチします。