Association de comptes Google avec OAuth

Les comptes sont associés à l'aide de flux implicites et code d'autorisation OAuth 2.0. Votre service doit être compatible avec les points de terminaison d'autorisation et d'échange de jetons conformes à 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 的徽标,请参阅徽标和商标

Créer le projet

Pour créer votre projet afin d'utiliser l'association de comptes:

  1. Go to the Google API Console.
  2. Cliquez sur 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 Créer .

Pour afficher votre ID de projet:

  1. Go to the Google API Console.
  2. Trouvez votre projet dans le tableau de la page de destination. L'ID du projet apparaît dans la colonne ID .

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

  1. Ouvrez la page de l'écran de consentement OAuth dans la console des API Google.
  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 et cliquez sur le bouton "Enregistrer".

    Nom de l'application:nom de l'application demandant le consentement des utilisateurs. Le nom doit refléter précisément votre application et correspondre à celui que les utilisateurs voient ailleurs. Le nom de l'application s'affichera sur l'écran de consentement pour l'association de comptes.

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

    Adresse e-mail d'assistance:cette option permet aux utilisateurs de vous contacter pour vous poser des questions sur leur consentement.

    Champs d'application pour les API Google:les champs d'application 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 champ d'application par défaut (adresse e-mail, profil, openid) est suffisant. Vous n'avez pas besoin d'ajouter de champs d'application sensibles. Il est généralement recommandé de demander des champs d'application de manière incrémentielle, au moment où l'accès est requis, plutôt qu'au départ. (en savoir plus).

    Domaines autorisés:afin de vous protéger, vous et vos utilisateurs, Google n'autorise que les applications qui s'authentifient via OAuth à utiliser des domaines autorisés. 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é 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 de votre demande, puis cliquez sur le bouton "Envoyer pour validation". Pour en savoir plus, consultez les conditions de validation OAuth.

Implémenter votre serveur OAuth

Pour prendre en charge le flux implicite OAuth 2.0, votre service fait un point final d'autorisation disponible par HTTPS. Ce point de terminaison est responsable de l'authentification et de l'obtention du consentement des utilisateurs pour l'accès aux données. Le point de terminaison d'autorisation présente une interface utilisateur de connexion à vos utilisateurs qui ne sont pas encore connectés et enregistre le consentement à l'accès demandé.

Lorsqu'une application Google doit appeler l'une des API autorisées de votre service, Google utilise ce point de terminaison pour obtenir l'autorisation de vos utilisateurs d'appeler ces API en leur nom.

Une session de flux implicite OAuth 2.0 typique initiée par Google a le flux suivant :

  1. Google ouvre votre point de terminaison d'autorisation dans le navigateur de l'utilisateur. L'utilisateur se connecte, s'il n'est pas déjà connecté, et autorise Google à accéder à ses données avec votre API, s'il ne l'a pas déjà fait.
  2. Votre service crée un jeton d' accès et retourne à Google. Pour ce faire, redirigez le navigateur de l'utilisateur vers Google avec le jeton d'accès joint à la demande.
  3. Google appelle les API de votre service et attache le jeton d'accès à chaque requête. Votre service vérifie que le jeton d'accès accorde à Google l'autorisation d'accéder à l'API, puis termine l'appel d'API.

Traiter les demandes d'autorisation

Lorsqu'une application Google doit effectuer l'association de comptes via un flux implicite OAuth 2.0, Google envoie l'utilisateur à votre point de terminaison d'autorisation avec une demande qui inclut les paramètres suivants :

Paramètres du point de terminaison d'autorisation
client_id L'ID client que vous avez attribué à Google.
redirect_uri L'URL à laquelle vous envoyez la réponse à cette demande.
state Une valeur comptable qui est retransmise à Google sans modification dans l'URI de redirection.
response_type Le type de valeur à renvoyer dans la réponse. Pour le flux implicite OAuth 2.0, le type de réponse est toujours token .
user_locale La langue compte Google RFC5646 format utilisé pour localiser votre contenu dans la langue de l'utilisateur.

Par exemple, si votre critère d'autorisation est disponible à https://myservice.example.com/auth , une demande pourrait ressembler à ce qui suit:

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

Pour que votre point de terminaison d'autorisation gère les demandes de connexion, procédez comme suit :

  1. Vérifiez les client_id et redirect_uri valeurs pour éviter d' accorder l' accès aux applications clientes non intentionnelles ou mal configurés:

    • Assurez -vous que le client_id correspond à l'ID client que vous avez attribué à Google.
    • Vérifiez que l'URL spécifiée par le redirect_uri paramètre a la forme suivante:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  2. Vérifiez si l'utilisateur est connecté à votre service. Si l'utilisateur n'est pas connecté, terminez le processus de connexion ou d'inscription de votre service.

  3. Générez un jeton d'accès que Google utilisera pour accéder à votre API. Le jeton d'accès peut être n'importe quelle valeur de chaîne, mais il doit représenter de manière unique l'utilisateur et le client auquel le jeton est destiné et ne doit pas être devinable.

  4. Envoyer une réponse HTTP qui redirige le navigateur de l'utilisateur à l'URL spécifiée par le redirect_uri paramètre. Incluez tous les paramètres suivants dans le fragment d'URL :

    • access_token : Le jeton d' accès que vous venez de générer
    • token_type : La chaîne bearer
    • state : la valeur d'état non modifié à partir de la demande d' origine

    Voici un exemple de l'URL résultant:

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

Le gestionnaire de redirection OAuth 2.0 de Google reçoit l'jeton d' accès et confirme que l' state valeur n'a pas changé. Une fois que Google a obtenu un jeton d'accès pour votre service, Google associe le jeton aux appels suivants à vos API de service.

Gérer les demandes d'informations sur les utilisateurs

Le point d'extrémité de userinfo est un OAuth 2.0 ressource protégée que les demandes de retour sur l'utilisateur liée. La mise en œuvre et l'hébergement du point de terminaison userinfo sont facultatifs, à l'exception des cas d'utilisation suivants :

Une fois que le jeton d'accès a été récupéré avec succès à partir de votre point de terminaison de jeton, Google envoie une demande à votre point de terminaison userinfo pour récupérer les informations de profil de base sur l'utilisateur lié.

en-têtes de demande de point de terminaison userinfo
Authorization header Le jeton d'accès de type Bearer.

Par exemple, si votre userinfo point final est disponible à https://myservice.example.com/userinfo , une demande pourrait ressembler à ce qui suit:

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

Pour que votre point de terminaison userinfo gère les demandes, procédez comme suit :

  1. Extrayez le jeton d'accès de l'en-tête d'autorisation et renvoyez les informations pour l'utilisateur associé au jeton d'accès.
  2. Si le jeton d'accès est non valide, un retour HTTP 401 erreur non autorisée avec l' utilisation du WWW-Authenticate - tête de réponse. Voici un exemple d'une réponse d'erreur userinfo:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    Si un 401 non autorisé, ou toute autre réponse d'erreur échoue est retournée au cours du processus de liaison, l'erreur sera non récupérable, le jeton Récupéré sera mis au rebut et l'utilisateur aura pour relancer le processus de liaison.
  3. Si le jeton d'accès est valide, le retour et réponse HTTP 200 avec l'objet JSON suivant dans le corps du protocole HTTPS réponse:

    {
    "sub": "USER_UUID",
    "email": "EMAIL_ADDRESS",
    "given_name": "FIRST_NAME",
    "family_name": "LAST_NAME",
    "name": "FULL_NAME",
    "picture": "PROFILE_PICTURE",
    }
    
    Si votre userinfo retourne point final une réponse de succès HTTP 200, le jeton récupéré et demandes sont enregistrées contre Google de l'utilisateur Compte.

    réponse du point de terminaison userinfo
    sub Un identifiant unique qui identifie l'utilisateur dans votre système.
    email Adresse e-mail de l'utilisateur.
    given_name En option: Prénom de l'utilisateur.
    family_name Facultatif: Nom de l'utilisateur.
    name Facultatif: Nom complet de l'utilisateur.
    picture En option: photo du profil de l'utilisateur.

Valider votre intégration

Vous pouvez valider votre implémentation en utilisant le Playground OAuth 2.0 outil.

Dans l'outil, procédez comme suit :

  1. Cliquez sur Configuration des pour ouvrir la fenêtre Configuration OAuth 2.0.
  2. Dans le champ d'écoulement OAuth, sélectionnez côté client.
  3. Dans le domaine Endpoints OAuth, sélectionnez 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 Étape 1, ne sélectionnez pas de champs Google. Au lieu de cela, laissez ce champ vide ou saisissez une étendue valide pour votre serveur (ou une chaîne arbitraire si vous n'utilisez pas d'étendues OAuth). Lorsque vous avez terminé, cliquez sur Autoriser les API.
  6. Dans les étapes 2 et 3 sections, passez par le flux OAuth 2.0 et vérifiez que chaque étape fonctionne comme prévu.

Vous pouvez valider votre implémentation en utilisant le compte Google Linking Demo outil.

Dans l'outil, procédez comme suit :

  1. Cliquez sur le signe-avec le bouton Google.
  2. Choisissez le compte que vous souhaitez associer.
  3. Saisissez l'ID du service.
  4. Saisissez éventuellement une ou plusieurs étendues pour lesquelles vous demanderez l'accès.
  5. Cliquez sur Démarrer démo.
  6. Lorsque vous y êtes invité, confirmez que vous pouvez consentir et refuser la demande d'association.
  7. Confirmez que vous êtes redirigé vers votre plateforme.