開始在 Android 上使用 App Check 和 Play Integrity

本頁面說明如何使用內建的 Play Integrity 供應器，在 Android 應用程式中啟用 App Check。啟用 App Check 後，您就能確保只有您的應用程式可以存取專案的 Firebase 資源。請參閱這項功能的總覽。

目前，內建的 Play Integrity 供應器僅支援由 Google Play 發行的 Android 應用程式。如要使用 Play Integrity 的非 Play 功能，或將 App Check 與您自己的自訂提供者搭配使用，請參閱「實作自訂 App Check 提供者」。

1. 設定 Firebase 專案

  1. 如果尚未將 Firebase 新增至 Android 專案，請將 Firebase 新增至 Android 專案。

  2. 啟用 Play Integrity API：

    1. 在 Google Play 管理中心中選取應用程式，或新增尚未加入的應用程式。

    2. 在「版本」部分，按一下「應用程式完整性」。

    3. 前往頁面中的「Play Integrity API」部分，點選「連結 Cloud 專案」，然後從 Google Cloud 專案清單中選取 Firebase 專案。您在此處選取的專案必須與註冊應用程式的 Firebase 專案相同 (請參閱下一個步驟)。

  3. 在 Firebase 控制台的 App Check 專區中，為應用程式註冊透過 Play Integrity 供應商使用 App Check。您需要提供應用程式簽署憑證的 SHA-256 指紋。

    您通常需要註冊所有專案的應用程式，因為一旦啟用 Firebase 產品的強制執行功能，只有已註冊的應用程式才能存取產品的後端資源。

  4. 選用：在應用程式註冊設定中，為供應商核發的 App Check 權杖設定自訂存留時間 (TTL)。您可以將 TTL 設為 30 分鐘至 7 天之間的任何值。變更這個值時，請注意下列權衡：

    • 安全性：縮短存留時間可提供更強的安全性，因為這樣一來，攻擊者就無法在較短的時間內濫用遭洩漏或攔截的權杖。
    • 效能：TTL 越短，應用程式執行認證的頻率就越高。由於應用程式認證程序每次執行時都會為網路要求增加延遲時間，因此 TTL 時間過短可能會影響應用程式效能。
    • 配額和費用：較短的 TTL 和頻繁的重複認證會讓配額耗盡得更快，而付費服務可能會產生更多費用。請參閱「配額與限制」。

    預設的 TTL 為 1 小時，適合大多數應用程式。請注意，App Check 程式庫會在 TTL 時間長度的約一半時間內重新整理權杖。

2. 將 App Check 程式庫新增至應用程式

在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，加入 Android 的 App Check 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependencies for the App Check libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity")
}

只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。

(替代做法)  不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。

dependencies {
    // Add the dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity:18.0.0")
}
 想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

3. 初始化 App Check

將下列初始化程式碼加入應用程式，讓應用程式在使用任何其他 Firebase SDK 前優先執行：

Kotlin+KTX 

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance(),
)
MainActivity.kt

Java 

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());
MainActivity.java

後續步驟

在應用程式中安裝 App Check 程式庫後，請開始向使用者發布更新版應用程式。

更新後的用戶端應用程式會開始傳送 App Check 權杖，並附帶每項對 Firebase 提出的要求，但 Firebase 產品不會要求權杖必須有效，除非您在 Firebase 控制台的 App Check 部分啟用強制執行功能。

監控指標並啟用強制執行功能

不過，啟用違規處置前，請先確認這項處置不會影響現有的合法使用者。另一方面，如果您發現應用程式資源遭到可疑使用，可能需要盡快啟用強制執行機制。

為協助您做出這項決定，您可以查看所用服務的 App Check 指標：

啟用 App Check 強制執行功能

瞭解 App Check 對使用者的影響，並準備繼續執行時，您可以啟用 App Check 強制執行機制：

  • 為 Data Connect、Vertex AI in Firebase、Realtime Database、Cloud Firestore、Cloud Storage、Authentication、Google 身分識別服務 (適用於 iOS)、Maps JavaScript API 和 Places API (新版) 啟用 App Check 強制執行。
  • 為 Cloud Functions 啟用 App Check 強制執行設定。

在偵錯環境中使用 App Check

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

請參閱「在 Android 上使用 App Check 與偵錯提供者」。