Vinculación de Cuentas de Google con OAuth

Las cuentas se vinculan con los flujos implícitos y de código de autorización de OAuth 2.0, que son estándares de la industria.

Tu servicio debe admitir extremos de autorización y de intercambio de tokens compatibles con OAuth 2.0.

En el flujo implícito, Google abre el extremo de autorización en el navegador del usuario. Después de acceder correctamente, devuelves un token de acceso de larga duración a Google. Este token de acceso ahora se incluye en cada solicitud que se envía desde Google.

En el flujo de código de autorización, necesitas dos extremos:

El extremo de autorización, que presenta la IU de acceso a los usuarios que aún no accedieron El extremo de autorización también crea un código de autorización de corta duración para registrar el consentimiento de los usuarios para el acceso solicitado.
El extremo de intercambio de tokens, que es responsable de dos tipos de intercambios:
1. Intercambia un código de autorización por un token de actualización de larga duración y un token de acceso de corta duración. Este intercambio se produce cuando el usuario pasa por el flujo de vinculación de cuentas.
2. Intercambia un token de actualización de larga duración por un token de acceso de corta duración. Este intercambio se produce cuando Google necesita un nuevo token de acceso porque venció.

Elige un flujo de OAuth 2.0

Si bien el flujo implícito es más fácil de implementar, Google recomienda que los tokens de acceso emitidos por el flujo implícito nunca venzan. Esto se debe a que el usuario se ve obligado a volver a vincular su cuenta después de que vence un token con el flujo implícito. Si necesitas que el token venza por motivos de seguridad, te recomendamos que uses el flujo de código de autorización en su lugar.

Lineamientos de diseño

En esta sección, se describen los requisitos y las recomendaciones de diseño para la pantalla del usuario que alojas para los flujos de vinculación de OAuth. Después de que la app de Google le hace una llamada, tu plataforma le muestra al usuario una página de acceso a Google y una pantalla de consentimiento para la vinculación de cuentas. Se redirecciona al usuario a la app de Google después de que da su consentimiento para vincular las cuentas.

En esta figura, se muestran los pasos para que un usuario vincule su Cuenta de Google a tu sistema de autenticación. En la primera captura de pantalla, se muestra la vinculación que inicia el usuario desde tu plataforma. La segunda imagen muestra el acceso del usuario a Google, mientras que la tercera muestra el consentimiento y la confirmación del usuario para vincular su Cuenta de Google con tu app. La captura de pantalla final muestra una cuenta de usuario vinculada correctamente en la app de Google. — **Figura 1.** Acceso del usuario a la vinculación de cuentas con Google y pantallas de consentimiento

Requisitos

Debes comunicar que la cuenta del usuario se vinculará a Google, no a un producto específico de Google, como Google Home o Asistente de Google.

Recomendaciones

Crea el proyecto

Para crear tu proyecto y usar la vinculación de cuentas, haz lo siguiente:

Ve a la Consola de API de Google.
Haz clic en Crear proyecto.
Ingresa un nombre o acepta la sugerencia generada.
Confirma o edita los campos restantes.
Haz clic en Crear.

Para ver el ID del proyecto, haz lo siguiente:

Ve a la Consola de API de Google.
Busca tu proyecto en la tabla de la página de destino. El ID del proyecto aparece en la ID columna.

Configura la pantalla de consentimiento de OAuth

El proceso de vinculación de Cuentas de Google incluye una pantalla de consentimiento que les indica a los usuarios la aplicación que solicita acceso a sus datos, qué tipo de datos solicita y las condiciones que se aplican. Deberás configurar la pantalla de consentimiento de OAuth antes de generar un ID de cliente de la API de Google.

Abre la página de la pantalla de consentimiento de OAuth de la consola de APIs de Google.
Si se te solicita, selecciona el proyecto que acabas de crear.
En la página "Pantalla de consentimiento de OAuth", completa el formulario y haz clic en el botón "Guardar".

Nombre de la aplicación: Es el nombre de la aplicación que solicita el consentimiento. El nombre debe reflejar con precisión tu aplicación y ser coherente con el nombre de la aplicación que los usuarios ven en otros lugares. El nombre de la aplicación se mostrará en la pantalla de consentimiento de vinculación de cuentas.

Logotipo de la aplicación: Es una imagen en la pantalla de consentimiento que ayudará a los usuarios a reconocer tu app. El logotipo se muestra en la pantalla de consentimiento de vinculación de cuentas y en la configuración de la cuenta.

Correo electrónico de asistencia: Es para que los usuarios se comuniquen contigo si tienen preguntas sobre su consentimiento.

Permisos para las APIs de Google: Los permisos permiten que tu aplicación acceda a los datos privados de Google de tu usuario. Para el caso de uso de vinculación de Cuentas de Google, el permiso predeterminado (correo electrónico, perfil, openid) es suficiente, no es necesario agregar permisos sensibles. Por lo general, se recomienda solicitar permisos de forma incremental, en el momento en que se requiere el acceso, en lugar de hacerlo por adelantado. Obtén más información.

Dominios autorizados: Para protegerlos a ti y a tus usuarios, Google solo permite que las aplicaciones que se autentican con OAuth usen dominios autorizados. Los vínculos de tus aplicaciones deben alojarse en dominios autorizados. Obtén más información.

Vínculo a la página principal de la aplicación: Es la página principal de tu aplicación. Debe alojarse en un dominio autorizado.

Vínculo a la Política de Privacidad de la aplicación: Se muestra en la pantalla de consentimiento de vinculación de Cuentas de Google. Debe alojarse en un dominio autorizado.

Vínculo a las Condiciones del Servicio de la aplicación (opcional): Debe alojarse en un dominio autorizado.

Figura 1. Pantalla de consentimiento de vinculación de Cuentas de Google para una aplicación ficticia, Tunery
Verifica el "Estado de verificación". Si tu aplicación necesita verificación, haz clic en el botón "Enviar para verificación" para enviarla. Consulta los requisitos de verificación de OAuth para obtener más detalles.

Implementa tu servidor de OAuth

Una implementación del servidor OAuth 2.0 del flujo de código de autorización consta de dos extremos que tu servicio pone a disposición a través de HTTPS. El primer endpoint es el de autorización, que se encarga de encontrar u obtener el consentimiento de los usuarios para acceder a los datos. El extremo de autorización presenta una IU de acceso a los usuarios que aún no accedieron y registra el consentimiento para el acceso solicitado. El segundo extremo es el de intercambio de tokens, que se usa para obtener cadenas encriptadas, llamadas tokens, que autorizan a un usuario a acceder a tu servicio.

Cuando una aplicación de Google necesita llamar a una de las APIs de tu servicio, Google usa estos extremos en conjunto para obtener permiso de tus usuarios para llamar a estas APIs en su nombre.

Vinculación de la Cuenta de Google: Flujo de código de autorización de OAuth

En el siguiente diagrama de secuencia, se detallan las interacciones entre el usuario, Google y los extremos de tu servicio.

Figura 1. La secuencia de eventos en el flujo de código de autorización de OAuth 2.0 para la vinculación de la Cuenta de Google.

Funciones y responsabilidades

En la siguiente tabla, se definen los roles y las responsabilidades de los actores en el flujo de OAuth de la vinculación de la Cuenta de Google (GAL). Ten en cuenta que, en GAL, Google actúa como el cliente de OAuth, mientras que tu servicio actúa como el proveedor de identidad o servicio.

Actor / Componente	Rol de GAL	Responsabilidades
App o servidor de Google	Cliente de OAuth	Inicia el flujo, recibe el código de autorización, lo intercambia por tokens y los almacena de forma segura para acceder a las APIs de tu servicio.
Tu extremo de autorización	Servidor de autorización	Autentica a tus usuarios y obtiene su consentimiento para compartir el acceso a sus datos con Google.
Tu extremo de intercambio de tokens	Servidor de autorización	Valida los códigos de autorización y los tokens de actualización, y emite tokens de acceso al servidor de Google.
URI de redireccionamiento de Google	Extremo de devolución de llamada	Recibe el redireccionamiento del usuario desde tu servicio de autorización con los valores `code` y `state`.

Una sesión del flujo de código de autorización de OAuth 2.0 iniciada por Google tiene el siguiente flujo:

Google abre tu extremo de autorización en el navegador del usuario. Si el flujo comenzó en un dispositivo solo de voz para una Acción, Google transfiere la ejecución a un teléfono.
El usuario accede, si aún no lo hizo, y le otorga permiso a Google para acceder a sus datos con tu API, si aún no lo hizo.
Tu servicio crea un código de autorización y se lo devuelve a Google. Para ello, redirecciona el navegador del usuario a Google con el código de autorización adjunto a la solicitud.
Google envía el código de autorización a tu extremo de intercambio de tokens, que verifica la autenticidad del código y devuelve un token de acceso y un token de actualización. El token de acceso es un token de corta duración que tu servicio acepta como credenciales para acceder a las APIs. El token de actualización es un token de larga duración que Google puede almacenar y usar para adquirir tokens de acceso nuevos cuando estos vencen.
Una vez que el usuario completa el flujo de vinculación de cuentas, cada solicitud posterior que se envía desde Google contiene un token de acceso.

Cómo controlar las solicitudes de autorización

Cuando necesites realizar la vinculación de cuentas con el flujo de código de autorización de OAuth 2.0, Google enviará al usuario a tu extremo de autorización con una solicitud que incluye los siguientes parámetros:

Parámetros del extremo de autorización
`client_id`	Es el ID de cliente que le asignaste a Google.
`redirect_uri`	Es la URL a la que envías la respuesta a esta solicitud.
`state`	Es un valor de contabilidad que se devuelve a Google sin cambios en el URI de redireccionamiento.
`scope`	Opcional: Es un conjunto de cadenas de alcance delimitadas por espacios que especifican los datos para los que Google solicita autorización.
`response_type`	Es el tipo de valor que se devolverá en la respuesta. Para el flujo de código de autorización de OAuth 2.0, el tipo de respuesta siempre es `code`.
`user_locale`	Es el parámetro de configuración de idioma de la Cuenta de Google en formato RFC5646, que se usa para localizar tu contenido en el idioma preferido del usuario.

Por ejemplo, si tu extremo de autorización está disponible en https://myservice.example.com/auth, una solicitud podría verse de la siguiente manera:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Para que tu extremo de autorización controle las solicitudes de acceso, sigue estos pasos:

Verifica que client_id coincida con el ID de cliente que le asignaste a Google y que redirect_uri coincida con la URL de redireccionamiento que Google proporcionó para tu servicio. Estas verificaciones son importantes para evitar otorgar acceso a apps cliente no deseadas o mal configuradas. Si admites varios flujos de OAuth 2.0, confirma también que response_type sea code.
Verifica si el usuario accedió a tu servicio. Si el usuario no accedió a su cuenta, completa el flujo de acceso o registro de tu servicio.
Genera un código de autorización para que Google lo use y acceda a tu API. El código de autorización puede ser cualquier valor de cadena, pero debe representar de forma única al usuario, al cliente para el que se genera el token y la hora de vencimiento del código, y no debe ser adivinable. Por lo general, emites códigos de autorización que vencen después de aproximadamente 10 minutos.

Confirma que la URL especificada por el parámetro redirect_uri tenga el siguiente formato:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

Redirecciona el navegador del usuario a la URL especificada por el parámetro redirect_uri. Incluye el código de autorización que acabas de generar y el valor de estado original sin modificar cuando realices el redireccionamiento. Para ello, agrega los parámetros code y state. A continuación, se muestra un ejemplo de la URL resultante:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

Cómo controlar las solicitudes de intercambio de tokens

El extremo de intercambio de tokens de tu servicio es responsable de dos tipos de intercambios de tokens:

Intercambia códigos de autorización por tokens de acceso y tokens de actualización
Intercambia tokens de actualización por tokens de acceso

Las solicitudes de intercambio de tokens incluyen los siguientes parámetros:

Parámetros del extremo de intercambio de tokens
`client_id`	Cadena que identifica el origen de la solicitud como Google. Esta cadena debe registrarse en tu sistema como el identificador único de Google.
`client_secret`	Es una cadena secreta que registraste en Google para tu servicio.
`grant_type`	Es el tipo de token que se intercambia. Puede ser `authorization_code` o `refresh_token`.
`code`	Cuando es `grant_type=authorization_code`, este parámetro es el código que Google recibió de tu extremo de acceso o intercambio de tokens.
`redirect_uri`	Cuando es `grant_type=authorization_code`, este parámetro es la URL que se usa en la solicitud de autorización inicial.
`refresh_token`	Cuando es `grant_type=refresh_token`, este parámetro es el token de actualización que Google recibió de tu extremo de intercambio de tokens.

Intercambia códigos de autorización por tokens de acceso y tokens de actualización

Después de que el usuario accede y tu extremo de autorización devuelve un código de autorización de corta duración a Google, Google envía una solicitud a tu extremo de intercambio de tokens para intercambiar el código de autorización por un token de acceso y un token de actualización.

Para estas solicitudes, el valor de grant_type es authorization_code, y el valor de code es el valor del código de autorización que otorgaste anteriormente a Google. A continuación, se muestra un ejemplo de una solicitud para intercambiar un código de autorización por un token de acceso y un token de actualización:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Para intercambiar códigos de autorización por un token de acceso y un token de actualización, tu extremo de intercambio de tokens responde a las solicitudes de POST ejecutando los siguientes pasos:

Verifica que client_id identifique el origen de la solicitud como un origen autorizado y que client_secret coincida con el valor esperado.
Verifica que el código de autorización sea válido y no haya vencido, y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado al código de autorización.
Confirma que la URL especificada por el parámetro redirect_uri sea idéntica al valor que se usó en la solicitud de autorización inicial.
Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Bad Request con {"error": "invalid_grant"} como cuerpo.
De lo contrario, usa el ID de usuario del código de autorización para generar un token de actualización y un token de acceso. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de forma única al usuario y al cliente para el que se genera el token, y no deben ser adivinables. En el caso de los tokens de acceso, también registra la hora de vencimiento del token, que suele ser una hora después de que lo emites. Los tokens de actualización no vencen.

Devuelve el siguiente objeto JSON en el cuerpo de la respuesta HTTPS:

{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google almacena el token de acceso y el token de actualización del usuario, y registra el vencimiento del token de acceso. Cuando vence el token de acceso, Google usa el token de actualización para obtener uno nuevo desde tu extremo de intercambio de tokens.

Intercambia tokens de actualización por tokens de acceso

Cuando vence un token de acceso, Google envía una solicitud a tu extremo de intercambio de tokens para intercambiar un token de actualización por un token de acceso nuevo.

Para estas solicitudes, el valor de grant_type es refresh_token, y el valor de refresh_token es el valor del token de actualización que otorgaste anteriormente a Google. A continuación, se muestra un ejemplo de una solicitud para intercambiar un token de actualización por un token de acceso:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Para intercambiar un token de actualización por un token de acceso, tu extremo de intercambio de tokens responde a las solicitudes de POST ejecutando los siguientes pasos:

Verifica que client_id identifique el origen de la solicitud como Google y que client_secret coincida con el valor esperado.
Verifica que el token de actualización sea válido y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado al token de actualización.
Si no puedes verificar todos los criterios anteriores, devuelve un error HTTP 400 Bad Request con {"error": "invalid_grant"} como cuerpo.
De lo contrario, usa el ID de usuario del token de actualización para generar un token de acceso. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de forma única al usuario y al cliente para el que se genera el token, y no deben ser adivinables. En el caso de los tokens de acceso, también registra la hora de vencimiento del token, que suele ser una hora después de que lo emites.

Devuelve el siguiente objeto JSON en el cuerpo de la respuesta HTTPS:

{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Controla las solicitudes userinfo

El extremo userinfo es un recurso protegido de OAuth 2.0 que muestra reclamos sobre el usuario vinculado. La implementación y el alojamiento del extremo userinfo son opcionales, excepto en los siguientes casos de uso:

Acceso a la cuenta vinculada con Google One Tap.
Suscripción sin inconvenientes en Android TV.

Una vez que el token de acceso se recupera correctamente del extremo del token, Google envía una solicitud al extremo userinfo para recuperar la información básica de perfil del usuario vinculado.

Encabezados de la solicitud del extremo userinfo
`Authorization header`	El token de acceso del tipo portador.

Por ejemplo, si el extremo userinfo está disponible en https://myservice.example.com/userinfo, una solicitud podría verse de la siguiente manera:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

Para que tu extremo userinfo controle las solicitudes, sigue estos pasos:

Extrae el token de acceso del encabezado de autorización y muestra la información del usuario asociada con el token de acceso.
Si el token de acceso no es válido, muestra un error HTTP 401 No autorizado con el encabezado de respuesta WWW-Authenticate. A continuación, se muestra un ejemplo de una respuesta de error de userinfo:
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
Si se muestra una respuesta de error 401 No autorizado o cualquier otra respuesta de error no exitosa durante el proceso de vinculación, el error no se podrá recuperar, el token recuperado se descartará y el usuario deberá volver a iniciar el proceso de vinculación.

Si el token de acceso es válido, devuelve una respuesta HTTP 200 con el siguiente objeto JSON en el cuerpo del protocolo HTTPS respuesta:

{
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}

Si el extremo userinfo muestra una respuesta exitosa HTTP 200, el token y las reclamaciones recuperados se registran con la Cuenta de Google del usuario.

respuesta del extremo userinfo
`sub`	Un ID único que identifica al usuario en tu sistema.
`email`	Dirección de correo electrónico del usuario.
`given_name`	Opcional: Es el nombre del usuario.
`family_name`	Opcional: Apellido del usuario.
`name`	Opcional: Es el nombre completo del usuario.
`picture`	Opcional: Foto de perfil del usuario.

Cómo validar la implementación

Puedes validar tu implementación con la herramienta OAuth 2.0 Playground.

En la herramienta, sigue estos pasos:

Haz clic en Configuración para abrir la ventana Configuración de OAuth 2.0.
En el campo Flujo de OAuth, selecciona Del cliente.
En el campo Extremos de OAuth, selecciona Personalizado.
Especifica tu extremo de OAuth 2.0 y el ID de cliente que le asignaste a Google en los campos correspondientes.
En la sección Paso 1, no selecciones ningún alcance de Google. En su lugar, deja este campo en blanco o escribe un alcance válido para tu servidor (o una cadena arbitraria si no usas alcances de OAuth). Cuando termines, haz clic en Autorizar APIs.
En las secciones Paso 2 y Paso 3, sigue el flujo de OAuth 2.0 y verifica que cada paso funcione según lo previsto.

Puedes validar tu implementación con la herramienta de demostración de vinculación de Cuentas de Google.