Implementa un servidor de OAuth 2.0

Cada acción smart home debe incluir un mecanismo para autenticar usuarios.

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

En esta página, se describe cómo configurar el servidor de OAuth 2.0 para que funcione con la acción smart home.

Vinculación de Cuentas de Google con OAuth

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

  • El extremo authorization, 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 en 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 token de acceso nuevo porque el que había vencido.

Lineamientos de diseño

En esta sección, se describen los requisitos de diseño y las recomendaciones para la pantalla de usuario que alojas en los flujos de vinculación de OAuth. Una vez que la app de Google la llama, tu plataforma le muestra al usuario un acceso a la página de Google y a la pantalla de consentimiento de vinculación de cuentas. Se dirige al usuario a la app de Google después de que otorga 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. La primera captura de pantalla muestra un vínculo iniciado por el usuario desde tu plataforma. En la segunda, se 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. En la captura de pantalla final, se muestra una cuenta de usuario vinculada correctamente en Google app.
Figura 1: Cuenta que vincula al usuario a las pantallas de consentimiento y Google

Requisitos

  1. Debes comunicar que la cuenta del usuario se vinculará a Google, no a un producto de Google específico, como Google Home o Asistente de Google.
  2. Debes tener una declaración de autorización de Google, como "Si accedes, 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.

Recomendaciones

Te recomendamos que hagas lo siguiente:

  1. Muestra 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 indicarle al usuario qué datos requiere Google y por qué.

  3. Llamado a la acción claro Declara un llamado a la acción claro en tu 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. Posibilidad de cancelar. Proporciona una forma para que los usuarios retrocedan o cancelen si eligen no vincular.

  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 Acceder con Google.

  6. Capacidad de desvincularse. Ofrece un mecanismo para que los usuarios puedan desvincularse, como una URL a la configuración de la cuenta en tu plataforma. Como alternativa, puedes incluir un vínculo a una Cuenta de Google en la que los usuarios puedan administrar su cuenta vinculada.

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

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

  8. Incluya su logotipo. Muestre el logotipo de su empresa en la pantalla de consentimiento. Usa tus lineamientos de estilo para ubicar 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 del servidor OAuth 2.0 del flujo de código de autorización consta de dos extremos, que tu servicio pone a disposición mediante HTTPS. El primer extremo es el de autorización, que es responsable de buscar u 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 extremo de intercambio de tokens, que se usa para obtener strings 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 API de tu servicio, Google usa estos extremos juntos para obtener permiso de los usuarios a fin de llamar a estas API 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 el 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 ha hecho, y otorga permiso a Google para acceder a sus datos con tu API, si aún no lo ha hecho.
  3. Su servicio crea un código de autorización y se lo muestra a Google. Para hacerlo, 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 al extremo del 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 API. El token de actualización es un token de larga duración que Google puede almacenar y usar para adquirir nuevos tokens de acceso cuando vencen.
  5. 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.

Administra solicitudes de autorización

Cuando necesitas vincular cuentas mediante el flujo de código de autorización de OAuth 2.0, Google envía al usuario al extremo de autorización con una solicitud que incluye los siguientes parámetros:

Parámetros del extremo de autorización
client_id El ID de cliente que le asignaste a Google.
redirect_uri La URL a la que envías la respuesta a esta solicitud.
state Un valor de contabilidad que se devuelve a Google sin cambios en el URI de redireccionamiento.
scope Opcional: Un conjunto de strings de alcance delimitadas por espacios que especifican los datos para los que Google solicita autorización.
response_type El tipo de valor que se muestra 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 la configuración de idioma de la Cuenta de Google en formato RFC5646, que se usa para localizar el 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 el extremo de autorización controle las solicitudes de acceso, sigue estos pasos:

  1. 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 proporcionada por Google para tu servicio. Estas verificaciones son importantes para evitar que se otorgue acceso a apps cliente mal configuradas o no deseadas. Si admites varios flujos de OAuth 2.0, también confirma que response_type sea code.
  2. Verifica si el usuario accedió a tu servicio. Si el usuario no accedió, completa el flujo de acceso o de registro de tu servicio.
  3. Genera un código de autorización para que Google use a fin de acceder a tu API. El código de autorización puede ser cualquier valor de string, pero debe representar de forma única al usuario, al cliente para el que está el token y al 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 parámetro redirect_uri. Incluye el código de autorización que acabas de generar y el valor de estado original sin modificar cuando te redirecciones. Para ello, agrega 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 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 de actualización
  • Intercambiar tokens de actualización por tokens de acceso

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

Parámetros del extremo del intercambio de tokens
client_id Es una string que identifica el origen de la solicitud como Google. Esta string debe estar registrada en tu sistema como identificador único de Google.
client_secret Una string secreta que registraste en Google para tu servicio.
grant_type El tipo de token que se intercambia. Es 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 de 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 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 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, el extremo de intercambio de tokens responde a las solicitudes POST mediante los siguientes pasos:

  1. Verifica que client_id identifique el origen de la solicitud como un origen autorizado y que client_secret coincida con el valor esperado.
  2. Verifica que el código de autorización sea válido y no haya caducado, y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado al código de autorización.
  3. Confirma que la URL especificada por el parámetro redirect_uri sea idéntica al valor usado en la solicitud de autorización inicial.
  4. Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
  5. De lo contrario, usa el ID del usuario del código de autorización para generar un token de actualización y uno de acceso. Estos tokens pueden ser cualquier valor de string, pero deben representar de forma única al usuario y al cliente para los que es el token, y no deben ser adivinables. Para los tokens de acceso, también registra el tiempo de vencimiento del token, que suele ser una hora después de emitirlo. 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 su vencimiento. Cuando el token de acceso caduca, Google usa el token de actualización para obtener un nuevo token de acceso de tu extremo de intercambio de tokens.

Intercambiar tokens de actualización por tokens de acceso

Cuando un token de acceso caduca, Google envía una solicitud a tu extremo de intercambio de tokens para intercambiar un token de actualización por uno 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 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, el extremo de intercambio de tokens responde a las solicitudes POST mediante los siguientes pasos:

  1. Verifica que client_id identifique el origen de la solicitud como Google y que 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 al token de actualización.
  3. Si no puedes verificar todos los criterios anteriores, muestra un error de solicitud incorrecta HTTP 400 con {"error": "invalid_grant"} como cuerpo.
  4. De lo contrario, usa el ID del usuario del token de actualización para generar un token de acceso. Estos tokens pueden ser cualquier valor de string, pero deben representar al usuario y al cliente para los que está destinado el token y no deben ser adivinables. Para los tokens de acceso, también registra la hora de vencimiento del token, por lo general, una hora después de emitirlo.
  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
}

Cómo controlar solicitudes de información del usuario

El extremo userinfo es un recurso protegido con OAuth 2.0 que muestra reclamos sobre el usuario vinculado. Implementar y alojar el extremo userinfo es opcional, excepto en los siguientes casos prácticos:

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 solicitud del extremo userinfo
Authorization header El token de acceso del tipo Bearer.

Por ejemplo, si tu 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 el extremo userinfo maneje las solicitudes, sigue estos pasos:

  1. Extrae el token de acceso del encabezado de autorización y muestra información para el usuario asociado 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 información del usuario: 
    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 error en el proceso de vinculación, el error será irrecuperable, 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, se muestra una respuesta HTTP 200 con el siguiente objeto JSON en el cuerpo de la respuesta HTTPS: 

    {
"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 HTTP 200 exitosa, el token recuperado y las reclamaciones se registran en la Cuenta de Google del usuario.

    respuesta de 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: El nombre del usuario.
    family_name Opcional: Apellido del usuario.
    name Opcional: El nombre completo del usuario.
    picture Opcional: La foto de perfil del usuario.
Anterior
Lista de tareas para desarrolladores
Siguiente
Cree un proyecto de Actions