在網頁應用程式中,搭配偵錯供應商使用 App Check

對後端服務強制執行 App Check 後,應用程式中依附於該後端服務的功能,將無法從 localhost 或持續整合 (CI) 環境執行,因為這些環境不符合有效裝置的資格。如要在開發和測試期間於這些環境中執行應用程式,您必須建立應用程式的偵錯版本,並使用App Check debug provider,而非正式版認證提供者。

在 localhost 上使用偵錯供應器

localhost 執行應用程式時 (例如在本機開發期間),使用偵錯服務的方法如下:

  1. 在偵錯版本中,請先將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為 true,再初始化 App Check,即可啟用偵錯模式。例如:

    Web

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

    Web

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
    firebase.appCheck().activate(/* site key or provider */);
    
  2. 在本地端造訪網頁應用程式,然後開啟瀏覽器的開發人員工具。在偵錯控制台中,您會看到偵錯權杖:

    AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678".
    You will need to safelist it in the Firebase console for it to work.
    
  3. App Check 註冊偵錯權杖:

    1. Firebase 控制台中,依序前往「Security」(安全性) >「App Check」 > 「Apps」(應用程式) 分頁標籤

    2. 找出您的應用程式,按一下三點溢位選單 (),然後選取「管理偵錯權杖」

    3. 按照畫面上的指示註冊偵錯權杖。

    螢幕截圖:Firebase 控制台中的「管理偵錯權杖」選單項目

App Check 註冊權杖後,後端服務就會接受該權杖。

這個權杖可讓您存取後端服務,不必使用有效裝置,因此請務必妥善保管。請勿將其提交至公開存放區,或在應用程式的正式版本中發布。如果註冊的權杖遭到入侵,請立即使用 Firebase 控制台中的「管理偵錯權杖」刪除權杖。

這個權杖會儲存在本機瀏覽器中,只要您在同一部電腦上使用同一個瀏覽器,系統就會使用這個權杖。如要在其他瀏覽器或電腦上使用權杖,請將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為權杖字串,而非 true

在 CI 環境中使用偵錯提供者

以下說明如何在持續整合 (CI) 環境中使用偵錯供應器:

  1. Firebase 控制台中建立偵錯權杖:

    1. Firebase 控制台中,依序前往「Security」(安全性) >「App Check」 > 「Apps」(應用程式) 分頁標籤

    2. 找出您的應用程式,按一下三點溢位選單 (),然後選取「管理偵錯權杖」

    3. 按照畫面上的指示建立新的偵錯權杖。

    這個權杖可讓您存取後端服務,不必使用有效裝置,因此請務必妥善保管。請勿將其提交至公開存放區,或在應用程式的正式版本中發布。如果註冊的權杖遭到入侵,請立即使用 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

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

    Web

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

應用程式在 CI 環境中執行時,後端服務會將傳送的權杖視為有效。