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

本頁面向您展示如何使用內建的 Play Integrity 提供者在 Android 應用程式中啟用應用程式檢查。啟用應用程式檢查後,您可以協助確保只有您的應用程式可以存取專案的 Firebase 資源。請參閱此功能的概述

目前,內建的 Play Integrity 提供者僅支援 Google Play 分發的 Android 應用程式。若要使用 Play Integrity 的場外功能,或將 App Check 與您自己的自訂提供者結合使用,請參閱實作自訂 App Check 提供者

1. 設定您的 Firebase 項目

  1. 如果您尚未將Firebase 新增至您的 Android 專案中,請將其新增至您的 Android 專案中

  2. 啟用 Play 完整性 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. 可選:在應用程式註冊設定中,為提供者頒發的應用程式檢查令牌設定自訂生存時間 (TTL)。您可以將 TTL 設定為 30 分鐘到 7 天之間的任意值。更改此值時,請注意以下權衡:

    • 安全性:較短的 TTL 提供更強的安全性,因為它減少了攻擊者濫用洩漏或攔截的令牌的視窗。
    • 效能:較短的 TTL 意味著您的應用程式將更頻繁地執行證明。由於應用程式證明過程會在每次執行時增加網路請求的延遲,因此較短的 TTL 可能會影響應用程式的效能。
    • 配額和成本:較短的 TTL 和頻繁的重新認證會更快地耗盡您的配額,對於付費服務,可能會花費更多。請參閱配額和限制

    對於大多數應用程式來說,預設 TTL 1 小時是合理的。請注意,App Check 庫會在大約 TTL 持續時間的一半時刷新令牌。

2. 將 App Check 庫加入您的應用程式中

模組(應用程式層級)Gradle 檔案(通常<project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle )中,新增 App Check 的依賴項Android 的函式庫。我們建議使用Firebase Android BoM來控制函式庫版本控制。

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

    // 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:17.1.2")
}
正在尋找 Kotlin 特定的庫模組?2023 年 10 月(Firebase BoM 32.5.0)開始,Kotlin 和 Java 開發人員都可以依賴主庫模組(有關詳細信息,請參閱有關此計劃的常見問題解答)。

3. 初始化應用檢查

將以下初始化程式碼新增至您的應用程式中,以便它在您使用任何其他 Firebase SDK 之前執行:

Kotlin+KTX

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

Java

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

下一步

在您的應用程式中安裝 App Check 庫後,開始向您的用戶分發更新的應用程式。

更新後的客戶端應用程式將開始隨其向Firebase 發出的每個請求一起發送App Check 令牌,但在您在Firebase 控制台的App Check 部分中啟用強制執行之前,Firebase 產品不會要求令牌有效。

監控指標並啟用執行

但是,在啟用強制執行之前,您應該確保這樣做不會幹擾您現有的合法使用者。另一方面,如果您發現應用程式資源的可疑使用,您可能希望盡快啟用強制執行。

為了幫助做出此決定,您可以查看您使用的服務的 App Check 指標:

啟用應用程式檢查強制執行

當您了解 App Check 將如何影響您的使用者並且準備好繼續操作後,您可以啟用 App Check 強制執行:

在調試環境中使用 App Check

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

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