透過 Apple 平台的偵錯提供者使用 App Check

為應用程式註冊 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. 在 Xcode 專案 (v11.0 以上版本) 中啟用偵錯記錄功能:

    1. 依序開啟「Product」>「Schee」>「Edit scheme」
    2. 選取左選單中的「Run」(執行),然後選取「Arguments」分頁標籤。
    3. 在「Passed on Launch」區段中,新增 -FIRDebugEnabled
  3. 啟動應用程式。當 SDK 嘗試傳送要求至後端時,系統會記錄本機偵錯權杖。例如:

    [Firebase/AppCheck][I-FAA001001] Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. 在 Firebase 控制台的「App Check」(App Check) 部分,從應用程式的溢位選單中選擇「Manage debug token」。接著,註冊您在先前步驟中記錄的偵錯權杖。

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

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

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

在 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. 在 Xcode 中,將環境變數新增至測試配置,名稱為 FIRAAppCheckDebugToken,並將值設為 $(APP_CHECK_DEBUG_TOKEN)

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

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