Vinculação de contas com a vinculação "simplificada" do Login do Google com base em OAuth

O tipo de vinculação simplificada do Login do Google com base em OAuth adiciona o Login do Google à vinculação de contas com base em OAuth. Isso fornece vinculação baseada em voz integrada para usuários do Google e, ao mesmo tempo, permite a vinculação de contas para usuários que se registraram no serviço com uma identidade que não é do Google.

Esse tipo de vinculação começa com o Login do Google, que permite verificar se as informações do perfil do Google do usuário existem no seu sistema. Se as informações do usuário não forem encontradas no sistema, um fluxo padrão do OAuth será iniciado. O usuário também pode optar por criar uma nova conta com as informações do perfil do Google dele.

Figura 1: depois que a Ação tiver acesso ao perfil do Google do usuário, use-o para encontrar uma correspondência para o usuário no sistema de autenticação.

Para fazer a vinculação de contas com o tipo de vinculação simplificada, siga estas etapas gerais:

  1. Primeiro, peça que o usuário dê consentimento para acessar o perfil do Google.
  2. Use as informações no perfil para identificar o usuário.
  3. Se não encontrar uma correspondência para o usuário do Google no sistema de autenticação, o fluxo continuará dependendo se você configurou o projeto do Actions no Console do Actions para permitir a criação de contas de usuário por voz ou apenas no seu site.
    • Se você permitir a criação de conta por voz, valide o token de ID recebido do Google. Então, você poderá criar um usuário com base nas informações de perfil contidas no token de ID.
    • Se você não permitir a criação de contas por voz, o usuário será transferido para um navegador em que ele poderá carregar sua página de autorização e concluir o fluxo de criação.
Se você permitir a criação de contas por voz e não encontrar uma correspondência para o perfil do Google no seu sistema de autenticação, será necessário validar o token de ID recebido do Google. Então, você poderá criar um usuário com base nas informações de perfil contidas no token de ID. Se você não permitir a criação de contas de usuário por voz, o usuário será transferido para um navegador em que poderá carregar sua página de autorização e concluir o fluxo.
Figura 2. Uma representação visual do fluxo de OAuth e Login do Google quando as informações de um usuário não são encontradas no seu sistema.

Suporte à criação de contas por voz

Se você permitir a criação de contas de usuário por voz, o Google Assistente vai perguntar ao usuário se ele quer fazer o seguinte:

  • Criar uma nova conta no seu sistema usando as informações da Conta do Google dele ou
  • Faça login no seu sistema de autenticação com uma conta diferente, se ele já tiver uma conta que não seja do Google.

Permitir a criação de contas por voz é recomendado se você quiser minimizar o atrito do fluxo de criação de contas. O usuário só precisa sair do fluxo de voz se quiser fazer login usando uma conta que não seja do Google.

Não permitir a criação de conta por voz

Se você não permitir a criação de contas de usuário por voz, o Google Assistente vai abrir o URL do site fornecido para a autenticação. Se a interação estiver acontecendo em um dispositivo sem tela, o Google Assistente vai direcionar o usuário a um smartphone para continuar o fluxo de vinculação da conta.

É recomendável não permitir a criação se:

  • Você não quer permitir que usuários que tenham contas que não sejam do Google criem uma nova conta de usuário e que vinculem as contas de usuário existentes no seu sistema de autenticação. Por exemplo, se você oferecer um programa de fidelidade, convém garantir que o usuário não perca os pontos acumulados na conta atual.

  • Você precisa ter controle total do fluxo de criação da conta. Por exemplo, você poderá impedir a criação se precisar mostrar seus Termos de Serviço ao usuário durante a criação da conta.

Implementar a vinculação simplificada do Login do Google com base em OAuth

As contas estão vinculadas aos fluxos do OAuth 2.0 padrão do setor. O Actions on Google oferece suporte aos fluxos implícitos e de código de autorização.

No fluxo de código 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 para o Google. Esse token de acesso agora está incluído em todas as solicitações enviadas do Assistente para sua ação.

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

  • O endpoint de autorização, responsável por apresentar a IU de login aos usuários que ainda não fizeram login e registrar o consentimento para o acesso solicitado na forma de um código de autorização de curta duração.
  • O endpoint de troca de token, que é 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.

Embora o fluxo do código implícito seja mais simples de implementar, o Google recomenda que os tokens de acesso emitidos usando o fluxo implícito nunca expirem, porque o uso do token com o fluxo implícito força o usuário a vincular a conta novamente. Se você precisar da validade do token por motivos de segurança, considere o uso do fluxo do código de autenticação.

Configurar o projeto

Para configurar seu projeto para usar a vinculação simplificada, siga estas etapas:

  1. Abra o Console do Actions e selecione o projeto que você quer usar.
  2. Clique na guia Desenvolver e escolha Vinculação de contas.
  3. Ative a chave ao lado de Vinculação de contas.
  4. Na seção Criação de conta, selecione Sim.

  5. Em Tipo de vinculação, selecione OAuth e Login do Google e Implícito.

  6. Em Informações do cliente, faça o seguinte:

    • Atribua um valor ao ID do cliente emitido pelas suas ações para o Google para identificar solicitações do Google.
    • Insira os URLs dos endpoints de autorização e de troca de tokens.

  7. Clique em Salvar.

Implementar o servidor OAuth

Para oferecer suporte ao fluxo implícito do OAuth 2.0, seu serviço disponibiliza um endpoint de autorização por HTTPS. Esse endpoint é responsável por autenticar e receber o consentimento dos usuários para acessar os dados. O endpoint de autorização apresenta uma interface de login para os usuários que ainda não estão conectados e registra o consentimento para o acesso solicitado.

Quando a ação precisa chamar uma das APIs autorizadas do serviço, o Google usa esse endpoint para receber permissão dos usuários para chamar essas APIs em nome deles.

Uma sessão de fluxo implícito do OAuth 2.0 típica iniciada pelo Google tem este fluxo:

  1. O Google abre seu endpoint de autorização no navegador do usuário. O usuário faz login, caso ainda não tenha feito isso, e concede ao Google permissão para acessar os dados com sua API, caso ainda não tenha concedido essa permissão.
  2. O serviço cria um token de acesso e o retorna ao Google redirecionando o navegador do usuário de volta para o Google com o token de acesso anexado à solicitação.
  3. O Google chama as APIs do seu serviço e anexa o token de acesso a cada solicitação. Seu serviço verifica se o token de acesso concede ao Google autorização para acessar a API e, em seguida, conclui a chamada de API.

Processar solicitações de autorização

Quando sua Ação precisa realizar a vinculação de contas por um fluxo implícito do OAuth 2.0, o Google envia o usuário para o endpoint de autorização com uma solicitação que inclui os seguintes parâmetros:

Parâmetros do endpoint de autorização
client_id O ID do cliente que você atribuiu ao Google.
redirect_uri O URL para onde você envia a resposta para a solicitação.
state Um valor de registro que é retornado ao Google inalterado no URI de redirecionamento.
response_type O tipo de valor a ser retornado na resposta. Para o fluxo implícito do OAuth 2.0, o tipo de resposta é sempre token.

Por exemplo, se o endpoint de autorização estiver disponível em https://myservice.example.com/auth, uma solicitação poderá ter esta aparência:

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

Para que o endpoint de autorização processe solicitações de login, siga estas etapas:

  1. Verifique os valores client_id e redirect_uri para evitar a concessão de acesso a apps cliente não intencionais ou configurados incorretamente:

    • Confirme se o client_id corresponde ao ID do cliente atribuído ao Google.
    • Confirme se o URL especificado pelo parâmetro redirect_uri tem o seguinte formato: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID é o ID encontrado na página Configurações do projeto do Console do Actions.

  2. Verifique se o usuário está conectado ao serviço. Se o usuário não tiver feito login, conclua o fluxo de inscrição ou login do seu serviço.

  3. Gere um token de acesso que o Google usará para acessar sua API. O token de acesso pode ser qualquer valor de string, mas precisa representar exclusivamente o usuário e o cliente ao qual o token se destina e não pode ser adivinhado.

  4. Envie uma resposta HTTP que redirecione o navegador do usuário para o URL especificado pelo parâmetro redirect_uri. Inclua todos os parâmetros a seguir no fragmento de URL:

    • access_token: o token de acesso que você acabou de gerar.
    • token_type: a string bearer.
    • state: o valor de estado não modificado da solicitação original. Veja a seguir um exemplo do URL resultante: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

O gerenciador de redirecionamento do OAuth 2.0 do Google receberá o token de acesso e confirmará se o valor state não foi alterado. Depois que o Google receber um token de acesso para o serviço, ele o anexará às chamadas subsequentes para sua ação como parte do AppRequest.

处理自动关联

用户同意您的 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 包含用户的 Google 帐号 ID、名称和电子邮件地址等信息。
consent_code 可选：如果存在，这是一个一次性代码，用于表明用户已同意您的 Action 访问指定范围。
scope 可选：您已配置 Google 向用户请求的任何范围。

当您的令牌交换端点收到关联请求时，应执行以下操作：

Validar e decodificar a declaração do JWT

É possível validar e decodificar a declaração do JWT usando uma biblioteca de decodificação de JWT para sua linguagem. Use as chaves públicas do Google (disponíveis no formato JWK ou PEM) para verificar a assinatura do token.

Quando decodificada, a declaração do JWT é semelhante ao seguinte exemplo: 

{
  "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"
}

Além de verificar a assinatura do token, confira se o emissor da declaração (campo iss) é https://accounts.google.com e se o público (campo aud) é o ID do cliente atribuído à sua ação.

检查您的身份验证系统中是否已经存在相关 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 错误响应时，Google 会调用您的令牌交换端点，将 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 网络令牌 (JWT)，该令牌提供了 Google 用户身份的已签名断言。JWT 包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息，您可以使用这些信息在您的服务上创建新帐号。

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

Validar e decodificar a declaração do JWT

É possível validar e decodificar a declaração do JWT usando uma biblioteca de decodificação de JWT para sua linguagem. Use as chaves públicas do Google (disponíveis no formato JWK ou PEM) para verificar a assinatura do token.

Quando decodificada, a declaração do JWT é semelhante ao seguinte exemplo: 

{
  "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"
}

Além de verificar a assinatura do token, confira se o emissor da declaração (campo iss) é https://accounts.google.com e se o público (campo aud) é o ID do cliente atribuído à sua ação.

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

检查是否满足以下任一条件：

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

如果满足上述任一条件，请提示用户通过 HTTP 401 错误响应请求，将 error=linking_error 和用户的电子邮件地址指定为 login_hint，从而将其现有帐号与其 Google 帐号相关联，如以下示例所示：

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

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

如果两个条件都不满足，则使用 JWT 中提供的信息创建新的用户帐号。新帐号通常不会设置密码。建议您将 Google 登录功能添加到其他平台，让用户能够在应用的各种途径中通过 Google 登录。或者，您也可以通过电子邮件向用户发送用于启动密码恢复流程的链接，以便用户设置用于在其他平台上登录的密码。

创建完成后，发出访问令牌 ，然后返回 HTTPS 响应正文中 JSON 对象中的值，如以下示例所示： 

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

Projetar a interface do usuário de voz para o fluxo de autenticação

Conferir se o usuário foi verificado e iniciar o fluxo de vinculação da conta

  1. Abra seu projeto do Actions Builder no Actions Console.
  2. Crie um novo cenário para começar a vinculação da conta na sua Ação:
    1. Clique em Cenas.
    2. Clique no ícone add (+) para adicionar uma nova cena.
  3. No cenário recém-criado, clique no ícone de adição para Condições.
  4. Adicione uma condição que verifica se o usuário associado à conversa é um usuário verificado. Se a verificação falhar, a Ação não poderá fazer a vinculação da conta durante a conversa e vai voltar a fornecer acesso a recursos que não exijam a vinculação de conta.
    1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus != "VERIFIED"
    2. Em Transição, selecione uma cena que não exija vinculação de conta ou uma cena que seja o ponto de entrada para a funcionalidade exclusiva para convidados.

  1. Clique no ícone de adição para Condições.
  2. Adicione uma condição para acionar um fluxo de vinculação de conta se o usuário não tiver uma identidade associada.
    1. No campo Enter new expression em Condição, insira a seguinte lógica: user.verificationStatus == "VERIFIED"
    2. Em Transição, selecione a cena do sistema Vinculação de contas.
    3. Clique em Salvar.

Depois de salvar, uma nova cena do sistema de vinculação de contas chamada <SceneName>_AccountLinking será adicionada ao projeto.

Personalizar o cenário de vinculação da conta

  1. Em Scenes, selecione a cena do sistema de vinculação de contas.
  2. Clique em Enviar solicitação e adicione uma frase curta para descrever ao usuário por que a ação precisa acessar a identidade dele (por exemplo, "Para salvar suas preferências").
  3. Clique em Salvar.

  1. Em Condições, clique em Se o usuário concluir a vinculação da conta.
  2. Configure como o fluxo deve proceder se o usuário concordar em vincular a conta. Por exemplo, chame o webhook para processar qualquer lógica de negócios personalizada necessária e fazer a transição de volta para a cena de origem.
  3. Clique em Salvar.

  1. Em Condições, clique em Se o usuário cancelar ou dispensar a vinculação da conta.
  2. Configure como o fluxo deve proceder se o usuário não concordar em vincular a conta. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
  3. Clique em Salvar.

  1. Em Condições, clique em Se ocorrer um erro de sistema ou rede.
  2. Configure como o fluxo vai proceder se não for possível concluir o fluxo de vinculação da conta devido a erros no sistema ou na rede. Por exemplo, envie uma mensagem de confirmação e redirecione para cenas que fornecem funcionalidades que não exigem vinculação de conta.
  3. Clique em Salvar.

Processar solicitações de acesso a dados

Se a solicitação do Google Assistente contiver um token de acesso, verifique primeiro se o token de acesso é válido e não expirou. Em seguida, recupere a conta do usuário associada ao token no banco de dados da conta de usuário.