將 App Check 與偵錯服務供應商搭配使用

如果您的應用程式已註冊 App Check，而您想要在 App Check 通常不會歸入有效的環境 (例如開發期間的模擬器，或從持續整合 (CI) 環境) 中執行應用程式，則可以使用 App Check 偵錯供應商而非 App Attest 為應用程式建立偵錯版本。

在模擬器中使用偵錯提供者

如要在模擬器中執行應用程式的互動方式 (例如在開發期間) 使用偵錯提供者，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的「API 和服務」專區，然後在「憑證」頁面查詢專案的 iOS API 金鑰。

  2. 在偵錯版本中，將 App Check 設為使用偵錯提供者。您必須指定上一個步驟中取得的 API 金鑰。

    #if targetEnvironment(simulator)
GIDSignIn.sharedInstance.configureDebugProvider(withAPIKey: apiKey) { error in
  if let error {
    print("Error configuring `GIDSignIn` for App Check: \(error)")
  }
}
#else
// Configure App Check for production.
#endif

  3. 啟動應用程式。當 SDK 嘗試傳送要求至後端時，會將本機偵錯權杖記錄至 Xcode 主控台。例如：

    <Warning> [AppCheckCore][I-GAC004001] App Check debug token:
'123a4567-b89c-12d3-e456-789012345678'.

  4. 在 Firebase 控制台的「App Check」部分，從應用程式的溢位選單中選擇「Manage debug token」。接著，註冊您在上個步驟記錄的偵錯權杖。

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

註冊權杖後，Google 的 OAuth 2.0 端點會接受該權杖，使其適用於您的專案。

由於這個權杖可在沒有有效裝置的情況下存取驗證端點，因此請務必妥善保管。請勿將其提交至公開存放區。如果註冊的憑證遭盜用，請立即在 Firebase 控制台中撤銷。

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

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

  1. 在 Firebase 控制台的「App Check」部分，從應用程式的溢位選單中選擇「Manage debug token」。接著，建立新的偵錯權杖。下一步將會用到這個權杖。

    由於這個權杖可在沒有有效裝置的情況下存取驗證端點，因此請務必妥善保管。請勿將其提交至公開存放區。如果註冊的憑證遭盜用，請立即在 Firebase 控制台中撤銷。

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

  2. 將您剛建立的偵錯權杖新增至持續整合系統的安全金鑰儲存庫 (例如 GitHub Actions 的加密密鑰，或是 Travis CI 的加密變數)。

  3. 如有需要，請設定持續整合系統，在 CI 環境中以環境變數形式提供偵錯權杖。將變數命名為 APP_CHECK_DEBUG_TOKEN_FROM_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. 前往 Google Cloud 控制台的「API 和服務」專區，然後在「憑證」頁面查詢專案的 iOS API 金鑰。

  7. 在偵錯版本中，將 App Check 設為使用偵錯提供者。您必須指定上一個步驟中取得的 API 金鑰。

    #if targetEnvironment(simulator)
GIDSignIn.sharedInstance.configureDebugProvider(withAPIKey: apiKey) { error in
  if let error {
    print("Error configuring `GIDSignIn` for App Check: \(error)")
  }
}
#else
// Configure App Check for production.
#endif

當應用程式在 CI 環境中執行時，Google 的 OAuth 2.0 端點會接受傳送至專案的有效權杖。