在 Apple 平台上使用 App Check 與調試提供者

如果在為App Check 註冊您的應用程式後,您希望在App Check 通常不會歸類為有效的環境中運行您的應用程序,例如開發期間的模擬器,或在持續整合(CI) 環境中,您可以建立應用程式的偵錯版本,該版本使用 App Check 偵錯提供者而不是真正的證明提供者。

在模擬器中使用調試提供程序

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

  1. 在偵錯版本中,在使用任何 Firebase 後端服務之前,請建立並設定 App Check 偵錯提供者工廠:

    迅速

    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. 從左側選單中選擇“運行” ,然後選擇“參數”標籤。
    3. 「啟動時傳遞的參數」部分中,新增-FIRDebugEnabled
  3. 啟動應用程式。當 SDK 嘗試向後端發送請求時,將記錄本機偵錯令牌。例如:

    [Firebase/AppCheck][I-FAA001001] Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. 在 Firebase 控制台的「套用檢查」部分中,從應用程式的溢出選單中選擇「管理偵錯令牌」 。然後,註冊您在上一個步驟中記錄的偵錯令牌。

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

註冊令牌後,Firebase 後端服務會將其視為有效。

由於此代幣允許在沒有有效設備的情況下存取您的 Firebase 資源,因此保持其隱私至關重要。不要將其提交到公共儲存庫,如果註冊的令牌遭到洩露,請立即在 Firebase 控制台中撤銷它。

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

若要在持續整合 (CI) 環境中使用偵錯提供程序,請執行下列操作:

  1. 在 Firebase 控制台的「套用檢查」部分中,從應用程式的溢出選單中選擇「管理偵錯令牌」 。然後,建立一個新的調試令牌。您在下一步中將需要該令牌。

    由於此代幣允許在沒有有效設備的情況下存取您的 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. 配置 CI 測試腳本以將偵錯令牌作為環境變數傳遞。例如:

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

    迅速

    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 後端服務將接受其發送的有效令牌。