Vinculación optimizada con OAuth y Acceso con Google

Descripción general

La vinculación optimizada del Acceso con Google basada en OAuth agrega el Acceso con Google además de la vinculación de OAuth. Esto brinda una experiencia de vinculación sin inconvenientes a los usuarios de Google y habilita la creación de cuentas, lo que le permite al usuario crear una nueva cuenta en tu servicio utilizando su Cuenta de Google.

Para vincular cuentas mediante OAuth y el Acceso con Google, sigue estos pasos generales:

  1. Primero, pide al usuario que des su consentimiento para acceder a su perfil de Google.
  2. Usar la información del perfil para verificar si existe la cuenta de usuario
  3. Para los usuarios existentes, vincule las cuentas.
  4. Si no encuentras una coincidencia para el usuario de Google en tu sistema de autenticación, valida el token de ID de Google. Luego, puedes crear un usuario en función de la información de perfil incluida en el token de ID.
En esta figura, se muestran los pasos que debe seguir un usuario para vincular su Cuenta de Google mediante el flujo de vinculación optimizado. La primera captura de pantalla muestra cómo un usuario puede seleccionar tu app para la vinculación. La segunda captura de pantalla le permite al usuario confirmar si tiene una cuenta existente en tu servicio. La tercera captura de pantalla permite que el usuario seleccione la Cuenta de Google que desea vincular. La cuarta captura de pantalla muestra la confirmación para vincular su Cuenta de Google con tu app. La quinta captura de pantalla muestra una cuenta de usuario vinculada correctamente en Google app.

Figura 1. Vinculación de cuentas en el teléfono de un usuario con vinculación optimizada

Requisitos para la vinculación optimizada

Implementa tu servidor OAuth

El extremo de intercambio de tokens debe admitir los intents check, create y get. A continuación, se muestran los pasos completados a través del flujo de vinculación de cuentas y se indica cuándo se llama a los diferentes intents:

  1. ¿El usuario tiene una cuenta en tu sistema de autenticación? (El usuario decide SÍ o NO)
    1. SÍ: ¿El usuario usa el correo electrónico asociado con su Cuenta de Google para acceder a tu plataforma? (El usuario decide SÍ o NO)
      1. SÍ: ¿El usuario tiene una cuenta coincidente en tu sistema de autenticación? (check intent se llama para confirmar).
        1. SÍ: Se llama a get intent y la cuenta se vincula si el intent de retorno se muestra correctamente.
        2. NO: ¿Crear una cuenta nueva? (El usuario decide SÍ o NO)
          1. SÍ: Se llama a create intent y la cuenta se vincula si el intent para crear se muestra correctamente.
          2. NO : Se activa el flujo de OAuth web, se dirige al usuario al navegador y se le da la opción de vincularlo con otro correo electrónico.
      2. NO : Se activa el flujo de OAuth web, se dirige al usuario al navegador y se le da la opción de vincularlo con otro correo electrónico.
    2. NO: ¿El usuario tiene una cuenta coincidente en el sistema de autenticación? (check intent se llama para confirmar).
      1. SÍ: Se llama a get intent y la cuenta se vincula si el intent de retorno se muestra correctamente.
      2. NO: Se llama a create intent y la cuenta se vincula si se crea correctamente el intent para crear.

Verifique si hay una cuenta de usuario existente (verifique la intención)

Una vez que el usuario da su consentimiento para acceder a su perfil de Google, Google envía una solicitud que contiene una afirmación firmada de la identidad del usuario de Google. La aserción contiene información que incluye el ID de la cuenta de Google, el nombre y la dirección de correo electrónico del usuario. El punto final de intercambio de tokens configurado para su proyecto maneja esa solicitud.

Si la correspondiente cuenta de Google ya está presente en su sistema de autenticación, sus responde intercambio de tokens de punto final con account_found=true . Si la cuenta de Google no se corresponde con un usuario existente, el punto final Cambio de Ficha devuelve un error HTTP 404 No se ha encontrado con account_found=false .

La solicitud tiene la siguiente forma:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=check&assertion=JWT&scope=SCOPES

Su punto final de intercambio de tokens debe poder manejar los siguientes parámetros:

Parámetros de punto final de token
intent Para estas solicitudes, el valor de este parámetro es check .
grant_type El tipo de token que se intercambia. Para estas solicitudes, este parámetro tiene el valor urn:ietf:params:oauth:grant-type:jwt-bearer .
assertion Un token web JSON (JWT) que proporciona una afirmación firmada de la identidad del usuario de Google. El JWT contiene información que incluye el ID de la cuenta de Google, el nombre y la dirección de correo electrónico del usuario.

Para responder a los check solicitudes intención, su punto final el intercambio token debe realizar los siguientes pasos:

  • Valide y decodifique la afirmación JWT.
  • Compruebe si la cuenta de Google ya está presente en su sistema de autenticación.
Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

{
  "sub": "1234567890",      // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

  • email has a @gmail.com suffix, this is a Gmail account.
  • email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verfied can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

Compruebe si la cuenta de Google ya está presente en su sistema de autenticación

Compruebe si alguna de las siguientes condiciones es verdadera:

  • El Google ID de cuenta, que se encuentra en la afirmación de la sub campo, se encuentra en la base de datos de usuario.
  • La dirección de correo electrónico en la aserción coincide con un usuario en su base de datos de usuarios.

Si cualquiera de las condiciones es verdadera, el usuario ya se ha registrado. En ese caso, devuelva una respuesta como la siguiente:

HTTP/1.1 200 Success
Content-Type: application/json;charset=UTF-8

{
  "account_found":"true",
}

Si ni el ID de la cuenta de Google ni la dirección de correo electrónico especificada en la afirmación coinciden con un usuario en su base de datos, el usuario aún no se ha registrado. En este caso, el punto final Cambio de Ficha necesita para responder con un error de HTTP 404 que especifica "account_found": "false" , como en el siguiente ejemplo:

HTTP/1.1 404 Not found
Content-Type: application/json;charset=UTF-8

{
  "account_found":"false",
}

Manejar enlaces automáticos (obtener intención)

Una vez que el usuario da su consentimiento para acceder a su perfil de Google, Google envía una solicitud que contiene una afirmación firmada de la identidad del usuario de Google. La aserción contiene información que incluye el ID de la cuenta de Google, el nombre y la dirección de correo electrónico del usuario. El punto final de intercambio de tokens configurado para su proyecto maneja esa solicitud.

Si la cuenta de Google correspondiente ya está presente en su sistema de autenticación, su punto final de intercambio de tokens devuelve un token para el usuario. Si la cuenta de Google no se corresponde con un usuario existente, el punto final Cambio de Ficha devuelve un linking_error error y opcional login_hint .

La solicitud tiene la siguiente forma:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&scope=SCOPES

Su punto final de intercambio de tokens debe poder manejar los siguientes parámetros:

Parámetros de punto final de token
intent Para estas solicitudes, el valor de este parámetro es get .
grant_type El tipo de token que se intercambia. Para estas solicitudes, este parámetro tiene el valor urn:ietf:params:oauth:grant-type:jwt-bearer .
assertion Un token web JSON (JWT) que proporciona una afirmación firmada de la identidad del usuario de Google. El JWT contiene información que incluye el ID de la cuenta de Google, el nombre y la dirección de correo electrónico del usuario.
scope Opcional: Cualquier alcances que ha configurado Google a petición de los usuarios.

Para responder a las get solicitudes intención, su punto final el intercambio token debe realizar los siguientes pasos:

  • Valide y decodifique la afirmación JWT.
  • Compruebe si la cuenta de Google ya está presente en su sistema de autenticación.
Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

{
  "sub": "1234567890",      // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

  • email has a @gmail.com suffix, this is a Gmail account.
  • email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verfied can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

Compruebe si la cuenta de Google ya está presente en su sistema de autenticación

Compruebe si alguna de las siguientes condiciones es verdadera:

  • El Google ID de cuenta, que se encuentra en la afirmación de la sub campo, se encuentra en la base de datos de usuario.
  • La dirección de correo electrónico en la aserción coincide con un usuario en su base de datos de usuarios.

Si se encuentra una cuenta para el usuario, emitir un token de acceso y devolver los valores en un objeto JSON en el cuerpo de su respuesta HTTPS, como en el siguiente ejemplo:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

En algunos casos, la vinculación de cuentas basada en el token de ID puede fallar para el usuario. Si lo hace por alguna razón, su punto final Cambio de Ficha necesita para responder con un error HTTP 401 que especifica error=linking_error , como muestra el siguiente ejemplo:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Cuando Google recibe una respuesta de error 401 con linking_error , Google envía al usuario a su punto final con la autorización login_hint como parámetro. El usuario completa la vinculación de la cuenta utilizando el flujo de vinculación de OAuth en su navegador.

Handle account creation via Google Sign-In (create intent)

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create.

The request has the following form:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&assertion=JWT

Your token exchange endpoint must able to handle the following parameters:

Token endpoint parameters
intent For these requests, the value of this parameter is create.
grant_type The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
assertion A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address.

The JWT within the assertion parameter contains the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to the create intent requests, your token exchange endpoint must perform the following steps:

  • Validate and decode the JWT assertion.
  • Validate user information and create new account.
Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

{
  "sub": "1234567890",      // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "email_verified": true,   // true, if Google has verified the email address
  "hd": "example.com",      // If present, the host domain of the user's GSuite email address
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ",
  "locale": "en_US"         // User's locale, from browser or phone settings
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

  • email has a @gmail.com suffix, this is a Gmail account.
  • email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verfied can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

Validate user information and create new account

Check whether either of the following conditions are true:

  • The Google Account ID, found in the assertion's sub field, is in your user database.
  • The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account. To do so, respond to the request with an HTTP 401 error that specifies error=linking_error and gives the user's email address as the login_hint. The following is a sample response:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

When Google receives a 401 error response with linking_error, Google sends the user to your authorization endpoint with login_hint as a parameter. The user completes account linking using the OAuth linking flow in their browser.

If neither condition is true, create a new user account with the information provided in the JWT. New accounts don't typically have a password set. It's recommended that you add Google Sign-In to other platforms to enable users to log in with Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password to sign in on other platforms.

When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

Obtén tu ID de cliente de la API de Google

Deberá proporcionar su ID de cliente de la API de Google durante el proceso de registro de la vinculación de cuentas.

Para obtener tu ID de cliente de la API con el proyecto que creaste cuando completaste los pasos de vinculación de OAuth Para ello, completa los siguientes pasos:

  1. Abre la página Credenciales de la Consola de API de Google.
  2. Crea o selecciona un proyecto de las API de Google.

    Si tu proyecto no tiene un ID de cliente para el tipo de aplicación web, haz clic en Crear credenciales > ID de cliente de OAuth para crear uno. Asegúrate de incluir el dominio del sitio en el cuadro Orígenes autorizados de JavaScript. Cuando realizas pruebas o desarrollos locales, debes agregar http://localhost y http://localhost:<port_number> al campo Orígenes autorizados de JavaScript.

Cómo validar la implementación

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

  1. Click Configuration to open the OAuth 2.0 Configuration window.
  2. In the OAuth flow field, select Client-side.
  3. In the OAuth Endpoints field, select Custom.
  4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
  5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
  6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

  1. Click the Sign-in with Google button.
  2. Choose the account you'd like to link.
  3. Enter the service ID.
  4. Optionally enter one or more scopes that you will request access for.
  5. Click Start Demo.
  6. When prompted, confirm that you may consent and deny the linking request.
  7. Confirm that you are redirected to your platform.