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

為應用程式註冊 App Check 後,如果您想在 App Check 通常不會歸類為有效的環境中 (例如在開發期間在本機或持續整合 (CI) 環境中) 執行應用程式,則可以建立使用 App Check 偵錯供應商 (而非實際認證供應商) 的應用程式偵錯版本。

在 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. 在 Firebase 控制台的「App Check」(App Check) 部分,從應用程式的溢位選單中選擇「Manage debug token」。接著,註冊您在先前步驟中記錄的偵錯權杖。

    「管理偵錯權杖」選單項目的螢幕截圖

註冊權杖後,Firebase 後端服務會接受該權杖的有效性。

由於這個權杖可在沒有有效裝置的情況下存取您的 Firebase 資源,因此請務必確保其私密性。請勿將其提交至公開存放區。如果註冊的憑證遭駭,請在 Firebase 控制台立即撤銷該權杖。

這個權杖儲存在本機瀏覽器中,每當您在相同機器上的相同瀏覽器中使用應用程式時,都會使用這個權杖。如要在其他瀏覽器或其他機器上使用這個權杖,請將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為權杖字串,而非 true

在 CI 環境中使用偵錯供應商

如要在持續整合 (CI) 環境中使用偵錯供應商,請按照下列步驟操作:

  1. 在 Firebase 控制台的「App Check」(App Check) 部分,從應用程式的溢位選單中選擇「Manage debug token」。接著建立新的偵錯權杖。下個步驟中會會用到這組權杖。

    由於這個權杖可讓您在不使用有效裝置的情況下存取 Firebase 資源,因此請務必確保憑證不外洩。請勿將其提交至公開存放區。如果註冊的憑證遭駭,請在 Firebase 控制台立即撤銷該權杖。

    「管理偵錯權杖」選單項目的螢幕截圖

  2. 將您剛剛建立的偵錯權杖新增至 CI 系統的安全金鑰儲存庫 (例如 GitHub Actions 的加密密鑰或 Travis CI 的加密變數)。

  3. 如有需要,請設定持續整合系統,以在 CI 環境中提供偵錯權杖做為環境變數。以類似 APP_CHECK_DEBUG_TOKEN_FROM_CI 的形式為變數命名。

  4. 在偵錯版本中,將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為偵錯權杖環境變數的值來啟用偵錯模式,再匯入 App Check。例如:

    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 環境中執行應用程式時,Firebase 後端服務會接受其傳送的有效權杖。