透過 Apple 平台上的偵錯供應商使用 App Check

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

在模擬器中使用偵錯服務

在模擬器中以互動方式執行應用程式時 (例如在本機開發期間),請按照下列步驟使用偵錯服務:

  1. 在偵錯版本中,使用任何 Firebase 後端服務前,請先建立並設定 App Check 偵錯服務工廠:

    Swift

    let providerFactory = AppCheckDebugProviderFactory()
    AppCheck.setAppCheckProviderFactory(providerFactory)
    
    FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
          [[FIRAppCheckDebugProviderFactory alloc] init];
    [FIRAppCheck setAppCheckProviderFactory:providerFactory];
    
    // Use Firebase library to configure APIs
    [FIRApp configure];
  2. 取得偵錯權杖:

    1. 在模擬器或測試裝置上啟動應用程式。

    2. 開啟 Xcode 控制台,找出 App Check 偵錯權杖。例如:

      <Warning> [AppCheckCore][I-GAC004001] App Check debug token: '123a4567-b89c-12d3-e456-789012345678'.
      
    3. 複製權杖 (例如 123a4567-b89c-12d3-e456-789012345678)。

  3. 向 App Check 註冊偵錯權杖:

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

    2. 找到應用程式,按一下三點溢位選單 (),然後選取「Manage debug tokens」。

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

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

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

這個權杖可讓使用者在沒有有效裝置的情況下存取後端服務,因此請務必保密。請勿將權杖提交至公開存放區,或在應用程式的正式版本中提供。如果註冊的權杖遭到入侵,請立即在 Firebase 控制台中使用「Manage debug tokens」刪除權杖。

在 CI 環境中使用偵錯服務

如要在持續整合 (CI) 環境中使用偵錯服務進行單元測試,請按照下列步驟操作:

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

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

    2. 找到應用程式,按一下三點溢位選單 (),然後選取「Manage debug tokens」。

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

    這個權杖可讓使用者在沒有有效裝置的情況下存取後端服務,因此請務必保密。請勿將權杖提交至公開存放區,或在應用程式的正式版本中提供。如果註冊的權杖遭到入侵,請立即在 Firebase 控制台中使用「Manage debug tokens」刪除權杖。

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

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

  3. 如有需要,請設定 CI 系統,讓偵錯權杖在 CI 環境中做為環境變數使用。將變數命名為 APP_CHECK_DEBUG_TOKEN_FROM_CI。

  4. 在 Xcode 中,將環境變數新增至測試配置,名稱為 AppCheckDebugToken,值則為 $(APP_CHECK_DEBUG_TOKEN) 等。

  5. 設定 CI 測試指令碼,將偵錯權杖做為環境變數傳遞。例如:

    xcodebuild test -scheme YOUR_TEST_SCHEME -workspace YOUR_PROJECT.xcworkspace \
    APP_CHECK_DEBUG_TOKEN=$(APP_CHECK_DEBUG_TOKEN_FROM_CI)
  6. 在偵錯版本中,使用任何 Firebase 後端服務前,請先建立並設定 App Check 偵錯服務工廠:

    Swift

    let providerFactory = AppCheckDebugProviderFactory()
    AppCheck.setAppCheckProviderFactory(providerFactory)
    
    FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
          [[FIRAppCheckDebugProviderFactory alloc] init];
    [FIRAppCheck setAppCheckProviderFactory:providerFactory];
    
    // Use Firebase library to configure APIs
    [FIRApp configure];

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