Association simplifiée avec OAuth et Se connecter avec Google

Présentation

L'association simplifiée avec Se connecter avec Google basée sur OAuth ajoute Se connecter avec Google en plus de l'association OAuth. Cela permet aux utilisateurs Google d'associer facilement leur compte et de créer un compte sur votre service à l'aide de leur compte Google.

Pour associer un compte avec OAuth et Se connecter avec Google, procédez comme suit :

Demandez d'abord à l'utilisateur d'autoriser l'accès à son profil Google.
Utilisez les informations de son profil pour vérifier si le compte utilisateur existe.
Pour les utilisateurs existants, associez les comptes.
Si vous ne trouvez pas d'utilisateur Google correspondant dans votre système d'authentification, validez le jeton d'identité reçu de Google. Vous pouvez ensuite créer un utilisateur en fonction des informations de profil contenues dans le jeton d'identité.

Cette figure montre les étapes à suivre pour qu'un utilisateur associe son compte Google à l'aide du flux d'association simplifié. La première capture d'écran montre comment un utilisateur peut sélectionner votre application pour l'associer. La deuxième capture d'écran permet à l'utilisateur de confirmer s'il dispose ou non d'un compte existant sur votre service. La troisième capture d'écran permet à l'utilisateur de sélectionner le compte Google qu'il souhaite associer. La quatrième capture d'écran montre la confirmation de l'association du compte Google de l'utilisateur à votre application. La cinquième capture d'écran montre un compte utilisateur associé dans l'appli Google.

Figure 1 : Association de compte sur le téléphone d'un utilisateur avec l'association simplifiée

Conditions requises pour l'association simplifiée

Implémentez le flux d'association OAuth Web de base. Votre service doit être compatible avec les points de terminaison d'autorisation et d'échange de jetons conformes à OAuth 2.0.
Votre point de terminaison d'échange de jetons doit être compatible avec les assertions JSON Web Token (JWT) et implémenter les intents check, create et get.

Enregistrez votre ID client pour les API Google.

Implémenter votre serveur OAuth

Votre point de terminaison d'échange de jetons doit être compatible avec les intents check, create et get. Suivez ces étapes pour finaliser le flux d'association de comptes et découvrir quand les différents intents sont utilisés :

L'utilisateur dispose-t-il d'un compte dans votre système d'authentification ? (L'utilisateur décide en sélectionnant OUI ou NON)
1. OUI : l'utilisateur se connecte-t-il à votre plate-forme avec l'adresse e-mail associée à son compte Google ? (L'utilisateur décide en sélectionnant OUI ou NON)
  1. OUI : l'utilisateur dispose-t-il d'un compte correspondant dans votre système d'authentification ? (check intent est appelé pour confirmer)
    1. OUI : get intent est appelé et le compte est associé si l'intention de récupération est renvoyée avec succès.
    2. NON : Créer un compte ? (L'utilisateur décide en sélectionnant OUI ou NON)
      1. OUI : create intent est appelé et le compte est associé si l'intention de création est renvoyée avec succès.
      2. NON : le flux OAuth Web est déclenché, l'utilisateur est redirigé vers son navigateur et il a la possibilité d'associer un autre e-mail.
  2. NON : le flux OAuth Web est déclenché, l'utilisateur est redirigé vers son navigateur et il a la possibilité d'associer un autre e-mail.
2. NON : l'utilisateur dispose-t-il d'un compte correspondant dans votre système d'authentification ? (check intent est appelé pour confirmation)
  1. OUI : get intent est appelé et le compte est associé si l'intention de récupération est renvoyée avec succès.
  2. NON : create intent est appelé et le compte est associé si l'intention de création est renvoyée avec succès.

Rechercher un compte utilisateur existant (vérifier l'intent)

Une fois que l'utilisateur a autorisé l'accès à son profil Google, Google lui envoie une requête contenant une assertion signée de l'identité de l'utilisateur Google. La contient des informations comme l'ID du compte Google de l'utilisateur, votre nom et votre adresse e-mail. Le point de terminaison d'échange de jetons configuré pour votre le projet traite cette demande.

Si le compte Google correspondant est déjà présent dans votre authentification votre point de terminaison d'échange de jetons renvoie account_found=true. Si le Le compte Google ne correspond à aucun utilisateur existant, le point de terminaison de votre échange de jetons renvoie une erreur HTTP 404 Not Found avec account_found=false.

La demande se présente sous la forme suivante:

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&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Le point de terminaison de votre échange de jetons doit pouvoir gérer les paramètres suivants:

Paramètres du point de terminaison du jeton
`intent`	Pour ces requêtes, la valeur de ce paramètre est `check`
`grant_type`	Type de jeton échangé. Pour ces requêtes, a pour valeur `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`assertion`	Jeton Web JSON (JWT, JSON Web Token) qui fournit une assertion signée du jeton Google l'identité de l'utilisateur. Le jeton JWT contient des informations qui incluent le jeton ID, nom et adresse e-mail du compte Google.
`client_id`	ID client que vous avez attribué à Google.
`client_secret`	Code secret du client que vous avez attribué à Google.

Pour répondre aux requêtes d'intent check, le point de terminaison de votre échange de jetons doit procéder comme suit:

Validez et décodez l'assertion JWT.
Vérifiez si le compte Google est déjà présent dans votre système d'authentification.

Valider et décoder l'assertion JWT

Vous pouvez valider et décoder l'assertion JWT à l'aide d'un Bibliothèque de décodage JWT pour votre langage. Utilisez Clés publiques de Google, disponibles JWK ou formats PEM, à vérifier la signature du jeton.

Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:

{
  "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
}

En plus de vérifier la signature du jeton, vérifiez que l'assertion (champ iss) est https://accounts.google.com, que l'audience (champ aud) correspond à l'ID client qui vous a été attribué et que le jeton n'a pas expiré. (champ exp).

À l'aide des champs email, email_verified et hd, vous pouvez déterminer Google héberge les adresses e-mail et fait autorité pour celles-ci. Dans les cas où Google faisant autorité, l'utilisateur est actuellement connu comme étant le titulaire légitime du compte et vous pouvez ignorer le mot de passe ou d'autres méthodes d'authentification. Sinon, ces méthodes pour valider le compte avant de l'associer.

Cas dans lesquels Google fait autorité:

email comporte le suffixe @gmail.com. Il s'agit d'un compte Gmail.
email_verified est "true" et hd est défini. Il s'agit d'un compte G Suite.

Les utilisateurs peuvent créer un compte Google sans utiliser Gmail ni G Suite. Quand ? email ne contient pas de suffixe @gmail.com et hd est absent. Google ne l'est pas. faisant autorité et un mot de passe ou d'autres méthodes d'authentification sont recommandés pour l'utilisateur. email_verified peut également être défini sur "true", car Google a initialement validé utilisateur lors de la création du compte Google, quelle que soit la propriété du tiers compte de messagerie peut avoir changé depuis.

Vérifier si le compte Google est déjà présent dans votre système d'authentification

Vérifiez si l'une des conditions suivantes est remplie:

L'ID de compte Google, qui se trouve dans le champ sub de l'assertion, se trouve dans votre compte utilisateur base de données.
L'adresse e-mail indiquée dans l'assertion correspond à un utilisateur de votre base de données utilisateur.

Si l'une des conditions est vraie, l'utilisateur s'est déjà inscrit. Dans ce cas, renvoyer une réponse semblable à celle-ci:

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

{
  "account_found":"true",
}

Si ni l'ID de compte Google, ni l'adresse e-mail spécifiée dans le champ correspond à un utilisateur de votre base de données, l'utilisateur ne s'est pas encore inscrit. Dans Dans ce cas, le point de terminaison de votre échange de jetons doit renvoyer une erreur HTTP 404 qui spécifie "account_found": "false", comme dans l'exemple suivant:

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

{
  "account_found":"false",
}

Gérer l'association automatique (obtenir l'intention)

Si le compte Google correspondant est déjà présent dans votre authentification votre point de terminaison d'échange de jetons renvoie un jeton pour l'utilisateur. Si le Le compte Google ne correspond à aucun utilisateur existant, le point de terminaison de votre échange de jetons renvoie une erreur linking_error et une valeur login_hint facultative.

La demande se présente sous la forme suivante:

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&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Le point de terminaison de votre échange de jetons doit pouvoir gérer les paramètres suivants:

Paramètres du point de terminaison du jeton
`intent`	Pour ces requêtes, la valeur de ce paramètre est `get`.
`grant_type`	Type de jeton échangé. Pour ces requêtes, a pour valeur `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`assertion`	Jeton Web JSON (JWT, JSON Web Token) qui fournit une assertion signée du jeton Google l'identité de l'utilisateur. Le jeton JWT contient des informations qui incluent le jeton ID, nom et adresse e-mail du compte Google.
`scope`	Facultatif:toutes les habilitations que vous avez configurées pour les demandes utilisateurs.
`client_id`	ID client que vous avez attribué à Google.
`client_secret`	Code secret du client que vous avez attribué à Google.

Pour répondre aux requêtes d'intent get, le point de terminaison de votre échange de jetons doit procéder comme suit:

Validez et décodez l'assertion JWT.
Vérifiez si le compte Google est déjà présent dans votre système d'authentification.

Valider et décoder l'assertion JWT

Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:

{
  "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
}

Cas dans lesquels Google fait autorité:

email comporte le suffixe @gmail.com. Il s'agit d'un compte Gmail.
email_verified est "true" et hd est défini. Il s'agit d'un compte G Suite.

Vérifier si le compte Google est déjà présent dans votre système d'authentification

Vérifiez si l'une des conditions suivantes est remplie:

L'ID de compte Google, qui se trouve dans le champ sub de l'assertion, se trouve dans votre compte utilisateur base de données.
L'adresse e-mail indiquée dans l'assertion correspond à un utilisateur de votre base de données utilisateur.

Si un compte est trouvé pour l'utilisateur, émettez un jeton d'accès et renvoyez les valeurs dans un objet JSON dans le corps de votre réponse HTTPS, comme dans l'exemple suivant:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  "refresh_token": "REFRESH_TOKEN",
  "expires_in": SECONDS_TO_EXPIRATION
}

Dans certains cas, l'association de comptes basée sur un jeton d'ID peut échouer pour l'utilisateur. Si le fait pour une raison quelconque, votre point de terminaison d'échange de jetons doit répondre 401 spécifiant error=linking_error, comme le montre l'exemple suivant:

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

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

Lorsque Google reçoit une réponse d'erreur 401 avec linking_error, il envoie l'utilisateur à votre point de terminaison d'autorisation avec login_hint comme paramètre. La L'utilisateur effectue l'association du compte à l'aide du flux d'association OAuth dans son navigateur.

Gérer la création de compte avec Se connecter avec Google (intent "create")

Lorsqu'un utilisateur doit créer un compte sur votre service, Google envoie une requête à votre point de terminaison d'échange de jetons qui spécifie intent=create.

La requête se présente comme suit :

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&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Votre point de terminaison d'échange de jetons doit pouvoir gérer les paramètres suivants :

Paramètres du point de terminaison du jeton
`intent`	Pour ces requêtes, la valeur de ce paramètre est `create`.
`grant_type`	Type de jeton échangé. Pour ces requêtes, ce paramètre a la valeur `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`assertion`	Jeton Web JSON (JWT) qui fournit une assertion signée de l'identité de l'utilisateur Google. Le JWT contient des informations telles que l'ID de compte Google, le nom et l'adresse e-mail de l'utilisateur.
`client_id`	ID client que vous avez attribué à Google.
`client_secret`	Code secret du client que vous avez attribué à Google.

Le jeton JWT du paramètre assertion contient l'ID, le nom et l'adresse e-mail du compte Google de l'utilisateur. Vous pouvez les utiliser pour créer un compte sur votre service.

Pour répondre aux requêtes d'intent create, votre point de terminaison d'échange de jetons doit effectuer les étapes suivantes :

Validez et décodez l'assertion JWT.
Validez les informations de l'utilisateur et créez un compte.

Valider et décoder l'assertion JWT

Une fois décodée, l'assertion JWT ressemble à l'exemple suivant:

{
  "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
}

Cas dans lesquels Google fait autorité:

email comporte le suffixe @gmail.com. Il s'agit d'un compte Gmail.
email_verified est "true" et hd est défini. Il s'agit d'un compte G Suite.

Valider les informations de l'utilisateur et créer un compte

Vérifiez si l'une des conditions suivantes est remplie :

L'ID de compte Google, qui se trouve dans le champ sub de l'assertion, figure dans votre base de données utilisateur.
L'adresse e-mail de l'assertion correspond à un utilisateur de votre base de données.

Si l'une ou l'autre de ces conditions est remplie, invitez l'utilisateur à associer son compte existant à son compte Google. Pour ce faire, répondez à la requête avec une erreur HTTP 401 qui spécifie error=linking_error et indique l'adresse e-mail de l'utilisateur comme login_hint. Voici un exemple de réponse :

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

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

Lorsque Google reçoit une réponse d'erreur 401 avec linking_error, il redirige l'utilisateur vers votre point de terminaison d'autorisation avec login_hint comme paramètre. L'utilisateur associe son compte à l'aide du flux d'association OAuth dans son navigateur.

Si aucune de ces conditions n'est remplie, créez un compte utilisateur avec les informations fournies dans le JWT. Les nouveaux comptes n'ont généralement pas de mot de passe défini. Nous vous recommandons d'ajouter S'identifier avec Google à d'autres plates-formes pour permettre aux utilisateurs de se connecter avec Google sur les surfaces de votre application. Vous pouvez également envoyer à l'utilisateur un lien qui lance le processus de récupération de mot de passe pour lui permettre de définir un mot de passe et de se connecter sur d'autres plates-formes.

Une fois la création terminée, émettez un jeton d'accès et un jeton d'actualisation , puis renvoyez les valeurs dans un objet JSON dans le corps de votre réponse HTTPS, comme dans l'exemple suivant :

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  "refresh_token": "REFRESH_TOKEN",
  "expires_in": SECONDS_TO_EXPIRATION
}

Obtenir votre ID client pour les API Google

Vous devrez fournir votre ID client Google API lors de la procédure d'enregistrement pour l'association de compte.

Pour obtenir votre ID client API à l'aide du projet que vous avez créé lors de la procédure d'association OAuth. Pour ce faire, procédez comme suit :

Accédez à la page Clients.
Créez ou sélectionnez un projet Google APIs.

Si votre projet ne possède pas d'ID client pour le type d'application Web, cliquez sur Créer un client pour en créer un. Veillez à inclure le domaine de votre site dans la zone Origines JavaScript autorisées. Lorsque vous effectuez des tests ou un développement en local, vous devez ajouter http://localhost et http://localhost:<port_number> au champ Origines JavaScript autorisées.

Important : Ajoutez http://localhost et http://localhost:<port_number> au champ Origines JavaScript autorisées pour les tests ou le développement en local.
Remarque : L'ID client se présente comme suit :
```
1234567890-abc123def456.apps.googleusercontent.com
```

Valider votre intégration

Vous pouvez valider votre implémentation à l'aide de l' outil OAuth 2.0 Playground.

Dans l'outil, procédez comme suit :

Cliquez sur Configuration pour ouvrir la fenêtre de configuration OAuth 2.0.
Dans le champ OAuth flow (Flux OAuth), sélectionnez Client-side (Côté client).
Dans le champ OAuth Endpoints (Points de terminaison OAuth), sélectionnez Custom (Personnalisé).
Spécifiez votre point de terminaison OAuth 2.0 et l'ID client que vous avez attribué à Google dans les champs correspondants.
Dans la section Step 1 (Étape 1), ne sélectionnez aucun champ d'application Google. Laissez plutôt ce champ vide ou saisissez un champ d'application valide pour votre serveur (ou une chaîne arbitraire si vous n'utilisez pas de champs d'application OAuth). Lorsque vous avez terminé, cliquez sur Authorize APIs (Autoriser les API).
Dans les sections Step 2 (Étape 2) et Step 3 (Étape 3), parcourez le flux OAuth 2.0 et vérifiez que chaque étape fonctionne comme prévu.

Vous pouvez valider votre implémentation à l'aide de l'outil de démonstration de l'association de comptes Google .

Dans l'outil, procédez comme suit :

Cliquez sur le bouton Se connecter avec Google.
Sélectionnez le compte que vous souhaitez associer.
Saisissez l'ID de service.
Vous pouvez également saisir un ou plusieurs champs d'application pour lesquels vous demanderez l'accès.
Cliquez sur Start Demo (Démarrer la démonstration).
Lorsque vous y êtes invité, confirmez que vous pouvez donner votre consentement et refuser la demande d'association.
Vérifiez que vous êtes redirigé vers votre plate-forme.

Association simplifiée avec OAuth et Se connecter avec Google Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Présentation

Conditions requises pour l'association simplifiée

Implémenter votre serveur OAuth

Rechercher un compte utilisateur existant (vérifier l'intent)

Valider et décoder l'assertion JWT

Vérifier si le compte Google est déjà présent dans votre système d'authentification

Gérer l'association automatique (obtenir l'intention)

Valider et décoder l'assertion JWT

Vérifier si le compte Google est déjà présent dans votre système d'authentification

Gérer la création de compte avec Se connecter avec Google (intent "create")

Valider et décoder l'assertion JWT

Valider les informations de l'utilisateur et créer un compte

Obtenir votre ID client pour les API Google

Valider votre intégration

Association simplifiée avec OAuth et Se connecter avec Google