从 Google Identity Toolkit 迁移到 Firebase Authentication

最新版本的 Google Identity Toolkit 已作为 Firebase Authentication 发布。今后，Identity Toolkit 的功能开发工作将冻结，所有新功能开发都将在 Firebase Authentication 上完成。我们鼓励 Identity Toolkit 开发者尽快将应用迁移到 Firebase Authentication；不过，Identity Toolkit 仍可继续使用，在发布进一步公告之前不会弃用。

新功能

与 Google Identity Toolkit 相比，Firebase Authentication 已经有了一些重大功能增强：

  • 访问所有 Firebase 产品

    Firebase 是一个移动平台，可助您快速开发高品质应用、扩大用户群并赚取更多收入。Firebase 由各种互补功能组成，您可以根据需要进行组合搭配，其中包括以下方面的基础架构：移动Analytics、Cloud Messaging、Realtime Database、文件存储、Hosting、Remote Config、移动Crash Reporting和 Android 测试。

  • 更新后的界面

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

  • 简化的服务器设置

    我们让开发者能够更轻松地使用 Firebase Authentication。在使用 Identity Toolkit 时，我们发现许多开发者选择不实现电子邮件恢复流程，这导致其用户在忘记密码时无法恢复其账号。Firebase Authentication 可以向用户发送邮箱验证、重设密码和密码更改邮件，并且可以轻松为用户自定义文本。此外，您不再需要托管界面 widget 来托管重定向和完成密码更改操作。

  • 新版管理控制台

    Firebase 拥有新的开发者控制台，其“Authentication”部分可让您查看、修改和删除用户。这对于调试登录和注册流程非常有帮助。 您还可以通过该控制台配置身份验证方法和自定义电子邮件模板。

  • 新 SDK

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

  • 移动应用的会话管理

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

  • 匿名和 GitHub 身份验证

    Firebase Authentication 支持两种新的身份验证类型：GitHub 和匿名。匿名登录可用于创建唯一身份用户 ID，而无需用户完成任何登录或注册流程。现在，您可以使用匿名用户进行经过身份验证的 API 调用，就像使用普通用户一样。当用户决定注册账号时，所有活动都会保留在同一用户 ID 下。这非常适合服务器端购物车等情况，或任何您希望在引导用户完成注册流程之前与其互动的应用。

功能差异

Firebase Authentication 目前不提供某些 Identity Toolkit 功能，而其他功能已经过重新设计，其运作方式也有所不同。如果这些功能对您的应用很重要，您可能选择不立即迁移。在许多情况下，这些功能可能对您的应用并不重要，或者可能有简单的回退机制，使您能够继续迁移。

服务器端差异

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

  • 身份提供方

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

  • 服务器库

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

  • 账号管理电子邮件

    重设密码、邮箱验证和邮箱更改消息可以由 Firebase 或开发者自己的邮件服务器执行。目前，Firebase 电子邮件模板仅提供有限的自定义功能。

  • 邮箱变更确认

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

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

  • IDP 发布

    Identity Toolkit 能够逐步向您的登录系统添加身份提供方，以便您测试对支持请求的影响。此功能已从 Firebase Authentication 中移除。

客户端差异

在 Firebase 中，Google Identity Toolkit 提供的功能分为两个组件：

  • Firebase Authentication SDK

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

  • FirebaseUI Auth

    所有管理登录、注册、密码恢复和账号关联的界面流程都已使用 Firebase Authentication SDK 重新构建。它们以适用于 iOS 和 Android 的开源 SDK 的形式提供，使您能够以 Identity Toolkit 无法实现的方式完全自定义流程。

其他差异包括：

  • 会话和迁移

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

准备工作

在从 Identity Toolkit 迁移到 Firebase Authentication 之前，您必须

  1. 打开 Firebase 控制台，点击导入 Google 项目，然后选择您的 Identity Toolkit 项目。

  2. 依次点击 > 权限，打开“IAM 和管理”页面。

  3. 打开服务账号页。在这里，您可以看到之前为 Identity Toolkit 配置的服务账号。

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

  5. 返回 Firebase 控制台。 在“Auth”部分中，打开电子邮件模板页面。在此页面上，自定义应用的电子邮件模板。

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

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

    1. 您可以使用 npm 安装 Firebase Node.js 模块：

      $ 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

显著变更

Firebase 的 Web 实现与 Identity Toolkit 还有许多其他不同之处。

  • Web 会话管理

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

    Firebase 客户端 SDK 现在可以管理 Firebase ID 令牌，并与 Firebase Authentication 的后端配合使用，以保持会话处于最新状态。当发生重要的账号更改（例如用户密码更改）时，后端会使会话过期。Firebase ID 令牌不会自动在 Web 客户端上设置为 Cookie，并且只有一小时的生命周期。除非您希望会话仅持续一小时，否则 Firebase ID 令牌不适合用作验证所有页面请求的 Cookie。相反，您需要为用户登录设置监听器、获取 Firebase ID 令牌、验证令牌，并通过框架的 Cookie 管理系统创建自己的 Cookie。

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

  • 网页登录流程

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

  • 账号管理微件

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

  • 登录按钮/微件

    不再提供登录按钮和用户卡片等微件。您可以使用 Firebase Authentication API 轻松构建这些功能。

  • 无 signOutUrl

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

  • 无 oobActionUrl

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

  • CSS 自定义

    FirebaseUI 使用 Material Design Lite 样式，该样式会动态添加 Material Design 动画。

第 1 步：更改服务器代码

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

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

  2. 接下来，由于 Firebase 令牌与 Identity Toolkit 令牌不同，您必须更新令牌验证逻辑。在服务器上安装 Firebase Server SDK；或者，如果您使用的语言不受 Firebase Server SDK 支持，请下载适用于您环境的 JWT 令牌验证库，并正确验证令牌。

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

请参阅 Firebase Web API 参考文档。

第 2 步：更新 HTML

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

    1. 在 Firebase 控制台中打开您的项目。
    2. 在“概览”页面上，点击添加应用，然后点击将 Firebase 添加到您的 Web 应用。系统会显示用于初始化 Firebase 的代码段。
    3. 将初始化代码段复制并粘贴到您的网页中。

  2. 将 FirebaseUI Auth 添加到您的应用：

    <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. 成功登录 Firebase 后，通过调用 firebase.auth().currentUser.getToken() 获取 Firebase ID 令牌。

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

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

      如果您的框架不提供 CSRF 保护，则防止攻击的一种方法是使用 getToken() 为已登录用户获取 Firebase ID 令牌，并在每个请求中包含该令牌（默认情况下也会发送会话 Cookie）。然后，除了后端框架完成的会话 Cookie 检查之外，您还要使用 Firebase 服务器 SDK 验证该令牌。由于 Firebase ID 令牌仅使用网络存储空间进行存储，而绝不会存储在 Cookie 中，因此 CSRF 攻击将更难成功。

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

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

  1. 在 Firebase 控制台中，打开“Authentication”部分，然后点击登录方法标签页。

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

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

Android

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

  1. 打开 Firebase 控制台，然后选择您已导入的 Identity Toolkit 项目。

  2. 在“概览”页面上，点击添加应用，然后点击将 Firebase 添加到您的 Android 应用。在“添加 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. 在应用的 app 级 build.gradle 文件 (<var>my-project</var>/<var>app-module</var>/build.gradle) 中，将以下行添加到末尾，以启用 google-services 插件：

    // Add to the bottom of the file
apply plugin: 'com.google.gms.google-services'

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

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

    compile 'com.google.firebase:firebase-auth:25.0.0'
compile 'com.google.android.gms:play-services-auth:22.0.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. 运行以下命令，将 Firebase SDK 添加到您的应用中：

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

  2. 打开 Firebase 控制台，然后选择您已导入的 Identity Toolkit 项目。

  3. 在“概览”页面上，点击添加应用，然后点击将 Firebase 添加到您的 iOS 应用。在“添加 Firebase”对话框中，提供应用的软件包 ID 和应用商店 ID，然后点击添加应用。GoogleService-Info.plist 配置文件随后会下载到您的计算机。如果您的项目中有多个软件包 ID，则必须在 Firebase 控制台中关联每个软件包 ID，以便每个软件包 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 的调用。