使用 App Check 保護 API 金鑰

Firebase App Check 會封鎖來自非合法應用程式的流量，為應用程式對 Google 地圖平台的呼叫提供保護。方法是檢查 Play Integrity 等認證供應器提供的權杖。將應用程式與 App Check 整合，有助於防範惡意要求，避免您因未經授權的 API 呼叫而遭到收費。

我是否適合使用 App Check？

在大多數情況下，建議您使用 App Check，但在下列情況下，App Check 並非必要或不受支援：

  • 您使用的是原始的 Places SDK。App Check 僅支援 Places SDK (新版)。
  • 私人或實驗性應用程式。如果您的應用程式不開放公開存取，則不需要使用 App Check。
  • 如果您的應用程式只用於伺服器對伺服器，則不需要使用 App Check。不過，如果與 GMP 通訊的伺服器是由公開用戶端 (例如行動應用程式) 使用，建議您使用 App Check 保護該伺服器，而非 GMP。
  • 在裝置遭到入侵或不受信任時，App Check 建議的認證服務供應器將無法運作。如果您需要支援這類裝置，可以部署自訂認證服務。詳情請參閱操作說明。

導入步驟總覽

整體來說，您必須按照下列步驟將應用程式與 App Check 整合：

  1. 將 Firebase 新增至應用程式。
  2. 新增及初始化 App Check 程式庫。
  3. 新增權杖提供者。
  4. 啟用偵錯功能。
  5. 監控應用程式要求，並決定是否要執行。

整合 App Check 後，您就能在 Firebase 控制台中查看後端流量指標。這些指標會依據請求是否附帶有效的 App Check 權杖，提供請求的詳細資料。詳情請參閱 Firebase App Check 說明文件。

當您確定大部分要求都來自合法來源，且使用者已更新至包含 App Check 實作功能的最新版應用程式，即可啟用強制執行機制。強制執行之後，App Check 就會拒絕所有未取得有效 App Check 權杖的流量。

規劃 App Check 整合時的注意事項

規劃整合時，請考量以下幾點：

  • 我們推薦的認證服務供應商 Play Integrity 針對標準 API 用量層級設有每日呼叫限制。如要進一步瞭解呼叫限制，請參閱 Google Play Integrity 開發人員說明文件中的「設定」頁面。

    您也可以選擇使用自訂認證服務供應器，但這是進階用途。詳情請參閱「實作自訂 App Check 供應器」。

  • 您的應用程式使用者在啟動時會遇到一些延遲。不過，之後任何定期重新認證作業都會在背景執行，使用者應該不會再遇到任何延遲情形。啟動時的延遲時間長短取決於您選擇的認證服務供應商。

    App Check 權杖的有效時間 (稱為「存留時間」或 TTL) 會決定重新認證的頻率。您可以在 Firebase 控制台中設定這個時間長度。在 TTL 過半時，系統會重新認證。詳情請參閱認證服務供應商的 Firebase 說明文件。

將應用程式與 App Check 整合

必要條件

  • 已整合 4.1 以上版本 Places SDK 的應用程式。
  • 應用程式的 SHA-256 指紋。
  • 應用程式的套件名稱。
  • 您必須是 Cloud 控制台中應用程式的擁有者。
  • 您需要 Cloud 控制台中的應用程式專案 ID

步驟 1：將 Firebase 新增至應用程式

請按照 Firebase 開發人員說明文件中的操作說明，將 Firebase 新增至應用程式。

步驟 2：新增 App Check 程式庫並初始化 App Check

如要瞭解如何使用預設認證服務供應商 Play Integrity，請參閱「開始在 Android 上使用 App Check 和 Play Integrity」。

  1. 如果尚未完成，請將 Places SDK 整合至應用程式。

  2. 接著，請初始化 App Check 和 Places 用戶端。

    // Initialize App Check
FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());
  
// Initialize Places SDK
Places.initializeWithNewPlacesApiEnabled(context, API_KEY);
PlacesClient client = Places.createClient(context);.

步驟 3：新增權杖供應器

初始化 Places API 後，請呼叫 setPlacesAppCheckTokenProvider() 來設定 PlacesAppCheckTokenProvider。

Places.initializeWithNewPlacesApiEnabled(context, API_KEY);
Places.setPlacesAppCheckTokenProvider(new TokenProvider());
PlacesClient client = Places.createClient(context);.

以下是符記擷取器介面的實作範例：

  /** Sample client implementation of App Check token fetcher interface. */
  static class TokenProvider implements PlacesAppCheckTokenProvider {
    @Override
    public ListenableFuture<String> fetchAppCheckToken() {
      SettableFuture<String> future = SettableFuture.create();
      FirebaseAppCheck.getInstance()
          .getAppCheckToken(false)
          .addOnSuccessListener(
              appCheckToken -> {
                future.set(appCheckToken.getToken());
              })
          .addOnFailureListener(
              ex -> {
                future.setException(ex);
              });

      return future;
    }
  }

步驟 4：啟用偵錯功能 (選用)

如果您想在本機開發及測試應用程式，或是在持續整合 (CI) 環境中執行應用程式，可以建立應用程式的偵錯版本，使用偵錯密鑰取得有效的 App Check 符記。這樣一來，您就不會在偵錯版本中使用實際的認證提供者。

如要在模擬器或測試裝置上執行應用程式，請按照下列步驟操作：

  • 將 App Check 程式庫新增至 build.gradle 檔案。
  • 設定 App Check，以便在偵錯版本中使用偵錯提供者工廠。
  • 啟動應用程式，這麼做會建立本機偵錯符記。將這個權杖新增至 Firebase 控制台。
  • 如需更多資訊和操作說明，請參閱 App Check 說明文件。

如要在 CI 環境中執行應用程式，請按照下列步驟操作：

  • 在 Firebase 主控台中建立偵錯權杖，然後將其新增至 CI 系統的安全金鑰存放區。
  • 將 App Check 程式庫新增至 build.gradle 檔案。
  • 設定 CI 建構變化版本，以便使用偵錯符記。
  • 在需要 App Check 權杖的測試類別中，使用 DebugAppCheckTestHelper 包裝程式碼。
  • 如需更多資訊和操作說明，請參閱 App Check 說明文件。

步驟 5：監控應用程式要求並決定是否執行

在開始執行前，請務必確認不會影響應用程式的合法使用者。如要確認這點，請前往「App Check」指標畫面，查看應用程式流量中經過驗證、過時或不合法的百分比。確認大部分流量都已驗證後，即可啟用強制執行機制。

詳情請參閱 Firebase App Check 說明文件。