透過 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. 從左選單中選取「執行」，然後選取「引數」分頁標籤。
    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 部分，從應用程式的溢位選單中選擇「管理偵錯符記」。接著，請註冊您在上一個步驟中記錄的偵錯權杖。

    「Manage Debug Tokens」選單項目的螢幕截圖

註冊憑證後，Firebase 後端服務會將其視為有效憑證。

由於這組權杖可在沒有有效裝置的情況下存取 Firebase 資源，因此請務必保密。請勿將其提交至公開存放區，如果註冊的權杖遭到入侵，請立即在 Firebase 控制台中撤銷。

在持續整合環境中使用偵錯提供者

如要在持續整合 (CI) 環境中使用偵錯提供者，請執行下列操作：

  1. 在 Firebase 控制台的 App Check 部分，從應用程式的溢位選單中選擇「管理偵錯符記」。接著，請建立新的偵錯權杖。您將在下一個步驟中使用這組符記。

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

    「Manage Debug Tokens」選單項目的螢幕截圖

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

  3. 如有需要，請設定持續整合系統，讓偵錯符記碼可在持續整合環境中做為環境變數使用。為變數命名，例如 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. 在偵錯版本中，請先建立並設定 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 後端服務會將其傳送的權杖視為有效。