Effectuer une migration de Google Identity Toolkit vers Firebase Authentication

La dernière version de Google Identity Toolkit est disponible sous le nom de Firebase Authentication. À l'avenir, le développement de fonctionnalités sur Identity Toolkit sera gelé, et toutes les nouvelles fonctionnalités seront développées sur Firebase Authentication. Nous encourageons les développeurs Identity Toolkit à passer à Firebase Authentication dès que cela est possible pour leurs applications. Toutefois, Identity Toolkit continue de fonctionner et ne sera pas abandonné sans autre annonce.

Nouvelles fonctionnalités

Firebase Authentication propose déjà des fonctionnalités améliorées par rapport à Google Identity Toolkit:

  • 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 est composé de fonctionnalités complémentaires que vous pouvez combiner selon vos besoins. Il inclut une infrastructure pour les données analytiques mobiles, la messagerie cloud, Realtime Database, le stockage de fichiers, l'hébergement statique, la configuration à distance, les rapports d'erreurs mobiles et les tests Android.

  • UI mises à jour

    Nous avons complètement reconstruit les flux d'UI en nous basant sur les dernières recherches UX de Google. Cela inclut la récupération de mot de passe, l'association de comptes, les flux de déambiguï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é les conversions de connexion et d'inscription pour les applications participantes. Il permet également de modifier facilement le thème pour qu'il corresponde à votre application. Pour une personnalisation maximale, les versions Android et iOS sont Open Source.

  • Configuration simplifiée du serveur

    Nous avons facilité l'utilisation de Firebase Authentication pour les développeurs. Avec Identity Toolkit, nous avons constaté que de nombreux développeurs choisissaient de ne pas implémenter le flux de récupération par e-mail, ce qui empêchait leurs utilisateurs de récupérer leur compte s'ils avaient oublié leur mot de passe. Firebase Authentication peut envoyer des messages de validation de l'adresse e-mail, de réinitialisation du mot de passe et de modification du 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'interface utilisateur pour héberger les redirections et effectuer les opérations de modification de mot de passe.

  • Nouvelle console d'administration

    Firebase dispose d'une nouvelle console pour les développeurs. La section "Authentification" vous permet d'afficher, de modifier et de supprimer vos utilisateurs. Cela peut vous aider à 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.

  • Nouveaux SDK

    Toutes les API de serveur d'Identity Toolkit sont désormais disponibles en mode natif avec chacune de nos bibliothèques clientes (Android, iOS, Web). Les développeurs pourront se connecter et enregistrer de nouveaux utilisateurs, accéder aux propriétés utilisateur, associer, mettre à jour et supprimer des comptes, réinitialiser des mots de passe, etc., sans être liés à une UI fixe. Si vous préférez, vous pouvez créer manuellement l'intégralité de votre flux et de votre expérience de connexion sur 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. Firebase Auth utilise un service backend qui prend un jeton d'actualisation, créé à 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 s'authentifie de nouveau sur cet appareil.

  • Authentification anonyme et GitHub

    Firebase Authentication prend en charge deux nouveaux types d'authentification: GitHub et anonyme. La connexion anonyme permet de créer un ID utilisateur unique sans que l'utilisateur ait à passer par un processus de connexion ou d'inscription. Avec un utilisateur anonyme, vous pouvez désormais effectuer des appels d'API authentifiés, comme vous le feriez avec un utilisateur standard. Lorsque l'utilisateur décide de créer un compte, toutes les activités sont conservées avec le même ID utilisateur. Cela est idéal pour les situations telles qu'un panier côté serveur ou toute application dans laquelle vous souhaitez engager l'utilisateur avant de l'envoyer dans un flux d'inscription.

Différences de fonctionnalités

Certaines fonctionnalités d'Identity Toolkit ne sont actuellement pas disponibles dans Firebase Authentication, 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 peuvent ne pas être importantes pour votre application ou il peut exister des solutions de remplacement simples qui vous permettront de procéder à la migration.

Différences côté serveur

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

  • Fournisseurs d'identité

    PayPal et AOL ne sont pas acceptés. Les utilisateurs disposant de comptes issus de ces IDP peuvent toujours se connecter à votre application via le parcours de récupération de mot de passe et configurer un mot de passe pour leur compte.

  • Bibliothèques de serveurs

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

  • E-mails de gestion de compte

    Les messages de réinitialisation de 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 par le propre serveur de messagerie du développeur. Actuellement, les modèles d'e-mails Firebase ne proposent qu'une personnalisation limitée.

  • Confirmation de changement d'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 de l'adresse e-mail.

    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 le changement.

  • Déploiement des fournisseurs d'identité

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

Différences côté client

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

  • SDK Firebase Authentication

    Dans Firebase Authentication, les fonctionnalités fournies par l'API REST d'Identity Toolkit ont été empaquetées dans des SDK client disponibles pour Android, iOS et JavaScript. Vous pouvez utiliser le SDK pour connecter et enregistrer des utilisateurs, accéder aux informations de profil utilisateur, 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 backend via des appels REST.

  • Authentification FirebaseUI

    Tous les flux d'UI qui gèrent la connexion, l'inscription, la récupération de mot de passe et l'association de comptes ont été restructurés à l'aide des SDK Firebase Authentication. Ils sont disponibles en tant que SDK Open Source pour iOS et Android, ce qui vous permet de personnaliser complètement les flux de manière impossible avec Identity Toolkit.

Voici d'autres différences:

  • Sessions et migration

    Étant donné que les sessions sont gérées différemment dans Identity Kit et Firebase Authentication, les sessions existantes de vos utilisateurs seront arrêtées lors de la mise à niveau du SDK, et vos utilisateurs devront se reconnecter.

Avant de commencer

Avant de pouvoir passer d'Identity Toolkit à Firebase Authentication, vous devez :

  1. Ouvrez la console Firebase, cliquez sur Importer un projet Google, puis sélectionnez votre projet Identity Toolkit.

  2. Cliquez sur  > Autorisations pour ouvrir la page "IAM et administration".

  3. Ouvrez la Comptes de service. Vous pouvez y voir le compte de service que vous avez précédemment configuré 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é pour vous. Vous en aurez besoin pour initialiser le SDK à l'étape suivante.

  5. Revenez à la console Firebase. Dans la section "Authentification", ouvrez la page Modèles d'e-mails. Sur cette page, personnalisez les modèles d'e-mails de votre application.

    Dans Identity Toolkit, lorsque les utilisateurs réinitialisent leurs mots de passe, modifient leurs adresses e-mail et valident leurs adresses e-mail, vous devez obtenir un code hors bande auprès du serveur Identity Toolkit, puis l'envoyer aux utilisateurs par e-mail. Firebase 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 Firebase sur votre serveur, installez le SDK Firebase.

    1. Vous pouvez installer le module Node.js Firebase avec npm:

      $ npm init
      $ npm install --save firebase-admin
      
    2. Dans votre code, vous pouvez accéder à Firebase à l'aide des éléments suivants:

      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

Modifications notables

L'implémentation Web de Firebase présente un certain nombre de différences supplémentaires 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 démarrer la session. La durée de vie de ce cookie était de deux semaines. Il 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 requêtes de page 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 Firebase gèrent désormais les jetons d'identification Firebase et fonctionnent avec le backend de Firebase Authentication pour maintenir la session à jour. Le backend expire les sessions lorsque des modifications importantes du compte (telles que la modification du mot de passe de l'utilisateur) ont été apportées. Les jetons d'identification Firebase ne sont pas automatiquement définis en tant que 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'identification Firebase ne sont pas adaptés à l'utilisation en tant que cookie pour valider toutes vos requêtes de page. Vous devrez plutôt configurer un écouteur pour la connexion de l'utilisateur, obtenir le jeton d'identification Firebase, 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 au début de la connexion pour connaître l'identifiant qu'ils souhaitaient utiliser. Le flux de l'UI Firebase Auth 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'interface utilisateur de Firebase. Cela facilitera la prise en charge des utilisateurs anonymes, des utilisateurs d'authentification personnalisée ou des utilisateurs de fournisseurs pour lesquels les adresses e-mail ne sont pas obligatoires.

  • Widget de gestion des comptes

    Ce widget fournit une UI permettant aux utilisateurs de modifier leurs adresses e-mail, leur mot de passe ou de dissocier leurs comptes des fournisseurs d'identité. Il 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. Ils peuvent être créés très facilement à l'aide de l'API Firebase Authentication.

  • Aucune valeur signOutUrl

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

  • Aucun oobActionUrl

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

  • Personnalisation CSS

    FirebaseUI 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 (valide pendant deux semaines) pour gérer les sessions des utilisateurs Web, vous devez le convertir pour qu'il utilise son propre cookie de session.

    1. Implémentez un point de terminaison pour valider le jeton d'identification Firebase 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 requête comme non authentifiée.
    3. Si vous ne voulez pas que vos utilisateurs perdent leurs sessions de connexion existantes, vous devez attendre deux semaines pour que tous les jetons Identity Toolkit expirent, ou effectuer également la validation à double jeton pour votre application Web, comme décrit ci-dessous à l'étape 3.
  2. Ensuite, comme les jetons Firebase sont différents des jetons Identity Toolkit, vous devez mettre à jour votre logique de validation des jetons. Installez le SDK Firebase Server sur votre serveur. Si vous utilisez une langue non prise en charge par le SDK Firebase Server, 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, il est possible que des chemins de code continuent de dépendre 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 du serveur supplémentaire qui examine le jeton et détermine s'il doit utiliser le SDK Firebase ou le SDK Identity Toolkit pour le valider. Si vous ne disposez que d'une application Web, toutes les nouvelles requêtes d'authentification seront transférées vers Firebase. Par conséquent, vous n'avez qu'à utiliser les méthodes de validation des jetons Firebase.

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

Étape 2: Mettez à jour votre code HTML

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

    1. Ouvrez votre projet dans la console Firebase.
    2. Sur la page "Overview" (Vue d'ensemble), cliquez sur Add App (Ajouter une application), puis sur Add Firebase to your web app (Ajouter Firebase à votre application Web). Un extrait de code qui initialise Firebase s'affiche.
    3. Copiez et collez l'extrait d'initialisation dans votre page Web.
  2. Ajoutez FirebaseUI Auth à 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 appuyiez sur le jeton d'identité Identity Toolkit pour la gestion des sessions, vous devez apporter les modifications suivantes côté client:

    1. Une fois connecté avec Firebase, obtenez un jeton d'ID Firebase en appelant firebase.auth().currentUser.getToken().

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

      Ne vous appuyez pas uniquement sur le 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 falsification de requêtes intersites (CSRF).

      Si votre framework ne fournit pas de protection contre les attaques CSRF, une façon d'empêcher une attaque consiste à obtenir un jeton d'ID Firebase pour l'utilisateur connecté avec getToken() et à inclure le jeton avec chaque requête (le cookie de session sera également envoyé par défaut). Vous devez ensuite valider ce jeton à l'aide du SDK de serveur Firebase en plus de la vérification du cookie de session, que votre framework backend a effectuée. Cela rend les attaques CSRF plus difficiles à réussir, car le jeton d'ID Firebase 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 qui durent deux semaines, ou vous pouvez les rendre plus longs ou plus courts en fonction des exigences de sécurité de votre application. Lorsqu'un utilisateur se déconnecte, effacez le cookie de session.

Étape 3: Mettre à jour les URL de redirection de l'IDP

  1. Dans la console Firebase, ouvrez la section "Authentication" (Authentification) et cliquez sur l'onglet "Sign-in Method" (Méthode de connexion).

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

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

Android

Étape 1: Ajoutez Firebase à votre application

  1. Ouvrez la console Firebase, puis sélectionnez votre projet Identity Toolkit, que vous avez déjà importé.

  2. Sur la page "Vue d'ensemble", cliquez sur Ajouter une application, puis sur Ajouter Firebase à votre application Android. 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 ensuite 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 votre fichier build.gradle de niveau 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. Dans le fichier build.gradle au niveau du projet, ajoutez également 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) de votre application, ajoutez la ligne suivante en bas pour activer le plug-in google-services:

    // Add to the bottom of the file
    apply plugin: 'com.google.gms.google-services'
    

    Le plug-in google-services utilise le fichier google-services.json pour configurer votre application pour 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:23.1.0'
    compile 'com.google.android.gms:play-services-auth:21.3.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: Ajoutez 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: Ajoutez Firebase à votre application

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

    $ cd your-project directory
    $ pod init
    $ pod 'Firebase'
    
  2. Ouvrez la console Firebase, puis sélectionnez votre projet Identity Toolkit, que vous avez déjà importé.

  3. Sur la page "Vue d'ensemble", cliquez sur Ajouter une application, puis sur Ajouter Firebase à votre application iOS. Dans la boîte de dialogue "Ajouter Firebase", indiquez l'ID de bundle et l'ID App Store de votre application, puis cliquez sur Ajouter une application. Le fichier de configuration GoogleService-Info.plist est ensuite téléchargé sur votre ordinateur. Si votre projet contient plusieurs ID de bundle, chacun d'eux doit être associé dans la console Firebase afin de pouvoir disposer de son propre fichier GoogleService-Info.plist.

  4. Copiez le fichier de configuration à la racine de votre projet Xcode, puis 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: Ajoutez FirebaseUI à votre application

  1. Ajoutez FirebaseUI Auth à votre application.

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