Migrer de Google Identity Toolkit vers Identity Platform de Google Cloud

La dernière version de Google Identity Toolkit est disponible sous le nom Identity Platform et Firebase Authentication. À l'avenir, les fonctionnalités d'Identity Toolkit seront figées. Toutes les nouvelles fonctionnalités seront développées sur Identity Platform et Firebase Authentication. Nous encourageons les développeurs Identity Toolkit à migrer vers ces plates-formes dès que cela est pratique pour leurs applications.

Nouvelles fonctionnalités

Identity Platform offre déjà des améliorations importantes par rapport à Google Identity Toolkit :

  • Nouvelle console d'administration

    Identity Platform dispose d'une nouvelle console pour les développeurs qui vous permet d'afficher, de modifier et de supprimer vos utilisateurs. Cela peut être utile pour déboguer vos flux de connexion et d'inscription. La console vous permet également de configurer des méthodes d'authentification et de personnaliser des modèles d'e-mails.

  • Nouvelles méthodes d'authentification

    Identity Platform est compatible avec les normes de fédération d'entreprise, telles que SAML et OIDC, ce qui vous permet de faire évoluer vos applications et services SaaS. Identity Platform est également compatible avec des fournisseurs tels que GitHub, Microsoft, Yahoo, etc. Vous pouvez utiliser la connexion anonyme pour créer un ID utilisateur unique sans demander à l'utilisateur de suivre une procédure de connexion ou d'inscription. Cela vous permet d'effectuer des appels d'API authentifiés comme vous le feriez avec un utilisateur normal. Lorsque l'utilisateur décide de s'inscrire, toute son activité est conservée avec le même ID utilisateur. Cela est utile pour les scénarios tels que les paniers d'achat côté serveur ou d'autres applications dans lesquelles vous souhaitez engager l'utilisateur avant de l'envoyer dans un flux d'inscription.

  • Développez votre activité en toute confiance grâce aux contrats de niveau de service et à l'assistance cloud

    Identity Platform s'appuie sur l'infrastructure Google de confiance et fournit des contrats de niveau de service et une assistance Google Cloud. Cela signifie que vous pouvez faire évoluer votre service en toute confiance et compter sur Google pour vous fournir la résilience, la disponibilité et l'évolutivité dont vous avez besoin.

  • Accès à l'ensemble de Firebase

    Firebase est une plate-forme mobile qui vous permet de développer rapidement des applications de qualité, d'élargir votre base d'utilisateurs et d'accroître vos revenus. Firebase se compose de fonctionnalités complémentaires que vous pouvez combiner pour répondre à vos besoins. Il inclut une infrastructure pour l'analyse mobile, la messagerie cloud, la base de données en temps réel, le stockage de fichiers, l'hébergement statique, la configuration à distance, le signalement des plantages mobiles et les tests Android.

  • Interfaces utilisateur mises à jour

    Nous avons entièrement repensé les flux d'interface utilisateur en nous basant sur les dernières recherches de Google sur l'expérience utilisateur. Cela inclut la récupération de mot de passe, l'association de comptes et les flux de désambiguïsation de comptes nouveaux/existants, qui prennent souvent beaucoup de temps à coder et à déboguer. Il intègre Smart Lock pour les mots de passe sur Android, ce qui a considérablement amélioré le taux de conversion des connexions et des inscriptions pour les applications participantes. Il permet également de modifier facilement les thèmes pour les adapter à votre application. Pour une personnalisation maximale, les versions Android et iOS ont été rendues Open Source.

  • Configuration simplifiée du serveur

    Avec Identity Toolkit, nous avons constaté que de nombreux développeurs choisissaient de ne pas implémenter le flux de récupération d'adresse e-mail, ce qui empêchait leurs utilisateurs de récupérer leur compte s'ils oubliaient leur mot de passe. Identity Platform peut envoyer des messages de validation d'adresse e-mail, de réinitialisation de mot de passe et de modification de mot de passe à l'utilisateur. Le texte peut être facilement personnalisé pour vos utilisateurs. De plus, vous n'avez plus besoin d'héberger les widgets d'UI pour héberger les redirections et effectuer les opérations de modification de mot de passe.

  • Nouveaux SDK

    Toutes les API serveur d'Identity Toolkit sont désormais disponibles de manière native avec chacune de nos bibliothèques clientes (Android, iOS, Web). Les développeurs pourront se connecter et inscrire des utilisateurs anciens et nouveaux, accéder aux propriétés des utilisateurs, associer, mettre à jour et supprimer des comptes, réinitialiser des mots de passe, et plus encore, sans être liés à une interface utilisateur fixe. Si vous le préférez, vous pouvez créer manuellement votre propre flux et expérience de connexion à l'aide de cette API.

  • Gestion des sessions pour les applications mobiles

    Avec Identity Toolkit, les applications créaient leur propre état de session en fonction de l'événement d'authentification initial d'Identity Toolkit. Identity Platform utilise un service de backend qui prend un jeton d'actualisation généré à partir de l'événement d'authentification et l'échange contre des jetons d'accès d'une heure pour Android, iOS et JavaScript. Lorsqu'un utilisateur modifie son mot de passe, les jetons d'actualisation ne peuvent plus générer de nouveaux jetons d'accès, ce qui désactive l'accès jusqu'à ce que l'utilisateur se réauthentifie sur cet appareil.

Différences entre les fonctionnalités

Certaines fonctionnalités d'Identity Toolkit ne sont actuellement pas disponibles dans Identity Platform, tandis que d'autres ont été repensées et fonctionnent différemment. Vous pouvez choisir de ne pas migrer immédiatement si ces fonctionnalités sont importantes pour votre application. Dans de nombreux cas, ces fonctionnalités ne sont peut-être pas importantes pour votre application ou il existe peut-être des solutions de repli simples qui vous permettront de poursuivre la migration.

Différences côté serveur

Le service Identity Toolkit principal, avec ses API REST sous-jacentes, sa logique de validation de compte et sa base de données utilisateur principale, n'a subi que des mises à jour mineures. Toutefois, certaines fonctionnalités et la manière dont vous intégrez Identity Platform à votre service ont changé.

  • Fournisseurs d'identité

    PayPal et AOL ne sont pas acceptés. Les utilisateurs disposant de comptes auprès de ces IdP peuvent toujours se connecter à votre application à l'aide du flux de récupération de mot de passe et définir un mot de passe pour leur compte.

  • Bibliothèques de serveur

    Actuellement, des SDK Admin sont disponibles pour Java, Node.js, Python, Go et C#.

  • E-mails de gestion de compte

    Les messages de réinitialisation du mot de passe, de validation de l'adresse e-mail et de modification de l'adresse e-mail peuvent être envoyés par Firebase ou à partir du propre serveur de messagerie du développeur. Actuellement, les modèles d'e-mails n'offrent qu'une personnalisation limitée depuis l'UI, mais peuvent être davantage personnalisés avec les SDK Admin.

  • Confirmation de la modification de l'adresse e-mail

    Dans Identity Toolkit, lorsqu'un utilisateur décide de modifier son adresse e-mail, un e-mail est envoyé à la nouvelle adresse avec un lien permettant de poursuivre le processus de modification.

    Firebase confirme le changement d'adresse e-mail en envoyant un e-mail de révocation à l'ancienne adresse e-mail, avec un lien permettant d'annuler la modification.

  • Déploiement de l'IdP

    Identity Toolkit vous permettait d'ajouter progressivement des fournisseurs d'identité à votre système de connexion afin de pouvoir tester l'impact sur vos demandes d'assistance. Cette fonctionnalité a été supprimée de Firebase Authentication.

Différences côté client

Dans Identity Platform, les fonctionnalités fournies par Google Identity Toolkit sont divisées en deux composants :

  • SDK client et serveur

    Dans Identity Platform, la fonctionnalité fournie par l'API REST Identity Toolkit a été regroupée dans des SDK client disponibles pour Android, iOS et JavaScript. Vous pouvez utiliser le SDK pour connecter et inscrire des utilisateurs, accéder aux informations de leur profil, associer, mettre à jour et supprimer des comptes, et réinitialiser des mots de passe à l'aide du SDK client au lieu de communiquer avec le service de backend via des appels REST.

  • Widget d'UI

    Tous les flux d'interface utilisateur qui gèrent la connexion, l'inscription, la récupération de mot de passe et l'association de compte ont été recréés à l'aide des SDK clients et regroupés dans un widget de connexion. Ils sont disponibles en tant que SDK Open Source pour iOS, Android et le Web. Ils vous permettent de personnaliser entièrement les flux, ce qui n'est pas possible avec Identity Toolkit.

Voici d'autres différences :

  • Sessions et migration

    Étant donné que les sessions sont gérées différemment dans Identity Toolkit et Identity Platform, les sessions existantes de vos utilisateurs seront interrompues lors de la mise à niveau du SDK, et vos utilisateurs devront se reconnecter.

Avant de commencer

Avant de pouvoir migrer d'Identity Toolkit vers Identity Platform, vous devez :

  1. Ouvrez la console Cloud et sélectionnez votre projet Identity Toolkit.

  2. Dans Marketplace, accédez à Identity Platform et sélectionnez "Activer Identity Platform".

  3. Ouvrez la Comptes de service. Vous pouvez y voir le compte de service que vous avez configuré précédemment pour Identity Toolkit.

  4. À côté du compte de service, cliquez sur > Créer une clé. Ensuite, dans la boîte de dialogue Créer une clé privée, définissez le type de clé sur JSON, puis cliquez sur Créer. Un fichier JSON contenant les identifiants de votre compte de service est téléchargé. Vous en aurez besoin pour initialiser le SDK à l'étape suivante.

  5. Revenez à la console Cloud. Dans la section "Fournisseurs", dans le mode de connexion "Adresse e-mail/Mot de passe", ouvrez la page Modèles d'e-mails. Vous pouvez ensuite personnaliser les modèles de votre application.

    Dans Identity Toolkit, lorsque les utilisateurs réinitialisaient leur mot de passe, changeaient d'adresse e-mail ou vérifiaient leur adresse e-mail, vous deviez obtenir un code OOB auprès du serveur Identity Toolkit, puis l'envoyer aux utilisateurs par e-mail. Identity Platform envoie des e-mails en fonction des modèles que vous configurez, sans aucune action supplémentaire requise.

  6. Facultatif : Si vous devez accéder aux services Identity Platform sur votre serveur, installez le SDK Firebase.

    1. Vous pouvez installer le SDK Admin Node.js avec npm :

      $ npm init
$ npm install --save firebase-admin

    2. Dans votre code, vous pouvez accéder à Firebase à l'aide de :

      var admin = require('firebase-admin');
var app = admin.initializeApp({
  credential: admin.credential.cert('path/to/serviceAccountCredentials.json')
});

Ensuite, suivez les étapes de migration pour la plate-forme de votre application : Android, iOS ou Web.

Serveurs et JavaScript

Changements notables

L'implémentation Web d'Identity Platform présente d'autres différences par rapport à Identity Toolkit.

  • Gestion des sessions Web

    Auparavant, lorsqu'un utilisateur s'authentifiait à l'aide du widget Identity Toolkit, un cookie était défini pour l'utilisateur et utilisé pour amorcer la session. Ce cookie avait une durée de vie de deux semaines et permettait à l'utilisateur d'utiliser le widget de gestion de compte pour modifier son mot de passe et son adresse e-mail. Certains sites utilisaient ce cookie pour authentifier toutes les autres demandes de pages sur le site. D'autres sites ont utilisé le cookie pour créer leurs propres cookies via le système de gestion des cookies de leur framework.

    Les SDK client Identity Platform gèrent désormais les jetons d'identité et fonctionnent avec le backend Identity Platform pour maintenir la session à jour. Le backend fait expirer les sessions lorsque des modifications importantes du compte (comme le changement de mot de passe de l'utilisateur) ont été effectuées. Les jetons d'identité ne sont pas automatiquement définis comme cookies sur le client Web et n'ont qu'une durée de vie d'une heure. Sauf si vous ne souhaitez que des sessions d'une heure, les jetons d'identité ne sont pas adaptés pour être utilisés comme cookie afin de valider toutes vos demandes de page. Vous devrez plutôt configurer un écouteur pour le moment où l'utilisateur se connecte, obtenir le jeton d'identité, valider le jeton et créer votre propre cookie via le système de gestion des cookies de votre framework.

    Vous devrez définir la durée de vie de la session de votre cookie en fonction des besoins de sécurité de votre application.

  • Flux de connexion Web

    Auparavant, les utilisateurs étaient redirigés vers accountchooser.com lorsqu'ils initiaient la connexion pour indiquer l'identifiant qu'ils souhaitaient utiliser. Le flux de l'UI Identity Platform commence désormais par une liste de méthodes de connexion, y compris une option d'adresse e-mail qui accède à accountchooser.com pour le Web et utilise l'API hintRequest sur Android. De plus, les adresses e-mail ne sont plus obligatoires dans l'UI. Cela permettra de prendre plus facilement en charge les utilisateurs anonymes, les utilisateurs d'authentification personnalisée ou les utilisateurs de fournisseurs pour lesquels les adresses e-mail ne sont pas requises.

  • Widget de gestion des comptes

    Ce widget fournit une interface utilisateur permettant aux utilisateurs de modifier leur adresse e-mail ou leur mot de passe, ou de dissocier leurs comptes des fournisseurs d'identité. Elle est actuellement en cours de développement.

  • Bouton/widget de connexion

    Les widgets tels que le bouton de connexion et la fiche utilisateur ne sont plus fournis. Elles peuvent être créées très facilement à l'aide de l'API Firebase Authentication.

  • signOutUrl manquant

    Vous devrez appeler firebase.auth.signOut() et gérer le rappel.

  • No oobActionUrl

    L'envoi d'e-mails est désormais géré par Identity Platform et configuré dans la console Firebase.

  • Personnalisation des CSS

    Le widget d'UI utilise le style Material Design Lite, qui ajoute dynamiquement des animations Material Design.

Étape 1 : Modifier le code du serveur

  1. Si votre serveur s'appuie sur le jeton Identity Toolkit (valable deux semaines) pour gérer les sessions des utilisateurs Web, vous devez convertir le serveur pour qu'il utilise son propre cookie de session.

    1. Implémentez un point de terminaison pour valider le jeton d'identité et définir le cookie de session pour l'utilisateur. L'application cliente envoie le jeton d'ID Firebase à ce point de terminaison.
    2. Si la requête entrante contient votre propre cookie de session, vous pouvez considérer l'utilisateur comme authentifié. Sinon, traitez la demande comme non authentifiée.
    3. Si vous ne souhaitez pas que vos utilisateurs perdent leurs sessions existantes, vous devez attendre deux semaines pour que tous les jetons Identity Toolkit expirent. Vous pouvez également effectuer la validation à double jeton pour votre application Web, comme décrit à l'étape 3 ci-dessous.

  2. Ensuite, comme les jetons d'ID sont différents des jetons Identity Toolkit, vous devez mettre à jour votre logique de validation des jetons. Installez le SDK Admin sur votre serveur. Si vous utilisez un langage non compatible avec le SDK Admin, téléchargez une bibliothèque de validation de jetons JWT pour votre environnement et validez correctement le jeton.

  3. Lorsque vous effectuez les mises à jour ci-dessus pour la première fois, vous pouvez toujours avoir des chemins de code qui s'appuient sur des jetons Identity Toolkit. Si vous avez des applications iOS ou Android, les utilisateurs devront passer à la nouvelle version de l'application pour que les nouveaux chemins de code fonctionnent. Si vous ne souhaitez pas forcer vos utilisateurs à mettre à jour votre application, vous pouvez ajouter une logique de validation de serveur supplémentaire qui examine le jeton et détermine s'il doit utiliser le SDK Firebase ou le SDK Identity Toolkit pour valider le jeton. Si vous ne possédez qu'une application Web, toutes les nouvelles demandes d'authentification seront transférées vers Identity Platform. Vous n'aurez donc qu'à utiliser les méthodes de validation des jetons d'ID.

Consultez la documentation de référence de l'API Web.

Étape 2 : Mettez à jour votre code HTML

  1. Ajoutez le code d'initialisation à votre application :

    1. Ouvrez votre projet dans la console Cloud.
    2. Sur la page Fournisseurs, cliquez sur Informations sur la configuration de l'application. Un extrait de code qui initialise Identity Platform s'affiche.
    3. Copiez et collez l'extrait d'initialisation sur votre page Web.

  2. Ajoutez le widget d'authentification à votre application :

    <script src="https://www.gstatic.com/firebasejs/ui/live/0.4/firebase-ui-auth.js"></script>
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/live/0.4/firebase-ui-auth.css" />
<!-- *******************************************************************************************
   * TODO(DEVELOPER): Paste the initialization snippet from:
   * Firebase Console > Overview > Add Firebase to your web app. *
   ***************************************************************************************** -->
<script type="text/javascript">
  // FirebaseUI config.
  var uiConfig = {
    'signInSuccessUrl': '<url-to-redirect-to-on-success>',
    'signInOptions': [
      // Leave the lines as is for the providers you want to offer your users.
      firebase.auth.GoogleAuthProvider.PROVIDER_ID,
      firebase.auth.FacebookAuthProvider.PROVIDER_ID,
      firebase.auth.TwitterAuthProvider.PROVIDER_ID,
      firebase.auth.GithubAuthProvider.PROVIDER_ID,
      firebase.auth.EmailAuthProvider.PROVIDER_ID
    ],
    // Terms of service url.
    'tosUrl': '<your-tos-url>',
  };

  // Initialize the FirebaseUI Widget using Firebase.
  var ui = new firebaseui.auth.AuthUI(firebase.auth());
  // The start method will wait until the DOM is loaded.
  ui.start('#firebaseui-auth-container', uiConfig);
</script>

  3. Supprimez le SDK Identity Toolkit de votre application.

  4. Si vous vous êtes appuyé sur le jeton d'identité Identity Toolkit pour la gestion des sessions, vous devez apporter les modifications suivantes côté client :

    1. Une fois la connexion réussie avec Identity Platform, obtenez un jeton d'identité en appelant firebase.auth().currentUser.getToken().

    2. Envoyez le jeton d'identité au serveur backend, validez-le et émettez votre propre cookie de session.

      Ne vous fiez pas uniquement au cookie de session lorsque vous effectuez des opérations sensibles ou que vous envoyez des requêtes de modification authentifiées à votre serveur. Vous devrez fournir une protection supplémentaire contre la contrefaçon de requêtes intersites (CSRF).

      Si votre framework ne fournit pas de protection CSRF, une façon d'empêcher une attaque consiste à obtenir un jeton d'identité pour l'utilisateur connecté avec getToken() et à inclure le jeton dans chaque requête (le cookie de session sera également envoyé par défaut). Vous validerez ensuite ce jeton à l'aide de l'Admin SDK en plus de la vérification du cookie de session effectuée par votre framework de backend. Il sera ainsi plus difficile pour les attaques CSRF de réussir, car le jeton d'identité n'est stocké qu'à l'aide du stockage Web et jamais dans un cookie.

    3. Les jetons Identity Toolkit sont valides pendant deux semaines. Vous pouvez continuer à émettre des jetons valables deux semaines, ou vous pouvez les rendre plus ou moins longs en fonction des exigences de sécurité de votre application. Lorsque l'utilisateur se déconnecte, effacez le cookie de session.

Étape 3 : Mettez à jour les URL de redirection de l'IdP

  1. Dans la console Cloud, ouvrez la section Fournisseurs.

  2. Pour chaque fournisseur de connexion fédérée que vous acceptez, procédez comme suit :

    1. Cliquez sur le nom du fournisseur d'identité.
    2. Copiez l'URI de redirection OAuth.
    3. Dans la console pour les développeurs du fournisseur d'identité, mettez à jour l'URI de redirection OAuth.

Android

Étape 1 : Ajoutez Identity Platform à votre application avec Firebase

  1. Ouvrez la console Cloud et sélectionnez votre projet Identity Toolkit.

  2. Sur la page "Fournisseurs", cliquez sur Informations sur la configuration de l'application, sélectionnez l'onglet Android, puis cliquez sur Premiers pas dans Firebase. Dans la boîte de dialogue "Ajouter Firebase", indiquez le nom du package et l'empreinte du certificat de signature de votre application, puis cliquez sur Ajouter une application. Le fichier de configuration google-services.json est alors téléchargé sur votre ordinateur.

  3. Copiez le fichier de configuration dans le répertoire racine du module de votre application Android. Ce fichier de configuration contient des informations sur le projet et le client Google OAuth.

  4. Dans le fichier build.gradle au niveau du projet (<var>your-project</var>/build.gradle), spécifiez le nom du package de votre application dans la section defaultConfig :

    defaultConfig {
   …..
  applicationId "com.your-app"
}

  5. Toujours dans le fichier build.gradle au niveau du projet, ajoutez une dépendance pour inclure le plug-in google-services :

    buildscript {
 dependencies {
   // Add this line
   classpath 'com.google.gms:google-services:3.0.0'
 }
}

  6. Dans le fichier build.gradle au niveau de l'application (<var>my-project</var>/<var>app-module</var>/build.gradle), ajoutez la ligne suivante après le plug-in Android Gradle pour activer le plug-in google-services :

    apply plugin: 'com.android.application'
// Add this line
apply plugin: 'com.google.gms.google-services'

    Le plug-in google-services utilise le fichier google-services.json pour configurer votre application afin qu'elle utilise Firebase.

  7. Dans le fichier build.gradle au niveau de l'application, ajoutez également la dépendance Firebase Authentication :

    compile 'com.google.firebase:firebase-auth:24.0.1'
compile 'com.google.android.gms:play-services-auth:21.4.0'

Étape 2 : Supprimez le SDK Identity Toolkit

  1. Supprimez la configuration Identity Toolkit du fichier AndroidManifest.xml. Ces informations sont incluses dans le fichier google-service.json et chargées par le plug-in google-services.
  2. Supprimez le SDK Identity Toolkit de votre application.

Étape 3 : Ajouter FirebaseUI à votre application

  1. Ajoutez FirebaseUI Auth à votre application.

  2. Dans votre application, remplacez les appels au SDK Identity Toolkit par des appels à FirebaseUI.

iOS

Étape 1 : Ajouter Firebase à votre application

  1. Ajoutez le SDK client à votre application en exécutant les commandes suivantes :

    $ cd your-project directory
$ pod init
$ pod 'Firebase'

  2. Ouvrez la console Cloud et sélectionnez votre projet Identity Toolkit.

  3. Sur la page "Fournisseurs", cliquez sur Détails de configuration de l'application, sélectionnez l'onglet iOS, puis cliquez sur Commencer dans Firebase. Dans la boîte de dialogue "Ajouter Firebase", indiquez le nom du package et l'empreinte du certificat de signature de votre application, puis cliquez sur Ajouter une application. Le fichier de configuration google-services.json est alors téléchargé sur votre ordinateur. Dans la boîte de dialogue "Ajouter Firebase", indiquez l'ID du bundle et l'ID de l'App Store de votre application, puis cliquez sur Ajouter l'application. Le fichier de configuration GoogleService-Info.plist est alors téléchargé sur votre ordinateur. Si votre projet comporte plusieurs ID de bundle, chacun d'eux doit être associé dans la console Firebase pour pouvoir disposer de son propre fichier GoogleService-Info.plist.

  4. Copiez le fichier de configuration à la racine de votre projet Xcode et ajoutez-le à toutes les cibles.

Étape 2 : Supprimez le SDK Identity Toolkit

  1. Supprimez GoogleIdentityToolkit du fichier Podfile de votre application.
  2. Exécutez la commande pod install.

Étape 3 : Ajouter FirebaseUI à votre application

  1. Ajoutez FirebaseUI Auth à votre application.

  2. Dans votre application, remplacez les appels au SDK Identity Toolkit par des appels à FirebaseUI.