Verifica el token de ID de Google en el servidor

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

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 cookie de doble envío para evitar ataques 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 firma correctamente el token de ID. Usa las claves públicas de Google (disponibles en formato JWK o PEM) para verificar la firma del token. Estas claves rotan con regularidad. Examina el encabezado Cache-Control en la respuesta para determinar cuándo debes recuperarlas de nuevo.
    • 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 para 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ó el tiempo de vencimiento (exp) del token de ID.
    • Si necesitas validar que el token de ID representa una cuenta de organización de Google Workspace o Cloud Identity, puedes verificar el reclamo 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 por Google.

    Con los campos email, email_verified y hd, puedes determinar si Google aloja una dirección de correo electrónico y es autoritativo para ella. En los casos en que Google es autoritativo, se sabe que el usuario es el propietario legítimo de la cuenta, por lo que puedes omitir la contraseña o cualquier otro método de desafío.

    Casos en los que Google es una fuente acreditada:

    • Si email tiene el sufijo @gmail.com, se trata de una cuenta de Gmail.
    • email_verified es verdadero y hd está configurado, se trata de una cuenta de Google Workspace.

    Los usuarios pueden registrarse para obtener Cuentas de Google sin usar Gmail ni Google Workspace. Cuando email no contiene un sufijo @gmail.com y hd está ausente, Google no es autoritativo y se recomiendan métodos de contraseña o de otro tipo para verificar al usuario. email_verified también puede ser verdadero, ya que Google verificó inicialmente al usuario cuando se creó la Cuenta de Google. Sin embargo, es posible que la propiedad de la cuenta de correo electrónico de terceros haya cambiado desde entonces.

    En lugar de escribir tu propio código para realizar estos pasos de verificación, te recomendamos que uses una biblioteca cliente de las APIs 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

    Usar una de las bibliotecas cliente de las APIs de Google (p.ej., Java Node.js, PHP 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 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 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.");
    }

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

    Si necesitas validar que el token de ID represente un espacio de nombres de Google Workspace o Cloud cuenta de organización, puedes verificar la reclamación de hd si revisas el nombre de dominio que muestra el método Payload.getHostedDomain() El dominio de la La reclamación email no es suficiente para garantizar que la cuenta esté administrada por un dominio. u organización.

    Node.js

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

    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: 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);

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

    Si necesitas validar que el token de ID represente un espacio de nombres de Google Workspace o Cloud de tu organización, puedes verificar la reclamación de hd, que indica el estado dominio 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' => $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
    }

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

    Si necesitas validar que el token de ID represente un espacio de nombres de Google Workspace o Cloud de tu organización, puedes verificar la reclamación de hd, que indica el estado dominio 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 el 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 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

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

  3. Una vez que se confirme la validez del token, puedes 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 permita al usuario proporcionar información de perfil adicional, si es necesario. También le permite al usuario crear la cuenta nueva y una sesión de usuario que accedió de forma silenciosa.

    • Una cuenta existente en tu sitio: Puedes mostrar una página web que le 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 que regresa: Puedes permitir que el usuario acceda de forma silenciosa.