Association de comptes Google avec OAuth

Pour créer votre projet afin d'associer des comptes :

1. Accédez à la console Google APIs.
2. Cliquez sur Create Project (Créer un projet).
3. Saisissez un nom ou acceptez la suggestion générée.
4. Confirmez ou modifiez les champs restants.
5. Cliquez sur Create (Créer).

Pour afficher l'ID de votre projet :

1. Accédez à la console Google APIs.
2. Recherchez votre projet dans le tableau de la page de destination. L'ID du projet s'affiche dans la colonne ID.

Configurer votre écran de consentement OAuth

Le processus d'association de comptes Google inclut un écran de consentement qui indique aux utilisateurs l'application qui demande l'accès à leurs données, le type de données demandé et les conditions applicables. Vous devez configurer votre écran de consentement OAuth avant de générer un ID client Google API.

1. Ouvrez la page Écran de consentement OAuth de la console Google APIs.
2. Si vous y êtes invité, sélectionnez le projet que vous venez de créer.

3. Sur la page "Écran de consentement OAuth", remplissez le formulaire, puis cliquez sur le bouton "Enregistrer".

   Nom de l'application : nom de l'application qui demande le consentement. Le nom doit refléter précisément votre application et être cohérent avec le nom de l'application que les utilisateurs voient ailleurs. Le nom de l'application s'affiche sur l'écran de consentement pour l'association de comptes.

   Logo de l'application : image sur l'écran de consentement qui aide les utilisateurs à reconnaître votre application. Le logo s'affiche sur l'écran de consentement pour l'association de comptes et dans les paramètres du compte.

   Adresse e-mail d'assistance : permet aux utilisateurs de vous contacter s'ils ont des questions sur leur consentement.

   Niveaux d'accès pour les API Google : les niveaux d'accès permettent à votre application d'accéder aux données Google privées de vos utilisateurs. Pour le cas d'utilisation de l'association de comptes Google, le niveau d'accès par défaut (e-mail, profil, OpenID) suffit. Vous n'avez pas besoin d'ajouter de niveaux d'accès sensibles. En règle générale, il est préférable de demander les niveaux d'accès de manière incrémentale, au moment où l'accès est requis, plutôt qu'à l'avance. En savoir plus.

   Domaines autorisés : pour garantir votre protection et celle de vos utilisateurs, Google limite l'utilisation de domaines autorisés aux applications qui s'authentifient à l'aide d'OAuth. Les liens de vos applications doivent être hébergés sur des domaines autorisés. En savoir plus.

   Lien vers la page d'accueil de l'application : page d'accueil de votre application. Doit être hébergée sur un domaine autorisé.

   Lien vers les règles de confidentialité de l'application : s'affiche sur l'écran de consentement pour l'association de comptes Google. Doit être hébergé sur un domaine autorisé.

   Lien vers les conditions d'utilisation de l'application (facultatif) : doit être hébergé sur un domaine autorisé.

   

   Figure 1 : Écran de consentement pour l'association de comptes Google pour une application fictive, Tunery

4. Vérifiez l'état de validation. Si votre application doit être validée, cliquez sur le bouton "Envoyer pour validation" pour l'envoyer. Pour en savoir plus, consultez les conditions de validation OAuth.

Implémenter votre serveur OAuth

Une mise en œuvre serveur OAuth 2.0 du flux de code d'autorisation comprend les éléments suivants : deux points de terminaison, que votre service met à disposition via HTTPS. Le premier point de terminaison est le point de terminaison d'autorisation chargé de trouver ou d'obtenir le consentement des utilisateurs pour l'accès aux données. Le point de terminaison d'autorisation présente une interface utilisateur qui n'est pas déjà connectée et qui enregistre le consentement des utilisateurs. l'accès demandé. Le deuxième point de terminaison est le point de terminaison de l'échange de jetons, est utilisé pour obtenir des chaînes chiffrées, appelées jetons, qui autorisent un utilisateur à à accéder à votre service.

Lorsqu'une application Google doit appeler l'une des API de votre service, Google utilise ces points de terminaison pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en son nom.

Une session de flux avec code d'autorisation OAuth 2.0 initiée par Google dispose du flux suivant:

1. Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. Si le flux sur un appareil à commande vocale pour une action, Google transfère l'exécution sur un téléphone.
2. L'utilisateur se connecte, s'il n'est pas déjà connecté, et autorise Google à accéder à leurs données avec votre API, s'ils ne l'ont pas déjà accordé.
3. Votre service crée un code d'autorisation et le renvoie à Google. À faire Redirigez donc le navigateur de l'utilisateur vers Google avec le code d'autorisation joint à la demande.
4. Google envoie le code d'autorisation au point de terminaison de votre échange de jetons, qui vérifie l'authenticité du code et renvoie un jeton d'accès et une jeton d'actualisation. Le jeton d'accès est un jeton de courte durée que votre service accepte comme identifiants d'accès aux API. Le jeton d'actualisation est un jeton que Google peut stocker et utiliser pour obtenir de nouveaux jetons d'accès arrive à expiration.
5. Une fois que l'utilisateur a terminé le processus d'association de compte, toutes les étapes suivantes envoyée par Google contient un jeton d'accès.

Gérer les requêtes d'autorisation

Lorsque vous devez associer des comptes à l'aide du code d'autorisation OAuth 2.0 flux d'autorisation, Google redirige l'utilisateur vers votre point de terminaison d'autorisation avec une requête comprend les paramètres suivants:

Par exemple, si votre point de terminaison d'autorisation est disponible https://myservice.example.com/auth, une requête peut se présenter comme suit:

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

Pour que votre point de terminaison d'autorisation traite les requêtes de connexion, procédez comme suit : étapes:

1. Vérifiez que client_id correspond à l'ID client que vous avez attribué à Google et que redirect_uri correspond à l'URL de redirection fournie par Google pour votre service. Ces vérifications sont importantes pour empêcher l'accès à des applications clientes non intentionnelles ou mal configurées. Si vous acceptez plusieurs Pour les flux OAuth 2.0, vérifiez également que response_type est défini sur code.
2. Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas connecté, terminer le processus de connexion ou d'inscription de votre service.
3. Générez un code d'autorisation que Google utilisera pour accéder à votre API. Le code d'autorisation peut être n'importe quelle valeur de chaîne, mais il doit être unique représenter l'utilisateur, le client auquel le jeton est destiné et la date d'expiration du code et ne doit pas être devinable. Vous émettez généralement une autorisation codes qui expirent au bout de 10 minutes environ.
4. Vérifiez que l'URL spécifiée par le paramètre redirect_uri comporte le ce formulaire:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. Redirigez le navigateur de l'utilisateur vers l'URL spécifiée par le paramètre Paramètre redirect_uri. Indiquez le code d'autorisation généré et la valeur d'état non modifiée d'origine lorsque vous redirigez en ajoutant les paramètres code et state. Voici un exemple exemple de l'URL obtenue:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Gérer les requêtes d'échange de jetons

Le point de terminaison de l'échange de jetons de votre service est responsable de deux types de jetons places de marché:

• Échangez des codes d'autorisation contre des jetons d'accès et d'actualisation
• Échanger des jetons d'actualisation contre des jetons d'accès

Les requêtes d'échange de jetons incluent les paramètres suivants:

Échangez des codes d'autorisation contre des jetons d'accès et d'actualisation

Une fois que l'utilisateur s'est connecté et que votre point de terminaison d'autorisation renvoie un code d'autorisation à Google, celui-ci envoie une demande à votre échange de jetons pour échanger le code d'autorisation contre un jeton d'accès et une actualisation à partir d'un jeton d'accès.

Pour ces requêtes, la valeur de grant_type est authorization_code, et La valeur code correspond à la valeur du code d'autorisation que vous avez accordé précédemment. à Google. Voici un exemple de requête d'échange un code d'autorisation pour un jeton d'accès et un jeton d'actualisation:

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

Pour échanger des codes d'autorisation contre un jeton d'accès et un jeton d'actualisation, votre Le point de terminaison de l'échange de jetons répond aux requêtes POST en exécutant la commande suivante : étapes:

1. Vérifiez que client_id identifie l'origine de la requête comme étant autorisée l'origine et que client_secret correspond à la valeur attendue.
2. Vérifiez que le code d'autorisation est valide et qu'il n'a pas expiré, et que le spécifié dans la requête correspond à l'identifiant client associé au d'autorisation.
3. Vérifiez que l'URL spécifiée par le paramètre redirect_uri est identique à la valeur utilisée dans la requête d'autorisation initiale.
4. Si vous ne pouvez pas vérifier tous les critères ci-dessus, renvoyez une réponse Erreur 400 "Requête incorrecte" avec {"error": "invalid_grant"} dans le corps.
5. Sinon, utilisez l'ID utilisateur du code d'autorisation pour générer une actualisation. et un jeton d'accès. Ces jetons peuvent être de n'importe quelle valeur de chaîne, mais ils doit représenter de manière unique l'utilisateur et le client pour lequel le jeton est destiné. ne doit pas être devinable. Pour les jetons d'accès, notez également l'heure d'expiration le jeton, qui est généralement une heure après son émission. Les jetons d'actualisation n'expirent pas.
6. Renvoyez l'objet JSON suivant dans le corps de la réponse HTTPS:

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

Google stocke le jeton d'accès et le jeton d'actualisation pour l'utilisateur et les enregistrements l'expiration du jeton d'accès. Lorsque le jeton d'accès expire, Google utilise le jeton d'actualisation pour obtenir un nouveau jeton d'accès à partir du point de terminaison de votre échange de jetons.

Échanger des jetons d'actualisation contre des jetons d'accès

Lorsqu'un jeton d'accès expire, Google envoie une demande à votre échange de jetons pour échanger un jeton d'actualisation contre un nouveau jeton d'accès.

Pour ces requêtes, la valeur de grant_type est refresh_token, et la valeur de refresh_token est la valeur du jeton d'actualisation que vous avez précédemment accordé Google Voici un exemple de requête d'échange d'un jeton d'actualisation pour un jeton d'accès:

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

Pour échanger un jeton d'actualisation contre un jeton d'accès, votre point de terminaison échange répond aux requêtes POST en procédant comme suit:

1. Vérifiez que client_id identifie l'origine de la requête comme étant Google. que client_secret correspond à la valeur attendue.
2. Vérifiez que le jeton d'actualisation est valide et que l'ID client spécifié dans la requête correspond à l'ID client associé au jeton d'actualisation.
3. Si vous ne pouvez pas vérifier tous les critères ci-dessus, renvoyez une erreur HTTP 400 Erreur de requête incorrecte avec {"error": "invalid_grant"} dans le corps.
4. Sinon, utilisez l'ID utilisateur du jeton d'actualisation pour générer un accès à partir d'un jeton d'accès. Ces jetons peuvent correspondre à n'importe quelle valeur de chaîne, mais ils doivent être uniques représentent l'utilisateur et le client auquel est destiné le jeton, et ils ne doivent pas être devinable. Pour les jetons d'accès, enregistrez également l'heure d'expiration du jeton, généralement une heure après l'émission du jeton.
5. Renvoyez l'objet JSON suivant dans le corps de la requête réponse:

   {
   "token_type": "Porteur",
   "access_token": "ACCESS_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }

处理 userinfo 请求

userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：

• 使用 Google One Tap 登录关联的账号。
• Android TV 提供顺畅的订阅体验。

从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。

例如，如果您的 userinfo 端点可通过 https://myservice.example.com/userinfo 时，请求可能如下所示：

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

为了让 userinfo 端点能够处理请求，请执行以下步骤：

1. 从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
2. 如果访问令牌无效，则使用 WWW-Authenticate 响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。

3. 如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应 回答：

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }

   如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。

   userinfo 端点响应
   sub	系统中用于识别用户的唯一 ID。
   email	用户的电子邮件地址。
   given_name	可选：用户的名字。
   family_name	可选：用户的姓氏。
   name	可选：用户的全名。
   picture	可选：用户的个人资料照片。

Valider votre implémentation

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

Dans l'outil, procédez comme suit :

1. Cliquez sur Configuration settings pour ouvrir la fenêtre de configuration OAuth 2.0.
2. Dans le champ OAuth flow (Flux OAuth), sélectionnez Client-side (Côté client).
3. Dans le champ OAuth Endpoints (Points de terminaison OAuth), sélectionnez Custom (Personnalisé).
4. Spécifiez votre point de terminaison OAuth 2.0 et l'ID client que vous avez attribué à Google dans les champs correspondants.
5. 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).
6. 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 :

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