通过基于 OAuth 的 Google 登录“简化”关联实现帐号关联

如果使用基于 OAuth 的 Google 登录“精简”关联类型，则会在基于 OAuth 的帐号关联之前添加 Google 登录。这样可以为 Google 用户提供基于语音的无缝关联，同时还可以为使用非 Google 身份注册服务的用户启用帐号关联。

此关联类型以 Google 登录开头，可让您检查您的系统中是否存在用户的 Google 个人资料信息。如果未在系统中找到用户的信息，即会开始标准 OAuth 流程。用户也可以选择使用其 Google 个人资料信息创建新帐号。

图 1：您的 Action 获得用户的 Google 个人资料的访问权限后，您可以使用它在您的身份验证系统中查找该用户的匹配项。

如需使用精简关联类型执行帐号关联，请按以下常规步骤操作：

  1. 首先，请用户同意访问其 Google 个人资料。
  2. 使用其个人资料中的信息来识别用户。
  3. 如果您在身份验证系统中找不到 Google 用户匹配项，流程会继续，具体取决于您是在 Actions 控制台中将 Actions 项目配置为允许通过语音创建用户帐号，还是仅允许在您的网站上创建用户帐号。
    • 如果您允许通过语音创建帐号，请验证从 Google 收到的 ID 令牌。然后，您可以根据 ID 令牌中包含的个人资料信息创建用户。
    • 如果您不允许通过语音创建帐号，用户会被转移到浏览器，他们可以在其中加载您的授权页面并完成用户创建流程。
如果您允许通过语音创建帐号，但在身份验证系统中找不到与 Google 个人资料匹配的个人资料，则需要验证从 Google 收到的 ID 令牌。然后，您可以根据 ID 令牌中包含的个人资料信息创建用户。如果您不允许通过语音创建用户帐号，系统会将用户转到浏览器，以便他们可以加载您的授权页面并完成该流程。
图 2. 在您的系统找不到用户信息时，OAuth 和 Google 登录流程的直观表示。

支持通过语音创建账号

如果您允许通过语音创建用户帐号，Google 助理会询问用户是否想要执行以下操作：

  • 使用 Google 帐号信息在您的系统上创建一个新帐号，或
  • 如果用户已有非 Google 帐号，请使用其他帐号登录您的身份验证系统。

如果您想尽可能减少帐号创建流程的麻烦，建议允许通过语音创建帐号。用户只有在想使用现有的非 Google 帐号登录时，才需要退出语音流程。

禁止通过语音创建账号

如果您禁止通过语音创建用户帐号，Google 助理会打开您为进行用户身份验证而提供的网站的网址。如果互动发生在没有屏幕的设备上，Google 助理会将用户定向到手机，以继续完成账号关联流程。

在以下情况下，建议禁止创建：

  • 您不希望允许拥有非 Google 帐号的用户创建新的用户帐号，并希望他们与您的身份验证系统中的现有用户帐号相关联。例如，如果您提供会员回馈活动，则可能需要确保用户不会失去现有帐号累积的积分。

  • 您需要完全控制帐号创建流程。例如，如果您需要在创建帐号时向用户显示服务条款，可以禁止创建帐号。

实现基于 OAuth 的 Google 登录“简化”链接

帐号与业界标准 OAuth 2.0 流程相关联。 Actions on Google 支持隐式和授权代码流程。

In the implicit code 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 the Assistant to your Action.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
  • 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.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

配置项目

如需将项目配置为使用简化型关联，请按以下步骤操作：

  1. 打开 Actions 控制台，然后选择您要使用的项目。
  2. 点击 Develop 标签页，然后选择 Account linking。
  3. 启用帐号关联旁边的开关。
  4. 在帐号创建部分，选择是。

  5. 在关联类型中，依次选择 OAuth 和 Google 登录和隐式。

  6. 在 Client Information（客户信息）中，执行以下操作：

    • 为您的 Actions 向 Google 发出的客户端 ID 分配一个值，以标识来自 Google 的请求。
    • 插入授权端点和令牌交换端点的网址。

  7. 点击保存。

实现 OAuth 服务器

为了支持 OAuth 2.0 隐式流程，您的服务会进行授权 端点。此端点负责 就数据访问征得用户同意。授权端点 向尚未登录的用户显示登录界面，并记录 同意所请求的访问。

当您的 Action 需要调用您的某项授权的 API 时，Google 会使用 此端点来获得用户许可，以在其上调用这些 API 。

由 Google 发起的典型 OAuth 2.0 隐式流会话具有以下特征： 以下流程：

  1. Google 会在用户的浏览器中打开您的授权端点。通过 如果用户尚未登录，则可以登录，并且授予 Google 访问 通过您的 API 访问其数据（如果尚未授予权限）。
  2. 您的服务会创建一个访问令牌并将其返回给 通过使用访问令牌将用户的浏览器重定向回 Google， 附件。
  3. Google 调用您的服务的 API，并使用 。您的服务会验证访问令牌是否向 Google 授予 访问 API 的授权，然后完成 API 调用。

处理授权请求

当您的 Action 需要通过 OAuth 2.0 隐式流程执行账号关联时， Google 会通过包含以下内容的请求将用户发送到您的授权端点： 以下参数：

授权端点参数
client_id 您分配给 Google 的客户 ID。
redirect_uri 此请求的响应发送到的网址。
state 将一个在 重定向 URI。
response_type 要在响应中返回的值的类型。对于 OAuth 2.0 隐式 则响应类型始终为 token。

例如，如果您的授权端点可通过 https://myservice.example.com/auth 访问， 请求可能如下所示：

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

为了让授权端点能够处理登录请求，请执行以下步骤：

  1. 验证 client_id 和 redirect_uri 值， 防止向意外或配置错误的客户端应用授予访问权限：

    • 确认 client_id 是否与您的客户端 ID 匹配 分配给 Google。
    • 确认 redirect_uri 指定的网址 参数的格式如下： 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID 是项目设置页面上的 ID Actions 控制台界面。

  2. 检查用户是否已登录您的服务。如果用户未登录 中，完成服务的登录或注册流程。

  3. 生成 Google 将用于访问您的 API 的访问令牌。通过 访问令牌可以是任何字符串值，但必须唯一地表示 令牌对应的用户和客户端，且不得被猜到。

  4. 发送 HTTP 响应，将用户浏览器重定向到相应网址 由 redirect_uri 参数指定。添加所有 以下参数：

    • access_token：您刚刚生成的访问令牌
    • token_type：字符串 bearer
    • state：原始状态的未修改状态值 请求 以下是生成的网址示例： 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google 的 OAuth 2.0 重定向处理程序将收到访问令牌并确认 state 值没有更改。在 Google 获得 访问令牌，则 Google 会将该令牌附加到后续调用 作为 AppRequest 的一部分添加到您的 Action。

处理自动关联

在用户同意你的 Action 访问他们的 Google 个人资料后，Google 发送请求，其中包含 Google 用户身份的已签名断言。 该断言包含的信息包括用户的 Google 账号 ID、姓名、 和电子邮件地址。为项目配置的令牌交换端点处理 请求。

如果您的身份验证系统中已经存在相应的 Google 账号， 您的令牌交换端点为用户返回令牌。如果 Google 账号没有 匹配现有用户，您的令牌交换端点会返回 user_not_found 错误。

请求的格式如下：

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

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

您的令牌交换端点必须能够处理以下参数：

令牌端点参数
grant_type 所交换的令牌的类型。对于这类请求 参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer。
intent 对于这些请求，此参数的值为 `get`。
assertion 一个 JSON Web 令牌 (JWT)，提供 Google 用户身份。JWT 包含的信息包括 账号 ID、名称和电子邮件地址。
consent_code 可选：一个一次性代码（如果存在）用于表明 用户已同意你的 Action 访问指定范围。
scope 可选：您配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，它应该 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

解码后，JWT 断言如以下示例所示： 

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

检查您的身份验证系统中是否已存在该 Google 账号

请检查以下任一条件是否成立：

  • Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
  • 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则表明用户已经注册，您可以发出 访问令牌。

如果断言中指定的 Google 账号 ID 和电子邮件地址都没有 与您数据库中的用户匹配，表示该用户尚未注册。在这种情况下，您的 令牌交换端点应回复 HTTP 401 错误，指定 error=user_not_found， 如以下示例中所示：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}
当 Google 收到包含 user_not_found 错误的 401 错误响应时， 使用 intent 参数的值调用您的令牌交换端点 设置为 create 并发送包含用户个人资料信息的 ID 令牌 一起发送。

通过 Google 登录功能处理账号创建

当用户需要在您的服务中创建账号时，Google 会 向令牌交换端点发送的请求 intent=create，如以下示例所示：

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

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

assertion 参数包含 JSON Web 令牌 (JWT)，可提供 Google 用户的身份的已签名断言。JWT 包含 其中包含用户的 Google 账号 ID、姓名和电子邮件地址 为您的服务创建一个新账号。

如需响应账号创建请求，您的令牌交换端点必须执行以下操作 以下：

验证和解码 JWT 断言

您可以使用适用于您语言的 JWT 解码库来验证和解码 JWT 断言。 使用 Google 的公钥（适用于 JWK 或 PEM 格式）来验证令牌的 签名。

解码后，JWT 断言如以下示例所示： 

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

除了验证令牌的签名之外，还要验证断言的颁发者 （iss 字段）为 https://accounts.google.com，且受众群体（aud 字段） 是分配给您的 Action 的客户端 ID。

验证用户信息并创建新账号

请检查以下任一条件是否成立：

  • Google 账号 ID 可在断言的 sub 字段中找到，也可位于您的用户数据库中。
  • 断言中的电子邮件地址与用户数据库中的用户匹配。

如果满足上述任一条件，则提示用户将其现有账号关联 通过使用 HTTP 401 错误响应请求 error=linking_error，并将用户的电子邮件地址为 login_hint，如 示例：

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

如果以上两个条件都不满足，请使用相应信息创建一个新的用户账号 。新账号通常不会设置密码。时间是 建议您将 Google 登录功能添加到其他平台，以便用户能够 在您的应用的各个界面上通过 Google 投放广告。或者，您也可以 通过电子邮件向用户发送链接，启动密码恢复流程，以便用户设置 密码，以便在其他平台上登录。

创建完成后，发出一个访问令牌 并在 HTTPS 响应的正文，如以下示例所示： 

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

为身份验证流程设计语音界面

检查用户是否已通过验证，并启动账号关联流程

  1. 在 Actions 控制台中打开您的 Actions Builder 项目。
  2. 创建一个新场景，以开始在您的 Action 中关联帐号：
    1. 点击 Scenes。
    2. 点击添加 (+) 图标以添加新场景。
  3. 在新创建的场景中，点击条件对应的添加 图标。
  4. 添加一个条件，用于检查与对话关联的用户是否为经过验证的用户。如果检查失败，您的 Action 无法在对话期间执行帐号关联，而应回退以提供对不需要帐号关联的功能的访问权限。
    1. 在条件下的 Enter new expression 字段中，输入以下逻辑：user.verificationStatus != "VERIFIED"
    2. 在 Transition 下，选择不需要帐号关联的场景，或选择访客专享功能的入口点。

  1. 点击条件对应的添加 图标。
  2. 添加一个条件，以便在用户没有关联的身份时触发帐号关联流程。
    1. 在条件下的 Enter new expression 字段中，输入以下逻辑：user.verificationStatus == "VERIFIED"
    2. 在转换下，选择帐号关联系统场景。
    3. 点击保存。

保存后，系统会将一个名为 <SceneName>_AccountLinking 的新帐号关联系统场景添加到您的项目中。

自定义账号关联场景

  1. 在 Scenes 下，选择帐号关联系统场景。
  2. 点击发送提示并添加一小句话，向用户说明该 Action 为何需要访问其身份（例如“保存您的偏好设置”）。
  3. 点击保存。

  1. 在条件下，点击如果用户成功完成帐号关联。
  2. 配置当用户同意关联其账号时该流程应如何处理。 例如，调用网络钩子以处理所需的任何自定义业务逻辑，并转换回原始场景。
  3. 点击保存。

  1. 在条件下方，点击如果用户取消或忽略帐号关联。
  2. 配置如果用户不同意关联其帐号，相应流程应如何处理。例如，发送确认消息并重定向到提供无需进行帐号关联的功能的场景。
  3. 点击保存。

  1. 在条件下方，点击如果出现系统或网络错误。
  2. 配置帐号关联流程因系统或网络错误而无法完成时应采取的流程。例如，发送确认消息并重定向到提供无需进行帐号关联的功能的场景。
  3. 点击保存。

处理数据访问请求

如果 Google 助理请求包含访问令牌，请先检查访问令牌是否有效且未过期，然后从用户帐号数据库中检索与该令牌关联的用户帐号。