使用入门:将 App Check 与 SafetyNet 搭配使用 (Android)

本页介绍如何使用内置的 SafetyNet 提供程序在 Android 应用中启用 App Check。启用 App Check 有助于确保只有您的应用可以访问项目的 Firebase 资源。请查看此功能的概览

如果您希望将 App Check 与自己的自定义提供程序搭配使用,请参阅实现自定义 App Check 提供程序

1. 设置您的 Firebase 项目

  1. 将 Firebase 添加到您的 Android 项目(如果尚未添加)。

  2. 在 Firebase 控制台的 App Check 部分中注册您的应用,以便将 App Check 与 SafetyNet 提供程序搭配使用。您需要提供应用签名证书的 SHA-256 指纹

    您通常需要注册项目的所有应用,因为在您为 Firebase 产品启用强制执行后,只有注册的应用才能访问产品的后端资源。

  3. 可选:在应用注册设置中,为提供程序颁发的 App Check 令牌设置自定义存留时间 (TTL)。您可以将 TTL 设置为 30 分钟到 7 天之间的任何值。更改此值时,请注意权衡以下几个方面:

    • 安全性:较短的 TTL 可以提供更强的安全性,因为它可以缩短攻击者可能滥用已泄露或者已被拦截的令牌的时长。
    • 性能:较短的 TTL 意味着您的应用将更频繁地执行证明操作。由于每次执行应用证明过程都会增加网络请求的延迟时间,因此短 TTL 可能会影响应用的性能。
    • 配额和费用:较短的 TTL 和频繁的重新证明会更快地耗尽您的配额,而对于付费服务,费用可能更高。请参阅配额和限制

    对于大多数应用而言,默认的 TTL(1 小时)比较合理。请注意,App Check 库会在达到 TTL 时长约一半时刷新令牌。

2.将 App Check 库添加到您的应用

在您的模块(应用级)Gradle 文件(通常是 app/build.gradle)中,声明 App Check Android 库的依赖项:

dependencies {
    implementation 'com.google.firebase:firebase-appcheck-safetynet:16.1.2'
}

3. 初始化 App Check

将以下初始化代码添加到您的应用,使其在您使用任何其他 Firebase SDK 之前运行:

Kotlin+KTX

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    SafetyNetAppCheckProviderFactory.getInstance()
)

Java

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

后续步骤

将 App Check 库安装到您的应用中之后,开始将更新后的应用分发给用户。

更新后的客户端应用会开始将 App Check 令牌随其发出的每个请求一起发送到 Firebase;不过,您在 Firebase 控制台的 App Check 部分中启用强制执行之前,Firebase 产品并不会要求令牌必须有效。

监控指标并启用强制执行

不过,在启用强制执行之前,您应该确保这样做不会干扰现有的合法用户。另一方面,如果您发现自己的应用资源被非法使用,建议您尽快启用强制执行。

为帮助您做出相关决策,建议您查看自己使用的服务的 App Check 指标:

启用 App Check 强制执行

在了解 App Check 对用户有何影响并为后续操作做好准备之后,您便可以启用 App Check 强制执行:

在调试环境中使用 App Check

为应用启用 App Check 后,如果您希望在 App Check 通常不会归类为有效提供程序的环境(例如开发期间的模拟器)或持续集成 (CI) 环境中运行您的应用,可以创建应用的调试 build,该 build 使用 App Check 调试提供程序,而不是真正的证明提供程序。

请参阅将 App Check 与调试提供程序搭配使用 (Android)