此页面向您展示如何使用内置的 SafetyNet 提供程序在 Android 应用程序中启用 App Check。当您启用 App Check 时,您有助于确保只有您的应用可以访问您项目的 Firebase 资源。请参阅此功能的概述。
如果您想将 App Check 与您自己的自定义提供程序一起使用,请参阅实施自定义 App Check 提供程序。
1. 设置您的 Firebase 项目
如果您还没有将 Firebase 添加到您的 Android 项目中,请将其添加到您的 Android 项目中。
在 Firebase 控制台的App Check部分注册您的应用以使用 SafetyNet 提供商的 App Check。您需要提供应用签名证书的 SHA-256 指纹。
您通常需要注册所有项目的应用程序,因为一旦您为 Firebase 产品启用强制执行,只有注册的应用程序才能访问该产品的后端资源。
可选:在应用程序注册设置中,为提供商颁发的 App Check 令牌设置自定义生存时间 (TTL)。您可以将 TTL 设置为 30 分钟到 7 天之间的任何值。更改此值时,请注意以下权衡:
- 安全性:较短的 TTL 提供更强的安全性,因为它减少了攻击者可以滥用泄漏或拦截令牌的窗口。
- 性能:更短的 TTL 意味着您的应用程序将更频繁地执行证明。由于每次执行应用证明过程都会增加网络请求的延迟,因此较短的 TTL 会影响应用的性能。
- 配额和成本:较短的 TTL 和频繁的重新证明会更快地耗尽您的配额,而对于付费服务,可能会花费更多。请参阅配额和限制。
1 小时的默认 TTL 对于大多数应用程序来说是合理的。请注意,App Check 库会在 TTL 持续时间的一半左右刷新令牌。
2.将App Check库添加到您的应用中
在您的模块(应用级)Gradle 文件(通常是app/build.gradle
)中,声明 App Check Android 库的依赖项:
Kotlin+KTX
dependencies {
implementation 'com.google.firebase:firebase-appcheck-safetynet:16.1.1'
}
Java
dependencies {
implementation 'com.google.firebase:firebase-appcheck-safetynet:16.1.1'
}
3.初始化App Check
将以下初始化代码添加到您的应用程序,以便它在您使用任何其他 Firebase SDK 之前运行:
Kotlin+KTX
FirebaseApp.initializeApp(/*context=*/this) val firebaseAppCheck = FirebaseAppCheck.getInstance() firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance() )
Java
FirebaseApp.initializeApp(/*context=*/ this); FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance());
下一步
在您的应用程序中安装 App Check 库后,开始将更新后的应用程序分发给您的用户。
更新后的客户端应用程序将开始发送 App Check 令牌及其向 Firebase 发出的每个请求,但 Firebase 产品不会要求令牌有效,直到您在 Firebase 控制台的 App Check 部分启用强制执行。
监控指标并启用强制执行
但是,在您启用强制执行之前,您应该确保这样做不会干扰您现有的合法用户。另一方面,如果您发现对应用资源的可疑使用,您可能希望尽快启用强制措施。
为帮助做出此决定,您可以查看您使用的服务的 App Check 指标:
启用 App Check 强制执行
当您了解 App Check 将如何影响您的用户并准备好继续操作时,您可以启用 App Check 强制执行:
- 为实时数据库、Cloud Firestore 和 Cloud Storage启用 App Check 强制执行。
- 为 Cloud Functions 启用 App Check 强制执行。
在调试环境中使用 App Check
如果在为 App Check 注册您的应用程序后,您希望在 App Check 通常不会归类为有效的环境中运行您的应用程序,例如开发期间的模拟器,或来自持续集成 (CI) 环境,您可以创建您的应用程序的调试版本,使用 App Check 调试提供程序而不是真正的证明提供程序。
请参阅将 App Check 与 Android 上的调试提供程序一起使用。