将 Google 帐号关联至 OAuth

账号使用行业标准 OAuth 2.0 隐式 和 授权代码 流程进行关联。

In the implicit flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from Google.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Choose an OAuth 2.0 flow

Although the implicit flow is simpler to implement, Google recommends that access tokens issued by the implicit flow never expire. This is because the user is forced to link their account again after a token expires with the implicit flow. If you need token expiration for security reasons, we strongly recommend that you use the authorization code flow instead.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have clear method for signing in to their Google account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

创建项目

如需创建项目以使用账号关联，请执行以下操作：

1. 前往 Google API 控制台。
2. 点击 Create project 。
3. 输入名称或接受生成的建议。
4. 确认或修改任何剩余字段。
5. 点击创建 。

如需查看项目 ID，请执行以下操作：

1. 前往 Google API 控制台。
2. 在着陆页的表格中找到您的项目。项目 ID 会显示在 ID 列中。

配置 OAuth 权限请求页面

Google 账号关联过程包含一个权限请求页面，该页面会告知用户请求访问其数据的应用、应用请求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

1. 打开 Google API 控制台的 OAuth 权限请求页面 页面。
2. 如果系统提示您选择项目，请选择您刚刚创建的项目。

3. 在“OAuth 权限请求页面”上，填写表单，然后点击“保存”按钮。

   应用名称 ：向用户征求同意的应用的名称。该名称应准确反映您的应用，并且与用户在其他位置看到的应用名称保持一致。应用名称将显示在账号关联权限请求页面上。

   应用徽标：权限请求页面上显示的一张图片，用以让用户认出您的应用。徽标会显示在账号关联权限请求页面和账号设置中

   支持邮箱 ：用户用于针对其同意问题与您联系的邮箱。

   Google API 的范围 ：范围允许您的应用访问用户的私有 Google 数据。对于 Google 账号关联用例，默认范围（邮箱、个人资料、openid）就足够了，您无需添加任何敏感范围。通常，最佳做法是在需要访问权限时逐步请求范围，而不是提前请求。了解详情。

   已获授权的网域 ：为了保护您和您的用户，Google 只允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

   应用首页链接 ：应用的首页。必须托管在已获授权的网域上。

   应用隐私权政策链接 ：显示在 Google 账号关联权限请求页面上。必须托管在已获授权的网域上。

   应用服务条款链接（可选） ：必须托管在已获授权的网域上。

   

   图 1. 虚构应用 Tunery 的 Google 账号关联权限请求页面

4. 查看“验证状态”，如果您的应用需要验证，请点击“提交以进行验证”按钮，提交应用以进行验证。如需了解详情，请参阅 OAuth 验证要求。

实现 OAuth 服务器

授权代码流程的 OAuth 2.0 服务器实现包含两个端点，您的服务通过 HTTPS 提供这两个端点。第一个端点是授权端点，负责查找或征得用户同意以获取数据访问权限。授权端点会向尚未登录的用户显示登录界面，并记录用户对所请求访问权限的同意情况。第二个端点是令牌交换端点，用于获取加密字符串（称为令牌），这些令牌可授权用户访问您的服务。

当 Google 应用需要调用您某项服务的 API 时，Google 会同时使用这些端点来征得用户同意，以便代表用户调用这些 API。

Google 账号关联：OAuth 授权代码流程

以下序列图详细说明了用户、Google 和您服务的端点之间的互动。

角色和职责

下表定义了 Google 账号关联 (GAL) OAuth 流中各个参与者的角色和职责。请注意，在 GAL 中，Google 充当 OAuth 客户端，而您的服务充当身份/服务提供方。

由 Google 发起的 OAuth 2.0 授权代码流程会话具有以下流程：

1. Google 会在用户的浏览器中打开您的授权端点。如果流程是在仅支持语音的设备上针对某项操作启动的，Google 会将执行转移到手机。
2. 用户登录（如果尚未登录），并授予 Google 权限以通过您的 API 访问其数据（如果尚未授予权限）。
3. 您的服务创建授权代码并将其返回给 Google。为此，请将用户的浏览器重定向回 Google，并在请求中附上授权代码。
4. Google 会将授权代码发送到您的令牌交换端点，该端点会验证代码的真实性，并返回访问令牌和刷新令牌。访问令牌是一种短期有效的令牌，您的服务会将其作为凭据来接受，以便访问 API。刷新令牌是一种长期有效的令牌，Google 可以存储并使用它在访问令牌过期时获取新的访问令牌。
5. 用户完成账号关联流程后，Google 发送的每个后续请求都包含一个访问令牌。

处理授权请求

当您需要使用 OAuth 2.0 授权码流程执行账号关联时，Google 会将用户发送到您的授权端点，并发送包含以下参数的请求：

例如，如果您的授权端点位于 https://myservice.example.com/auth，则请求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

如需让授权端点处理登录请求，请执行以下步骤：

1. 验证 client_id 是否与您分配给 Google 的客户端 ID 一致，以及 redirect_uri 是否与 Google 为您的服务提供的重定向网址一致。这些检查对于防止向意外或配置错误的客户端应用授予访问权限非常重要。如果您支持多个 OAuth 2.0 流程，还需确认 response_type 是否为 code。
2. 检查用户是否已登录您的服务。如果用户未登录，请完成服务的登录或注册流程。
3. 生成一个授权代码，供 Google 用于访问您的 API。 授权代码可以是任何字符串值，但必须唯一表示用户、令牌所针对的客户端和代码的过期时间，并且不得可猜测。您通常会签发大约 10 分钟后过期的授权码。
4. 确认 redirect_uri 参数指定的网址具有以下格式：

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. 将用户的浏览器重定向到 redirect_uri 参数指定的网址。通过附加 code 和 state 参数进行重定向时，请添加您刚刚生成的授权代码和原始的未修改状态值。以下是生成的网址示例：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

处理令牌交换请求

您服务的令牌交换端点负责处理两种类型的令牌交换：

• 将授权代码交换为访问令牌和刷新令牌
• 将刷新令牌换成访问令牌

令牌交换请求包含以下参数：

将授权代码交换为访问令牌和刷新令牌

用户登录后，您的授权端点会向 Google 返回一个时效很短的授权代码，然后 Google 会向您的令牌交换端点发送请求，以将该授权代码换成访问令牌和刷新令牌。

对于这些请求，grant_type 的值为 authorization_code，code 的值为您之前授予 Google 的授权代码的值。以下是使用授权代码交换访问令牌和刷新令牌的请求示例：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

如需使用授权代码换取访问令牌和刷新令牌，令牌交换端点会通过执行以下步骤来响应 POST 请求：

1. 验证 client_id 是否将请求来源标识为授权来源，以及 client_secret 是否与预期值匹配。
2. 验证授权代码是否有效且未过期，以及请求中指定的客户端 ID 是否与授权代码关联的客户端 ID 相符。
3. 确认 redirect_uri 参数指定的网址与初始授权请求中使用的值完全相同。
4. 如果您无法验证上述所有条件，请返回 HTTP 400 Bad Request 错误，并将 {"error": "invalid_grant"} 作为正文。
5. 否则，使用授权代码中的用户 ID 生成刷新令牌和访问令牌。这些令牌可以是任何字符串值，但必须唯一表示用户和令牌所针对的客户端，并且不得可猜测。对于访问令牌，还要记录令牌的过期时间，该时间通常是在您发放令牌后一小时。刷新令牌不会过期。
6. 在 HTTPS 响应的正文中返回以下 JSON 对象：

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Google 会存储用户的访问令牌和刷新令牌，并记录访问令牌的过期时间。当访问令牌过期时，Google 会使用刷新令牌从您的令牌交换端点获取新的访问令牌。

将刷新令牌换成访问令牌

当访问令牌过期时，Google 会向您的令牌交换端点发送请求，以将刷新令牌换成新的访问令牌。

对于这些请求，grant_type 的值为 refresh_token，而 refresh_token 的值为您之前授予 Google 的刷新令牌的值。以下是将刷新令牌换成访问令牌的请求示例：

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

如需将刷新令牌换成访问令牌，令牌交换端点会通过执行以下步骤来响应 POST 请求：

1. 验证 client_id 是否将请求源标识为 Google，以及 client_secret 是否与预期值一致。
2. 验证刷新令牌是否有效，以及请求中指定的客户端 ID 是否与刷新令牌关联的客户端 ID 相符。
3. 如果您无法验证上述所有条件，请返回 HTTP 400 Bad Request 错误，并将 {"error": "invalid_grant"} 作为正文。
4. 否则，请使用刷新令牌中的用户 ID 生成访问令牌。这些令牌可以是任何字符串值，但必须唯一表示用户和令牌所针对的客户端，并且不得可猜测。对于访问令牌，还要记录令牌的过期时间，通常是在您发放令牌后一小时。
5. 在 HTTPS 响应的正文中返回以下 JSON 对象：

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

处理 userinfo 请求

userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：

• 使用 Google One Tap 登录关联的账号。
• Android TV 提供顺畅的订阅体验。

从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。

例如，如果您的 userinfo 端点可通过 https://myservice.example.com/userinfo 时，请求可能如下所示：

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

为了让 userinfo 端点能够处理请求，请执行以下步骤：

1. 从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
2. 如果访问令牌无效，则使用 WWW-Authenticate 响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。

3. 如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应 回答：

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }

   如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。

   userinfo 端点响应
   sub	系统中用于识别用户的唯一 ID。
   email	用户的电子邮件地址。
   given_name	可选：用户的名字。
   family_name	可选：用户的姓氏。
   name	可选：用户的全名。
   picture	可选：用户的个人资料照片。

验证您的实现

您可以使用 OAuth 2.0 Playground 工具验证您的实现。

在该工具中，执行以下步骤：

1. 点击配置 settings 以打开“OAuth 2.0 配置”窗口。
2. 在 OAuth flow（OAuth 流程）字段中，选择 Client-side（客户端）。
3. 在 OAuth Endpoints 字段中，选择 Custom。
4. 在相应字段中指定您的 OAuth 2.0 端点以及您分配给 Google 的客户端 ID。
5. 在第 1 步部分中，请勿选择任何 Google 范围。请将此字段留空，或输入适用于您服务器的范围（如果您不使用 OAuth 范围，则输入任意字符串）。完成后，点击 Authorize APIs。
6. 在第 2 步和第 3 步部分中，完成 OAuth 2.0 流程，并验证每个步骤是否按预期运行。

您可以使用 Google 账号关联演示工具验证您的实现。

在该工具中，执行以下步骤：

1. 点击使用 Google 账号登录按钮。
2. 选择您要关联的账号。
3. 输入服务 ID。
4. （可选）输入您将请求访问的一个或多个范围。
5. 点击开始演示。
6. 当系统提示时，请确认您可以同意或拒绝关联请求。
7. 确认您已重定向到相应平台。