Vinculação simplificada com o OAuth e o Login do Google

Visão geral

A vinculação simplificada do Login do Google baseado em OAuth adiciona o Login do Google aos Vinculação do OAuth. Isso proporciona uma experiência de vinculação perfeita para usuários do Google e também permite a criação de contas, o que permite que o usuário crie uma nova conta no seu serviço usando a própria Conta do Google.

Para vincular a conta com o OAuth e o Login do Google, siga estas instruções etapas:

1. Primeiro, peça ao usuário que dê consentimento para acessar o perfil do Google dele.
2. Use as informações no perfil para verificar se a conta de usuário existe.
3. Vincule as contas dos usuários atuais.
4. Se você não encontrar uma correspondência para o usuário do Google no seu sistema de autenticação, validar o token de ID recebido do Google. Em seguida, é possível criar um nas informações de perfil contidas no token de ID.

Figura 1. Vinculação de contas no smartphone do usuário com a vinculação simplificada

Requisitos para a vinculação simplificada

• Implemente o fluxo de vinculação OAuth da Web básica. Seu serviço precisa ser compatível com OAuth 2.0 autorização e troca de token.
• O endpoint de troca de token precisa oferecer suporte a declarações JSON Web Token (JWT) e implementar as intents check, create e get.

• Registre seu ID do cliente da API do Google.

Implementar seu servidor OAuth

Seu endpoint de troca de token precisa oferecer suporte às intents check, create e get. Confira abaixo as etapas concluídas no fluxo de vinculação de contas e indique quando as diferentes intents são chamadas:

1. O usuário tem uma conta no seu sistema de autenticação? (O usuário decide selecionando SIM ou NÃO)
   1. SIM : o usuário utiliza o e-mail associado à Conta do Google para fazer login na sua plataforma? (O usuário decide selecionando SIM ou NÃO)
      1. SIM : o usuário tem uma conta correspondente no sistema de autenticação? (check intent é chamado para confirmar)
         1. SIM : get intent será chamado, e a conta será vinculada se a intent recebida retornar.
         2. NÃO : criar uma nova conta? (O usuário decide selecionando SIM ou NÃO)
            1. SIM : create intent será chamado, e a conta será vinculada se a intent criar retornar.
            2. NÃO : o fluxo de OAuth da Web é acionado, o usuário é direcionado para o navegador e tem a opção de vincular com um e-mail diferente.
      2. NÃO : o fluxo OAuth da Web é acionado, o usuário é direcionado para o navegador e tem a opção de vincular com um e-mail diferente.
   2. NÃO : o usuário tem uma conta correspondente no seu sistema de autenticação? (check intent é chamado para confirmar)
      1. SIM : get intent será chamado, e a conta será vinculada se a intent recebida retornar.
      2. NÃO : create intent é chamado, e a conta é vinculada se a intent de criação retornar.

Check for an existing user account (check intent)

After the user gives consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint responds with account_found=true. If the Google account doesn't match an existing user, your token exchange endpoint returns an HTTP 404 Not Found error with account_found=false.

The request has the following form:

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=check&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Your token exchange endpoint must be able to handle the following parameters:

To respond to the check intent requests, your token exchange endpoint must perform the following steps:

• Validate and decode the JWT assertion.
• Check if the Google account is already present in your authentication system.

Valide e decodifique a declaração do JWT

É possível validar e decodificar a declaração do JWT usando um Biblioteca de decodificação JWT para sua linguagem. Usar as chaves públicas do Google, disponíveis em JWK ou PEM, para verificar a assinatura do token.

Quando decodificada, a declaração JWT se parece com o 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
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

Além de verificar a assinatura do token, verifique se a propriedade emissor (campo iss) é https://accounts.google.com, que o público-alvo (campo aud) é seu ID de cliente atribuído e que o token não expirou (campo exp).

Use os campos email, email_verified e hd para determinar se O Google hospeda e é autoritativo para um endereço de e-mail. Nos casos em que o Google autoritativo, o usuário é atualmente conhecido como o proprietário legítimo da conta e você pode pular a senha ou outros métodos de desafio. Caso contrário, estes métodos pode ser usada para verificar a conta antes da vinculação.

Casos em que o Google é confiável:

• email tem o sufixo @gmail.com. Esta é uma conta do Gmail.
• A opção email_verified é verdadeira e hd foi definida. Esta é uma conta do G Suite.

Os usuários podem se registrar para Contas do Google sem usar o Gmail ou o G Suite. Quando email não contém um sufixo @gmail.com e hd está ausente, o Google não está com autoridade e senha ou outros métodos de desafio o usuário. email_verified também pode ser verdadeiro porque o Google verificou inicialmente o usuário quando a Conta do Google foi criada, mas a propriedade do terceiro pode ter mudado desde então.

Check if the Google account is already present in your authentication system

Check whether either of the following conditions are true:

• The Google Account ID, found in the assertion's sub field, is in your user database.
• The email address in the assertion matches a user in your user database.

If either condition is true, the user has already signed up. In that case, return a response like the following:

HTTP/1.1 200 Success
Content-Type: application/json;charset=UTF-8

{
  "account_found":"true",
}

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint needs to reply with a HTTP 404 error that specifies "account_found": "false", as in the following example:

HTTP/1.1 404 Not found
Content-Type: application/json;charset=UTF-8

{
  "account_found":"false",
}

Processar a vinculação automática (get intent)

Depois que o usuário autoriza o acesso ao perfil do Google, o Google envia uma solicitação que contém uma declaração assinada sobre a identidade do usuário do Google. A contém informações que incluem o ID da Conta do Google do usuário, nome e endereço de e-mail. O endpoint de troca de token configurado para sua projeto lida com essa solicitação.

Se a Conta do Google correspondente já estiver na sua autenticação seu endpoint de troca de token retornará um token para o usuário. Se o A Conta do Google não corresponde a um usuário atual, seu endpoint de troca de token retorna um erro linking_error e um login_hint opcional.

A solicitação tem o seguinte formato:

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&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Seu endpoint de troca de token precisa ser capaz de lidar com os seguintes parâmetros:

Para responder às solicitações da intent get, o endpoint de troca de token precisa executar as seguintes etapas:

• Valide e decodifique a declaração do JWT.
• Verifique se a Conta do Google já está no seu sistema de autenticação.

Valide e decodifique a declaração do JWT

É possível validar e decodificar a declaração do JWT usando um Biblioteca de decodificação JWT para sua linguagem. Usar as chaves públicas do Google, disponíveis em JWK ou PEM, para verificar a assinatura do token.

Quando decodificada, a declaração JWT se parece com o 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
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

Além de verificar a assinatura do token, verifique se a propriedade emissor (campo iss) é https://accounts.google.com, que o público-alvo (campo aud) é seu ID de cliente atribuído e que o token não expirou (campo exp).

Use os campos email, email_verified e hd para determinar se O Google hospeda e é autoritativo para um endereço de e-mail. Nos casos em que o Google autoritativo, o usuário é atualmente conhecido como o proprietário legítimo da conta e você pode pular a senha ou outros métodos de desafio. Caso contrário, estes métodos pode ser usada para verificar a conta antes da vinculação.

Casos em que o Google é confiável:

• email tem o sufixo @gmail.com. Esta é uma conta do Gmail.
• A opção email_verified é verdadeira e hd foi definida. Esta é uma conta do G Suite.

Os usuários podem se registrar para Contas do Google sem usar o Gmail ou o G Suite. Quando email não contém um sufixo @gmail.com e hd está ausente, o Google não está com autoridade e senha ou outros métodos de desafio o usuário. email_verified também pode ser verdadeiro porque o Google verificou inicialmente o usuário quando a Conta do Google foi criada, mas a propriedade do terceiro pode ter mudado desde então.

Verificar se a Conta do Google já está no sistema de autenticação

Verifique se uma das condições a seguir é verdadeira:

• O ID da Conta do Google, encontrado no campo sub da declaração, está no seu nome de usuário no seu banco de dados.
• O endereço de e-mail na declaração corresponde a um usuário no seu banco de dados de usuários.

Se uma conta for encontrada para o usuário, emita um token de acesso e retorne os valores em um objeto JSON no corpo da resposta HTTPS, como no exemplo a seguir:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "refresh_token": "REFRESH_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

Em alguns casos, a vinculação de contas com base no token de ID pode falhar para o usuário. Se fizer isso por qualquer motivo, seu endpoint de troca de token precisará responder com uma solicitação HTTP Erro 401 que especifica error=linking_error, como mostra o exemplo a seguir:

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

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

Quando o Google recebe uma resposta de erro 401 com linking_error, ele envia o usuário ao endpoint de autorização com login_hint como parâmetro. A o usuário conclui a vinculação da conta usando o fluxo de vinculação OAuth no navegador.

Handle account creation via Google Sign-In (create intent)

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create.

The request has the following form:

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&assertion=JWT&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Your token exchange endpoint must able to handle the following parameters:

The JWT within the assertion parameter contains the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to the create intent requests, your token exchange endpoint must perform the following steps:

• Validate and decode the JWT assertion.
• Validate user information and create new account.

Valide e decodifique a declaração do JWT

É possível validar e decodificar a declaração do JWT usando um Biblioteca de decodificação JWT para sua linguagem. Usar as chaves públicas do Google, disponíveis em JWK ou PEM, para verificar a assinatura do token.

Quando decodificada, a declaração JWT se parece com o 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
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

Além de verificar a assinatura do token, verifique se a propriedade emissor (campo iss) é https://accounts.google.com, que o público-alvo (campo aud) é seu ID de cliente atribuído e que o token não expirou (campo exp).

Use os campos email, email_verified e hd para determinar se O Google hospeda e é autoritativo para um endereço de e-mail. Nos casos em que o Google autoritativo, o usuário é atualmente conhecido como o proprietário legítimo da conta e você pode pular a senha ou outros métodos de desafio. Caso contrário, estes métodos pode ser usada para verificar a conta antes da vinculação.

Casos em que o Google é confiável:

• email tem o sufixo @gmail.com. Esta é uma conta do Gmail.
• A opção email_verified é verdadeira e hd foi definida. Esta é uma conta do G Suite.

Os usuários podem se registrar para Contas do Google sem usar o Gmail ou o G Suite. Quando email não contém um sufixo @gmail.com e hd está ausente, o Google não está com autoridade e senha ou outros métodos de desafio o usuário. email_verified também pode ser verdadeiro porque o Google verificou inicialmente o usuário quando a Conta do Google foi criada, mas a propriedade do terceiro pode ter mudado desde então.

Validate user information and create new account

Check whether either of the following conditions are true:

• The Google Account ID, found in the assertion's sub field, is in your user database.
• The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account. To do so, respond to the request with an HTTP 401 error that specifies error=linking_error and gives the user's email address as the login_hint. The following is a sample response:

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

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

When Google receives a 401 error response with linking_error, Google sends the user to your authorization endpoint with login_hint as a parameter. The user completes account linking using the OAuth linking flow in their browser.

If neither condition is true, create a new user account with the information provided in the JWT. New accounts don't typically have a password set. It's recommended that you add Google Sign-In to other platforms to enable users to log in with Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password to sign in on other platforms.

When the creation is completed, issue an access token and refresh token and return the values in a JSON object in the body of your HTTPS response, like in the following example:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "refresh_token": "REFRESH_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

Receber seu ID do cliente da API do Google

Será necessário fornecer o ID do cliente da API do Google durante o processo de registro da vinculação de contas.

Para conseguir o ID do cliente da API usando o projeto que você criou durante as etapas de vinculação OAuth. Para isso, siga estas etapas:

1. Abra a página Credenciais do Console de APIs do Google.

2. Crie ou selecione um projeto de APIs do Google.

   Se o projeto não tiver um ID do cliente para o tipo de aplicativo da Web, clique em Criar credenciais > ID do cliente OAuth para criar um. Certifique-se de incluir o domínio do site na caixa Origens JavaScript autorizadas. Quando você realiza testes ou desenvolvimentos locais, é preciso adicionar http://localhost e http://localhost:<port_number> no campo Origens JavaScript autorizadas.

Como validar a implementação

É possível validar sua implementação usando a ferramenta OAuth 2.0 Playground.

Na ferramenta, siga estas etapas:

1. Clique em Configuração settings para abrir a janela de configuração do OAuth 2.0.
2. No campo Fluxo do OAuth, selecione Lado do cliente.
3. No campo Endpoints OAuth, selecione Personalizado.
4. Especifique o endpoint OAuth 2.0 e o ID do cliente atribuído ao Google nos campos correspondentes.
5. Na seção Etapa 1, não selecione nenhum escopo do Google. Em vez disso, deixe esse campo em branco ou digite um escopo válido para seu servidor (ou uma string arbitrária se você não usar escopos do OAuth). Quando terminar, clique em Autorizar APIs.
6. Nas seções Etapa 2 e Etapa 3, siga o fluxo OAuth 2.0 e verifique se cada etapa funciona conforme o esperado.

É possível validar sua implementação usando a ferramenta Demo de vinculação de Contas do Google.

Na ferramenta, siga estas etapas:

1. Clique no botão Fazer login com o Google.
2. Escolha a conta que você quer vincular.
3. Insira o ID do serviço.
4. Opcionalmente, insira um ou mais escopos para os quais você vai solicitar acesso.
5. Clique em Iniciar demonstração.
6. Quando solicitado, confirme que você pode consentir e negar o pedido de vinculação.
7. Confirme se você foi redirecionado para a plataforma.