Intégrer Identity Platform à l'API reCAPTCHA Enterprise

Fournisseur de messagerie-mot de passe

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

Mode d'audit

Lorsque vous définissez l'application de l'authentification par e-mail et mot de passe en mode audit, Identity Platform crée une ou plusieurs clés reCAPTCHA dans votre projet, qui 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 de reCAPTCHA.

Mode d'application forcée

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

Fournisseur de téléphonie

Les modes d'audit et d'application forcée se comportent comme suit pour les flux d'authentification par téléphone.

Mode d'audit

Lorsque vous définissez l'application de l'authentification par téléphone en mode d'audit, Identity Platform utilise la protection contre les robots reCAPTCHA pour la validation des applications. Si la requête de l'utilisateur passe l'évaluation de la protection contre les robots, Identity Platform envoie un message SMS contenant un code de validation sur le téléphone de l'utilisateur. Si l'évaluation de la protection contre les robots échoue pour une requête et que vous utilisez le SDK client, des méthodes de validation de remplacement sont déclenchées pour terminer le flux d'authentification par téléphone. Les méthodes de remplacement acceptées dépendent de la plate-forme de votre application.

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

• Le jeton reCAPTCHA est manquant.
• Le jeton reCAPTCHA n'est pas valide ou a expiré.
• Le score du jeton reCAPTCHA n'atteint pas le seuil.
• reCAPTCHA n'est pas configuré correctement.

Assurez-vous que les méthodes de validation de remplacement 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 d'application forcée

Lorsque vous définissez l'application de l'authentification par téléphone sur le mode forcé, Identity Platform utilise la protection contre les robots reCAPTCHA pour la validation des applications. Si la requête de l'utilisateur passe l'évaluation de la protection contre les robots, Identity Platform envoie un message SMS contenant un code de validation sur le téléphone de l'utilisateur. Si l'évaluation de la protection contre les robots échoue, Identity Platform bloque la requête et n'envoie pas de message SMS contenant un code de validation.

Aucune vérification de remplacement n'est requise en mode d'application, vous n'avez pas besoin de configurer de méthodes de validation supplémentaires pour votre application. Toutefois, nous vous recommandons de configurer le vérificateur reCAPTCHA pour les applications Web afin de vous assurer que reCAPTCHA v2 est activé si vous décidez de définir le mode reCAPTCHA de votre application sur AUDIT ou OFF.

Fournisseur de messagerie-mot de passe

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

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

2. Pour activer la protection contre les robots pour un projet, utilisez le SDK Admin. La prise en charge de 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 la section Modes de protection contre les bots reCAPTCHA.
   • 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 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 inférieur. 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 tenant à 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 du 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 de la règle sur le mode d'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.

Fournisseur de téléphonie

Pour activer la protection contre les bots reCAPTCHA 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 dans votre projet.

2. Pour activer la protection contre les robots pour un projet, utilisez le SDK Admin. La prise en charge de reCAPTCHA est disponible sur 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 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 la section Modes de protection contre les bots reCAPTCHA.

   • 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 entre 0.0 et 1.0. Par exemple, si vous définissez un seuil de 0.6, reCAPTCHA refusera toute requête avec un score de 0.5 ou inférieur. Par conséquent, plus vous définissez le score plus é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 tenant à 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 du 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 de la règle sur le mode d'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 pour les versions 11 et ultérieures du SDK JavaScript.

   Une fois le SDK Web intégré à 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. Passez à la dernière version du SDK Android. La prise en charge de reCAPTCHA pour l'authentification par e-mail et mot de passe, ainsi que pour l'authentification par téléphone dans les applications Android, est disponible à partir de la version 23.1.0 du SDK Android.

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

   Une fois que vous avez intégré le SDK Android à votre application, le SDK 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 de votre fichier build.gradle au niveau de l'application:

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

   Veillez à 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 iOS reCAPTCHA à 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 > Association 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 de messagerie-mot de passe

Pour appliquer reCAPTCHA aux flux d'authentification par e-mail et mot de passe d'un projet ou d'un locataire, utilisez le SDK Admin pour exécuter les opérations suivantes:

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

Fournisseur de téléphonie

Pour activer l'application de reCAPTCHA pour les flux d'authentification par SMS sur un projet ou un locataire, utilisez le SDK Admin pour exécuter les opérations suivantes:

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

Fournisseur de messagerie-mot de passe

Pour désactiver la protection contre les bots pour les flux d'authentification par e-mail et mot de passe, exécutez la commande suivante à l'aide du SDK Admin:

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

Fournisseur de téléphonie

Pour désactiver la protection contre les robots pour les flux d'authentification par SMS, exécutez la commande suivante à l'aide du SDK Admin:

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