Intégrer Identity Platform à l'API reCAPTCHA Enterprise

Fournisseur d'adresse e-mail et de mot de passe

Les modes Audit et Appliquer se comportent comme suit pour les flux d'authentification par adresse e-mail et mot de passe.

Mode Audit

Lorsque vous définissez l'application du mot de passe/e-mail sur le mode audit, Identity Platform crée une ou plusieurs clés reCAPTCHA dans votre projet. Ces clés sont utilisées pour évaluer le trafic vers les API Identity Platform sans bloquer aucune requête. Utilisez les métriques émises en mode audit pour déterminer si vous devez activer l'application reCAPTCHA.

Mode application forcée

Lorsque vous définissez l'application de l'authentification par e-mail et mot de passe sur le mode "Appliquer", Identity Platform crée une ou plusieurs clés reCAPTCHA dans votre projet. Ces clés servent à évaluer le trafic vers les API Identity Platform. Les requêtes API qui n'incluent pas de jeton reCAPTCHA sont rejetées. N'activez l'application qu'après avoir migré tous vos clients vers un SDK compatible avec reCAPTCHA.

Opérateur téléphonique

Les modes "Audit" et "Appliquer" se comportent comme suit pour les flux d'authentification par téléphone.

Mode Audit

Lorsque vous définissez l'application de l'authentification par téléphone sur le mode audit, Identity Platform utilise la protection reCAPTCHA contre les robots pour la validation des applications. Si la demande d'un utilisateur réussit l'évaluation concernant la fraude à la facturation par l'opérateur, un code de validation par SMS est envoyé. Si la demande d'un utilisateur échoue à l'évaluation concernant la fraude à la facturation par l'opérateur et que vous utilisez le SDK client, Identity Platform déclenche des méthodes de validation de secours pour terminer le flux d'authentification par téléphone. Les méthodes de secours acceptées dépendent de la plate-forme de votre application.

Le SDK client déclenche les méthodes de validation de secours dans les scénarios suivants :

• Le jeton reCAPTCHA est manquant.
• Le jeton reCAPTCHA n'est pas valide ou a expiré.
• Le jeton reCAPTCHA ne dépasse pas le seuil de score.
• reCAPTCHA n'est pas configuré correctement.

Assurez-vous que les méthodes de validation de secours pour la plate-forme de votre application sont configurées et prêtes à être déclenchées par le SDK client si nécessaire.

Mode application forcée

Lorsque vous définissez l'application de l'authentification par téléphone sur le mode "Appliquer", Identity Platform utilise la protection reCAPTCHA contre les robots pour la validation des applications. Si la demande d'un utilisateur réussit l'évaluation concernant la fraude à la facturation par l'opérateur, un code de validation par SMS est envoyé. Si la demande d'un utilisateur échoue à l'évaluation concernant la fraude à la facturation par l'opérateur, Identity Platform bloque la demande et n'envoie pas de message SMS contenant un code de validation.

Aucune validation de secours n'est requise en mode "Appliquer". Vous n'avez pas besoin de configurer de méthodes de validation supplémentaires pour votre application. Toutefois, nous vous recommandons de configurer un outil de vérification reCAPTCHA pour les applications Web afin de vous assurer que reCAPTCHA v2 est activé si vous décidez de passer au mode reCAPTCHA AUDIT ou OFF pour votre application.

Fournisseur d'adresse e-mail et de mot de passe

Pour activer la protection reCAPTCHA contre les robots pour les flux d'authentification par adresse e-mail et mot de passe, procédez comme suit :

1. Si vous ne l'avez pas déjà fait, activez l'API reCAPTCHA Enterprise sur votre projet.

2. Pour activer la protection contre les robots pour un projet, utilisez le SDK Admin. La compatibilité avec reCAPTCHA est disponible sur les versions 11.7.0 et ultérieures du SDK Admin Node.js.

   Exemple :

   // Update project config with reCAPTCHA config
   const updateConfigRequest = {
     recaptchaConfig: {
       emailPasswordEnforcementState:  'ENFORCE_MODE',
       managedRules: [{
         endScore: END_SCORE,
         action: 'BLOCK'
       }]
     }
   };
   const updateProjectConfigWithRecaptcha = () => {
     getAuth().projectConfigManager().updateProjectConfig(updateConfigRequest).then((response) => {
       console.log('Updated reCAPTCHA config for project: ', response.recaptchaConfig);
     }).catch((error) => {
       console.log('Error updating project config:', error);
     });
   }
   

   Remplacez les éléments suivants :

   • ENFORCE_MODE : mode que vous souhaitez définir pour l'application de l'authentification reCAPTCHA par e-mail et mot de passe. Les valeurs valides sont OFF, AUDIT et ENFORCE. Pour activer la protection contre les robots, ce paramètre doit être défini sur AUDIT ou ENFORCE. Lorsque vous activez la protection contre les robots pour la première fois, nous vous recommandons de définir ce paramètre sur AUDIT et de vous assurer que vos flux d'authentification sont protégés avant de le définir sur ENFORCE. Pour en savoir plus sur le fonctionnement des modes, consultez Modes de protection reCAPTCHA contre les robots.
   • END_SCORE : score d'évaluation de la protection contre les robots le plus bas qu'une requête peut avoir avant d'échouer. Vous pouvez définir ce score sur une valeur comprise entre 0.0 et 1.0. Par exemple, si vous définissez un seuil de 0.6, reCAPTCHA échouera pour toute requête avec un score de 0.5 ou moins. Par conséquent, plus vous définissez un score élevé, plus les règles seront strictes.

   Vous pouvez également activer la protection contre les robots avec la même méthode de configuration pour un locataire à l'aide du SDK Admin. Pour en savoir plus sur la mise à jour d'un locataire, consultez Mettre à jour un locataire.

3. Si vous utilisez Identity Platform sur iOS ou Android, vous devez enregistrer votre application depuis la console Firebase :

   • Pour iOS, enregistrez chaque ID de bundle qui utilise Identity Platform.
   • Pour Android, enregistrez chaque nom de package Android qui utilise Identity Platform.

   Si vous utilisez Identity Platform sur le Web, vous devez ajouter un domaine autorisé pour chaque domaine qui utilise reCAPTCHA. Pour ajouter des domaines autorisés, procédez comme suit :

   1. Dans la console Google Cloud , accédez à la page Identity Platform.

      Accéder à Identity Platform

   2. Accédez à Paramètres > Sécurité.

   3. Cliquez sur Ajouter un domaine.

   4. Saisissez le nom de domaine, puis cliquez sur Ajouter pour l'enregistrer.

   Le provisionnement des clés reCAPTCHA peut prendre plusieurs minutes.

4. Si vous avez défini l'application en mode audit, nous vous recommandons de surveiller les métriques reCAPTCHA pour la protection contre les robots afin de vous assurer que vos flux sont protégés.

Opérateur téléphonique

Pour activer la protection reCAPTCHA contre les robots pour les flux d'authentification par SMS, procédez comme suit :

1. Si vous ne l'avez pas déjà fait, activez l'API reCAPTCHA Enterprise sur votre projet.

2. Pour activer la protection contre les robots pour un projet, utilisez le SDK Admin. La compatibilité avec reCAPTCHA est disponible dans les versions 12.7.0 et ultérieures du SDK Admin Node.js.

   Exemple :

   // Update project config with reCAPTCHA config
   const updateProjectConfigRequest = {
     recaptchaConfig: {
       phoneEnforcementState: 'ENFORCE_MODE',
       managedRules: [{ endScore: END_SCORE, action: 'BLOCK' }],
       useSmsBotScore: 'true',
     }
   }
   let projectConfig = await getAuth().projectConfigManager().updateProject(updateProjectConfigRequest);
   

   Remplacez les éléments suivants :

   • ENFORCE_MODE : mode que vous souhaitez définir pour l'application forcée de l'authentification par téléphone reCAPTCHA. Les valeurs valides sont OFF, AUDIT et ENFORCE. Pour activer la protection contre les robots pour les flux basés sur les SMS, ce paramètre doit être défini sur AUDIT ou ENFORCE, et useSmsBotScore doit être défini sur true.

     Lorsque vous activez la protection contre les robots pour la première fois, nous vous recommandons de définir ce paramètre sur AUDIT et de vous assurer que vos flux d'authentification sont protégés avant de le définir sur ENFORCE. Pour en savoir plus sur le fonctionnement des modes, consultez Modes de protection reCAPTCHA contre les robots.

   • END_SCORE : score d'évaluation de la protection contre les robots le plus bas qu'une requête peut avoir avant d'échouer. Vous pouvez définir ce score sur une valeur comprise entre 0.0 et 1.0. Par exemple, si vous définissez un seuil de 0.6, reCAPTCHA échouera pour toute requête avec un score de 0.5 ou moins. Par conséquent, plus vous définissez un score élevé, plus les règles seront strictes.

   Vous pouvez également activer la protection contre les robots avec la même méthode de configuration pour un locataire à l'aide du SDK Admin. Pour en savoir plus sur la mise à jour d'un locataire, consultez Mettre à jour un locataire.

3. Si vous utilisez Identity Platform sur iOS ou Android, vous devez enregistrer votre application depuis la console Firebase :

   • Pour iOS, enregistrez chaque ID de bundle qui utilise Identity Platform.
   • Pour Android, enregistrez chaque nom de package Android qui utilise Identity Platform.

   Si vous utilisez Identity Platform sur le Web, vous devez ajouter un domaine autorisé pour chaque domaine qui utilise reCAPTCHA. Pour ajouter des domaines autorisés :

   1. Dans la console Google Cloud , accédez à la page Identity Platform.

      Accéder à Identity Platform

   2. Accédez à Paramètres > Sécurité.

   3. Cliquez sur Ajouter un domaine.

   4. Saisissez le nom de domaine, puis cliquez sur Ajouter pour l'enregistrer.

   Le provisionnement des clés reCAPTCHA peut prendre plusieurs minutes.

4. Si vous avez défini l'application en mode audit, nous vous recommandons de surveiller les métriques reCAPTCHA pour la protection contre les robots afin de vous assurer que vos flux sont protégés.

Web

1. Passez à la dernière version du SDK Web.

   • La compatibilité de reCAPTCHA avec l'authentification par e-mail et mot de passe dans les applications Web est disponible dans les versions 9.20.0 et ultérieures du SDK JavaScript.
   • La compatibilité de reCAPTCHA avec l'authentification par téléphone dans les applications Web est disponible dans les versions 11 et ultérieures du SDK JavaScript.

   Une fois que vous avez intégré le SDK Web à votre application, il récupère automatiquement votre configuration reCAPTCHA et active la protection pour les fournisseurs que vous avez configurés.

2. Si nécessaire, vous pouvez forcer la récupération du signal reCAPTCHA comme suit :

   import { initializeRecaptchaConfig } from '@firebase/auth';
   
   // Initialize Firebase Authentication
   const auth = getAuth();
   initializeRecaptchaConfig(auth)
     .then(() => {
       console.log("Recaptcha Enterprise Config Initialization successful.")
     })
     .catch((error) => {
       console.error("Recaptcha Enterprise Config Initialization failed with " + error)
     });
   

Android

1. Mettez à jour le SDK Android vers la dernière version. La compatibilité reCAPTCHA pour l'authentification par e-mail et mot de passe, ainsi que l'authentification par téléphone dans les applications Android, est disponible sur la version 23.1.0 et ultérieure du SDK Android.

   De plus, la compatibilité avec reCAPTCHA nécessite le niveau d'API 23 (Marshmallow) ou supérieur, et Android 6 ou version ultérieure.

   Une fois que vous avez intégré le SDK Android à votre application, il récupère automatiquement votre configuration reCAPTCHA et active la protection pour les fournisseurs que vous avez configurés.

2. Ajoutez la règle de compilation suivante à la section des dépendances du fichier build.gradle au niveau de l'application :

   implementation 'com.google.android.recaptcha:recaptcha:18.5.1'
   

   Assurez-vous d'utiliser le SDK reCAPTCHA version 18.5.1 ou ultérieure.

3. Si nécessaire, vous pouvez forcer la récupération du signal reCAPTCHA comme suit :

   • Kotlin :

   // Initialize Firebase Authentication
   auth = Firebase.auth
   
   auth.initializeRecaptchaConfig().addOnCompleteListener(this) { task ->
       if (task.isSuccessful) {
           Log.d(TAG, "Recaptcha Enterprise Initialization successful.")
       } else {
           Log.w(TAG, "Recaptcha Enterprise Initialization failed.")
       }
   }
   

   • Java :

   // Initialize Firebase Authentication
   auth = FirebaseAuth.getInstance();
   auth.initializeRecaptchaConfig().addOnCompleteListener(
     this, new OnCompleteListener<void>() {
     @Override
     public void onComplete(@NonNull Task<void> task) {
       if (task.isSuccessful()) {
         Log.d(TAG, "Recaptcha Enterprise Initialization successful.");
       } else {
         Log.w(TAG, "Recaptcha Enterprise Initialization failed.");
       }
     }
   });
   

iOS

1. Passez à la version 11.6.0 ou ultérieure du SDK iOS. Une fois que vous avez intégré le SDK iOS à votre application, il récupère automatiquement votre configuration reCAPTCHA et active la protection pour les fournisseurs que vous avez configurés.

2. Pour intégrer le SDK reCAPTCHA iOS à votre application, consultez Préparer votre environnement.

3. Assurez-vous que -ObjC est répertorié dans vos indicateurs de l'éditeur de liens. Accédez à Cible > Paramètres de compilation > Tous > Associer et vérifiez que Other Linker Flags affiche -ObjC.

4. Si nécessaire, vous pouvez forcer la récupération du signal reCAPTCHA comme suit :

   • Swift :

   // Initialize Firebase Authentication
   try await Auth.auth().initializeRecaptchaConfig()
   

   • Objective-C :

   // Initialize Firebase Authentication
   [[FIRAuth auth] initializeRecaptchaConfigWithCompletion:^(NSError * _Nullable error) {
     // Firebase Authentication initialization finished
   }];
   

Fournisseur d'adresse e-mail et de mot de passe

Pour activer l'application reCAPTCHA pour les flux d'authentification par e-mail et mot de passe sur un projet ou un locataire, utilisez le SDK Admin pour exécuter la commande suivante :

const enforceRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'ENFORCE',
    }]
  }
};

Opérateur téléphonique

Pour activer l'application reCAPTCHA pour les flux d'authentification par SMS sur un projet ou un locataire, utilisez le SDK Admin pour exécuter la commande suivante :

const enforceRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'ENFORCE',
    useSmsBotScore: 'true'
    }]
  }
};

Fournisseur d'adresse e-mail et de mot de passe

Pour désactiver la protection contre les robots pour les flux d'authentification par e-mail et mot de passe, utilisez le SDK Admin pour exécuter la commande suivante :

const disableRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'OFF',
  }
};

Opérateur téléphonique

Pour désactiver la protection contre les robots pour les flux d'authentification par SMS, utilisez le SDK Admin pour exécuter la commande suivante :

const disableRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'OFF',
    useSmsBotScore: 'false'
  }
};