Verifica el token de ID de Google en tu servidor

Después de que Google muestra un token de ID, se envía mediante una solicitud del método HTTP POST, con el nombre del parámetro credential, a tu extremo de acceso.

El siguiente es un ejemplo en el lenguaje Python que muestra los pasos habituales para validar y consumir el token de ID:

  1. Verifica el token de falsificación de solicitudes entre sitios (CSRF). Cuando envías credenciales a tu extremo de acceso, usamos el patrón de doble envío de cookies para evitar ataques de CSRF. Antes de cada envío, generamos un token. Luego, el token se coloca en la cookie y en el cuerpo de la publicación, como se muestra en el siguiente ejemplo de código:

    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. Verifica el token de ID.

    Para verificar que el token sea válido, asegúrate de que se cumplan los siguientes criterios:

    • Google tiene la firma correcta del token de ID. Usa las claves públicas de Google (disponibles en formato JWK o PEM) para verificar la firma del token. Estas claves se rotan con regularidad. Examina el encabezado Cache-Control en la respuesta para determinar cuándo debes volver a recuperarlas.
    • El valor de aud en el token de ID es igual a uno de los IDs de cliente de tu app. Esta verificación es necesaria para evitar que los tokens de ID emitidos a una app maliciosa se usen para acceder a datos sobre el mismo usuario en el servidor de backend de tu app.
    • El valor de iss en el token de ID es igual a accounts.google.com o https://accounts.google.com.
    • No pasó la hora de vencimiento (exp) del token de ID.
    • Si necesitas validar que el token de ID represente una cuenta de organización de Google Workspace o Cloud, puedes verificar la reclamación hd, que indica el dominio alojado del usuario. Se debe usar cuando se restringe el acceso a un recurso solo a miembros de ciertos dominios. La ausencia de este reclamo indica que la cuenta no pertenece a un dominio alojado en Google.

    En lugar de escribir tu propio código para realizar estos pasos de verificación, te recomendamos que uses una biblioteca cliente de la API de Google para tu plataforma o una biblioteca JWT de uso general. Para el desarrollo y la depuración, puedes llamar a nuestro extremo de validación tokeninfo.

    Usa una biblioteca cliente de la API de Google

    El uso de una de las bibliotecas cliente de la API de Google (p.ej., Java, Node.js, PHP o Python) es la forma recomendada de validar tokens de ID de Google en un entorno de producción.

    Java

    Para validar un token de ID en Java, utiliza el objeto GoogleIdTokenVerifier. Por ejemplo:

    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 CLIENT_ID of the app that accesses the backend:
        .setAudience(Collections.singletonList(CLIENT_ID))
        // Or, if multiple clients access the backend:
        //.setAudience(Arrays.asList(CLIENT_ID_1, CLIENT_ID_2, 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.");
    }

    El método GoogleIdTokenVerifier.verify() verifica la firma de JWT, la reclamación aud, la reclamación iss y exp.

    Si necesitas validar que el token de ID representa una cuenta de organización de Google Workspace o Cloud, puedes verificar la reclamación hd. Para ello, revisa el nombre de dominio que muestra el método Payload.getHostedDomain(). El dominio de la reclamación email no es suficiente para garantizar que una organización o dominio administre la cuenta.

    Node.js

    Para validar un token de ID en Node.js, usa la biblioteca de Google Auth para Node.js. Instala la biblioteca:

    npm install google-auth-library --save
    Luego, llama a la función verifyIdToken(). Por ejemplo:

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

    La función verifyIdToken verifica la firma de JWT, la reclamación aud, la reclamación exp y iss.

    Si necesitas validar que el token de ID represente una cuenta de organización de Google Workspace o Cloud, puedes verificar la reclamación hd, que indica el dominio alojado del usuario. Se debe usar cuando se restringe el acceso a un recurso solo a los miembros de ciertos dominios. La ausencia de este reclamo indica que la cuenta no pertenece a un dominio alojado en Google.

    PHP

    Para validar un token de ID en PHP, usa la biblioteca cliente de la API de Google para PHP. Instala la biblioteca (por ejemplo, con Composer):

    composer require google/apiclient
    Luego, llama a la función verifyIdToken(). Por ejemplo:

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

    La función verifyIdToken verifica la firma de JWT, la reclamación aud, la reclamación exp y iss.

    Si necesitas validar que el token de ID represente una cuenta de organización de Google Workspace o Cloud, puedes verificar la reclamación hd, que indica el dominio alojado del usuario. Se debe usar cuando se restringe el acceso a un recurso solo a los miembros de ciertos dominios. La ausencia de este reclamo indica que la cuenta no pertenece a un dominio alojado en Google.

    Python

    Para validar un token de ID en Python, usa la función verify_oauth2_token. Por ejemplo:

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

    La función verify_oauth2_token verifica la firma de JWT y la reclamación aud y exp. También debes verificar la reclamación hd (si corresponde) examinando el objeto que muestra verify_oauth2_token. Si varios clientes acceden al servidor de backend, también verifica de forma manual la reclamación aud.

  3. Una vez que se confirme la validez del token, podrás usar la información del token de ID de Google para correlacionar el estado de la cuenta de tu sitio:

    • Un usuario no registrado: Puedes mostrar una interfaz de usuario (IU) de registro que le permite al usuario proporcionar información de perfil adicional, si es necesario. También permite que el usuario cree en silencio la cuenta nueva y una sesión de usuario iniciada.

    • Una cuenta existente que ya existe en tu sitio: Puedes mostrar una página web que permita al usuario final ingresar su contraseña y vincular la cuenta heredada con sus credenciales de Google. Esto confirma que el usuario tiene acceso a la cuenta existente.

    • Un usuario federado recurrente: Puedes hacer que el usuario acceda sin aviso.