带有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在用户的浏览器中打开您的授权端点。用户登录(如果尚未登录),如果尚未授予Google许可,则可以使用您的API来访问其数据。
  2. 您的服务会创建一个访问令牌,并将其返回给Google。为此,请将用户的浏览器重定向回Google,并将访问令牌附加到请求中。
  3. Google会调用您服务的API,并在每个请求中附加访问令牌。您的服务将验证访问令牌是否已授予Google授权以访问API,然后完成API调用。

处理授权请求

当Google应用程序需要通过OAuth 2.0隐式流程执行帐户链接时,Google会通过包含以下参数的请求将用户发送到您的授权端点:

授权端点参数
client_id您分配给Google的客户ID。
redirect_uri您将对此请求的响应发送到的URL。
state重定向URI中的传递给Google的簿记值保持不变。
response_type要在响应中返回的值的类型。对于OAuth 2.0隐式流,响应类型始终为token
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&response_type=token&user_locale=LOCALE

为了使您的授权端点能够处理登录请求,请执行以下步骤:

  1. 验证client_idredirect_uri值,以防止授予对意外或错误配置的客户端应用程序的访问权限:

    • 确认client_id与您分配给Google的客户ID匹配。
    • 确认redirect_uri参数指定的URL具有以下格式:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  2. 检查用户是否登录到您的服务。如果用户未登录,请完成服务的登录或注册流程。

  3. 为Google生成访问令牌,以用于访问您的API。访问令牌可以是任何字符串值,但是它必须唯一地代表令牌所针对的用户和客户端,并且不能猜测。

  4. 发送HTTP响应,该响应将用户的浏览器redirect_uriredirect_uri参数指定的URL。在URL片段中包括以下所有参数:

    • access_token :您刚刚生成的访问令牌
    • token_type :字符串bearer
    • state :原始请求中未修改的state值

    以下是所得URL的示例:

    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会将令牌附加到对您的服务API的后续调用中。

验证您的实施

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.