使用入门:将 App Check 与自定义提供程序搭配使用 (Unity)

本页介绍了如何使用自定义 App Check 提供程序在 Unity 应用中启用 App Check。启用 App Check 有助于确保只有您的应用可以访问项目的 Firebase 资源。

如果您希望将 App Check 与默认提供程序搭配使用,请参阅通过默认提供程序启用 App Check (Unity)

准备工作

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

按照 App Check 的设置说明操作,将 App Check 库添加到您的��组依赖项中。

2. 实现 App Check 接口

首先,您需要创建实现 IAppCheckProviderIAppCheckProviderFactory 接口的类。

您的 AppCheckProvider 类必须具有 GetTokenAsync() 方法,用于收集您的自定义 App Check 提供程序作为真实性证明所需要的所有信息,并将其发送到令牌获取服务以换取 App Check 令牌。App Check SDK 会处理令牌缓存,因此,请始终在您的 GetTokenAsync() 实现中获取新令牌。

public class YourCustomAppCheckProvider : IAppCheckProvider {
  public Task<AppCheckToken> GetTokenAsync() {
    // Logic to exchange proof of authenticity for an App Check token and
    //   expiration time.
    // ...

    AppCheckToken appCheckToken = new AppCheckToken() {
      Token = tokenFromAbove,
      ExpireTime = DateTime.UtcNow.AddMinutes(60)
    };

    return Task<AppCheckToken>.FromResult(appCheckToken);
  }
};

此外,请实现 AppCheckProviderFactory 类,用于创建 AppCheckProvider 实现的实例:

public class YourCustomAppCheckProviderFactory : IAppCheckProviderFactory {
  IAppCheckProvider CreateProvider(FirebaseApp app) {
    // Create and return an AppCheckProvider object.
    return new YourCustomAppCheckProvider(app);
  }
}

3. 初始化 App Check

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

FirebaseAppCheck.SetAppCheckProviderFactory(
  new YourCustomAppCheckProviderFactory());

后续步骤

将 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 与调试提供程序搭配使用 (Unity)