带有OAuth的Google帐户链接

帐户使用行业标准的OAuth 2.0隐式授权代码流进行链接。您的服务必须支持符合OAuth 2.0的授权令牌交换端点。

隐式流程中,Google在用户的浏览器中打开您的授权端点。成功登录后,您可以将长期访问令牌返回给Google。现在,此访问令牌包含在Google发送的每个请求中。

授权代码流中,您需要两个端点:

  • 授权端点,向尚未登录的用户显示登录UI。授权端点还创建了一个短暂的授权代码,以记录用户对所请求访问的同意。

  • 令牌交换端点,它负责两种类型的交换:

    1. 将授权代码交换为长寿命的刷新令牌和短寿命的访问令牌。当用户完成帐户链接流程时,就会发生这种交换。
    2. 将长寿命的刷新令牌交换为短寿命的访问令牌。当Google需要一个新的访问令牌(因为该令牌已过期)时,就会发生这种交换。

选择一个OAuth 2.0流程

尽管隐式流更易于实现,但Google建议隐式流发出的访问令牌永远不会过期。这是因为在令牌与隐式流一起过期之后,用户被迫再次链接其帐户。如果出于安全原因需要令牌到期,我们强烈建议您改用授权代码流。

设计准则

本部分描述了托管OAuth链接流的用户屏幕的设计要求和建议。在由Google应用程序调用后,您的平台会显示登录Google页面和用户的帐户链接同意屏幕。在同意链接帐户后,该用户将被定向回到Google的应用程序。

此图显示了用户将其Google帐户链接到您的身份验证系统的步骤。第一个屏幕截图显示了用户从您的平台启动的链接。第二张图片显示用户登录Google,第三张图片显示用户同意并确认将其Google帐户与您的应用程序关联。最终的屏幕截图显示了Google应用程序中已成功链接的用户帐户。
图1.帐户链接用户登录到Google和同意屏幕。

要求

  1. 您必须告知用户帐户将链接到Google,而不是特定的Google产品(例如Google Home或Google Assistant)。

推荐建议

我们建议您执行以下操作:

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

  2. 要共享的数据。使用简洁明了的语言告诉用户Google需要提供哪些数据以及原因。

  3. 清除号召性用语。在您的同意屏幕上注明明确的号召性用语,例如“同意并链接”。这是因为用户需要了解与Google共享帐户链接所需的数据。

  4. 取消的能力。如果用户选择不链接,则为用户提供返回或取消的方式。

  5. 清除登录过程。确保用户使用清晰的方法登录自己的Google帐户,例如用户名和密码或使用Google登录字段。

  6. 取消链接的能力。为用户提供取消链接的机制,例如指向其平台上的帐户设置的URL。或者,您可以包含指向Google帐户的链接,用户可以在其中管理其链接的帐户。

  7. 能够更改用户帐户。建议用户切换帐户的方法。如果用户倾向于拥有多个帐户,这将特别有益。

    • 如果用户必须关闭同意屏幕才能切换帐户,请向Google发送可恢复的错误,以便用户可以使用OAuth链接隐式流程登录所需的帐户。
  8. 包括您的徽标。在同意屏幕上显示您的公司徽标。使用样式准则放置徽标。如果您还希望显示Google的徽标,请参阅徽标和商标

建立专案

要创建您的项目以使用帐户链接:

  1. Go to the Google API Console.
  2. 单击创建项目
  3. 输入名称或接受生成的建议。
  4. 确认或编辑所有剩余字段。
  5. 点击创建

要查看您的项目ID:

  1. Go to the Google API Console.
  2. 在登录页面的表格中找到您的项目。项目ID出现在ID列中。

Google帐户链接过程包括一个同意屏幕,该屏幕告诉用户请求访问其数据的应用程序,他们要求的数据类型以及适用的条款。在生成Google API客户端ID之前,您需要先配置OAuth同意屏幕。

  1. 打开Goog​​le API控制台的OAuth同意屏幕页面。
  2. 如果出现提示,请选择刚刚创建的项目。
  3. 在“ OAuth同意屏幕”页面上,填写表格,然后单击“保存”按钮。

    申请名称:要求同意的申请名称。该名称应准确反映您的应用程序,并与用户在其他地方看到的应用程序名称一致。应用程序名称将显示在“帐户链接同意”屏幕上。

    应用程序徽标:同意屏幕上的图像,可帮助用户识别您的应用程序。徽标显示在“帐户链接同意”屏幕和帐户设置上

    支持电子邮件:供用户与您联系以获取有关其同意的问题。

    Google API范围范围允许您的应用访问用户的私人Google数据。对于Google帐户关联用例,默认范围(电子邮件,个人资料,openid)就足够了,您无需添加任何敏感范围。通常,最佳做法是在需要访问时而不是预先请求增量地作用域。 了解更多

    授权域:为了保护您和您的用户,Google仅允许使用OAuth进行身份验证的应用程序使用授权域。您的应用程序的链接必须托管在授权域中。 了解更多

    应用程序主页链接:您的应用程序的主页。必须托管在授权域上。

    应用程序隐私权政策链接:显示在Google Acount Linking同意屏幕上。必须托管在授权域上。

    应用程序服务条款链接(可选):必须托管在授权域中。

    图1 。虚拟应用程序Google Tuning的Google帐户链接同意屏幕

  4. 选中“验证状态”,如果您的应用程序需要验证,则单击“提交验证”按钮以提交您的应用程序以进行验证。有关详细信息,请参阅OAuth验证要求

实施您的OAuth服务器

授权码流的的OAuth 2.0服务器实现由两个端点,通过HTTPS,你的服务使可用的。第一个端点是授权端点,它负责查找或获得用户对数据访问的同意。授权端点向尚未登录的用户显示登录 UI,并记录对请求访问的同意。第二个端点是令牌交换端点,用于获取加密字符串,称为令牌,授权用户访问您的服务。

当 Google 应用程序需要调用您服务的某个 API 时,Google 会结合使用这些端点来获得您的用户的许可,以代表他们调用这些 API。

Google发起的一次OAuth 2.0授权码流会话流程如下:

  1. Google 在用户的浏览器中打开您的授权端点。如果流程在 Action 的纯语音设备上开始,Google 会将执行转移到手机。
  2. 用户登录(如果尚未登录)并授予 Google 使用您的 API 访问其数据的权限(如果他们尚未授予权限)。
  3. 您的服务创建一个授权码,并返回给谷歌。为此,请将用户的浏览器重定向回 Google,并将授权代码附加到请求中。
  4. 谷歌发送授权代码,您的令牌交换终结,从而验证代码的真实性,并返回一个访问令牌刷新令牌。访问令牌是一个短期令牌,您的服务接受它作为访问 API 的凭据。刷新令牌是一个长期存在的令牌,Google 可以存储它并在它们到期时使用它来获取新的访问令牌。
  5. 用户完成帐户关联流程后,从 Google 发送的每个后续请求都包含一个访问令牌。

处理授权请求

当您需要使用 OAuth 2.0 授权代码流执行帐户关联时,Google 会将用户发送到您的授权端点,并发送一个包含以下参数的请求:

授权端点参数
client_id您分配给 Google 的客户 ID。
redirect_uri您向其发送对此请求的响应的 URL。
state传递回 Google 的簿记值在重定向 URI 中保持不变。
scope可选:以空格分隔的集合,其指定谷歌正在请求授权的数据范围的字符串。
response_type要在响应中返回的值的类型。对于的OAuth 2.0授权码流,响应类型总是code
user_locale在谷歌帐户语言设置RFC5646格式,用于本地化用户的首选语言内容。

例如,如果您的授权端点可在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您分配给谷歌的客户ID匹配,并且该redirect_uri由谷歌为您服务提供的重定向URL匹配。这些检查对于防止授予对意外或配置错误的客户端应用程序的访问权限非常重要。如果你支持多种OAuth 2.0流程的,也确认response_typecode
  2. 检查用户是否已登录您的服务。如果用户未登录,请完成服务的登录或注册流程。
  3. 生成供 Google 用于访问您的 API 的授权代码。授权码可以是任意字符串值,但必须唯一代表用户、token所针对的客户端、授权码的过期时间,并且不能被猜到。您通常会发出大约 10 分钟后过期的授权代码。
  4. 确认URL指定由redirect_uri参数有以下形式:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  5. 重定向用户的浏览器由指定的URL redirect_uri参数。当你通过附加重定向包括刚刚生成授权码和原始未修正的状态值codestate参数。以下是所得的URL的一个示例:
    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_coderefresh_token
codegrant_type=authorization_code ,这个参数是从您登录或令牌交换终结收到谷歌的代码。
redirect_urigrant_type=authorization_code ,该参数是在初始授权请求中使用的URL。
refresh_tokengrant_type=refresh_token ,这个参数是令牌从令牌交换终结收到谷歌的刷新。
交换访问令牌和刷新令牌的授权代码

在用户登录并且您的授权端点向 Google 返回一个短期授权代码后,Google 会向您的令牌交换端点发送请求,以交换访问令牌和刷新令牌的授权代码。

对于这些请求,价值grant_typeauthorization_code ,和值code是您先前授予给谷歌授权码的值。以下是为访问令牌和刷新令牌交换授权代码的请求示例:

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

要为访问Exchange授权码令牌和刷新令牌,您的令牌交换终结响应POST通过执行以下步骤要求:

  1. 验证该client_id识别为授权原点,并且所述请求源client_secret预期值相匹配。
  2. 验证授权码是否有效且未过期,以及请求中指定的客户端 ID 是否与与授权码关联的客户端 ID 匹配。
  3. 确认URL中指定由redirect_uri参数是相同的初始授权请求中使用的值。
  4. 如果您无法验证所有的上述标准,则返回一个HTTP 400错误的请求错误与{"error": "invalid_grant"}作为身体。
  5. 否则,使用授权代码中的用户 ID 生成刷新令牌和访问令牌。这些令牌可以是任何字符串值,但它们必须唯一地代表令牌所针对的用户和客户端,并且不能被猜测。对于访问令牌,还要记录令牌的到期时间,通常是您发出令牌后的一个小时。刷新令牌不会过期。
  6. 返回以下JSON对象在HTTPS响应的主体:
    {
    "token_type": "Bearer",
    "access_token": "ACCESS_TOKEN",
    "refresh_token": "REFRESH_TOKEN",
    "expires_in": SECONDS_TO_EXPIRATION
    }
    

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

交换刷新令牌以获取访问令牌

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

对于这些请求,价值grant_typerefresh_token ,和值refresh_token是令牌先前授予谷歌刷新的值。以下是将刷新令牌交换为访问令牌的请求示例:

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标识请求起源谷歌,那client_secret预期值相符。
  2. 验证刷新令牌是否有效,以及请求中指定的客户端 ID 是否与与刷新令牌关联的客户端 ID 匹配。
  3. 如果您无法验证所有的上述标准,则返回一个HTTP 400错误的请求错误与{"error": "invalid_grant"}作为身体。
  4. 否则,使用刷新令牌中的用户 ID 生成访问令牌。这些令牌可以是任何字符串值,但它们必须唯一地代表令牌所针对的用户和客户端,并且不能被猜测。对于访问令牌,还要记录令牌的到期时间,通常是在您发出令牌后的一个小时。
  5. 在 HTTPS 响应的正文中返回以下 JSON 对象:
    {
    "token_type": "Bearer",
    "access_token": " ACCESS_TOKEN ",
    "expires_in": SECONDS_TO_EXPIRATION
    }

验证您的实施

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

  1. Click Configuration to open the OAuth 2.0 Configuration window.
  2. In the OAuth flow field, select Client-side.
  3. In the OAuth Endpoints field, select Custom.
  4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
  5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
  6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

  1. Click the Sign-in with Google button.
  2. Choose the account you'd like to link.
  3. Enter the service ID.
  4. Optionally enter one or more scopes that you will request access for.
  5. Click Start Demo.
  6. When prompted, confirm that you may consent and deny the linking request.
  7. Confirm that you are redirected to your platform.