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

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

在開發期間使用偵錯提供者

如要在以互動方式執行應用程式時 (例如開發期間) 使用偵錯供應器,請按照下列步驟操作:

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

    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 專案 (11.0 以上版本) 中啟用偵錯記錄:

    1. 開啟「Product」>「Scheme」>「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 系統,在 CI 環境中以環境變數的形式提供偵錯權杖。將變數命名為 APP_CHECK_DEBUG_TOKEN_FROM_CI 等名稱。

  4. 在 Xcode 中,將環境變數新增至測試架構,並將名稱設為 FIRAAppCheckDebugToken,值設為 $(APP_CHECK_DEBUG_TOKEN) 等。

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

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

    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 後端服務會接受應用程式傳送的權杖,並視為有效。