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

針對 App Check 註冊 App Check 後,如果您想在 App Check 通常不會歸類為有效的環境中執行應用程式,例如在開發期間使用模擬器或裝置,或是從持續整合 (CI) 環境執行,您可以使用應用程式檢查偵錯提供者 (而非實際認證提供者) 建立應用程式的偵錯版本。

在開發階段使用偵錯提供者

如要在以互動方式執行應用程式時 (例如開發期間) 使用偵錯提供者,請執行以下操作:

  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」(產品) >「Scheem」(配置) >「Edit scheme」(編輯配置)。
    2. 選取左選單中的「Run」,然後選取「Arguments」分頁標籤。
    3. 在「Arguments Passed on Launch」區段中,新增 -FIRDebugEnabled
  3. 啟動應用程式。當 SDK 嘗試傳送要求至後端時,系統會記錄本機偵錯權杖。例如:

    [Firebase/AppCheck][I-FAA001001] Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. 在 Firebase 控制台的「App Check」區段中,從應用程式的溢位選單中選擇「管理偵錯權杖」。接著,註冊您在上一個步驟中記錄的偵錯權杖。

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

註冊權杖後,Firebase 後端服務會接受權杖。

由於這個權杖可在沒有有效裝置的情況下存取 Firebase 資源,因此請務必妥善保管。不要將其提交至公開存放區,如果已註冊的憑證遭到入侵,請立即在 Firebase 控制台中撤銷。

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

如要在持續整合 (CI) 環境中使用偵錯提供者,請按照下列指示操作:

  1. 在 Firebase 控制台的「App Check」區段中,從應用程式的溢位選單中選擇「管理偵錯權杖」。接著建立新的偵錯權杖。下一個步驟會需要用到權杖。

    由於這組憑證可在沒有有效裝置的情況下存取 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];

應用程式在持續整合環境中執行時,Firebase 後端服務會接受自身傳送的權杖有效。