透過 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. 開啟產品 >配置 >編輯配置
    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. 在「App Check」(應用程式檢查) 部分 前往 Firebase 控制台,然後在應用程式的「管理偵錯權杖」中選擇「管理偵錯權杖」 溢位選單接著,註冊您在先前記錄中登入的偵錯權杖 採用

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

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

因為這組權杖可讓您在沒有 有效的裝置,請務必確保該裝置的私密性。請勿將程式碼部署至 公開存放區,如果註冊權杖曾遭駭,請撤銷該組權杖 設定流程

在 CI 環境中使用偵錯供應商

如要在持續整合 (CI) 環境中使用偵錯供應商,請按照下列步驟操作: 包括:

  1. 在「App Check」(應用程式檢查) 部分 前往 Firebase 控制台,然後在應用程式的「管理偵錯權杖」中選擇「管理偵錯權杖」 溢位選單接著建立新的偵錯權杖。需在 下一步

    因為這項權杖可在沒有專案的情況下存取 Firebase 資源 有效的裝置,請務必確保該裝置的私密性。請勿將程式碼部署至 公開存放區,如果註冊權杖曾遭駭,請撤銷該組權杖 設定流程

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

  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. 在偵錯版本中使用任何 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 後端服務會接受 傳送的憑證