实现 OAuth 2.0 服务器

每个 Cloud-to-cloud 集成都必须包含用户身份验证机制。

通过身份验证，您可以将用户的 Google 账号与用户在您的身份验证系统中的账号相关联。这样，您就可以在您的执行方式接收到智能家居 intent 时识别用户。Google 智能家居仅支持包含授权代码流程的 OAuth。

本页介绍了如何设置 OAuth 2.0 服务器，以使其可与 Cloud-to-cloud 集成。

使用 OAuth 进行 Google 账号关联

在授权代码流程中，您需要两个端点：

  • 授权端点，向尚未登录的用户显示登录界面。授权端点还会创建一个短期有效的授权代码，用于记录用户对所请求的访问的同意情况。

  • 令牌交换端点，负责进行两种类型的交换：

    1. 将授权代码交换为长期刷新令牌和短期访问令牌。这种交换会在用户完成帐号关联流程后发生。
    2. 将长期刷新令牌交换成短期访问令牌。当 Google 因访问令牌已过期而需要新的访问令牌时，就会发生这种交换。

设计准则

本部分介绍了您为 OAuth 关联流程托管的用户屏幕的设计要求和建议。Google 应用调用该方法后，您的平台会向用户显示登录 Google 页面和帐号关联同意屏幕。用户在同意关联帐号后，会被重定向回 Google 的应用。

此图显示了用户将其 Google 帐号与您的身份验证系统相关联的步骤。第一个屏幕截图显示了用户从您的平台发起的关联。第二张图片显示了用户登录 Google 的情况，第三张图片显示了用户同意和确认将其 Google 帐号与您的应用相关联。最后的屏幕截图显示了 Google 应用中已成功关联的用户帐号。
图 1.帐号关联用户登录 Google 和权限请求页面。

要求

  1. 您必须表明用户的帐号将关联到 Google，而不是 Google Home 或 Google 助理等特定 Google 产品。
  2. 您必须拥有 Google 授权声明，例如“登录即表示您授权 Google 控制您的设备”。请参阅 Google Home 开发者政策的 Google 设备控制授权部分。
  3. 如果用户选择不关联，您必须为他们提供返回或取消的途径。
  4. 您必须打开“网络 OAuth 关联”页面，并确保用户能够清楚使用方法（例如用户名和密码字段）登录其 Google 帐号。不要使用 Google 登录 (GSI) 方法，让用户不必转到“网络 OAuth 关联”页面就可以进行关联。这违反了 Google 政策。

建议

建议您执行以下操作：

  1. 显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。

  2. 要分享的数据。使用简明扼要的语言告知用户 Google 需要他们的哪些数据以及原因。

  3. 明确的号召性用语。在您的同意屏幕上提供明确的号召性用语，例如“同意并关联”。这是因为用户需要了解他们需要与 Google 分享哪些数据才能关联帐号。

  4. 能够解除关联。提供一种供用户解除关联的机制，例如指向其在您平台上帐号设置的网址。或者，您也可以添加指向 Google 帐号的链接，以便用户管理其关联的帐号。

  5. 能够更改用户帐号。为用户提供切换帐号的方法。如果用户通常有多个帐号，此功能尤为有用。

    • 如果用户必须关闭同意屏幕才能切换帐号，请向 Google 发送可恢复的错误，以便用户通过 OAuth 关联方式登录所需的帐号。

  6. 添加徽标。在同意屏幕上显示贵公司的徽标。 根据样式准则放置徽标。如果您还想显示 Google 的徽标，请参阅徽标和商标。

授权代码流程

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

当 Google 应用需要调用您服务的某个 API 时，Google 会将这些端点搭配使用，以便从用户那里获得代表用户调用这些 API 的权限。

Google 发起的 OAuth 2.0 授权代码流程会遵循以下流程：

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

处理授权请求

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

授权端点参数
client_id 您分配给 Google 的客户端 ID。
redirect_uri 您要将此请求的回复发送到的网址。
state 一种记账值，会在重定向 URI 中保持不变地传回给 Google。
scope 可选：一组以空格分隔的范围字符串，用于指定 Google 请求授权访问的数据。
response_type 要在响应中返回的值的类型。对于 OAuth 2.0 授权代码流程，响应类型始终为 code。
user_locale 采用 RFC5646 格式的 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

处理令牌交换请求

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

  • 使用授权代码换取访问令牌和刷新令牌
  • 将刷新令牌换成访问令牌

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

令牌交换端点参数
client_id 此字符串用于将请求源标识为 Google。此字符串必须在您的系统中注册为 Google 的唯一标识符。
client_secret 您向 Google 注册的用于服务的密钥字符串。
grant_type 要交换的令牌的类型。可为 authorization_code 或 refresh_token。
code 如果为 grant_type=authorization_code，此参数是 Google 从您的登录或令牌交换端点收到的代码。
redirect_uri 为 grant_type=authorization_code 时，此参数是初始授权请求中使用的网址。
refresh_token 如果为 grant_type=refresh_token，此参数是 Google 从您的令牌交换端点收到的刷新令牌。

配置 Google 向您的服务器发送凭据的方式

根据其实现方式，授权服务器希望在请求正文或请求标头中接收客户端凭据。

默认情况下，Google 会在请求正文中发送凭据。如果您的授权服务器要求客户端凭据位于请求标头中，您必须相应地配置 Cloud-to-cloud 集成：

前往 Play 管理中心

  1. 在项目列表中，点击要处理的项目旁边的打开。

  2. 在云到云下，选择开发。

  3. 点击集成旁边的打开。

  4. 向下滚动到权限（可选）部分，然后选中允许 Google 通过 HTTP 基本 Auth 标头来传输客户端 ID 和客户端密钥复选框。

  5. 点击保存以保存更改。

使用授权代码换取访问令牌和刷新令牌

用户登录后，您的授权端点会向 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 错误请求，并将 {"error": "invalid_grant"} 作为正文。
  5. 否则，请使用授权代码中的用户 ID 生成刷新令牌和访问令牌。这些令牌可以是任何字符串值，但必须能唯一代表相应用户和令牌所针对的客户端，并且不得可猜测。对于访问令牌，还应记录令牌的到期时间，该时间通常为您签发令牌后的 1 小时。刷新令牌不会过期。
  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 错误请求，并将 {"error": "invalid_grant"} 作为正文。
  4. 否则，请使用刷新令牌中的用户 ID 生成访问令牌。这些令牌可以是任何字符串值，但必须能唯一代表令牌所代表的用户和客户端，并且不得可猜测。对于访问令牌，还应记录令牌的到期时间，通常是在您签发令牌后的 1 小时。
  5. 在 HTTPS 响应的正文中返回以下 JSON 对象：
    {
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

处理 userinfo 请求

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

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

userinfo 端点请求标头
Authorization header Bearer 类型的访问令牌。

例如，如果您的 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 可选：用户的个人资料照片。
上一页
Developer checklist
下一页
Create an Actions project