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 con las cuentas de usuarios en tu sistema de autenticación. Esto te permite identificar a tus usuarios cuando tu entrega recibe un intent de casa inteligente. La casa inteligente de Google solo es compatible con 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 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 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 a fin de 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 completa 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 este ya venció.

Lineamientos de diseño

En esta sección, se describen los requisitos y las recomendaciones de diseño para la pantalla de usuario que alojas para los flujos de vinculación de OAuth. Después de que la app de Google lo llame, la plataforma le mostrará al usuario una página de acceso a Google y una pantalla de consentimiento para vincular la cuenta. Se dirige al usuario de vuelta a la app de Google después de dar su consentimiento para vincular las cuentas.

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

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 contar con una declaración de autorización de Google, como “Al acceder, autorizas a Google a controlar tus dispositivos”. Consulta el artículo de la Autorización de Control de Dispositivos de Google de las Políticas para Desarrolladores de Google Home.
  3. Debes proporcionar una forma para que los usuarios regresen o cancelen el servicio, si deciden no realizar la vinculación.
  4. 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 los campos de nombre de usuario y contraseña. No uses el método de Acceso con Google (GSI) que permita a los usuarios vincular sin que se los dirija a la página de vinculación de OAuth web. Esto constituye un incumplimiento de la política de Google.

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 decirle al usuario qué datos de su cliente necesita Google y por qué.

  3. Llamado a la acción claro. Crea 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 desvinculación. Ofrece un mecanismo de desvinculación, como una URL a la configuración de sus cuentas en tu plataforma. Como alternativa, puedes incluir un vínculo a la Cuenta de Google en la que los usuarios puedan administrar su cuenta vinculada.

  5. Capacidad de cambiar la cuenta de usuario. Sugiere un método para que los usuarios cambien de cuenta. 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 para que el usuario pueda acceder a la cuenta deseada con la vinculación de OAuth.
  6. Incluye tu logotipo. Mostrar el logotipo de su 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 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
    }

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

userinfo endpoint request headers
Authorization header The access token of type Bearer.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

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

For your userinfo endpoint to handle requests, do the following steps:

  1. Extract access token from the Authorization header and return information for the user associated with the access token.
  2. If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.
  3. If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

    {
    "sub": "USER_UUID",
    "email": "EMAIL_ADDRESS",
    "given_name": "FIRST_NAME",
    "family_name": "LAST_NAME",
    "name": "FULL_NAME",
    "picture": "PROFILE_PICTURE",
    }
    
    If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

    userinfo endpoint response
    sub A unique ID that identifies the user in your system.
    email Email address of the user.
    given_name Optional: First name of the user.
    family_name Optional: Last name of the user.
    name Optional: Full name of the user.
    picture Optional: Profile picture of the user.