Vinculação de Conta do Google com OAuth

As contas são vinculadas usando fluxos implícitos e de código de autorização padrão do setor 2.0. Seu serviço precisa ser compatível com endpoints de autorização e troca de tokens compatíveis com o OAuth 2.0.

No fluxo implícito, o Google abre o endpoint de autorização no navegador do usuário. Após o login, você retorna um token de acesso de longa duração ao Google. Agora, esse token de acesso está incluído em todas as solicitações enviadas do Google.

No fluxo de código de autorização, você precisa de dois endpoints:

• o endpoint de autorização, que apresenta a IU de login aos seus usuários que ainda não fizeram login; O endpoint de autorização também cria um código de autorização de curta duração para registrar usuários e consentir com o acesso solicitado.

• O endpoint de troca de token, responsável por dois tipos de trocas:

  1. Troca um código de autorização por um token de atualização de longa duração e um token de acesso de curta duração. Essa troca acontece quando o usuário passa pelo fluxo de vinculação da conta.
  2. Troca um token de atualização de longa duração por um token de acesso de curta duração. Essa troca acontece quando o Google precisa de um novo token de acesso porque ele expirou.

Escolher um fluxo do OAuth 2.0

Embora o fluxo implícito seja mais simples de implementar, o Google recomenda que os tokens de acesso emitidos pelo fluxo implícito nunca expirem. Isso ocorre porque o usuário é forçado a vincular a conta novamente depois que um token expira com o fluxo implícito. Se você precisar da expiração do token por motivos de segurança, é altamente recomendável usar o fluxo de código de autorização.

Observação: use os botões a seguir para escolher qual fluxo do OAuth 2.0 você quer implementar. Se necessário, o conteúdo deste guia será atualizado para corresponder à sua escolha.

Fluxo implícito Código de autorização

Diretrizes de design

Esta seção descreve os requisitos de projeto e as recomendações para a tela do usuário hospedada para fluxos de vinculação do OAuth. Depois de ser chamado pelo app do Google, sua plataforma exibe um login na página do Google e na tela de consentimento de vinculação da conta ao usuário. O usuário é redirecionado de volta ao app do Google depois de autorizar a vinculação das contas.

Figura 1. Login do usuário: login na conta do Google e telas de consentimento.

Requisitos

1. Você precisa comunicar que a conta do usuário será vinculada ao Google, não a um produto específico do Google, como o Google Home ou o Google Assistente.

Recomendações

Portanto, recomendamos que você faça o seguinte:

1. Exibir a Política de Privacidade do Google. Inclua um link para a Política de Privacidade do Google na tela de consentimento.

2. Dados a serem compartilhados. Use uma linguagem clara e concisa para dizer ao usuário quais dados o Google exige e por quê.

3. Call-to-action clara. Insira uma call-to-action clara na tela de consentimento, como "Aceitar e vincular". Isso ocorre porque os usuários precisam entender quais dados eles precisam compartilhar com o Google para vincular as contas.

4. Opção de cancelamento. Ofereça aos usuários a opção de voltar ou cancelar.

5. Limpar o processo de login. Verifique se os usuários têm um método claro para fazer login na Conta do Google, como campos de nome de usuário e senha ou Fazer login com o Google.

6. Capacidade de desvincular. Ofereça um mecanismo para os usuários desvincularem, como um URL para as configurações da conta na plataforma. Se preferir, inclua um link para a Conta do Google em que os usuários possam gerenciar a conta vinculada.

7. É possível mudar a conta de usuário. Sugerir um método para os usuários trocarem de conta. Isso é útil principalmente quando os usuários costumam ter várias contas.

   • Se um usuário precisar fechar a tela de consentimento para alternar entre contas, envie um erro recuperável ao Google para que o usuário possa fazer login na conta desejada com vinculação do OAuth e o fluxo implícito.

8. Inclua seu logotipo. Exiba o logotipo da sua empresa na tela de consentimento. Use suas diretrizes de estilo para inserir o logotipo. Se você também quiser exibir o logotipo do Google, consulte Logotipos e marcas registradas.

Figura 2. Diretrizes de design para o login de usuários no Google e em telas de consentimento.

Criar o projeto

Observação :é possível reutilizar um projeto atual sem precisar criar um novo principalmente para vincular contas.

Para criar seu projeto e usar a vinculação de contas, faça o seguinte:

1. Go to the Google API Console.
2. Clique em Criar projeto .
3. Digite um nome ou aceite a sugestão gerada.
4. Confirme ou edite os campos restantes.
5. Clique em Create .

Para visualizar o seu ID do projeto:

1. Go to the Google API Console.
2. Encontre seu projeto na tabela na página de destino. O ID do projeto aparece na coluna ID .

Configurar a tela de permissão OAuth

O processo de vinculação de Contas do Google inclui uma tela de consentimento que informa aos usuários o aplicativo que está solicitando acesso aos dados deles, o tipo de dado solicitado e os termos aplicáveis. Você precisa configurar a tela de permissão OAuth antes de gerar um ID do cliente da API do Google.

1. Abra a página Tela de permissão OAuth do Console de APIs do Google.
2. Se solicitado, selecione o projeto que você acabou de criar.

3. Na página "Tela de permissão OAuth", preencha o formulário e clique no botão "Salvar".

   Nome do aplicativo: o nome do aplicativo que está solicitando o consentimento. O nome precisa refletir com precisão o aplicativo e ser consistente com o nome do aplicativo que os usuários veem em outros lugares. O nome do aplicativo vai ser mostrado na tela de permissão da vinculação de contas.

   Logotipo do aplicativo:uma imagem na tela de permissão que ajuda os usuários a reconhecer seu app. O logotipo é exibido na tela de permissão para vinculação de contas e nas configurações da conta.

   E-mail de suporte:para os usuários entrarem em contato com você para esclarecer dúvidas sobre o consentimento.

   Escopos para APIs do Google:os escopos permitem que seu aplicativo acesse os dados particulares do usuário do Google. Para o caso de uso de vinculação de Conta do Google, o escopo padrão (e-mail, perfil, OpenID) é suficiente. Não é necessário adicionar escopos confidenciais. Geralmente, é uma prática recomendada solicitar escopos de forma incremental no momento em que o acesso é necessário, em vez de antecipadamente. Saiba mais.

   Domínios autorizados:para proteger você e seus usuários, o Google permite que apenas aplicativos com autenticação OAuth usem os domínios autorizados. Os links dos seus aplicativos precisam estar hospedados em domínios autorizados. Saiba mais.

   Link da página inicial do aplicativo: página inicial do seu aplicativo. Precisa estar hospedado em um domínio autorizado.

   Link da Política de Privacidade do aplicativo:aparece na tela de permissão para vinculação de Contas do Google. Precisa estar hospedado em um domínio autorizado.

   Link dos Termos de Serviço do aplicativo (opcional): precisa ser hospedado em um domínio autorizado.

   

   Figura 1. Tela de consentimento de vinculação de Conta do Google para um aplicativo fictício, o Tunery

4. Marque o "Status da verificação" se o seu aplicativo precisar de verificação e clique no botão "Enviar para verificação" para enviá-lo para verificação. Consulte os requisitos de verificação do OAuth para ver mais detalhes.

Implementar o servidor OAuth

为了支持OAuth 2.0已隐含流，你的服务使可通过HTTPS授权端点。此端点负责身份验证并获得用户对数据访问的同意。授权端点向尚未登录的用户显示登录 UI，并记录对请求访问的同意。

当 Google 应用程序需要调用您的服务的授权 API 之一时，Google 会使用此端点来获得您的用户的许可，以代表他们调用这些 API。

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

1. Google 在用户的浏览器中打开您的授权端点。用户登录（如果尚未登录）并授予 Google 使用您的 API 访问其数据的权限（如果他们尚未授予权限）。
2. 您的服务创建的访问令牌并将其返回给谷歌。为此，请使用附加到请求的访问令牌将用户的浏览器重定向回 Google。
3. Google 会调用您服务的 API 并在每个请求中附加访问令牌。您的服务会验证访问令牌是否授予 Google 访问 API 的授权，然后完成 API 调用。

处理授权请求

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

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

对于处理登录请求的授权端点，请执行以下步骤：

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

   • 确认该client_id你分配给谷歌的客户ID相匹配。
   • 确认URL指定由redirect_uri参数有以下形式：

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

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

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

4. 发送用户的浏览器重定向到被指定的URL的HTTP响应redirect_uri参数。在 URL 片段中包含以下所有参数：

   • access_token ：刚才生成的令牌，你的访问
   • token_type ：字符串bearer
   • state ：从原始请求的未修改的状态值

   以下是所得的URL的一个示例：

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

谷歌的OAuth 2.0重定向处理接收的令牌的访问并确认state的值并没有改变。在 Google 为您的服务获取访问令牌后，Google 会将令牌附加到对您的服务 API 的后续调用中。

处理用户信息请求

该用户信息终端是一个OAuth 2.0保护的资源，对链接的用户返回的权利要求。实现和托管 userinfo 端点是可选的，以下用例除外：

• 链接帐户登录与谷歌一个水龙头。
• 无摩擦订阅的AndroidTV。

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

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

例如，如果你的用户信息终端可在https://myservice.example.com/userinfo ，请求看起来像下面这样：

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

要让您的 userinfo 端点处理请求，请执行以下步骤：

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

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

   如果一个401未经授权，或任何其它不成功错误响应在关联过程返回时，误差将是不可恢复的，所检索的令牌将被丢弃，并且用户将必须再次启动链接过程。

3. 如果访问令牌是有效的，回国与以下JSON对象在HTTPS响应的身体HTTP 200回应：

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

   如果你的用户信息端点返回一个HTTP 200成功响应，检索到的令牌和索赔登记针对用户的谷歌帐户。

   用户信息端点响应
   sub	标识系统中用户的唯一 ID。
   email	用户的电子邮件地址。
   given_name	可选：用户的名字。
   family_name	可选：用户的姓氏。
   name	可选：用户的全名。
   picture	可选：用户的档案图片。

Como validar a implementação

您可以通过使用验证实现的OAuth 2.0游乐场工具。

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

1. 单击配置打开的OAuth 2.0配置窗口。
2. 在OAuth流场中，选择客户端。
3. 在OAuth端点字段中，选择自定义。
4. 在相应字段中指定您的 OAuth 2.0 端点和您分配给 Google 的客户端 ID。
5. 在步骤1部分，不要选择任何谷歌范围。相反，将此字段留空或键入对您的服务器有效的范围（如果不使用 OAuth 范围，则输入任意字符串）。当您完成后，单击授权的API。
6. 在步骤2和步骤3段，完成OAuth 2.0流程和验证每个步骤按预期工作。

您可以通过验证您的实现谷歌帐户链接演示工具。

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

1. 点击登录在与谷歌按钮。
2. 选择您要关联的帐户。
3. 输入服务标识。
4. （可选）输入您将请求访问的一个或多个范围。
5. 单击开始演示。
6. 出现提示时，确认您可以同意并拒绝链接请求。
7. 确认您被重定向到您的平台。