Utiliser App Check avec le fournisseur de débogage dans les applications Web

Si, après avoir enregistré votre application pour App Check, vous souhaitez exécuter votre application dans un environnement qu'App Check ne classerait normalement pas comme valide, comme localement pendant le développement ou à partir d'un environnement d'intégration continue (CI), vous pouvez créer une version de débogage de votre application qui utilise le fournisseur de débogage App Check au lieu d'un véritable fournisseur d'attestation.

Avertissement : Le fournisseur de débogage autorise l'accès à vos ressources Firebase à partir d'appareils non vérifiés. N'utilisez pas le fournisseur de débogage dans les versions de production de votre application et ne partagez pas vos versions de débogage avec des parties non approuvées.

Utiliser le fournisseur de débogage sur localhost

Pour utiliser le fournisseur de débogage lors de l'exécution de votre application à partir de localhost (pendant le développement, par exemple), procédez comme suit :

Avertissement : N'essayez pas d'activer le débogage localhost en ajoutant localhost aux domaines autorisés de reCAPTCHA. Cela permettrait à n'importe qui d'exécuter votre application à partir de ses machines locales !

1. Dans votre version de débogage, activez le mode débogage en définissant self.FIREBASE_APPCHECK_DEBUG_TOKEN sur true avant d'initialiser App Check. Par example:

   Web version 9

   self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
   initializeAppCheck(app, { /* App Check options */ });
   

   Web version 8

   self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
   firebase.appCheck().activate(/* site key or provider */);
   

   Remarque : Dans les versions du SDK Web Firebase antérieures à la v9, self.FIREBASE_APPCHECK_DEBUG_TOKEN est lu au moment de l'importation, et non au moment de l'initialisation/activation. Cela nécessitait qu'il soit défini dans index.html avant le chargement du groupe de codes. Pour éviter cette restriction, effectuez une mise à niveau vers la v9.

2. Visitez votre application Web localement et ouvrez l'outil de développement du navigateur. Dans la console de débogage, vous verrez un jeton de débogage :

   AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678". You will
   need to safelist it in the Firebase console for it to work.

3. Dans la section App Check de la console Firebase, choisissez Gérer les jetons de débogage dans le menu de débordement de votre application. Ensuite, enregistrez le jeton de débogage que vous avez connecté à l'étape précédente.

   

Après avoir enregistré le jeton, les services backend Firebase l'accepteront comme valide.

Étant donné que ce jeton permet d'accéder à vos ressources Firebase sans appareil valide, il est essentiel que vous le gardiez privé. Ne le validez pas dans un référentiel public et si un jeton enregistré est compromis, révoquez-le immédiatement dans la console Firebase.

Ce jeton est stocké localement dans votre navigateur et sera utilisé chaque fois que vous utiliserez votre application dans le même navigateur sur la même machine. Si vous souhaitez utiliser le jeton dans un autre navigateur ou sur une autre machine, définissez self.FIREBASE_APPCHECK_DEBUG_TOKEN sur la chaîne du jeton au lieu de true .

Utiliser le fournisseur de débogage dans un environnement CI

Pour utiliser le fournisseur de débogage dans un environnement d'intégration continue (CI), procédez comme suit :

1. Dans la section App Check de la console Firebase, choisissez Gérer les jetons de débogage dans le menu de débordement de votre application. Ensuite, créez un nouveau jeton de débogage. Vous aurez besoin du jeton à l'étape suivante.

   Étant donné que ce jeton permet d'accéder à vos ressources Firebase sans appareil valide, il est essentiel que vous le gardiez privé. Ne le validez pas dans un référentiel public et si un jeton enregistré est compromis, révoquez-le immédiatement dans la console Firebase.

   

2. Ajoutez le jeton de débogage que vous venez de créer au magasin de clés sécurisé de votre système CI (par exemple, les secrets chiffrés de GitHub Actions ou les variables chiffrées de Travis CI).

3. Si nécessaire, configurez votre système CI pour rendre votre jeton de débogage disponible dans l'environnement CI en tant que variable d'environnement. Nommez la variable quelque chose comme APP_CHECK_DEBUG_TOKEN_FROM_CI .

4. Dans votre version de débogage, activez le mode débogage en définissant self.FIREBASE_APPCHECK_DEBUG_TOKEN sur la valeur de la variable d'environnement du jeton de débogage avant d'importer App Check. Par example:

   Web version 9

   self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
   initializeAppCheck(app, { /* App Check options */ });
   

   Web version 8

   self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
   firebase.appCheck().activate(/* site key or provider */);
   

Lorsque votre application s'exécute dans un environnement CI, les services de backend Firebase acceptent le jeton qu'il envoie comme valide.