Google 致力于为黑人社区推动种族平等。查看具体举措

使用 Web 应用中的 App Check 保护非 Firebase 资源

您可以使用 App Check 保护应用的非 Firebase 资源,例如自托管后端。为此,您需要修改您的应用程序客户端以将 App Check 令牌与每个请求一起发送到您的后端,并将您的后端修改为每个请求都需要有效的 App Check 令牌;下面对这两项任务进行了说明。

在你开始之前

添加应用程序检查到您的应用程序,将使用默认的reCAPTCHA V3提供商,或自定义提供

使用后端请求发送 App Check 令牌

在您的应用程序客户端,每个请求之前,获得一个有效的,未过期的,应用程序检查与令牌appCheck().getToken()如有必要,App Check 库将刷新令牌。

获得有效令牌后,将其与请求一起发送到后端。你是如何做到这一点的细节是你的,但不发送应用程序检查令牌作为网址的一部分,包括在查询参数,因为这使得他们很容易受到意外泄漏和拦截。以下示例在自定义 HTTP 标头中发送令牌,这是推荐的方法。

网页版 9

const { initializeAppCheck, getToken } = require('firebase/app-check');

const appCheck = initializeAppCheck(
    app,
    { provider: provider } // ReCaptchaV3Provider or CustomProvider
);

const callApiWithAppCheckExample = async () => {
  let appCheckTokenResponse;
  try {
      appCheckTokenResponse = await getToken(appCheck, /* forceRefresh= */ false);
  } catch (err) {
      // Handle any errors if the token was not retrieved.
      return;
  }

  // Include the App Check token with requests to your server.
  const apiResponse = await fetch('https://yourbackend.example.com/yourApiEndpoint', {
      headers: {
          'X-Firebase-AppCheck': appCheckTokenResponse.token,
      }
  });

  // Handle response from your backend.
};

网页版 8

const callApiWithAppCheckExample = async () => {
  let appCheckTokenResponse;
  try {
      appCheckTokenResponse = await firebase.appCheck().getToken(/* forceRefresh= */ false);
  } catch (err) {
      // Handle any errors if the token was not retrieved.
      return;
  }

  // Include the App Check token with requests to your server.
  const apiResponse = await fetch('https://yourbackend.example.com/yourApiEndpoint', {
      headers: {
          'X-Firebase-AppCheck': appCheckTokenResponse.token,
      }
  });

  // Handle response from your backend.
};

在后端验证 App Check 令牌

在你的后端代码,如果您尚未安装了Node.js的管理SDK ,这样做。然后,向 API 端点添加执行以下操作的逻辑:

  • 检查每个请求是否包含 App Check 令牌。

  • 验证应用程序检查令牌使用管理SDK的appCheck().verifyToken()方法。

    如果验证成功, verifyToken()返回解码的应用程序检查令牌。成功验证表明令牌源自属于您的 Firebase 项目的应用。

拒绝任何未通过检查的请求。例如,使用 Express.js 中间件:

const express = require('express');
const app = express();

const firebaseAdmin = require('firebase-admin');
const firebaseApp = firebaseAdmin.initializeApp();

const appCheckVerification = async (req, res, next) => {
    const appCheckToken = req.header('X-Firebase-AppCheck');

    if (!appCheckToken) {
        res.status(401);
        return next('Unauthorized');
    }

    try {
        const appCheckClaims = await firebaseAdmin.appCheck().verifyToken(appCheckToken);

        // If verifyToken() succeeds, continue with the next middleware
        // function in the stack.
        return next();
    } catch (err) {
        res.status(401);
        return next('Unauthorized');
    }
}

app.get('/yourApiEndpoint', [appCheckVerification], (req, res) => {
    // Handle request.
});