Vinculación de Cuentas de Google con OAuth

Las cuentas se vinculan mediante los flujos implícitos y de código de autorización de OAuth 2.0 estándar de la industria. Tu servicio debe ser compatible con los extremos de autorización y intercambio de tokens que cumplan con OAuth 2.0.

隐式流程中,Google 会在用户的浏览器中打开您的授权端点。成功登录后,系统会将长期访问令牌返回到 Google。现在,从 Google 发送的每个请求中都包含此访问令牌。

授权代码流程中,您需要两个端点:

  • 授权端点 - 向尚未登录的用户显示登录界面。授权端点还会创建一个短期授权代码,用于记录用户针对所请求的访问权限的同意情况。

  • 令牌交换端点,负责两种交换类型:

    1. 将授权代码交换为长期刷新令牌和短期访问令牌。这种交换会在用户完成帐号关联流程时进行。
    2. 将长期有效的刷新令牌交换为短期访问令牌。当 Google 需要新的访问令牌时,由于此令牌已过期,因此出现这种交换。

选择 OAuth 2.0 流程

虽然隐式数据流的实现过程更简单,但 Google 建议隐式数据流签发的访问令牌永远不会过期。这是因为在令牌随隐式流程过期后,用户被迫再次关联自己的帐号。出于安全考虑,如果您需要令牌过期,我们强烈建议您改为使用授权代码流程。

设计准则

本部分将介绍针对 OAuth 关联流程托管的用户屏幕的设计要求和建议。在由 Google 的应用调用后,您的平台会向用户显示“登录 Google”页面和帐号关联屏幕。用户同意关联帐号后,会被重定向回 Google 的应用。

此图显示了用户将其 Google 帐号与身份验证系统关联的步骤。第一个屏幕截图显示了用户从您的平台发起的关联。第二张图片展示了用户登录 Google 的界面,第三张图片显示了用户同意将其 Google 帐号与应用关联的确认消息。最后的屏幕截图显示的是已成功在 Google 应用中关联的用户帐号。
图 1.帐号关联用户登录 Google 和同意屏幕。

要求

  1. 您必须告知用户该用户帐号将与 Google 关联,而不是与特定 Google 产品(例如 Google Home 或 Google 助理)关联。

建议

建议您执行以下操作:

  1. 显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。

  2. 要共享的数据。使用简洁明了的语言向用户说明他们的 Google 需要哪些数据以及为何收集这些数据。

  3. 明确的号召性用语。在同意屏幕上提供明确的号召性用语,例如“同意并关联”。这是因为用户需要了解他们需要与 Google 共享哪些数据,才能关联帐号。

  4. 能够取消。如果用户不关联,则可以提供返回或取消的方式。

  5. 清除登录流程。确保用户有明确的登录 Google 帐号的方法,例如用户名和密码字段或使用 Google 帐号登录字段。

  6. 能够解除关联。为用户提供解除关联的机制,例如他们在平台上的帐号设置网址。或者,您也可以添加指向 Google 帐号的链接,以便用户可以管理关联的帐号。

  7. 能够更改用户帐号。推荐一种供用户切换帐号的方法。如果用户往往拥有多个帐号,这一点尤其有用。

    • 如果用户必须关闭同意屏幕才能切换帐号,请向 Google 发送一个可恢复错误,以便用户通过 OAuth 关联隐式流程登录所需帐号。
  8. 添加徽标。在同意屏幕上显示公司徽标。 根据样式指南放置徽标。如果您还希望显示 Google 的徽标,请参阅徽标和商标

Crea el proyecto

Para crear tu proyecto y usar la vinculación de cuentas, sigue estos pasos:

  1. Go to the Google API Console.
  2. Haz clic en Crear proyecto .
  3. Ingrese un nombre o acepte la sugerencia generada.
  4. Confirme o edite los campos restantes.
  5. Haz clic en Crear .

Para ver su ID de proyecto:

  1. Go to the Google API Console.
  2. Encuentra tu proyecto en la tabla de la página de inicio. El ID del proyecto aparece en la columna ID .

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

  1. Abre la página Pantalla de consentimiento de OAuth de la consola de APIs de Google.
  2. Si se te solicita, selecciona el proyecto que acabas de crear.
  3. 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 tu aplicación con exactitud y ser coherente con el nombre que los usuarios ven en otros lugares. El nombre de la aplicación se mostrará en la pantalla de consentimiento de la 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: Permite que los usuarios se comuniquen contigo si tienen preguntas sobre su consentimiento.

    Alcances 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 la vinculación de Cuentas de Google, el alcance predeterminado (email, profile, openid) es suficiente; no necesitas agregar ningún alcance sensible. Por lo general, se recomienda solicitar alcances de forma incremental cuando se requiere acceso, en lugar de hacerlo de forma anticipada. Más información

    Dominios autorizados: Para protegerlos a ti y a tus usuarios, Google solo permite que las aplicaciones que se autentiquen con OAuth usen dominios autorizados. Los vínculos de tus aplicaciones deben estar alojados en dominios autorizados. 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 estar alojado en un dominio autorizado.

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

    Vínculo de las Condiciones del Servicio de la aplicación (opcional): Se debe alojar en un dominio autorizado.

    Figura 1: Pantalla de consentimiento de vinculación de Cuentas de Google para una aplicación ficticia, Tunery

  4. Revisa el "Estado de verificación" y, si es necesario verificar tu aplicación, haz clic en el botón "Enviar para verificación" a fin de enviarla para que se verifique. Consulta los requisitos de verificación de OAuth para obtener más información.

Implementa tu servidor OAuth

Para apoyar el flujo implícita OAuth 2.0, el servicio hace un punto final de autorización a disposición por HTTPS. Este punto final es responsable de la autenticación y la obtención del consentimiento de los usuarios para el acceso a los datos. El extremo de autorización presenta una IU de inicio de sesión para los usuarios que aún no han iniciado sesión y registra el consentimiento para el acceso solicitado.

Cuando una aplicación de Google necesita llamar a una de las API autorizadas de su servicio, Google utiliza este punto final para obtener permiso de sus usuarios para llamar a estas API en su nombre.

Una sesión típica de flujo implícito de OAuth 2.0 iniciada por Google tiene el siguiente flujo:

  1. Google abre su punto final de autorización en el navegador del usuario. El usuario inicia sesión, si aún no lo ha hecho, y le otorga permiso a Google para acceder a sus datos con su API, si aún no lo ha otorgado.
  2. Su servicio crea un token de acceso y vuelve a Google. Para hacerlo, redirija el navegador del usuario a Google con el token de acceso adjunto a la solicitud.
  3. Google llama a las API de su servicio y adjunta el token de acceso con cada solicitud. Su servicio verifica que el token de acceso otorgue a Google la autorización para acceder a la API y luego completa la llamada a la API.

Manejar solicitudes de autorización

Cuando una aplicación de Google necesita realizar la vinculación de cuentas a través de un flujo implícito de OAuth 2.0, Google envía al usuario a su punto final de autorización con una solicitud que incluye los siguientes parámetros:

Parámetros de punto final de autorización
client_id El ID de cliente que asignó a Google.
redirect_uri La URL a la que envía la respuesta a esta solicitud.
state Un valor contable que se devuelve a Google sin cambios en el URI de redireccionamiento.
response_type El tipo de valor que se devolverá en la respuesta. Para el flujo implícita OAuth 2.0, el tipo de respuesta es siempre token .
user_locale La configuración de idioma en la cuenta de Google RFC5646 formato utilizado para localizar su contenido en el idioma preferido del usuario.

Por ejemplo, si su punto final de autorización está disponible en https://myservice.example.com/auth , una solicitud puede tener un aspecto como el siguiente:

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

Para que su punto final de autorización maneje las solicitudes de inicio de sesión, siga los siguientes pasos:

  1. Verificar los client_id y redirect_uri valores para evitar la concesión de acceso a las aplicaciones cliente no deseados o mal configurados:

    • Confirmar que el client_id coincide con el ID de cliente que ha asignado a Google.
    • Confirmar que la URL especificada por el redirect_uri parámetro tiene la siguiente forma:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  2. Compruebe si el usuario ha iniciado sesión en su servicio. Si el usuario no ha iniciado sesión, complete el proceso de inicio de sesión o registro de su servicio.

  3. Genere un token de acceso para que Google lo utilice para acceder a su API. El token de acceso puede ser cualquier valor de cadena, pero debe representar de forma única al usuario y al cliente para el que es el token y no debe ser adivinable.

  4. Enviar una respuesta HTTP que redirige el navegador del usuario a la URL especificada por el redirect_uri parámetro. Incluya todos los siguientes parámetros en el fragmento de URL:

    • access_token : El token de acceso que acaba de generar
    • token_type : La cadena bearer
    • state : El valor de estado no modificado de la solicitud original

    El siguiente es un ejemplo de la URL resultante:

    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

OAuth 2.0 manejador de redirección de Google recibe el token de acceso y confirma que el state valor no ha cambiado. Una vez que Google ha obtenido un token de acceso para su servicio, Google adjunta el token a las llamadas posteriores a las API de su servicio.

Manejar solicitudes de información de usuario

El punto final userinfo es un recurso protegido OAuth 2.0 que las reclamaciones de retorno sobre el usuario vinculado. La implementación y el alojamiento del punto final de userinfo es opcional, excepto en los siguientes casos de uso:

Una vez que el token de acceso se ha recuperado correctamente de su punto final de token, Google envía una solicitud a su punto final de información de usuario para recuperar información de perfil básica sobre el usuario vinculado.

encabezados de solicitud de punto final de userinfo
Authorization header El token de acceso de tipo Bearer.

Por ejemplo, si su userinfo punto final está disponible en https://myservice.example.com/userinfo , una solicitud puede tener un aspecto como el siguiente:

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

Para que su punto final de userinfo maneje las solicitudes, siga los siguientes pasos:

  1. Extraiga el token de acceso del encabezado de autorización y devuelva la información para el usuario asociado con el token de acceso.
  2. Si el token de acceso no es válido, devuelve un error HTTP 401 no autorizado con el uso de la WWW-Authenticate encabezado de respuesta. A continuación se muestra un ejemplo de una respuesta de error userinfo:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    Si un 401 no autorizado, o cualquier otra respuesta de error sin éxito se devuelve durante el proceso de vinculación, el error será no recuperable, el token recuperada será descartado y el usuario tendrá para iniciar el proceso de vinculación nuevamente.
  3. Si el token de acceso es válido, el retorno y la 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 su userinfo de punto final devuelve una respuesta de éxito HTTP 200, el recuperado token y reclamaciones se registran en contra de Google del usuario cuenta.

    respuesta del punto final de userinfo
    sub Una identificación única que identifica al usuario en su sistema.
    email Dirección de correo electrónico del usuario.
    given_name Opcional: Nombre del usuario.
    family_name Opcional: Apellido del usuario.
    name Opcional: Nombre completo del usuario.
    picture Opcional: Foto del perfil de usuario.

Cómo validar la implementación

Puede validar su aplicación mediante el uso de la Zona de juegos OAuth 2.0 herramienta.

En la herramienta, siga los siguientes pasos:

  1. Haga clic en Configuración de para abrir la ventana de configuración de OAuth 2.0.
  2. En el campo de flujo de OAuth, seleccione el lado del cliente.
  3. En el campo de OAuth puntos finales, seleccione Personalizar.
  4. Especifique su punto final de OAuth 2.0 y el ID de cliente que asignó a Google en los campos correspondientes.
  5. En la sección Paso 1, no seleccione ninguna alcances de Google. En su lugar, deje este campo en blanco o escriba un ámbito válido para su servidor (o una cadena arbitraria si no utiliza ámbitos OAuth). Cuando haya terminado, haga clic en Autorizar API.
  6. En las secciones Paso 2 y el Paso 3, vaya a través del flujo de OAuth 2.0 y verificar que cada paso funciona como se pretende.

Puede validar su aplicación mediante el uso de la cuenta de Google Vinculación demostración herramienta.

En la herramienta, siga los siguientes pasos:

  1. Haga clic en el Inicio de sesión con el botón de Google.
  2. Elija la cuenta que desea vincular.
  3. Ingrese la identificación del servicio.
  4. Opcionalmente, ingrese uno o más ámbitos para los que solicitará acceso.
  5. Haga clic en Inicio de demostración.
  6. Cuando se le solicite, confirme que puede dar su consentimiento y rechazar la solicitud de vinculación.
  7. Confirme que se le redirige a su plataforma.