从 Google Identity Toolkit 迁移到 Google Cloud Identity Platform

最新版 Google Identity Toolkit 已发布为 Identity Platform 和 Firebase Authentication。今后，我们将停止开发 Identity Toolkit 中的功能；所有新功能开发工作都将在 Identity Platform 和 Firebase Authentication 中进行。我们鼓励 Identity Toolkit 开发者在其应用可行时尽快迁移到这些平台。

新功能

与 Google Identity Toolkit 相比，Identity Platform 已经有了显著的功能增强：

  • 新版管理控制台

    Identity Platform 有一个新的开发者控制台，可让您查看、修改和删除用户；这有助于调试登录和注册流程。您还可以通过控制台配置身份验证方法和自定义电子邮件模板。

  • 新的身份验证方法

    Identity Platform 支持 SAML 和 OIDC 等企业联盟标准，可让您扩展 SaaS 应用和服务。Identity Platform 还支持 GitHub、Microsoft、Yahoo 等提供商。您可以使用匿名登录创建唯一用户 ID，而无需用户完成任何登录或注册流程；这样，您就可以像对待普通用户一样发出经过身份验证的 API 调用。当用户决定注册账号时，系统会使用相同的用户 ID 保留所有活动记录。这对于服务器端购物车或其他应用（您希望在引导用户完成注册流程之前吸引他们互动）等场景非常有用。

  • 借助服务等级协议和云支持服务，放心地进行扩容

    Identity Platform 基于可信的 Google 基础架构构建，并提供 Google Cloud 的服务等级协议和支持。这意味着，您可以放心地扩缩服务，并依靠 Google 提供您所需的弹性、可用性和可伸缩性。

  • 访问所有 Firebase 产品

    Firebase 是一个移动平台，可助您快速开发高品质应用、扩大用户群并赚取更多收入。Firebase 由互为补充的功能组成，您可以根据需要进行组合使用，其中包括适用于以下基础架构的功能：移动分析、云消息传递、实时数据库、文件存储、静态托管、远程配置、移动崩溃报告和 Android 测试。

  • 更新后的界面

    我们根据 Google 的最新用户体验研究，彻底重构了界面流程。这包括密码恢复、账号关联、新/现有账号歧义消除流程，这些流程通常需要花费大量时间进行编码和调试。它集成了 Android 上的 Smart Lock（密码专用），这让参与计划的应用的登录和注册转化次数显著增加。它还支持轻松修改主题以匹配您的应用，并且为了实现最大程度的自定义性，Android 和 iOS 版本均已开源。

  • 简化了服务器设置

    在使用身份工具包后，我们发现许多开发者选择不实现电子邮件恢复流程，这导致用户在忘记密码时无法恢复账号。Identity Platform 可以向用户发送电子邮件验证、密码重置和密码更改消息，并且您可以轻松为用户自定义文本。此外，您无需再托管界面微件即可托管重定向和完成密码更改操作。

  • 新 SDK

    Identity Toolkit 的所有服务器 API 现已原生集成到我们的每个客户端库（Android、iOS、Web）中。开发者将能够登录和注册新老用户、访问用户属性、关联、更新和删除账号、重置密码等，而无需绑定到固定的界面。如果您愿意，也可以基于此 API 手动构建自己的整个登录流程和体验。

  • 移动应用的会话管理

    借助 Identity Toolkit，应用可以根据 Identity Toolkit 中的初始身份验证事件创建自己的会话状态。Identity Platform 使用后端服务，该服务会获取从身份验证事件铸造的刷新令牌，并将其换成有效期为 1 小时的 Android、iOS 和 JavaScript 访问令牌。当用户更改密码后，刷新令牌将无法再生成新的访问令牌，从而会停用访问权限，直到用户在相应设备上重新进行身份验证。

功能差异

Identity Platform 目前不支持一些 Identity Toolkit 功能，而其他功能已重新设计，并且运作方式有所不同。如果这些功能对您的应用至关重要，您可以选择不立即迁移。在许多情况下，这些功能可能对您的应用不重要，或者可能有简单的回退方式，可让您继续迁移。

服务器端差异

核心 Identity Toolkit 服务及其底层 REST API、账号验证逻辑和主要用户数据库仅进行了细微更新。不过，某些功能以及将 Identity Platform 集成到服务中的方式已发生变化。

  • 身份提供商

    不支持 PayPal 和 AOL。拥有这些 IDP 账号的用户仍然可以通过密码恢复流程登录您的应用，并为其账号设置密码。

  • 服务器库

    目前，有适用于 Java、Node.js、Python、Go 和 C# 的 Admin SDK。

  • 账号管理电子邮件地址

    密码重置、电子邮件验证和电子邮件更改消息可以由 Firebase 执行，也可以由开发者的自有邮件服务器执行。目前，电子邮件模板只能通过界面进行有限的自定义，但可以使用 Admin SDK 进行进一步的自定义

  • 电子邮件地址更改确认

    在 Identity Toolkit 中，当用户决定更改电子邮件地址时，系统会向新地址发送一封电子邮件，其中包含用于继续电子邮件地址更改流程的链接。

    Firebase 会向旧电子邮件地址发送一封撤消电子邮件，其中包含用于还原更改的链接，以确认电子邮件地址更改。

  • IDP 发布

    Identity Toolkit 能够逐步将身份提供程序添加到登录系统，以便您实验对支持请求的影响。Firebase Authentication 已移除此功能。

客户端差异

在 Identity Platform 中，Google Identity 工具包提供的功能分为两个组件：

  • 客户端和服务器 SDK

    在 Identity Platform 中，Identity Toolkit 的 REST API 提供的功能已打包到适用于 Android、iOS 和 JavaScript 的客户端 SDK 中。您可以使用该 SDK 登录和注册用户；访问用户个人资料信息；关联、更新和删除账号；以及使用客户端 SDK 重置密码，而不是通过 REST 调用与后端服务通信。

  • 界面微件

    管理登录、注册、密码恢复和账号关联的所有界面流程均已使用客户端 SDK 重建，并打包为登录 widget。它们以适用于 iOS、Android 和 Web 的开源 SDK 的形式提供，可让您以 Identity Toolkit 无法实现的方式完全自定义流程。

其他差异包括：

  • 会话和迁移

    由于 Identity Toolkit 和 Identity Platform 中会以不同的方式管理会话，因此在升级 SDK 后，用户的现有会话将会终止，用户将不得不重新登录。

准备工作

在从 Identity Toolkit 迁移到 Identity Platform 之前，您必须满足以下条件：

  1. 打开 Cloud 控制台，然后选择您的身份工具包项目。

  2. 在 Marketplace 中，浏览到 Identity Platform，然后选择“启用 Identity Platform”

  3. 打开服务账号页。您可以在此处查看之前为 Identity Toolkit 配置的服务账号。

  4. 在服务账号旁边，依次点击 > 创建密钥。然后，在创建私钥对话框中，将“密钥类型”设置为 JSON，然后点击创建。系统会为您下载包含服务账号凭据的 JSON 文件。您在下一步初始化 SDK 时需要用到此文件。

  5. 返回 Cloud 控制台。 在“提供方”部分的“电子邮件地址/密码”登录方法中，打开电子邮件模板页面。然后，您可以自定义应用的模板。

    在 Identity Toolkit 中，当用户重置密码、更改电子邮件地址或验证电子邮件地址时，您需要从 Identity Toolkit 服务器获取 OOB 代码，然后通过电子邮件将代码发送给用户。Identity Platform 会根据您配置的模板发送电子邮件，无需您执行任何其他操作。

  6. 可选：如果您需要访问服务器上的 Identity Platform 服务，请安装 Firebase SDK。

    1. 您可以使用 npm 安装 Node.js Admin SDK：

      $ npm init
$ npm install --save firebase-admin

    2. 在代码中，您可以使用以下方式访问 Firebase：

      var admin = require('firebase-admin');
var app = admin.initializeApp({
  credential: admin.credential.cert('path/to/serviceAccountCredentials.json')
});

接下来，完成应用所用平台的迁移步骤：Android、iOS、Web。

服务器和 JavaScript

显著变更

Identity Platform 的 Web 实现与 Identity Toolkit 之间还有一些其他差异。

  • Web 会话管理

    以前，当用户使用 Identity Toolkit widget 进行身份验证时，系统会为用户设置一个 Cookie，该 Cookie 用于引导会话。此 Cookie 的有效期为两周，用于允许用户使用账号管理 widget 更改密码和电子邮件地址。部分网站使用此 Cookie 对网站上的所有其他网页请求进行身份验证。其他网站则使用该 Cookie 通过其框架的 Cookie 管理系统创建自己的 Cookie。

    Identity Platform 客户端 SDK 现在管理 ID 令牌，并与 Identity Platform 的后端协作以保持会话的新鲜度。当发生重要账号更改（例如用户密码更改）时，后端会使会话失效。ID 令牌不会自动在 Web 客户端上设置为 Cookie，并且其生命周期只有一小时。除非您希望会话仅持续一小时，否则不应将 ID 令牌用作 Cookie 来验证您的所有网页请求。相反，您需要设置监听器，以便在用户登录时获取 ID 令牌、验证令牌，并通过框架的 Cookie 管理系统创建自己的 Cookie。

    您需要根据应用的安全需求设置 Cookie 的会话生命周期。

  • 网页登录流程

    以前，在用户发起登录时，系统会重定向到 accountchooser.com，以了解用户想要使用哪个标识符。Identity Platform 界面的流程现在从登录方法列表开始，其中包括一个电子邮件选项，该选项会在 Web 上转到 accountchooser.com，并在 Android 上使用 hintRequest API。此外，界面中不再需要电子邮件地址。 这样，您就可以更轻松地支持匿名用户、自定义身份验证用户或来自不要求电子邮件地址的提供方的用户。

  • “账号管理”微件

    此 widget 提供了一个界面，供用户更改电子邮件地址、更改密码或解除其账号与身份提供程序的关联。此功能目前正在开发中。

  • 登录按钮/微件

    系统不再提供登录按钮和用户卡片等微件。您可以使用 Firebase Authentication API 非常轻松地构建这些页面。

  • 无 signOutUrl

    您需要调用 firebase.auth.signOut() 并处理回调。

  • 无 oobActionUrl

    电子邮件发送现在由 Identity Platform 处理，并在 Firebase 控制台中进行配置。

  • CSS 自定义

    界面 widget 使用 Material Design Lite 样式，可动态添加 Material Design 动画。

第 1 步：更改服务器代码

  1. 如果您的服务器依赖于 Identity Toolkit 令牌（有效期为两周）来管理 Web 用户会话，则需要将服务器转换为使用自己的会话 Cookie。

    1. 实现一个端点，用于验证 ID 令牌并为用户设置会话 Cookie。客户端应用会将 Firebase ID 令牌发送到此端点。
    2. 如果传入请求包含您自己的会话 Cookie，您可以将用户视为已通过身份验证。否则，将请求视为未经身份验证。
    3. 如果您不希望任何用户丢失其现有的已登录会话，则应等待两周，让所有 Identity Toolkit 令牌过期，或者还应为您的 Web 应用执行双令牌验证（如第 3 步中所述）。

  2. 接下来，由于 ID 令牌不同于身份工具包令牌，因此您必须更新令牌验证逻辑。将 Admin SDK 安装到您的服务器；或者，如果您使用的语言不受 Admin SDK 支持，请为您的环境下载 JWT 令牌验证库，并正确验证令牌。

  3. 首次进行上述更新时，您可能仍有依赖于 Identity Toolkit 令牌的代码路径。如果您有 iOS 或 Android 应用，用户需要升级到新版应用，才能使用新代码路径。如果您不想强制用户更新应用，可以添加额外的服务器验证逻辑，用于检查令牌并确定是否需要使用 Firebase SDK 或 Identity Toolkit SDK 来验证令牌。如果您只有 Web 应用，则所有新的身份验证请求都将转移到 Identity Platform，因此您只需使用 ID 令牌验证方法。

请参阅 Web API 参考文档。

第 2 步：更新 HTML

  1. 将初始化代码添加到您的应用：

    1. 在 Cloud 控制台中打开您的项目。
    2. 在提供商页面上，点击应用设置详情。系统会显示用于初始化 Identity Platform 的代码段。
    3. 将初始化代码段复制并粘贴到您的网页中。

  2. 将身份验证 widget 添加到您的应用：

    <script src="https://www.gstatic.com/firebasejs/ui/live/0.4/firebase-ui-auth.js"></script>
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/live/0.4/firebase-ui-auth.css" />
<!-- *******************************************************************************************
   * TODO(DEVELOPER): Paste the initialization snippet from:
   * Firebase Console > Overview > Add Firebase to your web app. *
   ***************************************************************************************** -->
<script type="text/javascript">
  // FirebaseUI config.
  var uiConfig = {
    'signInSuccessUrl': '<url-to-redirect-to-on-success>',
    'signInOptions': [
      // Leave the lines as is for the providers you want to offer your users.
      firebase.auth.GoogleAuthProvider.PROVIDER_ID,
      firebase.auth.FacebookAuthProvider.PROVIDER_ID,
      firebase.auth.TwitterAuthProvider.PROVIDER_ID,
      firebase.auth.GithubAuthProvider.PROVIDER_ID,
      firebase.auth.EmailAuthProvider.PROVIDER_ID
    ],
    // Terms of service url.
    'tosUrl': '<your-tos-url>',
  };

  // Initialize the FirebaseUI Widget using Firebase.
  var ui = new firebaseui.auth.AuthUI(firebase.auth());
  // The start method will wait until the DOM is loaded.
  ui.start('#firebaseui-auth-container', uiConfig);
</script>

  3. 从您的应用中移除 Identity Toolkit SDK。

  4. 如果您依赖 Identity Toolkit ID 令牌进行会话管理，则必须在客户端进行以下更改：

    1. 使用 Identity Platform 成功登录后，通过调用 firebase.auth().currentUser.getToken() 获取 ID 令牌。

    2. 将 ID 令牌发送到后端服务器，对其进行验证，然后发出您自己的会话 Cookie。

      执行敏感操作或向服务器发送经过身份验证的修改请求时，请勿仅依赖会话 Cookie。您需要提供额外的跨站请求伪造 (CSRF) 保护。

      如果您的框架不提供 CSRF 保护，则可以使用 getToken() 为已登录的用户获取 ID 令牌，并在每个请求中添加该令牌（系统还会默认发送会话 Cookie）。然后，除了后端框架完成的会话 Cookie 检查之外，您还需要使用 Admin SDK 验证该令牌。这样一来，CSRF 攻击就更难成功，因为 ID 令牌仅使用 Web 存储空间存储，绝不会存储在 Cookie 中。

    3. Identity Toolkit 令牌的有效期为两周。您可以继续发出有效期为两周的令牌，也可以根据应用的安全要求延长或缩短有效期。当用户退出账号时，清除会话 Cookie。

第 3 步：更新 IDP 重定向网址

  1. 在 Cloud 控制台中，打开提供商部分。

  2. 对于您支持的每个联合登录提供方，请执行以下操作：

    1. 点击登录提供商的名称。
    2. 复制 OAuth 重定向 URI。
    3. 在登录提供方的开发者控制台中，更新 OAuth 重定向 URI。

Android

第 1 步：使用 Firebase 将 Identity Platform 添加到您的应用

  1. 打开 Cloud 控制台，然后选择您的身份工具包项目。

  2. 在“提供程序”页面上，点击应用设置详情，选择 Android 标签页，然后点击 在 Firebase 中开始使用。 在“添加 Firebase”对话框中，提供应用的软件包名称和签名证书指纹，然后点击添加应用。系统随即会将 google-services.json 配置文件下载到您的计算机。

  3. 将配置文件复制到 Android 应用模块根目录。此配置文件包含项目和 Google OAuth 客户端信息。

  4. 在项目级 build.gradle 文件 (<var>your-project</var>/build.gradle) 的 defaultConfig 部分中，指定应用的软件包名称：

    defaultConfig {
   …..
  applicationId "com.your-app"
}

  5. 此外，在项目级 build.gradle 文件中，添加一个依赖项以包含 google-services 插件：

    buildscript {
 dependencies {
   // Add this line
   classpath 'com.google.gms:google-services:3.0.0'
 }
}

  6. 在应用的应用级 build.gradle 文件 (<var>my-project</var>/<var>app-module</var>/build.gradle) 中，在 Android Gradle 插件后面添加以下代码行，以启用 google-services 插件：

    apply plugin: 'com.android.application'
// Add this line
apply plugin: 'com.google.gms.google-services'

    google-services 插件使用 google-services.json 文件将您的应用配置为使用 Firebase。

  7. 同样是在应用级 build.gradle 文件中，添加 Firebase Authentication 依赖项：

    compile 'com.google.firebase:firebase-auth:23.1.0'
compile 'com.google.android.gms:play-services-auth:21.3.0'

第 2 步：移除 Identity Toolkit SDK

  1. 从 AndroidManifest.xml 文件中移除 Identity Toolkit 配置。此信息包含在 google-service.json 文件中，并由 google-services 插件加载。
  2. 从您的应用中移除 Identity Toolkit SDK。

第 3 步：将 FirebaseUI 添加到您的应用

  1. 将 FirebaseUI Auth 添加到您的应用。

  2. 在您的应用中，将对 Identity Toolkit SDK 的调用替换为对 FirebaseUI 的调用。

iOS

第 1 步：将 Firebase 添加到您的应用

  1. 运行以下命令，将客户端 SDK 添加到您的应用中：

    $ cd your-project directory
$ pod init
$ pod 'Firebase'

  2. 打开 Cloud 控制台，然后选择您的身份工具包项目。

  3. 在“提供程序”页面上，点击应用设置详情，选择 iOS 标签页，然后点击 在 Firebase 中开始。在“添加 Firebase”对话框中，提供应用的软件包名称和签名证书指纹，然后点击添加应用。系统随即会将 google-services.json 配置文件下载到您的计算机。在“添加 Firebase”对话框中，提供应用的 bundle ID 和 App Store ID，然后点击添加应用。系统随即会将 GoogleService-Info.plist 配置文件下载到您的计算机。如果您的项目中有多个软件包 ID，则必须在 Firebase 控制台中关联每个软件包 ID，使其都有自己的 GoogleService-Info.plist 文件。

  4. 将配置文件复制到 Xcode 项目的根目录，然后将其添加到所有目标。

第 2 步：移除 Identity Toolkit SDK

  1. 从应用的 Podfile 中移除 GoogleIdentityToolkit。
  2. 运行 pod install 命令。

第 3 步：将 FirebaseUI 添加到您的应用

  1. 将 FirebaseUI Auth 添加到您的应用。

  2. 在您的应用中，将对 Identity Toolkit SDK 的调用替换为对 FirebaseUI 的调用。