在 Web 應用程式中將 App Check 與偵錯提供者結合使用

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

在本機上使用調試提供者

若要在從localhost執行應用程式時(例如在開發期間)使用偵錯提供程序,請執行下列操作:

  1. 在偵錯版本中,在初始化 App Check 之前,透過將self.FIREBASE_APPCHECK_DEBUG_TOKEN設為true來啟用偵錯模式。例如:

    網路模組化API

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

    Web 命名空間 API

    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 控制台的「套用檢查」部分中,從應用程式的溢出選單中選擇「管理偵錯令牌」 。然後,註冊您在上一個步驟中登入的偵錯令牌。

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

註冊令牌後,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設定為偵錯令牌環境變數的值來啟用偵錯模式。例如:

    網路模組化API

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

    Web 命名空間 API

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

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