選取平台： Android iOS JavaScript

使用應用程式檢查服務保護 API 金鑰安全

Firebase App Check 可封鎖來自正當應用程式以外來源的流量，保護應用程式對 Google 地圖平台發出的呼叫。方法是檢查認證供應商 (例如 Play Integrity) 的權杖。將應用程式與 App Check 整合，有助於防範惡意要求，避免因未經授權的 API 呼叫而產生費用。

我適合使用 App Check 嗎？

在大多數情況下，建議使用應用程式檢查，但在下列情況下，則不需要或不支援應用程式檢查：

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

導入步驟總覽

如要整合應用程式與應用程式檢查，大致上需要按照下列步驟操作：

  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) 環境中執行應用程式，可以建立應用程式的偵錯版本，並使用偵錯密鑰取得有效的應用程式檢查權杖。這樣您就能避免在偵錯版本中使用真實的認證提供者。

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

  • 在 build.gradle 檔案中加入 App Check 程式庫。
  • 設定 App Check，在偵錯版本中使用偵錯供應商 Factory。
  • 啟動應用程式，系統會建立本機偵錯權杖。將這個權杖新增至 Firebase 控制台。
  • 如需更多資訊和操作說明，請參閱 App Check 說明文件。

如要在 CI 環境中執行應用程式：

  • 在 Firebase 控制台中建立偵錯權杖，並新增至 CI 系統的安全金鑰儲存庫。
  • 在 build.gradle 檔案中加入 App Check 程式庫。
  • 將 CI 建構變數設為使用偵錯權杖。
  • 在測試類別中，使用 DebugAppCheckTestHelper 包裝需要 App Check 權杖的程式碼。
  • 如需更多資訊和操作說明，請參閱 App Check 說明文件。

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

開始強制執行前，請先確認不會影響應用程式的合法使用者。為此，請前往「應用程式檢查」指標畫面，查看應用程式流量中，已驗證、過時或違法的流量百分比。確認大部分流量都已通過驗證後，即可啟用強制執行功能。

如需更多資訊和操作說明，請參閱 Firebase App Check 說明文件。