Premiers pas avec App Check avec Play Integrity sur Android

Cette page explique comment activer App Check dans une application Android à l'aide du fournisseur Play Integrity intégré. Lorsque vous activez App Check, vous vous assurez que seule votre application peut accéder aux ressources Firebase de votre projet. Consultez la présentation de cette fonctionnalité.

Actuellement, le fournisseur Play Integrity intégré n'est compatible qu'avec les applications Android distribuées par Google Play. Pour utiliser les fonctionnalités hors Play d'intégrité Play ou pour utiliser App Check avec votre propre fournisseur personnalisé, consultez Implémenter un fournisseur App Check personnalisé.

1. Configurer votre projet Firebase

1. Ajoutez Firebase à votre projet Android si ce n'est pas déjà fait.

2. Activez l'API Play Integrity:

   1. Dans la Google Play Console, sélectionnez votre application ou ajoutez-la si vous ne l'avez pas déjà fait.

   2. Dans la section Release (Publier), cliquez sur App integrity (Intégrité de l'appli).

   3. Accédez à la section API Play Integrity de la page, cliquez sur Associer un projet Cloud, puis sélectionnez votre projet Firebase dans la liste des projets Google Cloud. Le projet que vous sélectionnez ici doit être le même projet Firebase que celui dans lequel vous enregistrez votre application (voir l'étape suivante).

3. Enregistrez vos applications pour qu'elles utilisent App Check avec le fournisseur Play Integrity dans la section App Check de la console Firebase. Vous devrez fournir l'empreinte SHA-256 du certificat de signature de votre application.

   Vous devez généralement enregistrer toutes les applications de votre projet. En effet, une fois que vous avez activé l'application pour un produit Firebase, seules les applications enregistrées peuvent accéder aux ressources backend du produit.

4. Facultatif : Dans les paramètres d'enregistrement de l'application, définissez une valeur TTL (Time To Live) personnalisée pour les jetons App Check émis par le fournisseur. Vous pouvez définir le TTL sur une valeur comprise entre 30 minutes et sept jours. Lorsque vous modifiez cette valeur, tenez compte des compromis suivants :

   • Sécurité: des TTL plus courts offrent une sécurité renforcée, car cela réduit la période pendant laquelle un jeton fuite ou intercepté peut être utilisé de manière abusive par un pirate informatique.
   • Performances : des TTL plus courts signifient que votre application effectuera des attestations plus fréquemment. Étant donné que le processus d'attestation d'application ajoute une latence aux requêtes réseau chaque fois qu'il est exécuté, un TTL court peut avoir un impact sur les performances de votre application.
   • Quota et coût : les TTL plus courts et les réattestations fréquentes réduisent plus rapidement votre quota. Pour les services payants, cela peut entraîner des coûts plus élevés. Consultez Quotas et limites pour en savoir plus.

   La valeur TTL par défaut de 1 heure est raisonnable pour la plupart des applications. Notez que la bibliothèque App Check actualise les jetons environ la moitié de la durée de TTL.

2. Ajouter la bibliothèque App Check à votre application

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependencies for the App Check libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity")
}

En utilisant Firebase Android BoM, votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.

dependencies {
    // Add the dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity:18.0.0")
}

3. Initialiser App Check

Ajoutez le code d'initialisation suivant à votre application pour qu'il s'exécute avant que vous n'utilisiez d'autres SDK Firebase :

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance(),
)
MainActivity.kt

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());
MainActivity.java

Étapes suivantes

Une fois la bibliothèque App Check installée dans votre application, commencez à distribuer l'application mise à jour à vos utilisateurs.

L'application cliente mise à jour commencera à envoyer des jetons App Check avec chaque requête envoyée à Firebase, mais les produits Firebase n'exigeront pas que les jetons soient valides tant que vous n'aurez pas activé l'application dans la section App Check de la console Firebase.

Surveiller les métriques et activer l'application

Toutefois, avant d'activer l'application, vous devez vous assurer qu'elle n'entraînera pas de perturbation pour vos utilisateurs légitimes existants. En revanche, si vous constatez une utilisation suspecte de vos ressources d'application, vous pouvez activer l'application plus tôt.

Pour vous aider à prendre cette décision, vous pouvez consulter les métriques App Check des services que vous utilisez :

• Surveillez les métriques de requête App Check pour Realtime Database, Cloud Firestore, Cloud Storage, Authentication (bêta) et Vertex AI in Firebase.
• Surveillez les métriques des requêtes App Check pour Cloud Functions.

Activer l'application des règles App Check

Une fois que vous avez compris l'impact de App Check sur vos utilisateurs et que vous êtes prêt à continuer, vous pouvez activer l'application de App Check :

• Activez l'application forcée de App Check pour Realtime Database, Cloud Firestore, Cloud Storage, Authentication (bêta) et Vertex AI in Firebase.
• Activez l'application forcée App Check pour Cloud Functions.

Utiliser App Check dans les environnements de débogage

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

Consultez Utiliser App Check avec le fournisseur de débogage sur Android.