Cette page a été traduite par l'API Cloud Translation.

Utiliser App Check pour sécuriser votre clé API

Firebase App Check protège les appels de votre application vers Google Maps Platform en bloquant le trafic provenant d'autres sources que les applications légitimes. Pour ce faire, il recherche un jeton auprès d'un fournisseur d'attestation tel que App Attest. Intégrer App Check à vos applications vous permet de vous protéger contre les requêtes malveillantes, et vous n'êtes donc pas facturé pour les appels d'API non autorisés.

App Check est-il adapté à mes besoins ?

Dans la plupart des cas, App Check est recommandé. Toutefois, il n'est pas nécessaire ou n'est pas compatible dans les cas suivants:

Vous utilisez le SDK Places d'origine. App Check n'est compatible qu'avec le SDK Places (nouveau).
Applications privées ou expérimentales. Si votre application n'est pas accessible au public, l'App Check n'est pas nécessaire.
Si votre application n'est utilisée que de serveur à serveur, App Check n'est pas nécessaire. Toutefois, si le serveur qui communique avec GMP est utilisé par des clients publics (tels que des applications mobiles), envisagez d'utiliser App Check pour protéger ce serveur au lieu de GMP.
Les fournisseurs d'attestation recommandés par App Check ne fonctionnent pas sur les appareils considérés comme compromis ou non fiables par votre fournisseur d'attestation. Si vous devez prendre en charge ces appareils, vous pouvez déployer un service d'attestation personnalisé. Pour en savoir plus, consultez les instructions.

Présentation des étapes d'implémentation

Voici les étapes à suivre pour intégrer votre application à App Check:

Ajoutez Firebase à votre application.
Ajoutez et initialisez la bibliothèque App Check.
Ajoutez le fournisseur de jetons à votre application.
Initialisez les API Places et App Check.
Activez le débogage.
Surveillez les requêtes de votre application et décidez de la mise en œuvre.

Une fois l'intégration à App Check effectuée, vous pourrez consulter les métriques de trafic du backend dans la console Firebase. Ces métriques fournissent une répartition des requêtes selon qu'elles sont accompagnées d'un jeton App Check valide ou non. Pour en savoir plus, consultez la documentation Firebase App Check.

Lorsque vous êtes sûr que la plupart des requêtes proviennent de sources légitimes et que les utilisateurs ont mis à jour la dernière version de votre application incluant votre implémentation d'App Check, vous pouvez activer l'application. Une fois l'application activée, App Check refusera tout trafic sans jeton App Check valide.

Éléments à prendre en compte lors de la planification d'une intégration d'App Check

Voici quelques éléments à prendre en compte lorsque vous planifiez votre intégration:

Les fournisseurs d'attestation que nous recommandons, Device Check ou App Attest, sont soumis à des quotas et à des limites définis par Apple.
Vous pouvez choisir d'utiliser un fournisseur d'attestation personnalisé, mais il s'agit d'un cas d'utilisation avancé. Pour en savoir plus, consultez la documentation Firebase App Check.
Les utilisateurs de votre application subiront une latence au démarrage. Toutefois, par la suite, toute réattestation périodique se produira en arrière-plan, et les utilisateurs ne devraient plus subir de latence. La latence exacte au démarrage dépend du fournisseur d'attestation que vous choisissez.

La durée de validité du jeton App Check (durée de vie ou TTL) détermine la fréquence des réattestations. Cette durée peut être configurée dans la console Firebase. La réattestation se produit lorsque la moitié environ de la valeur TTL s'est écoulée. Pour en savoir plus, consultez la documentation Firebase sur votre fournisseur d'attestation.

Intégrer votre application à App Check

Prérequis et exigences

Une application avec le SDK Places version 9.2 ou ultérieure installé.
ID du bundle de l'application.
Votre ID d'équipe dans l'Apple Member Center, sous "Membership" (Abonnement).
Si vous prévoyez d'utiliser la vérification de l'appareil, votre fichier de clé privée et votre ID de clé.
Vous devez être le propriétaire de l'application dans Cloud Console.
Vous aurez besoin de l'ID de projet de l'application dans la console Cloud.

Étape 1: Ajoutez Firebase à votre application

Suivez les instructions de la documentation destinée aux développeurs Firebase pour ajouter Firebase à votre application.

Lorsque vous enregistrez votre application, vous recevez un fichier de configuration, GoogleService-Info.plist. Ajoutez ce fichier, non modifié, au niveau racine de votre application.

Remarque: À l'étape 5 de la documentation destinée aux développeurs Firebase, où vous ajoutez des modules Firebase à votre fichier AppDelegate, ajoutez les modules suivants:

Swift

import FirebaseCore
import FirebaseAppCheck
import GooglePlaces

Objective-C

@import FirebaseCore;      
@import FirebaseAppCheck;
@import GooglePlaces;

Étape 2: Ajoutez la bibliothèque App Check et initialisez-la

Firebase fournit des instructions pour chaque fournisseur d'attestation par défaut. Ces instructions vous expliquent comment configurer un projet Firebase et ajouter la bibliothèque App Check à votre application. Suivez les exemples de code fournis pour initialiser App Check.

Suivez les instructions de Firebase pour ajouter la bibliothèque App Check :
- Instructions pour l'attestation d'application
- Instructions de vérification de l'appareil

Initialisez App Check.

Si vous utilisez App Attest, suivez la documentation destinée aux développeurs Firebase pour App Attest.

Suivez les instructions Firebase App Check pour créer une implémentation de AppCheckProviderFactory et l'ajouter à votre fichier AppDelegate.

Swift

let providerFactory = YourAppCheckProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

Objective-C

YourAppCheckProviderFactory *providerFactory =
    [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

Si vous utilisez la vérification de l'appareil, ajoutez les éléments suivants à votre AppDelegate:

Swift

AppCheck.setAppCheckProviderFactory(DeviceCheckProviderFactory())

Objective-C

[FIRAppCheck setAppCheckProviderFactory:providerFactory];

Étape 3: Ajoutez le fournisseur de jetons

Créez un fichier nommé AppCheckTokenProvider (ou, si vous utilisez Objective-C, deux fichiers nommés AppCheckTokenProvider.h et AppCheckTokenProvider.m) au niveau racine de votre application. Ajoutez les instructions d'importation et la définition de classe suivantes:

Swift

// AppCheckTokenProvider.swift

import FirebaseAppCheck
import Foundation
import GooglePlaces

class AppCheckTokenProvider: NSObject, GMSPlacesAppCheckTokenProvider {
  func fetchAppCheckToken() async throws -> String {
    return try await AppCheck.appCheck().token(forcingRefresh: false).token
  }
}

Objective-C

// AppCheckTokenProvider.h

@import Foundation;
@import GooglePlaces;

@interface AppCheckTokenProvider : NSObject <GMSPlacesAppCheckTokenProvider>
@end

// AppCheckTokenProvider.m

#import "AppCheckTokenProvider.h"

@import FirebaseAppCheck;

@implementation AppCheckTokenProvider

- (void)fetchAppCheckTokenWithCompletion:(nonnull GMSAppCheckTokenCompletion)completion {
  [[FIRAppCheck appCheck]
      tokenForcingRefresh:NO
               completion:^(FIRAppCheckToken *_Nullable token, NSError *_Nullable error) {
                 if (token) {
                   completion(token.token, nil);
                 } else {
                   completion(nil, error);
                 }
               }];
}

@end

Étape 4: Initialiser les API Places et App Check

Dans votre fichier AppDelegate, initialisez l'API Places:

Swift

GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

Objective-C

[GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

Ensuite, initialisez l'API App Check:

Swift

GMSPlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

Objective-C

[GMSPlacesClient setAppCheckTokenProvider:[[AppCheckTokenProvider alloc] init]];

Étape 5: Activez le débogage (facultatif)

Si vous souhaitez développer et tester votre application localement ou l'exécuter dans un environnement d'intégration continue (CI), vous pouvez créer un build de débogage de votre application qui utilise un secret de débogage pour obtenir des jetons App Check valides. Vous pouvez ainsi éviter d'utiliser de véritables fournisseurs d'attestation dans votre build de débogage.

Pour tester votre application dans le simulateur ou sur un appareil de test:

Créez et définissez la fabrique du fournisseur de débogage App Check.

Cet exemple de code gère à la fois les scénarios de débogage et de production:

Swift

#if targetEnvironment(simulator)
      let providerFactory = AppCheckDebugProviderFactory()
#else
      let providerFactory = YourAppCheckProviderFactory()
#endif

Objective-C

if (targetEnvironment == simulator){

FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
}

else {

YourAppCheckProviderFactory *providerFactory =
      [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
}

Activez la journalisation dans votre projet Xcode, lancez l'application et recherchez le jeton de débogage local dans le journal.
Ajoutez ce jeton à la console Firebase.
Pour en savoir plus et obtenir des instructions, consultez la documentation sur App Check.

Pour exécuter votre application dans un environnement de CI:

Créez un jeton de débogage dans la console Firebase, puis ajoutez-le au magasin de clés sécurisé de votre système de CI.
Dans Xcode, ajoutez une variable d'environnement à votre schéma de test avec le nom FIRAAppCheckDebugToken et $(APP_CHECK_DEBUG_TOKEN) (ou quelque chose de similaire) comme valeur.
Dans votre script de test CI, transmettez le jeton de débogage en tant qu'environnement

Créez et définissez la fabrique du fournisseur de débogage App Check.

Cet exemple de code gère à la fois les scénarios de débogage et de production:

Swift

  #if targetEnvironment(ci)
        let providerFactory = AppCheckDebugProviderFactory()
        AppCheck.setAppCheckProviderFactory(providerFactory)
  #else
        let providerFactory = YourAppCheckProviderFactory()
  #endif

Objective-C

if (targetEnvironment == ci) {
FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
}

else {
YourAppCheckProviderFactory *providerFactory =
      [[YourAppCheckProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];
}

Pour en savoir plus et obtenir des instructions, consultez la documentation sur App Check.

Étape 6: Surveillez les requêtes de votre application et décidez de la mise en œuvre

Avant de commencer à appliquer les mesures, vous devez vous assurer que vous ne perturberez pas les utilisateurs légitimes de votre application. Pour ce faire, accédez à l'écran des métriques App Check pour voir quel pourcentage du trafic de votre application est validé, obsolète ou non légitime. Une fois que vous constatez que la majorité de votre trafic est validé, vous pouvez activer l'application.

Pour en savoir plus et obtenir des instructions, consultez la documentation Firebase App Check.