OpenID Connect

Las API de OAuth 2.0 de Google se pueden utilizar para la autenticación y la autorización. En este documento, se describe nuestra implementación de OAuth 2.0 para la autenticación, que cumple con la especificación OpenID Connect y cuenta con la certificación de OpenID. La documentación que se encuentra en Usa OAuth 2.0 para acceder a las API de Google también se aplica a este servicio. Si deseas explorar este protocolo de forma interactiva, te recomendamos Google OAuth 2.0 Playground. Para obtener ayuda sobre Stack Overflow, etiqueta tus preguntas con 'google-oauth'.

Configura OAuth 2.0

Antes de que tu aplicación pueda usar el sistema de autenticación OAuth 2.0 de Google para el acceso de los usuarios, debes configurar un proyecto en Google API Console a fin de obtener credenciales de OAuth 2.0, establecer un URI de redireccionamiento y personalizar (opcionalmente) la información de desarrollo de la marca que tus usuarios ven en la pantalla de consentimiento del usuario. También puedes usar API Console para crear una cuenta de servicio, habilitar la facturación, configurar filtros y realizar otras tareas. Para obtener más detalles, consulta la Ayuda deGoogle API Console.

Obtén credenciales de OAuth 2.0

Necesitas credenciales de OAuth 2.0, incluidos un ID y un secreto de cliente, para autenticar a los usuarios y obtener acceso a las API de Google.

Para ver la ID del cliente y el secreto del cliente para una credencial OAuth 2.0 dada, haga clic en el siguiente texto: Seleccionar credencial . En la ventana que se abre, elija su proyecto y la credencial que desea, luego haga clic en Ver .

O vea su ID de cliente y el secreto del cliente desde la página de Credenciales en API Console :

  1. Go to the Credentials page.
  2. Haga clic en el nombre de su credencial o en el ícono de lápiz ( ). Su ID de cliente y secreto están en la parte superior de la página.

Configura un URI de redireccionamiento

El URI de redireccionamiento que estableces en el API Console determina a dónde debe enviar Google las respuestas a tus solicitudes de autenticación.

Para crear, ver o editar los URI de redireccionamiento para una credencial de OAuth 2.0 dada, haga lo siguiente:

  1. Go to the Credentials page.
  2. En la sección de ID de cliente OAuth 2.0 de la página, haga clic en una credencial.
  3. Ver o editar los URI de redireccionamiento.

Si no hay una sección de ID de cliente OAuth 2.0 en la página Credenciales, entonces su proyecto no tiene credenciales OAuth. Para crear uno, haga clic en Crear credenciales .

Cómo personalizar la pantalla de consentimiento del usuario

Para los usuarios, la experiencia de autenticación de OAuth 2.0 incluye una pantalla de consentimiento que describe la información que el usuario lanza y las condiciones que se aplican. Por ejemplo, cuando el usuario accede, se le puede pedir que otorgue a tu app acceso a su dirección de correo electrónico y a la información básica de la cuenta. Solicitas acceso a esta información mediante el parámetro scope, que tu app incluye en su solicitud de autenticación. También puedes usar los permisos para solicitar acceso a otras API de Google.

La pantalla de consentimiento del usuario también presenta información de desarrollo de la marca, como el nombre del producto, el logotipo y la URL de la página principal. Puedes controlar la información de marca en el API Console.

Para habilitar la pantalla de consentimiento de su proyecto:

  1. Abra el Consent Screen page en el Google API Console .
  2. If prompted, select a project, or create a new one.
  3. Rellene el formulario y haga clic en Guardar .

En el siguiente diálogo de consentimiento, se muestra lo que vería un usuario cuando una combinación de permisos de OAuth 2.0 y Google Drive está presente en la solicitud. (Este diálogo genérico se generó con Google OAuth 2.0 Playground, por lo que no incluye información de desarrollo de la marca que se establecería en API Console).

Captura de pantalla de la página de consentimiento

Accede al servicio

Google y terceros proporcionan bibliotecas que puedes usar para encargarte de muchos de los detalles de implementación de la autenticación de usuarios y el acceso a las API de Google. Entre los ejemplos, se incluyen Google Identity Services y las bibliotecas cliente de Google, que están disponibles para una variedad de plataformas.

Si eliges no usar una biblioteca, sigue las instrucciones que aparecen en el resto de este documento, en el que se describen los flujos de solicitudes HTTP que subyacen a las bibliotecas disponibles.

Autenticación del usuario

La autenticación del usuario implica obtener un token de ID y validarlo. Los tokens de ID son una función estandarizada de OpenID Connect diseñada para usarse en el intercambio de aserciones de identidad en Internet.

Los enfoques más utilizados para autenticar un usuario y obtener un token de ID se denominan flujo de servidor y de flujo implícito. El flujo del servidor permite que el servidor de backend de una aplicación verifique la identidad de la persona mediante un navegador o un dispositivo móvil. El flujo implícito se usa cuando una aplicación del cliente (por lo general, una app de JavaScript que se ejecuta en el navegador) necesita acceder a las API de forma directa en lugar de hacerlo a través de su servidor de backend.

En este documento, se describe cómo realizar el flujo del servidor para autenticar al usuario. El flujo implícito es mucho más complicado debido a los riesgos de seguridad relacionados con el manejo y el uso de tokens del cliente. Si necesitas implementar un flujo implícito, te recomendamos usar los servicios de identidad de Google.

Flujo del servidor

Asegúrate de configurar tu app en API Console para que pueda usar estos protocolos y autenticar a tus usuarios. Cuando un usuario intenta acceder con Google, debes hacer lo siguiente:

  1. Cree un token de estado antifalsificación
  2. Envía una solicitud de autenticación a Google
  3. Confirme el token de estado antifalsificación
  4. Intercambio code para tokens de acceso y de ID
  5. Obtén información del usuario a partir del token de ID
  6. Autentica el usuario

1. Crea un token de estado antifalsificación

Debes evitar ataques de falsificación de solicitudes para proteger la seguridad de los usuarios. El primer paso es crear un token de sesión único que conserve el estado entre tu app y el cliente. Luego, harás coincidir este token de sesión único con la respuesta de autenticación que muestra el servicio de acceso de Google OAuth para verificar que el usuario realice la solicitud y no un atacante malicioso. A menudo, estos tokens se denominan tokens de falsificación de solicitudes entre sitios (CSRF).

Una buena opción para un token de estado es una string de alrededor de 30 caracteres construida con un generador de números aleatorios de alta calidad. Otro es un hash que se genera mediante la firma de algunas de las variables de estado de la sesión con una clave que se mantiene en secreto en el backend.

En el siguiente código, se muestra cómo generar tokens de sesión únicos.

PHP

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para PHP.

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
$state = bin2hex(random_bytes(128/8));
$app['session']->set('state', $state);
// Set the client ID, token state, and application name in the HTML while
// serving it.
return $app['twig']->render('index.html', array(
    'CLIENT_ID' => CLIENT_ID,
    'STATE' => $state,
    'APPLICATION_NAME' => APPLICATION_NAME
));

Java

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para Java.

// Create a state token to prevent request forgery.
// Store it in the session for later validation.
String state = new BigInteger(130, new SecureRandom()).toString(32);
request.session().attribute("state", state);
// Read index.html into memory, and set the client ID,
// token state, and application name in the HTML before serving it.
return new Scanner(new File("index.html"), "UTF-8")
    .useDelimiter("\\A").next()
    .replaceAll("[{]{2}\\s*CLIENT_ID\\s*[}]{2}", CLIENT_ID)
    .replaceAll("[{]{2}\\s*STATE\\s*[}]{2}", state)
    .replaceAll("[{]{2}\\s*APPLICATION_NAME\\s*[}]{2}",
    APPLICATION_NAME);

Python

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para Python.

# Create a state token to prevent request forgery.
# Store it in the session for later validation.
state = hashlib.sha256(os.urandom(1024)).hexdigest()
session['state'] = state
# Set the client ID, token state, and application name in the HTML while
# serving it.
response = make_response(
    render_template('index.html',
                    CLIENT_ID=CLIENT_ID,
                    STATE=state,
                    APPLICATION_NAME=APPLICATION_NAME))

2. Envía una solicitud de autenticación a Google

El siguiente paso es formar una solicitud GET HTTPS con los parámetros de URI adecuados. Ten en cuenta el uso de HTTPS en lugar de HTTP en todos los pasos de este proceso; las conexiones HTTP se rechazan. Debes recuperar el URI base del Documento de descubrimiento con el valor de metadatos authorization_endpoint. En la siguiente discusión, se supone que el URI base es https://accounts.google.com/o/oauth2/v2/auth.

Para una solicitud básica, especifica los siguientes parámetros:

  • client_id, que obtienes del API ConsoleCredentials page.
  • response_type, que en una solicitud de flujo de código de autorización básica debe ser code. (Obtén más información en response_type).
  • scope, que en una solicitud básica debe ser openid email. (Más información en scope)
  • redirect_uri debe ser el extremo HTTP de tu servidor que recibirá la respuesta de Google. El valor debe coincidir exactamente con uno de los URI de redireccionamiento autorizados para el cliente de OAuth 2.0, que configuraste en el Credentials pagede API Console. Si este valor no coincide con un URI autorizado, la solicitud fallará y mostrará el error redirect_uri_mismatch.
  • state debe incluir el valor del token de sesión único antifalsificación y cualquier otra información necesaria para recuperar el contexto cuando el usuario vuelve a tu aplicación, p.ej., la URL de inicio. (Más información en state)
  • nonce es un valor aleatorio generado por tu app que habilita la protección contra la reproducción cuando está presente.
  • login_hint puede ser la dirección de correo electrónico del usuario o la string sub, que equivale al ID de Google del usuario. Si no proporcionas un login_hint y el usuario ya accedió, la pantalla de consentimiento incluye una solicitud de aprobación para liberar la dirección de correo electrónico del usuario en tu app (obtén más información en login_hint).
  • Usa el parámetro hd a fin de optimizar el flujo de OpenID Connect para los usuarios de un dominio específico asociado con una organización de Google Cloud. (Obtén más información en hd).

A continuación, se muestra un ejemplo de un URI de autenticación de OpenID Connect completo, con saltos de línea y espacios para facilitar la lectura:

https://accounts.google.com/o/oauth2/v2/auth?
 response_type=code&
 client_id=424911365001.apps.googleusercontent.com&
 scope=openid%20email&
 redirect_uri=https%3A//oauth2.example.com/code&
 state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foauth2-login-demo.example.com%2FmyHome&
 login_hint=jsmith@example.com&
 nonce=0394852-3190485-2490358&
 hd=example.com

Los usuarios deben dar su consentimiento si tu app solicita información nueva sobre ellos o si tu app solicita acceso a una cuenta que no aprobó anteriormente.

3. Confirmar token de estado antifalsificación

La respuesta se envía al redirect_uri que especificaste en la solicitud. Todas las respuestas se muestran en la string de consulta, como se muestra a continuación:

https://oauth2.example.com/code?state=security_token%3D138r5719ru3e1%26url%3Dhttps%3A%2F%2Foa2cb.example.com%2FmyHome&code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&scope=openid%20email%20https://www.googleapis.com/auth/userinfo.email

En el servidor, debes confirmar que el state recibido de Google coincida con el token de sesión que creaste en el Paso 1. Esta verificación de ida y vuelta ayuda a garantizar que el usuario, no una secuencia de comandos malintencionada, esté realizando la solicitud.

En el siguiente código, se muestra cómo confirmar los tokens de sesión que creaste en el paso 1:

PHP

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para PHP.

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if ($request->get('state') != ($app['session']->get('state'))) {
  return new Response('Invalid state parameter', 401);
}

Java

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para Java.

// Ensure that there is no request forgery going on, and that the user
// sending us this connect request is the user that was supposed to.
if (!request.queryParams("state").equals(
    request.session().attribute("state"))) {
  response.status(401);
  return GSON.toJson("Invalid state parameter.");
}

Python

Si deseas usar este ejemplo, debes descargar la biblioteca cliente de las API de Google para Python.

# Ensure that the request is not a forgery and that the user sending
# this connect request is the expected user.
if request.args.get('state', '') != session['state']:
  response = make_response(json.dumps('Invalid state parameter.'), 401)
  response.headers['Content-Type'] = 'application/json'
  return response

4. Intercambia code por el token de acceso y el token de ID

La respuesta incluye un parámetro code, un código de autorización único que el servidor puede intercambiar por un token de acceso y un token de ID. Tu servidor realiza este intercambio mediante el envío de una solicitud POST HTTPS. La solicitud POST se envía al extremo del token, que debes recuperar del documento de descubrimiento mediante el valor de metadatos token_endpoint. En la siguiente discusión, se supone que el extremo es https://oauth2.googleapis.com/token. La solicitud debe incluir los siguientes parámetros en el cuerpo POST:

Campos
code El código de autorización que se muestra en la solicitud inicial.
client_id El ID de cliente que obtienes del API ConsoleCredentials page, como se describe en Obtén credenciales de OAuth 2.0.
client_secret El secreto de cliente que obtienes de API ConsoleCredentials page, como se describe en Obtén credenciales de OAuth 2.0
redirect_uri Un URI de redireccionamiento autorizado para la client_id especificada en el Credentials pagede API Console, como se describe en Configura un URI de redireccionamiento.
grant_type Este campo debe contener un valor de authorization_code, según se define en la especificación OAuth 2.0.

La solicitud real podría verse como el siguiente ejemplo:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your-client-id&
client_secret=your-client-secret&
redirect_uri=https%3A//oauth2.example.com/code&
grant_type=authorization_code

Una respuesta exitosa a esta solicitud contiene los siguientes campos en un arreglo JSON:

Campos
access_token Un token que se puede enviar a una API de Google.
expires_in La vida útil restante del token de acceso en segundos.
id_token Un JWT que contiene información de identidad sobre el usuario que está firmado digitalmente por Google.
scope Los permisos de acceso otorgados por access_token se expresan como una lista de strings separadas por mayúsculas y minúsculas, y que distinguen entre mayúsculas y minúsculas.
token_type Identifica el tipo de token que se muestra. En este momento, este campo siempre tiene el valor Bearer.
refresh_token (opcional)

Este campo solo está presente si el parámetro access_type se configuró como offline en la solicitud de autenticación. Para obtener más detalles, consulta Cómo actualizar tokens.

5. Obtén información del usuario a partir del token de ID

Un token de ID es un JWT (token web JSON), es decir, un objeto JSON con codificación base64 firmado de manera criptográfica. Por lo general, es fundamental que valides un token de ID antes de usarlo, pero, como te comunicas directamente con Google a través de un canal HTTPS sin intermediarios y usas tu secreto del cliente para autenticarte en Google, puedes tener la confianza de que el token que recibes realmente proviene de Google y es válido. Si el servidor pasa el token de ID a otros componentes de la app, es muy importante que los otros componentes validen el token antes de usarlo.

Dado que la mayoría de las bibliotecas de API combinan la validación con el trabajo de decodificación de los valores codificados en Base64url y el análisis del JSON dentro, probablemente terminarás validando el token de todas formas a medida que accedas a las reclamaciones en el token de ID.

Una carga útil de token de ID

Un token de ID es un objeto JSON que contiene un conjunto de pares nombre/valor. A continuación, se muestra un ejemplo con formato para facilitar la lectura:

{
  "iss": "https://accounts.google.com",
  "azp": "1234987819200.apps.googleusercontent.com",
  "aud": "1234987819200.apps.googleusercontent.com",
  "sub": "10769150350006150715113082367",
  "at_hash": "HK6E_P6Dh8Y93mRNtsDB1Q",
  "hd": "example.com",
  "email": "jsmith@example.com",
  "email_verified": "true",
  "iat": 1353601026,
  "exp": 1353604926,
  "nonce": "0394852-3190485-2490358"
}

Los tokens de ID de Google pueden contener los siguientes campos (conocidos como reclamos):

Claim Proporcionada Descripción
aud always El público al que está destinado este token de ID. Debe ser uno de los ID de cliente de OAuth 2.0 de tu aplicación.
exp always Hora de vencimiento a partir de la cual no se debe aceptar el token de ID. Se representa en tiempo Unix (segundos enteros).
iat always La hora en que se emitió el token de ID. Representado en tiempo Unix (segundos enteros).
iss always El identificador de la entidad emisora de la respuesta. Siempre debe ser https://accounts.google.com o accounts.google.com para los tokens de ID de Google.
sub always Un identificador para el usuario, único entre todas las Cuentas de Google y que nunca se reutiliza. Una Cuenta de Google puede tener varias direcciones de correo electrónico en diferentes momentos, pero el valor sub nunca cambia. Usa sub dentro de tu aplicación como la clave de identificador único para el usuario. La longitud máxima es de 255 caracteres ASCII que distinguen entre mayúsculas y minúsculas.
at_hash Hash del token de acceso Proporciona una validación de que el token de acceso está vinculado al token de identidad. Si el token de ID se emite con un valor access_token en el flujo del servidor, esta reclamación siempre se incluye. Esta reclamación se puede usar como un mecanismo alternativo para protegerse de ataques de falsificación de solicitudes entre sitios, pero si sigues los pasos 1 y 3, no es necesario verificar el token de acceso.
azp El client_id del presentador autorizado. Esta reclamación solo es necesaria cuando la parte que solicita el token de ID no es lo mismo que el público del token de ID. Este puede ser el caso en Google para las apps híbridas en las que una aplicación web y una app para Android tienen un client_id de OAuth 2.0 diferente, pero comparten el mismo proyecto de las API de Google.
email La dirección de correo electrónico del usuario. Es posible que este valor no sea exclusivo de este usuario y no sea adecuado para usarlo como clave primaria. Solo se proporciona si el alcance incluye el valor del permiso email.
email_verified Verdadero si el usuario verificó la dirección de correo electrónico; de lo contrario, es falso.
family_name Apellido(s) o apellido(s) del usuario Se puede proporcionar cuando hay un reclamo de name presente.
given_name El nombre o los nombres del usuario. Se puede proporcionar cuando hay un reclamo de name presente.
hd El dominio asociado con la organización de Google Cloud del usuario. Se proporciona solo si el usuario pertenece a una organización de Google Cloud.
locale La configuración regional del usuario, representada por una etiqueta de idioma BCP 47. Se puede proporcionar cuando hay una reclamación name presente.
name El nombre completo del usuario, en formato visible. Se pueden proporcionar cuando:
  • El alcance de la solicitud incluyó la string "profile"
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamos name, puedes usarlos para actualizar los registros del usuario de tu app. Ten en cuenta que nunca se garantiza que este reclamo esté presente.

nonce El valor de nonce que proporciona tu app en la solicitud de autenticación. Debes aplicar la protección contra los ataques de repetición. Para ello, asegúrate de que se presente solo una vez.
picture URL de la foto de perfil del usuario. Se pueden proporcionar cuando:
  • El alcance de la solicitud incluyó la string "profile"
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamos picture, puedes usarlos para actualizar los registros de usuario de tu app. Ten en cuenta que nunca se garantiza que este reclamo esté presente.

profile URL de la página de perfil del usuario. Se pueden proporcionar cuando:
  • El alcance de la solicitud incluyó la string "profile"
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamos profile, puedes usarlos para actualizar los registros de usuario de tu app. Ten en cuenta que nunca se garantiza que este reclamo esté presente.

6. Autentica al usuario

Después de obtener información del usuario a partir del token de ID, debes consultar la base de datos de usuarios de tu aplicación. Si el usuario ya existe en tu base de datos, debes iniciar una sesión de aplicación para ese usuario si la respuesta de la API de Google cumple con todos los requisitos de acceso.

Si el usuario no existe en tu base de datos de usuarios, debes redireccionarlo al flujo de registro de usuario nuevo. Es posible que puedas registrar automáticamente al usuario según la información que recibas de Google o, al menos, completar con anterioridad muchos de los campos que necesitas en tu formulario de registro. Además de la información del token de ID, puedes obtener información de perfil de usuario adicional en nuestros extremos de perfil de usuario.

Temas avanzados

En las siguientes secciones, se describe la API de Google OAuth 2.0 con más detalle. Esta información está dirigida a desarrolladores con requisitos avanzados sobre autenticación y autorización.

Acceso a otras API de Google

Una de las ventajas de usar OAuth 2.0 para la autenticación es que tu aplicación puede obtener permiso para usar otras API de Google en nombre del usuario (como YouTube, Google Drive, Calendario o Contactos) al mismo tiempo que autenticas al usuario. Para hacerlo, incluye los otros alcances que necesitas en la solicitud de autenticación que envías a Google. Por ejemplo, para agregar el grupo etario de un usuario a tu solicitud de autenticación, pasa un parámetro de alcance de openid email https://www.googleapis.com/auth/profile.agerange.read. Se solicita al usuario que aparezca correctamente en la pantalla de consentimiento. El token de acceso que recibes de Google te permite acceder a todas las API relacionadas con los permisos de acceso que solicitaste y que se otorgaron.

Tokens de actualización

En tu solicitud de acceso a la API, puedes solicitar que se muestre un token de actualización durante el intercambio code. Un token de actualización proporciona a tu app acceso continuo a las API de Google mientras el usuario no está presente en tu aplicación. Para solicitar un token de actualización, agrega el parámetro access_type a offline en tu solicitud de autenticación.

Consideraciones:

  • Asegúrate de almacenar el token de actualización de forma segura y permanente, ya que solo podrás obtener un token de actualización la primera vez que realices el flujo de intercambio de código.
  • Hay límites en la cantidad de tokens de actualización que se emiten: uno por cada cliente y otro por todos los clientes. Si tu aplicación solicita demasiados tokens de actualización, es posible que se encuentre con estos límites. En ese caso, los tokens de actualización antiguos dejarán de funcionar.

Para obtener más información, consulta Cómo actualizar un token de acceso (acceso sin conexión).

Puedes pedirle al usuario que vuelva a autorizar tu app estableciendo el parámetro prompt en consent en tu solicitud de autenticación. Cuando se incluye prompt=consent, se muestra la pantalla de consentimiento cada vez que tu app solicita autorización de permisos de acceso, incluso si todos los permisos se otorgaron previamente al proyecto de las API de Google. Por este motivo, incluye prompt=consent solo cuando sea necesario.

Para obtener más información sobre el parámetro prompt, consulta prompt en la tabla Parámetros de URI de autenticación.

Parámetros de URI de autenticación

En la siguiente tabla, se proporcionan descripciones más completas de los parámetros que acepta la API de autenticación de OAuth 2.0 de Google.

Parámetro Obligatorio Descripción
client_id (Obligatorio) La string de ID de cliente que obtienes de Credentials pagede API Console, como se describe en Obtén credenciales de OAuth 2.0.
nonce (Obligatorio) Un valor aleatorio generado por tu app que habilita la protección contra la reproducción.
response_type (Obligatorio) Si el valor es code, inicia un flujo de código de autorización básico que requiere un POST en el extremo del token para obtener los tokens. Si el valor es token id_token o id_token token, inicia un flujo implícito, que requiere el uso de JavaScript en el URI de redireccionamiento para recuperar tokens del identificador #fragment de URI.
redirect_uri (Obligatorio) Determina a dónde se envía la respuesta. El valor de este parámetro debe coincidir exactamente con uno de los valores de redireccionamiento autorizados que estableciste en el Credentials page de API Console(incluidos el esquema HTTP o HTTPS, el uso de mayúsculas y minúsculas, si corresponde).
scope (Obligatorio)

El parámetro de alcance debe comenzar con el valor openid y, luego, incluir el valor profile, el valor email o ambos.

Si el valor del permiso profile está presente, el token de ID puede (pero no se garantiza) incluir las reclamaciones profile predeterminadas del usuario.

Si el valor del permiso email está presente, el token de ID incluye las reclamaciones email y email_verified.

Además de estos permisos específicos de OpenID, tu argumento de alcance también puede incluir otros valores de alcance. Todos los valores de alcance deben estar separados por espacios. Por ejemplo, si deseas acceder por archivo a la cuenta de Google Drive de un usuario, tu parámetro de alcance puede ser openid profile email https://www.googleapis.com/auth/drive.file.

Si deseas obtener información sobre los alcances disponibles, consulta Alcances de OAuth 2.0 para las API de Google o la documentación de la API de Google que deseas usar.

state (Opcional, pero muy recomendable)

Una string opaca que es de ida y vuelta en el protocolo; es decir, se muestra como un parámetro de URI en el flujo básico y en el identificador de URI #fragment en el flujo implícito.

state puede ser útil para correlacionar solicitudes y respuestas. Debido a que se puede adivinar tu redirect_uri, el uso de un valor state puede aumentar la certeza de que una conexión entrante es el resultado de una solicitud de autenticación iniciada por la app. Si generas una string aleatoria o codificas el hash de algún estado del cliente (p.ej., una cookie) en esta variable state, puedes validar la respuesta para garantizar que la solicitud y la respuesta se originen en el mismo navegador. Esto brinda protección contra ataques, como la falsificación de solicitudes entre sitios.

access_type (Opcional) Los valores permitidos son offline y online. El efecto se documenta en Acceso sin conexión; si se solicita un token de acceso, el cliente no recibe un token de actualización, a menos que se especifique un valor de offline.
display (Opcional) Un valor de string ASCII para especificar cómo el servidor de autorización muestra las páginas de la interfaz de usuario de autenticación y consentimiento. Los servidores de Google especifican y aceptan los siguientes valores, pero no tienen ningún efecto en su comportamiento: page, popup, touch y wap.
hd (Opcional)

Optimiza el proceso de acceso para las cuentas que son propiedad de una organización de Google Cloud. Si incluyes el dominio de la organización de Google Cloud (por ejemplo, mycollege.edu), puedes indicar que la IU de selección de cuentas debe optimizarse para las cuentas de ese dominio. Para optimizar las cuentas de organización de Google Cloud en general, en lugar de un solo dominio de organización de Google Cloud, establece un valor de asterisco (*): hd=*.

No dependas de esta optimización de la IU para controlar quién puede acceder a tu app, ya que se pueden modificar las solicitudes del cliente. Asegúrate de validar que el token de ID que se muestra tenga un valor de reclamación hd que coincida con lo que esperas (p.ej., mycolledge.edu). A diferencia del parámetro de solicitud, la reclamación hd del token de ID se encuentra dentro de un token de seguridad de Google, de modo que el valor sea confiable.

include_granted_scopes (Opcional) Si se proporciona este parámetro con el valor true y se otorga la solicitud de autorización, la autorización incluirá cualquier autorización anterior otorgada a esta combinación de usuario y aplicación para otros permisos. Consulta Autorización incremental.

Ten en cuenta que no puedes realizar una autorización incremental con el flujo de la aplicación instalada.

login_hint (Opcional) Cuando tu app sabe qué usuario intenta autenticar, puede proporcionar este parámetro como una sugerencia para el servidor de autenticación. Si pasas esta sugerencia, se elimina el selector de cuentas y se completa previamente el cuadro de correo electrónico en el formulario de acceso o se selecciona la sesión adecuada (si el usuario usa acceso múltiple), lo que puede ayudarte a evitar problemas que ocurran si tu app accede con la cuenta de usuario incorrecta. El valor puede ser una dirección de correo electrónico o la string sub, que es equivalente al ID de Google del usuario.
prompt (Opcional) Una lista de valores de string delimitado por espacios que especifica si el servidor de autorización solicita al usuario una nueva autenticación y consentimiento. Los valores posibles son los siguientes:
  • none

    El servidor de autorización no muestra ninguna pantalla de autenticación ni de consentimiento del usuario. Si el usuario aún no está autenticado y no tiene un consentimiento preconfigurado para los alcances solicitados, mostrará un error. Puedes usar none para verificar la autenticación o el consentimiento existentes.

  • consent

    El servidor de autorización solicita al usuario su consentimiento antes de mostrar información al cliente.

  • select_account

    El servidor de autorización solicita al usuario que seleccione una cuenta de usuario. Esto permite que un usuario que tiene varias cuentas en el servidor de autorización seleccione entre las múltiples cuentas para las que puede tener sesiones actuales.

Si no se especifica ningún valor y el usuario no tiene autorización previa, se mostrará una pantalla de consentimiento.

Valida un token de ID

Debes validar todos los tokens de ID en tu servidor, a menos que sepas que provienen directamente de Google. Por ejemplo, tu servidor debe verificar como auténticos los tokens de ID que recibe de tus apps cliente.

Las siguientes son situaciones comunes en las que puedes enviar tokens de ID a tu servidor:

  • Enviando tokens de ID con solicitudes que se deben autenticar. Los tokens de ID te indican el usuario específico que realiza la solicitud y para qué cliente se otorgó ese token de ID.

Los tokens de ID son sensibles y se pueden usar de forma inadecuada si se interceptan. Para asegurarte de que estos tokens se manejen de forma segura, transmítelos solo a través de HTTPS y solo a través de datos de POST o dentro de los encabezados de la solicitud. Si almacenas tokens de ID en tu servidor, también debes almacenarlos de forma segura.

Un aspecto que hace que los tokens de ID sea útil es que puedes pasarlos en diferentes componentes de tu app. Estos componentes pueden usar un token de ID como un mecanismo de autenticación ligero que autentique la app y el usuario. Sin embargo, antes de que puedas usar la información en el token de ID o depender de ella como una afirmación de que el usuario se autenticó, debes validarla.

La validación de un token de ID requiere varios pasos:

  1. Verifica que el emisor haya firmado correctamente el token de ID. Los tokens emitidos por Google se firman con uno de los certificados que se encuentran en el URI especificado en el valor de metadatos jwks_uri del documento de descubrimiento.
  2. Verifica que el valor de la reclamación iss en el token de ID sea igual a https://accounts.google.com o accounts.google.com.
  3. Verifica que el valor de la reclamación aud en el token de ID sea igual al ID de cliente de tu app.
  4. Verifica que no haya transcurrido la hora de vencimiento (reclamo de exp) del token de ID.
  5. Si especificaste un valor de parámetro hd en la solicitud, verifica que el token de ID tenga una reclamación hd que coincida con un dominio aceptado asociado a una organización de Google Cloud.

Los pasos 2 a 5 solo incluyen comparaciones de strings y fechas que son bastante sencillas, por lo que no las detallaremos aquí.

El primer paso es más complejo y requiere la comprobación de firmas criptográficas. Para fines de depuración, puedes usar el extremo tokeninfo de Google a fin de comparar el procesamiento local implementado en tu servidor o dispositivo. Supongamos que el valor de tu token de ID es XYZ123. Luego, debes anular la referencia al URI https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123. Si la firma del token es válida, la respuesta sería la carga útil de JWT en su forma de objeto JSON decodificado.

El extremo tokeninfo es útil para la depuración, pero para fines de producción, recupera claves públicas de Google del extremo de claves y realiza la validación de manera local. Debes recuperar el URI de las claves del Documento de descubrimiento con el valor de metadatos jwks_uri. Las solicitudes al extremo de depuración pueden limitarse o estar sujetas a errores intermitentes.

Dado que Google cambia sus claves públicas con poca frecuencia, puedes almacenarlas en caché mediante las directivas de caché de la respuesta HTTP y, en la gran mayoría de los casos, realizar la validación local de manera mucho más eficiente que con el extremo tokeninfo. Esta validación requiere recuperar y analizar certificados, y realizar las llamadas criptográficas adecuadas para verificar la firma. Por suerte, existen bibliotecas bien depuradas disponibles en una amplia variedad de idiomas para lograr esto (consulta jwt.io).

Cómo obtener información del perfil del usuario

Para obtener información de perfil adicional sobre el usuario, puedes usar el token de acceso (que recibe la aplicación durante el flujo de autenticación) y el estándar OpenID Connect:

  1. Para cumplir con OpenID, debes incluir los valores de alcance openid profile en tu solicitud de autenticación.

    Si quieres que se incluya la dirección de correo electrónico del usuario, puedes especificar un valor de alcance adicional de email. Para especificar profile y email, puedes incluir el siguiente parámetro en tu URI de solicitud de autenticación:

    scope=openid%20profile%20email
  2. Agrega tu token de acceso al encabezado de autorización y realiza una solicitud GET HTTPS al extremo userinfo, que deberías recuperar del documento de descubrimiento con el valor de metadatos userinfo_endpoint. La respuesta userinfo incluye información sobre el usuario, como se describe en OpenID Connect Standard Claims y el valor de metadatos claims_supported del documento de descubrimiento. Los usuarios o sus organizaciones pueden optar por proporcionar o retener ciertos campos, por lo que es posible que no obtengas información de todos los campos para los permisos de acceso autorizados.

El documento de descubrimiento

El protocolo OpenID Connect requiere el uso de varios extremos para autenticar usuarios y solicitar recursos, incluidos tokens, información de usuarios y claves públicas.

Para simplificar las implementaciones y aumentar la flexibilidad, OpenID Connect permite usar un documento de descubrimiento, un documento JSON encontrado en una ubicación conocida que contiene pares clave-valor que proporcionan detalles sobre la configuración del proveedor de OpenID Connect, incluidos los URI de los extremos de autorización, token, revocación, información del usuario y claves públicas. El documento de descubrimiento para el servicio OpenID Connect de Google se puede recuperar de:

https://accounts.google.com/.well-known/openid-configuration

Para usar los servicios de OpenID Connect de Google, debes codificar el URI de documento de descubrimiento (https://accounts.google.com/.well-known/openid-configuration) en tu aplicación. La aplicación recupera el documento, aplica reglas de almacenamiento en caché en la respuesta y, luego, recupera los URI del extremo según sea necesario. Por ejemplo, para autenticar a un usuario, tu código recuperaría el valor de metadatos authorization_endpoint (https://accounts.google.com/o/oauth2/v2/auth en el siguiente ejemplo) como el URI base para las solicitudes de autenticación que se envían a Google.

A continuación, se muestra un ejemplo de ese documento; los nombres de los campos son los especificados en OpenID Connect Discovery 1.0 (consulta sus significados en ese documento). Los valores son meramente ilustrativos y pueden cambiar, aunque se copiaron de una versión reciente del documento real de Google Discovery:

{
  "issuer": "https://accounts.google.com",
  "authorization_endpoint": "https://accounts.google.com/o/oauth2/v2/auth",
  "device_authorization_endpoint": "https://oauth2.googleapis.com/device/code",
  "token_endpoint": "https://oauth2.googleapis.com/token",
  "userinfo_endpoint": "https://openidconnect.googleapis.com/v1/userinfo",
  "revocation_endpoint": "https://oauth2.googleapis.com/revoke",
  "jwks_uri": "https://www.googleapis.com/oauth2/v3/certs",
  "response_types_supported": [
    "code",
    "token",
    "id_token",
    "code token",
    "code id_token",
    "token id_token",
    "code token id_token",
    "none"
  ],
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "scopes_supported": [
    "openid",
    "email",
    "profile"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_post",
    "client_secret_basic"
  ],
  "claims_supported": [
    "aud",
    "email",
    "email_verified",
    "exp",
    "family_name",
    "given_name",
    "iat",
    "iss",
    "locale",
    "name",
    "picture",
    "sub"
  ],
  "code_challenge_methods_supported": [
    "plain",
    "S256"
  ]
}

Para evitar un recorrido de ida y vuelta HTTP, puedes almacenar en caché los valores del documento de descubrimiento. Se usan encabezados de almacenamiento en caché HTTP estándar que se deben respetar.

Bibliotecas cliente

Las siguientes bibliotecas cliente facilitan la implementación de OAuth 2.0 mediante la integración en frameworks populares:

Cumplimiento de OpenID Connect

El sistema de autenticación de OAuth 2.0 de Google es compatible con las funciones necesarias de la especificación de OpenID Connect Core. Cualquier cliente diseñado para funcionar con OpenID Connect debe interactuar con este servicio (a excepción del Objeto de solicitud de OpenID).