Verificar o token de ID do Google no lado do servidor

Depois que o Google retorna um token de ID, ele é enviado por uma solicitação de método HTTP POST, com o nome do parâmetro credential, para seu endpoint de login.

Confira abaixo um exemplo na linguagem Python que mostra as etapas usuais para validar e consumir o token de ID:

  1. Verifique o token de falsificação de solicitações entre sites (CSRF). Quando você envia as credenciais para o endpoint de login, usamos o padrão de envio duplo de cookies para evitar ataques CSRF. Antes de cada envio, geramos um token. Em seguida, o token é colocado no cookie e no corpo da postagem, conforme mostrado no exemplo de código abaixo:

    csrf_token_cookie = self.request.cookies.get('g_csrf_token')
    if not csrf_token_cookie:
        webapp2.abort(400, 'No CSRF token in Cookie.')
    csrf_token_body = self.request.get('g_csrf_token')
    if not csrf_token_body:
        webapp2.abort(400, 'No CSRF token in post body.')
    if csrf_token_cookie != csrf_token_body:
        webapp2.abort(400, 'Failed to verify double submit cookie.')
    
  2. Verifique o token de ID.

    Para verificar se o token é válido, confira se os seguintes critérios são atendidos:

    • O token de ID é assinado corretamente pelo Google. Use as chaves públicas do Google (disponíveis nos formatos JWK ou PEM) para verificar a assinatura do token. Essas chaves são trocadas regularmente. Examine o cabeçalho Cache-Control na resposta para determinar quando você deve recuperá-las novamente.
    • O valor de aud no token de ID é igual a um dos IDs de cliente do seu app. Essa verificação é necessária para evitar que tokens de ID emitidos para um app malicioso sejam usados para acessar dados sobre o mesmo usuário no servidor de back-end do seu app.
    • O valor de iss no token de ID é igual a accounts.google.com ou https://accounts.google.com.
    • O prazo de validade (exp) do token de ID ainda não expirou.
    • Se você precisar validar se o token de ID representa uma conta de organização do Google Workspace ou do Cloud, verifique a declaração hd, que indica o domínio hospedado do usuário. Isso precisa ser usado ao restringir o acesso a um recurso apenas a membros de determinados domínios. A ausência dessa declaração indica que a conta não pertence a um domínio hospedado pelo Google.

    Usando os campos email, email_verified e hd, você pode determinar se o Google hospeda e é autoridade para um endereço de e-mail. Nos casos em que o Google é autoritário, o usuário é conhecido como o proprietário legítimo da conta, e você pode pular a senha ou outros métodos de desafio.

    Casos em que o Google é autoridade:

    • Se o nome de usuário de email tiver o sufixo @gmail.com, ele será uma conta do Gmail.
    • email_verified é verdadeiro e hd está definido, essa é uma conta do Google Workspace.

    Os usuários podem se registrar para ter Contas do Google sem usar o Gmail ou o Google Workspace. Quando email não contém um sufixo @gmail.com e hd está ausente, o Google não é autoritário, e é recomendável usar senha ou outros métodos de desafio para verificar o usuário. email_verified também pode ser verdadeiro, já que o Google verificou inicialmente o usuário quando a Conta do Google foi criada. No entanto, a propriedade da conta de e-mail de terceiros pode ter mudado desde então.

    Em vez de escrever seu próprio código para realizar essas etapas de verificação, recomendamos usar uma biblioteca de cliente das APIs do Google para sua plataforma ou uma biblioteca JWT de uso geral. Para desenvolvimento e depuração, chame nosso endpoint de validação tokeninfo.

    Usar uma biblioteca de cliente das APIs do Google

    Usar uma das bibliotecas de cliente das APIs do Google (por exemplo, Java Node.js PHP, Python) é a forma recomendada de validar tokens de ID do Google em um ambiente de produção.

    Java

    Para validar um token de ID em Java, use o método objeto GoogleIdTokenVerifier. Exemplo:

    import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken;
    import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
    import com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier;
    
    ...
    
    GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
        // Specify the WEB_CLIENT_ID of the app that accesses the backend:
        .setAudience(Collections.singletonList(WEB_CLIENT_ID))
        // Or, if multiple clients access the backend:
        //.setAudience(Arrays.asList(WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3))
        .build();
    
    // (Receive idTokenString by HTTPS POST)
    
    GoogleIdToken idToken = verifier.verify(idTokenString);
    if (idToken != null) {
      Payload payload = idToken.getPayload();
    
      // Print user identifier
      String userId = payload.getSubject();
      System.out.println("User ID: " + userId);
    
      // Get profile information from payload
      String email = payload.getEmail();
      boolean emailVerified = Boolean.valueOf(payload.getEmailVerified());
      String name = (String) payload.get("name");
      String pictureUrl = (String) payload.get("picture");
      String locale = (String) payload.get("locale");
      String familyName = (String) payload.get("family_name");
      String givenName = (String) payload.get("given_name");
    
      // Use or store profile information
      // ...
    
    } else {
      System.out.println("Invalid ID token.");
    }

    O método GoogleIdTokenVerifier.verify() verifica o JWT assinatura, a declaração aud, a declaração iss e a Reivindicação exp.

    Se você precisar validar se o token de ID representa uma conta do Google Workspace ou conta da organização, você pode verificar a declaração hd conferindo o nome de domínio retornados pelo método Payload.getHostedDomain(). O domínio do email reivindicação é insuficiente para garantir que a conta seja gerenciada por um domínio ou organização.

    .
    Node.js

    Para validar um token de ID no Node.js, use a Biblioteca do Google Auth para Node.js. Instale a biblioteca:

    npm install google-auth-library --save
    Em seguida, chame a função verifyIdToken(). Exemplo:

    const {OAuth2Client} = require('google-auth-library');
    const client = new OAuth2Client();
    async function verify() {
      const ticket = await client.verifyIdToken({
          idToken: token,
          audience: WEB_CLIENT_ID,  // Specify the WEB_CLIENT_ID of the app that accesses the backend
          // Or, if multiple clients access the backend:
          //[WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]
      });
      const payload = ticket.getPayload();
      const userid = payload['sub'];
      // If the request specified a Google Workspace domain:
      // const domain = payload['hd'];
    }
    verify().catch(console.error);

    A função verifyIdToken verifica a assinatura JWT, a declaração aud, a declaração exp e a declaração iss.

    Se você precisar validar se o token de ID representa uma conta do Google Workspace ou da organização, verifique a declaração hd, que indica o servidor domínio do usuário. Precisa ser usado ao restringir o acesso a um recurso apenas para membros de determinados domínios. A ausência dessa reivindicação indica que a conta não pertence a um domínio hospedado pelo Google.

    .
    PHP

    Para validar um token de ID em PHP, use a biblioteca de cliente de APIs do Google para PHP. Instale a biblioteca (por exemplo, usando o Composer):

    composer require google/apiclient
    Em seguida, chame a função verifyIdToken(). Exemplo:

    require_once 'vendor/autoload.php';
    
    // Get $id_token via HTTPS POST.
    
    $client = new Google_Client(['client_id' => $WEB_CLIENT_ID]);  // Specify the WEB_CLIENT_ID of the app that accesses the backend
    $payload = $client->verifyIdToken($id_token);
    if ($payload) {
      $userid = $payload['sub'];
      // If the request specified a Google Workspace domain
      //$domain = $payload['hd'];
    } else {
      // Invalid ID token
    }

    A função verifyIdToken verifica a assinatura JWT, a declaração aud, a declaração exp e a declaração iss.

    Se você precisar validar se o token de ID representa uma conta do Google Workspace ou da organização, verifique a declaração hd, que indica o servidor domínio do usuário. Precisa ser usado ao restringir o acesso a um recurso apenas para membros de determinados domínios. A ausência dessa reivindicação indica que a conta não pertence a um domínio hospedado pelo Google.

    .
    Python

    Para validar um token de ID em Python, use o verify_oauth2_token função. Exemplo:

    from google.oauth2 import id_token
    from google.auth.transport import requests
    
    # (Receive token by HTTPS POST)
    # ...
    
    try:
        # Specify the WEB_CLIENT_ID of the app that accesses the backend:
        idinfo = id_token.verify_oauth2_token(token, requests.Request(), WEB_CLIENT_ID)
    
        # Or, if multiple clients access the backend server:
        # idinfo = id_token.verify_oauth2_token(token, requests.Request())
        # if idinfo['aud'] not in [WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]:
        #     raise ValueError('Could not verify audience.')
    
        # If the request specified a Google Workspace domain
        # if idinfo['hd'] != DOMAIN_NAME:
        #     raise ValueError('Wrong domain name.')
    
        # ID token is valid. Get the user's Google Account ID from the decoded token.
        userid = idinfo['sub']
    except ValueError:
        # Invalid token
        pass

    A função verify_oauth2_token verifica o JWT assinatura, a declaração aud e a declaração exp. Você também precisa verificar a hd (se aplicável) examinando o objeto que verify_oauth2_token retorna. Se vários clientes acessarem o servidor de back-end, verifique manualmente a declaração aud.

  3. Depois que a validade do token for confirmada, você poderá usar as informações no token de ID do Google para correlacionar o status da conta do seu site:

    • Um usuário não registrado:é possível mostrar uma interface do usuário (IU) de inscrição que permita que o usuário forneça outras informações de perfil, se necessário. Ele também permite que o usuário crie a nova conta e uma sessão de usuário conectado.

    • Uma conta que já existe no seu site:é possível mostrar uma página da Web que permite que o usuário final insira a senha e vincule a conta legada às credenciais do Google. Isso confirma que o usuário tem acesso à conta.

    • Um usuário federado que retorna:é possível fazer o login do usuário em segundo plano.