Vinculação de contas com o OAuth e o Login do Google (Dialogflow)

O tipo de vinculação do OAuth e do Login do Google adiciona o Login do Google sobre o OAuth a vinculação de contas. Isso fornece um link baseado em voz simples para os usuários do Google e, ao mesmo tempo, ativar a vinculação de contas para os usuários que se registraram no serviço. com uma identidade que não seja do Google.

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

Figura 1: depois que sua ação obtém acesso ao Google perfil, você pode usá-lo para encontrar uma correspondência para o usuário em seu sistema de autenticação.

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 do perfil para identificar o usuário.
3. Se você não encontrar uma correspondência para o usuário do Google no seu sistema de autenticação, o fluxo continuará dependendo se você configurou seu projeto do Actions no Console do Actions para permitir a criação de contas de usuário por voz ou somente por comandos seu site.
   • Se você permitir a criação de contas por voz, valide o documento de identificação. token recebido do Google. Você pode criar um usuário com base no 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 no qual eles podem carregar a página de autorização e completar o processo fluxo de criação.

Figura 2. Uma representação visual das instâncias Fluxo de login quando as informações de um usuário não são encontradas no sistema.

Oferecer suporte à criação de contas por voz

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

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

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

Não permitir a criação de contas usando a voz

Se você não permitir a criação de contas de usuário por voz, o Google Assistente abrirá o URL para site que você forneceu para autenticação do usuário. Se a interação estiver acontecendo em um dispositivo sem tela, o Google Assistente direciona o usuário para 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 não tenham contas do Google criem um novo conta de usuário e quiser que eles o vinculem às contas de usuário existentes na sua do Google Cloud. Por exemplo, se você oferecer um programa de fidelidade, é importante garantir que o usuário não perca os pontos acumulados uma conta existente.

• Você precisa ter controle total do fluxo de criação de contas. Por exemplo, é possível proibir a criação se você precisar mostrar seus Termos de Serviço para o usuário durante criação de conta.

.

Observação: selecione uma das opções de fluxo abaixo para saber mais sobre como implementar os fluxo selecionado. Se necessário, o conteúdo do guia será recarregado para se adaptar da sua escolha.

Permitir a criação de contas por voz Não permitir a criação de contas usando a voz

Implementar a vinculação de contas do OAuth e do Login do Google

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

Observação :se você estiver implementando a vinculação de contas para gerenciar informações financeiras, outras políticas podem ser aplicadas à sua Ação. Isso pode levar até seis semanas para analisar uma ação com vinculação de contas para conseguir informações financeiras. considere esse tempo ao planejar sua programação de lançamentos. Para facilitar a revisão siga as políticas de serviços financeiros. antes de enviar sua Ação para revisão.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• The token exchange endpoint, which is responsible for two types of exchanges:
  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Configurar o projeto

Para configurar o projeto para usar o OAuth e a conta do Login do Google , 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 & 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 vindas do Google.
   • Insira os URLs dos endpoints de autorização e de troca de token.

7. Clique em Salvar.

Implementar seu servidor OAuth

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth2 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

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

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

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

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

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

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Handle automatic linking

After the user gives your Action 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 returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

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=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

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

Token endpoint parameters
grant_type	The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	For these requests, the value of this parameter is `get`.
assertion	A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address.
consent_code	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should do the following:

Valide e decodifique a declaração do JWT

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

Observação: as chaves não podem ser fixadas no código. Siga as instruções da Descoberta de conexão do OpenID protocolo e verifique o cabeçalho cache-control para decidir por quanto tempo a chave deve ser armazenada em cache.

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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

Além de verificar a assinatura do token, verifique se o emissor da declaração (campo iss) é https://accounts.google.com e que o público-alvo (campo aud) é o ID do cliente atribuído à sua açã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 and you can issue an access token.

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 should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

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

{
  "error":"user_not_found",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

Handle account creation via Google Sign-In

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create, as in the following example:

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]

The assertion parameter contains A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes 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 account creation requests, your token exchange endpoint must do the following:

Valide e decodifique a declaração do JWT

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

Observação: as chaves não podem ser fixadas no código. Siga as instruções da Descoberta de conexão do OpenID protocolo e verifique o cabeçalho cache-control para decidir por quanto tempo a chave deve ser armazenada em cache.

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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

Além de verificar a assinatura do token, verifique se o emissor da declaração (campo iss) é https://accounts.google.com e que o público-alvo (campo aud) é o ID do cliente atribuído à sua açã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 by responding to the request with an HTTP 401 error, specifying error=linking_error and the user's email address as the login_hint, as in the following example:

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

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via 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 for signing in on other platforms.

When the creation is completed, issue an access 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",
  
  "expires_in": SECONDS_TO_EXPIRATION
}

Iniciar o fluxo de autenticação

Aviso:não forneça aos usuários uma conta obrigatória de vinculação no início da conversa com sua ação. Em vez disso, dê aos usuários não autenticados um fluxo de convidado para mostrar como sua Ação funciona e só peça a vinculação da conta se for necessário continuar. Se os usuários deixar a ação consistentemente devido a problemas de vinculação de contas, o Google não promover ativamente a Ação, o que pode diminuir o tráfego de usuários dela.

Apenas usuários verificados podem fazer a vinculação de contas. Se o usuário for um convidado, a vinculação da conta vai falhar. Saiba como identificar e processar usuários convidados.

usar a intent do Assistente de login da conta; para iniciar o fluxo de autenticação.

Dialogflow (Node.js)

const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
})

// Intent that starts the account linking flow.
app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

Dialogflow (Java)

private String clientId = "<your_client_id>";

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

SDK do Actions (Node.js)

const app = actionssdk({
  clientId: CLIENT_ID,
})

app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

SDK do Actions (Java)

private String clientId = "<your_client_id>";

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

Processar solicitações de acesso a dados

Se a solicitação do Assistente tiver um token de acesso, faça o seguinte: verifique primeiro se o token de acesso é válido e não expirou e, em seguida, recupere-o do a conta de usuário associada ao token.