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. 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 tu servidor de OAuth 2.0 para que funcione con tu integración de Cloud-to-cloud.

Vinculación de la Cuenta de Google con OAuth

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.
2. You must have a Google authorization statement such as "By signing in, you are authorizing Google to control your devices." See the Google Device Control Authorization section of the Google Home Developer Policies.
3. You must open the Web OAuth linking page and ensure users have a clear method for signing in to their Google Account, such as fields for their username and password. Don't use the Google Sign-In (GSI) method that enables users to link without being taken to the Web OAuth Linking page. It is a violation of Google policy.
4. You must include at least one of the following items in the OAuth linking page to indicate the integration to which the user is linking:
   • Company logo
   • Company name
   • Integration name
   • App icon

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have a clear method for signing in to their Google Account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

Flujo de código de autorización

Una implementación del servidor de 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 o 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.

Una sesión del 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 le 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 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.
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 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.
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.

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:

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 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, también confirma que response_type es code.
2. 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.
3. 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.
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 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:

Configura cómo Google envía credenciales a tu servidor

Según su implementación, tu servidor de autorización espera recibir credenciales del cliente en el cuerpo o 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 del cliente estén en el encabezado de la solicitud, debes configurar tu integración de Cloud-to-cloud de la siguiente manera:

Ir a la consola para desarrolladores

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

2. En Cloud-to-Cloud, selecciona Develop.

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

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 vencido, 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 que se usó en la solicitud de autorización inicial.
4. Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Bad Request 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 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.
6. 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:

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, devuelve un error HTTP 400 Bad Request 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 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.
5. 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.

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.