Implementa un servidor de OAuth 2.0

Cada integración de Cloud-to-cloud debe incluir un mecanismo para autenticar a los usuarios.

La autenticación te permite vincular las Cuentas de Google de tus usuarios con las cuentas de usuario en tu sistema de autenticación. Esto te permite identificar a tus usuarios cuando tu entrega recibe un intent de casa inteligente. Las casas inteligentes de Google solo admiten OAuth con un flujo de código de autorización.

En esta página, se describe cómo configurar tu servidor de OAuth 2.0 para que funcione con tu integración de Cloud-to-cloud.

Vinculación de Cuentas de Google con OAuth

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 al 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 sigue el flujo de vinculación de la cuenta.
  2. Intercambia un token de actualización de larga duración por un token de acceso de corta duración. Este intercambio ocurre cuando Google necesita un nuevo token de acceso porque el que tenía venció.

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 la llame, tu plataforma mostrará al usuario una página de acceso a Google y una pantalla de consentimiento para la vinculación de la cuenta. Después de que el usuario otorga su consentimiento para vincular las cuentas, se lo redirecciona a la app de Google.

Requisitos

1. 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.
2. Debes tener una declaración de autorización de Google, como "Al acceder, autorizas a Google a controlar tus dispositivos". Consulta la sección Autorización de control de dispositivos de Google de las Políticas para desarrolladores de Google Home.
3. Debes abrir la página de vinculación de OAuth web y asegurarte de que los usuarios tengan un método claro para acceder a su Cuenta de Google, como campos para su nombre de usuario y contraseña. No uses el método de Acceso con Google (GSI) que permite a los usuarios vincular sus cuentas sin que se los redireccione a la página de vinculación de OAuth web. Constituye un incumplimiento de la política de Google.
4. Debes incluir al menos uno de los siguientes elementos en la página de vinculación de OAuth para indicar la integración a la que se vincula el usuario:
   • Logotipo de la empresa
   • Nombre de la empresa
   • Nombre de la integración
   • Ícono de la app

Recomendaciones

Te recomendamos que hagas lo siguiente:

1. Mostrar la Política de Privacidad de Google Incluye un vínculo a la Política de Privacidad de Google en la pantalla de consentimiento.

2. Datos que se compartirán. Usa un lenguaje claro y conciso para informarle al usuario qué datos suyos requiere Google y por qué, y qué datos de uso o interacción puede compartir Google contigo.

3. Llamado a la acción claro. Incluye un llamado a la acción claro en la pantalla de consentimiento, como “Aceptar y vincular”. Esto se debe a que los usuarios deben comprender qué datos deben compartir con Google para vincular sus cuentas.

4. Capacidad de cancelar Proporciona una forma para que los usuarios vuelvan o cancelen la vinculación si deciden no vincular sus cuentas.

5. Proceso de acceso claro. Asegúrate de que los usuarios tengan un método claro para acceder a su Cuenta de Google, como campos para su nombre de usuario y contraseña, o la opción Acceder con Google.

6. Capacidad de desvincular Ofrece un mecanismo para que los usuarios desvinculen sus cuentas, como una URL a la configuración de la cuenta en tu plataforma. Como alternativa, puedes incluir un vínculo a la Cuenta de Google, en la que los usuarios pueden administrar su cuenta vinculada. Si un usuario desvincula tu integración, usa agentUsers.delete para notificar el cambio a Google.

7. Capacidad de cambiar la cuenta de usuario Sugerir un método para que los usuarios cambien de cuenta Esto es especialmente beneficioso si los usuarios suelen tener varias cuentas.

   • Si un usuario debe cerrar la pantalla de consentimiento para cambiar de cuenta, envía un error recuperable a Google para que el usuario pueda acceder a la cuenta deseada con la vinculación de OAuth.

8. Incluye tu logotipo. Muestra el logotipo de tu empresa en la pantalla de consentimiento. Usa tus lineamientos de estilo para colocar tu logotipo. Si también deseas mostrar el logotipo de Google, consulta Logotipos y marcas.

Flujo de código de autorización

Una implementación de 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 extremo es el de autorización, que es responsable de encontrar o obtener el consentimiento de los usuarios para el acceso 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.

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

1. Google abre tu extremo de autorización en el navegador del usuario. Si el flujo se inició en un dispositivo solo de voz para una Acción, Google transfiere la ejecución a un teléfono.
2. El usuario accede, si aún no lo hizo, y otorga permiso a Google para acceder a sus datos con tu API, si aún no lo hizo.
3. Tu servicio crea un código de autorización y lo muestra a Google. Para ello, redirecciona el navegador del usuario a Google con el código de autorización adjunto a la solicitud.
4. Google envía el código de autorización a tu extremo de intercambio de tokens, que verifica la autenticidad del código y muestra 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 vencen.
5. Después de 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 necesitas realizar la vinculación de cuentas con el flujo de código de autorización de OAuth 2.0, Google envía al usuario a tu extremo de autorización con una solicitud que incluye los siguientes parámetros:

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

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

1. Verifica que el client_id coincida con el ID de cliente que asignaste a Google y que el 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 el response_type sea code.
2. Verifica si el usuario accedió a tu servicio. Si no lo hizo, completa el flujo de acceso o registro de tu servicio.
3. Genera un código de autorización para que Google lo use para acceder 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 es 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.
4. 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
     

5. Redirecciona el navegador del usuario a la URL especificada por el redirect_uri parámetro. Incluye el código de autorización que acabas de generar y el valor de estado original y sin modificar cuando redirecciones agregando los parámetros code y state. El siguiente es 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:

Configura la forma en que Google envía credenciales a tu servidor

Según su implementación, tu servidor de autorización espera recibir credenciales de cliente en el cuerpo de la solicitud o en el encabezado de la solicitud.

De forma predeterminada, Google envía las credenciales en el cuerpo de la solicitud. Si tu servidor de autorización requiere que las credenciales de cliente estén en el encabezado de la solicitud, debes configurar tu Cloud-to-cloud integración en consecuencia:

Ir a la consola de desarrolladores

1. En la lista de proyectos, haz clic en Abrir junto al proyecto con el que deseas trabajar.

2. En Nube a nube, selecciona Desarrollar.

3. Haz clic en Abrir junto a tu integración.

4. Desplázate hacia abajo hasta la sección Permisos (opcional) y selecciona la casilla de verificación Hacer que Google transmita el secreto y el ID de cliente a través del encabezado de autenticación básica HTTP.

5. Haz clic en Guardar para guardar los cambios.

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 muestra 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. El siguiente es 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 POST ejecutando los siguientes pasos:

1. Verifica que el client_id identifique el origen de la solicitud como un origen autorizado y que el client_secret coincida con el valor esperado.
2. 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 con el código de autorización.
3. 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.
4. Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
5. 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 es el token, y no deben ser adivinables. Para los tokens de acceso, también registra la hora de vencimiento del token, que suele ser una hora después de que emites el token. Los tokens de actualización no vencen.
6. Muestra 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 para el usuario, y registra el vencimiento del token de acceso. Cuando vence el token de acceso, Google usa el token de actualización para obtener un token de acceso nuevo de 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. El siguiente es 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 POST ejecutando los siguientes pasos:

1. Verifica que el client_id identifique el origen de la solicitud como Google y que el client_secret coincida con el valor esperado.
2. 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 con el token de actualización.
3. Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
4. 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 es el token, y no deben ser adivinables. Para los tokens de acceso, también registra la hora de vencimiento del token, que suele ser una hora después de que emites el token.
5. Muestra 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.

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:

1. Extrae el token de acceso del encabezado de autorización y muestra la información del usuario asociada con el token de acceso.
2. 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.

3. 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.