OpenID Connect

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Las API de OAuth 2.0 de Google se pueden utilizar tanto para la autenticación como para 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 de 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 manera interactiva, te recomendamos la Zona de pruebas de Google OAuth 2.0. 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 (opcional) personalizar la información de marca que ven tus usuarios en la pantalla de consentimiento del usuario. También puedes usar API Console para crear una cuenta de servicio, habilitar la facturación, configurar el filtrado 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 del 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 dónde Google envía las respuestas a tus solicitudes de autenticación.

To create, view, or edit the redirect URIs for a given OAuth 2.0 credential, do the following:

  1. Go to the Credentials page.
  2. In the OAuth 2.0 client IDs section of the page, click a credential.
  3. View or edit the redirect URIs.

If there is no OAuth 2.0 client IDs section on the Credentials page, then your project has no OAuth credentials. To create one, click Create credentials.

Cómo personalizar la pantalla de consentimiento del usuario

Para los usuarios, la experiencia de autenticación 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 acceda, es posible que se le pida 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 con 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 marca, como el nombre del producto, el logotipo y la URL de una 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 cuadro de diálogo de consentimiento, se muestra lo que vería un usuario cuando hay una combinación de permisos de OAuth 2.0 y Google Drive en la solicitud. (Este diálogo genérico se generó con Google OAuth 2.0 Playground, por lo que no incluye información de marca que se establecería en API Console).

Captura de pantalla de la página de consentimiento

Accede al servicio

Google y los 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. Algunos ejemplos incluyen los Servicios de identidad de Google y las bibliotecas cliente de Google, que están disponibles para una variedad de plataformas.

Si decides no usar una biblioteca, sigue las instrucciones que se detallan en el resto de este documento, en las 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 uso compartido de afirmaciones de identidad en Internet.

Los enfoques más utilizados para autenticar a un usuario y obtener un token de ID se denominan flujo de “servidor” y “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 para controlar y usar los tokens del cliente. Si necesitas implementar un flujo implícito, te recomendamos que uses los Servicios de identidad de Google.

Flujo del servidor

Asegúrate de configurar tu app en el 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 por token 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 proteger la seguridad de tus usuarios y evitar los ataques de falsificación de solicitudes. El primer paso es crear un token de sesión único que mantenga el estado entre la app y el cliente del usuario. Luego, harás coincidir este token de sesión único con la respuesta de autenticación que muestra el servicio de acceso de OAuth de Google para verificar que el usuario esté realizando la solicitud y no un atacante malicioso. Estos tokens se conocen como tokens de falsificación de solicitudes entre sitios (CSRF).

Una buena opción para un token de estado es una string de 30 o más 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 tu backend.

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

PHP

Debes descargar la biblioteca cliente de las API de Google para PHP a fin de usar esta muestra.

// 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

Para 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

Debes descargar la biblioteca cliente de las API de Google para Python a fin de usar esta muestra.

# 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 de 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 mediante el valor de metadatos authorization_endpoint. En el siguiente debate, 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 de API ConsoleCredentials page.
  • response_type, que en una solicitud de flujo de código de autorización básico debe ser code. (Obtén más información en response_type).
  • scope, que en una solicitud básica debe ser openid email (Obtén más información en scope).
  • redirect_uri debe ser el extremo HTTP en 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 se 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 regrese a tu aplicación, p.ej., la URL de inicio. (Obtén más información en state).
  • nonce es un valor aleatorio que genera tu app y permite la protección contra la repetició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 en particular asociado con una organización de Google Cloud. (Obtén más información en hd).

Este es un ejemplo de un URI de autenticación completo de OpenID Connect, 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 la cuenta que no aprobaron 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, realice la solicitud.

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

PHP

Debes descargar la biblioteca cliente de las API de Google para PHP a fin de usar esta muestra.

// 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

Para 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

Debes descargar la biblioteca cliente de las API de Google para Python a fin de usar esta muestra.

# 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 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 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 el siguiente debate, 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 a partir de la solicitud inicial.
client_id El ID de cliente que obtienes de 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 el client_id determinado especificado 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, como 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 correcta 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 Google firmó de manera digital.
scope Los permisos de acceso que otorga access_token se expresan como una lista de strings delimitadas por mayúsculas y minúsculas, y que distinguen entre mayúsculas y minúsculas.
token_type Identifica el tipo de token mostrado. 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 estableció en offline en la solicitud de autenticación. Para obtener más información, consulta Tokens de actualización.

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 criptográfica basado en Base64. Por lo general, es fundamental que valides un token de ID antes de usarlo. Sin embargo, dado que te comunicas directamente con Google a través de un canal HTTPS sin intermediarios y usas el secreto de cliente para autenticarte en Google, puedes tener la certeza de que el token que recibes realmente proviene de Google y es válido. Si tu servidor pasa el token de ID a otros componentes de tu app, es muy importante que los otros componentes validen el token antes de usarlo.

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

Carga útil de un 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 claims):

Emitir reclamos Proporcionado 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 del cual no se debe aceptar el token de ID. Representado en tiempo Unix (segundos enteros).
iat always La hora a la 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 https://accounts.google.com o accounts.google.com para los tokens de ID de Google.
sub always Es 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 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 de protección contra ataques de falsificación de solicitudes entre sitios, pero si sigues el Paso 1 y el Paso 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 la misma que el público del token de ID. Este puede ser el caso en Google de 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 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 apto para su uso como clave primaria. Se proporciona solo si tu permiso incluía el valor del permiso email.
email_verified Verdadero si la dirección de correo electrónico del usuario se ha verificado; de lo contrario, es falsa.
family_name Los apellidos o apellidos de los usuarios. Se puede proporcionar cuando hay una reclamación name presente.
given_name Nombre o apellido del usuario. Se puede proporcionar cuando hay una reclamación name presente.
hd Es el dominio asociado con la organización del usuario de Google Cloud. 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 un formato visible Se puede proporcionar en los siguientes casos:
  • El alcance de la solicitud incluía la string "profile".
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamaciones name, puedes usarlas para actualizar los registros del usuario de tu app. Ten en cuenta que este reclamo nunca está presente.

nonce El valor de nonce que tu app proporcionó 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 La URL de la foto de perfil del usuario. Se puede proporcionar en los siguientes casos:
  • El alcance de la solicitud incluía la string "profile".
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamaciones picture, puedes usarlas para actualizar los registros del usuario de tu app. Ten en cuenta que este reclamo nunca está presente.

profile La URL de la página de perfil del usuario. Se puede proporcionar en los siguientes casos:
  • El alcance de la solicitud incluía la string "profile".
  • El token de ID se muestra cuando se actualiza un token

Cuando hay reclamaciones profile, puedes usarlas para actualizar los registros del usuario de tu app. Ten en cuenta que este reclamo nunca está presente.

6. Autentica al usuario

Después de obtener la información del usuario del token de ID, debes consultar la base de datos de usuarios de tu app. 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 en función de la información que recibas de Google o, al menos, puedes completar previamente muchos de los campos que necesitas en tu formulario de registro. Además de la información en el 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 relacionados con la autenticación y la 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 permisos que necesites en la solicitud de autenticación que envías a Google. Por ejemplo, para agregar la edad del usuario a tu solicitud de autenticación, pasa un parámetro de permiso de openid email https://www.googleapis.com/auth/profile.agerange.read. Se solicita al usuario que aparezca de manera adecuada 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 se te 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 la 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.
  • Existen límites en la cantidad de tokens de actualización que se emiten: uno por cada cliente y otra por cada usuario. Si tu aplicación solicita demasiados tokens de actualización, podría llegar a estos límites, en cuyo caso los tokens de actualización anteriores dejarán de funcionar.

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

Puedes pedirle al usuario que vuelva a autorizar tu app. Para ello, establece 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 a tu 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 Obligatoria Descripción
client_id (Obligatorio) Es 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 repetición.
response_type (Obligatorio) Si el valor es code, se 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, se inicia un flujo implícito que requiere el uso de JavaScript en el URI de redireccionamiento para recuperar tokens del identificador de #fragment de URI.
redirect_uri (Obligatorio) Determina adónde se envía la respuesta. El valor de este parámetro debe coincidir exactamente con uno de los valores de redireccionamiento autorizados que configures en el Credentials page de API Console(incluidos el esquema HTTP o HTTPS, el caso y el “/” final, si corresponde).
scope (Obligatorio)

El parámetro de permiso 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 permiso también puede incluir otros valores de permiso. Todos los valores de alcance deben estar separados por espacios. Por ejemplo, si quieres tener acceso por archivo a la unidad de Google Drive de un usuario, tu parámetro de permiso podría ser openid profile email https://www.googleapis.com/auth/drive.file.

Para obtener más información sobre los permisos 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 recomendado)

Es una string opaca que se completa 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 tu redirect_uri se puede adivinar, con un valor state puede aumentar tu seguridad de que una conexión entrante es el resultado de una solicitud de autenticación que inició tu 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 afectan su comportamiento: page, popup, touch y wap.
hd (opcional)

Optimice el proceso de acceso para las cuentas que pertenecen a 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. A fin de realizar optimizaciones para cuentas de organización de Google Cloud en general, en lugar de solo un dominio de la organización de Google Cloud, establece el valor de un asterisco (*): hd=*.

No dependas de esta optimización de 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 que se haya otorgado 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 app 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), que puede ayudarte a evitar problemas que ocurran si tu app accede a 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 delimitados por espacios que especifica si el servidor de autorización solicita la reautenticación y el consentimiento. Los valores posibles son los siguientes:
  • none

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

  • consent

    El servidor de autorización solicita el consentimiento del usuario antes de mostrar la información al cliente.

  • select_account

    El servidor de autorización le 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 autorizó el acceso, 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 a qué cliente se le otorgó ese token de ID.

Los tokens de ID son sensibles y se pueden utilizar de forma inadecuada si se interceptan. Debes asegurarte de que estos tokens se manejen de forma segura mediante su transmisión solo a través de HTTPS y solo a través de datos POST o dentro de los encabezados de la solicitud. Si almacenas tokens de ID en el servidor, también debes almacenarlos de forma segura.

Una cosa que hace que los tokens de ID sea útil es el hecho de que puedes pasarlos por 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, para poder usar la información en el token de ID o confiar en ella como una afirmación de que el usuario se autenticó, debes validarla.

La validación de un token de ID requiere los siguientes pasos:

  1. Verifica que el emisor haya firmado correctamente el token de ID. Los tokens emitidos por Google se firman mediante 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 la app.
  4. Verifica que no haya pasado el tiempo de caducidad (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 con una organización de Google Cloud.

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

El primer paso es más complejo y requiere la verificación de la firma criptográfica. 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 del token de tu 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 formulario de objeto JSON decodificado.

El extremo tokeninfo es útil para depurar, pero para fines de producción, recupera las claves públicas de Google desde el 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, realiza 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, hay bibliotecas bien depuradas disponibles en una gran variedad de lenguajes para lograrlo (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 tu aplicación recibe durante el flujo de autenticación) y el estándar OpenID Connect:

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

    Si deseas que se incluya la dirección de correo electrónico del usuario, puedes especificar un valor de permiso 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 el token de acceso al encabezado de autorización y realiza una solicitud GET HTTPS al extremo userinfo, que debes obtener del documento de descubrimiento mediante el valor de metadatos userinfo_endpoint. La respuesta de 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 elegir proporcionar o retener determinados campos, por lo que es posible que no obtengas información de cada campo para los permisos de acceso autorizados.

El documento de descubrimiento

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

Para simplificar las implementaciones y aumentar la flexibilidad, OpenID Connect permite el uso de 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 las siguientes ubicaciones:

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. Tu aplicación recupera el documento, aplica reglas de almacenamiento en caché en la respuesta y, luego, recupera los URI de extremo según sea necesario. Por ejemplo, para autenticar un usuario, tu código recuperará 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 un documento de este tipo; los nombres de los campos son los especificados en OpenID Connect Discovery 1.0 (consulta el significado de ese documento). Los valores son meramente ilustrativos y pueden cambiar, aunque se copian 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 HTTP ida y vuelta, 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 con marcos de trabajo populares:

Cumplimiento de OpenID Connect

El sistema de autenticación OAuth 2.0 de Google admite las funciones necesarias de la especificación OpenID Connect Core. Cualquier cliente que esté diseñado para funcionar con OpenID Connect debe interactuar con este servicio (excepto para el objeto de solicitud de OpenID).