將 App Check 與 Web 應用程序中的調試提供程序一起使用

如果在您為 App Check 註冊了您的應用程序後,您希望在 App Check 通常不會歸類為有效的環境中運行您的應用程序,例如在開發期間本地運行,或者從持續集成 (CI) 環境中運行您的應用程序,您可以創建使用 App Check 調試提供程序而不是真正的證明提供程序的應用程序的調試版本。

在 localhost 上使用調試提供程序

要在從localhost運行您的應用程序時(例如在開發期間)使用調試提供程序,請執行以下操作:

  1. 在您的調試版本中,通過在初始化 App Check 之前將self.FIREBASE_APPCHECK_DEBUG_TOKEN設置為true來啟用調試模式。例如:

    Web version 9

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
    initializeAppCheck(app, { /* App Check options */ });
    

    Web version 8

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
    firebase.appCheck().activate(/* site key or provider */);
    
  2. 在本地訪問您的 Web 應用程序並打開瀏覽器的開發人員工具。在調試控制台中,您將看到一個調試令牌:

    AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678". You will
    need to safelist it in the Firebase console for it to work.
  3. 在 Firebase 控制台的應用檢查部分,從應用的溢出菜單中選擇管理調試令牌。然後,註冊您在上一步中登錄的調試令牌。

    “管理調試令牌”菜單項的屏幕截圖

註冊令牌後,Firebase 後端服務會將其視為有效。

由於此令牌允許在沒有有效設備的情況下訪問您的 Firebase 資源,因此將其保密至關重要。不要將其提交到公共存儲庫,如果已註冊的令牌遭到破壞,請立即在 Firebase 控制台中將其撤消。

此令牌本地存儲在您的瀏覽器中,每當您在同一台機器上的同一瀏覽器中使用您的應用程序時都會使用此令牌。如果您想在另一個瀏覽器或另一台機器上使用令牌,請將self.FIREBASE_APPCHECK_DEBUG_TOKEN設置為令牌字符串而不是true

在 CI 環境中使用調試提供程序

要在持續集成 (CI) 環境中使用調試提供程序,請執行以下操作:

  1. 在 Firebase 控制台的應用檢查部分,從應用的溢出菜單中選擇管理調試令牌。然後,創建一個新的調試令牌。您將在下一步中需要該令牌。

    由於此令牌允許在沒有有效設備的情況下訪問您的 Firebase 資源,因此將其保密至關重要。不要將其提交到公共存儲庫,如果已註冊的令牌遭到破壞,請立即在 Firebase 控制台中將其撤消。

    “管理調試令牌”菜單項的屏幕截圖

  2. 將您剛剛創建的調試令牌添加到 CI 系統的安全密鑰存儲區(例如,GitHub Actions 的加密機密或 Travis CI 的加密變量)。

  3. 如有必要,配置您的 CI 系統以使您的調試令牌在 CI 環境中作為環境變量可用。將變量命名為APP_CHECK_DEBUG_TOKEN_FROM_CI之類的名稱。

  4. 在您的調試版本中,通過在導入 App Check 之前將self.FIREBASE_APPCHECK_DEBUG_TOKEN設置為調試令牌環境變量的值來啟用調試模式。例如:

    Web version 9

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
    initializeAppCheck(app, { /* App Check options */ });
    

    Web version 8

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
    firebase.appCheck().activate(/* site key or provider */);
    

當您的應用在 CI 環境中運行時,Firebase 後端服務將接受它發送的有效令牌。